From cbae3174b23a0fb6a4328787c1a1ed29eac1425b Mon Sep 17 00:00:00 2001 From: Emotion Date: Wed, 2 Aug 2023 00:58:34 +1200 Subject: [PATCH] Time to add the new API docs --- docs/api/_category_.json | 8 + docs/api/index.md | 12 + docs/api/info.md | 7 + docs/api/valkyrie-js.acct.md | 14 + ...valkyrie-js.api.apiclient._constructor_.md | 24 + .../valkyrie-js.api.apiclient.credential.md | 11 + docs/api/valkyrie-js.api.apiclient.fetch.md | 11 + docs/api/valkyrie-js.api.apiclient.md | 32 + docs/api/valkyrie-js.api.apiclient.origin.md | 11 + docs/api/valkyrie-js.api.apiclient.request.md | 57 + docs/api/valkyrie-js.api.apierror.md | 17 + docs/api/valkyrie-js.api.fetchlike.md | 22 + docs/api/valkyrie-js.api.isapierror.md | 22 + docs/api/valkyrie-js.api.md | 25 + ...yrie-js.channelconnection._constructor_.md | 22 + .../valkyrie-js.channelconnection.channel.md | 11 + .../valkyrie-js.channelconnection.dispose.md | 15 + docs/api/valkyrie-js.channelconnection.id.md | 11 + .../valkyrie-js.channelconnection.incount.md | 11 + docs/api/valkyrie-js.channelconnection.md | 39 + .../api/valkyrie-js.channelconnection.name.md | 11 + .../valkyrie-js.channelconnection.outcount.md | 11 + .../api/valkyrie-js.channelconnection.send.md | 26 + .../valkyrie-js.channelconnection.stream.md | 11 + docs/api/valkyrie-js.channels.md | 143 ++ docs/api/valkyrie-js.endpoints.md | 1911 +++++++++++++++++ docs/api/valkyrie-js.entities.ad.md | 11 + docs/api/valkyrie-js.entities.announcement.md | 21 + docs/api/valkyrie-js.entities.antenna.md | 29 + docs/api/valkyrie-js.entities.app.md | 11 + docs/api/valkyrie-js.entities.authsession.md | 17 + docs/api/valkyrie-js.entities.blocking.md | 18 + docs/api/valkyrie-js.entities.channel.md | 15 + docs/api/valkyrie-js.entities.clip.md | 11 + docs/api/valkyrie-js.entities.customemoji.md | 17 + docs/api/valkyrie-js.entities.datestring.md | 11 + ...ie-js.entities.detailedinstancemetadata.md | 15 + docs/api/valkyrie-js.entities.drivefile.md | 26 + docs/api/valkyrie-js.entities.drivefolder.md | 11 + docs/api/valkyrie-js.entities.following.md | 18 + ...-js.entities.followingfolloweepopulated.md | 15 + ...-js.entities.followingfollowerpopulated.md | 15 + .../api/valkyrie-js.entities.followrequest.md | 17 + docs/api/valkyrie-js.entities.gallerypost.md | 11 + docs/api/valkyrie-js.entities.id.md | 11 + docs/api/valkyrie-js.entities.instance.md | 40 + .../valkyrie-js.entities.instancemetadata.md | 15 + ...lkyrie-js.entities.liteinstancemetadata.md | 46 + docs/api/valkyrie-js.entities.md | 51 + docs/api/valkyrie-js.entities.medetailed.md | 40 + .../valkyrie-js.entities.messagingmessage.md | 27 + docs/api/valkyrie-js.entities.note.md | 51 + docs/api/valkyrie-js.entities.notefavorite.md | 18 + docs/api/valkyrie-js.entities.notereaction.md | 18 + docs/api/valkyrie-js.entities.notification.md | 82 + docs/api/valkyrie-js.entities.origintype.md | 11 + docs/api/valkyrie-js.entities.page.md | 33 + docs/api/valkyrie-js.entities.pageevent.md | 19 + docs/api/valkyrie-js.entities.serverinfo.md | 24 + docs/api/valkyrie-js.entities.signin.md | 19 + docs/api/valkyrie-js.entities.stats.md | 19 + docs/api/valkyrie-js.entities.user.md | 13 + docs/api/valkyrie-js.entities.userdetailed.md | 56 + docs/api/valkyrie-js.entities.usergroup.md | 11 + docs/api/valkyrie-js.entities.userlist.md | 18 + docs/api/valkyrie-js.entities.userlite.md | 35 + docs/api/valkyrie-js.entities.usersorting.md | 17 + docs/api/valkyrie-js.ffvisibility.md | 11 + docs/api/valkyrie-js.md | 43 + docs/api/valkyrie-js.mutednotereasons.md | 16 + docs/api/valkyrie-js.notevisibilities.md | 16 + docs/api/valkyrie-js.notificationtypes.md | 24 + docs/api/valkyrie-js.permissions.md | 11 + docs/api/valkyrie-js.stream._constructor_.md | 30 + docs/api/valkyrie-js.stream.close.md | 15 + .../valkyrie-js.stream.disconnecttochannel.md | 22 + docs/api/valkyrie-js.stream.md | 36 + ...lkyrie-js.stream.removesharedconnection.md | 22 + ...ie-js.stream.removesharedconnectionpool.md | 22 + docs/api/valkyrie-js.stream.send.md | 23 + docs/api/valkyrie-js.stream.state.md | 11 + docs/api/valkyrie-js.stream.usechannel.md | 28 + 82 files changed, 3788 insertions(+) create mode 100644 docs/api/_category_.json create mode 100644 docs/api/index.md create mode 100644 docs/api/info.md create mode 100644 docs/api/valkyrie-js.acct.md create mode 100644 docs/api/valkyrie-js.api.apiclient._constructor_.md create mode 100644 docs/api/valkyrie-js.api.apiclient.credential.md create mode 100644 docs/api/valkyrie-js.api.apiclient.fetch.md create mode 100644 docs/api/valkyrie-js.api.apiclient.md create mode 100644 docs/api/valkyrie-js.api.apiclient.origin.md create mode 100644 docs/api/valkyrie-js.api.apiclient.request.md create mode 100644 docs/api/valkyrie-js.api.apierror.md create mode 100644 docs/api/valkyrie-js.api.fetchlike.md create mode 100644 docs/api/valkyrie-js.api.isapierror.md create mode 100644 docs/api/valkyrie-js.api.md create mode 100644 docs/api/valkyrie-js.channelconnection._constructor_.md create mode 100644 docs/api/valkyrie-js.channelconnection.channel.md create mode 100644 docs/api/valkyrie-js.channelconnection.dispose.md create mode 100644 docs/api/valkyrie-js.channelconnection.id.md create mode 100644 docs/api/valkyrie-js.channelconnection.incount.md create mode 100644 docs/api/valkyrie-js.channelconnection.md create mode 100644 docs/api/valkyrie-js.channelconnection.name.md create mode 100644 docs/api/valkyrie-js.channelconnection.outcount.md create mode 100644 docs/api/valkyrie-js.channelconnection.send.md create mode 100644 docs/api/valkyrie-js.channelconnection.stream.md create mode 100644 docs/api/valkyrie-js.channels.md create mode 100644 docs/api/valkyrie-js.endpoints.md create mode 100644 docs/api/valkyrie-js.entities.ad.md create mode 100644 docs/api/valkyrie-js.entities.announcement.md create mode 100644 docs/api/valkyrie-js.entities.antenna.md create mode 100644 docs/api/valkyrie-js.entities.app.md create mode 100644 docs/api/valkyrie-js.entities.authsession.md create mode 100644 docs/api/valkyrie-js.entities.blocking.md create mode 100644 docs/api/valkyrie-js.entities.channel.md create mode 100644 docs/api/valkyrie-js.entities.clip.md create mode 100644 docs/api/valkyrie-js.entities.customemoji.md create mode 100644 docs/api/valkyrie-js.entities.datestring.md create mode 100644 docs/api/valkyrie-js.entities.detailedinstancemetadata.md create mode 100644 docs/api/valkyrie-js.entities.drivefile.md create mode 100644 docs/api/valkyrie-js.entities.drivefolder.md create mode 100644 docs/api/valkyrie-js.entities.following.md create mode 100644 docs/api/valkyrie-js.entities.followingfolloweepopulated.md create mode 100644 docs/api/valkyrie-js.entities.followingfollowerpopulated.md create mode 100644 docs/api/valkyrie-js.entities.followrequest.md create mode 100644 docs/api/valkyrie-js.entities.gallerypost.md create mode 100644 docs/api/valkyrie-js.entities.id.md create mode 100644 docs/api/valkyrie-js.entities.instance.md create mode 100644 docs/api/valkyrie-js.entities.instancemetadata.md create mode 100644 docs/api/valkyrie-js.entities.liteinstancemetadata.md create mode 100644 docs/api/valkyrie-js.entities.md create mode 100644 docs/api/valkyrie-js.entities.medetailed.md create mode 100644 docs/api/valkyrie-js.entities.messagingmessage.md create mode 100644 docs/api/valkyrie-js.entities.note.md create mode 100644 docs/api/valkyrie-js.entities.notefavorite.md create mode 100644 docs/api/valkyrie-js.entities.notereaction.md create mode 100644 docs/api/valkyrie-js.entities.notification.md create mode 100644 docs/api/valkyrie-js.entities.origintype.md create mode 100644 docs/api/valkyrie-js.entities.page.md create mode 100644 docs/api/valkyrie-js.entities.pageevent.md create mode 100644 docs/api/valkyrie-js.entities.serverinfo.md create mode 100644 docs/api/valkyrie-js.entities.signin.md create mode 100644 docs/api/valkyrie-js.entities.stats.md create mode 100644 docs/api/valkyrie-js.entities.user.md create mode 100644 docs/api/valkyrie-js.entities.userdetailed.md create mode 100644 docs/api/valkyrie-js.entities.usergroup.md create mode 100644 docs/api/valkyrie-js.entities.userlist.md create mode 100644 docs/api/valkyrie-js.entities.userlite.md create mode 100644 docs/api/valkyrie-js.entities.usersorting.md create mode 100644 docs/api/valkyrie-js.ffvisibility.md create mode 100644 docs/api/valkyrie-js.md create mode 100644 docs/api/valkyrie-js.mutednotereasons.md create mode 100644 docs/api/valkyrie-js.notevisibilities.md create mode 100644 docs/api/valkyrie-js.notificationtypes.md create mode 100644 docs/api/valkyrie-js.permissions.md create mode 100644 docs/api/valkyrie-js.stream._constructor_.md create mode 100644 docs/api/valkyrie-js.stream.close.md create mode 100644 docs/api/valkyrie-js.stream.disconnecttochannel.md create mode 100644 docs/api/valkyrie-js.stream.md create mode 100644 docs/api/valkyrie-js.stream.removesharedconnection.md create mode 100644 docs/api/valkyrie-js.stream.removesharedconnectionpool.md create mode 100644 docs/api/valkyrie-js.stream.send.md create mode 100644 docs/api/valkyrie-js.stream.state.md create mode 100644 docs/api/valkyrie-js.stream.usechannel.md diff --git a/docs/api/_category_.json b/docs/api/_category_.json new file mode 100644 index 0000000..5ee20bf --- /dev/null +++ b/docs/api/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Api", + "position": 3, + "link": { + "type": "generated-index", + "description": "Here you can find our api docs." + } +} \ No newline at end of file diff --git a/docs/api/index.md b/docs/api/index.md new file mode 100644 index 0000000..bde31ce --- /dev/null +++ b/docs/api/index.md @@ -0,0 +1,12 @@ + + +[Home](./index) + +## API Reference + +## Packages + +| Package | Description | +| --- | --- | +| [valkyrie-js](./valkyrie-js) | | + diff --git a/docs/api/info.md b/docs/api/info.md new file mode 100644 index 0000000..e3738e0 --- /dev/null +++ b/docs/api/info.md @@ -0,0 +1,7 @@ +--- +title: info +--- + +# About this section + +In this section of the documentation you will find the docs for the Valkyriecoms api which you can use by following the insturction of the [toastielab page](https://toastielab.dev/Valkyriecoms/-/packages/npm/valkyrie-js/0.0.24) \ No newline at end of file diff --git a/docs/api/valkyrie-js.acct.md b/docs/api/valkyrie-js.acct.md new file mode 100644 index 0000000..6fde153 --- /dev/null +++ b/docs/api/valkyrie-js.acct.md @@ -0,0 +1,14 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [Acct](./valkyrie-js.acct) + +## Acct type + +**Signature:** + +```typescript +export declare type Acct = { + username: string; + host: string | null; +}; +``` diff --git a/docs/api/valkyrie-js.api.apiclient._constructor_.md b/docs/api/valkyrie-js.api.apiclient._constructor_.md new file mode 100644 index 0000000..3cfa18d --- /dev/null +++ b/docs/api/valkyrie-js.api.apiclient._constructor_.md @@ -0,0 +1,24 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [api](./valkyrie-js.api) > [APIClient](./valkyrie-js.api.apiclient) > [(constructor)](./valkyrie-js.api.apiclient._constructor_) + +## api.APIClient.(constructor) + +Constructs a new instance of the `APIClient` class + +**Signature:** + +```typescript +constructor(opts: { + origin: APIClient["origin"]; + credential?: APIClient["credential"]; + fetch?: APIClient["fetch"] | null | undefined; + }); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| opts | { origin: [APIClient](./valkyrie-js.api.apiclient)\["origin"\]; credential?: [APIClient](./valkyrie-js.api.apiclient)\["credential"\]; fetch?: [APIClient](./valkyrie-js.api.apiclient)\["fetch"\] \| null \| undefined; } | | + diff --git a/docs/api/valkyrie-js.api.apiclient.credential.md b/docs/api/valkyrie-js.api.apiclient.credential.md new file mode 100644 index 0000000..9eefa1c --- /dev/null +++ b/docs/api/valkyrie-js.api.apiclient.credential.md @@ -0,0 +1,11 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [api](./valkyrie-js.api) > [APIClient](./valkyrie-js.api.apiclient) > [credential](./valkyrie-js.api.apiclient.credential) + +## api.APIClient.credential property + +**Signature:** + +```typescript +credential: string | null | undefined; +``` diff --git a/docs/api/valkyrie-js.api.apiclient.fetch.md b/docs/api/valkyrie-js.api.apiclient.fetch.md new file mode 100644 index 0000000..2c8c4ee --- /dev/null +++ b/docs/api/valkyrie-js.api.apiclient.fetch.md @@ -0,0 +1,11 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [api](./valkyrie-js.api) > [APIClient](./valkyrie-js.api.apiclient) > [fetch](./valkyrie-js.api.apiclient.fetch) + +## api.APIClient.fetch property + +**Signature:** + +```typescript +fetch: FetchLike; +``` diff --git a/docs/api/valkyrie-js.api.apiclient.md b/docs/api/valkyrie-js.api.apiclient.md new file mode 100644 index 0000000..7bc7772 --- /dev/null +++ b/docs/api/valkyrie-js.api.apiclient.md @@ -0,0 +1,32 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [api](./valkyrie-js.api) > [APIClient](./valkyrie-js.api.apiclient) + +## api.APIClient class + +**Signature:** + +```typescript +export declare class APIClient +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(opts)](./valkyrie-js.api.apiclient._constructor_) | | Constructs a new instance of the APIClient class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [credential](./valkyrie-js.api.apiclient.credential) | | string \| null \| undefined | | +| [fetch](./valkyrie-js.api.apiclient.fetch) | | [FetchLike](./valkyrie-js.api.fetchlike) | | +| [origin](./valkyrie-js.api.apiclient.origin) | | string | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [request(endpoint, params, credential)](./valkyrie-js.api.apiclient.request) | | | + diff --git a/docs/api/valkyrie-js.api.apiclient.origin.md b/docs/api/valkyrie-js.api.apiclient.origin.md new file mode 100644 index 0000000..130d27e --- /dev/null +++ b/docs/api/valkyrie-js.api.apiclient.origin.md @@ -0,0 +1,11 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [api](./valkyrie-js.api) > [APIClient](./valkyrie-js.api.apiclient) > [origin](./valkyrie-js.api.apiclient.origin) + +## api.APIClient.origin property + +**Signature:** + +```typescript +origin: string; +``` diff --git a/docs/api/valkyrie-js.api.apiclient.request.md b/docs/api/valkyrie-js.api.apiclient.request.md new file mode 100644 index 0000000..3f29b65 --- /dev/null +++ b/docs/api/valkyrie-js.api.apiclient.request.md @@ -0,0 +1,57 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [api](./valkyrie-js.api) > [APIClient](./valkyrie-js.api.apiclient) > [request](./valkyrie-js.api.apiclient.request) + +## api.APIClient.request() method + +**Signature:** + +```typescript +request( + endpoint: E, + params?: P, + credential?: string | null | undefined, + ): Promise< + Endpoints[E]["res"] extends { + $switch: { + $cases: [any, any][]; + $default: any; + }; + } + ? IsCaseMatched extends true + ? GetCaseResult + : IsCaseMatched extends true + ? GetCaseResult + : IsCaseMatched extends true + ? GetCaseResult + : IsCaseMatched extends true + ? GetCaseResult + : IsCaseMatched extends true + ? GetCaseResult + : IsCaseMatched extends true + ? GetCaseResult + : IsCaseMatched extends true + ? GetCaseResult + : IsCaseMatched extends true + ? GetCaseResult + : IsCaseMatched extends true + ? GetCaseResult + : IsCaseMatched extends true + ? GetCaseResult + : Endpoints[E]["res"]["$switch"]["$default"] + : Endpoints[E]["res"] + >; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| endpoint | E | | +| params | P | _(Optional)_ | +| credential | string \| null \| undefined | _(Optional)_ | + +**Returns:** + +Promise< [Endpoints](./valkyrie-js.endpoints)\[E\]\["res"\] extends { $switch: { $cases: \[any, any\]\[\]; $default: any; }; } ? IsCaseMatched<E, P, 0> extends true ? GetCaseResult<E, P, 0> : IsCaseMatched<E, P, 1> extends true ? GetCaseResult<E, P, 1> : IsCaseMatched<E, P, 2> extends true ? GetCaseResult<E, P, 2> : IsCaseMatched<E, P, 3> extends true ? GetCaseResult<E, P, 3> : IsCaseMatched<E, P, 4> extends true ? GetCaseResult<E, P, 4> : IsCaseMatched<E, P, 5> extends true ? GetCaseResult<E, P, 5> : IsCaseMatched<E, P, 6> extends true ? GetCaseResult<E, P, 6> : IsCaseMatched<E, P, 7> extends true ? GetCaseResult<E, P, 7> : IsCaseMatched<E, P, 8> extends true ? GetCaseResult<E, P, 8> : IsCaseMatched<E, P, 9> extends true ? GetCaseResult<E, P, 9> : [Endpoints](./valkyrie-js.endpoints)\[E\]\["res"\]\["$switch"\]\["$default"\] : [Endpoints](./valkyrie-js.endpoints)\[E\]\["res"\] > + diff --git a/docs/api/valkyrie-js.api.apierror.md b/docs/api/valkyrie-js.api.apierror.md new file mode 100644 index 0000000..343b5ae --- /dev/null +++ b/docs/api/valkyrie-js.api.apierror.md @@ -0,0 +1,17 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [api](./valkyrie-js.api) > [APIError](./valkyrie-js.api.apierror) + +## api.APIError type + +**Signature:** + +```typescript +export declare type APIError = { + id: string; + code: string; + message: string; + kind: "client" | "server"; + info: Record; +}; +``` diff --git a/docs/api/valkyrie-js.api.fetchlike.md b/docs/api/valkyrie-js.api.fetchlike.md new file mode 100644 index 0000000..a268feb --- /dev/null +++ b/docs/api/valkyrie-js.api.fetchlike.md @@ -0,0 +1,22 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [api](./valkyrie-js.api) > [FetchLike](./valkyrie-js.api.fetchlike) + +## api.FetchLike type + +**Signature:** + +```typescript +export declare type FetchLike = ( + input: string, + init?: { + method?: string; + body?: string; + credentials?: RequestCredentials; + cache?: RequestCache; + }, +) => Promise<{ + status: number; + json(): Promise; +}>; +``` diff --git a/docs/api/valkyrie-js.api.isapierror.md b/docs/api/valkyrie-js.api.isapierror.md new file mode 100644 index 0000000..ce2df32 --- /dev/null +++ b/docs/api/valkyrie-js.api.isapierror.md @@ -0,0 +1,22 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [api](./valkyrie-js.api) > [isAPIError](./valkyrie-js.api.isapierror) + +## api.isAPIError() function + +**Signature:** + +```typescript +export declare function isAPIError(reason: any): reason is APIError; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| reason | any | | + +**Returns:** + +reason is [APIError](./valkyrie-js.api.apierror) + diff --git a/docs/api/valkyrie-js.api.md b/docs/api/valkyrie-js.api.md new file mode 100644 index 0000000..085bde6 --- /dev/null +++ b/docs/api/valkyrie-js.api.md @@ -0,0 +1,25 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [api](./valkyrie-js.api) + +## api namespace + +## Classes + +| Class | Description | +| --- | --- | +| [APIClient](./valkyrie-js.api.apiclient) | | + +## Functions + +| Function | Description | +| --- | --- | +| [isAPIError(reason)](./valkyrie-js.api.isapierror) | | + +## Type Aliases + +| Type Alias | Description | +| --- | --- | +| [APIError](./valkyrie-js.api.apierror) | | +| [FetchLike](./valkyrie-js.api.fetchlike) | | + diff --git a/docs/api/valkyrie-js.channelconnection._constructor_.md b/docs/api/valkyrie-js.channelconnection._constructor_.md new file mode 100644 index 0000000..50b6365 --- /dev/null +++ b/docs/api/valkyrie-js.channelconnection._constructor_.md @@ -0,0 +1,22 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [ChannelConnection](./valkyrie-js.channelconnection) > [(constructor)](./valkyrie-js.channelconnection._constructor_) + +## ChannelConnection.(constructor) + +Constructs a new instance of the `Connection` class + +**Signature:** + +```typescript +constructor(stream: Stream, channel: string, name?: string); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| stream | [Stream](./valkyrie-js.stream) | | +| channel | string | | +| name | string | _(Optional)_ | + diff --git a/docs/api/valkyrie-js.channelconnection.channel.md b/docs/api/valkyrie-js.channelconnection.channel.md new file mode 100644 index 0000000..627b86e --- /dev/null +++ b/docs/api/valkyrie-js.channelconnection.channel.md @@ -0,0 +1,11 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [ChannelConnection](./valkyrie-js.channelconnection) > [channel](./valkyrie-js.channelconnection.channel) + +## ChannelConnection.channel property + +**Signature:** + +```typescript +channel: string; +``` diff --git a/docs/api/valkyrie-js.channelconnection.dispose.md b/docs/api/valkyrie-js.channelconnection.dispose.md new file mode 100644 index 0000000..12efe15 --- /dev/null +++ b/docs/api/valkyrie-js.channelconnection.dispose.md @@ -0,0 +1,15 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [ChannelConnection](./valkyrie-js.channelconnection) > [dispose](./valkyrie-js.channelconnection.dispose) + +## ChannelConnection.dispose() method + +**Signature:** + +```typescript +abstract dispose(): void; +``` +**Returns:** + +void + diff --git a/docs/api/valkyrie-js.channelconnection.id.md b/docs/api/valkyrie-js.channelconnection.id.md new file mode 100644 index 0000000..67ca0b8 --- /dev/null +++ b/docs/api/valkyrie-js.channelconnection.id.md @@ -0,0 +1,11 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [ChannelConnection](./valkyrie-js.channelconnection) > [id](./valkyrie-js.channelconnection.id) + +## ChannelConnection.id property + +**Signature:** + +```typescript +abstract id: string; +``` diff --git a/docs/api/valkyrie-js.channelconnection.incount.md b/docs/api/valkyrie-js.channelconnection.incount.md new file mode 100644 index 0000000..1de383f --- /dev/null +++ b/docs/api/valkyrie-js.channelconnection.incount.md @@ -0,0 +1,11 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [ChannelConnection](./valkyrie-js.channelconnection) > [inCount](./valkyrie-js.channelconnection.incount) + +## ChannelConnection.inCount property + +**Signature:** + +```typescript +inCount: number; +``` diff --git a/docs/api/valkyrie-js.channelconnection.md b/docs/api/valkyrie-js.channelconnection.md new file mode 100644 index 0000000..6604153 --- /dev/null +++ b/docs/api/valkyrie-js.channelconnection.md @@ -0,0 +1,39 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [ChannelConnection](./valkyrie-js.channelconnection) + +## ChannelConnection class + +**Signature:** + +```typescript +export declare abstract class Connection< + Channel extends AnyOf = any, +> extends EventEmitter +``` +**Extends:** EventEmitter<Channel\["events"\]> + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(stream, channel, name)](./valkyrie-js.channelconnection._constructor_) | | Constructs a new instance of the Connection class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [channel](./valkyrie-js.channelconnection.channel) | | string | | +| [id](./valkyrie-js.channelconnection.id) | abstract | string | | +| [inCount](./valkyrie-js.channelconnection.incount) | | number | | +| [name?](./valkyrie-js.channelconnection.name) | | string | _(Optional)_ | +| [outCount](./valkyrie-js.channelconnection.outcount) | | number | | +| [stream](./valkyrie-js.channelconnection.stream) | protected | [Stream](./valkyrie-js.stream) | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [dispose()](./valkyrie-js.channelconnection.dispose) | abstract | | +| [send(type, body)](./valkyrie-js.channelconnection.send) | | | + diff --git a/docs/api/valkyrie-js.channelconnection.name.md b/docs/api/valkyrie-js.channelconnection.name.md new file mode 100644 index 0000000..20fc557 --- /dev/null +++ b/docs/api/valkyrie-js.channelconnection.name.md @@ -0,0 +1,11 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [ChannelConnection](./valkyrie-js.channelconnection) > [name](./valkyrie-js.channelconnection.name) + +## ChannelConnection.name property + +**Signature:** + +```typescript +name?: string; +``` diff --git a/docs/api/valkyrie-js.channelconnection.outcount.md b/docs/api/valkyrie-js.channelconnection.outcount.md new file mode 100644 index 0000000..d368fb5 --- /dev/null +++ b/docs/api/valkyrie-js.channelconnection.outcount.md @@ -0,0 +1,11 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [ChannelConnection](./valkyrie-js.channelconnection) > [outCount](./valkyrie-js.channelconnection.outcount) + +## ChannelConnection.outCount property + +**Signature:** + +```typescript +outCount: number; +``` diff --git a/docs/api/valkyrie-js.channelconnection.send.md b/docs/api/valkyrie-js.channelconnection.send.md new file mode 100644 index 0000000..6507955 --- /dev/null +++ b/docs/api/valkyrie-js.channelconnection.send.md @@ -0,0 +1,26 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [ChannelConnection](./valkyrie-js.channelconnection) > [send](./valkyrie-js.channelconnection.send) + +## ChannelConnection.send() method + +**Signature:** + +```typescript +send( + type: T, + body: Channel["receives"][T], + ): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | T | | +| body | Channel\["receives"\]\[T\] | | + +**Returns:** + +void + diff --git a/docs/api/valkyrie-js.channelconnection.stream.md b/docs/api/valkyrie-js.channelconnection.stream.md new file mode 100644 index 0000000..cb652c2 --- /dev/null +++ b/docs/api/valkyrie-js.channelconnection.stream.md @@ -0,0 +1,11 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [ChannelConnection](./valkyrie-js.channelconnection) > [stream](./valkyrie-js.channelconnection.stream) + +## ChannelConnection.stream property + +**Signature:** + +```typescript +protected stream: Stream; +``` diff --git a/docs/api/valkyrie-js.channels.md b/docs/api/valkyrie-js.channels.md new file mode 100644 index 0000000..e40bc58 --- /dev/null +++ b/docs/api/valkyrie-js.channels.md @@ -0,0 +1,143 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [Channels](./valkyrie-js.channels) + +## Channels type + +**Signature:** + +```typescript +export declare type Channels = { + main: { + params: null; + events: { + notification: (payload: Notification) => void; + mention: (payload: Note) => void; + reply: (payload: Note) => void; + renote: (payload: Note) => void; + follow: (payload: User) => void; + followed: (payload: User) => void; + unfollow: (payload: User) => void; + meUpdated: (payload: MeDetailed) => void; + pageEvent: (payload: PageEvent) => void; + urlUploadFinished: (payload: { + marker: string; + file: DriveFile; + }) => void; + readAllNotifications: () => void; + unreadNotification: (payload: Notification) => void; + unreadMention: (payload: Note["id"]) => void; + readAllUnreadMentions: () => void; + unreadSpecifiedNote: (payload: Note["id"]) => void; + readAllUnreadSpecifiedNotes: () => void; + readAllMessagingMessages: () => void; + messagingMessage: (payload: MessagingMessage) => void; + unreadMessagingMessage: (payload: MessagingMessage) => void; + readAllAntennas: () => void; + unreadAntenna: (payload: Antenna) => void; + readAllAnnouncements: () => void; + readAllChannels: () => void; + unreadChannel: (payload: Note["id"]) => void; + myTokenRegenerated: () => void; + reversiNoInvites: () => void; + reversiInvited: (payload: FIXME) => void; + signin: (payload: FIXME) => void; + registryUpdated: (payload: { + scope?: string[]; + key: string; + value: any | null; + }) => void; + driveFileCreated: (payload: DriveFile) => void; + readAntenna: (payload: Antenna) => void; + }; + receives: null; + }; + homeTimeline: { + params: null; + events: { + note: (payload: Note) => void; + }; + receives: null; + }; + localTimeline: { + params: null; + events: { + note: (payload: Note) => void; + }; + receives: null; + }; + hybridTimeline: { + params: null; + events: { + note: (payload: Note) => void; + }; + receives: null; + }; + recommendedTimeline: { + params: null; + events: { + note: (payload: Note) => void; + }; + receives: null; + }; + globalTimeline: { + params: null; + events: { + note: (payload: Note) => void; + }; + receives: null; + }; + antenna: { + params: { + antennaId: Antenna["id"]; + }; + events: { + note: (payload: Note) => void; + }; + receives: null; + }; + messaging: { + params: { + otherparty?: User["id"] | null; + group?: UserGroup["id"] | null; + }; + events: { + message: (payload: MessagingMessage) => void; + deleted: (payload: MessagingMessage["id"]) => void; + read: (payload: MessagingMessage["id"][]) => void; + typers: (payload: User[]) => void; + }; + receives: { + read: { + id: MessagingMessage["id"]; + }; + }; + }; + serverStats: { + params: null; + events: { + stats: (payload: FIXME) => void; + }; + receives: { + requestLog: { + id: string | number; + length: number; + }; + }; + }; + queueStats: { + params: null; + events: { + stats: (payload: FIXME) => void; + }; + receives: { + requestLog: { + id: string | number; + length: number; + }; + }; + }; +}; +``` +**References:** [Note](./valkyrie-js.entities.note), [User](./valkyrie-js.entities.user), [MeDetailed](./valkyrie-js.entities.medetailed), [PageEvent](./valkyrie-js.entities.pageevent), [DriveFile](./valkyrie-js.entities.drivefile), [MessagingMessage](./valkyrie-js.entities.messagingmessage), [Antenna](./valkyrie-js.entities.antenna), [UserGroup](./valkyrie-js.entities.usergroup) + diff --git a/docs/api/valkyrie-js.endpoints.md b/docs/api/valkyrie-js.endpoints.md new file mode 100644 index 0000000..76f7503 --- /dev/null +++ b/docs/api/valkyrie-js.endpoints.md @@ -0,0 +1,1911 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [Endpoints](./valkyrie-js.endpoints) + +## Endpoints type + +**Signature:** + +```typescript +export declare type Endpoints = { + "admin/abuse-user-reports": { + req: TODO; + res: TODO; + }; + "admin/delete-all-files-of-a-user": { + req: { + userId: User["id"]; + }; + res: null; + }; + "admin/delete-logs": { + req: NoParams; + res: null; + }; + "admin/get-index-stats": { + req: TODO; + res: TODO; + }; + "admin/get-table-stats": { + req: TODO; + res: TODO; + }; + "admin/invite": { + req: TODO; + res: TODO; + }; + "admin/logs": { + req: TODO; + res: TODO; + }; + "admin/meta": { + req: TODO; + res: TODO; + }; + "admin/reset-password": { + req: TODO; + res: TODO; + }; + "admin/resolve-abuse-user-report": { + req: TODO; + res: TODO; + }; + "admin/resync-chart": { + req: TODO; + res: TODO; + }; + "admin/send-email": { + req: TODO; + res: TODO; + }; + "admin/server-info": { + req: TODO; + res: TODO; + }; + "admin/show-moderation-logs": { + req: TODO; + res: TODO; + }; + "admin/show-user": { + req: TODO; + res: TODO; + }; + "admin/show-users": { + req: TODO; + res: TODO; + }; + "admin/silence-user": { + req: TODO; + res: TODO; + }; + "admin/suspend-user": { + req: TODO; + res: TODO; + }; + "admin/unsilence-user": { + req: TODO; + res: TODO; + }; + "admin/unsuspend-user": { + req: TODO; + res: TODO; + }; + "admin/update-meta": { + req: TODO; + res: TODO; + }; + "admin/vacuum": { + req: TODO; + res: TODO; + }; + "admin/accounts/create": { + req: TODO; + res: TODO; + }; + "admin/ad/create": { + req: TODO; + res: TODO; + }; + "admin/ad/delete": { + req: { + id: Ad["id"]; + }; + res: null; + }; + "admin/ad/list": { + req: TODO; + res: TODO; + }; + "admin/ad/update": { + req: TODO; + res: TODO; + }; + "admin/announcements/create": { + req: TODO; + res: TODO; + }; + "admin/announcements/delete": { + req: { + id: Announcement["id"]; + }; + res: null; + }; + "admin/announcements/list": { + req: TODO; + res: TODO; + }; + "admin/announcements/update": { + req: TODO; + res: TODO; + }; + "admin/drive/clean-remote-files": { + req: TODO; + res: TODO; + }; + "admin/drive/cleanup": { + req: TODO; + res: TODO; + }; + "admin/drive/files": { + req: TODO; + res: TODO; + }; + "admin/drive/show-file": { + req: TODO; + res: TODO; + }; + "admin/emoji/add": { + req: TODO; + res: TODO; + }; + "admin/emoji/copy": { + req: TODO; + res: TODO; + }; + "admin/emoji/list-remote": { + req: TODO; + res: TODO; + }; + "admin/emoji/list": { + req: TODO; + res: TODO; + }; + "admin/emoji/remove": { + req: TODO; + res: TODO; + }; + "admin/emoji/update": { + req: TODO; + res: TODO; + }; + "admin/federation/delete-all-files": { + req: { + host: string; + }; + res: null; + }; + "admin/federation/refresh-remote-instance-metadata": { + req: TODO; + res: TODO; + }; + "admin/federation/remove-all-following": { + req: TODO; + res: TODO; + }; + "admin/federation/update-instance": { + req: TODO; + res: TODO; + }; + "admin/moderators/add": { + req: TODO; + res: TODO; + }; + "admin/moderators/remove": { + req: TODO; + res: TODO; + }; + "admin/promo/create": { + req: TODO; + res: TODO; + }; + "admin/queue/clear": { + req: TODO; + res: TODO; + }; + "admin/queue/deliver-delayed": { + req: TODO; + res: TODO; + }; + "admin/queue/inbox-delayed": { + req: TODO; + res: TODO; + }; + "admin/queue/jobs": { + req: TODO; + res: TODO; + }; + "admin/queue/stats": { + req: TODO; + res: TODO; + }; + "admin/relays/add": { + req: TODO; + res: TODO; + }; + "admin/relays/list": { + req: TODO; + res: TODO; + }; + "admin/relays/remove": { + req: TODO; + res: TODO; + }; + announcements: { + req: { + limit?: number; + withUnreads?: boolean; + sinceId?: Announcement["id"]; + untilId?: Announcement["id"]; + }; + res: Announcement[]; + }; + "antennas/create": { + req: TODO; + res: Antenna; + }; + "antennas/delete": { + req: { + antennaId: Antenna["id"]; + }; + res: null; + }; + "antennas/list": { + req: NoParams; + res: Antenna[]; + }; + "antennas/notes": { + req: { + antennaId: Antenna["id"]; + limit?: number; + sinceId?: Note["id"]; + untilId?: Note["id"]; + }; + res: Note[]; + }; + "antennas/show": { + req: { + antennaId: Antenna["id"]; + }; + res: Antenna; + }; + "antennas/update": { + req: TODO; + res: Antenna; + }; + "antennas/mark-read": { + req: TODO; + res: Antenna; + }; + "ap/get": { + req: { + uri: string; + }; + res: Record; + }; + "ap/show": { + req: { + uri: string; + }; + res: + | { + type: "Note"; + object: Note; + } + | { + type: "User"; + object: UserDetailed; + }; + }; + "app/create": { + req: TODO; + res: App; + }; + "app/show": { + req: { + appId: App["id"]; + }; + res: App; + }; + "auth/accept": { + req: { + token: string; + }; + res: null; + }; + "auth/session/generate": { + req: { + appSecret: string; + }; + res: { + token: string; + url: string; + }; + }; + "auth/session/show": { + req: { + token: string; + }; + res: AuthSession; + }; + "auth/session/userkey": { + req: { + appSecret: string; + token: string; + }; + res: { + accessToken: string; + user: User; + }; + }; + "blocking/create": { + req: { + userId: User["id"]; + }; + res: UserDetailed; + }; + "blocking/delete": { + req: { + userId: User["id"]; + }; + res: UserDetailed; + }; + "blocking/list": { + req: { + limit?: number; + sinceId?: Blocking["id"]; + untilId?: Blocking["id"]; + }; + res: Blocking[]; + }; + "channels/create": { + req: TODO; + res: TODO; + }; + "channels/featured": { + req: TODO; + res: TODO; + }; + "channels/follow": { + req: TODO; + res: TODO; + }; + "channels/followed": { + req: TODO; + res: TODO; + }; + "channels/owned": { + req: TODO; + res: TODO; + }; + "channels/pin-note": { + req: TODO; + res: TODO; + }; + "channels/show": { + req: TODO; + res: TODO; + }; + "channels/timeline": { + req: TODO; + res: TODO; + }; + "channels/unfollow": { + req: TODO; + res: TODO; + }; + "channels/update": { + req: TODO; + res: TODO; + }; + "charts/active-users": { + req: { + span: "day" | "hour"; + limit?: number; + offset?: number | null; + }; + res: { + local: { + users: number[]; + }; + remote: { + users: number[]; + }; + }; + }; + "charts/drive": { + req: { + span: "day" | "hour"; + limit?: number; + offset?: number | null; + }; + res: { + local: { + decCount: number[]; + decSize: number[]; + incCount: number[]; + incSize: number[]; + totalCount: number[]; + totalSize: number[]; + }; + remote: { + decCount: number[]; + decSize: number[]; + incCount: number[]; + incSize: number[]; + totalCount: number[]; + totalSize: number[]; + }; + }; + }; + "charts/federation": { + req: { + span: "day" | "hour"; + limit?: number; + offset?: number | null; + }; + res: { + instance: { + dec: number[]; + inc: number[]; + total: number[]; + }; + }; + }; + "charts/hashtag": { + req: { + span: "day" | "hour"; + limit?: number; + offset?: number | null; + }; + res: TODO; + }; + "charts/instance": { + req: { + span: "day" | "hour"; + limit?: number; + offset?: number | null; + host: string; + }; + res: { + drive: { + decFiles: number[]; + decUsage: number[]; + incFiles: number[]; + incUsage: number[]; + totalFiles: number[]; + totalUsage: number[]; + }; + followers: { + dec: number[]; + inc: number[]; + total: number[]; + }; + following: { + dec: number[]; + inc: number[]; + total: number[]; + }; + notes: { + dec: number[]; + inc: number[]; + total: number[]; + diffs: { + normal: number[]; + renote: number[]; + reply: number[]; + }; + }; + requests: { + failed: number[]; + received: number[]; + succeeded: number[]; + }; + users: { + dec: number[]; + inc: number[]; + total: number[]; + }; + }; + }; + "charts/network": { + req: { + span: "day" | "hour"; + limit?: number; + offset?: number | null; + }; + res: TODO; + }; + "charts/notes": { + req: { + span: "day" | "hour"; + limit?: number; + offset?: number | null; + }; + res: { + local: { + dec: number[]; + inc: number[]; + total: number[]; + diffs: { + normal: number[]; + renote: number[]; + reply: number[]; + }; + }; + remote: { + dec: number[]; + inc: number[]; + total: number[]; + diffs: { + normal: number[]; + renote: number[]; + reply: number[]; + }; + }; + }; + }; + "charts/user/drive": { + req: { + span: "day" | "hour"; + limit?: number; + offset?: number | null; + userId: User["id"]; + }; + res: { + decCount: number[]; + decSize: number[]; + incCount: number[]; + incSize: number[]; + totalCount: number[]; + totalSize: number[]; + }; + }; + "charts/user/following": { + req: { + span: "day" | "hour"; + limit?: number; + offset?: number | null; + userId: User["id"]; + }; + res: TODO; + }; + "charts/user/notes": { + req: { + span: "day" | "hour"; + limit?: number; + offset?: number | null; + userId: User["id"]; + }; + res: { + dec: number[]; + inc: number[]; + total: number[]; + diffs: { + normal: number[]; + renote: number[]; + reply: number[]; + }; + }; + }; + "charts/user/reactions": { + req: { + span: "day" | "hour"; + limit?: number; + offset?: number | null; + userId: User["id"]; + }; + res: TODO; + }; + "charts/users": { + req: { + span: "day" | "hour"; + limit?: number; + offset?: number | null; + }; + res: { + local: { + dec: number[]; + inc: number[]; + total: number[]; + }; + remote: { + dec: number[]; + inc: number[]; + total: number[]; + }; + }; + }; + "clips/add-note": { + req: TODO; + res: TODO; + }; + "clips/create": { + req: TODO; + res: TODO; + }; + "clips/delete": { + req: { + clipId: Clip["id"]; + }; + res: null; + }; + "clips/list": { + req: TODO; + res: TODO; + }; + "clips/notes": { + req: TODO; + res: TODO; + }; + "clips/show": { + req: TODO; + res: TODO; + }; + "clips/update": { + req: TODO; + res: TODO; + }; + drive: { + req: NoParams; + res: { + capacity: number; + usage: number; + }; + }; + "drive/files": { + req: { + folderId?: DriveFolder["id"] | null; + type?: DriveFile["type"] | null; + limit?: number; + sinceId?: DriveFile["id"]; + untilId?: DriveFile["id"]; + }; + res: DriveFile[]; + }; + "drive/files/attached-notes": { + req: TODO; + res: TODO; + }; + "drive/files/check-existence": { + req: TODO; + res: TODO; + }; + "drive/files/create": { + req: TODO; + res: TODO; + }; + "drive/files/delete": { + req: { + fileId: DriveFile["id"]; + }; + res: null; + }; + "drive/files/find-by-hash": { + req: TODO; + res: TODO; + }; + "drive/files/find": { + req: { + name: string; + folderId?: DriveFolder["id"] | null; + }; + res: DriveFile[]; + }; + "drive/files/show": { + req: { + fileId?: DriveFile["id"]; + url?: string; + }; + res: DriveFile; + }; + "drive/files/update": { + req: { + fileId: DriveFile["id"]; + folderId?: DriveFolder["id"] | null; + name?: string; + isSensitive?: boolean; + comment?: string | null; + }; + res: DriveFile; + }; + "drive/files/upload-from-url": { + req: { + url: string; + folderId?: DriveFolder["id"] | null; + isSensitive?: boolean; + comment?: string | null; + marker?: string | null; + force?: boolean; + }; + res: null; + }; + "drive/folders": { + req: { + folderId?: DriveFolder["id"] | null; + limit?: number; + sinceId?: DriveFile["id"]; + untilId?: DriveFile["id"]; + }; + res: DriveFolder[]; + }; + "drive/folders/create": { + req: { + name?: string; + parentId?: DriveFolder["id"] | null; + }; + res: DriveFolder; + }; + "drive/folders/delete": { + req: { + folderId: DriveFolder["id"]; + }; + res: null; + }; + "drive/folders/find": { + req: { + name: string; + parentId?: DriveFolder["id"] | null; + }; + res: DriveFolder[]; + }; + "drive/folders/show": { + req: { + folderId: DriveFolder["id"]; + }; + res: DriveFolder; + }; + "drive/folders/update": { + req: { + folderId: DriveFolder["id"]; + name?: string; + parentId?: DriveFolder["id"] | null; + }; + res: DriveFolder; + }; + "drive/stream": { + req: { + type?: DriveFile["type"] | null; + limit?: number; + sinceId?: DriveFile["id"]; + untilId?: DriveFile["id"]; + }; + res: DriveFile[]; + }; + endpoint: { + req: { + endpoint: string; + }; + res: { + params: { + name: string; + type: string; + }[]; + }; + }; + endpoints: { + req: NoParams; + res: string[]; + }; + "federation/dns": { + req: { + host: string; + }; + res: { + a: string[]; + aaaa: string[]; + cname: string[]; + txt: string[]; + }; + }; + "federation/followers": { + req: { + host: string; + limit?: number; + sinceId?: Following["id"]; + untilId?: Following["id"]; + }; + res: FollowingFolloweePopulated[]; + }; + "federation/following": { + req: { + host: string; + limit?: number; + sinceId?: Following["id"]; + untilId?: Following["id"]; + }; + res: FollowingFolloweePopulated[]; + }; + "federation/instances": { + req: { + host?: string | null; + blocked?: boolean | null; + notResponding?: boolean | null; + suspended?: boolean | null; + federating?: boolean | null; + subscribing?: boolean | null; + publishing?: boolean | null; + limit?: number; + offset?: number; + sort?: + | "+pubSub" + | "-pubSub" + | "+notes" + | "-notes" + | "+users" + | "-users" + | "+following" + | "-following" + | "+followers" + | "-followers" + | "+caughtAt" + | "-caughtAt" + | "+lastCommunicatedAt" + | "-lastCommunicatedAt" + | "+driveUsage" + | "-driveUsage" + | "+driveFiles" + | "-driveFiles"; + }; + res: Instance[]; + }; + "federation/show-instance": { + req: { + host: string; + }; + res: Instance; + }; + "federation/update-remote-user": { + req: { + userId: User["id"]; + }; + res: null; + }; + "federation/users": { + req: { + host: string; + limit?: number; + sinceId?: User["id"]; + untilId?: User["id"]; + }; + res: UserDetailed[]; + }; + "following/create": { + req: { + userId: User["id"]; + }; + res: User; + }; + "following/delete": { + req: { + userId: User["id"]; + }; + res: User; + }; + "following/requests/accept": { + req: { + userId: User["id"]; + }; + res: null; + }; + "following/requests/cancel": { + req: { + userId: User["id"]; + }; + res: User; + }; + "following/requests/list": { + req: NoParams; + res: FollowRequest[]; + }; + "following/requests/reject": { + req: { + userId: User["id"]; + }; + res: null; + }; + "gallery/featured": { + req: TODO; + res: TODO; + }; + "gallery/popular": { + req: TODO; + res: TODO; + }; + "gallery/posts": { + req: TODO; + res: TODO; + }; + "gallery/posts/create": { + req: TODO; + res: TODO; + }; + "gallery/posts/delete": { + req: { + postId: GalleryPost["id"]; + }; + res: null; + }; + "gallery/posts/like": { + req: TODO; + res: TODO; + }; + "gallery/posts/show": { + req: TODO; + res: TODO; + }; + "gallery/posts/unlike": { + req: TODO; + res: TODO; + }; + "gallery/posts/update": { + req: TODO; + res: TODO; + }; + "games/reversi/games": { + req: TODO; + res: TODO; + }; + "games/reversi/games/show": { + req: TODO; + res: TODO; + }; + "games/reversi/games/surrender": { + req: TODO; + res: TODO; + }; + "games/reversi/invitations": { + req: TODO; + res: TODO; + }; + "games/reversi/match": { + req: TODO; + res: TODO; + }; + "games/reversi/match/cancel": { + req: TODO; + res: TODO; + }; + "get-online-users-count": { + req: NoParams; + res: { + count: number; + }; + }; + "hashtags/list": { + req: TODO; + res: TODO; + }; + "hashtags/search": { + req: TODO; + res: TODO; + }; + "hashtags/show": { + req: TODO; + res: TODO; + }; + "hashtags/trend": { + req: TODO; + res: TODO; + }; + "hashtags/users": { + req: TODO; + res: TODO; + }; + i: { + req: NoParams; + res: User; + }; + "i/apps": { + req: TODO; + res: TODO; + }; + "i/authorized-apps": { + req: TODO; + res: TODO; + }; + "i/change-password": { + req: TODO; + res: TODO; + }; + "i/delete-account": { + req: { + password: string; + }; + res: null; + }; + "i/export-blocking": { + req: TODO; + res: TODO; + }; + "i/export-following": { + req: TODO; + res: TODO; + }; + "i/export-mute": { + req: TODO; + res: TODO; + }; + "i/export-notes": { + req: TODO; + res: TODO; + }; + "i/export-user-lists": { + req: TODO; + res: TODO; + }; + "i/favorites": { + req: { + limit?: number; + sinceId?: NoteFavorite["id"]; + untilId?: NoteFavorite["id"]; + }; + res: NoteFavorite[]; + }; + "i/gallery/likes": { + req: TODO; + res: TODO; + }; + "i/gallery/posts": { + req: TODO; + res: TODO; + }; + "i/get-word-muted-notes-count": { + req: TODO; + res: TODO; + }; + "i/import-following": { + req: TODO; + res: TODO; + }; + "i/import-user-lists": { + req: TODO; + res: TODO; + }; + "i/move": { + req: TODO; + res: TODO; + }; + "i/known-as": { + req: TODO; + res: TODO; + }; + "i/notifications": { + req: { + limit?: number; + sinceId?: Notification["id"]; + untilId?: Notification["id"]; + following?: boolean; + markAsRead?: boolean; + includeTypes?: Notification["type"][]; + excludeTypes?: Notification["type"][]; + }; + res: Notification[]; + }; + "i/page-likes": { + req: TODO; + res: TODO; + }; + "i/pages": { + req: TODO; + res: TODO; + }; + "i/pin": { + req: { + noteId: Note["id"]; + }; + res: MeDetailed; + }; + "i/read-all-messaging-messages": { + req: TODO; + res: TODO; + }; + "i/read-all-unread-notes": { + req: TODO; + res: TODO; + }; + "i/read-announcement": { + req: TODO; + res: TODO; + }; + "i/regenerate-token": { + req: { + password: string; + }; + res: null; + }; + "i/registry/get-all": { + req: { + scope?: string[]; + }; + res: Record; + }; + "i/registry/get-detail": { + req: { + key: string; + scope?: string[]; + }; + res: { + updatedAt: DateString; + value: any; + }; + }; + "i/registry/get": { + req: { + key: string; + scope?: string[]; + }; + res: any; + }; + "i/registry/keys-with-type": { + req: { + scope?: string[]; + }; + res: Record< + string, + "null" | "array" | "number" | "string" | "boolean" | "object" + >; + }; + "i/registry/keys": { + req: { + scope?: string[]; + }; + res: string[]; + }; + "i/registry/remove": { + req: { + key: string; + scope?: string[]; + }; + res: null; + }; + "i/registry/scopes": { + req: NoParams; + res: string[][]; + }; + "i/registry/set": { + req: { + key: string; + value: any; + scope?: string[]; + }; + res: null; + }; + "i/revoke-token": { + req: TODO; + res: TODO; + }; + "i/signin-history": { + req: { + limit?: number; + sinceId?: Signin["id"]; + untilId?: Signin["id"]; + }; + res: Signin[]; + }; + "i/unpin": { + req: { + noteId: Note["id"]; + }; + res: MeDetailed; + }; + "i/update-email": { + req: { + password: string; + email?: string | null; + }; + res: MeDetailed; + }; + "i/update": { + req: { + name?: string | null; + description?: string | null; + lang?: string | null; + location?: string | null; + birthday?: string | null; + avatarId?: DriveFile["id"] | null; + bannerId?: DriveFile["id"] | null; + fields?: { + name: string; + value: string; + }[]; + isLocked?: boolean; + isExplorable?: boolean; + hideOnlineStatus?: boolean; + carefulBot?: boolean; + autoAcceptFollowed?: boolean; + noCrawle?: boolean; + preventAiLearning?: boolean; + isBot?: boolean; + isCat?: boolean; + injectFeaturedNote?: boolean; + receiveAnnouncementEmail?: boolean; + alwaysMarkNsfw?: boolean; + mutedWords?: string[][]; + mutingNotificationTypes?: Notification["type"][]; + emailNotificationTypes?: string[]; + }; + res: MeDetailed; + }; + "i/user-group-invites": { + req: TODO; + res: TODO; + }; + "i/2fa/done": { + req: TODO; + res: TODO; + }; + "i/2fa/key-done": { + req: TODO; + res: TODO; + }; + "i/2fa/password-less": { + req: TODO; + res: TODO; + }; + "i/2fa/register-key": { + req: TODO; + res: TODO; + }; + "i/2fa/register": { + req: TODO; + res: TODO; + }; + "i/2fa/update-key": { + req: TODO; + res: TODO; + }; + "i/2fa/remove-key": { + req: TODO; + res: TODO; + }; + "i/2fa/unregister": { + req: TODO; + res: TODO; + }; + "messaging/history": { + req: { + limit?: number; + group?: boolean; + }; + res: MessagingMessage[]; + }; + "messaging/messages": { + req: { + userId?: User["id"]; + groupId?: UserGroup["id"]; + limit?: number; + sinceId?: MessagingMessage["id"]; + untilId?: MessagingMessage["id"]; + markAsRead?: boolean; + }; + res: MessagingMessage[]; + }; + "messaging/messages/create": { + req: { + userId?: User["id"]; + groupId?: UserGroup["id"]; + text?: string; + fileId?: DriveFile["id"]; + }; + res: MessagingMessage; + }; + "messaging/messages/delete": { + req: { + messageId: MessagingMessage["id"]; + }; + res: null; + }; + "messaging/messages/read": { + req: { + messageId: MessagingMessage["id"]; + }; + res: null; + }; + meta: { + req: { + detail?: boolean; + }; + res: { + $switch: { + $cases: [ + [ + { + detail: true; + }, + DetailedInstanceMetadata, + ], + [ + { + detail: false; + }, + LiteInstanceMetadata, + ], + [ + { + detail: boolean; + }, + LiteInstanceMetadata | DetailedInstanceMetadata, + ], + ]; + $default: LiteInstanceMetadata; + }; + }; + }; + "miauth/gen-token": { + req: TODO; + res: TODO; + }; + "mute/create": { + req: TODO; + res: TODO; + }; + "mute/delete": { + req: { + userId: User["id"]; + }; + res: null; + }; + "mute/list": { + req: TODO; + res: TODO; + }; + "renote-mute/create": { + req: TODO; + res: TODO; + }; + "renote-mute/delete": { + req: { + userId: User["id"]; + }; + res: null; + }; + "renote-mute/list": { + req: TODO; + res: TODO; + }; + "my/apps": { + req: TODO; + res: TODO; + }; + notes: { + req: { + limit?: number; + sinceId?: Note["id"]; + untilId?: Note["id"]; + }; + res: Note[]; + }; + "notes/children": { + req: { + noteId: Note["id"]; + limit?: number; + sinceId?: Note["id"]; + untilId?: Note["id"]; + }; + res: Note[]; + }; + "notes/clips": { + req: TODO; + res: TODO; + }; + "notes/conversation": { + req: TODO; + res: TODO; + }; + "notes/create": { + req: NoteSubmitReq; + res: { + createdNote: Note; + }; + }; + "notes/delete": { + req: { + noteId: Note["id"]; + }; + res: null; + }; + "notes/edit": { + req: NoteSubmitReq; + res: { + createdNote: Note; + }; + }; + "notes/favorites/create": { + req: { + noteId: Note["id"]; + }; + res: null; + }; + "notes/favorites/delete": { + req: { + noteId: Note["id"]; + }; + res: null; + }; + "notes/featured": { + req: TODO; + res: Note[]; + }; + "notes/global-timeline": { + req: { + limit?: number; + sinceId?: Note["id"]; + untilId?: Note["id"]; + sinceDate?: number; + untilDate?: number; + }; + res: Note[]; + }; + "notes/recommended-timeline": { + req: { + limit?: number; + sinceId?: Note["id"]; + untilId?: Note["id"]; + sinceDate?: number; + untilDate?: number; + }; + res: Note[]; + }; + "notes/hybrid-timeline": { + req: { + limit?: number; + sinceId?: Note["id"]; + untilId?: Note["id"]; + sinceDate?: number; + untilDate?: number; + }; + res: Note[]; + }; + "notes/local-timeline": { + req: { + limit?: number; + sinceId?: Note["id"]; + untilId?: Note["id"]; + sinceDate?: number; + untilDate?: number; + }; + res: Note[]; + }; + "notes/mentions": { + req: { + following?: boolean; + limit?: number; + sinceId?: Note["id"]; + untilId?: Note["id"]; + }; + res: Note[]; + }; + "notes/polls/recommendation": { + req: TODO; + res: TODO; + }; + "notes/polls/vote": { + req: { + noteId: Note["id"]; + choice: number; + }; + res: null; + }; + "notes/reactions": { + req: { + noteId: Note["id"]; + type?: string | null; + limit?: number; + }; + res: NoteReaction[]; + }; + "notes/reactions/create": { + req: { + noteId: Note["id"]; + reaction: string; + }; + res: null; + }; + "notes/reactions/delete": { + req: { + noteId: Note["id"]; + }; + res: null; + }; + "notes/renotes": { + req: { + limit?: number; + sinceId?: Note["id"]; + untilId?: Note["id"]; + noteId: Note["id"]; + }; + res: Note[]; + }; + "notes/replies": { + req: { + limit?: number; + sinceId?: Note["id"]; + untilId?: Note["id"]; + noteId: Note["id"]; + }; + res: Note[]; + }; + "notes/search-by-tag": { + req: TODO; + res: TODO; + }; + "notes/search": { + req: TODO; + res: TODO; + }; + "notes/show": { + req: { + noteId: Note["id"]; + }; + res: Note; + }; + "notes/state": { + req: TODO; + res: TODO; + }; + "notes/timeline": { + req: { + limit?: number; + sinceId?: Note["id"]; + untilId?: Note["id"]; + sinceDate?: number; + untilDate?: number; + }; + res: Note[]; + }; + "notes/unrenote": { + req: { + noteId: Note["id"]; + }; + res: null; + }; + "notes/user-list-timeline": { + req: { + listId: UserList["id"]; + limit?: number; + sinceId?: Note["id"]; + untilId?: Note["id"]; + sinceDate?: number; + untilDate?: number; + }; + res: Note[]; + }; + "notes/watching/create": { + req: TODO; + res: TODO; + }; + "notes/watching/delete": { + req: { + noteId: Note["id"]; + }; + res: null; + }; + "notifications/create": { + req: { + body: string; + header?: string | null; + icon?: string | null; + }; + res: null; + }; + "notifications/mark-all-as-read": { + req: NoParams; + res: null; + }; + "notifications/read": { + req: { + notificationId: Notification["id"]; + }; + res: null; + }; + "page-push": { + req: { + pageId: Page["id"]; + event: string; + var?: any; + }; + res: null; + }; + "pages/create": { + req: TODO; + res: Page; + }; + "pages/delete": { + req: { + pageId: Page["id"]; + }; + res: null; + }; + "pages/featured": { + req: NoParams; + res: Page[]; + }; + "pages/like": { + req: { + pageId: Page["id"]; + }; + res: null; + }; + "pages/show": { + req: { + pageId?: Page["id"]; + name?: string; + username?: string; + }; + res: Page; + }; + "pages/unlike": { + req: { + pageId: Page["id"]; + }; + res: null; + }; + "pages/update": { + req: TODO; + res: null; + }; + ping: { + req: NoParams; + res: { + pong: number; + }; + }; + "pinned-users": { + req: TODO; + res: TODO; + }; + "promo/read": { + req: TODO; + res: TODO; + }; + "request-reset-password": { + req: { + username: string; + email: string; + }; + res: null; + }; + "reset-password": { + req: { + token: string; + password: string; + }; + res: null; + }; + "room/show": { + req: TODO; + res: TODO; + }; + "room/update": { + req: TODO; + res: TODO; + }; + stats: { + req: NoParams; + res: Stats; + }; + "server-info": { + req: NoParams; + res: ServerInfo; + }; + "latest-version": { + req: NoParams; + res: TODO; + }; + "sw/register": { + req: TODO; + res: TODO; + }; + "username/available": { + req: { + username: string; + }; + res: { + available: boolean; + }; + }; + users: { + req: { + limit?: number; + offset?: number; + sort?: UserSorting; + origin?: OriginType; + }; + res: User[]; + }; + "users/clips": { + req: TODO; + res: TODO; + }; + "users/followers": { + req: { + userId?: User["id"]; + username?: User["username"]; + host?: User["host"] | null; + limit?: number; + sinceId?: Following["id"]; + untilId?: Following["id"]; + }; + res: FollowingFollowerPopulated[]; + }; + "users/following": { + req: { + userId?: User["id"]; + username?: User["username"]; + host?: User["host"] | null; + limit?: number; + sinceId?: Following["id"]; + untilId?: Following["id"]; + }; + res: FollowingFolloweePopulated[]; + }; + "users/gallery/posts": { + req: TODO; + res: TODO; + }; + "users/get-frequently-replied-users": { + req: TODO; + res: TODO; + }; + "users/groups/create": { + req: TODO; + res: TODO; + }; + "users/groups/delete": { + req: { + groupId: UserGroup["id"]; + }; + res: null; + }; + "users/groups/invitations/accept": { + req: TODO; + res: TODO; + }; + "users/groups/invitations/reject": { + req: TODO; + res: TODO; + }; + "users/groups/invite": { + req: TODO; + res: TODO; + }; + "users/groups/joined": { + req: TODO; + res: TODO; + }; + "users/groups/owned": { + req: TODO; + res: TODO; + }; + "users/groups/pull": { + req: TODO; + res: TODO; + }; + "users/groups/show": { + req: TODO; + res: TODO; + }; + "users/groups/transfer": { + req: TODO; + res: TODO; + }; + "users/groups/update": { + req: TODO; + res: TODO; + }; + "users/lists/create": { + req: { + name: string; + }; + res: UserList; + }; + "users/lists/delete": { + req: { + listId: UserList["id"]; + }; + res: null; + }; + "users/lists/list": { + req: NoParams; + res: UserList[]; + }; + "users/lists/pull": { + req: { + listId: UserList["id"]; + userId: User["id"]; + }; + res: null; + }; + "users/lists/push": { + req: { + listId: UserList["id"]; + userId: User["id"]; + }; + res: null; + }; + "users/lists/show": { + req: { + listId: UserList["id"]; + }; + res: UserList; + }; + "users/lists/update": { + req: { + listId: UserList["id"]; + name: string; + }; + res: UserList; + }; + "users/notes": { + req: { + userId: User["id"]; + limit?: number; + sinceId?: Note["id"]; + untilId?: Note["id"]; + sinceDate?: number; + untilDate?: number; + }; + res: Note[]; + }; + "users/pages": { + req: TODO; + res: TODO; + }; + "users/recommendation": { + req: TODO; + res: TODO; + }; + "users/relation": { + req: TODO; + res: TODO; + }; + "users/report-abuse": { + req: TODO; + res: TODO; + }; + "users/search-by-username-and-host": { + req: TODO; + res: TODO; + }; + "users/search": { + req: TODO; + res: TODO; + }; + "users/show": { + req: + | ShowUserReq + | { + userIds: User["id"][]; + }; + res: { + $switch: { + $cases: [ + [ + { + userIds: User["id"][]; + }, + UserDetailed[], + ], + ]; + $default: UserDetailed; + }; + }; + }; + "users/stats": { + req: TODO; + res: TODO; + }; +}; +``` +**References:** [User](./valkyrie-js.entities.user), [Ad](./valkyrie-js.entities.ad), [Announcement](./valkyrie-js.entities.announcement), [Antenna](./valkyrie-js.entities.antenna), [Note](./valkyrie-js.entities.note), [UserDetailed](./valkyrie-js.entities.userdetailed), [App](./valkyrie-js.entities.app), [AuthSession](./valkyrie-js.entities.authsession), [Blocking](./valkyrie-js.entities.blocking), [Clip](./valkyrie-js.entities.clip), [DriveFolder](./valkyrie-js.entities.drivefolder), [DriveFile](./valkyrie-js.entities.drivefile), [Following](./valkyrie-js.entities.following), [FollowingFolloweePopulated](./valkyrie-js.entities.followingfolloweepopulated), [Instance](./valkyrie-js.entities.instance), [FollowRequest](./valkyrie-js.entities.followrequest), [GalleryPost](./valkyrie-js.entities.gallerypost), [NoteFavorite](./valkyrie-js.entities.notefavorite), [MeDetailed](./valkyrie-js.entities.medetailed), [DateString](./valkyrie-js.entities.datestring), [Signin](./valkyrie-js.entities.signin), [MessagingMessage](./valkyrie-js.entities.messagingmessage), [UserGroup](./valkyrie-js.entities.usergroup), [DetailedInstanceMetadata](./valkyrie-js.entities.detailedinstancemetadata), [LiteInstanceMetadata](./valkyrie-js.entities.liteinstancemetadata), [NoteReaction](./valkyrie-js.entities.notereaction), [UserList](./valkyrie-js.entities.userlist), [Page](./valkyrie-js.entities.page), [Stats](./valkyrie-js.entities.stats), [ServerInfo](./valkyrie-js.entities.serverinfo), [UserSorting](./valkyrie-js.entities.usersorting), [OriginType](./valkyrie-js.entities.origintype), [FollowingFollowerPopulated](./valkyrie-js.entities.followingfollowerpopulated) + diff --git a/docs/api/valkyrie-js.entities.ad.md b/docs/api/valkyrie-js.entities.ad.md new file mode 100644 index 0000000..124f7b9 --- /dev/null +++ b/docs/api/valkyrie-js.entities.ad.md @@ -0,0 +1,11 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [Ad](./valkyrie-js.entities.ad) + +## entities.Ad type + +**Signature:** + +```typescript +export declare type Ad = TODO; +``` diff --git a/docs/api/valkyrie-js.entities.announcement.md b/docs/api/valkyrie-js.entities.announcement.md new file mode 100644 index 0000000..76a786f --- /dev/null +++ b/docs/api/valkyrie-js.entities.announcement.md @@ -0,0 +1,21 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [Announcement](./valkyrie-js.entities.announcement) + +## entities.Announcement type + +**Signature:** + +```typescript +export declare type Announcement = { + id: ID; + createdAt: DateString; + updatedAt: DateString | null; + text: string; + title: string; + imageUrl: string | null; + isRead?: boolean; +}; +``` +**References:** [ID](./valkyrie-js.entities.id), [DateString](./valkyrie-js.entities.datestring) + diff --git a/docs/api/valkyrie-js.entities.antenna.md b/docs/api/valkyrie-js.entities.antenna.md new file mode 100644 index 0000000..8e42e15 --- /dev/null +++ b/docs/api/valkyrie-js.entities.antenna.md @@ -0,0 +1,29 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [Antenna](./valkyrie-js.entities.antenna) + +## entities.Antenna type + +**Signature:** + +```typescript +export declare type Antenna = { + id: ID; + createdAt: DateString; + name: string; + keywords: string[][]; + excludeKeywords: string[][]; + src: "home" | "all" | "users" | "list" | "group" | "instances"; + userListId: ID | null; + userGroupId: ID | null; + users: string[]; + instances: string[]; + caseSensitive: boolean; + notify: boolean; + withReplies: boolean; + withFile: boolean; + hasUnreadNote: boolean; +}; +``` +**References:** [ID](./valkyrie-js.entities.id), [DateString](./valkyrie-js.entities.datestring) + diff --git a/docs/api/valkyrie-js.entities.app.md b/docs/api/valkyrie-js.entities.app.md new file mode 100644 index 0000000..11ef9f5 --- /dev/null +++ b/docs/api/valkyrie-js.entities.app.md @@ -0,0 +1,11 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [App](./valkyrie-js.entities.app) + +## entities.App type + +**Signature:** + +```typescript +export declare type App = TODO; +``` diff --git a/docs/api/valkyrie-js.entities.authsession.md b/docs/api/valkyrie-js.entities.authsession.md new file mode 100644 index 0000000..56bb2f2 --- /dev/null +++ b/docs/api/valkyrie-js.entities.authsession.md @@ -0,0 +1,17 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [AuthSession](./valkyrie-js.entities.authsession) + +## entities.AuthSession type + +**Signature:** + +```typescript +export declare type AuthSession = { + id: ID; + app: App; + token: string; +}; +``` +**References:** [ID](./valkyrie-js.entities.id), [App](./valkyrie-js.entities.app) + diff --git a/docs/api/valkyrie-js.entities.blocking.md b/docs/api/valkyrie-js.entities.blocking.md new file mode 100644 index 0000000..4261312 --- /dev/null +++ b/docs/api/valkyrie-js.entities.blocking.md @@ -0,0 +1,18 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [Blocking](./valkyrie-js.entities.blocking) + +## entities.Blocking type + +**Signature:** + +```typescript +export declare type Blocking = { + id: ID; + createdAt: DateString; + blockeeId: User["id"]; + blockee: UserDetailed; +}; +``` +**References:** [ID](./valkyrie-js.entities.id), [DateString](./valkyrie-js.entities.datestring), [User](./valkyrie-js.entities.user), [UserDetailed](./valkyrie-js.entities.userdetailed) + diff --git a/docs/api/valkyrie-js.entities.channel.md b/docs/api/valkyrie-js.entities.channel.md new file mode 100644 index 0000000..c3b6254 --- /dev/null +++ b/docs/api/valkyrie-js.entities.channel.md @@ -0,0 +1,15 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [Channel](./valkyrie-js.entities.channel) + +## entities.Channel type + +**Signature:** + +```typescript +export declare type Channel = { + id: ID; +}; +``` +**References:** [ID](./valkyrie-js.entities.id) + diff --git a/docs/api/valkyrie-js.entities.clip.md b/docs/api/valkyrie-js.entities.clip.md new file mode 100644 index 0000000..a8324e9 --- /dev/null +++ b/docs/api/valkyrie-js.entities.clip.md @@ -0,0 +1,11 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [Clip](./valkyrie-js.entities.clip) + +## entities.Clip type + +**Signature:** + +```typescript +export declare type Clip = TODO; +``` diff --git a/docs/api/valkyrie-js.entities.customemoji.md b/docs/api/valkyrie-js.entities.customemoji.md new file mode 100644 index 0000000..c531364 --- /dev/null +++ b/docs/api/valkyrie-js.entities.customemoji.md @@ -0,0 +1,17 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [CustomEmoji](./valkyrie-js.entities.customemoji) + +## entities.CustomEmoji type + +**Signature:** + +```typescript +export declare type CustomEmoji = { + id: string; + name: string; + url: string; + category: string; + aliases: string[]; +}; +``` diff --git a/docs/api/valkyrie-js.entities.datestring.md b/docs/api/valkyrie-js.entities.datestring.md new file mode 100644 index 0000000..c5220bc --- /dev/null +++ b/docs/api/valkyrie-js.entities.datestring.md @@ -0,0 +1,11 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [DateString](./valkyrie-js.entities.datestring) + +## entities.DateString type + +**Signature:** + +```typescript +export declare type DateString = string; +``` diff --git a/docs/api/valkyrie-js.entities.detailedinstancemetadata.md b/docs/api/valkyrie-js.entities.detailedinstancemetadata.md new file mode 100644 index 0000000..ec1c41b --- /dev/null +++ b/docs/api/valkyrie-js.entities.detailedinstancemetadata.md @@ -0,0 +1,15 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [DetailedInstanceMetadata](./valkyrie-js.entities.detailedinstancemetadata) + +## entities.DetailedInstanceMetadata type + +**Signature:** + +```typescript +export declare type DetailedInstanceMetadata = LiteInstanceMetadata & { + features: Record; +}; +``` +**References:** [LiteInstanceMetadata](./valkyrie-js.entities.liteinstancemetadata) + diff --git a/docs/api/valkyrie-js.entities.drivefile.md b/docs/api/valkyrie-js.entities.drivefile.md new file mode 100644 index 0000000..52b1512 --- /dev/null +++ b/docs/api/valkyrie-js.entities.drivefile.md @@ -0,0 +1,26 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [DriveFile](./valkyrie-js.entities.drivefile) + +## entities.DriveFile type + +**Signature:** + +```typescript +export declare type DriveFile = { + id: ID; + createdAt: DateString; + isSensitive: boolean; + name: string; + thumbnailUrl: string; + url: string; + type: string; + size: number; + md5: string; + blurhash: string; + comment: string | null; + properties: Record; +}; +``` +**References:** [ID](./valkyrie-js.entities.id), [DateString](./valkyrie-js.entities.datestring) + diff --git a/docs/api/valkyrie-js.entities.drivefolder.md b/docs/api/valkyrie-js.entities.drivefolder.md new file mode 100644 index 0000000..2f7ba90 --- /dev/null +++ b/docs/api/valkyrie-js.entities.drivefolder.md @@ -0,0 +1,11 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [DriveFolder](./valkyrie-js.entities.drivefolder) + +## entities.DriveFolder type + +**Signature:** + +```typescript +export declare type DriveFolder = TODO; +``` diff --git a/docs/api/valkyrie-js.entities.following.md b/docs/api/valkyrie-js.entities.following.md new file mode 100644 index 0000000..7c927e6 --- /dev/null +++ b/docs/api/valkyrie-js.entities.following.md @@ -0,0 +1,18 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [Following](./valkyrie-js.entities.following) + +## entities.Following type + +**Signature:** + +```typescript +export declare type Following = { + id: ID; + createdAt: DateString; + followerId: User["id"]; + followeeId: User["id"]; +}; +``` +**References:** [ID](./valkyrie-js.entities.id), [DateString](./valkyrie-js.entities.datestring), [User](./valkyrie-js.entities.user) + diff --git a/docs/api/valkyrie-js.entities.followingfolloweepopulated.md b/docs/api/valkyrie-js.entities.followingfolloweepopulated.md new file mode 100644 index 0000000..5e4817d --- /dev/null +++ b/docs/api/valkyrie-js.entities.followingfolloweepopulated.md @@ -0,0 +1,15 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [FollowingFolloweePopulated](./valkyrie-js.entities.followingfolloweepopulated) + +## entities.FollowingFolloweePopulated type + +**Signature:** + +```typescript +export declare type FollowingFolloweePopulated = Following & { + followee: UserDetailed; +}; +``` +**References:** [Following](./valkyrie-js.entities.following), [UserDetailed](./valkyrie-js.entities.userdetailed) + diff --git a/docs/api/valkyrie-js.entities.followingfollowerpopulated.md b/docs/api/valkyrie-js.entities.followingfollowerpopulated.md new file mode 100644 index 0000000..b1c345d --- /dev/null +++ b/docs/api/valkyrie-js.entities.followingfollowerpopulated.md @@ -0,0 +1,15 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [FollowingFollowerPopulated](./valkyrie-js.entities.followingfollowerpopulated) + +## entities.FollowingFollowerPopulated type + +**Signature:** + +```typescript +export declare type FollowingFollowerPopulated = Following & { + follower: UserDetailed; +}; +``` +**References:** [Following](./valkyrie-js.entities.following), [UserDetailed](./valkyrie-js.entities.userdetailed) + diff --git a/docs/api/valkyrie-js.entities.followrequest.md b/docs/api/valkyrie-js.entities.followrequest.md new file mode 100644 index 0000000..441f0d0 --- /dev/null +++ b/docs/api/valkyrie-js.entities.followrequest.md @@ -0,0 +1,17 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [FollowRequest](./valkyrie-js.entities.followrequest) + +## entities.FollowRequest type + +**Signature:** + +```typescript +export declare type FollowRequest = { + id: ID; + follower: User; + followee: User; +}; +``` +**References:** [ID](./valkyrie-js.entities.id), [User](./valkyrie-js.entities.user) + diff --git a/docs/api/valkyrie-js.entities.gallerypost.md b/docs/api/valkyrie-js.entities.gallerypost.md new file mode 100644 index 0000000..e27d124 --- /dev/null +++ b/docs/api/valkyrie-js.entities.gallerypost.md @@ -0,0 +1,11 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [GalleryPost](./valkyrie-js.entities.gallerypost) + +## entities.GalleryPost type + +**Signature:** + +```typescript +export declare type GalleryPost = TODO; +``` diff --git a/docs/api/valkyrie-js.entities.id.md b/docs/api/valkyrie-js.entities.id.md new file mode 100644 index 0000000..044e621 --- /dev/null +++ b/docs/api/valkyrie-js.entities.id.md @@ -0,0 +1,11 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [ID](./valkyrie-js.entities.id) + +## entities.ID type + +**Signature:** + +```typescript +export declare type ID = string; +``` diff --git a/docs/api/valkyrie-js.entities.instance.md b/docs/api/valkyrie-js.entities.instance.md new file mode 100644 index 0000000..199cd8f --- /dev/null +++ b/docs/api/valkyrie-js.entities.instance.md @@ -0,0 +1,40 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [Instance](./valkyrie-js.entities.instance) + +## entities.Instance type + +**Signature:** + +```typescript +export declare type Instance = { + id: ID; + caughtAt: DateString; + host: string; + usersCount: number; + notesCount: number; + followingCount: number; + followersCount: number; + driveUsage: number; + driveFiles: number; + latestRequestSentAt: DateString | null; + latestStatus: number | null; + latestRequestReceivedAt: DateString | null; + lastCommunicatedAt: DateString; + isNotResponding: boolean; + isSuspended: boolean; + softwareName: string | null; + softwareVersion: string | null; + openRegistrations: boolean | null; + name: string | null; + description: string | null; + maintainerName: string | null; + maintainerEmail: string | null; + iconUrl: string | null; + faviconUrl: string | null; + themeColor: string | null; + infoUpdatedAt: DateString | null; +}; +``` +**References:** [ID](./valkyrie-js.entities.id), [DateString](./valkyrie-js.entities.datestring) + diff --git a/docs/api/valkyrie-js.entities.instancemetadata.md b/docs/api/valkyrie-js.entities.instancemetadata.md new file mode 100644 index 0000000..7a8cd2f --- /dev/null +++ b/docs/api/valkyrie-js.entities.instancemetadata.md @@ -0,0 +1,15 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [InstanceMetadata](./valkyrie-js.entities.instancemetadata) + +## entities.InstanceMetadata type + +**Signature:** + +```typescript +export declare type InstanceMetadata = + | LiteInstanceMetadata + | DetailedInstanceMetadata; +``` +**References:** [LiteInstanceMetadata](./valkyrie-js.entities.liteinstancemetadata), [DetailedInstanceMetadata](./valkyrie-js.entities.detailedinstancemetadata) + diff --git a/docs/api/valkyrie-js.entities.liteinstancemetadata.md b/docs/api/valkyrie-js.entities.liteinstancemetadata.md new file mode 100644 index 0000000..a157394 --- /dev/null +++ b/docs/api/valkyrie-js.entities.liteinstancemetadata.md @@ -0,0 +1,46 @@ + + +[Home](./indexgt; [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [LiteInstanceMetadata](./valkyrie-js.entities.liteinstancemetadata) + +## entities.LiteInstanceMetadata type + +**Signature:** + +```typescript +export declare type LiteInstanceMetadata = { + maintainerName: string | null; + maintainerEmail: string | null; + version: string; + name: string | null; + uri: string; + description: string | null; + tosUrl: string | null; + disableRegistration: boolean; + disableLocalTimeline: boolean; + disableRecommendedTimeline: boolean; + disableGlobalTimeline: boolean; + driveCapacityPerLocalUserMb: number; + driveCapacityPerRemoteUserMb: number; + enableHcaptcha: boolean; + hcaptchaSiteKey: string | null; + enableRecaptcha: boolean; + recaptchaSiteKey: string | null; + swPublickey: string | null; + maxNoteTextLength: number; + enableEmail: boolean; + enableTwitterIntegration: boolean; + enableGithubIntegration: boolean; + enableDiscordIntegration: boolean; + enableServiceWorker: boolean; + emojis: CustomEmoji[]; + ads: { + id: ID; + ratio: number; + place: string; + url: string; + imageUrl: string; + }[]; +}; +``` +**References:** [CustomEmoji](./valkyrie-js.entities.customemoji), [ID](./valkyrie-js.entities.id) + diff --git a/docs/api/valkyrie-js.entities.md b/docs/api/valkyrie-js.entities.md new file mode 100644 index 0000000..26e625b --- /dev/null +++ b/docs/api/valkyrie-js.entities.md @@ -0,0 +1,51 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) + +## entities namespace + +## Type Aliases + +| Type Alias | Description | +| --- | --- | +| [Ad](./valkyrie-js.entities.ad) | | +| [Announcement](./valkyrie-js.entities.announcement) | | +| [Antenna](./valkyrie-js.entities.antenna) | | +| [App](./valkyrie-js.entities.app) | | +| [AuthSession](./valkyrie-js.entities.authsession) | | +| [Blocking](./valkyrie-js.entities.blocking) | | +| [Channel](./valkyrie-js.entities.channel) | | +| [Clip](./valkyrie-js.entities.clip) | | +| [CustomEmoji](./valkyrie-js.entities.customemoji) | | +| [DateString](./valkyrie-js.entities.datestring) | | +| [DetailedInstanceMetadata](./valkyrie-js.entities.detailedinstancemetadata) | | +| [DriveFile](./valkyrie-js.entities.drivefile) | | +| [DriveFolder](./valkyrie-js.entities.drivefolder) | | +| [Following](./valkyrie-js.entities.following) | | +| [FollowingFolloweePopulated](./valkyrie-js.entities.followingfolloweepopulated) | | +| [FollowingFollowerPopulated](./valkyrie-js.entities.followingfollowerpopulated) | | +| [FollowRequest](./valkyrie-js.entities.followrequest) | | +| [GalleryPost](./valkyrie-js.entities.gallerypost) | | +| [ID](./valkyrie-js.entities.id) | | +| [Instance](./valkyrie-js.entities.instance) | | +| [InstanceMetadata](./valkyrie-js.entities.instancemetadata) | | +| [LiteInstanceMetadata](./valkyrie-js.entities.liteinstancemetadata) | | +| [MeDetailed](./valkyrie-js.entities.medetailed) | | +| [MessagingMessage](./valkyrie-js.entities.messagingmessage) | | +| [Note](./valkyrie-js.entities.note) | | +| [NoteFavorite](./valkyrie-js.entities.notefavorite) | | +| [NoteReaction](./valkyrie-js.entities.notereaction) | | +| [Notification](./valkyrie-js.entities.notification) | | +| [OriginType](./valkyrie-js.entities.origintype) | | +| [Page](./valkyrie-js.entities.page) | | +| [PageEvent](./valkyrie-js.entities.pageevent) | | +| [ServerInfo](./valkyrie-js.entities.serverinfo) | | +| [Signin](./valkyrie-js.entities.signin) | | +| [Stats](./valkyrie-js.entities.stats) | | +| [User](./valkyrie-js.entities.user) | | +| [UserDetailed](./valkyrie-js.entities.userdetailed) | | +| [UserGroup](./valkyrie-js.entities.usergroup) | | +| [UserList](./valkyrie-js.entities.userlist) | | +| [UserLite](./valkyrie-js.entities.userlite) | | +| [UserSorting](./valkyrie-js.entities.usersorting) | | + diff --git a/docs/api/valkyrie-js.entities.medetailed.md b/docs/api/valkyrie-js.entities.medetailed.md new file mode 100644 index 0000000..26bcb8e --- /dev/null +++ b/docs/api/valkyrie-js.entities.medetailed.md @@ -0,0 +1,40 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [MeDetailed](./valkyrie-js.entities.medetailed) + +## entities.MeDetailed type + +**Signature:** + +```typescript +export declare type MeDetailed = UserDetailed & { + avatarId: DriveFile["id"]; + bannerId: DriveFile["id"]; + autoAcceptFollowed: boolean; + alwaysMarkNsfw: boolean; + carefulBot: boolean; + emailNotificationTypes: string[]; + hasPendingReceivedFollowRequest: boolean; + hasUnreadAnnouncement: boolean; + hasUnreadAntenna: boolean; + hasUnreadChannel: boolean; + hasUnreadMentions: boolean; + hasUnreadMessagingMessage: boolean; + hasUnreadNotification: boolean; + hasUnreadSpecifiedNotes: boolean; + hideOnlineStatus: boolean; + injectFeaturedNote: boolean; + integrations: Record; + isDeleted: boolean; + isExplorable: boolean; + mutedWords: string[][]; + mutingNotificationTypes: string[]; + noCrawle: boolean; + preventAiLearning: boolean; + receiveAnnouncementEmail: boolean; + usePasswordLessLogin: boolean; + [other: string]: any; +}; +``` +**References:** [UserDetailed](./valkyrie-js.entities.userdetailed), [DriveFile](./valkyrie-js.entities.drivefile) + diff --git a/docs/api/valkyrie-js.entities.messagingmessage.md b/docs/api/valkyrie-js.entities.messagingmessage.md new file mode 100644 index 0000000..3ca1b82 --- /dev/null +++ b/docs/api/valkyrie-js.entities.messagingmessage.md @@ -0,0 +1,27 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [MessagingMessage](./valkyrie-js.entities.messagingmessage) + +## entities.MessagingMessage type + +**Signature:** + +```typescript +export declare type MessagingMessage = { + id: ID; + createdAt: DateString; + file: DriveFile | null; + fileId: DriveFile["id"] | null; + isRead: boolean; + reads: User["id"][]; + text: string | null; + user: User; + userId: User["id"]; + recipient?: User | null; + recipientId: User["id"] | null; + group?: UserGroup | null; + groupId: UserGroup["id"] | null; +}; +``` +**References:** [ID](./valkyrie-js.entities.id), [DateString](./valkyrie-js.entities.datestring), [DriveFile](./valkyrie-js.entities.drivefile), [User](./valkyrie-js.entities.user), [UserGroup](./valkyrie-js.entities.usergroup) + diff --git a/docs/api/valkyrie-js.entities.note.md b/docs/api/valkyrie-js.entities.note.md new file mode 100644 index 0000000..f69717b --- /dev/null +++ b/docs/api/valkyrie-js.entities.note.md @@ -0,0 +1,51 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [Note](./valkyrie-js.entities.note) + +## entities.Note type + +**Signature:** + +```typescript +export declare type Note = { + id: ID; + createdAt: DateString; + text: string | null; + cw: string | null; + user: User; + userId: User["id"]; + reply?: Note; + replyId: Note["id"]; + renote?: Note; + renoteId: Note["id"]; + files: DriveFile[]; + fileIds: DriveFile["id"][]; + visibility: "public" | "home" | "followers" | "specified"; + visibleUserIds?: User["id"][]; + localOnly?: boolean; + channel?: Channel["id"]; + myReaction?: string; + reactions: Record; + renoteCount: number; + repliesCount: number; + poll?: { + expiresAt: DateString | null; + multiple: boolean; + choices: { + isVoted: boolean; + text: string; + votes: number; + }[]; + }; + emojis: { + name: string; + url: string; + }[]; + uri?: string; + url?: string; + updatedAt?: DateString; + isHidden?: boolean; +}; +``` +**References:** [ID](./valkyrie-js.entities.id), [DateString](./valkyrie-js.entities.datestring), [User](./valkyrie-js.entities.user), [Note](./valkyrie-js.entities.note), [DriveFile](./valkyrie-js.entities.drivefile), [Channel](./valkyrie-js.entities.channel) + diff --git a/docs/api/valkyrie-js.entities.notefavorite.md b/docs/api/valkyrie-js.entities.notefavorite.md new file mode 100644 index 0000000..37656cf --- /dev/null +++ b/docs/api/valkyrie-js.entities.notefavorite.md @@ -0,0 +1,18 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [NoteFavorite](./valkyrie-js.entities.notefavorite) + +## entities.NoteFavorite type + +**Signature:** + +```typescript +export declare type NoteFavorite = { + id: ID; + createdAt: DateString; + noteId: Note["id"]; + note: Note; +}; +``` +**References:** [ID](./valkyrie-js.entities.id), [DateString](./valkyrie-js.entities.datestring), [Note](./valkyrie-js.entities.note) + diff --git a/docs/api/valkyrie-js.entities.notereaction.md b/docs/api/valkyrie-js.entities.notereaction.md new file mode 100644 index 0000000..d448945 --- /dev/null +++ b/docs/api/valkyrie-js.entities.notereaction.md @@ -0,0 +1,18 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [NoteReaction](./valkyrie-js.entities.notereaction) + +## entities.NoteReaction type + +**Signature:** + +```typescript +export declare type NoteReaction = { + id: ID; + createdAt: DateString; + user: UserLite; + type: string; +}; +``` +**References:** [ID](./valkyrie-js.entities.id), [DateString](./valkyrie-js.entities.datestring), [UserLite](./valkyrie-js.entities.userlite) + diff --git a/docs/api/valkyrie-js.entities.notification.md b/docs/api/valkyrie-js.entities.notification.md new file mode 100644 index 0000000..098d41e --- /dev/null +++ b/docs/api/valkyrie-js.entities.notification.md @@ -0,0 +1,82 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [Notification](./valkyrie-js.entities.notification) + +## entities.Notification type + +**Signature:** + +```typescript +export declare type Notification = { + id: ID; + createdAt: DateString; + isRead: boolean; +} & ( + | { + type: "reaction"; + reaction: string; + user: User; + userId: User["id"]; + note: Note; + } + | { + type: "reply"; + user: User; + userId: User["id"]; + note: Note; + } + | { + type: "renote"; + user: User; + userId: User["id"]; + note: Note; + } + | { + type: "quote"; + user: User; + userId: User["id"]; + note: Note; + } + | { + type: "mention"; + user: User; + userId: User["id"]; + note: Note; + } + | { + type: "pollVote"; + user: User; + userId: User["id"]; + note: Note; + } + | { + type: "follow"; + user: User; + userId: User["id"]; + } + | { + type: "followRequestAccepted"; + user: User; + userId: User["id"]; + } + | { + type: "receiveFollowRequest"; + user: User; + userId: User["id"]; + } + | { + type: "groupInvited"; + invitation: UserGroup; + user: User; + userId: User["id"]; + } + | { + type: "app"; + header?: string | null; + body: string; + icon?: string | null; + } +); +``` +**References:** [ID](./valkyrie-js.entities.id), [DateString](./valkyrie-js.entities.datestring), [User](./valkyrie-js.entities.user), [Note](./valkyrie-js.entities.note), [UserGroup](./valkyrie-js.entities.usergroup) + diff --git a/docs/api/valkyrie-js.entities.origintype.md b/docs/api/valkyrie-js.entities.origintype.md new file mode 100644 index 0000000..c135400 --- /dev/null +++ b/docs/api/valkyrie-js.entities.origintype.md @@ -0,0 +1,11 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [OriginType](./valkyrie-js.entities.origintype) + +## entities.OriginType type + +**Signature:** + +```typescript +export declare type OriginType = "combined" | "local" | "remote"; +``` diff --git a/docs/api/valkyrie-js.entities.page.md b/docs/api/valkyrie-js.entities.page.md new file mode 100644 index 0000000..875c543 --- /dev/null +++ b/docs/api/valkyrie-js.entities.page.md @@ -0,0 +1,33 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [Page](./valkyrie-js.entities.page) + +## entities.Page type + +**Signature:** + +```typescript +export declare type Page = { + id: ID; + createdAt: DateString; + updatedAt: DateString; + userId: User["id"]; + user: User; + content: Record[]; + variables: Record[]; + title: string; + name: string; + summary: string | null; + hideTitleWhenPinned: boolean; + alignCenter: boolean; + font: string; + script: string; + eyeCatchingImageId: DriveFile["id"] | null; + eyeCatchingImage: DriveFile | null; + attachedFiles: any; + likedCount: number; + isLiked?: boolean; +}; +``` +**References:** [ID](./valkyrie-js.entities.id), [DateString](./valkyrie-js.entities.datestring), [User](./valkyrie-js.entities.user), [DriveFile](./valkyrie-js.entities.drivefile) + diff --git a/docs/api/valkyrie-js.entities.pageevent.md b/docs/api/valkyrie-js.entities.pageevent.md new file mode 100644 index 0000000..63daca8 --- /dev/null +++ b/docs/api/valkyrie-js.entities.pageevent.md @@ -0,0 +1,19 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [PageEvent](./valkyrie-js.entities.pageevent) + +## entities.PageEvent type + +**Signature:** + +```typescript +export declare type PageEvent = { + pageId: Page["id"]; + event: string; + var: any; + userId: User["id"]; + user: User; +}; +``` +**References:** [Page](./valkyrie-js.entities.page), [User](./valkyrie-js.entities.user) + diff --git a/docs/api/valkyrie-js.entities.serverinfo.md b/docs/api/valkyrie-js.entities.serverinfo.md new file mode 100644 index 0000000..7b22c43 --- /dev/null +++ b/docs/api/valkyrie-js.entities.serverinfo.md @@ -0,0 +1,24 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [ServerInfo](./valkyrie-js.entities.serverinfo) + +## entities.ServerInfo type + +**Signature:** + +```typescript +export declare type ServerInfo = { + machine: string; + cpu: { + model: string; + cores: number; + }; + mem: { + total: number; + }; + fs: { + total: number; + used: number; + }; +}; +``` diff --git a/docs/api/valkyrie-js.entities.signin.md b/docs/api/valkyrie-js.entities.signin.md new file mode 100644 index 0000000..e577c27 --- /dev/null +++ b/docs/api/valkyrie-js.entities.signin.md @@ -0,0 +1,19 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [Signin](./valkyrie-js.entities.signin) + +## entities.Signin type + +**Signature:** + +```typescript +export declare type Signin = { + id: ID; + createdAt: DateString; + ip: string; + headers: Record; + success: boolean; +}; +``` +**References:** [ID](./valkyrie-js.entities.id), [DateString](./valkyrie-js.entities.datestring) + diff --git a/docs/api/valkyrie-js.entities.stats.md b/docs/api/valkyrie-js.entities.stats.md new file mode 100644 index 0000000..1ffa3ca --- /dev/null +++ b/docs/api/valkyrie-js.entities.stats.md @@ -0,0 +1,19 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [Stats](./valkyrie-js.entities.stats) + +## entities.Stats type + +**Signature:** + +```typescript +export declare type Stats = { + notesCount: number; + originalNotesCount: number; + usersCount: number; + originalUsersCount: number; + instances: number; + driveUsageLocal: number; + driveUsageRemote: number; +}; +``` diff --git a/docs/api/valkyrie-js.entities.user.md b/docs/api/valkyrie-js.entities.user.md new file mode 100644 index 0000000..43e9221 --- /dev/null +++ b/docs/api/valkyrie-js.entities.user.md @@ -0,0 +1,13 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [User](./valkyrie-js.entities.user) + +## entities.User type + +**Signature:** + +```typescript +export declare type User = UserLite | UserDetailed; +``` +**References:** [UserLite](./valkyrie-js.entities.userlite), [UserDetailed](./valkyrie-js.entities.userdetailed) + diff --git a/docs/api/valkyrie-js.entities.userdetailed.md b/docs/api/valkyrie-js.entities.userdetailed.md new file mode 100644 index 0000000..b432327 --- /dev/null +++ b/docs/api/valkyrie-js.entities.userdetailed.md @@ -0,0 +1,56 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [UserDetailed](./valkyrie-js.entities.userdetailed) + +## entities.UserDetailed type + +**Signature:** + +```typescript +export declare type UserDetailed = UserLite & { + bannerBlurhash: string | null; + bannerColor: string | null; + bannerUrl: string | null; + birthday: string | null; + createdAt: DateString; + description: string | null; + ffVisibility: "public" | "followers" | "private"; + fields: { + name: string; + value: string; + }[]; + followersCount: number; + followingCount: number; + hasPendingFollowRequestFromYou: boolean; + hasPendingFollowRequestToYou: boolean; + isAdmin: boolean; + isBlocked: boolean; + isBlocking: boolean; + isBot: boolean; + isCat: boolean; + isFollowed: boolean; + isFollowing: boolean; + isLocked: boolean; + isModerator: boolean; + isMuted: boolean; + isRenoteMuted: boolean; + isSilenced: boolean; + isSuspended: boolean; + lang: string | null; + lastFetchedAt?: DateString; + location: string | null; + notesCount: number; + pinnedNoteIds: ID[]; + pinnedNotes: Note[]; + pinnedPage: Page | null; + pinnedPageId: string | null; + publicReactions: boolean; + securityKeys: boolean; + twoFactorEnabled: boolean; + updatedAt: DateString | null; + uri: string | null; + url: string | null; +}; +``` +**References:** [UserLite](./valkyrie-js.entities.userlite), [DateString](./valkyrie-js.entities.datestring), [ID](./valkyrie-js.entities.id), [Note](./valkyrie-js.entities.note), [Page](./valkyrie-js.entities.page) + diff --git a/docs/api/valkyrie-js.entities.usergroup.md b/docs/api/valkyrie-js.entities.usergroup.md new file mode 100644 index 0000000..564eac4 --- /dev/null +++ b/docs/api/valkyrie-js.entities.usergroup.md @@ -0,0 +1,11 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [UserGroup](./valkyrie-js.entities.usergroup) + +## entities.UserGroup type + +**Signature:** + +```typescript +export declare type UserGroup = TODO; +``` diff --git a/docs/api/valkyrie-js.entities.userlist.md b/docs/api/valkyrie-js.entities.userlist.md new file mode 100644 index 0000000..7e8aad3 --- /dev/null +++ b/docs/api/valkyrie-js.entities.userlist.md @@ -0,0 +1,18 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [UserList](./valkyrie-js.entities.userlist) + +## entities.UserList type + +**Signature:** + +```typescript +export declare type UserList = { + id: ID; + createdAt: DateString; + name: string; + userIds: User["id"][]; +}; +``` +**References:** [ID](./valkyrie-js.entities.id), [DateString](./valkyrie-js.entities.datestring), [User](./valkyrie-js.entities.user) + diff --git a/docs/api/valkyrie-js.entities.userlite.md b/docs/api/valkyrie-js.entities.userlite.md new file mode 100644 index 0000000..9020c50 --- /dev/null +++ b/docs/api/valkyrie-js.entities.userlite.md @@ -0,0 +1,35 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [UserLite](./valkyrie-js.entities.userlite) + +## entities.UserLite type + +**Signature:** + +```typescript +export declare type UserLite = { + id: ID; + username: string; + host: string | null; + name: string; + onlineStatus: "online" | "active" | "offline" | "unknown"; + avatarUrl: string; + avatarBlurhash: string; + alsoKnownAs: string[]; + movedToUri: any; + emojis: { + name: string; + url: string; + }[]; + instance?: { + name: Instance["name"]; + softwareName: Instance["softwareName"]; + softwareVersion: Instance["softwareVersion"]; + iconUrl: Instance["iconUrl"]; + faviconUrl: Instance["faviconUrl"]; + themeColor: Instance["themeColor"]; + }; +}; +``` +**References:** [ID](./valkyrie-js.entities.id), [Instance](./valkyrie-js.entities.instance) + diff --git a/docs/api/valkyrie-js.entities.usersorting.md b/docs/api/valkyrie-js.entities.usersorting.md new file mode 100644 index 0000000..9ca70ef --- /dev/null +++ b/docs/api/valkyrie-js.entities.usersorting.md @@ -0,0 +1,17 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [entities](./valkyrie-js.entities) > [UserSorting](./valkyrie-js.entities.usersorting) + +## entities.UserSorting type + +**Signature:** + +```typescript +export declare type UserSorting = + | "+follower" + | "-follower" + | "+createdAt" + | "-createdAt" + | "+updatedAt" + | "-updatedAt"; +``` diff --git a/docs/api/valkyrie-js.ffvisibility.md b/docs/api/valkyrie-js.ffvisibility.md new file mode 100644 index 0000000..766d444 --- /dev/null +++ b/docs/api/valkyrie-js.ffvisibility.md @@ -0,0 +1,11 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [ffVisibility](./valkyrie-js.ffvisibility) + +## ffVisibility variable + +**Signature:** + +```typescript +ffVisibility: readonly ["public", "followers", "private"] +``` diff --git a/docs/api/valkyrie-js.md b/docs/api/valkyrie-js.md new file mode 100644 index 0000000..0cc526e --- /dev/null +++ b/docs/api/valkyrie-js.md @@ -0,0 +1,43 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) + +## valkyrie-js package + +## Classes + +| Class | Description | +| --- | --- | +| [Stream](./valkyrie-js.stream) | | + +## Abstract Classes + +| Abstract Class | Description | +| --- | --- | +| [ChannelConnection](./valkyrie-js.channelconnection) | | + +## Namespaces + +| Namespace | Description | +| --- | --- | +| [api](./valkyrie-js.api) | | +| [entities](./valkyrie-js.entities) | | + +## Variables + +| Variable | Description | +| --- | --- | +| [ffVisibility](./valkyrie-js.ffvisibility) | | +| [mutedNoteReasons](./valkyrie-js.mutednotereasons) | | +| [noteVisibilities](./valkyrie-js.notevisibilities) | | +| [notificationTypes](./valkyrie-js.notificationtypes) | | +| [permissions](./valkyrie-js.permissions) | | + +## Type Aliases + +| Type Alias | Description | +| --- | --- | +| [Acct](./valkyrie-js.acct) | | +| [Channels](./valkyrie-js.channels) | | +| [Endpoints](./valkyrie-js.endpoints) | | + diff --git a/docs/api/valkyrie-js.mutednotereasons.md b/docs/api/valkyrie-js.mutednotereasons.md new file mode 100644 index 0000000..a967216 --- /dev/null +++ b/docs/api/valkyrie-js.mutednotereasons.md @@ -0,0 +1,16 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [mutedNoteReasons](./valkyrie-js.mutednotereasons) + +## mutedNoteReasons variable + +**Signature:** + +```typescript +mutedNoteReasons: readonly [ + "word", + "manual", + "spam", + "other", +] +``` diff --git a/docs/api/valkyrie-js.notevisibilities.md b/docs/api/valkyrie-js.notevisibilities.md new file mode 100644 index 0000000..24e5795 --- /dev/null +++ b/docs/api/valkyrie-js.notevisibilities.md @@ -0,0 +1,16 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [noteVisibilities](./valkyrie-js.notevisibilities) + +## noteVisibilities variable + +**Signature:** + +```typescript +noteVisibilities: readonly [ + "public", + "home", + "followers", + "specified", +] +``` diff --git a/docs/api/valkyrie-js.notificationtypes.md b/docs/api/valkyrie-js.notificationtypes.md new file mode 100644 index 0000000..f4d03fd --- /dev/null +++ b/docs/api/valkyrie-js.notificationtypes.md @@ -0,0 +1,24 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [notificationTypes](./valkyrie-js.notificationtypes) + +## notificationTypes variable + +**Signature:** + +```typescript +notificationTypes: readonly [ + "follow", + "mention", + "reply", + "renote", + "quote", + "reaction", + "pollVote", + "pollEnded", + "receiveFollowRequest", + "followRequestAccepted", + "groupInvited", + "app", +] +``` diff --git a/docs/api/valkyrie-js.permissions.md b/docs/api/valkyrie-js.permissions.md new file mode 100644 index 0000000..0fabe3e --- /dev/null +++ b/docs/api/valkyrie-js.permissions.md @@ -0,0 +1,11 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [permissions](./valkyrie-js.permissions) + +## permissions variable + +**Signature:** + +```typescript +permissions: string[] +``` diff --git a/docs/api/valkyrie-js.stream._constructor_.md b/docs/api/valkyrie-js.stream._constructor_.md new file mode 100644 index 0000000..e2de8d7 --- /dev/null +++ b/docs/api/valkyrie-js.stream._constructor_.md @@ -0,0 +1,30 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [Stream](./valkyrie-js.stream) > [(constructor)](./valkyrie-js.stream._constructor_) + +## Stream.(constructor) + +Constructs a new instance of the `Stream` class + +**Signature:** + +```typescript +constructor( + origin: string, + user: { + token: string; + } | null, + options?: { + WebSocket?: any; + }, + ); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| origin | string | | +| user | { token: string; } \| null | | +| options | { WebSocket?: any; } | _(Optional)_ | + diff --git a/docs/api/valkyrie-js.stream.close.md b/docs/api/valkyrie-js.stream.close.md new file mode 100644 index 0000000..204c8af --- /dev/null +++ b/docs/api/valkyrie-js.stream.close.md @@ -0,0 +1,15 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [Stream](./valkyrie-js.stream) > [close](./valkyrie-js.stream.close) + +## Stream.close() method + +**Signature:** + +```typescript +close(): void; +``` +**Returns:** + +void + diff --git a/docs/api/valkyrie-js.stream.disconnecttochannel.md b/docs/api/valkyrie-js.stream.disconnecttochannel.md new file mode 100644 index 0000000..60bcada --- /dev/null +++ b/docs/api/valkyrie-js.stream.disconnecttochannel.md @@ -0,0 +1,22 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [Stream](./valkyrie-js.stream) > [disconnectToChannel](./valkyrie-js.stream.disconnecttochannel) + +## Stream.disconnectToChannel() method + +**Signature:** + +```typescript +disconnectToChannel(connection: NonSharedConnection): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| connection | NonSharedConnection | | + +**Returns:** + +void + diff --git a/docs/api/valkyrie-js.stream.md b/docs/api/valkyrie-js.stream.md new file mode 100644 index 0000000..b52b5f9 --- /dev/null +++ b/docs/api/valkyrie-js.stream.md @@ -0,0 +1,36 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [Stream](./valkyrie-js.stream) + +## Stream class + +**Signature:** + +```typescript +export default class Stream extends EventEmitter +``` +**Extends:** EventEmitter<StreamEvents> + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(origin, user, options)](./valkyrie-js.stream._constructor_) | | Constructs a new instance of the Stream class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [state](./valkyrie-js.stream.state) | | "initializing" \| "reconnecting" \| "connected" | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [close()](./valkyrie-js.stream.close) | | | +| [disconnectToChannel(connection)](./valkyrie-js.stream.disconnecttochannel) | | | +| [removeSharedConnection(connection)](./valkyrie-js.stream.removesharedconnection) | | | +| [removeSharedConnectionPool(pool)](./valkyrie-js.stream.removesharedconnectionpool) | | | +| [send(typeOrPayload, payload)](./valkyrie-js.stream.send) | | | +| [useChannel(channel, params, name)](./valkyrie-js.stream.usechannel) | | | + diff --git a/docs/api/valkyrie-js.stream.removesharedconnection.md b/docs/api/valkyrie-js.stream.removesharedconnection.md new file mode 100644 index 0000000..4732830 --- /dev/null +++ b/docs/api/valkyrie-js.stream.removesharedconnection.md @@ -0,0 +1,22 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [Stream](./valkyrie-js.stream) > [removeSharedConnection](./valkyrie-js.stream.removesharedconnection) + +## Stream.removeSharedConnection() method + +**Signature:** + +```typescript +removeSharedConnection(connection: SharedConnection): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| connection | SharedConnection | | + +**Returns:** + +void + diff --git a/docs/api/valkyrie-js.stream.removesharedconnectionpool.md b/docs/api/valkyrie-js.stream.removesharedconnectionpool.md new file mode 100644 index 0000000..520a664 --- /dev/null +++ b/docs/api/valkyrie-js.stream.removesharedconnectionpool.md @@ -0,0 +1,22 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [Stream](./valkyrie-js.stream) > [removeSharedConnectionPool](./valkyrie-js.stream.removesharedconnectionpool) + +## Stream.removeSharedConnectionPool() method + +**Signature:** + +```typescript +removeSharedConnectionPool(pool: Pool): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| pool | Pool | | + +**Returns:** + +void + diff --git a/docs/api/valkyrie-js.stream.send.md b/docs/api/valkyrie-js.stream.send.md new file mode 100644 index 0000000..e5c11bc --- /dev/null +++ b/docs/api/valkyrie-js.stream.send.md @@ -0,0 +1,23 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [Stream](./valkyrie-js.stream) > [send](./valkyrie-js.stream.send) + +## Stream.send() method + +**Signature:** + +```typescript +send(typeOrPayload: any, payload?: any): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| typeOrPayload | any | | +| payload | any | _(Optional)_ | + +**Returns:** + +void + diff --git a/docs/api/valkyrie-js.stream.state.md b/docs/api/valkyrie-js.stream.state.md new file mode 100644 index 0000000..c06b418 --- /dev/null +++ b/docs/api/valkyrie-js.stream.state.md @@ -0,0 +1,11 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [Stream](./valkyrie-js.stream) > [state](./valkyrie-js.stream.state) + +## Stream.state property + +**Signature:** + +```typescript +state: "initializing" | "reconnecting" | "connected"; +``` diff --git a/docs/api/valkyrie-js.stream.usechannel.md b/docs/api/valkyrie-js.stream.usechannel.md new file mode 100644 index 0000000..60262f5 --- /dev/null +++ b/docs/api/valkyrie-js.stream.usechannel.md @@ -0,0 +1,28 @@ + + +[Home](./index) > [valkyrie-js](./valkyrie-js) > [Stream](./valkyrie-js.stream) > [useChannel](./valkyrie-js.stream.usechannel) + +## Stream.useChannel() method + +**Signature:** + +```typescript +useChannel( + channel: C, + params?: Channels[C]["params"], + name?: string, + ): Connection; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| channel | C | | +| params | [Channels](./valkyrie-js.channels)\[C\]\["params"\] | _(Optional)_ | +| name | string | _(Optional)_ | + +**Returns:** + +[Connection](./valkyrie-js.channelconnection)<[Channels](./valkyrie-js.channels)\[C\]> +