From 027b4db37bba385ab9131ce5dc618db104d4687e Mon Sep 17 00:00:00 2001 From: ThatOneCalculator Date: Thu, 19 Oct 2023 16:18:21 -0700 Subject: [PATCH] refactor: :recycle: firefish-js build --- packages/firefish-js/.editorconfig | 7 - packages/firefish-js/.swcrc | 1 + packages/firefish-js/README.md | 1 - packages/firefish-js/api-extractor.json | 364 - packages/firefish-js/codecov.yml | 2 - packages/firefish-js/etc/firefish-js.api.json | 9814 ----------------- packages/firefish-js/etc/firefish-js.api.md | 2839 ----- .../firefish-js/markdown/firefish-js.acct.md | 14 - ...firefish-js.api.apiclient._constructor_.md | 24 - .../firefish-js.api.apiclient.credential.md | 11 - .../firefish-js.api.apiclient.fetch.md | 11 - .../markdown/firefish-js.api.apiclient.md | 32 - .../firefish-js.api.apiclient.origin.md | 11 - .../firefish-js.api.apiclient.request.md | 57 - .../markdown/firefish-js.api.apierror.md | 17 - .../markdown/firefish-js.api.fetchlike.md | 22 - .../markdown/firefish-js.api.isapierror.md | 22 - .../firefish-js/markdown/firefish-js.api.md | 25 - ...fish-js.channelconnection._constructor_.md | 22 - .../firefish-js.channelconnection.channel.md | 11 - .../firefish-js.channelconnection.dispose.md | 15 - .../firefish-js.channelconnection.id.md | 11 - .../firefish-js.channelconnection.incount.md | 11 - .../markdown/firefish-js.channelconnection.md | 39 - .../firefish-js.channelconnection.name.md | 11 - .../firefish-js.channelconnection.outcount.md | 11 - .../firefish-js.channelconnection.send.md | 26 - .../firefish-js.channelconnection.stream.md | 11 - .../markdown/firefish-js.channels.md | 143 - .../markdown/firefish-js.endpoints.md | 1911 ---- .../markdown/firefish-js.entities.ad.md | 11 - .../firefish-js.entities.announcement.md | 21 - .../markdown/firefish-js.entities.antenna.md | 29 - .../markdown/firefish-js.entities.app.md | 11 - .../firefish-js.entities.authsession.md | 17 - .../markdown/firefish-js.entities.blocking.md | 18 - .../markdown/firefish-js.entities.channel.md | 15 - .../markdown/firefish-js.entities.clip.md | 11 - .../firefish-js.entities.customemoji.md | 17 - .../firefish-js.entities.datestring.md | 11 - ...sh-js.entities.detailedinstancemetadata.md | 15 - .../firefish-js.entities.drivefile.md | 26 - .../firefish-js.entities.drivefolder.md | 11 - .../firefish-js.entities.following.md | 18 - ...-js.entities.followingfolloweepopulated.md | 15 - ...-js.entities.followingfollowerpopulated.md | 15 - .../firefish-js.entities.followrequest.md | 17 - .../firefish-js.entities.gallerypost.md | 11 - .../markdown/firefish-js.entities.id.md | 11 - .../markdown/firefish-js.entities.instance.md | 40 - .../firefish-js.entities.instancemetadata.md | 15 - ...refish-js.entities.liteinstancemetadata.md | 46 - .../markdown/firefish-js.entities.md | 51 - .../firefish-js.entities.medetailed.md | 40 - .../firefish-js.entities.messagingmessage.md | 27 - .../markdown/firefish-js.entities.note.md | 51 - .../firefish-js.entities.notefavorite.md | 18 - .../firefish-js.entities.notereaction.md | 18 - .../firefish-js.entities.notification.md | 82 - .../firefish-js.entities.origintype.md | 11 - .../markdown/firefish-js.entities.page.md | 33 - .../firefish-js.entities.pageevent.md | 19 - .../firefish-js.entities.serverinfo.md | 24 - .../markdown/firefish-js.entities.signin.md | 19 - .../markdown/firefish-js.entities.stats.md | 19 - .../markdown/firefish-js.entities.user.md | 13 - .../firefish-js.entities.userdetailed.md | 56 - .../firefish-js.entities.usergroup.md | 11 - .../markdown/firefish-js.entities.userlist.md | 18 - .../markdown/firefish-js.entities.userlite.md | 35 - .../firefish-js.entities.usersorting.md | 17 - .../markdown/firefish-js.ffvisibility.md | 11 - packages/firefish-js/markdown/firefish-js.md | 43 - .../markdown/firefish-js.mutednotereasons.md | 16 - .../markdown/firefish-js.notevisibilities.md | 16 - .../markdown/firefish-js.notificationtypes.md | 24 - .../markdown/firefish-js.permissions.md | 11 - .../firefish-js.stream._constructor_.md | 30 - .../markdown/firefish-js.stream.close.md | 15 - .../firefish-js.stream.disconnecttochannel.md | 22 - .../markdown/firefish-js.stream.md | 36 - ...refish-js.stream.removesharedconnection.md | 22 - ...sh-js.stream.removesharedconnectionpool.md | 22 - .../markdown/firefish-js.stream.send.md | 23 - .../markdown/firefish-js.stream.state.md | 11 - .../markdown/firefish-js.stream.usechannel.md | 28 - packages/firefish-js/markdown/index.md | 12 - packages/firefish-js/package.json | 19 +- packages/firefish-js/src/streaming.ts | 3 +- pnpm-lock.yaml | 19 +- 90 files changed, 17 insertions(+), 16825 deletions(-) delete mode 100644 packages/firefish-js/.editorconfig delete mode 100644 packages/firefish-js/api-extractor.json delete mode 100644 packages/firefish-js/codecov.yml delete mode 100644 packages/firefish-js/etc/firefish-js.api.json delete mode 100644 packages/firefish-js/etc/firefish-js.api.md delete mode 100644 packages/firefish-js/markdown/firefish-js.acct.md delete mode 100644 packages/firefish-js/markdown/firefish-js.api.apiclient._constructor_.md delete mode 100644 packages/firefish-js/markdown/firefish-js.api.apiclient.credential.md delete mode 100644 packages/firefish-js/markdown/firefish-js.api.apiclient.fetch.md delete mode 100644 packages/firefish-js/markdown/firefish-js.api.apiclient.md delete mode 100644 packages/firefish-js/markdown/firefish-js.api.apiclient.origin.md delete mode 100644 packages/firefish-js/markdown/firefish-js.api.apiclient.request.md delete mode 100644 packages/firefish-js/markdown/firefish-js.api.apierror.md delete mode 100644 packages/firefish-js/markdown/firefish-js.api.fetchlike.md delete mode 100644 packages/firefish-js/markdown/firefish-js.api.isapierror.md delete mode 100644 packages/firefish-js/markdown/firefish-js.api.md delete mode 100644 packages/firefish-js/markdown/firefish-js.channelconnection._constructor_.md delete mode 100644 packages/firefish-js/markdown/firefish-js.channelconnection.channel.md delete mode 100644 packages/firefish-js/markdown/firefish-js.channelconnection.dispose.md delete mode 100644 packages/firefish-js/markdown/firefish-js.channelconnection.id.md delete mode 100644 packages/firefish-js/markdown/firefish-js.channelconnection.incount.md delete mode 100644 packages/firefish-js/markdown/firefish-js.channelconnection.md delete mode 100644 packages/firefish-js/markdown/firefish-js.channelconnection.name.md delete mode 100644 packages/firefish-js/markdown/firefish-js.channelconnection.outcount.md delete mode 100644 packages/firefish-js/markdown/firefish-js.channelconnection.send.md delete mode 100644 packages/firefish-js/markdown/firefish-js.channelconnection.stream.md delete mode 100644 packages/firefish-js/markdown/firefish-js.channels.md delete mode 100644 packages/firefish-js/markdown/firefish-js.endpoints.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.ad.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.announcement.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.antenna.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.app.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.authsession.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.blocking.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.channel.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.clip.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.customemoji.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.datestring.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.detailedinstancemetadata.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.drivefile.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.drivefolder.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.following.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.followingfolloweepopulated.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.followingfollowerpopulated.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.followrequest.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.gallerypost.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.id.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.instance.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.instancemetadata.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.liteinstancemetadata.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.medetailed.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.messagingmessage.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.note.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.notefavorite.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.notereaction.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.notification.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.origintype.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.page.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.pageevent.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.serverinfo.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.signin.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.stats.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.user.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.userdetailed.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.usergroup.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.userlist.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.userlite.md delete mode 100644 packages/firefish-js/markdown/firefish-js.entities.usersorting.md delete mode 100644 packages/firefish-js/markdown/firefish-js.ffvisibility.md delete mode 100644 packages/firefish-js/markdown/firefish-js.md delete mode 100644 packages/firefish-js/markdown/firefish-js.mutednotereasons.md delete mode 100644 packages/firefish-js/markdown/firefish-js.notevisibilities.md delete mode 100644 packages/firefish-js/markdown/firefish-js.notificationtypes.md delete mode 100644 packages/firefish-js/markdown/firefish-js.permissions.md delete mode 100644 packages/firefish-js/markdown/firefish-js.stream._constructor_.md delete mode 100644 packages/firefish-js/markdown/firefish-js.stream.close.md delete mode 100644 packages/firefish-js/markdown/firefish-js.stream.disconnecttochannel.md delete mode 100644 packages/firefish-js/markdown/firefish-js.stream.md delete mode 100644 packages/firefish-js/markdown/firefish-js.stream.removesharedconnection.md delete mode 100644 packages/firefish-js/markdown/firefish-js.stream.removesharedconnectionpool.md delete mode 100644 packages/firefish-js/markdown/firefish-js.stream.send.md delete mode 100644 packages/firefish-js/markdown/firefish-js.stream.state.md delete mode 100644 packages/firefish-js/markdown/firefish-js.stream.usechannel.md delete mode 100644 packages/firefish-js/markdown/index.md diff --git a/packages/firefish-js/.editorconfig b/packages/firefish-js/.editorconfig deleted file mode 100644 index da178f0707..0000000000 --- a/packages/firefish-js/.editorconfig +++ /dev/null @@ -1,7 +0,0 @@ -root = true - -[*] -indent_style = tab -indent_size = 2 -charset = utf-8 -insert_final_newline = true diff --git a/packages/firefish-js/.swcrc b/packages/firefish-js/.swcrc index 508e597b5c..0fbb5c87c5 100644 --- a/packages/firefish-js/.swcrc +++ b/packages/firefish-js/.swcrc @@ -1,5 +1,6 @@ { "$schema": "https://json.schemastore.org/swcrc", + "sourceMaps": true, "jsc": { "parser": { "syntax": "typescript", diff --git a/packages/firefish-js/README.md b/packages/firefish-js/README.md index 24839275ab..e75ba12681 100644 --- a/packages/firefish-js/README.md +++ b/packages/firefish-js/README.md @@ -6,4 +6,3 @@ https://www.npmjs.com/package/firefish-js To fully build, run `pnpm i && pnpm run render`. -![Parody of the Javascript logo with "CK" instead of "JS"](https://codeberg.org/repo-avatars/80771-4d86135f67b9a460cdd1be9e91648e5f) diff --git a/packages/firefish-js/api-extractor.json b/packages/firefish-js/api-extractor.json deleted file mode 100644 index a95281a6d5..0000000000 --- a/packages/firefish-js/api-extractor.json +++ /dev/null @@ -1,364 +0,0 @@ -/** - * Config file for API Extractor. For more info, please visit: https://api-extractor.com - */ -{ - "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", - - /** - * Optionally specifies another JSON config file that this file extends from. This provides a way for - * standard settings to be shared across multiple projects. - * - * If the path starts with "./" or "../", the path is resolved relative to the folder of the file that contains - * the "extends" field. Otherwise, the first path segment is interpreted as an NPM package name, and will be - * resolved using NodeJS require(). - * - * SUPPORTED TOKENS: none - * DEFAULT VALUE: "" - */ - // "extends": "./shared/api-extractor-base.json" - // "extends": "my-package/include/api-extractor-base.json" - - /** - * Determines the "" token that can be used with other config file settings. The project folder - * typically contains the tsconfig.json and package.json config files, but the path is user-defined. - * - * The path is resolved relative to the folder of the config file that contains the setting. - * - * The default value for "projectFolder" is the token "", which means the folder is determined by traversing - * parent folders, starting from the folder containing api-extractor.json, and stopping at the first folder - * that contains a tsconfig.json file. If a tsconfig.json file cannot be found in this way, then an error - * will be reported. - * - * SUPPORTED TOKENS: - * DEFAULT VALUE: "" - */ - // "projectFolder": "..", - - /** - * (REQUIRED) Specifies the .d.ts file to be used as the starting point for analysis. API Extractor - * analyzes the symbols exported by this module. - * - * The file extension must be ".d.ts" and not ".ts". - * - * The path is resolved relative to the folder of the config file that contains the setting; to change this, - * prepend a folder token such as "". - * - * SUPPORTED TOKENS: , , - */ - "mainEntryPointFilePath": "/built/index.d.ts", - - /** - * A list of NPM package names whose exports should be treated as part of this package. - * - * For example, suppose that Webpack is used to generate a distributed bundle for the project "library1", - * and another NPM package "library2" is embedded in this bundle. Some types from library2 may become part - * of the exported API for library1, but by default API Extractor would generate a .d.ts rollup that explicitly - * imports library2. To avoid this, we can specify: - * - * "bundledPackages": [ "library2" ], - * - * This would direct API Extractor to embed those types directly in the .d.ts rollup, as if they had been - * local files for library1. - */ - "bundledPackages": [], - - /** - * Determines how the TypeScript compiler engine will be invoked by API Extractor. - */ - "compiler": { - /** - * Specifies the path to the tsconfig.json file to be used by API Extractor when analyzing the project. - * - * The path is resolved relative to the folder of the config file that contains the setting; to change this, - * prepend a folder token such as "". - * - * Note: This setting will be ignored if "overrideTsconfig" is used. - * - * SUPPORTED TOKENS: , , - * DEFAULT VALUE: "/tsconfig.json" - */ - // "tsconfigFilePath": "/tsconfig.json", - /** - * Provides a compiler configuration that will be used instead of reading the tsconfig.json file from disk. - * The object must conform to the TypeScript tsconfig schema: - * - * http://json.schemastore.org/tsconfig - * - * If omitted, then the tsconfig.json file will be read from the "projectFolder". - * - * DEFAULT VALUE: no overrideTsconfig section - */ - // "overrideTsconfig": { - // . . . - // } - /** - * This option causes the compiler to be invoked with the --skipLibCheck option. This option is not recommended - * and may cause API Extractor to produce incomplete or incorrect declarations, but it may be required when - * dependencies contain declarations that are incompatible with the TypeScript engine that API Extractor uses - * for its analysis. Where possible, the underlying issue should be fixed rather than relying on skipLibCheck. - * - * DEFAULT VALUE: false - */ - // "skipLibCheck": true, - }, - - /** - * Configures how the API report file (*.api.md) will be generated. - */ - "apiReport": { - /** - * (REQUIRED) Whether to generate an API report. - */ - "enabled": true - - /** - * The filename for the API report files. It will be combined with "reportFolder" or "reportTempFolder" to produce - * a full file path. - * - * The file extension should be ".api.md", and the string should not contain a path separator such as "\" or "/". - * - * SUPPORTED TOKENS: , - * DEFAULT VALUE: ".api.md" - */ - // "reportFileName": ".api.md", - - /** - * Specifies the folder where the API report file is written. The file name portion is determined by - * the "reportFileName" setting. - * - * The API report file is normally tracked by Git. Changes to it can be used to trigger a branch policy, - * e.g. for an API review. - * - * The path is resolved relative to the folder of the config file that contains the setting; to change this, - * prepend a folder token such as "". - * - * SUPPORTED TOKENS: , , - * DEFAULT VALUE: "/etc/" - */ - // "reportFolder": "/etc/", - - /** - * Specifies the folder where the temporary report file is written. The file name portion is determined by - * the "reportFileName" setting. - * - * After the temporary file is written to disk, it is compared with the file in the "reportFolder". - * If they are different, a production build will fail. - * - * The path is resolved relative to the folder of the config file that contains the setting; to change this, - * prepend a folder token such as "". - * - * SUPPORTED TOKENS: , , - * DEFAULT VALUE: "/temp/" - */ - // "reportTempFolder": "/temp/" - }, - - /** - * Configures how the doc model file (*.api.json) will be generated. - */ - "docModel": { - /** - * (REQUIRED) Whether to generate a doc model file. - */ - "enabled": true - - /** - * The output path for the doc model file. The file extension should be ".api.json". - * - * The path is resolved relative to the folder of the config file that contains the setting; to change this, - * prepend a folder token such as "". - * - * SUPPORTED TOKENS: , , - * DEFAULT VALUE: "/temp/.api.json" - */ - // "apiJsonFilePath": "/temp/.api.json" - }, - - /** - * Configures how the .d.ts rollup file will be generated. - */ - "dtsRollup": { - /** - * (REQUIRED) Whether to generate the .d.ts rollup file. - */ - "enabled": false - - /** - * Specifies the output path for a .d.ts rollup file to be generated without any trimming. - * This file will include all declarations that are exported by the main entry point. - * - * If the path is an empty string, then this file will not be written. - * - * The path is resolved relative to the folder of the config file that contains the setting; to change this, - * prepend a folder token such as "". - * - * SUPPORTED TOKENS: , , - * DEFAULT VALUE: "/dist/.d.ts" - */ - // "untrimmedFilePath": "/dist/.d.ts", - - /** - * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "beta" release. - * This file will include only declarations that are marked as "@public" or "@beta". - * - * The path is resolved relative to the folder of the config file that contains the setting; to change this, - * prepend a folder token such as "". - * - * SUPPORTED TOKENS: , , - * DEFAULT VALUE: "" - */ - // "betaTrimmedFilePath": "/dist/-beta.d.ts", - - /** - * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "public" release. - * This file will include only declarations that are marked as "@public". - * - * If the path is an empty string, then this file will not be written. - * - * The path is resolved relative to the folder of the config file that contains the setting; to change this, - * prepend a folder token such as "". - * - * SUPPORTED TOKENS: , , - * DEFAULT VALUE: "" - */ - // "publicTrimmedFilePath": "/dist/-public.d.ts", - - /** - * When a declaration is trimmed, by default it will be replaced by a code comment such as - * "Excluded from this release type: exampleMember". Set "omitTrimmingComments" to true to remove the - * declaration completely. - * - * DEFAULT VALUE: false - */ - // "omitTrimmingComments": true - }, - - /** - * Configures how the tsdoc-metadata.json file will be generated. - */ - "tsdocMetadata": { - /** - * Whether to generate the tsdoc-metadata.json file. - * - * DEFAULT VALUE: true - */ - // "enabled": true, - /** - * Specifies where the TSDoc metadata file should be written. - * - * The path is resolved relative to the folder of the config file that contains the setting; to change this, - * prepend a folder token such as "". - * - * The default value is "", which causes the path to be automatically inferred from the "tsdocMetadata", - * "typings" or "main" fields of the project's package.json. If none of these fields are set, the lookup - * falls back to "tsdoc-metadata.json" in the package folder. - * - * SUPPORTED TOKENS: , , - * DEFAULT VALUE: "" - */ - // "tsdocMetadataFilePath": "/dist/tsdoc-metadata.json" - }, - - /** - * Specifies what type of newlines API Extractor should use when writing output files. By default, the output files - * will be written with Windows-style newlines. To use POSIX-style newlines, specify "lf" instead. - * To use the OS's default newline kind, specify "os". - * - * DEFAULT VALUE: "crlf" - */ - // "newlineKind": "crlf", - - /** - * Configures how API Extractor reports error and warning messages produced during analysis. - * - * There are three sources of messages: compiler messages, API Extractor messages, and TSDoc messages. - */ - "messages": { - /** - * Configures handling of diagnostic messages reported by the TypeScript compiler engine while analyzing - * the input .d.ts files. - * - * TypeScript message identifiers start with "TS" followed by an integer. For example: "TS2551" - * - * DEFAULT VALUE: A single "default" entry with logLevel=warning. - */ - "compilerMessageReporting": { - /** - * Configures the default routing for messages that don't match an explicit rule in this table. - */ - "default": { - /** - * Specifies whether the message should be written to the the tool's output log. Note that - * the "addToApiReportFile" property may supersede this option. - * - * Possible values: "error", "warning", "none" - * - * Errors cause the build to fail and return a nonzero exit code. Warnings cause a production build fail - * and return a nonzero exit code. For a non-production build (e.g. when "api-extractor run" includes - * the "--local" option), the warning is displayed but the build will not fail. - * - * DEFAULT VALUE: "warning" - */ - "logLevel": "warning" - - /** - * When addToApiReportFile is true: If API Extractor is configured to write an API report file (.api.md), - * then the message will be written inside that file; otherwise, the message is instead logged according to - * the "logLevel" option. - * - * DEFAULT VALUE: false - */ - // "addToApiReportFile": false - } - - // "TS2551": { - // "logLevel": "warning", - // "addToApiReportFile": true - // }, - // - // . . . - }, - - /** - * Configures handling of messages reported by API Extractor during its analysis. - * - * API Extractor message identifiers start with "ae-". For example: "ae-extra-release-tag" - * - * DEFAULT VALUE: See api-extractor-defaults.json for the complete table of extractorMessageReporting mappings - */ - "extractorMessageReporting": { - "default": { - "logLevel": "none" - // "addToApiReportFile": false - } - - // "ae-extra-release-tag": { - // "logLevel": "warning", - // "addToApiReportFile": true - // }, - // - // . . . - }, - - /** - * Configures handling of messages reported by the TSDoc parser when analyzing code comments. - * - * TSDoc message identifiers start with "tsdoc-". For example: "tsdoc-link-tag-unescaped-text" - * - * DEFAULT VALUE: A single "default" entry with logLevel=warning. - */ - "tsdocMessageReporting": { - "default": { - "logLevel": "warning" - // "addToApiReportFile": false - } - - // "tsdoc-link-tag-unescaped-text": { - // "logLevel": "warning", - // "addToApiReportFile": true - // }, - // - // . . . - } - } -} diff --git a/packages/firefish-js/codecov.yml b/packages/firefish-js/codecov.yml deleted file mode 100644 index 5242987213..0000000000 --- a/packages/firefish-js/codecov.yml +++ /dev/null @@ -1,2 +0,0 @@ -codecov: - token: d55e1270-f20a-4727-aa05-2bd57793315a diff --git a/packages/firefish-js/etc/firefish-js.api.json b/packages/firefish-js/etc/firefish-js.api.json deleted file mode 100644 index 8cb56a2d70..0000000000 --- a/packages/firefish-js/etc/firefish-js.api.json +++ /dev/null @@ -1,9814 +0,0 @@ -{ - "metadata": { - "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.36.0", - "schemaVersion": 1011, - "oldestForwardsCompatibleVersion": 1001, - "tsdocConfig": { - "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", - "noStandardTags": true, - "tagDefinitions": [ - { - "tagName": "@alpha", - "syntaxKind": "modifier" - }, - { - "tagName": "@beta", - "syntaxKind": "modifier" - }, - { - "tagName": "@defaultValue", - "syntaxKind": "block" - }, - { - "tagName": "@decorator", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@deprecated", - "syntaxKind": "block" - }, - { - "tagName": "@eventProperty", - "syntaxKind": "modifier" - }, - { - "tagName": "@example", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@experimental", - "syntaxKind": "modifier" - }, - { - "tagName": "@inheritDoc", - "syntaxKind": "inline" - }, - { - "tagName": "@internal", - "syntaxKind": "modifier" - }, - { - "tagName": "@label", - "syntaxKind": "inline" - }, - { - "tagName": "@link", - "syntaxKind": "inline", - "allowMultiple": true - }, - { - "tagName": "@override", - "syntaxKind": "modifier" - }, - { - "tagName": "@packageDocumentation", - "syntaxKind": "modifier" - }, - { - "tagName": "@param", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@privateRemarks", - "syntaxKind": "block" - }, - { - "tagName": "@public", - "syntaxKind": "modifier" - }, - { - "tagName": "@readonly", - "syntaxKind": "modifier" - }, - { - "tagName": "@remarks", - "syntaxKind": "block" - }, - { - "tagName": "@returns", - "syntaxKind": "block" - }, - { - "tagName": "@sealed", - "syntaxKind": "modifier" - }, - { - "tagName": "@see", - "syntaxKind": "block" - }, - { - "tagName": "@throws", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@typeParam", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@virtual", - "syntaxKind": "modifier" - }, - { - "tagName": "@betaDocumentation", - "syntaxKind": "modifier" - }, - { - "tagName": "@internalRemarks", - "syntaxKind": "block" - }, - { - "tagName": "@preapproved", - "syntaxKind": "modifier" - } - ], - "supportForTags": { - "@alpha": true, - "@beta": true, - "@defaultValue": true, - "@decorator": true, - "@deprecated": true, - "@eventProperty": true, - "@example": true, - "@experimental": true, - "@inheritDoc": true, - "@internal": true, - "@label": true, - "@link": true, - "@override": true, - "@packageDocumentation": true, - "@param": true, - "@privateRemarks": true, - "@public": true, - "@readonly": true, - "@remarks": true, - "@returns": true, - "@sealed": true, - "@see": true, - "@throws": true, - "@typeParam": true, - "@virtual": true, - "@betaDocumentation": true, - "@internalRemarks": true, - "@preapproved": true - }, - "reportUnsupportedHtmlElements": false - } - }, - "kind": "Package", - "canonicalReference": "firefish-js!", - "docComment": "", - "name": "firefish-js", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EntryPoint", - "canonicalReference": "firefish-js!", - "name": "", - "preserveMemberOrder": false, - "members": [ - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!Acct:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type Acct = " - }, - { - "kind": "Content", - "text": "{\n\tusername: string;\n\thost: string | null;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/acct.ts", - "releaseTag": "Public", - "name": "Acct", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Namespace", - "canonicalReference": "firefish-js!api:namespace", - "docComment": "", - "excerptTokens": [], - "fileUrlPath": "src/index.ts", - "releaseTag": "None", - "name": "api", - "preserveMemberOrder": false, - "members": [ - { - "kind": "Class", - "canonicalReference": "firefish-js!api.APIClient:class", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare class APIClient " - } - ], - "fileUrlPath": "src/api.ts", - "releaseTag": "Public", - "isAbstract": false, - "name": "APIClient", - "preserveMemberOrder": false, - "members": [ - { - "kind": "Constructor", - "canonicalReference": "firefish-js!api.APIClient:constructor(1)", - "docComment": "/**\n * Constructs a new instance of the `APIClient` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(opts: " - }, - { - "kind": "Content", - "text": "{\n\t\torigin: " - }, - { - "kind": "Reference", - "text": "APIClient", - "canonicalReference": "firefish-js!api.APIClient:class" - }, - { - "kind": "Content", - "text": "[\"origin\"];\n\t\tcredential?: " - }, - { - "kind": "Reference", - "text": "APIClient", - "canonicalReference": "firefish-js!api.APIClient:class" - }, - { - "kind": "Content", - "text": "[\"credential\"];\n\t\tfetch?: " - }, - { - "kind": "Reference", - "text": "APIClient", - "canonicalReference": "firefish-js!api.APIClient:class" - }, - { - "kind": "Content", - "text": "[\"fetch\"] | null | undefined;\n\t}" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "opts", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 8 - }, - "isOptional": false - } - ] - }, - { - "kind": "Property", - "canonicalReference": "firefish-js!api.APIClient#credential:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "credential: " - }, - { - "kind": "Content", - "text": "string | null | undefined" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "credential", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false, - "isProtected": false, - "isAbstract": false - }, - { - "kind": "Property", - "canonicalReference": "firefish-js!api.APIClient#fetch:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "fetch: " - }, - { - "kind": "Reference", - "text": "FetchLike", - "canonicalReference": "firefish-js!api.FetchLike:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "fetch", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false, - "isProtected": false, - "isAbstract": false - }, - { - "kind": "Property", - "canonicalReference": "firefish-js!api.APIClient#origin:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "origin: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "origin", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false, - "isProtected": false, - "isAbstract": false - }, - { - "kind": "Method", - "canonicalReference": "firefish-js!api.APIClient#request:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "request(\n\t\tendpoint: " - }, - { - "kind": "Content", - "text": "E" - }, - { - "kind": "Content", - "text": ",\n\t\tparams?: " - }, - { - "kind": "Content", - "text": "P" - }, - { - "kind": "Content", - "text": ",\n\t\tcredential?: " - }, - { - "kind": "Content", - "text": "string | null | undefined" - }, - { - "kind": "Content", - "text": ",\n\t): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<\n\t\t" - }, - { - "kind": "Reference", - "text": "Endpoints", - "canonicalReference": "firefish-js!Endpoints:type" - }, - { - "kind": "Content", - "text": "[E][\"res\"] extends {\n\t\t\t$switch: {\n\t\t\t\t$cases: [any, any][];\n\t\t\t\t$default: any;\n\t\t\t};\n\t\t}\n\t\t\t? " - }, - { - "kind": "Reference", - "text": "IsCaseMatched", - "canonicalReference": "firefish-js!~IsCaseMatched:type" - }, - { - "kind": "Content", - "text": " extends true\n\t\t\t\t? " - }, - { - "kind": "Reference", - "text": "GetCaseResult", - "canonicalReference": "firefish-js!~GetCaseResult:type" - }, - { - "kind": "Content", - "text": "\n\t\t\t\t: " - }, - { - "kind": "Reference", - "text": "IsCaseMatched", - "canonicalReference": "firefish-js!~IsCaseMatched:type" - }, - { - "kind": "Content", - "text": " extends true\n\t\t\t\t? " - }, - { - "kind": "Reference", - "text": "GetCaseResult", - "canonicalReference": "firefish-js!~GetCaseResult:type" - }, - { - "kind": "Content", - "text": "\n\t\t\t\t: " - }, - { - "kind": "Reference", - "text": "IsCaseMatched", - "canonicalReference": "firefish-js!~IsCaseMatched:type" - }, - { - "kind": "Content", - "text": " extends true\n\t\t\t\t? " - }, - { - "kind": "Reference", - "text": "GetCaseResult", - "canonicalReference": "firefish-js!~GetCaseResult:type" - }, - { - "kind": "Content", - "text": "\n\t\t\t\t: " - }, - { - "kind": "Reference", - "text": "IsCaseMatched", - "canonicalReference": "firefish-js!~IsCaseMatched:type" - }, - { - "kind": "Content", - "text": " extends true\n\t\t\t\t? " - }, - { - "kind": "Reference", - "text": "GetCaseResult", - "canonicalReference": "firefish-js!~GetCaseResult:type" - }, - { - "kind": "Content", - "text": "\n\t\t\t\t: " - }, - { - "kind": "Reference", - "text": "IsCaseMatched", - "canonicalReference": "firefish-js!~IsCaseMatched:type" - }, - { - "kind": "Content", - "text": " extends true\n\t\t\t\t? " - }, - { - "kind": "Reference", - "text": "GetCaseResult", - "canonicalReference": "firefish-js!~GetCaseResult:type" - }, - { - "kind": "Content", - "text": "\n\t\t\t\t: " - }, - { - "kind": "Reference", - "text": "IsCaseMatched", - "canonicalReference": "firefish-js!~IsCaseMatched:type" - }, - { - "kind": "Content", - "text": " extends true\n\t\t\t\t? " - }, - { - "kind": "Reference", - "text": "GetCaseResult", - "canonicalReference": "firefish-js!~GetCaseResult:type" - }, - { - "kind": "Content", - "text": "\n\t\t\t\t: " - }, - { - "kind": "Reference", - "text": "IsCaseMatched", - "canonicalReference": "firefish-js!~IsCaseMatched:type" - }, - { - "kind": "Content", - "text": " extends true\n\t\t\t\t? " - }, - { - "kind": "Reference", - "text": "GetCaseResult", - "canonicalReference": "firefish-js!~GetCaseResult:type" - }, - { - "kind": "Content", - "text": "\n\t\t\t\t: " - }, - { - "kind": "Reference", - "text": "IsCaseMatched", - "canonicalReference": "firefish-js!~IsCaseMatched:type" - }, - { - "kind": "Content", - "text": " extends true\n\t\t\t\t? " - }, - { - "kind": "Reference", - "text": "GetCaseResult", - "canonicalReference": "firefish-js!~GetCaseResult:type" - }, - { - "kind": "Content", - "text": "\n\t\t\t\t: " - }, - { - "kind": "Reference", - "text": "IsCaseMatched", - "canonicalReference": "firefish-js!~IsCaseMatched:type" - }, - { - "kind": "Content", - "text": " extends true\n\t\t\t\t? " - }, - { - "kind": "Reference", - "text": "GetCaseResult", - "canonicalReference": "firefish-js!~GetCaseResult:type" - }, - { - "kind": "Content", - "text": "\n\t\t\t\t: " - }, - { - "kind": "Reference", - "text": "IsCaseMatched", - "canonicalReference": "firefish-js!~IsCaseMatched:type" - }, - { - "kind": "Content", - "text": " extends true\n\t\t\t\t? " - }, - { - "kind": "Reference", - "text": "GetCaseResult", - "canonicalReference": "firefish-js!~GetCaseResult:type" - }, - { - "kind": "Content", - "text": "\n\t\t\t\t: " - }, - { - "kind": "Reference", - "text": "Endpoints", - "canonicalReference": "firefish-js!Endpoints:type" - }, - { - "kind": "Content", - "text": "[E][\"res\"][\"$switch\"][\"$default\"]\n\t\t\t: " - }, - { - "kind": "Reference", - "text": "Endpoints", - "canonicalReference": "firefish-js!Endpoints:type" - }, - { - "kind": "Content", - "text": "[E][\"res\"]\n\t>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "typeParameters": [ - { - "typeParameterName": "E", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "typeParameterName": "P", - "constraintTokenRange": { - "startIndex": 4, - "endIndex": 6 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 13, - "endIndex": 61 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "endpoint", - "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "isOptional": false - }, - { - "parameterName": "params", - "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 - }, - "isOptional": true - }, - { - "parameterName": "credential", - "parameterTypeTokenRange": { - "startIndex": 11, - "endIndex": 12 - }, - "isOptional": true - } - ], - "isOptional": false, - "isAbstract": false, - "name": "request" - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!api.APIError:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type APIError = " - }, - { - "kind": "Content", - "text": "{\n\tid: string;\n\tcode: string;\n\tmessage: string;\n\tkind: \"client\" | \"server\";\n\tinfo: " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": ";\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/api.ts", - "releaseTag": "Public", - "name": "APIError", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!api.FetchLike:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type FetchLike = " - }, - { - "kind": "Content", - "text": "(\n\tinput: string,\n\tinit?: {\n\t\tmethod?: string;\n\t\tbody?: string;\n\t\tcredentials?: " - }, - { - "kind": "Reference", - "text": "RequestCredentials", - "canonicalReference": "!RequestCredentials:type" - }, - { - "kind": "Content", - "text": ";\n\t\tcache?: " - }, - { - "kind": "Reference", - "text": "RequestCache", - "canonicalReference": "!RequestCache:type" - }, - { - "kind": "Content", - "text": ";\n\t},\n) => " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<{\n\tstatus: number;\n\tjson(): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n}>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/api.ts", - "releaseTag": "Public", - "name": "FetchLike", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 10 - } - }, - { - "kind": "Function", - "canonicalReference": "firefish-js!api.isAPIError:function(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare function isAPIError(reason: " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "reason", - "canonicalReference": "firefish-js!~reason" - }, - { - "kind": "Content", - "text": " is " - }, - { - "kind": "Reference", - "text": "APIError", - "canonicalReference": "firefish-js!api.APIError:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/api.ts", - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 6 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "reason", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "name": "isAPIError" - } - ] - }, - { - "kind": "Class", - "canonicalReference": "firefish-js!ChannelConnection:class", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare abstract class Connection<\n\tChannel extends " - }, - { - "kind": "Reference", - "text": "AnyOf", - "canonicalReference": "firefish-js!~AnyOf:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Channels", - "canonicalReference": "firefish-js!Channels:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": " = " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": ",\n> extends " - }, - { - "kind": "Reference", - "text": "EventEmitter", - "canonicalReference": "eventemitter3!EventEmitter.EventEmitter" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": " " - } - ], - "fileUrlPath": "src/streaming.ts", - "releaseTag": "Public", - "typeParameters": [ - { - "typeParameterName": "Channel", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 5 - }, - "defaultTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 - } - } - ], - "isAbstract": true, - "name": "ChannelConnection", - "preserveMemberOrder": false, - "members": [ - { - "kind": "Constructor", - "canonicalReference": "firefish-js!ChannelConnection:constructor(1)", - "docComment": "/**\n * Constructs a new instance of the `Connection` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(stream: " - }, - { - "kind": "Reference", - "text": "Stream", - "canonicalReference": "firefish-js!Stream:class" - }, - { - "kind": "Content", - "text": ", channel: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", name?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "stream", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "channel", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": false - }, - { - "parameterName": "name", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": true - } - ] - }, - { - "kind": "Property", - "canonicalReference": "firefish-js!ChannelConnection#channel:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "channel: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "channel", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false, - "isProtected": false, - "isAbstract": false - }, - { - "kind": "Method", - "canonicalReference": "firefish-js!ChannelConnection#dispose:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "abstract dispose(): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [], - "isOptional": false, - "isAbstract": true, - "name": "dispose" - }, - { - "kind": "Property", - "canonicalReference": "firefish-js!ChannelConnection#id:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "abstract id: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false, - "isProtected": false, - "isAbstract": true - }, - { - "kind": "Property", - "canonicalReference": "firefish-js!ChannelConnection#inCount:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "inCount: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "inCount", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false, - "isProtected": false, - "isAbstract": false - }, - { - "kind": "Property", - "canonicalReference": "firefish-js!ChannelConnection#name:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "name?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "name", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false, - "isProtected": false, - "isAbstract": false - }, - { - "kind": "Property", - "canonicalReference": "firefish-js!ChannelConnection#outCount:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "outCount: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "outCount", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false, - "isProtected": false, - "isAbstract": false - }, - { - "kind": "Method", - "canonicalReference": "firefish-js!ChannelConnection#send:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "send(\n\t\ttype: " - }, - { - "kind": "Content", - "text": "T" - }, - { - "kind": "Content", - "text": ",\n\t\tbody: " - }, - { - "kind": "Content", - "text": "Channel[\"receives\"][T]" - }, - { - "kind": "Content", - "text": ",\n\t): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "type", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": false - }, - { - "parameterName": "body", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": false - } - ], - "isOptional": false, - "isAbstract": false, - "name": "send" - }, - { - "kind": "Property", - "canonicalReference": "firefish-js!ChannelConnection#stream:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "protected stream: " - }, - { - "kind": "Reference", - "text": "Stream", - "canonicalReference": "firefish-js!Stream:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "stream", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false, - "isProtected": true, - "isAbstract": false - } - ], - "extendsTokenRange": { - "startIndex": 8, - "endIndex": 10 - }, - "implementsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!Channels:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type Channels = " - }, - { - "kind": "Content", - "text": "{\n\tmain: {\n\t\tparams: null;\n\t\tevents: {\n\t\t\tnotification: (payload: " - }, - { - "kind": "Reference", - "text": "Notification", - "canonicalReference": "firefish-js!entities.Notification_2:type" - }, - { - "kind": "Content", - "text": ") => void;\n\t\t\tmention: (payload: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": ") => void;\n\t\t\treply: (payload: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": ") => void;\n\t\t\trenote: (payload: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": ") => void;\n\t\t\tfollow: (payload: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": ") => void;\n\t\t\tfollowed: (payload: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": ") => void;\n\t\t\tunfollow: (payload: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": ") => void;\n\t\t\tmeUpdated: (payload: " - }, - { - "kind": "Reference", - "text": "MeDetailed", - "canonicalReference": "firefish-js!entities.MeDetailed:type" - }, - { - "kind": "Content", - "text": ") => void;\n\t\t\tpageEvent: (payload: " - }, - { - "kind": "Reference", - "text": "PageEvent", - "canonicalReference": "firefish-js!entities.PageEvent:type" - }, - { - "kind": "Content", - "text": ") => void;\n\t\t\turlUploadFinished: (payload: {\n\t\t\t\tmarker: string;\n\t\t\t\tfile: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": ";\n\t\t\t}) => void;\n\t\t\treadAllNotifications: () => void;\n\t\t\tunreadNotification: (payload: " - }, - { - "kind": "Reference", - "text": "Notification", - "canonicalReference": "firefish-js!entities.Notification_2:type" - }, - { - "kind": "Content", - "text": ") => void;\n\t\t\tunreadMention: (payload: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"]) => void;\n\t\t\treadAllUnreadMentions: () => void;\n\t\t\tunreadSpecifiedNote: (payload: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"]) => void;\n\t\t\treadAllUnreadSpecifiedNotes: () => void;\n\t\t\treadAllMessagingMessages: () => void;\n\t\t\tmessagingMessage: (payload: " - }, - { - "kind": "Reference", - "text": "MessagingMessage", - "canonicalReference": "firefish-js!entities.MessagingMessage:type" - }, - { - "kind": "Content", - "text": ") => void;\n\t\t\tunreadMessagingMessage: (payload: " - }, - { - "kind": "Reference", - "text": "MessagingMessage", - "canonicalReference": "firefish-js!entities.MessagingMessage:type" - }, - { - "kind": "Content", - "text": ") => void;\n\t\t\treadAllAntennas: () => void;\n\t\t\tunreadAntenna: (payload: " - }, - { - "kind": "Reference", - "text": "Antenna", - "canonicalReference": "firefish-js!entities.Antenna:type" - }, - { - "kind": "Content", - "text": ") => void;\n\t\t\treadAllAnnouncements: () => void;\n\t\t\treadAllChannels: () => void;\n\t\t\tunreadChannel: (payload: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"]) => void;\n\t\t\tmyTokenRegenerated: () => void;\n\t\t\treversiNoInvites: () => void;\n\t\t\treversiInvited: (payload: " - }, - { - "kind": "Reference", - "text": "FIXME", - "canonicalReference": "firefish-js!~FIXME:type" - }, - { - "kind": "Content", - "text": ") => void;\n\t\t\tsignin: (payload: " - }, - { - "kind": "Reference", - "text": "FIXME", - "canonicalReference": "firefish-js!~FIXME:type" - }, - { - "kind": "Content", - "text": ") => void;\n\t\t\tregistryUpdated: (payload: {\n\t\t\t\tscope?: string[];\n\t\t\t\tkey: string;\n\t\t\t\tvalue: any | null;\n\t\t\t}) => void;\n\t\t\tdriveFileCreated: (payload: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": ") => void;\n\t\t\treadAntenna: (payload: " - }, - { - "kind": "Reference", - "text": "Antenna", - "canonicalReference": "firefish-js!entities.Antenna:type" - }, - { - "kind": "Content", - "text": ") => void;\n\t\t};\n\t\treceives: null;\n\t};\n\thomeTimeline: {\n\t\tparams: null;\n\t\tevents: {\n\t\t\tnote: (payload: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": ") => void;\n\t\t};\n\t\treceives: null;\n\t};\n\tlocalTimeline: {\n\t\tparams: null;\n\t\tevents: {\n\t\t\tnote: (payload: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": ") => void;\n\t\t};\n\t\treceives: null;\n\t};\n\thybridTimeline: {\n\t\tparams: null;\n\t\tevents: {\n\t\t\tnote: (payload: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": ") => void;\n\t\t};\n\t\treceives: null;\n\t};\n\trecommendedTimeline: {\n\t\tparams: null;\n\t\tevents: {\n\t\t\tnote: (payload: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": ") => void;\n\t\t};\n\t\treceives: null;\n\t};\n\tglobalTimeline: {\n\t\tparams: null;\n\t\tevents: {\n\t\t\tnote: (payload: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": ") => void;\n\t\t};\n\t\treceives: null;\n\t};\n\tantenna: {\n\t\tparams: {\n\t\t\tantennaId: " - }, - { - "kind": "Reference", - "text": "Antenna", - "canonicalReference": "firefish-js!entities.Antenna:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tevents: {\n\t\t\tnote: (payload: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": ") => void;\n\t\t};\n\t\treceives: null;\n\t};\n\tmessaging: {\n\t\tparams: {\n\t\t\totherparty?: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"] | null;\n\t\t\tgroup?: " - }, - { - "kind": "Reference", - "text": "UserGroup", - "canonicalReference": "firefish-js!entities.UserGroup:type" - }, - { - "kind": "Content", - "text": "[\"id\"] | null;\n\t\t};\n\t\tevents: {\n\t\t\tmessage: (payload: " - }, - { - "kind": "Reference", - "text": "MessagingMessage", - "canonicalReference": "firefish-js!entities.MessagingMessage:type" - }, - { - "kind": "Content", - "text": ") => void;\n\t\t\tdeleted: (payload: " - }, - { - "kind": "Reference", - "text": "MessagingMessage", - "canonicalReference": "firefish-js!entities.MessagingMessage:type" - }, - { - "kind": "Content", - "text": "[\"id\"]) => void;\n\t\t\tread: (payload: " - }, - { - "kind": "Reference", - "text": "MessagingMessage", - "canonicalReference": "firefish-js!entities.MessagingMessage:type" - }, - { - "kind": "Content", - "text": "[\"id\"][]) => void;\n\t\t\ttypers: (payload: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[]) => void;\n\t\t};\n\t\treceives: {\n\t\t\tread: {\n\t\t\t\tid: " - }, - { - "kind": "Reference", - "text": "MessagingMessage", - "canonicalReference": "firefish-js!entities.MessagingMessage:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\t};\n\t\t};\n\t};\n\tserverStats: {\n\t\tparams: null;\n\t\tevents: {\n\t\t\tstats: (payload: " - }, - { - "kind": "Reference", - "text": "FIXME", - "canonicalReference": "firefish-js!~FIXME:type" - }, - { - "kind": "Content", - "text": ") => void;\n\t\t};\n\t\treceives: {\n\t\t\trequestLog: {\n\t\t\t\tid: string | number;\n\t\t\t\tlength: number;\n\t\t\t};\n\t\t};\n\t};\n\tqueueStats: {\n\t\tparams: null;\n\t\tevents: {\n\t\t\tstats: (payload: " - }, - { - "kind": "Reference", - "text": "FIXME", - "canonicalReference": "firefish-js!~FIXME:type" - }, - { - "kind": "Content", - "text": ") => void;\n\t\t};\n\t\treceives: {\n\t\t\trequestLog: {\n\t\t\t\tid: string | number;\n\t\t\t\tlength: number;\n\t\t\t};\n\t\t};\n\t};\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/streaming.types.ts", - "releaseTag": "Public", - "name": "Channels", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 76 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!Endpoints:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type Endpoints = " - }, - { - "kind": "Content", - "text": "{\n\t\"admin/abuse-user-reports\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/delete-all-files-of-a-user\": {\n\t\treq: {\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"admin/delete-logs\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "NoParams", - "canonicalReference": "firefish-js!~NoParams:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: null;\n\t};\n\t\"admin/get-index-stats\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/get-table-stats\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/invite\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/logs\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/meta\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/reset-password\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/resolve-abuse-user-report\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/resync-chart\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/send-email\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/server-info\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/show-moderation-logs\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/show-user\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/show-users\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/silence-user\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/suspend-user\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/unsilence-user\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/unsuspend-user\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/update-meta\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/vacuum\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/accounts/create\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/ad/create\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/ad/delete\": {\n\t\treq: {\n\t\t\tid: " - }, - { - "kind": "Reference", - "text": "Ad", - "canonicalReference": "firefish-js!entities.Ad:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"admin/ad/list\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/ad/update\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/announcements/create\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/announcements/delete\": {\n\t\treq: {\n\t\t\tid: " - }, - { - "kind": "Reference", - "text": "Announcement", - "canonicalReference": "firefish-js!entities.Announcement:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"admin/announcements/list\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/announcements/update\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/drive/clean-remote-files\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/drive/cleanup\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/drive/files\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/drive/show-file\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/emoji/add\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/emoji/copy\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/emoji/list-remote\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/emoji/list\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/emoji/remove\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/emoji/update\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/federation/delete-all-files\": {\n\t\treq: {\n\t\t\thost: string;\n\t\t};\n\t\tres: null;\n\t};\n\t\"admin/federation/refresh-remote-instance-metadata\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/federation/remove-all-following\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/federation/update-instance\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/moderators/add\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/moderators/remove\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/promo/create\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/queue/clear\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/queue/deliver-delayed\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/queue/inbox-delayed\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/queue/jobs\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/queue/stats\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/relays/add\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/relays/list\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"admin/relays/remove\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\tannouncements: {\n\t\treq: {\n\t\t\tlimit?: number;\n\t\t\twithUnreads?: boolean;\n\t\t\tsinceId?: " - }, - { - "kind": "Reference", - "text": "Announcement", - "canonicalReference": "firefish-js!entities.Announcement:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuntilId?: " - }, - { - "kind": "Reference", - "text": "Announcement", - "canonicalReference": "firefish-js!entities.Announcement:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Announcement", - "canonicalReference": "firefish-js!entities.Announcement:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"antennas/create\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Antenna", - "canonicalReference": "firefish-js!entities.Antenna:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"antennas/delete\": {\n\t\treq: {\n\t\t\tantennaId: " - }, - { - "kind": "Reference", - "text": "Antenna", - "canonicalReference": "firefish-js!entities.Antenna:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"antennas/list\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "NoParams", - "canonicalReference": "firefish-js!~NoParams:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Antenna", - "canonicalReference": "firefish-js!entities.Antenna:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"antennas/notes\": {\n\t\treq: {\n\t\t\tantennaId: " - }, - { - "kind": "Reference", - "text": "Antenna", - "canonicalReference": "firefish-js!entities.Antenna:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tlimit?: number;\n\t\t\tsinceId?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuntilId?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"antennas/show\": {\n\t\treq: {\n\t\t\tantennaId: " - }, - { - "kind": "Reference", - "text": "Antenna", - "canonicalReference": "firefish-js!entities.Antenna:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Antenna", - "canonicalReference": "firefish-js!entities.Antenna:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"antennas/update\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Antenna", - "canonicalReference": "firefish-js!entities.Antenna:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"antennas/mark-read\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Antenna", - "canonicalReference": "firefish-js!entities.Antenna:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"ap/get\": {\n\t\treq: {\n\t\t\turi: string;\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"ap/show\": {\n\t\treq: {\n\t\t\turi: string;\n\t\t};\n\t\tres:\n\t\t\t| {\n\t\t\t\t\ttype: \"Note\";\n\t\t\t\t\tobject: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": ";\n\t\t\t }\n\t\t\t| {\n\t\t\t\t\ttype: \"User\";\n\t\t\t\t\tobject: " - }, - { - "kind": "Reference", - "text": "UserDetailed", - "canonicalReference": "firefish-js!entities.UserDetailed:type" - }, - { - "kind": "Content", - "text": ";\n\t\t\t };\n\t};\n\t\"app/create\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "App", - "canonicalReference": "firefish-js!entities.App:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"app/show\": {\n\t\treq: {\n\t\t\tappId: " - }, - { - "kind": "Reference", - "text": "App", - "canonicalReference": "firefish-js!entities.App:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "App", - "canonicalReference": "firefish-js!entities.App:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"auth/accept\": {\n\t\treq: {\n\t\t\ttoken: string;\n\t\t};\n\t\tres: null;\n\t};\n\t\"auth/session/generate\": {\n\t\treq: {\n\t\t\tappSecret: string;\n\t\t};\n\t\tres: {\n\t\t\ttoken: string;\n\t\t\turl: string;\n\t\t};\n\t};\n\t\"auth/session/show\": {\n\t\treq: {\n\t\t\ttoken: string;\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "AuthSession", - "canonicalReference": "firefish-js!entities.AuthSession:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"auth/session/userkey\": {\n\t\treq: {\n\t\t\tappSecret: string;\n\t\t\ttoken: string;\n\t\t};\n\t\tres: {\n\t\t\taccessToken: string;\n\t\t\tuser: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": ";\n\t\t};\n\t};\n\t\"blocking/create\": {\n\t\treq: {\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "UserDetailed", - "canonicalReference": "firefish-js!entities.UserDetailed:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"blocking/delete\": {\n\t\treq: {\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "UserDetailed", - "canonicalReference": "firefish-js!entities.UserDetailed:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"blocking/list\": {\n\t\treq: {\n\t\t\tlimit?: number;\n\t\t\tsinceId?: " - }, - { - "kind": "Reference", - "text": "Blocking", - "canonicalReference": "firefish-js!entities.Blocking:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuntilId?: " - }, - { - "kind": "Reference", - "text": "Blocking", - "canonicalReference": "firefish-js!entities.Blocking:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Blocking", - "canonicalReference": "firefish-js!entities.Blocking:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"channels/create\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"channels/featured\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"channels/follow\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"channels/followed\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"channels/owned\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"channels/pin-note\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"channels/show\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"channels/timeline\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"channels/unfollow\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"channels/update\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"charts/active-users\": {\n\t\treq: {\n\t\t\tspan: \"day\" | \"hour\";\n\t\t\tlimit?: number;\n\t\t\toffset?: number | null;\n\t\t};\n\t\tres: {\n\t\t\tlocal: {\n\t\t\t\tusers: number[];\n\t\t\t};\n\t\t\tremote: {\n\t\t\t\tusers: number[];\n\t\t\t};\n\t\t};\n\t};\n\t\"charts/drive\": {\n\t\treq: {\n\t\t\tspan: \"day\" | \"hour\";\n\t\t\tlimit?: number;\n\t\t\toffset?: number | null;\n\t\t};\n\t\tres: {\n\t\t\tlocal: {\n\t\t\t\tdecCount: number[];\n\t\t\t\tdecSize: number[];\n\t\t\t\tincCount: number[];\n\t\t\t\tincSize: number[];\n\t\t\t\ttotalCount: number[];\n\t\t\t\ttotalSize: number[];\n\t\t\t};\n\t\t\tremote: {\n\t\t\t\tdecCount: number[];\n\t\t\t\tdecSize: number[];\n\t\t\t\tincCount: number[];\n\t\t\t\tincSize: number[];\n\t\t\t\ttotalCount: number[];\n\t\t\t\ttotalSize: number[];\n\t\t\t};\n\t\t};\n\t};\n\t\"charts/federation\": {\n\t\treq: {\n\t\t\tspan: \"day\" | \"hour\";\n\t\t\tlimit?: number;\n\t\t\toffset?: number | null;\n\t\t};\n\t\tres: {\n\t\t\tinstance: {\n\t\t\t\tdec: number[];\n\t\t\t\tinc: number[];\n\t\t\t\ttotal: number[];\n\t\t\t};\n\t\t};\n\t};\n\t\"charts/hashtag\": {\n\t\treq: {\n\t\t\tspan: \"day\" | \"hour\";\n\t\t\tlimit?: number;\n\t\t\toffset?: number | null;\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"charts/instance\": {\n\t\treq: {\n\t\t\tspan: \"day\" | \"hour\";\n\t\t\tlimit?: number;\n\t\t\toffset?: number | null;\n\t\t\thost: string;\n\t\t};\n\t\tres: {\n\t\t\tdrive: {\n\t\t\t\tdecFiles: number[];\n\t\t\t\tdecUsage: number[];\n\t\t\t\tincFiles: number[];\n\t\t\t\tincUsage: number[];\n\t\t\t\ttotalFiles: number[];\n\t\t\t\ttotalUsage: number[];\n\t\t\t};\n\t\t\tfollowers: {\n\t\t\t\tdec: number[];\n\t\t\t\tinc: number[];\n\t\t\t\ttotal: number[];\n\t\t\t};\n\t\t\tfollowing: {\n\t\t\t\tdec: number[];\n\t\t\t\tinc: number[];\n\t\t\t\ttotal: number[];\n\t\t\t};\n\t\t\tnotes: {\n\t\t\t\tdec: number[];\n\t\t\t\tinc: number[];\n\t\t\t\ttotal: number[];\n\t\t\t\tdiffs: {\n\t\t\t\t\tnormal: number[];\n\t\t\t\t\trenote: number[];\n\t\t\t\t\treply: number[];\n\t\t\t\t};\n\t\t\t};\n\t\t\trequests: {\n\t\t\t\tfailed: number[];\n\t\t\t\treceived: number[];\n\t\t\t\tsucceeded: number[];\n\t\t\t};\n\t\t\tusers: {\n\t\t\t\tdec: number[];\n\t\t\t\tinc: number[];\n\t\t\t\ttotal: number[];\n\t\t\t};\n\t\t};\n\t};\n\t\"charts/network\": {\n\t\treq: {\n\t\t\tspan: \"day\" | \"hour\";\n\t\t\tlimit?: number;\n\t\t\toffset?: number | null;\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"charts/notes\": {\n\t\treq: {\n\t\t\tspan: \"day\" | \"hour\";\n\t\t\tlimit?: number;\n\t\t\toffset?: number | null;\n\t\t};\n\t\tres: {\n\t\t\tlocal: {\n\t\t\t\tdec: number[];\n\t\t\t\tinc: number[];\n\t\t\t\ttotal: number[];\n\t\t\t\tdiffs: {\n\t\t\t\t\tnormal: number[];\n\t\t\t\t\trenote: number[];\n\t\t\t\t\treply: number[];\n\t\t\t\t};\n\t\t\t};\n\t\t\tremote: {\n\t\t\t\tdec: number[];\n\t\t\t\tinc: number[];\n\t\t\t\ttotal: number[];\n\t\t\t\tdiffs: {\n\t\t\t\t\tnormal: number[];\n\t\t\t\t\trenote: number[];\n\t\t\t\t\treply: number[];\n\t\t\t\t};\n\t\t\t};\n\t\t};\n\t};\n\t\"charts/user/drive\": {\n\t\treq: {\n\t\t\tspan: \"day\" | \"hour\";\n\t\t\tlimit?: number;\n\t\t\toffset?: number | null;\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: {\n\t\t\tdecCount: number[];\n\t\t\tdecSize: number[];\n\t\t\tincCount: number[];\n\t\t\tincSize: number[];\n\t\t\ttotalCount: number[];\n\t\t\ttotalSize: number[];\n\t\t};\n\t};\n\t\"charts/user/following\": {\n\t\treq: {\n\t\t\tspan: \"day\" | \"hour\";\n\t\t\tlimit?: number;\n\t\t\toffset?: number | null;\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"charts/user/notes\": {\n\t\treq: {\n\t\t\tspan: \"day\" | \"hour\";\n\t\t\tlimit?: number;\n\t\t\toffset?: number | null;\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: {\n\t\t\tdec: number[];\n\t\t\tinc: number[];\n\t\t\ttotal: number[];\n\t\t\tdiffs: {\n\t\t\t\tnormal: number[];\n\t\t\t\trenote: number[];\n\t\t\t\treply: number[];\n\t\t\t};\n\t\t};\n\t};\n\t\"charts/user/reactions\": {\n\t\treq: {\n\t\t\tspan: \"day\" | \"hour\";\n\t\t\tlimit?: number;\n\t\t\toffset?: number | null;\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"charts/users\": {\n\t\treq: {\n\t\t\tspan: \"day\" | \"hour\";\n\t\t\tlimit?: number;\n\t\t\toffset?: number | null;\n\t\t};\n\t\tres: {\n\t\t\tlocal: {\n\t\t\t\tdec: number[];\n\t\t\t\tinc: number[];\n\t\t\t\ttotal: number[];\n\t\t\t};\n\t\t\tremote: {\n\t\t\t\tdec: number[];\n\t\t\t\tinc: number[];\n\t\t\t\ttotal: number[];\n\t\t\t};\n\t\t};\n\t};\n\t\"clips/add-note\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"clips/create\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"clips/delete\": {\n\t\treq: {\n\t\t\tclipId: " - }, - { - "kind": "Reference", - "text": "Clip", - "canonicalReference": "firefish-js!entities.Clip:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"clips/list\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"clips/notes\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"clips/show\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"clips/update\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\tdrive: {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "NoParams", - "canonicalReference": "firefish-js!~NoParams:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: {\n\t\t\tcapacity: number;\n\t\t\tusage: number;\n\t\t};\n\t};\n\t\"drive/files\": {\n\t\treq: {\n\t\t\tfolderId?: " - }, - { - "kind": "Reference", - "text": "DriveFolder", - "canonicalReference": "firefish-js!entities.DriveFolder:type" - }, - { - "kind": "Content", - "text": "[\"id\"] | null;\n\t\t\ttype?: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": "[\"type\"] | null;\n\t\t\tlimit?: number;\n\t\t\tsinceId?: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuntilId?: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"drive/files/attached-notes\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"drive/files/check-existence\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"drive/files/create\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"drive/files/delete\": {\n\t\treq: {\n\t\t\tfileId: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"drive/files/find-by-hash\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"drive/files/find\": {\n\t\treq: {\n\t\t\tname: string;\n\t\t\tfolderId?: " - }, - { - "kind": "Reference", - "text": "DriveFolder", - "canonicalReference": "firefish-js!entities.DriveFolder:type" - }, - { - "kind": "Content", - "text": "[\"id\"] | null;\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"drive/files/show\": {\n\t\treq: {\n\t\t\tfileId?: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\turl?: string;\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"drive/files/update\": {\n\t\treq: {\n\t\t\tfileId: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tfolderId?: " - }, - { - "kind": "Reference", - "text": "DriveFolder", - "canonicalReference": "firefish-js!entities.DriveFolder:type" - }, - { - "kind": "Content", - "text": "[\"id\"] | null;\n\t\t\tname?: string;\n\t\t\tisSensitive?: boolean;\n\t\t\tcomment?: string | null;\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"drive/files/upload-from-url\": {\n\t\treq: {\n\t\t\turl: string;\n\t\t\tfolderId?: " - }, - { - "kind": "Reference", - "text": "DriveFolder", - "canonicalReference": "firefish-js!entities.DriveFolder:type" - }, - { - "kind": "Content", - "text": "[\"id\"] | null;\n\t\t\tisSensitive?: boolean;\n\t\t\tcomment?: string | null;\n\t\t\tmarker?: string | null;\n\t\t\tforce?: boolean;\n\t\t};\n\t\tres: null;\n\t};\n\t\"drive/folders\": {\n\t\treq: {\n\t\t\tfolderId?: " - }, - { - "kind": "Reference", - "text": "DriveFolder", - "canonicalReference": "firefish-js!entities.DriveFolder:type" - }, - { - "kind": "Content", - "text": "[\"id\"] | null;\n\t\t\tlimit?: number;\n\t\t\tsinceId?: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuntilId?: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "DriveFolder", - "canonicalReference": "firefish-js!entities.DriveFolder:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"drive/folders/create\": {\n\t\treq: {\n\t\t\tname?: string;\n\t\t\tparentId?: " - }, - { - "kind": "Reference", - "text": "DriveFolder", - "canonicalReference": "firefish-js!entities.DriveFolder:type" - }, - { - "kind": "Content", - "text": "[\"id\"] | null;\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "DriveFolder", - "canonicalReference": "firefish-js!entities.DriveFolder:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"drive/folders/delete\": {\n\t\treq: {\n\t\t\tfolderId: " - }, - { - "kind": "Reference", - "text": "DriveFolder", - "canonicalReference": "firefish-js!entities.DriveFolder:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"drive/folders/find\": {\n\t\treq: {\n\t\t\tname: string;\n\t\t\tparentId?: " - }, - { - "kind": "Reference", - "text": "DriveFolder", - "canonicalReference": "firefish-js!entities.DriveFolder:type" - }, - { - "kind": "Content", - "text": "[\"id\"] | null;\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "DriveFolder", - "canonicalReference": "firefish-js!entities.DriveFolder:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"drive/folders/show\": {\n\t\treq: {\n\t\t\tfolderId: " - }, - { - "kind": "Reference", - "text": "DriveFolder", - "canonicalReference": "firefish-js!entities.DriveFolder:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "DriveFolder", - "canonicalReference": "firefish-js!entities.DriveFolder:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"drive/folders/update\": {\n\t\treq: {\n\t\t\tfolderId: " - }, - { - "kind": "Reference", - "text": "DriveFolder", - "canonicalReference": "firefish-js!entities.DriveFolder:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tname?: string;\n\t\t\tparentId?: " - }, - { - "kind": "Reference", - "text": "DriveFolder", - "canonicalReference": "firefish-js!entities.DriveFolder:type" - }, - { - "kind": "Content", - "text": "[\"id\"] | null;\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "DriveFolder", - "canonicalReference": "firefish-js!entities.DriveFolder:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"drive/stream\": {\n\t\treq: {\n\t\t\ttype?: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": "[\"type\"] | null;\n\t\t\tlimit?: number;\n\t\t\tsinceId?: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuntilId?: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\tendpoint: {\n\t\treq: {\n\t\t\tendpoint: string;\n\t\t};\n\t\tres: {\n\t\t\tparams: {\n\t\t\t\tname: string;\n\t\t\t\ttype: string;\n\t\t\t}[];\n\t\t};\n\t};\n\tendpoints: {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "NoParams", - "canonicalReference": "firefish-js!~NoParams:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: string[];\n\t};\n\t\"federation/dns\": {\n\t\treq: {\n\t\t\thost: string;\n\t\t};\n\t\tres: {\n\t\t\ta: string[];\n\t\t\taaaa: string[];\n\t\t\tcname: string[];\n\t\t\ttxt: string[];\n\t\t};\n\t};\n\t\"federation/followers\": {\n\t\treq: {\n\t\t\thost: string;\n\t\t\tlimit?: number;\n\t\t\tsinceId?: " - }, - { - "kind": "Reference", - "text": "Following", - "canonicalReference": "firefish-js!entities.Following:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuntilId?: " - }, - { - "kind": "Reference", - "text": "Following", - "canonicalReference": "firefish-js!entities.Following:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "FollowingFolloweePopulated", - "canonicalReference": "firefish-js!entities.FollowingFolloweePopulated:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"federation/following\": {\n\t\treq: {\n\t\t\thost: string;\n\t\t\tlimit?: number;\n\t\t\tsinceId?: " - }, - { - "kind": "Reference", - "text": "Following", - "canonicalReference": "firefish-js!entities.Following:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuntilId?: " - }, - { - "kind": "Reference", - "text": "Following", - "canonicalReference": "firefish-js!entities.Following:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "FollowingFolloweePopulated", - "canonicalReference": "firefish-js!entities.FollowingFolloweePopulated:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"federation/instances\": {\n\t\treq: {\n\t\t\thost?: string | null;\n\t\t\tblocked?: boolean | null;\n\t\t\tnotResponding?: boolean | null;\n\t\t\tsuspended?: boolean | null;\n\t\t\tfederating?: boolean | null;\n\t\t\tsubscribing?: boolean | null;\n\t\t\tpublishing?: boolean | null;\n\t\t\tlimit?: number;\n\t\t\toffset?: number;\n\t\t\tsort?:\n\t\t\t\t| \"+pubSub\"\n\t\t\t\t| \"-pubSub\"\n\t\t\t\t| \"+notes\"\n\t\t\t\t| \"-notes\"\n\t\t\t\t| \"+users\"\n\t\t\t\t| \"-users\"\n\t\t\t\t| \"+following\"\n\t\t\t\t| \"-following\"\n\t\t\t\t| \"+followers\"\n\t\t\t\t| \"-followers\"\n\t\t\t\t| \"+caughtAt\"\n\t\t\t\t| \"-caughtAt\"\n\t\t\t\t| \"+lastCommunicatedAt\"\n\t\t\t\t| \"-lastCommunicatedAt\"\n\t\t\t\t| \"+driveUsage\"\n\t\t\t\t| \"-driveUsage\"\n\t\t\t\t| \"+driveFiles\"\n\t\t\t\t| \"-driveFiles\";\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Instance", - "canonicalReference": "firefish-js!entities.Instance:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"federation/show-instance\": {\n\t\treq: {\n\t\t\thost: string;\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Instance", - "canonicalReference": "firefish-js!entities.Instance:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"federation/update-remote-user\": {\n\t\treq: {\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"federation/users\": {\n\t\treq: {\n\t\t\thost: string;\n\t\t\tlimit?: number;\n\t\t\tsinceId?: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuntilId?: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "UserDetailed", - "canonicalReference": "firefish-js!entities.UserDetailed:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"following/create\": {\n\t\treq: {\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"following/delete\": {\n\t\treq: {\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"following/requests/accept\": {\n\t\treq: {\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"following/requests/cancel\": {\n\t\treq: {\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"following/requests/list\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "NoParams", - "canonicalReference": "firefish-js!~NoParams:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "FollowRequest", - "canonicalReference": "firefish-js!entities.FollowRequest:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"following/requests/reject\": {\n\t\treq: {\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"gallery/featured\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"gallery/popular\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"gallery/posts\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"gallery/posts/create\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"gallery/posts/delete\": {\n\t\treq: {\n\t\t\tpostId: " - }, - { - "kind": "Reference", - "text": "GalleryPost", - "canonicalReference": "firefish-js!entities.GalleryPost:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"gallery/posts/like\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"gallery/posts/show\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"gallery/posts/unlike\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"gallery/posts/update\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"games/reversi/games\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"games/reversi/games/show\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"games/reversi/games/surrender\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"games/reversi/invitations\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"games/reversi/match\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"games/reversi/match/cancel\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"get-online-users-count\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "NoParams", - "canonicalReference": "firefish-js!~NoParams:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: {\n\t\t\tcount: number;\n\t\t};\n\t};\n\t\"hashtags/list\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"hashtags/search\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"hashtags/show\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"hashtags/trend\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"hashtags/users\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\ti: {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "NoParams", - "canonicalReference": "firefish-js!~NoParams:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/apps\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/authorized-apps\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/change-password\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/delete-account\": {\n\t\treq: {\n\t\t\tpassword: string;\n\t\t};\n\t\tres: null;\n\t};\n\t\"i/export-blocking\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/export-following\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/export-mute\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/export-notes\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/export-user-lists\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/favorites\": {\n\t\treq: {\n\t\t\tlimit?: number;\n\t\t\tsinceId?: " - }, - { - "kind": "Reference", - "text": "NoteFavorite", - "canonicalReference": "firefish-js!entities.NoteFavorite:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuntilId?: " - }, - { - "kind": "Reference", - "text": "NoteFavorite", - "canonicalReference": "firefish-js!entities.NoteFavorite:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "NoteFavorite", - "canonicalReference": "firefish-js!entities.NoteFavorite:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"i/gallery/likes\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/gallery/posts\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/get-word-muted-notes-count\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/import-following\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/import-user-lists\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/move\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/known-as\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/notifications\": {\n\t\treq: {\n\t\t\tlimit?: number;\n\t\t\tsinceId?: " - }, - { - "kind": "Reference", - "text": "Notification", - "canonicalReference": "firefish-js!entities.Notification_2:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuntilId?: " - }, - { - "kind": "Reference", - "text": "Notification", - "canonicalReference": "firefish-js!entities.Notification_2:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tfollowing?: boolean;\n\t\t\tmarkAsRead?: boolean;\n\t\t\tincludeTypes?: " - }, - { - "kind": "Reference", - "text": "Notification", - "canonicalReference": "firefish-js!entities.Notification_2:type" - }, - { - "kind": "Content", - "text": "[\"type\"][];\n\t\t\texcludeTypes?: " - }, - { - "kind": "Reference", - "text": "Notification", - "canonicalReference": "firefish-js!entities.Notification_2:type" - }, - { - "kind": "Content", - "text": "[\"type\"][];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Notification", - "canonicalReference": "firefish-js!entities.Notification_2:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"i/page-likes\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/pages\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/pin\": {\n\t\treq: {\n\t\t\tnoteId: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "MeDetailed", - "canonicalReference": "firefish-js!entities.MeDetailed:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/read-all-messaging-messages\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/read-all-unread-notes\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/read-announcement\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/regenerate-token\": {\n\t\treq: {\n\t\t\tpassword: string;\n\t\t};\n\t\tres: null;\n\t};\n\t\"i/registry/get-all\": {\n\t\treq: {\n\t\t\tscope?: string[];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/registry/get-detail\": {\n\t\treq: {\n\t\t\tkey: string;\n\t\t\tscope?: string[];\n\t\t};\n\t\tres: {\n\t\t\tupdatedAt: " - }, - { - "kind": "Reference", - "text": "DateString", - "canonicalReference": "firefish-js!entities.DateString:type" - }, - { - "kind": "Content", - "text": ";\n\t\t\tvalue: any;\n\t\t};\n\t};\n\t\"i/registry/get\": {\n\t\treq: {\n\t\t\tkey: string;\n\t\t\tscope?: string[];\n\t\t};\n\t\tres: any;\n\t};\n\t\"i/registry/keys-with-type\": {\n\t\treq: {\n\t\t\tscope?: string[];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "<\n\t\t\tstring,\n\t\t\t\"null\" | \"array\" | \"number\" | \"string\" | \"boolean\" | \"object\"\n\t\t>;\n\t};\n\t\"i/registry/keys\": {\n\t\treq: {\n\t\t\tscope?: string[];\n\t\t};\n\t\tres: string[];\n\t};\n\t\"i/registry/remove\": {\n\t\treq: {\n\t\t\tkey: string;\n\t\t\tscope?: string[];\n\t\t};\n\t\tres: null;\n\t};\n\t\"i/registry/scopes\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "NoParams", - "canonicalReference": "firefish-js!~NoParams:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: string[][];\n\t};\n\t\"i/registry/set\": {\n\t\treq: {\n\t\t\tkey: string;\n\t\t\tvalue: any;\n\t\t\tscope?: string[];\n\t\t};\n\t\tres: null;\n\t};\n\t\"i/revoke-token\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/signin-history\": {\n\t\treq: {\n\t\t\tlimit?: number;\n\t\t\tsinceId?: " - }, - { - "kind": "Reference", - "text": "Signin", - "canonicalReference": "firefish-js!entities.Signin:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuntilId?: " - }, - { - "kind": "Reference", - "text": "Signin", - "canonicalReference": "firefish-js!entities.Signin:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Signin", - "canonicalReference": "firefish-js!entities.Signin:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"i/unpin\": {\n\t\treq: {\n\t\t\tnoteId: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "MeDetailed", - "canonicalReference": "firefish-js!entities.MeDetailed:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/update-email\": {\n\t\treq: {\n\t\t\tpassword: string;\n\t\t\temail?: string | null;\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "MeDetailed", - "canonicalReference": "firefish-js!entities.MeDetailed:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/update\": {\n\t\treq: {\n\t\t\tname?: string | null;\n\t\t\tdescription?: string | null;\n\t\t\tlang?: string | null;\n\t\t\tlocation?: string | null;\n\t\t\tbirthday?: string | null;\n\t\t\tavatarId?: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": "[\"id\"] | null;\n\t\t\tbannerId?: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": "[\"id\"] | null;\n\t\t\tfields?: {\n\t\t\t\tname: string;\n\t\t\t\tvalue: string;\n\t\t\t}[];\n\t\t\tisLocked?: boolean;\n\t\t\tisExplorable?: boolean;\n\t\t\thideOnlineStatus?: boolean;\n\t\t\tcarefulBot?: boolean;\n\t\t\tautoAcceptFollowed?: boolean;\n\t\t\tnoCrawle?: boolean;\n\t\t\tpreventAiLearning?: boolean;\n\t\t\tisBot?: boolean;\n\t\t\tisCat?: boolean;\n\t\t\tinjectFeaturedNote?: boolean;\n\t\t\treceiveAnnouncementEmail?: boolean;\n\t\t\talwaysMarkNsfw?: boolean;\n\t\t\tmutedWords?: string[][];\n\t\t\tmutingNotificationTypes?: " - }, - { - "kind": "Reference", - "text": "Notification", - "canonicalReference": "firefish-js!entities.Notification_2:type" - }, - { - "kind": "Content", - "text": "[\"type\"][];\n\t\t\temailNotificationTypes?: string[];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "MeDetailed", - "canonicalReference": "firefish-js!entities.MeDetailed:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/user-group-invites\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/2fa/done\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/2fa/key-done\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/2fa/password-less\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/2fa/register-key\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/2fa/register\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/2fa/update-key\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/2fa/remove-key\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"i/2fa/unregister\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"messaging/history\": {\n\t\treq: {\n\t\t\tlimit?: number;\n\t\t\tgroup?: boolean;\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "MessagingMessage", - "canonicalReference": "firefish-js!entities.MessagingMessage:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"messaging/messages\": {\n\t\treq: {\n\t\t\tuserId?: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tgroupId?: " - }, - { - "kind": "Reference", - "text": "UserGroup", - "canonicalReference": "firefish-js!entities.UserGroup:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tlimit?: number;\n\t\t\tsinceId?: " - }, - { - "kind": "Reference", - "text": "MessagingMessage", - "canonicalReference": "firefish-js!entities.MessagingMessage:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuntilId?: " - }, - { - "kind": "Reference", - "text": "MessagingMessage", - "canonicalReference": "firefish-js!entities.MessagingMessage:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tmarkAsRead?: boolean;\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "MessagingMessage", - "canonicalReference": "firefish-js!entities.MessagingMessage:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"messaging/messages/create\": {\n\t\treq: {\n\t\t\tuserId?: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tgroupId?: " - }, - { - "kind": "Reference", - "text": "UserGroup", - "canonicalReference": "firefish-js!entities.UserGroup:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\ttext?: string;\n\t\t\tfileId?: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "MessagingMessage", - "canonicalReference": "firefish-js!entities.MessagingMessage:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"messaging/messages/delete\": {\n\t\treq: {\n\t\t\tmessageId: " - }, - { - "kind": "Reference", - "text": "MessagingMessage", - "canonicalReference": "firefish-js!entities.MessagingMessage:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"messaging/messages/read\": {\n\t\treq: {\n\t\t\tmessageId: " - }, - { - "kind": "Reference", - "text": "MessagingMessage", - "canonicalReference": "firefish-js!entities.MessagingMessage:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\tmeta: {\n\t\treq: {\n\t\t\tdetail?: boolean;\n\t\t};\n\t\tres: {\n\t\t\t$switch: {\n\t\t\t\t$cases: [\n\t\t\t\t\t[\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tdetail: true;\n\t\t\t\t\t\t},\n\t\t\t\t\t\t" - }, - { - "kind": "Reference", - "text": "DetailedInstanceMetadata", - "canonicalReference": "firefish-js!entities.DetailedInstanceMetadata:type" - }, - { - "kind": "Content", - "text": ",\n\t\t\t\t\t],\n\t\t\t\t\t[\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tdetail: false;\n\t\t\t\t\t\t},\n\t\t\t\t\t\t" - }, - { - "kind": "Reference", - "text": "LiteInstanceMetadata", - "canonicalReference": "firefish-js!entities.LiteInstanceMetadata:type" - }, - { - "kind": "Content", - "text": ",\n\t\t\t\t\t],\n\t\t\t\t\t[\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tdetail: boolean;\n\t\t\t\t\t\t},\n\t\t\t\t\t\t" - }, - { - "kind": "Reference", - "text": "LiteInstanceMetadata", - "canonicalReference": "firefish-js!entities.LiteInstanceMetadata:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "DetailedInstanceMetadata", - "canonicalReference": "firefish-js!entities.DetailedInstanceMetadata:type" - }, - { - "kind": "Content", - "text": ",\n\t\t\t\t\t],\n\t\t\t\t];\n\t\t\t\t$default: " - }, - { - "kind": "Reference", - "text": "LiteInstanceMetadata", - "canonicalReference": "firefish-js!entities.LiteInstanceMetadata:type" - }, - { - "kind": "Content", - "text": ";\n\t\t\t};\n\t\t};\n\t};\n\t\"miauth/gen-token\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"mute/create\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"mute/delete\": {\n\t\treq: {\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"mute/list\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"renote-mute/create\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"renote-mute/delete\": {\n\t\treq: {\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"renote-mute/list\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"my/apps\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\tnotes: {\n\t\treq: {\n\t\t\tlimit?: number;\n\t\t\tsinceId?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuntilId?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"notes/children\": {\n\t\treq: {\n\t\t\tnoteId: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tlimit?: number;\n\t\t\tsinceId?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuntilId?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"notes/clips\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"notes/conversation\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"notes/create\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "NoteSubmitReq", - "canonicalReference": "firefish-js!~NoteSubmitReq:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: {\n\t\t\tcreatedNote: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": ";\n\t\t};\n\t};\n\t\"notes/delete\": {\n\t\treq: {\n\t\t\tnoteId: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"notes/edit\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "NoteSubmitReq", - "canonicalReference": "firefish-js!~NoteSubmitReq:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: {\n\t\t\tcreatedNote: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": ";\n\t\t};\n\t};\n\t\"notes/favorites/create\": {\n\t\treq: {\n\t\t\tnoteId: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"notes/favorites/delete\": {\n\t\treq: {\n\t\t\tnoteId: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"notes/featured\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"notes/global-timeline\": {\n\t\treq: {\n\t\t\tlimit?: number;\n\t\t\tsinceId?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuntilId?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tsinceDate?: number;\n\t\t\tuntilDate?: number;\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"notes/recommended-timeline\": {\n\t\treq: {\n\t\t\tlimit?: number;\n\t\t\tsinceId?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuntilId?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tsinceDate?: number;\n\t\t\tuntilDate?: number;\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"notes/hybrid-timeline\": {\n\t\treq: {\n\t\t\tlimit?: number;\n\t\t\tsinceId?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuntilId?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tsinceDate?: number;\n\t\t\tuntilDate?: number;\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"notes/local-timeline\": {\n\t\treq: {\n\t\t\tlimit?: number;\n\t\t\tsinceId?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuntilId?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tsinceDate?: number;\n\t\t\tuntilDate?: number;\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"notes/mentions\": {\n\t\treq: {\n\t\t\tfollowing?: boolean;\n\t\t\tlimit?: number;\n\t\t\tsinceId?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuntilId?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"notes/polls/recommendation\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"notes/polls/vote\": {\n\t\treq: {\n\t\t\tnoteId: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tchoice: number;\n\t\t};\n\t\tres: null;\n\t};\n\t\"notes/reactions\": {\n\t\treq: {\n\t\t\tnoteId: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\ttype?: string | null;\n\t\t\tlimit?: number;\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "NoteReaction", - "canonicalReference": "firefish-js!entities.NoteReaction:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"notes/reactions/create\": {\n\t\treq: {\n\t\t\tnoteId: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\treaction: string;\n\t\t};\n\t\tres: null;\n\t};\n\t\"notes/reactions/delete\": {\n\t\treq: {\n\t\t\tnoteId: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"notes/renotes\": {\n\t\treq: {\n\t\t\tlimit?: number;\n\t\t\tsinceId?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuntilId?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tnoteId: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"notes/replies\": {\n\t\treq: {\n\t\t\tlimit?: number;\n\t\t\tsinceId?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuntilId?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tnoteId: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"notes/search-by-tag\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"notes/search\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"notes/show\": {\n\t\treq: {\n\t\t\tnoteId: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"notes/state\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"notes/timeline\": {\n\t\treq: {\n\t\t\tlimit?: number;\n\t\t\tsinceId?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuntilId?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tsinceDate?: number;\n\t\t\tuntilDate?: number;\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"notes/unrenote\": {\n\t\treq: {\n\t\t\tnoteId: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"notes/user-list-timeline\": {\n\t\treq: {\n\t\t\tlistId: " - }, - { - "kind": "Reference", - "text": "UserList", - "canonicalReference": "firefish-js!entities.UserList:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tlimit?: number;\n\t\t\tsinceId?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuntilId?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tsinceDate?: number;\n\t\t\tuntilDate?: number;\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"notes/watching/create\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"notes/watching/delete\": {\n\t\treq: {\n\t\t\tnoteId: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"notifications/create\": {\n\t\treq: {\n\t\t\tbody: string;\n\t\t\theader?: string | null;\n\t\t\ticon?: string | null;\n\t\t};\n\t\tres: null;\n\t};\n\t\"notifications/mark-all-as-read\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "NoParams", - "canonicalReference": "firefish-js!~NoParams:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: null;\n\t};\n\t\"notifications/read\": {\n\t\treq: {\n\t\t\tnotificationId: " - }, - { - "kind": "Reference", - "text": "Notification", - "canonicalReference": "firefish-js!entities.Notification_2:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"page-push\": {\n\t\treq: {\n\t\t\tpageId: " - }, - { - "kind": "Reference", - "text": "Page", - "canonicalReference": "firefish-js!entities.Page:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tevent: string;\n\t\t\tvar?: any;\n\t\t};\n\t\tres: null;\n\t};\n\t\"pages/create\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Page", - "canonicalReference": "firefish-js!entities.Page:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"pages/delete\": {\n\t\treq: {\n\t\t\tpageId: " - }, - { - "kind": "Reference", - "text": "Page", - "canonicalReference": "firefish-js!entities.Page:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"pages/featured\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "NoParams", - "canonicalReference": "firefish-js!~NoParams:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Page", - "canonicalReference": "firefish-js!entities.Page:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"pages/like\": {\n\t\treq: {\n\t\t\tpageId: " - }, - { - "kind": "Reference", - "text": "Page", - "canonicalReference": "firefish-js!entities.Page:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"pages/show\": {\n\t\treq: {\n\t\t\tpageId?: " - }, - { - "kind": "Reference", - "text": "Page", - "canonicalReference": "firefish-js!entities.Page:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tname?: string;\n\t\t\tusername?: string;\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Page", - "canonicalReference": "firefish-js!entities.Page:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"pages/unlike\": {\n\t\treq: {\n\t\t\tpageId: " - }, - { - "kind": "Reference", - "text": "Page", - "canonicalReference": "firefish-js!entities.Page:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"pages/update\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: null;\n\t};\n\tping: {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "NoParams", - "canonicalReference": "firefish-js!~NoParams:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: {\n\t\t\tpong: number;\n\t\t};\n\t};\n\t\"pinned-users\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"promo/read\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"request-reset-password\": {\n\t\treq: {\n\t\t\tusername: string;\n\t\t\temail: string;\n\t\t};\n\t\tres: null;\n\t};\n\t\"reset-password\": {\n\t\treq: {\n\t\t\ttoken: string;\n\t\t\tpassword: string;\n\t\t};\n\t\tres: null;\n\t};\n\t\"room/show\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"room/update\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\tstats: {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "NoParams", - "canonicalReference": "firefish-js!~NoParams:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Stats", - "canonicalReference": "firefish-js!entities.Stats:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"server-info\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "NoParams", - "canonicalReference": "firefish-js!~NoParams:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "ServerInfo", - "canonicalReference": "firefish-js!entities.ServerInfo:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"latest-version\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "NoParams", - "canonicalReference": "firefish-js!~NoParams:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"sw/register\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"username/available\": {\n\t\treq: {\n\t\t\tusername: string;\n\t\t};\n\t\tres: {\n\t\t\tavailable: boolean;\n\t\t};\n\t};\n\tusers: {\n\t\treq: {\n\t\t\tlimit?: number;\n\t\t\toffset?: number;\n\t\t\tsort?: " - }, - { - "kind": "Reference", - "text": "UserSorting", - "canonicalReference": "firefish-js!entities.UserSorting:type" - }, - { - "kind": "Content", - "text": ";\n\t\t\torigin?: " - }, - { - "kind": "Reference", - "text": "OriginType", - "canonicalReference": "firefish-js!entities.OriginType:type" - }, - { - "kind": "Content", - "text": ";\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"users/clips\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"users/followers\": {\n\t\treq: {\n\t\t\tuserId?: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tusername?: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"username\"];\n\t\t\thost?: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"host\"] | null;\n\t\t\tlimit?: number;\n\t\t\tsinceId?: " - }, - { - "kind": "Reference", - "text": "Following", - "canonicalReference": "firefish-js!entities.Following:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuntilId?: " - }, - { - "kind": "Reference", - "text": "Following", - "canonicalReference": "firefish-js!entities.Following:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "FollowingFollowerPopulated", - "canonicalReference": "firefish-js!entities.FollowingFollowerPopulated:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"users/following\": {\n\t\treq: {\n\t\t\tuserId?: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tusername?: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"username\"];\n\t\t\thost?: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"host\"] | null;\n\t\t\tlimit?: number;\n\t\t\tsinceId?: " - }, - { - "kind": "Reference", - "text": "Following", - "canonicalReference": "firefish-js!entities.Following:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuntilId?: " - }, - { - "kind": "Reference", - "text": "Following", - "canonicalReference": "firefish-js!entities.Following:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "FollowingFolloweePopulated", - "canonicalReference": "firefish-js!entities.FollowingFolloweePopulated:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"users/gallery/posts\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"users/get-frequently-replied-users\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"users/groups/create\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"users/groups/delete\": {\n\t\treq: {\n\t\t\tgroupId: " - }, - { - "kind": "Reference", - "text": "UserGroup", - "canonicalReference": "firefish-js!entities.UserGroup:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"users/groups/invitations/accept\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"users/groups/invitations/reject\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"users/groups/invite\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"users/groups/joined\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"users/groups/owned\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"users/groups/pull\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"users/groups/show\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"users/groups/transfer\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"users/groups/update\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"users/lists/create\": {\n\t\treq: {\n\t\t\tname: string;\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "UserList", - "canonicalReference": "firefish-js!entities.UserList:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"users/lists/delete\": {\n\t\treq: {\n\t\t\tlistId: " - }, - { - "kind": "Reference", - "text": "UserList", - "canonicalReference": "firefish-js!entities.UserList:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"users/lists/list\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "NoParams", - "canonicalReference": "firefish-js!~NoParams:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "UserList", - "canonicalReference": "firefish-js!entities.UserList:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"users/lists/pull\": {\n\t\treq: {\n\t\t\tlistId: " - }, - { - "kind": "Reference", - "text": "UserList", - "canonicalReference": "firefish-js!entities.UserList:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"users/lists/push\": {\n\t\treq: {\n\t\t\tlistId: " - }, - { - "kind": "Reference", - "text": "UserList", - "canonicalReference": "firefish-js!entities.UserList:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: null;\n\t};\n\t\"users/lists/show\": {\n\t\treq: {\n\t\t\tlistId: " - }, - { - "kind": "Reference", - "text": "UserList", - "canonicalReference": "firefish-js!entities.UserList:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "UserList", - "canonicalReference": "firefish-js!entities.UserList:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"users/lists/update\": {\n\t\treq: {\n\t\t\tlistId: " - }, - { - "kind": "Reference", - "text": "UserList", - "canonicalReference": "firefish-js!entities.UserList:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tname: string;\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "UserList", - "canonicalReference": "firefish-js!entities.UserList:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"users/notes\": {\n\t\treq: {\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tlimit?: number;\n\t\t\tsinceId?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tuntilId?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tsinceDate?: number;\n\t\t\tuntilDate?: number;\n\t\t};\n\t\tres: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[];\n\t};\n\t\"users/pages\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"users/recommendation\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"users/relation\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"users/report-abuse\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"users/search-by-username-and-host\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"users/search\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n\t\"users/show\": {\n\t\treq:\n\t\t\t| " - }, - { - "kind": "Reference", - "text": "ShowUserReq", - "canonicalReference": "firefish-js!~ShowUserReq:type" - }, - { - "kind": "Content", - "text": "\n\t\t\t| {\n\t\t\t\t\tuserIds: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"][];\n\t\t\t };\n\t\tres: {\n\t\t\t$switch: {\n\t\t\t\t$cases: [\n\t\t\t\t\t[\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tuserIds: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"][];\n\t\t\t\t\t\t},\n\t\t\t\t\t\t" - }, - { - "kind": "Reference", - "text": "UserDetailed", - "canonicalReference": "firefish-js!entities.UserDetailed:type" - }, - { - "kind": "Content", - "text": "[],\n\t\t\t\t\t],\n\t\t\t\t];\n\t\t\t\t$default: " - }, - { - "kind": "Reference", - "text": "UserDetailed", - "canonicalReference": "firefish-js!entities.UserDetailed:type" - }, - { - "kind": "Content", - "text": ";\n\t\t\t};\n\t\t};\n\t};\n\t\"users/stats\": {\n\t\treq: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t\tres: " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO:type" - }, - { - "kind": "Content", - "text": ";\n\t};\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/api.types.ts", - "releaseTag": "Public", - "name": "Endpoints", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 1158 - } - }, - { - "kind": "Namespace", - "canonicalReference": "firefish-js!entities:namespace", - "docComment": "", - "excerptTokens": [], - "fileUrlPath": "src/index.ts", - "releaseTag": "None", - "name": "entities", - "preserveMemberOrder": false, - "members": [ - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.Ad:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type Ad = " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO_2:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "Ad", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.Announcement:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type Announcement = " - }, - { - "kind": "Content", - "text": "{\n\tid: " - }, - { - "kind": "Reference", - "text": "ID", - "canonicalReference": "firefish-js!entities.ID:type" - }, - { - "kind": "Content", - "text": ";\n\tcreatedAt: " - }, - { - "kind": "Reference", - "text": "DateString", - "canonicalReference": "firefish-js!entities.DateString:type" - }, - { - "kind": "Content", - "text": ";\n\tupdatedAt: " - }, - { - "kind": "Reference", - "text": "DateString", - "canonicalReference": "firefish-js!entities.DateString:type" - }, - { - "kind": "Content", - "text": " | null;\n\ttext: string;\n\ttitle: string;\n\timageUrl: string | null;\n\tisRead?: boolean;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "Announcement", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.Antenna:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type Antenna = " - }, - { - "kind": "Content", - "text": "{\n\tid: " - }, - { - "kind": "Reference", - "text": "ID", - "canonicalReference": "firefish-js!entities.ID:type" - }, - { - "kind": "Content", - "text": ";\n\tcreatedAt: " - }, - { - "kind": "Reference", - "text": "DateString", - "canonicalReference": "firefish-js!entities.DateString:type" - }, - { - "kind": "Content", - "text": ";\n\tname: string;\n\tkeywords: string[][];\n\texcludeKeywords: string[][];\n\tsrc: \"home\" | \"all\" | \"users\" | \"list\" | \"group\" | \"instances\";\n\tuserListId: " - }, - { - "kind": "Reference", - "text": "ID", - "canonicalReference": "firefish-js!entities.ID:type" - }, - { - "kind": "Content", - "text": " | null;\n\tuserGroupId: " - }, - { - "kind": "Reference", - "text": "ID", - "canonicalReference": "firefish-js!entities.ID:type" - }, - { - "kind": "Content", - "text": " | null;\n\tusers: string[];\n\tinstances: string[];\n\tcaseSensitive: boolean;\n\tnotify: boolean;\n\twithReplies: boolean;\n\twithFile: boolean;\n\thasUnreadNote: boolean;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "Antenna", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 10 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.App:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type App = " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO_2:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "App", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.AuthSession:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type AuthSession = " - }, - { - "kind": "Content", - "text": "{\n\tid: " - }, - { - "kind": "Reference", - "text": "ID", - "canonicalReference": "firefish-js!entities.ID:type" - }, - { - "kind": "Content", - "text": ";\n\tapp: " - }, - { - "kind": "Reference", - "text": "App", - "canonicalReference": "firefish-js!entities.App:type" - }, - { - "kind": "Content", - "text": ";\n\ttoken: string;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "AuthSession", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 6 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.Blocking:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type Blocking = " - }, - { - "kind": "Content", - "text": "{\n\tid: " - }, - { - "kind": "Reference", - "text": "ID", - "canonicalReference": "firefish-js!entities.ID:type" - }, - { - "kind": "Content", - "text": ";\n\tcreatedAt: " - }, - { - "kind": "Reference", - "text": "DateString", - "canonicalReference": "firefish-js!entities.DateString:type" - }, - { - "kind": "Content", - "text": ";\n\tblockeeId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\tblockee: " - }, - { - "kind": "Reference", - "text": "UserDetailed", - "canonicalReference": "firefish-js!entities.UserDetailed:type" - }, - { - "kind": "Content", - "text": ";\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "Blocking", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 10 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.Channel:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type Channel = " - }, - { - "kind": "Content", - "text": "{\n\tid: " - }, - { - "kind": "Reference", - "text": "ID", - "canonicalReference": "firefish-js!entities.ID:type" - }, - { - "kind": "Content", - "text": ";\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "Channel", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.Clip:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type Clip = " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO_2:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "Clip", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.CustomEmoji:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type CustomEmoji = " - }, - { - "kind": "Content", - "text": "{\n\tid: string;\n\tname: string;\n\turl: string;\n\tcategory: string;\n\taliases: string[];\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "CustomEmoji", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.DateString:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type DateString = " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "DateString", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.DetailedInstanceMetadata:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type DetailedInstanceMetadata = " - }, - { - "kind": "Reference", - "text": "LiteInstanceMetadata", - "canonicalReference": "firefish-js!entities.LiteInstanceMetadata:type" - }, - { - "kind": "Content", - "text": " & {\n\tfeatures: " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": ";\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "DetailedInstanceMetadata", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.DriveFile:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type DriveFile = " - }, - { - "kind": "Content", - "text": "{\n\tid: " - }, - { - "kind": "Reference", - "text": "ID", - "canonicalReference": "firefish-js!entities.ID:type" - }, - { - "kind": "Content", - "text": ";\n\tcreatedAt: " - }, - { - "kind": "Reference", - "text": "DateString", - "canonicalReference": "firefish-js!entities.DateString:type" - }, - { - "kind": "Content", - "text": ";\n\tisSensitive: boolean;\n\tname: string;\n\tthumbnailUrl: string;\n\turl: string;\n\ttype: string;\n\tsize: number;\n\tmd5: string;\n\tblurhash: string;\n\tcomment: string | null;\n\tproperties: " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": ";\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "DriveFile", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.DriveFolder:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type DriveFolder = " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO_2:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "DriveFolder", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.Following:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type Following = " - }, - { - "kind": "Content", - "text": "{\n\tid: " - }, - { - "kind": "Reference", - "text": "ID", - "canonicalReference": "firefish-js!entities.ID:type" - }, - { - "kind": "Content", - "text": ";\n\tcreatedAt: " - }, - { - "kind": "Reference", - "text": "DateString", - "canonicalReference": "firefish-js!entities.DateString:type" - }, - { - "kind": "Content", - "text": ";\n\tfollowerId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\tfolloweeId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "Following", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 10 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.FollowingFolloweePopulated:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type FollowingFolloweePopulated = " - }, - { - "kind": "Reference", - "text": "Following", - "canonicalReference": "firefish-js!entities.Following:type" - }, - { - "kind": "Content", - "text": " & {\n\tfollowee: " - }, - { - "kind": "Reference", - "text": "UserDetailed", - "canonicalReference": "firefish-js!entities.UserDetailed:type" - }, - { - "kind": "Content", - "text": ";\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "FollowingFolloweePopulated", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.FollowingFollowerPopulated:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type FollowingFollowerPopulated = " - }, - { - "kind": "Reference", - "text": "Following", - "canonicalReference": "firefish-js!entities.Following:type" - }, - { - "kind": "Content", - "text": " & {\n\tfollower: " - }, - { - "kind": "Reference", - "text": "UserDetailed", - "canonicalReference": "firefish-js!entities.UserDetailed:type" - }, - { - "kind": "Content", - "text": ";\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "FollowingFollowerPopulated", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.FollowRequest:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type FollowRequest = " - }, - { - "kind": "Content", - "text": "{\n\tid: " - }, - { - "kind": "Reference", - "text": "ID", - "canonicalReference": "firefish-js!entities.ID:type" - }, - { - "kind": "Content", - "text": ";\n\tfollower: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": ";\n\tfollowee: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": ";\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "FollowRequest", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.GalleryPost:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type GalleryPost = " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO_2:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "GalleryPost", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.ID:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type ID = " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "ID", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.Instance:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type Instance = " - }, - { - "kind": "Content", - "text": "{\n\tid: " - }, - { - "kind": "Reference", - "text": "ID", - "canonicalReference": "firefish-js!entities.ID:type" - }, - { - "kind": "Content", - "text": ";\n\tcaughtAt: " - }, - { - "kind": "Reference", - "text": "DateString", - "canonicalReference": "firefish-js!entities.DateString:type" - }, - { - "kind": "Content", - "text": ";\n\thost: string;\n\tusersCount: number;\n\tnotesCount: number;\n\tfollowingCount: number;\n\tfollowersCount: number;\n\tdriveUsage: number;\n\tdriveFiles: number;\n\tlatestRequestSentAt: " - }, - { - "kind": "Reference", - "text": "DateString", - "canonicalReference": "firefish-js!entities.DateString:type" - }, - { - "kind": "Content", - "text": " | null;\n\tlatestStatus: number | null;\n\tlatestRequestReceivedAt: " - }, - { - "kind": "Reference", - "text": "DateString", - "canonicalReference": "firefish-js!entities.DateString:type" - }, - { - "kind": "Content", - "text": " | null;\n\tlastCommunicatedAt: " - }, - { - "kind": "Reference", - "text": "DateString", - "canonicalReference": "firefish-js!entities.DateString:type" - }, - { - "kind": "Content", - "text": ";\n\tisNotResponding: boolean;\n\tisSuspended: boolean;\n\tsoftwareName: string | null;\n\tsoftwareVersion: string | null;\n\topenRegistrations: boolean | null;\n\tname: string | null;\n\tdescription: string | null;\n\tmaintainerName: string | null;\n\tmaintainerEmail: string | null;\n\ticonUrl: string | null;\n\tfaviconUrl: string | null;\n\tthemeColor: string | null;\n\tinfoUpdatedAt: " - }, - { - "kind": "Reference", - "text": "DateString", - "canonicalReference": "firefish-js!entities.DateString:type" - }, - { - "kind": "Content", - "text": " | null;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "Instance", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 14 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.InstanceMetadata:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type InstanceMetadata =\n\t" - }, - { - "kind": "Content", - "text": "| " - }, - { - "kind": "Reference", - "text": "LiteInstanceMetadata", - "canonicalReference": "firefish-js!entities.LiteInstanceMetadata:type" - }, - { - "kind": "Content", - "text": "\n\t| " - }, - { - "kind": "Reference", - "text": "DetailedInstanceMetadata", - "canonicalReference": "firefish-js!entities.DetailedInstanceMetadata:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "InstanceMetadata", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.LiteInstanceMetadata:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type LiteInstanceMetadata = " - }, - { - "kind": "Content", - "text": "{\n\tmaintainerName: string | null;\n\tmaintainerEmail: string | null;\n\tversion: string;\n\tname: string | null;\n\turi: string;\n\tdescription: string | null;\n\ttosUrl: string | null;\n\tdisableRegistration: boolean;\n\tdisableLocalTimeline: boolean;\n\tdisableRecommendedTimeline: boolean;\n\tdisableGlobalTimeline: boolean;\n\tdriveCapacityPerLocalUserMb: number;\n\tdriveCapacityPerRemoteUserMb: number;\n\tenableHcaptcha: boolean;\n\thcaptchaSiteKey: string | null;\n\tenableRecaptcha: boolean;\n\trecaptchaSiteKey: string | null;\n\tswPublickey: string | null;\n\tmaxNoteTextLength: number;\n\tenableEmail: boolean;\n\tenableTwitterIntegration: boolean;\n\tenableGithubIntegration: boolean;\n\tenableDiscordIntegration: boolean;\n\tenableServiceWorker: boolean;\n\temojis: " - }, - { - "kind": "Reference", - "text": "CustomEmoji", - "canonicalReference": "firefish-js!entities.CustomEmoji:type" - }, - { - "kind": "Content", - "text": "[];\n\tads: {\n\t\tid: " - }, - { - "kind": "Reference", - "text": "ID", - "canonicalReference": "firefish-js!entities.ID:type" - }, - { - "kind": "Content", - "text": ";\n\t\tratio: number;\n\t\tplace: string;\n\t\turl: string;\n\t\timageUrl: string;\n\t}[];\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "LiteInstanceMetadata", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 6 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.MeDetailed:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type MeDetailed = " - }, - { - "kind": "Reference", - "text": "UserDetailed", - "canonicalReference": "firefish-js!entities.UserDetailed:type" - }, - { - "kind": "Content", - "text": " & {\n\tavatarId: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\tbannerId: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\tautoAcceptFollowed: boolean;\n\talwaysMarkNsfw: boolean;\n\tcarefulBot: boolean;\n\temailNotificationTypes: string[];\n\thasPendingReceivedFollowRequest: boolean;\n\thasUnreadAnnouncement: boolean;\n\thasUnreadAntenna: boolean;\n\thasUnreadChannel: boolean;\n\thasUnreadMentions: boolean;\n\thasUnreadMessagingMessage: boolean;\n\thasUnreadNotification: boolean;\n\thasUnreadSpecifiedNotes: boolean;\n\thideOnlineStatus: boolean;\n\tinjectFeaturedNote: boolean;\n\tintegrations: " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": ";\n\tisDeleted: boolean;\n\tisExplorable: boolean;\n\tmutedWords: string[][];\n\tmutingNotificationTypes: string[];\n\tnoCrawle: boolean;\n\tpreventAiLearning: boolean;\n\treceiveAnnouncementEmail: boolean;\n\tusePasswordLessLogin: boolean;\n\t[other: string]: any;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "MeDetailed", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 9 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.MessagingMessage:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type MessagingMessage = " - }, - { - "kind": "Content", - "text": "{\n\tid: " - }, - { - "kind": "Reference", - "text": "ID", - "canonicalReference": "firefish-js!entities.ID:type" - }, - { - "kind": "Content", - "text": ";\n\tcreatedAt: " - }, - { - "kind": "Reference", - "text": "DateString", - "canonicalReference": "firefish-js!entities.DateString:type" - }, - { - "kind": "Content", - "text": ";\n\tfile: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": " | null;\n\tfileId: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": "[\"id\"] | null;\n\tisRead: boolean;\n\treads: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"][];\n\ttext: string | null;\n\tuser: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": ";\n\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\trecipient?: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": " | null;\n\trecipientId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"] | null;\n\tgroup?: " - }, - { - "kind": "Reference", - "text": "UserGroup", - "canonicalReference": "firefish-js!entities.UserGroup:type" - }, - { - "kind": "Content", - "text": " | null;\n\tgroupId: " - }, - { - "kind": "Reference", - "text": "UserGroup", - "canonicalReference": "firefish-js!entities.UserGroup:type" - }, - { - "kind": "Content", - "text": "[\"id\"] | null;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "MessagingMessage", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 24 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.Note:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type Note = " - }, - { - "kind": "Content", - "text": "{\n\tid: " - }, - { - "kind": "Reference", - "text": "ID", - "canonicalReference": "firefish-js!entities.ID:type" - }, - { - "kind": "Content", - "text": ";\n\tcreatedAt: " - }, - { - "kind": "Reference", - "text": "DateString", - "canonicalReference": "firefish-js!entities.DateString:type" - }, - { - "kind": "Content", - "text": ";\n\ttext: string | null;\n\tcw: string | null;\n\tuser: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": ";\n\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\treply?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": ";\n\treplyId: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\trenote?: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": ";\n\trenoteId: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\tfiles: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": "[];\n\tfileIds: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": "[\"id\"][];\n\tvisibility: \"public\" | \"home\" | \"followers\" | \"specified\";\n\tvisibleUserIds?: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"][];\n\tlocalOnly?: boolean;\n\tchannel?: " - }, - { - "kind": "Reference", - "text": "Channel", - "canonicalReference": "firefish-js!entities.Channel:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\tmyReaction?: string;\n\treactions: " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": ";\n\trenoteCount: number;\n\trepliesCount: number;\n\tpoll?: {\n\t\texpiresAt: " - }, - { - "kind": "Reference", - "text": "DateString", - "canonicalReference": "firefish-js!entities.DateString:type" - }, - { - "kind": "Content", - "text": " | null;\n\t\tmultiple: boolean;\n\t\tchoices: {\n\t\t\tisVoted: boolean;\n\t\t\ttext: string;\n\t\t\tvotes: number;\n\t\t}[];\n\t};\n\temojis: {\n\t\tname: string;\n\t\turl: string;\n\t}[];\n\turi?: string;\n\turl?: string;\n\tupdatedAt?: " - }, - { - "kind": "Reference", - "text": "DateString", - "canonicalReference": "firefish-js!entities.DateString:type" - }, - { - "kind": "Content", - "text": ";\n\tisHidden?: boolean;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "Note", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 32 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.NoteFavorite:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type NoteFavorite = " - }, - { - "kind": "Content", - "text": "{\n\tid: " - }, - { - "kind": "Reference", - "text": "ID", - "canonicalReference": "firefish-js!entities.ID:type" - }, - { - "kind": "Content", - "text": ";\n\tcreatedAt: " - }, - { - "kind": "Reference", - "text": "DateString", - "canonicalReference": "firefish-js!entities.DateString:type" - }, - { - "kind": "Content", - "text": ";\n\tnoteId: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\tnote: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": ";\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "NoteFavorite", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 10 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.NoteReaction:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type NoteReaction = " - }, - { - "kind": "Content", - "text": "{\n\tid: " - }, - { - "kind": "Reference", - "text": "ID", - "canonicalReference": "firefish-js!entities.ID:type" - }, - { - "kind": "Content", - "text": ";\n\tcreatedAt: " - }, - { - "kind": "Reference", - "text": "DateString", - "canonicalReference": "firefish-js!entities.DateString:type" - }, - { - "kind": "Content", - "text": ";\n\tuser: " - }, - { - "kind": "Reference", - "text": "UserLite", - "canonicalReference": "firefish-js!entities.UserLite:type" - }, - { - "kind": "Content", - "text": ";\n\ttype: string;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "NoteReaction", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.Notification:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type Notification = " - }, - { - "kind": "Content", - "text": "{\n\tid: " - }, - { - "kind": "Reference", - "text": "ID", - "canonicalReference": "firefish-js!entities.ID:type" - }, - { - "kind": "Content", - "text": ";\n\tcreatedAt: " - }, - { - "kind": "Reference", - "text": "DateString", - "canonicalReference": "firefish-js!entities.DateString:type" - }, - { - "kind": "Content", - "text": ";\n\tisRead: boolean;\n} & (\n\t| {\n\t\t\ttype: \"reaction\";\n\t\t\treaction: string;\n\t\t\tuser: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": ";\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tnote: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": ";\n\t }\n\t| {\n\t\t\ttype: \"reply\";\n\t\t\tuser: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": ";\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tnote: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": ";\n\t }\n\t| {\n\t\t\ttype: \"renote\";\n\t\t\tuser: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": ";\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tnote: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": ";\n\t }\n\t| {\n\t\t\ttype: \"quote\";\n\t\t\tuser: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": ";\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tnote: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": ";\n\t }\n\t| {\n\t\t\ttype: \"mention\";\n\t\t\tuser: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": ";\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tnote: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": ";\n\t }\n\t| {\n\t\t\ttype: \"pollVote\";\n\t\t\tuser: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": ";\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t\t\tnote: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": ";\n\t }\n\t| {\n\t\t\ttype: \"follow\";\n\t\t\tuser: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": ";\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t }\n\t| {\n\t\t\ttype: \"followRequestAccepted\";\n\t\t\tuser: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": ";\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t }\n\t| {\n\t\t\ttype: \"receiveFollowRequest\";\n\t\t\tuser: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": ";\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t }\n\t| {\n\t\t\ttype: \"groupInvited\";\n\t\t\tinvitation: " - }, - { - "kind": "Reference", - "text": "UserGroup", - "canonicalReference": "firefish-js!entities.UserGroup:type" - }, - { - "kind": "Content", - "text": ";\n\t\t\tuser: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": ";\n\t\t\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\t }\n\t| {\n\t\t\ttype: \"app\";\n\t\t\theader?: string | null;\n\t\t\tbody: string;\n\t\t\ticon?: string | null;\n\t }\n)" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "Notification", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 60 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.OriginType:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type OriginType = " - }, - { - "kind": "Content", - "text": "\"combined\" | \"local\" | \"remote\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "OriginType", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.Page:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type Page = " - }, - { - "kind": "Content", - "text": "{\n\tid: " - }, - { - "kind": "Reference", - "text": "ID", - "canonicalReference": "firefish-js!entities.ID:type" - }, - { - "kind": "Content", - "text": ";\n\tcreatedAt: " - }, - { - "kind": "Reference", - "text": "DateString", - "canonicalReference": "firefish-js!entities.DateString:type" - }, - { - "kind": "Content", - "text": ";\n\tupdatedAt: " - }, - { - "kind": "Reference", - "text": "DateString", - "canonicalReference": "firefish-js!entities.DateString:type" - }, - { - "kind": "Content", - "text": ";\n\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\tuser: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": ";\n\tcontent: " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "[];\n\tvariables: " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "[];\n\ttitle: string;\n\tname: string;\n\tsummary: string | null;\n\thideTitleWhenPinned: boolean;\n\talignCenter: boolean;\n\tfont: string;\n\tscript: string;\n\teyeCatchingImageId: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": "[\"id\"] | null;\n\teyeCatchingImage: " - }, - { - "kind": "Reference", - "text": "DriveFile", - "canonicalReference": "firefish-js!entities.DriveFile:type" - }, - { - "kind": "Content", - "text": " | null;\n\tattachedFiles: any;\n\tlikedCount: number;\n\tisLiked?: boolean;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "Page", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 20 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.PageEvent:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type PageEvent = " - }, - { - "kind": "Content", - "text": "{\n\tpageId: " - }, - { - "kind": "Reference", - "text": "Page", - "canonicalReference": "firefish-js!entities.Page:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\tevent: string;\n\tvar: any;\n\tuserId: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"];\n\tuser: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": ";\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "PageEvent", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.ServerInfo:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type ServerInfo = " - }, - { - "kind": "Content", - "text": "{\n\tmachine: string;\n\tcpu: {\n\t\tmodel: string;\n\t\tcores: number;\n\t};\n\tmem: {\n\t\ttotal: number;\n\t};\n\tfs: {\n\t\ttotal: number;\n\t\tused: number;\n\t};\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "ServerInfo", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.Signin:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type Signin = " - }, - { - "kind": "Content", - "text": "{\n\tid: " - }, - { - "kind": "Reference", - "text": "ID", - "canonicalReference": "firefish-js!entities.ID:type" - }, - { - "kind": "Content", - "text": ";\n\tcreatedAt: " - }, - { - "kind": "Reference", - "text": "DateString", - "canonicalReference": "firefish-js!entities.DateString:type" - }, - { - "kind": "Content", - "text": ";\n\tip: string;\n\theaders: " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": ";\n\tsuccess: boolean;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "Signin", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.Stats:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type Stats = " - }, - { - "kind": "Content", - "text": "{\n\tnotesCount: number;\n\toriginalNotesCount: number;\n\tusersCount: number;\n\toriginalUsersCount: number;\n\tinstances: number;\n\tdriveUsageLocal: number;\n\tdriveUsageRemote: number;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "Stats", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.User:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type User = " - }, - { - "kind": "Reference", - "text": "UserLite", - "canonicalReference": "firefish-js!entities.UserLite:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "UserDetailed", - "canonicalReference": "firefish-js!entities.UserDetailed:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "User", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.UserDetailed:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type UserDetailed = " - }, - { - "kind": "Reference", - "text": "UserLite", - "canonicalReference": "firefish-js!entities.UserLite:type" - }, - { - "kind": "Content", - "text": " & {\n\tbannerBlurhash: string | null;\n\tbannerColor: string | null;\n\tbannerUrl: string | null;\n\tbirthday: string | null;\n\tcreatedAt: " - }, - { - "kind": "Reference", - "text": "DateString", - "canonicalReference": "firefish-js!entities.DateString:type" - }, - { - "kind": "Content", - "text": ";\n\tdescription: string | null;\n\tffVisibility: \"public\" | \"followers\" | \"private\";\n\tfields: {\n\t\tname: string;\n\t\tvalue: string;\n\t}[];\n\tfollowersCount: number;\n\tfollowingCount: number;\n\thasPendingFollowRequestFromYou: boolean;\n\thasPendingFollowRequestToYou: boolean;\n\tisAdmin: boolean;\n\tisBlocked: boolean;\n\tisBlocking: boolean;\n\tisBot: boolean;\n\tisCat: boolean;\n\tisFollowed: boolean;\n\tisFollowing: boolean;\n\tisLocked: boolean;\n\tisModerator: boolean;\n\tisMuted: boolean;\n\tisRenoteMuted: boolean;\n\tisSilenced: boolean;\n\tisSuspended: boolean;\n\tlang: string | null;\n\tlastFetchedAt?: " - }, - { - "kind": "Reference", - "text": "DateString", - "canonicalReference": "firefish-js!entities.DateString:type" - }, - { - "kind": "Content", - "text": ";\n\tlocation: string | null;\n\tnotesCount: number;\n\tpinnedNoteIds: " - }, - { - "kind": "Reference", - "text": "ID", - "canonicalReference": "firefish-js!entities.ID:type" - }, - { - "kind": "Content", - "text": "[];\n\tpinnedNotes: " - }, - { - "kind": "Reference", - "text": "Note", - "canonicalReference": "firefish-js!entities.Note:type" - }, - { - "kind": "Content", - "text": "[];\n\tpinnedPage: " - }, - { - "kind": "Reference", - "text": "Page", - "canonicalReference": "firefish-js!entities.Page:type" - }, - { - "kind": "Content", - "text": " | null;\n\tpinnedPageId: string | null;\n\tpublicReactions: boolean;\n\tsecurityKeys: boolean;\n\ttwoFactorEnabled: boolean;\n\tupdatedAt: " - }, - { - "kind": "Reference", - "text": "DateString", - "canonicalReference": "firefish-js!entities.DateString:type" - }, - { - "kind": "Content", - "text": " | null;\n\turi: string | null;\n\turl: string | null;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "UserDetailed", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 15 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.UserGroup:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type UserGroup = " - }, - { - "kind": "Reference", - "text": "TODO", - "canonicalReference": "firefish-js!~TODO_2:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "UserGroup", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.UserList:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type UserList = " - }, - { - "kind": "Content", - "text": "{\n\tid: " - }, - { - "kind": "Reference", - "text": "ID", - "canonicalReference": "firefish-js!entities.ID:type" - }, - { - "kind": "Content", - "text": ";\n\tcreatedAt: " - }, - { - "kind": "Reference", - "text": "DateString", - "canonicalReference": "firefish-js!entities.DateString:type" - }, - { - "kind": "Content", - "text": ";\n\tname: string;\n\tuserIds: " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "firefish-js!entities.User:type" - }, - { - "kind": "Content", - "text": "[\"id\"][];\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "UserList", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 8 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.UserLite:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type UserLite = " - }, - { - "kind": "Content", - "text": "{\n\tid: " - }, - { - "kind": "Reference", - "text": "ID", - "canonicalReference": "firefish-js!entities.ID:type" - }, - { - "kind": "Content", - "text": ";\n\tusername: string;\n\thost: string | null;\n\tname: string;\n\tonlineStatus: \"online\" | \"active\" | \"offline\" | \"unknown\";\n\tavatarUrl: string;\n\tavatarBlurhash: string;\n\talsoKnownAs: string[];\n\tmovedToUri: any;\n\temojis: {\n\t\tname: string;\n\t\turl: string;\n\t}[];\n\tinstance?: {\n\t\tname: " - }, - { - "kind": "Reference", - "text": "Instance", - "canonicalReference": "firefish-js!entities.Instance:type" - }, - { - "kind": "Content", - "text": "[\"name\"];\n\t\tsoftwareName: " - }, - { - "kind": "Reference", - "text": "Instance", - "canonicalReference": "firefish-js!entities.Instance:type" - }, - { - "kind": "Content", - "text": "[\"softwareName\"];\n\t\tsoftwareVersion: " - }, - { - "kind": "Reference", - "text": "Instance", - "canonicalReference": "firefish-js!entities.Instance:type" - }, - { - "kind": "Content", - "text": "[\"softwareVersion\"];\n\t\ticonUrl: " - }, - { - "kind": "Reference", - "text": "Instance", - "canonicalReference": "firefish-js!entities.Instance:type" - }, - { - "kind": "Content", - "text": "[\"iconUrl\"];\n\t\tfaviconUrl: " - }, - { - "kind": "Reference", - "text": "Instance", - "canonicalReference": "firefish-js!entities.Instance:type" - }, - { - "kind": "Content", - "text": "[\"faviconUrl\"];\n\t\tthemeColor: " - }, - { - "kind": "Reference", - "text": "Instance", - "canonicalReference": "firefish-js!entities.Instance:type" - }, - { - "kind": "Content", - "text": "[\"themeColor\"];\n\t};\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "UserLite", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 16 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "firefish-js!entities.UserSorting:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export declare type UserSorting =\n\t" - }, - { - "kind": "Content", - "text": "| \"+follower\"\n\t| \"-follower\"\n\t| \"+createdAt\"\n\t| \"-createdAt\"\n\t| \"+updatedAt\"\n\t| \"-updatedAt\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "src/entities.ts", - "releaseTag": "Public", - "name": "UserSorting", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ] - }, - { - "kind": "Variable", - "canonicalReference": "firefish-js!ffVisibility:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "ffVisibility: " - }, - { - "kind": "Content", - "text": "readonly [\"public\", \"followers\", \"private\"]" - } - ], - "fileUrlPath": "src/index.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "ffVisibility", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Variable", - "canonicalReference": "firefish-js!mutedNoteReasons:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "mutedNoteReasons: " - }, - { - "kind": "Content", - "text": "readonly [\n\t\"word\",\n\t\"manual\",\n\t\"spam\",\n\t\"other\",\n]" - } - ], - "fileUrlPath": "src/index.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "mutedNoteReasons", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Variable", - "canonicalReference": "firefish-js!noteVisibilities:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "noteVisibilities: " - }, - { - "kind": "Content", - "text": "readonly [\n\t\"public\",\n\t\"home\",\n\t\"followers\",\n\t\"specified\",\n]" - } - ], - "fileUrlPath": "src/index.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "noteVisibilities", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Variable", - "canonicalReference": "firefish-js!notificationTypes:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "notificationTypes: " - }, - { - "kind": "Content", - "text": "readonly [\n\t\"follow\",\n\t\"mention\",\n\t\"reply\",\n\t\"renote\",\n\t\"quote\",\n\t\"reaction\",\n\t\"pollVote\",\n\t\"pollEnded\",\n\t\"receiveFollowRequest\",\n\t\"followRequestAccepted\",\n\t\"groupInvited\",\n\t\"app\",\n]" - } - ], - "fileUrlPath": "src/index.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "notificationTypes", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Variable", - "canonicalReference": "firefish-js!permissions:var", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "permissions: " - }, - { - "kind": "Content", - "text": "string[]" - } - ], - "fileUrlPath": "src/index.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "permissions", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Class", - "canonicalReference": "firefish-js!Stream:class", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "export default class Stream extends " - }, - { - "kind": "Reference", - "text": "EventEmitter", - "canonicalReference": "eventemitter3!EventEmitter.EventEmitter" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "StreamEvents", - "canonicalReference": "firefish-js!~StreamEvents:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": " " - } - ], - "fileUrlPath": "src/streaming.ts", - "releaseTag": "Public", - "isAbstract": false, - "name": "Stream", - "preserveMemberOrder": false, - "members": [ - { - "kind": "Constructor", - "canonicalReference": "firefish-js!Stream:constructor(1)", - "docComment": "/**\n * Constructs a new instance of the `Stream` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(\n\t\torigin: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ",\n\t\tuser: " - }, - { - "kind": "Content", - "text": "{\n\t\t\ttoken: string;\n\t\t} | null" - }, - { - "kind": "Content", - "text": ",\n\t\toptions?: " - }, - { - "kind": "Content", - "text": "{\n\t\t\tWebSocket?: any;\n\t\t}" - }, - { - "kind": "Content", - "text": ",\n\t);" - } - ], - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "origin", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "user", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": false - }, - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": true - } - ] - }, - { - "kind": "Method", - "canonicalReference": "firefish-js!Stream#close:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "close(): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [], - "isOptional": false, - "isAbstract": false, - "name": "close" - }, - { - "kind": "Method", - "canonicalReference": "firefish-js!Stream#disconnectToChannel:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "disconnectToChannel(connection: " - }, - { - "kind": "Reference", - "text": "NonSharedConnection", - "canonicalReference": "firefish-js!~NonSharedConnection:class" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "connection", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "isOptional": false, - "isAbstract": false, - "name": "disconnectToChannel" - }, - { - "kind": "Method", - "canonicalReference": "firefish-js!Stream#removeSharedConnection:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "removeSharedConnection(connection: " - }, - { - "kind": "Reference", - "text": "SharedConnection", - "canonicalReference": "firefish-js!~SharedConnection:class" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "connection", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "isOptional": false, - "isAbstract": false, - "name": "removeSharedConnection" - }, - { - "kind": "Method", - "canonicalReference": "firefish-js!Stream#removeSharedConnectionPool:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "removeSharedConnectionPool(pool: " - }, - { - "kind": "Reference", - "text": "Pool", - "canonicalReference": "firefish-js!~Pool:class" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "pool", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "isOptional": false, - "isAbstract": false, - "name": "removeSharedConnectionPool" - }, - { - "kind": "Method", - "canonicalReference": "firefish-js!Stream#send:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "send(typeOrPayload: " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": ", payload?: " - }, - { - "kind": "Content", - "text": "any" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "typeOrPayload", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "payload", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": true - } - ], - "isOptional": false, - "isAbstract": false, - "name": "send" - }, - { - "kind": "Property", - "canonicalReference": "firefish-js!Stream#state:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "state: " - }, - { - "kind": "Content", - "text": "\"initializing\" | \"reconnecting\" | \"connected\"" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "state", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false, - "isProtected": false, - "isAbstract": false - }, - { - "kind": "Method", - "canonicalReference": "firefish-js!Stream#useChannel:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "useChannel(\n\t\tchannel: " - }, - { - "kind": "Content", - "text": "C" - }, - { - "kind": "Content", - "text": ",\n\t\tparams?: " - }, - { - "kind": "Reference", - "text": "Channels", - "canonicalReference": "firefish-js!Channels:type" - }, - { - "kind": "Content", - "text": "[C][\"params\"]" - }, - { - "kind": "Content", - "text": ",\n\t\tname?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ",\n\t): " - }, - { - "kind": "Reference", - "text": "Connection", - "canonicalReference": "firefish-js!ChannelConnection:class" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Channels", - "canonicalReference": "firefish-js!Channels:type" - }, - { - "kind": "Content", - "text": "[C]>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "typeParameters": [ - { - "typeParameterName": "C", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 15 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "channel", - "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 - }, - "isOptional": false - }, - { - "parameterName": "params", - "parameterTypeTokenRange": { - "startIndex": 6, - "endIndex": 8 - }, - "isOptional": true - }, - { - "parameterName": "name", - "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 - }, - "isOptional": true - } - ], - "isOptional": false, - "isAbstract": false, - "name": "useChannel" - } - ], - "extendsTokenRange": { - "startIndex": 1, - "endIndex": 5 - }, - "implementsTokenRanges": [] - } - ] - } - ] -} diff --git a/packages/firefish-js/etc/firefish-js.api.md b/packages/firefish-js/etc/firefish-js.api.md deleted file mode 100644 index 08a001de27..0000000000 --- a/packages/firefish-js/etc/firefish-js.api.md +++ /dev/null @@ -1,2839 +0,0 @@ -## API Report File for "firefish-js" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { EventEmitter } from 'eventemitter3'; - -// @public (undocumented) -export type Acct = { - username: string; - host: string | null; -}; - -// Warning: (ae-forgotten-export) The symbol "TODO_2" needs to be exported by the entry point index.d.ts -// -// @public (undocumented) -type Ad = TODO_2; - -// @public (undocumented) -type Announcement = { - id: ID; - createdAt: DateString; - updatedAt: DateString | null; - text: string; - title: string; - imageUrl: string | null; - isRead?: boolean; -}; - -// @public (undocumented) -type Antenna = { - id: ID; - createdAt: DateString; - name: string; - keywords: string[][]; - excludeKeywords: string[][]; - src: "home" | "all" | "users" | "list" | "group" | "instances"; - userListId: ID | null; - userGroupId: ID | null; - users: string[]; - instances: string[]; - caseSensitive: boolean; - notify: boolean; - withReplies: boolean; - withFile: boolean; - hasUnreadNote: boolean; -}; - -declare namespace api { - export { - isAPIError, - APIError, - FetchLike, - APIClient - } -} -export { api } - -// @public (undocumented) -class APIClient { - constructor(opts: { - origin: APIClient["origin"]; - credential?: APIClient["credential"]; - fetch?: APIClient["fetch"] | null | undefined; - }); - // (undocumented) - credential: string | null | undefined; - // (undocumented) - fetch: FetchLike; - // (undocumented) - origin: string; - // Warning: (ae-forgotten-export) The symbol "IsCaseMatched" needs to be exported by the entry point index.d.ts - // Warning: (ae-forgotten-export) The symbol "GetCaseResult" needs to be exported by the entry point index.d.ts - // - // (undocumented) - request( - endpoint: E, - params?: P, - credential?: string | null | undefined, - ): Promise< - Endpoints[E]["res"] extends { - $switch: { - $cases: [any, any][]; - $default: any; - }; - } - ? IsCaseMatched extends true - ? GetCaseResult - : IsCaseMatched extends true - ? GetCaseResult - : IsCaseMatched extends true - ? GetCaseResult - : IsCaseMatched extends true - ? GetCaseResult - : IsCaseMatched extends true - ? GetCaseResult - : IsCaseMatched extends true - ? GetCaseResult - : IsCaseMatched extends true - ? GetCaseResult - : IsCaseMatched extends true - ? GetCaseResult - : IsCaseMatched extends true - ? GetCaseResult - : IsCaseMatched extends true - ? GetCaseResult - : Endpoints[E]["res"]["$switch"]["$default"] - : Endpoints[E]["res"] - >; -} - -// @public (undocumented) -type APIError = { - id: string; - code: string; - message: string; - kind: "client" | "server"; - info: Record; -}; - -// @public (undocumented) -type App = TODO_2; - -// @public (undocumented) -type AuthSession = { - id: ID; - app: App; - token: string; -}; - -// @public (undocumented) -type Blocking = { - id: ID; - createdAt: DateString; - blockeeId: User["id"]; - blockee: UserDetailed; -}; - -// @public (undocumented) -type Channel = { - id: ID; -}; - -// Warning: (ae-forgotten-export) The symbol "AnyOf" needs to be exported by the entry point index.d.ts -// -// @public (undocumented) -export abstract class ChannelConnection< - Channel extends AnyOf = any, -> extends EventEmitter { - constructor(stream: Stream, channel: string, name?: string); - // (undocumented) - channel: string; - // (undocumented) - abstract dispose(): void; - // (undocumented) - abstract id: string; - // (undocumented) - inCount: number; - // (undocumented) - name?: string; - // (undocumented) - outCount: number; - // (undocumented) - send( - type: T, - body: Channel["receives"][T], - ): void; - // (undocumented) - protected stream: Stream; -} - -// @public (undocumented) -export type Channels = { - main: { - params: null; - events: { - notification: (payload: Notification_2) => void; - mention: (payload: Note) => void; - reply: (payload: Note) => void; - renote: (payload: Note) => void; - follow: (payload: User) => void; - followed: (payload: User) => void; - unfollow: (payload: User) => void; - meUpdated: (payload: MeDetailed) => void; - pageEvent: (payload: PageEvent) => void; - urlUploadFinished: (payload: { - marker: string; - file: DriveFile; - }) => void; - readAllNotifications: () => void; - unreadNotification: (payload: Notification_2) => void; - unreadMention: (payload: Note["id"]) => void; - readAllUnreadMentions: () => void; - unreadSpecifiedNote: (payload: Note["id"]) => void; - readAllUnreadSpecifiedNotes: () => void; - readAllMessagingMessages: () => void; - messagingMessage: (payload: MessagingMessage) => void; - unreadMessagingMessage: (payload: MessagingMessage) => void; - readAllAntennas: () => void; - unreadAntenna: (payload: Antenna) => void; - readAllAnnouncements: () => void; - readAllChannels: () => void; - unreadChannel: (payload: Note["id"]) => void; - myTokenRegenerated: () => void; - reversiNoInvites: () => void; - reversiInvited: (payload: FIXME) => void; - signin: (payload: FIXME) => void; - registryUpdated: (payload: { - scope?: string[]; - key: string; - value: any | null; - }) => void; - driveFileCreated: (payload: DriveFile) => void; - readAntenna: (payload: Antenna) => void; - }; - receives: null; - }; - homeTimeline: { - params: null; - events: { - note: (payload: Note) => void; - }; - receives: null; - }; - localTimeline: { - params: null; - events: { - note: (payload: Note) => void; - }; - receives: null; - }; - hybridTimeline: { - params: null; - events: { - note: (payload: Note) => void; - }; - receives: null; - }; - recommendedTimeline: { - params: null; - events: { - note: (payload: Note) => void; - }; - receives: null; - }; - globalTimeline: { - params: null; - events: { - note: (payload: Note) => void; - }; - receives: null; - }; - antenna: { - params: { - antennaId: Antenna["id"]; - }; - events: { - note: (payload: Note) => void; - }; - receives: null; - }; - messaging: { - params: { - otherparty?: User["id"] | null; - group?: UserGroup["id"] | null; - }; - events: { - message: (payload: MessagingMessage) => void; - deleted: (payload: MessagingMessage["id"]) => void; - read: (payload: MessagingMessage["id"][]) => void; - typers: (payload: User[]) => void; - }; - receives: { - read: { - id: MessagingMessage["id"]; - }; - }; - }; - serverStats: { - params: null; - events: { - stats: (payload: FIXME) => void; - }; - receives: { - requestLog: { - id: string | number; - length: number; - }; - }; - }; - queueStats: { - params: null; - events: { - stats: (payload: FIXME) => void; - }; - receives: { - requestLog: { - id: string | number; - length: number; - }; - }; - }; -}; - -// @public (undocumented) -type Clip = TODO_2; - -// @public (undocumented) -type CustomEmoji = { - id: string; - name: string; - url: string; - category: string; - aliases: string[]; -}; - -// @public (undocumented) -type DateString = string; - -// @public (undocumented) -type DetailedInstanceMetadata = LiteInstanceMetadata & { - features: Record; -}; - -// @public (undocumented) -type DriveFile = { - id: ID; - createdAt: DateString; - isSensitive: boolean; - name: string; - thumbnailUrl: string; - url: string; - type: string; - size: number; - md5: string; - blurhash: string; - comment: string | null; - properties: Record; -}; - -// @public (undocumented) -type DriveFolder = TODO_2; - -// @public (undocumented) -export type Endpoints = { - "admin/abuse-user-reports": { - req: TODO; - res: TODO; - }; - "admin/delete-all-files-of-a-user": { - req: { - userId: User["id"]; - }; - res: null; - }; - "admin/delete-logs": { - req: NoParams; - res: null; - }; - "admin/get-index-stats": { - req: TODO; - res: TODO; - }; - "admin/get-table-stats": { - req: TODO; - res: TODO; - }; - "admin/invite": { - req: TODO; - res: TODO; - }; - "admin/logs": { - req: TODO; - res: TODO; - }; - "admin/meta": { - req: TODO; - res: TODO; - }; - "admin/reset-password": { - req: TODO; - res: TODO; - }; - "admin/resolve-abuse-user-report": { - req: TODO; - res: TODO; - }; - "admin/resync-chart": { - req: TODO; - res: TODO; - }; - "admin/send-email": { - req: TODO; - res: TODO; - }; - "admin/server-info": { - req: TODO; - res: TODO; - }; - "admin/show-moderation-logs": { - req: TODO; - res: TODO; - }; - "admin/show-user": { - req: TODO; - res: TODO; - }; - "admin/show-users": { - req: TODO; - res: TODO; - }; - "admin/silence-user": { - req: TODO; - res: TODO; - }; - "admin/suspend-user": { - req: TODO; - res: TODO; - }; - "admin/unsilence-user": { - req: TODO; - res: TODO; - }; - "admin/unsuspend-user": { - req: TODO; - res: TODO; - }; - "admin/update-meta": { - req: TODO; - res: TODO; - }; - "admin/vacuum": { - req: TODO; - res: TODO; - }; - "admin/accounts/create": { - req: TODO; - res: TODO; - }; - "admin/ad/create": { - req: TODO; - res: TODO; - }; - "admin/ad/delete": { - req: { - id: Ad["id"]; - }; - res: null; - }; - "admin/ad/list": { - req: TODO; - res: TODO; - }; - "admin/ad/update": { - req: TODO; - res: TODO; - }; - "admin/announcements/create": { - req: TODO; - res: TODO; - }; - "admin/announcements/delete": { - req: { - id: Announcement["id"]; - }; - res: null; - }; - "admin/announcements/list": { - req: TODO; - res: TODO; - }; - "admin/announcements/update": { - req: TODO; - res: TODO; - }; - "admin/drive/clean-remote-files": { - req: TODO; - res: TODO; - }; - "admin/drive/cleanup": { - req: TODO; - res: TODO; - }; - "admin/drive/files": { - req: TODO; - res: TODO; - }; - "admin/drive/show-file": { - req: TODO; - res: TODO; - }; - "admin/emoji/add": { - req: TODO; - res: TODO; - }; - "admin/emoji/copy": { - req: TODO; - res: TODO; - }; - "admin/emoji/list-remote": { - req: TODO; - res: TODO; - }; - "admin/emoji/list": { - req: TODO; - res: TODO; - }; - "admin/emoji/remove": { - req: TODO; - res: TODO; - }; - "admin/emoji/update": { - req: TODO; - res: TODO; - }; - "admin/federation/delete-all-files": { - req: { - host: string; - }; - res: null; - }; - "admin/federation/refresh-remote-instance-metadata": { - req: TODO; - res: TODO; - }; - "admin/federation/remove-all-following": { - req: TODO; - res: TODO; - }; - "admin/federation/update-instance": { - req: TODO; - res: TODO; - }; - "admin/moderators/add": { - req: TODO; - res: TODO; - }; - "admin/moderators/remove": { - req: TODO; - res: TODO; - }; - "admin/promo/create": { - req: TODO; - res: TODO; - }; - "admin/queue/clear": { - req: TODO; - res: TODO; - }; - "admin/queue/deliver-delayed": { - req: TODO; - res: TODO; - }; - "admin/queue/inbox-delayed": { - req: TODO; - res: TODO; - }; - "admin/queue/jobs": { - req: TODO; - res: TODO; - }; - "admin/queue/stats": { - req: TODO; - res: TODO; - }; - "admin/relays/add": { - req: TODO; - res: TODO; - }; - "admin/relays/list": { - req: TODO; - res: TODO; - }; - "admin/relays/remove": { - req: TODO; - res: TODO; - }; - announcements: { - req: { - limit?: number; - withUnreads?: boolean; - sinceId?: Announcement["id"]; - untilId?: Announcement["id"]; - }; - res: Announcement[]; - }; - "antennas/create": { - req: TODO; - res: Antenna; - }; - "antennas/delete": { - req: { - antennaId: Antenna["id"]; - }; - res: null; - }; - "antennas/list": { - req: NoParams; - res: Antenna[]; - }; - "antennas/notes": { - req: { - antennaId: Antenna["id"]; - limit?: number; - sinceId?: Note["id"]; - untilId?: Note["id"]; - }; - res: Note[]; - }; - "antennas/show": { - req: { - antennaId: Antenna["id"]; - }; - res: Antenna; - }; - "antennas/update": { - req: TODO; - res: Antenna; - }; - "antennas/mark-read": { - req: TODO; - res: Antenna; - }; - "ap/get": { - req: { - uri: string; - }; - res: Record; - }; - "ap/show": { - req: { - uri: string; - }; - res: - | { - type: "Note"; - object: Note; - } - | { - type: "User"; - object: UserDetailed; - }; - }; - "app/create": { - req: TODO; - res: App; - }; - "app/show": { - req: { - appId: App["id"]; - }; - res: App; - }; - "auth/accept": { - req: { - token: string; - }; - res: null; - }; - "auth/session/generate": { - req: { - appSecret: string; - }; - res: { - token: string; - url: string; - }; - }; - "auth/session/show": { - req: { - token: string; - }; - res: AuthSession; - }; - "auth/session/userkey": { - req: { - appSecret: string; - token: string; - }; - res: { - accessToken: string; - user: User; - }; - }; - "blocking/create": { - req: { - userId: User["id"]; - }; - res: UserDetailed; - }; - "blocking/delete": { - req: { - userId: User["id"]; - }; - res: UserDetailed; - }; - "blocking/list": { - req: { - limit?: number; - sinceId?: Blocking["id"]; - untilId?: Blocking["id"]; - }; - res: Blocking[]; - }; - "channels/create": { - req: TODO; - res: TODO; - }; - "channels/featured": { - req: TODO; - res: TODO; - }; - "channels/follow": { - req: TODO; - res: TODO; - }; - "channels/followed": { - req: TODO; - res: TODO; - }; - "channels/owned": { - req: TODO; - res: TODO; - }; - "channels/pin-note": { - req: TODO; - res: TODO; - }; - "channels/show": { - req: TODO; - res: TODO; - }; - "channels/timeline": { - req: TODO; - res: TODO; - }; - "channels/unfollow": { - req: TODO; - res: TODO; - }; - "channels/update": { - req: TODO; - res: TODO; - }; - "charts/active-users": { - req: { - span: "day" | "hour"; - limit?: number; - offset?: number | null; - }; - res: { - local: { - users: number[]; - }; - remote: { - users: number[]; - }; - }; - }; - "charts/drive": { - req: { - span: "day" | "hour"; - limit?: number; - offset?: number | null; - }; - res: { - local: { - decCount: number[]; - decSize: number[]; - incCount: number[]; - incSize: number[]; - totalCount: number[]; - totalSize: number[]; - }; - remote: { - decCount: number[]; - decSize: number[]; - incCount: number[]; - incSize: number[]; - totalCount: number[]; - totalSize: number[]; - }; - }; - }; - "charts/federation": { - req: { - span: "day" | "hour"; - limit?: number; - offset?: number | null; - }; - res: { - instance: { - dec: number[]; - inc: number[]; - total: number[]; - }; - }; - }; - "charts/hashtag": { - req: { - span: "day" | "hour"; - limit?: number; - offset?: number | null; - }; - res: TODO; - }; - "charts/instance": { - req: { - span: "day" | "hour"; - limit?: number; - offset?: number | null; - host: string; - }; - res: { - drive: { - decFiles: number[]; - decUsage: number[]; - incFiles: number[]; - incUsage: number[]; - totalFiles: number[]; - totalUsage: number[]; - }; - followers: { - dec: number[]; - inc: number[]; - total: number[]; - }; - following: { - dec: number[]; - inc: number[]; - total: number[]; - }; - notes: { - dec: number[]; - inc: number[]; - total: number[]; - diffs: { - normal: number[]; - renote: number[]; - reply: number[]; - }; - }; - requests: { - failed: number[]; - received: number[]; - succeeded: number[]; - }; - users: { - dec: number[]; - inc: number[]; - total: number[]; - }; - }; - }; - "charts/network": { - req: { - span: "day" | "hour"; - limit?: number; - offset?: number | null; - }; - res: TODO; - }; - "charts/notes": { - req: { - span: "day" | "hour"; - limit?: number; - offset?: number | null; - }; - res: { - local: { - dec: number[]; - inc: number[]; - total: number[]; - diffs: { - normal: number[]; - renote: number[]; - reply: number[]; - }; - }; - remote: { - dec: number[]; - inc: number[]; - total: number[]; - diffs: { - normal: number[]; - renote: number[]; - reply: number[]; - }; - }; - }; - }; - "charts/user/drive": { - req: { - span: "day" | "hour"; - limit?: number; - offset?: number | null; - userId: User["id"]; - }; - res: { - decCount: number[]; - decSize: number[]; - incCount: number[]; - incSize: number[]; - totalCount: number[]; - totalSize: number[]; - }; - }; - "charts/user/following": { - req: { - span: "day" | "hour"; - limit?: number; - offset?: number | null; - userId: User["id"]; - }; - res: TODO; - }; - "charts/user/notes": { - req: { - span: "day" | "hour"; - limit?: number; - offset?: number | null; - userId: User["id"]; - }; - res: { - dec: number[]; - inc: number[]; - total: number[]; - diffs: { - normal: number[]; - renote: number[]; - reply: number[]; - }; - }; - }; - "charts/user/reactions": { - req: { - span: "day" | "hour"; - limit?: number; - offset?: number | null; - userId: User["id"]; - }; - res: TODO; - }; - "charts/users": { - req: { - span: "day" | "hour"; - limit?: number; - offset?: number | null; - }; - res: { - local: { - dec: number[]; - inc: number[]; - total: number[]; - }; - remote: { - dec: number[]; - inc: number[]; - total: number[]; - }; - }; - }; - "clips/add-note": { - req: TODO; - res: TODO; - }; - "clips/create": { - req: TODO; - res: TODO; - }; - "clips/delete": { - req: { - clipId: Clip["id"]; - }; - res: null; - }; - "clips/list": { - req: TODO; - res: TODO; - }; - "clips/notes": { - req: TODO; - res: TODO; - }; - "clips/show": { - req: TODO; - res: TODO; - }; - "clips/update": { - req: TODO; - res: TODO; - }; - drive: { - req: NoParams; - res: { - capacity: number; - usage: number; - }; - }; - "drive/files": { - req: { - folderId?: DriveFolder["id"] | null; - type?: DriveFile["type"] | null; - limit?: number; - sinceId?: DriveFile["id"]; - untilId?: DriveFile["id"]; - }; - res: DriveFile[]; - }; - "drive/files/attached-notes": { - req: TODO; - res: TODO; - }; - "drive/files/check-existence": { - req: TODO; - res: TODO; - }; - "drive/files/create": { - req: TODO; - res: TODO; - }; - "drive/files/delete": { - req: { - fileId: DriveFile["id"]; - }; - res: null; - }; - "drive/files/find-by-hash": { - req: TODO; - res: TODO; - }; - "drive/files/find": { - req: { - name: string; - folderId?: DriveFolder["id"] | null; - }; - res: DriveFile[]; - }; - "drive/files/show": { - req: { - fileId?: DriveFile["id"]; - url?: string; - }; - res: DriveFile; - }; - "drive/files/update": { - req: { - fileId: DriveFile["id"]; - folderId?: DriveFolder["id"] | null; - name?: string; - isSensitive?: boolean; - comment?: string | null; - }; - res: DriveFile; - }; - "drive/files/upload-from-url": { - req: { - url: string; - folderId?: DriveFolder["id"] | null; - isSensitive?: boolean; - comment?: string | null; - marker?: string | null; - force?: boolean; - }; - res: null; - }; - "drive/folders": { - req: { - folderId?: DriveFolder["id"] | null; - limit?: number; - sinceId?: DriveFile["id"]; - untilId?: DriveFile["id"]; - }; - res: DriveFolder[]; - }; - "drive/folders/create": { - req: { - name?: string; - parentId?: DriveFolder["id"] | null; - }; - res: DriveFolder; - }; - "drive/folders/delete": { - req: { - folderId: DriveFolder["id"]; - }; - res: null; - }; - "drive/folders/find": { - req: { - name: string; - parentId?: DriveFolder["id"] | null; - }; - res: DriveFolder[]; - }; - "drive/folders/show": { - req: { - folderId: DriveFolder["id"]; - }; - res: DriveFolder; - }; - "drive/folders/update": { - req: { - folderId: DriveFolder["id"]; - name?: string; - parentId?: DriveFolder["id"] | null; - }; - res: DriveFolder; - }; - "drive/stream": { - req: { - type?: DriveFile["type"] | null; - limit?: number; - sinceId?: DriveFile["id"]; - untilId?: DriveFile["id"]; - }; - res: DriveFile[]; - }; - endpoint: { - req: { - endpoint: string; - }; - res: { - params: { - name: string; - type: string; - }[]; - }; - }; - endpoints: { - req: NoParams; - res: string[]; - }; - "federation/dns": { - req: { - host: string; - }; - res: { - a: string[]; - aaaa: string[]; - cname: string[]; - txt: string[]; - }; - }; - "federation/followers": { - req: { - host: string; - limit?: number; - sinceId?: Following["id"]; - untilId?: Following["id"]; - }; - res: FollowingFolloweePopulated[]; - }; - "federation/following": { - req: { - host: string; - limit?: number; - sinceId?: Following["id"]; - untilId?: Following["id"]; - }; - res: FollowingFolloweePopulated[]; - }; - "federation/instances": { - req: { - host?: string | null; - blocked?: boolean | null; - notResponding?: boolean | null; - suspended?: boolean | null; - federating?: boolean | null; - subscribing?: boolean | null; - publishing?: boolean | null; - limit?: number; - offset?: number; - sort?: - | "+pubSub" - | "-pubSub" - | "+notes" - | "-notes" - | "+users" - | "-users" - | "+following" - | "-following" - | "+followers" - | "-followers" - | "+caughtAt" - | "-caughtAt" - | "+lastCommunicatedAt" - | "-lastCommunicatedAt" - | "+driveUsage" - | "-driveUsage" - | "+driveFiles" - | "-driveFiles"; - }; - res: Instance[]; - }; - "federation/show-instance": { - req: { - host: string; - }; - res: Instance; - }; - "federation/update-remote-user": { - req: { - userId: User["id"]; - }; - res: null; - }; - "federation/users": { - req: { - host: string; - limit?: number; - sinceId?: User["id"]; - untilId?: User["id"]; - }; - res: UserDetailed[]; - }; - "following/create": { - req: { - userId: User["id"]; - }; - res: User; - }; - "following/delete": { - req: { - userId: User["id"]; - }; - res: User; - }; - "following/requests/accept": { - req: { - userId: User["id"]; - }; - res: null; - }; - "following/requests/cancel": { - req: { - userId: User["id"]; - }; - res: User; - }; - "following/requests/list": { - req: NoParams; - res: FollowRequest[]; - }; - "following/requests/reject": { - req: { - userId: User["id"]; - }; - res: null; - }; - "gallery/featured": { - req: TODO; - res: TODO; - }; - "gallery/popular": { - req: TODO; - res: TODO; - }; - "gallery/posts": { - req: TODO; - res: TODO; - }; - "gallery/posts/create": { - req: TODO; - res: TODO; - }; - "gallery/posts/delete": { - req: { - postId: GalleryPost["id"]; - }; - res: null; - }; - "gallery/posts/like": { - req: TODO; - res: TODO; - }; - "gallery/posts/show": { - req: TODO; - res: TODO; - }; - "gallery/posts/unlike": { - req: TODO; - res: TODO; - }; - "gallery/posts/update": { - req: TODO; - res: TODO; - }; - "games/reversi/games": { - req: TODO; - res: TODO; - }; - "games/reversi/games/show": { - req: TODO; - res: TODO; - }; - "games/reversi/games/surrender": { - req: TODO; - res: TODO; - }; - "games/reversi/invitations": { - req: TODO; - res: TODO; - }; - "games/reversi/match": { - req: TODO; - res: TODO; - }; - "games/reversi/match/cancel": { - req: TODO; - res: TODO; - }; - "get-online-users-count": { - req: NoParams; - res: { - count: number; - }; - }; - "hashtags/list": { - req: TODO; - res: TODO; - }; - "hashtags/search": { - req: TODO; - res: TODO; - }; - "hashtags/show": { - req: TODO; - res: TODO; - }; - "hashtags/trend": { - req: TODO; - res: TODO; - }; - "hashtags/users": { - req: TODO; - res: TODO; - }; - i: { - req: NoParams; - res: User; - }; - "i/apps": { - req: TODO; - res: TODO; - }; - "i/authorized-apps": { - req: TODO; - res: TODO; - }; - "i/change-password": { - req: TODO; - res: TODO; - }; - "i/delete-account": { - req: { - password: string; - }; - res: null; - }; - "i/export-blocking": { - req: TODO; - res: TODO; - }; - "i/export-following": { - req: TODO; - res: TODO; - }; - "i/export-mute": { - req: TODO; - res: TODO; - }; - "i/export-notes": { - req: TODO; - res: TODO; - }; - "i/export-user-lists": { - req: TODO; - res: TODO; - }; - "i/favorites": { - req: { - limit?: number; - sinceId?: NoteFavorite["id"]; - untilId?: NoteFavorite["id"]; - }; - res: NoteFavorite[]; - }; - "i/gallery/likes": { - req: TODO; - res: TODO; - }; - "i/gallery/posts": { - req: TODO; - res: TODO; - }; - "i/get-word-muted-notes-count": { - req: TODO; - res: TODO; - }; - "i/import-following": { - req: TODO; - res: TODO; - }; - "i/import-user-lists": { - req: TODO; - res: TODO; - }; - "i/move": { - req: TODO; - res: TODO; - }; - "i/known-as": { - req: TODO; - res: TODO; - }; - "i/notifications": { - req: { - limit?: number; - sinceId?: Notification_2["id"]; - untilId?: Notification_2["id"]; - following?: boolean; - markAsRead?: boolean; - includeTypes?: Notification_2["type"][]; - excludeTypes?: Notification_2["type"][]; - }; - res: Notification_2[]; - }; - "i/page-likes": { - req: TODO; - res: TODO; - }; - "i/pages": { - req: TODO; - res: TODO; - }; - "i/pin": { - req: { - noteId: Note["id"]; - }; - res: MeDetailed; - }; - "i/read-all-messaging-messages": { - req: TODO; - res: TODO; - }; - "i/read-all-unread-notes": { - req: TODO; - res: TODO; - }; - "i/read-announcement": { - req: TODO; - res: TODO; - }; - "i/regenerate-token": { - req: { - password: string; - }; - res: null; - }; - "i/registry/get-all": { - req: { - scope?: string[]; - }; - res: Record; - }; - "i/registry/get-detail": { - req: { - key: string; - scope?: string[]; - }; - res: { - updatedAt: DateString; - value: any; - }; - }; - "i/registry/get": { - req: { - key: string; - scope?: string[]; - }; - res: any; - }; - "i/registry/keys-with-type": { - req: { - scope?: string[]; - }; - res: Record< - string, - "null" | "array" | "number" | "string" | "boolean" | "object" - >; - }; - "i/registry/keys": { - req: { - scope?: string[]; - }; - res: string[]; - }; - "i/registry/remove": { - req: { - key: string; - scope?: string[]; - }; - res: null; - }; - "i/registry/scopes": { - req: NoParams; - res: string[][]; - }; - "i/registry/set": { - req: { - key: string; - value: any; - scope?: string[]; - }; - res: null; - }; - "i/revoke-token": { - req: TODO; - res: TODO; - }; - "i/signin-history": { - req: { - limit?: number; - sinceId?: Signin["id"]; - untilId?: Signin["id"]; - }; - res: Signin[]; - }; - "i/unpin": { - req: { - noteId: Note["id"]; - }; - res: MeDetailed; - }; - "i/update-email": { - req: { - password: string; - email?: string | null; - }; - res: MeDetailed; - }; - "i/update": { - req: { - name?: string | null; - description?: string | null; - lang?: string | null; - location?: string | null; - birthday?: string | null; - avatarId?: DriveFile["id"] | null; - bannerId?: DriveFile["id"] | null; - fields?: { - name: string; - value: string; - }[]; - isLocked?: boolean; - isExplorable?: boolean; - hideOnlineStatus?: boolean; - carefulBot?: boolean; - autoAcceptFollowed?: boolean; - noCrawle?: boolean; - preventAiLearning?: boolean; - isBot?: boolean; - isCat?: boolean; - injectFeaturedNote?: boolean; - receiveAnnouncementEmail?: boolean; - alwaysMarkNsfw?: boolean; - mutedWords?: string[][]; - mutingNotificationTypes?: Notification_2["type"][]; - emailNotificationTypes?: string[]; - }; - res: MeDetailed; - }; - "i/user-group-invites": { - req: TODO; - res: TODO; - }; - "i/2fa/done": { - req: TODO; - res: TODO; - }; - "i/2fa/key-done": { - req: TODO; - res: TODO; - }; - "i/2fa/password-less": { - req: TODO; - res: TODO; - }; - "i/2fa/register-key": { - req: TODO; - res: TODO; - }; - "i/2fa/register": { - req: TODO; - res: TODO; - }; - "i/2fa/update-key": { - req: TODO; - res: TODO; - }; - "i/2fa/remove-key": { - req: TODO; - res: TODO; - }; - "i/2fa/unregister": { - req: TODO; - res: TODO; - }; - "messaging/history": { - req: { - limit?: number; - group?: boolean; - }; - res: MessagingMessage[]; - }; - "messaging/messages": { - req: { - userId?: User["id"]; - groupId?: UserGroup["id"]; - limit?: number; - sinceId?: MessagingMessage["id"]; - untilId?: MessagingMessage["id"]; - markAsRead?: boolean; - }; - res: MessagingMessage[]; - }; - "messaging/messages/create": { - req: { - userId?: User["id"]; - groupId?: UserGroup["id"]; - text?: string; - fileId?: DriveFile["id"]; - }; - res: MessagingMessage; - }; - "messaging/messages/delete": { - req: { - messageId: MessagingMessage["id"]; - }; - res: null; - }; - "messaging/messages/read": { - req: { - messageId: MessagingMessage["id"]; - }; - res: null; - }; - meta: { - req: { - detail?: boolean; - }; - res: { - $switch: { - $cases: [ - [ - { - detail: true; - }, - DetailedInstanceMetadata, - ], - [ - { - detail: false; - }, - LiteInstanceMetadata, - ], - [ - { - detail: boolean; - }, - LiteInstanceMetadata | DetailedInstanceMetadata, - ], - ]; - $default: LiteInstanceMetadata; - }; - }; - }; - "miauth/gen-token": { - req: TODO; - res: TODO; - }; - "mute/create": { - req: TODO; - res: TODO; - }; - "mute/delete": { - req: { - userId: User["id"]; - }; - res: null; - }; - "mute/list": { - req: TODO; - res: TODO; - }; - "renote-mute/create": { - req: TODO; - res: TODO; - }; - "renote-mute/delete": { - req: { - userId: User["id"]; - }; - res: null; - }; - "renote-mute/list": { - req: TODO; - res: TODO; - }; - "my/apps": { - req: TODO; - res: TODO; - }; - notes: { - req: { - limit?: number; - sinceId?: Note["id"]; - untilId?: Note["id"]; - }; - res: Note[]; - }; - "notes/children": { - req: { - noteId: Note["id"]; - limit?: number; - sinceId?: Note["id"]; - untilId?: Note["id"]; - }; - res: Note[]; - }; - "notes/clips": { - req: TODO; - res: TODO; - }; - "notes/conversation": { - req: TODO; - res: TODO; - }; - "notes/create": { - req: NoteSubmitReq; - res: { - createdNote: Note; - }; - }; - "notes/delete": { - req: { - noteId: Note["id"]; - }; - res: null; - }; - "notes/edit": { - req: NoteSubmitReq; - res: { - createdNote: Note; - }; - }; - "notes/favorites/create": { - req: { - noteId: Note["id"]; - }; - res: null; - }; - "notes/favorites/delete": { - req: { - noteId: Note["id"]; - }; - res: null; - }; - "notes/featured": { - req: TODO; - res: Note[]; - }; - "notes/global-timeline": { - req: { - limit?: number; - sinceId?: Note["id"]; - untilId?: Note["id"]; - sinceDate?: number; - untilDate?: number; - }; - res: Note[]; - }; - "notes/recommended-timeline": { - req: { - limit?: number; - sinceId?: Note["id"]; - untilId?: Note["id"]; - sinceDate?: number; - untilDate?: number; - }; - res: Note[]; - }; - "notes/hybrid-timeline": { - req: { - limit?: number; - sinceId?: Note["id"]; - untilId?: Note["id"]; - sinceDate?: number; - untilDate?: number; - }; - res: Note[]; - }; - "notes/local-timeline": { - req: { - limit?: number; - sinceId?: Note["id"]; - untilId?: Note["id"]; - sinceDate?: number; - untilDate?: number; - }; - res: Note[]; - }; - "notes/mentions": { - req: { - following?: boolean; - limit?: number; - sinceId?: Note["id"]; - untilId?: Note["id"]; - }; - res: Note[]; - }; - "notes/polls/recommendation": { - req: TODO; - res: TODO; - }; - "notes/polls/vote": { - req: { - noteId: Note["id"]; - choice: number; - }; - res: null; - }; - "notes/reactions": { - req: { - noteId: Note["id"]; - type?: string | null; - limit?: number; - }; - res: NoteReaction[]; - }; - "notes/reactions/create": { - req: { - noteId: Note["id"]; - reaction: string; - }; - res: null; - }; - "notes/reactions/delete": { - req: { - noteId: Note["id"]; - }; - res: null; - }; - "notes/renotes": { - req: { - limit?: number; - sinceId?: Note["id"]; - untilId?: Note["id"]; - noteId: Note["id"]; - }; - res: Note[]; - }; - "notes/replies": { - req: { - limit?: number; - sinceId?: Note["id"]; - untilId?: Note["id"]; - noteId: Note["id"]; - }; - res: Note[]; - }; - "notes/search-by-tag": { - req: TODO; - res: TODO; - }; - "notes/search": { - req: TODO; - res: TODO; - }; - "notes/show": { - req: { - noteId: Note["id"]; - }; - res: Note; - }; - "notes/state": { - req: TODO; - res: TODO; - }; - "notes/timeline": { - req: { - limit?: number; - sinceId?: Note["id"]; - untilId?: Note["id"]; - sinceDate?: number; - untilDate?: number; - }; - res: Note[]; - }; - "notes/unrenote": { - req: { - noteId: Note["id"]; - }; - res: null; - }; - "notes/user-list-timeline": { - req: { - listId: UserList["id"]; - limit?: number; - sinceId?: Note["id"]; - untilId?: Note["id"]; - sinceDate?: number; - untilDate?: number; - }; - res: Note[]; - }; - "notes/watching/create": { - req: TODO; - res: TODO; - }; - "notes/watching/delete": { - req: { - noteId: Note["id"]; - }; - res: null; - }; - "notifications/create": { - req: { - body: string; - header?: string | null; - icon?: string | null; - }; - res: null; - }; - "notifications/mark-all-as-read": { - req: NoParams; - res: null; - }; - "notifications/read": { - req: { - notificationId: Notification_2["id"]; - }; - res: null; - }; - "page-push": { - req: { - pageId: Page["id"]; - event: string; - var?: any; - }; - res: null; - }; - "pages/create": { - req: TODO; - res: Page; - }; - "pages/delete": { - req: { - pageId: Page["id"]; - }; - res: null; - }; - "pages/featured": { - req: NoParams; - res: Page[]; - }; - "pages/like": { - req: { - pageId: Page["id"]; - }; - res: null; - }; - "pages/show": { - req: { - pageId?: Page["id"]; - name?: string; - username?: string; - }; - res: Page; - }; - "pages/unlike": { - req: { - pageId: Page["id"]; - }; - res: null; - }; - "pages/update": { - req: TODO; - res: null; - }; - ping: { - req: NoParams; - res: { - pong: number; - }; - }; - "pinned-users": { - req: TODO; - res: TODO; - }; - "promo/read": { - req: TODO; - res: TODO; - }; - "request-reset-password": { - req: { - username: string; - email: string; - }; - res: null; - }; - "reset-password": { - req: { - token: string; - password: string; - }; - res: null; - }; - "room/show": { - req: TODO; - res: TODO; - }; - "room/update": { - req: TODO; - res: TODO; - }; - stats: { - req: NoParams; - res: Stats; - }; - "server-info": { - req: NoParams; - res: ServerInfo; - }; - "latest-version": { - req: NoParams; - res: TODO; - }; - "sw/register": { - req: TODO; - res: TODO; - }; - "username/available": { - req: { - username: string; - }; - res: { - available: boolean; - }; - }; - users: { - req: { - limit?: number; - offset?: number; - sort?: UserSorting; - origin?: OriginType; - }; - res: User[]; - }; - "users/clips": { - req: TODO; - res: TODO; - }; - "users/followers": { - req: { - userId?: User["id"]; - username?: User["username"]; - host?: User["host"] | null; - limit?: number; - sinceId?: Following["id"]; - untilId?: Following["id"]; - }; - res: FollowingFollowerPopulated[]; - }; - "users/following": { - req: { - userId?: User["id"]; - username?: User["username"]; - host?: User["host"] | null; - limit?: number; - sinceId?: Following["id"]; - untilId?: Following["id"]; - }; - res: FollowingFolloweePopulated[]; - }; - "users/gallery/posts": { - req: TODO; - res: TODO; - }; - "users/get-frequently-replied-users": { - req: TODO; - res: TODO; - }; - "users/groups/create": { - req: TODO; - res: TODO; - }; - "users/groups/delete": { - req: { - groupId: UserGroup["id"]; - }; - res: null; - }; - "users/groups/invitations/accept": { - req: TODO; - res: TODO; - }; - "users/groups/invitations/reject": { - req: TODO; - res: TODO; - }; - "users/groups/invite": { - req: TODO; - res: TODO; - }; - "users/groups/joined": { - req: TODO; - res: TODO; - }; - "users/groups/owned": { - req: TODO; - res: TODO; - }; - "users/groups/pull": { - req: TODO; - res: TODO; - }; - "users/groups/show": { - req: TODO; - res: TODO; - }; - "users/groups/transfer": { - req: TODO; - res: TODO; - }; - "users/groups/update": { - req: TODO; - res: TODO; - }; - "users/lists/create": { - req: { - name: string; - }; - res: UserList; - }; - "users/lists/delete": { - req: { - listId: UserList["id"]; - }; - res: null; - }; - "users/lists/list": { - req: NoParams; - res: UserList[]; - }; - "users/lists/pull": { - req: { - listId: UserList["id"]; - userId: User["id"]; - }; - res: null; - }; - "users/lists/push": { - req: { - listId: UserList["id"]; - userId: User["id"]; - }; - res: null; - }; - "users/lists/show": { - req: { - listId: UserList["id"]; - }; - res: UserList; - }; - "users/lists/update": { - req: { - listId: UserList["id"]; - name: string; - }; - res: UserList; - }; - "users/notes": { - req: { - userId: User["id"]; - limit?: number; - sinceId?: Note["id"]; - untilId?: Note["id"]; - sinceDate?: number; - untilDate?: number; - }; - res: Note[]; - }; - "users/pages": { - req: TODO; - res: TODO; - }; - "users/recommendation": { - req: TODO; - res: TODO; - }; - "users/relation": { - req: TODO; - res: TODO; - }; - "users/report-abuse": { - req: TODO; - res: TODO; - }; - "users/search-by-username-and-host": { - req: TODO; - res: TODO; - }; - "users/search": { - req: TODO; - res: TODO; - }; - "users/show": { - req: - | ShowUserReq - | { - userIds: User["id"][]; - }; - res: { - $switch: { - $cases: [ - [ - { - userIds: User["id"][]; - }, - UserDetailed[], - ], - ]; - $default: UserDetailed; - }; - }; - }; - "users/stats": { - req: TODO; - res: TODO; - }; -}; - -declare namespace entities { - export { - ID, - DateString, - User, - UserLite, - UserDetailed, - UserGroup, - UserList, - MeDetailed, - DriveFile, - DriveFolder, - GalleryPost, - Note, - NoteReaction, - Notification_2 as Notification, - MessagingMessage, - CustomEmoji, - LiteInstanceMetadata, - DetailedInstanceMetadata, - InstanceMetadata, - ServerInfo, - Stats, - Page, - PageEvent, - Announcement, - Antenna, - App, - AuthSession, - Ad, - Clip, - NoteFavorite, - FollowRequest, - Channel, - Following, - FollowingFolloweePopulated, - FollowingFollowerPopulated, - Blocking, - Instance, - Signin, - UserSorting, - OriginType - } -} -export { entities } - -// @public (undocumented) -type FetchLike = ( - input: string, - init?: { - method?: string; - body?: string; - credentials?: RequestCredentials; - cache?: RequestCache; - }, -) => Promise<{ - status: number; - json(): Promise; -}>; - -// @public (undocumented) -export const ffVisibility: readonly ["public", "followers", "private"]; - -// @public (undocumented) -type Following = { - id: ID; - createdAt: DateString; - followerId: User["id"]; - followeeId: User["id"]; -}; - -// @public (undocumented) -type FollowingFolloweePopulated = Following & { - followee: UserDetailed; -}; - -// @public (undocumented) -type FollowingFollowerPopulated = Following & { - follower: UserDetailed; -}; - -// @public (undocumented) -type FollowRequest = { - id: ID; - follower: User; - followee: User; -}; - -// @public (undocumented) -type GalleryPost = TODO_2; - -// @public (undocumented) -type ID = string; - -// @public (undocumented) -type Instance = { - id: ID; - caughtAt: DateString; - host: string; - usersCount: number; - notesCount: number; - followingCount: number; - followersCount: number; - driveUsage: number; - driveFiles: number; - latestRequestSentAt: DateString | null; - latestStatus: number | null; - latestRequestReceivedAt: DateString | null; - lastCommunicatedAt: DateString; - isNotResponding: boolean; - isSuspended: boolean; - softwareName: string | null; - softwareVersion: string | null; - openRegistrations: boolean | null; - name: string | null; - description: string | null; - maintainerName: string | null; - maintainerEmail: string | null; - iconUrl: string | null; - faviconUrl: string | null; - themeColor: string | null; - infoUpdatedAt: DateString | null; -}; - -// @public (undocumented) -type InstanceMetadata = - | LiteInstanceMetadata - | DetailedInstanceMetadata; - -// @public (undocumented) -function isAPIError(reason: any): reason is APIError; - -// @public (undocumented) -type LiteInstanceMetadata = { - maintainerName: string | null; - maintainerEmail: string | null; - version: string; - name: string | null; - uri: string; - description: string | null; - tosUrl: string | null; - disableRegistration: boolean; - disableLocalTimeline: boolean; - disableRecommendedTimeline: boolean; - disableGlobalTimeline: boolean; - driveCapacityPerLocalUserMb: number; - driveCapacityPerRemoteUserMb: number; - enableHcaptcha: boolean; - hcaptchaSiteKey: string | null; - enableRecaptcha: boolean; - recaptchaSiteKey: string | null; - swPublickey: string | null; - maxNoteTextLength: number; - enableEmail: boolean; - enableTwitterIntegration: boolean; - enableGithubIntegration: boolean; - enableDiscordIntegration: boolean; - enableServiceWorker: boolean; - emojis: CustomEmoji[]; - ads: { - id: ID; - ratio: number; - place: string; - url: string; - imageUrl: string; - }[]; -}; - -// @public (undocumented) -type MeDetailed = UserDetailed & { - avatarId: DriveFile["id"]; - bannerId: DriveFile["id"]; - autoAcceptFollowed: boolean; - alwaysMarkNsfw: boolean; - carefulBot: boolean; - emailNotificationTypes: string[]; - hasPendingReceivedFollowRequest: boolean; - hasUnreadAnnouncement: boolean; - hasUnreadAntenna: boolean; - hasUnreadChannel: boolean; - hasUnreadMentions: boolean; - hasUnreadMessagingMessage: boolean; - hasUnreadNotification: boolean; - hasUnreadSpecifiedNotes: boolean; - hideOnlineStatus: boolean; - injectFeaturedNote: boolean; - integrations: Record; - isDeleted: boolean; - isExplorable: boolean; - mutedWords: string[][]; - mutingNotificationTypes: string[]; - noCrawle: boolean; - preventAiLearning: boolean; - receiveAnnouncementEmail: boolean; - usePasswordLessLogin: boolean; - [other: string]: any; -}; - -// @public (undocumented) -type MessagingMessage = { - id: ID; - createdAt: DateString; - file: DriveFile | null; - fileId: DriveFile["id"] | null; - isRead: boolean; - reads: User["id"][]; - text: string | null; - user: User; - userId: User["id"]; - recipient?: User | null; - recipientId: User["id"] | null; - group?: UserGroup | null; - groupId: UserGroup["id"] | null; -}; - -// @public (undocumented) -export const mutedNoteReasons: readonly [ - "word", - "manual", - "spam", - "other", -]; - -// @public (undocumented) -type Note = { - id: ID; - createdAt: DateString; - text: string | null; - cw: string | null; - user: User; - userId: User["id"]; - reply?: Note; - replyId: Note["id"]; - renote?: Note; - renoteId: Note["id"]; - files: DriveFile[]; - fileIds: DriveFile["id"][]; - visibility: "public" | "home" | "followers" | "specified"; - visibleUserIds?: User["id"][]; - localOnly?: boolean; - channel?: Channel["id"]; - myReaction?: string; - reactions: Record; - renoteCount: number; - repliesCount: number; - poll?: { - expiresAt: DateString | null; - multiple: boolean; - choices: { - isVoted: boolean; - text: string; - votes: number; - }[]; - }; - emojis: { - name: string; - url: string; - }[]; - uri?: string; - url?: string; - updatedAt?: DateString; - isHidden?: boolean; -}; - -// @public (undocumented) -type NoteFavorite = { - id: ID; - createdAt: DateString; - noteId: Note["id"]; - note: Note; -}; - -// @public (undocumented) -type NoteReaction = { - id: ID; - createdAt: DateString; - user: UserLite; - type: string; -}; - -// @public (undocumented) -export const noteVisibilities: readonly [ - "public", - "home", - "followers", - "specified", -]; - -// @public (undocumented) -type Notification_2 = { - id: ID; - createdAt: DateString; - isRead: boolean; -} & ( - | { - type: "reaction"; - reaction: string; - user: User; - userId: User["id"]; - note: Note; - } - | { - type: "reply"; - user: User; - userId: User["id"]; - note: Note; - } - | { - type: "renote"; - user: User; - userId: User["id"]; - note: Note; - } - | { - type: "quote"; - user: User; - userId: User["id"]; - note: Note; - } - | { - type: "mention"; - user: User; - userId: User["id"]; - note: Note; - } - | { - type: "pollVote"; - user: User; - userId: User["id"]; - note: Note; - } - | { - type: "follow"; - user: User; - userId: User["id"]; - } - | { - type: "followRequestAccepted"; - user: User; - userId: User["id"]; - } - | { - type: "receiveFollowRequest"; - user: User; - userId: User["id"]; - } - | { - type: "groupInvited"; - invitation: UserGroup; - user: User; - userId: User["id"]; - } - | { - type: "app"; - header?: string | null; - body: string; - icon?: string | null; - } -); - -// @public (undocumented) -export const notificationTypes: readonly [ - "follow", - "mention", - "reply", - "renote", - "quote", - "reaction", - "pollVote", - "pollEnded", - "receiveFollowRequest", - "followRequestAccepted", - "groupInvited", - "app", -]; - -// @public (undocumented) -type OriginType = "combined" | "local" | "remote"; - -// @public (undocumented) -type Page = { - id: ID; - createdAt: DateString; - updatedAt: DateString; - userId: User["id"]; - user: User; - content: Record[]; - variables: Record[]; - title: string; - name: string; - summary: string | null; - hideTitleWhenPinned: boolean; - alignCenter: boolean; - font: string; - script: string; - eyeCatchingImageId: DriveFile["id"] | null; - eyeCatchingImage: DriveFile | null; - attachedFiles: any; - likedCount: number; - isLiked?: boolean; -}; - -// @public (undocumented) -type PageEvent = { - pageId: Page["id"]; - event: string; - var: any; - userId: User["id"]; - user: User; -}; - -// @public (undocumented) -export const permissions: string[]; - -// @public (undocumented) -type ServerInfo = { - machine: string; - cpu: { - model: string; - cores: number; - }; - mem: { - total: number; - }; - fs: { - total: number; - used: number; - }; -}; - -// @public (undocumented) -type Signin = { - id: ID; - createdAt: DateString; - ip: string; - headers: Record; - success: boolean; -}; - -// @public (undocumented) -type Stats = { - notesCount: number; - originalNotesCount: number; - usersCount: number; - originalUsersCount: number; - instances: number; - driveUsageLocal: number; - driveUsageRemote: number; -}; - -// Warning: (ae-forgotten-export) The symbol "StreamEvents" needs to be exported by the entry point index.d.ts -// -// @public (undocumented) -export class Stream extends EventEmitter { - constructor( - origin: string, - user: { - token: string; - } | null, - options?: { - WebSocket?: any; - }, - ); - // (undocumented) - close(): void; - // Warning: (ae-forgotten-export) The symbol "NonSharedConnection" needs to be exported by the entry point index.d.ts - // - // (undocumented) - disconnectToChannel(connection: NonSharedConnection): void; - // Warning: (ae-forgotten-export) The symbol "SharedConnection" needs to be exported by the entry point index.d.ts - // - // (undocumented) - removeSharedConnection(connection: SharedConnection): void; - // Warning: (ae-forgotten-export) The symbol "Pool" needs to be exported by the entry point index.d.ts - // - // (undocumented) - removeSharedConnectionPool(pool: Pool): void; - // (undocumented) - send(typeOrPayload: any, payload?: any): void; - // (undocumented) - state: "initializing" | "reconnecting" | "connected"; - // (undocumented) - useChannel( - channel: C, - params?: Channels[C]["params"], - name?: string, - ): ChannelConnection; - } - -// @public (undocumented) -type User = UserLite | UserDetailed; - -// @public (undocumented) -type UserDetailed = UserLite & { - bannerBlurhash: string | null; - bannerColor: string | null; - bannerUrl: string | null; - birthday: string | null; - createdAt: DateString; - description: string | null; - ffVisibility: "public" | "followers" | "private"; - fields: { - name: string; - value: string; - }[]; - followersCount: number; - followingCount: number; - hasPendingFollowRequestFromYou: boolean; - hasPendingFollowRequestToYou: boolean; - isAdmin: boolean; - isBlocked: boolean; - isBlocking: boolean; - isBot: boolean; - isCat: boolean; - isFollowed: boolean; - isFollowing: boolean; - isLocked: boolean; - isModerator: boolean; - isMuted: boolean; - isRenoteMuted: boolean; - isSilenced: boolean; - isSuspended: boolean; - lang: string | null; - lastFetchedAt?: DateString; - location: string | null; - notesCount: number; - pinnedNoteIds: ID[]; - pinnedNotes: Note[]; - pinnedPage: Page | null; - pinnedPageId: string | null; - publicReactions: boolean; - securityKeys: boolean; - twoFactorEnabled: boolean; - updatedAt: DateString | null; - uri: string | null; - url: string | null; -}; - -// @public (undocumented) -type UserGroup = TODO_2; - -// @public (undocumented) -type UserList = { - id: ID; - createdAt: DateString; - name: string; - userIds: User["id"][]; -}; - -// @public (undocumented) -type UserLite = { - id: ID; - username: string; - host: string | null; - name: string; - onlineStatus: "online" | "active" | "offline" | "unknown"; - avatarUrl: string; - avatarBlurhash: string; - alsoKnownAs: string[]; - movedToUri: any; - emojis: { - name: string; - url: string; - }[]; - instance?: { - name: Instance["name"]; - softwareName: Instance["softwareName"]; - softwareVersion: Instance["softwareVersion"]; - iconUrl: Instance["iconUrl"]; - faviconUrl: Instance["faviconUrl"]; - themeColor: Instance["themeColor"]; - }; -}; - -// @public (undocumented) -type UserSorting = - | "+follower" - | "-follower" - | "+createdAt" - | "-createdAt" - | "+updatedAt" - | "-updatedAt"; - -// Warnings were encountered during analysis: -// -// src/api.types.ts:80:37 - (ae-forgotten-export) The symbol "TODO" needs to be exported by the entry point index.d.ts -// src/api.types.ts:83:28 - (ae-forgotten-export) The symbol "NoParams" needs to be exported by the entry point index.d.ts -// src/api.types.ts:853:5 - (ae-forgotten-export) The symbol "NoteSubmitReq" needs to be exported by the entry point index.d.ts -// src/api.types.ts:1094:3 - (ae-forgotten-export) The symbol "ShowUserReq" needs to be exported by the entry point index.d.ts -// src/streaming.types.ts:56:18 - (ae-forgotten-export) The symbol "FIXME" needs to be exported by the entry point index.d.ts - -// (No @packageDocumentation comment for this package) - -``` diff --git a/packages/firefish-js/markdown/firefish-js.acct.md b/packages/firefish-js/markdown/firefish-js.acct.md deleted file mode 100644 index 6779aed150..0000000000 --- a/packages/firefish-js/markdown/firefish-js.acct.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [Acct](./firefish-js.acct.md) - -## Acct type - -**Signature:** - -```typescript -export declare type Acct = { - username: string; - host: string | null; -}; -``` diff --git a/packages/firefish-js/markdown/firefish-js.api.apiclient._constructor_.md b/packages/firefish-js/markdown/firefish-js.api.apiclient._constructor_.md deleted file mode 100644 index f9af10bc40..0000000000 --- a/packages/firefish-js/markdown/firefish-js.api.apiclient._constructor_.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [api](./firefish-js.api.md) > [APIClient](./firefish-js.api.apiclient.md) > [(constructor)](./firefish-js.api.apiclient._constructor_.md) - -## api.APIClient.(constructor) - -Constructs a new instance of the `APIClient` class - -**Signature:** - -```typescript -constructor(opts: { - origin: APIClient["origin"]; - credential?: APIClient["credential"]; - fetch?: APIClient["fetch"] | null | undefined; - }); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| opts | { origin: [APIClient](./firefish-js.api.apiclient.md)\["origin"\]; credential?: [APIClient](./firefish-js.api.apiclient.md)\["credential"\]; fetch?: [APIClient](./firefish-js.api.apiclient.md)\["fetch"\] \| null \| undefined; } | | - diff --git a/packages/firefish-js/markdown/firefish-js.api.apiclient.credential.md b/packages/firefish-js/markdown/firefish-js.api.apiclient.credential.md deleted file mode 100644 index 323203aac1..0000000000 --- a/packages/firefish-js/markdown/firefish-js.api.apiclient.credential.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [api](./firefish-js.api.md) > [APIClient](./firefish-js.api.apiclient.md) > [credential](./firefish-js.api.apiclient.credential.md) - -## api.APIClient.credential property - -**Signature:** - -```typescript -credential: string | null | undefined; -``` diff --git a/packages/firefish-js/markdown/firefish-js.api.apiclient.fetch.md b/packages/firefish-js/markdown/firefish-js.api.apiclient.fetch.md deleted file mode 100644 index ee2ad9b8de..0000000000 --- a/packages/firefish-js/markdown/firefish-js.api.apiclient.fetch.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [api](./firefish-js.api.md) > [APIClient](./firefish-js.api.apiclient.md) > [fetch](./firefish-js.api.apiclient.fetch.md) - -## api.APIClient.fetch property - -**Signature:** - -```typescript -fetch: FetchLike; -``` diff --git a/packages/firefish-js/markdown/firefish-js.api.apiclient.md b/packages/firefish-js/markdown/firefish-js.api.apiclient.md deleted file mode 100644 index 077e8f2957..0000000000 --- a/packages/firefish-js/markdown/firefish-js.api.apiclient.md +++ /dev/null @@ -1,32 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [api](./firefish-js.api.md) > [APIClient](./firefish-js.api.apiclient.md) - -## api.APIClient class - -**Signature:** - -```typescript -export declare class APIClient -``` - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(opts)](./firefish-js.api.apiclient._constructor_.md) | | Constructs a new instance of the APIClient class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [credential](./firefish-js.api.apiclient.credential.md) | | string \| null \| undefined | | -| [fetch](./firefish-js.api.apiclient.fetch.md) | | [FetchLike](./firefish-js.api.fetchlike.md) | | -| [origin](./firefish-js.api.apiclient.origin.md) | | string | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [request(endpoint, params, credential)](./firefish-js.api.apiclient.request.md) | | | - diff --git a/packages/firefish-js/markdown/firefish-js.api.apiclient.origin.md b/packages/firefish-js/markdown/firefish-js.api.apiclient.origin.md deleted file mode 100644 index 74eff2e1fd..0000000000 --- a/packages/firefish-js/markdown/firefish-js.api.apiclient.origin.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [api](./firefish-js.api.md) > [APIClient](./firefish-js.api.apiclient.md) > [origin](./firefish-js.api.apiclient.origin.md) - -## api.APIClient.origin property - -**Signature:** - -```typescript -origin: string; -``` diff --git a/packages/firefish-js/markdown/firefish-js.api.apiclient.request.md b/packages/firefish-js/markdown/firefish-js.api.apiclient.request.md deleted file mode 100644 index 1d387fb33e..0000000000 --- a/packages/firefish-js/markdown/firefish-js.api.apiclient.request.md +++ /dev/null @@ -1,57 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [api](./firefish-js.api.md) > [APIClient](./firefish-js.api.apiclient.md) > [request](./firefish-js.api.apiclient.request.md) - -## api.APIClient.request() method - -**Signature:** - -```typescript -request( - endpoint: E, - params?: P, - credential?: string | null | undefined, - ): Promise< - Endpoints[E]["res"] extends { - $switch: { - $cases: [any, any][]; - $default: any; - }; - } - ? IsCaseMatched extends true - ? GetCaseResult - : IsCaseMatched extends true - ? GetCaseResult - : IsCaseMatched extends true - ? GetCaseResult - : IsCaseMatched extends true - ? GetCaseResult - : IsCaseMatched extends true - ? GetCaseResult - : IsCaseMatched extends true - ? GetCaseResult - : IsCaseMatched extends true - ? GetCaseResult - : IsCaseMatched extends true - ? GetCaseResult - : IsCaseMatched extends true - ? GetCaseResult - : IsCaseMatched extends true - ? GetCaseResult - : Endpoints[E]["res"]["$switch"]["$default"] - : Endpoints[E]["res"] - >; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| endpoint | E | | -| params | P | _(Optional)_ | -| credential | string \| null \| undefined | _(Optional)_ | - -**Returns:** - -Promise< [Endpoints](./firefish-js.endpoints.md)\[E\]\["res"\] extends { $switch: { $cases: \[any, any\]\[\]; $default: any; }; } ? IsCaseMatched<E, P, 0> extends true ? GetCaseResult<E, P, 0> : IsCaseMatched<E, P, 1> extends true ? GetCaseResult<E, P, 1> : IsCaseMatched<E, P, 2> extends true ? GetCaseResult<E, P, 2> : IsCaseMatched<E, P, 3> extends true ? GetCaseResult<E, P, 3> : IsCaseMatched<E, P, 4> extends true ? GetCaseResult<E, P, 4> : IsCaseMatched<E, P, 5> extends true ? GetCaseResult<E, P, 5> : IsCaseMatched<E, P, 6> extends true ? GetCaseResult<E, P, 6> : IsCaseMatched<E, P, 7> extends true ? GetCaseResult<E, P, 7> : IsCaseMatched<E, P, 8> extends true ? GetCaseResult<E, P, 8> : IsCaseMatched<E, P, 9> extends true ? GetCaseResult<E, P, 9> : [Endpoints](./firefish-js.endpoints.md)\[E\]\["res"\]\["$switch"\]\["$default"\] : [Endpoints](./firefish-js.endpoints.md)\[E\]\["res"\] > - diff --git a/packages/firefish-js/markdown/firefish-js.api.apierror.md b/packages/firefish-js/markdown/firefish-js.api.apierror.md deleted file mode 100644 index 7eb3bb2d80..0000000000 --- a/packages/firefish-js/markdown/firefish-js.api.apierror.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [api](./firefish-js.api.md) > [APIError](./firefish-js.api.apierror.md) - -## api.APIError type - -**Signature:** - -```typescript -export declare type APIError = { - id: string; - code: string; - message: string; - kind: "client" | "server"; - info: Record; -}; -``` diff --git a/packages/firefish-js/markdown/firefish-js.api.fetchlike.md b/packages/firefish-js/markdown/firefish-js.api.fetchlike.md deleted file mode 100644 index 8edc80de29..0000000000 --- a/packages/firefish-js/markdown/firefish-js.api.fetchlike.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [api](./firefish-js.api.md) > [FetchLike](./firefish-js.api.fetchlike.md) - -## api.FetchLike type - -**Signature:** - -```typescript -export declare type FetchLike = ( - input: string, - init?: { - method?: string; - body?: string; - credentials?: RequestCredentials; - cache?: RequestCache; - }, -) => Promise<{ - status: number; - json(): Promise; -}>; -``` diff --git a/packages/firefish-js/markdown/firefish-js.api.isapierror.md b/packages/firefish-js/markdown/firefish-js.api.isapierror.md deleted file mode 100644 index ea31e0c9fb..0000000000 --- a/packages/firefish-js/markdown/firefish-js.api.isapierror.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [api](./firefish-js.api.md) > [isAPIError](./firefish-js.api.isapierror.md) - -## api.isAPIError() function - -**Signature:** - -```typescript -export declare function isAPIError(reason: any): reason is APIError; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| reason | any | | - -**Returns:** - -reason is [APIError](./firefish-js.api.apierror.md) - diff --git a/packages/firefish-js/markdown/firefish-js.api.md b/packages/firefish-js/markdown/firefish-js.api.md deleted file mode 100644 index c0dbed5355..0000000000 --- a/packages/firefish-js/markdown/firefish-js.api.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [api](./firefish-js.api.md) - -## api namespace - -## Classes - -| Class | Description | -| --- | --- | -| [APIClient](./firefish-js.api.apiclient.md) | | - -## Functions - -| Function | Description | -| --- | --- | -| [isAPIError(reason)](./firefish-js.api.isapierror.md) | | - -## Type Aliases - -| Type Alias | Description | -| --- | --- | -| [APIError](./firefish-js.api.apierror.md) | | -| [FetchLike](./firefish-js.api.fetchlike.md) | | - diff --git a/packages/firefish-js/markdown/firefish-js.channelconnection._constructor_.md b/packages/firefish-js/markdown/firefish-js.channelconnection._constructor_.md deleted file mode 100644 index 4705c06275..0000000000 --- a/packages/firefish-js/markdown/firefish-js.channelconnection._constructor_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [ChannelConnection](./firefish-js.channelconnection.md) > [(constructor)](./firefish-js.channelconnection._constructor_.md) - -## ChannelConnection.(constructor) - -Constructs a new instance of the `Connection` class - -**Signature:** - -```typescript -constructor(stream: Stream, channel: string, name?: string); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| stream | [Stream](./firefish-js.stream.md) | | -| channel | string | | -| name | string | _(Optional)_ | - diff --git a/packages/firefish-js/markdown/firefish-js.channelconnection.channel.md b/packages/firefish-js/markdown/firefish-js.channelconnection.channel.md deleted file mode 100644 index 71569bac51..0000000000 --- a/packages/firefish-js/markdown/firefish-js.channelconnection.channel.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [ChannelConnection](./firefish-js.channelconnection.md) > [channel](./firefish-js.channelconnection.channel.md) - -## ChannelConnection.channel property - -**Signature:** - -```typescript -channel: string; -``` diff --git a/packages/firefish-js/markdown/firefish-js.channelconnection.dispose.md b/packages/firefish-js/markdown/firefish-js.channelconnection.dispose.md deleted file mode 100644 index d968d4ad98..0000000000 --- a/packages/firefish-js/markdown/firefish-js.channelconnection.dispose.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [ChannelConnection](./firefish-js.channelconnection.md) > [dispose](./firefish-js.channelconnection.dispose.md) - -## ChannelConnection.dispose() method - -**Signature:** - -```typescript -abstract dispose(): void; -``` -**Returns:** - -void - diff --git a/packages/firefish-js/markdown/firefish-js.channelconnection.id.md b/packages/firefish-js/markdown/firefish-js.channelconnection.id.md deleted file mode 100644 index 1f4f9896f4..0000000000 --- a/packages/firefish-js/markdown/firefish-js.channelconnection.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [ChannelConnection](./firefish-js.channelconnection.md) > [id](./firefish-js.channelconnection.id.md) - -## ChannelConnection.id property - -**Signature:** - -```typescript -abstract id: string; -``` diff --git a/packages/firefish-js/markdown/firefish-js.channelconnection.incount.md b/packages/firefish-js/markdown/firefish-js.channelconnection.incount.md deleted file mode 100644 index e53cecf6fd..0000000000 --- a/packages/firefish-js/markdown/firefish-js.channelconnection.incount.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [ChannelConnection](./firefish-js.channelconnection.md) > [inCount](./firefish-js.channelconnection.incount.md) - -## ChannelConnection.inCount property - -**Signature:** - -```typescript -inCount: number; -``` diff --git a/packages/firefish-js/markdown/firefish-js.channelconnection.md b/packages/firefish-js/markdown/firefish-js.channelconnection.md deleted file mode 100644 index 68e77916e6..0000000000 --- a/packages/firefish-js/markdown/firefish-js.channelconnection.md +++ /dev/null @@ -1,39 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [ChannelConnection](./firefish-js.channelconnection.md) - -## ChannelConnection class - -**Signature:** - -```typescript -export declare abstract class Connection< - Channel extends AnyOf = any, -> extends EventEmitter -``` -**Extends:** EventEmitter<Channel\["events"\]> - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(stream, channel, name)](./firefish-js.channelconnection._constructor_.md) | | Constructs a new instance of the Connection class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [channel](./firefish-js.channelconnection.channel.md) | | string | | -| [id](./firefish-js.channelconnection.id.md) | abstract | string | | -| [inCount](./firefish-js.channelconnection.incount.md) | | number | | -| [name?](./firefish-js.channelconnection.name.md) | | string | _(Optional)_ | -| [outCount](./firefish-js.channelconnection.outcount.md) | | number | | -| [stream](./firefish-js.channelconnection.stream.md) | protected | [Stream](./firefish-js.stream.md) | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [dispose()](./firefish-js.channelconnection.dispose.md) | abstract | | -| [send(type, body)](./firefish-js.channelconnection.send.md) | | | - diff --git a/packages/firefish-js/markdown/firefish-js.channelconnection.name.md b/packages/firefish-js/markdown/firefish-js.channelconnection.name.md deleted file mode 100644 index 77acd5ea58..0000000000 --- a/packages/firefish-js/markdown/firefish-js.channelconnection.name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [ChannelConnection](./firefish-js.channelconnection.md) > [name](./firefish-js.channelconnection.name.md) - -## ChannelConnection.name property - -**Signature:** - -```typescript -name?: string; -``` diff --git a/packages/firefish-js/markdown/firefish-js.channelconnection.outcount.md b/packages/firefish-js/markdown/firefish-js.channelconnection.outcount.md deleted file mode 100644 index ec79be6339..0000000000 --- a/packages/firefish-js/markdown/firefish-js.channelconnection.outcount.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [ChannelConnection](./firefish-js.channelconnection.md) > [outCount](./firefish-js.channelconnection.outcount.md) - -## ChannelConnection.outCount property - -**Signature:** - -```typescript -outCount: number; -``` diff --git a/packages/firefish-js/markdown/firefish-js.channelconnection.send.md b/packages/firefish-js/markdown/firefish-js.channelconnection.send.md deleted file mode 100644 index 75b869e866..0000000000 --- a/packages/firefish-js/markdown/firefish-js.channelconnection.send.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [ChannelConnection](./firefish-js.channelconnection.md) > [send](./firefish-js.channelconnection.send.md) - -## ChannelConnection.send() method - -**Signature:** - -```typescript -send( - type: T, - body: Channel["receives"][T], - ): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| type | T | | -| body | Channel\["receives"\]\[T\] | | - -**Returns:** - -void - diff --git a/packages/firefish-js/markdown/firefish-js.channelconnection.stream.md b/packages/firefish-js/markdown/firefish-js.channelconnection.stream.md deleted file mode 100644 index a36829797d..0000000000 --- a/packages/firefish-js/markdown/firefish-js.channelconnection.stream.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [ChannelConnection](./firefish-js.channelconnection.md) > [stream](./firefish-js.channelconnection.stream.md) - -## ChannelConnection.stream property - -**Signature:** - -```typescript -protected stream: Stream; -``` diff --git a/packages/firefish-js/markdown/firefish-js.channels.md b/packages/firefish-js/markdown/firefish-js.channels.md deleted file mode 100644 index 555047e3e0..0000000000 --- a/packages/firefish-js/markdown/firefish-js.channels.md +++ /dev/null @@ -1,143 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [Channels](./firefish-js.channels.md) - -## Channels type - -**Signature:** - -```typescript -export declare type Channels = { - main: { - params: null; - events: { - notification: (payload: Notification) => void; - mention: (payload: Note) => void; - reply: (payload: Note) => void; - renote: (payload: Note) => void; - follow: (payload: User) => void; - followed: (payload: User) => void; - unfollow: (payload: User) => void; - meUpdated: (payload: MeDetailed) => void; - pageEvent: (payload: PageEvent) => void; - urlUploadFinished: (payload: { - marker: string; - file: DriveFile; - }) => void; - readAllNotifications: () => void; - unreadNotification: (payload: Notification) => void; - unreadMention: (payload: Note["id"]) => void; - readAllUnreadMentions: () => void; - unreadSpecifiedNote: (payload: Note["id"]) => void; - readAllUnreadSpecifiedNotes: () => void; - readAllMessagingMessages: () => void; - messagingMessage: (payload: MessagingMessage) => void; - unreadMessagingMessage: (payload: MessagingMessage) => void; - readAllAntennas: () => void; - unreadAntenna: (payload: Antenna) => void; - readAllAnnouncements: () => void; - readAllChannels: () => void; - unreadChannel: (payload: Note["id"]) => void; - myTokenRegenerated: () => void; - reversiNoInvites: () => void; - reversiInvited: (payload: FIXME) => void; - signin: (payload: FIXME) => void; - registryUpdated: (payload: { - scope?: string[]; - key: string; - value: any | null; - }) => void; - driveFileCreated: (payload: DriveFile) => void; - readAntenna: (payload: Antenna) => void; - }; - receives: null; - }; - homeTimeline: { - params: null; - events: { - note: (payload: Note) => void; - }; - receives: null; - }; - localTimeline: { - params: null; - events: { - note: (payload: Note) => void; - }; - receives: null; - }; - hybridTimeline: { - params: null; - events: { - note: (payload: Note) => void; - }; - receives: null; - }; - recommendedTimeline: { - params: null; - events: { - note: (payload: Note) => void; - }; - receives: null; - }; - globalTimeline: { - params: null; - events: { - note: (payload: Note) => void; - }; - receives: null; - }; - antenna: { - params: { - antennaId: Antenna["id"]; - }; - events: { - note: (payload: Note) => void; - }; - receives: null; - }; - messaging: { - params: { - otherparty?: User["id"] | null; - group?: UserGroup["id"] | null; - }; - events: { - message: (payload: MessagingMessage) => void; - deleted: (payload: MessagingMessage["id"]) => void; - read: (payload: MessagingMessage["id"][]) => void; - typers: (payload: User[]) => void; - }; - receives: { - read: { - id: MessagingMessage["id"]; - }; - }; - }; - serverStats: { - params: null; - events: { - stats: (payload: FIXME) => void; - }; - receives: { - requestLog: { - id: string | number; - length: number; - }; - }; - }; - queueStats: { - params: null; - events: { - stats: (payload: FIXME) => void; - }; - receives: { - requestLog: { - id: string | number; - length: number; - }; - }; - }; -}; -``` -**References:** [Note](./firefish-js.entities.note.md), [User](./firefish-js.entities.user.md), [MeDetailed](./firefish-js.entities.medetailed.md), [PageEvent](./firefish-js.entities.pageevent.md), [DriveFile](./firefish-js.entities.drivefile.md), [MessagingMessage](./firefish-js.entities.messagingmessage.md), [Antenna](./firefish-js.entities.antenna.md), [UserGroup](./firefish-js.entities.usergroup.md) - diff --git a/packages/firefish-js/markdown/firefish-js.endpoints.md b/packages/firefish-js/markdown/firefish-js.endpoints.md deleted file mode 100644 index 4d2162d571..0000000000 --- a/packages/firefish-js/markdown/firefish-js.endpoints.md +++ /dev/null @@ -1,1911 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [Endpoints](./firefish-js.endpoints.md) - -## Endpoints type - -**Signature:** - -```typescript -export declare type Endpoints = { - "admin/abuse-user-reports": { - req: TODO; - res: TODO; - }; - "admin/delete-all-files-of-a-user": { - req: { - userId: User["id"]; - }; - res: null; - }; - "admin/delete-logs": { - req: NoParams; - res: null; - }; - "admin/get-index-stats": { - req: TODO; - res: TODO; - }; - "admin/get-table-stats": { - req: TODO; - res: TODO; - }; - "admin/invite": { - req: TODO; - res: TODO; - }; - "admin/logs": { - req: TODO; - res: TODO; - }; - "admin/meta": { - req: TODO; - res: TODO; - }; - "admin/reset-password": { - req: TODO; - res: TODO; - }; - "admin/resolve-abuse-user-report": { - req: TODO; - res: TODO; - }; - "admin/resync-chart": { - req: TODO; - res: TODO; - }; - "admin/send-email": { - req: TODO; - res: TODO; - }; - "admin/server-info": { - req: TODO; - res: TODO; - }; - "admin/show-moderation-logs": { - req: TODO; - res: TODO; - }; - "admin/show-user": { - req: TODO; - res: TODO; - }; - "admin/show-users": { - req: TODO; - res: TODO; - }; - "admin/silence-user": { - req: TODO; - res: TODO; - }; - "admin/suspend-user": { - req: TODO; - res: TODO; - }; - "admin/unsilence-user": { - req: TODO; - res: TODO; - }; - "admin/unsuspend-user": { - req: TODO; - res: TODO; - }; - "admin/update-meta": { - req: TODO; - res: TODO; - }; - "admin/vacuum": { - req: TODO; - res: TODO; - }; - "admin/accounts/create": { - req: TODO; - res: TODO; - }; - "admin/ad/create": { - req: TODO; - res: TODO; - }; - "admin/ad/delete": { - req: { - id: Ad["id"]; - }; - res: null; - }; - "admin/ad/list": { - req: TODO; - res: TODO; - }; - "admin/ad/update": { - req: TODO; - res: TODO; - }; - "admin/announcements/create": { - req: TODO; - res: TODO; - }; - "admin/announcements/delete": { - req: { - id: Announcement["id"]; - }; - res: null; - }; - "admin/announcements/list": { - req: TODO; - res: TODO; - }; - "admin/announcements/update": { - req: TODO; - res: TODO; - }; - "admin/drive/clean-remote-files": { - req: TODO; - res: TODO; - }; - "admin/drive/cleanup": { - req: TODO; - res: TODO; - }; - "admin/drive/files": { - req: TODO; - res: TODO; - }; - "admin/drive/show-file": { - req: TODO; - res: TODO; - }; - "admin/emoji/add": { - req: TODO; - res: TODO; - }; - "admin/emoji/copy": { - req: TODO; - res: TODO; - }; - "admin/emoji/list-remote": { - req: TODO; - res: TODO; - }; - "admin/emoji/list": { - req: TODO; - res: TODO; - }; - "admin/emoji/remove": { - req: TODO; - res: TODO; - }; - "admin/emoji/update": { - req: TODO; - res: TODO; - }; - "admin/federation/delete-all-files": { - req: { - host: string; - }; - res: null; - }; - "admin/federation/refresh-remote-instance-metadata": { - req: TODO; - res: TODO; - }; - "admin/federation/remove-all-following": { - req: TODO; - res: TODO; - }; - "admin/federation/update-instance": { - req: TODO; - res: TODO; - }; - "admin/moderators/add": { - req: TODO; - res: TODO; - }; - "admin/moderators/remove": { - req: TODO; - res: TODO; - }; - "admin/promo/create": { - req: TODO; - res: TODO; - }; - "admin/queue/clear": { - req: TODO; - res: TODO; - }; - "admin/queue/deliver-delayed": { - req: TODO; - res: TODO; - }; - "admin/queue/inbox-delayed": { - req: TODO; - res: TODO; - }; - "admin/queue/jobs": { - req: TODO; - res: TODO; - }; - "admin/queue/stats": { - req: TODO; - res: TODO; - }; - "admin/relays/add": { - req: TODO; - res: TODO; - }; - "admin/relays/list": { - req: TODO; - res: TODO; - }; - "admin/relays/remove": { - req: TODO; - res: TODO; - }; - announcements: { - req: { - limit?: number; - withUnreads?: boolean; - sinceId?: Announcement["id"]; - untilId?: Announcement["id"]; - }; - res: Announcement[]; - }; - "antennas/create": { - req: TODO; - res: Antenna; - }; - "antennas/delete": { - req: { - antennaId: Antenna["id"]; - }; - res: null; - }; - "antennas/list": { - req: NoParams; - res: Antenna[]; - }; - "antennas/notes": { - req: { - antennaId: Antenna["id"]; - limit?: number; - sinceId?: Note["id"]; - untilId?: Note["id"]; - }; - res: Note[]; - }; - "antennas/show": { - req: { - antennaId: Antenna["id"]; - }; - res: Antenna; - }; - "antennas/update": { - req: TODO; - res: Antenna; - }; - "antennas/mark-read": { - req: TODO; - res: Antenna; - }; - "ap/get": { - req: { - uri: string; - }; - res: Record; - }; - "ap/show": { - req: { - uri: string; - }; - res: - | { - type: "Note"; - object: Note; - } - | { - type: "User"; - object: UserDetailed; - }; - }; - "app/create": { - req: TODO; - res: App; - }; - "app/show": { - req: { - appId: App["id"]; - }; - res: App; - }; - "auth/accept": { - req: { - token: string; - }; - res: null; - }; - "auth/session/generate": { - req: { - appSecret: string; - }; - res: { - token: string; - url: string; - }; - }; - "auth/session/show": { - req: { - token: string; - }; - res: AuthSession; - }; - "auth/session/userkey": { - req: { - appSecret: string; - token: string; - }; - res: { - accessToken: string; - user: User; - }; - }; - "blocking/create": { - req: { - userId: User["id"]; - }; - res: UserDetailed; - }; - "blocking/delete": { - req: { - userId: User["id"]; - }; - res: UserDetailed; - }; - "blocking/list": { - req: { - limit?: number; - sinceId?: Blocking["id"]; - untilId?: Blocking["id"]; - }; - res: Blocking[]; - }; - "channels/create": { - req: TODO; - res: TODO; - }; - "channels/featured": { - req: TODO; - res: TODO; - }; - "channels/follow": { - req: TODO; - res: TODO; - }; - "channels/followed": { - req: TODO; - res: TODO; - }; - "channels/owned": { - req: TODO; - res: TODO; - }; - "channels/pin-note": { - req: TODO; - res: TODO; - }; - "channels/show": { - req: TODO; - res: TODO; - }; - "channels/timeline": { - req: TODO; - res: TODO; - }; - "channels/unfollow": { - req: TODO; - res: TODO; - }; - "channels/update": { - req: TODO; - res: TODO; - }; - "charts/active-users": { - req: { - span: "day" | "hour"; - limit?: number; - offset?: number | null; - }; - res: { - local: { - users: number[]; - }; - remote: { - users: number[]; - }; - }; - }; - "charts/drive": { - req: { - span: "day" | "hour"; - limit?: number; - offset?: number | null; - }; - res: { - local: { - decCount: number[]; - decSize: number[]; - incCount: number[]; - incSize: number[]; - totalCount: number[]; - totalSize: number[]; - }; - remote: { - decCount: number[]; - decSize: number[]; - incCount: number[]; - incSize: number[]; - totalCount: number[]; - totalSize: number[]; - }; - }; - }; - "charts/federation": { - req: { - span: "day" | "hour"; - limit?: number; - offset?: number | null; - }; - res: { - instance: { - dec: number[]; - inc: number[]; - total: number[]; - }; - }; - }; - "charts/hashtag": { - req: { - span: "day" | "hour"; - limit?: number; - offset?: number | null; - }; - res: TODO; - }; - "charts/instance": { - req: { - span: "day" | "hour"; - limit?: number; - offset?: number | null; - host: string; - }; - res: { - drive: { - decFiles: number[]; - decUsage: number[]; - incFiles: number[]; - incUsage: number[]; - totalFiles: number[]; - totalUsage: number[]; - }; - followers: { - dec: number[]; - inc: number[]; - total: number[]; - }; - following: { - dec: number[]; - inc: number[]; - total: number[]; - }; - notes: { - dec: number[]; - inc: number[]; - total: number[]; - diffs: { - normal: number[]; - renote: number[]; - reply: number[]; - }; - }; - requests: { - failed: number[]; - received: number[]; - succeeded: number[]; - }; - users: { - dec: number[]; - inc: number[]; - total: number[]; - }; - }; - }; - "charts/network": { - req: { - span: "day" | "hour"; - limit?: number; - offset?: number | null; - }; - res: TODO; - }; - "charts/notes": { - req: { - span: "day" | "hour"; - limit?: number; - offset?: number | null; - }; - res: { - local: { - dec: number[]; - inc: number[]; - total: number[]; - diffs: { - normal: number[]; - renote: number[]; - reply: number[]; - }; - }; - remote: { - dec: number[]; - inc: number[]; - total: number[]; - diffs: { - normal: number[]; - renote: number[]; - reply: number[]; - }; - }; - }; - }; - "charts/user/drive": { - req: { - span: "day" | "hour"; - limit?: number; - offset?: number | null; - userId: User["id"]; - }; - res: { - decCount: number[]; - decSize: number[]; - incCount: number[]; - incSize: number[]; - totalCount: number[]; - totalSize: number[]; - }; - }; - "charts/user/following": { - req: { - span: "day" | "hour"; - limit?: number; - offset?: number | null; - userId: User["id"]; - }; - res: TODO; - }; - "charts/user/notes": { - req: { - span: "day" | "hour"; - limit?: number; - offset?: number | null; - userId: User["id"]; - }; - res: { - dec: number[]; - inc: number[]; - total: number[]; - diffs: { - normal: number[]; - renote: number[]; - reply: number[]; - }; - }; - }; - "charts/user/reactions": { - req: { - span: "day" | "hour"; - limit?: number; - offset?: number | null; - userId: User["id"]; - }; - res: TODO; - }; - "charts/users": { - req: { - span: "day" | "hour"; - limit?: number; - offset?: number | null; - }; - res: { - local: { - dec: number[]; - inc: number[]; - total: number[]; - }; - remote: { - dec: number[]; - inc: number[]; - total: number[]; - }; - }; - }; - "clips/add-note": { - req: TODO; - res: TODO; - }; - "clips/create": { - req: TODO; - res: TODO; - }; - "clips/delete": { - req: { - clipId: Clip["id"]; - }; - res: null; - }; - "clips/list": { - req: TODO; - res: TODO; - }; - "clips/notes": { - req: TODO; - res: TODO; - }; - "clips/show": { - req: TODO; - res: TODO; - }; - "clips/update": { - req: TODO; - res: TODO; - }; - drive: { - req: NoParams; - res: { - capacity: number; - usage: number; - }; - }; - "drive/files": { - req: { - folderId?: DriveFolder["id"] | null; - type?: DriveFile["type"] | null; - limit?: number; - sinceId?: DriveFile["id"]; - untilId?: DriveFile["id"]; - }; - res: DriveFile[]; - }; - "drive/files/attached-notes": { - req: TODO; - res: TODO; - }; - "drive/files/check-existence": { - req: TODO; - res: TODO; - }; - "drive/files/create": { - req: TODO; - res: TODO; - }; - "drive/files/delete": { - req: { - fileId: DriveFile["id"]; - }; - res: null; - }; - "drive/files/find-by-hash": { - req: TODO; - res: TODO; - }; - "drive/files/find": { - req: { - name: string; - folderId?: DriveFolder["id"] | null; - }; - res: DriveFile[]; - }; - "drive/files/show": { - req: { - fileId?: DriveFile["id"]; - url?: string; - }; - res: DriveFile; - }; - "drive/files/update": { - req: { - fileId: DriveFile["id"]; - folderId?: DriveFolder["id"] | null; - name?: string; - isSensitive?: boolean; - comment?: string | null; - }; - res: DriveFile; - }; - "drive/files/upload-from-url": { - req: { - url: string; - folderId?: DriveFolder["id"] | null; - isSensitive?: boolean; - comment?: string | null; - marker?: string | null; - force?: boolean; - }; - res: null; - }; - "drive/folders": { - req: { - folderId?: DriveFolder["id"] | null; - limit?: number; - sinceId?: DriveFile["id"]; - untilId?: DriveFile["id"]; - }; - res: DriveFolder[]; - }; - "drive/folders/create": { - req: { - name?: string; - parentId?: DriveFolder["id"] | null; - }; - res: DriveFolder; - }; - "drive/folders/delete": { - req: { - folderId: DriveFolder["id"]; - }; - res: null; - }; - "drive/folders/find": { - req: { - name: string; - parentId?: DriveFolder["id"] | null; - }; - res: DriveFolder[]; - }; - "drive/folders/show": { - req: { - folderId: DriveFolder["id"]; - }; - res: DriveFolder; - }; - "drive/folders/update": { - req: { - folderId: DriveFolder["id"]; - name?: string; - parentId?: DriveFolder["id"] | null; - }; - res: DriveFolder; - }; - "drive/stream": { - req: { - type?: DriveFile["type"] | null; - limit?: number; - sinceId?: DriveFile["id"]; - untilId?: DriveFile["id"]; - }; - res: DriveFile[]; - }; - endpoint: { - req: { - endpoint: string; - }; - res: { - params: { - name: string; - type: string; - }[]; - }; - }; - endpoints: { - req: NoParams; - res: string[]; - }; - "federation/dns": { - req: { - host: string; - }; - res: { - a: string[]; - aaaa: string[]; - cname: string[]; - txt: string[]; - }; - }; - "federation/followers": { - req: { - host: string; - limit?: number; - sinceId?: Following["id"]; - untilId?: Following["id"]; - }; - res: FollowingFolloweePopulated[]; - }; - "federation/following": { - req: { - host: string; - limit?: number; - sinceId?: Following["id"]; - untilId?: Following["id"]; - }; - res: FollowingFolloweePopulated[]; - }; - "federation/instances": { - req: { - host?: string | null; - blocked?: boolean | null; - notResponding?: boolean | null; - suspended?: boolean | null; - federating?: boolean | null; - subscribing?: boolean | null; - publishing?: boolean | null; - limit?: number; - offset?: number; - sort?: - | "+pubSub" - | "-pubSub" - | "+notes" - | "-notes" - | "+users" - | "-users" - | "+following" - | "-following" - | "+followers" - | "-followers" - | "+caughtAt" - | "-caughtAt" - | "+lastCommunicatedAt" - | "-lastCommunicatedAt" - | "+driveUsage" - | "-driveUsage" - | "+driveFiles" - | "-driveFiles"; - }; - res: Instance[]; - }; - "federation/show-instance": { - req: { - host: string; - }; - res: Instance; - }; - "federation/update-remote-user": { - req: { - userId: User["id"]; - }; - res: null; - }; - "federation/users": { - req: { - host: string; - limit?: number; - sinceId?: User["id"]; - untilId?: User["id"]; - }; - res: UserDetailed[]; - }; - "following/create": { - req: { - userId: User["id"]; - }; - res: User; - }; - "following/delete": { - req: { - userId: User["id"]; - }; - res: User; - }; - "following/requests/accept": { - req: { - userId: User["id"]; - }; - res: null; - }; - "following/requests/cancel": { - req: { - userId: User["id"]; - }; - res: User; - }; - "following/requests/list": { - req: NoParams; - res: FollowRequest[]; - }; - "following/requests/reject": { - req: { - userId: User["id"]; - }; - res: null; - }; - "gallery/featured": { - req: TODO; - res: TODO; - }; - "gallery/popular": { - req: TODO; - res: TODO; - }; - "gallery/posts": { - req: TODO; - res: TODO; - }; - "gallery/posts/create": { - req: TODO; - res: TODO; - }; - "gallery/posts/delete": { - req: { - postId: GalleryPost["id"]; - }; - res: null; - }; - "gallery/posts/like": { - req: TODO; - res: TODO; - }; - "gallery/posts/show": { - req: TODO; - res: TODO; - }; - "gallery/posts/unlike": { - req: TODO; - res: TODO; - }; - "gallery/posts/update": { - req: TODO; - res: TODO; - }; - "games/reversi/games": { - req: TODO; - res: TODO; - }; - "games/reversi/games/show": { - req: TODO; - res: TODO; - }; - "games/reversi/games/surrender": { - req: TODO; - res: TODO; - }; - "games/reversi/invitations": { - req: TODO; - res: TODO; - }; - "games/reversi/match": { - req: TODO; - res: TODO; - }; - "games/reversi/match/cancel": { - req: TODO; - res: TODO; - }; - "get-online-users-count": { - req: NoParams; - res: { - count: number; - }; - }; - "hashtags/list": { - req: TODO; - res: TODO; - }; - "hashtags/search": { - req: TODO; - res: TODO; - }; - "hashtags/show": { - req: TODO; - res: TODO; - }; - "hashtags/trend": { - req: TODO; - res: TODO; - }; - "hashtags/users": { - req: TODO; - res: TODO; - }; - i: { - req: NoParams; - res: User; - }; - "i/apps": { - req: TODO; - res: TODO; - }; - "i/authorized-apps": { - req: TODO; - res: TODO; - }; - "i/change-password": { - req: TODO; - res: TODO; - }; - "i/delete-account": { - req: { - password: string; - }; - res: null; - }; - "i/export-blocking": { - req: TODO; - res: TODO; - }; - "i/export-following": { - req: TODO; - res: TODO; - }; - "i/export-mute": { - req: TODO; - res: TODO; - }; - "i/export-notes": { - req: TODO; - res: TODO; - }; - "i/export-user-lists": { - req: TODO; - res: TODO; - }; - "i/favorites": { - req: { - limit?: number; - sinceId?: NoteFavorite["id"]; - untilId?: NoteFavorite["id"]; - }; - res: NoteFavorite[]; - }; - "i/gallery/likes": { - req: TODO; - res: TODO; - }; - "i/gallery/posts": { - req: TODO; - res: TODO; - }; - "i/get-word-muted-notes-count": { - req: TODO; - res: TODO; - }; - "i/import-following": { - req: TODO; - res: TODO; - }; - "i/import-user-lists": { - req: TODO; - res: TODO; - }; - "i/move": { - req: TODO; - res: TODO; - }; - "i/known-as": { - req: TODO; - res: TODO; - }; - "i/notifications": { - req: { - limit?: number; - sinceId?: Notification["id"]; - untilId?: Notification["id"]; - following?: boolean; - markAsRead?: boolean; - includeTypes?: Notification["type"][]; - excludeTypes?: Notification["type"][]; - }; - res: Notification[]; - }; - "i/page-likes": { - req: TODO; - res: TODO; - }; - "i/pages": { - req: TODO; - res: TODO; - }; - "i/pin": { - req: { - noteId: Note["id"]; - }; - res: MeDetailed; - }; - "i/read-all-messaging-messages": { - req: TODO; - res: TODO; - }; - "i/read-all-unread-notes": { - req: TODO; - res: TODO; - }; - "i/read-announcement": { - req: TODO; - res: TODO; - }; - "i/regenerate-token": { - req: { - password: string; - }; - res: null; - }; - "i/registry/get-all": { - req: { - scope?: string[]; - }; - res: Record; - }; - "i/registry/get-detail": { - req: { - key: string; - scope?: string[]; - }; - res: { - updatedAt: DateString; - value: any; - }; - }; - "i/registry/get": { - req: { - key: string; - scope?: string[]; - }; - res: any; - }; - "i/registry/keys-with-type": { - req: { - scope?: string[]; - }; - res: Record< - string, - "null" | "array" | "number" | "string" | "boolean" | "object" - >; - }; - "i/registry/keys": { - req: { - scope?: string[]; - }; - res: string[]; - }; - "i/registry/remove": { - req: { - key: string; - scope?: string[]; - }; - res: null; - }; - "i/registry/scopes": { - req: NoParams; - res: string[][]; - }; - "i/registry/set": { - req: { - key: string; - value: any; - scope?: string[]; - }; - res: null; - }; - "i/revoke-token": { - req: TODO; - res: TODO; - }; - "i/signin-history": { - req: { - limit?: number; - sinceId?: Signin["id"]; - untilId?: Signin["id"]; - }; - res: Signin[]; - }; - "i/unpin": { - req: { - noteId: Note["id"]; - }; - res: MeDetailed; - }; - "i/update-email": { - req: { - password: string; - email?: string | null; - }; - res: MeDetailed; - }; - "i/update": { - req: { - name?: string | null; - description?: string | null; - lang?: string | null; - location?: string | null; - birthday?: string | null; - avatarId?: DriveFile["id"] | null; - bannerId?: DriveFile["id"] | null; - fields?: { - name: string; - value: string; - }[]; - isLocked?: boolean; - isExplorable?: boolean; - hideOnlineStatus?: boolean; - carefulBot?: boolean; - autoAcceptFollowed?: boolean; - noCrawle?: boolean; - preventAiLearning?: boolean; - isBot?: boolean; - isCat?: boolean; - injectFeaturedNote?: boolean; - receiveAnnouncementEmail?: boolean; - alwaysMarkNsfw?: boolean; - mutedWords?: string[][]; - mutingNotificationTypes?: Notification["type"][]; - emailNotificationTypes?: string[]; - }; - res: MeDetailed; - }; - "i/user-group-invites": { - req: TODO; - res: TODO; - }; - "i/2fa/done": { - req: TODO; - res: TODO; - }; - "i/2fa/key-done": { - req: TODO; - res: TODO; - }; - "i/2fa/password-less": { - req: TODO; - res: TODO; - }; - "i/2fa/register-key": { - req: TODO; - res: TODO; - }; - "i/2fa/register": { - req: TODO; - res: TODO; - }; - "i/2fa/update-key": { - req: TODO; - res: TODO; - }; - "i/2fa/remove-key": { - req: TODO; - res: TODO; - }; - "i/2fa/unregister": { - req: TODO; - res: TODO; - }; - "messaging/history": { - req: { - limit?: number; - group?: boolean; - }; - res: MessagingMessage[]; - }; - "messaging/messages": { - req: { - userId?: User["id"]; - groupId?: UserGroup["id"]; - limit?: number; - sinceId?: MessagingMessage["id"]; - untilId?: MessagingMessage["id"]; - markAsRead?: boolean; - }; - res: MessagingMessage[]; - }; - "messaging/messages/create": { - req: { - userId?: User["id"]; - groupId?: UserGroup["id"]; - text?: string; - fileId?: DriveFile["id"]; - }; - res: MessagingMessage; - }; - "messaging/messages/delete": { - req: { - messageId: MessagingMessage["id"]; - }; - res: null; - }; - "messaging/messages/read": { - req: { - messageId: MessagingMessage["id"]; - }; - res: null; - }; - meta: { - req: { - detail?: boolean; - }; - res: { - $switch: { - $cases: [ - [ - { - detail: true; - }, - DetailedInstanceMetadata, - ], - [ - { - detail: false; - }, - LiteInstanceMetadata, - ], - [ - { - detail: boolean; - }, - LiteInstanceMetadata | DetailedInstanceMetadata, - ], - ]; - $default: LiteInstanceMetadata; - }; - }; - }; - "miauth/gen-token": { - req: TODO; - res: TODO; - }; - "mute/create": { - req: TODO; - res: TODO; - }; - "mute/delete": { - req: { - userId: User["id"]; - }; - res: null; - }; - "mute/list": { - req: TODO; - res: TODO; - }; - "renote-mute/create": { - req: TODO; - res: TODO; - }; - "renote-mute/delete": { - req: { - userId: User["id"]; - }; - res: null; - }; - "renote-mute/list": { - req: TODO; - res: TODO; - }; - "my/apps": { - req: TODO; - res: TODO; - }; - notes: { - req: { - limit?: number; - sinceId?: Note["id"]; - untilId?: Note["id"]; - }; - res: Note[]; - }; - "notes/children": { - req: { - noteId: Note["id"]; - limit?: number; - sinceId?: Note["id"]; - untilId?: Note["id"]; - }; - res: Note[]; - }; - "notes/clips": { - req: TODO; - res: TODO; - }; - "notes/conversation": { - req: TODO; - res: TODO; - }; - "notes/create": { - req: NoteSubmitReq; - res: { - createdNote: Note; - }; - }; - "notes/delete": { - req: { - noteId: Note["id"]; - }; - res: null; - }; - "notes/edit": { - req: NoteSubmitReq; - res: { - createdNote: Note; - }; - }; - "notes/favorites/create": { - req: { - noteId: Note["id"]; - }; - res: null; - }; - "notes/favorites/delete": { - req: { - noteId: Note["id"]; - }; - res: null; - }; - "notes/featured": { - req: TODO; - res: Note[]; - }; - "notes/global-timeline": { - req: { - limit?: number; - sinceId?: Note["id"]; - untilId?: Note["id"]; - sinceDate?: number; - untilDate?: number; - }; - res: Note[]; - }; - "notes/recommended-timeline": { - req: { - limit?: number; - sinceId?: Note["id"]; - untilId?: Note["id"]; - sinceDate?: number; - untilDate?: number; - }; - res: Note[]; - }; - "notes/hybrid-timeline": { - req: { - limit?: number; - sinceId?: Note["id"]; - untilId?: Note["id"]; - sinceDate?: number; - untilDate?: number; - }; - res: Note[]; - }; - "notes/local-timeline": { - req: { - limit?: number; - sinceId?: Note["id"]; - untilId?: Note["id"]; - sinceDate?: number; - untilDate?: number; - }; - res: Note[]; - }; - "notes/mentions": { - req: { - following?: boolean; - limit?: number; - sinceId?: Note["id"]; - untilId?: Note["id"]; - }; - res: Note[]; - }; - "notes/polls/recommendation": { - req: TODO; - res: TODO; - }; - "notes/polls/vote": { - req: { - noteId: Note["id"]; - choice: number; - }; - res: null; - }; - "notes/reactions": { - req: { - noteId: Note["id"]; - type?: string | null; - limit?: number; - }; - res: NoteReaction[]; - }; - "notes/reactions/create": { - req: { - noteId: Note["id"]; - reaction: string; - }; - res: null; - }; - "notes/reactions/delete": { - req: { - noteId: Note["id"]; - }; - res: null; - }; - "notes/renotes": { - req: { - limit?: number; - sinceId?: Note["id"]; - untilId?: Note["id"]; - noteId: Note["id"]; - }; - res: Note[]; - }; - "notes/replies": { - req: { - limit?: number; - sinceId?: Note["id"]; - untilId?: Note["id"]; - noteId: Note["id"]; - }; - res: Note[]; - }; - "notes/search-by-tag": { - req: TODO; - res: TODO; - }; - "notes/search": { - req: TODO; - res: TODO; - }; - "notes/show": { - req: { - noteId: Note["id"]; - }; - res: Note; - }; - "notes/state": { - req: TODO; - res: TODO; - }; - "notes/timeline": { - req: { - limit?: number; - sinceId?: Note["id"]; - untilId?: Note["id"]; - sinceDate?: number; - untilDate?: number; - }; - res: Note[]; - }; - "notes/unrenote": { - req: { - noteId: Note["id"]; - }; - res: null; - }; - "notes/user-list-timeline": { - req: { - listId: UserList["id"]; - limit?: number; - sinceId?: Note["id"]; - untilId?: Note["id"]; - sinceDate?: number; - untilDate?: number; - }; - res: Note[]; - }; - "notes/watching/create": { - req: TODO; - res: TODO; - }; - "notes/watching/delete": { - req: { - noteId: Note["id"]; - }; - res: null; - }; - "notifications/create": { - req: { - body: string; - header?: string | null; - icon?: string | null; - }; - res: null; - }; - "notifications/mark-all-as-read": { - req: NoParams; - res: null; - }; - "notifications/read": { - req: { - notificationId: Notification["id"]; - }; - res: null; - }; - "page-push": { - req: { - pageId: Page["id"]; - event: string; - var?: any; - }; - res: null; - }; - "pages/create": { - req: TODO; - res: Page; - }; - "pages/delete": { - req: { - pageId: Page["id"]; - }; - res: null; - }; - "pages/featured": { - req: NoParams; - res: Page[]; - }; - "pages/like": { - req: { - pageId: Page["id"]; - }; - res: null; - }; - "pages/show": { - req: { - pageId?: Page["id"]; - name?: string; - username?: string; - }; - res: Page; - }; - "pages/unlike": { - req: { - pageId: Page["id"]; - }; - res: null; - }; - "pages/update": { - req: TODO; - res: null; - }; - ping: { - req: NoParams; - res: { - pong: number; - }; - }; - "pinned-users": { - req: TODO; - res: TODO; - }; - "promo/read": { - req: TODO; - res: TODO; - }; - "request-reset-password": { - req: { - username: string; - email: string; - }; - res: null; - }; - "reset-password": { - req: { - token: string; - password: string; - }; - res: null; - }; - "room/show": { - req: TODO; - res: TODO; - }; - "room/update": { - req: TODO; - res: TODO; - }; - stats: { - req: NoParams; - res: Stats; - }; - "server-info": { - req: NoParams; - res: ServerInfo; - }; - "latest-version": { - req: NoParams; - res: TODO; - }; - "sw/register": { - req: TODO; - res: TODO; - }; - "username/available": { - req: { - username: string; - }; - res: { - available: boolean; - }; - }; - users: { - req: { - limit?: number; - offset?: number; - sort?: UserSorting; - origin?: OriginType; - }; - res: User[]; - }; - "users/clips": { - req: TODO; - res: TODO; - }; - "users/followers": { - req: { - userId?: User["id"]; - username?: User["username"]; - host?: User["host"] | null; - limit?: number; - sinceId?: Following["id"]; - untilId?: Following["id"]; - }; - res: FollowingFollowerPopulated[]; - }; - "users/following": { - req: { - userId?: User["id"]; - username?: User["username"]; - host?: User["host"] | null; - limit?: number; - sinceId?: Following["id"]; - untilId?: Following["id"]; - }; - res: FollowingFolloweePopulated[]; - }; - "users/gallery/posts": { - req: TODO; - res: TODO; - }; - "users/get-frequently-replied-users": { - req: TODO; - res: TODO; - }; - "users/groups/create": { - req: TODO; - res: TODO; - }; - "users/groups/delete": { - req: { - groupId: UserGroup["id"]; - }; - res: null; - }; - "users/groups/invitations/accept": { - req: TODO; - res: TODO; - }; - "users/groups/invitations/reject": { - req: TODO; - res: TODO; - }; - "users/groups/invite": { - req: TODO; - res: TODO; - }; - "users/groups/joined": { - req: TODO; - res: TODO; - }; - "users/groups/owned": { - req: TODO; - res: TODO; - }; - "users/groups/pull": { - req: TODO; - res: TODO; - }; - "users/groups/show": { - req: TODO; - res: TODO; - }; - "users/groups/transfer": { - req: TODO; - res: TODO; - }; - "users/groups/update": { - req: TODO; - res: TODO; - }; - "users/lists/create": { - req: { - name: string; - }; - res: UserList; - }; - "users/lists/delete": { - req: { - listId: UserList["id"]; - }; - res: null; - }; - "users/lists/list": { - req: NoParams; - res: UserList[]; - }; - "users/lists/pull": { - req: { - listId: UserList["id"]; - userId: User["id"]; - }; - res: null; - }; - "users/lists/push": { - req: { - listId: UserList["id"]; - userId: User["id"]; - }; - res: null; - }; - "users/lists/show": { - req: { - listId: UserList["id"]; - }; - res: UserList; - }; - "users/lists/update": { - req: { - listId: UserList["id"]; - name: string; - }; - res: UserList; - }; - "users/notes": { - req: { - userId: User["id"]; - limit?: number; - sinceId?: Note["id"]; - untilId?: Note["id"]; - sinceDate?: number; - untilDate?: number; - }; - res: Note[]; - }; - "users/pages": { - req: TODO; - res: TODO; - }; - "users/recommendation": { - req: TODO; - res: TODO; - }; - "users/relation": { - req: TODO; - res: TODO; - }; - "users/report-abuse": { - req: TODO; - res: TODO; - }; - "users/search-by-username-and-host": { - req: TODO; - res: TODO; - }; - "users/search": { - req: TODO; - res: TODO; - }; - "users/show": { - req: - | ShowUserReq - | { - userIds: User["id"][]; - }; - res: { - $switch: { - $cases: [ - [ - { - userIds: User["id"][]; - }, - UserDetailed[], - ], - ]; - $default: UserDetailed; - }; - }; - }; - "users/stats": { - req: TODO; - res: TODO; - }; -}; -``` -**References:** [User](./firefish-js.entities.user.md), [Ad](./firefish-js.entities.ad.md), [Announcement](./firefish-js.entities.announcement.md), [Antenna](./firefish-js.entities.antenna.md), [Note](./firefish-js.entities.note.md), [UserDetailed](./firefish-js.entities.userdetailed.md), [App](./firefish-js.entities.app.md), [AuthSession](./firefish-js.entities.authsession.md), [Blocking](./firefish-js.entities.blocking.md), [Clip](./firefish-js.entities.clip.md), [DriveFolder](./firefish-js.entities.drivefolder.md), [DriveFile](./firefish-js.entities.drivefile.md), [Following](./firefish-js.entities.following.md), [FollowingFolloweePopulated](./firefish-js.entities.followingfolloweepopulated.md), [Instance](./firefish-js.entities.instance.md), [FollowRequest](./firefish-js.entities.followrequest.md), [GalleryPost](./firefish-js.entities.gallerypost.md), [NoteFavorite](./firefish-js.entities.notefavorite.md), [MeDetailed](./firefish-js.entities.medetailed.md), [DateString](./firefish-js.entities.datestring.md), [Signin](./firefish-js.entities.signin.md), [MessagingMessage](./firefish-js.entities.messagingmessage.md), [UserGroup](./firefish-js.entities.usergroup.md), [DetailedInstanceMetadata](./firefish-js.entities.detailedinstancemetadata.md), [LiteInstanceMetadata](./firefish-js.entities.liteinstancemetadata.md), [NoteReaction](./firefish-js.entities.notereaction.md), [UserList](./firefish-js.entities.userlist.md), [Page](./firefish-js.entities.page.md), [Stats](./firefish-js.entities.stats.md), [ServerInfo](./firefish-js.entities.serverinfo.md), [UserSorting](./firefish-js.entities.usersorting.md), [OriginType](./firefish-js.entities.origintype.md), [FollowingFollowerPopulated](./firefish-js.entities.followingfollowerpopulated.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.ad.md b/packages/firefish-js/markdown/firefish-js.entities.ad.md deleted file mode 100644 index 9b3ef29e12..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.ad.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [Ad](./firefish-js.entities.ad.md) - -## entities.Ad type - -**Signature:** - -```typescript -export declare type Ad = TODO; -``` diff --git a/packages/firefish-js/markdown/firefish-js.entities.announcement.md b/packages/firefish-js/markdown/firefish-js.entities.announcement.md deleted file mode 100644 index fba76c2279..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.announcement.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [Announcement](./firefish-js.entities.announcement.md) - -## entities.Announcement type - -**Signature:** - -```typescript -export declare type Announcement = { - id: ID; - createdAt: DateString; - updatedAt: DateString | null; - text: string; - title: string; - imageUrl: string | null; - isRead?: boolean; -}; -``` -**References:** [ID](./firefish-js.entities.id.md), [DateString](./firefish-js.entities.datestring.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.antenna.md b/packages/firefish-js/markdown/firefish-js.entities.antenna.md deleted file mode 100644 index c92eca8496..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.antenna.md +++ /dev/null @@ -1,29 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [Antenna](./firefish-js.entities.antenna.md) - -## entities.Antenna type - -**Signature:** - -```typescript -export declare type Antenna = { - id: ID; - createdAt: DateString; - name: string; - keywords: string[][]; - excludeKeywords: string[][]; - src: "home" | "all" | "users" | "list" | "group" | "instances"; - userListId: ID | null; - userGroupId: ID | null; - users: string[]; - instances: string[]; - caseSensitive: boolean; - notify: boolean; - withReplies: boolean; - withFile: boolean; - hasUnreadNote: boolean; -}; -``` -**References:** [ID](./firefish-js.entities.id.md), [DateString](./firefish-js.entities.datestring.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.app.md b/packages/firefish-js/markdown/firefish-js.entities.app.md deleted file mode 100644 index bef377f53b..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.app.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [App](./firefish-js.entities.app.md) - -## entities.App type - -**Signature:** - -```typescript -export declare type App = TODO; -``` diff --git a/packages/firefish-js/markdown/firefish-js.entities.authsession.md b/packages/firefish-js/markdown/firefish-js.entities.authsession.md deleted file mode 100644 index d43848ac31..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.authsession.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [AuthSession](./firefish-js.entities.authsession.md) - -## entities.AuthSession type - -**Signature:** - -```typescript -export declare type AuthSession = { - id: ID; - app: App; - token: string; -}; -``` -**References:** [ID](./firefish-js.entities.id.md), [App](./firefish-js.entities.app.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.blocking.md b/packages/firefish-js/markdown/firefish-js.entities.blocking.md deleted file mode 100644 index 189692fb92..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.blocking.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [Blocking](./firefish-js.entities.blocking.md) - -## entities.Blocking type - -**Signature:** - -```typescript -export declare type Blocking = { - id: ID; - createdAt: DateString; - blockeeId: User["id"]; - blockee: UserDetailed; -}; -``` -**References:** [ID](./firefish-js.entities.id.md), [DateString](./firefish-js.entities.datestring.md), [User](./firefish-js.entities.user.md), [UserDetailed](./firefish-js.entities.userdetailed.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.channel.md b/packages/firefish-js/markdown/firefish-js.entities.channel.md deleted file mode 100644 index 002716f8e3..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.channel.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [Channel](./firefish-js.entities.channel.md) - -## entities.Channel type - -**Signature:** - -```typescript -export declare type Channel = { - id: ID; -}; -``` -**References:** [ID](./firefish-js.entities.id.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.clip.md b/packages/firefish-js/markdown/firefish-js.entities.clip.md deleted file mode 100644 index 41979bc70a..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.clip.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [Clip](./firefish-js.entities.clip.md) - -## entities.Clip type - -**Signature:** - -```typescript -export declare type Clip = TODO; -``` diff --git a/packages/firefish-js/markdown/firefish-js.entities.customemoji.md b/packages/firefish-js/markdown/firefish-js.entities.customemoji.md deleted file mode 100644 index 4a0b1925b0..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.customemoji.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [CustomEmoji](./firefish-js.entities.customemoji.md) - -## entities.CustomEmoji type - -**Signature:** - -```typescript -export declare type CustomEmoji = { - id: string; - name: string; - url: string; - category: string; - aliases: string[]; -}; -``` diff --git a/packages/firefish-js/markdown/firefish-js.entities.datestring.md b/packages/firefish-js/markdown/firefish-js.entities.datestring.md deleted file mode 100644 index 39a9873e56..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.datestring.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [DateString](./firefish-js.entities.datestring.md) - -## entities.DateString type - -**Signature:** - -```typescript -export declare type DateString = string; -``` diff --git a/packages/firefish-js/markdown/firefish-js.entities.detailedinstancemetadata.md b/packages/firefish-js/markdown/firefish-js.entities.detailedinstancemetadata.md deleted file mode 100644 index 7629502d39..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.detailedinstancemetadata.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [DetailedInstanceMetadata](./firefish-js.entities.detailedinstancemetadata.md) - -## entities.DetailedInstanceMetadata type - -**Signature:** - -```typescript -export declare type DetailedInstanceMetadata = LiteInstanceMetadata & { - features: Record; -}; -``` -**References:** [LiteInstanceMetadata](./firefish-js.entities.liteinstancemetadata.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.drivefile.md b/packages/firefish-js/markdown/firefish-js.entities.drivefile.md deleted file mode 100644 index 1393b5c63b..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.drivefile.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [DriveFile](./firefish-js.entities.drivefile.md) - -## entities.DriveFile type - -**Signature:** - -```typescript -export declare type DriveFile = { - id: ID; - createdAt: DateString; - isSensitive: boolean; - name: string; - thumbnailUrl: string; - url: string; - type: string; - size: number; - md5: string; - blurhash: string; - comment: string | null; - properties: Record; -}; -``` -**References:** [ID](./firefish-js.entities.id.md), [DateString](./firefish-js.entities.datestring.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.drivefolder.md b/packages/firefish-js/markdown/firefish-js.entities.drivefolder.md deleted file mode 100644 index dbbefb1205..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.drivefolder.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [DriveFolder](./firefish-js.entities.drivefolder.md) - -## entities.DriveFolder type - -**Signature:** - -```typescript -export declare type DriveFolder = TODO; -``` diff --git a/packages/firefish-js/markdown/firefish-js.entities.following.md b/packages/firefish-js/markdown/firefish-js.entities.following.md deleted file mode 100644 index f5423fb876..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.following.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [Following](./firefish-js.entities.following.md) - -## entities.Following type - -**Signature:** - -```typescript -export declare type Following = { - id: ID; - createdAt: DateString; - followerId: User["id"]; - followeeId: User["id"]; -}; -``` -**References:** [ID](./firefish-js.entities.id.md), [DateString](./firefish-js.entities.datestring.md), [User](./firefish-js.entities.user.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.followingfolloweepopulated.md b/packages/firefish-js/markdown/firefish-js.entities.followingfolloweepopulated.md deleted file mode 100644 index 85ed36bf4b..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.followingfolloweepopulated.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [FollowingFolloweePopulated](./firefish-js.entities.followingfolloweepopulated.md) - -## entities.FollowingFolloweePopulated type - -**Signature:** - -```typescript -export declare type FollowingFolloweePopulated = Following & { - followee: UserDetailed; -}; -``` -**References:** [Following](./firefish-js.entities.following.md), [UserDetailed](./firefish-js.entities.userdetailed.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.followingfollowerpopulated.md b/packages/firefish-js/markdown/firefish-js.entities.followingfollowerpopulated.md deleted file mode 100644 index 50d28b5984..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.followingfollowerpopulated.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [FollowingFollowerPopulated](./firefish-js.entities.followingfollowerpopulated.md) - -## entities.FollowingFollowerPopulated type - -**Signature:** - -```typescript -export declare type FollowingFollowerPopulated = Following & { - follower: UserDetailed; -}; -``` -**References:** [Following](./firefish-js.entities.following.md), [UserDetailed](./firefish-js.entities.userdetailed.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.followrequest.md b/packages/firefish-js/markdown/firefish-js.entities.followrequest.md deleted file mode 100644 index 8fbd54b1c0..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.followrequest.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [FollowRequest](./firefish-js.entities.followrequest.md) - -## entities.FollowRequest type - -**Signature:** - -```typescript -export declare type FollowRequest = { - id: ID; - follower: User; - followee: User; -}; -``` -**References:** [ID](./firefish-js.entities.id.md), [User](./firefish-js.entities.user.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.gallerypost.md b/packages/firefish-js/markdown/firefish-js.entities.gallerypost.md deleted file mode 100644 index 057366a8e4..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.gallerypost.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [GalleryPost](./firefish-js.entities.gallerypost.md) - -## entities.GalleryPost type - -**Signature:** - -```typescript -export declare type GalleryPost = TODO; -``` diff --git a/packages/firefish-js/markdown/firefish-js.entities.id.md b/packages/firefish-js/markdown/firefish-js.entities.id.md deleted file mode 100644 index 4cc166f980..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [ID](./firefish-js.entities.id.md) - -## entities.ID type - -**Signature:** - -```typescript -export declare type ID = string; -``` diff --git a/packages/firefish-js/markdown/firefish-js.entities.instance.md b/packages/firefish-js/markdown/firefish-js.entities.instance.md deleted file mode 100644 index 6b78533b0f..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.instance.md +++ /dev/null @@ -1,40 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [Instance](./firefish-js.entities.instance.md) - -## entities.Instance type - -**Signature:** - -```typescript -export declare type Instance = { - id: ID; - caughtAt: DateString; - host: string; - usersCount: number; - notesCount: number; - followingCount: number; - followersCount: number; - driveUsage: number; - driveFiles: number; - latestRequestSentAt: DateString | null; - latestStatus: number | null; - latestRequestReceivedAt: DateString | null; - lastCommunicatedAt: DateString; - isNotResponding: boolean; - isSuspended: boolean; - softwareName: string | null; - softwareVersion: string | null; - openRegistrations: boolean | null; - name: string | null; - description: string | null; - maintainerName: string | null; - maintainerEmail: string | null; - iconUrl: string | null; - faviconUrl: string | null; - themeColor: string | null; - infoUpdatedAt: DateString | null; -}; -``` -**References:** [ID](./firefish-js.entities.id.md), [DateString](./firefish-js.entities.datestring.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.instancemetadata.md b/packages/firefish-js/markdown/firefish-js.entities.instancemetadata.md deleted file mode 100644 index c7e6f8a44d..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.instancemetadata.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [InstanceMetadata](./firefish-js.entities.instancemetadata.md) - -## entities.InstanceMetadata type - -**Signature:** - -```typescript -export declare type InstanceMetadata = - | LiteInstanceMetadata - | DetailedInstanceMetadata; -``` -**References:** [LiteInstanceMetadata](./firefish-js.entities.liteinstancemetadata.md), [DetailedInstanceMetadata](./firefish-js.entities.detailedinstancemetadata.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.liteinstancemetadata.md b/packages/firefish-js/markdown/firefish-js.entities.liteinstancemetadata.md deleted file mode 100644 index f1af7e7b35..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.liteinstancemetadata.md +++ /dev/null @@ -1,46 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [LiteInstanceMetadata](./firefish-js.entities.liteinstancemetadata.md) - -## entities.LiteInstanceMetadata type - -**Signature:** - -```typescript -export declare type LiteInstanceMetadata = { - maintainerName: string | null; - maintainerEmail: string | null; - version: string; - name: string | null; - uri: string; - description: string | null; - tosUrl: string | null; - disableRegistration: boolean; - disableLocalTimeline: boolean; - disableRecommendedTimeline: boolean; - disableGlobalTimeline: boolean; - driveCapacityPerLocalUserMb: number; - driveCapacityPerRemoteUserMb: number; - enableHcaptcha: boolean; - hcaptchaSiteKey: string | null; - enableRecaptcha: boolean; - recaptchaSiteKey: string | null; - swPublickey: string | null; - maxNoteTextLength: number; - enableEmail: boolean; - enableTwitterIntegration: boolean; - enableGithubIntegration: boolean; - enableDiscordIntegration: boolean; - enableServiceWorker: boolean; - emojis: CustomEmoji[]; - ads: { - id: ID; - ratio: number; - place: string; - url: string; - imageUrl: string; - }[]; -}; -``` -**References:** [CustomEmoji](./firefish-js.entities.customemoji.md), [ID](./firefish-js.entities.id.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.md b/packages/firefish-js/markdown/firefish-js.entities.md deleted file mode 100644 index 260bb8a8a1..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.md +++ /dev/null @@ -1,51 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) - -## entities namespace - -## Type Aliases - -| Type Alias | Description | -| --- | --- | -| [Ad](./firefish-js.entities.ad.md) | | -| [Announcement](./firefish-js.entities.announcement.md) | | -| [Antenna](./firefish-js.entities.antenna.md) | | -| [App](./firefish-js.entities.app.md) | | -| [AuthSession](./firefish-js.entities.authsession.md) | | -| [Blocking](./firefish-js.entities.blocking.md) | | -| [Channel](./firefish-js.entities.channel.md) | | -| [Clip](./firefish-js.entities.clip.md) | | -| [CustomEmoji](./firefish-js.entities.customemoji.md) | | -| [DateString](./firefish-js.entities.datestring.md) | | -| [DetailedInstanceMetadata](./firefish-js.entities.detailedinstancemetadata.md) | | -| [DriveFile](./firefish-js.entities.drivefile.md) | | -| [DriveFolder](./firefish-js.entities.drivefolder.md) | | -| [Following](./firefish-js.entities.following.md) | | -| [FollowingFolloweePopulated](./firefish-js.entities.followingfolloweepopulated.md) | | -| [FollowingFollowerPopulated](./firefish-js.entities.followingfollowerpopulated.md) | | -| [FollowRequest](./firefish-js.entities.followrequest.md) | | -| [GalleryPost](./firefish-js.entities.gallerypost.md) | | -| [ID](./firefish-js.entities.id.md) | | -| [Instance](./firefish-js.entities.instance.md) | | -| [InstanceMetadata](./firefish-js.entities.instancemetadata.md) | | -| [LiteInstanceMetadata](./firefish-js.entities.liteinstancemetadata.md) | | -| [MeDetailed](./firefish-js.entities.medetailed.md) | | -| [MessagingMessage](./firefish-js.entities.messagingmessage.md) | | -| [Note](./firefish-js.entities.note.md) | | -| [NoteFavorite](./firefish-js.entities.notefavorite.md) | | -| [NoteReaction](./firefish-js.entities.notereaction.md) | | -| [Notification](./firefish-js.entities.notification.md) | | -| [OriginType](./firefish-js.entities.origintype.md) | | -| [Page](./firefish-js.entities.page.md) | | -| [PageEvent](./firefish-js.entities.pageevent.md) | | -| [ServerInfo](./firefish-js.entities.serverinfo.md) | | -| [Signin](./firefish-js.entities.signin.md) | | -| [Stats](./firefish-js.entities.stats.md) | | -| [User](./firefish-js.entities.user.md) | | -| [UserDetailed](./firefish-js.entities.userdetailed.md) | | -| [UserGroup](./firefish-js.entities.usergroup.md) | | -| [UserList](./firefish-js.entities.userlist.md) | | -| [UserLite](./firefish-js.entities.userlite.md) | | -| [UserSorting](./firefish-js.entities.usersorting.md) | | - diff --git a/packages/firefish-js/markdown/firefish-js.entities.medetailed.md b/packages/firefish-js/markdown/firefish-js.entities.medetailed.md deleted file mode 100644 index 252f698e93..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.medetailed.md +++ /dev/null @@ -1,40 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [MeDetailed](./firefish-js.entities.medetailed.md) - -## entities.MeDetailed type - -**Signature:** - -```typescript -export declare type MeDetailed = UserDetailed & { - avatarId: DriveFile["id"]; - bannerId: DriveFile["id"]; - autoAcceptFollowed: boolean; - alwaysMarkNsfw: boolean; - carefulBot: boolean; - emailNotificationTypes: string[]; - hasPendingReceivedFollowRequest: boolean; - hasUnreadAnnouncement: boolean; - hasUnreadAntenna: boolean; - hasUnreadChannel: boolean; - hasUnreadMentions: boolean; - hasUnreadMessagingMessage: boolean; - hasUnreadNotification: boolean; - hasUnreadSpecifiedNotes: boolean; - hideOnlineStatus: boolean; - injectFeaturedNote: boolean; - integrations: Record; - isDeleted: boolean; - isExplorable: boolean; - mutedWords: string[][]; - mutingNotificationTypes: string[]; - noCrawle: boolean; - preventAiLearning: boolean; - receiveAnnouncementEmail: boolean; - usePasswordLessLogin: boolean; - [other: string]: any; -}; -``` -**References:** [UserDetailed](./firefish-js.entities.userdetailed.md), [DriveFile](./firefish-js.entities.drivefile.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.messagingmessage.md b/packages/firefish-js/markdown/firefish-js.entities.messagingmessage.md deleted file mode 100644 index 41869577ec..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.messagingmessage.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [MessagingMessage](./firefish-js.entities.messagingmessage.md) - -## entities.MessagingMessage type - -**Signature:** - -```typescript -export declare type MessagingMessage = { - id: ID; - createdAt: DateString; - file: DriveFile | null; - fileId: DriveFile["id"] | null; - isRead: boolean; - reads: User["id"][]; - text: string | null; - user: User; - userId: User["id"]; - recipient?: User | null; - recipientId: User["id"] | null; - group?: UserGroup | null; - groupId: UserGroup["id"] | null; -}; -``` -**References:** [ID](./firefish-js.entities.id.md), [DateString](./firefish-js.entities.datestring.md), [DriveFile](./firefish-js.entities.drivefile.md), [User](./firefish-js.entities.user.md), [UserGroup](./firefish-js.entities.usergroup.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.note.md b/packages/firefish-js/markdown/firefish-js.entities.note.md deleted file mode 100644 index 0d17b96c7d..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.note.md +++ /dev/null @@ -1,51 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [Note](./firefish-js.entities.note.md) - -## entities.Note type - -**Signature:** - -```typescript -export declare type Note = { - id: ID; - createdAt: DateString; - text: string | null; - cw: string | null; - user: User; - userId: User["id"]; - reply?: Note; - replyId: Note["id"]; - renote?: Note; - renoteId: Note["id"]; - files: DriveFile[]; - fileIds: DriveFile["id"][]; - visibility: "public" | "home" | "followers" | "specified"; - visibleUserIds?: User["id"][]; - localOnly?: boolean; - channel?: Channel["id"]; - myReaction?: string; - reactions: Record; - renoteCount: number; - repliesCount: number; - poll?: { - expiresAt: DateString | null; - multiple: boolean; - choices: { - isVoted: boolean; - text: string; - votes: number; - }[]; - }; - emojis: { - name: string; - url: string; - }[]; - uri?: string; - url?: string; - updatedAt?: DateString; - isHidden?: boolean; -}; -``` -**References:** [ID](./firefish-js.entities.id.md), [DateString](./firefish-js.entities.datestring.md), [User](./firefish-js.entities.user.md), [Note](./firefish-js.entities.note.md), [DriveFile](./firefish-js.entities.drivefile.md), [Channel](./firefish-js.entities.channel.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.notefavorite.md b/packages/firefish-js/markdown/firefish-js.entities.notefavorite.md deleted file mode 100644 index c5331fbbe0..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.notefavorite.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [NoteFavorite](./firefish-js.entities.notefavorite.md) - -## entities.NoteFavorite type - -**Signature:** - -```typescript -export declare type NoteFavorite = { - id: ID; - createdAt: DateString; - noteId: Note["id"]; - note: Note; -}; -``` -**References:** [ID](./firefish-js.entities.id.md), [DateString](./firefish-js.entities.datestring.md), [Note](./firefish-js.entities.note.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.notereaction.md b/packages/firefish-js/markdown/firefish-js.entities.notereaction.md deleted file mode 100644 index c17614e363..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.notereaction.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [NoteReaction](./firefish-js.entities.notereaction.md) - -## entities.NoteReaction type - -**Signature:** - -```typescript -export declare type NoteReaction = { - id: ID; - createdAt: DateString; - user: UserLite; - type: string; -}; -``` -**References:** [ID](./firefish-js.entities.id.md), [DateString](./firefish-js.entities.datestring.md), [UserLite](./firefish-js.entities.userlite.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.notification.md b/packages/firefish-js/markdown/firefish-js.entities.notification.md deleted file mode 100644 index 700aed0f1c..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.notification.md +++ /dev/null @@ -1,82 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [Notification](./firefish-js.entities.notification.md) - -## entities.Notification type - -**Signature:** - -```typescript -export declare type Notification = { - id: ID; - createdAt: DateString; - isRead: boolean; -} & ( - | { - type: "reaction"; - reaction: string; - user: User; - userId: User["id"]; - note: Note; - } - | { - type: "reply"; - user: User; - userId: User["id"]; - note: Note; - } - | { - type: "renote"; - user: User; - userId: User["id"]; - note: Note; - } - | { - type: "quote"; - user: User; - userId: User["id"]; - note: Note; - } - | { - type: "mention"; - user: User; - userId: User["id"]; - note: Note; - } - | { - type: "pollVote"; - user: User; - userId: User["id"]; - note: Note; - } - | { - type: "follow"; - user: User; - userId: User["id"]; - } - | { - type: "followRequestAccepted"; - user: User; - userId: User["id"]; - } - | { - type: "receiveFollowRequest"; - user: User; - userId: User["id"]; - } - | { - type: "groupInvited"; - invitation: UserGroup; - user: User; - userId: User["id"]; - } - | { - type: "app"; - header?: string | null; - body: string; - icon?: string | null; - } -); -``` -**References:** [ID](./firefish-js.entities.id.md), [DateString](./firefish-js.entities.datestring.md), [User](./firefish-js.entities.user.md), [Note](./firefish-js.entities.note.md), [UserGroup](./firefish-js.entities.usergroup.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.origintype.md b/packages/firefish-js/markdown/firefish-js.entities.origintype.md deleted file mode 100644 index f0b6134189..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.origintype.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [OriginType](./firefish-js.entities.origintype.md) - -## entities.OriginType type - -**Signature:** - -```typescript -export declare type OriginType = "combined" | "local" | "remote"; -``` diff --git a/packages/firefish-js/markdown/firefish-js.entities.page.md b/packages/firefish-js/markdown/firefish-js.entities.page.md deleted file mode 100644 index 92fddd7946..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.page.md +++ /dev/null @@ -1,33 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [Page](./firefish-js.entities.page.md) - -## entities.Page type - -**Signature:** - -```typescript -export declare type Page = { - id: ID; - createdAt: DateString; - updatedAt: DateString; - userId: User["id"]; - user: User; - content: Record[]; - variables: Record[]; - title: string; - name: string; - summary: string | null; - hideTitleWhenPinned: boolean; - alignCenter: boolean; - font: string; - script: string; - eyeCatchingImageId: DriveFile["id"] | null; - eyeCatchingImage: DriveFile | null; - attachedFiles: any; - likedCount: number; - isLiked?: boolean; -}; -``` -**References:** [ID](./firefish-js.entities.id.md), [DateString](./firefish-js.entities.datestring.md), [User](./firefish-js.entities.user.md), [DriveFile](./firefish-js.entities.drivefile.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.pageevent.md b/packages/firefish-js/markdown/firefish-js.entities.pageevent.md deleted file mode 100644 index 8ce209a3d2..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.pageevent.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [PageEvent](./firefish-js.entities.pageevent.md) - -## entities.PageEvent type - -**Signature:** - -```typescript -export declare type PageEvent = { - pageId: Page["id"]; - event: string; - var: any; - userId: User["id"]; - user: User; -}; -``` -**References:** [Page](./firefish-js.entities.page.md), [User](./firefish-js.entities.user.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.serverinfo.md b/packages/firefish-js/markdown/firefish-js.entities.serverinfo.md deleted file mode 100644 index 3c7e10980d..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.serverinfo.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [ServerInfo](./firefish-js.entities.serverinfo.md) - -## entities.ServerInfo type - -**Signature:** - -```typescript -export declare type ServerInfo = { - machine: string; - cpu: { - model: string; - cores: number; - }; - mem: { - total: number; - }; - fs: { - total: number; - used: number; - }; -}; -``` diff --git a/packages/firefish-js/markdown/firefish-js.entities.signin.md b/packages/firefish-js/markdown/firefish-js.entities.signin.md deleted file mode 100644 index 8c67d7c083..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.signin.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [Signin](./firefish-js.entities.signin.md) - -## entities.Signin type - -**Signature:** - -```typescript -export declare type Signin = { - id: ID; - createdAt: DateString; - ip: string; - headers: Record; - success: boolean; -}; -``` -**References:** [ID](./firefish-js.entities.id.md), [DateString](./firefish-js.entities.datestring.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.stats.md b/packages/firefish-js/markdown/firefish-js.entities.stats.md deleted file mode 100644 index 36cce7da7c..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.stats.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [Stats](./firefish-js.entities.stats.md) - -## entities.Stats type - -**Signature:** - -```typescript -export declare type Stats = { - notesCount: number; - originalNotesCount: number; - usersCount: number; - originalUsersCount: number; - instances: number; - driveUsageLocal: number; - driveUsageRemote: number; -}; -``` diff --git a/packages/firefish-js/markdown/firefish-js.entities.user.md b/packages/firefish-js/markdown/firefish-js.entities.user.md deleted file mode 100644 index b3795a1355..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.user.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [User](./firefish-js.entities.user.md) - -## entities.User type - -**Signature:** - -```typescript -export declare type User = UserLite | UserDetailed; -``` -**References:** [UserLite](./firefish-js.entities.userlite.md), [UserDetailed](./firefish-js.entities.userdetailed.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.userdetailed.md b/packages/firefish-js/markdown/firefish-js.entities.userdetailed.md deleted file mode 100644 index 839f0105a5..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.userdetailed.md +++ /dev/null @@ -1,56 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [UserDetailed](./firefish-js.entities.userdetailed.md) - -## entities.UserDetailed type - -**Signature:** - -```typescript -export declare type UserDetailed = UserLite & { - bannerBlurhash: string | null; - bannerColor: string | null; - bannerUrl: string | null; - birthday: string | null; - createdAt: DateString; - description: string | null; - ffVisibility: "public" | "followers" | "private"; - fields: { - name: string; - value: string; - }[]; - followersCount: number; - followingCount: number; - hasPendingFollowRequestFromYou: boolean; - hasPendingFollowRequestToYou: boolean; - isAdmin: boolean; - isBlocked: boolean; - isBlocking: boolean; - isBot: boolean; - isCat: boolean; - isFollowed: boolean; - isFollowing: boolean; - isLocked: boolean; - isModerator: boolean; - isMuted: boolean; - isRenoteMuted: boolean; - isSilenced: boolean; - isSuspended: boolean; - lang: string | null; - lastFetchedAt?: DateString; - location: string | null; - notesCount: number; - pinnedNoteIds: ID[]; - pinnedNotes: Note[]; - pinnedPage: Page | null; - pinnedPageId: string | null; - publicReactions: boolean; - securityKeys: boolean; - twoFactorEnabled: boolean; - updatedAt: DateString | null; - uri: string | null; - url: string | null; -}; -``` -**References:** [UserLite](./firefish-js.entities.userlite.md), [DateString](./firefish-js.entities.datestring.md), [ID](./firefish-js.entities.id.md), [Note](./firefish-js.entities.note.md), [Page](./firefish-js.entities.page.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.usergroup.md b/packages/firefish-js/markdown/firefish-js.entities.usergroup.md deleted file mode 100644 index bffa8e9f01..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.usergroup.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [UserGroup](./firefish-js.entities.usergroup.md) - -## entities.UserGroup type - -**Signature:** - -```typescript -export declare type UserGroup = TODO; -``` diff --git a/packages/firefish-js/markdown/firefish-js.entities.userlist.md b/packages/firefish-js/markdown/firefish-js.entities.userlist.md deleted file mode 100644 index d049f0899e..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.userlist.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [UserList](./firefish-js.entities.userlist.md) - -## entities.UserList type - -**Signature:** - -```typescript -export declare type UserList = { - id: ID; - createdAt: DateString; - name: string; - userIds: User["id"][]; -}; -``` -**References:** [ID](./firefish-js.entities.id.md), [DateString](./firefish-js.entities.datestring.md), [User](./firefish-js.entities.user.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.userlite.md b/packages/firefish-js/markdown/firefish-js.entities.userlite.md deleted file mode 100644 index 0111a39a6a..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.userlite.md +++ /dev/null @@ -1,35 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [UserLite](./firefish-js.entities.userlite.md) - -## entities.UserLite type - -**Signature:** - -```typescript -export declare type UserLite = { - id: ID; - username: string; - host: string | null; - name: string; - onlineStatus: "online" | "active" | "offline" | "unknown"; - avatarUrl: string; - avatarBlurhash: string; - alsoKnownAs: string[]; - movedToUri: any; - emojis: { - name: string; - url: string; - }[]; - instance?: { - name: Instance["name"]; - softwareName: Instance["softwareName"]; - softwareVersion: Instance["softwareVersion"]; - iconUrl: Instance["iconUrl"]; - faviconUrl: Instance["faviconUrl"]; - themeColor: Instance["themeColor"]; - }; -}; -``` -**References:** [ID](./firefish-js.entities.id.md), [Instance](./firefish-js.entities.instance.md) - diff --git a/packages/firefish-js/markdown/firefish-js.entities.usersorting.md b/packages/firefish-js/markdown/firefish-js.entities.usersorting.md deleted file mode 100644 index be9ebb81d1..0000000000 --- a/packages/firefish-js/markdown/firefish-js.entities.usersorting.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [entities](./firefish-js.entities.md) > [UserSorting](./firefish-js.entities.usersorting.md) - -## entities.UserSorting type - -**Signature:** - -```typescript -export declare type UserSorting = - | "+follower" - | "-follower" - | "+createdAt" - | "-createdAt" - | "+updatedAt" - | "-updatedAt"; -``` diff --git a/packages/firefish-js/markdown/firefish-js.ffvisibility.md b/packages/firefish-js/markdown/firefish-js.ffvisibility.md deleted file mode 100644 index 9cee2dc387..0000000000 --- a/packages/firefish-js/markdown/firefish-js.ffvisibility.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [ffVisibility](./firefish-js.ffvisibility.md) - -## ffVisibility variable - -**Signature:** - -```typescript -ffVisibility: readonly ["public", "followers", "private"] -``` diff --git a/packages/firefish-js/markdown/firefish-js.md b/packages/firefish-js/markdown/firefish-js.md deleted file mode 100644 index 03e0519189..0000000000 --- a/packages/firefish-js/markdown/firefish-js.md +++ /dev/null @@ -1,43 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) - -## firefish-js package - -## Classes - -| Class | Description | -| --- | --- | -| [Stream](./firefish-js.stream.md) | | - -## Abstract Classes - -| Abstract Class | Description | -| --- | --- | -| [ChannelConnection](./firefish-js.channelconnection.md) | | - -## Namespaces - -| Namespace | Description | -| --- | --- | -| [api](./firefish-js.api.md) | | -| [entities](./firefish-js.entities.md) | | - -## Variables - -| Variable | Description | -| --- | --- | -| [ffVisibility](./firefish-js.ffvisibility.md) | | -| [mutedNoteReasons](./firefish-js.mutednotereasons.md) | | -| [noteVisibilities](./firefish-js.notevisibilities.md) | | -| [notificationTypes](./firefish-js.notificationtypes.md) | | -| [permissions](./firefish-js.permissions.md) | | - -## Type Aliases - -| Type Alias | Description | -| --- | --- | -| [Acct](./firefish-js.acct.md) | | -| [Channels](./firefish-js.channels.md) | | -| [Endpoints](./firefish-js.endpoints.md) | | - diff --git a/packages/firefish-js/markdown/firefish-js.mutednotereasons.md b/packages/firefish-js/markdown/firefish-js.mutednotereasons.md deleted file mode 100644 index 537d897ce6..0000000000 --- a/packages/firefish-js/markdown/firefish-js.mutednotereasons.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [mutedNoteReasons](./firefish-js.mutednotereasons.md) - -## mutedNoteReasons variable - -**Signature:** - -```typescript -mutedNoteReasons: readonly [ - "word", - "manual", - "spam", - "other", -] -``` diff --git a/packages/firefish-js/markdown/firefish-js.notevisibilities.md b/packages/firefish-js/markdown/firefish-js.notevisibilities.md deleted file mode 100644 index c39e4075cc..0000000000 --- a/packages/firefish-js/markdown/firefish-js.notevisibilities.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [noteVisibilities](./firefish-js.notevisibilities.md) - -## noteVisibilities variable - -**Signature:** - -```typescript -noteVisibilities: readonly [ - "public", - "home", - "followers", - "specified", -] -``` diff --git a/packages/firefish-js/markdown/firefish-js.notificationtypes.md b/packages/firefish-js/markdown/firefish-js.notificationtypes.md deleted file mode 100644 index 49ae568d52..0000000000 --- a/packages/firefish-js/markdown/firefish-js.notificationtypes.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [notificationTypes](./firefish-js.notificationtypes.md) - -## notificationTypes variable - -**Signature:** - -```typescript -notificationTypes: readonly [ - "follow", - "mention", - "reply", - "renote", - "quote", - "reaction", - "pollVote", - "pollEnded", - "receiveFollowRequest", - "followRequestAccepted", - "groupInvited", - "app", -] -``` diff --git a/packages/firefish-js/markdown/firefish-js.permissions.md b/packages/firefish-js/markdown/firefish-js.permissions.md deleted file mode 100644 index 937a41de1e..0000000000 --- a/packages/firefish-js/markdown/firefish-js.permissions.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [permissions](./firefish-js.permissions.md) - -## permissions variable - -**Signature:** - -```typescript -permissions: string[] -``` diff --git a/packages/firefish-js/markdown/firefish-js.stream._constructor_.md b/packages/firefish-js/markdown/firefish-js.stream._constructor_.md deleted file mode 100644 index 908972661d..0000000000 --- a/packages/firefish-js/markdown/firefish-js.stream._constructor_.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [Stream](./firefish-js.stream.md) > [(constructor)](./firefish-js.stream._constructor_.md) - -## Stream.(constructor) - -Constructs a new instance of the `Stream` class - -**Signature:** - -```typescript -constructor( - origin: string, - user: { - token: string; - } | null, - options?: { - WebSocket?: any; - }, - ); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| origin | string | | -| user | { token: string; } \| null | | -| options | { WebSocket?: any; } | _(Optional)_ | - diff --git a/packages/firefish-js/markdown/firefish-js.stream.close.md b/packages/firefish-js/markdown/firefish-js.stream.close.md deleted file mode 100644 index c37d8c0459..0000000000 --- a/packages/firefish-js/markdown/firefish-js.stream.close.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [Stream](./firefish-js.stream.md) > [close](./firefish-js.stream.close.md) - -## Stream.close() method - -**Signature:** - -```typescript -close(): void; -``` -**Returns:** - -void - diff --git a/packages/firefish-js/markdown/firefish-js.stream.disconnecttochannel.md b/packages/firefish-js/markdown/firefish-js.stream.disconnecttochannel.md deleted file mode 100644 index c3944ecc87..0000000000 --- a/packages/firefish-js/markdown/firefish-js.stream.disconnecttochannel.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [Stream](./firefish-js.stream.md) > [disconnectToChannel](./firefish-js.stream.disconnecttochannel.md) - -## Stream.disconnectToChannel() method - -**Signature:** - -```typescript -disconnectToChannel(connection: NonSharedConnection): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| connection | NonSharedConnection | | - -**Returns:** - -void - diff --git a/packages/firefish-js/markdown/firefish-js.stream.md b/packages/firefish-js/markdown/firefish-js.stream.md deleted file mode 100644 index 91c8bb6508..0000000000 --- a/packages/firefish-js/markdown/firefish-js.stream.md +++ /dev/null @@ -1,36 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [Stream](./firefish-js.stream.md) - -## Stream class - -**Signature:** - -```typescript -export default class Stream extends EventEmitter -``` -**Extends:** EventEmitter<StreamEvents> - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(origin, user, options)](./firefish-js.stream._constructor_.md) | | Constructs a new instance of the Stream class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [state](./firefish-js.stream.state.md) | | "initializing" \| "reconnecting" \| "connected" | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [close()](./firefish-js.stream.close.md) | | | -| [disconnectToChannel(connection)](./firefish-js.stream.disconnecttochannel.md) | | | -| [removeSharedConnection(connection)](./firefish-js.stream.removesharedconnection.md) | | | -| [removeSharedConnectionPool(pool)](./firefish-js.stream.removesharedconnectionpool.md) | | | -| [send(typeOrPayload, payload)](./firefish-js.stream.send.md) | | | -| [useChannel(channel, params, name)](./firefish-js.stream.usechannel.md) | | | - diff --git a/packages/firefish-js/markdown/firefish-js.stream.removesharedconnection.md b/packages/firefish-js/markdown/firefish-js.stream.removesharedconnection.md deleted file mode 100644 index cddf982fab..0000000000 --- a/packages/firefish-js/markdown/firefish-js.stream.removesharedconnection.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [Stream](./firefish-js.stream.md) > [removeSharedConnection](./firefish-js.stream.removesharedconnection.md) - -## Stream.removeSharedConnection() method - -**Signature:** - -```typescript -removeSharedConnection(connection: SharedConnection): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| connection | SharedConnection | | - -**Returns:** - -void - diff --git a/packages/firefish-js/markdown/firefish-js.stream.removesharedconnectionpool.md b/packages/firefish-js/markdown/firefish-js.stream.removesharedconnectionpool.md deleted file mode 100644 index fd56dd287c..0000000000 --- a/packages/firefish-js/markdown/firefish-js.stream.removesharedconnectionpool.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [Stream](./firefish-js.stream.md) > [removeSharedConnectionPool](./firefish-js.stream.removesharedconnectionpool.md) - -## Stream.removeSharedConnectionPool() method - -**Signature:** - -```typescript -removeSharedConnectionPool(pool: Pool): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| pool | Pool | | - -**Returns:** - -void - diff --git a/packages/firefish-js/markdown/firefish-js.stream.send.md b/packages/firefish-js/markdown/firefish-js.stream.send.md deleted file mode 100644 index 4defb4d187..0000000000 --- a/packages/firefish-js/markdown/firefish-js.stream.send.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [Stream](./firefish-js.stream.md) > [send](./firefish-js.stream.send.md) - -## Stream.send() method - -**Signature:** - -```typescript -send(typeOrPayload: any, payload?: any): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| typeOrPayload | any | | -| payload | any | _(Optional)_ | - -**Returns:** - -void - diff --git a/packages/firefish-js/markdown/firefish-js.stream.state.md b/packages/firefish-js/markdown/firefish-js.stream.state.md deleted file mode 100644 index 4ad898f878..0000000000 --- a/packages/firefish-js/markdown/firefish-js.stream.state.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [Stream](./firefish-js.stream.md) > [state](./firefish-js.stream.state.md) - -## Stream.state property - -**Signature:** - -```typescript -state: "initializing" | "reconnecting" | "connected"; -``` diff --git a/packages/firefish-js/markdown/firefish-js.stream.usechannel.md b/packages/firefish-js/markdown/firefish-js.stream.usechannel.md deleted file mode 100644 index 791ac17a35..0000000000 --- a/packages/firefish-js/markdown/firefish-js.stream.usechannel.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [firefish-js](./firefish-js.md) > [Stream](./firefish-js.stream.md) > [useChannel](./firefish-js.stream.usechannel.md) - -## Stream.useChannel() method - -**Signature:** - -```typescript -useChannel( - channel: C, - params?: Channels[C]["params"], - name?: string, - ): Connection; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| channel | C | | -| params | [Channels](./firefish-js.channels.md)\[C\]\["params"\] | _(Optional)_ | -| name | string | _(Optional)_ | - -**Returns:** - -[Connection](./firefish-js.channelconnection.md)<[Channels](./firefish-js.channels.md)\[C\]> - diff --git a/packages/firefish-js/markdown/index.md b/packages/firefish-js/markdown/index.md deleted file mode 100644 index 0eebad9831..0000000000 --- a/packages/firefish-js/markdown/index.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) - -## API Reference - -## Packages - -| Package | Description | -| --- | --- | -| [firefish-js](./firefish-js.md) | | - diff --git a/packages/firefish-js/package.json b/packages/firefish-js/package.json index a9e4e2ee9e..dd597032c2 100644 --- a/packages/firefish-js/package.json +++ b/packages/firefish-js/package.json @@ -1,19 +1,14 @@ { "name": "firefish-js", - "version": "0.0.24", + "version": "0.0.25", "description": "Firefish SDK for JavaScript", "main": "./built/index.js", "types": "./built/index.d.ts", "scripts": { "build": "pnpm swc src -d built -D", "build:debug": "pnpm swc src -d built -s -D", - "render": "pnpm run build && pnpm run api && pnpm run api-prod && cp temp/firefish-js.api.json etc/ && pnpm run api-doc", - "tsd": "tsc && tsd", - "api": "pnpm api-extractor run --local --verbose", - "api-prod": "pnpm api-extractor run --verbose", - "api-doc": "pnpm api-documenter markdown -i ./etc/", - "lint": "pnpm biome check --apply *.ts", - "format": "pnpm biome format --write **/*.ts", + "lint": "pnpm biome check --apply src", + "format": "pnpm biome format --write src", "jest": "jest --coverage --detectOpenHandles", "test": "pnpm jest && pnpm tsd" }, @@ -22,8 +17,6 @@ "url": "https://git.joinfirefish.org/firefish/firefish.git" }, "devDependencies": { - "@microsoft/api-extractor": "^7.36.0", - "@microsoft/api-documenter": "^7.22.21", "@swc/cli": "^0.1.62", "@swc/core": "1.3.78", "@types/jest": "^27.4.0", @@ -37,12 +30,10 @@ "tsd": "^0.28.1", "typescript": "5.1.3" }, - "files": [ - "built" - ], + "files": ["built"], "dependencies": { "eventemitter3": "^4.0.7", - "reconnecting-websocket": "^4.4.0", + "reconnecting": "^4.4.1", "semver": "^7.3.8" }, "optionalDependencies": { diff --git a/packages/firefish-js/src/streaming.ts b/packages/firefish-js/src/streaming.ts index 924e33a45c..7d27c646ef 100644 --- a/packages/firefish-js/src/streaming.ts +++ b/packages/firefish-js/src/streaming.ts @@ -1,5 +1,5 @@ import { EventEmitter } from "eventemitter3"; -import ReconnectingWebsocket from "reconnecting-websocket"; +import ReconnectingWebsocket from "reconnecting"; import { BroadcastEvents, Channels } from "./streaming.types"; function autobind(instance: any): void { @@ -81,7 +81,6 @@ export default class Stream extends EventEmitter { `${wsOrigin}/streaming?${query}`, "", { - minReconnectionDelay: 1, // https://github.com/pladaria/reconnecting-websocket/issues/91 WebSocket: options.WebSocket, }, ); diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 42feff5589..fe9aecb444 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -85,8 +85,8 @@ importers: specifier: ^1.0.4 version: 1.0.4 pnpm: - specifier: 8.8.0 - version: 8.8.0 + specifier: 8.9.2 + version: 8.9.2 start-server-and-test: specifier: 1.15.2 version: 1.15.2 @@ -896,9 +896,9 @@ importers: eventemitter3: specifier: ^4.0.7 version: 4.0.7 - reconnecting-websocket: - specifier: ^4.4.0 - version: 4.4.0 + reconnecting: + specifier: ^4.4.1 + version: 4.4.1 semver: specifier: ^7.3.8 version: 7.5.4 @@ -6982,6 +6982,7 @@ packages: /commander@9.5.0: resolution: {integrity: sha512-KRs7WVDKg86PWiuAqhDrAQnTXZKraVcCc6vFdL14qrZ/DcWwuRo7VoiYXalXO7S5GKpqYiVEwCbgFDfxNHKJBQ==} engines: {node: ^12.20.0 || >=14} + requiresBuild: true dev: true /comment-parser@1.4.0: @@ -15009,8 +15010,8 @@ packages: engines: {node: '>=14.19.0'} dev: false - /pnpm@8.8.0: - resolution: {integrity: sha512-eY5rMiZpzmPI2oVr1irR97bzb036oKwCWvK91wDQndXcqUPlytPtrF0bO668Syw/uA+7hTf5NnM8Mr4ux4BRRA==} + /pnpm@8.9.2: + resolution: {integrity: sha512-udNf6RsqWFTa3EMDSj57LmdfpLVuIOjgnvB4+lU8GPiu1EBR57Nui43UNfl+sMRMT/O0T8fG+n0h4frBe75mHg==} engines: {node: '>=16.14'} hasBin: true dev: true @@ -15869,8 +15870,8 @@ packages: resolve: 1.22.4 dev: true - /reconnecting-websocket@4.4.0: - resolution: {integrity: sha512-D2E33ceRPga0NvTDhJmphEgJ7FUYF0v4lr1ki0csq06OdlxKfugGzN0dSkxM/NfqCxYELK4KcaTOUOjTV6Dcng==} + /reconnecting@4.4.1: + resolution: {integrity: sha512-2GU8WqGpWVB0FcqJNbTDdRVSTw8W2205r+tWx8EVkFa8Oi5N2pbJeNPm9jHQNjDeQcqVILRNZfUX2RRHu6Zdog==} dev: false /redent@3.0.0: