diff --git a/packages/backend/src/server/api/mastodon/endpoints/account.ts b/packages/backend/src/server/api/mastodon/endpoints/account.ts index f72b4657d..36b49c900 100644 --- a/packages/backend/src/server/api/mastodon/endpoints/account.ts +++ b/packages/backend/src/server/api/mastodon/endpoints/account.ts @@ -71,7 +71,7 @@ export class ApiAccountMastodon { public async lookup() { try { - const data = await this.client.search((this.request.query as any).acct, 'accounts'); + const data = await this.client.search((this.request.query as any).acct, { type: 'accounts' }); return convertAccount(data.data.accounts[0]); } catch (e: any) { /* console.error(e); diff --git a/packages/backend/src/server/api/mastodon/endpoints/search.ts b/packages/backend/src/server/api/mastodon/endpoints/search.ts index 79195ee9a..5c68402ed 100644 --- a/packages/backend/src/server/api/mastodon/endpoints/search.ts +++ b/packages/backend/src/server/api/mastodon/endpoints/search.ts @@ -23,7 +23,7 @@ async function getHighlight( }); const api = await apicall.json(); const data: MisskeyEntity.Note[] = api; - return data.map((note) => new Converter(BASE_URL).note(note, domain)); + return data.map((note) => Converter.note(note, domain)); } catch (e: any) { console.log(e); console.log(e.response.data); @@ -49,7 +49,7 @@ async function getFeaturedUser( BASE_URL: string, host: string, accessTokens: st return data.map((u) => { return { source: 'past_interactions', - account: new Converter(BASE_URL).userDetail(u, host), + account: Converter.userDetail(u, host), }; }); } catch (e: any) { diff --git a/packages/backend/src/server/api/mastodon/endpoints/status.ts b/packages/backend/src/server/api/mastodon/endpoints/status.ts index b3faa7f0e..5ce0c8941 100644 --- a/packages/backend/src/server/api/mastodon/endpoints/status.ts +++ b/packages/backend/src/server/api/mastodon/endpoints/status.ts @@ -171,7 +171,7 @@ export class ApiStatusMastodon { try { const id = body.in_reply_to_id; const post = await client.getStatus(id); - const react = post.data.reactions.filter((e: any) => e.me)[0].name; + const react = post.data.emoji_reactions.filter((e: any) => e.me)[0].name; const data = await client.deleteEmojiReaction(id, react); reply.send(data.data); } catch (e: any) { diff --git a/packages/backend/src/server/oauth/oauth2.txt b/packages/backend/src/server/oauth/oauth2.txt deleted file mode 100644 index cd96cda12..000000000 --- a/packages/backend/src/server/oauth/oauth2.txt +++ /dev/null @@ -1,489 +0,0 @@ -/* - * SPDX-FileCopyrightText: syuilo and other misskey contributors - * SPDX-License-Identifier: AGPL-3.0-only - */ - -import dns from 'node:dns/promises'; -import { fileURLToPath } from 'node:url'; -import { Inject, Injectable } from '@nestjs/common'; -import { JSDOM } from 'jsdom'; -import httpLinkHeader from 'http-link-header'; -import ipaddr from 'ipaddr.js'; -import oauth2orize, { type OAuth2, AuthorizationError, ValidateFunctionArity2, OAuth2Req, MiddlewareRequest } from 'oauth2orize'; -import oauth2Pkce from 'oauth2orize-pkce'; -import fastifyView from '@fastify/view'; -import pug from 'pug'; -import bodyParser from 'body-parser'; -import fastifyExpress from '@fastify/express'; -import { verifyChallenge } from 'pkce-challenge'; -import { mf2 } from 'microformats-parser'; -import { secureRndstr } from '@/misc/secure-rndstr.js'; -import { HttpRequestService } from '@/core/HttpRequestService.js'; -import { kinds } from '@/misc/api-permissions.js'; -import type { Config } from '@/config.js'; -import { DI } from '@/di-symbols.js'; -import { bindThis } from '@/decorators.js'; -import type { AccessTokensRepository, UsersRepository } from '@/models/_.js'; -import { IdService } from '@/core/IdService.js'; -import { CacheService } from '@/core/CacheService.js'; -import type { MiLocalUser } from '@/models/User.js'; -import { MemoryKVCache } from '@/misc/cache.js'; -import { LoggerService } from '@/core/LoggerService.js'; -import Logger from '@/logger.js'; -import { StatusError } from '@/misc/status-error.js'; -import type { ServerResponse } from 'node:http'; -import type { FastifyInstance } from 'fastify'; -const base64regex = /^([0-9a-zA-Z+/]{4})*(([0-9a-zA-Z+/]{2}==)|([0-9a-zA-Z+/]{3}=))?$/; - -// TODO: Consider migrating to @node-oauth/oauth2-server once -// https://github.com/node-oauth/node-oauth2-server/issues/180 is figured out. -// Upstream the various validations and RFC9207 implementation in that case. - -// Follows https://indieauth.spec.indieweb.org/#client-identifier -// This is also mostly similar to https://developers.google.com/identity/protocols/oauth2/web-server#uri-validation -// although Google has stricter rule. -function validateClientId(raw: string): URL { - // "Clients are identified by a [URL]." - const url = ((): URL => { - try { - if (base64regex.test(raw)) return new URL(atob(raw)); - return new URL(raw); - } catch { throw new AuthorizationError('client_id must be a valid URL', 'invalid_request'); } - })(); - - // "Client identifier URLs MUST have either an https or http scheme" - // But then again: - // https://datatracker.ietf.org/doc/html/rfc6749.html#section-3.1.2.1 - // 'The redirection endpoint SHOULD require the use of TLS as described - // in Section 1.6 when the requested response type is "code" or "token"' - const allowedProtocols = process.env.NODE_ENV === 'test' ? ['http:', 'https:'] : ['https:']; - if (!allowedProtocols.includes(url.protocol)) { - throw new AuthorizationError('client_id must be a valid HTTPS URL', 'invalid_request'); - } - - // "MUST contain a path component (new URL() implicitly adds one)" - - // "MUST NOT contain single-dot or double-dot path segments," - const segments = url.pathname.split('/'); - if (segments.includes('.') || segments.includes('..')) { - throw new AuthorizationError('client_id must not contain dot path segments', 'invalid_request'); - } - - // ("MAY contain a query string component") - - // "MUST NOT contain a fragment component" - if (url.hash) { - throw new AuthorizationError('client_id must not contain a fragment component', 'invalid_request'); - } - - // "MUST NOT contain a username or password component" - if (url.username || url.password) { - throw new AuthorizationError('client_id must not contain a username or a password', 'invalid_request'); - } - - // ("MAY contain a port") - - // "host names MUST be domain names or a loopback interface and MUST NOT be - // IPv4 or IPv6 addresses except for IPv4 127.0.0.1 or IPv6 [::1]." - if (!url.hostname.match(/\.\w+$/) && !['localhost', '127.0.0.1', '[::1]'].includes(url.hostname)) { - throw new AuthorizationError('client_id must have a domain name as a host name', 'invalid_request'); - } - - return url; -} - -interface ClientInformation { - id: string; - redirectUris: string[]; - name: string; -} - -// https://indieauth.spec.indieweb.org/#client-information-discovery -// "Authorization servers SHOULD support parsing the [h-app] Microformat from the client_id, -// and if there is an [h-app] with a url property matching the client_id URL, -// then it should use the name and icon and display them on the authorization prompt." -// (But we don't display any icon for now) -// https://indieauth.spec.indieweb.org/#redirect-url -// "The client SHOULD publish one or more tags or Link HTTP headers with a rel attribute -// of redirect_uri at the client_id URL. -// Authorization endpoints verifying that a redirect_uri is allowed for use by a client MUST -// look for an exact match of the given redirect_uri in the request against the list of -// redirect_uris discovered after resolving any relative URLs." -async function discoverClientInformation(logger: Logger, httpRequestService: HttpRequestService, id: string): Promise { - try { - const res = await httpRequestService.send(id); - const redirectUris: string[] = []; - - const linkHeader = res.headers.get('link'); - if (linkHeader) { - redirectUris.push(...httpLinkHeader.parse(linkHeader).get('rel', 'redirect_uri').map(r => r.uri)); - } - - const text = await res.text(); - const fragment = JSDOM.fragment(text); - - redirectUris.push(...[...fragment.querySelectorAll('link[rel=redirect_uri][href]')].map(el => el.href)); - - let name = id; - if (text) { - const microformats = mf2(text, { baseUrl: res.url }); - const nameProperty = microformats.items.find(item => item.type?.includes('h-app') && item.properties.url.includes(id))?.properties.name[0]; - if (typeof nameProperty === 'string') { - name = nameProperty; - } - } - - return { - id, - redirectUris: redirectUris.map(uri => new URL(uri, res.url).toString()), - name: typeof name === 'string' ? name : id, - }; - } catch (err) { - console.error(err); - logger.error('Error while fetching client information', { err }); - if (err instanceof StatusError) { - throw new AuthorizationError('Failed to fetch client information', 'invalid_request'); - } else { - throw new AuthorizationError('Failed to parse client information', 'server_error'); - } - } -} - -type OmitFirstElement = T extends [unknown, ...(infer R)] - ? R - : []; - -interface OAuthParsedRequest extends OAuth2Req { - codeChallenge: string; - codeChallengeMethod: string; -} - -interface OAuthHttpResponse extends ServerResponse { - redirect(location: string): void; -} - -interface OAuth2DecisionRequest extends MiddlewareRequest { - body: { - transaction_id: string; - cancel: boolean; - login_token: string; - } -} - -function getQueryMode(issuerUrl: string): oauth2orize.grant.Options['modes'] { - return { - query: (txn, res, params): void => { - // https://datatracker.ietf.org/doc/html/rfc9207#name-response-parameter-iss - // "In authorization responses to the client, including error responses, - // an authorization server supporting this specification MUST indicate its - // identity by including the iss parameter in the response." - params.iss = issuerUrl; - - const parsed = new URL(txn.redirectURI); - for (const [key, value] of Object.entries(params)) { - parsed.searchParams.append(key, value as string); - } - - return (res as OAuthHttpResponse).redirect(parsed.toString()); - }, - }; -} - -/** - * Maps the transaction ID and the oauth/authorize parameters. - * - * Flow: - * 1. oauth/authorize endpoint will call store() to store the parameters - * and puts the generated transaction ID to the dialog page - * 2. oauth/decision will call load() to retrieve the parameters and then remove() - */ -class OAuth2Store { - #cache = new MemoryKVCache(1000 * 60 * 5); // expires after 5min - - load(req: OAuth2DecisionRequest, cb: (err: Error | null, txn?: OAuth2) => void): void { - const { transaction_id } = req.body; - if (!transaction_id) { - cb(new AuthorizationError('Missing transaction ID', 'invalid_request')); - return; - } - const loaded = this.#cache.get(transaction_id); - if (!loaded) { - cb(new AuthorizationError('Invalid or expired transaction ID', 'access_denied')); - return; - } - cb(null, loaded); - } - - store(req: OAuth2DecisionRequest, oauth2: OAuth2, cb: (err: Error | null, transactionID?: string) => void): void { - const transactionId = secureRndstr(128); - this.#cache.set(transactionId, oauth2); - cb(null, transactionId); - } - - remove(req: OAuth2DecisionRequest, tid: string, cb: () => void): void { - this.#cache.delete(tid); - cb(); - } -} - -@Injectable() -export class OAuth2ProviderService { - #server = oauth2orize.createServer({ - store: new OAuth2Store(), - }); - #logger: Logger; - - constructor( - @Inject(DI.config) - private config: Config, - private httpRequestService: HttpRequestService, - @Inject(DI.accessTokensRepository) - accessTokensRepository: AccessTokensRepository, - idService: IdService, - @Inject(DI.usersRepository) - private usersRepository: UsersRepository, - private cacheService: CacheService, - loggerService: LoggerService, - ) { - this.#logger = loggerService.getLogger('oauth'); - - const grantCodeCache = new MemoryKVCache<{ - clientId: string, - userId: string, - redirectUri: string, - codeChallenge: string, - scopes: string[], - - // fields to prevent multiple code use - grantedToken?: string, - revoked?: boolean, - used?: boolean, - }>(1000 * 60 * 5); // expires after 5m - - // https://datatracker.ietf.org/doc/html/draft-ietf-oauth-security-topics - // "Authorization servers MUST support PKCE [RFC7636]." - this.#server.grant(oauth2Pkce.extensions()); - this.#server.grant(oauth2orize.grant.code({ - modes: getQueryMode(config.url), - }, (client, redirectUri, token, ares, areq, locals, done) => { - (async (): Promise>> => { - this.#logger.info(`Checking the user before sending authorization code to ${client.id}`); - - if (!token) { - throw new AuthorizationError('No user', 'invalid_request'); - } - const user = await this.cacheService.localUserByNativeTokenCache.fetch(token, - () => this.usersRepository.findOneBy({ token }) as Promise); - if (!user) { - throw new AuthorizationError('No such user', 'invalid_request'); - } - - this.#logger.info(`Sending authorization code on behalf of user ${user.id} to ${client.id} through ${redirectUri}, with scope: [${areq.scope}]`); - - const code = secureRndstr(128); - grantCodeCache.set(code, { - clientId: client.id, - userId: user.id, - redirectUri, - codeChallenge: (areq as OAuthParsedRequest).codeChallenge, - scopes: areq.scope, - }); - return [code]; - })().then(args => done(null, ...args), err => done(err)); - })); - this.#server.exchange(oauth2orize.exchange.authorizationCode((client, code, redirectUri, body, authInfo, done) => { - (async (): Promise> | undefined> => { - this.#logger.info('Checking the received authorization code for the exchange'); - const granted = grantCodeCache.get(code); - if (!granted) { - return; - } - - // https://datatracker.ietf.org/doc/html/rfc6749.html#section-4.1.2 - // "If an authorization code is used more than once, the authorization server - // MUST deny the request and SHOULD revoke (when possible) all tokens - // previously issued based on that authorization code." - if (granted.used) { - this.#logger.info(`Detected multiple code use from ${granted.clientId} for user ${granted.userId}. Revoking the code.`); - grantCodeCache.delete(code); - granted.revoked = true; - if (granted.grantedToken) { - await accessTokensRepository.delete({ token: granted.grantedToken }); - } - return; - } - granted.used = true; - - // https://datatracker.ietf.org/doc/html/rfc6749.html#section-4.1.3 - if (body.client_id !== granted.clientId) return; - if (redirectUri !== granted.redirectUri) return; - - // https://datatracker.ietf.org/doc/html/rfc7636.html#section-4.6 - if (!body.code_verifier) return; - if (!(await verifyChallenge(body.code_verifier as string, granted.codeChallenge))) return; - - const accessToken = secureRndstr(128); - const now = new Date(); - - // NOTE: we don't have a setup for automatic token expiration - await accessTokensRepository.insert({ - id: idService.genId(), - createdAt: now, - lastUsedAt: now, - userId: granted.userId, - token: accessToken, - hash: accessToken, - name: granted.clientId, - permission: granted.scopes, - }); - - if (granted.revoked) { - this.#logger.info('Canceling the token as the authorization code was revoked in parallel during the process.'); - await accessTokensRepository.delete({ token: accessToken }); - return; - } - - granted.grantedToken = accessToken; - this.#logger.info(`Generated access token for ${granted.clientId} for user ${granted.userId}, with scope: [${granted.scopes}]`); - - return [accessToken, undefined, { scope: granted.scopes.join(' ') }]; - })().then(args => done(null, ...args ?? []), err => done(err)); - })); - } - - @bindThis - public async createServer(fastify: FastifyInstance): Promise { - // https://datatracker.ietf.org/doc/html/rfc8414.html - // https://indieauth.spec.indieweb.org/#indieauth-server-metadata - fastify.get('/.well-known/oauth-authorization-server', async (_request, reply) => { - reply.send({ - issuer: this.config.url, - authorization_endpoint: new URL('/oauth/authorize', this.config.url), - token_endpoint: new URL('/oauth/token', this.config.url), - scopes_supported: kinds, - response_types_supported: ['code'], - grant_types_supported: ['authorization_code'], - service_documentation: 'https://misskey-hub.net', - code_challenge_methods_supported: ['S256'], - authorization_response_iss_parameter_supported: true, - }); - }); - - fastify.get('/oauth/authorize', async (request, reply) => { - const oauth2 = (request.raw as MiddlewareRequest).oauth2; - if (!oauth2) { - throw new Error('Unexpected lack of authorization information'); - } - - this.#logger.info(`Rendering authorization page for "${oauth2.client.name}"`); - - reply.header('Cache-Control', 'no-store'); - return await reply.view('oauth', { - transactionId: oauth2.transactionID, - clientName: oauth2.client.name, - scope: oauth2.req.scope.join(' '), - }); - }); - fastify.post('/oauth/decision', async () => { }); - fastify.post('/oauth/token', async () => { }); - - fastify.register(fastifyView, { - root: fileURLToPath(new URL('../web/views', import.meta.url)), - engine: { pug }, - defaultContext: { - version: this.config.version, - config: this.config, - }, - }); - - await fastify.register(fastifyExpress); - fastify.use('/oauth/authorize', this.#server.authorize(((areq, done) => { - (async (): Promise> => { - // This should return client/redirectURI AND the error, or - // the handler can't send error to the redirection URI - - const { codeChallenge, codeChallengeMethod, clientID, redirectURI, scope } = areq as OAuthParsedRequest; - - this.#logger.info(`Validating authorization parameters, with client_id: ${clientID}, redirect_uri: ${redirectURI}, scope: ${scope}`); - - const clientUrl = validateClientId(clientID); - - // https://indieauth.spec.indieweb.org/#client-information-discovery - // "the server may want to resolve the domain name first and avoid fetching the document - // if the IP address is within the loopback range defined by [RFC5735] - // or any other implementation-specific internal IP address." - if (process.env.NODE_ENV !== 'test' || process.env.MISSKEY_TEST_CHECK_IP_RANGE === '1') { - const lookup = await dns.lookup(clientUrl.hostname); - if (ipaddr.parse(lookup.address).range() !== 'unicast') { - throw new AuthorizationError('client_id resolves to disallowed IP range.', 'invalid_request'); - } - } - - // Find client information from the remote. - const clientInfo = await discoverClientInformation(this.#logger, this.httpRequestService, clientUrl.href); - - // Require the redirect URI to be included in an explicit list, per - // https://datatracker.ietf.org/doc/html/draft-ietf-oauth-security-topics#section-4.1.3 - /* if (!clientInfo.redirectUris.includes(redirectURI)) { - throw new AuthorizationError('Invalid redirect_uri', 'invalid_request'); - } */ - - try { - const scopes = [...new Set(scope)].filter(s => kinds.includes(s)); - if (!scopes.length) { - throw new AuthorizationError('`scope` parameter has no known scope', 'invalid_scope'); - } - areq.scope = scopes; - - // Require PKCE parameters. - // Recommended by https://indieauth.spec.indieweb.org/#authorization-request, but also prevents downgrade attack: - // https://datatracker.ietf.org/doc/html/draft-ietf-oauth-security-topics#name-pkce-downgrade-attack - if (typeof codeChallenge !== 'string') { - throw new AuthorizationError('`code_challenge` parameter is required', 'invalid_request'); - } - if (codeChallengeMethod !== 'S256') { - throw new AuthorizationError('`code_challenge_method` parameter must be set as S256', 'invalid_request'); - } - } catch (err) { - return [err as Error, clientInfo, redirectURI]; - } - - return [null, clientInfo, redirectURI]; - })().then(args => done(...args), err => done(err)); - }) as ValidateFunctionArity2)); - fastify.use('/oauth/authorize', this.#server.errorHandler({ - mode: 'indirect', - modes: getQueryMode(this.config.url), - })); - fastify.use('/oauth/authorize', this.#server.errorHandler()); - - fastify.use('/oauth/decision', bodyParser.urlencoded({ extended: false })); - fastify.use('/oauth/decision', this.#server.decision((req, done) => { - const { body } = req as OAuth2DecisionRequest; - this.#logger.info(`Received the decision. Cancel: ${!!body.cancel}`); - req.user = body.login_token; - done(null, undefined); - })); - fastify.use('/oauth/decision', this.#server.errorHandler()); - - // Clients may use JSON or urlencoded - fastify.use('/oauth/token', bodyParser.urlencoded({ extended: false })); - fastify.use('/oauth/token', bodyParser.json({ strict: true })); - fastify.use('/oauth/token', this.#server.token()); - fastify.use('/oauth/token', this.#server.errorHandler()); - - // Return 404 for any unknown paths under /oauth so that clients can know - // whether a certain endpoint is supported or not. - fastify.all('/oauth/*', async (_request, reply) => { - reply.code(404); - reply.send({ - error: { - message: 'Unknown OAuth endpoint.', - code: 'UNKNOWN_OAUTH_ENDPOINT', - id: 'aa49e620-26cb-4e28-aad6-8cbcb58db147', - kind: 'client', - }, - }); - }); - } -} diff --git a/packages/megalodon/.npmignore b/packages/megalodon/.npmignore new file mode 100644 index 000000000..fd54d1deb --- /dev/null +++ b/packages/megalodon/.npmignore @@ -0,0 +1,3 @@ +node_modules +./src +tsconfig.json diff --git a/packages/megalodon/package.json b/packages/megalodon/package.json index 3403b94b4..ebd958834 100644 --- a/packages/megalodon/package.json +++ b/packages/megalodon/package.json @@ -1,16 +1,35 @@ { "name": "megalodon", - "private": true, + "version": "7.0.1", + "description": "Mastodon API client for node.js and browser", "main": "./lib/src/index.js", "typings": "./lib/src/index.d.ts", "scripts": { "build": "tsc -p ./", - "build:debug": "pnpm run build", - "lint": "pnpm biome check **/*.ts --apply", - "format": "pnpm biome format --write src/**/*.ts", + "lint": "eslint --ext .js,.ts src", "doc": "typedoc --out ../docs ./src", "test": "NODE_ENV=test jest -u --maxWorkers=3" }, + "engines": { + "node": ">=15.0.0" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/h3poteto/megalodon.git" + }, + "keywords": [ + "mastodon", + "client", + "api", + "streaming", + "rest", + "proxy" + ], + "author": "h3poteto", + "license": "MIT", + "bugs": { + "url": "https://github.com/h3poteto/megalodon/issues" + }, "jest": { "moduleFileExtensions": [ "ts", @@ -25,59 +44,44 @@ ], "preset": "ts-jest/presets/default", "transform": { - "^.+\\.(ts|tsx)$": "ts-jest" - }, - "globals": { - "ts-jest": { + "^.+\\.(ts|tsx)$": ["ts-jest", { "tsconfig": "tsconfig.json" - } + }] }, "testEnvironment": "node" }, + "homepage": "https://github.com/h3poteto/megalodon#readme", "dependencies": { - "@types/oauth": "^0.9.0", - "@types/ws": "^8.5.4", - "axios": "1.2.2", - "dayjs": "^1.11.7", + "@types/oauth": "^0.9.2", + "@types/ws": "^8.5.5", + "axios": "1.5.0", + "dayjs": "^1.11.9", "form-data": "^4.0.0", - "https-proxy-agent": "^5.0.1", + "https-proxy-agent": "^7.0.2", "oauth": "^0.10.0", "object-assign-deep": "^0.4.0", "parse-link-header": "^2.0.0", - "socks-proxy-agent": "^7.0.0", - "typescript": "4.9.4", - "uuid": "^9.0.0", - "ws": "8.12.0", - "async-lock": "1.4.0" + "socks-proxy-agent": "^8.0.2", + "typescript": "5.1.6", + "uuid": "^9.0.1", + "ws": "8.14.2" }, "devDependencies": { - "@types/core-js": "^2.5.0", + "@types/core-js": "^2.5.6", "@types/form-data": "^2.5.0", - "@types/jest": "^29.4.0", - "@types/object-assign-deep": "^0.4.0", - "@types/parse-link-header": "^2.0.0", - "@types/uuid": "^9.0.0", - "@types/node": "18.11.18", - "@typescript-eslint/eslint-plugin": "^5.49.0", - "@typescript-eslint/parser": "^5.49.0", - "@types/async-lock": "1.4.0", - "eslint": "^8.32.0", - "eslint-config-prettier": "^8.6.0", - "eslint-config-standard": "^16.0.3", - "eslint-plugin-import": "^2.27.5", - "eslint-plugin-node": "^11.0.0", - "eslint-plugin-prettier": "^4.2.1", - "eslint-plugin-promise": "^6.1.1", - "eslint-plugin-standard": "^5.0.0", - "jest": "^29.4.0", - "jest-worker": "^29.4.0", + "@types/jest": "^29.5.5", + "@types/object-assign-deep": "^0.4.1", + "@types/parse-link-header": "^2.0.1", + "@types/uuid": "^9.0.4", + "@typescript-eslint/eslint-plugin": "^6.7.2", + "@typescript-eslint/parser": "^6.7.2", + "eslint": "^8.49.0", + "eslint-config-prettier": "^9.0.0", + "jest": "^29.7.0", + "jest-worker": "^29.7.0", "lodash": "^4.17.14", - "prettier": "^2.8.3", - "ts-jest": "^29.0.5", - "typedoc": "^0.23.24" - }, - "directories": { - "lib": "lib", - "test": "test" + "prettier": "^3.0.3", + "ts-jest": "^29.1.1", + "typedoc": "^0.25.1" } } diff --git a/packages/megalodon/src/axios.d.ts b/packages/megalodon/src/axios.d.ts index f19fe38a2..114cb06aa 100644 --- a/packages/megalodon/src/axios.d.ts +++ b/packages/megalodon/src/axios.d.ts @@ -1 +1 @@ -declare module "axios/lib/adapters/http"; +declare module 'axios/lib/adapters/http' diff --git a/packages/megalodon/src/cancel.ts b/packages/megalodon/src/cancel.ts index f8e4729b8..3b905a492 100644 --- a/packages/megalodon/src/cancel.ts +++ b/packages/megalodon/src/cancel.ts @@ -1,13 +1,13 @@ export class RequestCanceledError extends Error { - public isCancel: boolean; + public isCancel: boolean - constructor(msg: string) { - super(msg); - this.isCancel = true; - Object.setPrototypeOf(this, RequestCanceledError); - } + constructor(msg: string) { + super(msg) + this.isCancel = true + Object.setPrototypeOf(this, RequestCanceledError) + } } export const isCancel = (value: any): boolean => { - return value && value.isCancel; -}; + return value && value.isCancel +} diff --git a/packages/megalodon/src/converter.ts b/packages/megalodon/src/converter.ts index 93d669fa7..f768fc930 100644 --- a/packages/megalodon/src/converter.ts +++ b/packages/megalodon/src/converter.ts @@ -1,3 +1,3 @@ import MisskeyAPI from "./misskey/api_client"; -export default MisskeyAPI.Converter; +export default MisskeyAPI.Converter; \ No newline at end of file diff --git a/packages/megalodon/src/default.ts b/packages/megalodon/src/default.ts index 45bce13e2..0194b3dcc 100644 --- a/packages/megalodon/src/default.ts +++ b/packages/megalodon/src/default.ts @@ -1,3 +1,3 @@ -export const NO_REDIRECT = "urn:ietf:wg:oauth:2.0:oob"; -export const DEFAULT_SCOPE = ["read", "write", "follow"]; -export const DEFAULT_UA = "megalodon"; +export const NO_REDIRECT = 'urn:ietf:wg:oauth:2.0:oob' +export const DEFAULT_SCOPE = ['read', 'write', 'follow'] +export const DEFAULT_UA = 'megalodon' diff --git a/packages/megalodon/src/detector.ts b/packages/megalodon/src/detector.ts new file mode 100644 index 000000000..31f34d72f --- /dev/null +++ b/packages/megalodon/src/detector.ts @@ -0,0 +1,137 @@ +import axios, { AxiosRequestConfig } from 'axios' +import proxyAgent, { ProxyConfig } from './proxy_config' +import { NodeinfoError } from './megalodon' + +const NODEINFO_10 = 'http://nodeinfo.diaspora.software/ns/schema/1.0' +const NODEINFO_20 = 'http://nodeinfo.diaspora.software/ns/schema/2.0' +const NODEINFO_21 = 'http://nodeinfo.diaspora.software/ns/schema/2.1' + +type Links = { + links: Array +} + +type Link = { + href: string + rel: string +} + +type Nodeinfo10 = { + software: Software + metadata: Metadata +} + +type Nodeinfo20 = { + software: Software + metadata: Metadata +} + +type Nodeinfo21 = { + software: Software + metadata: Metadata +} + +type Software = { + name: string +} + +type Metadata = { + upstream?: { + name: string + } +} + +/** + * Detect SNS type. + * Now support Mastodon, Pleroma and Pixelfed. Throws an error when no known platform can be detected. + * + * @param url Base URL of SNS. + * @param proxyConfig Proxy setting, or set false if don't use proxy. + * @return SNS name. + */ +export const detector = async ( + url: string, + proxyConfig: ProxyConfig | false = false +): Promise<'mastodon' | 'pleroma' | 'misskey' | 'friendica'> => { + let options: AxiosRequestConfig = { + timeout: 20000 + } + if (proxyConfig) { + options = Object.assign(options, { + httpsAgent: proxyAgent(proxyConfig) + }) + } + + const res = await axios.get(url + '/.well-known/nodeinfo', options) + const link = res.data.links.find(l => l.rel === NODEINFO_20 || l.rel === NODEINFO_21) + if (!link) throw new NodeinfoError('Could not find nodeinfo') + switch (link.rel) { + case NODEINFO_10: { + const res = await axios.get(link.href, options) + switch (res.data.software.name) { + case 'pleroma': + return 'pleroma' + case 'akkoma': + return 'pleroma' + case 'mastodon': + return 'mastodon' + case "wildebeest": + return "mastodon" + case 'misskey': + return 'misskey' + case 'friendica': + return 'friendica' + default: + if (res.data.metadata.upstream?.name && res.data.metadata.upstream.name === 'mastodon') { + return 'mastodon' + } + throw new NodeinfoError('Unknown SNS') + } + } + case NODEINFO_20: { + const res = await axios.get(link.href, options) + switch (res.data.software.name) { + case 'pleroma': + return 'pleroma' + case 'akkoma': + return 'pleroma' + case 'mastodon': + return 'mastodon' + case "wildebeest": + return "mastodon" + case 'misskey': + return 'misskey' + case 'friendica': + return 'friendica' + default: + if (res.data.metadata.upstream?.name && res.data.metadata.upstream.name === 'mastodon') { + return 'mastodon' + } + throw new NodeinfoError('Unknown SNS') + } + } + case NODEINFO_21: { + const res = await axios.get(link.href, options) + switch (res.data.software.name) { + case 'pleroma': + return 'pleroma' + case 'akkoma': + return 'pleroma' + case 'mastodon': + return 'mastodon' + case "wildebeest": + return "mastodon" + case 'misskey': + return 'misskey' + case 'friendica': + return 'friendica' + default: + if (res.data.metadata.upstream?.name && res.data.metadata.upstream.name === 'mastodon') { + return 'mastodon' + } + throw new NodeinfoError('Unknown SNS') + } + } + default: + throw new NodeinfoError('Could not find nodeinfo') + } +} diff --git a/packages/megalodon/src/entities/account.ts b/packages/megalodon/src/entities/account.ts index 06a85eb98..89c0f17c4 100644 --- a/packages/megalodon/src/entities/account.ts +++ b/packages/megalodon/src/entities/account.ts @@ -1,27 +1,35 @@ /// /// /// +/// namespace Entity { - export type Account = { - id: string; - username: string; - acct: string; - display_name: string; - locked: boolean; - created_at: string; - followers_count: number; - following_count: number; - statuses_count: number; - note: string; - url: string; - avatar: string; - avatar_static: string; - header: string; - header_static: string; - emojis: Array; - moved: Account | null; - fields: Array; - bot: boolean | null; - source?: Source; - }; + export type Account = { + id: string + username: string + acct: string + display_name: string + locked: boolean + discoverable?: boolean + group: boolean | null + noindex: boolean | null + suspended: boolean | null + limited: boolean | null + created_at: string + followers_count: number + following_count: number + statuses_count: number + note: string + url: string + avatar: string + avatar_static: string + header: string + header_static: string + emojis: Array + moved: Account | null + fields: Array + bot: boolean | null + source?: Source + role?: Role + mute_expires_at?: string + } } diff --git a/packages/megalodon/src/entities/activity.ts b/packages/megalodon/src/entities/activity.ts index 6bc0b6d80..2494916a9 100644 --- a/packages/megalodon/src/entities/activity.ts +++ b/packages/megalodon/src/entities/activity.ts @@ -1,8 +1,8 @@ namespace Entity { - export type Activity = { - week: string; - statuses: string; - logins: string; - registrations: string; - }; + export type Activity = { + week: string + statuses: string + logins: string + registrations: string + } } diff --git a/packages/megalodon/src/entities/announcement.ts b/packages/megalodon/src/entities/announcement.ts index 7c7983163..0db9c23bb 100644 --- a/packages/megalodon/src/entities/announcement.ts +++ b/packages/megalodon/src/entities/announcement.ts @@ -1,34 +1,40 @@ -/// /// -/// namespace Entity { - export type Announcement = { - id: string; - content: string; - starts_at: string | null; - ends_at: string | null; - published: boolean; - all_day: boolean; - published_at: string; - updated_at: string; - read?: boolean; - mentions: Array; - statuses: Array; - tags: Array; - emojis: Array; - reactions: Array; - }; + export type Announcement = { + id: string + content: string + starts_at: string | null + ends_at: string | null + published: boolean + all_day: boolean + published_at: string + updated_at: string | null + read: boolean | null + mentions: Array + statuses: Array + tags: Array + emojis: Array + reactions: Array + } - export type AnnouncementAccount = { - id: string; - username: string; - url: string; - acct: string; - }; + export type AnnouncementAccount = { + id: string + username: string + url: string + acct: string + } - export type AnnouncementStatus = { - id: string; - url: string; - }; + export type AnnouncementStatus = { + id: string + url: string + } + + export type AnnouncementReaction = { + name: string + count: number + me: boolean | null + url: string | null + static_url: string | null + } } diff --git a/packages/megalodon/src/entities/application.ts b/packages/megalodon/src/entities/application.ts index 9b98b1277..3af64fcf9 100644 --- a/packages/megalodon/src/entities/application.ts +++ b/packages/megalodon/src/entities/application.ts @@ -1,7 +1,7 @@ namespace Entity { - export type Application = { - name: string; - website?: string | null; - vapid_key?: string | null; - }; + export type Application = { + name: string + website?: string | null + vapid_key?: string | null + } } diff --git a/packages/megalodon/src/entities/async_attachment.ts b/packages/megalodon/src/entities/async_attachment.ts index 9cc17acc5..b383f90c5 100644 --- a/packages/megalodon/src/entities/async_attachment.ts +++ b/packages/megalodon/src/entities/async_attachment.ts @@ -1,14 +1,14 @@ /// namespace Entity { - export type AsyncAttachment = { - id: string; - type: "unknown" | "image" | "gifv" | "video" | "audio"; - url: string | null; - remote_url: string | null; - preview_url: string; - text_url: string | null; - meta: Meta | null; - description: string | null; - blurhash: string | null; - }; + export type AsyncAttachment = { + id: string + type: 'unknown' | 'image' | 'gifv' | 'video' | 'audio' + url: string | null + remote_url: string | null + preview_url: string + text_url: string | null + meta: Meta | null + description: string | null + blurhash: string | null + } } diff --git a/packages/megalodon/src/entities/attachment.ts b/packages/megalodon/src/entities/attachment.ts index 082c79edd..aab1deade 100644 --- a/packages/megalodon/src/entities/attachment.ts +++ b/packages/megalodon/src/entities/attachment.ts @@ -1,49 +1,49 @@ namespace Entity { - export type Sub = { - // For Image, Gifv, and Video - width?: number; - height?: number; - size?: string; - aspect?: number; + export type Sub = { + // For Image, Gifv, and Video + width?: number + height?: number + size?: string + aspect?: number - // For Gifv and Video - frame_rate?: string; + // For Gifv and Video + frame_rate?: string - // For Audio, Gifv, and Video - duration?: number; - bitrate?: number; - }; + // For Audio, Gifv, and Video + duration?: number + bitrate?: number + } - export type Focus = { - x: number; - y: number; - }; + export type Focus = { + x: number + y: number + } - export type Meta = { - original?: Sub; - small?: Sub; - focus?: Focus; - length?: string; - duration?: number; - fps?: number; - size?: string; - width?: number; - height?: number; - aspect?: number; - audio_encode?: string; - audio_bitrate?: string; - audio_channel?: string; - }; + export type Meta = { + original?: Sub + small?: Sub + focus?: Focus + length?: string + duration?: number + fps?: number + size?: string + width?: number + height?: number + aspect?: number + audio_encode?: string + audio_bitrate?: string + audio_channel?: string + } - export type Attachment = { - id: string; - type: "unknown" | "image" | "gifv" | "video" | "audio"; - url: string; - remote_url: string | null; - preview_url: string | null; - text_url: string | null; - meta: Meta | null; - description: string | null; - blurhash: string | null; - }; + export type Attachment = { + id: string + type: 'unknown' | 'image' | 'gifv' | 'video' | 'audio' + url: string + remote_url: string | null + preview_url: string | null + text_url: string | null + meta: Meta | null + description: string | null + blurhash: string | null + } } diff --git a/packages/megalodon/src/entities/card.ts b/packages/megalodon/src/entities/card.ts index 356d99aee..1ef6f5e4d 100644 --- a/packages/megalodon/src/entities/card.ts +++ b/packages/megalodon/src/entities/card.ts @@ -1,16 +1,18 @@ namespace Entity { - export type Card = { - url: string; - title: string; - description: string; - type: "link" | "photo" | "video" | "rich"; - image?: string; - author_name?: string; - author_url?: string; - provider_name?: string; - provider_url?: string; - html?: string; - width?: number; - height?: number; - }; + export type Card = { + url: string + title: string + description: string + type: 'link' | 'photo' | 'video' | 'rich' + image: string | null + author_name: string | null + author_url: string | null + provider_name: string | null + provider_url: string | null + html: string | null + width: number | null + height: number | null + embed_url: string | null + blurhash: string | null + } } diff --git a/packages/megalodon/src/entities/context.ts b/packages/megalodon/src/entities/context.ts index a794a7c5a..3f2eda58f 100644 --- a/packages/megalodon/src/entities/context.ts +++ b/packages/megalodon/src/entities/context.ts @@ -1,8 +1,8 @@ /// namespace Entity { - export type Context = { - ancestors: Array; - descendants: Array; - }; + export type Context = { + ancestors: Array + descendants: Array + } } diff --git a/packages/megalodon/src/entities/conversation.ts b/packages/megalodon/src/entities/conversation.ts index 2bdc19666..cdadf1e0f 100644 --- a/packages/megalodon/src/entities/conversation.ts +++ b/packages/megalodon/src/entities/conversation.ts @@ -2,10 +2,10 @@ /// namespace Entity { - export type Conversation = { - id: string; - accounts: Array; - last_status: Status | null; - unread: boolean; - }; + export type Conversation = { + id: string + accounts: Array + last_status: Status | null + unread: boolean + } } diff --git a/packages/megalodon/src/entities/emoji.ts b/packages/megalodon/src/entities/emoji.ts index 10c32ab0b..546ef818f 100644 --- a/packages/megalodon/src/entities/emoji.ts +++ b/packages/megalodon/src/entities/emoji.ts @@ -1,9 +1,9 @@ namespace Entity { - export type Emoji = { - shortcode: string; - static_url: string; - url: string; - visible_in_picker: boolean; - category: string; - }; + export type Emoji = { + shortcode: string + static_url: string + url: string + visible_in_picker: boolean + category?: string + } } diff --git a/packages/megalodon/src/entities/featured_tag.ts b/packages/megalodon/src/entities/featured_tag.ts index fc9f8c69c..06ae6d7a9 100644 --- a/packages/megalodon/src/entities/featured_tag.ts +++ b/packages/megalodon/src/entities/featured_tag.ts @@ -1,8 +1,8 @@ namespace Entity { - export type FeaturedTag = { - id: string; - name: string; - statuses_count: number; - last_status_at: string; - }; + export type FeaturedTag = { + id: string + name: string + statuses_count: number + last_status_at: string + } } diff --git a/packages/megalodon/src/entities/field.ts b/packages/megalodon/src/entities/field.ts index de4b6b2b7..03e4604b0 100644 --- a/packages/megalodon/src/entities/field.ts +++ b/packages/megalodon/src/entities/field.ts @@ -1,7 +1,7 @@ namespace Entity { - export type Field = { - name: string; - value: string; - verified_at: string | null; - }; + export type Field = { + name: string + value: string + verified_at: string | null + } } diff --git a/packages/megalodon/src/entities/filter.ts b/packages/megalodon/src/entities/filter.ts index 55b7305cc..ffbacb728 100644 --- a/packages/megalodon/src/entities/filter.ts +++ b/packages/megalodon/src/entities/filter.ts @@ -1,12 +1,12 @@ namespace Entity { - export type Filter = { - id: string; - phrase: string; - context: Array; - expires_at: string | null; - irreversible: boolean; - whole_word: boolean; - }; + export type Filter = { + id: string + phrase: string + context: Array + expires_at: string | null + irreversible: boolean + whole_word: boolean + } - export type FilterContext = string; + export type FilterContext = string } diff --git a/packages/megalodon/src/entities/follow_request.ts b/packages/megalodon/src/entities/follow_request.ts new file mode 100644 index 000000000..84ea4d02c --- /dev/null +++ b/packages/megalodon/src/entities/follow_request.ts @@ -0,0 +1,27 @@ +/// +/// + +namespace Entity { + export type FollowRequest = { + id: number + username: string + acct: string + display_name: string + locked: boolean + bot: boolean + discoverable?: boolean + group: boolean + created_at: string + note: string + url: string + avatar: string + avatar_static: string + header: string + header_static: string + followers_count: number + following_count: number + statuses_count: number + emojis: Array + fields: Array + } +} diff --git a/packages/megalodon/src/entities/history.ts b/packages/megalodon/src/entities/history.ts index 4676357d6..070969426 100644 --- a/packages/megalodon/src/entities/history.ts +++ b/packages/megalodon/src/entities/history.ts @@ -1,7 +1,7 @@ namespace Entity { - export type History = { - day: string; - uses: number; - accounts: number; - }; + export type History = { + day: string + uses: number + accounts: number + } } diff --git a/packages/megalodon/src/entities/identity_proof.ts b/packages/megalodon/src/entities/identity_proof.ts index 3b42e6f41..ff857addb 100644 --- a/packages/megalodon/src/entities/identity_proof.ts +++ b/packages/megalodon/src/entities/identity_proof.ts @@ -1,9 +1,9 @@ namespace Entity { - export type IdentityProof = { - provider: string; - provider_username: string; - updated_at: string; - proof_url: string; - profile_url: string; - }; + export type IdentityProof = { + provider: string + provider_username: string + updated_at: string + proof_url: string + profile_url: string + } } diff --git a/packages/megalodon/src/entities/instance.ts b/packages/megalodon/src/entities/instance.ts index 9c0f572db..8f4808be8 100644 --- a/packages/megalodon/src/entities/instance.ts +++ b/packages/megalodon/src/entities/instance.ts @@ -3,39 +3,38 @@ /// namespace Entity { - export type Instance = { - uri: string; - title: string; - description: string; - email: string; - version: string; - thumbnail: string | null; - urls: URLs; - stats: Stats; - languages: Array; - contact_account: Account | null; - max_toot_chars?: number; - registrations?: boolean; - configuration?: { - statuses: { - max_characters: number; - max_media_attachments: number; - characters_reserved_per_url: number; - }; - media_attachments: { - supported_mime_types: Array; - image_size_limit: number; - image_matrix_limit: number; - video_size_limit: number; - video_frame_limit: number; - video_matrix_limit: number; - }; - polls: { - max_options: number; - max_characters_per_option: number; - min_expiration: number; - max_expiration: number; - }; - }; - }; + export type Instance = { + uri: string + title: string + description: string + email: string + version: string + thumbnail: string | null + urls: URLs | null + stats: Stats + languages: Array + registrations: boolean + approval_required: boolean + invites_enabled?: boolean + configuration: { + statuses: { + max_characters: number + max_media_attachments?: number + characters_reserved_per_url?: number + } + polls?: { + max_options: number + max_characters_per_option: number + min_expiration: number + max_expiration: number + } + } + contact_account?: Account + rules?: Array + } + + export type InstanceRule = { + id: string + text: string + } } diff --git a/packages/megalodon/src/entities/list.ts b/packages/megalodon/src/entities/list.ts index 97e75286b..58c264aba 100644 --- a/packages/megalodon/src/entities/list.ts +++ b/packages/megalodon/src/entities/list.ts @@ -1,6 +1,9 @@ namespace Entity { - export type List = { - id: string; - title: string; - }; + export type List = { + id: string + title: string + replies_policy: RepliesPolicy | null + } + + export type RepliesPolicy = 'followed' | 'list' | 'none' } diff --git a/packages/megalodon/src/entities/marker.ts b/packages/megalodon/src/entities/marker.ts index 7ee99282c..33cb98a10 100644 --- a/packages/megalodon/src/entities/marker.ts +++ b/packages/megalodon/src/entities/marker.ts @@ -1,15 +1,15 @@ namespace Entity { - export type Marker = { - home?: { - last_read_id: string; - version: number; - updated_at: string; - }; - notifications?: { - last_read_id: string; - version: number; - updated_at: string; - unread_count?: number; - }; - }; + export type Marker = { + home?: { + last_read_id: string + version: number + updated_at: string + } + notifications?: { + last_read_id: string + version: number + updated_at: string + unread_count?: number + } + } } diff --git a/packages/megalodon/src/entities/mention.ts b/packages/megalodon/src/entities/mention.ts index 4fe36a655..046912971 100644 --- a/packages/megalodon/src/entities/mention.ts +++ b/packages/megalodon/src/entities/mention.ts @@ -1,8 +1,8 @@ namespace Entity { - export type Mention = { - id: string; - username: string; - url: string; - acct: string; - }; + export type Mention = { + id: string + username: string + url: string + acct: string + } } diff --git a/packages/megalodon/src/entities/notification.ts b/packages/megalodon/src/entities/notification.ts index 68eff3347..653d235d9 100644 --- a/packages/megalodon/src/entities/notification.ts +++ b/packages/megalodon/src/entities/notification.ts @@ -2,14 +2,15 @@ /// namespace Entity { - export type Notification = { - account: Account; - created_at: string; - id: string; - status?: Status; - reaction?: Reaction; - type: NotificationType; - }; + export type Notification = { + account: Account + created_at: string + id: string + status?: Status + emoji?: string + type: NotificationType + target?: Account + } - export type NotificationType = string; + export type NotificationType = string } diff --git a/packages/megalodon/src/entities/poll.ts b/packages/megalodon/src/entities/poll.ts index 2539d68b2..69706e8ae 100644 --- a/packages/megalodon/src/entities/poll.ts +++ b/packages/megalodon/src/entities/poll.ts @@ -1,14 +1,13 @@ /// namespace Entity { - export type Poll = { - id: string; - expires_at: string | null; - expired: boolean; - multiple: boolean; - votes_count: number; - options: Array; - voted: boolean; - own_votes: Array; - }; + export type Poll = { + id: string + expires_at: string | null + expired: boolean + multiple: boolean + votes_count: number + options: Array + voted: boolean + } } diff --git a/packages/megalodon/src/entities/poll_option.ts b/packages/megalodon/src/entities/poll_option.ts index e818a8607..ae4c63849 100644 --- a/packages/megalodon/src/entities/poll_option.ts +++ b/packages/megalodon/src/entities/poll_option.ts @@ -1,6 +1,6 @@ namespace Entity { - export type PollOption = { - title: string; - votes_count: number | null; - }; + export type PollOption = { + title: string + votes_count: number | null + } } diff --git a/packages/megalodon/src/entities/preferences.ts b/packages/megalodon/src/entities/preferences.ts index 7994dc568..cb5797c4c 100644 --- a/packages/megalodon/src/entities/preferences.ts +++ b/packages/megalodon/src/entities/preferences.ts @@ -1,9 +1,9 @@ namespace Entity { - export type Preferences = { - "posting:default:visibility": "public" | "unlisted" | "private" | "direct"; - "posting:default:sensitive": boolean; - "posting:default:language": string | null; - "reading:expand:media": "default" | "show_all" | "hide_all"; - "reading:expand:spoilers": boolean; - }; + export type Preferences = { + 'posting:default:visibility': 'public' | 'unlisted' | 'private' | 'direct' + 'posting:default:sensitive': boolean + 'posting:default:language': string | null + 'reading:expand:media': 'default' | 'show_all' | 'hide_all' + 'reading:expand:spoilers': boolean + } } diff --git a/packages/megalodon/src/entities/push_subscription.ts b/packages/megalodon/src/entities/push_subscription.ts index ad1146a24..fe7464e8e 100644 --- a/packages/megalodon/src/entities/push_subscription.ts +++ b/packages/megalodon/src/entities/push_subscription.ts @@ -1,16 +1,16 @@ namespace Entity { - export type Alerts = { - follow: boolean; - favourite: boolean; - mention: boolean; - reblog: boolean; - poll: boolean; - }; + export type Alerts = { + follow: boolean + favourite: boolean + mention: boolean + reblog: boolean + poll: boolean + } - export type PushSubscription = { - id: string; - endpoint: string; - server_key: string; - alerts: Alerts; - }; + export type PushSubscription = { + id: string + endpoint: string + server_key: string + alerts: Alerts + } } diff --git a/packages/megalodon/src/entities/reaction.ts b/packages/megalodon/src/entities/reaction.ts index 4edbec6a7..8c626f9e8 100644 --- a/packages/megalodon/src/entities/reaction.ts +++ b/packages/megalodon/src/entities/reaction.ts @@ -1,12 +1,10 @@ /// namespace Entity { - export type Reaction = { - count: number; - me: boolean; - name: string; - url?: string; - static_url?: string; - accounts?: Array; - }; + export type Reaction = { + count: number + me: boolean + name: string + accounts?: Array + } } diff --git a/packages/megalodon/src/entities/relationship.ts b/packages/megalodon/src/entities/relationship.ts index 91802d5c8..283a1158c 100644 --- a/packages/megalodon/src/entities/relationship.ts +++ b/packages/megalodon/src/entities/relationship.ts @@ -1,17 +1,17 @@ namespace Entity { - export type Relationship = { - id: string; - following: boolean; - followed_by: boolean; - delivery_following?: boolean; - blocking: boolean; - blocked_by: boolean; - muting: boolean; - muting_notifications: boolean; - requested: boolean; - domain_blocking: boolean; - showing_reblogs: boolean; - endorsed: boolean; - notifying: boolean; - }; + export type Relationship = { + id: string + following: boolean + followed_by: boolean + blocking: boolean + blocked_by: boolean + muting: boolean + muting_notifications: boolean + requested: boolean + domain_blocking: boolean + showing_reblogs: boolean + endorsed: boolean + notifying: boolean + note: string | null + } } diff --git a/packages/megalodon/src/entities/report.ts b/packages/megalodon/src/entities/report.ts index 6862a5fab..353886a34 100644 --- a/packages/megalodon/src/entities/report.ts +++ b/packages/megalodon/src/entities/report.ts @@ -1,9 +1,18 @@ +/// + namespace Entity { - export type Report = { - id: string; - action_taken: string; - comment: string; - account_id: string; - status_ids: Array; - }; + export type Report = { + id: string + action_taken: boolean + action_taken_at: string | null + status_ids: Array | null + rule_ids: Array | null + // These parameters don't exist in Pleroma + category: Category | null + comment: string | null + forwarded: boolean | null + target_account?: Account | null + } + + export type Category = 'spam' | 'violation' | 'other' } diff --git a/packages/megalodon/src/entities/results.ts b/packages/megalodon/src/entities/results.ts index 4448e5335..fe168de67 100644 --- a/packages/megalodon/src/entities/results.ts +++ b/packages/megalodon/src/entities/results.ts @@ -3,9 +3,9 @@ /// namespace Entity { - export type Results = { - accounts: Array; - statuses: Array; - hashtags: Array; - }; + export type Results = { + accounts: Array + statuses: Array + hashtags: Array + } } diff --git a/packages/megalodon/src/entities/role.ts b/packages/megalodon/src/entities/role.ts new file mode 100644 index 000000000..caaae9ea1 --- /dev/null +++ b/packages/megalodon/src/entities/role.ts @@ -0,0 +1,5 @@ +namespace Entity { + export type Role = { + name: string + } +} diff --git a/packages/megalodon/src/entities/scheduled_status.ts b/packages/megalodon/src/entities/scheduled_status.ts index 78dfb8ed2..561a5b9f2 100644 --- a/packages/megalodon/src/entities/scheduled_status.ts +++ b/packages/megalodon/src/entities/scheduled_status.ts @@ -1,10 +1,10 @@ /// /// namespace Entity { - export type ScheduledStatus = { - id: string; - scheduled_at: string; - params: StatusParams; - media_attachments: Array; - }; + export type ScheduledStatus = { + id: string + scheduled_at: string + params: StatusParams + media_attachments: Array | null + } } diff --git a/packages/megalodon/src/entities/source.ts b/packages/megalodon/src/entities/source.ts index 913b02fda..d87cf55d8 100644 --- a/packages/megalodon/src/entities/source.ts +++ b/packages/megalodon/src/entities/source.ts @@ -1,10 +1,10 @@ /// namespace Entity { - export type Source = { - privacy: string | null; - sensitive: boolean | null; - language: string | null; - note: string; - fields: Array; - }; + export type Source = { + privacy: string | null + sensitive: boolean | null + language: string | null + note: string + fields: Array + } } diff --git a/packages/megalodon/src/entities/stats.ts b/packages/megalodon/src/entities/stats.ts index 6471df039..76f0bad34 100644 --- a/packages/megalodon/src/entities/stats.ts +++ b/packages/megalodon/src/entities/stats.ts @@ -1,7 +1,7 @@ namespace Entity { - export type Stats = { - user_count: number; - status_count: number; - domain_count: number; - }; + export type Stats = { + user_count: number + status_count: number + domain_count: number + } } diff --git a/packages/megalodon/src/entities/status.ts b/packages/megalodon/src/entities/status.ts index f27f728b5..295703e57 100644 --- a/packages/megalodon/src/entities/status.ts +++ b/packages/megalodon/src/entities/status.ts @@ -1,7 +1,6 @@ /// /// /// -/// /// /// /// @@ -9,37 +8,42 @@ /// namespace Entity { - export type Status = { - id: string; - uri: string; - url: string; - account: Account; - in_reply_to_id: string | null; - in_reply_to_account_id: string | null; - reblog: Status | null; - content: string; - plain_content: string | null; - created_at: string; - emojis: Emoji[]; - replies_count: number; - reblogs_count: number; - favourites_count: number; - reblogged: boolean | null; - favourited: boolean | null; - muted: boolean | null; - sensitive: boolean; - spoiler_text: string; - visibility: "public" | "unlisted" | "private" | "direct"; - media_attachments: Array; - mentions: Array; - tags: Array; - card: Card | null; - poll: Poll | null; - application: Application | null; - language: string | null; - pinned: boolean | null; - reactions: Array; - quote: Status | null; - bookmarked: boolean; - }; + export type Status = { + id: string + uri: string + url: string + account: Account + in_reply_to_id: string | null + in_reply_to_account_id: string | null + reblog: Status | null + content: string + plain_content: string | null + created_at: string + emojis: Emoji[] + replies_count: number + reblogs_count: number + favourites_count: number + reblogged: boolean | null + favourited: boolean | null + muted: boolean | null + sensitive: boolean + spoiler_text: string + visibility: 'public' | 'unlisted' | 'private' | 'direct' + media_attachments: Array + mentions: Array + tags: Array + card: Card | null + poll: Poll | null + application: Application | null + language: string | null + pinned: boolean | null + emoji_reactions: Array + quote: boolean + bookmarked: boolean + } + + export type StatusTag = { + name: string + url: string + } } diff --git a/packages/megalodon/src/entities/status_params.ts b/packages/megalodon/src/entities/status_params.ts index 18908c01c..82d789086 100644 --- a/packages/megalodon/src/entities/status_params.ts +++ b/packages/megalodon/src/entities/status_params.ts @@ -1,12 +1,12 @@ namespace Entity { - export type StatusParams = { - text: string; - in_reply_to_id: string | null; - media_ids: Array | null; - sensitive: boolean | null; - spoiler_text: string | null; - visibility: "public" | "unlisted" | "private" | "direct"; - scheduled_at: string | null; - application_id: string; - }; + export type StatusParams = { + text: string + in_reply_to_id: string | null + media_ids: Array | null + sensitive: boolean | null + spoiler_text: string | null + visibility: 'public' | 'unlisted' | 'private' | 'direct' | null + scheduled_at: string | null + application_id: number | null + } } diff --git a/packages/megalodon/src/entities/status_source.ts b/packages/megalodon/src/entities/status_source.ts new file mode 100644 index 000000000..0de7030ed --- /dev/null +++ b/packages/megalodon/src/entities/status_source.ts @@ -0,0 +1,7 @@ +namespace Entity { + export type StatusSource = { + id: string + text: string + spoiler_text: string + } +} diff --git a/packages/megalodon/src/entities/tag.ts b/packages/megalodon/src/entities/tag.ts index ccc88aece..ddc5fe92b 100644 --- a/packages/megalodon/src/entities/tag.ts +++ b/packages/megalodon/src/entities/tag.ts @@ -1,10 +1,10 @@ /// namespace Entity { - export type Tag = { - name: string; - url: string; - history: Array | null; - following?: boolean; - }; + export type Tag = { + name: string + url: string + history: Array + following?: boolean + } } diff --git a/packages/megalodon/src/entities/token.ts b/packages/megalodon/src/entities/token.ts index 1583edafb..6fa28e39b 100644 --- a/packages/megalodon/src/entities/token.ts +++ b/packages/megalodon/src/entities/token.ts @@ -1,8 +1,8 @@ namespace Entity { - export type Token = { - access_token: string; - token_type: string; - scope: string; - created_at: number; - }; + export type Token = { + access_token: string + token_type: string + scope: string + created_at: number + } } diff --git a/packages/megalodon/src/entities/urls.ts b/packages/megalodon/src/entities/urls.ts index 1ee9ed67c..4a980d589 100644 --- a/packages/megalodon/src/entities/urls.ts +++ b/packages/megalodon/src/entities/urls.ts @@ -1,5 +1,5 @@ namespace Entity { - export type URLs = { - streaming_api: string; - }; + export type URLs = { + streaming_api: string + } } diff --git a/packages/megalodon/src/entity.ts b/packages/megalodon/src/entity.ts index b73d2b359..387981cec 100644 --- a/packages/megalodon/src/entity.ts +++ b/packages/megalodon/src/entity.ts @@ -11,6 +11,7 @@ /// /// /// +/// /// /// /// @@ -31,8 +32,9 @@ /// /// /// +/// /// /// /// -export default Entity; +export default Entity diff --git a/packages/megalodon/src/filter_context.ts b/packages/megalodon/src/filter_context.ts index 4c83cb15f..c69be98cd 100644 --- a/packages/megalodon/src/filter_context.ts +++ b/packages/megalodon/src/filter_context.ts @@ -1,11 +1,11 @@ -import Entity from "./entity"; +import Entity from './entity' namespace FilterContext { - export const Home: Entity.FilterContext = "home"; - export const Notifications: Entity.FilterContext = "notifications"; - export const Public: Entity.FilterContext = "public"; - export const Thread: Entity.FilterContext = "thread"; - export const Account: Entity.FilterContext = "account"; + export const Home: Entity.FilterContext = 'home' + export const Notifications: Entity.FilterContext = 'notifications' + export const Public: Entity.FilterContext = 'public' + export const Thread: Entity.FilterContext = 'thread' + export const Account: Entity.FilterContext = 'account' } -export default FilterContext; +export default FilterContext diff --git a/packages/megalodon/src/friendica.ts b/packages/megalodon/src/friendica.ts new file mode 100644 index 000000000..c5ee9d59c --- /dev/null +++ b/packages/megalodon/src/friendica.ts @@ -0,0 +1,2868 @@ +import { OAuth2 } from 'oauth' +import FormData from 'form-data' +import parseLinkHeader from 'parse-link-header' + +import FriendicaAPI from './friendica/api_client' +import WebSocket from './friendica/web_socket' +import { MegalodonInterface, NoImplementedError } from './megalodon' +import Response from './response' +import Entity from './entity' +import { NO_REDIRECT, DEFAULT_SCOPE, DEFAULT_UA } from './default' +import { ProxyConfig } from './proxy_config' +import OAuth from './oauth' +import { UnknownNotificationTypeError } from './notification' + +export default class Friendica implements MegalodonInterface { + public client: FriendicaAPI.Interface + public baseUrl: string + + /** + * @param baseUrl hostname or base URL + * @param accessToken access token from OAuth2 authorization + * @param userAgent UserAgent is specified in header on request. + * @param proxyConfig Proxy setting, or set false if don't use proxy. + */ + constructor( + baseUrl: string, + accessToken: string | null = null, + userAgent: string | null = DEFAULT_UA, + proxyConfig: ProxyConfig | false = false + ) { + let token = '' + if (accessToken) { + token = accessToken + } + let agent: string = DEFAULT_UA + if (userAgent) { + agent = userAgent + } + this.client = new FriendicaAPI.Client(baseUrl, token, agent, proxyConfig) + this.baseUrl = baseUrl + } + + public cancel(): void { + return this.client.cancel() + } + + /** + * First, call createApp to get client_id and client_secret. + * Next, call generateAuthUrl to get authorization url. + * @param client_name Form Data, which is sent to /api/v1/apps + * @param options Form Data, which is sent to /api/v1/apps. and properties should be **snake_case** + */ + public async registerApp( + client_name: string, + options: Partial<{ scopes: Array; redirect_uris: string; website: string }> + ): Promise { + const scopes = options.scopes || DEFAULT_SCOPE + return this.createApp(client_name, options).then(async appData => { + return this.generateAuthUrl(appData.client_id, appData.client_secret, { + scope: scopes, + redirect_uri: appData.redirect_uri + }).then(url => { + appData.url = url + return appData + }) + }) + } + + /** + * Call /api/v1/apps + * + * Create an application. + * @param client_name your application's name + * @param options Form Data + */ + public async createApp( + client_name: string, + options: Partial<{ scopes: Array; redirect_uris: string; website: string }> + ): Promise { + const scopes = options.scopes || DEFAULT_SCOPE + const redirect_uris = options.redirect_uris || NO_REDIRECT + + const params: { + client_name: string + redirect_uris: string + scopes: string + website?: string + } = { + client_name: client_name, + redirect_uris: redirect_uris, + scopes: scopes.join(' ') + } + if (options.website) params.website = options.website + + return this.client + .post('/api/v1/apps', params) + .then((res: Response) => OAuth.AppData.from(res.data)) + } + + /** + * Generate authorization url using OAuth2. + * + * @param clientId your OAuth app's client ID + * @param clientSecret your OAuth app's client Secret + * @param options as property, redirect_uri and scope are available, and must be the same as when you register your app + */ + public generateAuthUrl( + clientId: string, + clientSecret: string, + options: Partial<{ scope: Array; redirect_uri: string }> + ): Promise { + const scope = options.scope || DEFAULT_SCOPE + const redirect_uri = options.redirect_uri || NO_REDIRECT + return new Promise(resolve => { + const oauth = new OAuth2(clientId, clientSecret, this.baseUrl, undefined, '/oauth/token') + const url = oauth.getAuthorizeUrl({ + redirect_uri: redirect_uri, + response_type: 'code', + client_id: clientId, + scope: scope.join(' ') + }) + resolve(url) + }) + } + + // ====================================== + // apps + // ====================================== + /** + * GET /api/v1/apps/verify_credentials + * + * @return An Application + */ + public verifyAppCredentials(): Promise> { + return this.client.get('/api/v1/apps/verify_credentials') + } + + // ====================================== + // apps/oauth + // ====================================== + /** + * POST /oauth/token + * + * Fetch OAuth access token. + * Get an access token based client_id and client_secret and authorization code. + * @param client_id will be generated by #createApp or #registerApp + * @param client_secret will be generated by #createApp or #registerApp + * @param code will be generated by the link of #generateAuthUrl or #registerApp + * @param redirect_uri must be the same uri as the time when you register your OAuth application + */ + public async fetchAccessToken( + client_id: string | null, + client_secret: string, + code: string, + redirect_uri: string = NO_REDIRECT + ): Promise { + if (!client_id) { + throw new Error('client_id is required') + } + return this.client + .post('/oauth/token', { + client_id, + client_secret, + code, + redirect_uri, + grant_type: 'authorization_code' + }) + .then((res: Response) => OAuth.TokenData.from(res.data)) + } + + /** + * POST /oauth/token + * + * Refresh OAuth access token. + * Send refresh token and get new access token. + * @param client_id will be generated by #createApp or #registerApp + * @param client_secret will be generated by #createApp or #registerApp + * @param refresh_token will be get #fetchAccessToken + */ + public async refreshToken(client_id: string, client_secret: string, refresh_token: string): Promise { + return this.client + .post('/oauth/token', { + client_id, + client_secret, + refresh_token, + grant_type: 'refresh_token' + }) + .then((res: Response) => OAuth.TokenData.from(res.data)) + } + + /** + * POST /oauth/revoke + * + * Revoke an OAuth token. + * @param client_id will be generated by #createApp or #registerApp + * @param client_secret will be generated by #createApp or #registerApp + * @param token will be get #fetchAccessToken + */ + public async revokeToken(client_id: string, client_secret: string, token: string): Promise>> { + return this.client.post>('/oauth/revoke', { + client_id, + client_secret, + token + }) + } + + // ====================================== + // accounts + // ====================================== + public async registerAccount( + _username: string, + _email: string, + _password: string, + _agreement: boolean, + _locale: string, + _reason?: string | null + ): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + /** + * GET /api/v1/accounts/verify_credentials + * + * @return Account. + */ + public async verifyAccountCredentials(): Promise> { + return this.client.get('/api/v1/accounts/verify_credentials').then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.account(res.data) + }) + }) + } + + public async updateCredentials(_options?: { + discoverable?: boolean + bot?: boolean + display_name?: string + note?: string + avatar?: string + header?: string + locked?: boolean + source?: { + privacy?: string + sensitive?: boolean + language?: string + } + fields_attributes?: Array<{ name: string; value: string }> + }): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + /** + * GET /api/v1/accounts/:id + * + * @param id The account ID. + * @return An account. + */ + public async getAccount(id: string): Promise> { + return this.client.get(`/api/v1/accounts/${id}`).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.account(res.data) + }) + }) + } + + /** + * GET /api/v1/accounts/:id/statuses + * + * @param id The account ID. + + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID but starting with most recent. + * @param options.min_id Return results newer than ID. + * @param options.pinned Return statuses which include pinned statuses. + * @param options.exclude_replies Return statuses which exclude replies. + * @param options.exclude_reblogs Return statuses which exclude reblogs. + * @param options.only_media Show only statuses with media attached? Defaults to false. + * @return Account's statuses. + */ + public async getAccountStatuses( + id: string, + options?: { + limit?: number + max_id?: string + since_id?: string + min_id?: string + pinned?: boolean + exclude_replies?: boolean + exclude_reblogs?: boolean + only_media: boolean + } + ): Promise>> { + let params = {} + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.pinned) { + params = Object.assign(params, { + pinned: options.pinned + }) + } + if (options.exclude_replies) { + params = Object.assign(params, { + exclude_replies: options.exclude_replies + }) + } + if (options.exclude_reblogs) { + params = Object.assign(params, { + exclude_reblogs: options.exclude_reblogs + }) + } + if (options.only_media) { + params = Object.assign(params, { + only_media: options.only_media + }) + } + } + + return this.client.get>(`/api/v1/accounts/${id}/statuses`, params).then(res => { + return Object.assign(res, { + data: res.data.map(s => FriendicaAPI.Converter.status(s)) + }) + }) + } + + /** + * POST /api/v1/accounts/:id/follow + * + * @param id Target account ID. + * @return Relationship. + */ + public async subscribeAccount(id: string): Promise> { + const params = { + notify: true + } + return this.client.post(`/api/v1/accounts/${id}/follow`, params).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * POST /api/v1/accounts/:id/follow + * + * @param id Target account ID. + * @return Relationship. + */ + public async unsubscribeAccount(id: string): Promise> { + const params = { + notify: false + } + return this.client.post(`/api/v1/accounts/${id}/follow`, params).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.relationship(res.data) + }) + }) + } + + public getAccountFavourites( + _id: string, + _options?: { + limit?: number + max_id?: string + since_id?: string + } + ): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + /** + * GET /api/v1/accounts/:id/followers + * + * @param id The account ID. + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @return The array of accounts. + */ + public async getAccountFollowers( + id: string, + options?: { + limit?: number + max_id?: string + since_id?: string + get_all?: boolean + sleep_ms?: number + } + ): Promise>> { + let params = {} + if (options) { + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.urlToAccounts(`/api/v1/accounts/${id}/followers`, params, options?.get_all || false, options?.sleep_ms || 0) + } + + /** + * GET /api/v1/accounts/:id/following + * + * @param id The account ID. + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @return The array of accounts. + */ + public async getAccountFollowing( + id: string, + options?: { + limit?: number + max_id?: string + since_id?: string + get_all?: boolean + sleep_ms?: number + } + ): Promise>> { + let params = {} + if (options) { + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.urlToAccounts(`/api/v1/accounts/${id}/following`, params, options?.get_all || false, options?.sleep_ms || 0) + } + + /** Helper function to optionally follow Link headers as pagination */ + private async urlToAccounts(url: string, params: Record, get_all: boolean, sleep_ms: number) { + const res = await this.client.get>(url, params) + let converted = Object.assign({}, res, { + data: res.data.map(a => FriendicaAPI.Converter.account(a)) + }) + if (get_all && converted.headers.link) { + let parsed = parseLinkHeader(converted.headers.link) + while (parsed?.next) { + const nextRes = await this.client.get>(parsed?.next.url, undefined, undefined, true) + converted = Object.assign({}, converted, { + data: [...converted.data, ...nextRes.data.map(a => FriendicaAPI.Converter.account(a))] + }) + parsed = parseLinkHeader(nextRes.headers.link) + if (sleep_ms) { + await new Promise(converted => setTimeout(converted, sleep_ms)) + } + } + } + return converted + } + + /** + * GET /api/v1/accounts/:id/lists + * + * @param id The account ID. + * @return The array of lists. + */ + public async getAccountLists(id: string): Promise>> { + return this.client.get>(`/api/v1/accounts/${id}/lists`).then(res => { + return Object.assign(res, { + data: res.data.map(l => FriendicaAPI.Converter.list(l)) + }) + }) + } + + /** + * GET /api/v1/accounts/:id/identity_proofs + * + * @param id The account ID. + * @return Array of IdentityProof + */ + public async getIdentityProof(id: string): Promise>> { + return this.client.get>(`/api/v1/accounts/${id}/identity_proofs`).then(res => { + return Object.assign(res, { + data: res.data.map(i => FriendicaAPI.Converter.identity_proof(i)) + }) + }) + } + + /** + * POST /api/v1/accounts/:id/follow + * + * @param id The account ID. + * @param reblog Receive this account's reblogs in home timeline. + * @return Relationship + */ + public async followAccount(id: string, options?: { reblog?: boolean }): Promise> { + let params = {} + if (options) { + if (options.reblog !== undefined) { + params = Object.assign(params, { + reblog: options.reblog + }) + } + } + return this.client.post(`/api/v1/accounts/${id}/follow`, params).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * POST /api/v1/accounts/:id/unfollow + * + * @param id The account ID. + * @return Relationship + */ + public async unfollowAccount(id: string): Promise> { + return this.client.post(`/api/v1/accounts/${id}/unfollow`).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * POST /api/v1/accounts/:id/block + * + * @param id The account ID. + * @return Relationship + */ + public async blockAccount(id: string): Promise> { + return this.client.post(`/api/v1/accounts/${id}/block`).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * POST /api/v1/accounts/:id/unblock + * + * @param id The account ID. + * @return RElationship + */ + public async unblockAccount(id: string): Promise> { + return this.client.post(`/api/v1/accounts/${id}/unblock`).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * POST /api/v1/accounts/:id/mute + * + * @param id The account ID. + * @param notifications Mute notifications in addition to statuses. + * @return Relationship + */ + public async muteAccount(id: string, notifications = true): Promise> { + return this.client + .post(`/api/v1/accounts/${id}/mute`, { + notifications: notifications + }) + .then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * POST /api/v1/accounts/:id/unmute + * + * @param id The account ID. + * @return Relationship + */ + public async unmuteAccount(id: string): Promise> { + return this.client.post(`/api/v1/accounts/${id}/unmute`).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * POST /api/v1/accounts/:id/pin + * + * @param id The account ID. + * @return Relationship + */ + public async pinAccount(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + /** + * POST /api/v1/accounts/:id/unpin + * + * @param id The account ID. + * @return Relationship + */ + public async unpinAccount(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + /** + * GET /api/v1/accounts/relationships + * + * @param id The account ID. + * @return Relationship + */ + public async getRelationship(id: string): Promise> { + return this.client + .get>('/api/v1/accounts/relationships', { + id: [id] + }) + .then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.relationship(res.data[0]) + }) + }) + } + + /** + * Get multiple relationships in one method + * + * @param ids Array of account IDs. + * @return Array of Relationship. + */ + public async getRelationships(ids: Array): Promise>> { + return this.client + .get>('/api/v1/accounts/relationships', { + id: ids + }) + .then(res => { + return Object.assign(res, { + data: res.data.map(r => FriendicaAPI.Converter.relationship(r)) + }) + }) + } + + /** + * GET /api/v1/accounts/search + * + * @param q Search query. + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @return The array of accounts. + */ + public async searchAccount( + q: string, + options?: { + following?: boolean + resolve?: boolean + limit?: number + max_id?: string + since_id?: string + } + ): Promise>> { + let params = { q: q } + if (options) { + if (options.following !== undefined && options.following !== null) { + params = Object.assign(params, { + following: options.following + }) + } + if (options.resolve !== undefined && options.resolve !== null) { + params = Object.assign(params, { + resolve: options.resolve + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>('/api/v1/accounts/search', params).then(res => { + return Object.assign(res, { + data: res.data.map(a => FriendicaAPI.Converter.account(a)) + }) + }) + } + + // ====================================== + // accounts/bookmarks + // ====================================== + /** + * GET /api/v1/bookmarks + * + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + public async getBookmarks(options?: { + limit?: number + max_id?: string + since_id?: string + min_id?: string + }): Promise>> { + let params = {} + if (options) { + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + } + return this.client.get>('/api/v1/bookmarks', params).then(res => { + return Object.assign(res, { + data: res.data.map(s => FriendicaAPI.Converter.status(s)) + }) + }) + } + + // ====================================== + // accounts/favourites + // ====================================== + /** + * GET /api/v1/favourites + * + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + public async getFavourites(options?: { limit?: number; max_id?: string; min_id?: string }): Promise>> { + let params = {} + if (options) { + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>('/api/v1/favourites', params).then(res => { + return Object.assign(res, { + data: res.data.map(s => FriendicaAPI.Converter.status(s)) + }) + }) + } + + // ====================================== + // accounts/mutes + // ====================================== + /** + * GET /api/v1/mutes + * + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of accounts. + */ + public async getMutes(options?: { limit?: number; max_id?: string; min_id?: string }): Promise>> { + let params = {} + if (options) { + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>('/api/v1/mutes', params).then(res => { + return Object.assign(res, { + data: res.data.map(a => FriendicaAPI.Converter.account(a)) + }) + }) + } + + // ====================================== + // accounts/blocks + // ====================================== + /** + * GET /api/v1/blocks + * + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of accounts. + */ + public async getBlocks(options?: { limit?: number; max_id?: string; min_id?: string }): Promise>> { + let params = {} + if (options) { + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>('/api/v1/blocks', params).then(res => { + return Object.assign(res, { + data: res.data.map(a => FriendicaAPI.Converter.account(a)) + }) + }) + } + + // ====================================== + // accounts/domain_blocks + // ====================================== + public async getDomainBlocks(_options?: { limit?: number; max_id?: string; min_id?: string }): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + public blockDomain(_domain: string): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + public unblockDomain(_domain: string): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + // ====================================== + // accounts/filters + // ====================================== + /** + * GET /api/v1/filters + * + * @return Array of filters. + */ + public async getFilters(): Promise>> { + return this.client.get>('/api/v1/filters').then(res => { + return Object.assign(res, { + data: res.data.map(f => FriendicaAPI.Converter.filter(f)) + }) + }) + } + + public async getFilter(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + public async createFilter( + _phrase: string, + _context: Array, + _options?: { + irreversible?: boolean + whole_word?: boolean + expires_in?: string + } + ): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + public async updateFilter( + _id: string, + _phrase: string, + _context: Array, + _options?: { + irreversible?: boolean + whole_word?: boolean + expires_in?: string + } + ): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + public async deleteFilter(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + // ====================================== + // accounts/reports + // ====================================== + public async report( + _account_id: string, + _options?: { + status_ids?: Array + comment: string + forward?: boolean + category?: Entity.Category + rule_ids?: Array + } + ): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + // ====================================== + // accounts/follow_requests + // ====================================== + /** + * GET /api/v1/follow_requests + * + * @param limit Maximum number of results. + * @return Array of FollowRequest. + */ + public async getFollowRequests(limit?: number): Promise>> { + if (limit) { + return this.client + .get>('/api/v1/follow_requests', { + limit: limit + }) + .then(res => { + return Object.assign(res, { + data: res.data.map(a => FriendicaAPI.Converter.follow_request(a)) + }) + }) + } else { + return this.client.get>('/api/v1/follow_requests').then(res => { + return Object.assign(res, { + data: res.data.map(a => FriendicaAPI.Converter.follow_request(a)) + }) + }) + } + } + + /** + * POST /api/v1/follow_requests/:id/authorize + * + * @param id The FollowRequest ID. + * @return Relationship. + */ + public async acceptFollowRequest(id: string): Promise> { + return this.client.post(`/api/v1/follow_requests/${id}/authorize`).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * POST /api/v1/follow_requests/:id/reject + * + * @param id The FollowRequest ID. + * @return Relationship. + */ + public async rejectFollowRequest(id: string): Promise> { + return this.client.post(`/api/v1/follow_requests/${id}/reject`).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.relationship(res.data) + }) + }) + } + + // ====================================== + // accounts/endorsements + // ====================================== + /** + * GET /api/v1/endorsements + * + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @return Array of accounts. + */ + public async getEndorsements(options?: { limit?: number; max_id?: string; since_id?: string }): Promise>> { + let params = {} + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + } + return this.client.get>('/api/v1/endorsements', params).then(res => { + return Object.assign(res, { + data: res.data.map(a => FriendicaAPI.Converter.account(a)) + }) + }) + } + + // ====================================== + // accounts/featured_tags + // ====================================== + public async getFeaturedTags(): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + public async createFeaturedTag(_name: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + public deleteFeaturedTag(_id: string): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + public async getSuggestedTags(): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + // ====================================== + // accounts/preferences + // ====================================== + /** + * GET /api/v1/preferences + * + * @return Preferences. + */ + public async getPreferences(): Promise> { + return this.client.get('/api/v1/preferences').then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.preferences(res.data) + }) + }) + } + + // ====================================== + // accounts/followed_tags + // ====================================== + public async getFollowedTags(): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + // ====================================== + // accounts/suggestions + // ====================================== + /** + * GET /api/v1/suggestions + * + * @param limit Maximum number of results. + * @return Array of accounts. + */ + public async getSuggestions(limit?: number): Promise>> { + if (limit) { + return this.client + .get>('/api/v1/suggestions', { + limit: limit + }) + .then(res => { + return Object.assign(res, { + data: res.data.map(a => FriendicaAPI.Converter.account(a)) + }) + }) + } else { + return this.client.get>('/api/v1/suggestions').then(res => { + return Object.assign(res, { + data: res.data.map(a => FriendicaAPI.Converter.account(a)) + }) + }) + } + } + + // ====================================== + // accounts/tags + // ====================================== + /** + * GET /api/v1/tags/:id + * + * @param id Target hashtag id. + * @return Tag + */ + public async getTag(id: string): Promise> { + return this.client.get(`/api/v1/tags/${id}`).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.tag(res.data) + }) + }) + } + + /** + * POST /api/v1/tags/:id/follow + * + * @param id Target hashtag id. + * @return Tag + */ + public async followTag(id: string): Promise> { + return this.client.post(`/api/v1/tags/${id}/follow`).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.tag(res.data) + }) + }) + } + + /** + * POST /api/v1/tags/:id/unfollow + * + * @param id Target hashtag id. + * @return Tag + */ + public async unfollowTag(id: string): Promise> { + return this.client.post(`/api/v1/tags/${id}/unfollow`).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.tag(res.data) + }) + }) + } + + // ====================================== + // statuses + // ====================================== + /** + * POST /api/v1/statuses + * + * @param status Text content of status. + * @param options.media_ids Array of Attachment ids. + * @param options.poll Poll object. + * @param options.in_reply_to_id ID of the status being replied to, if status is a reply. + * @param options.sensitive Mark status and attached media as sensitive? + * @param options.spoiler_text Text to be shown as a warning or subject before the actual content. + * @param options.visibility Visibility of the posted status. + * @param options.scheduled_at ISO 8601 Datetime at which to schedule a status. + * @param options.language ISO 639 language code for this status. + * @param options.quote_id ID of the status being quoted to, if status is a quote. + * @return Status. When options.scheduled_at is present, ScheduledStatus is returned instead. + */ + public async postStatus( + status: string, + options: { + media_ids?: Array + poll?: { options: Array; expires_in: number; multiple?: boolean; hide_totals?: boolean } + in_reply_to_id?: string + sensitive?: boolean + spoiler_text?: string + visibility?: 'public' | 'unlisted' | 'private' | 'direct' + scheduled_at?: string + language?: string + quote_id?: string + } + ): Promise> { + let params = { + status: status + } + if (options) { + if (options.media_ids) { + params = Object.assign(params, { + media_ids: options.media_ids + }) + } + if (options.poll) { + let pollParam = { + options: options.poll.options, + expires_in: options.poll.expires_in + } + if (options.poll.multiple !== undefined) { + pollParam = Object.assign(pollParam, { + multiple: options.poll.multiple + }) + } + if (options.poll.hide_totals !== undefined) { + pollParam = Object.assign(pollParam, { + hide_totals: options.poll.hide_totals + }) + } + params = Object.assign(params, { + poll: pollParam + }) + } + if (options.in_reply_to_id) { + params = Object.assign(params, { + in_reply_to_id: options.in_reply_to_id + }) + } + if (options.sensitive !== undefined) { + params = Object.assign(params, { + sensitive: options.sensitive + }) + } + if (options.spoiler_text) { + params = Object.assign(params, { + spoiler_text: options.spoiler_text + }) + } + if (options.visibility) { + params = Object.assign(params, { + visibility: options.visibility + }) + } + if (options.scheduled_at) { + params = Object.assign(params, { + scheduled_at: options.scheduled_at + }) + } + if (options.language) { + params = Object.assign(params, { + language: options.language + }) + } + if (options.quote_id) { + params = Object.assign(params, { + quote_id: options.quote_id + }) + } + } + if (options.scheduled_at) { + return this.client.post('/api/v1/statuses', params).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.scheduled_status(res.data) + }) + }) + } + return this.client.post('/api/v1/statuses', params).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.status(res.data) + }) + }) + } + /** + * GET /api/v1/statuses/:id + * + * @param id The target status id. + * @return Status + */ + public async getStatus(id: string): Promise> { + return this.client.get(`/api/v1/statuses/${id}`).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.status(res.data) + }) + }) + } + + /** + PUT /api/v1/statuses/:id + * + * @param id The target status id. + * @return Status + */ + public async editStatus( + id: string, + options: { + status?: string + spoiler_text?: string + sensitive?: boolean + media_ids?: Array + poll?: { options?: Array; expires_in?: number; multiple?: boolean; hide_totals?: boolean } + } + ): Promise> { + let params = {} + if (options.status) { + params = Object.assign(params, { + status: options.status + }) + } + if (options.spoiler_text) { + params = Object.assign(params, { + spoiler_text: options.spoiler_text + }) + } + if (options.sensitive) { + params = Object.assign(params, { + sensitive: options.sensitive + }) + } + if (options.media_ids) { + params = Object.assign(params, { + media_ids: options.media_ids + }) + } + if (options.poll) { + let pollParam = {} + if (options.poll.options !== undefined) { + pollParam = Object.assign(pollParam, { + options: options.poll.options + }) + } + if (options.poll.expires_in !== undefined) { + pollParam = Object.assign(pollParam, { + expires_in: options.poll.expires_in + }) + } + if (options.poll.multiple !== undefined) { + pollParam = Object.assign(pollParam, { + multiple: options.poll.multiple + }) + } + if (options.poll.hide_totals !== undefined) { + pollParam = Object.assign(pollParam, { + hide_totals: options.poll.hide_totals + }) + } + params = Object.assign(params, { + poll: pollParam + }) + } + return this.client.put(`/api/v1/statuses/${id}`, params).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.status(res.data) + }) + }) + } + + /** + * DELETE /api/v1/statuses/:id + * + * @param id The target status id. + * @return Status + */ + public async deleteStatus(id: string): Promise> { + return this.client.del(`/api/v1/statuses/${id}`).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.status(res.data) + }) + }) + } + + /** + * GET /api/v1/statuses/:id/context + * + * Get parent and child statuses. + * @param id The target status id. + * @return Context + */ + public async getStatusContext( + id: string, + options?: { limit?: number; max_id?: string; since_id?: string } + ): Promise> { + let params = {} + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + } + return this.client.get(`/api/v1/statuses/${id}/context`, params).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.context(res.data) + }) + }) + } + + /** + * GET /api/v1/statuses/:id/source + * + * Obtain the source properties for a status so that it can be edited. + * @param id The target status id. + * @return StatusSource + */ + public async getStatusSource(id: string): Promise> { + return this.client.get(`/api/v1/statuses/${id}/source`).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.status_source(res.data) + }) + }) + } + + /** + * GET /api/v1/statuses/:id/reblogged_by + * + * @param id The target status id. + * @return Array of accounts. + */ + public async getStatusRebloggedBy(id: string): Promise>> { + return this.client.get>(`/api/v1/statuses/${id}/reblogged_by`).then(res => { + return Object.assign(res, { + data: res.data.map(a => FriendicaAPI.Converter.account(a)) + }) + }) + } + + /** + * GET /api/v1/statuses/:id/favourited_by + * + * @param id The target status id. + * @return Array of accounts. + */ + public async getStatusFavouritedBy(id: string): Promise>> { + return this.client.get>(`/api/v1/statuses/${id}/favourited_by`).then(res => { + return Object.assign(res, { + data: res.data.map(a => FriendicaAPI.Converter.account(a)) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/favourite + * + * @param id The target status id. + * @return Status. + */ + public async favouriteStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/favourite`).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.status(res.data) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/unfavourite + * + * @param id The target status id. + * @return Status. + */ + public async unfavouriteStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/unfavourite`).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.status(res.data) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/reblog + * + * @param id The target status id. + * @return Status. + */ + public async reblogStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/reblog`).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.status(res.data) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/unreblog + * + * @param id The target status id. + * @return Status. + */ + public async unreblogStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/unreblog`).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.status(res.data) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/bookmark + * + * @param id The target status id. + * @return Status. + */ + public async bookmarkStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/bookmark`).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.status(res.data) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/unbookmark + * + * @param id The target status id. + * @return Status. + */ + public async unbookmarkStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/unbookmark`).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.status(res.data) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/mute + * + * @param id The target status id. + * @return Status + */ + public async muteStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/mute`).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.status(res.data) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/unmute + * + * @param id The target status id. + * @return Status + */ + public async unmuteStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/unmute`).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.status(res.data) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/pin + * @param id The target status id. + * @return Status + */ + public async pinStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/pin`).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.status(res.data) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/unpin + * + * @param id The target status id. + * @return Status + */ + public async unpinStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/unpin`).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.status(res.data) + }) + }) + } + + // ====================================== + // statuses/media + // ====================================== + /** + * POST /api/v2/media + * + * @param file The file to be attached, using multipart form data. + * @param options.description A plain-text description of the media. + * @param options.focus Two floating points (x,y), comma-delimited, ranging from -1.0 to 1.0. + * @return Attachment + */ + public async uploadMedia( + file: any, + options?: { description?: string; focus?: string } + ): Promise> { + const formData = new FormData() + formData.append('file', file) + if (options) { + if (options.description) { + formData.append('description', options.description) + } + if (options.focus) { + formData.append('focus', options.focus) + } + } + return this.client.postForm('/api/v2/media', formData).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.async_attachment(res.data) + }) + }) + } + + /** + * GET /api/v1/media/:id + * + * @param id Target media ID. + * @return Attachment + */ + public async getMedia(id: string): Promise> { + const res = await this.client.get(`/api/v1/media/${id}`) + + return Object.assign(res, { + data: FriendicaAPI.Converter.attachment(res.data) + }) + } + + /** + * PUT /api/v1/media/:id + * + * @param id Target media ID. + * @param options.file The file to be attached, using multipart form data. + * @param options.description A plain-text description of the media. + * @param options.focus Two floating points (x,y), comma-delimited, ranging from -1.0 to 1.0. + * @param options.is_sensitive Whether the media is sensitive. + * @return Attachment + */ + public async updateMedia( + id: string, + options?: { + file?: any + description?: string + focus?: string + } + ): Promise> { + const formData = new FormData() + if (options) { + if (options.file) { + formData.append('file', options.file) + } + if (options.description) { + formData.append('description', options.description) + } + if (options.focus) { + formData.append('focus', options.focus) + } + } + return this.client.putForm(`/api/v1/media/${id}`, formData).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.attachment(res.data) + }) + }) + } + + // ====================================== + // statuses/polls + // ====================================== + /** + * GET /api/v1/polls/:id + * + * @param id Target poll ID. + * @return Poll + */ + public async getPoll(id: string): Promise> { + return this.client.get(`/api/v1/polls/${id}`).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.poll(res.data) + }) + }) + } + + public async votePoll(_id: string, _choices: Array): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + // ====================================== + // statuses/scheduled_statuses + // ====================================== + /** + * GET /api/v1/scheduled_statuses + * + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of scheduled statuses. + */ + public async getScheduledStatuses(options?: { + limit?: number | null + max_id?: string | null + since_id?: string | null + min_id?: string | null + }): Promise>> { + let params = {} + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + } + return this.client.get>('/api/v1/scheduled_statuses', params).then(res => { + return Object.assign(res, { + data: res.data.map(s => FriendicaAPI.Converter.scheduled_status(s)) + }) + }) + } + + /** + * GET /api/v1/scheduled_statuses/:id + * + * @param id Target status ID. + * @return ScheduledStatus. + */ + public async getScheduledStatus(id: string): Promise> { + return this.client.get(`/api/v1/scheduled_statuses/${id}`).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.scheduled_status(res.data) + }) + }) + } + + public async scheduleStatus(_id: string, _scheduled_at?: string | null): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + /** + * DELETE /api/v1/scheduled_statuses/:id + * + * @param id Target scheduled status ID. + */ + public cancelScheduledStatus(id: string): Promise>> { + return this.client.del>(`/api/v1/scheduled_statuses/${id}`) + } + + // ====================================== + // timelines + // ====================================== + /** + * GET /api/v1/timelines/public + * + * @param options.only_media Show only statuses with media attached? Defaults to false. + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + public async getPublicTimeline(options?: { + only_media?: boolean + limit?: number + max_id?: string + since_id?: string + min_id?: string + }): Promise>> { + let params = { + local: false + } + if (options) { + if (options.only_media !== undefined) { + params = Object.assign(params, { + only_media: options.only_media + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>('/api/v1/timelines/public', params).then(res => { + return Object.assign(res, { + data: res.data.map(s => FriendicaAPI.Converter.status(s)) + }) + }) + } + + /** + * GET /api/v1/timelines/public + * + * @param options.only_media Show only statuses with media attached? Defaults to false. + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + public async getLocalTimeline(options?: { + only_media?: boolean + limit?: number + max_id?: string + since_id?: string + min_id?: string + }): Promise>> { + let params = { + local: true + } + if (options) { + if (options.only_media !== undefined) { + params = Object.assign(params, { + only_media: options.only_media + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>('/api/v1/timelines/public', params).then(res => { + return Object.assign(res, { + data: res.data.map(s => FriendicaAPI.Converter.status(s)) + }) + }) + } + + /** + * GET /api/v1/timelines/tag/:hashtag + * + * @param hashtag Content of a #hashtag, not including # symbol. + * @param options.local Show only local statuses? Defaults to false. + * @param options.only_media Show only statuses with media attached? Defaults to false. + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + public async getTagTimeline( + hashtag: string, + options?: { + local?: boolean + only_media?: boolean + limit?: number + max_id?: string + since_id?: string + min_id?: string + } + ): Promise>> { + let params = {} + if (options) { + if (options.local !== undefined) { + params = Object.assign(params, { + local: options.local + }) + } + if (options.only_media !== undefined) { + params = Object.assign(params, { + only_media: options.only_media + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>(`/api/v1/timelines/tag/${hashtag}`, params).then(res => { + return Object.assign(res, { + data: res.data.map(s => FriendicaAPI.Converter.status(s)) + }) + }) + } + + /** + * GET /api/v1/timelines/home + * + * @param options.local Show only local statuses? Defaults to false. + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + public async getHomeTimeline(options?: { + local?: boolean + limit?: number + max_id?: string + since_id?: string + min_id?: string + }): Promise>> { + let params = {} + if (options) { + if (options.local !== undefined) { + params = Object.assign(params, { + local: options.local + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>('/api/v1/timelines/home', params).then(res => { + return Object.assign(res, { + data: res.data.map(s => FriendicaAPI.Converter.status(s)) + }) + }) + } + + /** + * GET /api/v1/timelines/list/:list_id + * + * @param list_id Local ID of the list in the database. + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + public async getListTimeline( + list_id: string, + options?: { + limit?: number + max_id?: string + since_id?: string + min_id?: string + } + ): Promise>> { + let params = {} + if (options) { + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>(`/api/v1/timelines/list/${list_id}`, params).then(res => { + return Object.assign(res, { + data: res.data.map(s => FriendicaAPI.Converter.status(s)) + }) + }) + } + + // ====================================== + // timelines/conversations + // ====================================== + /** + * GET /api/v1/conversations + * + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + public async getConversationTimeline(options?: { + limit?: number + max_id?: string + since_id?: string + min_id?: string + }): Promise>> { + let params = {} + if (options) { + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>('/api/v1/conversations', params).then(res => { + return Object.assign(res, { + data: res.data.map(c => FriendicaAPI.Converter.conversation(c)) + }) + }) + } + + /** + * DELETE /api/v1/conversations/:id + * + * @param id Target conversation ID. + */ + public deleteConversation(id: string): Promise>> { + return this.client.del>(`/api/v1/conversations/${id}`) + } + + /** + * POST /api/v1/conversations/:id/read + * + * @param id Target conversation ID. + * @return Conversation. + */ + public async readConversation(id: string): Promise> { + return this.client.post(`/api/v1/conversations/${id}/read`).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.conversation(res.data) + }) + }) + } + + // ====================================== + // timelines/lists + // ====================================== + /** + * GET /api/v1/lists + * + * @return Array of lists. + */ + public async getLists(): Promise>> { + return this.client.get>('/api/v1/lists').then(res => { + return Object.assign(res, { + data: res.data.map(l => FriendicaAPI.Converter.list(l)) + }) + }) + } + + /** + * GET /api/v1/lists/:id + * + * @param id Target list ID. + * @return List. + */ + public async getList(id: string): Promise> { + return this.client.get(`/api/v1/lists/${id}`).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.list(res.data) + }) + }) + } + + /** + * POST /api/v1/lists + * + * @param title List name. + * @return List. + */ + public async createList(title: string): Promise> { + return this.client + .post('/api/v1/lists', { + title: title + }) + .then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.list(res.data) + }) + }) + } + + /** + * PUT /api/v1/lists/:id + * + * @param id Target list ID. + * @param title New list name. + * @return List. + */ + public async updateList(id: string, title: string): Promise> { + return this.client + .put(`/api/v1/lists/${id}`, { + title: title + }) + .then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.list(res.data) + }) + }) + } + + /** + * DELETE /api/v1/lists/:id + * + * @param id Target list ID. + */ + public deleteList(id: string): Promise>> { + return this.client.del>(`/api/v1/lists/${id}`) + } + + /** + * GET /api/v1/lists/:id/accounts + * + * @param id Target list ID. + * @param options.limit Max number of results to return. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of accounts. + */ + public async getAccountsInList( + id: string, + options?: { + limit?: number + max_id?: string + since_id?: string + } + ): Promise>> { + let params = {} + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + } + return this.client.get>(`/api/v1/lists/${id}/accounts`, params).then(res => { + return Object.assign(res, { + data: res.data.map(a => FriendicaAPI.Converter.account(a)) + }) + }) + } + + /** + * POST /api/v1/lists/:id/accounts + * + * @param id Target list ID. + * @param account_ids Array of account IDs to add to the list. + */ + public addAccountsToList(id: string, account_ids: Array): Promise>> { + return this.client.post>(`/api/v1/lists/${id}/accounts`, { + account_ids: account_ids + }) + } + + /** + * DELETE /api/v1/lists/:id/accounts + * + * @param id Target list ID. + * @param account_ids Array of account IDs to add to the list. + */ + public deleteAccountsFromList(id: string, account_ids: Array): Promise>> { + return this.client.del>(`/api/v1/lists/${id}/accounts`, { + account_ids: account_ids + }) + } + + // ====================================== + // timelines/markers + // ====================================== + public async getMarkers(_timeline: Array): Promise>> { + return new Promise(resolve => { + const res: Response = { + data: {}, + status: 200, + statusText: '200', + headers: {} + } + resolve(res) + }) + } + + public async saveMarkers(_options?: { + home?: { last_read_id: string } + notifications?: { last_read_id: string } + }): Promise> { + return new Promise(resolve => { + const res: Response = { + data: {}, + status: 200, + statusText: '200', + headers: {} + } + resolve(res) + }) + } + + // ====================================== + // notifications + // ====================================== + /** + * GET /api/v1/notifications + * + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @param options.exclude_types Array of types to exclude. + * @param options.account_id Return only notifications received from this account. + * @return Array of notifications. + */ + public async getNotifications(options?: { + limit?: number + max_id?: string + since_id?: string + min_id?: string + exclude_types?: Array + account_id?: string + }): Promise>> { + let params = {} + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.exclude_types) { + params = Object.assign(params, { + exclude_types: options.exclude_types.map(e => FriendicaAPI.Converter.encodeNotificationType(e)) + }) + } + if (options.account_id) { + params = Object.assign(params, { + account_id: options.account_id + }) + } + } + return this.client.get>('/api/v1/notifications', params).then(res => { + return Object.assign(res, { + data: res.data.flatMap(n => { + const notify = FriendicaAPI.Converter.notification(n) + if (notify instanceof UnknownNotificationTypeError) return [] + return notify + }) + }) + }) + } + + /** + * GET /api/v1/notifications/:id + * + * @param id Target notification ID. + * @return Notification. + */ + public async getNotification(id: string): Promise> { + const res = await this.client.get(`/api/v1/notifications/${id}`) + const notify = FriendicaAPI.Converter.notification(res.data) + if (notify instanceof UnknownNotificationTypeError) { + throw new UnknownNotificationTypeError() + } + return { ...res, data: notify } + } + + /** + * POST /api/v1/notifications/clear + */ + public dismissNotifications(): Promise>> { + return this.client.post>('/api/v1/notifications/clear') + } + + /** + * POST /api/v1/notifications/:id/dismiss + * + * @param id Target notification ID. + */ + public dismissNotification(id: string): Promise>> { + return this.client.post>(`/api/v1/notifications/${id}/dismiss`) + } + + public readNotifications(_options: { + id?: string + max_id?: string + }): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + // ====================================== + // notifications/push + // ====================================== + /** + * POST /api/v1/push/subscription + * + * @param subscription[endpoint] Endpoint URL that is called when a notification event occurs. + * @param subscription[keys][p256dh] User agent public key. Base64 encoded string of public key of ECDH key using prime256v1 curve. + * @param subscription[keys] Auth secret. Base64 encoded string of 16 bytes of random data. + * @param data[alerts][follow] Receive follow notifications? + * @param data[alerts][favourite] Receive favourite notifications? + * @param data[alerts][reblog] Receive reblog notifictaions? + * @param data[alerts][mention] Receive mention notifications? + * @param data[alerts][poll] Receive poll notifications? + * @return PushSubscription. + */ + public async subscribePushNotification( + subscription: { endpoint: string; keys: { p256dh: string; auth: string } }, + data?: { alerts: { follow?: boolean; favourite?: boolean; reblog?: boolean; mention?: boolean; poll?: boolean } } | null + ): Promise> { + let params = { + subscription + } + if (data) { + params = Object.assign(params, { + data + }) + } + return this.client.post('/api/v1/push/subscription', params).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.push_subscription(res.data) + }) + }) + } + + /** + * GET /api/v1/push/subscription + * + * @return PushSubscription. + */ + public async getPushSubscription(): Promise> { + return this.client.get('/api/v1/push/subscription').then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.push_subscription(res.data) + }) + }) + } + + /** + * PUT /api/v1/push/subscription + * + * @param data[alerts][follow] Receive follow notifications? + * @param data[alerts][favourite] Receive favourite notifications? + * @param data[alerts][reblog] Receive reblog notifictaions? + * @param data[alerts][mention] Receive mention notifications? + * @param data[alerts][poll] Receive poll notifications? + * @return PushSubscription. + */ + public async updatePushSubscription( + data?: { alerts: { follow?: boolean; favourite?: boolean; reblog?: boolean; mention?: boolean; poll?: boolean } } | null + ): Promise> { + let params = {} + if (data) { + params = Object.assign(params, { + data + }) + } + return this.client.put('/api/v1/push/subscription', params).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.push_subscription(res.data) + }) + }) + } + + /** + * DELETE /api/v1/push/subscription + */ + public deletePushSubscription(): Promise>> { + return this.client.del>('/api/v1/push/subscription') + } + + // ====================================== + // search + // ====================================== + /** + * GET /api/v2/search + * + * @param q The search query. + * @param options.type Enum of search target. + * @param options.limit Maximum number of results to load, per type. Defaults to 20. Max 40. + * @param options.max_id Return results older than this id. + * @param options.min_id Return results immediately newer than this id. + * @param options.resolve Attempt WebFinger lookup. Defaults to false. + * @param options.following Only include accounts that the user is following. Defaults to false. + * @param options.account_id If provided, statuses returned will be authored only by this account. + * @param options.exclude_unreviewed Filter out unreviewed tags? Defaults to false. + * @return Results. + */ + public async search( + q: string, + options?: { + type?: 'accounts' | 'hashtags' | 'statuses' + limit?: number + max_id?: string + min_id?: string + resolve?: boolean + offset?: number + following?: boolean + account_id?: string + exclude_unreviewed?: boolean + } + ): Promise> { + let params = { + q + } + if (options) { + if (options.type) { + params = Object.assign(params, { + type: options.type + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.resolve !== undefined) { + params = Object.assign(params, { + resolve: options.resolve + }) + } + if (options.offset) { + params = Object.assign(params, { + offset: options.offset + }) + } + if (options.following !== undefined) { + params = Object.assign(params, { + following: options.following + }) + } + if (options.account_id) { + params = Object.assign(params, { + account_id: options.account_id + }) + } + if (options.exclude_unreviewed) { + params = Object.assign(params, { + exclude_unreviewed: options.exclude_unreviewed + }) + } + } + return this.client.get('/api/v2/search', params).then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.results(res.data) + }) + }) + } + + // ====================================== + // instance + // ====================================== + /** + * GET /api/v1/instance + */ + public async getInstance(): Promise> { + return this.client.get('/api/v1/instance').then(res => { + return Object.assign(res, { + data: FriendicaAPI.Converter.instance(res.data) + }) + }) + } + + /** + * GET /api/v1/instance/peers + */ + public getInstancePeers(): Promise>> { + return this.client.get>('/api/v1/instance/peers') + } + + /** + * GET /api/v1/instance/activity + */ + public async getInstanceActivity(): Promise>> { + return this.client.get>('/api/v1/instance/activity').then(res => { + return Object.assign(res, { + data: res.data.map(a => FriendicaAPI.Converter.activity(a)) + }) + }) + } + + // ====================================== + // instance/trends + // ====================================== + /** + * GET /api/v1/trends + * + * @param limit Maximum number of results to return. Defaults to 10. + */ + public async getInstanceTrends(limit?: number | null): Promise>> { + let params = {} + if (limit) { + params = Object.assign(params, { + limit + }) + } + return this.client.get>('/api/v1/trends', params).then(res => { + return Object.assign(res, { + data: res.data.map(t => FriendicaAPI.Converter.tag(t)) + }) + }) + } + + // ====================================== + // instance/directory + // ====================================== + /** + * GET /api/v1/directory + * + * @param options.limit How many accounts to load. Default 40. + * @param options.offset How many accounts to skip before returning results. Default 0. + * @param options.order Order of results. + * @param options.local Only return local accounts. + * @return Array of accounts. + */ + public async getInstanceDirectory(options?: { + limit?: number + offset?: number + order?: 'active' | 'new' + local?: boolean + }): Promise>> { + let params = {} + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.offset) { + params = Object.assign(params, { + offset: options.offset + }) + } + if (options.order) { + params = Object.assign(params, { + order: options.order + }) + } + if (options.local !== undefined) { + params = Object.assign(params, { + local: options.local + }) + } + } + return this.client.get>('/api/v1/directory', params).then(res => { + return Object.assign(res, { + data: res.data.map(a => FriendicaAPI.Converter.account(a)) + }) + }) + } + + // ====================================== + // instance/custom_emojis + // ====================================== + /** + * GET /api/v1/custom_emojis + * + * @return Array of emojis. + */ + public async getInstanceCustomEmojis(): Promise>> { + return this.client.get>('/api/v1/custom_emojis').then(res => { + return Object.assign(res, { + data: res.data.map(e => FriendicaAPI.Converter.emoji(e)) + }) + }) + } + + // ====================================== + // instance/announcements + // ====================================== + /** + * GET /api/v1/announcements + * + * @return Array of announcements. + */ + public async getInstanceAnnouncements(): Promise>> { + return new Promise(resolve => { + resolve({ + data: [], + status: 200, + statusText: '200', + headers: null + }) + }) + } + + /** + * POST /api/v1/announcements/:id/dismiss + * + * @param id The ID of the Announcement in the database. + */ + public async dismissInstanceAnnouncement(_id: string): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + /** + * PUT /api/v1/announcements/:id/reactions/:name + * + * @param id The ID of the Announcement in the database. + * @param name Unicode emoji, or the shortcode of a custom emoji. + */ + public async addReactionToAnnouncement(_id: string, _name: string): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + /** + * DELETE /api/v1/announcements/:id/reactions/:name + * + * @param id The ID of the Announcement in the database. + * @param name Unicode emoji, or the shortcode of a custom emoji. + */ + public async removeReactionFromAnnouncement(_id: string, _name: string): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + // ====================================== + // Emoji reactions + // ====================================== + public async createEmojiReaction(_id: string, _emoji: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + public async deleteEmojiReaction(_id: string, _emoji: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + public async getEmojiReactions(_id: string): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + public async getEmojiReaction(_id: string, _emoji: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('friendica does not support') + reject(err) + }) + } + + // ====================================== + // WebSocket + // ====================================== + public userSocket(): WebSocket { + return this.client.socket('/api/v1/streaming', 'user') + } + + public publicSocket(): WebSocket { + return this.client.socket('/api/v1/streaming', 'public') + } + + public localSocket(): WebSocket { + return this.client.socket('/api/v1/streaming', 'public:local') + } + + public tagSocket(tag: string): WebSocket { + return this.client.socket('/api/v1/streaming', 'hashtag', `tag=${tag}`) + } + + public listSocket(list_id: string): WebSocket { + return this.client.socket('/api/v1/streaming', 'list', `list=${list_id}`) + } + + public directSocket(): WebSocket { + return this.client.socket('/api/v1/streaming', 'direct') + } +} diff --git a/packages/megalodon/src/friendica/api_client.ts b/packages/megalodon/src/friendica/api_client.ts new file mode 100644 index 000000000..1f27fd6d2 --- /dev/null +++ b/packages/megalodon/src/friendica/api_client.ts @@ -0,0 +1,768 @@ +import axios, { AxiosResponse, AxiosRequestConfig } from 'axios' +import objectAssignDeep from 'object-assign-deep' + +import WebSocket from './web_socket' +import Response from '../response' +import { RequestCanceledError } from '../cancel' +import proxyAgent, { ProxyConfig } from '../proxy_config' +import { NO_REDIRECT, DEFAULT_SCOPE, DEFAULT_UA } from '../default' +import FriendicaEntity from './entity' +import MegalodonEntity from '../entity' +import NotificationType, { UnknownNotificationTypeError } from '../notification' +import FriendicaNotificationType from './notification' + +namespace FriendicaAPI { + /** + * Interface + */ + export interface Interface { + get(path: string, params?: any, headers?: { [key: string]: string }, pathIsFullyQualified?: boolean): Promise> + put(path: string, params?: any, headers?: { [key: string]: string }): Promise> + putForm(path: string, params?: any, headers?: { [key: string]: string }): Promise> + patch(path: string, params?: any, headers?: { [key: string]: string }): Promise> + patchForm(path: string, params?: any, headers?: { [key: string]: string }): Promise> + post(path: string, params?: any, headers?: { [key: string]: string }): Promise> + postForm(path: string, params?: any, headers?: { [key: string]: string }): Promise> + del(path: string, params?: any, headers?: { [key: string]: string }): Promise> + cancel(): void + socket(path: string, stream: string, params?: string): WebSocket + } + + /** + * Friendica API client. + * + * Using axios for request, you will handle promises. + */ + export class Client implements Interface { + static DEFAULT_SCOPE = DEFAULT_SCOPE + static DEFAULT_URL = 'https://mastodon.social' + static NO_REDIRECT = NO_REDIRECT + + private accessToken: string | null + private baseUrl: string + private userAgent: string + private abortController: AbortController + private proxyConfig: ProxyConfig | false = false + + /** + * @param baseUrl hostname or base URL + * @param accessToken access token from OAuth2 authorization + * @param userAgent UserAgent is specified in header on request. + * @param proxyConfig Proxy setting, or set false if don't use proxy. + */ + constructor( + baseUrl: string, + accessToken: string | null = null, + userAgent: string = DEFAULT_UA, + proxyConfig: ProxyConfig | false = false + ) { + this.accessToken = accessToken + this.baseUrl = baseUrl + this.userAgent = userAgent + this.proxyConfig = proxyConfig + this.abortController = new AbortController() + axios.defaults.signal = this.abortController.signal + } + + /** + * GET request to mastodon REST API. + * @param path relative path from baseUrl + * @param params Query parameters + * @param headers Request header object + */ + public async get( + path: string, + params = {}, + headers: { [key: string]: string } = {}, + pathIsFullyQualified = false + ): Promise> { + let options: AxiosRequestConfig = { + params: params, + headers: headers, + maxContentLength: Infinity, + maxBodyLength: Infinity + } + if (this.accessToken) { + options = objectAssignDeep({}, options, { + headers: { + Authorization: `Bearer ${this.accessToken}` + } + }) + } + if (this.proxyConfig) { + options = Object.assign(options, { + httpAgent: proxyAgent(this.proxyConfig), + httpsAgent: proxyAgent(this.proxyConfig) + }) + } + return axios + .get((pathIsFullyQualified ? '' : this.baseUrl) + path, options) + .catch((err: Error) => { + if (axios.isCancel(err)) { + throw new RequestCanceledError(err.message) + } else { + throw err + } + }) + .then((resp: AxiosResponse) => { + const res: Response = { + data: resp.data, + status: resp.status, + statusText: resp.statusText, + headers: resp.headers + } + return res + }) + } + + /** + * PUT request to mastodon REST API. + * @param path relative path from baseUrl + * @param params Form data. If you want to post file, please use FormData() + * @param headers Request header object + */ + public async put(path: string, params = {}, headers: { [key: string]: string } = {}): Promise> { + let options: AxiosRequestConfig = { + headers: headers, + maxContentLength: Infinity, + maxBodyLength: Infinity + } + if (this.accessToken) { + options = objectAssignDeep({}, options, { + headers: { + Authorization: `Bearer ${this.accessToken}` + } + }) + } + if (this.proxyConfig) { + options = Object.assign(options, { + httpAgent: proxyAgent(this.proxyConfig), + httpsAgent: proxyAgent(this.proxyConfig) + }) + } + return axios + .put(this.baseUrl + path, params, options) + .catch((err: Error) => { + if (axios.isCancel(err)) { + throw new RequestCanceledError(err.message) + } else { + throw err + } + }) + .then((resp: AxiosResponse) => { + const res: Response = { + data: resp.data, + status: resp.status, + statusText: resp.statusText, + headers: resp.headers + } + return res + }) + } + + /** + * PUT request to mastodon REST API for multipart. + * @param path relative path from baseUrl + * @param params Form data. If you want to post file, please use FormData() + * @param headers Request header object + */ + public async putForm(path: string, params = {}, headers: { [key: string]: string } = {}): Promise> { + let options: AxiosRequestConfig = { + headers: headers, + maxContentLength: Infinity, + maxBodyLength: Infinity + } + if (this.accessToken) { + options = objectAssignDeep({}, options, { + headers: { + Authorization: `Bearer ${this.accessToken}` + } + }) + } + if (this.proxyConfig) { + options = Object.assign(options, { + httpAgent: proxyAgent(this.proxyConfig), + httpsAgent: proxyAgent(this.proxyConfig) + }) + } + return axios + .putForm(this.baseUrl + path, params, options) + .catch((err: Error) => { + if (axios.isCancel(err)) { + throw new RequestCanceledError(err.message) + } else { + throw err + } + }) + .then((resp: AxiosResponse) => { + const res: Response = { + data: resp.data, + status: resp.status, + statusText: resp.statusText, + headers: resp.headers + } + return res + }) + } + + /** + * PATCH request to mastodon REST API. + * @param path relative path from baseUrl + * @param params Form data. If you want to post file, please use FormData() + * @param headers Request header object + */ + public async patch(path: string, params = {}, headers: { [key: string]: string } = {}): Promise> { + let options: AxiosRequestConfig = { + headers: headers, + maxContentLength: Infinity, + maxBodyLength: Infinity + } + if (this.accessToken) { + options = objectAssignDeep({}, options, { + headers: { + Authorization: `Bearer ${this.accessToken}` + } + }) + } + if (this.proxyConfig) { + options = Object.assign(options, { + httpAgent: proxyAgent(this.proxyConfig), + httpsAgent: proxyAgent(this.proxyConfig) + }) + } + return axios + .patch(this.baseUrl + path, params, options) + .catch((err: Error) => { + if (axios.isCancel(err)) { + throw new RequestCanceledError(err.message) + } else { + throw err + } + }) + .then((resp: AxiosResponse) => { + const res: Response = { + data: resp.data, + status: resp.status, + statusText: resp.statusText, + headers: resp.headers + } + return res + }) + } + + /** + * PATCH request to mastodon REST API for multipart. + * @param path relative path from baseUrl + * @param params Form data. If you want to post file, please use FormData() + * @param headers Request header object + */ + public async patchForm(path: string, params = {}, headers: { [key: string]: string } = {}): Promise> { + let options: AxiosRequestConfig = { + headers: headers, + maxContentLength: Infinity, + maxBodyLength: Infinity + } + if (this.accessToken) { + options = objectAssignDeep({}, options, { + headers: { + Authorization: `Bearer ${this.accessToken}` + } + }) + } + if (this.proxyConfig) { + options = Object.assign(options, { + httpAgent: proxyAgent(this.proxyConfig), + httpsAgent: proxyAgent(this.proxyConfig) + }) + } + return axios + .patchForm(this.baseUrl + path, params, options) + .catch((err: Error) => { + if (axios.isCancel(err)) { + throw new RequestCanceledError(err.message) + } else { + throw err + } + }) + .then((resp: AxiosResponse) => { + const res: Response = { + data: resp.data, + status: resp.status, + statusText: resp.statusText, + headers: resp.headers + } + return res + }) + } + + /** + * POST request to mastodon REST API. + * @param path relative path from baseUrl + * @param params Form data + * @param headers Request header object + */ + public async post(path: string, params = {}, headers: { [key: string]: string } = {}): Promise> { + let options: AxiosRequestConfig = { + headers: headers, + maxContentLength: Infinity, + maxBodyLength: Infinity + } + if (this.accessToken) { + options = objectAssignDeep({}, options, { + headers: { + Authorization: `Bearer ${this.accessToken}` + } + }) + } + if (this.proxyConfig) { + options = Object.assign(options, { + httpAgent: proxyAgent(this.proxyConfig), + httpsAgent: proxyAgent(this.proxyConfig) + }) + } + return axios.post(this.baseUrl + path, params, options).then((resp: AxiosResponse) => { + const res: Response = { + data: resp.data, + status: resp.status, + statusText: resp.statusText, + headers: resp.headers + } + return res + }) + } + + /** + * POST request to mastodon REST API for multipart. + * @param path relative path from baseUrl + * @param params Form data + * @param headers Request header object + */ + public async postForm(path: string, params = {}, headers: { [key: string]: string } = {}): Promise> { + let options: AxiosRequestConfig = { + headers: headers, + maxContentLength: Infinity, + maxBodyLength: Infinity + } + if (this.accessToken) { + options = objectAssignDeep({}, options, { + headers: { + Authorization: `Bearer ${this.accessToken}` + } + }) + } + if (this.proxyConfig) { + options = Object.assign(options, { + httpAgent: proxyAgent(this.proxyConfig), + httpsAgent: proxyAgent(this.proxyConfig) + }) + } + return axios.postForm(this.baseUrl + path, params, options).then((resp: AxiosResponse) => { + const res: Response = { + data: resp.data, + status: resp.status, + statusText: resp.statusText, + headers: resp.headers + } + return res + }) + } + + /** + * DELETE request to mastodon REST API. + * @param path relative path from baseUrl + * @param params Form data + * @param headers Request header object + */ + public async del(path: string, params = {}, headers: { [key: string]: string } = {}): Promise> { + let options: AxiosRequestConfig = { + data: params, + headers: headers, + maxContentLength: Infinity, + maxBodyLength: Infinity + } + if (this.accessToken) { + options = objectAssignDeep({}, options, { + headers: { + Authorization: `Bearer ${this.accessToken}` + } + }) + } + if (this.proxyConfig) { + options = Object.assign(options, { + httpAgent: proxyAgent(this.proxyConfig), + httpsAgent: proxyAgent(this.proxyConfig) + }) + } + return axios + .delete(this.baseUrl + path, options) + .catch((err: Error) => { + if (axios.isCancel(err)) { + throw new RequestCanceledError(err.message) + } else { + throw err + } + }) + .then((resp: AxiosResponse) => { + const res: Response = { + data: resp.data, + status: resp.status, + statusText: resp.statusText, + headers: resp.headers + } + return res + }) + } + + /** + * Cancel all requests in this instance. + * @returns void + */ + public cancel(): void { + return this.abortController.abort() + } + + /** + * Get connection and receive websocket connection for Pleroma API. + * + * @param path relative path from baseUrl: normally it is `/streaming`. + * @param stream Stream name, please refer: https://git.pleroma.social/pleroma/pleroma/blob/develop/lib/pleroma/web/mastodon_api/mastodon_socket.ex#L19-28 + * @returns WebSocket, which inherits from EventEmitter + */ + public socket(path: string, stream: string, params?: string): WebSocket { + if (!this.accessToken) { + throw new Error('accessToken is required') + } + const url = this.baseUrl + path + const streaming = new WebSocket(url, stream, params, this.accessToken, this.userAgent, this.proxyConfig) + process.nextTick(() => { + streaming.start() + }) + return streaming + } + } + + export namespace Entity { + export type Account = FriendicaEntity.Account + export type Activity = FriendicaEntity.Activity + export type Application = FriendicaEntity.Application + export type AsyncAttachment = FriendicaEntity.AsyncAttachment + export type Attachment = FriendicaEntity.Attachment + export type Card = FriendicaEntity.Card + export type Context = FriendicaEntity.Context + export type Conversation = FriendicaEntity.Conversation + export type Emoji = FriendicaEntity.Emoji + export type FeaturedTag = FriendicaEntity.FeaturedTag + export type Field = FriendicaEntity.Field + export type Filter = FriendicaEntity.Filter + export type FollowRequest = FriendicaEntity.FollowRequest + export type History = FriendicaEntity.History + export type IdentityProof = FriendicaEntity.IdentityProof + export type Instance = FriendicaEntity.Instance + export type List = FriendicaEntity.List + export type Marker = FriendicaEntity.Marker + export type Mention = FriendicaEntity.Mention + export type Notification = FriendicaEntity.Notification + export type Poll = FriendicaEntity.Poll + export type PollOption = FriendicaEntity.PollOption + export type Preferences = FriendicaEntity.Preferences + export type PushSubscription = FriendicaEntity.PushSubscription + export type Relationship = FriendicaEntity.Relationship + export type Report = FriendicaEntity.Report + export type Results = FriendicaEntity.Results + export type ScheduledStatus = FriendicaEntity.ScheduledStatus + export type Source = FriendicaEntity.Source + export type Stats = FriendicaEntity.Stats + export type Status = FriendicaEntity.Status + export type StatusParams = FriendicaEntity.StatusParams + export type StatusSource = FriendicaEntity.StatusSource + export type Tag = FriendicaEntity.Tag + export type Token = FriendicaEntity.Token + export type URLs = FriendicaEntity.URLs + } + + export namespace Converter { + export const encodeNotificationType = ( + t: MegalodonEntity.NotificationType + ): FriendicaEntity.NotificationType | UnknownNotificationTypeError => { + switch (t) { + case NotificationType.Follow: + return FriendicaNotificationType.Follow + case NotificationType.Favourite: + return FriendicaNotificationType.Favourite + case NotificationType.Reblog: + return FriendicaNotificationType.Reblog + case NotificationType.Mention: + return FriendicaNotificationType.Mention + case NotificationType.FollowRequest: + return FriendicaNotificationType.FollowRequest + case NotificationType.Status: + return FriendicaNotificationType.Status + case NotificationType.PollExpired: + return FriendicaNotificationType.Poll + case NotificationType.Update: + return FriendicaNotificationType.Update + default: + return new UnknownNotificationTypeError() + } + } + + export const decodeNotificationType = ( + t: FriendicaEntity.NotificationType + ): MegalodonEntity.NotificationType | UnknownNotificationTypeError => { + switch (t) { + case FriendicaNotificationType.Follow: + return NotificationType.Follow + case FriendicaNotificationType.Favourite: + return NotificationType.Favourite + case FriendicaNotificationType.Mention: + return NotificationType.Mention + case FriendicaNotificationType.Reblog: + return NotificationType.Reblog + case FriendicaNotificationType.FollowRequest: + return NotificationType.FollowRequest + case FriendicaNotificationType.Status: + return NotificationType.Status + case FriendicaNotificationType.Poll: + return NotificationType.PollExpired + case FriendicaNotificationType.Update: + return NotificationType.Update + default: + return new UnknownNotificationTypeError() + } + } + + export const account = (a: Entity.Account): MegalodonEntity.Account => ({ + id: a.id, + username: a.username, + acct: a.acct, + display_name: a.display_name, + locked: a.locked, + discoverable: a.discoverable, + group: a.group, + noindex: null, + suspended: null, + limited: null, + created_at: a.created_at, + followers_count: a.followers_count, + following_count: a.following_count, + statuses_count: a.statuses_count, + note: a.note, + url: a.url, + avatar: a.avatar, + avatar_static: a.avatar_static, + header: a.header, + header_static: a.header_static, + emojis: a.emojis.map(e => emoji(e)), + moved: a.moved ? account(a.moved) : null, + fields: a.fields.map(f => field(f)), + bot: a.bot, + source: a.source ? source(a.source) : undefined + }) + export const activity = (a: Entity.Activity): MegalodonEntity.Activity => a + export const application = (a: Entity.Application): MegalodonEntity.Application => a + export const attachment = (a: Entity.Attachment): MegalodonEntity.Attachment => a + export const async_attachment = (a: Entity.AsyncAttachment) => { + if (a.url) { + return { + id: a.id, + type: a.type, + url: a.url, + remote_url: a.remote_url, + preview_url: a.preview_url, + text_url: a.text_url, + meta: a.meta, + description: a.description, + blurhash: a.blurhash + } as MegalodonEntity.Attachment + } else { + return a as MegalodonEntity.AsyncAttachment + } + } + export const card = (c: Entity.Card): MegalodonEntity.Card => ({ + url: c.url, + title: c.title, + description: c.description, + type: c.type, + image: c.image, + author_name: c.author_name, + author_url: c.author_url, + provider_name: c.provider_name, + provider_url: c.provider_url, + html: c.html, + width: c.width, + height: c.height, + embed_url: null, + blurhash: c.blurhash + }) + export const context = (c: Entity.Context): MegalodonEntity.Context => ({ + ancestors: Array.isArray(c.ancestors) ? c.ancestors.map(a => status(a)) : [], + descendants: Array.isArray(c.descendants) ? c.descendants.map(d => status(d)) : [] + }) + export const conversation = (c: Entity.Conversation): MegalodonEntity.Conversation => ({ + id: c.id, + accounts: Array.isArray(c.accounts) ? c.accounts.map(a => account(a)) : [], + last_status: c.last_status ? status(c.last_status) : null, + unread: c.unread + }) + export const emoji = (e: Entity.Emoji): MegalodonEntity.Emoji => ({ + shortcode: e.shortcode, + static_url: e.static_url, + url: e.url, + visible_in_picker: e.visible_in_picker + }) + export const featured_tag = (e: Entity.FeaturedTag): MegalodonEntity.FeaturedTag => e + export const field = (f: Entity.Field): MegalodonEntity.Field => f + export const filter = (f: Entity.Filter): MegalodonEntity.Filter => f + export const follow_request = (f: Entity.FollowRequest): MegalodonEntity.FollowRequest => ({ + id: f.id, + username: f.username, + acct: f.acct, + display_name: f.display_name, + locked: f.locked, + bot: f.bot, + discoverable: f.discoverable, + group: f.group, + created_at: f.created_at, + note: f.note, + url: f.url, + avatar: f.avatar, + avatar_static: f.avatar_static, + header: f.header, + header_static: f.header_static, + followers_count: f.followers_count, + following_count: f.following_count, + statuses_count: f.statuses_count, + emojis: f.emojis.map(e => emoji(e)), + fields: f.fields.map(f => field(f)) + }) + export const history = (h: Entity.History): MegalodonEntity.History => h + export const identity_proof = (i: Entity.IdentityProof): MegalodonEntity.IdentityProof => i + export const instance = (i: Entity.Instance): MegalodonEntity.Instance => { + return { + uri: i.uri, + title: i.title, + description: i.description, + email: i.email, + version: i.version, + thumbnail: i.thumbnail, + urls: i.urls ? urls(i.urls) : null, + stats: stats(i.stats), + languages: i.languages, + registrations: i.registrations, + approval_required: i.approval_required, + invites_enabled: i.invites_enabled, + configuration: { + statuses: { + max_characters: i.max_toot_chars + } + }, + contact_account: account(i.contact_account), + rules: i.rules + } + } + export const list = (l: Entity.List): MegalodonEntity.List => l + export const marker = (m: Entity.Marker): MegalodonEntity.Marker => m + export const mention = (m: Entity.Mention): MegalodonEntity.Mention => m + export const notification = (n: Entity.Notification): MegalodonEntity.Notification | UnknownNotificationTypeError => { + const notificationType = decodeNotificationType(n.type) + if (notificationType instanceof UnknownNotificationTypeError) return notificationType + if (n.status) { + return { + account: account(n.account), + created_at: n.created_at, + id: n.id, + status: status(n.status), + type: notificationType + } + } else { + return { + account: account(n.account), + created_at: n.created_at, + id: n.id, + type: notificationType + } + } + } + export const poll = (p: Entity.Poll): MegalodonEntity.Poll => p + export const poll_option = (p: Entity.PollOption): MegalodonEntity.PollOption => p + export const preferences = (p: Entity.Preferences): MegalodonEntity.Preferences => p + export const push_subscription = (p: Entity.PushSubscription): MegalodonEntity.PushSubscription => p + export const relationship = (r: Entity.Relationship): MegalodonEntity.Relationship => r + export const report = (r: Entity.Report): MegalodonEntity.Report => ({ + id: r.id, + action_taken: r.action_taken, + action_taken_at: null, + category: r.category, + comment: r.comment, + forwarded: r.forwarded, + status_ids: r.status_ids, + rule_ids: r.rule_ids, + target_account: account(r.target_account) + }) + export const results = (r: Entity.Results): MegalodonEntity.Results => ({ + accounts: Array.isArray(r.accounts) ? r.accounts.map(a => account(a)) : [], + statuses: Array.isArray(r.statuses) ? r.statuses.map(s => status(s)) : [], + hashtags: Array.isArray(r.hashtags) ? r.hashtags.map(h => tag(h)) : [] + }) + export const scheduled_status = (s: Entity.ScheduledStatus): MegalodonEntity.ScheduledStatus => { + return { + id: s.id, + scheduled_at: s.scheduled_at, + params: status_params(s.params), + media_attachments: s.media_attachments ? s.media_attachments.map(a => attachment(a)) : null + } + } + export const source = (s: Entity.Source): MegalodonEntity.Source => s + export const stats = (s: Entity.Stats): MegalodonEntity.Stats => s + export const status = (s: Entity.Status): MegalodonEntity.Status => ({ + id: s.id, + uri: s.uri, + url: s.url, + account: account(s.account), + in_reply_to_id: s.in_reply_to_id, + in_reply_to_account_id: s.in_reply_to_account_id, + reblog: s.reblog ? status(s.reblog) : s.quote ? status(s.quote) : null, + content: s.content, + plain_content: null, + created_at: s.created_at, + emojis: Array.isArray(s.emojis) ? s.emojis.map(e => emoji(e)) : [], + replies_count: s.replies_count, + reblogs_count: s.reblogs_count, + favourites_count: s.favourites_count, + reblogged: s.reblogged, + favourited: s.favourited, + muted: s.muted, + sensitive: s.sensitive, + spoiler_text: s.spoiler_text, + visibility: s.visibility, + media_attachments: Array.isArray(s.media_attachments) ? s.media_attachments.map(m => attachment(m)) : [], + mentions: Array.isArray(s.mentions) ? s.mentions.map(m => mention(m)) : [], + tags: s.tags, + card: s.card ? card(s.card) : null, + poll: s.poll ? poll(s.poll) : null, + application: s.application ? application(s.application) : null, + language: s.language, + pinned: s.pinned, + emoji_reactions: [], + bookmarked: s.bookmarked ? s.bookmarked : false, + quote: false + }) + export const status_params = (s: Entity.StatusParams): MegalodonEntity.StatusParams => { + return { + text: s.text, + in_reply_to_id: s.in_reply_to_id, + media_ids: s.media_ids, + sensitive: s.sensitive, + spoiler_text: s.spoiler_text, + visibility: s.visibility, + scheduled_at: s.scheduled_at, + application_id: parseInt(s.application_id) + } + } + export const status_source = (s: Entity.StatusSource): MegalodonEntity.StatusSource => s + export const tag = (t: Entity.Tag): MegalodonEntity.Tag => t + export const token = (t: Entity.Token): MegalodonEntity.Token => t + export const urls = (u: Entity.URLs): MegalodonEntity.URLs => u + } +} +export default FriendicaAPI diff --git a/packages/megalodon/src/friendica/entities/account.ts b/packages/megalodon/src/friendica/entities/account.ts new file mode 100644 index 000000000..670a58371 --- /dev/null +++ b/packages/megalodon/src/friendica/entities/account.ts @@ -0,0 +1,29 @@ +/// +/// +/// +namespace FriendicaEntity { + export type Account = { + id: string + username: string + acct: string + display_name: string + locked: boolean + discoverable?: boolean + group: boolean | null + created_at: string + followers_count: number + following_count: number + statuses_count: number + note: string + url: string + avatar: string + avatar_static: string + header: string + header_static: string + emojis: Array + moved: Account | null + fields: Array + bot: boolean + source?: Source + } +} diff --git a/packages/megalodon/src/friendica/entities/activity.ts b/packages/megalodon/src/friendica/entities/activity.ts new file mode 100644 index 000000000..4db360d23 --- /dev/null +++ b/packages/megalodon/src/friendica/entities/activity.ts @@ -0,0 +1,8 @@ +namespace FriendicaEntity { + export type Activity = { + week: string + statuses: string + logins: string + registrations: string + } +} diff --git a/packages/megalodon/src/friendica/entities/application.ts b/packages/megalodon/src/friendica/entities/application.ts new file mode 100644 index 000000000..5e54ce82d --- /dev/null +++ b/packages/megalodon/src/friendica/entities/application.ts @@ -0,0 +1,7 @@ +namespace FriendicaEntity { + export type Application = { + name: string + website?: string | null + vapid_key?: string | null + } +} diff --git a/packages/megalodon/src/friendica/entities/async_attachment.ts b/packages/megalodon/src/friendica/entities/async_attachment.ts new file mode 100644 index 000000000..76934af66 --- /dev/null +++ b/packages/megalodon/src/friendica/entities/async_attachment.ts @@ -0,0 +1,14 @@ +/// +namespace FriendicaEntity { + export type AsyncAttachment = { + id: string + type: 'unknown' | 'image' | 'gifv' | 'video' | 'audio' + url: string | null + remote_url: string | null + preview_url: string + text_url: string | null + meta: Meta | null + description: string | null + blurhash: string | null + } +} diff --git a/packages/megalodon/src/friendica/entities/attachment.ts b/packages/megalodon/src/friendica/entities/attachment.ts new file mode 100644 index 000000000..04be0e72d --- /dev/null +++ b/packages/megalodon/src/friendica/entities/attachment.ts @@ -0,0 +1,49 @@ +namespace FriendicaEntity { + export type Sub = { + // For Image, Gifv, and Video + width?: number + height?: number + size?: string + aspect?: number + + // For Gifv and Video + frame_rate?: string + + // For Audio, Gifv, and Video + duration?: number + bitrate?: number + } + + export type Focus = { + x: number + y: number + } + + export type Meta = { + original?: Sub + small?: Sub + focus?: Focus + length?: string + duration?: number + fps?: number + size?: string + width?: number + height?: number + aspect?: number + audio_encode?: string + audio_bitrate?: string + audio_channel?: string + } + + export type Attachment = { + id: string + type: 'unknown' | 'image' | 'gifv' | 'video' | 'audio' + url: string + remote_url: string | null + preview_url: string | null + text_url: string | null + meta: Meta | null + description: string | null + blurhash: string | null + } +} diff --git a/packages/megalodon/src/friendica/entities/card.ts b/packages/megalodon/src/friendica/entities/card.ts new file mode 100644 index 000000000..c23471983 --- /dev/null +++ b/packages/megalodon/src/friendica/entities/card.ts @@ -0,0 +1,17 @@ +namespace FriendicaEntity { + export type Card = { + url: string + title: string + description: string + type: 'link' | 'photo' | 'video' | 'rich' + image: string | null + author_name: string + author_url: string + provider_name: string + provider_url: string + html: string + width: number + height: number + blurhash: string | null + } +} diff --git a/packages/megalodon/src/friendica/entities/context.ts b/packages/megalodon/src/friendica/entities/context.ts new file mode 100644 index 000000000..9c977544a --- /dev/null +++ b/packages/megalodon/src/friendica/entities/context.ts @@ -0,0 +1,8 @@ +/// + +namespace FriendicaEntity { + export type Context = { + ancestors: Array + descendants: Array + } +} diff --git a/packages/megalodon/src/friendica/entities/conversation.ts b/packages/megalodon/src/friendica/entities/conversation.ts new file mode 100644 index 000000000..550ae7081 --- /dev/null +++ b/packages/megalodon/src/friendica/entities/conversation.ts @@ -0,0 +1,11 @@ +/// +/// + +namespace FriendicaEntity { + export type Conversation = { + id: string + accounts: Array + last_status: Status | null + unread: boolean + } +} diff --git a/packages/megalodon/src/friendica/entities/emoji.ts b/packages/megalodon/src/friendica/entities/emoji.ts new file mode 100644 index 000000000..a0d92e6bc --- /dev/null +++ b/packages/megalodon/src/friendica/entities/emoji.ts @@ -0,0 +1,8 @@ +namespace FriendicaEntity { + export type Emoji = { + shortcode: string + static_url: string + url: string + visible_in_picker: boolean + } +} diff --git a/packages/megalodon/src/friendica/entities/featured_tag.ts b/packages/megalodon/src/friendica/entities/featured_tag.ts new file mode 100644 index 000000000..14dd1a826 --- /dev/null +++ b/packages/megalodon/src/friendica/entities/featured_tag.ts @@ -0,0 +1,8 @@ +namespace FriendicaEntity { + export type FeaturedTag = { + id: string + name: string + statuses_count: number + last_status_at: string + } +} diff --git a/packages/megalodon/src/friendica/entities/field.ts b/packages/megalodon/src/friendica/entities/field.ts new file mode 100644 index 000000000..299ca0a45 --- /dev/null +++ b/packages/megalodon/src/friendica/entities/field.ts @@ -0,0 +1,7 @@ +namespace FriendicaEntity { + export type Field = { + name: string + value: string + verified_at: string | null + } +} diff --git a/packages/megalodon/src/friendica/entities/filter.ts b/packages/megalodon/src/friendica/entities/filter.ts new file mode 100644 index 000000000..a71a936ab --- /dev/null +++ b/packages/megalodon/src/friendica/entities/filter.ts @@ -0,0 +1,12 @@ +namespace FriendicaEntity { + export type Filter = { + id: string + phrase: string + context: Array + expires_at: string | null + irreversible: boolean + whole_word: boolean + } + + export type FilterContext = string +} diff --git a/packages/megalodon/src/friendica/entities/follow_request.ts b/packages/megalodon/src/friendica/entities/follow_request.ts new file mode 100644 index 000000000..83f5bf9ba --- /dev/null +++ b/packages/megalodon/src/friendica/entities/follow_request.ts @@ -0,0 +1,27 @@ +/// +/// + +namespace FriendicaEntity { + export type FollowRequest = { + id: number + username: string + acct: string + display_name: string + locked: boolean + bot: boolean + discoverable?: boolean + group: boolean + created_at: string + note: string + url: string + avatar: string + avatar_static: string + header: string + header_static: string + followers_count: number + following_count: number + statuses_count: number + emojis: Array + fields: Array + } +} diff --git a/packages/megalodon/src/friendica/entities/history.ts b/packages/megalodon/src/friendica/entities/history.ts new file mode 100644 index 000000000..8f9cd6bd6 --- /dev/null +++ b/packages/megalodon/src/friendica/entities/history.ts @@ -0,0 +1,7 @@ +namespace FriendicaEntity { + export type History = { + day: string + uses: number + accounts: number + } +} diff --git a/packages/megalodon/src/friendica/entities/identity_proof.ts b/packages/megalodon/src/friendica/entities/identity_proof.ts new file mode 100644 index 000000000..fb6166c65 --- /dev/null +++ b/packages/megalodon/src/friendica/entities/identity_proof.ts @@ -0,0 +1,9 @@ +namespace FriendicaEntity { + export type IdentityProof = { + provider: string + provider_username: string + updated_at: string + proof_url: string + profile_url: string + } +} diff --git a/packages/megalodon/src/friendica/entities/instance.ts b/packages/megalodon/src/friendica/entities/instance.ts new file mode 100644 index 000000000..a86390eb0 --- /dev/null +++ b/packages/megalodon/src/friendica/entities/instance.ts @@ -0,0 +1,28 @@ +/// +/// +/// + +namespace FriendicaEntity { + export type Instance = { + uri: string + title: string + description: string + email: string + version: string + thumbnail: string | null + urls: URLs | null + stats: Stats + languages: Array + registrations: boolean + approval_required: boolean + invites_enabled: boolean + max_toot_chars: number + contact_account: Account + rules: Array + } + + export type InstanceRule = { + id: string + text: string + } +} diff --git a/packages/megalodon/src/friendica/entities/list.ts b/packages/megalodon/src/friendica/entities/list.ts new file mode 100644 index 000000000..90487aec2 --- /dev/null +++ b/packages/megalodon/src/friendica/entities/list.ts @@ -0,0 +1,9 @@ +namespace FriendicaEntity { + export type List = { + id: string + title: string + replies_policy: RepliesPolicy + } + + export type RepliesPolicy = 'followed' | 'list' | 'none' +} diff --git a/packages/megalodon/src/friendica/entities/marker.ts b/packages/megalodon/src/friendica/entities/marker.ts new file mode 100644 index 000000000..4ec41a07d --- /dev/null +++ b/packages/megalodon/src/friendica/entities/marker.ts @@ -0,0 +1,14 @@ +namespace FriendicaEntity { + export type Marker = { + home: { + last_read_id: string + version: number + updated_at: string + } + notifications: { + last_read_id: string + version: number + updated_at: string + } + } +} diff --git a/packages/megalodon/src/friendica/entities/mention.ts b/packages/megalodon/src/friendica/entities/mention.ts new file mode 100644 index 000000000..0e93333fe --- /dev/null +++ b/packages/megalodon/src/friendica/entities/mention.ts @@ -0,0 +1,8 @@ +namespace FriendicaEntity { + export type Mention = { + id: string + username: string + url: string + acct: string + } +} diff --git a/packages/megalodon/src/friendica/entities/notification.ts b/packages/megalodon/src/friendica/entities/notification.ts new file mode 100644 index 000000000..acdbfb927 --- /dev/null +++ b/packages/megalodon/src/friendica/entities/notification.ts @@ -0,0 +1,14 @@ +/// +/// + +namespace FriendicaEntity { + export type Notification = { + account: Account + created_at: string + id: string + status?: Status + type: NotificationType + } + + export type NotificationType = string +} diff --git a/packages/megalodon/src/friendica/entities/poll.ts b/packages/megalodon/src/friendica/entities/poll.ts new file mode 100644 index 000000000..4ac2262c5 --- /dev/null +++ b/packages/megalodon/src/friendica/entities/poll.ts @@ -0,0 +1,13 @@ +/// + +namespace FriendicaEntity { + export type Poll = { + id: string + expires_at: string | null + expired: boolean + multiple: boolean + votes_count: number + options: Array + voted: boolean + } +} diff --git a/packages/megalodon/src/friendica/entities/poll_option.ts b/packages/megalodon/src/friendica/entities/poll_option.ts new file mode 100644 index 000000000..f9628ddd8 --- /dev/null +++ b/packages/megalodon/src/friendica/entities/poll_option.ts @@ -0,0 +1,6 @@ +namespace FriendicaEntity { + export type PollOption = { + title: string + votes_count: number | null + } +} diff --git a/packages/megalodon/src/friendica/entities/preferences.ts b/packages/megalodon/src/friendica/entities/preferences.ts new file mode 100644 index 000000000..dec8b511b --- /dev/null +++ b/packages/megalodon/src/friendica/entities/preferences.ts @@ -0,0 +1,9 @@ +namespace FriendicaEntity { + export type Preferences = { + 'posting:default:visibility': 'public' | 'unlisted' | 'private' | 'direct' + 'posting:default:sensitive': boolean + 'posting:default:language': string | null + 'reading:expand:media': 'default' | 'show_all' | 'hide_all' + 'reading:expand:spoilers': boolean + } +} diff --git a/packages/megalodon/src/friendica/entities/push_subscription.ts b/packages/megalodon/src/friendica/entities/push_subscription.ts new file mode 100644 index 000000000..857a98f27 --- /dev/null +++ b/packages/megalodon/src/friendica/entities/push_subscription.ts @@ -0,0 +1,16 @@ +namespace FriendicaEntity { + export type Alerts = { + follow: boolean + favourite: boolean + mention: boolean + reblog: boolean + poll: boolean + } + + export type PushSubscription = { + id: string + endpoint: string + server_key: string + alerts: Alerts + } +} diff --git a/packages/megalodon/src/friendica/entities/relationship.ts b/packages/megalodon/src/friendica/entities/relationship.ts new file mode 100644 index 000000000..bba3099a8 --- /dev/null +++ b/packages/megalodon/src/friendica/entities/relationship.ts @@ -0,0 +1,17 @@ +namespace FriendicaEntity { + export type Relationship = { + id: string + following: boolean + followed_by: boolean + blocking: boolean + blocked_by: boolean + muting: boolean + muting_notifications: boolean + requested: boolean + domain_blocking: boolean + showing_reblogs: boolean + endorsed: boolean + notifying: boolean + note: string | null + } +} diff --git a/packages/megalodon/src/friendica/entities/report.ts b/packages/megalodon/src/friendica/entities/report.ts new file mode 100644 index 000000000..f20d6d2db --- /dev/null +++ b/packages/megalodon/src/friendica/entities/report.ts @@ -0,0 +1,16 @@ +/// + +namespace FriendicaEntity { + export type Report = { + id: string + action_taken: boolean + category: Category + comment: string + forwarded: boolean + status_ids: Array | null + rule_ids: Array | null + target_account: Account + } + + export type Category = 'spam' | 'violation' | 'other' +} diff --git a/packages/megalodon/src/friendica/entities/results.ts b/packages/megalodon/src/friendica/entities/results.ts new file mode 100644 index 000000000..7af235657 --- /dev/null +++ b/packages/megalodon/src/friendica/entities/results.ts @@ -0,0 +1,11 @@ +/// +/// +/// + +namespace FriendicaEntity { + export type Results = { + accounts: Array + statuses: Array + hashtags: Array + } +} diff --git a/packages/megalodon/src/friendica/entities/scheduled_status.ts b/packages/megalodon/src/friendica/entities/scheduled_status.ts new file mode 100644 index 000000000..da292f700 --- /dev/null +++ b/packages/megalodon/src/friendica/entities/scheduled_status.ts @@ -0,0 +1,10 @@ +/// +/// +namespace FriendicaEntity { + export type ScheduledStatus = { + id: string + scheduled_at: string + params: StatusParams + media_attachments: Array + } +} diff --git a/packages/megalodon/src/friendica/entities/source.ts b/packages/megalodon/src/friendica/entities/source.ts new file mode 100644 index 000000000..4033e911e --- /dev/null +++ b/packages/megalodon/src/friendica/entities/source.ts @@ -0,0 +1,10 @@ +/// +namespace FriendicaEntity { + export type Source = { + privacy: string | null + sensitive: boolean | null + language: string | null + note: string + fields: Array + } +} diff --git a/packages/megalodon/src/friendica/entities/stats.ts b/packages/megalodon/src/friendica/entities/stats.ts new file mode 100644 index 000000000..8ef290b7b --- /dev/null +++ b/packages/megalodon/src/friendica/entities/stats.ts @@ -0,0 +1,7 @@ +namespace FriendicaEntity { + export type Stats = { + user_count: number + status_count: number + domain_count: number + } +} diff --git a/packages/megalodon/src/friendica/entities/status.ts b/packages/megalodon/src/friendica/entities/status.ts new file mode 100644 index 000000000..9d2e8b966 --- /dev/null +++ b/packages/megalodon/src/friendica/entities/status.ts @@ -0,0 +1,48 @@ +/// +/// +/// +/// +/// +/// +/// + +namespace FriendicaEntity { + export type Status = { + id: string + uri: string + url: string + account: Account + in_reply_to_id: string | null + in_reply_to_account_id: string | null + reblog: Status | null + content: string + created_at: string + emojis: Emoji[] + replies_count: number + reblogs_count: number + favourites_count: number + reblogged: boolean | null + favourited: boolean | null + muted: boolean | null + sensitive: boolean + spoiler_text: string + visibility: 'public' | 'unlisted' | 'private' | 'direct' + media_attachments: Array + mentions: Array + tags: Array + card: Card | null + poll: Poll | null + application: Application | null + language: string | null + pinned: boolean | null + bookmarked?: boolean + // These parameters are unique parameters in fedibird.com for quote. + quote_id?: string + quote?: Status | null + } + + export type StatusTag = { + name: string + url: string + } +} diff --git a/packages/megalodon/src/friendica/entities/status_params.ts b/packages/megalodon/src/friendica/entities/status_params.ts new file mode 100644 index 000000000..6a14af837 --- /dev/null +++ b/packages/megalodon/src/friendica/entities/status_params.ts @@ -0,0 +1,12 @@ +namespace FriendicaEntity { + export type StatusParams = { + text: string + in_reply_to_id: string | null + media_ids: Array | null + sensitive: boolean | null + spoiler_text: string | null + visibility: 'public' | 'unlisted' | 'private' | null + scheduled_at: string | null + application_id: string + } +} diff --git a/packages/megalodon/src/friendica/entities/status_source.ts b/packages/megalodon/src/friendica/entities/status_source.ts new file mode 100644 index 000000000..2b5ee9bd0 --- /dev/null +++ b/packages/megalodon/src/friendica/entities/status_source.ts @@ -0,0 +1,7 @@ +namespace FriendicaEntity { + export type StatusSource = { + id: string + text: string + spoiler_text: string + } +} diff --git a/packages/megalodon/src/friendica/entities/tag.ts b/packages/megalodon/src/friendica/entities/tag.ts new file mode 100644 index 000000000..f7998d22f --- /dev/null +++ b/packages/megalodon/src/friendica/entities/tag.ts @@ -0,0 +1,10 @@ +/// + +namespace FriendicaEntity { + export type Tag = { + name: string + url: string + history: Array + following?: boolean + } +} diff --git a/packages/megalodon/src/friendica/entities/token.ts b/packages/megalodon/src/friendica/entities/token.ts new file mode 100644 index 000000000..904d68651 --- /dev/null +++ b/packages/megalodon/src/friendica/entities/token.ts @@ -0,0 +1,8 @@ +namespace FriendicaEntity { + export type Token = { + access_token: string + token_type: string + scope: string + created_at: number + } +} diff --git a/packages/megalodon/src/friendica/entities/urls.ts b/packages/megalodon/src/friendica/entities/urls.ts new file mode 100644 index 000000000..8c736b9ef --- /dev/null +++ b/packages/megalodon/src/friendica/entities/urls.ts @@ -0,0 +1,5 @@ +namespace FriendicaEntity { + export type URLs = { + streaming_api: string + } +} diff --git a/packages/megalodon/src/friendica/entity.ts b/packages/megalodon/src/friendica/entity.ts new file mode 100644 index 000000000..6d64f061c --- /dev/null +++ b/packages/megalodon/src/friendica/entity.ts @@ -0,0 +1,38 @@ +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// + +export default FriendicaEntity diff --git a/packages/megalodon/src/friendica/notification.ts b/packages/megalodon/src/friendica/notification.ts new file mode 100644 index 000000000..78701c46b --- /dev/null +++ b/packages/megalodon/src/friendica/notification.ts @@ -0,0 +1,14 @@ +import FriendicaEntity from './entity' + +namespace FriendicaNotificationType { + export const Mention: FriendicaEntity.NotificationType = 'mention' + export const Reblog: FriendicaEntity.NotificationType = 'reblog' + export const Favourite: FriendicaEntity.NotificationType = 'favourite' + export const Follow: FriendicaEntity.NotificationType = 'follow' + export const Poll: FriendicaEntity.NotificationType = 'poll' + export const FollowRequest: FriendicaEntity.NotificationType = 'follow_request' + export const Status: FriendicaEntity.NotificationType = 'status' + export const Update: FriendicaEntity.NotificationType = 'update' +} + +export default FriendicaNotificationType diff --git a/packages/megalodon/src/friendica/web_socket.ts b/packages/megalodon/src/friendica/web_socket.ts new file mode 100644 index 000000000..ca16f24a5 --- /dev/null +++ b/packages/megalodon/src/friendica/web_socket.ts @@ -0,0 +1,18 @@ +import { WebSocketInterface } from '../megalodon' +import { EventEmitter } from 'events' +import { ProxyConfig } from '../proxy_config' + +export default class WebSocket extends EventEmitter implements WebSocketInterface { + constructor( + _url: string, + _stream: string, + _params: string | undefined, + _accessToken: string, + _userAgent: string, + _proxyConfig: ProxyConfig | false = false + ) { + super() + } + public start() {} + public stop() {} +} diff --git a/packages/megalodon/src/index.ts b/packages/megalodon/src/index.ts index 758d3a46a..0d2b70c29 100644 --- a/packages/megalodon/src/index.ts +++ b/packages/megalodon/src/index.ts @@ -1,32 +1,33 @@ -import Response from "./response"; -import OAuth from "./oauth"; -import { isCancel, RequestCanceledError } from "./cancel"; -import { ProxyConfig } from "./proxy_config"; -import generator, { - detector, - MegalodonInterface, - WebSocketInterface, -} from "./megalodon"; -import Misskey from "./misskey"; -import Entity from "./entity"; -import NotificationType from "./notification"; -import FilterContext from "./filter_context"; -import Converter from "./converter"; +import Response from './response' +import OAuth from './oauth' +import { isCancel, RequestCanceledError } from './cancel' +import { ProxyConfig } from './proxy_config' +import generator, { MegalodonInterface, WebSocketInterface } from './megalodon' +import { detector } from './detector' +import Mastodon from './mastodon' +import Pleroma from './pleroma' +import Misskey from './misskey' +import Entity from './entity' +import NotificationType from './notification' +import FilterContext from './filter_context' +import Converter from './converter' export { - Response, - OAuth, - RequestCanceledError, - isCancel, - ProxyConfig, - detector, - MegalodonInterface, - WebSocketInterface, - NotificationType, - FilterContext, - Misskey, - Entity, - Converter, -}; + Response, + OAuth, + RequestCanceledError, + isCancel, + ProxyConfig, + detector, + MegalodonInterface, + WebSocketInterface, + NotificationType, + FilterContext, + Mastodon, + Pleroma, + Misskey, + Entity, + Converter +} -export default generator; +export default generator diff --git a/packages/megalodon/src/mastodon.ts b/packages/megalodon/src/mastodon.ts new file mode 100644 index 000000000..4a8b1fc1e --- /dev/null +++ b/packages/megalodon/src/mastodon.ts @@ -0,0 +1,3169 @@ +import { OAuth2 } from 'oauth' +import FormData from 'form-data' +import parseLinkHeader from 'parse-link-header' + +import MastodonAPI from './mastodon/api_client' +import WebSocket from './mastodon/web_socket' +import { MegalodonInterface, NoImplementedError } from './megalodon' +import Response from './response' +import Entity from './entity' +import { NO_REDIRECT, DEFAULT_SCOPE, DEFAULT_UA } from './default' +import { ProxyConfig } from './proxy_config' +import OAuth from './oauth' +import { UnknownNotificationTypeError } from './notification' + +export default class Mastodon implements MegalodonInterface { + public client: MastodonAPI.Interface + public baseUrl: string + + /** + * @param baseUrl hostname or base URL + * @param accessToken access token from OAuth2 authorization + * @param userAgent UserAgent is specified in header on request. + * @param proxyConfig Proxy setting, or set false if don't use proxy. + */ + constructor( + baseUrl: string, + accessToken: string | null = null, + userAgent: string | null = DEFAULT_UA, + proxyConfig: ProxyConfig | false = false + ) { + let token: string = '' + if (accessToken) { + token = accessToken + } + let agent: string = DEFAULT_UA + if (userAgent) { + agent = userAgent + } + this.client = new MastodonAPI.Client(baseUrl, token, agent, proxyConfig) + this.baseUrl = baseUrl + } + + public cancel(): void { + return this.client.cancel() + } + + /** + * Call /api/v1/apps + * + * Create an application. + * @param client_name your application's name + * @param options Form Data + */ + public async registerApp( + client_name: string, + options: Partial<{ scopes: Array; redirect_uris: string; website: string }> + ): Promise { + const scopes = options.scopes || DEFAULT_SCOPE + return this.createApp(client_name, options).then(async appData => { + return this.generateAuthUrl(appData.client_id, appData.client_secret, { + scope: scopes, + redirect_uri: appData.redirect_uri + }).then(url => { + appData.url = url + return appData + }) + }) + } + + /** + * Call /api/v1/apps + * + * Create an application. + * @param client_name your application's name + * @param options Form Data + */ + public async createApp( + client_name: string, + options: Partial<{ scopes: Array; redirect_uris: string; website: string }> + ): Promise { + const scopes = options.scopes || DEFAULT_SCOPE + const redirect_uris = options.redirect_uris || NO_REDIRECT + + const params: { + client_name: string + redirect_uris: string + scopes: string + website?: string + } = { + client_name: client_name, + redirect_uris: redirect_uris, + scopes: scopes.join(' ') + } + if (options.website) params.website = options.website + + return this.client + .post('/api/v1/apps', params) + .then((res: Response) => OAuth.AppData.from(res.data)) + } + + /** + * Generate authorization url using OAuth2. + * + * @param clientId your OAuth app's client ID + * @param clientSecret your OAuth app's client Secret + * @param options as property, redirect_uri and scope are available, and must be the same as when you register your app + */ + public generateAuthUrl( + clientId: string, + clientSecret: string, + options: Partial<{ scope: Array; redirect_uri: string }> + ): Promise { + const scope = options.scope || DEFAULT_SCOPE + const redirect_uri = options.redirect_uri || NO_REDIRECT + return new Promise(resolve => { + const oauth = new OAuth2(clientId, clientSecret, this.baseUrl, undefined, '/oauth/token') + const url = oauth.getAuthorizeUrl({ + redirect_uri: redirect_uri, + response_type: 'code', + client_id: clientId, + scope: scope.join(' ') + }) + resolve(url) + }) + } + + // ====================================== + // apps + // ====================================== + /** + * GET /api/v1/apps/verify_credentials + * + * @return An Application + */ + public verifyAppCredentials(): Promise> { + return this.client.get('/api/v1/apps/verify_credentials') + } + + // ====================================== + // apps/oauth + // ====================================== + /** + * POST /oauth/token + * + * Fetch OAuth access token. + * Get an access token based client_id and client_secret and authorization code. + * @param client_id will be generated by #createApp or #registerApp + * @param client_secret will be generated by #createApp or #registerApp + * @param code will be generated by the link of #generateAuthUrl or #registerApp + * @param redirect_uri must be the same uri as the time when you register your OAuth application + */ + public async fetchAccessToken( + client_id: string | null, + client_secret: string, + code: string, + redirect_uri: string = NO_REDIRECT + ): Promise { + if (!client_id) { + throw new Error('client_id is required') + } + return this.client + .post('/oauth/token', { + client_id, + client_secret, + code, + redirect_uri, + grant_type: 'authorization_code' + }) + .then((res: Response) => OAuth.TokenData.from(res.data)) + } + + /** + * POST /oauth/revoke + * + * Revoke an OAuth token. + * @param client_id will be generated by #createApp or #registerApp + * @param client_secret will be generated by #createApp or #registerApp + * @param token will be get #fetchAccessToken + */ + public async refreshToken(client_id: string, client_secret: string, refresh_token: string): Promise { + return this.client + .post('/oauth/token', { + client_id, + client_secret, + refresh_token, + grant_type: 'refresh_token' + }) + .then((res: Response) => OAuth.TokenData.from(res.data)) + } + + /** + * POST /oauth/revoke + * + * Revoke an OAuth token. + * @param client_id will be generated by #createApp or #registerApp + * @param client_secret will be generated by #createApp or #registerApp + * @param token will be get #fetchAccessToken + */ + public async revokeToken(client_id: string, client_secret: string, token: string): Promise> { + return this.client.post<{}>('/oauth/revoke', { + client_id, + client_secret, + token + }) + } + + // ====================================== + // accounts + // ====================================== + /** + * POST /api/v1/accounts + * + * @param username Username for the account. + * @param email Email for the account. + * @param password Password for the account. + * @param agreement Whether the user agrees to the local rules, terms, and policies. + * @param locale The language of the confirmation email that will be sent + * @param reason Text that will be reviewed by moderators if registrations require manual approval. + * @return An account token. + */ + public async registerAccount( + username: string, + email: string, + password: string, + agreement: boolean, + locale: string, + reason?: string | null + ): Promise> { + let params = { + username: username, + email: email, + password: password, + agreement: agreement, + locale: locale + } + if (reason) { + params = Object.assign(params, { + reason: reason + }) + } + return this.client.post('/api/v1/accounts', params).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.token(res.data) + }) + }) + } + + /** + * GET /api/v1/accounts/verify_credentials + * + * @return Account. + */ + public async verifyAccountCredentials(): Promise> { + return this.client.get('/api/v1/accounts/verify_credentials').then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.account(res.data) + }) + }) + } + + /** + * PATCH /api/v1/accounts/update_credentials + * + * @return An account. + */ + public async updateCredentials(options?: { + discoverable?: boolean + bot?: boolean + display_name?: string + note?: string + avatar?: string + header?: string + locked?: boolean + source?: { + privacy?: string + sensitive?: boolean + language?: string + } + fields_attributes?: Array<{ name: string; value: string }> + }): Promise> { + let params = {} + if (options) { + if (options.discoverable !== undefined) { + params = Object.assign(params, { + discoverable: options.discoverable + }) + } + if (options.bot !== undefined) { + params = Object.assign(params, { + bot: options.bot + }) + } + if (options.display_name) { + params = Object.assign(params, { + display_name: options.display_name + }) + } + if (options.note) { + params = Object.assign(params, { + note: options.note + }) + } + if (options.avatar) { + params = Object.assign(params, { + avatar: options.avatar + }) + } + if (options.header) { + params = Object.assign(params, { + header: options.header + }) + } + if (options.locked !== undefined) { + params = Object.assign(params, { + locked: options.locked + }) + } + if (options.source) { + params = Object.assign(params, { + source: options.source + }) + } + if (options.fields_attributes) { + params = Object.assign(params, { + fields_attributes: options.fields_attributes + }) + } + } + return this.client.patch('/api/v1/accounts/update_credentials', params).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.account(res.data) + }) + }) + } + + /** + * GET /api/v1/accounts/:id + * + * @param id The account ID. + * @return An account. + */ + public async getAccount(id: string): Promise> { + return this.client.get(`/api/v1/accounts/${id}`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.account(res.data) + }) + }) + } + + /** + * GET /api/v1/accounts/:id/statuses + * + * @param id The account ID. + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID but starting with most recent. + * @param options.min_id Return results newer than ID. + * @param options.pinned Return statuses which include pinned statuses. + * @param options.exclude_replies Return statuses which exclude replies. + * @param options.exclude_reblogs Return statuses which exclude reblogs. + * @param options.only_media Show only statuses with media attached? Defaults to false. + * @return Account's statuses. + */ + public async getAccountStatuses( + id: string, + options?: { + limit?: number + max_id?: string + since_id?: string + min_id?: string + pinned?: boolean + exclude_replies?: boolean + exclude_reblogs?: boolean + only_media: boolean + } + ): Promise>> { + let params = {} + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.pinned) { + params = Object.assign(params, { + pinned: options.pinned + }) + } + if (options.exclude_replies) { + params = Object.assign(params, { + exclude_replies: options.exclude_replies + }) + } + if (options.exclude_reblogs) { + params = Object.assign(params, { + exclude_reblogs: options.exclude_reblogs + }) + } + if (options.only_media) { + params = Object.assign(params, { + only_media: options.only_media + }) + } + } + return this.client.get>(`/api/v1/accounts/${id}/statuses`, params).then(res => { + return Object.assign(res, { + data: res.data.map(s => MastodonAPI.Converter.status(s)) + }) + }) + } + + public getAccountFavourites( + _id: string, + _options?: { + limit?: number + max_id?: string + since_id?: string + } + ): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('mastodon does not support') + reject(err) + }) + } + + /** + * POST /api/v1/accounts/:id/follow + * + * @param id Target account ID. + * @return Relationship. + */ + public async subscribeAccount(id: string): Promise> { + const params = { + notify: true + } + return this.client.post(`/api/v1/accounts/${id}/follow`, params).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * POST /api/v1/accounts/:id/follow + * + * @param id Target account ID. + * @return Relationship. + */ + public async unsubscribeAccount(id: string): Promise> { + const params = { + notify: false + } + return this.client.post(`/api/v1/accounts/${id}/follow`, params).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * GET /api/v1/accounts/:id/followers + * + * @param id The account ID. + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @return The array of accounts. + */ + public async getAccountFollowers( + id: string, + options?: { + limit?: number + max_id?: string + since_id?: string + get_all?: boolean + sleep_ms?: number + } + ): Promise>> { + let params = {} + if (options) { + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.urlToAccounts(`/api/v1/accounts/${id}/followers`, params, options?.get_all || false, options?.sleep_ms || 0) + } + + /** + * GET /api/v1/accounts/:id/following + * + * @param id The account ID. + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @return The array of accounts. + */ + public async getAccountFollowing( + id: string, + options?: { + limit?: number + max_id?: string + since_id?: string + get_all?: boolean + sleep_ms?: number + } + ): Promise>> { + let params = {} + if (options) { + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.urlToAccounts(`/api/v1/accounts/${id}/following`, params, options?.get_all || false, options?.sleep_ms || 0) + } + + /** Helper function to optionally follow Link headers as pagination */ + private async urlToAccounts(url: string, params: Record, get_all: boolean, sleep_ms: number) { + const res = await this.client.get>(url, params) + let converted = Object.assign({}, res, { + data: res.data.map(a => MastodonAPI.Converter.account(a)) + }) + if (get_all && converted.headers.link) { + let parsed = parseLinkHeader(converted.headers.link) + while (parsed?.next) { + const nextRes = await this.client.get>(parsed?.next.url, undefined, undefined, true) + converted = Object.assign({}, converted, { + data: [...converted.data, ...nextRes.data.map(a => MastodonAPI.Converter.account(a))] + }) + parsed = parseLinkHeader(nextRes.headers.link) + if (sleep_ms) { + await new Promise(converted => setTimeout(converted, sleep_ms)) + } + } + } + return converted + } + + /** + * GET /api/v1/accounts/:id/lists + * + * @param id The account ID. + * @return The array of lists. + */ + public async getAccountLists(id: string): Promise>> { + return this.client.get>(`/api/v1/accounts/${id}/lists`).then(res => { + return Object.assign(res, { + data: res.data.map(l => MastodonAPI.Converter.list(l)) + }) + }) + } + + /** + * GET /api/v1/accounts/:id/identity_proofs + * + * @param id The account ID. + * @return Array of IdentityProof + */ + public async getIdentityProof(id: string): Promise>> { + return this.client.get>(`/api/v1/accounts/${id}/identity_proofs`).then(res => { + return Object.assign(res, { + data: res.data.map(i => MastodonAPI.Converter.identity_proof(i)) + }) + }) + } + + /** + * POST /api/v1/accounts/:id/follow + * + * @param id The account ID. + * @param reblog Receive this account's reblogs in home timeline. + * @return Relationship + */ + public async followAccount(id: string, options?: { reblog?: boolean }): Promise> { + let params = {} + if (options) { + if (options.reblog !== undefined) { + params = Object.assign(params, { + reblog: options.reblog + }) + } + } + return this.client.post(`/api/v1/accounts/${id}/follow`, params).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * POST /api/v1/accounts/:id/unfollow + * + * @param id The account ID. + * @return Relationship + */ + public async unfollowAccount(id: string): Promise> { + return this.client.post(`/api/v1/accounts/${id}/unfollow`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * POST /api/v1/accounts/:id/block + * + * @param id The account ID. + * @return Relationship + */ + public async blockAccount(id: string): Promise> { + return this.client.post(`/api/v1/accounts/${id}/block`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * POST /api/v1/accounts/:id/unblock + * + * @param id The account ID. + * @return RElationship + */ + public async unblockAccount(id: string): Promise> { + return this.client.post(`/api/v1/accounts/${id}/unblock`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * POST /api/v1/accounts/:id/mute + * + * @param id The account ID. + * @param notifications Mute notifications in addition to statuses. + * @return Relationship + */ + public async muteAccount(id: string, notifications: boolean = true): Promise> { + return this.client + .post(`/api/v1/accounts/${id}/mute`, { + notifications: notifications + }) + .then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * POST /api/v1/accounts/:id/unmute + * + * @param id The account ID. + * @return Relationship + */ + public async unmuteAccount(id: string): Promise> { + return this.client.post(`/api/v1/accounts/${id}/unmute`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * POST /api/v1/accounts/:id/pin + * + * @param id The account ID. + * @return Relationship + */ + public async pinAccount(id: string): Promise> { + return this.client.post(`/api/v1/accounts/${id}/pin`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * POST /api/v1/accounts/:id/unpin + * + * @param id The account ID. + * @return Relationship + */ + public async unpinAccount(id: string): Promise> { + return this.client.post(`/api/v1/accounts/${id}/unpin`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * GET /api/v1/accounts/relationships + * + * @param id The account ID. + * @return Relationship + */ + public async getRelationship(id: string): Promise> { + return this.client + .get>('/api/v1/accounts/relationships', { + id: [id] + }) + .then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.relationship(res.data[0]) + }) + }) + } + + /** + * GET /api/v1/accounts/relationships + * + * @param ids Array of account IDs. + * @return Array of Relationship. + */ + public async getRelationships(ids: Array): Promise>> { + return this.client + .get>('/api/v1/accounts/relationships', { + id: ids + }) + .then(res => { + return Object.assign(res, { + data: res.data.map(r => MastodonAPI.Converter.relationship(r)) + }) + }) + } + + /** + * GET /api/v1/accounts/search + * + * @param q Search query. + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @return The array of accounts. + */ + public async searchAccount( + q: string, + options?: { + following?: boolean + resolve?: boolean + limit?: number + max_id?: string + since_id?: string + } + ): Promise>> { + let params = { q: q } + if (options) { + if (options.following !== undefined && options.following !== null) { + params = Object.assign(params, { + following: options.following + }) + } + if (options.resolve !== undefined && options.resolve !== null) { + params = Object.assign(params, { + resolve: options.resolve + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>('/api/v1/accounts/search', params).then(res => { + return Object.assign(res, { + data: res.data.map(a => MastodonAPI.Converter.account(a)) + }) + }) + } + + // ====================================== + // accounts/bookmarks + // ====================================== + + /** + * GET /api/v1/bookmarks + * + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + public async getBookmarks(options?: { + limit?: number + max_id?: string + since_id?: string + min_id?: string + }): Promise>> { + let params = {} + if (options) { + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + } + return this.client.get>('/api/v1/bookmarks', params).then(res => { + return Object.assign(res, { + data: res.data.map(s => MastodonAPI.Converter.status(s)) + }) + }) + } + + // ====================================== + // accounts/favourites + // ====================================== + + /** + * GET /api/v1/favourites + * + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + public async getFavourites(options?: { limit?: number; max_id?: string; min_id?: string }): Promise>> { + let params = {} + if (options) { + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>('/api/v1/favourites', params).then(res => { + return Object.assign(res, { + data: res.data.map(s => MastodonAPI.Converter.status(s)) + }) + }) + } + + // ====================================== + // accounts/mutes + // ====================================== + /** + * GET /api/v1/mutes + * + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of accounts. + */ + public async getMutes(options?: { limit?: number; max_id?: string; min_id?: string }): Promise>> { + let params = {} + if (options) { + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>('/api/v1/mutes', params).then(res => { + return Object.assign(res, { + data: res.data.map(a => MastodonAPI.Converter.account(a)) + }) + }) + } + + // ====================================== + // accounts/blocks + // ====================================== + /** + * GET /api/v1/blocks + * + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of accounts. + */ + public async getBlocks(options?: { limit?: number; max_id?: string; min_id?: string }): Promise>> { + let params = {} + if (options) { + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>('/api/v1/blocks', params).then(res => { + return Object.assign(res, { + data: res.data.map(a => MastodonAPI.Converter.account(a)) + }) + }) + } + + // ====================================== + // accounts/domain_blocks + // ====================================== + /** + * GET /api/v1/domain_blocks + * + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of domain name. + */ + public async getDomainBlocks(options?: { limit?: number; max_id?: string; min_id?: string }): Promise>> { + let params = {} + if (options) { + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>('/api/v1/domain_blocks', params) + } + + /** + * POST/api/v1/domain_blocks + * + * @param domain Domain to block. + */ + public blockDomain(domain: string): Promise> { + return this.client.post<{}>('/api/v1/domain_blocks', { + domain: domain + }) + } + + /** + * DELETE /api/v1/domain_blocks + * + * @param domain Domain to unblock + */ + public unblockDomain(domain: string): Promise> { + return this.client.del<{}>('/api/v1/domain_blocks', { + domain: domain + }) + } + + // ====================================== + // accounts/filters + // ====================================== + /** + * GET /api/v1/filters + * + * @return Array of filters. + */ + public async getFilters(): Promise>> { + return this.client.get>('/api/v1/filters').then(res => { + return Object.assign(res, { + data: res.data.map(f => MastodonAPI.Converter.filter(f)) + }) + }) + } + + /** + * GET /api/v1/filters/:id + * + * @param id The filter ID. + * @return Filter. + */ + public async getFilter(id: string): Promise> { + return this.client.get(`/api/v1/filters/${id}`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.filter(res.data) + }) + }) + } + + /** + * POST /api/v1/filters + * + * @param phrase Text to be filtered. + * @param context Array of enumerable strings home, notifications, public, thread, account. At least one context must be specified. + * @param options.irreversible Should the server irreversibly drop matching entities from home and notifications? + * @param options.whole_word Consider word boundaries? + * @param options.expires_in ISO 8601 Datetime for when the filter expires. + * @return Filter + */ + public async createFilter( + phrase: string, + context: Array, + options?: { + irreversible?: boolean + whole_word?: boolean + expires_in?: string + } + ): Promise> { + let params = { + phrase: phrase, + context: context + } + if (options) { + if (options.irreversible !== undefined) { + params = Object.assign(params, { + irreversible: options.irreversible + }) + } + if (options.whole_word !== undefined) { + params = Object.assign(params, { + whole_word: options.whole_word + }) + } + if (options.expires_in) { + params = Object.assign(params, { + expires_in: options.expires_in + }) + } + } + return this.client.post('/api/v1/filters', params).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.filter(res.data) + }) + }) + } + + /** + * PUT /api/v1/filters/:id + * + * @param id The filter ID. + * @param phrase Text to be filtered. + * @param context Array of enumerable strings home, notifications, public, thread, account. At least one context must be specified. + * @param options.irreversible Should the server irreversibly drop matching entities from home and notifications? + * @param options.whole_word Consider word boundaries? + * @param options.expires_in ISO 8601 Datetime for when the filter expires. + * @return Filter + */ + public async updateFilter( + id: string, + phrase: string, + context: Array, + options?: { + irreversible?: boolean + whole_word?: boolean + expires_in?: string + } + ): Promise> { + let params = { + phrase: phrase, + context: context + } + if (options) { + if (options.irreversible !== undefined) { + params = Object.assign(params, { + irreversible: options.irreversible + }) + } + if (options.whole_word !== undefined) { + params = Object.assign(params, { + whole_word: options.whole_word + }) + } + if (options.expires_in) { + params = Object.assign(params, { + expires_in: options.expires_in + }) + } + } + return this.client.put(`/api/v1/filters/${id}`, params).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.filter(res.data) + }) + }) + } + + /** + * DELETE /api/v1/filters/:id + * + * @param id The filter ID. + * @return Removed filter. + */ + public async deleteFilter(id: string): Promise> { + return this.client.del(`/api/v1/filters/${id}`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.filter(res.data) + }) + }) + } + + // ====================================== + // accounts/reports + // ====================================== + /** + * POST /api/v1/reports + * + * @param account_id Target account ID. + * @param options.status_ids Array of Statuses ids to attach to the report. + * @param options.comment The reason for the report. Default maximum of 1000 characters. + * @param options.forward If the account is remote, should the report be forwarded to the remote admin? + * @param options.category Specify if the report is due to spam, violation of enumerated instance rules, or some other reason. Defaults to other. Will be set to violation if rule_ids[] is provided (regardless of any category value you provide). + * @param options.rule_ids For violation category reports, specify the ID of the exact rules broken. Rules and their IDs are available via GET /api/v1/instance/rules and GET /api/v1/instance. + * @return Report + */ + public async report( + account_id: string, + options?: { + status_ids?: Array + comment: string + forward?: boolean + category?: Entity.Category + rule_ids?: Array + } + ): Promise> { + let params = { + account_id: account_id + } + if (options) { + if (options.status_ids) { + params = Object.assign(params, { + status_ids: options.status_ids + }) + } + if (options.comment) { + params = Object.assign(params, { + comment: options.comment + }) + } + if (options.forward !== undefined) { + params = Object.assign(params, { + forward: options.forward + }) + } + if (options.category) { + params = Object.assign(params, { + category: options.category + }) + } + if (options.rule_ids) { + params = Object.assign(params, { + rule_ids: options.rule_ids + }) + } + } + return this.client.post('/api/v1/reports', params).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.report(res.data) + }) + }) + } + + // ====================================== + // accounts/follow_requests + // ====================================== + /** + * GET /api/v1/follow_requests + * + * @param limit Maximum number of results. + * @return Array of account. + */ + public async getFollowRequests(limit?: number): Promise>> { + if (limit) { + return this.client + .get>('/api/v1/follow_requests', { + limit: limit + }) + .then(res => { + return Object.assign(res, { + data: res.data.map(a => MastodonAPI.Converter.account(a)) + }) + }) + } else { + return this.client.get>('/api/v1/follow_requests').then(res => { + return Object.assign(res, { + data: res.data.map(a => MastodonAPI.Converter.account(a)) + }) + }) + } + } + + /** + * POST /api/v1/follow_requests/:id/authorize + * + * @param id Target account ID. + * @return Relationship. + */ + public async acceptFollowRequest(id: string): Promise> { + return this.client.post(`/api/v1/follow_requests/${id}/authorize`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * POST /api/v1/follow_requests/:id/reject + * + * @param id Target account ID. + * @return Relationship. + */ + public async rejectFollowRequest(id: string): Promise> { + return this.client.post(`/api/v1/follow_requests/${id}/reject`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.relationship(res.data) + }) + }) + } + + // ====================================== + // accounts/endorsements + // ====================================== + /** + * GET /api/v1/endorsements + * + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @return Array of accounts. + */ + public async getEndorsements(options?: { limit?: number; max_id?: string; since_id?: string }): Promise>> { + let params = {} + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + } + return this.client.get>('/api/v1/endorsements', params).then(res => { + return Object.assign(res, { + data: res.data.map(a => MastodonAPI.Converter.account(a)) + }) + }) + } + + // ====================================== + // accounts/featured_tags + // ====================================== + /** + * GET /api/v1/featured_tags + * + * @return Array of featured tag. + */ + public async getFeaturedTags(): Promise>> { + return this.client.get>('/api/v1/featured_tags').then(res => { + return Object.assign(res, { + data: res.data.map(f => MastodonAPI.Converter.featured_tag(f)) + }) + }) + } + + /** + * POST /api/v1/featured_tags + * + * @param name Target hashtag name. + * @return FeaturedTag. + */ + public async createFeaturedTag(name: string): Promise> { + return this.client + .post('/api/v1/featured_tags', { + name: name + }) + .then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.featured_tag(res.data) + }) + }) + } + + /** + * DELETE /api/v1/featured_tags/:id + * + * @param id Target featured tag id. + * @return Empty + */ + public deleteFeaturedTag(id: string): Promise> { + return this.client.del<{}>(`/api/v1/featured_tags/${id}`) + } + + /** + * GET /api/v1/featured_tags/suggestions + * + * @return Array of tag. + */ + public async getSuggestedTags(): Promise>> { + return this.client.get>('/api/v1/featured_tags/suggestions').then(res => { + return Object.assign(res, { + data: res.data.map(t => MastodonAPI.Converter.tag(t)) + }) + }) + } + + // ====================================== + // accounts/preferences + // ====================================== + /** + * GET /api/v1/preferences + * + * @return Preferences. + */ + public async getPreferences(): Promise> { + return this.client.get('/api/v1/preferences').then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.preferences(res.data) + }) + }) + } + + // ====================================== + // accounts/followed_tags + // ====================================== + /** + * GET /api/v1/followed_tags + * + * @return Array of Tag. + */ + public async getFollowedTags(): Promise>> { + return this.client.get>('/api/v1/followed_tags').then(res => { + return Object.assign(res, { + data: res.data.map(tag => MastodonAPI.Converter.tag(tag)) + }) + }) + } + + // ====================================== + // accounts/suggestions + // ====================================== + /** + * GET /api/v1/suggestions + * + * @param limit Maximum number of results. + * @return Array of accounts. + */ + public async getSuggestions(limit?: number): Promise>> { + if (limit) { + return this.client + .get>('/api/v1/suggestions', { + limit: limit + }) + .then(res => { + return Object.assign(res, { + data: res.data.map(a => MastodonAPI.Converter.account(a)) + }) + }) + } else { + return this.client.get>('/api/v1/suggestions').then(res => { + return Object.assign(res, { + data: res.data.map(a => MastodonAPI.Converter.account(a)) + }) + }) + } + } + + // ====================================== + // accounts/tags + // ====================================== + /** + * GET /api/v1/tags/:id + * + * @param id Target hashtag id. + * @return Tag + */ + public async getTag(id: string): Promise> { + return this.client.get(`/api/v1/tags/${id}`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.tag(res.data) + }) + }) + } + + /** + * POST /api/v1/tags/:id/follow + * + * @param id Target hashtag id. + * @return Tag + */ + public async followTag(id: string): Promise> { + return this.client.post(`/api/v1/tags/${id}/follow`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.tag(res.data) + }) + }) + } + + /** + * POST /api/v1/tags/:id/unfollow + * + * @param id Target hashtag id. + * @return Tag + */ + public async unfollowTag(id: string): Promise> { + return this.client.post(`/api/v1/tags/${id}/unfollow`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.tag(res.data) + }) + }) + } + + // ====================================== + // statuses + // ====================================== + /** + * POST /api/v1/statuses + * + * @param status Text content of status. + * @param options.media_ids Array of Attachment ids. + * @param options.poll Poll object. + * @param options.in_reply_to_id ID of the status being replied to, if status is a reply. + * @param options.sensitive Mark status and attached media as sensitive? + * @param options.spoiler_text Text to be shown as a warning or subject before the actual content. + * @param options.visibility Visibility of the posted status. + * @param options.scheduled_at ISO 8601 Datetime at which to schedule a status. + * @param options.language ISO 639 language code for this status. + * @param options.quote_id ID of the status being quoted to, if status is a quote. + * @return Status. When options.scheduled_at is present, ScheduledStatus is returned instead. + */ + public async postStatus( + status: string, + options: { + media_ids?: Array + poll?: { options: Array; expires_in: number; multiple?: boolean; hide_totals?: boolean } + in_reply_to_id?: string + sensitive?: boolean + spoiler_text?: string + visibility?: 'public' | 'unlisted' | 'private' | 'direct' + scheduled_at?: string + language?: string + quote_id?: string + } + ): Promise> { + let params = { + status: status + } + if (options) { + if (options.media_ids) { + params = Object.assign(params, { + media_ids: options.media_ids + }) + } + if (options.poll) { + let pollParam = { + options: options.poll.options, + expires_in: options.poll.expires_in + } + if (options.poll.multiple !== undefined) { + pollParam = Object.assign(pollParam, { + multiple: options.poll.multiple + }) + } + if (options.poll.hide_totals !== undefined) { + pollParam = Object.assign(pollParam, { + hide_totals: options.poll.hide_totals + }) + } + params = Object.assign(params, { + poll: pollParam + }) + } + if (options.in_reply_to_id) { + params = Object.assign(params, { + in_reply_to_id: options.in_reply_to_id + }) + } + if (options.sensitive !== undefined) { + params = Object.assign(params, { + sensitive: options.sensitive + }) + } + if (options.spoiler_text) { + params = Object.assign(params, { + spoiler_text: options.spoiler_text + }) + } + if (options.visibility) { + params = Object.assign(params, { + visibility: options.visibility + }) + } + if (options.scheduled_at) { + params = Object.assign(params, { + scheduled_at: options.scheduled_at + }) + } + if (options.language) { + params = Object.assign(params, { + language: options.language + }) + } + if (options.quote_id) { + params = Object.assign(params, { + quote_id: options.quote_id + }) + } + } + if (options && options.scheduled_at) { + return this.client.post('/api/v1/statuses', params).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.scheduled_status(res.data) + }) + }) + } + return this.client.post('/api/v1/statuses', params).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.status(res.data) + }) + }) + } + + /** + * GET /api/v1/statuses/:id + * + * @param id The target status id. + * @return Status + */ + public async getStatus(id: string): Promise> { + return this.client.get(`/api/v1/statuses/${id}`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.status(res.data) + }) + }) + } + + /** + PUT /api/v1/statuses/:id + * + * @param id The target status id. + * @return Status + */ + public async editStatus( + id: string, + options: { + status?: string + spoiler_text?: string + sensitive?: boolean + media_ids?: Array + poll?: { options?: Array; expires_in?: number; multiple?: boolean; hide_totals?: boolean } + } + ): Promise> { + let params = {} + if (options.status) { + params = Object.assign(params, { + status: options.status + }) + } + if (options.spoiler_text) { + params = Object.assign(params, { + spoiler_text: options.spoiler_text + }) + } + if (options.sensitive) { + params = Object.assign(params, { + sensitive: options.sensitive + }) + } + if (options.media_ids) { + params = Object.assign(params, { + media_ids: options.media_ids + }) + } + if (options.poll) { + let pollParam = {} + if (options.poll.options !== undefined) { + pollParam = Object.assign(pollParam, { + options: options.poll.options + }) + } + if (options.poll.expires_in !== undefined) { + pollParam = Object.assign(pollParam, { + expires_in: options.poll.expires_in + }) + } + if (options.poll.multiple !== undefined) { + pollParam = Object.assign(pollParam, { + multiple: options.poll.multiple + }) + } + if (options.poll.hide_totals !== undefined) { + pollParam = Object.assign(pollParam, { + hide_totals: options.poll.hide_totals + }) + } + params = Object.assign(params, { + poll: pollParam + }) + } + return this.client.put(`/api/v1/statuses/${id}`, params).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.status(res.data) + }) + }) + } + + /** + * DELETE /api/v1/statuses/:id + * + * @param id The target status id. + * @return Status + */ + public async deleteStatus(id: string): Promise> { + return this.client.del(`/api/v1/statuses/${id}`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.status(res.data) + }) + }) + } + + /** + * GET /api/v1/statuses/:id/context + * + * Get parent and child statuses. + * @param id The target status id. + * @return Context + */ + public async getStatusContext( + id: string, + options?: { limit?: number; max_id?: string; since_id?: string } + ): Promise> { + let params = {} + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + } + return this.client.get(`/api/v1/statuses/${id}/context`, params).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.context(res.data) + }) + }) + } + + /** + * GET /api/v1/statuses/:id/source + * + * Obtain the source properties for a status so that it can be edited. + * @param id The target status id. + * @return StatusSource + */ + public async getStatusSource(id: string): Promise> { + return this.client.get(`/api/v1/statuses/${id}/source`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.status_source(res.data) + }) + }) + } + + /** + * GET /api/v1/statuses/:id/reblogged_by + * + * @param id The target status id. + * @return Array of accounts. + */ + public async getStatusRebloggedBy(id: string): Promise>> { + return this.client.get>(`/api/v1/statuses/${id}/reblogged_by`).then(res => { + return Object.assign(res, { + data: res.data.map(a => MastodonAPI.Converter.account(a)) + }) + }) + } + + /** + * GET /api/v1/statuses/:id/favourited_by + * + * @param id The target status id. + * @return Array of accounts. + */ + public async getStatusFavouritedBy(id: string): Promise>> { + return this.client.get>(`/api/v1/statuses/${id}/favourited_by`).then(res => { + return Object.assign(res, { + data: res.data.map(a => MastodonAPI.Converter.account(a)) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/favourite + * + * @param id The target status id. + * @return Status. + */ + public async favouriteStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/favourite`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.status(res.data) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/unfavourite + * + * @param id The target status id. + * @return Status. + */ + public async unfavouriteStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/unfavourite`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.status(res.data) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/reblog + * + * @param id The target status id. + * @return Status. + */ + public async reblogStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/reblog`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.status(res.data) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/unreblog + * + * @param id The target status id. + * @return Status. + */ + public async unreblogStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/unreblog`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.status(res.data) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/bookmark + * + * @param id The target status id. + * @return Status. + */ + public async bookmarkStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/bookmark`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.status(res.data) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/unbookmark + * + * @param id The target status id. + * @return Status. + */ + public async unbookmarkStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/unbookmark`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.status(res.data) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/mute + * + * @param id The target status id. + * @return Status + */ + public async muteStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/mute`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.status(res.data) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/unmute + * + * @param id The target status id. + * @return Status + */ + public async unmuteStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/unmute`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.status(res.data) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/pin + * @param id The target status id. + * @return Status + */ + public async pinStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/pin`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.status(res.data) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/unpin + * + * @param id The target status id. + * @return Status + */ + public async unpinStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/unpin`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.status(res.data) + }) + }) + } + + // ====================================== + // statuses/media + // ====================================== + /** + * POST /api/v2/media + * + * @param file The file to be attached, using multipart form data. + * @param options.description A plain-text description of the media. + * @param options.focus Two floating points (x,y), comma-delimited, ranging from -1.0 to 1.0. + * @return Attachment + */ + public async uploadMedia( + file: any, + options?: { description?: string; focus?: string } + ): Promise> { + const formData = new FormData() + formData.append('file', file) + if (options) { + if (options.description) { + formData.append('description', options.description) + } + if (options.focus) { + formData.append('focus', options.focus) + } + } + return this.client.postForm('/api/v2/media', formData).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.async_attachment(res.data) + }) + }) + } + + /** + * GET /api/v1/media/:id + * + * @param id Target media ID. + * @return Attachment + */ + public async getMedia(id: string): Promise> { + const res = await this.client.get(`/api/v1/media/${id}`) + + return Object.assign(res, { + data: MastodonAPI.Converter.attachment(res.data) + }) + } + + /** + * PUT /api/v1/media/:id + * + * @param id Target media ID. + * @param options.file The file to be attached, using multipart form data. + * @param options.description A plain-text description of the media. + * @param options.focus Two floating points (x,y), comma-delimited, ranging from -1.0 to 1.0. + * @param options.is_sensitive Whether the media is sensitive. + * @return Attachment + */ + public async updateMedia( + id: string, + options?: { + file?: any + description?: string + focus?: string + } + ): Promise> { + const formData = new FormData() + if (options) { + if (options.file) { + formData.append('file', options.file) + } + if (options.description) { + formData.append('description', options.description) + } + if (options.focus) { + formData.append('focus', options.focus) + } + } + return this.client.putForm(`/api/v1/media/${id}`, formData).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.attachment(res.data) + }) + }) + } + + // ====================================== + // statuses/polls + // ====================================== + /** + * GET /api/v1/polls/:id + * + * @param id Target poll ID. + * @return Poll + */ + public async getPoll(id: string): Promise> { + return this.client.get(`/api/v1/polls/${id}`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.poll(res.data) + }) + }) + } + + /** + * POST /api/v1/polls/:id/votes + * + * @param id Target poll ID. + * @param choices Array of own votes containing index for each option (starting from 0). + * @return Poll + */ + public async votePoll(id: string, choices: Array): Promise> { + return this.client + .post(`/api/v1/polls/${id}/votes`, { + choices: choices + }) + .then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.poll(res.data) + }) + }) + } + + // ====================================== + // statuses/scheduled_statuses + // ====================================== + /** + * GET /api/v1/scheduled_statuses + * + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of scheduled statuses. + */ + public async getScheduledStatuses(options?: { + limit?: number | null + max_id?: string | null + since_id?: string | null + min_id?: string | null + }): Promise>> { + let params = {} + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + } + return this.client.get>('/api/v1/scheduled_statuses', params).then(res => { + return Object.assign(res, { + data: res.data.map(s => MastodonAPI.Converter.scheduled_status(s)) + }) + }) + } + + /** + * GET /api/v1/scheduled_statuses/:id + * + * @param id Target status ID. + * @return ScheduledStatus. + */ + public async getScheduledStatus(id: string): Promise> { + return this.client.get(`/api/v1/scheduled_statuses/${id}`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.scheduled_status(res.data) + }) + }) + } + + /** + * PUT /api/v1/scheduled_statuses/:id + * + * @param id Target scheduled status ID. + * @param scheduled_at ISO 8601 Datetime at which the status will be published. + * @return ScheduledStatus. + */ + public async scheduleStatus(id: string, scheduled_at?: string | null): Promise> { + let params = {} + if (scheduled_at) { + params = Object.assign(params, { + scheduled_at: scheduled_at + }) + } + return this.client.put(`/api/v1/scheduled_statuses/${id}`, params).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.scheduled_status(res.data) + }) + }) + } + + /** + * DELETE /api/v1/scheduled_statuses/:id + * + * @param id Target scheduled status ID. + */ + public cancelScheduledStatus(id: string): Promise> { + return this.client.del<{}>(`/api/v1/scheduled_statuses/${id}`) + } + + // ====================================== + // timelines + // ====================================== + /** + * GET /api/v1/timelines/public + * + * @param options.only_media Show only statuses with media attached? Defaults to false. + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + public async getPublicTimeline(options?: { + only_media?: boolean + limit?: number + max_id?: string + since_id?: string + min_id?: string + }): Promise>> { + let params = { + local: false + } + if (options) { + if (options.only_media !== undefined) { + params = Object.assign(params, { + only_media: options.only_media + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>('/api/v1/timelines/public', params).then(res => { + return Object.assign(res, { + data: res.data.map(s => MastodonAPI.Converter.status(s)) + }) + }) + } + + /** + * GET /api/v1/timelines/public + * + * @param options.only_media Show only statuses with media attached? Defaults to false. + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + public async getLocalTimeline(options?: { + only_media?: boolean + limit?: number + max_id?: string + since_id?: string + min_id?: string + }): Promise>> { + let params = { + local: true + } + if (options) { + if (options.only_media !== undefined) { + params = Object.assign(params, { + only_media: options.only_media + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>('/api/v1/timelines/public', params).then(res => { + return Object.assign(res, { + data: res.data.map(s => MastodonAPI.Converter.status(s)) + }) + }) + } + + /** + * GET /api/v1/timelines/tag/:hashtag + * + * @param hashtag Content of a #hashtag, not including # symbol. + * @param options.local Show only local statuses? Defaults to false. + * @param options.only_media Show only statuses with media attached? Defaults to false. + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + public async getTagTimeline( + hashtag: string, + options?: { + local?: boolean + only_media?: boolean + limit?: number + max_id?: string + since_id?: string + min_id?: string + } + ): Promise>> { + let params = {} + if (options) { + if (options.local !== undefined) { + params = Object.assign(params, { + local: options.local + }) + } + if (options.only_media !== undefined) { + params = Object.assign(params, { + only_media: options.only_media + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>(`/api/v1/timelines/tag/${hashtag}`, params).then(res => { + return Object.assign(res, { + data: res.data.map(s => MastodonAPI.Converter.status(s)) + }) + }) + } + + /** + * GET /api/v1/timelines/home + * + * @param options.local Show only local statuses? Defaults to false. + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + public async getHomeTimeline(options?: { + local?: boolean + limit?: number + max_id?: string + since_id?: string + min_id?: string + }): Promise>> { + let params = {} + if (options) { + if (options.local !== undefined) { + params = Object.assign(params, { + local: options.local + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>('/api/v1/timelines/home', params).then(res => { + return Object.assign(res, { + data: res.data.map(s => MastodonAPI.Converter.status(s)) + }) + }) + } + + /** + * GET /api/v1/timelines/list/:list_id + * + * @param list_id Local ID of the list in the database. + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + public async getListTimeline( + list_id: string, + options?: { + limit?: number + max_id?: string + since_id?: string + min_id?: string + } + ): Promise>> { + let params = {} + if (options) { + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>(`/api/v1/timelines/list/${list_id}`, params).then(res => { + return Object.assign(res, { + data: res.data.map(s => MastodonAPI.Converter.status(s)) + }) + }) + } + + // ====================================== + // timelines/conversations + // ====================================== + /** + * GET /api/v1/conversations + * + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + public async getConversationTimeline(options?: { + limit?: number + max_id?: string + since_id?: string + min_id?: string + }): Promise>> { + let params = {} + if (options) { + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>('/api/v1/conversations', params).then(res => { + return Object.assign(res, { + data: res.data.map(c => MastodonAPI.Converter.conversation(c)) + }) + }) + } + + /** + * DELETE /api/v1/conversations/:id + * + * @param id Target conversation ID. + */ + public deleteConversation(id: string): Promise> { + return this.client.del<{}>(`/api/v1/conversations/${id}`) + } + + /** + * POST /api/v1/conversations/:id/read + * + * @param id Target conversation ID. + * @return Conversation. + */ + public async readConversation(id: string): Promise> { + return this.client.post(`/api/v1/conversations/${id}/read`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.conversation(res.data) + }) + }) + } + + // ====================================== + // timelines/lists + // ====================================== + /** + * GET /api/v1/lists + * + * @return Array of lists. + */ + public async getLists(): Promise>> { + return this.client.get>('/api/v1/lists').then(res => { + return Object.assign(res, { + data: res.data.map(l => MastodonAPI.Converter.list(l)) + }) + }) + } + + /** + * GET /api/v1/lists/:id + * + * @param id Target list ID. + * @return List. + */ + public async getList(id: string): Promise> { + return this.client.get(`/api/v1/lists/${id}`).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.list(res.data) + }) + }) + } + + /** + * POST /api/v1/lists + * + * @param title List name. + * @return List. + */ + public async createList(title: string): Promise> { + return this.client + .post('/api/v1/lists', { + title: title + }) + .then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.list(res.data) + }) + }) + } + + /** + * PUT /api/v1/lists/:id + * + * @param id Target list ID. + * @param title New list name. + * @return List. + */ + public async updateList(id: string, title: string): Promise> { + return this.client + .put(`/api/v1/lists/${id}`, { + title: title + }) + .then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.list(res.data) + }) + }) + } + + /** + * DELETE /api/v1/lists/:id + * + * @param id Target list ID. + */ + public deleteList(id: string): Promise> { + return this.client.del<{}>(`/api/v1/lists/${id}`) + } + + /** + * GET /api/v1/lists/:id/accounts + * + * @param id Target list ID. + * @param options.limit Max number of results to return. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of accounts. + */ + public async getAccountsInList( + id: string, + options?: { + limit?: number + max_id?: string + since_id?: string + } + ): Promise>> { + let params = {} + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + } + return this.client.get>(`/api/v1/lists/${id}/accounts`, params).then(res => { + return Object.assign(res, { + data: res.data.map(a => MastodonAPI.Converter.account(a)) + }) + }) + } + + /** + * POST /api/v1/lists/:id/accounts + * + * @param id Target list ID. + * @param account_ids Array of account IDs to add to the list. + */ + public addAccountsToList(id: string, account_ids: Array): Promise> { + return this.client.post<{}>(`/api/v1/lists/${id}/accounts`, { + account_ids: account_ids + }) + } + + /** + * DELETE /api/v1/lists/:id/accounts + * + * @param id Target list ID. + * @param account_ids Array of account IDs to add to the list. + */ + public deleteAccountsFromList(id: string, account_ids: Array): Promise> { + return this.client.del<{}>(`/api/v1/lists/${id}/accounts`, { + account_ids: account_ids + }) + } + + // ====================================== + // timelines/markers + // ====================================== + /** + * GET /api/v1/markers + * + * @param timelines Array of timeline names, String enum anyOf home, notifications. + * @return Marker or empty object. + */ + public async getMarkers(timeline: Array): Promise>> { + return this.client + .get>('/api/v1/markers', { + timeline: timeline + }) + .then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.marker(res.data) + }) + }) + } + + /** + * POST /api/v1/markers + * + * @param options.home Marker position of the last read status ID in home timeline. + * @param options.notifications Marker position of the last read notification ID in notifications. + * @return Marker. + */ + public async saveMarkers(options?: { + home?: { last_read_id: string } + notifications?: { last_read_id: string } + }): Promise> { + let params = {} + if (options) { + if (options.home) { + params = Object.assign(params, { + home: options.home + }) + } + if (options.notifications) { + params = Object.assign(params, { + notifications: options.notifications + }) + } + } + return this.client.post('/api/v1/markers', params).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.marker(res.data) + }) + }) + } + + // ====================================== + // notifications + // ====================================== + /** + * GET /api/v1/notifications + * + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @param options.exclude_types Array of types to exclude. + * @param options.account_id Return only notifications received from this account. + * @return Array of notifications. + */ + public async getNotifications(options?: { + limit?: number + max_id?: string + since_id?: string + min_id?: string + exclude_types?: Array + account_id?: string + }): Promise>> { + let params = {} + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.exclude_types) { + params = Object.assign(params, { + exclude_types: options.exclude_types.map(e => MastodonAPI.Converter.encodeNotificationType(e)) + }) + } + if (options.account_id) { + params = Object.assign(params, { + account_id: options.account_id + }) + } + } + return this.client.get>('/api/v1/notifications', params).then(res => { + return Object.assign(res, { + data: res.data.flatMap(n => { + const notify = MastodonAPI.Converter.notification(n) + if (notify instanceof UnknownNotificationTypeError) return [] + return notify + }) + }) + }) + } + + /** + * GET /api/v1/notifications/:id + * + * @param id Target notification ID. + * @return Notification. + */ + public async getNotification(id: string): Promise> { + const res = await this.client.get(`/api/v1/notifications/${id}`) + const notify = MastodonAPI.Converter.notification(res.data) + if (notify instanceof UnknownNotificationTypeError) { + throw new UnknownNotificationTypeError() + } + return { ...res, data: notify } + } + + /** + * POST /api/v1/notifications/clear + */ + public dismissNotifications(): Promise> { + return this.client.post<{}>('/api/v1/notifications/clear') + } + + /** + * POST /api/v1/notifications/:id/dismiss + * + * @param id Target notification ID. + */ + public dismissNotification(id: string): Promise> { + return this.client.post<{}>(`/api/v1/notifications/${id}/dismiss`) + } + + public readNotifications(_options: { + id?: string + max_id?: string + }): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('mastodon does not support') + reject(err) + }) + } + + // ====================================== + // notifications/push + // ====================================== + /** + * POST /api/v1/push/subscription + * + * @param subscription[endpoint] Endpoint URL that is called when a notification event occurs. + * @param subscription[keys][p256dh] User agent public key. Base64 encoded string of public key of ECDH key using prime256v1 curve. + * @param subscription[keys] Auth secret. Base64 encoded string of 16 bytes of random data. + * @param data[alerts][follow] Receive follow notifications? + * @param data[alerts][favourite] Receive favourite notifications? + * @param data[alerts][reblog] Receive reblog notifictaions? + * @param data[alerts][mention] Receive mention notifications? + * @param data[alerts][poll] Receive poll notifications? + * @return PushSubscription. + */ + public async subscribePushNotification( + subscription: { endpoint: string; keys: { p256dh: string; auth: string } }, + data?: { alerts: { follow?: boolean; favourite?: boolean; reblog?: boolean; mention?: boolean; poll?: boolean } } | null + ): Promise> { + let params = { + subscription + } + if (data) { + params = Object.assign(params, { + data + }) + } + return this.client.post('/api/v1/push/subscription', params).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.push_subscription(res.data) + }) + }) + } + + /** + * GET /api/v1/push/subscription + * + * @return PushSubscription. + */ + public async getPushSubscription(): Promise> { + return this.client.get('/api/v1/push/subscription').then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.push_subscription(res.data) + }) + }) + } + + /** + * PUT /api/v1/push/subscription + * + * @param data[alerts][follow] Receive follow notifications? + * @param data[alerts][favourite] Receive favourite notifications? + * @param data[alerts][reblog] Receive reblog notifictaions? + * @param data[alerts][mention] Receive mention notifications? + * @param data[alerts][poll] Receive poll notifications? + * @return PushSubscription. + */ + public async updatePushSubscription( + data?: { alerts: { follow?: boolean; favourite?: boolean; reblog?: boolean; mention?: boolean; poll?: boolean } } | null + ): Promise> { + let params = {} + if (data) { + params = Object.assign(params, { + data + }) + } + return this.client.put('/api/v1/push/subscription', params).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.push_subscription(res.data) + }) + }) + } + + /** + * DELETE /api/v1/push/subscription + */ + public deletePushSubscription(): Promise> { + return this.client.del<{}>('/api/v1/push/subscription') + } + + // ====================================== + // search + // ====================================== + /** + * GET /api/v2/search + * + * @param q The search query. + * @param type Enum of search target. + * @param options.limit Maximum number of results to load, per type. Defaults to 20. Max 40. + * @param options.max_id Return results older than this id. + * @param options.min_id Return results immediately newer than this id. + * @param options.resolve Attempt WebFinger lookup. Defaults to false. + * @param options.following Only include accounts that the user is following. Defaults to false. + * @param options.account_id If provided, statuses returned will be authored only by this account. + * @param options.exclude_unreviewed Filter out unreviewed tags? Defaults to false. + * @return Results. + */ + public async search( + q: string, + options?: { + type?: 'accounts' | 'hashtags' | 'statuses' + limit?: number + max_id?: string + min_id?: string + resolve?: boolean + offset?: number + following?: boolean + account_id?: string + exclude_unreviewed?: boolean + } + ): Promise> { + let params = { + q + } + if (options) { + if (options.type) { + params = Object.assign(params, { + type: options.type + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.resolve !== undefined) { + params = Object.assign(params, { + resolve: options.resolve + }) + } + if (options.offset) { + params = Object.assign(params, { + offset: options.offset + }) + } + if (options.following !== undefined) { + params = Object.assign(params, { + following: options.following + }) + } + if (options.account_id) { + params = Object.assign(params, { + account_id: options.account_id + }) + } + if (options.exclude_unreviewed) { + params = Object.assign(params, { + exclude_unreviewed: options.exclude_unreviewed + }) + } + } + return this.client.get('/api/v2/search', params).then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.results(res.data) + }) + }) + } + + // ====================================== + // instance + // ====================================== + /** + * GET /api/v1/instance + */ + public async getInstance(): Promise> { + return this.client.get('/api/v1/instance').then(res => { + return Object.assign(res, { + data: MastodonAPI.Converter.instance(res.data) + }) + }) + } + + /** + * GET /api/v1/instance/peers + */ + public getInstancePeers(): Promise>> { + return this.client.get>('/api/v1/instance/peers') + } + + /** + * GET /api/v1/instance/activity + */ + public async getInstanceActivity(): Promise>> { + return this.client.get>('/api/v1/instance/activity').then(res => { + return Object.assign(res, { + data: res.data.map(a => MastodonAPI.Converter.activity(a)) + }) + }) + } + + // ====================================== + // instance/trends + // ====================================== + /** + * GET /api/v1/trends + * + * @param limit Maximum number of results to return. Defaults to 10. + */ + public async getInstanceTrends(limit?: number | null): Promise>> { + let params = {} + if (limit) { + params = Object.assign(params, { + limit + }) + } + return this.client.get>('/api/v1/trends', params).then(res => { + return Object.assign(res, { + data: res.data.map(t => MastodonAPI.Converter.tag(t)) + }) + }) + } + + // ====================================== + // instance/directory + // ====================================== + /** + * GET /api/v1/directory + * + * @param options.limit How many accounts to load. Default 40. + * @param options.offset How many accounts to skip before returning results. Default 0. + * @param options.order Order of results. + * @param options.local Only return local accounts. + * @return Array of accounts. + */ + public async getInstanceDirectory(options?: { + limit?: number + offset?: number + order?: 'active' | 'new' + local?: boolean + }): Promise>> { + let params = {} + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.offset) { + params = Object.assign(params, { + offset: options.offset + }) + } + if (options.order) { + params = Object.assign(params, { + order: options.order + }) + } + if (options.local !== undefined) { + params = Object.assign(params, { + local: options.local + }) + } + } + return this.client.get>('/api/v1/directory', params).then(res => { + return Object.assign(res, { + data: res.data.map(a => MastodonAPI.Converter.account(a)) + }) + }) + } + + // ====================================== + // instance/custom_emojis + // ====================================== + /** + * GET /api/v1/custom_emojis + * + * @return Array of emojis. + */ + public async getInstanceCustomEmojis(): Promise>> { + return this.client.get>('/api/v1/custom_emojis').then(res => { + return Object.assign(res, { + data: res.data.map(e => MastodonAPI.Converter.emoji(e)) + }) + }) + } + + // ====================================== + // instance/announcements + // ====================================== + /** + * GET /api/v1/announcements + * + * @return Array of announcements. + */ + public async getInstanceAnnouncements(): Promise>> { + return this.client.get>('/api/v1/announcements').then(res => { + return Object.assign(res, { + data: res.data.map(a => MastodonAPI.Converter.announcement(a)) + }) + }) + } + + /** + * POST /api/v1/announcements/:id/dismiss + * + * @param id The ID of the Announcement in the database. + */ + public async dismissInstanceAnnouncement(id: string): Promise>> { + return this.client.post>(`/api/v1/announcements/${id}/dismiss`) + } + + /** + * PUT /api/v1/announcements/:id/reactions/:name + * + * @param id The ID of the Announcement in the database. + * @param name Unicode emoji, or the shortcode of a custom emoji. + */ + public async addReactionToAnnouncement(id: string, name: string): Promise>> { + return this.client.put>(`/api/v1/announcements/${id}/reactions/${name}`) + } + + /** + * DELETE /api/v1/announcements/:id/reactions/:name + * + * @param id The ID of the Announcement in the database. + * @param name Unicode emoji, or the shortcode of a custom emoji. + */ + public async removeReactionFromAnnouncement(id: string, name: string): Promise>> { + return this.client.del>(`/api/v1/announcements/${id}/reactions/${name}`) + } + + // ====================================== + // Emoji reactions + // ====================================== + public async createEmojiReaction(_id: string, _emoji: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('mastodon does not support') + reject(err) + }) + } + + public async deleteEmojiReaction(_id: string, _emoji: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('mastodon does not support') + reject(err) + }) + } + + public async getEmojiReactions(_id: string): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('mastodon does not support') + reject(err) + }) + } + + public async getEmojiReaction(_id: string, _emoji: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('mastodon does not support') + reject(err) + }) + } + + // ====================================== + // WebSocket + // ====================================== + public userSocket(): WebSocket { + return this.client.socket('/api/v1/streaming', 'user') + } + + public publicSocket(): WebSocket { + return this.client.socket('/api/v1/streaming', 'public') + } + + public localSocket(): WebSocket { + return this.client.socket('/api/v1/streaming', 'public:local') + } + + public tagSocket(tag: string): WebSocket { + return this.client.socket('/api/v1/streaming', 'hashtag', `tag=${tag}`) + } + + public listSocket(list_id: string): WebSocket { + return this.client.socket('/api/v1/streaming', 'list', `list=${list_id}`) + } + + public directSocket(): WebSocket { + return this.client.socket('/api/v1/streaming', 'direct') + } +} diff --git a/packages/megalodon/src/mastodon/api_client.ts b/packages/megalodon/src/mastodon/api_client.ts new file mode 100644 index 000000000..58f56d101 --- /dev/null +++ b/packages/megalodon/src/mastodon/api_client.ts @@ -0,0 +1,661 @@ +import axios, { AxiosResponse, AxiosRequestConfig } from 'axios' +import objectAssignDeep from 'object-assign-deep' + +import WebSocket from './web_socket' +import Response from '../response' +import { RequestCanceledError } from '../cancel' +import proxyAgent, { ProxyConfig } from '../proxy_config' +import { NO_REDIRECT, DEFAULT_SCOPE, DEFAULT_UA } from '../default' +import MastodonEntity from './entity' +import MegalodonEntity from '../entity' +import NotificationType, { UnknownNotificationTypeError } from '../notification' +import MastodonNotificationType from './notification' + +namespace MastodonAPI { + /** + * Interface + */ + export interface Interface { + get(path: string, params?: any, headers?: { [key: string]: string }, pathIsFullyQualified?: boolean): Promise> + put(path: string, params?: any, headers?: { [key: string]: string }): Promise> + putForm(path: string, params?: any, headers?: { [key: string]: string }): Promise> + patch(path: string, params?: any, headers?: { [key: string]: string }): Promise> + patchForm(path: string, params?: any, headers?: { [key: string]: string }): Promise> + post(path: string, params?: any, headers?: { [key: string]: string }): Promise> + postForm(path: string, params?: any, headers?: { [key: string]: string }): Promise> + del(path: string, params?: any, headers?: { [key: string]: string }): Promise> + cancel(): void + socket(path: string, stream: string, params?: string): WebSocket + } + + /** + * Mastodon API client. + * + * Using axios for request, you will handle promises. + */ + export class Client implements Interface { + static DEFAULT_SCOPE = DEFAULT_SCOPE + static DEFAULT_URL = 'https://mastodon.social' + static NO_REDIRECT = NO_REDIRECT + + private accessToken: string | null + private baseUrl: string + private userAgent: string + private abortController: AbortController + private proxyConfig: ProxyConfig | false = false + + /** + * @param baseUrl hostname or base URL + * @param accessToken access token from OAuth2 authorization + * @param userAgent UserAgent is specified in header on request. + * @param proxyConfig Proxy setting, or set false if don't use proxy. + */ + constructor( + baseUrl: string, + accessToken: string | null = null, + userAgent: string = DEFAULT_UA, + proxyConfig: ProxyConfig | false = false + ) { + this.accessToken = accessToken + this.baseUrl = baseUrl + this.userAgent = userAgent + this.proxyConfig = proxyConfig + this.abortController = new AbortController() + axios.defaults.signal = this.abortController.signal + } + + /** + * GET request to mastodon REST API. + * @param path relative path from baseUrl + * @param params Query parameters + * @param headers Request header object + */ + public async get( + path: string, + params = {}, + headers: { [key: string]: string } = {}, + pathIsFullyQualified = false + ): Promise> { + let options: AxiosRequestConfig = { + params: params, + headers: headers, + maxContentLength: Infinity, + maxBodyLength: Infinity + } + if (this.accessToken) { + options = objectAssignDeep({}, options, { + headers: { + Authorization: `Bearer ${this.accessToken}` + } + }) + } + if (this.proxyConfig) { + options = Object.assign(options, { + httpAgent: proxyAgent(this.proxyConfig), + httpsAgent: proxyAgent(this.proxyConfig) + }) + } + return axios + .get((pathIsFullyQualified ? '' : this.baseUrl) + path, options) + .catch((err: Error) => { + if (axios.isCancel(err)) { + throw new RequestCanceledError(err.message) + } else { + throw err + } + }) + .then((resp: AxiosResponse) => { + const res: Response = { + data: resp.data, + status: resp.status, + statusText: resp.statusText, + headers: resp.headers + } + return res + }) + } + + /** + * PUT request to mastodon REST API. + * @param path relative path from baseUrl + * @param params Form data. If you want to post file, please use FormData() + * @param headers Request header object + */ + public async put(path: string, params = {}, headers: { [key: string]: string } = {}): Promise> { + let options: AxiosRequestConfig = { + headers: headers, + maxContentLength: Infinity, + maxBodyLength: Infinity + } + if (this.accessToken) { + options = objectAssignDeep({}, options, { + headers: { + Authorization: `Bearer ${this.accessToken}` + } + }) + } + if (this.proxyConfig) { + options = Object.assign(options, { + httpAgent: proxyAgent(this.proxyConfig), + httpsAgent: proxyAgent(this.proxyConfig) + }) + } + return axios + .put(this.baseUrl + path, params, options) + .catch((err: Error) => { + if (axios.isCancel(err)) { + throw new RequestCanceledError(err.message) + } else { + throw err + } + }) + .then((resp: AxiosResponse) => { + const res: Response = { + data: resp.data, + status: resp.status, + statusText: resp.statusText, + headers: resp.headers + } + return res + }) + } + + /** + * PUT request to mastodon REST API for multipart. + * @param path relative path from baseUrl + * @param params Form data. If you want to post file, please use FormData() + * @param headers Request header object + */ + public async putForm(path: string, params = {}, headers: { [key: string]: string } = {}): Promise> { + let options: AxiosRequestConfig = { + headers: headers, + maxContentLength: Infinity, + maxBodyLength: Infinity + } + if (this.accessToken) { + options = objectAssignDeep({}, options, { + headers: { + Authorization: `Bearer ${this.accessToken}` + } + }) + } + if (this.proxyConfig) { + options = Object.assign(options, { + httpAgent: proxyAgent(this.proxyConfig), + httpsAgent: proxyAgent(this.proxyConfig) + }) + } + return axios + .putForm(this.baseUrl + path, params, options) + .catch((err: Error) => { + if (axios.isCancel(err)) { + throw new RequestCanceledError(err.message) + } else { + throw err + } + }) + .then((resp: AxiosResponse) => { + const res: Response = { + data: resp.data, + status: resp.status, + statusText: resp.statusText, + headers: resp.headers + } + return res + }) + } + + /** + * PATCH request to mastodon REST API. + * @param path relative path from baseUrl + * @param params Form data. If you want to post file, please use FormData() + * @param headers Request header object + */ + public async patch(path: string, params = {}, headers: { [key: string]: string } = {}): Promise> { + let options: AxiosRequestConfig = { + headers: headers, + maxContentLength: Infinity, + maxBodyLength: Infinity + } + if (this.accessToken) { + options = objectAssignDeep({}, options, { + headers: { + Authorization: `Bearer ${this.accessToken}` + } + }) + } + if (this.proxyConfig) { + options = Object.assign(options, { + httpAgent: proxyAgent(this.proxyConfig), + httpsAgent: proxyAgent(this.proxyConfig) + }) + } + return axios + .patch(this.baseUrl + path, params, options) + .catch((err: Error) => { + if (axios.isCancel(err)) { + throw new RequestCanceledError(err.message) + } else { + throw err + } + }) + .then((resp: AxiosResponse) => { + const res: Response = { + data: resp.data, + status: resp.status, + statusText: resp.statusText, + headers: resp.headers + } + return res + }) + } + + /** + * PATCH request to mastodon REST API for multipart. + * @param path relative path from baseUrl + * @param params Form data. If you want to post file, please use FormData() + * @param headers Request header object + */ + public async patchForm(path: string, params = {}, headers: { [key: string]: string } = {}): Promise> { + let options: AxiosRequestConfig = { + headers: headers, + maxContentLength: Infinity, + maxBodyLength: Infinity + } + if (this.accessToken) { + options = objectAssignDeep({}, options, { + headers: { + Authorization: `Bearer ${this.accessToken}` + } + }) + } + if (this.proxyConfig) { + options = Object.assign(options, { + httpAgent: proxyAgent(this.proxyConfig), + httpsAgent: proxyAgent(this.proxyConfig) + }) + } + return axios + .patchForm(this.baseUrl + path, params, options) + .catch((err: Error) => { + if (axios.isCancel(err)) { + throw new RequestCanceledError(err.message) + } else { + throw err + } + }) + .then((resp: AxiosResponse) => { + const res: Response = { + data: resp.data, + status: resp.status, + statusText: resp.statusText, + headers: resp.headers + } + return res + }) + } + + /** + * POST request to mastodon REST API. + * @param path relative path from baseUrl + * @param params Form data + * @param headers Request header object + */ + public async post(path: string, params = {}, headers: { [key: string]: string } = {}): Promise> { + let options: AxiosRequestConfig = { + headers: headers, + maxContentLength: Infinity, + maxBodyLength: Infinity + } + if (this.accessToken) { + options = objectAssignDeep({}, options, { + headers: { + Authorization: `Bearer ${this.accessToken}` + } + }) + } + if (this.proxyConfig) { + options = Object.assign(options, { + httpAgent: proxyAgent(this.proxyConfig), + httpsAgent: proxyAgent(this.proxyConfig) + }) + } + return axios.post(this.baseUrl + path, params, options).then((resp: AxiosResponse) => { + const res: Response = { + data: resp.data, + status: resp.status, + statusText: resp.statusText, + headers: resp.headers + } + return res + }) + } + + /** + * POST request to mastodon REST API for multipart. + * @param path relative path from baseUrl + * @param params Form data + * @param headers Request header object + */ + public async postForm(path: string, params = {}, headers: { [key: string]: string } = {}): Promise> { + let options: AxiosRequestConfig = { + headers: headers, + maxContentLength: Infinity, + maxBodyLength: Infinity + } + if (this.accessToken) { + options = objectAssignDeep({}, options, { + headers: { + Authorization: `Bearer ${this.accessToken}` + } + }) + } + if (this.proxyConfig) { + options = Object.assign(options, { + httpAgent: proxyAgent(this.proxyConfig), + httpsAgent: proxyAgent(this.proxyConfig) + }) + } + return axios.postForm(this.baseUrl + path, params, options).then((resp: AxiosResponse) => { + const res: Response = { + data: resp.data, + status: resp.status, + statusText: resp.statusText, + headers: resp.headers + } + return res + }) + } + + /** + * DELETE request to mastodon REST API. + * @param path relative path from baseUrl + * @param params Form data + * @param headers Request header object + */ + public async del(path: string, params = {}, headers: { [key: string]: string } = {}): Promise> { + let options: AxiosRequestConfig = { + data: params, + headers: headers, + maxContentLength: Infinity, + maxBodyLength: Infinity + } + if (this.accessToken) { + options = objectAssignDeep({}, options, { + headers: { + Authorization: `Bearer ${this.accessToken}` + } + }) + } + if (this.proxyConfig) { + options = Object.assign(options, { + httpAgent: proxyAgent(this.proxyConfig), + httpsAgent: proxyAgent(this.proxyConfig) + }) + } + return axios + .delete(this.baseUrl + path, options) + .catch((err: Error) => { + if (axios.isCancel(err)) { + throw new RequestCanceledError(err.message) + } else { + throw err + } + }) + .then((resp: AxiosResponse) => { + const res: Response = { + data: resp.data, + status: resp.status, + statusText: resp.statusText, + headers: resp.headers + } + return res + }) + } + + /** + * Cancel all requests in this instance. + * @returns void + */ + public cancel(): void { + return this.abortController.abort() + } + + /** + * Get connection and receive websocket connection for Pleroma API. + * + * @param path relative path from baseUrl: normally it is `/streaming`. + * @param stream Stream name, please refer: https://git.pleroma.social/pleroma/pleroma/blob/develop/lib/pleroma/web/mastodon_api/mastodon_socket.ex#L19-28 + * @returns WebSocket, which inherits from EventEmitter + */ + public socket(path: string, stream: string, params?: string): WebSocket { + if (!this.accessToken) { + throw new Error('accessToken is required') + } + const url = this.baseUrl + path + const streaming = new WebSocket(url, stream, params, this.accessToken, this.userAgent, this.proxyConfig) + process.nextTick(() => { + streaming.start() + }) + return streaming + } + } + + export namespace Entity { + export type Account = MastodonEntity.Account + export type Activity = MastodonEntity.Activity + export type Announcement = MastodonEntity.Announcement + export type Application = MastodonEntity.Application + export type AsyncAttachment = MegalodonEntity.AsyncAttachment + export type Attachment = MastodonEntity.Attachment + export type Card = MastodonEntity.Card + export type Context = MastodonEntity.Context + export type Conversation = MastodonEntity.Conversation + export type Emoji = MastodonEntity.Emoji + export type FeaturedTag = MastodonEntity.FeaturedTag + export type Field = MastodonEntity.Field + export type Filter = MastodonEntity.Filter + export type History = MastodonEntity.History + export type IdentityProof = MastodonEntity.IdentityProof + export type Instance = MastodonEntity.Instance + export type List = MastodonEntity.List + export type Marker = MastodonEntity.Marker + export type Mention = MastodonEntity.Mention + export type Notification = MastodonEntity.Notification + export type Poll = MastodonEntity.Poll + export type PollOption = MastodonEntity.PollOption + export type Preferences = MastodonEntity.Preferences + export type PushSubscription = MastodonEntity.PushSubscription + export type Relationship = MastodonEntity.Relationship + export type Report = MastodonEntity.Report + export type Results = MastodonEntity.Results + export type Role = MastodonEntity.Role + export type ScheduledStatus = MastodonEntity.ScheduledStatus + export type Source = MastodonEntity.Source + export type Stats = MastodonEntity.Stats + export type Status = MastodonEntity.Status + export type StatusParams = MastodonEntity.StatusParams + export type StatusSource = MastodonEntity.StatusSource + export type Tag = MastodonEntity.Tag + export type Token = MastodonEntity.Token + export type URLs = MastodonEntity.URLs + } + + export namespace Converter { + export const encodeNotificationType = ( + t: MegalodonEntity.NotificationType + ): MastodonEntity.NotificationType | UnknownNotificationTypeError => { + switch (t) { + case NotificationType.Follow: + return MastodonNotificationType.Follow + case NotificationType.Favourite: + return MastodonNotificationType.Favourite + case NotificationType.Reblog: + return MastodonNotificationType.Reblog + case NotificationType.Mention: + return MastodonNotificationType.Mention + case NotificationType.FollowRequest: + return MastodonNotificationType.FollowRequest + case NotificationType.Status: + return MastodonNotificationType.Status + case NotificationType.PollExpired: + return MastodonNotificationType.Poll + case NotificationType.Update: + return MastodonNotificationType.Update + case NotificationType.AdminSignup: + return MastodonNotificationType.AdminSignup + case NotificationType.AdminReport: + return MastodonNotificationType.AdminReport + default: + return new UnknownNotificationTypeError() + } + } + + export const decodeNotificationType = ( + t: MastodonEntity.NotificationType + ): MegalodonEntity.NotificationType | UnknownNotificationTypeError => { + switch (t) { + case MastodonNotificationType.Follow: + return NotificationType.Follow + case MastodonNotificationType.Favourite: + return NotificationType.Favourite + case MastodonNotificationType.Mention: + return NotificationType.Mention + case MastodonNotificationType.Reblog: + return NotificationType.Reblog + case MastodonNotificationType.FollowRequest: + return NotificationType.FollowRequest + case MastodonNotificationType.Status: + return NotificationType.Status + case MastodonNotificationType.Poll: + return NotificationType.PollExpired + case MastodonNotificationType.Update: + return NotificationType.Update + case MastodonNotificationType.AdminSignup: + return NotificationType.AdminSignup + case MastodonNotificationType.AdminReport: + return NotificationType.AdminReport + default: + return new UnknownNotificationTypeError() + } + } + + export const account = (a: Entity.Account): MegalodonEntity.Account => a + export const activity = (a: Entity.Activity): MegalodonEntity.Activity => a + export const announcement = (a: Entity.Announcement): MegalodonEntity.Announcement => a + export const application = (a: Entity.Application): MegalodonEntity.Application => a + export const attachment = (a: Entity.Attachment): MegalodonEntity.Attachment => a + export const async_attachment = (a: Entity.AsyncAttachment) => { + if (a.url) { + return { + id: a.id, + type: a.type, + url: a.url!, + remote_url: a.remote_url, + preview_url: a.preview_url, + text_url: a.text_url, + meta: a.meta, + description: a.description, + blurhash: a.blurhash + } as MegalodonEntity.Attachment + } else { + return a as MegalodonEntity.AsyncAttachment + } + } + export const card = (c: Entity.Card): MegalodonEntity.Card => c + export const context = (c: Entity.Context): MegalodonEntity.Context => ({ + ancestors: Array.isArray(c.ancestors) ? c.ancestors.map(a => status(a)) : [], + descendants: Array.isArray(c.descendants) ? c.descendants.map(d => status(d)) : [] + }) + export const conversation = (c: Entity.Conversation): MegalodonEntity.Conversation => ({ + id: c.id, + accounts: Array.isArray(c.accounts) ? c.accounts.map(a => account(a)) : [], + last_status: c.last_status ? status(c.last_status) : null, + unread: c.unread + }) + export const emoji = (e: Entity.Emoji): MegalodonEntity.Emoji => e + export const featured_tag = (e: Entity.FeaturedTag): MegalodonEntity.FeaturedTag => e + export const field = (f: Entity.Field): MegalodonEntity.Field => f + export const filter = (f: Entity.Filter): MegalodonEntity.Filter => f + export const history = (h: Entity.History): MegalodonEntity.History => h + export const identity_proof = (i: Entity.IdentityProof): MegalodonEntity.IdentityProof => i + export const instance = (i: Entity.Instance): MegalodonEntity.Instance => i + export const list = (l: Entity.List): MegalodonEntity.List => l + export const marker = (m: Entity.Marker | Record): MegalodonEntity.Marker | Record => m + export const mention = (m: Entity.Mention): MegalodonEntity.Mention => m + export const notification = (n: Entity.Notification): MegalodonEntity.Notification | UnknownNotificationTypeError => { + const notificationType = decodeNotificationType(n.type) + if (notificationType instanceof UnknownNotificationTypeError) return notificationType + if (n.status) { + return { + account: account(n.account), + created_at: n.created_at, + id: n.id, + status: status(n.status), + type: notificationType + } + } else { + return { + account: account(n.account), + created_at: n.created_at, + id: n.id, + type: notificationType + } + } + } + export const poll = (p: Entity.Poll): MegalodonEntity.Poll => p + export const poll_option = (p: Entity.PollOption): MegalodonEntity.PollOption => p + export const preferences = (p: Entity.Preferences): MegalodonEntity.Preferences => p + export const push_subscription = (p: Entity.PushSubscription): MegalodonEntity.PushSubscription => p + export const relationship = (r: Entity.Relationship): MegalodonEntity.Relationship => r + export const report = (r: Entity.Report): MegalodonEntity.Report => r + export const results = (r: Entity.Results): MegalodonEntity.Results => ({ + accounts: Array.isArray(r.accounts) ? r.accounts.map(a => account(a)) : [], + statuses: Array.isArray(r.statuses) ? r.statuses.map(s => status(s)) : [], + hashtags: Array.isArray(r.hashtags) ? r.hashtags.map(h => tag(h)) : [] + }) + export const scheduled_status = (s: Entity.ScheduledStatus): MegalodonEntity.ScheduledStatus => s + export const source = (s: Entity.Source): MegalodonEntity.Source => s + export const stats = (s: Entity.Stats): MegalodonEntity.Stats => s + export const status = (s: Entity.Status): MegalodonEntity.Status => ({ + id: s.id, + uri: s.uri, + url: s.url, + account: account(s.account), + in_reply_to_id: s.in_reply_to_id, + in_reply_to_account_id: s.in_reply_to_account_id, + reblog: s.reblog ? status(s.reblog) : s.quote ? status(s.quote) : null, + content: s.content, + plain_content: null, + created_at: s.created_at, + emojis: Array.isArray(s.emojis) ? s.emojis.map(e => emoji(e)) : [], + replies_count: s.replies_count, + reblogs_count: s.reblogs_count, + favourites_count: s.favourites_count, + reblogged: s.reblogged, + favourited: s.favourited, + muted: s.muted, + sensitive: s.sensitive, + spoiler_text: s.spoiler_text, + visibility: s.visibility, + media_attachments: Array.isArray(s.media_attachments) ? s.media_attachments.map(m => attachment(m)) : [], + mentions: Array.isArray(s.mentions) ? s.mentions.map(m => mention(m)) : [], + tags: s.tags, + card: s.card ? card(s.card) : null, + poll: s.poll ? poll(s.poll) : null, + application: s.application ? application(s.application) : null, + language: s.language, + pinned: s.pinned, + emoji_reactions: [], + bookmarked: s.bookmarked ? s.bookmarked : false, + // Now quote is supported only fedibird.com. + quote: s.quote !== undefined && s.quote !== null + }) + export const status_params = (s: Entity.StatusParams): MegalodonEntity.StatusParams => s + export const status_source = (s: Entity.StatusSource): MegalodonEntity.StatusSource => s + export const tag = (t: Entity.Tag): MegalodonEntity.Tag => t + export const token = (t: Entity.Token): MegalodonEntity.Token => t + export const urls = (u: Entity.URLs): MegalodonEntity.URLs => u + } +} +export default MastodonAPI diff --git a/packages/megalodon/src/mastodon/entities/account.ts b/packages/megalodon/src/mastodon/entities/account.ts new file mode 100644 index 000000000..9055fdd91 --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/account.ts @@ -0,0 +1,35 @@ +/// +/// +/// +/// +namespace MastodonEntity { + export type Account = { + id: string + username: string + acct: string + display_name: string + locked: boolean + discoverable?: boolean + group: boolean | null + noindex: boolean | null + suspended: boolean | null + limited: boolean | null + created_at: string + followers_count: number + following_count: number + statuses_count: number + note: string + url: string + avatar: string + avatar_static: string + header: string + header_static: string + emojis: Array + moved: Account | null + fields: Array + bot: boolean + source?: Source + role?: Role + mute_expires_at?: string + } +} diff --git a/packages/megalodon/src/mastodon/entities/activity.ts b/packages/megalodon/src/mastodon/entities/activity.ts new file mode 100644 index 000000000..3e84c9df0 --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/activity.ts @@ -0,0 +1,8 @@ +namespace MastodonEntity { + export type Activity = { + week: string + statuses: string + logins: string + registrations: string + } +} diff --git a/packages/megalodon/src/mastodon/entities/announcement.ts b/packages/megalodon/src/mastodon/entities/announcement.ts new file mode 100644 index 000000000..426112e76 --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/announcement.ts @@ -0,0 +1,40 @@ +/// + +namespace MastodonEntity { + export type Announcement = { + id: string + content: string + starts_at: string | null + ends_at: string | null + published: boolean + all_day: boolean + published_at: string + updated_at: string + read: boolean | null + mentions: Array + statuses: Array + tags: Array + emojis: Array + reactions: Array + } + + export type AnnouncementAccount = { + id: string + username: string + url: string + acct: string + } + + export type AnnouncementStatus = { + id: string + url: string + } + + export type AnnouncementReaction = { + name: string + count: number + me: boolean | null + url: string | null + static_url: string | null + } +} diff --git a/packages/megalodon/src/mastodon/entities/application.ts b/packages/megalodon/src/mastodon/entities/application.ts new file mode 100644 index 000000000..a3f07997e --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/application.ts @@ -0,0 +1,7 @@ +namespace MastodonEntity { + export type Application = { + name: string + website?: string | null + vapid_key?: string | null + } +} diff --git a/packages/megalodon/src/mastodon/entities/async_attachment.ts b/packages/megalodon/src/mastodon/entities/async_attachment.ts new file mode 100644 index 000000000..45f574d64 --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/async_attachment.ts @@ -0,0 +1,14 @@ +/// +namespace MastodonEntity { + export type AsyncAttachment = { + id: string + type: 'unknown' | 'image' | 'gifv' | 'video' | 'audio' + url: string | null + remote_url: string | null + preview_url: string + text_url: string | null + meta: Meta | null + description: string | null + blurhash: string | null + } +} diff --git a/packages/megalodon/src/mastodon/entities/attachment.ts b/packages/megalodon/src/mastodon/entities/attachment.ts new file mode 100644 index 000000000..ec51c5bca --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/attachment.ts @@ -0,0 +1,49 @@ +namespace MastodonEntity { + export type Sub = { + // For Image, Gifv, and Video + width?: number + height?: number + size?: string + aspect?: number + + // For Gifv and Video + frame_rate?: string + + // For Audio, Gifv, and Video + duration?: number + bitrate?: number + } + + export type Focus = { + x: number + y: number + } + + export type Meta = { + original?: Sub + small?: Sub + focus?: Focus + length?: string + duration?: number + fps?: number + size?: string + width?: number + height?: number + aspect?: number + audio_encode?: string + audio_bitrate?: string + audio_channel?: string + } + + export type Attachment = { + id: string + type: 'unknown' | 'image' | 'gifv' | 'video' | 'audio' + url: string + remote_url: string | null + preview_url: string | null + text_url: string | null + meta: Meta | null + description: string | null + blurhash: string | null + } +} diff --git a/packages/megalodon/src/mastodon/entities/card.ts b/packages/megalodon/src/mastodon/entities/card.ts new file mode 100644 index 000000000..9058de7f7 --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/card.ts @@ -0,0 +1,18 @@ +namespace MastodonEntity { + export type Card = { + url: string + title: string + description: string + type: 'link' | 'photo' | 'video' | 'rich' + image: string | null + author_name: string + author_url: string + provider_name: string + provider_url: string + html: string + width: number + height: number + embed_url: string + blurhash: string | null + } +} diff --git a/packages/megalodon/src/mastodon/entities/context.ts b/packages/megalodon/src/mastodon/entities/context.ts new file mode 100644 index 000000000..c2b6e2682 --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/context.ts @@ -0,0 +1,8 @@ +/// + +namespace MastodonEntity { + export type Context = { + ancestors: Array + descendants: Array + } +} diff --git a/packages/megalodon/src/mastodon/entities/conversation.ts b/packages/megalodon/src/mastodon/entities/conversation.ts new file mode 100644 index 000000000..0ee3f1d7f --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/conversation.ts @@ -0,0 +1,11 @@ +/// +/// + +namespace MastodonEntity { + export type Conversation = { + id: string + accounts: Array + last_status: Status | null + unread: boolean + } +} diff --git a/packages/megalodon/src/mastodon/entities/emoji.ts b/packages/megalodon/src/mastodon/entities/emoji.ts new file mode 100644 index 000000000..543491432 --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/emoji.ts @@ -0,0 +1,9 @@ +namespace MastodonEntity { + export type Emoji = { + shortcode: string + static_url: string + url: string + visible_in_picker: boolean + category?: string + } +} diff --git a/packages/megalodon/src/mastodon/entities/featured_tag.ts b/packages/megalodon/src/mastodon/entities/featured_tag.ts new file mode 100644 index 000000000..a2628b98c --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/featured_tag.ts @@ -0,0 +1,8 @@ +namespace MastodonEntity { + export type FeaturedTag = { + id: string + name: string + statuses_count: number + last_status_at: string + } +} diff --git a/packages/megalodon/src/mastodon/entities/field.ts b/packages/megalodon/src/mastodon/entities/field.ts new file mode 100644 index 000000000..b6ada5d13 --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/field.ts @@ -0,0 +1,7 @@ +namespace MastodonEntity { + export type Field = { + name: string + value: string + verified_at: string | null + } +} diff --git a/packages/megalodon/src/mastodon/entities/filter.ts b/packages/megalodon/src/mastodon/entities/filter.ts new file mode 100644 index 000000000..1e17e61b2 --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/filter.ts @@ -0,0 +1,12 @@ +namespace MastodonEntity { + export type Filter = { + id: string + phrase: string + context: Array + expires_at: string | null + irreversible: boolean + whole_word: boolean + } + + export type FilterContext = string +} diff --git a/packages/megalodon/src/mastodon/entities/history.ts b/packages/megalodon/src/mastodon/entities/history.ts new file mode 100644 index 000000000..cc1a3b4fb --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/history.ts @@ -0,0 +1,7 @@ +namespace MastodonEntity { + export type History = { + day: string + uses: number + accounts: number + } +} diff --git a/packages/megalodon/src/mastodon/entities/identity_proof.ts b/packages/megalodon/src/mastodon/entities/identity_proof.ts new file mode 100644 index 000000000..a4dab9eaf --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/identity_proof.ts @@ -0,0 +1,9 @@ +namespace MastodonEntity { + export type IdentityProof = { + provider: string + provider_username: string + updated_at: string + proof_url: string + profile_url: string + } +} diff --git a/packages/megalodon/src/mastodon/entities/instance.ts b/packages/megalodon/src/mastodon/entities/instance.ts new file mode 100644 index 000000000..842e2c6bb --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/instance.ts @@ -0,0 +1,49 @@ +/// +/// +/// + +namespace MastodonEntity { + export type Instance = { + uri: string + title: string + description: string + email: string + version: string + thumbnail: string | null + urls: URLs + stats: Stats + languages: Array + registrations: boolean + approval_required: boolean + invites_enabled: boolean + max_toot_chars?: number + configuration: { + statuses: { + max_characters: number + max_media_attachments: number + characters_reserved_per_url: number + } + media_attachments: { + supported_mime_types: Array + image_size_limit: number + image_matrix_limit: number + video_size_limit: number + video_frame_limit: number + video_matrix_limit: number + } + polls: { + max_options: number + max_characters_per_option: number + min_expiration: number + max_expiration: number + } + } + contact_account: Account + rules: Array + } + + export type InstanceRule = { + id: string + text: string + } +} diff --git a/packages/megalodon/src/mastodon/entities/list.ts b/packages/megalodon/src/mastodon/entities/list.ts new file mode 100644 index 000000000..503499839 --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/list.ts @@ -0,0 +1,9 @@ +namespace MastodonEntity { + export type List = { + id: string + title: string + replies_policy: RepliesPolicy + } + + export type RepliesPolicy = 'followed' | 'list' | 'none' +} diff --git a/packages/megalodon/src/mastodon/entities/marker.ts b/packages/megalodon/src/mastodon/entities/marker.ts new file mode 100644 index 000000000..1b0983e2b --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/marker.ts @@ -0,0 +1,14 @@ +namespace MastodonEntity { + export type Marker = { + home: { + last_read_id: string + version: number + updated_at: string + } + notifications: { + last_read_id: string + version: number + updated_at: string + } + } +} diff --git a/packages/megalodon/src/mastodon/entities/mention.ts b/packages/megalodon/src/mastodon/entities/mention.ts new file mode 100644 index 000000000..ddc99d93e --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/mention.ts @@ -0,0 +1,8 @@ +namespace MastodonEntity { + export type Mention = { + id: string + username: string + url: string + acct: string + } +} diff --git a/packages/megalodon/src/mastodon/entities/notification.ts b/packages/megalodon/src/mastodon/entities/notification.ts new file mode 100644 index 000000000..ad5519bae --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/notification.ts @@ -0,0 +1,14 @@ +/// +/// + +namespace MastodonEntity { + export type Notification = { + account: Account + created_at: string + id: string + status?: Status + type: NotificationType + } + + export type NotificationType = string +} diff --git a/packages/megalodon/src/mastodon/entities/poll.ts b/packages/megalodon/src/mastodon/entities/poll.ts new file mode 100644 index 000000000..eaf09050f --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/poll.ts @@ -0,0 +1,13 @@ +/// + +namespace MastodonEntity { + export type Poll = { + id: string + expires_at: string | null + expired: boolean + multiple: boolean + votes_count: number + options: Array + voted: boolean + } +} diff --git a/packages/megalodon/src/mastodon/entities/poll_option.ts b/packages/megalodon/src/mastodon/entities/poll_option.ts new file mode 100644 index 000000000..d3c14190f --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/poll_option.ts @@ -0,0 +1,6 @@ +namespace MastodonEntity { + export type PollOption = { + title: string + votes_count: number | null + } +} diff --git a/packages/megalodon/src/mastodon/entities/preferences.ts b/packages/megalodon/src/mastodon/entities/preferences.ts new file mode 100644 index 000000000..3c8cc953c --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/preferences.ts @@ -0,0 +1,9 @@ +namespace MastodonEntity { + export type Preferences = { + 'posting:default:visibility': 'public' | 'unlisted' | 'private' | 'direct' + 'posting:default:sensitive': boolean + 'posting:default:language': string | null + 'reading:expand:media': 'default' | 'show_all' | 'hide_all' + 'reading:expand:spoilers': boolean + } +} diff --git a/packages/megalodon/src/mastodon/entities/push_subscription.ts b/packages/megalodon/src/mastodon/entities/push_subscription.ts new file mode 100644 index 000000000..ad96ea685 --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/push_subscription.ts @@ -0,0 +1,16 @@ +namespace MastodonEntity { + export type Alerts = { + follow: boolean + favourite: boolean + mention: boolean + reblog: boolean + poll: boolean + } + + export type PushSubscription = { + id: string + endpoint: string + server_key: string + alerts: Alerts + } +} diff --git a/packages/megalodon/src/mastodon/entities/relationship.ts b/packages/megalodon/src/mastodon/entities/relationship.ts new file mode 100644 index 000000000..8e02df576 --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/relationship.ts @@ -0,0 +1,18 @@ +namespace MastodonEntity { + export type Relationship = { + id: string + following: boolean + followed_by: boolean + blocking: boolean + blocked_by: boolean + muting: boolean + muting_notifications: boolean + requested: boolean + domain_blocking: boolean + showing_reblogs: boolean + endorsed: boolean + notifying: boolean + note: string + languages: Array + } +} diff --git a/packages/megalodon/src/mastodon/entities/report.ts b/packages/megalodon/src/mastodon/entities/report.ts new file mode 100644 index 000000000..0eba265a3 --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/report.ts @@ -0,0 +1,17 @@ +/// + +namespace MastodonEntity { + export type Report = { + id: string + action_taken: boolean + action_taken_at: string | null + category: Category + comment: string + forwarded: boolean + status_ids: Array | null + rule_ids: Array | null + target_account: Account + } + + export type Category = 'spam' | 'violation' | 'other' +} diff --git a/packages/megalodon/src/mastodon/entities/results.ts b/packages/megalodon/src/mastodon/entities/results.ts new file mode 100644 index 000000000..a1c906543 --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/results.ts @@ -0,0 +1,11 @@ +/// +/// +/// + +namespace MastodonEntity { + export type Results = { + accounts: Array + statuses: Array + hashtags: Array + } +} diff --git a/packages/megalodon/src/mastodon/entities/role.ts b/packages/megalodon/src/mastodon/entities/role.ts new file mode 100644 index 000000000..ebfad59c1 --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/role.ts @@ -0,0 +1,5 @@ +namespace MastodonEntity { + export type Role = { + name: string + } +} diff --git a/packages/megalodon/src/mastodon/entities/scheduled_status.ts b/packages/megalodon/src/mastodon/entities/scheduled_status.ts new file mode 100644 index 000000000..2388311ac --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/scheduled_status.ts @@ -0,0 +1,10 @@ +/// +/// +namespace MastodonEntity { + export type ScheduledStatus = { + id: string + scheduled_at: string + params: StatusParams + media_attachments: Array + } +} diff --git a/packages/megalodon/src/mastodon/entities/source.ts b/packages/megalodon/src/mastodon/entities/source.ts new file mode 100644 index 000000000..c10460217 --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/source.ts @@ -0,0 +1,10 @@ +/// +namespace MastodonEntity { + export type Source = { + privacy: string | null + sensitive: boolean | null + language: string | null + note: string + fields: Array + } +} diff --git a/packages/megalodon/src/mastodon/entities/stats.ts b/packages/megalodon/src/mastodon/entities/stats.ts new file mode 100644 index 000000000..925da8501 --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/stats.ts @@ -0,0 +1,7 @@ +namespace MastodonEntity { + export type Stats = { + user_count: number + status_count: number + domain_count: number + } +} diff --git a/packages/megalodon/src/mastodon/entities/status.ts b/packages/megalodon/src/mastodon/entities/status.ts new file mode 100644 index 000000000..9624e9c72 --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/status.ts @@ -0,0 +1,49 @@ +/// +/// +/// +/// +/// +/// +/// +/// + +namespace MastodonEntity { + export type Status = { + id: string + uri: string + url: string + account: Account + in_reply_to_id: string | null + in_reply_to_account_id: string | null + reblog: Status | null + content: string + created_at: string + emojis: Emoji[] + replies_count: number + reblogs_count: number + favourites_count: number + reblogged: boolean | null + favourited: boolean | null + muted: boolean | null + sensitive: boolean + spoiler_text: string + visibility: 'public' | 'unlisted' | 'private' | 'direct' + media_attachments: Array + mentions: Array + tags: Array + card: Card | null + poll: Poll | null + application: Application | null + language: string | null + pinned: boolean | null + bookmarked?: boolean + // These parameters are unique parameters in fedibird.com for quote. + quote_id?: string + quote?: Status | null + } + + export type StatusTag = { + name: string + url: string + } +} diff --git a/packages/megalodon/src/mastodon/entities/status_params.ts b/packages/megalodon/src/mastodon/entities/status_params.ts new file mode 100644 index 000000000..1b6ffb7dd --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/status_params.ts @@ -0,0 +1,12 @@ +namespace MastodonEntity { + export type StatusParams = { + text: string + in_reply_to_id: string | null + media_ids: Array | null + sensitive: boolean | null + spoiler_text: string | null + visibility: 'public' | 'unlisted' | 'private' | 'direct' | null + scheduled_at: string | null + application_id: number + } +} diff --git a/packages/megalodon/src/mastodon/entities/status_source.ts b/packages/megalodon/src/mastodon/entities/status_source.ts new file mode 100644 index 000000000..f8ca42c03 --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/status_source.ts @@ -0,0 +1,7 @@ +namespace MastodonEntity { + export type StatusSource = { + id: string + text: string + spoiler_text: string + } +} diff --git a/packages/megalodon/src/mastodon/entities/tag.ts b/packages/megalodon/src/mastodon/entities/tag.ts new file mode 100644 index 000000000..8a10ad58b --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/tag.ts @@ -0,0 +1,10 @@ +/// + +namespace MastodonEntity { + export type Tag = { + name: string + url: string + history: Array + following?: boolean + } +} diff --git a/packages/megalodon/src/mastodon/entities/token.ts b/packages/megalodon/src/mastodon/entities/token.ts new file mode 100644 index 000000000..128663ecf --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/token.ts @@ -0,0 +1,8 @@ +namespace MastodonEntity { + export type Token = { + access_token: string + token_type: string + scope: string + created_at: number + } +} diff --git a/packages/megalodon/src/mastodon/entities/urls.ts b/packages/megalodon/src/mastodon/entities/urls.ts new file mode 100644 index 000000000..4f6b55a4c --- /dev/null +++ b/packages/megalodon/src/mastodon/entities/urls.ts @@ -0,0 +1,5 @@ +namespace MastodonEntity { + export type URLs = { + streaming_api: string + } +} diff --git a/packages/megalodon/src/mastodon/entity.ts b/packages/megalodon/src/mastodon/entity.ts new file mode 100644 index 000000000..dcafdfe74 --- /dev/null +++ b/packages/megalodon/src/mastodon/entity.ts @@ -0,0 +1,39 @@ +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// + +export default MastodonEntity diff --git a/packages/megalodon/src/mastodon/notification.ts b/packages/megalodon/src/mastodon/notification.ts new file mode 100644 index 000000000..b7551a019 --- /dev/null +++ b/packages/megalodon/src/mastodon/notification.ts @@ -0,0 +1,16 @@ +import MastodonEntity from './entity' + +namespace MastodonNotificationType { + export const Mention: MastodonEntity.NotificationType = 'mention' + export const Reblog: MastodonEntity.NotificationType = 'reblog' + export const Favourite: MastodonEntity.NotificationType = 'favourite' + export const Follow: MastodonEntity.NotificationType = 'follow' + export const Poll: MastodonEntity.NotificationType = 'poll' + export const FollowRequest: MastodonEntity.NotificationType = 'follow_request' + export const Status: MastodonEntity.NotificationType = 'status' + export const Update: MastodonEntity.NotificationType = 'update' + export const AdminSignup: MastodonEntity.NotificationType = 'admin.sign_up' + export const AdminReport: MastodonEntity.NotificationType = 'admin.report' +} + +export default MastodonNotificationType diff --git a/packages/megalodon/src/mastodon/web_socket.ts b/packages/megalodon/src/mastodon/web_socket.ts new file mode 100644 index 000000000..28bf38a66 --- /dev/null +++ b/packages/megalodon/src/mastodon/web_socket.ts @@ -0,0 +1,348 @@ +import WS from 'ws' +import dayjs, { Dayjs } from 'dayjs' +import { EventEmitter } from 'events' +import proxyAgent, { ProxyConfig } from '../proxy_config' +import { WebSocketInterface } from '../megalodon' +import MastodonAPI from './api_client' +import { UnknownNotificationTypeError } from '../notification' + +/** + * WebSocket + * Pleroma is not support streaming. It is support websocket instead of streaming. + * So this class connect to Phoenix websocket for Pleroma. + */ +export default class WebSocket extends EventEmitter implements WebSocketInterface { + public url: string + public stream: string + public params: string | null + public parser: Parser + public headers: { [key: string]: string } + public proxyConfig: ProxyConfig | false = false + private _accessToken: string + private _reconnectInterval: number + private _reconnectMaxAttempts: number + private _reconnectCurrentAttempts: number + private _connectionClosed: boolean + private _client: WS | null + private _pongReceivedTimestamp: Dayjs + private _heartbeatInterval: number = 60000 + private _pongWaiting: boolean = false + + /** + * @param url Full url of websocket: e.g. https://pleroma.io/api/v1/streaming + * @param stream Stream name, please refer: https://git.pleroma.social/pleroma/pleroma/blob/develop/lib/pleroma/web/mastodon_api/mastodon_socket.ex#L19-28 + * @param accessToken The access token. + * @param userAgent The specified User Agent. + * @param proxyConfig Proxy setting, or set false if don't use proxy. + */ + constructor( + url: string, + stream: string, + params: string | undefined, + accessToken: string, + userAgent: string, + proxyConfig: ProxyConfig | false = false + ) { + super() + this.url = url + this.stream = stream + if (params === undefined) { + this.params = null + } else { + this.params = params + } + this.parser = new Parser() + this.headers = { + 'User-Agent': userAgent + } + this.proxyConfig = proxyConfig + this._accessToken = accessToken + this._reconnectInterval = 10000 + this._reconnectMaxAttempts = Infinity + this._reconnectCurrentAttempts = 0 + this._connectionClosed = false + this._client = null + this._pongReceivedTimestamp = dayjs() + } + + /** + * Start websocket connection. + */ + public start() { + this._connectionClosed = false + this._resetRetryParams() + this._startWebSocketConnection() + } + + /** + * Reset connection and start new websocket connection. + */ + private _startWebSocketConnection() { + this._resetConnection() + this._setupParser() + this._client = this._connect(this.url, this.stream, this.params, this._accessToken, this.headers, this.proxyConfig) + this._bindSocket(this._client) + } + + /** + * Stop current connection. + */ + public stop() { + this._connectionClosed = true + this._resetConnection() + this._resetRetryParams() + } + + /** + * Clean up current connection, and listeners. + */ + private _resetConnection() { + if (this._client) { + this._client.close(1000) + this._client.removeAllListeners() + this._client = null + } + + if (this.parser) { + this.parser.removeAllListeners() + } + } + + /** + * Resets the parameters used in reconnect. + */ + private _resetRetryParams() { + this._reconnectCurrentAttempts = 0 + } + + /** + * Reconnects to the same endpoint. + */ + private _reconnect() { + setTimeout(() => { + // Skip reconnect when client is connecting. + // https://github.com/websockets/ws/blob/7.2.1/lib/websocket.js#L365 + if (this._client && this._client.readyState === WS.CONNECTING) { + return + } + + if (this._reconnectCurrentAttempts < this._reconnectMaxAttempts) { + this._reconnectCurrentAttempts++ + this._clearBinding() + if (this._client) { + // In reconnect, we want to close the connection immediately, + // because recoonect is necessary when some problems occur. + this._client.terminate() + } + // Call connect methods + console.log('Reconnecting') + this._client = this._connect(this.url, this.stream, this.params, this._accessToken, this.headers, this.proxyConfig) + this._bindSocket(this._client) + } + }, this._reconnectInterval) + } + + /** + * @param url Base url of streaming endpoint. + * @param stream The specified stream name. + * @param accessToken Access token. + * @param headers The specified headers. + * @param proxyConfig Proxy setting, or set false if don't use proxy. + * @return A WebSocket instance. + */ + private _connect( + url: string, + stream: string, + params: string | null, + accessToken: string, + headers: { [key: string]: string }, + proxyConfig: ProxyConfig | false + ): WS { + const parameter: Array = [`stream=${stream}`] + + if (params) { + parameter.push(params) + } + + if (accessToken !== null) { + parameter.push(`access_token=${accessToken}`) + } + const requestURL: string = `${url}/?${parameter.join('&')}` + let options: WS.ClientOptions = { + headers: headers + } + if (proxyConfig) { + options = Object.assign(options, { + agent: proxyAgent(proxyConfig) + }) + } + + const cli: WS = new WS(requestURL, options) + return cli + } + + /** + * Clear binding event for web socket client. + */ + private _clearBinding() { + if (this._client) { + this._client.removeAllListeners('close') + this._client.removeAllListeners('pong') + this._client.removeAllListeners('open') + this._client.removeAllListeners('message') + this._client.removeAllListeners('error') + } + } + + /** + * Bind event for web socket client. + * @param client A WebSocket instance. + */ + private _bindSocket(client: WS) { + client.on('close', (code: number, _reason: Buffer) => { + // Refer the code: https://tools.ietf.org/html/rfc6455#section-7.4 + if (code === 1000) { + this.emit('close', {}) + } else { + console.log(`Closed connection with ${code}`) + // If already called close method, it does not retry. + if (!this._connectionClosed) { + this._reconnect() + } + } + }) + client.on('pong', () => { + this._pongWaiting = false + this.emit('pong', {}) + this._pongReceivedTimestamp = dayjs() + // It is required to anonymous function since get this scope in checkAlive. + setTimeout(() => this._checkAlive(this._pongReceivedTimestamp), this._heartbeatInterval) + }) + client.on('open', () => { + this.emit('connect', {}) + // Call first ping event. + setTimeout(() => { + client.ping('') + }, 10000) + }) + client.on('message', (data: WS.Data, isBinary: boolean) => { + this.parser.parse(data, isBinary) + }) + client.on('error', (err: Error) => { + this.emit('error', err) + }) + } + + /** + * Set up parser when receive message. + */ + private _setupParser() { + this.parser.on('update', (status: MastodonAPI.Entity.Status) => { + this.emit('update', MastodonAPI.Converter.status(status)) + }) + this.parser.on('notification', (notification: MastodonAPI.Entity.Notification) => { + const n = MastodonAPI.Converter.notification(notification) + if (n instanceof UnknownNotificationTypeError) { + console.warn(`Unknown notification event has received: ${notification}`) + } else { + this.emit('notification', n) + } + }) + this.parser.on('delete', (id: string) => { + this.emit('delete', id) + }) + this.parser.on('conversation', (conversation: MastodonAPI.Entity.Conversation) => { + this.emit('conversation', MastodonAPI.Converter.conversation(conversation)) + }) + this.parser.on('status_update', (status: MastodonAPI.Entity.Status) => { + this.emit('status_update', MastodonAPI.Converter.status(status)) + }) + this.parser.on('error', (err: Error) => { + this.emit('parser-error', err) + }) + this.parser.on('heartbeat', _ => { + this.emit('heartbeat', 'heartbeat') + }) + } + + /** + * Call ping and wait to pong. + */ + private _checkAlive(timestamp: Dayjs) { + const now: Dayjs = dayjs() + // Block multiple calling, if multiple pong event occur. + // It the duration is less than interval, through ping. + if (now.diff(timestamp) > this._heartbeatInterval - 1000 && !this._connectionClosed) { + // Skip ping when client is connecting. + // https://github.com/websockets/ws/blob/7.2.1/lib/websocket.js#L289 + if (this._client && this._client.readyState !== WS.CONNECTING) { + this._pongWaiting = true + this._client.ping('') + setTimeout(() => { + if (this._pongWaiting) { + this._pongWaiting = false + this._reconnect() + } + }, 10000) + } + } + } +} + +/** + * Parser + * This class provides parser for websocket message. + */ +export class Parser extends EventEmitter { + /** + * @param message Message body of websocket. + */ + public parse(data: WS.Data, isBinary: boolean) { + const message = isBinary ? data : data.toString() + if (typeof message !== 'string') { + this.emit('heartbeat', {}) + return + } + + if (message === '') { + this.emit('heartbeat', {}) + return + } + + let event = '' + let payload = '' + let mes = {} + try { + const obj = JSON.parse(message) + event = obj.event + payload = obj.payload + mes = JSON.parse(payload) + } catch (err) { + // delete event does not have json object + if (event !== 'delete') { + this.emit('error', new Error(`Error parsing websocket reply: ${message}, error message: ${err}`)) + return + } + } + + switch (event) { + case 'update': + this.emit('update', mes as MastodonAPI.Entity.Status) + break + case 'notification': + this.emit('notification', mes as MastodonAPI.Entity.Notification) + break + case 'conversation': + this.emit('conversation', mes as MastodonAPI.Entity.Conversation) + break + case 'delete': + this.emit('delete', payload) + break + case 'status.update': + this.emit('status_update', mes as MastodonAPI.Entity.Status) + break + default: + this.emit('error', new Error(`Unknown event has received: ${message}`)) + } + } +} diff --git a/packages/megalodon/src/megalodon.ts b/packages/megalodon/src/megalodon.ts index ad4d863ab..19cd5c555 100644 --- a/packages/megalodon/src/megalodon.ts +++ b/packages/megalodon/src/megalodon.ts @@ -1,183 +1,166 @@ -import Response from "./response"; -import OAuth from "./oauth"; -import proxyAgent, { ProxyConfig } from "./proxy_config"; -import Entity from "./entity"; -import axios, { AxiosRequestConfig } from "axios"; -import Misskey from "./misskey"; -import { DEFAULT_UA } from "./default"; +import Response from './response' +import OAuth from './oauth' +import Pleroma from './pleroma' +import { ProxyConfig } from './proxy_config' +import Mastodon from './mastodon' +import Entity from './entity' +import Misskey from './misskey' +import Friendica from './friendica' export interface WebSocketInterface { - start(): void; - stop(): void; - // EventEmitter - on(event: string | symbol, listener: (...args: any[]) => void): this; - once(event: string | symbol, listener: (...args: any[]) => void): this; - removeListener( - event: string | symbol, - listener: (...args: any[]) => void, - ): this; - removeAllListeners(event?: string | symbol): this; + start(): void + stop(): void + // EventEmitter + on(event: string | symbol, listener: (...args: any[]) => void): this + once(event: string | symbol, listener: (...args: any[]) => void): this + removeListener(event: string | symbol, listener: (...args: any[]) => void): this + removeAllListeners(event?: string | symbol): this } export interface MegalodonInterface { - /** - * Cancel all requests in this instance. - * - * @return void - */ - cancel(): void; + /** + * Cancel all requests in this instance. + * + * @return void + */ + cancel(): void - /** - * First, call createApp to get client_id and client_secret. - * Next, call generateAuthUrl to get authorization url. - * @param client_name Form Data, which is sent to /api/v1/apps - * @param options Form Data, which is sent to /api/v1/apps. and properties should be **snake_case** - */ - registerApp( - client_name: string, - options: Partial<{ - scopes: Array; - redirect_uris: string; - website: string; - }>, - ): Promise; + /** + * First, call createApp to get client_id and client_secret. + * Next, call generateAuthUrl to get authorization url. + * + * @param client_name Form Data, which is sent to /api/v1/apps + * @param options Form Data, which is sent to /api/v1/apps. and properties should be **snake_case** + */ + registerApp( + client_name: string, + options: Partial<{ scopes: Array; redirect_uris: string; website: string }> + ): Promise - /** - * Call /api/v1/apps - * - * Create an application. - * @param client_name your application's name - * @param options Form Data - */ - createApp( - client_name: string, - options: Partial<{ - scopes: Array; - redirect_uris: string; - website: string; - }>, - ): Promise; + /** + * Create an application. + * + * @param client_name your application's name + * @param options Form Data + */ + createApp( + client_name: string, + options: Partial<{ scopes: Array; redirect_uris: string; website: string }> + ): Promise - // ====================================== - // apps - // ====================================== - /** - * GET /api/v1/apps/verify_credentials - * - * @return An Application - */ - verifyAppCredentials(): Promise>; + // ====================================== + // apps + // ====================================== + /** + * Verify the app works. + * + * @return An Application + */ + verifyAppCredentials(): Promise> - // ====================================== - // apps/oauth - // ====================================== + // ====================================== + // apps/oauth + // ====================================== + /** + * Fetch OAuth access token. + * Get an access token based client_id and client_secret and authorization code. + * + * @param client_id will be generated by #createApp or #registerApp + * @param client_secret will be generated by #createApp or #registerApp + * @param code will be generated by the link of #generateAuthUrl or #registerApp + * @param redirect_uri must be the same uri as the time when you register your OAuth application + */ + fetchAccessToken(client_id: string | null, client_secret: string, code: string, redirect_uri?: string): Promise - /** - * POST /oauth/token - * - * Fetch OAuth access token. - * Get an access token based client_id and client_secret and authorization code. - * @param client_id will be generated by #createApp or #registerApp - * @param client_secret will be generated by #createApp or #registerApp - * @param code will be generated by the link of #generateAuthUrl or #registerApp - * @param redirect_uri must be the same uri as the time when you register your OAuth application - */ - fetchAccessToken( - client_id: string | null, - client_secret: string, - code: string, - redirect_uri?: string, - ): Promise; + /** + * Refresh OAuth access token. + * Send refresh token and get new access token. + * + * @param client_id will be generated by #createApp or #registerApp + * @param client_secret will be generated by #createApp or #registerApp + * @param refresh_token will be get #fetchAccessToken + */ + refreshToken(client_id: string, client_secret: string, refresh_token: string): Promise - /** - * POST /oauth/token - * - * Refresh OAuth access token. - * Send refresh token and get new access token. - * @param client_id will be generated by #createApp or #registerApp - * @param client_secret will be generated by #createApp or #registerApp - * @param refresh_token will be get #fetchAccessToken - */ - refreshToken( - client_id: string, - client_secret: string, - refresh_token: string, - ): Promise; + /** + * Revoke an OAuth token. + * + * @param client_id will be generated by #createApp or #registerApp + * @param client_secret will be generated by #createApp or #registerApp + * @param token will be get #fetchAccessToken + */ + revokeToken(client_id: string, client_secret: string, token: string): Promise> - /** - * POST /oauth/revoke - * - * Revoke an OAuth token. - * @param client_id will be generated by #createApp or #registerApp - * @param client_secret will be generated by #createApp or #registerApp - * @param token will be get #fetchAccessToken - */ - revokeToken( - client_id: string, - client_secret: string, - token: string, - ): Promise>; - - // ====================================== - // accounts - // ====================================== - /** - * POST /api/v1/accounts - * - * @param username Username for the account. - * @param email Email for the account. - * @param password Password for the account. - * @param agreement Whether the user agrees to the local rules, terms, and policies. - * @param locale The language of the confirmation email that will be sent - * @param reason Text that will be reviewed by moderators if registrations require manual approval. - * @return An account token. - */ - registerAccount( - username: string, - email: string, - password: string, - agreement: boolean, - locale: string, - reason?: string | null, - ): Promise>; - /** - * GET /api/v1/accounts/verify_credentials - * - * @return Account. - */ - verifyAccountCredentials(): Promise>; - /** - * PATCH /api/v1/accounts/update_credentials - * - * @return An account. - */ - updateCredentials(options?: { - discoverable?: boolean; - bot?: boolean; - display_name?: string; - note?: string; - avatar?: string; - header?: string; - locked?: boolean; - source?: { - privacy?: string; - sensitive?: boolean; - language?: string; - }; - fields_attributes?: Array<{ name: string; value: string }>; - }): Promise>; - /** - * GET /api/v1/accounts/:id - * - * @param id The account ID. - * @return An account. - */ - getAccount(id: string): Promise>; - /** - * GET /api/v1/accounts/:id/statuses + // ====================================== + // accounts + // ====================================== + /** + * Creates a user and account records. Returns an account access token for the app that initiated the request. The app should save this token for later, and should wait for the user to confirm their account by clicking a link in their email inbox. + * + * @param username Username for the account. + * @param email Email for the account. + * @param password Password for the account. + * @param agreement Whether the user agrees to the local rules, terms, and policies. + * @param locale The language of the confirmation email that will be sent + * @param reason Text that will be reviewed by moderators if registrations require manual approval. + * @return An account token. + */ + registerAccount( + username: string, + email: string, + password: string, + agreement: boolean, + locale: string, + reason?: string | null + ): Promise> + /** + * Test to make sure that the user token works. + * + * @return Account. + */ + verifyAccountCredentials(): Promise> + /** + * Update the user’s display and preferences. + * + * @param options.discoverable Whether the account should be shown in the profile directory. + * @param options.bot Whether the account has a bot flag. + * @param options.display_name The display name to use for the profile. + * @param options.note The account bio. + * @param options.avatar Avatar image encoded using multipart/form-data. + * @param options.header Header image encoded using multipart/form-data. + * @param options.locked Whether manual approval of follow requests is required. + * @param options.source.privacy Default post privacy for authored statuses. Can be public, unlisted, or private. + * @param options.source.sensitive Whether to mark authored statuses as sensitive by default. + * @param options.source.language Default language to use for authored statuses (ISO 6391). + * @param options.fields_attributes The profile fields to be set. Inside this hash, the key is an integer cast to a string (although the exact integer does not matter), and the value is another hash including name and value. By default, max 4 fields. + * @return An account. + */ + updateCredentials(options?: { + discoverable?: boolean + bot?: boolean + display_name?: string + note?: string + avatar?: string + header?: string + locked?: boolean + source?: { + privacy?: string + sensitive?: boolean + language?: string + } + fields_attributes?: Array<{ name: string; value: string }> + }): Promise> + /** + * View information about a profile. + * + * @param id The account ID. + * @return An account. + */ + getAccount(id: string): Promise> + /** + * Statuses posted to the given account. * * @param id The account ID. - * @param options.limit Max number of results to return. Defaults to 20. * @param options.max_id Return results older than ID. * @param options.since_id Return results newer than ID but starting with most recent. @@ -188,1333 +171,1253 @@ export interface MegalodonInterface { * @param options.only_media Show only statuses with media attached? Defaults to false. * @return Account's statuses. */ - getAccountStatuses( - id: string, - options?: { - limit?: number; - max_id?: string; - since_id?: string; - min_id?: string; - pinned?: boolean; - exclude_replies?: boolean; - exclude_reblogs?: boolean; - only_media?: boolean; - }, - ): Promise>>; - /** - * GET /api/v1/pleroma/accounts/:id/favourites - * - * @param id Target account ID. - * @param options.limit Max number of results to return. - * @param options.max_id Return results order than ID. - * @param options.since_id Return results newer than ID. - * @return Array of statuses. - */ - getAccountFavourites( - id: string, - options?: { - limit?: number; - max_id?: string; - since_id?: string; - }, - ): Promise>>; - /** - * POST /api/v1/pleroma/accounts/:id/subscribe - * - * @param id Target account ID. - * @return Relationship. - */ - subscribeAccount(id: string): Promise>; - /** - * POST /api/v1/pleroma/accounts/:id/unsubscribe - * - * @param id Target account ID. - * @return Relationship. - */ - unsubscribeAccount(id: string): Promise>; - /** - * GET /api/v1/accounts/:id/followers - * - * @param id The account ID. - * @param options.limit Max number of results to return. Defaults to 40. - * @param options.max_id Return results older than ID. - * @param options.since_id Return results newer than ID. - * @return The array of accounts. - */ - getAccountFollowers( - id: string, - options?: { - limit?: number; - max_id?: string; - since_id?: string; - get_all?: boolean; - sleep_ms?: number; - }, - ): Promise>>; - - /** - * GET /api/v1/accounts/:id/featured_tags - * - * @param id The account ID. - * @return The array of accounts. - */ - getAccountFeaturedTags( - id: string, - ): Promise>>; - - /** - * GET /api/v1/accounts/:id/following - * - * @param id The account ID. - * @param options.limit Max number of results to return. Defaults to 40. - * @param options.max_id Return results older than ID. - * @param options.since_id Return results newer than ID. - * @return The array of accounts. - */ - getAccountFollowing( - id: string, - options?: { - limit?: number; - max_id?: string; - since_id?: string; - get_all?: boolean; - sleep_ms?: number; - }, - ): Promise>>; - /** - * GET /api/v1/accounts/:id/lists - * - * @param id The account ID. - * @return The array of lists. - */ - getAccountLists(id: string): Promise>>; - /** - * GET /api/v1/accounts/:id/identity_proofs - * - * @param id The account ID. - * @return Array of IdentityProof - */ - getIdentityProof(id: string): Promise>>; - /** - * POST /api/v1/accounts/:id/follow - * - * @param id The account ID. - * @param reblog Receive this account's reblogs in home timeline. - * @return Relationship - */ - followAccount( - id: string, - options?: { - reblog?: boolean; - }, - ): Promise>; - /** - * POST /api/v1/accounts/:id/unfollow - * - * @param id The account ID. - * @return Relationship - */ - unfollowAccount(id: string): Promise>; - /** - * POST /api/v1/accounts/:id/block - * - * @param id The account ID. - * @return Relationship - */ - blockAccount(id: string): Promise>; - /** - * POST /api/v1/accounts/:id/unblock - * - * @param id The account ID. - * @return RElationship - */ - unblockAccount(id: string): Promise>; - /** - * POST /api/v1/accounts/:id/mute - * - * @param id The account ID. - * @param notifications Mute notifications in addition to statuses. - * @return Relationship - */ - muteAccount( - id: string, - notifications: boolean, - ): Promise>; - /** - * POST /api/v1/accounts/:id/unmute - * - * @param id The account ID. - * @return Relationship - */ - unmuteAccount(id: string): Promise>; - /** - * POST /api/v1/accounts/:id/pin - * - * @param id The account ID. - * @return Relationship - */ - pinAccount(id: string): Promise>; - /** - * POST /api/v1/accounts/:id/unpin - * - * @param id The account ID. - * @return Relationship - */ - unpinAccount(id: string): Promise>; - /** - * GET /api/v1/accounts/relationships - * - * @param id The account ID. - * @return Relationship - */ - getRelationship(id: string): Promise>; - /** - * Get multiple relationships in one method - * - * @param ids Array of account IDs. - * @return Array of Relationship. - */ - getRelationships( - ids: Array, - ): Promise>>; - /** - * GET /api/v1/accounts/search - * - * @param q Search query. - * @param options.limit Max number of results to return. Defaults to 40. - * @param options.max_id Return results older than ID. - * @param options.since_id Return results newer than ID. - * @return The array of accounts. - */ - searchAccount( - q: string, - options?: { - following?: boolean; - resolve?: boolean; - limit?: number; - max_id?: string; - since_id?: string; - }, - ): Promise>>; - // ====================================== - // accounts/bookmarks - // ====================================== - /** - * GET /api/v1/bookmarks - * - * @param options.limit Max number of results to return. Defaults to 40. - * @param options.max_id Return results older than ID. - * @param options.since_id Return results newer than ID. - * @param options.min_id Return results immediately newer than ID. - * @return Array of statuses. - */ - getBookmarks(options?: { - limit?: number; - max_id?: string; - since_id?: string; - min_id?: string; - }): Promise>>; - // ====================================== - // accounts/favourites - // ====================================== - /** - * GET /api/v1/favourites - * - * @param options.limit Max number of results to return. Defaults to 40. - * @param options.max_id Return results older than ID. - * @param options.min_id Return results immediately newer than ID. - * @return Array of statuses. - */ - getFavourites(options?: { - limit?: number; - max_id?: string; - min_id?: string; - }): Promise>>; - // ====================================== - // accounts/mutes - // ====================================== - /** - * GET /api/v1/mutes - * - * @param options.limit Max number of results to return. Defaults to 40. - * @param options.max_id Return results older than ID. - * @param options.min_id Return results immediately newer than ID. - * @return Array of accounts. - */ - getMutes(options?: { - limit?: number; - max_id?: string; - min_id?: string; - }): Promise>>; - // ====================================== - // accounts/blocks - // ====================================== - /** - * GET /api/v1/blocks - * - * @param options.limit Max number of results to return. Defaults to 40. - * @param options.max_id Return results older than ID. - * @param options.min_id Return results immediately newer than ID. - * @return Array of accounts. - */ - getBlocks(options?: { - limit?: number; - max_id?: string; - min_id?: string; - }): Promise>>; - // ====================================== - // accounts/domain_blocks - // ====================================== - /** - * GET /api/v1/domain_blocks - * - * @param options.limit Max number of results to return. Defaults to 40. - * @param options.max_id Return results older than ID. - * @param options.min_id Return results immediately newer than ID. - * @return Array of domain name. - */ - getDomainBlocks(options?: { - limit?: number; - max_id?: string; - min_id?: string; - }): Promise>>; - /** - * POST/api/v1/domain_blocks - * - * @param domain Domain to block. - */ - blockDomain(domain: string): Promise>; - /** - * DELETE /api/v1/domain_blocks - * - * @param domain Domain to unblock - */ - unblockDomain(domain: string): Promise>; - // ====================================== - // accounts/filters - // ====================================== - /** - * GET /api/v1/filters - * - * @return Array of filters. - */ - getFilters(): Promise>>; - /** - * GET /api/v1/filters/:id - * - * @param id The filter ID. - * @return Filter. - */ - getFilter(id: string): Promise>; - /** - * POST /api/v1/filters - * - * @param phrase Text to be filtered. - * @param context Array of enumerable strings home, notifications, public, thread, account. At least one context must be specified. - * @param options.irreversible Should the server irreversibly drop matching entities from home and notifications? - * @param options.whole_word Consider word boundaries? - * @param options.expires_in ISO 8601 Datetime for when the filter expires. - * @return Filter - */ - createFilter( - phrase: string, - context: Array, - options?: { - irreversible?: boolean; - whole_word?: boolean; - expires_in?: string; - }, - ): Promise>; - /** - * PUT /api/v1/filters/:id - * - * @param id The filter ID. - * @param phrase Text to be filtered. - * @param context Array of enumerable strings home, notifications, public, thread, account. At least one context must be specified. - * @param options.irreversible Should the server irreversibly drop matching entities from home and notifications? - * @param options.whole_word Consider word boundaries? - * @param options.expires_in ISO 8601 Datetime for when the filter expires. - * @return Filter - */ - updateFilter( - id: string, - phrase: string, - context: Array, - options?: { - irreversible?: boolean; - whole_word?: boolean; - expires_in?: string; - }, - ): Promise>; - /** - * DELETE /api/v1/filters/:id - * - * @param id The filter ID. - * @return Removed filter. - */ - deleteFilter(id: string): Promise>; - // ====================================== - // accounts/reports - // ====================================== - /** - * POST /api/v1/reports - * - * @param account_id Target account ID. - * @param comment Reason of the report. - * @param options.status_ids Array of Statuses ids to attach to the report. - * @param options.forward If the account is remote, should the report be forwarded to the remote admin? - * @return Report - */ - report( - account_id: string, - comment: string, - options?: { status_ids?: Array; forward?: boolean }, - ): Promise>; - // ====================================== - // accounts/follow_requests - // ====================================== - /** - * GET /api/v1/follow_requests - * - * @param limit Maximum number of results. - * @return Array of account. - */ - getFollowRequests(limit?: number): Promise>>; - /** - * POST /api/v1/follow_requests/:id/authorize - * - * @param id Target account ID. - * @return Relationship. - */ - acceptFollowRequest(id: string): Promise>; - /** - * POST /api/v1/follow_requests/:id/reject - * - * @param id Target account ID. - * @return Relationship. - */ - rejectFollowRequest(id: string): Promise>; - // ====================================== - // accounts/endorsements - // ====================================== - /** - * GET /api/v1/endorsements - * - * @param options.limit Max number of results to return. Defaults to 40. - * @param options.max_id Return results older than ID. - * @param options.since_id Return results newer than ID. - * @return Array of accounts. - */ - getEndorsements(options?: { - limit?: number; - max_id?: string; - since_id?: string; - }): Promise>>; - // ====================================== - // accounts/featured_tags - // ====================================== - /** - * GET /api/v1/featured_tags - * - * @return Array of featured tag. - */ - getFeaturedTags(): Promise>>; - /** - * POST /api/v1/featured_tags - * - * @param name Target hashtag name. - * @return FeaturedTag. - */ - createFeaturedTag(name: string): Promise>; - /** - * DELETE /api/v1/featured_tags/:id - * - * @param id Target featured tag id. - * @return Empty - */ - deleteFeaturedTag(id: string): Promise>; - /** - * GET /api/v1/featured_tags/suggestions - * - * @return Array of tag. - */ - getSuggestedTags(): Promise>>; - // ====================================== - // accounts/preferences - // ====================================== - /** - * GET /api/v1/preferences - * - * @return Preferences. - */ - getPreferences(): Promise>; - // ====================================== - // accounts/suggestions - // ====================================== - /** - * GET /api/v1/suggestions - * - * @param limit Maximum number of results. - * @return Array of accounts. - */ - getSuggestions(limit?: number): Promise>>; - // ====================================== - // accounts/tags - // ====================================== - getFollowedTags(): Promise>>; - /** - * GET /api/v1/tags/:id - * - * @param id Target hashtag id. - * @return Tag - */ - getTag(id: string): Promise>; - /** - * POST /api/v1/tags/:id/follow - * - * @param id Target hashtag id. - * @return Tag - */ - followTag(id: string): Promise>; - /** - * POST /api/v1/tags/:id/unfollow - * - * @param id Target hashtag id. - * @return Tag - */ - unfollowTag(id: string): Promise>; - // ====================================== - // statuses - // ====================================== - /** - * POST /api/v1/statuses - * - * @param status Text content of status. - * @param options.media_ids Array of Attachment ids. - * @param options.poll Poll object. - * @param options.in_reply_to_id ID of the status being replied to, if status is a reply. - * @param options.sensitive Mark status and attached media as sensitive? - * @param options.spoiler_text Text to be shown as a warning or subject before the actual content. - * @param options.visibility Visibility of the posted status. - * @param options.scheduled_at ISO 8601 Datetime at which to schedule a status. - * @param options.language ISO 639 language code for this status. - * @param options.quote_id ID of the status being quoted to, if status is a quote. - * @return Status - */ - postStatus( - status: string, - options?: { - media_ids?: Array; - poll?: { - options: Array; - expires_in: number; - multiple?: boolean; - hide_totals?: boolean; - }; - in_reply_to_id?: string; - sensitive?: boolean; - spoiler_text?: string; - visibility?: "public" | "unlisted" | "private" | "direct"; - scheduled_at?: string; - language?: string; - quote_id?: string; - }, - ): Promise>; - /** - * GET /api/v1/statuses/:id - * - * @param id The target status id. - * @return Status - */ - getStatus(id: string): Promise>; - /** - PUT /api/v1/statuses/:id - * - * @param id The target status id. - * @return Status + getAccountStatuses( + id: string, + options?: { + limit?: number + max_id?: string + since_id?: string + min_id?: string + pinned?: boolean + exclude_replies?: boolean + exclude_reblogs?: boolean + only_media?: boolean + } + ): Promise>> + /** + * Favourites timeline of any user. + * + * @param id Target account ID. + * @param options.limit Max number of results to return. + * @param options.max_id Return results order than ID. + * @param options.since_id Return results newer than ID. + * @return Array of statuses. */ - editStatus( - id: string, - options: { - status?: string; - spoiler_text?: string; - sensitive?: boolean; - media_ids?: Array; - poll?: { - options?: Array; - expires_in?: number; - multiple?: boolean; - hide_totals?: boolean; - }; - }, - ): Promise>; - /** - * DELETE /api/v1/statuses/:id - * - * @param id The target status id. - * @return Status - */ - deleteStatus(id: string): Promise>; - /** - * GET /api/v1/statuses/:id/context - * - * Get parent and child statuses. - * @param id The target status id. - * @return Context - */ - getStatusContext( - id: string, - options?: { limit?: number; max_id?: string; since_id?: string }, - ): Promise>; - /** - * GET /api/v1/statuses/:id/history - * - * Get status edit history. - * @param id The target status id. - * @return StatusEdit - */ - getStatusHistory(id: string): Promise>>; - /** - * GET /api/v1/statuses/:id/reblogged_by - * - * @param id The target status id. - * @return Array of accounts. - */ - getStatusRebloggedBy(id: string): Promise>>; - /** - * GET /api/v1/statuses/:id/favourited_by - * - * @param id The target status id. - * @return Array of accounts. - */ - getStatusFavouritedBy(id: string): Promise>>; - /** - * POST /api/v1/statuses/:id/favourite - * - * @param id The target status id. - * @return Status. - */ - favouriteStatus(id: string): Promise>; - /** - * POST /api/v1/statuses/:id/unfavourite - * - * @param id The target status id. - * @return Status. - */ - unfavouriteStatus(id: string): Promise>; - /** - * POST /api/v1/statuses/:id/reblog - * - * @param id The target status id. - * @return Status. - */ - reblogStatus(id: string): Promise>; - /** - * POST /api/v1/statuses/:id/unreblog - * - * @param id The target status id. - * @return Status. - */ - unreblogStatus(id: string): Promise>; - /** - * POST /api/v1/statuses/:id/bookmark - * - * @param id The target status id. - * @return Status. - */ - bookmarkStatus(id: string): Promise>; - /** - * POST /api/v1/statuses/:id/unbookmark - * - * @param id The target status id. - * @return Status. - */ - unbookmarkStatus(id: string): Promise>; - /** - * POST /api/v1/statuses/:id/mute - * - * @param id The target status id. - * @return Status - */ - muteStatus(id: string): Promise>; - /** - * POST /api/v1/statuses/:id/unmute - * - * @param id The target status id. - * @return Status - */ - unmuteStatus(id: string): Promise>; - /** - * POST /api/v1/statuses/:id/pin - * @param id The target status id. - * @return Status - */ - pinStatus(id: string): Promise>; - /** - * POST /api/v1/statuses/:id/unpin - * - * @param id The target status id. - * @return Status - */ - unpinStatus(id: string): Promise>; - /** - * POST /api/v1/statuses/:id/react/:name - * @param id The target status id. - * @param name The name of the emoji reaction to add. - * @return Status - */ - reactStatus(id: string, name: string): Promise>; - /** - * POST /api/v1/statuses/:id/unreact/:name - * - * @param id The target status id. - * @param name The name of the emoji reaction to remove. - * @return Status - */ - unreactStatus(id: string, name: string): Promise>; - // ====================================== - // statuses/media - // ====================================== - /** - * POST /api/v2/media - * - * @param file The file to be attached, using multipart form data. - * @param options.description A plain-text description of the media. - * @param options.focus Two floating points (x,y), comma-delimited, ranging from -1.0 to 1.0. - * @return Attachment - */ - uploadMedia( - file: any, - options?: { description?: string; focus?: string }, - ): Promise>; - /** - * GET /api/v1/media/:id - * - * @param id Target media ID. - * @return Attachment - */ - getMedia(id: string): Promise>; - /** - * PUT /api/v1/media/:id - * - * @param id Target media ID. - * @param options.file The file to be attached, using multipart form data. - * @param options.description A plain-text description of the media. - * @param options.focus Two floating points (x,y), comma-delimited, ranging from -1.0 to 1.0. - * @param options.is_sensitive Whether the media is sensitive. - * @return Attachment - */ - updateMedia( - id: string, - options?: { - file?: any; - description?: string; - focus?: string; - is_sensitive?: boolean; - }, - ): Promise>; - // ====================================== - // statuses/polls - // ====================================== - /** - * GET /api/v1/polls/:id - * - * @param id Target poll ID. - * @return Poll - */ - getPoll(id: string): Promise>; - /** - * POST /api/v1/polls/:id/votes - * - * @param id Target poll ID. - * @param choices Array of own votes containing index for each option (starting from 0). - * @return Poll - */ - votePoll(id: string, choices: Array): Promise>; - // ====================================== - // statuses/scheduled_statuses - // ====================================== - /** - * GET /api/v1/scheduled_statuses - * - * @param options.limit Max number of results to return. Defaults to 20. - * @param options.max_id Return results older than ID. - * @param options.since_id Return results newer than ID. - * @param options.min_id Return results immediately newer than ID. - * @return Array of scheduled statuses. - */ - getScheduledStatuses(options?: { - limit?: number; - max_id?: string; - since_id?: string; - min_id?: string; - }): Promise>>; - /** - * GET /api/v1/scheduled_statuses/:id - * - * @param id Target status ID. - * @return ScheduledStatus. - */ - getScheduledStatus(id: string): Promise>; - /** - * PUT /api/v1/scheduled_statuses/:id - * - * @param id Target scheduled status ID. - * @param scheduled_at ISO 8601 Datetime at which the status will be published. - * @return ScheduledStatus. - */ - scheduleStatus( - id: string, - scheduled_at?: string | null, - ): Promise>; - /** - * DELETE /api/v1/scheduled_statuses/:id - * - * @param id Target scheduled status ID. - */ - cancelScheduledStatus(id: string): Promise>; - // ====================================== - // timelines - // ====================================== - /** - * GET /api/v1/timelines/public - * - * @param options.only_media Show only statuses with media attached? Defaults to false. - * @param options.limit Max number of results to return. Defaults to 20. - * @param options.max_id Return results older than ID. - * @param options.since_id Return results newer than ID. - * @param options.min_id Return results immediately newer than ID. - * @return Array of statuses. - */ - getPublicTimeline(options?: { - only_media?: boolean; - limit?: number; - max_id?: string; - since_id?: string; - min_id?: string; - }): Promise>>; - /** - * GET /api/v1/timelines/public - * - * @param options.only_media Show only statuses with media attached? Defaults to false. - * @param options.limit Max number of results to return. Defaults to 20. - * @param options.max_id Return results older than ID. - * @param options.since_id Return results newer than ID. - * @param options.min_id Return results immediately newer than ID. - * @return Array of statuses. - */ - getLocalTimeline(options?: { - only_media?: boolean; - limit?: number; - max_id?: string; - since_id?: string; - min_id?: string; - }): Promise>>; - /** - * GET /api/v1/timelines/tag/:hashtag - * - * @param hashtag Content of a #hashtag, not including # symbol. - * @param options.local Show only local statuses? Defaults to false. - * @param options.only_media Show only statuses with media attached? Defaults to false. - * @param options.limit Max number of results to return. Defaults to 20. - * @param options.max_id Return results older than ID. - * @param options.since_id Return results newer than ID. - * @param options.min_id Return results immediately newer than ID. - * @return Array of statuses. - */ - getTagTimeline( - hashtag: string, - options?: { - local?: boolean; - only_media?: boolean; - limit?: number; - max_id?: string; - since_id?: string; - min_id?: string; - }, - ): Promise>>; - /** - * GET /api/v1/timelines/home - * - * @param options.local Show only local statuses? Defaults to false. - * @param options.limit Max number of results to return. Defaults to 20. - * @param options.max_id Return results older than ID. - * @param options.since_id Return results newer than ID. - * @param options.min_id Return results immediately newer than ID. - * @return Array of statuses. - */ - getHomeTimeline(options?: { - local?: boolean; - limit?: number; - max_id?: string; - since_id?: string; - min_id?: string; - }): Promise>>; - /** - * GET /api/v1/timelines/list/:list_id - * - * @param list_id Local ID of the list in the database. - * @param options.limit Max number of results to return. Defaults to 20. - * @param options.max_id Return results older than ID. - * @param options.since_id Return results newer than ID. - * @param options.min_id Return results immediately newer than ID. - * @return Array of statuses. - */ - getListTimeline( - list_id: string, - options?: { - limit?: number; - max_id?: string; - since_id?: string; - min_id?: string; - }, - ): Promise>>; - // ====================================== - // timelines/conversations - // ====================================== - /** - * GET /api/v1/conversations - * - * @param options.limit Max number of results to return. Defaults to 20. - * @param options.max_id Return results older than ID. - * @param options.since_id Return results newer than ID. - * @param options.min_id Return results immediately newer than ID. - * @return Array of statuses. - */ - getConversationTimeline(options?: { - limit?: number; - max_id?: string; - since_id?: string; - min_id?: string; - }): Promise>>; - /** - * DELETE /api/v1/conversations/:id - * - * @param id Target conversation ID. - */ - deleteConversation(id: string): Promise>; - /** - * POST /api/v1/conversations/:id/read - * - * @param id Target conversation ID. - * @return Conversation. - */ - readConversation(id: string): Promise>; - // ====================================== - // timelines/lists - // ====================================== - /** - * GET /api/v1/lists - * - * @return Array of lists. - */ - getLists(id: string): Promise>>; - /** - * GET /api/v1/lists/:id - * - * @param id Target list ID. - * @return List. - */ - getList(id: string): Promise>; - /** - * POST /api/v1/lists - * - * @param title List name. - * @return List. - */ - createList(title: string): Promise>; - /** - * PUT /api/v1/lists/:id - * - * @param id Target list ID. - * @param title New list name. - * @return List. - */ - updateList(id: string, title: string): Promise>; - /** - * DELETE /api/v1/lists/:id - * - * @param id Target list ID. - */ - deleteList(id: string): Promise>; - /** - * GET /api/v1/lists/:id/accounts - * - * @param id Target list ID. - * @param options.limit Max number of results to return. - * @param options.max_id Return results older than ID. - * @param options.since_id Return results newer than ID. - * @param options.min_id Return results immediately newer than ID. - * @return Array of accounts. - */ - getAccountsInList( - id: string, - options?: { - limit?: number; - max_id?: string; - since_id?: string; - }, - ): Promise>>; - /** - * POST /api/v1/lists/:id/accounts - * - * @param id Target list ID. - * @param account_ids Array of account IDs to add to the list. - */ - addAccountsToList( - id: string, - account_ids: Array, - ): Promise>; - /** - * DELETE /api/v1/lists/:id/accounts - * - * @param id Target list ID. - * @param account_ids Array of account IDs to add to the list. - */ - deleteAccountsFromList( - id: string, - account_ids: Array, - ): Promise>; - // ====================================== - // timelines/markers - // ====================================== - /** - * GET /api/v1/markers - * - * @param timelines Array of timeline names, String enum anyOf home, notifications. - * @return Marker or empty object. - */ - getMarkers(timeline: Array): Promise>; - /** - * POST /api/v1/markers - * - * @param options.home Marker position of the last read status ID in home timeline. - * @param options.notifications Marker position of the last read notification ID in notifications. - * @return Marker. - */ - saveMarkers(options?: { - home?: { last_read_id: string }; - notifications?: { last_read_id: string }; - }): Promise>; - // ====================================== - // notifications - // ====================================== - /** - * GET /api/v1/notifications - * - * @param options.limit Max number of results to return. Defaults to 20. - * @param options.max_id Return results older than ID. - * @param options.since_id Return results newer than ID. - * @param options.min_id Return results immediately newer than ID. - * @param options.exclude_types Array of types to exclude. - * @param options.account_id Return only notifications received from this account. - * @return Array of notifications. - */ - getNotifications(options?: { - limit?: number; - max_id?: string; - since_id?: string; - min_id?: string; - exclude_types?: Array; - account_id?: string; - }): Promise>>; - /** - * GET /api/v1/notifications/:id - * - * @param id Target notification ID. - * @return Notification. - */ - getNotification(id: string): Promise>; - /** - * POST /api/v1/notifications/clear - */ - dismissNotifications(): Promise>; - /** - * POST /api/v1/notifications/:id/dismiss - * - * @param id Target notification ID. - */ - dismissNotification(id: string): Promise>; - /** - * POST /api/v1/pleroma/notifcations/read - * - * @param id A single notification ID to read - * @param max_id Read all notifications up to this ID - * @return Array of notifications - */ - readNotifications(options: { id?: string; max_id?: string }): Promise< - Response> - >; - // ====================================== - // notifications/push - // ====================================== - /** - * POST /api/v1/push/subscription - * - * @param subscription[endpoint] Endpoint URL that is called when a notification event occurs. - * @param subscription[keys][p256dh] User agent public key. Base64 encoded string of public key of ECDH key using prime256v1 curve. - * @param subscription[keys] Auth secret. Base64 encoded string of 16 bytes of random data. - * @param data[alerts][follow] Receive follow notifications? - * @param data[alerts][favourite] Receive favourite notifications? - * @param data[alerts][reblog] Receive reblog notifictaions? - * @param data[alerts][mention] Receive mention notifications? - * @param data[alerts][poll] Receive poll notifications? - * @return PushSubscription. - */ - subscribePushNotification( - subscription: { endpoint: string; keys: { p256dh: string; auth: string } }, - data?: { - alerts: { - follow?: boolean; - favourite?: boolean; - reblog?: boolean; - mention?: boolean; - poll?: boolean; - }; - } | null, - ): Promise>; - /** - * GET /api/v1/push/subscription - * - * @return PushSubscription. - */ - getPushSubscription(): Promise>; - /** - * PUT /api/v1/push/subscription - * - * @param data[alerts][follow] Receive follow notifications? - * @param data[alerts][favourite] Receive favourite notifications? - * @param data[alerts][reblog] Receive reblog notifictaions? - * @param data[alerts][mention] Receive mention notifications? - * @param data[alerts][poll] Receive poll notifications? - * @return PushSubscription. - */ - updatePushSubscription( - data?: { - alerts: { - follow?: boolean; - favourite?: boolean; - reblog?: boolean; - mention?: boolean; - poll?: boolean; - }; - } | null, - ): Promise>; - /** - * DELETE /api/v1/push/subscription - */ - deletePushSubscription(): Promise>; - // ====================================== - // search - // ====================================== - /** - * GET /api/v2/search - * - * @param q The search query. - * @param type Enum of search target. - * @param options.limit Maximum number of results to load, per type. Defaults to 20. Max 40. - * @param options.max_id Return results older than this id. - * @param options.min_id Return results immediately newer than this id. - * @param options.resolve Attempt WebFinger lookup. Defaults to false. - * @param options.following Only include accounts that the user is following. Defaults to false. - * @param options.account_id If provided, statuses returned will be authored only by this account. - * @param options.exclude_unreviewed Filter out unreviewed tags? Defaults to false. - * @return Results. - */ - search( - q: string, - type: "accounts" | "hashtags" | "statuses", - options?: { - limit?: number; - max_id?: string; - min_id?: string; - resolve?: boolean; - offset?: number; - following?: boolean; - account_id?: string; - exclude_unreviewed?: boolean; - }, - ): Promise>; + getAccountFavourites( + id: string, + options?: { + limit?: number + max_id?: string + since_id?: string + } + ): Promise>> + /** + * Subscribe to receive notifications for all statuses posted by a user. + * + * @param id Target account ID. + * @return Relationship. + */ + subscribeAccount(id: string): Promise> + /** + * Unsubscribe to stop receiving notifications from user statuses. + * + * @param id Target account ID. + * @return Relationship. + */ + unsubscribeAccount(id: string): Promise> + /** + * Accounts which follow the given account, if network is not hidden by the account owner. + * + * @param id The account ID. + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.get_all + * @param options.sleep_ms + * @return The array of accounts. + */ + getAccountFollowers( + id: string, + options?: { + limit?: number + max_id?: string + since_id?: string + get_all?: boolean + sleep_ms?: number + } + ): Promise>> + /** + * Accounts which the given account is following, if network is not hidden by the account owner. + * + * @param id The account ID. + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.get_all + * @param options.sleep_ms + * @return The array of accounts. + */ + getAccountFollowing( + id: string, + options?: { + limit?: number + max_id?: string + since_id?: string + get_all?: boolean + sleep_ms?: number + } + ): Promise>> + /** + * User lists that you have added this account to. + * + * @param id The account ID. + * @return The array of lists. + */ + getAccountLists(id: string): Promise>> + /** + * Returns an IdentityProof. + * + * @param id The account ID. + * @return Array of IdentityProof + */ + getIdentityProof(id: string): Promise>> + /** + * Follow the given account. Can also be used to update whether to show reblogs or enable notifications. + * + * @param id The account ID. + * @param reblog Receive this account's reblogs in home timeline. + * @return Relationship + */ + followAccount( + id: string, + options?: { + reblog?: boolean + } + ): Promise> + /** + * Unfollow the given account. + * + * @param id The account ID. + * @return Relationship + */ + unfollowAccount(id: string): Promise> + /** + * lock the given account. Clients should filter statuses from this account if received. + * + * @param id The account ID. + * @return Relationship + */ + blockAccount(id: string): Promise> + /** + * Unblock the given account. + * + * @param id The account ID. + * @return RElationship + */ + unblockAccount(id: string): Promise> + /** + * Mute the given account. Clients should filter statuses and notifications from this account, if received, + * + * @param id The account ID. + * @param notifications Mute notifications in addition to statuses. + * @return Relationship + */ + muteAccount(id: string, notifications: boolean): Promise> + /** + * Unmute the given account. + * + * @param id The account ID. + * @return Relationship + */ + unmuteAccount(id: string): Promise> + /** + * Add the given account to the user’s featured profiles. + * + * @param id The account ID. + * @return Relationship + */ + pinAccount(id: string): Promise> + /** + * Remove the given account from the user’s featured profiles. + * + * @param id The account ID. + * @return Relationship + */ + unpinAccount(id: string): Promise> + /** + * Find out whether a given account is followed, blocked, muted, etc. + * + * @param id The account ID. + * @return Relationship + */ + getRelationship(id: string): Promise> + /** + * Find out whether given accounts are followed, blocked, muted, etc. + * + * @param ids Array of account IDs. + * @return Array of Relationship. + */ + getRelationships(ids: Array): Promise>> + /** + * Search for matching accounts by username or display name. + * + * @param q Search query. + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @return The array of accounts. + */ + searchAccount( + q: string, + options?: { + following?: boolean + resolve?: boolean + limit?: number + max_id?: string + since_id?: string + } + ): Promise>> + // ====================================== + // accounts/bookmarks + // ====================================== + /** + * Statuses the user has bookmarked. + * + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + getBookmarks(options?: { limit?: number; max_id?: string; since_id?: string; min_id?: string }): Promise>> + // ====================================== + // accounts/favourites + // ====================================== + /** + * Statuses the user has favourited. + * + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + getFavourites(options?: { limit?: number; max_id?: string; min_id?: string }): Promise>> + // ====================================== + // accounts/mutes + // ====================================== + /** + * Accounts the user has muted. + * + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of accounts. + */ + getMutes(options?: { limit?: number; max_id?: string; min_id?: string }): Promise>> + // ====================================== + // accounts/blocks + // ====================================== + /** + * View blocked users. + * + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of accounts. + */ + getBlocks(options?: { limit?: number; max_id?: string; min_id?: string }): Promise>> + // ====================================== + // accounts/domain_blocks + // ====================================== + /** + * View domains the user has blocked. + * + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of domain name. + */ + getDomainBlocks(options?: { limit?: number; max_id?: string; min_id?: string }): Promise>> + /** + * Block a domain. + * + * @param domain Domain to block. + */ + blockDomain(domain: string): Promise> + /** + * Remove a domain block, if it exists in the user’s array of blocked domains. + * + * @param domain Domain to unblock + */ + unblockDomain(domain: string): Promise> + // ====================================== + // accounts/filters + // ====================================== + /** + * Get filters of the current user. + * + * @return Array of filters. + */ + getFilters(): Promise>> + /** + * Get a specyfic filter. + * + * @param id The filter ID. + * @return Filter. + */ + getFilter(id: string): Promise> + /** + * Create a filter. + * + * @param phrase Text to be filtered. + * @param context Array of enumerable strings home, notifications, public, thread, account. At least one context must be specified. + * @param options.irreversible Should the server irreversibly drop matching entities from home and notifications? + * @param options.whole_word Consider word boundaries? + * @param options.expires_in ISO 8601 Datetime for when the filter expires. + * @return Filter + */ + createFilter( + phrase: string, + context: Array, + options?: { + irreversible?: boolean + whole_word?: boolean + expires_in?: string + } + ): Promise> + /** + * Replaces a filter’s parameters in-place. + * + * @param id The filter ID. + * @param phrase Text to be filtered. + * @param context Array of enumerable strings home, notifications, public, thread, account. At least one context must be specified. + * @param options.irreversible Should the server irreversibly drop matching entities from home and notifications? + * @param options.whole_word Consider word boundaries? + * @param options.expires_in ISO 8601 Datetime for when the filter expires. + * @return Filter + */ + updateFilter( + id: string, + phrase: string, + context: Array, + options?: { + irreversible?: boolean + whole_word?: boolean + expires_in?: string + } + ): Promise> + /** + * Remove a filter. + * + * @param id The filter ID. + * @return Removed filter. + */ + deleteFilter(id: string): Promise> + // ====================================== + // accounts/reports + // ====================================== + /** + * File a report. + * + * @param account_id Target account ID. + * @param options.status_ids Array of Statuses ids to attach to the report. + * @param options.comment The reason for the report. Default maximum of 1000 characters. + * @param options.forward If the account is remote, should the report be forwarded to the remote admin? + * @param options.category Specify if the report is due to spam, violation of enumerated instance rules, or some other reason. Defaults to other. Will be set to violation if rule_ids[] is provided (regardless of any category value you provide). + * @param options.rule_ids For violation category reports, specify the ID of the exact rules broken. Rules and their IDs are available via GET /api/v1/instance/rules and GET /api/v1/instance. + * @return Report + */ + report( + account_id: string, + options?: { + status_ids?: Array + comment: string + forward?: boolean + category?: Entity.Category + rule_ids?: Array + } + ): Promise> + // ====================================== + // accounts/follow_requests + // ====================================== + /** + * Get pending follow requests. + * + * @param limit Maximum number of results. + * @return Array of account or follow request. + */ + getFollowRequests(limit?: number): Promise>> + /** + * Accept the follow request. + * + * @param id Target account ID. Or follow request ID in Friendica. + * @return Relationship. + */ + acceptFollowRequest(id: string): Promise> + /** + * Reject the follow request. + * + * @param id Target account ID. Or follow request ID in Friendica. + * @return Relationship. + */ + rejectFollowRequest(id: string): Promise> + // ====================================== + // accounts/endorsements + // ====================================== + /** + * Accounts that the user is currently featuring on their profile. + * + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @return Array of accounts. + */ + getEndorsements(options?: { limit?: number; max_id?: string; since_id?: string }): Promise>> + // ====================================== + // accounts/featured_tags + // ====================================== + /** + * List all hashtags featured on your profile. + * + * @return Array of featured tag. + */ + getFeaturedTags(): Promise>> + /** + * Promote a hashtag on your profile. + * + * @param name Target hashtag name. + * @return FeaturedTag. + */ + createFeaturedTag(name: string): Promise> + /** + * Stop promoting a hashtag on your profile. + * + * @param id Target featured tag id. + * @return Empty + */ + deleteFeaturedTag(id: string): Promise> + /** + * Shows up to 10 recently-used tags. + * + * @return Array of tag. + */ + getSuggestedTags(): Promise>> + // ====================================== + // accounts/preferences + // ====================================== + /** + * Get preferences defined by the user in their account settings. + * + * @return Preferences. + */ + getPreferences(): Promise> + // ====================================== + // accounts/followed_tags + // ====================================== + /** + * View all followed tags. + * + * @return Array of tag. + */ + getFollowedTags(): Promise>> + // ====================================== + // accounts/suggestions + // ====================================== + /** + * Accounts the user has had past positive interactions with, but is not yet following. + * + * @param limit Maximum number of results. + * @return Array of accounts. + */ + getSuggestions(limit?: number): Promise>> + // ====================================== + // accounts/tags + // ====================================== + /** + * Show a hashtag and its associated information + * + * @param id Target hashtag id. + * @return Tag + */ + getTag(id: string): Promise> + /** + * Follow a hashtag. Posts containing a followed hashtag will be inserted into your home timeline. + * + * @param id Target hashtag id. + * @return Tag + */ + followTag(id: string): Promise> + /** + * Unfollow a hashtag. Posts containing this hashtag will no longer be inserted into your home timeline. + * + * @param id Target hashtag id. + * @return Tag + */ + unfollowTag(id: string): Promise> + // ====================================== + // statuses + // ====================================== + /** + * Publish a status with the given parameters. + * + * @param status Text content of status. + * @param options.media_ids Array of Attachment ids. + * @param options.poll Poll object. + * @param options.in_reply_to_id ID of the status being replied to, if status is a reply. + * @param options.sensitive Mark status and attached media as sensitive? + * @param options.spoiler_text Text to be shown as a warning or subject before the actual content. + * @param options.visibility Visibility of the posted status. + * @param options.scheduled_at ISO 8601 Datetime at which to schedule a status. + * @param options.language ISO 639 language code for this status. + * @param options.quote_id ID of the status being quoted to, if status is a quote. + * @return Status. When options.scheduled_at is present, ScheduledStatus is returned instead. + */ + postStatus( + status: string, + options?: { + media_ids?: Array + poll?: { options: Array; expires_in: number; multiple?: boolean; hide_totals?: boolean } + in_reply_to_id?: string + sensitive?: boolean + spoiler_text?: string + visibility?: 'public' | 'unlisted' | 'private' | 'direct' + scheduled_at?: string + language?: string + quote_id?: string + } + ): Promise> + /** + * Obtain information about a status. + * + * @param id The target status id. + * @return Status + */ + getStatus(id: string): Promise> + /** + * Edit a given status to change its text, sensitivity, media attachments, or poll. Note that editing a poll’s options will reset the votes. + * + * @param id The target status id. + * @param options.status Text context of status. + * @param options.spoiler_text Text to be shown as a warning or subject before the actual content. + * @param options.sensitive Mark status and attached media as sensitive? + * @param options.media_ids Array of Attachment ids. + * @param options.poll Poll object. + * @return Status + */ + editStatus( + id: string, + options: { + status?: string + spoiler_text?: string + sensitive?: boolean + media_ids?: Array + poll?: { options?: Array; expires_in?: number; multiple?: boolean; hide_totals?: boolean } + } + ): Promise> + /** + * Delete one of your own statuses. + * + * @param id The target status id. + * @return Status + */ + deleteStatus(id: string): Promise> + /** + * Get parent and child statuses in context. + * View statuses above and below this status in the thread. + * + * @param id The target status id. + * @return Context + */ + getStatusContext(id: string, options?: { limit?: number; max_id?: string; since_id?: string }): Promise> + /** + * View status source. + * Obtain the source properties for a status so that it can be edited. + * + * @param id The target status id. + * @return StatusSource + */ + getStatusSource(id: string): Promise> + /** + * See who boosted a status. + * + * @param id The target status id. + * @return Array of accounts. + */ + getStatusRebloggedBy(id: string): Promise>> + /** + * See who favourited a status + * + * @param id The target status id. + * @return Array of accounts. + */ + getStatusFavouritedBy(id: string): Promise>> + /** + * Favourite a status. + * + * @param id The target status id. + * @return Status. + */ + favouriteStatus(id: string): Promise> + /** + * Undo favourite of a status. + * + * @param id The target status id. + * @return Status. + */ + unfavouriteStatus(id: string): Promise> + /** + * Boost a status. + * + * @param id The target status id. + * @return Status. + */ + reblogStatus(id: string): Promise> + /** + * Undo boost of a status. + * + * @param id The target status id. + * @return Status. + */ + unreblogStatus(id: string): Promise> + /** + * Bookmark a status + * + * @param id The target status id. + * @return Status. + */ + bookmarkStatus(id: string): Promise> + /** + * Undo bookmark of a status. + * + * @param id The target status id. + * @return Status. + */ + unbookmarkStatus(id: string): Promise> + /** + * Mute a conversation. + * + * @param id The target status id. + * @return Status + */ + muteStatus(id: string): Promise> + /** + * Unmute a conversation. + * + * @param id The target status id. + * @return Status + */ + unmuteStatus(id: string): Promise> + /** + * Pin status to profile. + * + * @param id The target status id. + * @return Status + */ + pinStatus(id: string): Promise> + /** + * Unpin status from profile. + * + * @param id The target status id. + * @return Status + */ + unpinStatus(id: string): Promise> + // ====================================== + // statuses/media + // ====================================== + /** + * Upload media as an attachment. + * + * @param file The file to be attached, using multipart form data. + * @param options.description A plain-text description of the media. + * @param options.focus Two floating points (x,y), comma-delimited, ranging from -1.0 to 1.0. + * @return Attachment + */ + uploadMedia(file: any, options?: { description?: string; focus?: string }): Promise> + /** + * Get media attachment. + * + * @param id Target media ID. + * @return Attachment + */ + getMedia(id: string): Promise> + /** + * Update media attachment. + * + * @param id Target media ID. + * @param options.file The file to be attached, using multipart form data. + * @param options.description A plain-text description of the media. + * @param options.focus Two floating points (x,y), comma-delimited, ranging from -1.0 to 1.0. + * @param options.is_sensitive Whether the media is sensitive. + * @return Attachment + */ + updateMedia( + id: string, + options?: { + file?: any + description?: string + focus?: string + is_sensitive?: boolean + } + ): Promise> + // ====================================== + // statuses/polls + // ====================================== + /** + * View a poll. + * + * @param id Target poll ID. + * @return Poll + */ + getPoll(id: string): Promise> + /** + * Vote on a poll. + * + * @param id Target poll ID. + * @param choices Array of own votes containing index for each option (starting from 0). + * @return Poll + */ + votePoll(id: string, choices: Array, status_id?: string | null): Promise> + // ====================================== + // statuses/scheduled_statuses + // ====================================== + /** + * View scheduled statuses. + * + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of scheduled statuses. + */ + getScheduledStatuses(options?: { + limit?: number + max_id?: string + since_id?: string + min_id?: string + }): Promise>> + /** + * View a single scheduled status. + * + * @param id Target status ID. + * @return ScheduledStatus. + */ + getScheduledStatus(id: string): Promise> + /** + * Update a scheduled status’s publishing date. + * + * @param id Target scheduled status ID. + * @param scheduled_at ISO 8601 Datetime at which the status will be published. + * @return ScheduledStatus. + */ + scheduleStatus(id: string, scheduled_at?: string | null): Promise> + /** + * Cancel a scheduled status. + * + * @param id Target scheduled status ID. + */ + cancelScheduledStatus(id: string): Promise> + // ====================================== + // timelines + // ====================================== + /** + * View public timeline. + * + * @param options.only_media Show only statuses with media attached? Defaults to false. + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + getPublicTimeline(options?: { + only_media?: boolean + limit?: number + max_id?: string + since_id?: string + min_id?: string + }): Promise>> + /** + * View local timeline. + * + * @param options.only_media Show only statuses with media attached? Defaults to false. + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + getLocalTimeline(options?: { + only_media?: boolean + limit?: number + max_id?: string + since_id?: string + min_id?: string + }): Promise>> + /** + * View hashtag timeline. + * + * @param hashtag Content of a #hashtag, not including # symbol. + * @param options.local Show only local statuses? Defaults to false. + * @param options.only_media Show only statuses with media attached? Defaults to false. + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + getTagTimeline( + hashtag: string, + options?: { + local?: boolean + only_media?: boolean + limit?: number + max_id?: string + since_id?: string + min_id?: string + } + ): Promise>> + /** + * View home timeline. + * + * @param options.local Show only local statuses? Defaults to false. + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + getHomeTimeline(options?: { + local?: boolean + limit?: number + max_id?: string + since_id?: string + min_id?: string + }): Promise>> + /** + * View list timeline. + * + * @param list_id Local ID of the list in the database. + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + getListTimeline( + list_id: string, + options?: { + limit?: number + max_id?: string + since_id?: string + min_id?: string + } + ): Promise>> + // ====================================== + // timelines/conversations + // ====================================== + /** + * View all conversations. + * + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + getConversationTimeline(options?: { + limit?: number + max_id?: string + since_id?: string + min_id?: string + }): Promise>> + /** + * Remove a conversation. + * + * @param id Target conversation ID. + */ + deleteConversation(id: string): Promise> + /** + * Mark a conversation as read. + * + * @param id Target conversation ID. + * @return Conversation. + */ + readConversation(id: string): Promise> + // ====================================== + // timelines/lists + // ====================================== + /** + * View your lists. + * + * @return Array of lists. + */ + getLists(id: string): Promise>> + /** + * Show a single list. + * + * @param id Target list ID. + * @return List. + */ + getList(id: string): Promise> + /** + * Create a list. + * + * @param title List name. + * @return List. + */ + createList(title: string): Promise> + /** + * Update a list. + * + * @param id Target list ID. + * @param title New list name. + * @return List. + */ + updateList(id: string, title: string): Promise> + /** + * Delete a list. + * + * @param id Target list ID. + */ + deleteList(id: string): Promise> + /** + * View accounts in a list. + * + * @param id Target list ID. + * @param options.limit Max number of results to return. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of accounts. + */ + getAccountsInList( + id: string, + options?: { + limit?: number + max_id?: string + since_id?: string + } + ): Promise>> + /** + * Add accounts to a list. + * + * @param id Target list ID. + * @param account_ids Array of account IDs to add to the list. + */ + addAccountsToList(id: string, account_ids: Array): Promise> + /** + * Remove accounts from list. + * + * @param id Target list ID. + * @param account_ids Array of account IDs to add to the list. + */ + deleteAccountsFromList(id: string, account_ids: Array): Promise> + // ====================================== + // timelines/markers + // ====================================== + /** + * Get saved timeline positions. + * + * @param timelines Array of timeline names, String enum anyOf home, notifications. + * @return Marker or empty object. + */ + getMarkers(timeline: Array): Promise>> + /** + * Save your position in a timeline. + * + * @param options.home Marker position of the last read status ID in home timeline. + * @param options.notifications Marker position of the last read notification ID in notifications. + * @return Marker. + */ + saveMarkers(options?: { home?: { last_read_id: string }; notifications?: { last_read_id: string } }): Promise> + // ====================================== + // notifications + // ====================================== + /** + * Get all notifications. + * + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @param options.exclude_types Array of types to exclude. + * @param options.account_id Return only notifications received from this account. + * @return Array of notifications. + */ + getNotifications(options?: { + limit?: number + max_id?: string + since_id?: string + min_id?: string + exclude_types?: Array + account_id?: string + }): Promise>> + /** + * Get a single notification. + * + * @param id Target notification ID. + * @return Notification. + */ + getNotification(id: string): Promise> + /** + * Dismiss all notifications. + */ + dismissNotifications(): Promise> + /** + * Dismiss a single notification. + * + * @param id Target notification ID. + */ + dismissNotification(id: string): Promise> + /** + * Mark as read all unread notifications. + * + * @param id A single notification ID to read + * @param max_id Read all notifications up to this ID + * @return Array of notifications + */ + readNotifications(options: { id?: string; max_id?: string }): Promise>> + // ====================================== + // notifications/push + // ====================================== + /** + * Subscribe to push notifications. + * + * @param subscription[endpoint] Endpoint URL that is called when a notification event occurs. + * @param subscription[keys][p256dh] User agent public key. Base64 encoded string of public key of ECDH key using prime256v1 curve. + * @param subscription[keys] Auth secret. Base64 encoded string of 16 bytes of random data. + * @param data[alerts][follow] Receive follow notifications? + * @param data[alerts][favourite] Receive favourite notifications? + * @param data[alerts][reblog] Receive reblog notifictaions? + * @param data[alerts][mention] Receive mention notifications? + * @param data[alerts][poll] Receive poll notifications? + * @return PushSubscription. + */ + subscribePushNotification( + subscription: { endpoint: string; keys: { p256dh: string; auth: string } }, + data?: { alerts: { follow?: boolean; favourite?: boolean; reblog?: boolean; mention?: boolean; poll?: boolean } } | null + ): Promise> + /** + * Get current subscription. + * + * @return PushSubscription. + */ + getPushSubscription(): Promise> + /** + * Change types of notifications. + * + * @param data[alerts][follow] Receive follow notifications? + * @param data[alerts][favourite] Receive favourite notifications? + * @param data[alerts][reblog] Receive reblog notifictaions? + * @param data[alerts][mention] Receive mention notifications? + * @param data[alerts][poll] Receive poll notifications? + * @return PushSubscription. + */ + updatePushSubscription( + data?: { alerts: { follow?: boolean; favourite?: boolean; reblog?: boolean; mention?: boolean; poll?: boolean } } | null + ): Promise> + /** + * Remove current subscription. + */ + deletePushSubscription(): Promise> + // ====================================== + // search + // ====================================== + /** + * Perform a search. + * + * @param q The search query. + * @param options.type Enum of search target. + * @param options.limit Maximum number of results to load, per type. Defaults to 20. Max 40. + * @param options.max_id Return results older than this id. + * @param options.min_id Return results immediately newer than this id. + * @param options.resolve Attempt WebFinger lookup. Defaults to false. + * @param options.following Only include accounts that the user is following. Defaults to false. + * @param options.account_id If provided, statuses returned will be authored only by this account. + * @param options.exclude_unreviewed Filter out unreviewed tags? Defaults to false. + * @return Results. + */ + search( + q: string, + options?: { + type?: 'accounts' | 'hashtags' | 'statuses' + limit?: number + max_id?: string + min_id?: string + resolve?: boolean + offset?: number + following?: boolean + account_id?: string + exclude_unreviewed?: boolean + } + ): Promise> - // ====================================== - // instance - // ====================================== - /** - * GET /api/v1/instance - */ - getInstance(): Promise>; + // ====================================== + // instance + // ====================================== + /** + * View server information. + */ + getInstance(): Promise> - /** - * GET /api/v1/instance/peers - */ - getInstancePeers(): Promise>>; + /** + * List of connected domains. + */ + getInstancePeers(): Promise>> - /** - * GET /api/v1/instance/activity - */ - getInstanceActivity(): Promise>>; + /** + * Weekly activity. + */ + getInstanceActivity(): Promise>> - // ====================================== - // instance/trends - // ====================================== - /** - * GET /api/v1/trends - * - * @param limit Maximum number of results to return. Defaults to 10. - */ - getInstanceTrends( - limit?: number | null, - ): Promise>>; + // ====================================== + // instance/trends + // ====================================== + /** + * View trending tags. + * + * @param limit Maximum number of results to return. Defaults to 10. + */ + getInstanceTrends(limit?: number | null): Promise>> - // ====================================== - // instance/directory - // ====================================== - /** - * GET /api/v1/directory - * - * @param options.limit How many accounts to load. Default 40. - * @param options.offset How many accounts to skip before returning results. Default 0. - * @param options.order Order of results. - * @param options.local Only return local accounts. - * @return Array of accounts. - */ - getInstanceDirectory(options?: { - limit?: number; - offset?: number; - order?: "active" | "new"; - local?: boolean; - }): Promise>>; + // ====================================== + // instance/directory + // ====================================== + /** + * View profile directory. + * + * @param options.limit How many accounts to load. Default 40. + * @param options.offset How many accounts to skip before returning results. Default 0. + * @param options.order Order of results. + * @param options.local Only return local accounts. + * @return Array of accounts. + */ + getInstanceDirectory(options?: { + limit?: number + offset?: number + order?: 'active' | 'new' + local?: boolean + }): Promise>> - // ====================================== - // instance/custom_emojis - // ====================================== - /** - * GET /api/v1/custom_emojis - * - * @return Array of emojis. - */ - getInstanceCustomEmojis(): Promise>>; + // ====================================== + // instance/custom_emojis + // ====================================== + /** + * View all custom emoji. + * + * @return Array of emojis. + */ + getInstanceCustomEmojis(): Promise>> - // ====================================== - // instance/announcements - // ====================================== - /** - * GET /api/v1/announcements - * - * @param with_dismissed Include announcements dismissed by the user. Defaults to false. - * @return Array of announcements. - */ - getInstanceAnnouncements( - with_dismissed?: boolean | null, - ): Promise>>; + // ====================================== + // instance/announcements + // ====================================== + /** + * View all announcements. + * + * @return Array of announcements. + */ + getInstanceAnnouncements(): Promise>> - /** - * POST /api/v1/announcements/:id/dismiss - */ - dismissInstanceAnnouncement(id: string): Promise>; + /** + * Dismiss an announcement. + * + * @param id The ID of the Announcement in the database. + */ + dismissInstanceAnnouncement(id: string): Promise>> - // ====================================== - // Emoji reactions - // ====================================== - createEmojiReaction( - id: string, - emoji: string, - ): Promise>; - deleteEmojiReaction( - id: string, - emoji: string, - ): Promise>; - getEmojiReactions(id: string): Promise>>; - getEmojiReaction( - id: string, - emoji: string, - ): Promise>; + /** + * Add a reaction to an announcement. + * + * @param id The ID of the Announcement in the database. + * @param name Unicode emoji, or the shortcode of a custom emoji. + */ + addReactionToAnnouncement(id: string, name: string): Promise>> - // ====================================== - // WebSocket - // ====================================== - userSocket(): WebSocketInterface; - publicSocket(): WebSocketInterface; - localSocket(): WebSocketInterface; - tagSocket(tag: string): WebSocketInterface; - listSocket(list_id: string): WebSocketInterface; - directSocket(): WebSocketInterface; + /** + * Remove a reaction from an announcement. + * + * @param id The ID of the Announcement in the database. + * @param name Unicode emoji, or the shortcode of a custom emoji. + */ + removeReactionFromAnnouncement(id: string, name: string): Promise>> + + // ====================================== + // Emoji reactions + // ====================================== + /** + * React to a post with a unicode emoji. + * + * @param id Target status ID. + * @param emoji A unicode emoj. + * @return Status. + **/ + createEmojiReaction(id: string, emoji: string): Promise> + /** + * Remove a reaction to a post with a unicode emoji. + * + * @param id Target status ID. + * @param emoji A unicode emoji you want to remove. + * @return Status. + **/ + deleteEmojiReaction(id: string, emoji: string): Promise> + /** + * Get an object of emoji to account mappings with accounts that reacted to the post. + * + * @param id Target status ID. + * @return Array of reaction. + **/ + getEmojiReactions(id: string): Promise>> + /** + * Get an object of emoji to account mappings with accounts that reacted to the post for a specific emoji. + * + * @param id Target status ID. + * @param emoji A unicode emoji. + * @return Reaction. + **/ + getEmojiReaction(id: string, emoji: string): Promise> + + // ====================================== + // WebSocket + // ====================================== + userSocket(): WebSocketInterface + publicSocket(): WebSocketInterface + localSocket(): WebSocketInterface + tagSocket(tag: string): WebSocketInterface + listSocket(list_id: string): WebSocketInterface + directSocket(): WebSocketInterface } export class NoImplementedError extends Error { - constructor(err?: string) { - super(err); + constructor(err?: string) { + super(err) - this.name = new.target.name; - Object.setPrototypeOf(this, new.target.prototype); - } + this.name = new.target.name + Object.setPrototypeOf(this, new.target.prototype) + } } export class ArgumentError extends Error { - constructor(err?: string) { - super(err); + constructor(err?: string) { + super(err) - this.name = new.target.name; - Object.setPrototypeOf(this, new.target.prototype); - } + this.name = new.target.name + Object.setPrototypeOf(this, new.target.prototype) + } } export class UnexpectedError extends Error { - constructor(err?: string) { - super(err); + constructor(err?: string) { + super(err) - this.name = new.target.name; - Object.setPrototypeOf(this, new.target.prototype); - } + this.name = new.target.name + Object.setPrototypeOf(this, new.target.prototype) + } } -type Instance = { - title: string; - uri: string; - urls: { - streaming_api: string; - }; - version: string; -}; +export class NodeinfoError extends Error { + constructor(err?: string) { + super(err) -/** - * Detect SNS type. - * Now support Mastodon, Pleroma and Pixelfed. - * - * @param url Base URL of SNS. - * @param proxyConfig Proxy setting, or set false if don't use proxy. - * @return SNS name. - */ -export const detector = async ( - url: string, - proxyConfig: ProxyConfig | false = false, -): Promise<"mastodon" | "pleroma" | "misskey"> => { - let options: AxiosRequestConfig = { - headers: { - "User-Agent": DEFAULT_UA, - }, - }; - if (proxyConfig) { - options = Object.assign(options, { - httpsAgent: proxyAgent(proxyConfig), - }); - } - try { - const res = await axios.get(url + "/api/v1/instance", options); - if (res.data.version.includes("Pleroma")) { - return "pleroma"; - } else { - return "mastodon"; - } - } catch (err) { - await axios.post<{}>(url + "/api/meta", {}, options); - return "misskey"; - } -}; + this.name = new.target.name + Object.setPrototypeOf(this, new.target.prototype) + } +} /** * Get client for each SNS according to megalodon interface. * + * @param sns Name of your SNS, `mastodon` or `pleroma`. * @param baseUrl hostname or base URL. * @param accessToken access token from OAuth2 authorization * @param userAgent UserAgent is specified in header on request. @@ -1522,11 +1425,30 @@ export const detector = async ( * @return Client instance for each SNS you specified. */ const generator = ( - baseUrl: string, - accessToken: string | null = null, - userAgent: string | null = null, - proxyConfig: ProxyConfig | false = false, -): MegalodonInterface => - new Misskey(baseUrl, accessToken, userAgent, proxyConfig); + sns: 'mastodon' | 'pleroma' | 'misskey' | 'friendica', + baseUrl: string, + accessToken: string | null = null, + userAgent: string | null = null, + proxyConfig: ProxyConfig | false = false +): MegalodonInterface => { + switch (sns) { + case 'pleroma': { + const pleroma = new Pleroma(baseUrl, accessToken, userAgent, proxyConfig) + return pleroma + } + case 'misskey': { + const misskey = new Misskey(baseUrl, accessToken, userAgent, proxyConfig) + return misskey + } + case 'friendica': { + const friendica = new Friendica(baseUrl, accessToken, userAgent, proxyConfig) + return friendica + } + case 'mastodon': { + const mastodon = new Mastodon(baseUrl, accessToken, userAgent, proxyConfig) + return mastodon + } + } +} -export default generator; +export default generator diff --git a/packages/megalodon/src/misskey.ts b/packages/megalodon/src/misskey.ts index 8941a3fc7..39c768591 100644 --- a/packages/megalodon/src/misskey.ts +++ b/packages/megalodon/src/misskey.ts @@ -1,130 +1,93 @@ -import FormData from "form-data"; -import AsyncLock from "async-lock"; - -import MisskeyAPI from "./misskey/api_client"; -import { DEFAULT_UA } from "./default"; -import { ProxyConfig } from "./proxy_config"; -import OAuth from "./oauth"; -import Response from "./response"; -import Entity from "./entity"; -import { - MegalodonInterface, - WebSocketInterface, - NoImplementedError, - ArgumentError, - UnexpectedError, -} from "./megalodon"; -import MegalodonEntity from "@/entity"; -import fs from "node:fs"; -import MisskeyNotificationType from "./misskey/notification"; - -type AccountCache = { - locks: AsyncLock; - accounts: Entity.Account[]; -}; +import FormData from 'form-data' +import fs from 'fs'; +import MisskeyAPI from './misskey/api_client' +import { DEFAULT_UA } from './default' +import { ProxyConfig } from './proxy_config' +import OAuth from './oauth' +import Response from './response' +import { MegalodonInterface, WebSocketInterface, NoImplementedError, ArgumentError, UnexpectedError } from './megalodon' +import { UnknownNotificationTypeError } from './notification' export default class Misskey implements MegalodonInterface { - public client: MisskeyAPI.Interface; - public converter: MisskeyAPI.Converter; - public baseUrl: string; - public proxyConfig: ProxyConfig | false; + public client: MisskeyAPI.Interface + public baseUrl: string + public proxyConfig: ProxyConfig | false - /** - * @param baseUrl hostname or base URL - * @param accessToken access token from OAuth2 authorization - * @param userAgent UserAgent is specified in header on request. - * @param proxyConfig Proxy setting, or set false if don't use proxy. - */ - constructor( - baseUrl: string, - accessToken: string | null = null, - userAgent: string | null = DEFAULT_UA, - proxyConfig: ProxyConfig | false = false, - ) { - let token = ""; - if (accessToken) { - token = accessToken; - } - let agent: string = DEFAULT_UA; - if (userAgent) { - agent = userAgent; - } - this.converter = new MisskeyAPI.Converter(baseUrl); - this.client = new MisskeyAPI.Client( - baseUrl, - token, - agent, - proxyConfig, - this.converter, - ); - this.baseUrl = baseUrl; - this.proxyConfig = proxyConfig; - } + /** + * @param baseUrl hostname or base URL + * @param accessToken access token from OAuth2 authorization + * @param userAgent UserAgent is specified in header on request. + * @param proxyConfig Proxy setting, or set false if don't use proxy. + */ + constructor( + baseUrl: string, + accessToken: string | null = null, + userAgent: string | null = DEFAULT_UA, + proxyConfig: ProxyConfig | false = false + ) { + let token: string = '' + if (accessToken) { + token = accessToken + } + let agent: string = DEFAULT_UA + if (userAgent) { + agent = userAgent + } + this.client = new MisskeyAPI.Client(baseUrl, token, agent, proxyConfig) + this.baseUrl = baseUrl + this.proxyConfig = proxyConfig + } - private baseUrlToHost(baseUrl: string): string { - return baseUrl.replace("https://", ""); - } + public cancel(): void { + return this.client.cancel() + } - public cancel(): void { - return this.client.cancel(); - } + public async registerApp( + client_name: string, + options: Partial<{ scopes: Array; redirect_uris: string; website: string }> = { + scopes: MisskeyAPI.DEFAULT_SCOPE, + redirect_uris: this.baseUrl + } + ): Promise { + return this.createApp(client_name, options).then(async appData => { + return this.generateAuthUrlAndToken(appData.client_secret).then(session => { + appData.url = session.url + appData.session_token = session.token + return appData + }) + }) + } - public async registerApp( - client_name: string, - options: Partial<{ - scopes: Array; - redirect_uris: string; - website: string; - }> = { - scopes: MisskeyAPI.DEFAULT_SCOPE, - redirect_uris: this.baseUrl, - }, - ): Promise { - return this.createApp(client_name, options).then(async (appData) => { - return this.generateAuthUrlAndToken(appData.client_secret).then( - (session) => { - appData.url = session.url; - appData.session_token = session.token; - return appData; - }, - ); - }); - } + /** + * POST /api/app/create + * + * Create an application. + * @param client_name Your application's name. + * @param options Form data. + */ + public async createApp( + client_name: string, + options: Partial<{ scopes: Array; redirect_uris: string; website: string }> = { + scopes: MisskeyAPI.DEFAULT_SCOPE, + redirect_uris: this.baseUrl + } + ): Promise { + const redirect_uris = options.redirect_uris || this.baseUrl + const scopes = options.scopes || MisskeyAPI.DEFAULT_SCOPE - /** - * POST /api/app/create - * - * Create an application. - * @param client_name Your application's name. - * @param options Form data. - */ - public async createApp( - client_name: string, - options: Partial<{ - scopes: Array; - redirect_uris: string; - website: string; - }> = { - scopes: MisskeyAPI.DEFAULT_SCOPE, - redirect_uris: this.baseUrl, - }, - ): Promise { - const redirect_uris = options.redirect_uris || this.baseUrl; - const scopes = options.scopes || MisskeyAPI.DEFAULT_SCOPE; + const params: { + name: string + description: string + permission: Array + callbackUrl: string + } = { + name: client_name, + description: '', + permission: scopes, + callbackUrl: redirect_uris + } - const params: { - name: string; - description: string; - permission: Array; - callbackUrl: string; - } = { - name: client_name, - description: "", - permission: scopes, - callbackUrl: redirect_uris, - }; - - /** + /** * The response is: { "id": "xxxxxxxxxx", @@ -136,3301 +99,2153 @@ export default class Misskey implements MegalodonInterface { "secret": "string" } */ - return this.client - .post("/api/app/create", params) - .then((res: Response) => { - const appData: OAuth.AppDataFromServer = { - id: res.data.id, - name: res.data.name, - website: null, - redirect_uri: res.data.callbackUrl, - client_id: "", - client_secret: res.data.secret, - }; - return OAuth.AppData.from(appData); - }); - } - - /** - * POST /api/auth/session/generate - */ - public async generateAuthUrlAndToken( - clientSecret: string, - ): Promise { - return this.client - .post("/api/auth/session/generate", { - appSecret: clientSecret, - }) - .then((res: Response) => res.data); - } - - // ====================================== - // apps - // ====================================== - public async verifyAppCredentials(): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - // ====================================== - // apps/oauth - // ====================================== - /** - * POST /api/auth/session/userkey - * - * @param _client_id This parameter is not used in this method. - * @param client_secret Application secret key which will be provided in createApp. - * @param session_token Session token string which will be provided in generateAuthUrlAndToken. - * @param _redirect_uri This parameter is not used in this method. - */ - public async fetchAccessToken( - _client_id: string | null, - client_secret: string, - session_token: string, - _redirect_uri?: string, - ): Promise { - return this.client - .post("/api/auth/session/userkey", { - appSecret: client_secret, - token: session_token, - }) - .then((res) => { - const token = new OAuth.TokenData( - res.data.accessToken, - "misskey", - "", - 0, - null, - null, - ); - return token; - }); - } - - public async refreshToken( - _client_id: string, - _client_secret: string, - _refresh_token: string, - ): Promise { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - public async revokeToken( - _client_id: string, - _client_secret: string, - _token: string, - ): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - // ====================================== - // accounts - // ====================================== - public async registerAccount( - _username: string, - _email: string, - _password: string, - _agreement: boolean, - _locale: string, - _reason?: string | null, - ): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - /** - * POST /api/i - */ - public async verifyAccountCredentials(): Promise> { - return this.client - .post("/api/i") - .then((res) => { - return Object.assign(res, { - data: this.converter.userDetail( - res.data, - this.baseUrlToHost(this.baseUrl), - ), - }); - }); - } - - /** - * POST /api/i/update - */ - public async updateCredentials(options?: { - discoverable?: boolean; - bot?: boolean; - display_name?: string; - note?: string; - avatar?: string; - header?: string; - locked?: boolean; - source?: { - privacy?: string; - sensitive?: boolean; - language?: string; - } | null; - fields_attributes?: Array<{ name: string; value: string }>; - }): Promise> { - let params = {}; - if (options) { - if (options.bot !== undefined) { - params = Object.assign(params, { - isBot: options.bot, - }); - } - if (options.display_name) { - params = Object.assign(params, { - name: options.display_name, - }); - } - if (options.note) { - params = Object.assign(params, { - description: options.note, - }); - } - if (options.locked !== undefined) { - params = Object.assign(params, { - isLocked: options.locked, - }); - } - if (options.source) { - if (options.source.language) { - params = Object.assign(params, { - lang: options.source.language, - }); - } - if (options.source.sensitive) { - params = Object.assign(params, { - alwaysMarkNsfw: options.source.sensitive, - }); - } - } - } - return this.client - .post("/api/i", params) - .then((res) => { - return Object.assign(res, { - data: this.converter.userDetail( - res.data, - this.baseUrlToHost(this.baseUrl), - ), - }); - }); - } - - /** - * POST /api/users/show - */ - public async getAccount(id: string): Promise> { - return this.client - .post("/api/users/show", { - userId: id, - }) - .then((res) => { - return Object.assign(res, { - data: this.converter.userDetail( - res.data, - this.baseUrlToHost(this.baseUrl), - ), - }); - }); - } - - public async getAccountByName( - user: string, - host: string | null, - ): Promise> { - return this.client - .post("/api/users/show", { - username: user, - host: host ?? null, - }) - .then((res) => { - return Object.assign(res, { - data: this.converter.userDetail( - res.data, - this.baseUrlToHost(this.baseUrl), - ), - }); - }); - } - - /** - * POST /api/users/notes - */ - public async getAccountStatuses( - id: string, - options?: { - limit?: number; - max_id?: string; - since_id?: string; - pinned?: boolean; - exclude_replies: boolean; - exclude_reblogs: boolean; - only_media?: boolean; - }, - ): Promise>> { - const accountCache = this.getFreshAccountCache(); - - if (options?.pinned) { - return this.client - .post("/api/users/show", { - userId: id, - }) - .then(async (res) => { - if (res.data.pinnedNotes) { - return { - ...res, - data: await Promise.all( - res.data.pinnedNotes.map((n) => - this.noteWithDetails( - n, - this.baseUrlToHost(this.baseUrl), - accountCache, - ), - ), - ), - }; - } - return { ...res, data: [] }; - }); - } - - let params = { - userId: id, - }; - if (options) { - if (options.limit) { - params = Object.assign(params, { - limit: options.limit, - }); - } else { - params = Object.assign(params, { - limit: 20, - }); - } - if (options.max_id) { - params = Object.assign(params, { - untilId: options.max_id, - }); - } - if (options.since_id) { - params = Object.assign(params, { - sinceId: options.since_id, - }); - } - if (options.exclude_replies) { - params = Object.assign(params, { - includeReplies: false, - }); - } - if (options.exclude_reblogs) { - params = Object.assign(params, { - includeMyRenotes: false, - }); - } - if (options.only_media) { - params = Object.assign(params, { - withFiles: options.only_media, - }); - } - } else { - params = Object.assign(params, { - limit: 20, - }); - } - return this.client - .post>("/api/users/notes", params) - .then(async (res) => { - const statuses: Array = await Promise.all( - res.data.map((note) => - this.noteWithDetails( - note, - this.baseUrlToHost(this.baseUrl), - accountCache, - ), - ), - ); - return Object.assign(res, { - data: statuses, - }); - }); - } - - public async getAccountFavourites( - id: string, - options?: { - limit?: number; - max_id?: string; - since_id?: string; - }, - ): Promise>> { - const accountCache = this.getFreshAccountCache(); - - let params = { - userId: id, - }; - if (options) { - if (options.limit) { - params = Object.assign(params, { - limit: options.limit <= 100 ? options.limit : 100, - }); - } - if (options.max_id) { - params = Object.assign(params, { - untilId: options.max_id, - }); - } - if (options.since_id) { - params = Object.assign(params, { - sinceId: options.since_id, - }); - } - } - return this.client - .post>("/api/users/reactions", params) - .then(async (res) => { - return Object.assign(res, { - data: await Promise.all( - res.data.map((fav) => - this.noteWithDetails( - fav.note, - this.baseUrlToHost(this.baseUrl), - accountCache, - ), - ), - ), - }); - }); - } - - public async subscribeAccount( - _id: string, - ): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - public async unsubscribeAccount( - _id: string, - ): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - /** - * POST /api/users/followers - */ - public async getAccountFollowers( - id: string, - options?: { - limit?: number; - max_id?: string; - since_id?: string; - }, - ): Promise>> { - let params = { - userId: id, - }; - if (options) { - if (options.limit) { - params = Object.assign(params, { - limit: options.limit <= 100 ? options.limit : 100, - }); - } else { - params = Object.assign(params, { - limit: 40, - }); - } - } else { - params = Object.assign(params, { - limit: 40, - }); - } - return this.client - .post>("/api/users/followers", params) - .then(async (res) => { - return Object.assign(res, { - data: await Promise.all( - res.data.map(async (f) => - this.getAccount(f.followerId).then((p) => p.data), - ), - ), - }); - }); - } - - /** - * POST /api/users/following - */ - public async getAccountFollowing( - id: string, - options?: { - limit?: number; - max_id?: string; - since_id?: string; - }, - ): Promise>> { - let params = { - userId: id, - }; - if (options) { - if (options.limit) { - params = Object.assign(params, { - limit: options.limit <= 100 ? options.limit : 100, - }); - } - } - return this.client - .post>("/api/users/following", params) - .then(async (res) => { - return Object.assign(res, { - data: await Promise.all( - res.data.map(async (f) => - this.getAccount(f.followeeId).then((p) => p.data), - ), - ), - }); - }); - } - - public async getAccountLists( - _id: string, - ): Promise>> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - public async getIdentityProof( - _id: string, - ): Promise>> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - /** - * POST /api/following/create - */ - public async followAccount( - id: string, - _options?: { reblog?: boolean }, - ): Promise> { - await this.client.post<{}>("/api/following/create", { - userId: id, - }); - return this.client - .post("/api/users/relation", { - userId: id, - }) - .then((res) => { - return Object.assign(res, { - data: this.converter.relation(res.data), - }); - }); - } - - /** - * POST /api/following/delete - */ - public async unfollowAccount( - id: string, - ): Promise> { - await this.client.post<{}>("/api/following/delete", { - userId: id, - }); - return this.client - .post("/api/users/relation", { - userId: id, - }) - .then((res) => { - return Object.assign(res, { - data: this.converter.relation(res.data), - }); - }); - } - - /** - * POST /api/blocking/create - */ - public async blockAccount( - id: string, - ): Promise> { - await this.client.post<{}>("/api/blocking/create", { - userId: id, - }); - return this.client - .post("/api/users/relation", { - userId: id, - }) - .then((res) => { - return Object.assign(res, { - data: this.converter.relation(res.data), - }); - }); - } - - /** - * POST /api/blocking/delete - */ - public async unblockAccount( - id: string, - ): Promise> { - await this.client.post<{}>("/api/blocking/delete", { - userId: id, - }); - return this.client - .post("/api/users/relation", { - userId: id, - }) - .then((res) => { - return Object.assign(res, { - data: this.converter.relation(res.data), - }); - }); - } - - /** - * POST /api/mute/create - */ - public async muteAccount( - id: string, - _notifications: boolean, - ): Promise> { - await this.client.post<{}>("/api/mute/create", { - userId: id, - }); - return this.client - .post("/api/users/relation", { - userId: id, - }) - .then((res) => { - return Object.assign(res, { - data: this.converter.relation(res.data), - }); - }); - } - - /** - * POST /api/mute/delete - */ - public async unmuteAccount( - id: string, - ): Promise> { - await this.client.post<{}>("/api/mute/delete", { - userId: id, - }); - return this.client - .post("/api/users/relation", { - userId: id, - }) - .then((res) => { - return Object.assign(res, { - data: this.converter.relation(res.data), - }); - }); - } - - public async pinAccount(_id: string): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - public async unpinAccount( - _id: string, - ): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - /** - * POST /api/users/relation - * - * @param id The accountID, for example `'1sdfag'` - */ - public async getRelationship( - id: string, - ): Promise> { - return this.client - .post("/api/users/relation", { - userId: id, - }) - .then((res) => { - return Object.assign(res, { - data: this.converter.relation(res.data), - }); - }); - } - - /** - * POST /api/users/relation - * - * @param id Array of account ID, for example `['1sdfag', 'ds12aa']`. - */ - public async getRelationships( - ids: Array, - ): Promise>> { - return Promise.all(ids.map((id) => this.getRelationship(id))).then( - (results) => ({ - ...results[0], - data: results.map((r) => r.data), - }), - ); - } - - /** - * POST /api/users/search - */ - public async searchAccount( - q: string, - options?: { - following?: boolean; - resolve?: boolean; - limit?: number; - max_id?: string; - since_id?: string; - }, - ): Promise>> { - let params = { - query: q, - detail: true, - }; - if (options) { - if (options.resolve !== undefined) { - params = Object.assign(params, { - localOnly: options.resolve, - }); - } - if (options.limit) { - params = Object.assign(params, { - limit: options.limit, - }); - } else { - params = Object.assign(params, { - limit: 40, - }); - } - } else { - params = Object.assign(params, { - limit: 40, - }); - } - return this.client - .post>("/api/users/search", params) - .then((res) => { - return Object.assign(res, { - data: res.data.map((u) => - this.converter.userDetail(u, this.baseUrlToHost(this.baseUrl)), - ), - }); - }); - } - - // ====================================== - // accounts/bookmarks - // ====================================== - /** - * POST /api/i/favorites - */ - public async getBookmarks(options?: { - limit?: number; - max_id?: string; - since_id?: string; - min_id?: string; - }): Promise>> { - const accountCache = this.getFreshAccountCache(); - - let params = {}; - if (options) { - if (options.limit) { - params = Object.assign(params, { - limit: options.limit <= 100 ? options.limit : 100, - }); - } else { - params = Object.assign(params, { - limit: 40, - }); - } - if (options.max_id) { - params = Object.assign(params, { - untilId: options.max_id, - }); - } - if (options.min_id) { - params = Object.assign(params, { - sinceId: options.min_id, - }); - } - } else { - params = Object.assign(params, { - limit: 40, - }); - } - return this.client - .post>("/api/i/favorites", params) - .then(async (res) => { - return Object.assign(res, { - data: await Promise.all( - res.data.map((s) => - this.noteWithDetails( - s.note, - this.baseUrlToHost(this.baseUrl), - accountCache, - ), - ), - ), - }); - }); - } - - // ====================================== - // accounts/favourites - // ====================================== - public async getFavourites(options?: { - limit?: number; - max_id?: string; - min_id?: string; - }): Promise>> { - const userId = await this.client - .post("/api/i") - .then((res) => res.data.id); - return this.getAccountFavourites(userId, options); - } - - // ====================================== - // accounts/mutes - // ====================================== - /** - * POST /api/mute/list - */ - public async getMutes(options?: { - limit?: number; - max_id?: string; - min_id?: string; - }): Promise>> { - let params = {}; - if (options) { - if (options.limit) { - params = Object.assign(params, { - limit: options.limit, - }); - } else { - params = Object.assign(params, { - limit: 40, - }); - } - if (options.max_id) { - params = Object.assign(params, { - untilId: options.max_id, - }); - } - if (options.min_id) { - params = Object.assign(params, { - sinceId: options.min_id, - }); - } - } else { - params = Object.assign(params, { - limit: 40, - }); - } - return this.client - .post>("/api/mute/list", params) - .then((res) => { - return Object.assign(res, { - data: res.data.map((mute) => - this.converter.userDetail( - mute.mutee, - this.baseUrlToHost(this.baseUrl), - ), - ), - }); - }); - } - - // ====================================== - // accounts/blocks - // ====================================== - /** - * POST /api/blocking/list - */ - public async getBlocks(options?: { - limit?: number; - max_id?: string; - min_id?: string; - }): Promise>> { - let params = {}; - if (options) { - if (options.limit) { - params = Object.assign(params, { - limit: options.limit, - }); - } else { - params = Object.assign(params, { - limit: 40, - }); - } - if (options.max_id) { - params = Object.assign(params, { - untilId: options.max_id, - }); - } - if (options.min_id) { - params = Object.assign(params, { - sinceId: options.min_id, - }); - } - } else { - params = Object.assign(params, { - limit: 40, - }); - } - return this.client - .post>("/api/blocking/list", params) - .then((res) => { - return Object.assign(res, { - data: res.data.map((blocking) => - this.converter.userDetail( - blocking.blockee, - this.baseUrlToHost(this.baseUrl), - ), - ), - }); - }); - } - - // ====================================== - // accounts/domain_blocks - // ====================================== - public async getDomainBlocks(_options?: { - limit?: number; - max_id?: string; - min_id?: string; - }): Promise>> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - public async blockDomain(_domain: string): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - public async unblockDomain(_domain: string): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - // ====================================== - // accounts/filters - // ====================================== - public async getFilters(): Promise>> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - public async getFilter(_id: string): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - public async createFilter( - _phrase: string, - _context: Array, - _options?: { - irreversible?: boolean; - whole_word?: boolean; - expires_in?: string; - }, - ): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - public async updateFilter( - _id: string, - _phrase: string, - _context: Array, - _options?: { - irreversible?: boolean; - whole_word?: boolean; - expires_in?: string; - }, - ): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - public async deleteFilter(_id: string): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - // ====================================== - // accounts/reports - // ====================================== - /** - * POST /api/users/report-abuse - */ - public async report( - account_id: string, - comment: string, - _options?: { - status_ids?: Array; - forward?: boolean; - }, - ): Promise> { - return this.client - .post<{}>("/api/users/report-abuse", { - userId: account_id, - comment: comment, - }) - .then((res) => { - return Object.assign(res, { - data: { - id: "", - action_taken: "", - comment: comment, - account_id: account_id, - status_ids: [], - }, - }); - }); - } - - // ====================================== - // accounts/follow_requests - // ====================================== - /** - * POST /api/following/requests/list - */ - public async getFollowRequests( - _limit?: number, - ): Promise>> { - return this.client - .post>( - "/api/following/requests/list", - ) - .then((res) => { - return Object.assign(res, { - data: res.data.map((r) => this.converter.user(r.follower)), - }); - }); - } - - /** - * POST /api/following/requests/accept - */ - public async acceptFollowRequest( - id: string, - ): Promise> { - await this.client.post<{}>("/api/following/requests/accept", { - userId: id, - }); - return this.client - .post("/api/users/relation", { - userId: id, - }) - .then((res) => { - return Object.assign(res, { - data: this.converter.relation(res.data), - }); - }); - } - - /** - * POST /api/following/requests/reject - */ - public async rejectFollowRequest( - id: string, - ): Promise> { - await this.client.post<{}>("/api/following/requests/reject", { - userId: id, - }); - return this.client - .post("/api/users/relation", { - userId: id, - }) - .then((res) => { - return Object.assign(res, { - data: this.converter.relation(res.data), - }); - }); - } - - // ====================================== - // accounts/endorsements - // ====================================== - public async getEndorsements(_options?: { - limit?: number; - max_id?: string; - since_id?: string; - }): Promise>> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - // ====================================== - // accounts/featured_tags - // ====================================== - public async getFeaturedTags(): Promise>> { - return this.getAccountFeaturedTags(); - } - - public async getAccountFeaturedTags(): Promise< - Response> - > { - const tags: Entity.FeaturedTag[] = []; - const res: Response = { - headers: undefined, - statusText: "", - status: 200, - data: tags, - }; - return new Promise((resolve) => resolve(res)); - } - - public async createFeaturedTag( - _name: string, - ): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - public async deleteFeaturedTag(_id: string): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - public async getSuggestedTags(): Promise>> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - // ====================================== - // accounts/preferences - // ====================================== - public async getPreferences(): Promise> { - return this.client - .post("/api/i") - .then(async (res) => { - return Object.assign(res, { - data: this.converter.userPreferences( - res.data, - await this.getDefaultPostPrivacy(), - ), - }); - }); - } - - // ====================================== - // accounts/suggestions - // ====================================== - /** - * POST /api/users/recommendation - */ - public async getSuggestions( - limit?: number, - ): Promise>> { - let params = {}; - if (limit) { - params = Object.assign(params, { - limit: limit, - }); - } - return this.client - .post>( - "/api/users/recommendation", - params, - ) - .then((res) => ({ - ...res, - data: res.data.map((u) => - this.converter.userDetail(u, this.baseUrlToHost(this.baseUrl)), - ), - })); - } - - // ====================================== - // accounts/tags - // ====================================== - public async getFollowedTags(): Promise>> { - const tags: Entity.Tag[] = []; - const res: Response = { - headers: undefined, - statusText: "", - status: 200, - data: tags, - }; - return new Promise((resolve) => resolve(res)); - } - - public async getTag(_id: string): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - public async followTag(_id: string): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - public async unfollowTag(_id: string): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - // ====================================== - // statuses - // ====================================== - public async postStatus( - status: string, - options?: { - media_ids?: Array; - poll?: { - options: Array; - expires_in: number; - multiple?: boolean; - hide_totals?: boolean; - }; - in_reply_to_id?: string; - sensitive?: boolean; - spoiler_text?: string; - visibility?: "public" | "unlisted" | "private" | "direct"; - scheduled_at?: string; - language?: string; - quote_id?: string; - }, - ): Promise> { - let params = { - text: status, - }; - if (options) { - if (options.media_ids) { - params = Object.assign(params, { - fileIds: options.media_ids, - }); - } - if (options.poll) { - let pollParam = { - choices: options.poll.options, - expiresAt: null, - expiredAfter: options.poll.expires_in * 1000, - }; - if (options.poll.multiple !== undefined) { - pollParam = Object.assign(pollParam, { - multiple: options.poll.multiple, - }); - } - params = Object.assign(params, { - poll: pollParam, - }); - } - if (options.in_reply_to_id) { - params = Object.assign(params, { - replyId: options.in_reply_to_id, - }); - } - if (options.sensitive) { - params = Object.assign(params, { - cw: "", - }); - } - if (options.spoiler_text) { - params = Object.assign(params, { - cw: options.spoiler_text, - }); - } - if (options.visibility) { - params = Object.assign(params, { - visibility: this.converter.encodeVisibility(options.visibility), - }); - } - if (options.quote_id) { - params = Object.assign(params, { - renoteId: options.quote_id, - }); - } - } - return this.client - .post("/api/notes/create", params) - .then(async (res) => ({ - ...res, - data: await this.noteWithDetails( - res.data.createdNote, - this.baseUrlToHost(this.baseUrl), - this.getFreshAccountCache(), - ), - })); - } - - /** - * POST /api/notes/show - */ - public async getStatus(id: string): Promise> { - return this.client - .post("/api/notes/show", { - noteId: id, - }) - .then(async (res) => ({ - ...res, - data: await this.noteWithDetails( - res.data, - this.baseUrlToHost(this.baseUrl), - this.getFreshAccountCache(), - ), - })); - } - - private getFreshAccountCache(): AccountCache { - return { - locks: new AsyncLock(), - accounts: [], - }; - } - - public async notificationWithDetails( - n: MisskeyAPI.Entity.Notification, - host: string, - cache: AccountCache, - ): Promise { - const notification = this.converter.notification(n, host); - if (n.note) - notification.status = await this.noteWithDetails(n.note, host, cache); - if (notification.account) - notification.account = ( - await this.getAccount(notification.account.id) - ).data; - return notification; - } - - public async noteWithDetails( - n: MisskeyAPI.Entity.Note, - host: string, - cache: AccountCache, - ): Promise { - const status = await this.addUserDetailsToStatus( - this.converter.note(n, host), - cache, - ); - status.bookmarked = await this.isStatusBookmarked(n.id); - return this.addMentionsToStatus(status, cache); - } - - public async isStatusBookmarked(id: string): Promise { - return this.client - .post("/api/notes/state", { - noteId: id, - }) - .then((p) => p.data.isFavorited ?? false); - } - - public async addUserDetailsToStatus( - status: Entity.Status, - cache: AccountCache, - ): Promise { - if ( - status.account.followers_count === 0 && - status.account.followers_count === 0 && - status.account.statuses_count === 0 - ) - status.account = - (await this.getAccountCached( - status.account.id, - status.account.acct, - cache, - )) ?? status.account; - - if (status.reblog != null) - status.reblog = await this.addUserDetailsToStatus(status.reblog, cache); - - if (status.quote != null) - status.quote = await this.addUserDetailsToStatus(status.quote, cache); - - return status; - } - - public async addMentionsToStatus( - status: Entity.Status, - cache: AccountCache, - ): Promise { - if (status.mentions.length > 0) return status; - - if (status.reblog != null) - status.reblog = await this.addMentionsToStatus(status.reblog, cache); - - if (status.quote != null) - status.quote = await this.addMentionsToStatus(status.quote, cache); - - const idx = status.account.acct.indexOf("@"); - const origin = idx < 0 ? null : status.account.acct.substring(idx + 1); - - status.mentions = ( - await this.getMentions(status.plain_content!, origin, cache) - ).filter((p) => p != null); - for (const m of status.mentions.filter( - (value, index, array) => array.indexOf(value) === index, - )) { - const regexFull = new RegExp( - `(?<=^|\\s|>)@${m.acct}(?=[^a-zA-Z0-9]|$)`, - "gi", - ); - const regexLocalUser = new RegExp( - `(?<=^|\\s|>)@${m.acct}@${this.baseUrlToHost( - this.baseUrl, - )}(?=[^a-zA-Z0-9]|$)`, - "gi", - ); - const regexRemoteUser = new RegExp( - `(?<=^|\\s|>)@${m.username}(?=[^a-zA-Z0-9@]|$)`, - "gi", - ); - - if (m.acct == m.username) { - status.content = status.content.replace(regexLocalUser, `@${m.acct}`); - } else if (!status.content.match(regexFull)) { - status.content = status.content.replace(regexRemoteUser, `@${m.acct}`); - } - - status.content = status.content.replace( - regexFull, - `@${m.acct}`, - ); - } - return status; - } - - public async getMentions( - text: string, - origin: string | null, - cache: AccountCache, - ): Promise { - const mentions: Entity.Mention[] = []; - - if (text == undefined) return mentions; - - const mentionMatch = text.matchAll( - /(?<=^|\s)@(?[a-zA-Z0-9_]+)(?:@(?[a-zA-Z0-9-.]+\.[a-zA-Z0-9-]+)|)(?=[^a-zA-Z0-9]|$)/g, - ); - - for (const m of mentionMatch) { - try { - if (m.groups == null) continue; - - const account = await this.getAccountByNameCached( - m.groups.user, - m.groups.host ?? origin, - cache, - ); - - if (account == null) continue; - - mentions.push({ - id: account.id, - url: account.url, - username: account.username, - acct: account.acct, - }); - } catch {} - } - - return mentions; - } - - public async getAccountByNameCached( - user: string, - host: string | null, - cache: AccountCache, - ): Promise { - const acctToFind = host == null ? user : `${user}@${host}`; - - return await cache.locks.acquire(acctToFind, async () => { - const cacheHit = cache.accounts.find((p) => p.acct === acctToFind); - const account = - cacheHit ?? (await this.getAccountByName(user, host ?? null)).data; - - if (!account) { - return null; - } - - if (cacheHit == null) { - cache.accounts.push(account); - } - - return account; - }); - } - - public async getAccountCached( - id: string, - acct: string, - cache: AccountCache, - ): Promise { - return await cache.locks.acquire(acct, async () => { - const cacheHit = cache.accounts.find((p) => p.id === id); - const account = cacheHit ?? (await this.getAccount(id)).data; - - if (!account) { - return null; - } - - if (cacheHit == null) { - cache.accounts.push(account); - } - - return account; - }); - } - - public async editStatus( - _id: string, - _options: { - status?: string; - spoiler_text?: string; - sensitive?: boolean; - media_ids?: Array; - poll?: { - options?: Array; - expires_in?: number; - multiple?: boolean; - hide_totals?: boolean; - }; - }, - ): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - /** - * POST /api/notes/delete - */ - public async deleteStatus(id: string): Promise> { - return this.client.post<{}>("/api/notes/delete", { - noteId: id, - }); - } - - /** - * POST /api/notes/children - */ - public async getStatusContext( - id: string, - options?: { limit?: number; max_id?: string; since_id?: string }, - ): Promise> { - let params = { - noteId: id, - }; - if (options) { - if (options.limit) { - params = Object.assign(params, { - limit: options.limit, - depth: 12, - }); - } else { - params = Object.assign(params, { - limit: 30, - depth: 12, - }); - } - if (options.max_id) { - params = Object.assign(params, { - untilId: options.max_id, - }); - } - if (options.since_id) { - params = Object.assign(params, { - sinceId: options.since_id, - }); - } - } else { - params = Object.assign(params, { - limit: 30, - depth: 12, - }); - } - return this.client - .post>("/api/notes/children", params) - .then(async (res) => { - const accountCache = this.getFreshAccountCache(); - const conversation = await this.client.post< - Array - >("/api/notes/conversation", params); - const parents = await Promise.all( - conversation.data.map((n) => - this.noteWithDetails( - n, - this.baseUrlToHost(this.baseUrl), - accountCache, - ), - ), - ); - - const context: Entity.Context = { - ancestors: parents.reverse(), - descendants: this.dfs( - await Promise.all( - res.data.map((n) => - this.noteWithDetails( - n, - this.baseUrlToHost(this.baseUrl), - accountCache, - ), - ), - ), - ), - }; - return { - ...res, - data: context, - }; - }); - } - - private dfs(graph: Entity.Status[]) { - // we don't need to run dfs if we have zero or one elements - if (graph.length <= 1) { - return graph; - } - - // sort the graph first, so we can grab the correct starting point - graph = graph.sort((a, b) => { - if (a.id < b.id) return -1; - if (a.id > b.id) return 1; - return 0; - }); - - const initialPostId = graph[0].in_reply_to_id; - - // populate stack with all top level replies - const stack = graph - .filter((reply) => reply.in_reply_to_id === initialPostId) - .reverse(); - const visited = new Set(); - const result = []; - - while (stack.length) { - const currentPost = stack.pop(); - - if (currentPost === undefined) return result; - - if (!visited.has(currentPost)) { - visited.add(currentPost); - result.push(currentPost); - - for (const reply of graph - .filter((reply) => reply.in_reply_to_id === currentPost.id) - .reverse()) { - stack.push(reply); - } - } - } - - return result; - } - - public async getStatusHistory(): Promise>> { - // FIXME: stub, implement once we have note edit history in the database - const history: Entity.StatusEdit[] = []; - const res: Response = { - headers: undefined, - statusText: "", - status: 200, - data: history, - }; - return new Promise((resolve) => resolve(res)); - } - - /** - * POST /api/notes/renotes - */ - public async getStatusRebloggedBy( - id: string, - ): Promise>> { - return this.client - .post>("/api/notes/renotes", { - noteId: id, - }) - .then(async (res) => ({ - ...res, - data: ( - await Promise.all(res.data.map((n) => this.getAccount(n.user.id))) - ).map((p) => p.data), - })); - } - - public async getStatusFavouritedBy( - id: string, - ): Promise>> { - return this.client - .post>("/api/notes/reactions", { - noteId: id, - }) - .then(async (res) => ({ - ...res, - data: ( - await Promise.all(res.data.map((n) => this.getAccount(n.user.id))) - ).map((p) => p.data), - })); - } - - public async favouriteStatus(id: string): Promise> { - return this.createEmojiReaction(id, await this.getDefaultFavoriteEmoji()); - } - - private async getDefaultFavoriteEmoji(): Promise { - // NOTE: get-unsecure is calckey's extension. - // Misskey doesn't have this endpoint and regular `/i/registry/get` won't work - // unless you have a 'nativeToken', which is reserved for the frontend webapp. - - return await this.client - .post>("/api/i/registry/get-unsecure", { - key: "reactions", - scope: ["client", "base"], - }) - .then((res) => res.data[0] ?? "⭐"); - } - - private async getDefaultPostPrivacy(): Promise< - "public" | "unlisted" | "private" | "direct" - > { - // NOTE: get-unsecure is calckey's extension. - // Misskey doesn't have this endpoint and regular `/i/registry/get` won't work - // unless you have a 'nativeToken', which is reserved for the frontend webapp. - - return this.client - .post("/api/i/registry/get-unsecure", { - key: "defaultNoteVisibility", - scope: ["client", "base"], - }) - .then((res) => { - if ( - !res.data || - (res.data != "public" && - res.data != "home" && - res.data != "followers" && - res.data != "specified") - ) - return "public"; - return this.converter.visibility(res.data); - }) - .catch((_) => "public"); - } - - public async unfavouriteStatus(id: string): Promise> { - // NOTE: Misskey allows only one reaction per status, so we don't need to care what that emoji was. - return this.deleteEmojiReaction(id, ""); - } - - /** - * POST /api/notes/create - */ - public async reblogStatus(id: string): Promise> { - return this.client - .post("/api/notes/create", { - renoteId: id, - }) - .then(async (res) => ({ - ...res, - data: await this.noteWithDetails( - res.data.createdNote, - this.baseUrlToHost(this.baseUrl), - this.getFreshAccountCache(), - ), - })); - } - - /** - * POST /api/notes/unrenote - */ - public async unreblogStatus(id: string): Promise> { - await this.client.post<{}>("/api/notes/unrenote", { - noteId: id, - }); - return this.client - .post("/api/notes/show", { - noteId: id, - }) - .then(async (res) => ({ - ...res, - data: await this.noteWithDetails( - res.data, - this.baseUrlToHost(this.baseUrl), - this.getFreshAccountCache(), - ), - })); - } - - /** - * POST /api/notes/favorites/create - */ - public async bookmarkStatus(id: string): Promise> { - await this.client.post<{}>("/api/notes/favorites/create", { - noteId: id, - }); - return this.client - .post("/api/notes/show", { - noteId: id, - }) - .then(async (res) => ({ - ...res, - data: await this.noteWithDetails( - res.data, - this.baseUrlToHost(this.baseUrl), - this.getFreshAccountCache(), - ), - })); - } - - /** - * POST /api/notes/favorites/delete - */ - public async unbookmarkStatus(id: string): Promise> { - await this.client.post<{}>("/api/notes/favorites/delete", { - noteId: id, - }); - return this.client - .post("/api/notes/show", { - noteId: id, - }) - .then(async (res) => ({ - ...res, - data: await this.noteWithDetails( - res.data, - this.baseUrlToHost(this.baseUrl), - this.getFreshAccountCache(), - ), - })); - } - - public async muteStatus(_id: string): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - public async unmuteStatus(_id: string): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - /** - * POST /api/i/pin - */ - public async pinStatus(id: string): Promise> { - await this.client.post<{}>("/api/i/pin", { - noteId: id, - }); - return this.client - .post("/api/notes/show", { - noteId: id, - }) - .then(async (res) => ({ - ...res, - data: await this.noteWithDetails( - res.data, - this.baseUrlToHost(this.baseUrl), - this.getFreshAccountCache(), - ), - })); - } - - /** - * POST /api/i/unpin - */ - public async unpinStatus(id: string): Promise> { - await this.client.post<{}>("/api/i/unpin", { - noteId: id, - }); - return this.client - .post("/api/notes/show", { - noteId: id, - }) - .then(async (res) => ({ - ...res, - data: await this.noteWithDetails( - res.data, - this.baseUrlToHost(this.baseUrl), - this.getFreshAccountCache(), - ), - })); - } - - /** - * Convert a Unicode emoji or custom emoji name to a Misskey reaction. - * @see Misskey's reaction-lib.ts - */ - private reactionName(name: string): string { - // See: https://github.com/tc39/proposal-regexp-unicode-property-escapes#matching-emoji - const isUnicodeEmoji = - /\p{Emoji_Modifier_Base}\p{Emoji_Modifier}?|\p{Emoji_Presentation}|\p{Emoji}\uFE0F/gu.test( - name, - ); - if (isUnicodeEmoji) { - return name; - } - return `:${name}:`; - } - - /** - * POST /api/notes/reactions/create - */ - public async reactStatus( - id: string, - name: string, - ): Promise> { - await this.client.post<{}>("/api/notes/reactions/create", { - noteId: id, - reaction: this.reactionName(name), - }); - return this.client - .post("/api/notes/show", { - noteId: id, - }) - .then(async (res) => ({ - ...res, - data: await this.noteWithDetails( - res.data, - this.baseUrlToHost(this.baseUrl), - this.getFreshAccountCache(), - ), - })); - } - - /** - * POST /api/notes/reactions/delete - */ - public async unreactStatus( - id: string, - name: string, - ): Promise> { - await this.client.post<{}>("/api/notes/reactions/delete", { - noteId: id, - reaction: this.reactionName(name), - }); - return this.client - .post("/api/notes/show", { - noteId: id, - }) - .then(async (res) => ({ - ...res, - data: await this.noteWithDetails( - res.data, - this.baseUrlToHost(this.baseUrl), - this.getFreshAccountCache(), - ), - })); - } - - // ====================================== - // statuses/media - // ====================================== - /** - * POST /api/drive/files/create - */ - public async uploadMedia( - file: any, - options?: { description?: string; focus?: string }, - ): Promise> { - const formData = new FormData(); - formData.append("file", fs.createReadStream(file.path), { + return this.client.post('/api/app/create', params).then((res: Response) => { + const appData: OAuth.AppDataFromServer = { + id: res.data.id, + name: res.data.name, + website: null, + redirect_uri: res.data.callbackUrl, + client_id: '', + client_secret: res.data.secret + } + return OAuth.AppData.from(appData) + }) + } + + /** + * POST /api/auth/session/generate + */ + public async generateAuthUrlAndToken(clientSecret: string): Promise { + return this.client + .post('/api/auth/session/generate', { + appSecret: clientSecret + }) + .then((res: Response) => res.data) + } + + // ====================================== + // apps + // ====================================== + public async verifyAppCredentials(): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + // ====================================== + // apps/oauth + // ====================================== + /** + * POST /api/auth/session/userkey + * + * @param _client_id This parameter is not used in this method. + * @param client_secret Application secret key which will be provided in createApp. + * @param session_token Session token string which will be provided in generateAuthUrlAndToken. + * @param _redirect_uri This parameter is not used in this method. + */ + public async fetchAccessToken( + _client_id: string | null, + client_secret: string, + session_token: string, + _redirect_uri?: string + ): Promise { + return this.client + .post('/api/auth/session/userkey', { + appSecret: client_secret, + token: session_token + }) + .then(res => { + const token = new OAuth.TokenData(res.data.accessToken, 'misskey', '', 0, null, null) + return token + }) + } + + public async refreshToken(_client_id: string, _client_secret: string, _refresh_token: string): Promise { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async revokeToken(_client_id: string, _client_secret: string, _token: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + // ====================================== + // accounts + // ====================================== + public async registerAccount( + _username: string, + _email: string, + _password: string, + _agreement: boolean, + _locale: string, + _reason?: string | null + ): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + /** + * POST /api/i + */ + public async verifyAccountCredentials(): Promise> { + return this.client.post('/api/i').then(res => { + return Object.assign(res, { + data: MisskeyAPI.Converter.userDetail(res.data) + }) + }) + } + + /** + * POST /api/i/update + */ + public async updateCredentials(options?: { + discoverable?: boolean + bot?: boolean + display_name?: string + note?: string + avatar?: string + header?: string + locked?: boolean + source?: { + privacy?: string + sensitive?: boolean + language?: string + } | null + fields_attributes?: Array<{ name: string; value: string }> + }): Promise> { + let params = {} + if (options) { + if (options.bot !== undefined) { + params = Object.assign(params, { + isBot: options.bot + }) + } + if (options.display_name) { + params = Object.assign(params, { + name: options.display_name + }) + } + if (options.note) { + params = Object.assign(params, { + description: options.note + }) + } + if (options.locked !== undefined) { + params = Object.assign(params, { + isLocked: options.locked + }) + } + if (options.source) { + if (options.source.language) { + params = Object.assign(params, { + lang: options.source.language + }) + } + if (options.source.sensitive) { + params = Object.assign(params, { + alwaysMarkNsfw: options.source.sensitive + }) + } + } + } + return this.client.post('/api/i', params).then(res => { + return Object.assign(res, { + data: MisskeyAPI.Converter.userDetail(res.data) + }) + }) + } + + /** + * POST /api/users/show + */ + public async getAccount(id: string): Promise> { + return this.client + .post('/api/users/show', { + userId: id + }) + .then(res => { + return Object.assign(res, { + data: MisskeyAPI.Converter.userDetail(res.data) + }) + }) + } + + /** + * POST /api/users/notes + */ + public async getAccountStatuses( + id: string, + options?: { + limit?: number + max_id?: string + since_id?: string + pinned?: boolean + exclude_replies: boolean + exclude_reblogs: boolean + only_media?: boolean + } + ): Promise>> { + if (options && options.pinned) { + return this.client + .post('/api/users/show', { + userId: id + }) + .then(res => { + if (res.data.pinnedNotes) { + return { ...res, data: res.data.pinnedNotes.map(n => MisskeyAPI.Converter.note(n)) } + } + return { ...res, data: [] } + }) + } + + let params = { + userId: id + } + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + untilId: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + sinceId: options.since_id + }) + } + if (options.exclude_replies) { + params = Object.assign(params, { + includeReplies: false + }) + } + if (options.exclude_reblogs) { + params = Object.assign(params, { + includeMyRenotes: false + }) + } + if (options.only_media) { + params = Object.assign(params, { + withFiles: options.only_media + }) + } + } + return this.client.post>('/api/users/notes', params).then(res => { + const statuses: Array = res.data.map(note => MisskeyAPI.Converter.note(note)) + return Object.assign(res, { + data: statuses + }) + }) + } + + public async getAccountFavourites( + _id: string, + _options?: { + limit?: number + max_id?: string + since_id?: string + } + ): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async subscribeAccount(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async unsubscribeAccount(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + /** + * POST /api/users/followers + */ + public async getAccountFollowers( + id: string, + options?: { + limit?: number + max_id?: string + since_id?: string + } + ): Promise>> { + let params = { + userId: id + } + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.post>('/api/users/followers', params).then(res => { + return Object.assign(res, { + data: res.data.map(f => MisskeyAPI.Converter.follower(f)) + }) + }) + } + + /** + * POST /api/users/following + */ + public async getAccountFollowing( + id: string, + options?: { + limit?: number + max_id?: string + since_id?: string + } + ): Promise>> { + let params = { + userId: id + } + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.post>('/api/users/following', params).then(res => { + return Object.assign(res, { + data: res.data.map(f => MisskeyAPI.Converter.following(f)) + }) + }) + } + + public async getAccountLists(_id: string): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async getIdentityProof(_id: string): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + /** + * POST /api/following/create + */ + public async followAccount(id: string, _options?: { reblog?: boolean }): Promise> { + await this.client.post<{}>('/api/following/create', { + userId: id + }) + return this.client + .post('/api/users/relation', { + userId: id + }) + .then(res => { + return Object.assign(res, { + data: MisskeyAPI.Converter.relation(res.data) + }) + }) + } + + /** + * POST /api/following/delete + */ + public async unfollowAccount(id: string): Promise> { + await this.client.post<{}>('/api/following/delete', { + userId: id + }) + return this.client + .post('/api/users/relation', { + userId: id + }) + .then(res => { + return Object.assign(res, { + data: MisskeyAPI.Converter.relation(res.data) + }) + }) + } + + /** + * POST /api/blocking/create + */ + public async blockAccount(id: string): Promise> { + await this.client.post<{}>('/api/blocking/create', { + userId: id + }) + return this.client + .post('/api/users/relation', { + userId: id + }) + .then(res => { + return Object.assign(res, { + data: MisskeyAPI.Converter.relation(res.data) + }) + }) + } + + /** + * POST /api/blocking/delete + */ + public async unblockAccount(id: string): Promise> { + await this.client.post<{}>('/api/blocking/delete', { + userId: id + }) + return this.client + .post('/api/users/relation', { + userId: id + }) + .then(res => { + return Object.assign(res, { + data: MisskeyAPI.Converter.relation(res.data) + }) + }) + } + + /** + * POST /api/mute/create + */ + public async muteAccount(id: string, _notifications: boolean): Promise> { + await this.client.post<{}>('/api/mute/create', { + userId: id + }) + return this.client + .post('/api/users/relation', { + userId: id + }) + .then(res => { + return Object.assign(res, { + data: MisskeyAPI.Converter.relation(res.data) + }) + }) + } + + /** + * POST /api/mute/delete + */ + public async unmuteAccount(id: string): Promise> { + await this.client.post<{}>('/api/mute/delete', { + userId: id + }) + return this.client + .post('/api/users/relation', { + userId: id + }) + .then(res => { + return Object.assign(res, { + data: MisskeyAPI.Converter.relation(res.data) + }) + }) + } + + public async pinAccount(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async unpinAccount(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + /** + * POST /api/users/relation + * + * @param id The accountID, for example `'1sdfag'` + */ + public async getRelationship(id: string): Promise> { + return this.client + .post('/api/users/relation', { + userId: id + }) + .then(res => { + return Object.assign(res, { + data: MisskeyAPI.Converter.relation(res.data) + }) + }) + } + + /** + * POST /api/users/relation + * + * @param id Array of account ID, for example `['1sdfag', 'ds12aa']`. + */ + public async getRelationships(ids: Array): Promise>> { + return Promise.all(ids.map(id => this.getRelationship(id))).then(results => ({ + ...results[0], + data: results.map(r => r.data) + })) + } + + /** + * POST /api/users/search + */ + public async searchAccount( + q: string, + options?: { + following?: boolean + resolve?: boolean + limit?: number + max_id?: string + since_id?: string + } + ): Promise>> { + let params = { + query: q, + detail: true + } + if (options) { + if (options.resolve !== undefined) { + params = Object.assign(params, { + localOnly: options.resolve + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.post>('/api/users/search', params).then(res => { + return Object.assign(res, { + data: res.data.map(u => MisskeyAPI.Converter.userDetail(u)) + }) + }) + } + + // ====================================== + // accounts/bookmarks + // ====================================== + public async getBookmarks(_options?: { + limit?: number + max_id?: string + since_id?: string + min_id?: string + }): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + // ====================================== + // accounts/favourites + // ====================================== + /** + * POST /api/i/favorites + */ + public async getFavourites(options?: { limit?: number; max_id?: string; min_id?: string }): Promise>> { + let params = {} + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + untilId: options.max_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + sinceId: options.min_id + }) + } + } + return this.client.post>('/api/i/favorites', params).then(res => { + return Object.assign(res, { + data: res.data.map(fav => MisskeyAPI.Converter.note(fav.note)) + }) + }) + } + + // ====================================== + // accounts/mutes + // ====================================== + /** + * POST /api/mute/list + */ + public async getMutes(options?: { limit?: number; max_id?: string; min_id?: string }): Promise>> { + let params = {} + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + untilId: options.max_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + sinceId: options.min_id + }) + } + } + return this.client.post>('/api/mute/list', params).then(res => { + return Object.assign(res, { + data: res.data.map(mute => MisskeyAPI.Converter.userDetail(mute.mutee)) + }) + }) + } + + // ====================================== + // accounts/blocks + // ====================================== + /** + * POST /api/blocking/list + */ + public async getBlocks(options?: { limit?: number; max_id?: string; min_id?: string }): Promise>> { + let params = {} + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + untilId: options.max_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + sinceId: options.min_id + }) + } + } + return this.client.post>('/api/blocking/list', params).then(res => { + return Object.assign(res, { + data: res.data.map(blocking => MisskeyAPI.Converter.userDetail(blocking.blockee)) + }) + }) + } + + // ====================================== + // accounts/domain_blocks + // ====================================== + public async getDomainBlocks(_options?: { limit?: number; max_id?: string; min_id?: string }): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async blockDomain(_domain: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async unblockDomain(_domain: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + // ====================================== + // accounts/filters + // ====================================== + public async getFilters(): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async getFilter(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async createFilter( + _phrase: string, + _context: Array, + _options?: { + irreversible?: boolean + whole_word?: boolean + expires_in?: string + } + ): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async updateFilter( + _id: string, + _phrase: string, + _context: Array, + _options?: { + irreversible?: boolean + whole_word?: boolean + expires_in?: string + } + ): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async deleteFilter(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + // ====================================== + // accounts/reports + // ====================================== + /** + * POST /api/users/report-abuse + */ + public async report( + account_id: string, + options: { + status_ids?: Array + comment: string + forward?: boolean + category: Entity.Category + rule_ids?: Array + } + ): Promise> { + const category: Entity.Category = 'other' + return this.client + .post<{}>('/api/users/report-abuse', { + userId: account_id, + comment: options.comment + }) + .then(res => { + return Object.assign(res, { + data: { + id: '', + action_taken: false, + action_taken_at: null, + comment: options.comment, + category: category, + forwarded: false, + status_ids: null, + rule_ids: null + } + }) + }) + } + + // ====================================== + // accounts/follow_requests + // ====================================== + /** + * POST /api/following/requests/list + */ + public async getFollowRequests(_limit?: number): Promise>> { + return this.client.post>('/api/following/requests/list').then(res => { + return Object.assign(res, { + data: res.data.map(r => MisskeyAPI.Converter.user(r.follower)) + }) + }) + } + + /** + * POST /api/following/requests/accept + */ + public async acceptFollowRequest(id: string): Promise> { + await this.client.post<{}>('/api/following/requests/accept', { + userId: id + }) + return this.client + .post('/api/users/relation', { + userId: id + }) + .then(res => { + return Object.assign(res, { + data: MisskeyAPI.Converter.relation(res.data) + }) + }) + } + + /** + * POST /api/following/requests/reject + */ + public async rejectFollowRequest(id: string): Promise> { + await this.client.post<{}>('/api/following/requests/reject', { + userId: id + }) + return this.client + .post('/api/users/relation', { + userId: id + }) + .then(res => { + return Object.assign(res, { + data: MisskeyAPI.Converter.relation(res.data) + }) + }) + } + + // ====================================== + // accounts/endorsements + // ====================================== + public async getEndorsements(_options?: { + limit?: number + max_id?: string + since_id?: string + }): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + // ====================================== + // accounts/featured_tags + // ====================================== + public async getFeaturedTags(): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async createFeaturedTag(_name: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async deleteFeaturedTag(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async getSuggestedTags(): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + // ====================================== + // accounts/preferences + // ====================================== + public async getPreferences(): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + // ====================================== + // accounts/followed_tags + // ====================================== + public async getFollowedTags(): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + // ====================================== + // accounts/suggestions + // ====================================== + /** + * POST /api/users/recommendation + */ + public async getSuggestions(limit?: number): Promise>> { + let params = {} + if (limit) { + params = Object.assign(params, { + limit: limit + }) + } + return this.client + .post>('/api/users/recommendation', params) + .then(res => ({ ...res, data: res.data.map(u => MisskeyAPI.Converter.userDetail(u)) })) + } + + // ====================================== + // accounts/tags + // ====================================== + public async getTag(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async followTag(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async unfollowTag(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + // ====================================== + // statuses + // ====================================== + public async postStatus( + status: string, + options?: { + media_ids?: Array + poll?: { options: Array; expires_in: number; multiple?: boolean; hide_totals?: boolean } + in_reply_to_id?: string + sensitive?: boolean + spoiler_text?: string + visibility?: 'public' | 'unlisted' | 'private' | 'direct' + scheduled_at?: string + language?: string + quote_id?: string + } + ): Promise> { + let params = { + text: status + } + if (options) { + if (options.media_ids) { + params = Object.assign(params, { + fileIds: options.media_ids + }) + } + if (options.poll) { + let pollParam = { + choices: options.poll.options, + expiresAt: null, + expiredAfter: options.poll.expires_in + } + if (options.poll.multiple !== undefined) { + pollParam = Object.assign(pollParam, { + multiple: options.poll.multiple + }) + } + params = Object.assign(params, { + poll: pollParam + }) + } + if (options.in_reply_to_id) { + params = Object.assign(params, { + replyId: options.in_reply_to_id + }) + } + if (options.sensitive) { + params = Object.assign(params, { + cw: '' + }) + } + if (options.spoiler_text) { + params = Object.assign(params, { + cw: options.spoiler_text + }) + } + if (options.visibility) { + params = Object.assign(params, { + visibility: MisskeyAPI.Converter.encodeVisibility(options.visibility) + }) + } + if (options.quote_id) { + params = Object.assign(params, { + renoteId: options.quote_id + }) + } + } + return this.client + .post('/api/notes/create', params) + .then(res => ({ ...res, data: MisskeyAPI.Converter.note(res.data.createdNote) })) + } + + /** + * POST /api/notes/show + */ + public async getStatus(id: string): Promise> { + return this.client + .post('/api/notes/show', { + noteId: id + }) + .then(res => ({ ...res, data: MisskeyAPI.Converter.note(res.data) })) + } + + public async editStatus( + _id: string, + _options: { + status?: string + spoiler_text?: string + sensitive?: boolean + media_ids?: Array + poll?: { options?: Array; expires_in?: number; multiple?: boolean; hide_totals?: boolean } + } + ): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + /** + * POST /api/notes/delete + */ + public async deleteStatus(id: string): Promise> { + return this.client.post<{}>('/api/notes/delete', { + noteId: id + }) + } + + /** + * POST /api/notes/children + */ + public async getStatusContext( + id: string, + options?: { limit?: number; max_id?: string; since_id?: string } + ): Promise> { + let params = { + noteId: id + } + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + untilId: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + sinceId: options.since_id + }) + } + } + return this.client.post>('/api/notes/children', params).then(res => { + const context: Entity.Context = { + ancestors: [], + descendants: res.data.map(n => MisskeyAPI.Converter.note(n)) + } + return { + ...res, + data: context + } + }) + } + + public async getStatusSource(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + /** + * POST /api/notes/renotes + */ + public async getStatusRebloggedBy(id: string): Promise>> { + return this.client + .post>('/api/notes/renotes', { + noteId: id + }) + .then(res => ({ + ...res, + data: res.data.map(n => MisskeyAPI.Converter.user(n.user)) + })) + } + + public async getStatusFavouritedBy(_id: string): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + /** + * POST /api/notes/favorites/create + */ + public async favouriteStatus(id: string): Promise> { + await this.client.post<{}>('/api/notes/favorites/create', { + noteId: id + }) + return this.client + .post('/api/notes/show', { + noteId: id + }) + .then(res => ({ ...res, data: MisskeyAPI.Converter.note(res.data) })) + } + + /** + * POST /api/notes/favorites/delete + */ + public async unfavouriteStatus(id: string): Promise> { + await this.client.post<{}>('/api/notes/favorites/delete', { + noteId: id + }) + return this.client + .post('/api/notes/show', { + noteId: id + }) + .then(res => ({ ...res, data: MisskeyAPI.Converter.note(res.data) })) + } + + /** + * POST /api/notes/create + */ + public async reblogStatus(id: string): Promise> { + return this.client + .post('/api/notes/create', { + renoteId: id + }) + .then(res => ({ ...res, data: MisskeyAPI.Converter.note(res.data.createdNote) })) + } + + /** + * POST /api/notes/unrenote + */ + public async unreblogStatus(id: string): Promise> { + await this.client.post<{}>('/api/notes/unrenote', { + noteId: id + }) + return this.client + .post('/api/notes/show', { + noteId: id + }) + .then(res => ({ ...res, data: MisskeyAPI.Converter.note(res.data) })) + } + + public async bookmarkStatus(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async unbookmarkStatus(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async muteStatus(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async unmuteStatus(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + /** + * POST /api/i/pin + */ + public async pinStatus(id: string): Promise> { + await this.client.post<{}>('/api/i/pin', { + noteId: id + }) + return this.client + .post('/api/notes/show', { + noteId: id + }) + .then(res => ({ ...res, data: MisskeyAPI.Converter.note(res.data) })) + } + + /** + * POST /api/i/unpin + */ + public async unpinStatus(id: string): Promise> { + await this.client.post<{}>('/api/i/unpin', { + noteId: id + }) + return this.client + .post('/api/notes/show', { + noteId: id + }) + .then(res => ({ ...res, data: MisskeyAPI.Converter.note(res.data) })) + } + + // ====================================== + // statuses/media + // ====================================== + /** + * POST /api/drive/files/create + */ + public async uploadMedia(file: any, _options?: { description?: string; focus?: string }): Promise> { + const formData = new FormData() + formData.append('file', fs.createReadStream(file.path), { contentType: file.mimetype, }); - if (file.originalname != null && file.originalname !== "file") - formData.append("name", file.originalname); - - if (options?.description != null) - formData.append("comment", options.description); - - let headers: { [key: string]: string } = {}; - if (typeof formData.getHeaders === "function") { - headers = formData.getHeaders(); - } - return this.client - .post( - "/api/drive/files/create", - formData, - headers, - ) - .then((res) => ({ ...res, data: this.converter.file(res.data) })); - } - - public async getMedia(id: string): Promise> { - const res = await this.client.post( - "/api/drive/files/show", - { fileId: id }, - ); - return { ...res, data: this.converter.file(res.data) }; - } - - /** - * POST /api/drive/files/update - */ - public async updateMedia( - id: string, - options?: { - file?: any; - description?: string; - focus?: string; - is_sensitive?: boolean; - }, - ): Promise> { - let params = { - fileId: id, - }; - if (options) { - if (options.is_sensitive !== undefined) { - params = Object.assign(params, { - isSensitive: options.is_sensitive, - }); - } - - if (options.description !== undefined) { - params = Object.assign(params, { - comment: options.description, - }); - } - } - return this.client - .post("/api/drive/files/update", params) - .then((res) => ({ ...res, data: this.converter.file(res.data) })); - } - - // ====================================== - // statuses/polls - // ====================================== - public async getPoll(id: string): Promise> { - const res = await this.getStatus(id); - if (res.data.poll == null) throw new Error("poll not found"); - return { ...res, data: res.data.poll }; - } - - /** - * POST /api/notes/polls/vote - */ - public async votePoll( - id: string, - choices: Array, - ): Promise> { - if (!id) { - return new Promise((_, reject) => { - const err = new ArgumentError("id is required"); - reject(err); - }); - } - - for (const c of choices) { - const params = { - noteId: id, - choice: +c, - }; - await this.client.post<{}>("/api/notes/polls/vote", params); - } - - const res = await this.client - .post("/api/notes/show", { - noteId: id, - }) - .then(async (res) => { - const note = await this.noteWithDetails( - res.data, - this.baseUrlToHost(this.baseUrl), - this.getFreshAccountCache(), - ); - return { ...res, data: note.poll }; - }); - if (!res.data) { - return new Promise((_, reject) => { - const err = new UnexpectedError("poll does not exist"); - reject(err); - }); - } - return { ...res, data: res.data }; - } - - // ====================================== - // statuses/scheduled_statuses - // ====================================== - public async getScheduledStatuses(_options?: { - limit?: number; - max_id?: string; - since_id?: string; - min_id?: string; - }): Promise>> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - public async getScheduledStatus( - _id: string, - ): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - public async scheduleStatus( - _id: string, - _scheduled_at?: string | null, - ): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - public async cancelScheduledStatus(_id: string): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - // ====================================== - // timelines - // ====================================== - /** - * POST /api/notes/global-timeline - */ - public async getPublicTimeline(options?: { - only_media?: boolean; - limit?: number; - max_id?: string; - since_id?: string; - min_id?: string; - }): Promise>> { - const accountCache = this.getFreshAccountCache(); - - let params = {}; - if (options) { - if (options.only_media !== undefined) { - params = Object.assign(params, { - withFiles: options.only_media, - }); - } - if (options.limit) { - params = Object.assign(params, { - limit: options.limit, - }); - } else { - params = Object.assign(params, { - limit: 20, - }); - } - if (options.max_id) { - params = Object.assign(params, { - untilId: options.max_id, - }); - } - if (options.since_id) { - params = Object.assign(params, { - sinceId: options.since_id, - }); - } - if (options.min_id) { - params = Object.assign(params, { - sinceId: options.min_id, - }); - } - } else { - params = Object.assign(params, { - limit: 20, - }); - } - return this.client - .post>("/api/notes/global-timeline", params) - .then(async (res) => ({ - ...res, - data: ( - await Promise.all( - res.data.map((n) => - this.noteWithDetails( - n, - this.baseUrlToHost(this.baseUrl), - accountCache, - ), - ), - ) - ).sort(this.sortByIdDesc), - })); - } - - /** - * POST /api/notes/local-timeline - */ - public async getLocalTimeline(options?: { - only_media?: boolean; - limit?: number; - max_id?: string; - since_id?: string; - min_id?: string; - }): Promise>> { - const accountCache = this.getFreshAccountCache(); - - let params = {}; - if (options) { - if (options.only_media !== undefined) { - params = Object.assign(params, { - withFiles: options.only_media, - }); - } - if (options.limit) { - params = Object.assign(params, { - limit: options.limit, - }); - } else { - params = Object.assign(params, { - limit: 20, - }); - } - if (options.max_id) { - params = Object.assign(params, { - untilId: options.max_id, - }); - } - if (options.since_id) { - params = Object.assign(params, { - sinceId: options.since_id, - }); - } - if (options.min_id) { - params = Object.assign(params, { - sinceId: options.min_id, - }); - } - } else { - params = Object.assign(params, { - limit: 20, - }); - } - return this.client - .post>("/api/notes/local-timeline", params) - .then(async (res) => ({ - ...res, - data: ( - await Promise.all( - res.data.map((n) => - this.noteWithDetails( - n, - this.baseUrlToHost(this.baseUrl), - accountCache, - ), - ), - ) - ).sort(this.sortByIdDesc), - })); - } - - /** - * POST /api/notes/search-by-tag - */ - public async getTagTimeline( - hashtag: string, - options?: { - local?: boolean; - only_media?: boolean; - limit?: number; - max_id?: string; - since_id?: string; - min_id?: string; - }, - ): Promise>> { - const accountCache = this.getFreshAccountCache(); - - let params = { - tag: hashtag, - }; - if (options) { - if (options.only_media !== undefined) { - params = Object.assign(params, { - withFiles: options.only_media, - }); - } - if (options.limit) { - params = Object.assign(params, { - limit: options.limit, - }); - } else { - params = Object.assign(params, { - limit: 20, - }); - } - if (options.max_id) { - params = Object.assign(params, { - untilId: options.max_id, - }); - } - if (options.since_id) { - params = Object.assign(params, { - sinceId: options.since_id, - }); - } - if (options.min_id) { - params = Object.assign(params, { - sinceId: options.min_id, - }); - } - } else { - params = Object.assign(params, { - limit: 20, - }); - } - return this.client - .post>("/api/notes/search-by-tag", params) - .then(async (res) => ({ - ...res, - data: ( - await Promise.all( - res.data.map((n) => - this.noteWithDetails( - n, - this.baseUrlToHost(this.baseUrl), - accountCache, - ), - ), - ) - ).sort(this.sortByIdDesc), - })); - } - - /** - * POST /api/notes/timeline - */ - public async getHomeTimeline(options?: { - local?: boolean; - limit?: number; - max_id?: string; - since_id?: string; - min_id?: string; - }): Promise>> { - const accountCache = this.getFreshAccountCache(); - - let params = { - withFiles: false, - }; - if (options) { - if (options.limit) { - params = Object.assign(params, { - limit: options.limit, - }); - } else { - params = Object.assign(params, { - limit: 20, - }); - } - if (options.max_id) { - params = Object.assign(params, { - untilId: options.max_id, - }); - } - if (options.since_id) { - params = Object.assign(params, { - sinceId: options.since_id, - }); - } - if (options.min_id) { - params = Object.assign(params, { - sinceId: options.min_id, - }); - } - } else { - params = Object.assign(params, { - limit: 20, - }); - } - return this.client - .post>("/api/notes/timeline", params) - .then(async (res) => ({ - ...res, - data: ( - await Promise.all( - res.data.map((n) => - this.noteWithDetails( - n, - this.baseUrlToHost(this.baseUrl), - accountCache, - ), - ), - ) - ).sort(this.sortByIdDesc), - })); - } - - /** - * POST /api/notes/user-list-timeline - */ - public async getListTimeline( - list_id: string, - options?: { - limit?: number; - max_id?: string; - since_id?: string; - min_id?: string; - }, - ): Promise>> { - const accountCache = this.getFreshAccountCache(); - - let params = { - listId: list_id, - withFiles: false, - }; - if (options) { - if (options.limit) { - params = Object.assign(params, { - limit: options.limit, - }); - } else { - params = Object.assign(params, { - limit: 20, - }); - } - if (options.max_id) { - params = Object.assign(params, { - untilId: options.max_id, - }); - } - if (options.since_id) { - params = Object.assign(params, { - sinceId: options.since_id, - }); - } - if (options.min_id) { - params = Object.assign(params, { - sinceId: options.min_id, - }); - } - } else { - params = Object.assign(params, { - limit: 20, - }); - } - return this.client - .post>( - "/api/notes/user-list-timeline", - params, - ) - .then(async (res) => ({ - ...res, - data: ( - await Promise.all( - res.data.map((n) => - this.noteWithDetails( - n, - this.baseUrlToHost(this.baseUrl), - accountCache, - ), - ), - ) - ).sort(this.sortByIdDesc), - })); - } - - // ====================================== - // timelines/conversations - // ====================================== - /** - * POST /api/notes/mentions - */ - public async getConversationTimeline(options?: { - limit?: number; - max_id?: string; - since_id?: string; - min_id?: string; - }): Promise>> { - let params = { - visibility: "specified", - }; - if (options) { - if (options.limit) { - params = Object.assign(params, { - limit: options.limit, - }); - } else { - params = Object.assign(params, { - limit: 20, - }); - } - if (options.max_id) { - params = Object.assign(params, { - untilId: options.max_id, - }); - } - if (options.since_id) { - params = Object.assign(params, { - sinceId: options.since_id, - }); - } - if (options.min_id) { - params = Object.assign(params, { - sinceId: options.min_id, - }); - } - } else { - params = Object.assign(params, { - limit: 20, - }); - } - return this.client - .post>("/api/notes/mentions", params) - .then((res) => ({ - ...res, - data: res.data.map((n) => - this.converter.noteToConversation( - n, - this.baseUrlToHost(this.baseUrl), - ), - ), - })); - // FIXME: ^ this should also parse mentions - } - - public async deleteConversation(_id: string): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - public async readConversation( - _id: string, - ): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - private sortByIdDesc(a: Entity.Status, b: Entity.Status): number { - if (a.id < b.id) return 1; - if (a.id > b.id) return -1; - - return 0; - } - - // ====================================== - // timelines/lists - // ====================================== - /** - * POST /api/users/lists/list - */ - public async getLists(id: string): Promise>> { - return this.client - .post>("/api/users/lists/list", { userId: id }) - .then((res) => ({ - ...res, - data: res.data.map((l) => this.converter.list(l)), - })); - } - - /** - * POST /api/users/lists/show - */ - public async getList(id: string): Promise> { - return this.client - .post("/api/users/lists/show", { - listId: id, - }) - .then((res) => ({ ...res, data: this.converter.list(res.data) })); - } - - /** - * POST /api/users/lists/create - */ - public async createList(title: string): Promise> { - return this.client - .post("/api/users/lists/create", { - name: title, - }) - .then((res) => ({ ...res, data: this.converter.list(res.data) })); - } - - /** - * POST /api/users/lists/update - */ - public async updateList( - id: string, - title: string, - ): Promise> { - return this.client - .post("/api/users/lists/update", { - listId: id, - name: title, - }) - .then((res) => ({ ...res, data: this.converter.list(res.data) })); - } - - /** - * POST /api/users/lists/delete - */ - public async deleteList(id: string): Promise> { - return this.client.post<{}>("/api/users/lists/delete", { - listId: id, - }); - } - - /** - * POST /api/users/lists/show - */ - public async getAccountsInList( - id: string, - _options?: { - limit?: number; - max_id?: string; - since_id?: string; - }, - ): Promise>> { - const res = await this.client.post( - "/api/users/lists/show", - { - listId: id, - }, - ); - const promise = res.data.userIds.map((userId) => this.getAccount(userId)); - const accounts = await Promise.all(promise); - return { ...res, data: accounts.map((r) => r.data) }; - } - - /** - * POST /api/users/lists/push - */ - public async addAccountsToList( - id: string, - account_ids: Array, - ): Promise> { - return this.client.post<{}>("/api/users/lists/push", { - listId: id, - userId: account_ids[0], - }); - } - - /** - * POST /api/users/lists/pull - */ - public async deleteAccountsFromList( - id: string, - account_ids: Array, - ): Promise> { - return this.client.post<{}>("/api/users/lists/pull", { - listId: id, - userId: account_ids[0], - }); - } - - // ====================================== - // timelines/markers - // ====================================== - public async getMarkers( - _timeline: Array, - ): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - public async saveMarkers(_options?: { - home?: { last_read_id: string }; - notifications?: { last_read_id: string }; - }): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - // ====================================== - // notifications - // ====================================== - /** - * POST /api/i/notifications - */ - public async getNotifications(options?: { - limit?: number; - max_id?: string; - since_id?: string; - min_id?: string; - exclude_type?: Array; - account_id?: string; - }): Promise>> { - let params = {}; - if (options) { - if (options.limit) { - params = Object.assign(params, { - limit: options.limit <= 100 ? options.limit : 100, - }); - } else { - params = Object.assign(params, { - limit: 20, - }); - } - if (options.max_id) { - params = Object.assign(params, { - untilId: options.max_id, - }); - } - if (options.since_id) { - params = Object.assign(params, { - sinceId: options.since_id, - }); - } - if (options.min_id) { - params = Object.assign(params, { - sinceId: options.min_id, - }); - } - if (options.exclude_type) { - params = Object.assign(params, { - excludeType: options.exclude_type.map((e) => - this.converter.encodeNotificationType(e), - ), - }); - } - } else { - params = Object.assign(params, { - limit: 20, - }); - } - const cache = this.getFreshAccountCache(); - return this.client - .post>( - "/api/i/notifications", - params, - ) - .then(async (res) => ({ - ...res, - data: await Promise.all( - res.data - .filter( - (p) => p.type != MisskeyNotificationType.FollowRequestAccepted, - ) // these aren't supported on mastodon - .map((n) => - this.notificationWithDetails( - n, - this.baseUrlToHost(this.baseUrl), - cache, - ), - ), - ), - })); - } - - public async getNotification( - _id: string, - ): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - /** - * POST /api/notifications/mark-all-as-read - */ - public async dismissNotifications(): Promise> { - return this.client.post<{}>("/api/notifications/mark-all-as-read"); - } - - public async dismissNotification(_id: string): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - public async readNotifications(_options: { - id?: string; - max_id?: string; - }): Promise>> { - return new Promise((_, reject) => { - const err = new NoImplementedError("mastodon does not support"); - reject(err); - }); - } - - // ====================================== - // notifications/push - // ====================================== - public async subscribePushNotification( - _subscription: { endpoint: string; keys: { p256dh: string; auth: string } }, - _data?: { - alerts: { - follow?: boolean; - favourite?: boolean; - reblog?: boolean; - mention?: boolean; - poll?: boolean; - }; - } | null, - ): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - public async getPushSubscription(): Promise< - Response - > { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - public async updatePushSubscription( - _data?: { - alerts: { - follow?: boolean; - favourite?: boolean; - reblog?: boolean; - mention?: boolean; - poll?: boolean; - }; - } | null, - ): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - /** - * DELETE /api/v1/push/subscription - */ - public async deletePushSubscription(): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - // ====================================== - // search - // ====================================== - public async search( - q: string, - type: "accounts" | "hashtags" | "statuses", - options?: { - limit?: number; - max_id?: string; - min_id?: string; - resolve?: boolean; - offset?: number; - following?: boolean; - account_id?: string; - exclude_unreviewed?: boolean; - }, - ): Promise> { - const accountCache = this.getFreshAccountCache(); - - switch (type) { - case "accounts": { - if (q.startsWith("http://") || q.startsWith("https://")) { - return this.client - .post("/api/ap/show", { uri: q }) - .then(async (res) => { - if (res.status != 200 || res.data.type != "User") { - res.status = 200; - res.statusText = "OK"; - res.data = { - accounts: [], - statuses: [], - hashtags: [], - }; - - return res; - } - - const account = await this.converter.userDetail( - res.data.object as MisskeyAPI.Entity.UserDetail, - this.baseUrlToHost(this.baseUrl), - ); - - return { - ...res, - data: { - accounts: - options?.max_id && options?.max_id >= account.id - ? [] - : [account], - statuses: [], - hashtags: [], - }, - }; - }); - } - let params = { - query: q, - }; - if (options) { - if (options.limit) { - params = Object.assign(params, { - limit: options.limit, - }); - } else { - params = Object.assign(params, { - limit: 20, - }); - } - if (options.offset) { - params = Object.assign(params, { - offset: options.offset, - }); - } - if (options.resolve) { - params = Object.assign(params, { - localOnly: options.resolve, - }); - } - } else { - params = Object.assign(params, { - limit: 20, - }); - } - - try { - const match = q.match( - /^@(?[a-zA-Z0-9_]+)(?:@(?[a-zA-Z0-9-.]+\.[a-zA-Z0-9-]+)|)$/, - ); - if (match) { - const lookupQuery = { - username: match.groups?.user, - host: match.groups?.host, - }; - - const result = await this.client - .post( - "/api/users/show", - lookupQuery, - ) - .then((res) => ({ - ...res, - data: { - accounts: [ - this.converter.userDetail( - res.data, - this.baseUrlToHost(this.baseUrl), - ), - ], - statuses: [], - hashtags: [], - }, - })); - - if (result.status !== 200) { - result.status = 200; - result.statusText = "OK"; - result.data = { - accounts: [], - statuses: [], - hashtags: [], - }; - } - - return result; - } - } catch {} - - return this.client - .post>( - "/api/users/search", - params, - ) - .then((res) => ({ - ...res, - data: { - accounts: res.data.map((u) => - this.converter.userDetail(u, this.baseUrlToHost(this.baseUrl)), - ), - statuses: [], - hashtags: [], - }, - })); - } - case "statuses": { - if (q.startsWith("http://") || q.startsWith("https://")) { - return this.client - .post("/api/ap/show", { uri: q }) - .then(async (res) => { - if (res.status != 200 || res.data.type != "Note") { - res.status = 200; - res.statusText = "OK"; - res.data = { - accounts: [], - statuses: [], - hashtags: [], - }; - - return res; - } - - const post = await this.noteWithDetails( - res.data.object as MisskeyAPI.Entity.Note, - this.baseUrlToHost(this.baseUrl), - accountCache, - ); - - return { - ...res, - data: { - accounts: [], - statuses: - options?.max_id && options.max_id >= post.id ? [] : [post], - hashtags: [], - }, - }; - }); - } - let params = { - query: q, - }; - if (options) { - if (options.limit) { - params = Object.assign(params, { - limit: options.limit, - }); - } - if (options.offset) { - params = Object.assign(params, { - offset: options.offset, - }); - } - if (options.max_id) { - params = Object.assign(params, { - untilId: options.max_id, - }); - } - if (options.min_id) { - params = Object.assign(params, { - sinceId: options.min_id, - }); - } - if (options.account_id) { - params = Object.assign(params, { - userId: options.account_id, - }); - } - } - return this.client - .post>("/api/notes/search", params) - .then(async (res) => ({ - ...res, - data: { - accounts: [], - statuses: await Promise.all( - res.data.map((n) => - this.noteWithDetails( - n, - this.baseUrlToHost(this.baseUrl), - accountCache, - ), - ), - ), - hashtags: [], - }, - })); - } - case "hashtags": { - let params = { - query: q, - }; - if (options) { - if (options.limit) { - params = Object.assign(params, { - limit: options.limit, - }); - } - if (options.offset) { - params = Object.assign(params, { - offset: options.offset, - }); - } - } - return this.client - .post>("/api/hashtags/search", params) - .then((res) => ({ - ...res, - data: { - accounts: [], - statuses: [], - hashtags: res.data.map((h) => ({ - name: h, - url: h, - history: null, - following: false, - })), - }, - })); - } - } - } - - // ====================================== - // instance - // ====================================== - /** - * POST /api/meta - * POST /api/stats - */ - public async getInstance(): Promise> { - const meta = await this.client - .post("/api/meta", { "detail": true }) - .then((res) => res.data); - return this.client - .post("/api/stats", { "detail": true }) - .then((res) => ({ ...res, data: this.converter.meta(meta, res.data) })); - } - - public async getInstancePeers(): Promise>> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - public async getInstanceActivity(): Promise< - Response> - > { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - // ====================================== - // instance/trends - // ====================================== - /** - * POST /api/hashtags/trend - */ - public async getInstanceTrends( - _limit?: number | null, - ): Promise>> { - return this.client - .post>("/api/hashtags/trend") - .then((res) => ({ - ...res, - data: res.data.map((h) => this.converter.hashtag(h)), - })); - } - - // ====================================== - // instance/directory - // ====================================== - public async getInstanceDirectory(_options?: { - limit?: number; - offset?: number; - order?: "active" | "new"; - local?: boolean; - }): Promise>> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - // ====================================== - // instance/custom_emojis - // ====================================== - /** - * POST /api/meta - */ - public async getInstanceCustomEmojis(): Promise< - Response> - > { - return this.client - .post("/api/emojis") - .then((res) => ({ - ...res, - data: res.data.emojis.map((e: any) => this.converter.emoji(e)), - })); - } - - // ====================================== - // instance/announcements - // ====================================== - public async getInstanceAnnouncements( - with_dismissed?: boolean | null, - ): Promise>> { - let params = {}; - if (with_dismissed) { - params = Object.assign(params, { - withUnreads: with_dismissed, - }); - } - return this.client - .post>("/api/announcements", params) - .then((res) => ({ - ...res, - data: res.data.map((t) => this.converter.announcement(t)), - })); - } - - public async dismissInstanceAnnouncement(id: string): Promise> { - return this.client.post<{}>("/api/i/read-announcement", { - announcementId: id, - }); - } - - // ====================================== - // Emoji reactions - // ====================================== - /** - * POST /api/notes/reactions/create - * - * @param {string} id Target note ID. - * @param {string} emoji Reaction emoji string. This string is raw unicode emoji. - */ - public async createEmojiReaction( - id: string, - emoji: string, - ): Promise> { - await this.client.post<{}>("/api/notes/reactions/create", { - noteId: id, - reaction: emoji, - }); - return this.client - .post("/api/notes/show", { - noteId: id, - }) - .then(async (res) => ({ - ...res, - data: await this.noteWithDetails( - res.data, - this.baseUrlToHost(this.baseUrl), - this.getFreshAccountCache(), - ), - })); - } - - /** - * POST /api/notes/reactions/delete - */ - public async deleteEmojiReaction( - id: string, - _emoji: string, - ): Promise> { - await this.client.post<{}>("/api/notes/reactions/delete", { - noteId: id, - }); - return this.client - .post("/api/notes/show", { - noteId: id, - }) - .then(async (res) => ({ - ...res, - data: await this.noteWithDetails( - res.data, - this.baseUrlToHost(this.baseUrl), - this.getFreshAccountCache(), - ), - })); - } - - public async getEmojiReactions( - id: string, - ): Promise>> { - return this.client - .post>("/api/notes/reactions", { - noteId: id, - }) - .then((res) => ({ - ...res, - data: this.converter.reactions(res.data), - })); - } - - public async getEmojiReaction( - _id: string, - _emoji: string, - ): Promise> { - return new Promise((_, reject) => { - const err = new NoImplementedError("misskey does not support"); - reject(err); - }); - } - - public userSocket(): WebSocketInterface { - return this.client.socket("user"); - } - - public publicSocket(): WebSocketInterface { - return this.client.socket("globalTimeline"); - } - - public localSocket(): WebSocketInterface { - return this.client.socket("localTimeline"); - } - - public tagSocket(_tag: string): WebSocketInterface { - throw new NoImplementedError("TODO: implement"); - } - - public listSocket(list_id: string): WebSocketInterface { - return this.client.socket("list", list_id); - } - - public directSocket(): WebSocketInterface { - return this.client.socket("conversation"); - } + if (file.originalname != null && file.originalname !== "file") formData.append("name", file.originalname); + + if (_options?.description != null) formData.append("comment", _options.description); + let headers: { [key: string]: string } = {} + if (typeof formData.getHeaders === 'function') { + headers = formData.getHeaders() + } + return this.client + .post('/api/drive/files/create', formData, headers) + .then(res => ({ ...res, data: MisskeyAPI.Converter.file(res.data) })) + } + + public async getMedia(id: string): Promise> { + const res = await this.client.post('/api/drive/files/show', { fileId: id }) + return { ...res, data: MisskeyAPI.Converter.file(res.data) } + } + + /** + * POST /api/drive/files/update + */ + public async updateMedia( + id: string, + options?: { + file?: any + description?: string + focus?: string + is_sensitive?: boolean + } + ): Promise> { + let params = { + fileId: id + } + if (options) { + if (options.is_sensitive !== undefined) { + params = Object.assign(params, { + isSensitive: options.is_sensitive + }) + } + } + return this.client + .post('/api/drive/files/update', params) + .then(res => ({ ...res, data: MisskeyAPI.Converter.file(res.data) })) + } + + // ====================================== + // statuses/polls + // ====================================== + public async getPoll(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + /** + * POST /api/notes/polls/vote + */ + public async votePoll(_id: string, choices: Array, status_id?: string | null): Promise> { + if (!status_id) { + return new Promise((_, reject) => { + const err = new ArgumentError('status_id is required') + reject(err) + }) + } + const params = { + noteId: status_id, + choice: choices[0] + } + await this.client.post<{}>('/api/notes/polls/vote', params) + const res = await this.client + .post('/api/notes/show', { + noteId: status_id + }) + .then(res => { + const note = MisskeyAPI.Converter.note(res.data) + return { ...res, data: note.poll } + }) + if (!res.data) { + return new Promise((_, reject) => { + const err = new UnexpectedError('poll does not exist') + reject(err) + }) + } + return { ...res, data: res.data } + } + + // ====================================== + // statuses/scheduled_statuses + // ====================================== + public async getScheduledStatuses(_options?: { + limit?: number + max_id?: string + since_id?: string + min_id?: string + }): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async getScheduledStatus(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async scheduleStatus(_id: string, _scheduled_at?: string | null): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async cancelScheduledStatus(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + // ====================================== + // timelines + // ====================================== + /** + * POST /api/notes/global-timeline + */ + public async getPublicTimeline(options?: { + only_media?: boolean + limit?: number + max_id?: string + since_id?: string + min_id?: string + }): Promise>> { + let params = {} + if (options) { + if (options.only_media !== undefined) { + params = Object.assign(params, { + withFiles: options.only_media + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + untilId: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + sinceId: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + sinceId: options.min_id + }) + } + } + return this.client + .post>('/api/notes/global-timeline', params) + .then(res => ({ ...res, data: res.data.map(n => MisskeyAPI.Converter.note(n)) })) + } + + /** + * POST /api/notes/local-timeline + */ + public async getLocalTimeline(options?: { + only_media?: boolean + limit?: number + max_id?: string + since_id?: string + min_id?: string + }): Promise>> { + let params = {} + if (options) { + if (options.only_media !== undefined) { + params = Object.assign(params, { + withFiles: options.only_media + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + untilId: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + sinceId: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + sinceId: options.min_id + }) + } + } + return this.client + .post>('/api/notes/local-timeline', params) + .then(res => ({ ...res, data: res.data.map(n => MisskeyAPI.Converter.note(n)) })) + } + + /** + * POST /api/notes/search-by-tag + */ + public async getTagTimeline( + hashtag: string, + options?: { + local?: boolean + only_media?: boolean + limit?: number + max_id?: string + since_id?: string + min_id?: string + } + ): Promise>> { + let params = { + tag: hashtag + } + if (options) { + if (options.only_media !== undefined) { + params = Object.assign(params, { + withFiles: options.only_media + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + untilId: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + sinceId: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + sinceId: options.min_id + }) + } + } + return this.client + .post>('/api/notes/search-by-tag', params) + .then(res => ({ ...res, data: res.data.map(n => MisskeyAPI.Converter.note(n)) })) + } + + /** + * POST /api/notes/timeline + */ + public async getHomeTimeline(options?: { + local?: boolean + limit?: number + max_id?: string + since_id?: string + min_id?: string + }): Promise>> { + let params = { + withFiles: false + } + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + untilId: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + sinceId: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + sinceId: options.min_id + }) + } + } + return this.client + .post>('/api/notes/timeline', params) + .then(res => ({ ...res, data: res.data.map(n => MisskeyAPI.Converter.note(n)) })) + } + + /** + * POST /api/notes/user-list-timeline + */ + public async getListTimeline( + list_id: string, + options?: { + limit?: number + max_id?: string + since_id?: string + min_id?: string + } + ): Promise>> { + let params = { + listId: list_id, + withFiles: false + } + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + untilId: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + sinceId: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + sinceId: options.min_id + }) + } + } + return this.client + .post>('/api/notes/user-list-timeline', params) + .then(res => ({ ...res, data: res.data.map(n => MisskeyAPI.Converter.note(n)) })) + } + + // ====================================== + // timelines/conversations + // ====================================== + /** + * POST /api/notes/mentions + */ + public async getConversationTimeline(options?: { + limit?: number + max_id?: string + since_id?: string + min_id?: string + }): Promise>> { + let params = { + visibility: 'specified' + } + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + untilId: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + sinceId: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + sinceId: options.min_id + }) + } + } + return this.client + .post>('/api/notes/mentions', params) + .then(res => ({ ...res, data: res.data.map(n => MisskeyAPI.Converter.noteToConversation(n)) })) + } + + public async deleteConversation(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async readConversation(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + // ====================================== + // timelines/lists + // ====================================== + /** + * POST /api/users/lists/list + */ + public async getLists(id: string): Promise>> { + return this.client + .post>('/api/users/lists/list', { userId: id }) + .then(res => ({ ...res, data: res.data.map(l => MisskeyAPI.Converter.list(l)) })) + } + + /** + * POST /api/users/lists/show + */ + public async getList(id: string): Promise> { + return this.client + .post('/api/users/lists/show', { + listId: id + }) + .then(res => ({ ...res, data: MisskeyAPI.Converter.list(res.data) })) + } + + /** + * POST /api/users/lists/create + */ + public async createList(title: string): Promise> { + return this.client + .post('/api/users/lists/create', { + name: title + }) + .then(res => ({ ...res, data: MisskeyAPI.Converter.list(res.data) })) + } + + /** + * POST /api/users/lists/update + */ + public async updateList(id: string, title: string): Promise> { + return this.client + .post('/api/users/lists/update', { + listId: id, + name: title + }) + .then(res => ({ ...res, data: MisskeyAPI.Converter.list(res.data) })) + } + + /** + * POST /api/users/lists/delete + */ + public async deleteList(id: string): Promise> { + return this.client.post<{}>('/api/users/lists/delete', { + listId: id + }) + } + + /** + * POST /api/users/lists/show + */ + public async getAccountsInList( + id: string, + _options?: { + limit?: number + max_id?: string + since_id?: string + } + ): Promise>> { + const res = await this.client.post('/api/users/lists/show', { + listId: id + }) + const promise = res.data.userIds.map(userId => this.getAccount(userId)) + const accounts = await Promise.all(promise) + return { ...res, data: accounts.map(r => r.data) } + } + + /** + * POST /api/users/lists/push + */ + public async addAccountsToList(id: string, account_ids: Array): Promise> { + return this.client.post<{}>('/api/users/lists/push', { + listId: id, + userId: account_ids[0] + }) + } + + /** + * POST /api/users/lists/pull + */ + public async deleteAccountsFromList(id: string, account_ids: Array): Promise> { + return this.client.post<{}>('/api/users/lists/pull', { + listId: id, + userId: account_ids[0] + }) + } + + // ====================================== + // timelines/markers + // ====================================== + public async getMarkers(_timeline: Array): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async saveMarkers(_options?: { + home?: { last_read_id: string } + notifications?: { last_read_id: string } + }): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + // ====================================== + // notifications + // ====================================== + /** + * POST /api/i/notifications + */ + public async getNotifications(options?: { + limit?: number + max_id?: string + since_id?: string + min_id?: string + exclude_type?: Array + account_id?: string + }): Promise>> { + let params = {} + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + untilId: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + sinceId: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + sinceId: options.min_id + }) + } + if (options.exclude_type) { + params = Object.assign(params, { + excludeType: options.exclude_type.map(e => MisskeyAPI.Converter.encodeNotificationType(e)) + }) + } + } + const res = await this.client.post>('/api/i/notifications', params) + const notifications: Array = res.data.flatMap(n => { + const notify = MisskeyAPI.Converter.notification(n) + if (notify instanceof UnknownNotificationTypeError) { + return [] + } + return notify + }) + + return { ...res, data: notifications } + } + + public async getNotification(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + /** + * POST /api/notifications/mark-all-as-read + */ + public async dismissNotifications(): Promise> { + return this.client.post<{}>('/api/notifications/mark-all-as-read') + } + + public async dismissNotification(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async readNotifications(_options: { + id?: string + max_id?: string + }): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('mastodon does not support') + reject(err) + }) + } + + // ====================================== + // notifications/push + // ====================================== + public async subscribePushNotification( + _subscription: { endpoint: string; keys: { p256dh: string; auth: string } }, + _data?: { alerts: { follow?: boolean; favourite?: boolean; reblog?: boolean; mention?: boolean; poll?: boolean } } | null + ): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async getPushSubscription(): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async updatePushSubscription( + _data?: { alerts: { follow?: boolean; favourite?: boolean; reblog?: boolean; mention?: boolean; poll?: boolean } } | null + ): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + /** + * DELETE /api/v1/push/subscription + */ + public async deletePushSubscription(): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + // ====================================== + // search + // ====================================== + public async search( + q: string, + options: { + type: 'accounts' | 'hashtags' | 'statuses' + limit?: number + max_id?: string + min_id?: string + resolve?: boolean + offset?: number + following?: boolean + account_id?: string + exclude_unreviewed?: boolean + } + ): Promise> { + switch (options.type) { + case 'accounts': { + let params = { + query: q + } + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.offset) { + params = Object.assign(params, { + offset: options.offset + }) + } + if (options.resolve) { + params = Object.assign(params, { + localOnly: options.resolve + }) + } + } + return this.client.post>('/api/users/search', params).then(res => ({ + ...res, + data: { + accounts: res.data.map(u => MisskeyAPI.Converter.userDetail(u)), + statuses: [], + hashtags: [] + } + })) + } + case 'statuses': { + let params = { + query: q + } + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.offset) { + params = Object.assign(params, { + offset: options.offset + }) + } + if (options.max_id) { + params = Object.assign(params, { + untilId: options.max_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + sinceId: options.min_id + }) + } + if (options.account_id) { + params = Object.assign(params, { + userId: options.account_id + }) + } + } + return this.client.post>('/api/notes/search', params).then(res => ({ + ...res, + data: { + accounts: [], + statuses: res.data.map(n => MisskeyAPI.Converter.note(n)), + hashtags: [] + } + })) + } + case 'hashtags': { + let params = { + query: q + } + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.offset) { + params = Object.assign(params, { + offset: options.offset + }) + } + } + return this.client.post>('/api/hashtags/search', params).then(res => ({ + ...res, + data: { + accounts: [], + statuses: [], + hashtags: res.data.map(h => ({ name: h, url: h, history: [], following: false })) + } + })) + } + } + } + + // ====================================== + // instance + // ====================================== + /** + * POST /api/meta + * POST /api/stats + */ + public async getInstance(): Promise> { + const meta = await this.client + .post('/api/meta', { detail: true }) + .then(res => res.data) + return this.client + .post('/api/stats') + .then(res => ({ ...res, data: MisskeyAPI.Converter.meta(meta, res.data) })) + } + + public async getInstancePeers(): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async getInstanceActivity(): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + // ====================================== + // instance/trends + // ====================================== + /** + * POST /api/hashtags/trend + */ + public async getInstanceTrends(_limit?: number | null): Promise>> { + return this.client + .post>('/api/hashtags/trend') + .then(res => ({ ...res, data: res.data.map(h => MisskeyAPI.Converter.hashtag(h)) })) + } + + // ====================================== + // instance/directory + // ====================================== + public async getInstanceDirectory(_options?: { + limit?: number + offset?: number + order?: 'active' | 'new' + local?: boolean + }): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + // ====================================== + // instance/custom_emojis + // ====================================== + /** + * GET /api/emojis + */ + public async getInstanceCustomEmojis(): Promise>> { + return this.client + .get<{ emojis: Array }>('/api/emojis') + .then(res => ({ ...res, data: res.data.emojis.map(e => MisskeyAPI.Converter.emoji(e)) })) + } + + // ====================================== + // instance/announcements + // ====================================== + /** + * GET /api/announcements + * + * @return Array of announcements. + */ + public async getInstanceAnnouncements(): Promise>> { + return this.client + .post>('/api/announcements') + .then(res => ({ ...res, data: res.data.map(a => MisskeyAPI.Converter.announcement(a)) })) + } + + public async dismissInstanceAnnouncement(_id: string): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async addReactionToAnnouncement(_id: string, _name: string): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public async removeReactionFromAnnouncement(_id: string, _name: string): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + // ====================================== + // Emoji reactions + // ====================================== + /** + * POST /api/notes/reactions/create + * + * @param {string} id Target note ID. + * @param {string} emoji Reaction emoji string. This string is raw unicode emoji. + */ + public async createEmojiReaction(id: string, emoji: string): Promise> { + await this.client.post<{}>('/api/notes/reactions/create', { + noteId: id, + reaction: emoji + }) + return this.client + .post('/api/notes/show', { + noteId: id + }) + .then(res => ({ ...res, data: MisskeyAPI.Converter.note(res.data) })) + } + + /** + * POST /api/notes/reactions/delete + */ + public async deleteEmojiReaction(id: string, _emoji: string): Promise> { + await this.client.post<{}>('/api/notes/reactions/delete', { + noteId: id + }) + return this.client + .post('/api/notes/show', { + noteId: id + }) + .then(res => ({ ...res, data: MisskeyAPI.Converter.note(res.data) })) + } + + public async getEmojiReactions(id: string): Promise>> { + return this.client + .post>('/api/notes/reactions', { + noteId: id + }) + .then(res => ({ + ...res, + data: MisskeyAPI.Converter.reactions(res.data) + })) + } + + public async getEmojiReaction(_id: string, _emoji: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('misskey does not support') + reject(err) + }) + } + + public userSocket(): WebSocketInterface { + return this.client.socket('user') + } + + public publicSocket(): WebSocketInterface { + return this.client.socket('globalTimeline') + } + + public localSocket(): WebSocketInterface { + return this.client.socket('localTimeline') + } + + public tagSocket(_tag: string): WebSocketInterface { + throw new NoImplementedError('TODO: implement') + } + + public listSocket(list_id: string): WebSocketInterface { + return this.client.socket('list', list_id) + } + + public directSocket(): WebSocketInterface { + return this.client.socket('conversation') + } } diff --git a/packages/megalodon/src/misskey/api_client.ts b/packages/megalodon/src/misskey/api_client.ts index e4dd14045..ead094aca 100644 --- a/packages/megalodon/src/misskey/api_client.ts +++ b/packages/megalodon/src/misskey/api_client.ts @@ -1,727 +1,638 @@ -import axios, { AxiosResponse, AxiosRequestConfig } from "axios"; -import dayjs from "dayjs"; -import FormData from "form-data"; +import axios, { AxiosResponse, AxiosRequestConfig } from 'axios' +import dayjs from 'dayjs' +import FormData from 'form-data' -import { DEFAULT_UA } from "../default"; -import proxyAgent, { ProxyConfig } from "../proxy_config"; -import Response from "../response"; -import MisskeyEntity from "./entity"; -import MegalodonEntity from "../entity"; -import WebSocket from "./web_socket"; -import MisskeyNotificationType from "./notification"; -import NotificationType from "../notification"; +import { DEFAULT_UA } from '../default' +import proxyAgent, { ProxyConfig } from '../proxy_config' +import Response from '../response' +import MisskeyEntity from './entity' +import MegalodonEntity from '../entity' +import WebSocket from './web_socket' +import MisskeyNotificationType from './notification' +import NotificationType, { UnknownNotificationTypeError } from '../notification' namespace MisskeyAPI { - export namespace Entity { - export type App = MisskeyEntity.App; - export type Announcement = MisskeyEntity.Announcement; - export type Blocking = MisskeyEntity.Blocking; - export type Choice = MisskeyEntity.Choice; - export type CreatedNote = MisskeyEntity.CreatedNote; - export type Emoji = MisskeyEntity.Emoji; - export type Favorite = MisskeyEntity.Favorite; - export type Field = MisskeyEntity.Field; - export type File = MisskeyEntity.File; - export type Follower = MisskeyEntity.Follower; - export type Following = MisskeyEntity.Following; - export type FollowRequest = MisskeyEntity.FollowRequest; - export type Hashtag = MisskeyEntity.Hashtag; - export type List = MisskeyEntity.List; - export type Meta = MisskeyEntity.Meta; - export type Mute = MisskeyEntity.Mute; - export type Note = MisskeyEntity.Note; - export type Notification = MisskeyEntity.Notification; - export type Poll = MisskeyEntity.Poll; - export type Reaction = MisskeyEntity.Reaction; - export type Relation = MisskeyEntity.Relation; - export type User = MisskeyEntity.User; - export type UserDetail = MisskeyEntity.UserDetail; - export type UserDetailMe = MisskeyEntity.UserDetailMe; - export type GetAll = MisskeyEntity.GetAll; - export type UserKey = MisskeyEntity.UserKey; - export type Session = MisskeyEntity.Session; - export type Stats = MisskeyEntity.Stats; - export type State = MisskeyEntity.State; - export type APIEmoji = { emojis: Emoji[] }; - } + export namespace Entity { + export type Announcement = MisskeyEntity.Announcement + export type App = MisskeyEntity.App + export type Blocking = MisskeyEntity.Blocking + export type Choice = MisskeyEntity.Choice + export type CreatedNote = MisskeyEntity.CreatedNote + export type Emoji = MisskeyEntity.Emoji + export type Favorite = MisskeyEntity.Favorite + export type File = MisskeyEntity.File + export type Follower = MisskeyEntity.Follower + export type Following = MisskeyEntity.Following + export type FollowRequest = MisskeyEntity.FollowRequest + export type Hashtag = MisskeyEntity.Hashtag + export type List = MisskeyEntity.List + export type Meta = MisskeyEntity.Meta + export type Mute = MisskeyEntity.Mute + export type Note = MisskeyEntity.Note + export type Notification = MisskeyEntity.Notification + export type Poll = MisskeyEntity.Poll + export type Reaction = MisskeyEntity.Reaction + export type Relation = MisskeyEntity.Relation + export type User = MisskeyEntity.User + export type UserDetail = MisskeyEntity.UserDetail + export type UserKey = MisskeyEntity.UserKey + export type Session = MisskeyEntity.Session + export type Stats = MisskeyEntity.Stats + } - export class Converter { - private baseUrl: string; - private instanceHost: string; - private plcUrl: string; - private modelOfAcct = { - id: "1", - username: "none", - acct: "none", - display_name: "none", - locked: true, - bot: true, - discoverable: false, - group: false, - created_at: "1971-01-01T00:00:00.000Z", - note: "", - url: "plc", - avatar: "plc", - avatar_static: "plc", - header: "plc", - header_static: "plc", - followers_count: -1, - following_count: 0, - statuses_count: 0, - last_status_at: "1971-01-01T00:00:00.000Z", - noindex: true, - emojis: [], - fields: [], - moved: null, - }; + export namespace Converter { + export const announcement = (a: Entity.Announcement): MegalodonEntity.Announcement => ({ + id: a.id, + content: a.title + '\n' + a.text, + starts_at: null, + ends_at: null, + published: true, + all_day: true, + published_at: a.createdAt, + updated_at: a.updatedAt, + read: a.isRead !== undefined ? a.isRead : null, + mentions: [], + statuses: [], + tags: [], + emojis: [], + reactions: [] + }) - constructor(baseUrl: string) { - this.baseUrl = baseUrl; - this.instanceHost = baseUrl.substring(baseUrl.indexOf("//") + 2); - this.plcUrl = `${baseUrl}/static-assets/transparent.png`; - this.modelOfAcct.url = this.plcUrl; - this.modelOfAcct.avatar = this.plcUrl; - this.modelOfAcct.avatar_static = this.plcUrl; - this.modelOfAcct.header = this.plcUrl; - this.modelOfAcct.header_static = this.plcUrl; - } + export const emoji = (e: Entity.Emoji): MegalodonEntity.Emoji => { + return { + shortcode: e.name, + static_url: e.url, + url: e.url, + visible_in_picker: true, + category: e.category + } + } - // FIXME: Properly render MFM instead of just escaping HTML characters. - escapeMFM = (text: string): string => - text - .replace(/&/g, "&") - .replace(//g, ">") - .replace(/"/g, """) - .replace(/'/g, "'") - .replace(/`/g, "`") - .replace(/\r?\n/g, "
"); + export const user = (u: Entity.User, host: string | null = null): MegalodonEntity.Account => { + host ? host = host.replace("https://", "") : null; + let acct = u.username + if (u.host) { + acct = `${u.username}@${u.host}` + } + if (host) { + acct = `${u.username}@${host}` + } + return { + id: u.id, + username: u.username, + acct: acct, + display_name: u.name, + locked: false, + group: null, + noindex: null, + suspended: null, + limited: null, + created_at: '', + followers_count: 0, + following_count: 0, + statuses_count: 0, + note: '', + url: acct, + avatar: u.avatarUrl, + avatar_static: u.avatarColor, + header: '', + header_static: '', + emojis: mapEmojis(u.emojis), + moved: null, + fields: [], + bot: null + } + } - emoji = (e: Entity.Emoji): MegalodonEntity.Emoji => { - return { - shortcode: e.name, - static_url: e.url, - url: e.url, - visible_in_picker: true, - category: e.category, - }; - }; + export const userDetail = (u: Entity.UserDetail, host: string | null = null): MegalodonEntity.Account => { + host ? host = host.replace("https://", "") : null; + let acct = u.username + if (u.host) { + acct = `${u.username}@${u.host}` + } + if (host) { + acct = `${u.username}@${host}` + } + return { + id: u.id, + username: u.username, + acct: acct, + display_name: u.name, + locked: u.isLocked, + group: null, + noindex: null, + suspended: null, + limited: null, + created_at: u.createdAt, + followers_count: u.followersCount, + following_count: u.followingCount, + statuses_count: u.notesCount, + note: u.description ? u.description : '', + url: acct, + avatar: u.avatarUrl, + avatar_static: u.avatarColor, + header: u.bannerUrl, + header_static: u.bannerColor, + emojis: mapEmojis(u.emojis), + moved: null, + fields: [], + bot: u.isBot + } + } - field = (f: Entity.Field): MegalodonEntity.Field => ({ - name: f.name, - value: this.escapeMFM(f.value), - verified_at: null, - }); + export const visibility = (v: 'public' | 'home' | 'followers' | 'specified'): 'public' | 'unlisted' | 'private' | 'direct' => { + switch (v) { + case 'public': + return v + case 'home': + return 'unlisted' + case 'followers': + return 'private' + case 'specified': + return 'direct' + } + } - user = (u: Entity.User): MegalodonEntity.Account => { - let acct = u.username; - let acctUrl = `https://${u.host || this.instanceHost}/@${u.username}`; - if (u.host) { - acct = `${u.username}@${u.host}`; - acctUrl = `https://${u.host}/@${u.username}`; - } - return { - id: u.id, - username: u.username, - acct: acct, - display_name: u.name || u.username, - locked: false, - created_at: new Date().toISOString(), - followers_count: 0, - following_count: 0, - statuses_count: 0, - note: "", - url: acctUrl, - avatar: u.avatarUrl, - avatar_static: u.avatarUrl, - header: this.plcUrl, - header_static: this.plcUrl, - emojis: u.emojis && u.emojis.length > 0 ? u.emojis.map((e) => this.emoji(e)) : [], - moved: null, - fields: [], - bot: false, - }; - }; + export const encodeVisibility = (v: 'public' | 'unlisted' | 'private' | 'direct'): 'public' | 'home' | 'followers' | 'specified' => { + switch (v) { + case 'public': + return v + case 'unlisted': + return 'home' + case 'private': + return 'followers' + case 'direct': + return 'specified' + } + } - userDetail = ( - u: Entity.UserDetail, - host: string, - ): MegalodonEntity.Account => { - let acct = u.username; - host = host.replace("https://", ""); - let acctUrl = `https://${host || u.host || this.instanceHost}/@${ - u.username - }`; - if (u.host) { - acct = `${u.username}@${u.host}`; - acctUrl = `https://${u.host}/@${u.username}`; - } - return { - id: u.id, - username: u.username, - acct: acct, - display_name: u.name || u.username, - locked: u.isLocked, - created_at: u.createdAt, - followers_count: u.followersCount, - following_count: u.followingCount, - statuses_count: u.notesCount, - note: u.description?.replace(/\n|\\n/g, "
") ?? "", - url: acctUrl, - avatar: u.avatarUrl, - avatar_static: u.avatarUrl, - header: u.bannerUrl ?? this.plcUrl, - header_static: u.bannerUrl ?? this.plcUrl, - emojis: u.emojis && u.emojis.length > 0 ? u.emojis.map((e) => this.emoji(e)) : [], - moved: null, - fields: u.fields.map((f) => this.field(f)), - bot: u.isBot, - }; - }; + export const fileType = (s: string): 'unknown' | 'image' | 'gifv' | 'video' | 'audio' => { + if (s === 'image/gif') { + return 'gifv' + } + if (s.includes('image')) { + return 'image' + } + if (s.includes('video')) { + return 'video' + } + if (s.includes('audio')) { + return 'audio' + } + return 'unknown' + } - userPreferences = ( - u: MisskeyAPI.Entity.UserDetailMe, - v: "public" | "unlisted" | "private" | "direct", - ): MegalodonEntity.Preferences => { - return { - "reading:expand:media": "default", - "reading:expand:spoilers": false, - "posting:default:language": u.lang, - "posting:default:sensitive": u.alwaysMarkNsfw, - "posting:default:visibility": v, - }; - }; + export const file = (f: Entity.File): MegalodonEntity.Attachment => { + return { + id: f.id, + type: fileType(f.type), + url: f.url, + remote_url: f.url, + preview_url: f.thumbnailUrl, + text_url: f.url, + meta: { + width: f.properties.width, + height: f.properties.height + }, + description: null, + blurhash: null + } + } - visibility = ( - v: "public" | "home" | "followers" | "specified", - ): "public" | "unlisted" | "private" | "direct" => { - switch (v) { - case "public": - return v; - case "home": - return "unlisted"; - case "followers": - return "private"; - case "specified": - return "direct"; - } - }; + export const follower = (f: Entity.Follower): MegalodonEntity.Account => { + return user(f.follower) + } - encodeVisibility = ( - v: "public" | "unlisted" | "private" | "direct", - ): "public" | "home" | "followers" | "specified" => { - switch (v) { - case "public": - return v; - case "unlisted": - return "home"; - case "private": - return "followers"; - case "direct": - return "specified"; - } - }; + export const following = (f: Entity.Following): MegalodonEntity.Account => { + return user(f.followee) + } - fileType = ( - s: string, - ): "unknown" | "image" | "gifv" | "video" | "audio" => { - if (s === "image/gif") { - return "gifv"; - } - if (s.includes("image")) { - return "image"; - } - if (s.includes("video")) { - return "video"; - } - if (s.includes("audio")) { - return "audio"; - } - return "unknown"; - }; + export const relation = (r: Entity.Relation): MegalodonEntity.Relationship => { + return { + id: r.id, + following: r.isFollowing, + followed_by: r.isFollowed, + blocking: r.isBlocking, + blocked_by: r.isBlocked, + muting: r.isMuted, + muting_notifications: false, + requested: r.hasPendingFollowRequestFromYou, + domain_blocking: false, + showing_reblogs: true, + endorsed: false, + notifying: false, + note: null + } + } - file = (f: Entity.File): MegalodonEntity.Attachment => { - return { - id: f.id, - type: this.fileType(f.type), - url: f.url, - remote_url: f.url, - preview_url: f.thumbnailUrl, - text_url: f.url, - meta: { - width: f.properties.width, - height: f.properties.height, - }, - description: f.comment, - blurhash: f.blurhash, - }; - }; + export const choice = (c: Entity.Choice): MegalodonEntity.PollOption => { + return { + title: c.text, + votes_count: c.votes + } + } - follower = (f: Entity.Follower): MegalodonEntity.Account => { - return this.user(f.follower); - }; + export const poll = (p: Entity.Poll): MegalodonEntity.Poll => { + const now = dayjs() + const expire = dayjs(p.expiresAt) + const count = p.choices.reduce((sum, choice) => sum + choice.votes, 0) + return { + id: '', + expires_at: p.expiresAt, + expired: now.isAfter(expire), + multiple: p.multiple, + votes_count: count, + options: Array.isArray(p.choices) ? p.choices.map(c => choice(c)) : [], + voted: Array.isArray(p.choices) ? p.choices.some(c => c.isVoted) : false + } + } - following = (f: Entity.Following): MegalodonEntity.Account => { - return this.user(f.followee); - }; + export const note = (n: Entity.Note, host: string | null = null): MegalodonEntity.Status => { + host ? host = host.replace("https://", "") : null; + return { + id: n.id, + uri: n.uri ? n.uri : host ? `https://${host}/notes/${n.id}` : '', + url: n.url ? n.url : host ? `https://${host}/notes/${n.id}` : '', + account: user(n.user, host ? host : null), + in_reply_to_id: n.replyId, + in_reply_to_account_id: null, + reblog: n.renote ? note(n.renote) : null, + content: n.text + ? n.text + .replace(/&/g, '&') + .replace(//g, '>') + .replace(/"/g, '"') + .replace(/'/g, ''') + .replace(/`/g, '`') + .replace(/\r?\n/g, '
') + : '', + plain_content: n.text ? n.text : null, + created_at: n.createdAt, + emojis: mapEmojis(n.emojis).concat(mapReactionEmojis(n.reactionEmojis)), + replies_count: n.repliesCount, + reblogs_count: n.renoteCount, + favourites_count: 0, + reblogged: false, + favourited: false, + muted: false, + sensitive: Array.isArray(n.files) ? n.files.some(f => f.isSensitive) : false, + spoiler_text: n.cw ? n.cw : '', + visibility: visibility(n.visibility), + media_attachments: Array.isArray(n.files) ? n.files.map(f => file(f)) : [], + mentions: [], + tags: [], + card: null, + poll: n.poll ? poll(n.poll) : null, + application: null, + language: null, + pinned: null, + emoji_reactions: typeof n.reactions === 'object' ? mapReactions(n.reactions, n.myReaction) : [], + bookmarked: false, + quote: n.renote !== undefined && n.text !== null + } + } - relation = (r: Entity.Relation): MegalodonEntity.Relationship => { - return { - id: r.id, - following: r.isFollowing, - followed_by: r.isFollowed, - blocking: r.isBlocking, - blocked_by: r.isBlocked, - muting: r.isMuted, - muting_notifications: false, - requested: r.hasPendingFollowRequestFromYou, - domain_blocking: false, - showing_reblogs: true, - endorsed: false, - notifying: false, - }; - }; + const mapEmojis = (e: Array | { [key: string]: string }): Array => { + if (Array.isArray(e)) { + return e.map(e => emoji(e)) + } else if (e) { + return mapReactionEmojis(e) + } else { + return [] + } + } - choice = (c: Entity.Choice): MegalodonEntity.PollOption => { - return { - title: c.text, - votes_count: c.votes, - }; - }; + export const mapReactions = (r: { [key: string]: number }, myReaction?: string): Array => { + return Object.keys(r).map(key => { + if (myReaction && key === myReaction) { + return { + count: r[key], + me: true, + name: key + } + } + return { + count: r[key], + me: false, + name: key + } + }) + } - poll = (p: Entity.Poll, id: string): MegalodonEntity.Poll => { - const now = dayjs(); - const expire = dayjs(p.expiresAt); - const count = p.choices.reduce((sum, choice) => sum + choice.votes, 0); - return { - id: id, - expires_at: p.expiresAt, - expired: now.isAfter(expire), - multiple: p.multiple, - votes_count: count, - options: p.choices.map((c) => this.choice(c)), - voted: p.choices.some((c) => c.isVoted), - own_votes: p.choices - .filter((c) => c.isVoted) - .map((c) => p.choices.indexOf(c)), - }; - }; + const mapReactionEmojis = (r: { [key: string]: string }): Array => { + return Object.keys(r).map(key => ({ + shortcode: key, + static_url: r[key], + url: r[key], + visible_in_picker: true, + category: '' + })) + } - note = (n: Entity.Note, host: string): MegalodonEntity.Status => { - host = host.replace("https://", ""); + export const reactions = (r: Array): Array => { + const result: Array = [] + r.map(e => { + const i = result.findIndex(res => res.name === e.type) + if (i >= 0) { + result[i].count++ + } else { + result.push({ + count: 1, + me: false, + name: e.type + }) + } + }) + return result + } - return { - id: n.id, - uri: n.uri ? n.uri : `https://${host}/notes/${n.id}`, - url: n.uri ? n.uri : `https://${host}/notes/${n.id}`, - account: this.user(n.user), - in_reply_to_id: n.replyId, - in_reply_to_account_id: n.reply?.userId ?? null, - reblog: n.renote ? this.note(n.renote, host) : null, - content: n.text ? this.escapeMFM(n.text) : "", - plain_content: n.text ? n.text : null, - created_at: n.createdAt, - // Remove reaction emojis with names containing @ from the emojis list. - emojis: n.emojis && n.emojis.length > 0 ? n.emojis - .filter((e) => e.name.indexOf("@") === -1) - .map((e) => this.emoji(e)) : [], - replies_count: n.repliesCount, - reblogs_count: n.renoteCount, - favourites_count: this.getTotalReactions(n.reactions), - reblogged: false, - favourited: !!n.myReaction, - muted: false, - sensitive: n.files ? n.files.some((f) => f.isSensitive) : false, - spoiler_text: n.cw ? n.cw : "", - visibility: this.visibility(n.visibility), - media_attachments: n.files ? n.files.map((f) => this.file(f)) : [], - mentions: [], - tags: [], - card: null, - poll: n.poll ? this.poll(n.poll, n.id) : null, - application: null, - language: null, - pinned: null, - // Use emojis list to provide URLs for emoji reactions. - reactions: n.emojis && n.emojis.length > 0 ? this.mapReactions(n.emojis, n.reactions, n.myReaction) : [], - bookmarked: false, - quote: n.renote && n.text ? this.note(n.renote, host) : null, - }; - }; + export const noteToConversation = (n: Entity.Note): MegalodonEntity.Conversation => { + const accounts: Array = [user(n.user)] + if (n.reply) { + accounts.push(user(n.reply.user)) + } + return { + id: n.id, + accounts: accounts, + last_status: note(n), + unread: false + } + } - mapReactions = ( - emojis: Array, - r: { [key: string]: number }, - myReaction?: string, - ): Array => { - // Map of emoji shortcodes to image URLs. - const emojiUrls = new Map( - emojis.map((e) => [e.name, e.url]), - ); - return Object.keys(r).map((key) => { - // Strip colons from custom emoji reaction names to match emoji shortcodes. - const shortcode = key.replaceAll(":", ""); - // If this is a custom emoji (vs. a Unicode emoji), find its image URL. - const url = emojiUrls.get(shortcode); - // Finally, remove trailing @. from local custom emoji reaction names. - const name = shortcode.replace("@.", ""); - return { - count: r[key], - me: key === myReaction, - name, - url, - // We don't actually have a static version of the asset, but clients expect one anyway. - static_url: url, - }; - }); - }; + export const list = (l: Entity.List): MegalodonEntity.List => ({ + id: l.id, + title: l.name, + replies_policy: null + }) - getTotalReactions = (r: { [key: string]: number }): number => { - return Object.values(r).length > 0 - ? Object.values(r).reduce( - (previousValue, currentValue) => previousValue + currentValue, - ) - : 0; - }; + export const encodeNotificationType = ( + e: MegalodonEntity.NotificationType + ): MisskeyEntity.NotificationType | UnknownNotificationTypeError => { + switch (e) { + case NotificationType.Follow: + return MisskeyNotificationType.Follow + case NotificationType.Mention: + return MisskeyNotificationType.Reply + case NotificationType.Favourite: + case NotificationType.EmojiReaction: + return MisskeyNotificationType.Reaction + case NotificationType.Reblog: + return MisskeyNotificationType.Renote + case NotificationType.PollVote: + return MisskeyNotificationType.PollVote + case NotificationType.FollowRequest: + return MisskeyNotificationType.ReceiveFollowRequest + default: + return new UnknownNotificationTypeError() + } + } - reactions = ( - r: Array, - ): Array => { - const result: Array = []; - for (const e of r) { - const i = result.findIndex((res) => res.name === e.type); - if (i >= 0) { - result[i].count++; - } else { - result.push({ - count: 1, - me: false, - name: e.type, - }); - } - } - return result; - }; + export const decodeNotificationType = ( + e: MisskeyEntity.NotificationType + ): MegalodonEntity.NotificationType | UnknownNotificationTypeError => { + switch (e) { + case MisskeyNotificationType.Follow: + return NotificationType.Follow + case MisskeyNotificationType.Mention: + case MisskeyNotificationType.Reply: + return NotificationType.Mention + case MisskeyNotificationType.Renote: + case MisskeyNotificationType.Quote: + return NotificationType.Reblog + case MisskeyNotificationType.Reaction: + return NotificationType.EmojiReaction + case MisskeyNotificationType.PollVote: + return NotificationType.PollVote + case MisskeyNotificationType.ReceiveFollowRequest: + return NotificationType.FollowRequest + case MisskeyNotificationType.FollowRequestAccepted: + return NotificationType.Follow + default: + return new UnknownNotificationTypeError() + } + } - noteToConversation = ( - n: Entity.Note, - host: string, - ): MegalodonEntity.Conversation => { - const accounts: Array = [this.user(n.user)]; - if (n.reply) { - accounts.push(this.user(n.reply.user)); - } - return { - id: n.id, - accounts: accounts, - last_status: this.note(n, host), - unread: false, - }; - }; + export const notification = (n: Entity.Notification): MegalodonEntity.Notification | UnknownNotificationTypeError => { + const notificationType = decodeNotificationType(n.type) + if (notificationType instanceof UnknownNotificationTypeError) { + return notificationType + } + let notification = { + id: n.id, + account: user(n.user), + created_at: n.createdAt, + type: notificationType + } + if (n.note) { + notification = Object.assign(notification, { + status: note(n.note) + }) + } + if (n.reaction) { + notification = Object.assign(notification, { + emoji: n.reaction + }) + } + return notification + } - list = (l: Entity.List): MegalodonEntity.List => ({ - id: l.id, - title: l.name, - }); + export const stats = (s: Entity.Stats): MegalodonEntity.Stats => { + return { + user_count: s.usersCount, + status_count: s.notesCount, + domain_count: s.instances + } + } - encodeNotificationType = ( - e: MegalodonEntity.NotificationType, - ): MisskeyEntity.NotificationType => { - switch (e) { - case NotificationType.Follow: - return MisskeyNotificationType.Follow; - case NotificationType.Mention: - return MisskeyNotificationType.Reply; - case NotificationType.Favourite: - case NotificationType.Reaction: - return MisskeyNotificationType.Reaction; - case NotificationType.Reblog: - return MisskeyNotificationType.Renote; - case NotificationType.Poll: - return MisskeyNotificationType.PollEnded; - case NotificationType.FollowRequest: - return MisskeyNotificationType.ReceiveFollowRequest; - default: - return e; - } - }; + export const meta = (m: Entity.Meta, s: Entity.Stats): MegalodonEntity.Instance => { + const wss = m.uri.replace(/^https:\/\//, 'wss://') + return { + uri: m.uri, + title: m.name, + description: m.description, + email: m.maintainerEmail, + version: m.version, + thumbnail: m.bannerUrl, + urls: { + streaming_api: `${wss}/streaming` + }, + stats: stats(s), + languages: m.langs, + registrations: !m.disableRegistration, + approval_required: false, + configuration: { + statuses: { + max_characters: m.maxNoteTextLength, + max_media_attachments: m.policies.clipLimit + } + } + } + } - decodeNotificationType = ( - e: MisskeyEntity.NotificationType, - ): MegalodonEntity.NotificationType => { - switch (e) { - case MisskeyNotificationType.Follow: - return NotificationType.Follow; - case MisskeyNotificationType.Mention: - case MisskeyNotificationType.Reply: - return NotificationType.Mention; - case MisskeyNotificationType.Renote: - case MisskeyNotificationType.Quote: - return NotificationType.Reblog; - case MisskeyNotificationType.Reaction: - return NotificationType.Reaction; - case MisskeyNotificationType.PollEnded: - return NotificationType.Poll; - case MisskeyNotificationType.ReceiveFollowRequest: - return NotificationType.FollowRequest; - case MisskeyNotificationType.FollowRequestAccepted: - return NotificationType.Follow; - default: - return e; - } - }; + export const hashtag = (h: Entity.Hashtag): MegalodonEntity.Tag => { + return { + name: h.tag, + url: h.tag, + history: [], + following: false + } + } + } - announcement = (a: Entity.Announcement): MegalodonEntity.Announcement => ({ - id: a.id, - content: `

${this.escapeMFM(a.title)}

${this.escapeMFM(a.text)}`, - starts_at: null, - ends_at: null, - published: true, - all_day: false, - published_at: a.createdAt, - updated_at: a.updatedAt, - read: a.isRead, - mentions: [], - statuses: [], - tags: [], - emojis: [], - reactions: [], - }); + export const DEFAULT_SCOPE = [ + 'read:account', + 'write:account', + 'read:blocks', + 'write:blocks', + 'read:drive', + 'write:drive', + 'read:favorites', + 'write:favorites', + 'read:following', + 'write:following', + 'read:mutes', + 'write:mutes', + 'write:notes', + 'read:notifications', + 'write:notifications', + 'read:reactions', + 'write:reactions', + 'write:votes' + ] - notification = ( - n: Entity.Notification, - host: string, - ): MegalodonEntity.Notification => { - let notification = { - id: n.id, - account: n.user ? this.user(n.user) : this.modelOfAcct, - created_at: n.createdAt, - type: this.decodeNotificationType(n.type), - }; - if (n.note) { - notification = Object.assign(notification, { - status: this.note(n.note, host), - }); - if (notification.type === NotificationType.Poll) { - notification = Object.assign(notification, { - account: this.note(n.note, host).account, - }); - } - if (n.reaction) { - notification = Object.assign(notification, { - reaction: this.mapReactions(n.note.emojis, { [n.reaction]: 1 })[0], - }); - } - } - return notification; - }; + /** + * Interface + */ + export interface Interface { + get(path: string, params?: any, headers?: { [key: string]: string }): Promise> + post(path: string, params?: any, headers?: { [key: string]: string }): Promise> + cancel(): void + socket(channel: 'user' | 'localTimeline' | 'hybridTimeline' | 'globalTimeline' | 'conversation' | 'list', listId?: string): WebSocket + } - stats = (s: Entity.Stats): MegalodonEntity.Stats => { - return { - user_count: s.usersCount, - status_count: s.notesCount, - domain_count: s.instances, - }; - }; + /** + * Misskey API client. + * + * Usign axios for request, you will handle promises. + */ + export class Client implements Interface { + private accessToken: string | null + private baseUrl: string + private userAgent: string + private abortController: AbortController + private proxyConfig: ProxyConfig | false = false - meta = (m: Entity.Meta, s: Entity.Stats): MegalodonEntity.Instance => { - const wss = m.uri.replace(/^https:\/\//, "wss://"); - return { - uri: m.uri, - title: m.name, - description: m.description, - email: m.maintainerEmail, - version: m.version, - thumbnail: m.bannerUrl, - urls: { - streaming_api: `${wss}/streaming`, - }, - stats: this.stats(s), - languages: m.langs, - contact_account: null, - max_toot_chars: m.maxNoteTextLength, - registrations: !m.disableRegistration, - }; - }; + /** + * @param baseUrl hostname or base URL + * @param accessToken access token from OAuth2 authorization + * @param userAgent UserAgent is specified in header on request. + * @param proxyConfig Proxy setting, or set false if don't use proxy. + */ + constructor(baseUrl: string, accessToken: string | null, userAgent: string = DEFAULT_UA, proxyConfig: ProxyConfig | false = false) { + this.accessToken = accessToken + this.baseUrl = baseUrl + this.userAgent = userAgent + this.proxyConfig = proxyConfig + this.abortController = new AbortController() + axios.defaults.signal = this.abortController.signal + } - hashtag = (h: Entity.Hashtag): MegalodonEntity.Tag => { - return { - name: h.tag, - url: h.tag, - history: null, - following: false, - }; - }; - } + /** + * GET request to misskey API. + **/ + public async get(path: string, params: any = {}, headers: { [key: string]: string } = {}): Promise> { + let options: AxiosRequestConfig = { + params: params, + headers: headers, + maxContentLength: Infinity, + maxBodyLength: Infinity + } + if (this.proxyConfig) { + options = Object.assign(options, { + httpAgent: proxyAgent(this.proxyConfig), + httpsAgent: proxyAgent(this.proxyConfig) + }) + } + return axios.get(this.baseUrl + path, options).then((resp: AxiosResponse) => { + const res: Response = { + data: resp.data, + status: resp.status, + statusText: resp.statusText, + headers: resp.headers + } + return res + }) + } - export const DEFAULT_SCOPE = [ - "read:account", - "write:account", - "read:blocks", - "write:blocks", - "read:drive", - "write:drive", - "read:favorites", - "write:favorites", - "read:following", - "write:following", - "read:mutes", - "write:mutes", - "write:notes", - "read:notifications", - "write:notifications", - "read:reactions", - "write:reactions", - "write:votes", - ]; + /** + * POST request to misskey REST API. + * @param path relative path from baseUrl + * @param params Form data + * @param headers Request header object + */ + public async post(path: string, params: any = {}, headers: { [key: string]: string } = {}): Promise> { + let options: AxiosRequestConfig = { + headers: headers, + maxContentLength: Infinity, + maxBodyLength: Infinity + } + if (this.proxyConfig) { + options = Object.assign(options, { + httpAgent: proxyAgent(this.proxyConfig), + httpsAgent: proxyAgent(this.proxyConfig) + }) + } + let bodyParams = params + if (this.accessToken) { + if (params instanceof FormData) { + bodyParams.append('i', this.accessToken) + } else { + bodyParams = Object.assign(params, { + i: this.accessToken + }) + } + } + return axios.post(this.baseUrl + path, bodyParams, options).then((resp: AxiosResponse) => { + const res: Response = { + data: resp.data, + status: resp.status, + statusText: resp.statusText, + headers: resp.headers + } + return res + }) + } - /** - * Interface - */ - export interface Interface { - post( - path: string, - params?: any, - headers?: { [key: string]: string }, - ): Promise>; - cancel(): void; - socket( - channel: - | "user" - | "localTimeline" - | "hybridTimeline" - | "globalTimeline" - | "conversation" - | "list", - listId?: string, - ): WebSocket; - } + /** + * Cancel all requests in this instance. + * @returns void + */ + public cancel(): void { + return this.abortController.abort() + } - /** - * Misskey API client. - * - * Usign axios for request, you will handle promises. - */ - export class Client implements Interface { - private accessToken: string | null; - private baseUrl: string; - private userAgent: string; - private abortController: AbortController; - private proxyConfig: ProxyConfig | false = false; - private converter: Converter; - - /** - * @param baseUrl hostname or base URL - * @param accessToken access token from OAuth2 authorization - * @param userAgent UserAgent is specified in header on request. - * @param proxyConfig Proxy setting, or set false if don't use proxy. - * @param converter Converter instance. - */ - constructor( - baseUrl: string, - accessToken: string | null, - userAgent: string = DEFAULT_UA, - proxyConfig: ProxyConfig | false = false, - converter: Converter, - ) { - this.accessToken = accessToken; - this.baseUrl = baseUrl; - this.userAgent = userAgent; - this.proxyConfig = proxyConfig; - this.abortController = new AbortController(); - this.converter = converter; - axios.defaults.signal = this.abortController.signal; - } - - /** - * POST request to mastodon REST API. - * @param path relative path from baseUrl - * @param params Form data - * @param headers Request header object - */ - public async post( - path: string, - params: any = {}, - headers: { [key: string]: string } = {}, - ): Promise> { - let options: AxiosRequestConfig = { - headers: headers, - maxContentLength: Infinity, - maxBodyLength: Infinity, - }; - if (this.proxyConfig) { - options = Object.assign(options, { - httpAgent: proxyAgent(this.proxyConfig), - httpsAgent: proxyAgent(this.proxyConfig), - }); - } - let bodyParams = params; - if (this.accessToken) { - if (params instanceof FormData) { - bodyParams.append("i", this.accessToken); - } else { - bodyParams = Object.assign(params, { - i: this.accessToken, - }); - } - } - - return axios - .post(this.baseUrl + path, bodyParams, options) - .then((resp: AxiosResponse) => { - const res: Response = { - data: resp.data, - status: resp.status, - statusText: resp.statusText, - headers: resp.headers, - }; - return res; - }); - } - - /** - * Cancel all requests in this instance. - * @returns void - */ - public cancel(): void { - return this.abortController.abort(); - } - - /** - * Get connection and receive websocket connection for Misskey API. - * - * @param channel Channel name is user, localTimeline, hybridTimeline, globalTimeline, conversation or list. - * @param listId This parameter is required only list channel. - */ - public socket( - channel: - | "user" - | "localTimeline" - | "hybridTimeline" - | "globalTimeline" - | "conversation" - | "list", - listId?: string, - ): WebSocket { - if (!this.accessToken) { - throw new Error("accessToken is required"); - } - const url = `${this.baseUrl}/streaming`; - const streaming = new WebSocket( - url, - channel, - this.accessToken, - listId, - this.userAgent, - this.proxyConfig, - this.converter, - ); - process.nextTick(() => { - streaming.start(); - }); - return streaming; - } - } + /** + * Get connection and receive websocket connection for Misskey API. + * + * @param channel Channel name is user, localTimeline, hybridTimeline, globalTimeline, conversation or list. + * @param listId This parameter is required only list channel. + */ + public socket( + channel: 'user' | 'localTimeline' | 'hybridTimeline' | 'globalTimeline' | 'conversation' | 'list', + listId?: string + ): WebSocket { + if (!this.accessToken) { + throw new Error('accessToken is required') + } + const url = this.baseUrl + '/streaming' + const streaming = new WebSocket(url, channel, this.accessToken, listId, this.userAgent, this.proxyConfig) + process.nextTick(() => { + streaming.start() + }) + return streaming + } + } } -export default MisskeyAPI; +export default MisskeyAPI diff --git a/packages/megalodon/src/misskey/entities/announcement.ts b/packages/megalodon/src/misskey/entities/announcement.ts index 7594ba7ef..ec1739a75 100644 --- a/packages/megalodon/src/misskey/entities/announcement.ts +++ b/packages/megalodon/src/misskey/entities/announcement.ts @@ -1,10 +1,11 @@ namespace MisskeyEntity { - export type Announcement = { - id: string; - createdAt: string; - updatedAt: string; - text: string; - title: string; - isRead?: boolean; - }; + export type Announcement = { + id: string + createdAt: string + updatedAt: string | null + text: string + title: string + imageurl: string | null + isRead?: boolean + } } diff --git a/packages/megalodon/src/misskey/entities/app.ts b/packages/megalodon/src/misskey/entities/app.ts index 5924060d8..40a704b94 100644 --- a/packages/megalodon/src/misskey/entities/app.ts +++ b/packages/megalodon/src/misskey/entities/app.ts @@ -1,9 +1,9 @@ namespace MisskeyEntity { - export type App = { - id: string; - name: string; - callbackUrl: string; - permission: Array; - secret: string; - }; + export type App = { + id: string + name: string + callbackUrl: string + permission: Array + secret: string + } } diff --git a/packages/megalodon/src/misskey/entities/blocking.ts b/packages/megalodon/src/misskey/entities/blocking.ts index 3e56790a7..9900a777b 100644 --- a/packages/megalodon/src/misskey/entities/blocking.ts +++ b/packages/megalodon/src/misskey/entities/blocking.ts @@ -1,10 +1,10 @@ /// namespace MisskeyEntity { - export type Blocking = { - id: string; - createdAt: string; - blockeeId: string; - blockee: UserDetail; - }; + export type Blocking = { + id: string + createdAt: string + blockeeId: string + blockee: UserDetail + } } diff --git a/packages/megalodon/src/misskey/entities/createdNote.ts b/packages/megalodon/src/misskey/entities/createdNote.ts index 235f7063f..88ba60040 100644 --- a/packages/megalodon/src/misskey/entities/createdNote.ts +++ b/packages/megalodon/src/misskey/entities/createdNote.ts @@ -1,7 +1,7 @@ /// namespace MisskeyEntity { - export type CreatedNote = { - createdNote: Note; - }; + export type CreatedNote = { + createdNote: Note + } } diff --git a/packages/megalodon/src/misskey/entities/emoji.ts b/packages/megalodon/src/misskey/entities/emoji.ts index d320760e9..2bd4c8c73 100644 --- a/packages/megalodon/src/misskey/entities/emoji.ts +++ b/packages/megalodon/src/misskey/entities/emoji.ts @@ -1,9 +1,8 @@ namespace MisskeyEntity { - export type Emoji = { - name: string; - host: string | null; - url: string; - aliases: Array; - category: string; - }; + export type Emoji = { + name: string + url: string + aliases: Array + category: string + } } diff --git a/packages/megalodon/src/misskey/entities/favorite.ts b/packages/megalodon/src/misskey/entities/favorite.ts index ba948f2e7..8ed7a54bf 100644 --- a/packages/megalodon/src/misskey/entities/favorite.ts +++ b/packages/megalodon/src/misskey/entities/favorite.ts @@ -1,10 +1,10 @@ /// namespace MisskeyEntity { - export type Favorite = { - id: string; - createdAt: string; - noteId: string; - note: Note; - }; + export type Favorite = { + id: string + createdAt: string + noteId: string + note: Note + } } diff --git a/packages/megalodon/src/misskey/entities/file.ts b/packages/megalodon/src/misskey/entities/file.ts index e823dde1b..6e4e09eee 100644 --- a/packages/megalodon/src/misskey/entities/file.ts +++ b/packages/megalodon/src/misskey/entities/file.ts @@ -1,20 +1,18 @@ namespace MisskeyEntity { - export type File = { - id: string; - createdAt: string; - name: string; - type: string; - md5: string; - size: number; - isSensitive: boolean; - properties: { - width: number; - height: number; - avgColor: string; - }; - url: string; - thumbnailUrl: string; - comment: string; - blurhash: string; - }; + export type File = { + id: string + createdAt: string + name: string + type: string + md5: string + size: number + isSensitive: boolean + properties: { + width: number + height: number + avgColor: string + } + url: string + thumbnailUrl: string + } } diff --git a/packages/megalodon/src/misskey/entities/followRequest.ts b/packages/megalodon/src/misskey/entities/followRequest.ts index 60bd0e0ab..bd2777b2d 100644 --- a/packages/megalodon/src/misskey/entities/followRequest.ts +++ b/packages/megalodon/src/misskey/entities/followRequest.ts @@ -1,9 +1,9 @@ /// namespace MisskeyEntity { - export type FollowRequest = { - id: string; - follower: User; - followee: User; - }; + export type FollowRequest = { + id: string + follower: User + followee: User + } } diff --git a/packages/megalodon/src/misskey/entities/follower.ts b/packages/megalodon/src/misskey/entities/follower.ts index 34ae82551..70ef632e1 100644 --- a/packages/megalodon/src/misskey/entities/follower.ts +++ b/packages/megalodon/src/misskey/entities/follower.ts @@ -1,11 +1,11 @@ /// namespace MisskeyEntity { - export type Follower = { - id: string; - createdAt: string; - followeeId: string; - followerId: string; - follower: UserDetail; - }; + export type Follower = { + id: string + createdAt: string + followeeId: string + followerId: string + follower: UserDetail + } } diff --git a/packages/megalodon/src/misskey/entities/following.ts b/packages/megalodon/src/misskey/entities/following.ts index 6cbc8f1c3..927a91354 100644 --- a/packages/megalodon/src/misskey/entities/following.ts +++ b/packages/megalodon/src/misskey/entities/following.ts @@ -1,11 +1,11 @@ /// namespace MisskeyEntity { - export type Following = { - id: string; - createdAt: string; - followeeId: string; - followerId: string; - followee: UserDetail; - }; + export type Following = { + id: string + createdAt: string + followeeId: string + followerId: string + followee: UserDetail + } } diff --git a/packages/megalodon/src/misskey/entities/hashtag.ts b/packages/megalodon/src/misskey/entities/hashtag.ts index 3ec4d6675..6a3fe43ad 100644 --- a/packages/megalodon/src/misskey/entities/hashtag.ts +++ b/packages/megalodon/src/misskey/entities/hashtag.ts @@ -1,7 +1,7 @@ namespace MisskeyEntity { - export type Hashtag = { - tag: string; - chart: Array; - usersCount: number; - }; + export type Hashtag = { + tag: string + chart: Array + usersCount: number + } } diff --git a/packages/megalodon/src/misskey/entities/list.ts b/packages/megalodon/src/misskey/entities/list.ts index 60706592a..8167d2981 100644 --- a/packages/megalodon/src/misskey/entities/list.ts +++ b/packages/megalodon/src/misskey/entities/list.ts @@ -1,8 +1,8 @@ namespace MisskeyEntity { - export type List = { - id: string; - createdAt: string; - name: string; - userIds: Array; - }; + export type List = { + id: string + createdAt: string + name: string + userIds: Array + } } diff --git a/packages/megalodon/src/misskey/entities/meta.ts b/packages/megalodon/src/misskey/entities/meta.ts index 97827fe8f..6d168db23 100644 --- a/packages/megalodon/src/misskey/entities/meta.ts +++ b/packages/megalodon/src/misskey/entities/meta.ts @@ -1,18 +1,47 @@ /// namespace MisskeyEntity { - export type Meta = { - maintainerName: string; - maintainerEmail: string; - name: string; - version: string; - uri: string; - description: string; - langs: Array; - disableRegistration: boolean; - disableLocalTimeline: boolean; - bannerUrl: string; - maxNoteTextLength: 3000; - emojis: Array; - }; + export type Meta = { + maintainerName: string + maintainerEmail: string + name: string + version: string + uri: string + description: string + langs: Array + disableRegistration: boolean + disableLocalTimeline: boolean + bannerUrl: string + maxNoteTextLength: number + emojis: Array + policies: { + gtlAvailable: boolean + ltlAvailable: boolean + canPublicNote: boolean + canInvite: boolean + canManageCustomEmojis: boolean + canHideAds: boolean + driveCapacityMb: number + pinLimit: number + antennaLimit: number + wordMuteLimit: number + webhookLimit: number + clipLimit: number + noteEachClipsLimit: number + userListLimit: number + userEachUserListsLimit: number + rateLimitFactor: number + } + features: { + registration: boolean + emailRequiredForSignup: boolean + elasticsearch: boolean + hcaptcha: boolean + recaptcha: boolean + turnstile: boolean + objectStorage: boolean + serviceWorker: boolean + miauth: boolean + } + } } diff --git a/packages/megalodon/src/misskey/entities/mute.ts b/packages/megalodon/src/misskey/entities/mute.ts index 7975b3d31..3cd7ae409 100644 --- a/packages/megalodon/src/misskey/entities/mute.ts +++ b/packages/megalodon/src/misskey/entities/mute.ts @@ -1,10 +1,10 @@ /// namespace MisskeyEntity { - export type Mute = { - id: string; - createdAt: string; - muteeId: string; - mutee: UserDetail; - }; + export type Mute = { + id: string + createdAt: string + muteeId: string + mutee: UserDetail + } } diff --git a/packages/megalodon/src/misskey/entities/note.ts b/packages/megalodon/src/misskey/entities/note.ts index 64a0a5078..08c5f10ae 100644 --- a/packages/megalodon/src/misskey/entities/note.ts +++ b/packages/megalodon/src/misskey/entities/note.ts @@ -4,29 +4,32 @@ /// namespace MisskeyEntity { - export type Note = { - id: string; - createdAt: string; - userId: string; - user: User; - text: string | null; - cw: string | null; - visibility: "public" | "home" | "followers" | "specified"; - renoteCount: number; - repliesCount: number; - reactions: { [key: string]: number }; - emojis: Array; - fileIds: Array; - files: Array; - replyId: string | null; - renoteId: string | null; - uri?: string; - reply?: Note; - renote?: Note; - viaMobile?: boolean; - tags?: Array; - poll?: Poll; - mentions?: Array; - myReaction?: string; - }; + export type Note = { + id: string + createdAt: string + userId: string + user: User + text: string | null + cw: string | null + visibility: 'public' | 'home' | 'followers' | 'specified' + renoteCount: number + repliesCount: number + reactions: { [key: string]: number } + // This field includes only remote emojis + reactionEmojis: { [key: string]: string } + emojis: Array | { [key: string]: string } + fileIds: Array + files: Array + replyId: string | null + renoteId: string | null + uri?: string + url?: string + reply?: Note + renote?: Note + viaMobile?: boolean + tags?: Array + poll?: Poll + mentions?: Array + myReaction?: string + } } diff --git a/packages/megalodon/src/misskey/entities/notification.ts b/packages/megalodon/src/misskey/entities/notification.ts index 7ecb91153..c331a1ec8 100644 --- a/packages/megalodon/src/misskey/entities/notification.ts +++ b/packages/megalodon/src/misskey/entities/notification.ts @@ -2,16 +2,16 @@ /// namespace MisskeyEntity { - export type Notification = { - id: string; - createdAt: string; - // https://github.com/syuilo/misskey/blob/056942391aee135eb6c77aaa63f6ed5741d701a6/src/models/entities/notification.ts#L50-L62 - type: NotificationType; - userId: string; - user: User; - note?: Note; - reaction?: string; - }; + export type Notification = { + id: string + createdAt: string + // https://github.com/syuilo/misskey/blob/056942391aee135eb6c77aaa63f6ed5741d701a6/src/models/entities/notification.ts#L50-L62 + type: NotificationType + userId: string + user: User + note?: Note + reaction?: string + } - export type NotificationType = string; + export type NotificationType = string } diff --git a/packages/megalodon/src/misskey/entities/poll.ts b/packages/megalodon/src/misskey/entities/poll.ts index 9f6bfa40d..a3f1d971a 100644 --- a/packages/megalodon/src/misskey/entities/poll.ts +++ b/packages/megalodon/src/misskey/entities/poll.ts @@ -1,13 +1,13 @@ namespace MisskeyEntity { - export type Choice = { - text: string; - votes: number; - isVoted: boolean; - }; + export type Choice = { + text: string + votes: number + isVoted: boolean + } - export type Poll = { - multiple: boolean; - expiresAt: string; - choices: Array; - }; + export type Poll = { + multiple: boolean + expiresAt: string + choices: Array + } } diff --git a/packages/megalodon/src/misskey/entities/reaction.ts b/packages/megalodon/src/misskey/entities/reaction.ts index b35a25bfb..270ca6eab 100644 --- a/packages/megalodon/src/misskey/entities/reaction.ts +++ b/packages/megalodon/src/misskey/entities/reaction.ts @@ -1,11 +1,10 @@ /// namespace MisskeyEntity { - export type Reaction = { - id: string; - createdAt: string; - user: User; - url?: string; - type: string; - }; + export type Reaction = { + id: string + createdAt: string + user: User + type: string + } } diff --git a/packages/megalodon/src/misskey/entities/relation.ts b/packages/megalodon/src/misskey/entities/relation.ts index 6db4a1b16..07653b486 100644 --- a/packages/megalodon/src/misskey/entities/relation.ts +++ b/packages/megalodon/src/misskey/entities/relation.ts @@ -1,12 +1,12 @@ namespace MisskeyEntity { - export type Relation = { - id: string; - isFollowing: boolean; - hasPendingFollowRequestFromYou: boolean; - hasPendingFollowRequestToYou: boolean; - isFollowed: boolean; - isBlocking: boolean; - isBlocked: boolean; - isMuted: boolean; - }; + export type Relation = { + id: string + isFollowing: boolean + hasPendingFollowRequestFromYou: boolean + hasPendingFollowRequestToYou: boolean + isFollowed: boolean + isBlocking: boolean + isBlocked: boolean + isMuted: boolean + } } diff --git a/packages/megalodon/src/misskey/entities/session.ts b/packages/megalodon/src/misskey/entities/session.ts index 572333ff0..47fe9cf82 100644 --- a/packages/megalodon/src/misskey/entities/session.ts +++ b/packages/megalodon/src/misskey/entities/session.ts @@ -1,6 +1,6 @@ namespace MisskeyEntity { - export type Session = { - token: string; - url: string; - }; + export type Session = { + token: string + url: string + } } diff --git a/packages/megalodon/src/misskey/entities/state.ts b/packages/megalodon/src/misskey/entities/state.ts deleted file mode 100644 index 62d60ce28..000000000 --- a/packages/megalodon/src/misskey/entities/state.ts +++ /dev/null @@ -1,7 +0,0 @@ -namespace MisskeyEntity { - export type State = { - isFavorited: boolean; - isMutedThread: boolean; - isWatching: boolean; - }; -} diff --git a/packages/megalodon/src/misskey/entities/stats.ts b/packages/megalodon/src/misskey/entities/stats.ts index 9832a0ad8..7f080efda 100644 --- a/packages/megalodon/src/misskey/entities/stats.ts +++ b/packages/megalodon/src/misskey/entities/stats.ts @@ -1,9 +1,9 @@ namespace MisskeyEntity { - export type Stats = { - notesCount: number; - originalNotesCount: number; - usersCount: number; - originalUsersCount: number; - instances: number; - }; + export type Stats = { + notesCount: number + originalNotesCount: number + usersCount: number + originalUsersCount: number + instances: number + } } diff --git a/packages/megalodon/src/misskey/entities/user.ts b/packages/megalodon/src/misskey/entities/user.ts index 96610f6e6..78745c20d 100644 --- a/packages/megalodon/src/misskey/entities/user.ts +++ b/packages/megalodon/src/misskey/entities/user.ts @@ -1,13 +1,13 @@ /// namespace MisskeyEntity { - export type User = { - id: string; - name: string; - username: string; - host: string | null; - avatarUrl: string; - avatarColor: string; - emojis: Array; - }; + export type User = { + id: string + name: string + username: string + host: string | null + avatarUrl: string + avatarColor: string + emojis: Array | { [key: string]: string } + } } diff --git a/packages/megalodon/src/misskey/entities/userDetail.ts b/packages/megalodon/src/misskey/entities/userDetail.ts index 0f5bd5f64..607d9a511 100644 --- a/packages/megalodon/src/misskey/entities/userDetail.ts +++ b/packages/megalodon/src/misskey/entities/userDetail.ts @@ -1,34 +1,32 @@ /// -/// /// namespace MisskeyEntity { - export type UserDetail = { - id: string; - name: string; - username: string; - host: string | null; - avatarUrl: string; - avatarColor: string; - isAdmin: boolean; - isModerator: boolean; - isBot: boolean; - isCat: boolean; - emojis: Array; - createdAt: string; - bannerUrl: string; - bannerColor: string; - isLocked: boolean; - isSilenced: boolean; - isSuspended: boolean; - description: string; - followersCount: number; - followingCount: number; - notesCount: number; - avatarId: string; - bannerId: string; - pinnedNoteIds?: Array; - pinnedNotes?: Array; - fields: Array; - }; + export type UserDetail = { + id: string + name: string + username: string + host: string | null + avatarUrl: string + avatarColor: string + isAdmin: boolean + isModerator: boolean + isBot: boolean + isCat: boolean + emojis: Array | { [key: string]: string } + createdAt: string + bannerUrl: string + bannerColor: string + isLocked: boolean + isSilenced: boolean + isSuspended: boolean + description: string + followersCount: number + followingCount: number + notesCount: number + avatarId: string + bannerId: string + pinnedNoteIds?: Array + pinnedNotes?: Array + } } diff --git a/packages/megalodon/src/misskey/entities/userDetailMe.ts b/packages/megalodon/src/misskey/entities/userDetailMe.ts deleted file mode 100644 index 272e65ffa..000000000 --- a/packages/megalodon/src/misskey/entities/userDetailMe.ts +++ /dev/null @@ -1,36 +0,0 @@ -/// -/// -/// - -namespace MisskeyEntity { - export type UserDetailMe = { - id: string; - name: string; - username: string; - host: string | null; - avatarUrl: string; - avatarColor: string; - isAdmin: boolean; - isModerator: boolean; - isBot: boolean; - isCat: boolean; - emojis: Array; - createdAt: string; - bannerUrl: string; - bannerColor: string; - isLocked: boolean; - isSilenced: boolean; - isSuspended: boolean; - description: string; - followersCount: number; - followingCount: number; - notesCount: number; - avatarId: string; - bannerId: string; - pinnedNoteIds?: Array; - pinnedNotes?: Array; - fields: Array; - alwaysMarkNsfw: boolean; - lang: string | null; - }; -} diff --git a/packages/megalodon/src/misskey/entities/userkey.ts b/packages/megalodon/src/misskey/entities/userkey.ts index 921af6553..5b66e95b8 100644 --- a/packages/megalodon/src/misskey/entities/userkey.ts +++ b/packages/megalodon/src/misskey/entities/userkey.ts @@ -1,8 +1,8 @@ /// namespace MisskeyEntity { - export type UserKey = { - accessToken: string; - user: User; - }; + export type UserKey = { + accessToken: string + user: User + } } diff --git a/packages/megalodon/src/misskey/entity.ts b/packages/megalodon/src/misskey/entity.ts index 72a80f9d9..8498517be 100644 --- a/packages/megalodon/src/misskey/entity.ts +++ b/packages/megalodon/src/misskey/entity.ts @@ -1,10 +1,9 @@ -/// /// +/// /// /// /// /// -/// /// /// /// @@ -20,9 +19,8 @@ /// /// /// -/// /// /// /// -export default MisskeyEntity; +export default MisskeyEntity diff --git a/packages/megalodon/src/misskey/notification.ts b/packages/megalodon/src/misskey/notification.ts index eb7c2d23d..2909762c1 100644 --- a/packages/megalodon/src/misskey/notification.ts +++ b/packages/megalodon/src/misskey/notification.ts @@ -1,18 +1,16 @@ -import MisskeyEntity from "./entity"; +import MisskeyEntity from './entity' namespace MisskeyNotificationType { - export const Follow: MisskeyEntity.NotificationType = "follow"; - export const Mention: MisskeyEntity.NotificationType = "mention"; - export const Reply: MisskeyEntity.NotificationType = "reply"; - export const Renote: MisskeyEntity.NotificationType = "renote"; - export const Quote: MisskeyEntity.NotificationType = "quote"; - export const Reaction: MisskeyEntity.NotificationType = "favourite"; - export const PollEnded: MisskeyEntity.NotificationType = "pollEnded"; - export const ReceiveFollowRequest: MisskeyEntity.NotificationType = - "receiveFollowRequest"; - export const FollowRequestAccepted: MisskeyEntity.NotificationType = - "followRequestAccepted"; - export const GroupInvited: MisskeyEntity.NotificationType = "groupInvited"; + export const Follow: MisskeyEntity.NotificationType = 'follow' + export const Mention: MisskeyEntity.NotificationType = 'mention' + export const Reply: MisskeyEntity.NotificationType = 'reply' + export const Renote: MisskeyEntity.NotificationType = 'renote' + export const Quote: MisskeyEntity.NotificationType = 'quote' + export const Reaction: MisskeyEntity.NotificationType = 'reaction' + export const PollVote: MisskeyEntity.NotificationType = 'pollVote' + export const ReceiveFollowRequest: MisskeyEntity.NotificationType = 'receiveFollowRequest' + export const FollowRequestAccepted: MisskeyEntity.NotificationType = 'followRequestAccepted' + export const GroupInvited: MisskeyEntity.NotificationType = 'groupInvited' } -export default MisskeyNotificationType; +export default MisskeyNotificationType diff --git a/packages/megalodon/src/misskey/web_socket.ts b/packages/megalodon/src/misskey/web_socket.ts index 0cbfc2bfe..181fb1c90 100644 --- a/packages/megalodon/src/misskey/web_socket.ts +++ b/packages/megalodon/src/misskey/web_socket.ts @@ -1,365 +1,328 @@ -import WS from "ws"; -import dayjs, { Dayjs } from "dayjs"; -import { v4 as uuid } from "uuid"; -import { EventEmitter } from "events"; -import { WebSocketInterface } from "../megalodon"; -import proxyAgent, { ProxyConfig } from "../proxy_config"; -import MisskeyAPI from "./api_client"; +import WS from 'ws' +import dayjs, { Dayjs } from 'dayjs' +import { v4 as uuid } from 'uuid' +import { EventEmitter } from 'events' +import { WebSocketInterface } from '../megalodon' +import proxyAgent, { ProxyConfig } from '../proxy_config' +import MisskeyAPI from './api_client' +import { UnknownNotificationTypeError } from '../notification' /** * WebSocket * Misskey is not support http streaming. It supports websocket instead of streaming. * So this class connect to Misskey server with WebSocket. */ -export default class WebSocket - extends EventEmitter - implements WebSocketInterface -{ - public url: string; - public channel: - | "user" - | "localTimeline" - | "hybridTimeline" - | "globalTimeline" - | "conversation" - | "list"; - public parser: any; - public headers: { [key: string]: string }; - public proxyConfig: ProxyConfig | false = false; - public listId: string | null = null; - private _converter: MisskeyAPI.Converter; - private _accessToken: string; - private _reconnectInterval: number; - private _reconnectMaxAttempts: number; - private _reconnectCurrentAttempts: number; - private _connectionClosed: boolean; - private _client: WS | null = null; - private _channelID: string; - private _pongReceivedTimestamp: Dayjs; - private _heartbeatInterval = 60000; - private _pongWaiting = false; +export default class WebSocket extends EventEmitter implements WebSocketInterface { + public url: string + public channel: 'user' | 'localTimeline' | 'hybridTimeline' | 'globalTimeline' | 'conversation' | 'list' + public parser: Parser + public headers: { [key: string]: string } + public proxyConfig: ProxyConfig | false = false + public listId: string | null = null + private _accessToken: string + private _reconnectInterval: number + private _reconnectMaxAttempts: number + private _reconnectCurrentAttempts: number + private _connectionClosed: boolean + private _client: WS | null = null + private _channelID: string + private _pongReceivedTimestamp: Dayjs + private _heartbeatInterval: number = 60000 + private _pongWaiting: boolean = false - /** - * @param url Full url of websocket: e.g. wss://misskey.io/streaming - * @param channel Channel name is user, localTimeline, hybridTimeline, globalTimeline, conversation or list. - * @param accessToken The access token. - * @param listId This parameter is required when you specify list as channel. - */ - constructor( - url: string, - channel: - | "user" - | "localTimeline" - | "hybridTimeline" - | "globalTimeline" - | "conversation" - | "list", - accessToken: string, - listId: string | undefined, - userAgent: string, - proxyConfig: ProxyConfig | false = false, - converter: MisskeyAPI.Converter, - ) { - super(); - this.url = url; - this.parser = new Parser(); - this.channel = channel; - this.headers = { - "User-Agent": userAgent, - }; - if (listId === undefined) { - this.listId = null; - } else { - this.listId = listId; - } - this.proxyConfig = proxyConfig; - this._accessToken = accessToken; - this._reconnectInterval = 10000; - this._reconnectMaxAttempts = Infinity; - this._reconnectCurrentAttempts = 0; - this._connectionClosed = false; - this._channelID = uuid(); - this._pongReceivedTimestamp = dayjs(); - this._converter = converter; - } + /** + * @param url Full url of websocket: e.g. wss://misskey.io/streaming + * @param channel Channel name is user, localTimeline, hybridTimeline, globalTimeline, conversation or list. + * @param accessToken The access token. + * @param listId This parameter is required when you specify list as channel. + */ + constructor( + url: string, + channel: 'user' | 'localTimeline' | 'hybridTimeline' | 'globalTimeline' | 'conversation' | 'list', + accessToken: string, + listId: string | undefined, + userAgent: string, + proxyConfig: ProxyConfig | false = false + ) { + super() + this.url = url + this.parser = new Parser() + this.channel = channel + this.headers = { + 'User-Agent': userAgent + } + if (listId === undefined) { + this.listId = null + } else { + this.listId = listId + } + this.proxyConfig = proxyConfig + this._accessToken = accessToken + this._reconnectInterval = 10000 + this._reconnectMaxAttempts = Infinity + this._reconnectCurrentAttempts = 0 + this._connectionClosed = false + this._channelID = uuid() + this._pongReceivedTimestamp = dayjs() + } - /** - * Start websocket connection. - */ - public start() { - this._connectionClosed = false; - this._resetRetryParams(); - this._startWebSocketConnection(); - } + /** + * Start websocket connection. + */ + public start() { + this._connectionClosed = false + this._resetRetryParams() + this._startWebSocketConnection() + } - private baseUrlToHost(baseUrl: string): string { - return baseUrl.replace("https://", ""); - } + /** + * Reset connection and start new websocket connection. + */ + private _startWebSocketConnection() { + this._resetConnection() + this._setupParser() + this._client = this._connect() + this._bindSocket(this._client) + } - /** - * Reset connection and start new websocket connection. - */ - private _startWebSocketConnection() { - this._resetConnection(); - this._setupParser(); - this._client = this._connect(); - this._bindSocket(this._client); - } + /** + * Stop current connection. + */ + public stop() { + this._connectionClosed = true + this._resetConnection() + this._resetRetryParams() + } - /** - * Stop current connection. - */ - public stop() { - this._connectionClosed = true; - this._resetConnection(); - this._resetRetryParams(); - } + /** + * Clean up current connection, and listeners. + */ + private _resetConnection() { + if (this._client) { + this._client.close(1000) + this._client.removeAllListeners() + this._client = null + } - /** - * Clean up current connection, and listeners. - */ - private _resetConnection() { - if (this._client) { - this._client.close(1000); - this._client.removeAllListeners(); - this._client = null; - } + if (this.parser) { + this.parser.removeAllListeners() + } + } - if (this.parser) { - this.parser.removeAllListeners(); - } - } + /** + * Resets the parameters used in reconnect. + */ + private _resetRetryParams() { + this._reconnectCurrentAttempts = 0 + } - /** - * Resets the parameters used in reconnect. - */ - private _resetRetryParams() { - this._reconnectCurrentAttempts = 0; - } + /** + * Connect to the endpoint. + */ + private _connect(): WS { + let options: WS.ClientOptions = { + headers: this.headers + } + if (this.proxyConfig) { + options = Object.assign(options, { + agent: proxyAgent(this.proxyConfig) + }) + } + const cli: WS = new WS(`${this.url}?i=${this._accessToken}`, options) + return cli + } - /** - * Connect to the endpoint. - */ - private _connect(): WS { - let options: WS.ClientOptions = { - headers: this.headers, - }; - if (this.proxyConfig) { - options = Object.assign(options, { - agent: proxyAgent(this.proxyConfig), - }); - } - const cli: WS = new WS(`${this.url}?i=${this._accessToken}`, options); - return cli; - } + /** + * Connect specified channels in websocket. + */ + private _channel() { + if (!this._client) { + return + } + switch (this.channel) { + case 'conversation': + this._client.send( + JSON.stringify({ + type: 'connect', + body: { + channel: 'main', + id: this._channelID + } + }) + ) + break + case 'user': + this._client.send( + JSON.stringify({ + type: 'connect', + body: { + channel: 'main', + id: this._channelID + } + }) + ) + this._client.send( + JSON.stringify({ + type: 'connect', + body: { + channel: 'homeTimeline', + id: this._channelID + } + }) + ) + break + case 'list': + this._client.send( + JSON.stringify({ + type: 'connect', + body: { + channel: 'userList', + id: this._channelID, + params: { + listId: this.listId + } + } + }) + ) + break + default: + this._client.send( + JSON.stringify({ + type: 'connect', + body: { + channel: this.channel, + id: this._channelID + } + }) + ) + break + } + } - /** - * Connect specified channels in websocket. - */ - private _channel() { - if (!this._client) { - return; - } - switch (this.channel) { - case "conversation": - this._client.send( - JSON.stringify({ - type: "connect", - body: { - channel: "main", - id: this._channelID, - }, - }), - ); - break; - case "user": - this._client.send( - JSON.stringify({ - type: "connect", - body: { - channel: "main", - id: this._channelID, - }, - }), - ); - this._client.send( - JSON.stringify({ - type: "connect", - body: { - channel: "homeTimeline", - id: this._channelID, - }, - }), - ); - break; - case "list": - this._client.send( - JSON.stringify({ - type: "connect", - body: { - channel: "userList", - id: this._channelID, - params: { - listId: this.listId, - }, - }, - }), - ); - break; - default: - this._client.send( - JSON.stringify({ - type: "connect", - body: { - channel: this.channel, - id: this._channelID, - }, - }), - ); - break; - } - } + /** + * Reconnects to the same endpoint. + */ - /** - * Reconnects to the same endpoint. - */ + private _reconnect() { + setTimeout(() => { + // Skip reconnect when client is connecting. + // https://github.com/websockets/ws/blob/7.2.1/lib/websocket.js#L365 + if (this._client && this._client.readyState === WS.CONNECTING) { + return + } - private _reconnect() { - setTimeout(() => { - // Skip reconnect when client is connecting. - // https://github.com/websockets/ws/blob/7.2.1/lib/websocket.js#L365 - if (this._client && this._client.readyState === WS.CONNECTING) { - return; - } + if (this._reconnectCurrentAttempts < this._reconnectMaxAttempts) { + this._reconnectCurrentAttempts++ + this._clearBinding() + if (this._client) { + // In reconnect, we want to close the connection immediately, + // because recoonect is necessary when some problems occur. + this._client.terminate() + } + // Call connect methods + console.log('Reconnecting') + this._client = this._connect() + this._bindSocket(this._client) + } + }, this._reconnectInterval) + } - if (this._reconnectCurrentAttempts < this._reconnectMaxAttempts) { - this._reconnectCurrentAttempts++; - this._clearBinding(); - if (this._client) { - // In reconnect, we want to close the connection immediately, - // because recoonect is necessary when some problems occur. - this._client.terminate(); - } - // Call connect methods - console.log("Reconnecting"); - this._client = this._connect(); - this._bindSocket(this._client); - } - }, this._reconnectInterval); - } + /** + * Clear binding event for websocket client. + */ + private _clearBinding() { + if (this._client) { + this._client.removeAllListeners('close') + this._client.removeAllListeners('pong') + this._client.removeAllListeners('open') + this._client.removeAllListeners('message') + this._client.removeAllListeners('error') + } + } - /** - * Clear binding event for websocket client. - */ - private _clearBinding() { - if (this._client) { - this._client.removeAllListeners("close"); - this._client.removeAllListeners("pong"); - this._client.removeAllListeners("open"); - this._client.removeAllListeners("message"); - this._client.removeAllListeners("error"); - } - } + /** + * Bind event for web socket client. + * @param client A WebSocket instance. + */ + private _bindSocket(client: WS) { + client.on('close', (code: number, _reason: Buffer) => { + if (code === 1000) { + this.emit('close', {}) + } else { + console.log(`Closed connection with ${code}`) + if (!this._connectionClosed) { + this._reconnect() + } + } + }) + client.on('pong', () => { + this._pongWaiting = false + this.emit('pong', {}) + this._pongReceivedTimestamp = dayjs() + // It is required to anonymous function since get this scope in checkAlive. + setTimeout(() => this._checkAlive(this._pongReceivedTimestamp), this._heartbeatInterval) + }) + client.on('open', () => { + this.emit('connect', {}) + this._channel() + // Call first ping event. + setTimeout(() => { + client.ping('') + }, 10000) + }) + client.on('message', (data: WS.Data, isBinary: boolean) => { + this.parser.parse(data, isBinary, this._channelID) + }) + client.on('error', (err: Error) => { + this.emit('error', err) + }) + } - /** - * Bind event for web socket client. - * @param client A WebSocket instance. - */ - private _bindSocket(client: WS) { - client.on("close", (code: number, _reason: Buffer) => { - if (code === 1000) { - this.emit("close", {}); - } else { - console.log(`Closed connection with ${code}`); - if (!this._connectionClosed) { - this._reconnect(); - } - } - }); - client.on("pong", () => { - this._pongWaiting = false; - this.emit("pong", {}); - this._pongReceivedTimestamp = dayjs(); - // It is required to anonymous function since get this scope in checkAlive. - setTimeout( - () => this._checkAlive(this._pongReceivedTimestamp), - this._heartbeatInterval, - ); - }); - client.on("open", () => { - this.emit("connect", {}); - this._channel(); - // Call first ping event. - setTimeout(() => { - client.ping(""); - }, 10000); - }); - client.on("message", (data: WS.Data, isBinary: boolean) => { - this.parser.parse(data, isBinary, this._channelID); - }); - client.on("error", (err: Error) => { - this.emit("error", err); - }); - } + /** + * Set up parser when receive message. + */ + private _setupParser() { + this.parser.on('update', (note: MisskeyAPI.Entity.Note) => { + this.emit('update', MisskeyAPI.Converter.note(note)) + }) + this.parser.on('notification', (notification: MisskeyAPI.Entity.Notification) => { + const n = MisskeyAPI.Converter.notification(notification) + if (n instanceof UnknownNotificationTypeError) { + console.warn(`Unknown notification event has received: ${notification}`) + } else { + this.emit('notification', n) + } + }) + this.parser.on('conversation', (note: MisskeyAPI.Entity.Note) => { + this.emit('conversation', MisskeyAPI.Converter.noteToConversation(note)) + }) + this.parser.on('error', (err: Error) => { + this.emit('parser-error', err) + }) + } - /** - * Set up parser when receive message. - */ - private _setupParser() { - this.parser.on("update", (note: MisskeyAPI.Entity.Note) => { - this.emit( - "update", - this._converter.note(note, this.baseUrlToHost(this.url)), - ); - }); - this.parser.on( - "notification", - (notification: MisskeyAPI.Entity.Notification) => { - this.emit( - "notification", - this._converter.notification( - notification, - this.baseUrlToHost(this.url), - ), - ); - }, - ); - this.parser.on("conversation", (note: MisskeyAPI.Entity.Note) => { - this.emit( - "conversation", - this._converter.noteToConversation(note, this.baseUrlToHost(this.url)), - ); - }); - this.parser.on("error", (err: Error) => { - this.emit("parser-error", err); - }); - } - - /** - * Call ping and wait to pong. - */ - private _checkAlive(timestamp: Dayjs) { - const now: Dayjs = dayjs(); - // Block multiple calling, if multiple pong event occur. - // It the duration is less than interval, through ping. - if ( - now.diff(timestamp) > this._heartbeatInterval - 1000 && - !this._connectionClosed - ) { - // Skip ping when client is connecting. - // https://github.com/websockets/ws/blob/7.2.1/lib/websocket.js#L289 - if (this._client && this._client.readyState !== WS.CONNECTING) { - this._pongWaiting = true; - this._client.ping(""); - setTimeout(() => { - if (this._pongWaiting) { - this._pongWaiting = false; - this._reconnect(); - } - }, 10000); - } - } - } + /** + * Call ping and wait to pong. + */ + private _checkAlive(timestamp: Dayjs) { + const now: Dayjs = dayjs() + // Block multiple calling, if multiple pong event occur. + // It the duration is less than interval, through ping. + if (now.diff(timestamp) > this._heartbeatInterval - 1000 && !this._connectionClosed) { + // Skip ping when client is connecting. + // https://github.com/websockets/ws/blob/7.2.1/lib/websocket.js#L289 + if (this._client && this._client.readyState !== WS.CONNECTING) { + this._pongWaiting = true + this._client.ping('') + setTimeout(() => { + if (this._pongWaiting) { + this._pongWaiting = false + this._reconnect() + } + }, 10000) + } + } + } } /** @@ -367,92 +330,84 @@ export default class WebSocket * This class provides parser for websocket message. */ export class Parser extends EventEmitter { - /** - * @param message Message body of websocket. - * @param channelID Parse only messages which has same channelID. - */ - public parse(data: WS.Data, isBinary: boolean, channelID: string) { - const message = isBinary ? data : data.toString(); - if (typeof message !== "string") { - this.emit("heartbeat", {}); - return; - } + /** + * @param message Message body of websocket. + * @param channelID Parse only messages which has same channelID. + */ + public parse(data: WS.Data, isBinary: boolean, channelID: string) { + const message = isBinary ? data : data.toString() + if (typeof message !== 'string') { + this.emit('heartbeat', {}) + return + } - if (message === "") { - this.emit("heartbeat", {}); - return; - } + if (message === '') { + this.emit('heartbeat', {}) + return + } - let obj: { - type: string; - body: { - id: string; - type: string; - body: any; - }; - }; - let body: { - id: string; - type: string; - body: any; - }; + let obj: { + type: string + body: { + id: string + type: string + body: any + } + } + let body: { + id: string + type: string + body: any + } - try { - obj = JSON.parse(message); - if (obj.type !== "channel") { - return; - } - if (!obj.body) { - return; - } - body = obj.body; - if (body.id !== channelID) { - return; - } - } catch (err) { - this.emit( - "error", - new Error( - `Error parsing websocket reply: ${message}, error message: ${err}`, - ), - ); - return; - } + try { + obj = JSON.parse(message) + if (obj.type !== 'channel') { + return + } + if (!obj.body) { + return + } + body = obj.body + if (body.id !== channelID) { + return + } + } catch (err) { + this.emit('error', new Error(`Error parsing websocket reply: ${message}, error message: ${err}`)) + return + } - switch (body.type) { - case "note": - this.emit("update", body.body as MisskeyAPI.Entity.Note); - break; - case "notification": - this.emit("notification", body.body as MisskeyAPI.Entity.Notification); - break; - case "mention": { - const note = body.body as MisskeyAPI.Entity.Note; - if (note.visibility === "specified") { - this.emit("conversation", note); - } - break; - } - // When renote and followed event, the same notification will be received. - case "renote": - case "followed": - case "follow": - case "unfollow": - case "receiveFollowRequest": - case "meUpdated": - case "readAllNotifications": - case "readAllUnreadSpecifiedNotes": - case "readAllAntennas": - case "readAllUnreadMentions": - case "unreadNotification": - // Ignore these events - break; - default: - this.emit( - "error", - new Error(`Unknown event has received: ${JSON.stringify(body)}`), - ); - break; - } - } + switch (body.type) { + case 'note': + this.emit('update', body.body as MisskeyAPI.Entity.Note) + break + case 'notification': + this.emit('notification', body.body as MisskeyAPI.Entity.Notification) + break + case 'mention': { + const note = body.body as MisskeyAPI.Entity.Note + if (note.visibility === 'specified') { + this.emit('conversation', note) + } + break + } + // When renote and followed event, the same notification will be received. + case 'renote': + case 'followed': + case 'follow': + case 'unfollow': + case 'receiveFollowRequest': + case 'meUpdated': + case 'readAllNotifications': + case 'readAllUnreadSpecifiedNotes': + case 'readAllAntennas': + case 'readAllUnreadMentions': + case 'unreadNotification': + // Ignore these events + break + default: + this.emit('error', new Error(`Unknown event has received: ${JSON.stringify(body)}`)) + break + } + } } diff --git a/packages/megalodon/src/notification.ts b/packages/megalodon/src/notification.ts index 84cd23e40..7c08c5d47 100644 --- a/packages/megalodon/src/notification.ts +++ b/packages/megalodon/src/notification.ts @@ -1,14 +1,26 @@ -import Entity from "./entity"; +import Entity from './entity' namespace NotificationType { - export const Follow: Entity.NotificationType = "follow"; - export const Favourite: Entity.NotificationType = "favourite"; - export const Reblog: Entity.NotificationType = "reblog"; - export const Mention: Entity.NotificationType = "mention"; - export const Reaction: Entity.NotificationType = "reaction"; - export const FollowRequest: Entity.NotificationType = "follow_request"; - export const Status: Entity.NotificationType = "status"; - export const Poll: Entity.NotificationType = "poll"; + export const Follow: Entity.NotificationType = 'follow' + export const Favourite: Entity.NotificationType = 'favourite' + export const Reblog: Entity.NotificationType = 'reblog' + export const Mention: Entity.NotificationType = 'mention' + export const EmojiReaction: Entity.NotificationType = 'emoji_reaction' + export const FollowRequest: Entity.NotificationType = 'follow_request' + export const Status: Entity.NotificationType = 'status' + export const PollVote: Entity.NotificationType = 'poll_vote' + export const PollExpired: Entity.NotificationType = 'poll_expired' + export const Update: Entity.NotificationType = 'update' + export const Move: Entity.NotificationType = 'move' + export const AdminSignup: Entity.NotificationType = 'admin.sign_up' + export const AdminReport: Entity.NotificationType = 'admin.report' } -export default NotificationType; +export class UnknownNotificationTypeError extends Error { + constructor() { + super() + Object.setPrototypeOf(this, UnknownNotificationTypeError.prototype) + } +} + +export default NotificationType diff --git a/packages/megalodon/src/oauth.ts b/packages/megalodon/src/oauth.ts index f0df721f0..3c3ceb9de 100644 --- a/packages/megalodon/src/oauth.ts +++ b/packages/megalodon/src/oauth.ts @@ -3,121 +3,107 @@ * Response data when oauth request. **/ namespace OAuth { - export type AppDataFromServer = { - id: string; - name: string; - website: string | null; - redirect_uri: string; - client_id: string; - client_secret: string; - }; + export type AppDataFromServer = { + id: string + name: string + website: string | null + redirect_uri: string + client_id: string + client_secret: string + } - export type TokenDataFromServer = { - access_token: string; - token_type: string; - scope: string; - created_at: number; - expires_in: number | null; - refresh_token: string | null; - }; + export type TokenDataFromServer = { + access_token: string + token_type: string + scope: string + created_at: number + expires_in: number | null + refresh_token: string | null + } - export class AppData { - public url: string | null; - public session_token: string | null; - constructor( - public id: string, - public name: string, - public website: string | null, - public redirect_uri: string, - public client_id: string, - public client_secret: string, - ) { - this.url = null; - this.session_token = null; - } + export class AppData { + public url: string | null + public session_token: string | null + constructor( + public id: string, + public name: string, + public website: string | null, + public redirect_uri: string, + public client_id: string, + public client_secret: string + ) { + this.url = null + this.session_token = null + } - /** - * Serialize raw application data from server - * @param raw from server - */ - static from(raw: AppDataFromServer) { - return new this( - raw.id, - raw.name, - raw.website, - raw.redirect_uri, - raw.client_id, - raw.client_secret, - ); - } + /** + * Serialize raw application data from server + * @param raw from server + */ + static from(raw: AppDataFromServer) { + return new this(raw.id, raw.name, raw.website, raw.redirect_uri, raw.client_id, raw.client_secret) + } - get redirectUri() { - return this.redirect_uri; - } - get clientId() { - return this.client_id; - } - get clientSecret() { - return this.client_secret; - } - } + get redirectUri() { + return this.redirect_uri + } + get clientId() { + return this.client_id + } + get clientSecret() { + return this.client_secret + } + } - export class TokenData { - public _scope: string; - constructor( - public access_token: string, - public token_type: string, - scope: string, - public created_at: number, - public expires_in: number | null = null, - public refresh_token: string | null = null, - ) { - this._scope = scope; - } + export class TokenData { + public _scope: string + constructor( + public access_token: string, + public token_type: string, + scope: string, + public created_at: number, + public expires_in: number | null = null, + public refresh_token: string | null = null + ) { + this._scope = scope + } - /** - * Serialize raw token data from server - * @param raw from server - */ - static from(raw: TokenDataFromServer) { - return new this( - raw.access_token, - raw.token_type, - raw.scope, - raw.created_at, - raw.expires_in, - raw.refresh_token, - ); - } + /** + * Serialize raw token data from server + * @param raw from server + */ + static from(raw: TokenDataFromServer) { + return new this(raw.access_token, raw.token_type, raw.scope, raw.created_at, raw.expires_in, raw.refresh_token) + } - /** - * OAuth Aceess Token - */ - get accessToken() { - return this.access_token; - } - get tokenType() { - return this.token_type; - } - get scope() { - return this._scope; - } - /** - * Application ID - */ - get createdAt() { - return this.created_at; - } - get expiresIn() { - return this.expires_in; - } - /** - * OAuth Refresh Token - */ - get refreshToken() { - return this.refresh_token; - } - } + /** + * OAuth Aceess Token + */ + get accessToken() { + return this.access_token + } + get tokenType() { + return this.token_type + } + get scope() { + return this._scope + } + /** + * Application ID + */ + get createdAt() { + return this.created_at + } + get expiresIn() { + return this.expires_in + } + /** + * OAuth Refresh Token + */ + get refreshToken() { + return this.refresh_token + } + } } -export default OAuth; +export default OAuth diff --git a/packages/megalodon/src/parser.ts b/packages/megalodon/src/parser.ts index 2ddf2ac2e..67abff797 100644 --- a/packages/megalodon/src/parser.ts +++ b/packages/megalodon/src/parser.ts @@ -1,94 +1,86 @@ -import { EventEmitter } from "events"; -import Entity from "./entity"; +import { EventEmitter } from 'events' +import Entity from './entity' /** * Parser * Parse response data in streaming. **/ export class Parser extends EventEmitter { - private message: string; + private message: string - constructor() { - super(); - this.message = ""; - } + constructor() { + super() + this.message = '' + } - public parse(chunk: string) { - // skip heartbeats - if (chunk === ":thump\n") { - this.emit("heartbeat", {}); - return; - } + public parse(chunk: string) { + // skip heartbeats + if (chunk === ':thump\n') { + this.emit('heartbeat', {}) + return + } - this.message += chunk; - chunk = this.message; + this.message += chunk + chunk = this.message - const size: number = chunk.length; - let start = 0; - let offset = 0; - let curr: string | undefined; - let next: string | undefined; + const size: number = chunk.length + let start: number = 0 + let offset: number = 0 + let curr: string | undefined + let next: string | undefined - while (offset < size) { - curr = chunk[offset]; - next = chunk[offset + 1]; + while (offset < size) { + curr = chunk[offset] + next = chunk[offset + 1] - if (curr === "\n" && next === "\n") { - const piece: string = chunk.slice(start, offset); + if (curr === '\n' && next === '\n') { + const piece: string = chunk.slice(start, offset) - offset += 2; - start = offset; + offset += 2 + start = offset - if (!piece.length) continue; // empty object + if (!piece.length) continue // empty object - const root: Array = piece.split("\n"); + const root: Array = piece.split('\n') - // should never happen, as long as mastodon doesn't change API messages - if (root.length !== 2) continue; + // should never happen, as long as mastodon doesn't change API messages + if (root.length !== 2) continue - // remove event and data markers - const event: string = root[0].substr(7); - const data: string = root[1].substr(6); + // remove event and data markers + const event: string = root[0].substr(7) + const data: string = root[1].substr(6) - let jsonObj = {}; - try { - jsonObj = JSON.parse(data); - } catch (err) { - // delete event does not have json object - if (event !== "delete") { - this.emit( - "error", - new Error( - `Error parsing API reply: '${piece}', error message: '${err}'`, - ), - ); - continue; - } - } - switch (event) { - case "update": - this.emit("update", jsonObj as Entity.Status); - break; - case "notification": - this.emit("notification", jsonObj as Entity.Notification); - break; - case "conversation": - this.emit("conversation", jsonObj as Entity.Conversation); - break; - case "delete": - // When delete, data is an ID of the deleted status - this.emit("delete", data); - break; - default: - this.emit( - "error", - new Error(`Unknown event has received: ${event}`), - ); - continue; - } - } - offset++; - } - this.message = chunk.slice(start, size); - } + let jsonObj = {} + try { + jsonObj = JSON.parse(data) + } catch (err) { + // delete event does not have json object + if (event !== 'delete') { + this.emit('error', new Error(`Error parsing API reply: '${piece}', error message: '${err}'`)) + continue + } + } + switch (event) { + case 'update': + this.emit('update', jsonObj as Entity.Status) + break + case 'notification': + this.emit('notification', jsonObj as Entity.Notification) + break + case 'conversation': + this.emit('conversation', jsonObj as Entity.Conversation) + break + case 'delete': + // When delete, data is an ID of the deleted status + this.emit('delete', data) + break + default: + this.emit('error', new Error(`Unknown event has received: ${event}`)) + continue + } + } + offset++ + } + this.message = chunk.slice(start, size) + } } diff --git a/packages/megalodon/src/pleroma.ts b/packages/megalodon/src/pleroma.ts new file mode 100644 index 000000000..265c7d3c0 --- /dev/null +++ b/packages/megalodon/src/pleroma.ts @@ -0,0 +1,3217 @@ +import { OAuth2 } from 'oauth' +import FormData from 'form-data' + +import PleromaAPI from './pleroma/api_client' +import WebSocket from './pleroma/web_socket' +import { MegalodonInterface, NoImplementedError, ArgumentError } from './megalodon' +import Response from './response' +import Entity from './entity' +import { NO_REDIRECT, DEFAULT_SCOPE, DEFAULT_UA } from './default' +import { ProxyConfig } from './proxy_config' +import OAuth from './oauth' +import { UnknownNotificationTypeError } from './notification' + +export default class Pleroma implements MegalodonInterface { + public client: PleromaAPI.Interface + public baseUrl: string + + /** + * @param baseUrl hostname or base URL + * @param accessToken access token from OAuth2 authorization + * @param userAgent UserAgent is specified in header on request. + * @param proxyConfig Proxy setting, or set false if don't use proxy. + */ + constructor( + baseUrl: string, + accessToken: string | null = null, + userAgent: string | null = DEFAULT_UA, + proxyConfig: ProxyConfig | false = false + ) { + let token: string = '' + if (accessToken) { + token = accessToken + } + let agent: string = DEFAULT_UA + if (userAgent) { + agent = userAgent + } + this.client = new PleromaAPI.Client(baseUrl, token, agent, proxyConfig) + this.baseUrl = baseUrl + } + + public cancel(): void { + return this.client.cancel() + } + + /** + * First, call createApp to get client_id and client_secret. + * Next, call generateAuthUrl to get authorization url. + * @param client_name Form Data, which is sent to /api/v1/apps + * @param options Form Data, which is sent to /api/v1/apps. and properties should be **snake_case** + */ + public async registerApp( + client_name: string, + options: Partial<{ scopes: Array; redirect_uris: string; website: string }> + ): Promise { + const scopes = options.scopes || DEFAULT_SCOPE + return this.createApp(client_name, options).then(async appData => { + return this.generateAuthUrl(appData.client_id, appData.client_secret, { + scope: scopes, + redirect_uri: appData.redirect_uri + }).then(url => { + appData.url = url + return appData + }) + }) + } + + /** + * Call /api/v1/apps + * + * Create an application. + * @param client_name your application's name + * @param options Form Data + */ + public async createApp( + client_name: string, + options: Partial<{ scopes: Array; redirect_uris: string; website: string }> + ): Promise { + const scopes = options.scopes || DEFAULT_SCOPE + const redirect_uris = options.redirect_uris || NO_REDIRECT + + const params: { + client_name: string + redirect_uris: string + scopes: string + website?: string + } = { + client_name: client_name, + redirect_uris: redirect_uris, + scopes: scopes.join(' ') + } + if (options.website) params.website = options.website + + return this.client + .post('/api/v1/apps', params) + .then((res: Response) => OAuth.AppData.from(res.data)) + } + + /** + * Generate authorization url using OAuth2. + * + * @param clientId your OAuth app's client ID + * @param clientSecret your OAuth app's client Secret + * @param options as property, redirect_uri and scope are available, and must be the same as when you register your app + */ + public generateAuthUrl( + clientId: string, + clientSecret: string, + options: Partial<{ scope: Array; redirect_uri: string }> + ): Promise { + const scope = options.scope || DEFAULT_SCOPE + const redirect_uri = options.redirect_uri || NO_REDIRECT + return new Promise(resolve => { + const oauth = new OAuth2(clientId, clientSecret, this.baseUrl, undefined, '/oauth/token') + const url = oauth.getAuthorizeUrl({ + redirect_uri: redirect_uri, + response_type: 'code', + client_id: clientId, + scope: scope.join(' ') + }) + resolve(url) + }) + } + + // ====================================== + // apps + // ====================================== + /** + * GET /api/v1/apps/verify_credentials + * + * @return An Application + */ + public verifyAppCredentials(): Promise> { + return this.client.get('/api/v1/apps/verify_credentials') + } + + // ====================================== + // apps/oauth + // ====================================== + /** + * POST /oauth/token + * + * Fetch OAuth access token. + * Get an access token based client_id and client_secret and authorization code. + * @param client_id will be generated by #createApp or #registerApp + * @param client_secret will be generated by #createApp or #registerApp + * @param code will be generated by the link of #generateAuthUrl or #registerApp + * @param redirect_uri must be the same uri as the time when you register your OAuth application + */ + public async fetchAccessToken( + client_id: string | null, + client_secret: string, + code: string, + redirect_uri: string = NO_REDIRECT + ): Promise { + if (!client_id) { + throw new Error('client_id is required') + } + return this.client + .post('/oauth/token', { + client_id, + client_secret, + code, + redirect_uri, + grant_type: 'authorization_code' + }) + .then((res: Response) => OAuth.TokenData.from(res.data)) + } + + /** + * POST /oauth/token + * + * Refresh OAuth access token. + * Send refresh token and get new access token. + * @param client_id will be generated by #createApp or #registerApp + * @param client_secret will be generated by #createApp or #registerApp + * @param refresh_token will be get #fetchAccessToken + */ + public async refreshToken(client_id: string, client_secret: string, refresh_token: string): Promise { + return this.client + .post('/oauth/token', { + client_id, + client_secret, + refresh_token, + grant_type: 'refresh_token' + }) + .then((res: Response) => OAuth.TokenData.from(res.data)) + } + + /** + * POST /oauth/revoke + * + * Revoke an OAuth token. + * @param client_id will be generated by #createApp or #registerApp + * @param client_secret will be generated by #createApp or #registerApp + * @param token will be get #fetchAccessToken + */ + public async revokeToken(client_id: string, client_secret: string, token: string): Promise> { + return this.client.post<{}>('/oauth/revoke', { + client_id, + client_secret, + token + }) + } + + // ====================================== + // accounts + // ====================================== + /** + * POST /api/v1/accounts + * + * @param username Username for the account. + * @param email Email for the account. + * @param password Password for the account. + * @param agreement Whether the user agrees to the local rules, terms, and policies. + * @param locale The language of the confirmation email that will be sent + * @param reason Text that will be reviewed by moderators if registrations require manual approval. + * @return An account token. + */ + public async registerAccount( + username: string, + email: string, + password: string, + agreement: boolean, + locale: string, + reason?: string | null + ): Promise> { + let params = { + username: username, + email: email, + password: password, + agreement: agreement, + locale: locale + } + if (reason) { + params = Object.assign(params, { + reason: reason + }) + } + return this.client.post('/api/v1/accounts', params).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.token(res.data) + }) + }) + } + + /** + * GET /api/v1/accounts/verify_credentials + * + * @return Account. + */ + public async verifyAccountCredentials(): Promise> { + return this.client.get('/api/v1/accounts/verify_credentials').then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.account(res.data) + }) + }) + } + + /** + * PATCH /api/v1/accounts/update_credentials + * + * @return An account. + */ + public async updateCredentials(options?: { + discoverable?: boolean + bot?: boolean + display_name?: string + note?: string + avatar?: string + header?: string + locked?: boolean + source?: { + privacy?: string + sensitive?: boolean + language?: string + } + fields_attributes?: Array<{ name: string; value: string }> + }): Promise> { + let params = {} + if (options) { + if (options.discoverable !== undefined) { + params = Object.assign(params, { + discoverable: options.discoverable + }) + } + if (options.bot !== undefined) { + params = Object.assign(params, { + bot: options.bot + }) + } + if (options.display_name) { + params = Object.assign(params, { + display_name: options.display_name + }) + } + if (options.note) { + params = Object.assign(params, { + note: options.note + }) + } + if (options.avatar) { + params = Object.assign(params, { + avatar: options.avatar + }) + } + if (options.header) { + params = Object.assign(params, { + header: options.header + }) + } + if (options.locked !== undefined) { + params = Object.assign(params, { + locked: options.locked + }) + } + if (options.source) { + params = Object.assign(params, { + source: options.source + }) + } + if (options.fields_attributes) { + params = Object.assign(params, { + fields_attributes: options.fields_attributes + }) + } + } + return this.client.patch('/api/v1/accounts/update_credentials', params).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.account(res.data) + }) + }) + } + + /** + * GET /api/v1/accounts/:id + * + * @param id The account ID. + * @return An account. + */ + public async getAccount(id: string): Promise> { + return this.client.get(`/api/v1/accounts/${id}`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.account(res.data) + }) + }) + } + + /** + * GET /api/v1/accounts/:id/statuses + * + * @param id The account ID. + + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID but starting with most recent. + * @param options.min_id Return results newer than ID. + * @param options.pinned Return statuses which include pinned statuses. + * @param options.exclude_replies Return statuses which exclude replies. + * @param options.exclude_reblogs Return statuses which exclude reblogs. + * @param options.only_media Show only statuses with media attached? Defaults to false. + * @return Account's statuses. + */ + public async getAccountStatuses( + id: string, + options?: { + limit?: number + max_id?: string + since_id?: string + pinned?: boolean + exclude_replies?: boolean + exclude_reblogs?: boolean + only_media?: boolean + } + ): Promise>> { + let params = {} + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.pinned) { + params = Object.assign(params, { + pinned: options.pinned + }) + } + if (options.exclude_replies) { + params = Object.assign(params, { + exclude_replies: options.exclude_replies + }) + } + if (options.exclude_reblogs) { + params = Object.assign(params, { + exclude_reblogs: options.exclude_reblogs + }) + } + if (options.only_media) { + params = Object.assign(params, { + only_media: options.only_media + }) + } + } + return this.client.get>(`/api/v1/accounts/${id}/statuses`, params).then(res => { + return Object.assign(res, { + data: res.data.map(s => PleromaAPI.Converter.status(s)) + }) + }) + } + + /** + * GET /api/v1/pleroma/accounts/:id/favourites + * + * @param id Target account ID. + * @param options.limit Max number of results to return. + * @param options.max_id Return results order than ID. + * @param options.since_id Return results newer than ID. + * @return Array of statuses. + */ + public async getAccountFavourites( + id: string, + options?: { + limit?: number + max_id?: string + since_id?: string + } + ): Promise>> { + let params = {} + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + } + return this.client.get>(`/api/v1/pleroma/accounts/${id}/favourites`, params).then(res => { + return Object.assign(res, { + data: res.data.map(s => PleromaAPI.Converter.status(s)) + }) + }) + } + + /** + * POST /api/v1/pleroma/accounts/:id/subscribe + * + * @param id Target account ID. + * @return Relationship. + */ + public async subscribeAccount(id: string): Promise> { + return this.client.post(`/api/v1/pleroma/accounts/${id}/subscribe`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * POST /api/v1/pleroma/accounts/:id/unsubscribe + * + * @param id Target account ID. + * @return Relationship. + */ + public async unsubscribeAccount(id: string): Promise> { + return this.client.post(`/api/v1/pleroma/accounts/${id}/unsubscribe`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * GET /api/v1/accounts/:id/followers + * + * @param id The account ID. + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @return The array of accounts. + */ + public async getAccountFollowers( + id: string, + options?: { + limit?: number + max_id?: string + since_id?: string + } + ): Promise>> { + let params = {} + if (options) { + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>(`/api/v1/accounts/${id}/followers`, params).then(res => { + return Object.assign(res, { + data: res.data.map(a => PleromaAPI.Converter.account(a)) + }) + }) + } + + /** + * GET /api/v1/accounts/:id/following + * + * @param id The account ID. + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @return The array of accounts. + */ + public async getAccountFollowing( + id: string, + options?: { + limit?: number + max_id?: string + since_id?: string + } + ): Promise>> { + let params = {} + if (options) { + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>(`/api/v1/accounts/${id}/following`, params).then(res => { + return Object.assign(res, { + data: res.data.map(a => PleromaAPI.Converter.account(a)) + }) + }) + } + + /** + * GET /api/v1/accounts/:id/lists + * + * @param id The account ID. + * @return The array of lists. + */ + public async getAccountLists(id: string): Promise>> { + return this.client.get>(`/api/v1/accounts/${id}/lists`).then(res => { + return Object.assign(res, { + data: res.data.map(l => PleromaAPI.Converter.list(l)) + }) + }) + } + + /** + * GET /api/v1/accounts/:id/identity_proofs + * + * @param id The account ID. + * @return Array of IdentityProof + */ + public async getIdentityProof(id: string): Promise>> { + return this.client.get>(`/api/v1/accounts/${id}/identity_proofs`).then(res => { + return Object.assign(res, { + data: res.data.map(i => PleromaAPI.Converter.identity_proof(i)) + }) + }) + } + + /** + * POST /api/v1/accounts/:id/follow + * + * @param id The account ID. + * @param reblog Receive this account's reblogs in home timeline. + * @return Relationship + */ + public async followAccount(id: string, options?: { reblog?: boolean }): Promise> { + let params = {} + if (options) { + if (options.reblog !== undefined) { + params = Object.assign(params, { + reblog: options.reblog + }) + } + } + return this.client.post(`/api/v1/accounts/${id}/follow`, params).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * POST /api/v1/accounts/:id/unfollow + * + * @param id The account ID. + * @return Relationship + */ + public async unfollowAccount(id: string): Promise> { + return this.client.post(`/api/v1/accounts/${id}/unfollow`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * POST /api/v1/accounts/:id/block + * + * @param id The account ID. + * @return Relationship + */ + public async blockAccount(id: string): Promise> { + return this.client.post(`/api/v1/accounts/${id}/block`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * POST /api/v1/accounts/:id/unblock + * + * @param id The account ID. + * @return RElationship + */ + public async unblockAccount(id: string): Promise> { + return this.client.post(`/api/v1/accounts/${id}/unblock`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * POST /api/v1/accounts/:id/mute + * + * @param id The account ID. + * @param notifications Mute notifications in addition to statuses. + * @return Relationship + */ + public async muteAccount(id: string, notifications: boolean = true): Promise> { + return this.client + .post(`/api/v1/accounts/${id}/mute`, { + notifications: notifications + }) + .then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * POST /api/v1/accounts/:id/unmute + * + * @param id The account ID. + * @return Relationship + */ + public async unmuteAccount(id: string): Promise> { + return this.client.post(`/api/v1/accounts/${id}/unmute`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * POST /api/v1/accounts/:id/pin + * + * @param id The account ID. + * @return Relationship + */ + public async pinAccount(id: string): Promise> { + return this.client.post(`/api/v1/accounts/${id}/pin`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * POST /api/v1/accounts/:id/unpin + * + * @param id The account ID. + * @return Relationship + */ + public async unpinAccount(id: string): Promise> { + return this.client.post(`/api/v1/accounts/${id}/unpin`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * GET /api/v1/accounts/relationships + * + * @param id The account ID. + * @return Relationship + */ + public async getRelationship(id: string): Promise> { + return this.client + .get>('/api/v1/accounts/relationships', { + id: [id] + }) + .then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.relationship(res.data[0]) + }) + }) + } + + /** + * Get multiple relationships in one method + * + * @param ids Array of account IDs. + * @return Array of Relationship. + */ + public async getRelationships(ids: Array): Promise>> { + return this.client + .get>('/api/v1/accounts/relationships', { + id: ids + }) + .then(res => { + return Object.assign(res, { + data: res.data.map(r => PleromaAPI.Converter.relationship(r)) + }) + }) + } + + /** + * GET /api/v1/accounts/search + * + * @param q Search query. + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @return The array of accounts. + */ + public async searchAccount( + q: string, + options?: { + following?: boolean + resolve?: boolean + limit?: number + max_id?: string + since_id?: string + } + ): Promise>> { + let params = { q: q } + if (options) { + if (options.following !== undefined && options.following !== null) { + params = Object.assign(params, { + following: options.following + }) + } + if (options.resolve !== undefined && options.resolve !== null) { + params = Object.assign(params, { + resolve: options.resolve + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>('/api/v1/accounts/search', params).then(res => { + return Object.assign(res, { + data: res.data.map(a => PleromaAPI.Converter.account(a)) + }) + }) + } + + // ====================================== + // accounts/bookmarks + // ====================================== + /** + * GET /api/v1/bookmarks + * + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + public async getBookmarks(options?: { + limit?: number + max_id?: string + since_id?: string + min_id?: string + }): Promise>> { + let params = {} + if (options) { + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + } + return this.client.get>('/api/v1/bookmarks', params).then(res => { + return Object.assign(res, { + data: res.data.map(s => PleromaAPI.Converter.status(s)) + }) + }) + } + + // ====================================== + // accounts/favourites + // ====================================== + /** + * GET /api/v1/favourites + * + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + public async getFavourites(options?: { limit?: number; max_id?: string; min_id?: string }): Promise>> { + let params = {} + if (options) { + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>('/api/v1/favourites', params).then(res => { + return Object.assign(res, { + data: res.data.map(s => PleromaAPI.Converter.status(s)) + }) + }) + } + + // ====================================== + // accounts/mutes + // ====================================== + /** + * GET /api/v1/mutes + * + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of accounts. + */ + public async getMutes(options?: { limit?: number; max_id?: string; min_id?: string }): Promise>> { + let params = {} + if (options) { + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>('/api/v1/mutes', params).then(res => { + return Object.assign(res, { + data: res.data.map(a => PleromaAPI.Converter.account(a)) + }) + }) + } + + // ====================================== + // accounts/blocks + // ====================================== + /** + * GET /api/v1/blocks + * + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of accounts. + */ + public async getBlocks(options?: { limit?: number; max_id?: string; min_id?: string }): Promise>> { + let params = {} + if (options) { + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>('/api/v1/blocks', params).then(res => { + return Object.assign(res, { + data: res.data.map(a => PleromaAPI.Converter.account(a)) + }) + }) + } + + // ====================================== + // accounts/domain_blocks + // ====================================== + /** + * GET /api/v1/domain_blocks + * + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of domain name. + */ + public async getDomainBlocks(options?: { limit?: number; max_id?: string; min_id?: string }): Promise>> { + let params = {} + if (options) { + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>('/api/v1/domain_blocks', params) + } + + /** + * POST/api/v1/domain_blocks + * + * @param domain Domain to block. + */ + public blockDomain(domain: string): Promise> { + return this.client.post<{}>('/api/v1/domain_blocks', { + domain: domain + }) + } + + /** + * DELETE /api/v1/domain_blocks + * + * @param domain Domain to unblock + */ + public unblockDomain(domain: string): Promise> { + return this.client.del<{}>('/api/v1/domain_blocks', { + domain: domain + }) + } + + // ====================================== + // accounts/filters + // ====================================== + /** + * GET /api/v1/filters + * + * @return Array of filters. + */ + public async getFilters(): Promise>> { + return this.client.get>('/api/v1/filters').then(res => { + return Object.assign(res, { + data: res.data.map(f => PleromaAPI.Converter.filter(f)) + }) + }) + } + + /** + * GET /api/v1/filters/:id + * + * @param id The filter ID. + * @return Filter. + */ + public async getFilter(id: string): Promise> { + return this.client.get(`/api/v1/filters/${id}`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.filter(res.data) + }) + }) + } + + /** + * POST /api/v1/filters + * + * @param phrase Text to be filtered. + * @param context Array of enumerable strings home, notifications, public, thread, account. At least one context must be specified. + * @param options.irreversible Should the server irreversibly drop matching entities from home and notifications? + * @param options.whole_word Consider word boundaries? + * @param options.expires_in ISO 8601 Datetime for when the filter expires. + * @return Filter + */ + public async createFilter( + phrase: string, + context: Array, + options?: { + irreversible?: boolean + whole_word?: boolean + expires_in?: string + } + ): Promise> { + let params = { + phrase: phrase, + context: context + } + if (options) { + if (options.irreversible !== undefined) { + params = Object.assign(params, { + irreversible: options.irreversible + }) + } + if (options.whole_word !== undefined) { + params = Object.assign(params, { + whole_word: options.whole_word + }) + } + if (options.expires_in) { + params = Object.assign(params, { + expires_in: options.expires_in + }) + } + } + return this.client.post('/api/v1/filters', params).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.filter(res.data) + }) + }) + } + + /** + * PUT /api/v1/filters/:id + * + * @param id The filter ID. + * @param phrase Text to be filtered. + * @param context Array of enumerable strings home, notifications, public, thread, account. At least one context must be specified. + * @param options.irreversible Should the server irreversibly drop matching entities from home and notifications? + * @param options.whole_word Consider word boundaries? + * @param options.expires_in ISO 8601 Datetime for when the filter expires. + * @return Filter + */ + public async updateFilter( + id: string, + phrase: string, + context: Array, + options?: { + irreversible?: boolean + whole_word?: boolean + expires_in?: string + } + ): Promise> { + let params = { + phrase: phrase, + context: context + } + if (options) { + if (options.irreversible !== undefined) { + params = Object.assign(params, { + irreversible: options.irreversible + }) + } + if (options.whole_word !== undefined) { + params = Object.assign(params, { + whole_word: options.whole_word + }) + } + if (options.expires_in) { + params = Object.assign(params, { + expires_in: options.expires_in + }) + } + } + return this.client.put(`/api/v1/filters/${id}`, params).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.filter(res.data) + }) + }) + } + + /** + * DELETE /api/v1/filters/:id + * + * @param id The filter ID. + * @return Removed filter. + */ + public async deleteFilter(id: string): Promise> { + return this.client.del(`/api/v1/filters/${id}`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.filter(res.data) + }) + }) + } + + // ====================================== + // accounts/reports + // ====================================== + /** + * POST /api/v1/reports + * + * @param account_id Target account ID. + * @param options.status_ids Array of Statuses ids to attach to the report. + * @param options.comment The reason for the report. Default maximum of 1000 characters. + * @param options.forward If the account is remote, should the report be forwarded to the remote admin? + * @param options.category Specify if the report is due to spam, violation of enumerated instance rules, or some other reason. Defaults to other. Will be set to violation if rule_ids[] is provided (regardless of any category value you provide). + * @param options.rule_ids For violation category reports, specify the ID of the exact rules broken. Rules and their IDs are available via GET /api/v1/instance/rules and GET /api/v1/instance. + * @return Report + */ + public async report( + account_id: string, + options?: { + status_ids?: Array + comment: string + forward?: boolean + category?: Entity.Category + rule_ids?: Array + } + ): Promise> { + let params = { + account_id: account_id + } + if (options) { + if (options.status_ids) { + params = Object.assign(params, { + status_ids: options.status_ids + }) + } + if (options.comment) { + params = Object.assign(params, { + comment: options.comment + }) + } + if (options.forward !== undefined) { + params = Object.assign(params, { + forward: options.forward + }) + } + if (options.category) { + params = Object.assign(params, { + category: options.category + }) + } + if (options.rule_ids) { + params = Object.assign(params, { + rule_ids: options.rule_ids + }) + } + } + return this.client.post('/api/v1/reports', params).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.report(res.data) + }) + }) + } + + // ====================================== + // accounts/follow_requests + // ====================================== + /** + * GET /api/v1/follow_requests + * + * @param limit Maximum number of results. + * @return Array of account. + */ + public async getFollowRequests(limit?: number): Promise>> { + if (limit) { + return this.client + .get>('/api/v1/follow_requests', { + limit: limit + }) + .then(res => { + return Object.assign(res, { + data: res.data.map(a => PleromaAPI.Converter.account(a)) + }) + }) + } else { + return this.client.get>('/api/v1/follow_requests').then(res => { + return Object.assign(res, { + data: res.data.map(a => PleromaAPI.Converter.account(a)) + }) + }) + } + } + + /** + * POST /api/v1/follow_requests/:id/authorize + * + * @param id Target account ID. + * @return Relationship. + */ + public async acceptFollowRequest(id: string): Promise> { + return this.client.post(`/api/v1/follow_requests/${id}/authorize`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.relationship(res.data) + }) + }) + } + + /** + * POST /api/v1/follow_requests/:id/reject + * + * @param id Target account ID. + * @return Relationship. + */ + public async rejectFollowRequest(id: string): Promise> { + return this.client.post(`/api/v1/follow_requests/${id}/reject`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.relationship(res.data) + }) + }) + } + + // ====================================== + // accounts/endorsements + // ====================================== + /** + * GET /api/v1/endorsements + * + * @param options.limit Max number of results to return. Defaults to 40. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @return Array of accounts. + */ + public async getEndorsements(options?: { limit?: number; max_id?: string; since_id?: string }): Promise>> { + let params = {} + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + } + return this.client.get>('/api/v1/endorsements', params).then(res => { + return Object.assign(res, { + data: res.data.map(a => PleromaAPI.Converter.account(a)) + }) + }) + } + + // ====================================== + // accounts/featured_tags + // ====================================== + /** + * GET /api/v1/featured_tags + * + * @return Array of featured tag. + */ + public async getFeaturedTags(): Promise>> { + return this.client.get>('/api/v1/featured_tags').then(res => { + return Object.assign(res, { + data: res.data.map(f => PleromaAPI.Converter.featured_tag(f)) + }) + }) + } + + /** + * POST /api/v1/featured_tags + * + * @param name Target hashtag name. + * @return FeaturedTag. + */ + public async createFeaturedTag(name: string): Promise> { + return this.client + .post('/api/v1/featured_tags', { + name: name + }) + .then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.featured_tag(res.data) + }) + }) + } + + /** + * DELETE /api/v1/featured_tags/:id + * + * @param id Target featured tag id. + * @return Empty + */ + public deleteFeaturedTag(id: string): Promise> { + return this.client.del<{}>(`/api/v1/featured_tags/${id}`) + } + + /** + * GET /api/v1/featured_tags/suggestions + * + * @return Array of tag. + */ + public async getSuggestedTags(): Promise>> { + return this.client.get>('/api/v1/featured_tags/suggestions').then(res => { + return Object.assign(res, { + data: res.data.map(t => PleromaAPI.Converter.tag(t)) + }) + }) + } + + // ====================================== + // accounts/preferences + // ====================================== + /** + * GET /api/v1/preferences + * + * @return Preferences. + */ + public async getPreferences(): Promise> { + return this.client.get('/api/v1/preferences').then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.preferences(res.data) + }) + }) + } + + // ====================================== + // accounts/followed_tags + // ====================================== + public async getFollowedTags(): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('pleroma does not support') + reject(err) + }) + } + + // ====================================== + // accounts/suggestions + // ====================================== + /** + * GET /api/v1/suggestions + * + * @param limit Maximum number of results. + * @return Array of accounts. + */ + public async getSuggestions(limit?: number): Promise>> { + if (limit) { + return this.client + .get>('/api/v1/suggestions', { + limit: limit + }) + .then(res => { + return Object.assign(res, { + data: res.data.map(a => PleromaAPI.Converter.account(a)) + }) + }) + } else { + return this.client.get>('/api/v1/suggestions').then(res => { + return Object.assign(res, { + data: res.data.map(a => PleromaAPI.Converter.account(a)) + }) + }) + } + } + + // ====================================== + // accounts/tags + // ====================================== + /** + * GET /api/v1/tags/:id + * + * @param id Target hashtag id. + * @return Tag + */ + public async getTag(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('pleroma does not support') + reject(err) + }) + } + + /** + * POST /api/v1/tags/:id/follow + * + * @param id Target hashtag id. + * @return Tag + */ + public async followTag(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('pleroma does not support') + reject(err) + }) + } + + /** + * POST /api/v1/tags/:id/unfollow + * + * @param id Target hashtag id. + * @return Tag + */ + public async unfollowTag(_id: string): Promise> { + return new Promise((_, reject) => { + const err = new NoImplementedError('pleroma does not support') + reject(err) + }) + } + + // ====================================== + // statuses + // ====================================== + /** + * POST /api/v1/statuses + * + * @param status Text content of status. + * @param options.media_ids Array of Attachment ids. + * @param options.poll Poll object. + * @param options.in_reply_to_id ID of the status being replied to, if status is a reply. + * @param options.sensitive Mark status and attached media as sensitive? + * @param options.spoiler_text Text to be shown as a warning or subject before the actual content. + * @param options.visibility Visibility of the posted status. + * @param options.scheduled_at ISO 8601 Datetime at which to schedule a status. + * @param options.language ISO 639 language code for this status. + * @param options.quote_id ID of the status being quoted to, if status is a quote. + * @return Status. When options.scheduled_at is present, ScheduledStatus is returned instead. + */ + public async postStatus( + status: string, + options: { + media_ids?: Array + poll?: { options: Array; expires_in: number; multiple?: boolean; hide_totals?: boolean } + in_reply_to_id?: string + sensitive?: boolean + spoiler_text?: string + visibility?: 'public' | 'unlisted' | 'private' | 'direct' + scheduled_at?: string + language?: string + quote_id?: string + } + ): Promise> { + let params = { + status: status + } + if (options) { + if (options.media_ids) { + params = Object.assign(params, { + media_ids: options.media_ids + }) + } + if (options.poll) { + let pollParam = { + options: options.poll.options, + expires_in: options.poll.expires_in + } + if (options.poll.multiple !== undefined) { + pollParam = Object.assign(pollParam, { + multiple: options.poll.multiple + }) + } + if (options.poll.hide_totals !== undefined) { + pollParam = Object.assign(pollParam, { + hide_totals: options.poll.hide_totals + }) + } + params = Object.assign(params, { + poll: pollParam + }) + } + if (options.in_reply_to_id) { + params = Object.assign(params, { + in_reply_to_id: options.in_reply_to_id + }) + } + if (options.sensitive !== undefined) { + params = Object.assign(params, { + sensitive: options.sensitive + }) + } + if (options.spoiler_text) { + params = Object.assign(params, { + spoiler_text: options.spoiler_text + }) + } + if (options.visibility) { + params = Object.assign(params, { + visibility: options.visibility + }) + } + if (options.scheduled_at) { + params = Object.assign(params, { + scheduled_at: options.scheduled_at + }) + } + if (options.language) { + params = Object.assign(params, { + language: options.language + }) + } + if (options.quote_id) { + params = Object.assign(params, { + quote_id: options.quote_id + }) + } + } + if (options && options.scheduled_at) { + return this.client.post('/api/v1/statuses', params).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.scheduled_status(res.data) + }) + }) + } + return this.client.post('/api/v1/statuses', params).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.status(res.data) + }) + }) + } + + /** + * GET /api/v1/statuses/:id + * + * @param id The target status id. + * @return Status + */ + public async getStatus(id: string): Promise> { + return this.client.get(`/api/v1/statuses/${id}`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.status(res.data) + }) + }) + } + + /** + PUT /api/v1/statuses/:id + * + * @param id The target status id. + * @return Status + */ + public async editStatus( + id: string, + options: { + status?: string + spoiler_text?: string + sensitive?: boolean + media_ids?: Array + poll?: { options?: Array; expires_in?: number; multiple?: boolean; hide_totals?: boolean } + } + ): Promise> { + let params = {} + if (options.status) { + params = Object.assign(params, { + status: options.status + }) + } + if (options.spoiler_text) { + params = Object.assign(params, { + spoiler_text: options.spoiler_text + }) + } + if (options.sensitive) { + params = Object.assign(params, { + sensitive: options.sensitive + }) + } + if (options.media_ids) { + params = Object.assign(params, { + media_ids: options.media_ids + }) + } + if (options.poll) { + let pollParam = {} + if (options.poll.options !== undefined) { + pollParam = Object.assign(pollParam, { + options: options.poll.options + }) + } + if (options.poll.expires_in !== undefined) { + pollParam = Object.assign(pollParam, { + expires_in: options.poll.expires_in + }) + } + if (options.poll.multiple !== undefined) { + pollParam = Object.assign(pollParam, { + multiple: options.poll.multiple + }) + } + if (options.poll.hide_totals !== undefined) { + pollParam = Object.assign(pollParam, { + hide_totals: options.poll.hide_totals + }) + } + params = Object.assign(params, { + poll: pollParam + }) + } + return this.client.put(`/api/v1/statuses/${id}`, params).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.status(res.data) + }) + }) + } + + /** + * DELETE /api/v1/statuses/:id + * + * @param id The target status id. + * @return Status + */ + public async deleteStatus(id: string): Promise> { + return this.client.del(`/api/v1/statuses/${id}`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.status(res.data) + }) + }) + } + + /** + * GET /api/v1/statuses/:id/context + * + * Get parent and child statuses. + * @param id The target status id. + * @return Context + */ + public async getStatusContext( + id: string, + options?: { limit?: number; max_id?: string; since_id?: string } + ): Promise> { + let params = {} + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + } + return this.client.get(`/api/v1/statuses/${id}/context`, params).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.context(res.data) + }) + }) + } + + /** + * GET /api/v1/statuses/:id/source + * + * Obtain the source properties for a status so that it can be edited. + * @param id The target status id. + * @return StatusSource + */ + public async getStatusSource(id: string): Promise> { + return this.client.get(`/api/v1/statuses/${id}/source`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.status_source(res.data) + }) + }) + } + + /** + * GET /api/v1/statuses/:id/reblogged_by + * + * @param id The target status id. + * @return Array of accounts. + */ + public async getStatusRebloggedBy(id: string): Promise>> { + return this.client.get>(`/api/v1/statuses/${id}/reblogged_by`).then(res => { + return Object.assign(res, { + data: res.data.map(a => PleromaAPI.Converter.account(a)) + }) + }) + } + + /** + * GET /api/v1/statuses/:id/favourited_by + * + * @param id The target status id. + * @return Array of accounts. + */ + public async getStatusFavouritedBy(id: string): Promise>> { + return this.client.get>(`/api/v1/statuses/${id}/favourited_by`).then(res => { + return Object.assign(res, { + data: res.data.map(a => PleromaAPI.Converter.account(a)) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/favourite + * + * @param id The target status id. + * @return Status. + */ + public async favouriteStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/favourite`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.status(res.data) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/unfavourite + * + * @param id The target status id. + * @return Status. + */ + public async unfavouriteStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/unfavourite`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.status(res.data) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/reblog + * + * @param id The target status id. + * @return Status. + */ + public async reblogStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/reblog`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.status(res.data) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/unreblog + * + * @param id The target status id. + * @return Status. + */ + public async unreblogStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/unreblog`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.status(res.data) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/bookmark + * + * @param id The target status id. + * @return Status. + */ + public async bookmarkStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/bookmark`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.status(res.data) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/unbookmark + * + * @param id The target status id. + * @return Status. + */ + public async unbookmarkStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/unbookmark`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.status(res.data) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/mute + * + * @param id The target status id. + * @return Status + */ + public async muteStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/mute`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.status(res.data) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/unmute + * + * @param id The target status id. + * @return Status + */ + public async unmuteStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/unmute`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.status(res.data) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/pin + * @param id The target status id. + * @return Status + */ + public async pinStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/pin`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.status(res.data) + }) + }) + } + + /** + * POST /api/v1/statuses/:id/unpin + * + * @param id The target status id. + * @return Status + */ + public async unpinStatus(id: string): Promise> { + return this.client.post(`/api/v1/statuses/${id}/unpin`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.status(res.data) + }) + }) + } + + // ====================================== + // statuses/media + // ====================================== + /** + * POST /api/v2/media + * + * @param file The file to be attached, using multipart form data. + * @param options.description A plain-text description of the media. + * @param options.focus Two floating points (x,y), comma-delimited, ranging from -1.0 to 1.0. + * @return Attachment + */ + public async uploadMedia( + file: any, + options?: { description?: string; focus?: string } + ): Promise> { + const formData = new FormData() + formData.append('file', file) + if (options) { + if (options.description) { + formData.append('description', options.description) + } + if (options.focus) { + formData.append('focus', options.focus) + } + } + return this.client.postForm('/api/v2/media', formData).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.async_attachment(res.data) + }) + }) + } + + /** + * GET /api/v1/media/:id + * + * @param id Target media ID. + * @return Attachment + */ + public async getMedia(id: string): Promise> { + const res = await this.client.get(`/api/v1/media/${id}`) + + return Object.assign(res, { + data: PleromaAPI.Converter.attachment(res.data) + }) + } + + /** + * PUT /api/v1/media/:id + * + * @param id Target media ID. + * @param options.file The file to be attached, using multipart form data. + * @param options.description A plain-text description of the media. + * @param options.focus Two floating points (x,y), comma-delimited, ranging from -1.0 to 1.0. + * @param options.is_sensitive Whether the media is sensitive. + * @return Attachment + */ + public async updateMedia( + id: string, + options?: { + file?: any + description?: string + focus?: string + } + ): Promise> { + const formData = new FormData() + if (options) { + if (options.file) { + formData.append('file', options.file) + } + if (options.description) { + formData.append('description', options.description) + } + if (options.focus) { + formData.append('focus', options.focus) + } + } + return this.client.putForm(`/api/v1/media/${id}`, formData).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.attachment(res.data) + }) + }) + } + + // ====================================== + // statuses/polls + // ====================================== + /** + * GET /api/v1/polls/:id + * + * @param id Target poll ID. + * @return Poll + */ + public async getPoll(id: string): Promise> { + return this.client.get(`/api/v1/polls/${id}`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.poll(res.data) + }) + }) + } + + /** + * POST /api/v1/polls/:id/votes + * + * @param id Target poll ID. + * @param choices Array of own votes containing index for each option (starting from 0). + * @return Poll + */ + public async votePoll(id: string, choices: Array): Promise> { + return this.client + .post(`/api/v1/polls/${id}/votes`, { + choices: choices + }) + .then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.poll(res.data) + }) + }) + } + + // ====================================== + // statuses/scheduled_statuses + // ====================================== + /** + * GET /api/v1/scheduled_statuses + * + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of scheduled statuses. + */ + public async getScheduledStatuses(options?: { + limit?: number | null + max_id?: string | null + since_id?: string | null + min_id?: string | null + }): Promise>> { + let params = {} + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + } + return this.client.get>('/api/v1/scheduled_statuses', params).then(res => { + return Object.assign(res, { + data: res.data.map(s => PleromaAPI.Converter.scheduled_status(s)) + }) + }) + } + + /** + * GET /api/v1/scheduled_statuses/:id + * + * @param id Target status ID. + * @return ScheduledStatus. + */ + public async getScheduledStatus(id: string): Promise> { + return this.client.get(`/api/v1/scheduled_statuses/${id}`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.scheduled_status(res.data) + }) + }) + } + + /** + * PUT /api/v1/scheduled_statuses/:id + * + * @param id Target scheduled status ID. + * @param scheduled_at ISO 8601 Datetime at which the status will be published. + * @return ScheduledStatus. + */ + public async scheduleStatus(id: string, scheduled_at?: string | null): Promise> { + let params = {} + if (scheduled_at) { + params = Object.assign(params, { + scheduled_at: scheduled_at + }) + } + return this.client.put(`/api/v1/scheduled_statuses/${id}`, params).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.scheduled_status(res.data) + }) + }) + } + + /** + * DELETE /api/v1/scheduled_statuses/:id + * + * @param id Target scheduled status ID. + */ + public cancelScheduledStatus(id: string): Promise> { + return this.client.del<{}>(`/api/v1/scheduled_statuses/${id}`) + } + + // ====================================== + // timelines + // ====================================== + /** + * GET /api/v1/timelines/public + * + * @param options.only_media Show only statuses with media attached? Defaults to false. + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + public async getPublicTimeline(options?: { + only_media?: boolean + limit?: number + max_id?: string + since_id?: string + min_id?: string + }): Promise>> { + let params = { + local: false + } + if (options) { + if (options.only_media !== undefined) { + params = Object.assign(params, { + only_media: options.only_media + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>('/api/v1/timelines/public', params).then(res => { + return Object.assign(res, { + data: res.data.map(s => PleromaAPI.Converter.status(s)) + }) + }) + } + + /** + * GET /api/v1/timelines/public + * + * @param options.only_media Show only statuses with media attached? Defaults to false. + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + public async getLocalTimeline(options?: { + only_media?: boolean + limit?: number + max_id?: string + since_id?: string + min_id?: string + }): Promise>> { + let params = { + local: true + } + if (options) { + if (options.only_media !== undefined) { + params = Object.assign(params, { + only_media: options.only_media + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>('/api/v1/timelines/public', params).then(res => { + return Object.assign(res, { + data: res.data.map(s => PleromaAPI.Converter.status(s)) + }) + }) + } + + /** + * GET /api/v1/timelines/tag/:hashtag + * + * @param hashtag Content of a #hashtag, not including # symbol. + * @param options.local Show only local statuses? Defaults to false. + * @param options.only_media Show only statuses with media attached? Defaults to false. + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + public async getTagTimeline( + hashtag: string, + options?: { + local?: boolean + only_media?: boolean + limit?: number + max_id?: string + since_id?: string + min_id?: string + } + ): Promise>> { + let params = {} + if (options) { + if (options.local !== undefined) { + params = Object.assign(params, { + local: options.local + }) + } + if (options.only_media !== undefined) { + params = Object.assign(params, { + only_media: options.only_media + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>(`/api/v1/timelines/tag/${hashtag}`, params).then(res => { + return Object.assign(res, { + data: res.data.map(s => PleromaAPI.Converter.status(s)) + }) + }) + } + + /** + * GET /api/v1/timelines/home + * + * @param options.local Show only local statuses? Defaults to false. + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + public async getHomeTimeline(options?: { + local?: boolean + limit?: number + max_id?: string + since_id?: string + min_id?: string + }): Promise>> { + let params = {} + if (options) { + if (options.local !== undefined) { + params = Object.assign(params, { + local: options.local + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>('/api/v1/timelines/home', params).then(res => { + return Object.assign(res, { + data: res.data.map(s => PleromaAPI.Converter.status(s)) + }) + }) + } + + /** + * GET /api/v1/timelines/list/:list_id + * + * @param list_id Local ID of the list in the database. + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + public async getListTimeline( + list_id: string, + options?: { + limit?: number + max_id?: string + since_id?: string + min_id?: string + } + ): Promise>> { + let params = {} + if (options) { + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>(`/api/v1/timelines/list/${list_id}`, params).then(res => { + return Object.assign(res, { + data: res.data.map(s => PleromaAPI.Converter.status(s)) + }) + }) + } + + // ====================================== + // timelines/conversations + // ====================================== + /** + * GET /api/v1/conversations + * + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of statuses. + */ + public async getConversationTimeline(options?: { + limit?: number + max_id?: string + since_id?: string + min_id?: string + }): Promise>> { + let params = {} + if (options) { + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + } + return this.client.get>('/api/v1/conversations', params).then(res => { + return Object.assign(res, { + data: res.data.map(c => PleromaAPI.Converter.conversation(c)) + }) + }) + } + + /** + * DELETE /api/v1/conversations/:id + * + * @param id Target conversation ID. + */ + public deleteConversation(id: string): Promise> { + return this.client.del<{}>(`/api/v1/conversations/${id}`) + } + + /** + * POST /api/v1/conversations/:id/read + * + * @param id Target conversation ID. + * @return Conversation. + */ + public async readConversation(id: string): Promise> { + return this.client.post(`/api/v1/conversations/${id}/read`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.conversation(res.data) + }) + }) + } + + // ====================================== + // timelines/lists + // ====================================== + /** + * GET /api/v1/lists + * + * @return Array of lists. + */ + public async getLists(): Promise>> { + return this.client.get>('/api/v1/lists').then(res => { + return Object.assign(res, { + data: res.data.map(l => PleromaAPI.Converter.list(l)) + }) + }) + } + + /** + * GET /api/v1/lists/:id + * + * @param id Target list ID. + * @return List. + */ + public async getList(id: string): Promise> { + return this.client.get(`/api/v1/lists/${id}`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.list(res.data) + }) + }) + } + + /** + * POST /api/v1/lists + * + * @param title List name. + * @return List. + */ + public async createList(title: string): Promise> { + return this.client + .post('/api/v1/lists', { + title: title + }) + .then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.list(res.data) + }) + }) + } + + /** + * PUT /api/v1/lists/:id + * + * @param id Target list ID. + * @param title New list name. + * @return List. + */ + public async updateList(id: string, title: string): Promise> { + return this.client + .put(`/api/v1/lists/${id}`, { + title: title + }) + .then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.list(res.data) + }) + }) + } + + /** + * DELETE /api/v1/lists/:id + * + * @param id Target list ID. + */ + public deleteList(id: string): Promise> { + return this.client.del<{}>(`/api/v1/lists/${id}`) + } + + /** + * GET /api/v1/lists/:id/accounts + * + * @param id Target list ID. + * @param options.limit Max number of results to return. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @return Array of accounts. + */ + public async getAccountsInList( + id: string, + options?: { + limit?: number + max_id?: string + since_id?: string + } + ): Promise>> { + let params = {} + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + } + return this.client.get>(`/api/v1/lists/${id}/accounts`, params).then(res => { + return Object.assign(res, { + data: res.data.map(a => PleromaAPI.Converter.account(a)) + }) + }) + } + + /** + * POST /api/v1/lists/:id/accounts + * + * @param id Target list ID. + * @param account_ids Array of account IDs to add to the list. + */ + public addAccountsToList(id: string, account_ids: Array): Promise> { + return this.client.post<{}>(`/api/v1/lists/${id}/accounts`, { + account_ids: account_ids + }) + } + + /** + * DELETE /api/v1/lists/:id/accounts + * + * @param id Target list ID. + * @param account_ids Array of account IDs to add to the list. + */ + public deleteAccountsFromList(id: string, account_ids: Array): Promise> { + return this.client.del<{}>(`/api/v1/lists/${id}/accounts`, { + account_ids: account_ids + }) + } + + // ====================================== + // timelines/markers + // ====================================== + /** + * GET /api/v1/markers + * + * @param timelines Array of timeline names, String enum anyOf home, notifications. + * @return Marker or empty object. + */ + public async getMarkers(timeline: Array): Promise>> { + return this.client + .get>('/api/v1/markers', { + timeline: timeline + }) + .then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.marker(res.data) + }) + }) + } + + /** + * POST /api/v1/markers + * + * @param options.home Marker position of the last read status ID in home timeline. + * @param options.notifications Marker position of the last read notification ID in notifications. + * @return Marker. + */ + public async saveMarkers(options?: { + home?: { last_read_id: string } + notifications?: { last_read_id: string } + }): Promise> { + let params = {} + if (options) { + if (options.home) { + params = Object.assign(params, { + home: options.home + }) + } + if (options.notifications) { + params = Object.assign(params, { + notifications: options.notifications + }) + } + } + return this.client.post('/api/v1/markers', params).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.marker(res.data) + }) + }) + } + + // ====================================== + // notifications + // ====================================== + /** + * GET /api/v1/notifications + * + * @param options.limit Max number of results to return. Defaults to 20. + * @param options.max_id Return results older than ID. + * @param options.since_id Return results newer than ID. + * @param options.min_id Return results immediately newer than ID. + * @param options.exclude_types Array of types to exclude. + * @param options.account_id Return only notifications received from this account. + * @return Array of notifications. + */ + public async getNotifications(options?: { + limit?: number + max_id?: string + since_id?: string + min_id?: string + exclude_types?: Array + account_id?: string + }): Promise>> { + let params = {} + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.since_id) { + params = Object.assign(params, { + since_id: options.since_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.exclude_types) { + params = Object.assign(params, { + exclude_types: options.exclude_types.map(e => PleromaAPI.Converter.encodeNotificationType(e)) + }) + } + if (options.account_id) { + params = Object.assign(params, { + account_id: options.account_id + }) + } + } + return this.client.get>('/api/v1/notifications', params).then(res => { + return Object.assign(res, { + data: res.data.flatMap(n => { + const notify = PleromaAPI.Converter.notification(n) + if (notify instanceof UnknownNotificationTypeError) return [] + return notify + }) + }) + }) + } + + /** + * GET /api/v1/notifications/:id + * + * @param id Target notification ID. + * @return Notification. + */ + public async getNotification(id: string): Promise> { + const res = await this.client.get(`/api/v1/notifications/${id}`) + const notify = PleromaAPI.Converter.notification(res.data) + if (notify instanceof UnknownNotificationTypeError) { + throw new UnknownNotificationTypeError() + } + return { ...res, data: notify } + } + + /** + * POST /api/v1/notifications/clear + */ + public dismissNotifications(): Promise> { + return this.client.post<{}>('/api/v1/notifications/clear') + } + + /** + * POST /api/v1/notifications/:id/dismiss + * + * @param id Target notification ID. + */ + public dismissNotification(id: string): Promise> { + return this.client.post<{}>(`/api/v1/notifications/${id}/dismiss`) + } + + /** + * POST /api/v1/pleroma/notifcations/read + * + * @param id A single notification ID to read + * @param max_id Read all notifications up to this ID + * @return Array of notifications + */ + public async readNotifications(options: { + id?: string + max_id?: string + }): Promise>> { + if (options.id) { + const res = await this.client.post('/api/v1/pleroma/notifications/read', { + id: options.id + }) + const notify = PleromaAPI.Converter.notification(res.data) + if (notify instanceof UnknownNotificationTypeError) return { ...res, data: [] } + return { ...res, data: notify } + } else if (options.max_id) { + const res = await this.client.post>('/api/v1/pleroma/notifications/read', { + max_id: options.max_id + }) + return { + ...res, + data: res.data.flatMap(n => { + const notify = PleromaAPI.Converter.notification(n) + if (notify instanceof UnknownNotificationTypeError) return [] + return notify + }) + } + } else { + return new Promise((_, reject) => { + const err = new ArgumentError('id or max_id is required') + reject(err) + }) + } + } + + // ====================================== + // notifications/push + // ====================================== + /** + * POST /api/v1/push/subscription + * + * @param subscription[endpoint] Endpoint URL that is called when a notification event occurs. + * @param subscription[keys][p256dh] User agent public key. Base64 encoded string of public key of ECDH key using prime256v1 curve. + * @param subscription[keys] Auth secret. Base64 encoded string of 16 bytes of random data. + * @param data[alerts][follow] Receive follow notifications? + * @param data[alerts][favourite] Receive favourite notifications? + * @param data[alerts][reblog] Receive reblog notifictaions? + * @param data[alerts][mention] Receive mention notifications? + * @param data[alerts][poll] Receive poll notifications? + * @return PushSubscription. + */ + public async subscribePushNotification( + subscription: { endpoint: string; keys: { p256dh: string; auth: string } }, + data?: { alerts: { follow?: boolean; favourite?: boolean; reblog?: boolean; mention?: boolean; poll?: boolean } } | null + ): Promise> { + let params = { + subscription + } + if (data) { + params = Object.assign(params, { + data + }) + } + return this.client.post('/api/v1/push/subscription', params).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.push_subscription(res.data) + }) + }) + } + + /** + * GET /api/v1/push/subscription + * + * @return PushSubscription. + */ + public async getPushSubscription(): Promise> { + return this.client.get('/api/v1/push/subscription').then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.push_subscription(res.data) + }) + }) + } + + /** + * PUT /api/v1/push/subscription + * + * @param data[alerts][follow] Receive follow notifications? + * @param data[alerts][favourite] Receive favourite notifications? + * @param data[alerts][reblog] Receive reblog notifictaions? + * @param data[alerts][mention] Receive mention notifications? + * @param data[alerts][poll] Receive poll notifications? + * @return PushSubscription. + */ + public async updatePushSubscription( + data?: { alerts: { follow?: boolean; favourite?: boolean; reblog?: boolean; mention?: boolean; poll?: boolean } } | null + ): Promise> { + let params = {} + if (data) { + params = Object.assign(params, { + data + }) + } + return this.client.put('/api/v1/push/subscription', params).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.push_subscription(res.data) + }) + }) + } + + /** + * DELETE /api/v1/push/subscription + */ + public deletePushSubscription(): Promise> { + return this.client.del<{}>('/api/v1/push/subscription') + } + + // ====================================== + // search + // ====================================== + /** + * GET /api/v2/search + * + * @param q The search query. + * @param options.type Enum of search target. + * @param options.limit Maximum number of results to load, per type. Defaults to 20. Max 40. + * @param options.max_id Return results older than this id. + * @param options.min_id Return results immediately newer than this id. + * @param options.resolve Attempt WebFinger lookup. Defaults to false. + * @param options.following Only include accounts that the user is following. Defaults to false. + * @param options.account_id If provided, statuses returned will be authored only by this account. + * @param options.exclude_unreviewed Filter out unreviewed tags? Defaults to false. + * @return Results. + */ + public async search( + q: string, + options?: { + type?: 'accounts' | 'hashtags' | 'statuses' + limit?: number + max_id?: string + min_id?: string + resolve?: boolean + offset?: number + following?: boolean + account_id?: string + exclude_unreviewed?: boolean + } + ): Promise> { + let params = { + q + } + if (options) { + if (options.type) { + params = Object.assign(params, { + type: options.type + }) + } + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.max_id) { + params = Object.assign(params, { + max_id: options.max_id + }) + } + if (options.min_id) { + params = Object.assign(params, { + min_id: options.min_id + }) + } + if (options.resolve !== undefined) { + params = Object.assign(params, { + resolve: options.resolve + }) + } + if (options.offset) { + params = Object.assign(params, { + offset: options.offset + }) + } + if (options.following !== undefined) { + params = Object.assign(params, { + following: options.following + }) + } + if (options.account_id) { + params = Object.assign(params, { + account_id: options.account_id + }) + } + if (options.exclude_unreviewed) { + params = Object.assign(params, { + exclude_unreviewed: options.exclude_unreviewed + }) + } + } + return this.client.get('/api/v2/search', params).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.results(res.data) + }) + }) + } + + // ====================================== + // instance + // ====================================== + /** + * GET /api/v1/instance + */ + public async getInstance(): Promise> { + return this.client.get('/api/v1/instance').then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.instance(res.data) + }) + }) + } + + /** + * GET /api/v1/instance/peers + */ + public getInstancePeers(): Promise>> { + return this.client.get>('/api/v1/instance/peers') + } + + /** + * GET /api/v1/instance/activity + */ + public async getInstanceActivity(): Promise>> { + return this.client.get>('/api/v1/instance/activity').then(res => { + return Object.assign(res, { + data: res.data.map(a => PleromaAPI.Converter.activity(a)) + }) + }) + } + + // ====================================== + // instance/trends + // ====================================== + /** + * GET /api/v1/trends + * + * @param limit Maximum number of results to return. Defaults to 10. + */ + public async getInstanceTrends(limit?: number | null): Promise>> { + let params = {} + if (limit) { + params = Object.assign(params, { + limit + }) + } + return this.client.get>('/api/v1/trends', params).then(res => { + return Object.assign(res, { + data: res.data.map(t => PleromaAPI.Converter.tag(t)) + }) + }) + } + + // ====================================== + // instance/directory + // ====================================== + /** + * GET /api/v1/directory + * + * @param options.limit How many accounts to load. Default 40. + * @param options.offset How many accounts to skip before returning results. Default 0. + * @param options.order Order of results. + * @param options.local Only return local accounts. + * @return Array of accounts. + */ + public async getInstanceDirectory(options?: { + limit?: number + offset?: number + order?: 'active' | 'new' + local?: boolean + }): Promise>> { + let params = {} + if (options) { + if (options.limit) { + params = Object.assign(params, { + limit: options.limit + }) + } + if (options.offset) { + params = Object.assign(params, { + offset: options.offset + }) + } + if (options.order) { + params = Object.assign(params, { + order: options.order + }) + } + if (options.local !== undefined) { + params = Object.assign(params, { + local: options.local + }) + } + } + return this.client.get>('/api/v1/directory', params).then(res => { + return Object.assign(res, { + data: res.data.map(a => PleromaAPI.Converter.account(a)) + }) + }) + } + + // ====================================== + // instance/custom_emojis + // ====================================== + /** + * GET /api/v1/custom_emojis + * + * @return Array of emojis. + */ + public async getInstanceCustomEmojis(): Promise>> { + return this.client.get>('/api/v1/custom_emojis').then(res => { + return Object.assign(res, { + data: res.data.map(e => PleromaAPI.Converter.emoji(e)) + }) + }) + } + + // ====================================== + // instance/announcements + // ====================================== + /** + * GET /api/v1/announcements + * + * @return Array of announcements. + */ + public async getInstanceAnnouncements(): Promise>> { + return this.client.get>('/api/v1/announcements').then(res => { + return Object.assign(res, { + data: res.data.map(a => PleromaAPI.Converter.announcement(a)) + }) + }) + } + + /** + * POST /api/v1/announcements/:id/dismiss + * + * @param id The ID of the Announcement in the database. + */ + public async dismissInstanceAnnouncement(id: string): Promise>> { + return this.client.post>(`/api/v1/announcements/${id}/dismiss`) + } + + /** + * PUT /api/v1/announcements/:id/reactions/:name + * + * @param id The ID of the Announcement in the database. + * @param name Unicode emoji, or the shortcode of a custom emoji. + */ + public async addReactionToAnnouncement(_id: string, _name: string): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('pleroma does not support') + reject(err) + }) + } + + /** + * DELETE /api/v1/announcements/:id/reactions/:name + * + * @param id The ID of the Announcement in the database. + * @param name Unicode emoji, or the shortcode of a custom emoji. + */ + public async removeReactionFromAnnouncement(_id: string, _name: string): Promise>> { + return new Promise((_, reject) => { + const err = new NoImplementedError('pleroma does not support') + reject(err) + }) + } + + // ====================================== + // Emoji reactions + // ====================================== + /** + * PUT /api/v1/pleroma/statuses/:status_id/reactions/:emoji + * + * @param {string} id Target status ID. + * @param {string} emoji Reaction emoji string. This string is raw unicode emoji. + */ + public async createEmojiReaction(id: string, emoji: string): Promise> { + return this.client.put(`/api/v1/pleroma/statuses/${id}/reactions/${encodeURI(emoji)}`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.status(res.data) + }) + }) + } + + /** + * DELETE /api/v1/pleroma/statuses/:status_id/reactions/:emoji + * + * @param {string} id Target status ID. + * @param {string} emoji Reaction emoji string. This string is raw unicode emoji. + */ + public async deleteEmojiReaction(id: string, emoji: string): Promise> { + return this.client.del(`/api/v1/pleroma/statuses/${id}/reactions/${encodeURI(emoji)}`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.status(res.data) + }) + }) + } + + /** + * GET /api/v1/pleroma/statuses/:status_id/reactions + * + * @param {string} id Target status ID. + */ + public async getEmojiReactions(id: string): Promise>> { + return this.client.get>(`/api/v1/pleroma/statuses/${id}/reactions`).then(res => { + return Object.assign(res, { + data: res.data.map(r => PleromaAPI.Converter.reaction(r)) + }) + }) + } + + /** + * GET /api/v1/pleroma/statuses/:status_id/reactions/:emoji + * + * @param {string} id Target status ID. + * @param {string} emoji Reaction emoji string. This string is url encoded unicode emoji. + */ + public async getEmojiReaction(id: string, emoji: string): Promise> { + return this.client.get(`/api/v1/pleroma/statuses/${id}/reactions/${encodeURI(emoji)}`).then(res => { + return Object.assign(res, { + data: PleromaAPI.Converter.reaction(res.data) + }) + }) + } + + // ====================================== + // WebSocket + // ====================================== + public userSocket(): WebSocket { + return this.client.socket('/api/v1/streaming', 'user') + } + + public publicSocket(): WebSocket { + return this.client.socket('/api/v1/streaming', 'public') + } + + public localSocket(): WebSocket { + return this.client.socket('/api/v1/streaming', 'public:local') + } + + public tagSocket(tag: string): WebSocket { + return this.client.socket('/api/v1/streaming', 'hashtag', `tag=${tag}`) + } + + public listSocket(list_id: string): WebSocket { + return this.client.socket('/api/v1/streaming', 'list', `list=${list_id}`) + } + + public directSocket(): WebSocket { + return this.client.socket('/api/v1/streaming', 'direct') + } +} diff --git a/packages/megalodon/src/pleroma/api_client.ts b/packages/megalodon/src/pleroma/api_client.ts new file mode 100644 index 000000000..99d964353 --- /dev/null +++ b/packages/megalodon/src/pleroma/api_client.ts @@ -0,0 +1,823 @@ +import axios, { AxiosResponse, AxiosRequestConfig } from 'axios' +import objectAssignDeep from 'object-assign-deep' + +import MegalodonEntity from '../entity' +import PleromaEntity from './entity' +import Response from '../response' +import { RequestCanceledError } from '../cancel' +import proxyAgent, { ProxyConfig } from '../proxy_config' +import { NO_REDIRECT, DEFAULT_SCOPE, DEFAULT_UA } from '../default' +import WebSocket from './web_socket' +import NotificationType, { UnknownNotificationTypeError } from '../notification' +import PleromaNotificationType from './notification' + +namespace PleromaAPI { + export namespace Entity { + export type Account = PleromaEntity.Account + export type Activity = PleromaEntity.Activity + export type Announcement = PleromaEntity.Announcement + export type Application = PleromaEntity.Application + export type AsyncAttachment = PleromaEntity.AsyncAttachment + export type Attachment = PleromaEntity.Attachment + export type Card = PleromaEntity.Card + export type Context = PleromaEntity.Context + export type Conversation = PleromaEntity.Conversation + export type Emoji = PleromaEntity.Emoji + export type FeaturedTag = PleromaEntity.FeaturedTag + export type Field = PleromaEntity.Field + export type Filter = PleromaEntity.Filter + export type History = PleromaEntity.History + export type IdentityProof = PleromaEntity.IdentityProof + export type Instance = PleromaEntity.Instance + export type List = PleromaEntity.List + export type Marker = PleromaEntity.Marker + export type Mention = PleromaEntity.Mention + export type Notification = PleromaEntity.Notification + export type Poll = PleromaEntity.Poll + export type PollOption = PleromaEntity.PollOption + export type Preferences = PleromaEntity.Preferences + export type PushSubscription = PleromaEntity.PushSubscription + export type Reaction = PleromaEntity.Reaction + export type Relationship = PleromaEntity.Relationship + export type Report = PleromaEntity.Report + export type Results = PleromaEntity.Results + export type ScheduledStatus = PleromaEntity.ScheduledStatus + export type Source = PleromaEntity.Source + export type Stats = PleromaEntity.Stats + export type Status = PleromaEntity.Status + export type StatusParams = PleromaEntity.StatusParams + export type StatusSource = PleromaEntity.StatusSource + export type Tag = PleromaEntity.Tag + export type Token = PleromaEntity.Token + export type URLs = PleromaEntity.URLs + } + + export namespace Converter { + export const decodeNotificationType = ( + t: PleromaEntity.NotificationType + ): MegalodonEntity.NotificationType | UnknownNotificationTypeError => { + switch (t) { + case PleromaNotificationType.Mention: + return NotificationType.Mention + case PleromaNotificationType.Reblog: + return NotificationType.Reblog + case PleromaNotificationType.Favourite: + return NotificationType.Favourite + case PleromaNotificationType.Follow: + return NotificationType.Follow + case PleromaNotificationType.Poll: + return NotificationType.PollExpired + case PleromaNotificationType.PleromaEmojiReaction: + return NotificationType.EmojiReaction + case PleromaNotificationType.FollowRequest: + return NotificationType.FollowRequest + case PleromaNotificationType.Update: + return NotificationType.Update + case PleromaNotificationType.Move: + return NotificationType.Move + default: + return new UnknownNotificationTypeError() + } + } + export const encodeNotificationType = ( + t: MegalodonEntity.NotificationType + ): PleromaEntity.NotificationType | UnknownNotificationTypeError => { + switch (t) { + case NotificationType.Follow: + return PleromaNotificationType.Follow + case NotificationType.Favourite: + return PleromaNotificationType.Favourite + case NotificationType.Reblog: + return PleromaNotificationType.Reblog + case NotificationType.Mention: + return PleromaNotificationType.Mention + case NotificationType.PollExpired: + return PleromaNotificationType.Poll + case NotificationType.EmojiReaction: + return PleromaNotificationType.PleromaEmojiReaction + case NotificationType.FollowRequest: + return PleromaNotificationType.FollowRequest + case NotificationType.Update: + return PleromaNotificationType.Update + case NotificationType.Move: + return PleromaNotificationType.Move + default: + return new UnknownNotificationTypeError() + } + } + + export const account = (a: Entity.Account): MegalodonEntity.Account => { + return { + id: a.id, + username: a.username, + acct: a.acct, + display_name: a.display_name, + locked: a.locked, + discoverable: a.discoverable, + group: null, + noindex: a.noindex, + suspended: a.suspended, + limited: a.limited, + created_at: a.created_at, + followers_count: a.followers_count, + following_count: a.following_count, + statuses_count: a.statuses_count, + note: a.note, + url: a.url, + avatar: a.avatar, + avatar_static: a.avatar_static, + header: a.header, + header_static: a.header_static, + emojis: a.emojis.map(e => emoji(e)), + moved: a.moved ? account(a.moved) : null, + fields: a.fields, + bot: a.bot, + source: a.source + } + } + export const activity = (a: Entity.Activity): MegalodonEntity.Activity => a + export const announcement = (a: Entity.Announcement): MegalodonEntity.Announcement => ({ + id: a.id, + content: a.content, + starts_at: a.starts_at, + ends_at: a.ends_at, + published: a.published, + all_day: a.all_day, + published_at: a.published_at, + updated_at: a.updated_at, + read: null, + mentions: a.mentions, + statuses: a.statuses, + tags: a.tags, + emojis: a.emojis, + reactions: a.reactions + }) + export const application = (a: Entity.Application): MegalodonEntity.Application => a + export const attachment = (a: Entity.Attachment): MegalodonEntity.Attachment => a + export const async_attachment = (a: Entity.AsyncAttachment) => { + if (a.url) { + return { + id: a.id, + type: a.type, + url: a.url!, + remote_url: a.remote_url, + preview_url: a.preview_url, + text_url: a.text_url, + meta: a.meta, + description: a.description, + blurhash: a.blurhash + } as MegalodonEntity.Attachment + } else { + return a as MegalodonEntity.AsyncAttachment + } + } + export const card = (c: Entity.Card): MegalodonEntity.Card => ({ + url: c.url, + title: c.title, + description: c.description, + type: c.type, + image: c.image, + author_name: null, + author_url: null, + provider_name: c.provider_name, + provider_url: c.provider_url, + html: null, + width: null, + height: null, + embed_url: null, + blurhash: null + }) + export const context = (c: Entity.Context): MegalodonEntity.Context => ({ + ancestors: Array.isArray(c.ancestors) ? c.ancestors.map(a => status(a)) : [], + descendants: Array.isArray(c.descendants) ? c.descendants.map(d => status(d)) : [] + }) + export const conversation = (c: Entity.Conversation): MegalodonEntity.Conversation => ({ + id: c.id, + accounts: Array.isArray(c.accounts) ? c.accounts.map(a => account(a)) : [], + last_status: c.last_status ? status(c.last_status) : null, + unread: c.unread + }) + export const emoji = (e: Entity.Emoji): MegalodonEntity.Emoji => ({ + shortcode: e.shortcode, + static_url: e.static_url, + url: e.url, + visible_in_picker: e.visible_in_picker + }) + export const featured_tag = (f: Entity.FeaturedTag): MegalodonEntity.FeaturedTag => f + export const field = (f: Entity.Field): MegalodonEntity.Field => f + export const filter = (f: Entity.Filter): MegalodonEntity.Filter => f + export const history = (h: Entity.History): MegalodonEntity.History => h + export const identity_proof = (i: Entity.IdentityProof): MegalodonEntity.IdentityProof => i + export const instance = (i: Entity.Instance): MegalodonEntity.Instance => ({ + uri: i.uri, + title: i.title, + description: i.description, + email: i.email, + version: i.version, + thumbnail: i.thumbnail, + urls: urls(i.urls), + stats: stats(i.stats), + languages: i.languages, + registrations: i.registrations, + approval_required: i.approval_required, + configuration: { + statuses: { + max_characters: i.max_toot_chars, + max_media_attachments: i.max_media_attachments + }, + polls: { + max_options: i.poll_limits.max_options, + max_characters_per_option: i.poll_limits.max_option_chars, + min_expiration: i.poll_limits.min_expiration, + max_expiration: i.poll_limits.max_expiration + } + } + }) + export const list = (l: Entity.List): MegalodonEntity.List => ({ + id: l.id, + title: l.title, + replies_policy: null + }) + export const marker = (m: Entity.Marker | Record): MegalodonEntity.Marker | Record => { + if ((m as any).notifications) { + const mm = m as Entity.Marker + return { + notifications: { + last_read_id: mm.notifications.last_read_id, + version: mm.notifications.version, + updated_at: mm.notifications.updated_at, + unread_count: mm.notifications.pleroma.unread_count + } + } + } else { + return {} + } + } + export const mention = (m: Entity.Mention): MegalodonEntity.Mention => m + export const notification = (n: Entity.Notification): MegalodonEntity.Notification | UnknownNotificationTypeError => { + const notificationType = decodeNotificationType(n.type) + if (notificationType instanceof UnknownNotificationTypeError) return notificationType + if (n.status && n.emoji) { + return { + id: n.id, + account: account(n.account), + created_at: n.created_at, + status: status(n.status), + emoji: n.emoji, + type: notificationType + } + } else if (n.status) { + return { + id: n.id, + account: account(n.account), + created_at: n.created_at, + status: status(n.status), + type: notificationType + } + } else if (n.target) { + return { + id: n.id, + account: account(n.account), + created_at: n.created_at, + target: account(n.target), + type: notificationType + } + } else { + return { + id: n.id, + account: account(n.account), + created_at: n.created_at, + type: notificationType + } + } + } + export const poll = (p: Entity.Poll): MegalodonEntity.Poll => p + export const pollOption = (p: Entity.PollOption): MegalodonEntity.PollOption => p + export const preferences = (p: Entity.Preferences): MegalodonEntity.Preferences => p + export const push_subscription = (p: Entity.PushSubscription): MegalodonEntity.PushSubscription => p + export const reaction = (r: Entity.Reaction): MegalodonEntity.Reaction => { + const p = { + count: r.count, + me: r.me, + name: r.name + } + if (r.accounts) { + return Object.assign({}, p, { + accounts: r.accounts.map(a => account(a)) + }) + } + return p + } + export const relationship = (r: Entity.Relationship): MegalodonEntity.Relationship => ({ + id: r.id, + following: r.following, + followed_by: r.followed_by, + blocking: r.blocking, + blocked_by: r.blocked_by, + muting: r.muting, + muting_notifications: r.muting_notifications, + requested: r.requested, + domain_blocking: r.domain_blocking, + showing_reblogs: r.showing_reblogs, + endorsed: r.endorsed, + notifying: r.notifying, + note: r.note + }) + export const report = (r: Entity.Report): MegalodonEntity.Report => ({ + id: r.id, + action_taken: r.action_taken, + action_taken_at: null, + category: null, + comment: null, + forwarded: null, + status_ids: null, + rule_ids: null + }) + export const results = (r: Entity.Results): MegalodonEntity.Results => ({ + accounts: Array.isArray(r.accounts) ? r.accounts.map(a => account(a)) : [], + statuses: Array.isArray(r.statuses) ? r.statuses.map(s => status(s)) : [], + hashtags: Array.isArray(r.hashtags) ? r.hashtags.map(h => tag(h)) : [] + }) + export const scheduled_status = (s: Entity.ScheduledStatus): MegalodonEntity.ScheduledStatus => ({ + id: s.id, + scheduled_at: s.scheduled_at, + params: status_params(s.params), + media_attachments: Array.isArray(s.media_attachments) ? s.media_attachments.map(m => attachment(m)) : null + }) + export const source = (s: Entity.Source): MegalodonEntity.Source => s + export const stats = (s: Entity.Stats): MegalodonEntity.Stats => s + export const status = (s: Entity.Status): MegalodonEntity.Status => ({ + id: s.id, + uri: s.uri, + url: s.url, + account: account(s.account), + in_reply_to_id: s.in_reply_to_id, + in_reply_to_account_id: s.in_reply_to_account_id, + reblog: s.reblog ? status(s.reblog) : null, + content: s.content, + plain_content: s.pleroma.content?.['text/plain'] ? s.pleroma.content['text/plain'] : null, + created_at: s.created_at, + emojis: Array.isArray(s.emojis) ? s.emojis.map(e => emoji(e)) : [], + replies_count: s.replies_count, + reblogs_count: s.reblogs_count, + favourites_count: s.favourites_count, + reblogged: s.reblogged, + favourited: s.favourited, + muted: s.muted, + sensitive: s.sensitive, + spoiler_text: s.spoiler_text, + visibility: s.visibility, + media_attachments: Array.isArray(s.media_attachments) ? s.media_attachments.map(m => attachment(m)) : [], + mentions: Array.isArray(s.mentions) ? s.mentions.map(m => mention(m)) : [], + tags: s.tags, + card: s.card ? card(s.card) : null, + poll: s.poll ? poll(s.poll) : null, + application: s.application ? application(s.application) : null, + language: s.language, + pinned: s.pinned, + emoji_reactions: Array.isArray(s.pleroma.emoji_reactions) ? s.pleroma.emoji_reactions.map(r => reaction(r)) : [], + bookmarked: s.bookmarked ? s.bookmarked : false, + quote: s.reblog !== null && s.reblog.content !== s.content + }) + export const status_params = (s: Entity.StatusParams): MegalodonEntity.StatusParams => { + return { + text: s.text, + in_reply_to_id: s.in_reply_to_id, + media_ids: Array.isArray(s.media_ids) ? s.media_ids : null, + sensitive: s.sensitive, + spoiler_text: s.spoiler_text, + visibility: s.visibility, + scheduled_at: s.scheduled_at, + application_id: null + } + } + export const status_source = (s: Entity.StatusSource): MegalodonEntity.StatusSource => s + export const tag = (t: Entity.Tag): MegalodonEntity.Tag => t + export const token = (t: Entity.Token): MegalodonEntity.Token => t + export const urls = (u: Entity.URLs): MegalodonEntity.URLs => u + } + + /** + * Interface + */ + export interface Interface { + get(path: string, params?: any, headers?: { [key: string]: string }): Promise> + put(path: string, params?: any, headers?: { [key: string]: string }): Promise> + putForm(path: string, params?: any, headers?: { [key: string]: string }): Promise> + patch(path: string, params?: any, headers?: { [key: string]: string }): Promise> + patchForm(path: string, params?: any, headers?: { [key: string]: string }): Promise> + post(path: string, params?: any, headers?: { [key: string]: string }): Promise> + postForm(path: string, params?: any, headers?: { [key: string]: string }): Promise> + del(path: string, params?: any, headers?: { [key: string]: string }): Promise> + cancel(): void + socket(path: string, stream: string, params?: string): WebSocket + } + + /** + * Mastodon API client. + * + * Using axios for request, you will handle promises. + */ + export class Client implements Interface { + static DEFAULT_SCOPE = DEFAULT_SCOPE + static DEFAULT_URL = 'https://pleroma.io' + static NO_REDIRECT = NO_REDIRECT + + private accessToken: string | null + private baseUrl: string + private userAgent: string + private abortController: AbortController + private proxyConfig: ProxyConfig | false = false + + /** + * @param baseUrl hostname or base URL + * @param accessToken access token from OAuth2 authorization + * @param userAgent UserAgent is specified in header on request. + * @param proxyConfig Proxy setting, or set false if don't use proxy. + */ + constructor( + baseUrl: string, + accessToken: string | null = null, + userAgent: string = DEFAULT_UA, + proxyConfig: ProxyConfig | false = false + ) { + this.accessToken = accessToken + this.baseUrl = baseUrl + this.userAgent = userAgent + this.proxyConfig = proxyConfig + this.abortController = new AbortController() + axios.defaults.signal = this.abortController.signal + } + + /** + * GET request to mastodon REST API. + * @param path relative path from baseUrl + * @param params Query parameters + * @param headers Request header object + */ + public async get(path: string, params = {}, headers: { [key: string]: string } = {}): Promise> { + let options: AxiosRequestConfig = { + params: params, + headers: headers + } + if (this.accessToken) { + options = objectAssignDeep({}, options, { + headers: { + Authorization: `Bearer ${this.accessToken}` + } + }) + } + if (this.proxyConfig) { + options = Object.assign(options, { + httpAgent: proxyAgent(this.proxyConfig), + httpsAgent: proxyAgent(this.proxyConfig) + }) + } + return axios + .get(this.baseUrl + path, options) + .catch((err: Error) => { + if (axios.isCancel(err)) { + throw new RequestCanceledError(err.message) + } else { + throw err + } + }) + .then((resp: AxiosResponse) => { + const res: Response = { + data: resp.data, + status: resp.status, + statusText: resp.statusText, + headers: resp.headers + } + return res + }) + } + + /** + * PUT request to mastodon REST API. + * @param path relative path from baseUrl + * @param params Form data. If you want to post file, please use FormData() + * @param headers Request header object + */ + public async put(path: string, params = {}, headers: { [key: string]: string } = {}): Promise> { + let options: AxiosRequestConfig = { + headers: headers, + maxContentLength: Infinity, + maxBodyLength: Infinity + } + if (this.accessToken) { + options = objectAssignDeep({}, options, { + headers: { + Authorization: `Bearer ${this.accessToken}` + } + }) + } + if (this.proxyConfig) { + options = Object.assign(options, { + httpAgent: proxyAgent(this.proxyConfig), + httpsAgent: proxyAgent(this.proxyConfig) + }) + } + return axios + .put(this.baseUrl + path, params, options) + .catch((err: Error) => { + if (axios.isCancel(err)) { + throw new RequestCanceledError(err.message) + } else { + throw err + } + }) + .then((resp: AxiosResponse) => { + const res: Response = { + data: resp.data, + status: resp.status, + statusText: resp.statusText, + headers: resp.headers + } + return res + }) + } + + /** + * PUT request to mastodon REST API for multipart. + * @param path relative path from baseUrl + * @param params Form data. If you want to post file, please use FormData() + * @param headers Request header object + */ + public async putForm(path: string, params = {}, headers: { [key: string]: string } = {}): Promise> { + let options: AxiosRequestConfig = { + headers: headers, + maxContentLength: Infinity, + maxBodyLength: Infinity + } + if (this.accessToken) { + options = objectAssignDeep({}, options, { + headers: { + Authorization: `Bearer ${this.accessToken}` + } + }) + } + if (this.proxyConfig) { + options = Object.assign(options, { + httpAgent: proxyAgent(this.proxyConfig), + httpsAgent: proxyAgent(this.proxyConfig) + }) + } + return axios + .putForm(this.baseUrl + path, params, options) + .catch((err: Error) => { + if (axios.isCancel(err)) { + throw new RequestCanceledError(err.message) + } else { + throw err + } + }) + .then((resp: AxiosResponse) => { + const res: Response = { + data: resp.data, + status: resp.status, + statusText: resp.statusText, + headers: resp.headers + } + return res + }) + } + + /** + * PATCH request to mastodon REST API. + * @param path relative path from baseUrl + * @param params Form data. If you want to post file, please use FormData() + * @param headers Request header object + */ + public async patch(path: string, params = {}, headers: { [key: string]: string } = {}): Promise> { + let options: AxiosRequestConfig = { + headers: headers, + maxContentLength: Infinity, + maxBodyLength: Infinity + } + if (this.accessToken) { + options = objectAssignDeep({}, options, { + headers: { + Authorization: `Bearer ${this.accessToken}` + } + }) + } + if (this.proxyConfig) { + options = Object.assign(options, { + httpAgent: proxyAgent(this.proxyConfig), + httpsAgent: proxyAgent(this.proxyConfig) + }) + } + return axios + .patch(this.baseUrl + path, params, options) + .catch((err: Error) => { + if (axios.isCancel(err)) { + throw new RequestCanceledError(err.message) + } else { + throw err + } + }) + .then((resp: AxiosResponse) => { + const res: Response = { + data: resp.data, + status: resp.status, + statusText: resp.statusText, + headers: resp.headers + } + return res + }) + } + + /** + * PATCH request to mastodon REST API for multipart. + * @param path relative path from baseUrl + * @param params Form data. If you want to post file, please use FormData() + * @param headers Request header object + */ + public async patchForm(path: string, params = {}, headers: { [key: string]: string } = {}): Promise> { + let options: AxiosRequestConfig = { + headers: headers, + maxContentLength: Infinity, + maxBodyLength: Infinity + } + if (this.accessToken) { + options = objectAssignDeep({}, options, { + headers: { + Authorization: `Bearer ${this.accessToken}` + } + }) + } + if (this.proxyConfig) { + options = Object.assign(options, { + httpAgent: proxyAgent(this.proxyConfig), + httpsAgent: proxyAgent(this.proxyConfig) + }) + } + return axios + .patchForm(this.baseUrl + path, params, options) + .catch((err: Error) => { + if (axios.isCancel(err)) { + throw new RequestCanceledError(err.message) + } else { + throw err + } + }) + .then((resp: AxiosResponse) => { + const res: Response = { + data: resp.data, + status: resp.status, + statusText: resp.statusText, + headers: resp.headers + } + return res + }) + } + + /** + * POST request to mastodon REST API. + * @param path relative path from baseUrl + * @param params Form data + * @param headers Request header object + */ + public async post(path: string, params = {}, headers: { [key: string]: string } = {}): Promise> { + let options: AxiosRequestConfig = { + headers: headers, + maxContentLength: Infinity, + maxBodyLength: Infinity + } + if (this.accessToken) { + options = objectAssignDeep({}, options, { + headers: { + Authorization: `Bearer ${this.accessToken}` + } + }) + } + if (this.proxyConfig) { + options = Object.assign(options, { + httpAgent: proxyAgent(this.proxyConfig), + httpsAgent: proxyAgent(this.proxyConfig) + }) + } + return axios.post(this.baseUrl + path, params, options).then((resp: AxiosResponse) => { + const res: Response = { + data: resp.data, + status: resp.status, + statusText: resp.statusText, + headers: resp.headers + } + return res + }) + } + + /** + * POST request to mastodon REST API for multipart. + * @param path relative path from baseUrl + * @param params Form data + * @param headers Request header object + */ + public async postForm(path: string, params = {}, headers: { [key: string]: string } = {}): Promise> { + let options: AxiosRequestConfig = { + headers: headers, + maxContentLength: Infinity, + maxBodyLength: Infinity + } + if (this.accessToken) { + options = objectAssignDeep({}, options, { + headers: { + Authorization: `Bearer ${this.accessToken}` + } + }) + } + if (this.proxyConfig) { + options = Object.assign(options, { + httpAgent: proxyAgent(this.proxyConfig), + httpsAgent: proxyAgent(this.proxyConfig) + }) + } + return axios.postForm(this.baseUrl + path, params, options).then((resp: AxiosResponse) => { + const res: Response = { + data: resp.data, + status: resp.status, + statusText: resp.statusText, + headers: resp.headers + } + return res + }) + } + + /** + * DELETE request to mastodon REST API. + * @param path relative path from baseUrl + * @param params Form data + * @param headers Request header object + */ + public async del(path: string, params = {}, headers: { [key: string]: string } = {}): Promise> { + let options: AxiosRequestConfig = { + data: params, + headers: headers, + maxContentLength: Infinity, + maxBodyLength: Infinity + } + if (this.accessToken) { + options = objectAssignDeep({}, options, { + headers: { + Authorization: `Bearer ${this.accessToken}` + } + }) + } + if (this.proxyConfig) { + options = Object.assign(options, { + httpAgent: proxyAgent(this.proxyConfig), + httpsAgent: proxyAgent(this.proxyConfig) + }) + } + return axios + .delete(this.baseUrl + path, options) + .catch((err: Error) => { + if (axios.isCancel(err)) { + throw new RequestCanceledError(err.message) + } else { + throw err + } + }) + .then((resp: AxiosResponse) => { + const res: Response = { + data: resp.data, + status: resp.status, + statusText: resp.statusText, + headers: resp.headers + } + return res + }) + } + + /** + * Cancel all requests in this instance. + * @returns void + */ + public cancel(): void { + return this.abortController.abort() + } + + /** + * Get connection and receive websocket connection for Pleroma API. + * + * @param path relative path from baseUrl: normally it is `/streaming`. + * @param stream Stream name, please refer: https://git.pleroma.social/pleroma/pleroma/blob/develop/lib/pleroma/web/mastodon_api/mastodon_socket.ex#L19-28 + * @returns WebSocket, which inherits from EventEmitter + */ + public socket(path: string, stream: string, params?: string): WebSocket { + if (!this.accessToken) { + throw new Error('accessToken is required') + } + const url = this.baseUrl + path + const streaming = new WebSocket(url, stream, params, this.accessToken, this.userAgent, this.proxyConfig) + process.nextTick(() => { + streaming.start() + }) + return streaming + } + } +} + +export default PleromaAPI diff --git a/packages/megalodon/src/pleroma/entities/account.ts b/packages/megalodon/src/pleroma/entities/account.ts new file mode 100644 index 000000000..29d42643f --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/account.ts @@ -0,0 +1,31 @@ +/// +/// +/// +namespace PleromaEntity { + export type Account = { + id: string + username: string + acct: string + display_name: string + locked: boolean + discoverable?: boolean + noindex: boolean | null + suspended: boolean | null + limited: boolean | null + created_at: string + followers_count: number + following_count: number + statuses_count: number + note: string + url: string + avatar: string + avatar_static: string + header: string + header_static: string + emojis: Array + moved: Account | null + fields: Array + bot: boolean + source?: Source + } +} diff --git a/packages/megalodon/src/pleroma/entities/activity.ts b/packages/megalodon/src/pleroma/entities/activity.ts new file mode 100644 index 000000000..f70ad168e --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/activity.ts @@ -0,0 +1,8 @@ +namespace PleromaEntity { + export type Activity = { + week: string + statuses: string + logins: string + registrations: string + } +} diff --git a/packages/megalodon/src/pleroma/entities/announcement.ts b/packages/megalodon/src/pleroma/entities/announcement.ts new file mode 100644 index 000000000..247ad90c5 --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/announcement.ts @@ -0,0 +1,39 @@ +/// + +namespace PleromaEntity { + export type Announcement = { + id: string + content: string + starts_at: string | null + ends_at: string | null + published: boolean + all_day: boolean + published_at: string + updated_at: string + mentions: Array + statuses: Array + tags: Array + emojis: Array + reactions: Array + } + + export type AnnouncementAccount = { + id: string + username: string + url: string + acct: string + } + + export type AnnouncementStatus = { + id: string + url: string + } + + export type AnnouncementReaction = { + name: string + count: number + me: boolean | null + url: string | null + static_url: string | null + } +} diff --git a/packages/megalodon/src/pleroma/entities/application.ts b/packages/megalodon/src/pleroma/entities/application.ts new file mode 100644 index 000000000..055592d6c --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/application.ts @@ -0,0 +1,7 @@ +namespace PleromaEntity { + export type Application = { + name: string + website?: string | null + vapid_key?: string | null + } +} diff --git a/packages/megalodon/src/pleroma/entities/async_attachment.ts b/packages/megalodon/src/pleroma/entities/async_attachment.ts new file mode 100644 index 000000000..8784979cb --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/async_attachment.ts @@ -0,0 +1,14 @@ +/// +namespace PleromaEntity { + export type AsyncAttachment = { + id: string + type: 'unknown' | 'image' | 'gifv' | 'video' | 'audio' + url: string | null + remote_url: string | null + preview_url: string + text_url: string | null + meta: Meta | null + description: string | null + blurhash: string | null + } +} diff --git a/packages/megalodon/src/pleroma/entities/attachment.ts b/packages/megalodon/src/pleroma/entities/attachment.ts new file mode 100644 index 000000000..18d4371da --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/attachment.ts @@ -0,0 +1,49 @@ +namespace PleromaEntity { + export type Sub = { + // For Image, Gifv, and Video + width?: number + height?: number + size?: string + aspect?: number + + // For Gifv and Video + frame_rate?: string + + // For Audio, Gifv, and Video + duration?: number + bitrate?: number + } + + export type Focus = { + x: number + y: number + } + + export type Meta = { + original?: Sub + small?: Sub + focus?: Focus + length?: string + duration?: number + fps?: number + size?: string + width?: number + height?: number + aspect?: number + audio_encode?: string + audio_bitrate?: string + audio_channel?: string + } + + export type Attachment = { + id: string + type: 'unknown' | 'image' | 'gifv' | 'video' | 'audio' + url: string + remote_url: string | null + preview_url: string | null + text_url: string | null + meta: Meta | null + description: string | null + blurhash: string | null + } +} diff --git a/packages/megalodon/src/pleroma/entities/card.ts b/packages/megalodon/src/pleroma/entities/card.ts new file mode 100644 index 000000000..9aca99a8c --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/card.ts @@ -0,0 +1,11 @@ +namespace PleromaEntity { + export type Card = { + url: string + title: string + description: string + type: 'link' | 'photo' | 'video' | 'rich' + image: string | null + provider_name: string + provider_url: string + } +} diff --git a/packages/megalodon/src/pleroma/entities/context.ts b/packages/megalodon/src/pleroma/entities/context.ts new file mode 100644 index 000000000..f297bd2c1 --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/context.ts @@ -0,0 +1,8 @@ +/// + +namespace PleromaEntity { + export type Context = { + ancestors: Array + descendants: Array + } +} diff --git a/packages/megalodon/src/pleroma/entities/conversation.ts b/packages/megalodon/src/pleroma/entities/conversation.ts new file mode 100644 index 000000000..624e6da38 --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/conversation.ts @@ -0,0 +1,11 @@ +/// +/// + +namespace PleromaEntity { + export type Conversation = { + id: string + accounts: Array + last_status: Status | null + unread: boolean + } +} diff --git a/packages/megalodon/src/pleroma/entities/emoji.ts b/packages/megalodon/src/pleroma/entities/emoji.ts new file mode 100644 index 000000000..43ea22d77 --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/emoji.ts @@ -0,0 +1,8 @@ +namespace PleromaEntity { + export type Emoji = { + shortcode: string + static_url: string + url: string + visible_in_picker: boolean + } +} diff --git a/packages/megalodon/src/pleroma/entities/featured_tag.ts b/packages/megalodon/src/pleroma/entities/featured_tag.ts new file mode 100644 index 000000000..a42e27f9d --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/featured_tag.ts @@ -0,0 +1,8 @@ +namespace PleromaEntity { + export type FeaturedTag = { + id: string + name: string + statuses_count: number + last_status_at: string + } +} diff --git a/packages/megalodon/src/pleroma/entities/field.ts b/packages/megalodon/src/pleroma/entities/field.ts new file mode 100644 index 000000000..01803078a --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/field.ts @@ -0,0 +1,7 @@ +namespace PleromaEntity { + export type Field = { + name: string + value: string + verified_at: string | null + } +} diff --git a/packages/megalodon/src/pleroma/entities/filter.ts b/packages/megalodon/src/pleroma/entities/filter.ts new file mode 100644 index 000000000..08a18089c --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/filter.ts @@ -0,0 +1,12 @@ +namespace PleromaEntity { + export type Filter = { + id: string + phrase: string + context: Array + expires_at: string | null + irreversible: boolean + whole_word: boolean + } + + export type FilterContext = string +} diff --git a/packages/megalodon/src/pleroma/entities/history.ts b/packages/megalodon/src/pleroma/entities/history.ts new file mode 100644 index 000000000..9aaaeb8de --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/history.ts @@ -0,0 +1,7 @@ +namespace PleromaEntity { + export type History = { + day: string + uses: number + accounts: number + } +} diff --git a/packages/megalodon/src/pleroma/entities/identity_proof.ts b/packages/megalodon/src/pleroma/entities/identity_proof.ts new file mode 100644 index 000000000..463fdc681 --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/identity_proof.ts @@ -0,0 +1,9 @@ +namespace PleromaEntity { + export type IdentityProof = { + provider: string + provider_username: string + updated_at: string + proof_url: string + profile_url: string + } +} diff --git a/packages/megalodon/src/pleroma/entities/instance.ts b/packages/megalodon/src/pleroma/entities/instance.ts new file mode 100644 index 000000000..0b57e805e --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/instance.ts @@ -0,0 +1,46 @@ +/// +/// +/// + +namespace PleromaEntity { + export type Instance = { + uri: string + title: string + description: string + email: string + version: string + thumbnail: string | null + urls: URLs + stats: Stats + languages: Array + registrations: boolean + approval_required: boolean + max_toot_chars: number + max_media_attachments?: number + pleroma: { + metadata: { + account_activation_required: boolean + birthday_min_age: number + birthday_required: boolean + features: Array + federation: { + enabled: boolean + exclusions: boolean + } + fields_limits: { + max_fields: number + max_remote_fields: number + name_length: number + value_length: number + } + post_formats: Array + } + } + poll_limits: { + max_expiration: number + min_expiration: number + max_option_chars: number + max_options: number + } + } +} diff --git a/packages/megalodon/src/pleroma/entities/list.ts b/packages/megalodon/src/pleroma/entities/list.ts new file mode 100644 index 000000000..a3d4362d9 --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/list.ts @@ -0,0 +1,6 @@ +namespace PleromaEntity { + export type List = { + id: string + title: string + } +} diff --git a/packages/megalodon/src/pleroma/entities/marker.ts b/packages/megalodon/src/pleroma/entities/marker.ts new file mode 100644 index 000000000..720d4a905 --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/marker.ts @@ -0,0 +1,12 @@ +namespace PleromaEntity { + export type Marker = { + notifications: { + last_read_id: string + version: number + updated_at: string + pleroma: { + unread_count: number + } + } + } +} diff --git a/packages/megalodon/src/pleroma/entities/mention.ts b/packages/megalodon/src/pleroma/entities/mention.ts new file mode 100644 index 000000000..0d68b4ec2 --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/mention.ts @@ -0,0 +1,8 @@ +namespace PleromaEntity { + export type Mention = { + id: string + username: string + url: string + acct: string + } +} diff --git a/packages/megalodon/src/pleroma/entities/notification.ts b/packages/megalodon/src/pleroma/entities/notification.ts new file mode 100644 index 000000000..edfa456de --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/notification.ts @@ -0,0 +1,16 @@ +/// +/// + +namespace PleromaEntity { + export type Notification = { + account: Account + created_at: string + id: string + status?: Status + emoji?: string + type: NotificationType + target?: Account + } + + export type NotificationType = string +} diff --git a/packages/megalodon/src/pleroma/entities/poll.ts b/packages/megalodon/src/pleroma/entities/poll.ts new file mode 100644 index 000000000..82e0182ad --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/poll.ts @@ -0,0 +1,13 @@ +/// + +namespace PleromaEntity { + export type Poll = { + id: string + expires_at: string | null + expired: boolean + multiple: boolean + votes_count: number + options: Array + voted: boolean + } +} diff --git a/packages/megalodon/src/pleroma/entities/poll_option.ts b/packages/megalodon/src/pleroma/entities/poll_option.ts new file mode 100644 index 000000000..69717ca0f --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/poll_option.ts @@ -0,0 +1,6 @@ +namespace PleromaEntity { + export type PollOption = { + title: string + votes_count: number | null + } +} diff --git a/packages/megalodon/src/pleroma/entities/preferences.ts b/packages/megalodon/src/pleroma/entities/preferences.ts new file mode 100644 index 000000000..99f8d6bca --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/preferences.ts @@ -0,0 +1,9 @@ +namespace PleromaEntity { + export type Preferences = { + 'posting:default:visibility': 'public' | 'unlisted' | 'private' | 'direct' + 'posting:default:sensitive': boolean + 'posting:default:language': string | null + 'reading:expand:media': 'default' | 'show_all' | 'hide_all' + 'reading:expand:spoilers': boolean + } +} diff --git a/packages/megalodon/src/pleroma/entities/push_subscription.ts b/packages/megalodon/src/pleroma/entities/push_subscription.ts new file mode 100644 index 000000000..b3e14e68a --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/push_subscription.ts @@ -0,0 +1,16 @@ +namespace PleromaEntity { + export type Alerts = { + follow: boolean + favourite: boolean + mention: boolean + reblog: boolean + poll: boolean + } + + export type PushSubscription = { + id: string + endpoint: string + server_key: string + alerts: Alerts + } +} diff --git a/packages/megalodon/src/pleroma/entities/reaction.ts b/packages/megalodon/src/pleroma/entities/reaction.ts new file mode 100644 index 000000000..662600f25 --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/reaction.ts @@ -0,0 +1,10 @@ +/// + +namespace PleromaEntity { + export type Reaction = { + count: number + me: boolean + name: string + accounts?: Array + } +} diff --git a/packages/megalodon/src/pleroma/entities/relationship.ts b/packages/megalodon/src/pleroma/entities/relationship.ts new file mode 100644 index 000000000..039f8ec74 --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/relationship.ts @@ -0,0 +1,18 @@ +namespace PleromaEntity { + export type Relationship = { + id: string + following: boolean + followed_by: boolean + blocking: boolean + blocked_by: boolean + muting: boolean + muting_notifications: boolean + requested: boolean + domain_blocking: boolean + showing_reblogs: boolean + endorsed: boolean + subscribing: boolean + notifying: boolean + note: string + } +} diff --git a/packages/megalodon/src/pleroma/entities/report.ts b/packages/megalodon/src/pleroma/entities/report.ts new file mode 100644 index 000000000..5b9c650a1 --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/report.ts @@ -0,0 +1,6 @@ +namespace PleromaEntity { + export type Report = { + id: string + action_taken: boolean + } +} diff --git a/packages/megalodon/src/pleroma/entities/results.ts b/packages/megalodon/src/pleroma/entities/results.ts new file mode 100644 index 000000000..cd42e3b09 --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/results.ts @@ -0,0 +1,11 @@ +/// +/// +/// + +namespace PleromaEntity { + export type Results = { + accounts: Array + statuses: Array + hashtags: Array + } +} diff --git a/packages/megalodon/src/pleroma/entities/scheduled_status.ts b/packages/megalodon/src/pleroma/entities/scheduled_status.ts new file mode 100644 index 000000000..547d35fd8 --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/scheduled_status.ts @@ -0,0 +1,10 @@ +/// +/// +namespace PleromaEntity { + export type ScheduledStatus = { + id: string + scheduled_at: string + params: StatusParams + media_attachments: Array | null + } +} diff --git a/packages/megalodon/src/pleroma/entities/source.ts b/packages/megalodon/src/pleroma/entities/source.ts new file mode 100644 index 000000000..f2fa74ab7 --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/source.ts @@ -0,0 +1,10 @@ +/// +namespace PleromaEntity { + export type Source = { + privacy: string | null + sensitive: boolean | null + language: string | null + note: string + fields: Array + } +} diff --git a/packages/megalodon/src/pleroma/entities/stats.ts b/packages/megalodon/src/pleroma/entities/stats.ts new file mode 100644 index 000000000..ab3e77845 --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/stats.ts @@ -0,0 +1,7 @@ +namespace PleromaEntity { + export type Stats = { + user_count: number + status_count: number + domain_count: number + } +} diff --git a/packages/megalodon/src/pleroma/entities/status.ts b/packages/megalodon/src/pleroma/entities/status.ts new file mode 100644 index 000000000..1949ec954 --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/status.ts @@ -0,0 +1,64 @@ +/// +/// +/// +/// +/// +/// +/// +/// + +namespace PleromaEntity { + export type Status = { + id: string + uri: string + url: string + account: Account + in_reply_to_id: string | null + in_reply_to_account_id: string | null + reblog: Status | null + content: string + created_at: string + emojis: Emoji[] + replies_count: number + reblogs_count: number + favourites_count: number + reblogged: boolean | null + favourited: boolean | null + muted: boolean | null + sensitive: boolean + spoiler_text: string + visibility: 'public' | 'unlisted' | 'private' | 'direct' + media_attachments: Array + mentions: Array + tags: Array + card: Card | null + poll: Poll | null + application: Application | null + language: string | null + pinned: boolean | null + bookmarked?: boolean + // Reblogged status contains only local parameter. + pleroma: { + content?: { + 'text/plain': string + } + spoiler_text?: { + 'text/plain': string + } + conversation_id?: number + direct_conversation_id?: number | null + emoji_reactions?: Array + expires_at?: string + in_reply_to_account_acct?: string + local: boolean + parent_visible?: boolean + pinned_at?: string + thread_muted?: boolean + } + } + + export type StatusTag = { + name: string + url: string + } +} diff --git a/packages/megalodon/src/pleroma/entities/status_params.ts b/packages/megalodon/src/pleroma/entities/status_params.ts new file mode 100644 index 000000000..eda13a0b9 --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/status_params.ts @@ -0,0 +1,11 @@ +namespace PleromaEntity { + export type StatusParams = { + text: string + in_reply_to_id: string | null + media_ids?: Array | null + sensitive: boolean | null + spoiler_text: string | null + visibility: 'public' | 'unlisted' | 'private' | 'direct' | null + scheduled_at: string | null + } +} diff --git a/packages/megalodon/src/pleroma/entities/status_source.ts b/packages/megalodon/src/pleroma/entities/status_source.ts new file mode 100644 index 000000000..57d2bea78 --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/status_source.ts @@ -0,0 +1,7 @@ +namespace PleromaEntity { + export type StatusSource = { + id: string + text: string + spoiler_text: string + } +} diff --git a/packages/megalodon/src/pleroma/entities/tag.ts b/packages/megalodon/src/pleroma/entities/tag.ts new file mode 100644 index 000000000..e323ec72c --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/tag.ts @@ -0,0 +1,10 @@ +/// + +namespace PleromaEntity { + export type Tag = { + name: string + url: string + history: Array + following?: boolean + } +} diff --git a/packages/megalodon/src/pleroma/entities/token.ts b/packages/megalodon/src/pleroma/entities/token.ts new file mode 100644 index 000000000..0ac565b51 --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/token.ts @@ -0,0 +1,8 @@ +namespace PleromaEntity { + export type Token = { + access_token: string + token_type: string + scope: string + created_at: number + } +} diff --git a/packages/megalodon/src/pleroma/entities/urls.ts b/packages/megalodon/src/pleroma/entities/urls.ts new file mode 100644 index 000000000..7ad6faf2b --- /dev/null +++ b/packages/megalodon/src/pleroma/entities/urls.ts @@ -0,0 +1,5 @@ +namespace PleromaEntity { + export type URLs = { + streaming_api: string + } +} diff --git a/packages/megalodon/src/pleroma/entity.ts b/packages/megalodon/src/pleroma/entity.ts new file mode 100644 index 000000000..bd486f62b --- /dev/null +++ b/packages/megalodon/src/pleroma/entity.ts @@ -0,0 +1,39 @@ +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// > +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// + +export default PleromaEntity diff --git a/packages/megalodon/src/pleroma/notification.ts b/packages/megalodon/src/pleroma/notification.ts new file mode 100644 index 000000000..2dad51a6e --- /dev/null +++ b/packages/megalodon/src/pleroma/notification.ts @@ -0,0 +1,15 @@ +import PleromaEntity from './entity' + +namespace PleromaNotificationType { + export const Mention: PleromaEntity.NotificationType = 'mention' + export const Reblog: PleromaEntity.NotificationType = 'reblog' + export const Favourite: PleromaEntity.NotificationType = 'favourite' + export const Follow: PleromaEntity.NotificationType = 'follow' + export const Poll: PleromaEntity.NotificationType = 'poll' + export const PleromaEmojiReaction: PleromaEntity.NotificationType = 'pleroma:emoji_reaction' + export const FollowRequest: PleromaEntity.NotificationType = 'follow_request' + export const Update: PleromaEntity.NotificationType = 'update' + export const Move: PleromaEntity.NotificationType = 'move' +} + +export default PleromaNotificationType diff --git a/packages/megalodon/src/pleroma/web_socket.ts b/packages/megalodon/src/pleroma/web_socket.ts new file mode 100644 index 000000000..f96ea5dc5 --- /dev/null +++ b/packages/megalodon/src/pleroma/web_socket.ts @@ -0,0 +1,349 @@ +import WS from 'ws' +import dayjs, { Dayjs } from 'dayjs' +import { EventEmitter } from 'events' + +import proxyAgent, { ProxyConfig } from '../proxy_config' +import { WebSocketInterface } from '../megalodon' +import PleromaAPI from './api_client' +import { UnknownNotificationTypeError } from '../notification' + +/** + * WebSocket + * Pleroma is not support streaming. It is support websocket instead of streaming. + * So this class connect to Phoenix websocket for Pleroma. + */ +export default class WebSocket extends EventEmitter implements WebSocketInterface { + public url: string + public stream: string + public params: string | null + public parser: Parser + public headers: { [key: string]: string } + public proxyConfig: ProxyConfig | false = false + private _accessToken: string + private _reconnectInterval: number + private _reconnectMaxAttempts: number + private _reconnectCurrentAttempts: number + private _connectionClosed: boolean + private _client: WS | null + private _pongReceivedTimestamp: Dayjs + private _heartbeatInterval: number = 60000 + private _pongWaiting: boolean = false + + /** + * @param url Full url of websocket: e.g. https://pleroma.io/api/v1/streaming + * @param stream Stream name, please refer: https://git.pleroma.social/pleroma/pleroma/blob/develop/lib/pleroma/web/mastodon_api/mastodon_socket.ex#L19-28 + * @param accessToken The access token. + * @param userAgent The specified User Agent. + * @param proxyConfig Proxy setting, or set false if don't use proxy. + */ + constructor( + url: string, + stream: string, + params: string | undefined, + accessToken: string, + userAgent: string, + proxyConfig: ProxyConfig | false = false + ) { + super() + this.url = url + this.stream = stream + if (params === undefined) { + this.params = null + } else { + this.params = params + } + this.parser = new Parser() + this.headers = { + 'User-Agent': userAgent + } + this.proxyConfig = proxyConfig + this._accessToken = accessToken + this._reconnectInterval = 10000 + this._reconnectMaxAttempts = Infinity + this._reconnectCurrentAttempts = 0 + this._connectionClosed = false + this._client = null + this._pongReceivedTimestamp = dayjs() + } + + /** + * Start websocket connection. + */ + public start() { + this._connectionClosed = false + this._resetRetryParams() + this._startWebSocketConnection() + } + + /** + * Reset connection and start new websocket connection. + */ + private _startWebSocketConnection() { + this._resetConnection() + this._setupParser() + this._client = this._connect(this.url, this.stream, this.params, this._accessToken, this.headers, this.proxyConfig) + this._bindSocket(this._client) + } + + /** + * Stop current connection. + */ + public stop() { + this._connectionClosed = true + this._resetConnection() + this._resetRetryParams() + } + + /** + * Clean up current connection, and listeners. + */ + private _resetConnection() { + if (this._client) { + this._client.close(1000) + this._client.removeAllListeners() + this._client = null + } + + if (this.parser) { + this.parser.removeAllListeners() + } + } + + /** + * Resets the parameters used in reconnect. + */ + private _resetRetryParams() { + this._reconnectCurrentAttempts = 0 + } + + /** + * Reconnects to the same endpoint. + */ + private _reconnect() { + setTimeout(() => { + // Skip reconnect when client is connecting. + // https://github.com/websockets/ws/blob/7.2.1/lib/websocket.js#L365 + if (this._client && this._client.readyState === WS.CONNECTING) { + return + } + + if (this._reconnectCurrentAttempts < this._reconnectMaxAttempts) { + this._reconnectCurrentAttempts++ + this._clearBinding() + if (this._client) { + // In reconnect, we want to close the connection immediately, + // because recoonect is necessary when some problems occur. + this._client.terminate() + } + // Call connect methods + console.log('Reconnecting') + this._client = this._connect(this.url, this.stream, this.params, this._accessToken, this.headers, this.proxyConfig) + this._bindSocket(this._client) + } + }, this._reconnectInterval) + } + + /** + * @param url Base url of streaming endpoint. + * @param stream The specified stream name. + * @param accessToken Access token. + * @param headers The specified headers. + * @param proxyConfig Proxy setting, or set false if don't use proxy. + * @return A WebSocket instance. + */ + private _connect( + url: string, + stream: string, + params: string | null, + accessToken: string, + headers: { [key: string]: string }, + proxyConfig: ProxyConfig | false + ): WS { + const parameter: Array = [`stream=${stream}`] + + if (params) { + parameter.push(params) + } + + if (accessToken !== null) { + parameter.push(`access_token=${accessToken}`) + } + const requestURL: string = `${url}/?${parameter.join('&')}` + let options: WS.ClientOptions = { + headers: headers + } + if (proxyConfig) { + options = Object.assign(options, { + agent: proxyAgent(proxyConfig) + }) + } + + const cli: WS = new WS(requestURL, options) + return cli + } + + /** + * Clear binding event for web socket client. + */ + private _clearBinding() { + if (this._client) { + this._client.removeAllListeners('close') + this._client.removeAllListeners('pong') + this._client.removeAllListeners('open') + this._client.removeAllListeners('message') + this._client.removeAllListeners('error') + } + } + + /** + * Bind event for web socket client. + * @param client A WebSocket instance. + */ + private _bindSocket(client: WS) { + client.on('close', (code: number, _reason: Buffer) => { + // Refer the code: https://tools.ietf.org/html/rfc6455#section-7.4 + if (code === 1000) { + this.emit('close', {}) + } else { + console.log(`Closed connection with ${code}`) + // If already called close method, it does not retry. + if (!this._connectionClosed) { + this._reconnect() + } + } + }) + client.on('pong', () => { + this._pongWaiting = false + this.emit('pong', {}) + this._pongReceivedTimestamp = dayjs() + // It is required to anonymous function since get this scope in checkAlive. + setTimeout(() => this._checkAlive(this._pongReceivedTimestamp), this._heartbeatInterval) + }) + client.on('open', () => { + this.emit('connect', {}) + // Call first ping event. + setTimeout(() => { + client.ping('') + }, 10000) + }) + client.on('message', (data: WS.Data, isBinary: boolean) => { + this.parser.parse(data, isBinary) + }) + client.on('error', (err: Error) => { + this.emit('error', err) + }) + } + + /** + * Set up parser when receive message. + */ + private _setupParser() { + this.parser.on('update', (status: PleromaAPI.Entity.Status) => { + this.emit('update', PleromaAPI.Converter.status(status)) + }) + this.parser.on('notification', (notification: PleromaAPI.Entity.Notification) => { + const n = PleromaAPI.Converter.notification(notification) + if (n instanceof UnknownNotificationTypeError) { + console.warn(`Unknown notification event has received: ${notification}`) + } else { + this.emit('notification', n) + } + }) + this.parser.on('delete', (id: string) => { + this.emit('delete', id) + }) + this.parser.on('conversation', (conversation: PleromaAPI.Entity.Conversation) => { + this.emit('conversation', PleromaAPI.Converter.conversation(conversation)) + }) + this.parser.on('status_update', (status: PleromaAPI.Entity.Status) => { + this.emit('status_update', PleromaAPI.Converter.status(status)) + }) + this.parser.on('error', (err: Error) => { + this.emit('parser-error', err) + }) + this.parser.on('heartbeat', _ => { + this.emit('heartbeat', 'heartbeat') + }) + } + + /** + * Call ping and wait to pong. + */ + private _checkAlive(timestamp: Dayjs) { + const now: Dayjs = dayjs() + // Block multiple calling, if multiple pong event occur. + // It the duration is less than interval, through ping. + if (now.diff(timestamp) > this._heartbeatInterval - 1000 && !this._connectionClosed) { + // Skip ping when client is connecting. + // https://github.com/websockets/ws/blob/7.2.1/lib/websocket.js#L289 + if (this._client && this._client.readyState !== WS.CONNECTING) { + this._pongWaiting = true + this._client.ping('') + setTimeout(() => { + if (this._pongWaiting) { + this._pongWaiting = false + this._reconnect() + } + }, 10000) + } + } + } +} + +/** + * Parser + * This class provides parser for websocket message. + */ +export class Parser extends EventEmitter { + /** + * @param message Message body of websocket. + */ + public parse(data: WS.Data, isBinary: boolean) { + const message = isBinary ? data : data.toString() + if (typeof message !== 'string') { + this.emit('heartbeat', {}) + return + } + + if (message === '') { + this.emit('heartbeat', {}) + return + } + + let event = '' + let payload = '' + let mes = {} + try { + const obj = JSON.parse(message) + event = obj.event + payload = obj.payload + mes = JSON.parse(payload) + } catch (err) { + // delete event does not have json object + if (event !== 'delete') { + this.emit('error', new Error(`Error parsing websocket reply: ${message}, error message: ${err}`)) + return + } + } + + switch (event) { + case 'update': + this.emit('update', mes as PleromaAPI.Entity.Status) + break + case 'notification': + this.emit('notification', mes as PleromaAPI.Entity.Notification) + break + case 'conversation': + this.emit('conversation', mes as PleromaAPI.Entity.Conversation) + break + case 'delete': + this.emit('delete', payload) + break + case 'status.update': + this.emit('status_update', mes as PleromaAPI.Entity.Status) + break + default: + this.emit('error', new Error(`Unknown event has received: ${message}`)) + } + } +} diff --git a/packages/megalodon/src/proxy_config.ts b/packages/megalodon/src/proxy_config.ts index fadbcf084..c9ae01b73 100644 --- a/packages/megalodon/src/proxy_config.ts +++ b/packages/megalodon/src/proxy_config.ts @@ -1,92 +1,50 @@ -import { HttpsProxyAgent, HttpsProxyAgentOptions } from "https-proxy-agent"; -import { SocksProxyAgent, SocksProxyAgentOptions } from "socks-proxy-agent"; +import { HttpsProxyAgent } from 'https-proxy-agent' +import { SocksProxyAgent } from 'socks-proxy-agent' export type ProxyConfig = { - host: string; - port: number; - auth?: { - username: string; - password: string; - }; - protocol: - | "http" - | "https" - | "socks4" - | "socks4a" - | "socks5" - | "socks5h" - | "socks"; -}; + host: string + port: number + auth?: { + username: string + password: string + } + protocol: 'http' | 'https' | 'socks4' | 'socks4a' | 'socks5' | 'socks5h' | 'socks' +} class ProxyProtocolError extends Error {} -const proxyAgent = ( - proxyConfig: ProxyConfig, -): HttpsProxyAgent | SocksProxyAgent => { - switch (proxyConfig.protocol) { - case "http": { - let options: HttpsProxyAgentOptions = { - host: proxyConfig.host, - port: proxyConfig.port, - secureProxy: false, - }; - if (proxyConfig.auth) { - options = Object.assign(options, { - auth: `${proxyConfig.auth.username}:${proxyConfig.auth.password}`, - }); - } - const httpsAgent = new HttpsProxyAgent(options); - return httpsAgent; - } - case "https": { - let options: HttpsProxyAgentOptions = { - host: proxyConfig.host, - port: proxyConfig.port, - secureProxy: true, - }; - if (proxyConfig.auth) { - options = Object.assign(options, { - auth: `${proxyConfig.auth.username}:${proxyConfig.auth.password}`, - }); - } - const httpsAgent = new HttpsProxyAgent(options); - return httpsAgent; - } - case "socks4": - case "socks4a": { - let options: SocksProxyAgentOptions = { - type: 4, - hostname: proxyConfig.host, - port: proxyConfig.port, - }; - if (proxyConfig.auth) { - options = Object.assign(options, { - userId: proxyConfig.auth.username, - password: proxyConfig.auth.password, - }); - } - const socksAgent = new SocksProxyAgent(options); - return socksAgent; - } - case "socks5": - case "socks5h": - case "socks": { - let options: SocksProxyAgentOptions = { - type: 5, - hostname: proxyConfig.host, - port: proxyConfig.port, - }; - if (proxyConfig.auth) { - options = Object.assign(options, { - userId: proxyConfig.auth.username, - password: proxyConfig.auth.password, - }); - } - const socksAgent = new SocksProxyAgent(options); - return socksAgent; - } - default: - throw new ProxyProtocolError("protocol is not accepted"); - } -}; -export default proxyAgent; +const proxyAgent = (proxyConfig: ProxyConfig): HttpsProxyAgent<'http'> | HttpsProxyAgent<'https'> | SocksProxyAgent => { + switch (proxyConfig.protocol) { + case 'http': { + let url = new URL(`http://${proxyConfig.host}:${proxyConfig.port}`) + if (proxyConfig.auth) { + url = new URL(`http://${proxyConfig.auth.username}:${proxyConfig.auth.password}@${proxyConfig.host}:${proxyConfig.port}`) + } + const httpsAgent = new HttpsProxyAgent<'http'>(url) + return httpsAgent + } + case 'https': { + let url = new URL(`https://${proxyConfig.host}:${proxyConfig.port}`) + if (proxyConfig.auth) { + url = new URL(`https://${proxyConfig.auth.username}:${proxyConfig.auth.password}@${proxyConfig.host}:${proxyConfig.port}`) + } + const httpsAgent = new HttpsProxyAgent<'https'>(url) + return httpsAgent + } + case 'socks4': + case 'socks4a': + case 'socks5': + case 'socks5h': + case 'socks': { + let url = `socks://${proxyConfig.host}:${proxyConfig.port}` + if (proxyConfig.auth) { + url = `socks://${proxyConfig.auth.username}:${proxyConfig.auth.password}@${proxyConfig.host}:${proxyConfig.port}` + } + const socksAgent = new SocksProxyAgent(url) + return socksAgent + } + default: + throw new ProxyProtocolError('protocol is not accepted') + } +} +export default proxyAgent diff --git a/packages/megalodon/src/response.ts b/packages/megalodon/src/response.ts index 13fd8ab57..e27596203 100644 --- a/packages/megalodon/src/response.ts +++ b/packages/megalodon/src/response.ts @@ -1,8 +1,8 @@ type Response = { - data: T; - status: number; - statusText: string; - headers: any; -}; + data: T + status: number + statusText: string + headers: any +} -export default Response; +export default Response diff --git a/packages/megalodon/test/integration/cancel.spec.ts b/packages/megalodon/test/integration/cancel.spec.ts new file mode 100644 index 000000000..efc9d4977 --- /dev/null +++ b/packages/megalodon/test/integration/cancel.spec.ts @@ -0,0 +1,38 @@ +import MastodonAPI from '@/mastodon/api_client' +import { Worker } from 'jest-worker' + +jest.mock('axios', () => { + const mockAxios = jest.requireActual('axios') + mockAxios.get = (_path: string) => { + return new Promise(resolve => { + setTimeout(() => { + console.log('hoge') + resolve({ + data: 'hoge', + status: 200, + statusText: '200OK', + headers: [], + config: {} + }) + }, 5000) + }) + } + return mockAxios +}) + +const worker = async (client: MastodonAPI.Client) => { + const w: any = new Worker(require.resolve('./cancelWorker.ts')) + await w.cancel(client) +} + +// Could not use jest-worker under typescript. +// I'm waiting for resolve this issue. +// https://github.com/facebook/jest/issues/8872 +describe.skip('cancel', () => { + const client = new MastodonAPI.Client('testToken', 'https://pleroma.io/api/v1') + it('should be raised', async () => { + const getPromise = client.get<{}>('/timelines/home') + worker(client) + await expect(getPromise).rejects.toThrow() + }) +}) diff --git a/packages/megalodon/test/integration/cancelWorker.ts b/packages/megalodon/test/integration/cancelWorker.ts new file mode 100644 index 000000000..17a072278 --- /dev/null +++ b/packages/megalodon/test/integration/cancelWorker.ts @@ -0,0 +1,5 @@ +import MastodonAPI from '@/mastodon/api_client' + +export function cancel(client: MastodonAPI.Client) { + return client.cancel() +} diff --git a/packages/megalodon/test/integration/detector.spec.ts b/packages/megalodon/test/integration/detector.spec.ts new file mode 100644 index 000000000..86c32622e --- /dev/null +++ b/packages/megalodon/test/integration/detector.spec.ts @@ -0,0 +1,67 @@ +import { detector } from '../../src/index' + +describe('detector', () => { + describe('mastodon', () => { + const url = 'https://mastodon.social' + it('should be mastodon', async () => { + const mastodon = await detector(url) + expect(mastodon).toEqual('mastodon') + }) + }) + + describe('pleroma', () => { + const url = 'https://pleroma.io' + it('should be pleroma', async () => { + const pleroma = await detector(url) + expect(pleroma).toEqual('pleroma') + }) + }) + + describe('misskey', () => { + const url = 'https://misskey.io' + it('should be misskey', async () => { + const misskey = await detector(url) + expect(misskey).toEqual('misskey') + }) + }) + + describe('fedibird', () => { + const url = 'https://fedibird.com' + it('should be mastodon', async () => { + const fedibird = await detector(url) + expect(fedibird).toEqual('mastodon') + }, 20000) + }) + + describe('friendica', () => { + const url = 'https://squeet.me' + it('should be friendica', async () => { + const friendica = await detector(url) + expect(friendica).toEqual('friendica') + }) + }) + + describe('akkoma', () => { + const url = 'https://pleroma.noellabo.jp' + it('should be akkoma', async () => { + const akkoma = await detector(url) + expect(akkoma).toEqual('pleroma') + }) + }) + + describe('wildebeest', () => { + const url = 'https://wildebeest.mirror-kt.dev' + it('should be mastodon', async () => { + const wildebeest = await detector(url) + expect(wildebeest).toEqual('mastodon') + }) + }) + + describe('unknown', () => { + const url = 'https://google.com' + it('should be null', async () => { + const unknown = detector(url) + await expect(unknown).rejects.toThrow() + }) + }) +}) diff --git a/packages/megalodon/test/integration/mastodon.spec.ts b/packages/megalodon/test/integration/mastodon.spec.ts new file mode 100644 index 000000000..172d11a86 --- /dev/null +++ b/packages/megalodon/test/integration/mastodon.spec.ts @@ -0,0 +1,218 @@ +import MastodonEntity from '@/mastodon/entity' +import MastodonNotificationType from '@/mastodon/notification' +import Mastodon from '@/mastodon' +import MegalodonNotificationType from '@/notification' +import axios, { AxiosResponse, InternalAxiosRequestConfig, AxiosHeaders } from 'axios' + +jest.mock('axios') + +const account: MastodonEntity.Account = { + id: '1', + username: 'h3poteto', + acct: 'h3poteto@pleroma.io', + display_name: 'h3poteto', + locked: false, + group: false, + noindex: false, + suspended: false, + limited: false, + created_at: '2019-03-26T21:30:32', + followers_count: 10, + following_count: 10, + statuses_count: 100, + note: 'engineer', + url: 'https://pleroma.io', + avatar: '', + avatar_static: '', + header: '', + header_static: '', + emojis: [], + moved: null, + fields: [], + bot: false, + source: { + privacy: null, + sensitive: false, + language: null, + note: 'test', + fields: [] + } +} + +const status: MastodonEntity.Status = { + id: '1', + uri: 'http://example.com', + url: 'http://example.com', + account: account, + in_reply_to_id: null, + in_reply_to_account_id: null, + reblog: null, + content: 'hoge', + created_at: '2019-03-26T21:40:32', + emojis: [], + replies_count: 0, + reblogs_count: 0, + favourites_count: 0, + reblogged: null, + favourited: null, + muted: null, + sensitive: false, + spoiler_text: '', + visibility: 'public', + media_attachments: [], + mentions: [], + tags: [], + card: null, + poll: null, + application: { + name: 'Web' + } as MastodonEntity.Application, + language: null, + pinned: null, + bookmarked: false +} + +const follow: MastodonEntity.Notification = { + account: account, + created_at: '2021-01-31T23:33:26', + id: '1', + type: MastodonNotificationType.Follow +} + +const favourite: MastodonEntity.Notification = { + account: account, + created_at: '2021-01-31T23:33:26', + id: '2', + status: status, + type: MastodonNotificationType.Favourite +} + +const mention: MastodonEntity.Notification = { + account: account, + created_at: '2021-01-31T23:33:26', + id: '3', + status: status, + type: MastodonNotificationType.Mention +} + +const reblog: MastodonEntity.Notification = { + account: account, + created_at: '2021-01-31T23:33:26', + id: '4', + status: status, + type: MastodonNotificationType.Reblog +} + +const poll: MastodonEntity.Notification = { + account: account, + created_at: '2021-01-31T23:33:26', + id: '5', + type: MastodonNotificationType.Poll +} + +const followRequest: MastodonEntity.Notification = { + account: account, + created_at: '2021-01-31T23:33:26', + id: '6', + type: MastodonNotificationType.FollowRequest +} + +const toot: MastodonEntity.Notification = { + account: account, + created_at: '2021-01-31T23:33:26', + id: '7', + status: status, + type: MastodonNotificationType.Status +} + +const unknownEvent: MastodonEntity.Notification = { + account: account, + created_at: '2021-01-31T23:33:26', + id: '8', + type: 'unknown' +} + +;(axios.CancelToken.source as any).mockImplementation(() => { + return { + token: { + throwIfRequested: () => {}, + promise: { + then: () => {}, + catch: () => {} + } + } + } +}) + +describe('getNotifications', () => { + const client = new Mastodon('http://localhost', 'sample token') + const cases: Array<{ event: MastodonEntity.Notification; expected: Entity.NotificationType; title: string }> = [ + { + event: follow, + expected: MegalodonNotificationType.Follow, + title: 'follow' + }, + { + event: favourite, + expected: MegalodonNotificationType.Favourite, + title: 'favourite' + }, + { + event: mention, + expected: MegalodonNotificationType.Mention, + title: 'mention' + }, + { + event: reblog, + expected: MegalodonNotificationType.Reblog, + title: 'reblog' + }, + { + event: poll, + expected: MegalodonNotificationType.PollExpired, + title: 'poll' + }, + { + event: followRequest, + expected: MegalodonNotificationType.FollowRequest, + title: 'followRequest' + }, + { + event: toot, + expected: MegalodonNotificationType.Status, + title: 'status' + } + ] + cases.forEach(c => { + it(`should be ${c.title} event`, async () => { + const config: InternalAxiosRequestConfig = { + headers: new AxiosHeaders() + } + const mockResponse: AxiosResponse> = { + data: [c.event], + status: 200, + statusText: '200OK', + headers: {}, + config: config + } + ;(axios.get as any).mockResolvedValue(mockResponse) + const res = await client.getNotifications() + expect(res.data[0].type).toEqual(c.expected) + }) + }) + it('UnknownEvent should be ignored', async () => { + const config: InternalAxiosRequestConfig = { + headers: new AxiosHeaders() + } + const mockResponse: AxiosResponse> = { + data: [unknownEvent], + status: 200, + statusText: '200OK', + headers: {}, + config: config + } + ;(axios.get as any).mockResolvedValue(mockResponse) + const res = await client.getNotifications() + expect(res.data).toEqual([]) + }) +}) diff --git a/packages/megalodon/test/integration/mastodon/api_client.spec.ts b/packages/megalodon/test/integration/mastodon/api_client.spec.ts new file mode 100644 index 000000000..950105152 --- /dev/null +++ b/packages/megalodon/test/integration/mastodon/api_client.spec.ts @@ -0,0 +1,176 @@ +import MastodonAPI from '@/mastodon/api_client' +import Entity from '@/entity' +import Response from '@/response' +import axios, { AxiosResponse, InternalAxiosRequestConfig, AxiosHeaders } from 'axios' + +jest.mock('axios') + +const account: Entity.Account = { + id: '1', + username: 'h3poteto', + acct: 'h3poteto@pleroma.io', + display_name: 'h3poteto', + locked: false, + group: false, + noindex: false, + suspended: false, + limited: false, + created_at: '2019-03-26T21:30:32', + followers_count: 10, + following_count: 10, + statuses_count: 100, + note: 'engineer', + url: 'https://pleroma.io', + avatar: '', + avatar_static: '', + header: '', + header_static: '', + emojis: [], + moved: null, + fields: [], + bot: false, + source: { + privacy: null, + sensitive: false, + language: null, + note: 'test', + fields: [] + } +} + +const status: Entity.Status = { + id: '1', + uri: 'http://example.com', + url: 'http://example.com', + account: account, + in_reply_to_id: null, + in_reply_to_account_id: null, + reblog: null, + content: 'hoge', + plain_content: null, + created_at: '2019-03-26T21:40:32', + emojis: [], + replies_count: 0, + reblogs_count: 0, + favourites_count: 0, + reblogged: null, + favourited: null, + muted: null, + sensitive: false, + spoiler_text: '', + visibility: 'public', + media_attachments: [], + mentions: [], + tags: [], + card: null, + poll: null, + application: { + name: 'Web' + } as Entity.Application, + language: null, + pinned: null, + emoji_reactions: [], + bookmarked: false, + quote: false +} +;(axios.CancelToken.source as any).mockImplementation(() => { + return { + token: { + throwIfRequested: () => {}, + promise: { + then: () => {}, + catch: () => {} + } + } + } +}) + +const config: InternalAxiosRequestConfig = { + headers: new AxiosHeaders() +} + +describe('get', () => { + const client = new MastodonAPI.Client('testToken', 'https://pleroma.io/api/v1') + const mockResponse: AxiosResponse> = { + data: [status], + status: 200, + statusText: '200OK', + headers: {}, + config: config + } + it('should be responsed', async () => { + ;(axios.get as any).mockResolvedValue(mockResponse) + const response: Response> = await client.get>('/timelines/home') + expect(response.data).toEqual([status]) + }) +}) + +describe('put', () => { + const client = new MastodonAPI.Client('testToken', 'https://pleroma.io/api/v1') + const mockResponse: AxiosResponse = { + data: account, + status: 200, + statusText: '200OK', + headers: {}, + config: config + } + it('should be responsed', async () => { + ;(axios.put as any).mockResolvedValue(mockResponse) + const response: Response = await client.put('/accounts/update_credentials', { + display_name: 'hoge' + }) + expect(response.data).toEqual(account) + }) +}) + +describe('patch', () => { + const client = new MastodonAPI.Client('testToken', 'https://pleroma.io/api/v1') + const mockResponse: AxiosResponse = { + data: account, + status: 200, + statusText: '200OK', + headers: {}, + config: config + } + it('should be responsed', async () => { + ;(axios.patch as any).mockResolvedValue(mockResponse) + const response: Response = await client.patch('/accounts/update_credentials', { + display_name: 'hoge' + }) + expect(response.data).toEqual(account) + }) +}) + +describe('post', () => { + const client = new MastodonAPI.Client('testToken', 'https://pleroma.io/api/v1') + const mockResponse: AxiosResponse = { + data: status, + status: 200, + statusText: '200OK', + headers: {}, + config: config + } + it('should be responsed', async () => { + ;(axios.post as any).mockResolvedValue(mockResponse) + const response: Response = await client.post('/statuses', { + status: 'hoge' + }) + expect(response.data).toEqual(status) + }) +}) + +describe('del', () => { + const client = new MastodonAPI.Client('testToken', 'https://pleroma.io/api/v1') + const mockResponse: AxiosResponse<{}> = { + data: {}, + status: 200, + statusText: '200OK', + headers: {}, + config: config + } + it('should be responsed', async () => { + ;(axios.delete as any).mockResolvedValue(mockResponse) + const response: Response<{}> = await client.del<{}>('/statuses/12asdf34') + expect(response.data).toEqual({}) + }) +}) diff --git a/packages/megalodon/test/integration/megalodon.spec.ts b/packages/megalodon/test/integration/megalodon.spec.ts deleted file mode 100644 index 896453550..000000000 --- a/packages/megalodon/test/integration/megalodon.spec.ts +++ /dev/null @@ -1,27 +0,0 @@ -import { detector } from '../../src/index' - -describe('detector', () => { - describe('mastodon', () => { - const url = 'https://fedibird.com' - it('should be mastodon', async () => { - const mastodon = await detector(url) - expect(mastodon).toEqual('mastodon') - }) - }) - - describe('pleroma', () => { - const url = 'https://pleroma.soykaf.com' - it('should be pleroma', async () => { - const pleroma = await detector(url) - expect(pleroma).toEqual('pleroma') - }) - }) - - describe('misskey', () => { - const url = 'https://misskey.io' - it('should be misskey', async () => { - const misskey = await detector(url) - expect(misskey).toEqual('misskey') - }) - }) -}) diff --git a/packages/megalodon/test/integration/misskey.spec.ts b/packages/megalodon/test/integration/misskey.spec.ts index 0ec128842..ed3b9a40f 100644 --- a/packages/megalodon/test/integration/misskey.spec.ts +++ b/packages/megalodon/test/integration/misskey.spec.ts @@ -2,7 +2,7 @@ import MisskeyEntity from '@/misskey/entity' import MisskeyNotificationType from '@/misskey/notification' import Misskey from '@/misskey' import MegalodonNotificationType from '@/notification' -import axios, { AxiosResponse } from 'axios' +import axios, { AxiosHeaders, AxiosResponse, InternalAxiosRequestConfig } from 'axios' jest.mock('axios') @@ -27,6 +27,7 @@ const note: MisskeyEntity.Note = { renoteCount: 0, repliesCount: 0, reactions: {}, + reactionEmojis: {}, emojis: [], fileIds: [], files: [], @@ -93,7 +94,7 @@ const pollVote: MisskeyEntity.Notification = { createdAt: '2021-02-01T01:49:29', userId: user.id, user: user, - type: MisskeyNotificationType.PollEnded, + type: MisskeyNotificationType.PollVote, note: note } @@ -163,12 +164,12 @@ describe('getNotifications', () => { }, { event: reaction, - expected: MegalodonNotificationType.Reaction, + expected: MegalodonNotificationType.EmojiReaction, title: 'reaction' }, { event: pollVote, - expected: MegalodonNotificationType.Poll, + expected: MegalodonNotificationType.PollVote, title: 'pollVote' }, { @@ -180,25 +181,38 @@ describe('getNotifications', () => { event: followRequestAccepted, expected: MegalodonNotificationType.Follow, title: 'followRequestAccepted' - }, - { - event: groupInvited, - expected: MisskeyNotificationType.GroupInvited, - title: 'groupInvited' } ] cases.forEach(c => { it(`should be ${c.title} event`, async () => { + const config: InternalAxiosRequestConfig = { + headers: new AxiosHeaders() + } const mockResponse: AxiosResponse> = { data: [c.event], status: 200, statusText: '200OK', headers: {}, - config: {} + config: config } ;(axios.post as any).mockResolvedValue(mockResponse) const res = await client.getNotifications() expect(res.data[0].type).toEqual(c.expected) }) }) + it('groupInvited event should be ignored', async () => { + const config: InternalAxiosRequestConfig = { + headers: new AxiosHeaders() + } + const mockResponse: AxiosResponse> = { + data: [groupInvited], + status: 200, + statusText: '200OK', + headers: {}, + config: config + } + ;(axios.post as any).mockResolvedValue(mockResponse) + const res = await client.getNotifications() + expect(res.data).toEqual([]) + }) }) diff --git a/packages/megalodon/test/integration/pleroma.spec.ts b/packages/megalodon/test/integration/pleroma.spec.ts new file mode 100644 index 000000000..1e1f449e1 --- /dev/null +++ b/packages/megalodon/test/integration/pleroma.spec.ts @@ -0,0 +1,222 @@ +import PleromaEntity from '@/pleroma/entity' +import Pleroma from '@/pleroma' +import MegalodonNotificationType from '@/notification' +import PleromaNotificationType from '@/pleroma/notification' +import axios, { AxiosResponse, InternalAxiosRequestConfig, AxiosHeaders } from 'axios' + +jest.mock('axios') + +const account: PleromaEntity.Account = { + id: '1', + username: 'h3poteto', + acct: 'h3poteto@pleroma.io', + display_name: 'h3poteto', + locked: false, + noindex: null, + suspended: null, + limited: null, + created_at: '2019-03-26T21:30:32', + followers_count: 10, + following_count: 10, + statuses_count: 100, + note: 'engineer', + url: 'https://pleroma.io', + avatar: '', + avatar_static: '', + header: '', + header_static: '', + emojis: [], + moved: null, + fields: [], + bot: false, + source: { + privacy: null, + sensitive: false, + language: null, + note: 'test', + fields: [] + } +} + +const status: PleromaEntity.Status = { + id: '1', + uri: 'http://example.com', + url: 'http://example.com', + account: account, + in_reply_to_id: null, + in_reply_to_account_id: null, + reblog: null, + content: 'hoge', + created_at: '2019-03-26T21:40:32', + emojis: [], + replies_count: 0, + reblogs_count: 0, + favourites_count: 0, + reblogged: null, + favourited: null, + muted: null, + sensitive: false, + spoiler_text: '', + visibility: 'public', + media_attachments: [], + mentions: [], + tags: [], + card: null, + poll: null, + application: { + name: 'Web' + } as MastodonEntity.Application, + language: null, + pinned: null, + bookmarked: false, + pleroma: { + local: false + } +} + +const follow: PleromaEntity.Notification = { + account: account, + created_at: '2021-01-31T23:33:26', + id: '1', + type: PleromaNotificationType.Follow +} + +const favourite: PleromaEntity.Notification = { + account: account, + created_at: '2021-01-31T23:33:26', + id: '2', + type: PleromaNotificationType.Favourite, + status: status +} + +const mention: PleromaEntity.Notification = { + account: account, + created_at: '2021-01-31T23:33:26', + id: '3', + type: PleromaNotificationType.Mention, + status: status +} + +const reblog: PleromaEntity.Notification = { + account: account, + created_at: '2021-01-31T23:33:26', + id: '4', + type: PleromaNotificationType.Reblog, + status: status +} + +const poll: PleromaEntity.Notification = { + account: account, + created_at: '2021-01-31T23:33:26', + id: '5', + type: PleromaNotificationType.Poll, + status: status +} + +const emojiReaction: PleromaEntity.Notification = { + account: account, + created_at: '2021-01-31T23:33:26', + id: '6', + type: PleromaNotificationType.PleromaEmojiReaction, + status: status, + emoji: '♥' +} + +const unknownEvent: PleromaEntity.Notification = { + account: account, + created_at: '2021-01-31T23:33:26', + id: '8', + type: 'unknown' +} + +const followRequest: PleromaEntity.Notification = { + account: account, + created_at: '2021-01-31T23:33:26', + id: '7', + type: PleromaNotificationType.FollowRequest +} + +;(axios.CancelToken.source as any).mockImplementation(() => { + return { + token: { + throwIfRequested: () => {}, + promise: { + then: () => {}, + catch: () => {} + } + } + } +}) + +describe('getNotifications', () => { + const client = new Pleroma('http://localhost', 'sample token') + const cases: Array<{ event: PleromaEntity.Notification; expected: Entity.NotificationType; title: string }> = [ + { + event: follow, + expected: MegalodonNotificationType.Follow, + title: 'follow' + }, + { + event: favourite, + expected: MegalodonNotificationType.Favourite, + title: 'favourite' + }, + { + event: mention, + expected: MegalodonNotificationType.Mention, + title: 'mention' + }, + { + event: reblog, + expected: MegalodonNotificationType.Reblog, + title: 'reblog' + }, + { + event: poll, + expected: MegalodonNotificationType.PollExpired, + title: 'poll' + }, + { + event: emojiReaction, + expected: MegalodonNotificationType.EmojiReaction, + title: 'emojiReaction' + }, + { + event: followRequest, + expected: MegalodonNotificationType.FollowRequest, + title: 'followRequest' + } + ] + cases.forEach(c => { + it(`should be ${c.title} event`, async () => { + const config: InternalAxiosRequestConfig = { + headers: new AxiosHeaders() + } + const mockResponse: AxiosResponse> = { + data: [c.event], + status: 200, + statusText: '200OK', + headers: {}, + config: config + } + ;(axios.get as any).mockResolvedValue(mockResponse) + const res = await client.getNotifications() + expect(res.data[0].type).toEqual(c.expected) + }) + }) + it('UnknownEvent should be ignored', async () => { + const config: InternalAxiosRequestConfig = { + headers: new AxiosHeaders() + } + const mockResponse: AxiosResponse> = { + data: [unknownEvent], + status: 200, + statusText: '200OK', + headers: {}, + config: config + } + ;(axios.get as any).mockResolvedValue(mockResponse) + const res = await client.getNotifications() + expect(res.data).toEqual([]) + }) +}) diff --git a/packages/megalodon/test/unit/mastodon.spec.ts b/packages/megalodon/test/unit/mastodon.spec.ts new file mode 100644 index 000000000..311f60d12 --- /dev/null +++ b/packages/megalodon/test/unit/mastodon.spec.ts @@ -0,0 +1,6 @@ +describe('test', () => { + it('should be true', () => { + const res = true + expect(res).toEqual(true) + }) +}) diff --git a/packages/megalodon/test/unit/mastodon/api_client.spec.ts b/packages/megalodon/test/unit/mastodon/api_client.spec.ts new file mode 100644 index 000000000..1e3c6b523 --- /dev/null +++ b/packages/megalodon/test/unit/mastodon/api_client.spec.ts @@ -0,0 +1,80 @@ +import MastodonAPI from '@/mastodon/api_client' +import MegalodonEntity from '@/entity' +import MastodonEntity from '@/mastodon/entity' +import MegalodonNotificationType from '@/notification' +import MastodonNotificationType from '@/mastodon/notification' + +describe('api_client', () => { + describe('notification', () => { + describe('encode', () => { + it('megalodon notification type should be encoded to mastodon notification type', () => { + const cases: Array<{ src: MegalodonEntity.NotificationType; dist: MastodonEntity.NotificationType }> = [ + { + src: MegalodonNotificationType.Follow, + dist: MastodonNotificationType.Follow + }, + { + src: MegalodonNotificationType.Favourite, + dist: MastodonNotificationType.Favourite + }, + { + src: MegalodonNotificationType.Reblog, + dist: MastodonNotificationType.Reblog + }, + { + src: MegalodonNotificationType.Mention, + dist: MastodonNotificationType.Mention + }, + { + src: MegalodonNotificationType.PollExpired, + dist: MastodonNotificationType.Poll + }, + { + src: MegalodonNotificationType.FollowRequest, + dist: MastodonNotificationType.FollowRequest + }, + { + src: MegalodonNotificationType.Status, + dist: MastodonNotificationType.Status + } + ] + cases.forEach(c => { + expect(MastodonAPI.Converter.encodeNotificationType(c.src)).toEqual(c.dist) + }) + }) + }) + describe('decode', () => { + it('mastodon notification type should be decoded to megalodon notification type', () => { + const cases: Array<{ src: MastodonEntity.NotificationType; dist: MegalodonEntity.NotificationType }> = [ + { + src: MastodonNotificationType.Follow, + dist: MegalodonNotificationType.Follow + }, + { + src: MastodonNotificationType.Favourite, + dist: MegalodonNotificationType.Favourite + }, + { + src: MastodonNotificationType.Mention, + dist: MegalodonNotificationType.Mention + }, + { + src: MastodonNotificationType.Reblog, + dist: MegalodonNotificationType.Reblog + }, + { + src: MastodonNotificationType.Poll, + dist: MegalodonNotificationType.PollExpired + }, + { + src: MastodonNotificationType.FollowRequest, + dist: MegalodonNotificationType.FollowRequest + } + ] + cases.forEach(c => { + expect(MastodonAPI.Converter.decodeNotificationType(c.src)).toEqual(c.dist) + }) + }) + }) + }) +}) diff --git a/packages/megalodon/test/unit/misskey/api_client.spec.ts b/packages/megalodon/test/unit/misskey/api_client.spec.ts index 7cf33b983..38039385c 100644 --- a/packages/megalodon/test/unit/misskey/api_client.spec.ts +++ b/packages/megalodon/test/unit/misskey/api_client.spec.ts @@ -14,8 +14,6 @@ const user: MisskeyEntity.User = { emojis: [] } -const converter: MisskeyAPI.Converter = new MisskeyAPI.Converter("https://example.com") - describe('api_client', () => { describe('notification', () => { describe('encode', () => { @@ -34,7 +32,7 @@ describe('api_client', () => { dist: MisskeyNotificationType.Reaction }, { - src: MegalodonNotificationType.Reaction, + src: MegalodonNotificationType.EmojiReaction, dist: MisskeyNotificationType.Reaction }, { @@ -42,8 +40,8 @@ describe('api_client', () => { dist: MisskeyNotificationType.Renote }, { - src: MegalodonNotificationType.Poll, - dist: MisskeyNotificationType.PollEnded + src: MegalodonNotificationType.PollVote, + dist: MisskeyNotificationType.PollVote }, { src: MegalodonNotificationType.FollowRequest, @@ -51,7 +49,7 @@ describe('api_client', () => { } ] cases.forEach(c => { - expect(converter.encodeNotificationType(c.src)).toEqual(c.dist) + expect(MisskeyAPI.Converter.encodeNotificationType(c.src)).toEqual(c.dist) }) }) }) @@ -80,11 +78,11 @@ describe('api_client', () => { }, { src: MisskeyNotificationType.Reaction, - dist: MegalodonNotificationType.Reaction + dist: MegalodonNotificationType.EmojiReaction }, { - src: MisskeyNotificationType.PollEnded, - dist: MegalodonNotificationType.Poll + src: MisskeyNotificationType.PollVote, + dist: MegalodonNotificationType.PollVote }, { src: MisskeyNotificationType.ReceiveFollowRequest, @@ -96,7 +94,7 @@ describe('api_client', () => { } ] cases.forEach(c => { - expect(converter.decodeNotificationType(c.src)).toEqual(c.dist) + expect(MisskeyAPI.Converter.decodeNotificationType(c.src)).toEqual(c.dist) }) }) }) @@ -162,7 +160,7 @@ describe('api_client', () => { } ] - const reactions = converter.reactions(misskeyReactions) + const reactions = MisskeyAPI.Converter.reactions(misskeyReactions) expect(reactions).toEqual([ { count: 3, @@ -194,13 +192,14 @@ describe('api_client', () => { renoteCount: 0, repliesCount: 0, reactions: {}, + reactionEmojis: {}, emojis: [], fileIds: [], files: [], replyId: null, renoteId: null } - const megalodonStatus = converter.note(note, user.host || 'misskey.io') + const megalodonStatus = MisskeyAPI.Converter.note(note) expect(megalodonStatus.plain_content).toEqual(plainContent) expect(megalodonStatus.content).toEqual(content) }) @@ -218,16 +217,161 @@ describe('api_client', () => { renoteCount: 0, repliesCount: 0, reactions: {}, + reactionEmojis: {}, emojis: [], fileIds: [], files: [], replyId: null, renoteId: null } - const megalodonStatus = converter.note(note, user.host || 'misskey.io') + const megalodonStatus = MisskeyAPI.Converter.note(note) expect(megalodonStatus.plain_content).toEqual(plainContent) expect(megalodonStatus.content).toEqual(content) }) }) + describe('emoji reaction', () => { + it('reactionEmojis should be parsed', () => { + const plainContent = 'hoge\nfuga\nfuga' + const note: MisskeyEntity.Note = { + id: '1', + createdAt: '2021-02-01T01:49:29', + userId: '1', + user: user, + text: plainContent, + cw: null, + visibility: 'public', + renoteCount: 0, + repliesCount: 0, + reactions: { + ':example1@.:': 1, + ':example2@example.com:': 2 + }, + reactionEmojis: { + 'example2@example.com': 'https://example.com/emoji.png' + }, + emojis: [], + fileIds: [], + files: [], + replyId: null, + renoteId: null + } + const megalodonStatus = MisskeyAPI.Converter.note(note) + expect(megalodonStatus.emojis).toEqual([ + { + shortcode: 'example2@example.com', + static_url: 'https://example.com/emoji.png', + url: 'https://example.com/emoji.png', + visible_in_picker: true, + category: '' + } + ]) + expect(megalodonStatus.emoji_reactions).toEqual([ + { + count: 1, + me: false, + name: ':example1@.:' + }, + { + count: 2, + me: false, + name: ':example2@example.com:' + } + ]) + }) + }) + describe('emoji', () => { + it('emojis in array format should be parsed', () => { + const plainContent = 'hoge\nfuga\nfuga' + const note: MisskeyEntity.Note = { + id: '1', + createdAt: '2021-02-01T01:49:29', + userId: '1', + user: user, + text: plainContent, + cw: null, + visibility: 'public', + renoteCount: 0, + repliesCount: 0, + reactions: {}, + reactionEmojis: {}, + emojis: [ + { + aliases: [], + name: ':example1:', + url: 'https://example.com/emoji1.png', + category: '', + }, + { + aliases: [], + name: ':example2:', + url: 'https://example.com/emoji2.png', + category: '', + }, + ], + fileIds: [], + files: [], + replyId: null, + renoteId: null + } + const megalodonStatus = MisskeyAPI.Converter.note(note) + expect(megalodonStatus.emojis).toEqual([ + { + shortcode: ':example1:', + static_url: 'https://example.com/emoji1.png', + url: 'https://example.com/emoji1.png', + visible_in_picker: true, + category: '' + }, + { + shortcode: ':example2:', + static_url: 'https://example.com/emoji2.png', + url: 'https://example.com/emoji2.png', + visible_in_picker: true, + category: '' + } + ]) + }) + it('emojis in object format should be parsed', () => { + const plainContent = 'hoge\nfuga\nfuga' + const note: MisskeyEntity.Note = { + id: '1', + createdAt: '2021-02-01T01:49:29', + userId: '1', + user: user, + text: plainContent, + cw: null, + visibility: 'public', + renoteCount: 0, + repliesCount: 0, + reactions: {}, + reactionEmojis: {}, + emojis: { + ':example1:': 'https://example.com/emoji1.png', + ':example2:': 'https://example.com/emoji2.png', + }, + fileIds: [], + files: [], + replyId: null, + renoteId: null + } + const megalodonStatus = MisskeyAPI.Converter.note(note) + expect(megalodonStatus.emojis).toEqual([ + { + shortcode: ':example1:', + static_url: 'https://example.com/emoji1.png', + url: 'https://example.com/emoji1.png', + visible_in_picker: true, + category: '' + }, + { + shortcode: ':example2:', + static_url: 'https://example.com/emoji2.png', + url: 'https://example.com/emoji2.png', + visible_in_picker: true, + category: '' + } + ]) + }) + }) }) }) diff --git a/packages/megalodon/test/unit/parser.spec.ts b/packages/megalodon/test/unit/parser.spec.ts index 5174a647c..94c1d9802 100644 --- a/packages/megalodon/test/unit/parser.spec.ts +++ b/packages/megalodon/test/unit/parser.spec.ts @@ -7,6 +7,10 @@ const account: Entity.Account = { acct: 'h3poteto@pleroma.io', display_name: 'h3poteto', locked: false, + group: false, + noindex: null, + suspended: null, + limited: null, created_at: '2019-03-26T21:30:32', followers_count: 10, following_count: 10, @@ -54,9 +58,9 @@ const status: Entity.Status = { } as Entity.Application, language: null, pinned: null, - reactions: [], + emoji_reactions: [], bookmarked: false, - quote: null + quote: false } const notification: Entity.Notification = { diff --git a/packages/megalodon/test/unit/pleroma/api_client.spec.ts b/packages/megalodon/test/unit/pleroma/api_client.spec.ts new file mode 100644 index 000000000..98c9ec8e4 --- /dev/null +++ b/packages/megalodon/test/unit/pleroma/api_client.spec.ts @@ -0,0 +1,226 @@ +import PleromaAPI from '@/pleroma/api_client' +import MegalodonEntity from '@/entity' +import PleromaEntity from '@/pleroma/entity' +import MegalodonNotificationType from '@/notification' +import PleromaNotificationType from '@/pleroma/notification' + +const account: PleromaEntity.Account = { + id: '1', + username: 'h3poteto', + acct: 'h3poteto@pleroma.io', + display_name: 'h3poteto', + locked: false, + noindex: null, + suspended: null, + limited: null, + created_at: '2019-03-26T21:30:32', + followers_count: 10, + following_count: 10, + statuses_count: 100, + note: 'engineer', + url: 'https://pleroma.io', + avatar: '', + avatar_static: '', + header: '', + header_static: '', + emojis: [], + moved: null, + fields: [], + bot: false, + source: { + privacy: null, + sensitive: false, + language: null, + note: 'test', + fields: [] + } +} + +describe('api_client', () => { + describe('notification', () => { + describe('encode', () => { + it('megalodon notification type should be encoded to pleroma notification type', () => { + const cases: Array<{ src: MegalodonEntity.NotificationType; dist: PleromaEntity.NotificationType }> = [ + { + src: MegalodonNotificationType.Follow, + dist: PleromaNotificationType.Follow + }, + { + src: MegalodonNotificationType.Favourite, + dist: PleromaNotificationType.Favourite + }, + { + src: MegalodonNotificationType.Reblog, + dist: PleromaNotificationType.Reblog + }, + { + src: MegalodonNotificationType.Mention, + dist: PleromaNotificationType.Mention + }, + { + src: MegalodonNotificationType.PollExpired, + dist: PleromaNotificationType.Poll + }, + { + src: MegalodonNotificationType.EmojiReaction, + dist: PleromaNotificationType.PleromaEmojiReaction + }, + { + src: MegalodonNotificationType.FollowRequest, + dist: PleromaNotificationType.FollowRequest + }, + { + src: MegalodonNotificationType.Update, + dist: PleromaNotificationType.Update + }, + { + src: MegalodonNotificationType.Move, + dist: PleromaNotificationType.Move + } + ] + cases.forEach(c => { + expect(PleromaAPI.Converter.encodeNotificationType(c.src)).toEqual(c.dist) + }) + }) + }) + describe('decode', () => { + it('pleroma notification type should be decoded to megalodon notification type', () => { + const cases: Array<{ src: PleromaEntity.NotificationType; dist: MegalodonEntity.NotificationType }> = [ + { + src: PleromaNotificationType.Follow, + dist: MegalodonNotificationType.Follow + }, + { + src: PleromaNotificationType.Favourite, + dist: MegalodonNotificationType.Favourite + }, + { + src: PleromaNotificationType.Mention, + dist: MegalodonNotificationType.Mention + }, + { + src: PleromaNotificationType.Reblog, + dist: MegalodonNotificationType.Reblog + }, + { + src: PleromaNotificationType.Poll, + dist: MegalodonNotificationType.PollExpired + }, + { + src: PleromaNotificationType.PleromaEmojiReaction, + dist: MegalodonNotificationType.EmojiReaction + }, + { + src: PleromaNotificationType.FollowRequest, + dist: MegalodonNotificationType.FollowRequest + }, + { + src: PleromaNotificationType.Update, + dist: MegalodonNotificationType.Update + }, + { + src: PleromaNotificationType.Move, + dist: MegalodonNotificationType.Move + } + ] + cases.forEach(c => { + expect(PleromaAPI.Converter.decodeNotificationType(c.src)).toEqual(c.dist) + }) + }) + }) + }) + + describe('status', () => { + describe('plain content is included', () => { + it('plain content in pleroma entity should be exported in plain_content column', () => { + const plainContent = 'hoge\nfuga\nfuga' + const content = '

hoge
fuga
fuga

' + const pleromaStatus: PleromaEntity.Status = { + id: '1', + uri: 'https://pleroma.io/notice/1', + url: 'https://pleroma.io/notice/1', + account: account, + in_reply_to_id: null, + in_reply_to_account_id: null, + reblog: null, + content: content, + created_at: '2019-03-26T21:40:32', + emojis: [], + replies_count: 0, + reblogs_count: 0, + favourites_count: 0, + reblogged: null, + favourited: null, + muted: null, + sensitive: false, + spoiler_text: '', + visibility: 'public', + media_attachments: [], + mentions: [], + tags: [], + card: null, + poll: null, + application: { + name: 'Web' + } as MastodonEntity.Application, + language: null, + pinned: null, + bookmarked: false, + pleroma: { + content: { + 'text/plain': plainContent + }, + local: false + } + } + const megalodonStatus = PleromaAPI.Converter.status(pleromaStatus) + expect(megalodonStatus.plain_content).toEqual(plainContent) + expect(megalodonStatus.content).toEqual(content) + }) + }) + + describe('plain content is not included', () => { + it('plain_content should be null', () => { + const content = '

hoge
fuga
fuga

' + const pleromaStatus: PleromaEntity.Status = { + id: '1', + uri: 'https://pleroma.io/notice/1', + url: 'https://pleroma.io/notice/1', + account: account, + in_reply_to_id: null, + in_reply_to_account_id: null, + reblog: null, + content: content, + created_at: '2019-03-26T21:40:32', + emojis: [], + replies_count: 0, + reblogs_count: 0, + favourites_count: 0, + reblogged: null, + favourited: null, + muted: null, + sensitive: false, + spoiler_text: '', + visibility: 'public', + media_attachments: [], + mentions: [], + tags: [], + card: null, + poll: null, + application: { + name: 'Web' + } as MastodonEntity.Application, + language: null, + pinned: null, + bookmarked: false, + pleroma: { + local: false + } + } + const megalodonStatus = PleromaAPI.Converter.status(pleromaStatus) + expect(megalodonStatus.plain_content).toBeNull() + expect(megalodonStatus.content).toEqual(content) + }) + }) + }) +}) diff --git a/packages/megalodon/test/unit/webo_socket.spec.ts b/packages/megalodon/test/unit/webo_socket.spec.ts new file mode 100644 index 000000000..bb9f997a5 --- /dev/null +++ b/packages/megalodon/test/unit/webo_socket.spec.ts @@ -0,0 +1,184 @@ +import { Parser } from '@/mastodon/web_socket' +import Entity from '@/entity' + +const account: Entity.Account = { + id: '1', + username: 'h3poteto', + acct: 'h3poteto@pleroma.io', + display_name: 'h3poteto', + locked: false, + group: false, + noindex: null, + suspended: null, + limited: null, + created_at: '2019-03-26T21:30:32', + followers_count: 10, + following_count: 10, + statuses_count: 100, + note: 'engineer', + url: 'https://pleroma.io', + avatar: '', + avatar_static: '', + header: '', + header_static: '', + emojis: [], + moved: null, + fields: [], + bot: false +} +const status: Entity.Status = { + id: '1', + uri: 'http://example.com', + url: 'http://example.com', + account: account, + in_reply_to_id: null, + in_reply_to_account_id: null, + reblog: null, + content: 'hoge', + plain_content: 'hoge', + created_at: '2019-03-26T21:40:32', + emojis: [], + replies_count: 0, + reblogs_count: 0, + favourites_count: 0, + reblogged: null, + favourited: null, + muted: null, + sensitive: false, + spoiler_text: '', + visibility: 'public', + media_attachments: [], + mentions: [], + tags: [], + card: null, + poll: null, + application: { + name: 'Web' + } as Entity.Application, + language: null, + pinned: null, + emoji_reactions: [], + bookmarked: false, + quote: false +} + +const notification: Entity.Notification = { + id: '1', + account: account, + status: status, + type: 'favourite', + created_at: '2019-04-01T17:01:32' +} + +const conversation: Entity.Conversation = { + id: '1', + accounts: [account], + last_status: status, + unread: true +} + +describe('Parser', () => { + let parser: Parser + + beforeEach(() => { + parser = new Parser() + }) + + describe('parse', () => { + describe('message is heartbeat', () => { + describe('message is an object', () => { + const message = Buffer.alloc(0) + + it('should be called', () => { + const spy = jest.fn() + parser.once('heartbeat', spy) + parser.parse(message, true) + expect(spy).toHaveBeenCalledWith({}) + }) + }) + describe('message is empty string', () => { + const message: string = '' + + it('should be called', () => { + const spy = jest.fn() + parser.once('heartbeat', spy) + parser.parse(Buffer.from(message), false) + expect(spy).toHaveBeenCalledWith({}) + }) + }) + }) + + describe('message is not json', () => { + describe('event is delete', () => { + const message = JSON.stringify({ + event: 'delete', + payload: '12asdf34' + }) + + it('should be called', () => { + const spy = jest.fn() + parser.once('delete', spy) + parser.parse(Buffer.from(message), false) + expect(spy).toHaveBeenCalledWith('12asdf34') + }) + }) + describe('event is not delete', () => { + const message = JSON.stringify({ + event: 'event', + payload: '12asdf34' + }) + + it('should be called', () => { + const error = jest.fn() + const deleted = jest.fn() + parser.once('error', error) + parser.once('delete', deleted) + parser.parse(Buffer.from(message), false) + expect(error).toHaveBeenCalled() + expect(deleted).not.toHaveBeenCalled() + }) + }) + }) + + describe('message is json', () => { + describe('event is update', () => { + const message = JSON.stringify({ + event: 'update', + payload: JSON.stringify(status) + }) + it('should be called', () => { + const spy = jest.fn() + parser.once('update', spy) + parser.parse(Buffer.from(message), false) + expect(spy).toHaveBeenCalledWith(status) + }) + }) + + describe('event is notification', () => { + const message = JSON.stringify({ + event: 'notification', + payload: JSON.stringify(notification) + }) + it('should be called', () => { + const spy = jest.fn() + parser.once('notification', spy) + parser.parse(Buffer.from(message), false) + expect(spy).toHaveBeenCalledWith(notification) + }) + }) + + describe('event is conversation', () => { + const message = JSON.stringify({ + event: 'conversation', + payload: JSON.stringify(conversation) + }) + it('should be called', () => { + const spy = jest.fn() + parser.once('conversation', spy) + parser.parse(Buffer.from(message), false) + expect(spy).toHaveBeenCalledWith(conversation) + }) + }) + }) + }) +}) diff --git a/packages/megalodon/tsconfig.json b/packages/megalodon/tsconfig.json index 5a9bfbde9..7f6943225 100644 --- a/packages/megalodon/tsconfig.json +++ b/packages/megalodon/tsconfig.json @@ -3,7 +3,7 @@ /* Basic Options */ "target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */ "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */ - "lib": ["es2021", "dom"], /* Specify library files to be included in the compilation. */ + "lib": ["es6", "dom"], /* Specify library files to be included in the compilation. */ // "allowJs": true, /* Allow javascript files to be compiled. */ // "checkJs": true, /* Report errors in .js files. */ // "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */ @@ -30,7 +30,7 @@ "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */ /* Additional Checks */ - "noUnusedLocals": false, /* Report errors on unused locals. */ + "noUnusedLocals": true, /* Report errors on unused locals. */ "noUnusedParameters": true, /* Report errors on unused parameters. */ "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */ "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */