misskey/packages/misskey-js/etc/misskey-js.api.md

3070 lines
117 KiB
Markdown
Raw Normal View History

## API Report File for "misskey-js"
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { EventEmitter } from 'eventemitter3';
// @public (undocumented)
export type Acct = {
username: string;
host: string | null;
};
declare namespace acct {
export {
parse,
toString_2 as toString,
Acct
}
}
export { acct }
// Warning: (ae-forgotten-export) The symbol "components" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
type Ad = components['schemas']['Ad'];
// Warning: (ae-forgotten-export) The symbol "operations" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
type AdminAbuseUserReportsRequest = operations['admin/abuse-user-reports']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminAbuseUserReportsResponse = operations['admin/abuse-user-reports']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminAccountsCreateRequest = operations['admin/accounts/create']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminAccountsCreateResponse = operations['admin/accounts/create']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminAccountsDeleteRequest = operations['admin/accounts/delete']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminAccountsFindByEmailRequest = operations['admin/accounts/find-by-email']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminAccountsFindByEmailResponse = operations['admin/accounts/find-by-email']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminAdCreateRequest = operations['admin/ad/create']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminAdCreateResponse = operations['admin/ad/create']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminAdDeleteRequest = operations['admin/ad/delete']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminAdListRequest = operations['admin/ad/list']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminAdListResponse = operations['admin/ad/list']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminAdUpdateRequest = operations['admin/ad/update']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminAnnouncementsCreateRequest = operations['admin/announcements/create']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminAnnouncementsCreateResponse = operations['admin/announcements/create']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminAnnouncementsDeleteRequest = operations['admin/announcements/delete']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminAnnouncementsListRequest = operations['admin/announcements/list']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminAnnouncementsListResponse = operations['admin/announcements/list']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminAnnouncementsUpdateRequest = operations['admin/announcements/update']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminAvatarDecorationsCreateRequest = operations['admin/avatar-decorations/create']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminAvatarDecorationsDeleteRequest = operations['admin/avatar-decorations/delete']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminAvatarDecorationsListRequest = operations['admin/avatar-decorations/list']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminAvatarDecorationsListResponse = operations['admin/avatar-decorations/list']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminAvatarDecorationsUpdateRequest = operations['admin/avatar-decorations/update']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminDeleteAccountRequest = operations['admin/delete-account']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminDeleteAccountResponse = operations['admin/delete-account']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminDeleteAllFilesOfAUserRequest = operations['admin/delete-all-files-of-a-user']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminDriveFilesRequest = operations['admin/drive/files']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminDriveFilesResponse = operations['admin/drive/files']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminDriveShowFileRequest = operations['admin/drive/show-file']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminDriveShowFileResponse = operations['admin/drive/show-file']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminEmojiAddAliasesBulkRequest = operations['admin/emoji/add-aliases-bulk']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminEmojiAddRequest = operations['admin/emoji/add']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminEmojiCopyRequest = operations['admin/emoji/copy']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminEmojiCopyResponse = operations['admin/emoji/copy']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminEmojiDeleteBulkRequest = operations['admin/emoji/delete-bulk']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminEmojiDeleteRequest = operations['admin/emoji/delete']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminEmojiImportZipRequest = operations['admin/emoji/import-zip']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminEmojiListRemoteRequest = operations['admin/emoji/list-remote']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminEmojiListRemoteResponse = operations['admin/emoji/list-remote']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminEmojiListRequest = operations['admin/emoji/list']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminEmojiListResponse = operations['admin/emoji/list']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminEmojiRemoveAliasesBulkRequest = operations['admin/emoji/remove-aliases-bulk']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminEmojiSetAliasesBulkRequest = operations['admin/emoji/set-aliases-bulk']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminEmojiSetCategoryBulkRequest = operations['admin/emoji/set-category-bulk']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminEmojiSetLicenseBulkRequest = operations['admin/emoji/set-license-bulk']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminEmojiUpdateRequest = operations['admin/emoji/update']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminFederationDeleteAllFilesRequest = operations['admin/federation/delete-all-files']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminFederationRefreshRemoteInstanceMetadataRequest = operations['admin/federation/refresh-remote-instance-metadata']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminFederationRemoveAllFollowingRequest = operations['admin/federation/remove-all-following']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminFederationUpdateInstanceRequest = operations['admin/federation/update-instance']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminGetIndexStatsResponse = operations['admin/get-index-stats']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminGetTableStatsResponse = operations['admin/get-table-stats']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminGetUserIpsRequest = operations['admin/get-user-ips']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminGetUserIpsResponse = operations['admin/get-user-ips']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminInviteCreateRequest = operations['admin/invite/create']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminInviteCreateResponse = operations['admin/invite/create']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminInviteListRequest = operations['admin/invite/list']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminInviteListResponse = operations['admin/invite/list']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminMetaResponse = operations['admin/meta']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminPromoCreateRequest = operations['admin/promo/create']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminQueueDeliverDelayedResponse = operations['admin/queue/deliver-delayed']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminQueueInboxDelayedResponse = operations['admin/queue/inbox-delayed']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminQueuePromoteRequest = operations['admin/queue/promote']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminQueueStatsResponse = operations['admin/queue/stats']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminRelaysAddRequest = operations['admin/relays/add']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminRelaysAddResponse = operations['admin/relays/add']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminRelaysListResponse = operations['admin/relays/list']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminRelaysRemoveRequest = operations['admin/relays/remove']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminResetPasswordRequest = operations['admin/reset-password']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminResetPasswordResponse = operations['admin/reset-password']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminResolveAbuseUserReportRequest = operations['admin/resolve-abuse-user-report']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminRolesAssignRequest = operations['admin/roles/assign']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminRolesCreateRequest = operations['admin/roles/create']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminRolesCreateResponse = operations['admin/roles/create']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminRolesDeleteRequest = operations['admin/roles/delete']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminRolesListResponse = operations['admin/roles/list']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminRolesShowRequest = operations['admin/roles/show']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminRolesShowResponse = operations['admin/roles/show']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminRolesUnassignRequest = operations['admin/roles/unassign']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminRolesUpdateDefaultPoliciesRequest = operations['admin/roles/update-default-policies']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminRolesUpdateRequest = operations['admin/roles/update']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminRolesUsersRequest = operations['admin/roles/users']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminRolesUsersResponse = operations['admin/roles/users']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminSendEmailRequest = operations['admin/send-email']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminServerInfoResponse = operations['admin/server-info']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminShowModerationLogsRequest = operations['admin/show-moderation-logs']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminShowModerationLogsResponse = operations['admin/show-moderation-logs']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminShowUserRequest = operations['admin/show-user']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminShowUserResponse = operations['admin/show-user']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminShowUsersRequest = operations['admin/show-users']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminShowUsersResponse = operations['admin/show-users']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AdminSuspendUserRequest = operations['admin/suspend-user']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminUnsetUserAvatarRequest = operations['admin/unset-user-avatar']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminUnsetUserBannerRequest = operations['admin/unset-user-banner']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminUnsuspendUserRequest = operations['admin/unsuspend-user']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminUpdateMetaRequest = operations['admin/update-meta']['requestBody']['content']['application/json'];
// @public (undocumented)
type AdminUpdateUserNoteRequest = operations['admin/update-user-note']['requestBody']['content']['application/json'];
// @public (undocumented)
type Announcement = components['schemas']['Announcement'];
// @public (undocumented)
type AnnouncementCreated = {
announcement: Announcement;
};
// @public (undocumented)
type AnnouncementsRequest = operations['announcements']['requestBody']['content']['application/json'];
// @public (undocumented)
type AnnouncementsResponse = operations['announcements']['responses']['200']['content']['application/json'];
// @public (undocumented)
type Antenna = components['schemas']['Antenna'];
// @public (undocumented)
type AntennasCreateRequest = operations['antennas/create']['requestBody']['content']['application/json'];
// @public (undocumented)
type AntennasCreateResponse = operations['antennas/create']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AntennasDeleteRequest = operations['antennas/delete']['requestBody']['content']['application/json'];
// @public (undocumented)
type AntennasListResponse = operations['antennas/list']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AntennasNotesRequest = operations['antennas/notes']['requestBody']['content']['application/json'];
// @public (undocumented)
type AntennasNotesResponse = operations['antennas/notes']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AntennasShowRequest = operations['antennas/show']['requestBody']['content']['application/json'];
// @public (undocumented)
type AntennasShowResponse = operations['antennas/show']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AntennasUpdateRequest = operations['antennas/update']['requestBody']['content']['application/json'];
// @public (undocumented)
type AntennasUpdateResponse = operations['antennas/update']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ApGetRequest = operations['ap/get']['requestBody']['content']['application/json'];
// @public (undocumented)
type ApGetResponse = operations['ap/get']['responses']['200']['content']['application/json'];
declare namespace api {
export {
isAPIError,
SwitchCaseResponseType,
APIError,
FetchLike,
APIClient
}
}
export { api }
// @public (undocumented)
class APIClient {
constructor(opts: {
origin: APIClient['origin'];
credential?: APIClient['credential'];
fetch?: APIClient['fetch'] | null | undefined;
});
// (undocumented)
credential: string | null | undefined;
// (undocumented)
fetch: FetchLike;
// (undocumented)
origin: string;
}
// @public (undocumented)
type APIError = {
id: string;
code: string;
message: string;
kind: 'client' | 'server';
info: Record<string, any>;
};
// @public (undocumented)
type App = components['schemas']['App'];
// @public (undocumented)
type AppCreateRequest = operations['app/create']['requestBody']['content']['application/json'];
// @public (undocumented)
type AppCreateResponse = operations['app/create']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AppShowRequest = operations['app/show']['requestBody']['content']['application/json'];
// @public (undocumented)
type AppShowResponse = operations['app/show']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ApShowRequest = operations['ap/show']['requestBody']['content']['application/json'];
// @public (undocumented)
type ApShowResponse = operations['ap/show']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AuthAcceptRequest = operations['auth/accept']['requestBody']['content']['application/json'];
// @public (undocumented)
type AuthSessionGenerateRequest = operations['auth/session/generate']['requestBody']['content']['application/json'];
// @public (undocumented)
type AuthSessionGenerateResponse = operations['auth/session/generate']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AuthSessionShowRequest = operations['auth/session/show']['requestBody']['content']['application/json'];
// @public (undocumented)
type AuthSessionShowResponse = operations['auth/session/show']['responses']['200']['content']['application/json'];
// @public (undocumented)
type AuthSessionUserkeyRequest = operations['auth/session/userkey']['requestBody']['content']['application/json'];
// @public (undocumented)
type AuthSessionUserkeyResponse = operations['auth/session/userkey']['responses']['200']['content']['application/json'];
// @public (undocumented)
type Blocking = components['schemas']['Blocking'];
// @public (undocumented)
type BlockingCreateRequest = operations['blocking/create']['requestBody']['content']['application/json'];
// @public (undocumented)
type BlockingCreateResponse = operations['blocking/create']['responses']['200']['content']['application/json'];
// @public (undocumented)
type BlockingDeleteRequest = operations['blocking/delete']['requestBody']['content']['application/json'];
// @public (undocumented)
type BlockingDeleteResponse = operations['blocking/delete']['responses']['200']['content']['application/json'];
// @public (undocumented)
type BlockingListRequest = operations['blocking/list']['requestBody']['content']['application/json'];
// @public (undocumented)
type BlockingListResponse = operations['blocking/list']['responses']['200']['content']['application/json'];
// @public (undocumented)
type BubbleGameRankingRequest = operations['bubble-game/ranking']['requestBody']['content']['application/json'];
// @public (undocumented)
type BubbleGameRankingResponse = operations['bubble-game/ranking']['responses']['200']['content']['application/json'];
// @public (undocumented)
type BubbleGameRegisterRequest = operations['bubble-game/register']['requestBody']['content']['application/json'];
// @public (undocumented)
type BubbleGameRegisterResponse = operations['bubble-game/register']['responses']['200']['content']['application/json'];
// @public (undocumented)
type Channel = components['schemas']['Channel'];
// Warning: (ae-forgotten-export) The symbol "AnyOf" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export abstract class ChannelConnection<Channel extends AnyOf<Channels> = any> extends EventEmitter<Channel['events']> {
constructor(stream: Stream, channel: string, name?: string);
// (undocumented)
channel: string;
// (undocumented)
abstract dispose(): void;
// (undocumented)
abstract id: string;
// (undocumented)
inCount: number;
// (undocumented)
name?: string;
// (undocumented)
outCount: number;
// (undocumented)
send<T extends keyof Channel['receives']>(type: T, body: Channel['receives'][T]): void;
// (undocumented)
protected stream: Stream;
}
// @public (undocumented)
export type Channels = {
main: {
params: null;
events: {
notification: (payload: Notification_2) => void;
mention: (payload: Note) => void;
reply: (payload: Note) => void;
renote: (payload: Note) => void;
refactor: frontendのcomponentsの型エラーを改善 (#12926) * add: safeFloatParserを追加 * fix: 欠けていた型を追加 * refactor: pageBlockTypesをjson-schemaに移植 * refactor: components/global内の型エラーが出ている箇所を修正 * lint: fix null check style * refactor: fix type error * refactor: fix some type errors * fix: 翻訳が抜けていた箇所を修正 * refactor: getJsonSchemaで正しいスキーマが返されるように修正 * fix: MkChartの型エラーとbytesオプションが機能していない問題を修正 * fix(misskey-js): `drive`->`folderUpdated`のpayloadの型が間違っていたのを修正 * refactor: fix some type errors * change: Captcha読み込み中の文言をLoadingに変更 * refactor(backend/misskey-js): MainEventの型を改善 * refactor: chartjs-plugin-gradientが二重でpluginに登録されていたのを修正 * update: misskey-js.api.md * refactor: fix some type errors * fix: backendのtypecheckが落ちていたのを修正 * update: misskey-js.api.md * add: json-schemaのnoteにpollの型定義を追加 * refactor: noteのjson-schemaの型を改善 * refactor: MkPoll * refactor: fix some type errors * change: UserLiteにisLockedを持たせるように * fix: notificationスキーマにroleが含まれていないのを修正 * Revert "change: UserLiteにisLockedを持たせるように" This reverts commit 1bb0c8e7a9b19a4e9f21bf7381712b98f27672a5. * fix: フォロー通知から鍵垢へのフォローを行うと処理中のまま止まってしまう問題を修正 * refactor: noteスキーマのvisibilityにenumを追加 * change: deepCloneのCloneableTypeにundefinedを追加 * refactor: fix some type errors * refactor: `allowEmpty: false`を使用していた箇所を`minLength: 1`に置き換え * enhance: API 'retension' のresponseの型を追加 * fix: Chart関連のtooltipが正しい位置に表示されない問題を修正 * refactor: fix some type errors * fix: 型情報が不足していたのを修正 * enhance: announcementスキーマにenumを追加 * enhance: ロールポリシーの型定義をRoleServiceからjson-schemaに移植 * refactor: policiesを`ref: RolePolicies`に統一 * fix: API `meta` のレスポンスの型にpoliciesが含まれていないのを修正 * refactor: fix some type errors * fix: backendのlintが落ちているのを修正 * fix: MkFoldableSectionの開閉時のanimationが適用されていない問題を修正 * fix: backendのtypecheckが落ちているのを修正 * update: run build-misskey-js-with-types * fix: MkDialogのmount時に文字数制限の判定が行われない問題を修正 * update: CHANGELOG.md * refactor: MkUserSelectDialogの型を改善 * fix: deepCloneでundefinedはcloneしないように (#9207) * change: frontendのcloneをbackend側にも反映 * update: CHANGELOG.md * fix: RoleServiceからPackを通して型RolePoliciesに依存させないように * Update packages/frontend/src/scripts/get-note-summary.ts * revert RoleService.ts changes * change: optional chaining -> non-null assertion * remove: unused import * fix: propsで渡されたuserがUserLiteの場合に意図しない動作になってしまうのを修正 * change: fix null check style * refactor: fix type error * change: fix null check style * Update packages/frontend/src/components/MkDrive.vue Co-authored-by: syuilo <Syuilotan@yahoo.co.jp> * refactor: css moduleでglobalを使わないように * refactor: roleのiconUrlは必ず存在するものとして扱うように * enhance: MenuButtonのactiveにcomputedを受け付けられるように * Update packages/frontend/src/components/MkNotePreview.vue * Update MkWindow.vue * refactor: notification.noteは必ず存在するものとして扱うように * Update packages/frontend/src/components/MkNotification.vue Co-authored-by: syuilo <Syuilotan@yahoo.co.jp> * fix: MkSignupDialogでdoneのemit時にresを含んでいなかったのを修正 * Update packages/frontend/src/scripts/clone.ts Co-authored-by: syuilo <Syuilotan@yahoo.co.jp> * refactor: 不要な返り値の型を削除 * refactor: 不要なnullチェックを削除 * update: misskey-js-autogen * update: clone.ts * refactor * Update MkNotification.vue * Update MkNotification.vue * :v: * Update MkNotification.vue * Update MkNotification.vue * Update MkNotification.vue * Update MkNotifications.vue * Update MkUserSetupDialog.Profile.vue * Update MkUserCardMini.vue * :v: * Update MkMenu.vue --------- Co-authored-by: syuilo <Syuilotan@yahoo.co.jp>
2024-01-30 10:53:53 +00:00
follow: (payload: UserDetailedNotMe) => void;
followed: (payload: UserDetailed | UserLite) => void;
unfollow: (payload: UserDetailed) => void;
meUpdated: (payload: UserDetailed) => void;
pageEvent: (payload: PageEvent) => void;
urlUploadFinished: (payload: {
marker: string;
file: DriveFile;
}) => void;
readAllNotifications: () => void;
unreadNotification: (payload: Notification_2) => void;
unreadMention: (payload: Note['id']) => void;
readAllUnreadMentions: () => void;
unreadSpecifiedNote: (payload: Note['id']) => void;
readAllUnreadSpecifiedNotes: () => void;
readAllAntennas: () => void;
unreadAntenna: (payload: Antenna) => void;
readAllAnnouncements: () => void;
myTokenRegenerated: () => void;
signin: (payload: Signin) => void;
registryUpdated: (payload: {
scope?: string[];
key: string;
value: any | null;
}) => void;
driveFileCreated: (payload: DriveFile) => void;
readAntenna: (payload: Antenna) => void;
receiveFollowRequest: (payload: User) => void;
announcementCreated: (payload: AnnouncementCreated) => void;
};
receives: null;
};
homeTimeline: {
params: {
withRenotes?: boolean;
withFiles?: boolean;
};
events: {
note: (payload: Note) => void;
};
receives: null;
};
localTimeline: {
params: {
withRenotes?: boolean;
withReplies?: boolean;
withFiles?: boolean;
};
events: {
note: (payload: Note) => void;
};
receives: null;
};
hybridTimeline: {
params: {
withRenotes?: boolean;
withReplies?: boolean;
withFiles?: boolean;
};
events: {
note: (payload: Note) => void;
};
receives: null;
};
globalTimeline: {
params: {
withRenotes?: boolean;
withFiles?: boolean;
};
events: {
note: (payload: Note) => void;
};
receives: null;
};
userList: {
params: {
listId: string;
withFiles?: boolean;
refactor: frontendのcomponentsの型エラーを改善 (#12926) * add: safeFloatParserを追加 * fix: 欠けていた型を追加 * refactor: pageBlockTypesをjson-schemaに移植 * refactor: components/global内の型エラーが出ている箇所を修正 * lint: fix null check style * refactor: fix type error * refactor: fix some type errors * fix: 翻訳が抜けていた箇所を修正 * refactor: getJsonSchemaで正しいスキーマが返されるように修正 * fix: MkChartの型エラーとbytesオプションが機能していない問題を修正 * fix(misskey-js): `drive`->`folderUpdated`のpayloadの型が間違っていたのを修正 * refactor: fix some type errors * change: Captcha読み込み中の文言をLoadingに変更 * refactor(backend/misskey-js): MainEventの型を改善 * refactor: chartjs-plugin-gradientが二重でpluginに登録されていたのを修正 * update: misskey-js.api.md * refactor: fix some type errors * fix: backendのtypecheckが落ちていたのを修正 * update: misskey-js.api.md * add: json-schemaのnoteにpollの型定義を追加 * refactor: noteのjson-schemaの型を改善 * refactor: MkPoll * refactor: fix some type errors * change: UserLiteにisLockedを持たせるように * fix: notificationスキーマにroleが含まれていないのを修正 * Revert "change: UserLiteにisLockedを持たせるように" This reverts commit 1bb0c8e7a9b19a4e9f21bf7381712b98f27672a5. * fix: フォロー通知から鍵垢へのフォローを行うと処理中のまま止まってしまう問題を修正 * refactor: noteスキーマのvisibilityにenumを追加 * change: deepCloneのCloneableTypeにundefinedを追加 * refactor: fix some type errors * refactor: `allowEmpty: false`を使用していた箇所を`minLength: 1`に置き換え * enhance: API 'retension' のresponseの型を追加 * fix: Chart関連のtooltipが正しい位置に表示されない問題を修正 * refactor: fix some type errors * fix: 型情報が不足していたのを修正 * enhance: announcementスキーマにenumを追加 * enhance: ロールポリシーの型定義をRoleServiceからjson-schemaに移植 * refactor: policiesを`ref: RolePolicies`に統一 * fix: API `meta` のレスポンスの型にpoliciesが含まれていないのを修正 * refactor: fix some type errors * fix: backendのlintが落ちているのを修正 * fix: MkFoldableSectionの開閉時のanimationが適用されていない問題を修正 * fix: backendのtypecheckが落ちているのを修正 * update: run build-misskey-js-with-types * fix: MkDialogのmount時に文字数制限の判定が行われない問題を修正 * update: CHANGELOG.md * refactor: MkUserSelectDialogの型を改善 * fix: deepCloneでundefinedはcloneしないように (#9207) * change: frontendのcloneをbackend側にも反映 * update: CHANGELOG.md * fix: RoleServiceからPackを通して型RolePoliciesに依存させないように * Update packages/frontend/src/scripts/get-note-summary.ts * revert RoleService.ts changes * change: optional chaining -> non-null assertion * remove: unused import * fix: propsで渡されたuserがUserLiteの場合に意図しない動作になってしまうのを修正 * change: fix null check style * refactor: fix type error * change: fix null check style * Update packages/frontend/src/components/MkDrive.vue Co-authored-by: syuilo <Syuilotan@yahoo.co.jp> * refactor: css moduleでglobalを使わないように * refactor: roleのiconUrlは必ず存在するものとして扱うように * enhance: MenuButtonのactiveにcomputedを受け付けられるように * Update packages/frontend/src/components/MkNotePreview.vue * Update MkWindow.vue * refactor: notification.noteは必ず存在するものとして扱うように * Update packages/frontend/src/components/MkNotification.vue Co-authored-by: syuilo <Syuilotan@yahoo.co.jp> * fix: MkSignupDialogでdoneのemit時にresを含んでいなかったのを修正 * Update packages/frontend/src/scripts/clone.ts Co-authored-by: syuilo <Syuilotan@yahoo.co.jp> * refactor: 不要な返り値の型を削除 * refactor: 不要なnullチェックを削除 * update: misskey-js-autogen * update: clone.ts * refactor * Update MkNotification.vue * Update MkNotification.vue * :v: * Update MkNotification.vue * Update MkNotification.vue * Update MkNotification.vue * Update MkNotifications.vue * Update MkUserSetupDialog.Profile.vue * Update MkUserCardMini.vue * :v: * Update MkMenu.vue --------- Co-authored-by: syuilo <Syuilotan@yahoo.co.jp>
2024-01-30 10:53:53 +00:00
withRenotes?: boolean;
};
events: {
note: (payload: Note) => void;
};
receives: null;
};
hashtag: {
params: {
q?: string;
};
events: {
note: (payload: Note) => void;
};
receives: null;
};
roleTimeline: {
params: {
roleId: string;
};
events: {
note: (payload: Note) => void;
};
receives: null;
};
antenna: {
params: {
antennaId: string;
};
events: {
note: (payload: Note) => void;
};
receives: null;
};
channel: {
params: {
channelId: string;
};
events: {
note: (payload: Note) => void;
};
receives: null;
};
drive: {
params: null;
events: {
fileCreated: (payload: DriveFile) => void;
fileDeleted: (payload: DriveFile['id']) => void;
fileUpdated: (payload: DriveFile) => void;
folderCreated: (payload: DriveFolder) => void;
folderDeleted: (payload: DriveFolder['id']) => void;
refactor: frontendのcomponentsの型エラーを改善 (#12926) * add: safeFloatParserを追加 * fix: 欠けていた型を追加 * refactor: pageBlockTypesをjson-schemaに移植 * refactor: components/global内の型エラーが出ている箇所を修正 * lint: fix null check style * refactor: fix type error * refactor: fix some type errors * fix: 翻訳が抜けていた箇所を修正 * refactor: getJsonSchemaで正しいスキーマが返されるように修正 * fix: MkChartの型エラーとbytesオプションが機能していない問題を修正 * fix(misskey-js): `drive`->`folderUpdated`のpayloadの型が間違っていたのを修正 * refactor: fix some type errors * change: Captcha読み込み中の文言をLoadingに変更 * refactor(backend/misskey-js): MainEventの型を改善 * refactor: chartjs-plugin-gradientが二重でpluginに登録されていたのを修正 * update: misskey-js.api.md * refactor: fix some type errors * fix: backendのtypecheckが落ちていたのを修正 * update: misskey-js.api.md * add: json-schemaのnoteにpollの型定義を追加 * refactor: noteのjson-schemaの型を改善 * refactor: MkPoll * refactor: fix some type errors * change: UserLiteにisLockedを持たせるように * fix: notificationスキーマにroleが含まれていないのを修正 * Revert "change: UserLiteにisLockedを持たせるように" This reverts commit 1bb0c8e7a9b19a4e9f21bf7381712b98f27672a5. * fix: フォロー通知から鍵垢へのフォローを行うと処理中のまま止まってしまう問題を修正 * refactor: noteスキーマのvisibilityにenumを追加 * change: deepCloneのCloneableTypeにundefinedを追加 * refactor: fix some type errors * refactor: `allowEmpty: false`を使用していた箇所を`minLength: 1`に置き換え * enhance: API 'retension' のresponseの型を追加 * fix: Chart関連のtooltipが正しい位置に表示されない問題を修正 * refactor: fix some type errors * fix: 型情報が不足していたのを修正 * enhance: announcementスキーマにenumを追加 * enhance: ロールポリシーの型定義をRoleServiceからjson-schemaに移植 * refactor: policiesを`ref: RolePolicies`に統一 * fix: API `meta` のレスポンスの型にpoliciesが含まれていないのを修正 * refactor: fix some type errors * fix: backendのlintが落ちているのを修正 * fix: MkFoldableSectionの開閉時のanimationが適用されていない問題を修正 * fix: backendのtypecheckが落ちているのを修正 * update: run build-misskey-js-with-types * fix: MkDialogのmount時に文字数制限の判定が行われない問題を修正 * update: CHANGELOG.md * refactor: MkUserSelectDialogの型を改善 * fix: deepCloneでundefinedはcloneしないように (#9207) * change: frontendのcloneをbackend側にも反映 * update: CHANGELOG.md * fix: RoleServiceからPackを通して型RolePoliciesに依存させないように * Update packages/frontend/src/scripts/get-note-summary.ts * revert RoleService.ts changes * change: optional chaining -> non-null assertion * remove: unused import * fix: propsで渡されたuserがUserLiteの場合に意図しない動作になってしまうのを修正 * change: fix null check style * refactor: fix type error * change: fix null check style * Update packages/frontend/src/components/MkDrive.vue Co-authored-by: syuilo <Syuilotan@yahoo.co.jp> * refactor: css moduleでglobalを使わないように * refactor: roleのiconUrlは必ず存在するものとして扱うように * enhance: MenuButtonのactiveにcomputedを受け付けられるように * Update packages/frontend/src/components/MkNotePreview.vue * Update MkWindow.vue * refactor: notification.noteは必ず存在するものとして扱うように * Update packages/frontend/src/components/MkNotification.vue Co-authored-by: syuilo <Syuilotan@yahoo.co.jp> * fix: MkSignupDialogでdoneのemit時にresを含んでいなかったのを修正 * Update packages/frontend/src/scripts/clone.ts Co-authored-by: syuilo <Syuilotan@yahoo.co.jp> * refactor: 不要な返り値の型を削除 * refactor: 不要なnullチェックを削除 * update: misskey-js-autogen * update: clone.ts * refactor * Update MkNotification.vue * Update MkNotification.vue * :v: * Update MkNotification.vue * Update MkNotification.vue * Update MkNotification.vue * Update MkNotifications.vue * Update MkUserSetupDialog.Profile.vue * Update MkUserCardMini.vue * :v: * Update MkMenu.vue --------- Co-authored-by: syuilo <Syuilotan@yahoo.co.jp>
2024-01-30 10:53:53 +00:00
folderUpdated: (payload: DriveFolder) => void;
};
receives: null;
};
serverStats: {
params: null;
events: {
stats: (payload: ServerStats) => void;
statsLog: (payload: ServerStatsLog) => void;
};
receives: {
requestLog: {
id: string | number;
length: number;
};
};
};
queueStats: {
params: null;
events: {
stats: (payload: QueueStats) => void;
statsLog: (payload: QueueStatsLog) => void;
};
receives: {
requestLog: {
id: string | number;
length: number;
};
};
};
admin: {
params: null;
events: {
newAbuseUserReport: {
id: string;
targetUserId: string;
reporterId: string;
comment: string;
};
};
receives: null;
};
reversiGame: {
params: {
gameId: string;
};
events: {
started: (payload: {
game: ReversiGameDetailed;
}) => void;
ended: (payload: {
winnerId: User['id'] | null;
game: ReversiGameDetailed;
}) => void;
canceled: (payload: {
userId: User['id'];
}) => void;
changeReadyStates: (payload: {
user1: boolean;
user2: boolean;
}) => void;
updateSettings: (payload: {
userId: User['id'];
key: string;
value: any;
}) => void;
log: (payload: Record<string, any>) => void;
};
receives: {
putStone: {
pos: number;
id: string;
};
ready: boolean;
cancel: null | Record<string, never>;
updateSettings: {
key: string;
value: any;
};
claimTimeIsUp: null | Record<string, never>;
};
};
};
// @public (undocumented)
type ChannelsCreateRequest = operations['channels/create']['requestBody']['content']['application/json'];
// @public (undocumented)
type ChannelsCreateResponse = operations['channels/create']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ChannelsFavoriteRequest = operations['channels/favorite']['requestBody']['content']['application/json'];
// @public (undocumented)
type ChannelsFeaturedResponse = operations['channels/featured']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ChannelsFollowedRequest = operations['channels/followed']['requestBody']['content']['application/json'];
// @public (undocumented)
type ChannelsFollowedResponse = operations['channels/followed']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ChannelsFollowRequest = operations['channels/follow']['requestBody']['content']['application/json'];
// @public (undocumented)
type ChannelsMyFavoritesResponse = operations['channels/my-favorites']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ChannelsOwnedRequest = operations['channels/owned']['requestBody']['content']['application/json'];
// @public (undocumented)
type ChannelsOwnedResponse = operations['channels/owned']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ChannelsSearchRequest = operations['channels/search']['requestBody']['content']['application/json'];
// @public (undocumented)
type ChannelsSearchResponse = operations['channels/search']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ChannelsShowRequest = operations['channels/show']['requestBody']['content']['application/json'];
// @public (undocumented)
type ChannelsShowResponse = operations['channels/show']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ChannelsTimelineRequest = operations['channels/timeline']['requestBody']['content']['application/json'];
// @public (undocumented)
type ChannelsTimelineResponse = operations['channels/timeline']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ChannelsUnfavoriteRequest = operations['channels/unfavorite']['requestBody']['content']['application/json'];
// @public (undocumented)
type ChannelsUnfollowRequest = operations['channels/unfollow']['requestBody']['content']['application/json'];
// @public (undocumented)
type ChannelsUpdateRequest = operations['channels/update']['requestBody']['content']['application/json'];
// @public (undocumented)
type ChannelsUpdateResponse = operations['channels/update']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ChartsActiveUsersRequest = operations['charts/active-users']['requestBody']['content']['application/json'];
// @public (undocumented)
type ChartsActiveUsersResponse = operations['charts/active-users']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ChartsApRequestRequest = operations['charts/ap-request']['requestBody']['content']['application/json'];
// @public (undocumented)
type ChartsApRequestResponse = operations['charts/ap-request']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ChartsDriveRequest = operations['charts/drive']['requestBody']['content']['application/json'];
// @public (undocumented)
type ChartsDriveResponse = operations['charts/drive']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ChartsFederationRequest = operations['charts/federation']['requestBody']['content']['application/json'];
// @public (undocumented)
type ChartsFederationResponse = operations['charts/federation']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ChartsInstanceRequest = operations['charts/instance']['requestBody']['content']['application/json'];
// @public (undocumented)
type ChartsInstanceResponse = operations['charts/instance']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ChartsNotesRequest = operations['charts/notes']['requestBody']['content']['application/json'];
// @public (undocumented)
type ChartsNotesResponse = operations['charts/notes']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ChartsUserDriveRequest = operations['charts/user/drive']['requestBody']['content']['application/json'];
// @public (undocumented)
type ChartsUserDriveResponse = operations['charts/user/drive']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ChartsUserFollowingRequest = operations['charts/user/following']['requestBody']['content']['application/json'];
// @public (undocumented)
type ChartsUserFollowingResponse = operations['charts/user/following']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ChartsUserNotesRequest = operations['charts/user/notes']['requestBody']['content']['application/json'];
// @public (undocumented)
type ChartsUserNotesResponse = operations['charts/user/notes']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ChartsUserPvRequest = operations['charts/user/pv']['requestBody']['content']['application/json'];
// @public (undocumented)
type ChartsUserPvResponse = operations['charts/user/pv']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ChartsUserReactionsRequest = operations['charts/user/reactions']['requestBody']['content']['application/json'];
// @public (undocumented)
type ChartsUserReactionsResponse = operations['charts/user/reactions']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ChartsUsersRequest = operations['charts/users']['requestBody']['content']['application/json'];
// @public (undocumented)
type ChartsUsersResponse = operations['charts/users']['responses']['200']['content']['application/json'];
// @public (undocumented)
type Clip = components['schemas']['Clip'];
// @public (undocumented)
type ClipsAddNoteRequest = operations['clips/add-note']['requestBody']['content']['application/json'];
// @public (undocumented)
type ClipsCreateRequest = operations['clips/create']['requestBody']['content']['application/json'];
// @public (undocumented)
type ClipsCreateResponse = operations['clips/create']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ClipsDeleteRequest = operations['clips/delete']['requestBody']['content']['application/json'];
// @public (undocumented)
type ClipsFavoriteRequest = operations['clips/favorite']['requestBody']['content']['application/json'];
// @public (undocumented)
type ClipsListResponse = operations['clips/list']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ClipsMyFavoritesResponse = operations['clips/my-favorites']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ClipsNotesRequest = operations['clips/notes']['requestBody']['content']['application/json'];
// @public (undocumented)
type ClipsNotesResponse = operations['clips/notes']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ClipsRemoveNoteRequest = operations['clips/remove-note']['requestBody']['content']['application/json'];
// @public (undocumented)
type ClipsShowRequest = operations['clips/show']['requestBody']['content']['application/json'];
// @public (undocumented)
type ClipsShowResponse = operations['clips/show']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ClipsUnfavoriteRequest = operations['clips/unfavorite']['requestBody']['content']['application/json'];
// @public (undocumented)
type ClipsUpdateRequest = operations['clips/update']['requestBody']['content']['application/json'];
// @public (undocumented)
type ClipsUpdateResponse = operations['clips/update']['responses']['200']['content']['application/json'];
// @public (undocumented)
type DateString = string;
// @public (undocumented)
type DriveFile = components['schemas']['DriveFile'];
// @public (undocumented)
type DriveFilesAttachedNotesRequest = operations['drive/files/attached-notes']['requestBody']['content']['application/json'];
// @public (undocumented)
type DriveFilesAttachedNotesResponse = operations['drive/files/attached-notes']['responses']['200']['content']['application/json'];
// @public (undocumented)
type DriveFilesCheckExistenceRequest = operations['drive/files/check-existence']['requestBody']['content']['application/json'];
// @public (undocumented)
type DriveFilesCheckExistenceResponse = operations['drive/files/check-existence']['responses']['200']['content']['application/json'];
// @public (undocumented)
type DriveFilesCreateRequest = operations['drive/files/create']['requestBody']['content']['multipart/form-data'];
// @public (undocumented)
type DriveFilesCreateResponse = operations['drive/files/create']['responses']['200']['content']['application/json'];
// @public (undocumented)
type DriveFilesDeleteRequest = operations['drive/files/delete']['requestBody']['content']['application/json'];
// @public (undocumented)
type DriveFilesFindByHashRequest = operations['drive/files/find-by-hash']['requestBody']['content']['application/json'];
// @public (undocumented)
type DriveFilesFindByHashResponse = operations['drive/files/find-by-hash']['responses']['200']['content']['application/json'];
// @public (undocumented)
type DriveFilesFindRequest = operations['drive/files/find']['requestBody']['content']['application/json'];
// @public (undocumented)
type DriveFilesFindResponse = operations['drive/files/find']['responses']['200']['content']['application/json'];
// @public (undocumented)
type DriveFilesRequest = operations['drive/files']['requestBody']['content']['application/json'];
// @public (undocumented)
type DriveFilesResponse = operations['drive/files']['responses']['200']['content']['application/json'];
// @public (undocumented)
type DriveFilesShowRequest = operations['drive/files/show']['requestBody']['content']['application/json'];
// @public (undocumented)
type DriveFilesShowResponse = operations['drive/files/show']['responses']['200']['content']['application/json'];
// @public (undocumented)
type DriveFilesUpdateRequest = operations['drive/files/update']['requestBody']['content']['application/json'];
// @public (undocumented)
type DriveFilesUpdateResponse = operations['drive/files/update']['responses']['200']['content']['application/json'];
// @public (undocumented)
type DriveFilesUploadFromUrlRequest = operations['drive/files/upload-from-url']['requestBody']['content']['application/json'];
// @public (undocumented)
type DriveFolder = components['schemas']['DriveFolder'];
// @public (undocumented)
type DriveFoldersCreateRequest = operations['drive/folders/create']['requestBody']['content']['application/json'];
// @public (undocumented)
type DriveFoldersCreateResponse = operations['drive/folders/create']['responses']['200']['content']['application/json'];
// @public (undocumented)
type DriveFoldersDeleteRequest = operations['drive/folders/delete']['requestBody']['content']['application/json'];
// @public (undocumented)
type DriveFoldersFindRequest = operations['drive/folders/find']['requestBody']['content']['application/json'];
// @public (undocumented)
type DriveFoldersFindResponse = operations['drive/folders/find']['responses']['200']['content']['application/json'];
// @public (undocumented)
type DriveFoldersRequest = operations['drive/folders']['requestBody']['content']['application/json'];
// @public (undocumented)
type DriveFoldersResponse = operations['drive/folders']['responses']['200']['content']['application/json'];
// @public (undocumented)
type DriveFoldersShowRequest = operations['drive/folders/show']['requestBody']['content']['application/json'];
// @public (undocumented)
type DriveFoldersShowResponse = operations['drive/folders/show']['responses']['200']['content']['application/json'];
// @public (undocumented)
type DriveFoldersUpdateRequest = operations['drive/folders/update']['requestBody']['content']['application/json'];
// @public (undocumented)
type DriveFoldersUpdateResponse = operations['drive/folders/update']['responses']['200']['content']['application/json'];
// @public (undocumented)
type DriveResponse = operations['drive']['responses']['200']['content']['application/json'];
// @public (undocumented)
type DriveStreamRequest = operations['drive/stream']['requestBody']['content']['application/json'];
// @public (undocumented)
type DriveStreamResponse = operations['drive/stream']['responses']['200']['content']['application/json'];
// @public (undocumented)
type EmailAddressAvailableRequest = operations['email-address/available']['requestBody']['content']['application/json'];
// @public (undocumented)
type EmailAddressAvailableResponse = operations['email-address/available']['responses']['200']['content']['application/json'];
// @public (undocumented)
type EmojiAdded = {
emoji: EmojiDetailed;
};
// @public (undocumented)
type EmojiDeleted = {
emojis: EmojiDetailed[];
};
// @public (undocumented)
type EmojiDetailed = components['schemas']['EmojiDetailed'];
// @public (undocumented)
type EmojiRequest = operations['emoji']['requestBody']['content']['application/json'];
// @public (undocumented)
type EmojiResponse = operations['emoji']['responses']['200']['content']['application/json'];
// @public (undocumented)
type EmojiSimple = components['schemas']['EmojiSimple'];
// @public (undocumented)
type EmojisResponse = operations['emojis']['responses']['200']['content']['application/json'];
// @public (undocumented)
type EmojiUpdated = {
emojis: EmojiDetailed[];
};
// @public (undocumented)
type EmptyRequest = Record<string, unknown> | undefined;
// @public (undocumented)
type EmptyResponse = Record<string, unknown> | undefined;
// @public (undocumented)
type EndpointRequest = operations['endpoint']['requestBody']['content']['application/json'];
// @public (undocumented)
type EndpointResponse = operations['endpoint']['responses']['200']['content']['application/json'];
// Warning: (ae-forgotten-export) The symbol "Overwrite" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "Endpoints_2" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export type Endpoints = Overwrite<Endpoints_2, {
'users/show': {
req: UsersShowRequest;
res: {
$switch: {
$cases: [
[
{
userIds?: string[];
},
UserDetailed[]
]
];
$default: UserDetailed;
};
};
};
'signup': {
req: SignupRequest;
res: SignupResponse;
};
'signup-pending': {
req: SignupPendingRequest;
res: SignupPendingResponse;
};
'signin': {
req: SigninRequest;
res: SigninResponse;
};
}>;
// @public (undocumented)
type EndpointsResponse = operations['endpoints']['responses']['200']['content']['application/json'];
declare namespace entities {
export {
ID,
DateString,
PageEvent,
ModerationLog,
ServerStats,
ServerStatsLog,
QueueStats,
QueueStatsLog,
EmojiAdded,
EmojiUpdated,
EmojiDeleted,
AnnouncementCreated,
SignupRequest,
SignupResponse,
SignupPendingRequest,
SignupPendingResponse,
SigninRequest,
SigninResponse,
EmptyRequest,
EmptyResponse,
AdminMetaResponse,
AdminAbuseUserReportsRequest,
AdminAbuseUserReportsResponse,
AdminAccountsCreateRequest,
AdminAccountsCreateResponse,
AdminAccountsDeleteRequest,
AdminAccountsFindByEmailRequest,
AdminAccountsFindByEmailResponse,
AdminAdCreateRequest,
AdminAdCreateResponse,
AdminAdDeleteRequest,
AdminAdListRequest,
AdminAdListResponse,
AdminAdUpdateRequest,
AdminAnnouncementsCreateRequest,
AdminAnnouncementsCreateResponse,
AdminAnnouncementsDeleteRequest,
AdminAnnouncementsListRequest,
AdminAnnouncementsListResponse,
AdminAnnouncementsUpdateRequest,
AdminAvatarDecorationsCreateRequest,
AdminAvatarDecorationsDeleteRequest,
AdminAvatarDecorationsListRequest,
AdminAvatarDecorationsListResponse,
AdminAvatarDecorationsUpdateRequest,
AdminDeleteAllFilesOfAUserRequest,
AdminUnsetUserAvatarRequest,
AdminUnsetUserBannerRequest,
AdminDriveFilesRequest,
AdminDriveFilesResponse,
AdminDriveShowFileRequest,
AdminDriveShowFileResponse,
AdminEmojiAddAliasesBulkRequest,
AdminEmojiAddRequest,
AdminEmojiCopyRequest,
AdminEmojiCopyResponse,
AdminEmojiDeleteBulkRequest,
AdminEmojiDeleteRequest,
AdminEmojiImportZipRequest,
AdminEmojiListRemoteRequest,
AdminEmojiListRemoteResponse,
AdminEmojiListRequest,
AdminEmojiListResponse,
AdminEmojiRemoveAliasesBulkRequest,
AdminEmojiSetAliasesBulkRequest,
AdminEmojiSetCategoryBulkRequest,
AdminEmojiSetLicenseBulkRequest,
AdminEmojiUpdateRequest,
AdminFederationDeleteAllFilesRequest,
AdminFederationRefreshRemoteInstanceMetadataRequest,
AdminFederationRemoveAllFollowingRequest,
AdminFederationUpdateInstanceRequest,
AdminGetIndexStatsResponse,
AdminGetTableStatsResponse,
AdminGetUserIpsRequest,
AdminGetUserIpsResponse,
AdminInviteCreateRequest,
AdminInviteCreateResponse,
AdminInviteListRequest,
AdminInviteListResponse,
AdminPromoCreateRequest,
AdminQueueDeliverDelayedResponse,
AdminQueueInboxDelayedResponse,
AdminQueuePromoteRequest,
AdminQueueStatsResponse,
AdminRelaysAddRequest,
AdminRelaysAddResponse,
AdminRelaysListResponse,
AdminRelaysRemoveRequest,
AdminResetPasswordRequest,
AdminResetPasswordResponse,
AdminResolveAbuseUserReportRequest,
AdminSendEmailRequest,
AdminServerInfoResponse,
AdminShowModerationLogsRequest,
AdminShowModerationLogsResponse,
AdminShowUserRequest,
AdminShowUserResponse,
AdminShowUsersRequest,
AdminShowUsersResponse,
AdminSuspendUserRequest,
AdminUnsuspendUserRequest,
AdminUpdateMetaRequest,
AdminDeleteAccountRequest,
AdminDeleteAccountResponse,
AdminUpdateUserNoteRequest,
AdminRolesCreateRequest,
AdminRolesCreateResponse,
AdminRolesDeleteRequest,
AdminRolesListResponse,
AdminRolesShowRequest,
AdminRolesShowResponse,
AdminRolesUpdateRequest,
AdminRolesAssignRequest,
AdminRolesUnassignRequest,
AdminRolesUpdateDefaultPoliciesRequest,
AdminRolesUsersRequest,
AdminRolesUsersResponse,
AnnouncementsRequest,
AnnouncementsResponse,
AntennasCreateRequest,
AntennasCreateResponse,
AntennasDeleteRequest,
AntennasListResponse,
AntennasNotesRequest,
AntennasNotesResponse,
AntennasShowRequest,
AntennasShowResponse,
AntennasUpdateRequest,
AntennasUpdateResponse,
ApGetRequest,
ApGetResponse,
ApShowRequest,
ApShowResponse,
AppCreateRequest,
AppCreateResponse,
AppShowRequest,
AppShowResponse,
AuthAcceptRequest,
AuthSessionGenerateRequest,
AuthSessionGenerateResponse,
AuthSessionShowRequest,
AuthSessionShowResponse,
AuthSessionUserkeyRequest,
AuthSessionUserkeyResponse,
BlockingCreateRequest,
BlockingCreateResponse,
BlockingDeleteRequest,
BlockingDeleteResponse,
BlockingListRequest,
BlockingListResponse,
ChannelsCreateRequest,
ChannelsCreateResponse,
ChannelsFeaturedResponse,
ChannelsFollowRequest,
ChannelsFollowedRequest,
ChannelsFollowedResponse,
ChannelsOwnedRequest,
ChannelsOwnedResponse,
ChannelsShowRequest,
ChannelsShowResponse,
ChannelsTimelineRequest,
ChannelsTimelineResponse,
ChannelsUnfollowRequest,
ChannelsUpdateRequest,
ChannelsUpdateResponse,
ChannelsFavoriteRequest,
ChannelsUnfavoriteRequest,
ChannelsMyFavoritesResponse,
ChannelsSearchRequest,
ChannelsSearchResponse,
ChartsActiveUsersRequest,
ChartsActiveUsersResponse,
ChartsApRequestRequest,
ChartsApRequestResponse,
ChartsDriveRequest,
ChartsDriveResponse,
ChartsFederationRequest,
ChartsFederationResponse,
ChartsInstanceRequest,
ChartsInstanceResponse,
ChartsNotesRequest,
ChartsNotesResponse,
ChartsUserDriveRequest,
ChartsUserDriveResponse,
ChartsUserFollowingRequest,
ChartsUserFollowingResponse,
ChartsUserNotesRequest,
ChartsUserNotesResponse,
ChartsUserPvRequest,
ChartsUserPvResponse,
ChartsUserReactionsRequest,
ChartsUserReactionsResponse,
ChartsUsersRequest,
ChartsUsersResponse,
ClipsAddNoteRequest,
ClipsRemoveNoteRequest,
ClipsCreateRequest,
ClipsCreateResponse,
ClipsDeleteRequest,
ClipsListResponse,
ClipsNotesRequest,
ClipsNotesResponse,
ClipsShowRequest,
ClipsShowResponse,
ClipsUpdateRequest,
ClipsUpdateResponse,
ClipsFavoriteRequest,
ClipsUnfavoriteRequest,
ClipsMyFavoritesResponse,
DriveResponse,
DriveFilesRequest,
DriveFilesResponse,
DriveFilesAttachedNotesRequest,
DriveFilesAttachedNotesResponse,
DriveFilesCheckExistenceRequest,
DriveFilesCheckExistenceResponse,
DriveFilesCreateRequest,
DriveFilesCreateResponse,
DriveFilesDeleteRequest,
DriveFilesFindByHashRequest,
DriveFilesFindByHashResponse,
DriveFilesFindRequest,
DriveFilesFindResponse,
DriveFilesShowRequest,
DriveFilesShowResponse,
DriveFilesUpdateRequest,
DriveFilesUpdateResponse,
DriveFilesUploadFromUrlRequest,
DriveFoldersRequest,
DriveFoldersResponse,
DriveFoldersCreateRequest,
DriveFoldersCreateResponse,
DriveFoldersDeleteRequest,
DriveFoldersFindRequest,
DriveFoldersFindResponse,
DriveFoldersShowRequest,
DriveFoldersShowResponse,
DriveFoldersUpdateRequest,
DriveFoldersUpdateResponse,
DriveStreamRequest,
DriveStreamResponse,
EmailAddressAvailableRequest,
EmailAddressAvailableResponse,
EndpointRequest,
EndpointResponse,
EndpointsResponse,
FederationFollowersRequest,
FederationFollowersResponse,
FederationFollowingRequest,
FederationFollowingResponse,
FederationInstancesRequest,
FederationInstancesResponse,
FederationShowInstanceRequest,
FederationShowInstanceResponse,
FederationUpdateRemoteUserRequest,
FederationUsersRequest,
FederationUsersResponse,
FederationStatsRequest,
FederationStatsResponse,
FollowingCreateRequest,
FollowingCreateResponse,
FollowingDeleteRequest,
FollowingDeleteResponse,
FollowingUpdateRequest,
FollowingUpdateResponse,
FollowingUpdateAllRequest,
FollowingInvalidateRequest,
FollowingInvalidateResponse,
FollowingRequestsAcceptRequest,
FollowingRequestsCancelRequest,
FollowingRequestsCancelResponse,
FollowingRequestsListRequest,
FollowingRequestsListResponse,
FollowingRequestsRejectRequest,
GalleryFeaturedRequest,
GalleryFeaturedResponse,
GalleryPopularResponse,
GalleryPostsRequest,
GalleryPostsResponse,
GalleryPostsCreateRequest,
GalleryPostsCreateResponse,
GalleryPostsDeleteRequest,
GalleryPostsLikeRequest,
GalleryPostsShowRequest,
GalleryPostsShowResponse,
GalleryPostsUnlikeRequest,
GalleryPostsUpdateRequest,
GalleryPostsUpdateResponse,
GetOnlineUsersCountResponse,
GetAvatarDecorationsResponse,
HashtagsListRequest,
HashtagsListResponse,
HashtagsSearchRequest,
HashtagsSearchResponse,
HashtagsShowRequest,
HashtagsShowResponse,
HashtagsTrendResponse,
HashtagsUsersRequest,
HashtagsUsersResponse,
IResponse,
I2faDoneRequest,
I2faKeyDoneRequest,
I2faKeyDoneResponse,
I2faPasswordLessRequest,
I2faRegisterKeyRequest,
I2faRegisterKeyResponse,
I2faRegisterRequest,
I2faRegisterResponse,
I2faUpdateKeyRequest,
I2faRemoveKeyRequest,
I2faUnregisterRequest,
IAppsRequest,
IAppsResponse,
IAuthorizedAppsRequest,
IAuthorizedAppsResponse,
IClaimAchievementRequest,
IChangePasswordRequest,
IDeleteAccountRequest,
IExportFollowingRequest,
IFavoritesRequest,
IFavoritesResponse,
IGalleryLikesRequest,
IGalleryLikesResponse,
IGalleryPostsRequest,
IGalleryPostsResponse,
IImportBlockingRequest,
IImportFollowingRequest,
IImportMutingRequest,
IImportUserListsRequest,
IImportAntennasRequest,
INotificationsRequest,
INotificationsResponse,
INotificationsGroupedRequest,
INotificationsGroupedResponse,
IPageLikesRequest,
IPageLikesResponse,
IPagesRequest,
IPagesResponse,
IPinRequest,
IPinResponse,
IReadAnnouncementRequest,
IRegenerateTokenRequest,
IRegistryGetAllRequest,
IRegistryGetAllResponse,
IRegistryGetDetailRequest,
IRegistryGetDetailResponse,
IRegistryGetRequest,
IRegistryGetResponse,
IRegistryKeysWithTypeRequest,
IRegistryKeysWithTypeResponse,
IRegistryKeysRequest,
IRegistryRemoveRequest,
IRegistryScopesWithDomainResponse,
IRegistrySetRequest,
IRevokeTokenRequest,
ISigninHistoryRequest,
ISigninHistoryResponse,
IUnpinRequest,
IUnpinResponse,
IUpdateEmailRequest,
IUpdateEmailResponse,
IUpdateRequest,
IUpdateResponse,
IMoveRequest,
IMoveResponse,
IWebhooksCreateRequest,
IWebhooksCreateResponse,
IWebhooksListResponse,
IWebhooksShowRequest,
IWebhooksShowResponse,
IWebhooksUpdateRequest,
IWebhooksDeleteRequest,
InviteCreateResponse,
InviteDeleteRequest,
InviteListRequest,
InviteListResponse,
InviteLimitResponse,
MetaRequest,
MetaResponse,
EmojisResponse,
EmojiRequest,
EmojiResponse,
MiauthGenTokenRequest,
MiauthGenTokenResponse,
MuteCreateRequest,
MuteDeleteRequest,
MuteListRequest,
MuteListResponse,
RenoteMuteCreateRequest,
RenoteMuteDeleteRequest,
RenoteMuteListRequest,
RenoteMuteListResponse,
MyAppsRequest,
MyAppsResponse,
NotesRequest,
NotesResponse,
NotesChildrenRequest,
NotesChildrenResponse,
NotesClipsRequest,
NotesClipsResponse,
NotesConversationRequest,
NotesConversationResponse,
NotesCreateRequest,
NotesCreateResponse,
NotesDeleteRequest,
NotesFavoritesCreateRequest,
NotesFavoritesDeleteRequest,
NotesFeaturedRequest,
NotesFeaturedResponse,
NotesGlobalTimelineRequest,
NotesGlobalTimelineResponse,
NotesHybridTimelineRequest,
NotesHybridTimelineResponse,
NotesLocalTimelineRequest,
NotesLocalTimelineResponse,
NotesMentionsRequest,
NotesMentionsResponse,
NotesPollsRecommendationRequest,
NotesPollsRecommendationResponse,
NotesPollsVoteRequest,
NotesReactionsRequest,
NotesReactionsResponse,
NotesReactionsCreateRequest,
NotesReactionsDeleteRequest,
NotesRenotesRequest,
NotesRenotesResponse,
NotesRepliesRequest,
NotesRepliesResponse,
NotesSearchByTagRequest,
NotesSearchByTagResponse,
NotesSearchRequest,
NotesSearchResponse,
NotesShowRequest,
NotesShowResponse,
NotesStateRequest,
NotesStateResponse,
NotesThreadMutingCreateRequest,
NotesThreadMutingDeleteRequest,
NotesTimelineRequest,
NotesTimelineResponse,
NotesTranslateRequest,
NotesTranslateResponse,
NotesUnrenoteRequest,
NotesUserListTimelineRequest,
NotesUserListTimelineResponse,
NotificationsCreateRequest,
PagePushRequest,
PagesCreateRequest,
PagesCreateResponse,
PagesDeleteRequest,
PagesFeaturedResponse,
PagesLikeRequest,
PagesShowRequest,
PagesShowResponse,
PagesUnlikeRequest,
PagesUpdateRequest,
FlashCreateRequest,
FlashCreateResponse,
FlashDeleteRequest,
FlashFeaturedResponse,
FlashLikeRequest,
FlashShowRequest,
FlashShowResponse,
FlashUnlikeRequest,
FlashUpdateRequest,
FlashMyRequest,
FlashMyResponse,
FlashMyLikesRequest,
FlashMyLikesResponse,
PingResponse,
PinnedUsersResponse,
PromoReadRequest,
RolesListResponse,
RolesShowRequest,
RolesShowResponse,
RolesUsersRequest,
RolesUsersResponse,
RolesNotesRequest,
RolesNotesResponse,
RequestResetPasswordRequest,
ResetPasswordRequest,
ServerInfoResponse,
StatsResponse,
SwShowRegistrationRequest,
SwShowRegistrationResponse,
SwUpdateRegistrationRequest,
SwUpdateRegistrationResponse,
SwRegisterRequest,
SwRegisterResponse,
SwUnregisterRequest,
TestRequest,
TestResponse,
UsernameAvailableRequest,
UsernameAvailableResponse,
UsersRequest,
UsersResponse,
UsersClipsRequest,
UsersClipsResponse,
UsersFollowersRequest,
UsersFollowersResponse,
UsersFollowingRequest,
UsersFollowingResponse,
UsersGalleryPostsRequest,
UsersGalleryPostsResponse,
UsersGetFrequentlyRepliedUsersRequest,
UsersGetFrequentlyRepliedUsersResponse,
UsersFeaturedNotesRequest,
UsersFeaturedNotesResponse,
UsersListsCreateRequest,
UsersListsCreateResponse,
UsersListsDeleteRequest,
UsersListsListRequest,
UsersListsListResponse,
UsersListsPullRequest,
UsersListsPushRequest,
UsersListsShowRequest,
UsersListsShowResponse,
UsersListsFavoriteRequest,
UsersListsUnfavoriteRequest,
UsersListsUpdateRequest,
UsersListsUpdateResponse,
UsersListsCreateFromPublicRequest,
UsersListsCreateFromPublicResponse,
UsersListsUpdateMembershipRequest,
UsersListsGetMembershipsRequest,
UsersListsGetMembershipsResponse,
UsersNotesRequest,
UsersNotesResponse,
UsersPagesRequest,
UsersPagesResponse,
UsersFlashsRequest,
UsersFlashsResponse,
UsersReactionsRequest,
UsersReactionsResponse,
UsersRecommendationRequest,
UsersRecommendationResponse,
UsersRelationRequest,
UsersRelationResponse,
UsersReportAbuseRequest,
UsersSearchByUsernameAndHostRequest,
UsersSearchByUsernameAndHostResponse,
UsersSearchRequest,
UsersSearchResponse,
UsersShowRequest,
UsersShowResponse,
UsersAchievementsRequest,
UsersAchievementsResponse,
UsersUpdateMemoRequest,
FetchRssRequest,
FetchRssResponse,
FetchExternalResourcesRequest,
FetchExternalResourcesResponse,
RetentionResponse,
BubbleGameRegisterRequest,
BubbleGameRegisterResponse,
BubbleGameRankingRequest,
BubbleGameRankingResponse,
2024-01-19 11:51:49 +00:00
ReversiCancelMatchRequest,
ReversiCancelMatchResponse,
ReversiGamesRequest,
ReversiGamesResponse,
ReversiMatchRequest,
ReversiMatchResponse,
ReversiInvitationsResponse,
ReversiShowGameRequest,
ReversiShowGameResponse,
ReversiSurrenderRequest,
ReversiVerifyRequest,
ReversiVerifyResponse,
Error_2 as Error,
UserLite,
UserDetailedNotMeOnly,
MeDetailedOnly,
UserDetailedNotMe,
MeDetailed,
UserDetailed,
User,
UserList,
Ad,
Announcement,
App,
Note,
NoteReaction,
NoteFavorite,
Notification_2 as Notification,
DriveFile,
DriveFolder,
Following,
Muting,
RenoteMuting,
Blocking,
Hashtag,
InviteCode,
Page,
refactor: frontendのcomponentsの型エラーを改善 (#12926) * add: safeFloatParserを追加 * fix: 欠けていた型を追加 * refactor: pageBlockTypesをjson-schemaに移植 * refactor: components/global内の型エラーが出ている箇所を修正 * lint: fix null check style * refactor: fix type error * refactor: fix some type errors * fix: 翻訳が抜けていた箇所を修正 * refactor: getJsonSchemaで正しいスキーマが返されるように修正 * fix: MkChartの型エラーとbytesオプションが機能していない問題を修正 * fix(misskey-js): `drive`->`folderUpdated`のpayloadの型が間違っていたのを修正 * refactor: fix some type errors * change: Captcha読み込み中の文言をLoadingに変更 * refactor(backend/misskey-js): MainEventの型を改善 * refactor: chartjs-plugin-gradientが二重でpluginに登録されていたのを修正 * update: misskey-js.api.md * refactor: fix some type errors * fix: backendのtypecheckが落ちていたのを修正 * update: misskey-js.api.md * add: json-schemaのnoteにpollの型定義を追加 * refactor: noteのjson-schemaの型を改善 * refactor: MkPoll * refactor: fix some type errors * change: UserLiteにisLockedを持たせるように * fix: notificationスキーマにroleが含まれていないのを修正 * Revert "change: UserLiteにisLockedを持たせるように" This reverts commit 1bb0c8e7a9b19a4e9f21bf7381712b98f27672a5. * fix: フォロー通知から鍵垢へのフォローを行うと処理中のまま止まってしまう問題を修正 * refactor: noteスキーマのvisibilityにenumを追加 * change: deepCloneのCloneableTypeにundefinedを追加 * refactor: fix some type errors * refactor: `allowEmpty: false`を使用していた箇所を`minLength: 1`に置き換え * enhance: API 'retension' のresponseの型を追加 * fix: Chart関連のtooltipが正しい位置に表示されない問題を修正 * refactor: fix some type errors * fix: 型情報が不足していたのを修正 * enhance: announcementスキーマにenumを追加 * enhance: ロールポリシーの型定義をRoleServiceからjson-schemaに移植 * refactor: policiesを`ref: RolePolicies`に統一 * fix: API `meta` のレスポンスの型にpoliciesが含まれていないのを修正 * refactor: fix some type errors * fix: backendのlintが落ちているのを修正 * fix: MkFoldableSectionの開閉時のanimationが適用されていない問題を修正 * fix: backendのtypecheckが落ちているのを修正 * update: run build-misskey-js-with-types * fix: MkDialogのmount時に文字数制限の判定が行われない問題を修正 * update: CHANGELOG.md * refactor: MkUserSelectDialogの型を改善 * fix: deepCloneでundefinedはcloneしないように (#9207) * change: frontendのcloneをbackend側にも反映 * update: CHANGELOG.md * fix: RoleServiceからPackを通して型RolePoliciesに依存させないように * Update packages/frontend/src/scripts/get-note-summary.ts * revert RoleService.ts changes * change: optional chaining -> non-null assertion * remove: unused import * fix: propsで渡されたuserがUserLiteの場合に意図しない動作になってしまうのを修正 * change: fix null check style * refactor: fix type error * change: fix null check style * Update packages/frontend/src/components/MkDrive.vue Co-authored-by: syuilo <Syuilotan@yahoo.co.jp> * refactor: css moduleでglobalを使わないように * refactor: roleのiconUrlは必ず存在するものとして扱うように * enhance: MenuButtonのactiveにcomputedを受け付けられるように * Update packages/frontend/src/components/MkNotePreview.vue * Update MkWindow.vue * refactor: notification.noteは必ず存在するものとして扱うように * Update packages/frontend/src/components/MkNotification.vue Co-authored-by: syuilo <Syuilotan@yahoo.co.jp> * fix: MkSignupDialogでdoneのemit時にresを含んでいなかったのを修正 * Update packages/frontend/src/scripts/clone.ts Co-authored-by: syuilo <Syuilotan@yahoo.co.jp> * refactor: 不要な返り値の型を削除 * refactor: 不要なnullチェックを削除 * update: misskey-js-autogen * update: clone.ts * refactor * Update MkNotification.vue * Update MkNotification.vue * :v: * Update MkNotification.vue * Update MkNotification.vue * Update MkNotification.vue * Update MkNotifications.vue * Update MkUserSetupDialog.Profile.vue * Update MkUserCardMini.vue * :v: * Update MkMenu.vue --------- Co-authored-by: syuilo <Syuilotan@yahoo.co.jp>
2024-01-30 10:53:53 +00:00
PageBlock,
Channel,
QueueCount,
Antenna,
Clip,
FederationInstance,
GalleryPost,
EmojiSimple,
EmojiDetailed,
Flash,
Signin,
RoleLite,
2024-01-19 11:51:49 +00:00
Role,
refactor: frontendのcomponentsの型エラーを改善 (#12926) * add: safeFloatParserを追加 * fix: 欠けていた型を追加 * refactor: pageBlockTypesをjson-schemaに移植 * refactor: components/global内の型エラーが出ている箇所を修正 * lint: fix null check style * refactor: fix type error * refactor: fix some type errors * fix: 翻訳が抜けていた箇所を修正 * refactor: getJsonSchemaで正しいスキーマが返されるように修正 * fix: MkChartの型エラーとbytesオプションが機能していない問題を修正 * fix(misskey-js): `drive`->`folderUpdated`のpayloadの型が間違っていたのを修正 * refactor: fix some type errors * change: Captcha読み込み中の文言をLoadingに変更 * refactor(backend/misskey-js): MainEventの型を改善 * refactor: chartjs-plugin-gradientが二重でpluginに登録されていたのを修正 * update: misskey-js.api.md * refactor: fix some type errors * fix: backendのtypecheckが落ちていたのを修正 * update: misskey-js.api.md * add: json-schemaのnoteにpollの型定義を追加 * refactor: noteのjson-schemaの型を改善 * refactor: MkPoll * refactor: fix some type errors * change: UserLiteにisLockedを持たせるように * fix: notificationスキーマにroleが含まれていないのを修正 * Revert "change: UserLiteにisLockedを持たせるように" This reverts commit 1bb0c8e7a9b19a4e9f21bf7381712b98f27672a5. * fix: フォロー通知から鍵垢へのフォローを行うと処理中のまま止まってしまう問題を修正 * refactor: noteスキーマのvisibilityにenumを追加 * change: deepCloneのCloneableTypeにundefinedを追加 * refactor: fix some type errors * refactor: `allowEmpty: false`を使用していた箇所を`minLength: 1`に置き換え * enhance: API 'retension' のresponseの型を追加 * fix: Chart関連のtooltipが正しい位置に表示されない問題を修正 * refactor: fix some type errors * fix: 型情報が不足していたのを修正 * enhance: announcementスキーマにenumを追加 * enhance: ロールポリシーの型定義をRoleServiceからjson-schemaに移植 * refactor: policiesを`ref: RolePolicies`に統一 * fix: API `meta` のレスポンスの型にpoliciesが含まれていないのを修正 * refactor: fix some type errors * fix: backendのlintが落ちているのを修正 * fix: MkFoldableSectionの開閉時のanimationが適用されていない問題を修正 * fix: backendのtypecheckが落ちているのを修正 * update: run build-misskey-js-with-types * fix: MkDialogのmount時に文字数制限の判定が行われない問題を修正 * update: CHANGELOG.md * refactor: MkUserSelectDialogの型を改善 * fix: deepCloneでundefinedはcloneしないように (#9207) * change: frontendのcloneをbackend側にも反映 * update: CHANGELOG.md * fix: RoleServiceからPackを通して型RolePoliciesに依存させないように * Update packages/frontend/src/scripts/get-note-summary.ts * revert RoleService.ts changes * change: optional chaining -> non-null assertion * remove: unused import * fix: propsで渡されたuserがUserLiteの場合に意図しない動作になってしまうのを修正 * change: fix null check style * refactor: fix type error * change: fix null check style * Update packages/frontend/src/components/MkDrive.vue Co-authored-by: syuilo <Syuilotan@yahoo.co.jp> * refactor: css moduleでglobalを使わないように * refactor: roleのiconUrlは必ず存在するものとして扱うように * enhance: MenuButtonのactiveにcomputedを受け付けられるように * Update packages/frontend/src/components/MkNotePreview.vue * Update MkWindow.vue * refactor: notification.noteは必ず存在するものとして扱うように * Update packages/frontend/src/components/MkNotification.vue Co-authored-by: syuilo <Syuilotan@yahoo.co.jp> * fix: MkSignupDialogでdoneのemit時にresを含んでいなかったのを修正 * Update packages/frontend/src/scripts/clone.ts Co-authored-by: syuilo <Syuilotan@yahoo.co.jp> * refactor: 不要な返り値の型を削除 * refactor: 不要なnullチェックを削除 * update: misskey-js-autogen * update: clone.ts * refactor * Update MkNotification.vue * Update MkNotification.vue * :v: * Update MkNotification.vue * Update MkNotification.vue * Update MkNotification.vue * Update MkNotifications.vue * Update MkUserSetupDialog.Profile.vue * Update MkUserCardMini.vue * :v: * Update MkMenu.vue --------- Co-authored-by: syuilo <Syuilotan@yahoo.co.jp>
2024-01-30 10:53:53 +00:00
RolePolicies,
2024-01-19 11:51:49 +00:00
ReversiGameLite,
ReversiGameDetailed
}
}
export { entities }
// @public (undocumented)
type Error_2 = components['schemas']['Error'];
// @public (undocumented)
type FederationFollowersRequest = operations['federation/followers']['requestBody']['content']['application/json'];
// @public (undocumented)
type FederationFollowersResponse = operations['federation/followers']['responses']['200']['content']['application/json'];
// @public (undocumented)
type FederationFollowingRequest = operations['federation/following']['requestBody']['content']['application/json'];
// @public (undocumented)
type FederationFollowingResponse = operations['federation/following']['responses']['200']['content']['application/json'];
// @public (undocumented)
type FederationInstance = components['schemas']['FederationInstance'];
// @public (undocumented)
type FederationInstancesRequest = operations['federation/instances']['requestBody']['content']['application/json'];
// @public (undocumented)
type FederationInstancesResponse = operations['federation/instances']['responses']['200']['content']['application/json'];
// @public (undocumented)
type FederationShowInstanceRequest = operations['federation/show-instance']['requestBody']['content']['application/json'];
// @public (undocumented)
type FederationShowInstanceResponse = operations['federation/show-instance']['responses']['200']['content']['application/json'];
// @public (undocumented)
type FederationStatsRequest = operations['federation/stats']['requestBody']['content']['application/json'];
// @public (undocumented)
type FederationStatsResponse = operations['federation/stats']['responses']['200']['content']['application/json'];
// @public (undocumented)
type FederationUpdateRemoteUserRequest = operations['federation/update-remote-user']['requestBody']['content']['application/json'];
// @public (undocumented)
type FederationUsersRequest = operations['federation/users']['requestBody']['content']['application/json'];
// @public (undocumented)
type FederationUsersResponse = operations['federation/users']['responses']['200']['content']['application/json'];
// @public (undocumented)
type FetchExternalResourcesRequest = operations['fetch-external-resources']['requestBody']['content']['application/json'];
// @public (undocumented)
type FetchExternalResourcesResponse = operations['fetch-external-resources']['responses']['200']['content']['application/json'];
// @public (undocumented)
type FetchLike = (input: string, init?: {
method?: string;
body?: string;
credentials?: RequestCredentials;
cache?: RequestCache;
headers: {
[key in string]: string;
};
}) => Promise<{
status: number;
json(): Promise<any>;
}>;
// @public (undocumented)
type FetchRssRequest = operations['fetch-rss']['requestBody']['content']['application/json'];
// @public (undocumented)
type FetchRssResponse = operations['fetch-rss']['responses']['200']['content']['application/json'];
// @public (undocumented)
type Flash = components['schemas']['Flash'];
// @public (undocumented)
type FlashCreateRequest = operations['flash/create']['requestBody']['content']['application/json'];
// @public (undocumented)
type FlashCreateResponse = operations['flash/create']['responses']['200']['content']['application/json'];
// @public (undocumented)
type FlashDeleteRequest = operations['flash/delete']['requestBody']['content']['application/json'];
// @public (undocumented)
type FlashFeaturedResponse = operations['flash/featured']['responses']['200']['content']['application/json'];
// @public (undocumented)
type FlashLikeRequest = operations['flash/like']['requestBody']['content']['application/json'];
// @public (undocumented)
type FlashMyLikesRequest = operations['flash/my-likes']['requestBody']['content']['application/json'];
// @public (undocumented)
type FlashMyLikesResponse = operations['flash/my-likes']['responses']['200']['content']['application/json'];
// @public (undocumented)
type FlashMyRequest = operations['flash/my']['requestBody']['content']['application/json'];
// @public (undocumented)
type FlashMyResponse = operations['flash/my']['responses']['200']['content']['application/json'];
// @public (undocumented)
type FlashShowRequest = operations['flash/show']['requestBody']['content']['application/json'];
// @public (undocumented)
type FlashShowResponse = operations['flash/show']['responses']['200']['content']['application/json'];
// @public (undocumented)
type FlashUnlikeRequest = operations['flash/unlike']['requestBody']['content']['application/json'];
// @public (undocumented)
type FlashUpdateRequest = operations['flash/update']['requestBody']['content']['application/json'];
// @public (undocumented)
export const followersVisibilities: readonly ["public", "followers", "private"];
// @public (undocumented)
type Following = components['schemas']['Following'];
// @public (undocumented)
type FollowingCreateRequest = operations['following/create']['requestBody']['content']['application/json'];
// @public (undocumented)
type FollowingCreateResponse = operations['following/create']['responses']['200']['content']['application/json'];
// @public (undocumented)
type FollowingDeleteRequest = operations['following/delete']['requestBody']['content']['application/json'];
// @public (undocumented)
type FollowingDeleteResponse = operations['following/delete']['responses']['200']['content']['application/json'];
// @public (undocumented)
type FollowingInvalidateRequest = operations['following/invalidate']['requestBody']['content']['application/json'];
// @public (undocumented)
type FollowingInvalidateResponse = operations['following/invalidate']['responses']['200']['content']['application/json'];
// @public (undocumented)
type FollowingRequestsAcceptRequest = operations['following/requests/accept']['requestBody']['content']['application/json'];
// @public (undocumented)
type FollowingRequestsCancelRequest = operations['following/requests/cancel']['requestBody']['content']['application/json'];
// @public (undocumented)
type FollowingRequestsCancelResponse = operations['following/requests/cancel']['responses']['200']['content']['application/json'];
// @public (undocumented)
type FollowingRequestsListRequest = operations['following/requests/list']['requestBody']['content']['application/json'];
// @public (undocumented)
type FollowingRequestsListResponse = operations['following/requests/list']['responses']['200']['content']['application/json'];
// @public (undocumented)
type FollowingRequestsRejectRequest = operations['following/requests/reject']['requestBody']['content']['application/json'];
// @public (undocumented)
type FollowingUpdateAllRequest = operations['following/update-all']['requestBody']['content']['application/json'];
// @public (undocumented)
type FollowingUpdateRequest = operations['following/update']['requestBody']['content']['application/json'];
// @public (undocumented)
type FollowingUpdateResponse = operations['following/update']['responses']['200']['content']['application/json'];
// @public (undocumented)
export const followingVisibilities: readonly ["public", "followers", "private"];
// @public (undocumented)
type GalleryFeaturedRequest = operations['gallery/featured']['requestBody']['content']['application/json'];
// @public (undocumented)
type GalleryFeaturedResponse = operations['gallery/featured']['responses']['200']['content']['application/json'];
// @public (undocumented)
type GalleryPopularResponse = operations['gallery/popular']['responses']['200']['content']['application/json'];
// @public (undocumented)
type GalleryPost = components['schemas']['GalleryPost'];
// @public (undocumented)
type GalleryPostsCreateRequest = operations['gallery/posts/create']['requestBody']['content']['application/json'];
// @public (undocumented)
type GalleryPostsCreateResponse = operations['gallery/posts/create']['responses']['200']['content']['application/json'];
// @public (undocumented)
type GalleryPostsDeleteRequest = operations['gallery/posts/delete']['requestBody']['content']['application/json'];
// @public (undocumented)
type GalleryPostsLikeRequest = operations['gallery/posts/like']['requestBody']['content']['application/json'];
// @public (undocumented)
type GalleryPostsRequest = operations['gallery/posts']['requestBody']['content']['application/json'];
// @public (undocumented)
type GalleryPostsResponse = operations['gallery/posts']['responses']['200']['content']['application/json'];
// @public (undocumented)
type GalleryPostsShowRequest = operations['gallery/posts/show']['requestBody']['content']['application/json'];
// @public (undocumented)
type GalleryPostsShowResponse = operations['gallery/posts/show']['responses']['200']['content']['application/json'];
// @public (undocumented)
type GalleryPostsUnlikeRequest = operations['gallery/posts/unlike']['requestBody']['content']['application/json'];
// @public (undocumented)
type GalleryPostsUpdateRequest = operations['gallery/posts/update']['requestBody']['content']['application/json'];
// @public (undocumented)
type GalleryPostsUpdateResponse = operations['gallery/posts/update']['responses']['200']['content']['application/json'];
// @public (undocumented)
type GetAvatarDecorationsResponse = operations['get-avatar-decorations']['responses']['200']['content']['application/json'];
// @public (undocumented)
type GetOnlineUsersCountResponse = operations['get-online-users-count']['responses']['200']['content']['application/json'];
// @public (undocumented)
type Hashtag = components['schemas']['Hashtag'];
// @public (undocumented)
type HashtagsListRequest = operations['hashtags/list']['requestBody']['content']['application/json'];
// @public (undocumented)
type HashtagsListResponse = operations['hashtags/list']['responses']['200']['content']['application/json'];
// @public (undocumented)
type HashtagsSearchRequest = operations['hashtags/search']['requestBody']['content']['application/json'];
// @public (undocumented)
type HashtagsSearchResponse = operations['hashtags/search']['responses']['200']['content']['application/json'];
// @public (undocumented)
type HashtagsShowRequest = operations['hashtags/show']['requestBody']['content']['application/json'];
// @public (undocumented)
type HashtagsShowResponse = operations['hashtags/show']['responses']['200']['content']['application/json'];
// @public (undocumented)
type HashtagsTrendResponse = operations['hashtags/trend']['responses']['200']['content']['application/json'];
// @public (undocumented)
type HashtagsUsersRequest = operations['hashtags/users']['requestBody']['content']['application/json'];
// @public (undocumented)
type HashtagsUsersResponse = operations['hashtags/users']['responses']['200']['content']['application/json'];
// @public (undocumented)
type I2faDoneRequest = operations['i/2fa/done']['requestBody']['content']['application/json'];
// @public (undocumented)
type I2faKeyDoneRequest = operations['i/2fa/key-done']['requestBody']['content']['application/json'];
// @public (undocumented)
type I2faKeyDoneResponse = operations['i/2fa/key-done']['responses']['200']['content']['application/json'];
// @public (undocumented)
type I2faPasswordLessRequest = operations['i/2fa/password-less']['requestBody']['content']['application/json'];
// @public (undocumented)
type I2faRegisterKeyRequest = operations['i/2fa/register-key']['requestBody']['content']['application/json'];
// @public (undocumented)
type I2faRegisterKeyResponse = operations['i/2fa/register-key']['responses']['200']['content']['application/json'];
// @public (undocumented)
type I2faRegisterRequest = operations['i/2fa/register']['requestBody']['content']['application/json'];
// @public (undocumented)
type I2faRegisterResponse = operations['i/2fa/register']['responses']['200']['content']['application/json'];
// @public (undocumented)
type I2faRemoveKeyRequest = operations['i/2fa/remove-key']['requestBody']['content']['application/json'];
// @public (undocumented)
type I2faUnregisterRequest = operations['i/2fa/unregister']['requestBody']['content']['application/json'];
// @public (undocumented)
type I2faUpdateKeyRequest = operations['i/2fa/update-key']['requestBody']['content']['application/json'];
// @public (undocumented)
type IAppsRequest = operations['i/apps']['requestBody']['content']['application/json'];
// @public (undocumented)
type IAppsResponse = operations['i/apps']['responses']['200']['content']['application/json'];
// @public (undocumented)
type IAuthorizedAppsRequest = operations['i/authorized-apps']['requestBody']['content']['application/json'];
// @public (undocumented)
type IAuthorizedAppsResponse = operations['i/authorized-apps']['responses']['200']['content']['application/json'];
// @public (undocumented)
type IChangePasswordRequest = operations['i/change-password']['requestBody']['content']['application/json'];
// @public (undocumented)
type IClaimAchievementRequest = operations['i/claim-achievement']['requestBody']['content']['application/json'];
// @public (undocumented)
type ID = string;
// @public (undocumented)
type IDeleteAccountRequest = operations['i/delete-account']['requestBody']['content']['application/json'];
// @public (undocumented)
type IExportFollowingRequest = operations['i/export-following']['requestBody']['content']['application/json'];
// @public (undocumented)
type IFavoritesRequest = operations['i/favorites']['requestBody']['content']['application/json'];
// @public (undocumented)
type IFavoritesResponse = operations['i/favorites']['responses']['200']['content']['application/json'];
enhance: 招待機能の改善 (#11195) * refactor(backend): 招待機能を改修 * feat(backend): 招待コードのcreate/delete/listエンドポイントを追加 * add(misskey-js): エンドポイントと型を追加 * change(backend): metaでinvite関連の情報も返すように * add(misskey-js): エンドポイントと型を追加 * add(backend): `/endpoints/invite/limit`を追加 * fix: createdByがnullableではなかったのを修正 * fix: relationが取得できていなかった問題を修正 * fix: パラメータを間違えていたのを修正 * feat(client): 招待ページを実装 * change(client): インスタンスメニューの「招待」押した場合に招待ページに飛ぶように変更 * feat: 招待コードをコピーできるように * change(backend): metaに招待コード発行に関する情報を持たせるのをやめる * feat: ロールごとに招待コードの発行上限数などを設定できるように * change(client): 招待コードをコピーしたときにダイアログを出すように * add: 招待に関する管理者用のエンドポイントを追加 * change(backend): モデレーターであれば作成者以外でも招待コードを削除できるように * change(backend): admin/invite/listはオフセットでページネーションするように * feat(client): 招待コードの管理ページを追加 * feat(client): 招待コードのリストをソートできるように * change: `admin/invite/create`のレスポンスを修正 * fix(client): 有効期限を指定できていなかった問題を修正 * refactor: 必要のない箇所を削除 * perf(backend): use limit() instead of take() * change(client): 作成ボタンを見た目を変更 * refactor: 招待コードの生成部分を共通化し、コード内に"01OI"のいずれかの文字を含まないように * fix(client): paginationの仕様が変わっていたので修正 * change(backend): expiresAtパラメータのnullを許容 * change(client): 有効期限を設けないときは日付の入力欄を非表示に * fix: 自身のポリシーよりもインスタンス側のポリシーが優先表示される問題を修正 * fix: n時間のときに「n時間間」となってしまうのを修正 * fix(backend): ポリシーが途中で変更されたときに作成可能数がマイナス表記になってしまうのを修正 * change(client): 招待コードのユーザー名が不明な理由を表示するように * update: CHANGELOG.md * lint * refactor * refactor * tweak ui * :art: * :art: * add(backend): indexを追加 * change(backend): indexの追加に伴う変更 * change(client): インスタンスメニューの「招待」の場所を変更 * add(frontend): MkInviteCode用のstorybookを追加 * Update misskey-js.api.md * fix(misskey-js): InviteのcreatedByの型が間違っていたのを修正 --------- Co-authored-by: syuilo <Syuilotan@yahoo.co.jp> Co-authored-by: tamaina <tamaina@hotmail.co.jp>
2023-07-15 00:57:58 +00:00
// @public (undocumented)
type IGalleryLikesRequest = operations['i/gallery/likes']['requestBody']['content']['application/json'];
enhance: 招待機能の改善 (#11195) * refactor(backend): 招待機能を改修 * feat(backend): 招待コードのcreate/delete/listエンドポイントを追加 * add(misskey-js): エンドポイントと型を追加 * change(backend): metaでinvite関連の情報も返すように * add(misskey-js): エンドポイントと型を追加 * add(backend): `/endpoints/invite/limit`を追加 * fix: createdByがnullableではなかったのを修正 * fix: relationが取得できていなかった問題を修正 * fix: パラメータを間違えていたのを修正 * feat(client): 招待ページを実装 * change(client): インスタンスメニューの「招待」押した場合に招待ページに飛ぶように変更 * feat: 招待コードをコピーできるように * change(backend): metaに招待コード発行に関する情報を持たせるのをやめる * feat: ロールごとに招待コードの発行上限数などを設定できるように * change(client): 招待コードをコピーしたときにダイアログを出すように * add: 招待に関する管理者用のエンドポイントを追加 * change(backend): モデレーターであれば作成者以外でも招待コードを削除できるように * change(backend): admin/invite/listはオフセットでページネーションするように * feat(client): 招待コードの管理ページを追加 * feat(client): 招待コードのリストをソートできるように * change: `admin/invite/create`のレスポンスを修正 * fix(client): 有効期限を指定できていなかった問題を修正 * refactor: 必要のない箇所を削除 * perf(backend): use limit() instead of take() * change(client): 作成ボタンを見た目を変更 * refactor: 招待コードの生成部分を共通化し、コード内に"01OI"のいずれかの文字を含まないように * fix(client): paginationの仕様が変わっていたので修正 * change(backend): expiresAtパラメータのnullを許容 * change(client): 有効期限を設けないときは日付の入力欄を非表示に * fix: 自身のポリシーよりもインスタンス側のポリシーが優先表示される問題を修正 * fix: n時間のときに「n時間間」となってしまうのを修正 * fix(backend): ポリシーが途中で変更されたときに作成可能数がマイナス表記になってしまうのを修正 * change(client): 招待コードのユーザー名が不明な理由を表示するように * update: CHANGELOG.md * lint * refactor * refactor * tweak ui * :art: * :art: * add(backend): indexを追加 * change(backend): indexの追加に伴う変更 * change(client): インスタンスメニューの「招待」の場所を変更 * add(frontend): MkInviteCode用のstorybookを追加 * Update misskey-js.api.md * fix(misskey-js): InviteのcreatedByの型が間違っていたのを修正 --------- Co-authored-by: syuilo <Syuilotan@yahoo.co.jp> Co-authored-by: tamaina <tamaina@hotmail.co.jp>
2023-07-15 00:57:58 +00:00
// @public (undocumented)
type IGalleryLikesResponse = operations['i/gallery/likes']['responses']['200']['content']['application/json'];
// @public (undocumented)
type IGalleryPostsRequest = operations['i/gallery/posts']['requestBody']['content']['application/json'];
// @public (undocumented)
type IGalleryPostsResponse = operations['i/gallery/posts']['responses']['200']['content']['application/json'];
// @public (undocumented)
type IImportAntennasRequest = operations['i/import-antennas']['requestBody']['content']['application/json'];
// @public (undocumented)
type IImportBlockingRequest = operations['i/import-blocking']['requestBody']['content']['application/json'];
// @public (undocumented)
type IImportFollowingRequest = operations['i/import-following']['requestBody']['content']['application/json'];
// @public (undocumented)
type IImportMutingRequest = operations['i/import-muting']['requestBody']['content']['application/json'];
// @public (undocumented)
type IImportUserListsRequest = operations['i/import-user-lists']['requestBody']['content']['application/json'];
// @public (undocumented)
type IMoveRequest = operations['i/move']['requestBody']['content']['application/json'];
// @public (undocumented)
type IMoveResponse = operations['i/move']['responses']['200']['content']['application/json'];
// @public (undocumented)
type INotificationsGroupedRequest = operations['i/notifications-grouped']['requestBody']['content']['application/json'];
// @public (undocumented)
type INotificationsGroupedResponse = operations['i/notifications-grouped']['responses']['200']['content']['application/json'];
// @public (undocumented)
type INotificationsRequest = operations['i/notifications']['requestBody']['content']['application/json'];
// @public (undocumented)
type INotificationsResponse = operations['i/notifications']['responses']['200']['content']['application/json'];
// @public (undocumented)
type InviteCode = components['schemas']['InviteCode'];
// @public (undocumented)
type InviteCreateResponse = operations['invite/create']['responses']['200']['content']['application/json'];
// @public (undocumented)
type InviteDeleteRequest = operations['invite/delete']['requestBody']['content']['application/json'];
// @public (undocumented)
type InviteLimitResponse = operations['invite/limit']['responses']['200']['content']['application/json'];
// @public (undocumented)
type InviteListRequest = operations['invite/list']['requestBody']['content']['application/json'];
// @public (undocumented)
type InviteListResponse = operations['invite/list']['responses']['200']['content']['application/json'];
// @public (undocumented)
type IPageLikesRequest = operations['i/page-likes']['requestBody']['content']['application/json'];
// @public (undocumented)
type IPageLikesResponse = operations['i/page-likes']['responses']['200']['content']['application/json'];
// @public (undocumented)
type IPagesRequest = operations['i/pages']['requestBody']['content']['application/json'];
// @public (undocumented)
type IPagesResponse = operations['i/pages']['responses']['200']['content']['application/json'];
// @public (undocumented)
type IPinRequest = operations['i/pin']['requestBody']['content']['application/json'];
// @public (undocumented)
type IPinResponse = operations['i/pin']['responses']['200']['content']['application/json'];
// @public (undocumented)
type IReadAnnouncementRequest = operations['i/read-announcement']['requestBody']['content']['application/json'];
// @public (undocumented)
type IRegenerateTokenRequest = operations['i/regenerate-token']['requestBody']['content']['application/json'];
// @public (undocumented)
type IRegistryGetAllRequest = operations['i/registry/get-all']['requestBody']['content']['application/json'];
// @public (undocumented)
type IRegistryGetAllResponse = operations['i/registry/get-all']['responses']['200']['content']['application/json'];
// @public (undocumented)
type IRegistryGetDetailRequest = operations['i/registry/get-detail']['requestBody']['content']['application/json'];
// @public (undocumented)
type IRegistryGetDetailResponse = operations['i/registry/get-detail']['responses']['200']['content']['application/json'];
// @public (undocumented)
type IRegistryGetRequest = operations['i/registry/get']['requestBody']['content']['application/json'];
// @public (undocumented)
type IRegistryGetResponse = operations['i/registry/get']['responses']['200']['content']['application/json'];
// @public (undocumented)
type IRegistryKeysRequest = operations['i/registry/keys']['requestBody']['content']['application/json'];
// @public (undocumented)
type IRegistryKeysWithTypeRequest = operations['i/registry/keys-with-type']['requestBody']['content']['application/json'];
// @public (undocumented)
type IRegistryKeysWithTypeResponse = operations['i/registry/keys-with-type']['responses']['200']['content']['application/json'];
// @public (undocumented)
type IRegistryRemoveRequest = operations['i/registry/remove']['requestBody']['content']['application/json'];
// @public (undocumented)
type IRegistryScopesWithDomainResponse = operations['i/registry/scopes-with-domain']['responses']['200']['content']['application/json'];
// @public (undocumented)
type IRegistrySetRequest = operations['i/registry/set']['requestBody']['content']['application/json'];
// @public (undocumented)
type IResponse = operations['i']['responses']['200']['content']['application/json'];
enhance: 招待機能の改善 (#11195) * refactor(backend): 招待機能を改修 * feat(backend): 招待コードのcreate/delete/listエンドポイントを追加 * add(misskey-js): エンドポイントと型を追加 * change(backend): metaでinvite関連の情報も返すように * add(misskey-js): エンドポイントと型を追加 * add(backend): `/endpoints/invite/limit`を追加 * fix: createdByがnullableではなかったのを修正 * fix: relationが取得できていなかった問題を修正 * fix: パラメータを間違えていたのを修正 * feat(client): 招待ページを実装 * change(client): インスタンスメニューの「招待」押した場合に招待ページに飛ぶように変更 * feat: 招待コードをコピーできるように * change(backend): metaに招待コード発行に関する情報を持たせるのをやめる * feat: ロールごとに招待コードの発行上限数などを設定できるように * change(client): 招待コードをコピーしたときにダイアログを出すように * add: 招待に関する管理者用のエンドポイントを追加 * change(backend): モデレーターであれば作成者以外でも招待コードを削除できるように * change(backend): admin/invite/listはオフセットでページネーションするように * feat(client): 招待コードの管理ページを追加 * feat(client): 招待コードのリストをソートできるように * change: `admin/invite/create`のレスポンスを修正 * fix(client): 有効期限を指定できていなかった問題を修正 * refactor: 必要のない箇所を削除 * perf(backend): use limit() instead of take() * change(client): 作成ボタンを見た目を変更 * refactor: 招待コードの生成部分を共通化し、コード内に"01OI"のいずれかの文字を含まないように * fix(client): paginationの仕様が変わっていたので修正 * change(backend): expiresAtパラメータのnullを許容 * change(client): 有効期限を設けないときは日付の入力欄を非表示に * fix: 自身のポリシーよりもインスタンス側のポリシーが優先表示される問題を修正 * fix: n時間のときに「n時間間」となってしまうのを修正 * fix(backend): ポリシーが途中で変更されたときに作成可能数がマイナス表記になってしまうのを修正 * change(client): 招待コードのユーザー名が不明な理由を表示するように * update: CHANGELOG.md * lint * refactor * refactor * tweak ui * :art: * :art: * add(backend): indexを追加 * change(backend): indexの追加に伴う変更 * change(client): インスタンスメニューの「招待」の場所を変更 * add(frontend): MkInviteCode用のstorybookを追加 * Update misskey-js.api.md * fix(misskey-js): InviteのcreatedByの型が間違っていたのを修正 --------- Co-authored-by: syuilo <Syuilotan@yahoo.co.jp> Co-authored-by: tamaina <tamaina@hotmail.co.jp>
2023-07-15 00:57:58 +00:00
// @public (undocumented)
type IRevokeTokenRequest = operations['i/revoke-token']['requestBody']['content']['application/json'];
// @public (undocumented)
function isAPIError(reason: Record<PropertyKey, unknown>): reason is APIError;
// @public (undocumented)
type ISigninHistoryRequest = operations['i/signin-history']['requestBody']['content']['application/json'];
// @public (undocumented)
type ISigninHistoryResponse = operations['i/signin-history']['responses']['200']['content']['application/json'];
// @public (undocumented)
type IUnpinRequest = operations['i/unpin']['requestBody']['content']['application/json'];
// @public (undocumented)
type IUnpinResponse = operations['i/unpin']['responses']['200']['content']['application/json'];
// @public (undocumented)
type IUpdateEmailRequest = operations['i/update-email']['requestBody']['content']['application/json'];
// @public (undocumented)
type IUpdateEmailResponse = operations['i/update-email']['responses']['200']['content']['application/json'];
// @public (undocumented)
type IUpdateRequest = operations['i/update']['requestBody']['content']['application/json'];
// @public (undocumented)
type IUpdateResponse = operations['i/update']['responses']['200']['content']['application/json'];
// @public (undocumented)
type IWebhooksCreateRequest = operations['i/webhooks/create']['requestBody']['content']['application/json'];
// @public (undocumented)
type IWebhooksCreateResponse = operations['i/webhooks/create']['responses']['200']['content']['application/json'];
// @public (undocumented)
type IWebhooksDeleteRequest = operations['i/webhooks/delete']['requestBody']['content']['application/json'];
// @public (undocumented)
type IWebhooksListResponse = operations['i/webhooks/list']['responses']['200']['content']['application/json'];
// @public (undocumented)
type IWebhooksShowRequest = operations['i/webhooks/show']['requestBody']['content']['application/json'];
// @public (undocumented)
type IWebhooksShowResponse = operations['i/webhooks/show']['responses']['200']['content']['application/json'];
// @public (undocumented)
type IWebhooksUpdateRequest = operations['i/webhooks/update']['requestBody']['content']['application/json'];
// @public (undocumented)
type MeDetailed = components['schemas']['MeDetailed'];
// @public (undocumented)
type MeDetailedOnly = components['schemas']['MeDetailedOnly'];
// @public (undocumented)
type MetaRequest = operations['meta']['requestBody']['content']['application/json'];
// @public (undocumented)
type MetaResponse = operations['meta']['responses']['200']['content']['application/json'];
// @public (undocumented)
type MiauthGenTokenRequest = operations['miauth/gen-token']['requestBody']['content']['application/json'];
// @public (undocumented)
type MiauthGenTokenResponse = operations['miauth/gen-token']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ModerationLog = {
id: ID;
createdAt: DateString;
userId: User['id'];
user: UserDetailedNotMe | null;
} & ({
type: 'updateServerSettings';
info: ModerationLogPayloads['updateServerSettings'];
} | {
type: 'suspend';
info: ModerationLogPayloads['suspend'];
} | {
type: 'unsuspend';
info: ModerationLogPayloads['unsuspend'];
} | {
type: 'updateUserNote';
info: ModerationLogPayloads['updateUserNote'];
} | {
type: 'addCustomEmoji';
info: ModerationLogPayloads['addCustomEmoji'];
2023-09-24 01:57:24 +00:00
} | {
type: 'updateCustomEmoji';
info: ModerationLogPayloads['updateCustomEmoji'];
} | {
type: 'deleteCustomEmoji';
info: ModerationLogPayloads['deleteCustomEmoji'];
} | {
type: 'assignRole';
info: ModerationLogPayloads['assignRole'];
} | {
type: 'unassignRole';
info: ModerationLogPayloads['unassignRole'];
2023-09-25 01:29:12 +00:00
} | {
type: 'createRole';
info: ModerationLogPayloads['createRole'];
} | {
type: 'updateRole';
info: ModerationLogPayloads['updateRole'];
} | {
type: 'deleteRole';
info: ModerationLogPayloads['deleteRole'];
} | {
type: 'clearQueue';
info: ModerationLogPayloads['clearQueue'];
} | {
type: 'promoteQueue';
info: ModerationLogPayloads['promoteQueue'];
2023-09-24 01:46:09 +00:00
} | {
type: 'deleteDriveFile';
info: ModerationLogPayloads['deleteDriveFile'];
} | {
type: 'deleteNote';
info: ModerationLogPayloads['deleteNote'];
} | {
type: 'createGlobalAnnouncement';
info: ModerationLogPayloads['createGlobalAnnouncement'];
} | {
type: 'createUserAnnouncement';
info: ModerationLogPayloads['createUserAnnouncement'];
} | {
type: 'updateGlobalAnnouncement';
info: ModerationLogPayloads['updateGlobalAnnouncement'];
} | {
type: 'updateUserAnnouncement';
info: ModerationLogPayloads['updateUserAnnouncement'];
} | {
type: 'deleteGlobalAnnouncement';
info: ModerationLogPayloads['deleteGlobalAnnouncement'];
} | {
type: 'deleteUserAnnouncement';
info: ModerationLogPayloads['deleteUserAnnouncement'];
2023-09-23 11:50:02 +00:00
} | {
type: 'resetPassword';
info: ModerationLogPayloads['resetPassword'];
} | {
type: 'suspendRemoteInstance';
info: ModerationLogPayloads['suspendRemoteInstance'];
} | {
type: 'unsuspendRemoteInstance';
info: ModerationLogPayloads['unsuspendRemoteInstance'];
2023-09-24 06:40:38 +00:00
} | {
type: 'markSensitiveDriveFile';
info: ModerationLogPayloads['markSensitiveDriveFile'];
} | {
type: 'unmarkSensitiveDriveFile';
info: ModerationLogPayloads['unmarkSensitiveDriveFile'];
2023-09-28 01:02:05 +00:00
} | {
type: 'createInvitation';
info: ModerationLogPayloads['createInvitation'];
2023-09-29 06:01:13 +00:00
} | {
type: 'createAd';
info: ModerationLogPayloads['createAd'];
} | {
type: 'updateAd';
info: ModerationLogPayloads['updateAd'];
} | {
type: 'deleteAd';
info: ModerationLogPayloads['deleteAd'];
} | {
type: 'createAvatarDecoration';
info: ModerationLogPayloads['createAvatarDecoration'];
} | {
type: 'updateAvatarDecoration';
info: ModerationLogPayloads['updateAvatarDecoration'];
} | {
type: 'deleteAvatarDecoration';
info: ModerationLogPayloads['deleteAvatarDecoration'];
} | {
type: 'resolveAbuseReport';
info: ModerationLogPayloads['resolveAbuseReport'];
} | {
type: 'unsetUserAvatar';
info: ModerationLogPayloads['unsetUserAvatar'];
} | {
type: 'unsetUserBanner';
info: ModerationLogPayloads['unsetUserBanner'];
});
// @public (undocumented)
export const moderationLogTypes: readonly ["updateServerSettings", "suspend", "unsuspend", "updateUserNote", "addCustomEmoji", "updateCustomEmoji", "deleteCustomEmoji", "assignRole", "unassignRole", "createRole", "updateRole", "deleteRole", "clearQueue", "promoteQueue", "deleteDriveFile", "deleteNote", "createGlobalAnnouncement", "createUserAnnouncement", "updateGlobalAnnouncement", "updateUserAnnouncement", "deleteGlobalAnnouncement", "deleteUserAnnouncement", "resetPassword", "suspendRemoteInstance", "unsuspendRemoteInstance", "markSensitiveDriveFile", "unmarkSensitiveDriveFile", "resolveAbuseReport", "createInvitation", "createAd", "updateAd", "deleteAd", "createAvatarDecoration", "updateAvatarDecoration", "deleteAvatarDecoration", "unsetUserAvatar", "unsetUserBanner"];
// @public (undocumented)
type MuteCreateRequest = operations['mute/create']['requestBody']['content']['application/json'];
// @public (undocumented)
type MuteDeleteRequest = operations['mute/delete']['requestBody']['content']['application/json'];
// @public (undocumented)
export const mutedNoteReasons: readonly ["word", "manual", "spam", "other"];
// @public (undocumented)
type MuteListRequest = operations['mute/list']['requestBody']['content']['application/json'];
// @public (undocumented)
type MuteListResponse = operations['mute/list']['responses']['200']['content']['application/json'];
// @public (undocumented)
type Muting = components['schemas']['Muting'];
// @public (undocumented)
type MyAppsRequest = operations['my/apps']['requestBody']['content']['application/json'];
// @public (undocumented)
type MyAppsResponse = operations['my/apps']['responses']['200']['content']['application/json'];
// @public (undocumented)
type Note = components['schemas']['Note'];
// @public (undocumented)
type NoteFavorite = components['schemas']['NoteFavorite'];
// @public (undocumented)
type NoteReaction = components['schemas']['NoteReaction'];
// @public (undocumented)
type NotesChildrenRequest = operations['notes/children']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesChildrenResponse = operations['notes/children']['responses']['200']['content']['application/json'];
// @public (undocumented)
type NotesClipsRequest = operations['notes/clips']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesClipsResponse = operations['notes/clips']['responses']['200']['content']['application/json'];
// @public (undocumented)
type NotesConversationRequest = operations['notes/conversation']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesConversationResponse = operations['notes/conversation']['responses']['200']['content']['application/json'];
// @public (undocumented)
type NotesCreateRequest = operations['notes/create']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesCreateResponse = operations['notes/create']['responses']['200']['content']['application/json'];
// @public (undocumented)
type NotesDeleteRequest = operations['notes/delete']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesFavoritesCreateRequest = operations['notes/favorites/create']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesFavoritesDeleteRequest = operations['notes/favorites/delete']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesFeaturedRequest = operations['notes/featured']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesFeaturedResponse = operations['notes/featured']['responses']['200']['content']['application/json'];
// @public (undocumented)
type NotesGlobalTimelineRequest = operations['notes/global-timeline']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesGlobalTimelineResponse = operations['notes/global-timeline']['responses']['200']['content']['application/json'];
// @public (undocumented)
type NotesHybridTimelineRequest = operations['notes/hybrid-timeline']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesHybridTimelineResponse = operations['notes/hybrid-timeline']['responses']['200']['content']['application/json'];
// @public (undocumented)
type NotesLocalTimelineRequest = operations['notes/local-timeline']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesLocalTimelineResponse = operations['notes/local-timeline']['responses']['200']['content']['application/json'];
// @public (undocumented)
type NotesMentionsRequest = operations['notes/mentions']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesMentionsResponse = operations['notes/mentions']['responses']['200']['content']['application/json'];
// @public (undocumented)
type NotesPollsRecommendationRequest = operations['notes/polls/recommendation']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesPollsRecommendationResponse = operations['notes/polls/recommendation']['responses']['200']['content']['application/json'];
// @public (undocumented)
type NotesPollsVoteRequest = operations['notes/polls/vote']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesReactionsCreateRequest = operations['notes/reactions/create']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesReactionsDeleteRequest = operations['notes/reactions/delete']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesReactionsRequest = operations['notes/reactions']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesReactionsResponse = operations['notes/reactions']['responses']['200']['content']['application/json'];
// @public (undocumented)
type NotesRenotesRequest = operations['notes/renotes']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesRenotesResponse = operations['notes/renotes']['responses']['200']['content']['application/json'];
// @public (undocumented)
type NotesRepliesRequest = operations['notes/replies']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesRepliesResponse = operations['notes/replies']['responses']['200']['content']['application/json'];
// @public (undocumented)
type NotesRequest = operations['notes']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesResponse = operations['notes']['responses']['200']['content']['application/json'];
// @public (undocumented)
type NotesSearchByTagRequest = operations['notes/search-by-tag']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesSearchByTagResponse = operations['notes/search-by-tag']['responses']['200']['content']['application/json'];
// @public (undocumented)
type NotesSearchRequest = operations['notes/search']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesSearchResponse = operations['notes/search']['responses']['200']['content']['application/json'];
// @public (undocumented)
type NotesShowRequest = operations['notes/show']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesShowResponse = operations['notes/show']['responses']['200']['content']['application/json'];
// @public (undocumented)
type NotesStateRequest = operations['notes/state']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesStateResponse = operations['notes/state']['responses']['200']['content']['application/json'];
// @public (undocumented)
type NotesThreadMutingCreateRequest = operations['notes/thread-muting/create']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesThreadMutingDeleteRequest = operations['notes/thread-muting/delete']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesTimelineRequest = operations['notes/timeline']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesTimelineResponse = operations['notes/timeline']['responses']['200']['content']['application/json'];
// @public (undocumented)
type NotesTranslateRequest = operations['notes/translate']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesTranslateResponse = operations['notes/translate']['responses']['200']['content']['application/json'];
// @public (undocumented)
type NotesUnrenoteRequest = operations['notes/unrenote']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesUserListTimelineRequest = operations['notes/user-list-timeline']['requestBody']['content']['application/json'];
// @public (undocumented)
type NotesUserListTimelineResponse = operations['notes/user-list-timeline']['responses']['200']['content']['application/json'];
// @public (undocumented)
export const noteVisibilities: readonly ["public", "home", "followers", "specified"];
// @public (undocumented)
type Notification_2 = components['schemas']['Notification'];
// @public (undocumented)
type NotificationsCreateRequest = operations['notifications/create']['requestBody']['content']['application/json'];
// @public (undocumented)
export const notificationTypes: readonly ["note", "follow", "mention", "reply", "renote", "quote", "reaction", "pollVote", "pollEnded", "receiveFollowRequest", "followRequestAccepted", "groupInvited", "app", "roleAssigned", "achievementEarned"];
// @public (undocumented)
type Page = components['schemas']['Page'];
refactor: frontendのcomponentsの型エラーを改善 (#12926) * add: safeFloatParserを追加 * fix: 欠けていた型を追加 * refactor: pageBlockTypesをjson-schemaに移植 * refactor: components/global内の型エラーが出ている箇所を修正 * lint: fix null check style * refactor: fix type error * refactor: fix some type errors * fix: 翻訳が抜けていた箇所を修正 * refactor: getJsonSchemaで正しいスキーマが返されるように修正 * fix: MkChartの型エラーとbytesオプションが機能していない問題を修正 * fix(misskey-js): `drive`->`folderUpdated`のpayloadの型が間違っていたのを修正 * refactor: fix some type errors * change: Captcha読み込み中の文言をLoadingに変更 * refactor(backend/misskey-js): MainEventの型を改善 * refactor: chartjs-plugin-gradientが二重でpluginに登録されていたのを修正 * update: misskey-js.api.md * refactor: fix some type errors * fix: backendのtypecheckが落ちていたのを修正 * update: misskey-js.api.md * add: json-schemaのnoteにpollの型定義を追加 * refactor: noteのjson-schemaの型を改善 * refactor: MkPoll * refactor: fix some type errors * change: UserLiteにisLockedを持たせるように * fix: notificationスキーマにroleが含まれていないのを修正 * Revert "change: UserLiteにisLockedを持たせるように" This reverts commit 1bb0c8e7a9b19a4e9f21bf7381712b98f27672a5. * fix: フォロー通知から鍵垢へのフォローを行うと処理中のまま止まってしまう問題を修正 * refactor: noteスキーマのvisibilityにenumを追加 * change: deepCloneのCloneableTypeにundefinedを追加 * refactor: fix some type errors * refactor: `allowEmpty: false`を使用していた箇所を`minLength: 1`に置き換え * enhance: API 'retension' のresponseの型を追加 * fix: Chart関連のtooltipが正しい位置に表示されない問題を修正 * refactor: fix some type errors * fix: 型情報が不足していたのを修正 * enhance: announcementスキーマにenumを追加 * enhance: ロールポリシーの型定義をRoleServiceからjson-schemaに移植 * refactor: policiesを`ref: RolePolicies`に統一 * fix: API `meta` のレスポンスの型にpoliciesが含まれていないのを修正 * refactor: fix some type errors * fix: backendのlintが落ちているのを修正 * fix: MkFoldableSectionの開閉時のanimationが適用されていない問題を修正 * fix: backendのtypecheckが落ちているのを修正 * update: run build-misskey-js-with-types * fix: MkDialogのmount時に文字数制限の判定が行われない問題を修正 * update: CHANGELOG.md * refactor: MkUserSelectDialogの型を改善 * fix: deepCloneでundefinedはcloneしないように (#9207) * change: frontendのcloneをbackend側にも反映 * update: CHANGELOG.md * fix: RoleServiceからPackを通して型RolePoliciesに依存させないように * Update packages/frontend/src/scripts/get-note-summary.ts * revert RoleService.ts changes * change: optional chaining -> non-null assertion * remove: unused import * fix: propsで渡されたuserがUserLiteの場合に意図しない動作になってしまうのを修正 * change: fix null check style * refactor: fix type error * change: fix null check style * Update packages/frontend/src/components/MkDrive.vue Co-authored-by: syuilo <Syuilotan@yahoo.co.jp> * refactor: css moduleでglobalを使わないように * refactor: roleのiconUrlは必ず存在するものとして扱うように * enhance: MenuButtonのactiveにcomputedを受け付けられるように * Update packages/frontend/src/components/MkNotePreview.vue * Update MkWindow.vue * refactor: notification.noteは必ず存在するものとして扱うように * Update packages/frontend/src/components/MkNotification.vue Co-authored-by: syuilo <Syuilotan@yahoo.co.jp> * fix: MkSignupDialogでdoneのemit時にresを含んでいなかったのを修正 * Update packages/frontend/src/scripts/clone.ts Co-authored-by: syuilo <Syuilotan@yahoo.co.jp> * refactor: 不要な返り値の型を削除 * refactor: 不要なnullチェックを削除 * update: misskey-js-autogen * update: clone.ts * refactor * Update MkNotification.vue * Update MkNotification.vue * :v: * Update MkNotification.vue * Update MkNotification.vue * Update MkNotification.vue * Update MkNotifications.vue * Update MkUserSetupDialog.Profile.vue * Update MkUserCardMini.vue * :v: * Update MkMenu.vue --------- Co-authored-by: syuilo <Syuilotan@yahoo.co.jp>
2024-01-30 10:53:53 +00:00
// @public (undocumented)
type PageBlock = components['schemas']['PageBlock'];
// @public (undocumented)
type PageEvent = {
pageId: Page['id'];
event: string;
var: any;
userId: User['id'];
user: User;
};
// @public (undocumented)
type PagePushRequest = operations['page-push']['requestBody']['content']['application/json'];
// @public (undocumented)
type PagesCreateRequest = operations['pages/create']['requestBody']['content']['application/json'];
// @public (undocumented)
type PagesCreateResponse = operations['pages/create']['responses']['200']['content']['application/json'];
// @public (undocumented)
type PagesDeleteRequest = operations['pages/delete']['requestBody']['content']['application/json'];
// @public (undocumented)
type PagesFeaturedResponse = operations['pages/featured']['responses']['200']['content']['application/json'];
// @public (undocumented)
type PagesLikeRequest = operations['pages/like']['requestBody']['content']['application/json'];
// @public (undocumented)
type PagesShowRequest = operations['pages/show']['requestBody']['content']['application/json'];
// @public (undocumented)
type PagesShowResponse = operations['pages/show']['responses']['200']['content']['application/json'];
// @public (undocumented)
type PagesUnlikeRequest = operations['pages/unlike']['requestBody']['content']['application/json'];
// @public (undocumented)
type PagesUpdateRequest = operations['pages/update']['requestBody']['content']['application/json'];
// @public (undocumented)
function parse(acct: string): Acct;
// @public (undocumented)
export const permissions: readonly ["read:account", "write:account", "read:blocks", "write:blocks", "read:drive", "write:drive", "read:favorites", "write:favorites", "read:following", "write:following", "read:messaging", "write:messaging", "read:mutes", "write:mutes", "write:notes", "read:notifications", "write:notifications", "read:reactions", "write:reactions", "write:votes", "read:pages", "write:pages", "write:page-likes", "read:page-likes", "read:user-groups", "write:user-groups", "read:channels", "write:channels", "read:gallery", "write:gallery", "read:gallery-likes", "write:gallery-likes", "read:flash", "write:flash", "read:flash-likes", "write:flash-likes", "read:admin:abuse-user-reports", "write:admin:delete-account", "write:admin:delete-all-files-of-a-user", "read:admin:index-stats", "read:admin:table-stats", "read:admin:user-ips", "read:admin:meta", "write:admin:reset-password", "write:admin:resolve-abuse-user-report", "write:admin:send-email", "read:admin:server-info", "read:admin:show-moderation-log", "read:admin:show-user", "read:admin:show-users", "write:admin:suspend-user", "write:admin:unset-user-avatar", "write:admin:unset-user-banner", "write:admin:unsuspend-user", "write:admin:meta", "write:admin:user-note", "write:admin:roles", "read:admin:roles", "write:admin:relays", "read:admin:relays", "write:admin:invite-codes", "read:admin:invite-codes", "write:admin:announcements", "read:admin:announcements", "write:admin:avatar-decorations", "read:admin:avatar-decorations", "write:admin:federation", "write:admin:account", "read:admin:account", "write:admin:emoji", "read:admin:emoji", "write:admin:queue", "read:admin:queue", "write:admin:promo", "write:admin:drive", "read:admin:drive", "write:admin:ad", "read:admin:ad", "write:invite-codes", "read:invite-codes", "write:clip-favorite", "read:clip-favorite", "read:federation", "write:report-abuse"];
// @public (undocumented)
type PingResponse = operations['ping']['responses']['200']['content']['application/json'];
// @public (undocumented)
type PinnedUsersResponse = operations['pinned-users']['responses']['200']['content']['application/json'];
// @public (undocumented)
type PromoReadRequest = operations['promo/read']['requestBody']['content']['application/json'];
// @public (undocumented)
type QueueCount = components['schemas']['QueueCount'];
// @public (undocumented)
type QueueStats = {
deliver: {
activeSincePrevTick: number;
active: number;
waiting: number;
delayed: number;
};
inbox: {
activeSincePrevTick: number;
active: number;
waiting: number;
delayed: number;
};
};
// @public (undocumented)
type QueueStatsLog = QueueStats[];
// @public (undocumented)
type RenoteMuteCreateRequest = operations['renote-mute/create']['requestBody']['content']['application/json'];
// @public (undocumented)
type RenoteMuteDeleteRequest = operations['renote-mute/delete']['requestBody']['content']['application/json'];
// @public (undocumented)
type RenoteMuteListRequest = operations['renote-mute/list']['requestBody']['content']['application/json'];
// @public (undocumented)
type RenoteMuteListResponse = operations['renote-mute/list']['responses']['200']['content']['application/json'];
// @public (undocumented)
type RenoteMuting = components['schemas']['RenoteMuting'];
// @public (undocumented)
type RequestResetPasswordRequest = operations['request-reset-password']['requestBody']['content']['application/json'];
// @public (undocumented)
type ResetPasswordRequest = operations['reset-password']['requestBody']['content']['application/json'];
// @public (undocumented)
type RetentionResponse = operations['retention']['responses']['200']['content']['application/json'];
2024-01-19 11:51:49 +00:00
// @public (undocumented)
type ReversiCancelMatchRequest = operations['reversi/cancel-match']['requestBody']['content']['application/json'];
// @public (undocumented)
type ReversiCancelMatchResponse = operations['reversi/cancel-match']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ReversiGameDetailed = components['schemas']['ReversiGameDetailed'];
// @public (undocumented)
type ReversiGameLite = components['schemas']['ReversiGameLite'];
// @public (undocumented)
type ReversiGamesRequest = operations['reversi/games']['requestBody']['content']['application/json'];
// @public (undocumented)
type ReversiGamesResponse = operations['reversi/games']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ReversiInvitationsResponse = operations['reversi/invitations']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ReversiMatchRequest = operations['reversi/match']['requestBody']['content']['application/json'];
// @public (undocumented)
type ReversiMatchResponse = operations['reversi/match']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ReversiShowGameRequest = operations['reversi/show-game']['requestBody']['content']['application/json'];
// @public (undocumented)
type ReversiShowGameResponse = operations['reversi/show-game']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ReversiSurrenderRequest = operations['reversi/surrender']['requestBody']['content']['application/json'];
// @public (undocumented)
type ReversiVerifyRequest = operations['reversi/verify']['requestBody']['content']['application/json'];
// @public (undocumented)
type ReversiVerifyResponse = operations['reversi/verify']['responses']['200']['content']['application/json'];
// @public (undocumented)
type Role = components['schemas']['Role'];
// @public (undocumented)
type RoleLite = components['schemas']['RoleLite'];
refactor: frontendのcomponentsの型エラーを改善 (#12926) * add: safeFloatParserを追加 * fix: 欠けていた型を追加 * refactor: pageBlockTypesをjson-schemaに移植 * refactor: components/global内の型エラーが出ている箇所を修正 * lint: fix null check style * refactor: fix type error * refactor: fix some type errors * fix: 翻訳が抜けていた箇所を修正 * refactor: getJsonSchemaで正しいスキーマが返されるように修正 * fix: MkChartの型エラーとbytesオプションが機能していない問題を修正 * fix(misskey-js): `drive`->`folderUpdated`のpayloadの型が間違っていたのを修正 * refactor: fix some type errors * change: Captcha読み込み中の文言をLoadingに変更 * refactor(backend/misskey-js): MainEventの型を改善 * refactor: chartjs-plugin-gradientが二重でpluginに登録されていたのを修正 * update: misskey-js.api.md * refactor: fix some type errors * fix: backendのtypecheckが落ちていたのを修正 * update: misskey-js.api.md * add: json-schemaのnoteにpollの型定義を追加 * refactor: noteのjson-schemaの型を改善 * refactor: MkPoll * refactor: fix some type errors * change: UserLiteにisLockedを持たせるように * fix: notificationスキーマにroleが含まれていないのを修正 * Revert "change: UserLiteにisLockedを持たせるように" This reverts commit 1bb0c8e7a9b19a4e9f21bf7381712b98f27672a5. * fix: フォロー通知から鍵垢へのフォローを行うと処理中のまま止まってしまう問題を修正 * refactor: noteスキーマのvisibilityにenumを追加 * change: deepCloneのCloneableTypeにundefinedを追加 * refactor: fix some type errors * refactor: `allowEmpty: false`を使用していた箇所を`minLength: 1`に置き換え * enhance: API 'retension' のresponseの型を追加 * fix: Chart関連のtooltipが正しい位置に表示されない問題を修正 * refactor: fix some type errors * fix: 型情報が不足していたのを修正 * enhance: announcementスキーマにenumを追加 * enhance: ロールポリシーの型定義をRoleServiceからjson-schemaに移植 * refactor: policiesを`ref: RolePolicies`に統一 * fix: API `meta` のレスポンスの型にpoliciesが含まれていないのを修正 * refactor: fix some type errors * fix: backendのlintが落ちているのを修正 * fix: MkFoldableSectionの開閉時のanimationが適用されていない問題を修正 * fix: backendのtypecheckが落ちているのを修正 * update: run build-misskey-js-with-types * fix: MkDialogのmount時に文字数制限の判定が行われない問題を修正 * update: CHANGELOG.md * refactor: MkUserSelectDialogの型を改善 * fix: deepCloneでundefinedはcloneしないように (#9207) * change: frontendのcloneをbackend側にも反映 * update: CHANGELOG.md * fix: RoleServiceからPackを通して型RolePoliciesに依存させないように * Update packages/frontend/src/scripts/get-note-summary.ts * revert RoleService.ts changes * change: optional chaining -> non-null assertion * remove: unused import * fix: propsで渡されたuserがUserLiteの場合に意図しない動作になってしまうのを修正 * change: fix null check style * refactor: fix type error * change: fix null check style * Update packages/frontend/src/components/MkDrive.vue Co-authored-by: syuilo <Syuilotan@yahoo.co.jp> * refactor: css moduleでglobalを使わないように * refactor: roleのiconUrlは必ず存在するものとして扱うように * enhance: MenuButtonのactiveにcomputedを受け付けられるように * Update packages/frontend/src/components/MkNotePreview.vue * Update MkWindow.vue * refactor: notification.noteは必ず存在するものとして扱うように * Update packages/frontend/src/components/MkNotification.vue Co-authored-by: syuilo <Syuilotan@yahoo.co.jp> * fix: MkSignupDialogでdoneのemit時にresを含んでいなかったのを修正 * Update packages/frontend/src/scripts/clone.ts Co-authored-by: syuilo <Syuilotan@yahoo.co.jp> * refactor: 不要な返り値の型を削除 * refactor: 不要なnullチェックを削除 * update: misskey-js-autogen * update: clone.ts * refactor * Update MkNotification.vue * Update MkNotification.vue * :v: * Update MkNotification.vue * Update MkNotification.vue * Update MkNotification.vue * Update MkNotifications.vue * Update MkUserSetupDialog.Profile.vue * Update MkUserCardMini.vue * :v: * Update MkMenu.vue --------- Co-authored-by: syuilo <Syuilotan@yahoo.co.jp>
2024-01-30 10:53:53 +00:00
// @public (undocumented)
type RolePolicies = components['schemas']['RolePolicies'];
// @public (undocumented)
type RolesListResponse = operations['roles/list']['responses']['200']['content']['application/json'];
// @public (undocumented)
type RolesNotesRequest = operations['roles/notes']['requestBody']['content']['application/json'];
// @public (undocumented)
type RolesNotesResponse = operations['roles/notes']['responses']['200']['content']['application/json'];
// @public (undocumented)
type RolesShowRequest = operations['roles/show']['requestBody']['content']['application/json'];
// @public (undocumented)
type RolesShowResponse = operations['roles/show']['responses']['200']['content']['application/json'];
// @public (undocumented)
type RolesUsersRequest = operations['roles/users']['requestBody']['content']['application/json'];
// @public (undocumented)
type RolesUsersResponse = operations['roles/users']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ServerInfoResponse = operations['server-info']['responses']['200']['content']['application/json'];
// @public (undocumented)
type ServerStats = {
cpu: number;
mem: {
used: number;
active: number;
};
net: {
rx: number;
tx: number;
};
fs: {
r: number;
w: number;
};
};
// @public (undocumented)
type ServerStatsLog = ServerStats[];
// @public (undocumented)
type Signin = components['schemas']['Signin'];
// @public (undocumented)
type SigninRequest = {
username: string;
password: string;
token?: string;
};
// @public (undocumented)
type SigninResponse = {
id: User['id'];
i: string;
};
// @public (undocumented)
type SignupPendingRequest = {
code: string;
};
// @public (undocumented)
type SignupPendingResponse = {
id: User['id'];
i: string;
};
// @public (undocumented)
type SignupRequest = {
username: string;
password: string;
host?: string;
invitationCode?: string;
emailAddress?: string;
'hcaptcha-response'?: string | null;
'g-recaptcha-response'?: string | null;
'turnstile-response'?: string | null;
};
// @public (undocumented)
type SignupResponse = MeDetailed & {
token: string;
};
// @public (undocumented)
type StatsResponse = operations['stats']['responses']['200']['content']['application/json'];
// Warning: (ae-forgotten-export) The symbol "StreamEvents" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export class Stream extends EventEmitter<StreamEvents> {
constructor(origin: string, user: {
token: string;
} | null, options?: {
WebSocket?: any;
});
// (undocumented)
close(): void;
// Warning: (ae-forgotten-export) The symbol "NonSharedConnection" needs to be exported by the entry point index.d.ts
//
// (undocumented)
disconnectToChannel(connection: NonSharedConnection): void;
2023-06-06 00:37:36 +00:00
// (undocumented)
heartbeat(): void;
// (undocumented)
ping(): void;
// Warning: (ae-forgotten-export) The symbol "SharedConnection" needs to be exported by the entry point index.d.ts
//
// (undocumented)
removeSharedConnection(connection: SharedConnection): void;
// Warning: (ae-forgotten-export) The symbol "Pool" needs to be exported by the entry point index.d.ts
//
// (undocumented)
removeSharedConnectionPool(pool: Pool): void;
// (undocumented)
2023-04-08 05:39:54 +00:00
send(typeOrPayload: string): void;
// (undocumented)
send(typeOrPayload: string, payload: any): void;
// (undocumented)
send(typeOrPayload: Record<string, any> | any[]): void;
// (undocumented)
state: 'initializing' | 'reconnecting' | 'connected';
// (undocumented)
useChannel<C extends keyof Channels>(channel: C, params?: Channels[C]['params'], name?: string): ChannelConnection<Channels[C]>;
}
// Warning: (ae-forgotten-export) The symbol "SwitchCase" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "IsCaseMatched" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "GetCaseResult" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
type SwitchCaseResponseType<E extends keyof Endpoints, P extends Endpoints[E]['req']> = Endpoints[E]['res'] extends SwitchCase ? 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[E]['res']['$switch']['$default'] : Endpoints[E]['res'];
// @public (undocumented)
type SwRegisterRequest = operations['sw/register']['requestBody']['content']['application/json'];
// @public (undocumented)
type SwRegisterResponse = operations['sw/register']['responses']['200']['content']['application/json'];
// @public (undocumented)
type SwShowRegistrationRequest = operations['sw/show-registration']['requestBody']['content']['application/json'];
// @public (undocumented)
type SwShowRegistrationResponse = operations['sw/show-registration']['responses']['200']['content']['application/json'];
// @public (undocumented)
type SwUnregisterRequest = operations['sw/unregister']['requestBody']['content']['application/json'];
// @public (undocumented)
type SwUpdateRegistrationRequest = operations['sw/update-registration']['requestBody']['content']['application/json'];
// @public (undocumented)
type SwUpdateRegistrationResponse = operations['sw/update-registration']['responses']['200']['content']['application/json'];
// @public (undocumented)
type TestRequest = operations['test']['requestBody']['content']['application/json'];
// @public (undocumented)
type TestResponse = operations['test']['responses']['200']['content']['application/json'];
// @public (undocumented)
function toString_2(acct: Acct): string;
// @public (undocumented)
type User = components['schemas']['User'];
// @public (undocumented)
type UserDetailed = components['schemas']['UserDetailed'];
// @public (undocumented)
type UserDetailedNotMe = components['schemas']['UserDetailedNotMe'];
// @public (undocumented)
type UserDetailedNotMeOnly = components['schemas']['UserDetailedNotMeOnly'];
// @public (undocumented)
type UserList = components['schemas']['UserList'];
// @public (undocumented)
type UserLite = components['schemas']['UserLite'];
// @public (undocumented)
type UsernameAvailableRequest = operations['username/available']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsernameAvailableResponse = operations['username/available']['responses']['200']['content']['application/json'];
// @public (undocumented)
type UsersAchievementsRequest = operations['users/achievements']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersAchievementsResponse = operations['users/achievements']['responses']['200']['content']['application/json'];
// @public (undocumented)
type UsersClipsRequest = operations['users/clips']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersClipsResponse = operations['users/clips']['responses']['200']['content']['application/json'];
// @public (undocumented)
type UsersFeaturedNotesRequest = operations['users/featured-notes']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersFeaturedNotesResponse = operations['users/featured-notes']['responses']['200']['content']['application/json'];
// @public (undocumented)
type UsersFlashsRequest = operations['users/flashs']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersFlashsResponse = operations['users/flashs']['responses']['200']['content']['application/json'];
// @public (undocumented)
type UsersFollowersRequest = operations['users/followers']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersFollowersResponse = operations['users/followers']['responses']['200']['content']['application/json'];
// @public (undocumented)
type UsersFollowingRequest = operations['users/following']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersFollowingResponse = operations['users/following']['responses']['200']['content']['application/json'];
// @public (undocumented)
type UsersGalleryPostsRequest = operations['users/gallery/posts']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersGalleryPostsResponse = operations['users/gallery/posts']['responses']['200']['content']['application/json'];
// @public (undocumented)
type UsersGetFrequentlyRepliedUsersRequest = operations['users/get-frequently-replied-users']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersGetFrequentlyRepliedUsersResponse = operations['users/get-frequently-replied-users']['responses']['200']['content']['application/json'];
// @public (undocumented)
type UsersListsCreateFromPublicRequest = operations['users/lists/create-from-public']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersListsCreateFromPublicResponse = operations['users/lists/create-from-public']['responses']['200']['content']['application/json'];
// @public (undocumented)
type UsersListsCreateRequest = operations['users/lists/create']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersListsCreateResponse = operations['users/lists/create']['responses']['200']['content']['application/json'];
// @public (undocumented)
type UsersListsDeleteRequest = operations['users/lists/delete']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersListsFavoriteRequest = operations['users/lists/favorite']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersListsGetMembershipsRequest = operations['users/lists/get-memberships']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersListsGetMembershipsResponse = operations['users/lists/get-memberships']['responses']['200']['content']['application/json'];
// @public (undocumented)
type UsersListsListRequest = operations['users/lists/list']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersListsListResponse = operations['users/lists/list']['responses']['200']['content']['application/json'];
// @public (undocumented)
type UsersListsPullRequest = operations['users/lists/pull']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersListsPushRequest = operations['users/lists/push']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersListsShowRequest = operations['users/lists/show']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersListsShowResponse = operations['users/lists/show']['responses']['200']['content']['application/json'];
// @public (undocumented)
type UsersListsUnfavoriteRequest = operations['users/lists/unfavorite']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersListsUpdateMembershipRequest = operations['users/lists/update-membership']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersListsUpdateRequest = operations['users/lists/update']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersListsUpdateResponse = operations['users/lists/update']['responses']['200']['content']['application/json'];
// @public (undocumented)
type UsersNotesRequest = operations['users/notes']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersNotesResponse = operations['users/notes']['responses']['200']['content']['application/json'];
// @public (undocumented)
type UsersPagesRequest = operations['users/pages']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersPagesResponse = operations['users/pages']['responses']['200']['content']['application/json'];
// @public (undocumented)
type UsersReactionsRequest = operations['users/reactions']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersReactionsResponse = operations['users/reactions']['responses']['200']['content']['application/json'];
// @public (undocumented)
type UsersRecommendationRequest = operations['users/recommendation']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersRecommendationResponse = operations['users/recommendation']['responses']['200']['content']['application/json'];
// @public (undocumented)
type UsersRelationRequest = operations['users/relation']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersRelationResponse = operations['users/relation']['responses']['200']['content']['application/json'];
// @public (undocumented)
type UsersReportAbuseRequest = operations['users/report-abuse']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersRequest = operations['users']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersResponse = operations['users']['responses']['200']['content']['application/json'];
// @public (undocumented)
type UsersSearchByUsernameAndHostRequest = operations['users/search-by-username-and-host']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersSearchByUsernameAndHostResponse = operations['users/search-by-username-and-host']['responses']['200']['content']['application/json'];
// @public (undocumented)
type UsersSearchRequest = operations['users/search']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersSearchResponse = operations['users/search']['responses']['200']['content']['application/json'];
// @public (undocumented)
type UsersShowRequest = operations['users/show']['requestBody']['content']['application/json'];
// @public (undocumented)
type UsersShowResponse = operations['users/show']['responses']['200']['content']['application/json'];
// @public (undocumented)
type UsersUpdateMemoRequest = operations['users/update-memo']['requestBody']['content']['application/json'];
// Warnings were encountered during analysis:
//
// src/entities.ts:25:2 - (ae-forgotten-export) The symbol "ModerationLogPayloads" needs to be exported by the entry point index.d.ts
// (No @packageDocumentation comment for this package)
```