@runlot/api 0.1.0-rc.39 → 0.1.0-rc.41

package/dist/schema.d.ts

@@ -38,7 +38,7 @@ export interface paths {
         /**
          * GitHub OAuth 시작
          * @description `redirect` 는 로그인이 끝난 뒤 토큰을 fragment 로 실어 돌아갈 클라이언트
-         *     콜백이다 (`https://dash.runlot.dev/login/callback`). 서버의 허용 목록
+         *     콜백이다 (`https://dash.runlot.io/login/callback`). 서버의 허용 목록
          *     (`RUNLOT_GITHUB_REDIRECTS`, 기본은 `RUNLOT_PUBLIC_URL`) 접두에 맞아야 한다.
          *     302 로 GitHub authorize 페이지로 보낸다. 브라우저가 따라가는 경로라
          *     클라이언트 라이브러리는 부르지 않는다 — `window.location` 으로 연다.
@@ -128,6 +128,36 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/config": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * 이 배치의 이름들
+         * @description 대시보드가 **어느 배치에 붙어 있는지** 알아보는 자리다
+         *     (`docs/environments.md §3.2`). 대시보드는 정적 빌드 하나라 배치마다
+         *     다른 값을 알 길이 없었고, 화면이 그것을 문자열로 박고 있었다 —
+         *     환경이 둘이 되면 dev 화면이 프로덕션의 주소를 안내하고 그 안내는
+         *     그럴듯해서 아무 시험에도 안 잡힌다.
+         *
+         *     인증이 없다: 로그인 화면에도 문서 링크가 있다. 여기 실리는 것은
+         *     랜딩 페이지에 이미 적힌 이름들뿐이다.
+         *
+         *     기능의 켜짐/꺼짐은 여기 없다 — 결제·저장소·이메일은 각자의 끝점이
+         *     자기 상태를 말한다.
+         */
+        get: operations["getSiteConfig"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/me": {
         parameters: {
             query?: never;
@@ -1399,10 +1429,14 @@ export interface paths {
         get: operations["listMembers"];
         put?: never;
         /**
-         * 기존 사용자를 멤버로 넣는다 (`runlot org add-member`)
-         * @description **초대가 아니다** (docs/local-mvp.md §3 — 초대 UI 제외). 사용자는 이미
-         *     한 번 로그인해 `users` 에 있어야 하고, 없으면 404 `user_not_found`.
-         *     이미 멤버면 409 `already_member` — 역할을 바꾸는 것은 PUT 이다.
+         * 기존 사용자를 멤버로 넣는다 (운영·자동화용)
+         * @description **초대가 아니다.** 사용자는 이미 한 번 로그인해 `users` 에 있어야 하고
+         *     (`provider`+`subject` 로 가리킨다), 없으면 404 `user_not_found`. 이미
+         *     멤버면 409 `already_member` — 역할을 바꾸는 것은 PUT 이다.
+         *
+         *     사람을 부르는 표면은 이것이 아니라 `POST …/invites` 다
+         *     (docs/members.md): GitHub 의 `subject` 는 숫자 id 라 관리자가 알 수
+         *     없는 값이고, 이 끝점은 그것을 이미 아는 자동화의 것이다.
          *
          *     admin 이상. 감사 `member.add`.
          */
@@ -1413,6 +1447,133 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/orgs/{orgSlug}/invites": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orgSlug: components["parameters"]["OrgSlug"];
+            };
+            cookie?: never;
+        };
+        /**
+         * 대기 중인 초대 (`runlot member invites`)
+         * @description **admin 이상.** 멤버 목록은 member 이상이 보지만 초대 목록은 다르다 —
+         *     아직 조직에 없는 사람들의 이메일이고, 그것은 명부가 아니라 관리 작업의
+         *     상태다.
+         *
+         *     수락·폐기된 초대는 안 나온다 (이력의 자리는 감사 기록이다). 만료된
+         *     초대는 나온다 — 거기서 관리자가 할 일이 재발송이다.
+         */
+        get: operations["listInvites"];
+        put?: never;
+        /**
+         * 이메일로 초대한다 (`runlot member invite`)
+         * @description admin 이상. 메일은 즉시 나가지 않는다 — cp-core 의 발송 회차가 큐를
+         *     훑는다 (`sentAt` 이 비어 있으면 아직 큐에 있다는 뜻이다).
+         *
+         *     **같은 주소로 다시 부르면 재발송이다**: 새 초대가 아니라 같은 행이
+         *     갱신되고 (토큰·만료가 새로 서고 역할이 바뀐다) 200 으로 답한다. 새
+         *     초대는 201 이다.
+         *
+         *     이미 멤버인 주소는 409 `already_member`. 대기 중 초대가 너무 많으면
+         *     409 `too_many_invites` — 요금제 한도가 아니라 발신 남용 방지다.
+         *
+         *     수명은 이레, 한 번 쓰면 끝, 언제든 폐기할 수 있다. 감사 `member.invite`.
+         */
+        post: operations["createInvite"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/orgs/{orgSlug}/invites/{inviteId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orgSlug: components["parameters"]["OrgSlug"];
+                inviteId: string;
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /**
+         * 초대를 취소한다 (`runlot member uninvite`)
+         * @description admin 이상. 아직 안 나간 메일은 **안 나간다** — 폐기가 발송 큐도 비운다.
+         *     이미 수락·폐기된 초대는 404. 감사 `member.uninvite`.
+         */
+        delete: operations["revokeInvite"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/invites/{token}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                token: string;
+            };
+            cookie?: never;
+        };
+        /**
+         * 초대 미리보기 (인증 없음)
+         * @description **인증이 없다.** 초대 링크를 받은 사람은 아직 로그인하지 않았고, 로그인
+         *     하기 전에 이것이 무엇인지 알아야 한다. 토큰은 32 바이트 난수라 열거할
+         *     수 없고, 그래서 여는 대가가 "우리가 메일을 보낸 사람이 조직 이름을
+         *     본다" 로 끝난다.
+         *
+         *     **상태는 오류가 아니라 값이다** (`state`). 만료된 초대에 404 를 주면
+         *     화면이 "링크가 틀렸다" 와 "링크가 늙었다" 를 구분하지 못한다.
+         *
+         *     모르는 토큰은 404 — 오래전에 폐기된 토큰과 같은 답이다.
+         */
+        get: operations["getInvite"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/invites/{token}/accept": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                token: string;
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * 초대를 수락한다
+         * @description 로그인이 필요하다. **로그인한 계정의 이메일이 초대한 주소와 같아야
+         *     한다는 규칙은 없다** — GitHub 비공개 이메일로 로그인한 사람은
+         *     `users.email` 이 아예 없고, 그 규칙을 넣으면 그 사람은 어떤 조직에도
+         *     들어올 수 없다. 대신 수명 이레 · 한 번 쓰면 끝 · 언제든 폐기이고,
+         *     감사 기록에 초대한 주소와 수락한 계정이 **둘 다** 남는다.
+         *
+         *     **이미 멤버면 역할이 안 바뀐다** (`alreadyMember: true`). 초대장 하나가
+         *     admin 을 강등하는 표면이 되면 그 강등은 마지막-admin 검사를 지나지
+         *     않는다.
+         *
+         *     감사 `member.accept`.
+         */
+        post: operations["acceptInvite"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/orgs/{orgSlug}/members/{userId}": {
         parameters: {
             query?: never;
@@ -1434,9 +1595,14 @@ export interface paths {
         put: operations["setMemberRole"];
         post?: never;
         /**
-         * 멤버를 뺀다 (`runlot org remove-member`)
-         * @description admin 이상. 마지막 admin 은 뺄 수 없다 (409 `last_admin`). 감사
-         *     `member.remove`.
+         * 멤버를 뺀다 · 스스로 나간다 (`runlot member rm`, `runlot member leave`)
+         * @description **남을 빼는 것은 admin 이상, 자기를 빼는 것은 누구나** 할 수 있다
+         *     (`userId` 가 자기 자신이면 탈퇴다). admin 만 뺄 수 있게 두면 viewer 로
+         *     초대된 사람이 조직을 나갈 길이 아예 없다.
+         *
+         *     마지막 admin 은 뺄 수도 나갈 수도 없다 (409 `last_admin`). 감사는
+         *     제거가 `member.remove`, 탈퇴가 `member.leave` — 같은 문장이지만 다른
+         *     사건이라 이름이 갈린다.
          */
         delete: operations["removeMember"];
         options?: never;
@@ -1465,7 +1631,7 @@ export interface paths {
         /**
          * 커스텀 도메인을 연결한다 (`runlot domain add`)
          * @description 이름은 소문자·punycode 로 정규화해 저장한다. 와일드카드와 우리
-         *     도메인(`*.runlot.app`·`*.runlot.dev`·앱 도메인) 아래 이름은 받지 않는다.
+         *     도메인(`*.runlot.app`·`*.runlot.dev`·`*.runlot.io`·앱 도메인) 아래 이름은 받지 않는다.
          *
          *     레코드는 `pending_dns` 상태로 생성되고 **그 순간부터 해당 이름을 예약한다.** 검증
          *     중에도 다른 프로젝트가 같은 이름을 사용할 수 없다. 연결되기 전까지는
@@ -3026,6 +3192,53 @@ export interface components {
             /** Format: date-time */
             addedAt: string;
         };
+        /**
+         * @description `expired` 는 시각 비교의 결과이지 열이 아니다 — 초대는 만료되었다고
+         *     표시되지 않고, 만료 시각이 지났을 뿐이다.
+         * @enum {string}
+         */
+        InviteState: "pending" | "expired" | "accepted" | "revoked";
+        /**
+         * @description **토큰이 없다.** 평문 토큰은 메일에만 실리고, cp-public 은 그 열을 읽지도
+         *     못한다 (마이그레이션 0043 의 열 단위 GRANT).
+         */
+        Invite: {
+            /** Format: uuid */
+            inviteId: string;
+            /** Format: email */
+            email: string;
+            role: components["schemas"]["Role"];
+            state: components["schemas"]["InviteState"];
+            /** @description 부른 사람의 이름 또는 이메일. */
+            invitedBy?: string;
+            /** Format: date-time */
+            createdAt: string;
+            /** Format: date-time */
+            expiresAt: string;
+            /**
+             * Format: date-time
+             * @description 비어 있으면 아직 발송 큐에 있다 (발송은 cp-core 의 회차다).
+             */
+            sentAt?: string;
+            /** @description 마지막 발송 실패 이유. 성공해도 남을 수 있다. */
+            sendError?: string;
+        };
+        /** @description 토큰을 든 사람에게 보이는 초대 (인증 없이 답한다). */
+        InviteView: {
+            orgSlug: string;
+            orgName: string;
+            role: components["schemas"]["Role"];
+            /**
+             * Format: email
+             * @description **초대를 보낸 주소**다. 수락하는 계정의 주소와 다를 수 있고, 화면은
+             *     그 사실을 말해야 한다.
+             */
+            email: string;
+            invitedBy?: string;
+            state: components["schemas"]["InviteState"];
+            /** Format: date-time */
+            expiresAt: string;
+        };
         /**
          * @description 워커의 `env.<NAME>` 이 된다. `DB`·`ASSETS`(바인딩 `env.db`·`env.assets` 의 대문자 짝) 와 `RUNLOT_` 접두는 예약이다
          *     — 앞 둘은 이미 바인딩이고, 뒤는 노드가 프로세스 환경에 쓰는 이름
@@ -3906,6 +4119,38 @@ export interface operations {
             };
         };
     };
+    getSiteConfig: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description 배치의 이름들 */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description 앱 호스트네임의 접미사 (`<project>.<org>.<appDomain>`).
+                         * @example runlot.app
+                         */
+                        appDomain: string;
+                        /**
+                         * @description 공개 문서의 origin. **빈 값일 수 있다** — 그러면 화면은
+                         *     문서 링크를 안 그린다 (없는 곳으로 보내는 링크보다 낫다).
+                         * @example https://docs.runlot.io
+                         */
+                        docsUrl: string;
+                    };
+                };
+            };
+        };
+    };
     getMe: {
         parameters: {
             query?: never;
@@ -5954,6 +6199,169 @@ export interface operations {
             };
         };
     };
+    listInvites: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orgSlug: components["parameters"]["OrgSlug"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description 초대 목록 */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        invites: components["schemas"]["Invite"][];
+                    };
+                };
+            };
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+        };
+    };
+    createInvite: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orgSlug: components["parameters"]["OrgSlug"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /** Format: email */
+                    email: string;
+                    /** @description 기본값 `member`. */
+                    role?: components["schemas"]["Role"];
+                };
+            };
+        };
+        responses: {
+            /** @description 기존 초대를 다시 보냈다 */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Invite"];
+                };
+            };
+            /** @description 새 초대 */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Invite"];
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            /** @description 이미 멤버다 (`already_member`) · 대기 초대가 너무 많다 (`too_many_invites`) */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    revokeInvite: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orgSlug: components["parameters"]["OrgSlug"];
+                inviteId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description 취소했다 */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+        };
+    };
+    getInvite: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                token: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description 초대 */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["InviteView"];
+                };
+            };
+            404: components["responses"]["NotFound"];
+        };
+    };
+    acceptInvite: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                token: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description 수락했다 */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        orgSlug: string;
+                        orgName?: string;
+                        role: components["schemas"]["Role"];
+                        alreadyMember: boolean;
+                        invitedEmail?: string;
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+            /** @description 이미 수락됨 (`invite_used`) · 취소됨 (`invite_revoked`) · 만료됨 (`invite_expired`) */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
     setMemberRole: {
         parameters: {
             query?: never;