From 30311aca18e50a179021b45c3beaf0ee29d3a423 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E3=81=8A=E3=81=95=E3=82=80=E3=81=AE=E3=81=B2=E3=81=A8?=
<46447427+samunohito@users.noreply.github.com>
Date: Wed, 3 Jan 2024 13:41:28 +0900
Subject: [PATCH] =?UTF-8?q?fix(misskey-js):=20/signup=E3=81=A8/signin?=
=?UTF-8?q?=E3=81=AE=E5=AE=9A=E7=BE=A9=E3=82=92=E4=BD=9C=E6=88=90=E3=81=97?=
=?UTF-8?q?=E3=81=A6=E3=83=95=E3=83=AD=E3=83=B3=E3=83=88=E3=81=AE=E5=9E=8B?=
=?UTF-8?q?=E3=82=A8=E3=83=A9=E3=83=BC=E3=82=92=E6=8A=91=E5=88=B6=E3=81=99?=
=?UTF-8?q?=E3=82=8B=20(#12846)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
* fix(misskey-js): /signupと/signinの定義を復活してフロントの型エラーを抑制する
* fix ci
* fix ci
* fix
* fix
---------
Co-authored-by: osamu <46447427+sam-osamu@users.noreply.github.com>
---
packages/backend/test/e2e/2fa.ts | 2 +-
packages/backend/test/e2e/antennas.ts | 2 +-
packages/backend/test/e2e/api-visibility.ts | 10 ++--
packages/backend/test/e2e/api.ts | 6 +--
packages/backend/test/e2e/block.ts | 6 +--
packages/backend/test/e2e/endpoints.ts | 8 +--
packages/backend/test/e2e/fetch-resource.ts | 4 +-
packages/backend/test/e2e/ff-visibility.ts | 4 +-
packages/backend/test/e2e/move.ts | 12 ++---
packages/backend/test/e2e/mute.ts | 6 +--
packages/backend/test/e2e/note.ts | 4 +-
packages/backend/test/e2e/oauth.ts | 10 ++--
packages/backend/test/e2e/renote-mute.ts | 6 +--
packages/backend/test/e2e/streaming.ts | 14 ++---
packages/backend/test/e2e/thread-mute.ts | 6 +--
packages/backend/test/e2e/user-notes.ts | 2 +-
packages/misskey-js/etc/misskey-js.api.md | 59 +++++++++++++++++++++
packages/misskey-js/src/api.types.ts | 25 ++++++++-
packages/misskey-js/src/entities.ts | 37 ++++++++++++-
19 files changed, 170 insertions(+), 53 deletions(-)
diff --git a/packages/backend/test/e2e/2fa.ts b/packages/backend/test/e2e/2fa.ts
index ed967d2620..dfed8b2fce 100644
--- a/packages/backend/test/e2e/2fa.ts
+++ b/packages/backend/test/e2e/2fa.ts
@@ -24,7 +24,7 @@ import type * as misskey from 'misskey-js';
describe('2要素認証', () => {
let app: INestApplicationContext;
- let alice: misskey.entities.MeSignup;
+ let alice: misskey.entities.SignupResponse;
const config = loadConfig();
const password = 'test';
diff --git a/packages/backend/test/e2e/antennas.ts b/packages/backend/test/e2e/antennas.ts
index c0317f1435..9bac5122d4 100644
--- a/packages/backend/test/e2e/antennas.ts
+++ b/packages/backend/test/e2e/antennas.ts
@@ -37,7 +37,7 @@ describe('アンテナ', () => {
// - srcのenumにgroupが残っている
// - userGroupIdが残っている, isActiveがない
type Antenna = misskey.entities.Antenna | Packed<'Antenna'>;
- type User = misskey.entities.MeSignup;
+ type User = misskey.entities.SignupResponse;
type Note = misskey.entities.Note;
// アンテナを作成できる最小のパラメタ
diff --git a/packages/backend/test/e2e/api-visibility.ts b/packages/backend/test/e2e/api-visibility.ts
index 33c8d03fdb..afe4f9c05a 100644
--- a/packages/backend/test/e2e/api-visibility.ts
+++ b/packages/backend/test/e2e/api-visibility.ts
@@ -24,15 +24,15 @@ describe('API visibility', () => {
describe('Note visibility', () => {
//#region vars
/** ヒロイン */
- let alice: misskey.entities.MeSignup;
+ let alice: misskey.entities.SignupResponse;
/** フォロワー */
- let follower: misskey.entities.MeSignup;
+ let follower: misskey.entities.SignupResponse;
/** 非フォロワー */
- let other: misskey.entities.MeSignup;
+ let other: misskey.entities.SignupResponse;
/** 非フォロワーでもリプライやメンションをされた人 */
- let target: misskey.entities.MeSignup;
+ let target: misskey.entities.SignupResponse;
/** specified mentionでmentionを飛ばされる人 */
- let target2: misskey.entities.MeSignup;
+ let target2: misskey.entities.SignupResponse;
/** public-post */
let pub: any;
diff --git a/packages/backend/test/e2e/api.ts b/packages/backend/test/e2e/api.ts
index cf24228b83..ad351eebbb 100644
--- a/packages/backend/test/e2e/api.ts
+++ b/packages/backend/test/e2e/api.ts
@@ -13,9 +13,9 @@ import type * as misskey from 'misskey-js';
describe('API', () => {
let app: INestApplicationContext;
- let alice: misskey.entities.MeSignup;
- let bob: misskey.entities.MeSignup;
- let carol: misskey.entities.MeSignup;
+ let alice: misskey.entities.SignupResponse;
+ let bob: misskey.entities.SignupResponse;
+ let carol: misskey.entities.SignupResponse;
beforeAll(async () => {
app = await startServer();
diff --git a/packages/backend/test/e2e/block.ts b/packages/backend/test/e2e/block.ts
index 4445d9036c..25ff9f11ac 100644
--- a/packages/backend/test/e2e/block.ts
+++ b/packages/backend/test/e2e/block.ts
@@ -14,9 +14,9 @@ describe('Block', () => {
let app: INestApplicationContext;
// alice blocks bob
- let alice: misskey.entities.MeSignup;
- let bob: misskey.entities.MeSignup;
- let carol: misskey.entities.MeSignup;
+ let alice: misskey.entities.SignupResponse;
+ let bob: misskey.entities.SignupResponse;
+ let carol: misskey.entities.SignupResponse;
beforeAll(async () => {
app = await startServer();
diff --git a/packages/backend/test/e2e/endpoints.ts b/packages/backend/test/e2e/endpoints.ts
index 2ef3434bca..bfd0b0272d 100644
--- a/packages/backend/test/e2e/endpoints.ts
+++ b/packages/backend/test/e2e/endpoints.ts
@@ -17,10 +17,10 @@ import type * as misskey from 'misskey-js';
describe('Endpoints', () => {
let app: INestApplicationContext;
- let alice: misskey.entities.MeSignup;
- let bob: misskey.entities.MeSignup;
- let carol: misskey.entities.MeSignup;
- let dave: misskey.entities.MeSignup;
+ let alice: misskey.entities.SignupResponse;
+ let bob: misskey.entities.SignupResponse;
+ let carol: misskey.entities.SignupResponse;
+ let dave: misskey.entities.SignupResponse;
beforeAll(async () => {
app = await startServer();
diff --git a/packages/backend/test/e2e/fetch-resource.ts b/packages/backend/test/e2e/fetch-resource.ts
index 251d662760..28affe7768 100644
--- a/packages/backend/test/e2e/fetch-resource.ts
+++ b/packages/backend/test/e2e/fetch-resource.ts
@@ -25,7 +25,7 @@ const JSON_UTF8 = 'application/json; charset=utf-8';
describe('Webリソース', () => {
let app: INestApplicationContext;
- let alice: misskey.entities.MeSignup;
+ let alice: misskey.entities.SignupResponse;
let aliceUploadedFile: any;
let alicesPost: any;
let alicePage: any;
@@ -34,7 +34,7 @@ describe('Webリソース', () => {
let aliceGalleryPost: any;
let aliceChannel: any;
- let bob: misskey.entities.MeSignup;
+ let bob: misskey.entities.SignupResponse;
type Request = {
path: string,
diff --git a/packages/backend/test/e2e/ff-visibility.ts b/packages/backend/test/e2e/ff-visibility.ts
index 1fbd45c741..4d323e14e7 100644
--- a/packages/backend/test/e2e/ff-visibility.ts
+++ b/packages/backend/test/e2e/ff-visibility.ts
@@ -13,8 +13,8 @@ import type * as misskey from 'misskey-js';
describe('FF visibility', () => {
let app: INestApplicationContext;
- let alice: misskey.entities.MeSignup;
- let bob: misskey.entities.MeSignup;
+ let alice: misskey.entities.SignupResponse;
+ let bob: misskey.entities.SignupResponse;
beforeAll(async () => {
app = await startServer();
diff --git a/packages/backend/test/e2e/move.ts b/packages/backend/test/e2e/move.ts
index b009ef124a..f7da66a27c 100644
--- a/packages/backend/test/e2e/move.ts
+++ b/packages/backend/test/e2e/move.ts
@@ -20,12 +20,12 @@ describe('Account Move', () => {
let url: URL;
let root: any;
- let alice: misskey.entities.MeSignup;
- let bob: misskey.entities.MeSignup;
- let carol: misskey.entities.MeSignup;
- let dave: misskey.entities.MeSignup;
- let eve: misskey.entities.MeSignup;
- let frank: misskey.entities.MeSignup;
+ let alice: misskey.entities.SignupResponse;
+ let bob: misskey.entities.SignupResponse;
+ let carol: misskey.entities.SignupResponse;
+ let dave: misskey.entities.SignupResponse;
+ let eve: misskey.entities.SignupResponse;
+ let frank: misskey.entities.SignupResponse;
let Users: UsersRepository;
diff --git a/packages/backend/test/e2e/mute.ts b/packages/backend/test/e2e/mute.ts
index a4b57a1eba..3b5542dfe0 100644
--- a/packages/backend/test/e2e/mute.ts
+++ b/packages/backend/test/e2e/mute.ts
@@ -14,9 +14,9 @@ describe('Mute', () => {
let app: INestApplicationContext;
// alice mutes carol
- let alice: misskey.entities.MeSignup;
- let bob: misskey.entities.MeSignup;
- let carol: misskey.entities.MeSignup;
+ let alice: misskey.entities.SignupResponse;
+ let bob: misskey.entities.SignupResponse;
+ let carol: misskey.entities.SignupResponse;
beforeAll(async () => {
app = await startServer();
diff --git a/packages/backend/test/e2e/note.ts b/packages/backend/test/e2e/note.ts
index 961df99cc2..8d33c63485 100644
--- a/packages/backend/test/e2e/note.ts
+++ b/packages/backend/test/e2e/note.ts
@@ -16,8 +16,8 @@ describe('Note', () => {
let app: INestApplicationContext;
let Notes: any;
- let alice: misskey.entities.MeSignup;
- let bob: misskey.entities.MeSignup;
+ let alice: misskey.entities.SignupResponse;
+ let bob: misskey.entities.SignupResponse;
beforeAll(async () => {
app = await startServer();
diff --git a/packages/backend/test/e2e/oauth.ts b/packages/backend/test/e2e/oauth.ts
index 3a5e4ebdae..3ca1f8b542 100644
--- a/packages/backend/test/e2e/oauth.ts
+++ b/packages/backend/test/e2e/oauth.ts
@@ -75,7 +75,7 @@ function getMeta(html: string): { transactionId: string | undefined, clientName:
};
}
-function fetchDecision(transactionId: string, user: misskey.entities.MeSignup, { cancel }: { cancel?: boolean } = {}): Promise<Response> {
+function fetchDecision(transactionId: string, user: misskey.entities.SignupResponse, { cancel }: { cancel?: boolean } = {}): Promise<Response> {
return fetch(new URL('/oauth/decision', host), {
method: 'post',
body: new URLSearchParams({
@@ -90,14 +90,14 @@ function fetchDecision(transactionId: string, user: misskey.entities.MeSignup, {
});
}
-async function fetchDecisionFromResponse(response: Response, user: misskey.entities.MeSignup, { cancel }: { cancel?: boolean } = {}): Promise<Response> {
+async function fetchDecisionFromResponse(response: Response, user: misskey.entities.SignupResponse, { cancel }: { cancel?: boolean } = {}): Promise<Response> {
const { transactionId } = getMeta(await response.text());
assert.ok(transactionId);
return await fetchDecision(transactionId, user, { cancel });
}
-async function fetchAuthorizationCode(user: misskey.entities.MeSignup, scope: string, code_challenge: string): Promise<{ client: AuthorizationCode, code: string }> {
+async function fetchAuthorizationCode(user: misskey.entities.SignupResponse, scope: string, code_challenge: string): Promise<{ client: AuthorizationCode, code: string }> {
const client = new AuthorizationCode(clientConfig);
const response = await fetch(client.authorizeURL({
@@ -150,8 +150,8 @@ describe('OAuth', () => {
let app: INestApplicationContext;
let fastify: FastifyInstance;
- let alice: misskey.entities.MeSignup;
- let bob: misskey.entities.MeSignup;
+ let alice: misskey.entities.SignupResponse;
+ let bob: misskey.entities.SignupResponse;
let sender: (reply: FastifyReply) => void;
diff --git a/packages/backend/test/e2e/renote-mute.ts b/packages/backend/test/e2e/renote-mute.ts
index 7d57ba17b6..fededdff32 100644
--- a/packages/backend/test/e2e/renote-mute.ts
+++ b/packages/backend/test/e2e/renote-mute.ts
@@ -14,9 +14,9 @@ describe('Renote Mute', () => {
let app: INestApplicationContext;
// alice mutes carol
- let alice: misskey.entities.MeSignup;
- let bob: misskey.entities.MeSignup;
- let carol: misskey.entities.MeSignup;
+ let alice: misskey.entities.SignupResponse;
+ let bob: misskey.entities.SignupResponse;
+ let carol: misskey.entities.SignupResponse;
beforeAll(async () => {
app = await startServer();
diff --git a/packages/backend/test/e2e/streaming.ts b/packages/backend/test/e2e/streaming.ts
index 288c54bdbc..a447ba94ae 100644
--- a/packages/backend/test/e2e/streaming.ts
+++ b/packages/backend/test/e2e/streaming.ts
@@ -32,15 +32,15 @@ describe('Streaming', () => {
describe('Streaming', () => {
// Local users
- let ayano: misskey.entities.MeSignup;
- let kyoko: misskey.entities.MeSignup;
- let chitose: misskey.entities.MeSignup;
- let kanako: misskey.entities.MeSignup;
+ let ayano: misskey.entities.SignupResponse;
+ let kyoko: misskey.entities.SignupResponse;
+ let chitose: misskey.entities.SignupResponse;
+ let kanako: misskey.entities.SignupResponse;
// Remote users
- let akari: misskey.entities.MeSignup;
- let chinatsu: misskey.entities.MeSignup;
- let takumi: misskey.entities.MeSignup;
+ let akari: misskey.entities.SignupResponse;
+ let chinatsu: misskey.entities.SignupResponse;
+ let takumi: misskey.entities.SignupResponse;
let kyokoNote: any;
let kanakoNote: any;
diff --git a/packages/backend/test/e2e/thread-mute.ts b/packages/backend/test/e2e/thread-mute.ts
index 0e487976dc..5c68e2b150 100644
--- a/packages/backend/test/e2e/thread-mute.ts
+++ b/packages/backend/test/e2e/thread-mute.ts
@@ -13,9 +13,9 @@ import type * as misskey from 'misskey-js';
describe('Note thread mute', () => {
let app: INestApplicationContext;
- let alice: misskey.entities.MeSignup;
- let bob: misskey.entities.MeSignup;
- let carol: misskey.entities.MeSignup;
+ let alice: misskey.entities.SignupResponse;
+ let bob: misskey.entities.SignupResponse;
+ let carol: misskey.entities.SignupResponse;
beforeAll(async () => {
app = await startServer();
diff --git a/packages/backend/test/e2e/user-notes.ts b/packages/backend/test/e2e/user-notes.ts
index b5f00a6327..4f2e7c4cf3 100644
--- a/packages/backend/test/e2e/user-notes.ts
+++ b/packages/backend/test/e2e/user-notes.ts
@@ -13,7 +13,7 @@ import type * as misskey from 'misskey-js';
describe('users/notes', () => {
let app: INestApplicationContext;
- let alice: misskey.entities.MeSignup;
+ let alice: misskey.entities.SignupResponse;
let jpgNote: any;
let pngNote: any;
let jpgPngNote: any;
diff --git a/packages/misskey-js/etc/misskey-js.api.md b/packages/misskey-js/etc/misskey-js.api.md
index d4c43f207c..ddd69ce248 100644
--- a/packages/misskey-js/etc/misskey-js.api.md
+++ b/packages/misskey-js/etc/misskey-js.api.md
@@ -1034,6 +1034,18 @@ export type Endpoints = Overwrite<Endpoints_2, {
};
};
};
+ 'signup': {
+ req: SignupRequest;
+ res: SignupResponse;
+ };
+ 'signup-pending': {
+ req: SignupPendingRequest;
+ res: SignupPendingResponse;
+ };
+ 'signin': {
+ req: SigninRequest;
+ res: SigninResponse;
+ };
}>;
// @public (undocumented)
@@ -1053,6 +1065,12 @@ declare namespace entities {
EmojiUpdated,
EmojiDeleted,
AnnouncementCreated,
+ SignupRequest,
+ SignupResponse,
+ SignupPendingRequest,
+ SignupPendingResponse,
+ SigninRequest,
+ SigninResponse,
EmptyRequest,
EmptyResponse,
AdminMetaResponse,
@@ -2615,6 +2633,47 @@ type ServerStatsLog = string[];
// @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'];
diff --git a/packages/misskey-js/src/api.types.ts b/packages/misskey-js/src/api.types.ts
index d97646b7cc..75ab7d91b1 100644
--- a/packages/misskey-js/src/api.types.ts
+++ b/packages/misskey-js/src/api.types.ts
@@ -1,6 +1,14 @@
import { Endpoints as Gen } from './autogen/endpoint';
import { UserDetailed } from './autogen/models';
import { UsersShowRequest } from './autogen/entities';
+import {
+ SigninRequest,
+ SigninResponse,
+ SignupPendingRequest,
+ SignupPendingResponse,
+ SignupRequest,
+ SignupResponse,
+} from './entities';
type Overwrite<T, U extends { [Key in keyof T]?: unknown }> = Omit<
T,
@@ -55,6 +63,21 @@ export type Endpoints = Overwrite<
$default: UserDetailed;
};
};
- }
+ },
+ // api.jsonには載せないものなのでここで定義
+ 'signup': {
+ req: SignupRequest;
+ res: SignupResponse;
+ },
+ // api.jsonには載せないものなのでここで定義
+ 'signup-pending': {
+ req: SignupPendingRequest;
+ res: SignupPendingResponse;
+ },
+ // api.jsonには載せないものなのでここで定義
+ 'signin': {
+ req: SigninRequest;
+ res: SigninResponse;
+ },
}
>
diff --git a/packages/misskey-js/src/entities.ts b/packages/misskey-js/src/entities.ts
index 99f433cc02..6314c88e0b 100644
--- a/packages/misskey-js/src/entities.ts
+++ b/packages/misskey-js/src/entities.ts
@@ -1,5 +1,5 @@
import { ModerationLogPayloads } from './consts.js';
-import { Announcement, EmojiDetailed, Page, User, UserDetailed } from './autogen/models';
+import { Announcement, EmojiDetailed, MeDetailed, MeDetailedOnly, Page, User, UserDetailed } from './autogen/models';
export * from './autogen/entities';
export * from './autogen/models';
@@ -183,3 +183,38 @@ export type EmojiDeleted = {
export type AnnouncementCreated = {
announcement: Announcement;
};
+
+export 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;
+}
+
+export type SignupResponse = MeDetailed & {
+ token: string;
+}
+
+export type SignupPendingRequest = {
+ code: string;
+};
+
+export type SignupPendingResponse = {
+ id: User['id'],
+ i: string,
+};
+
+export type SigninRequest = {
+ username: string;
+ password: string;
+ token?: string;
+};
+
+export type SigninResponse = {
+ id: User['id'],
+ i: string,
+};