@runlot/api 0.1.0-rc.34 → 0.1.0-rc.36

package/dist/schema.d.ts

@@ -100,6 +100,34 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/hooks/polar": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Polar 결제 웹훅 (docs/billing.md)
+         * @description 사용자가 부르는 경로가 아니다. Polar 가 구독 사건을 여기에 배달한다.
+         *     인증은 토큰이 아니라 **Standard Webhooks 서명**이다 — `webhook-id`·
+         *     `webhook-timestamp`·`webhook-signature` 셋과 서버의
+         *     `RUNLOT_POLAR_WEBHOOK_SECRET` 으로 검증한다 (아니면 403, 시각 ±5 분).
+         *     같은 `webhook-id` 는 한 번만 적용한다 (재전달은 200 이고 무시).
+         *
+         *     `orgs.plan` 을 바꾸는 유일한 자리다: `subscription.active`·`updated` 의
+         *     status `active`/`trialing`/`past_due` 는 pro, 그 밖(`canceled`·`unpaid`…)은
+         *     free. 서버에 토큰이 없으면 501. 클라이언트 라이브러리는 부르지 않는다.
+         */
+        post: operations["polarHook"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/me": {
         parameters: {
             query?: never;
@@ -184,6 +212,36 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/orgs/{orgSlug}/projects/{projectName}/overview": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orgSlug: components["parameters"]["OrgSlug"];
+                projectName: components["parameters"]["ProjectName"];
+            };
+            cookie?: never;
+        };
+        /**
+         * 프로젝트 개요 (대시보드 첫 화면)
+         * @description 프로젝트를 열었을 때 첫 화면이 한 번에 받는 것 — 지금 서비스 중인 배포와
+         *     누가 올렸는지, 최근 배포 몇 개, 데이터베이스의 마지막 백업, 선언으로 켠
+         *     자원의 부여 여부, 이 프로젝트의 최근 알림. "지금 어떤가" 의 답이지
+         *     이력이 아니다 — 전부는 각 탭이 준다.
+         *
+         *     사용량은 여기 없다. 그것은 cp-core 가 창을 계산하는 값이라 `getUsage` 를
+         *     나란히 부른다 — 한 응답에 묶으면 cp-core 가 느린 날 첫 화면 전체가
+         *     그만큼 늦게 선다. viewer 이상.
+         */
+        get: operations["getProjectOverview"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/orgs/{orgSlug}/projects/{projectName}/deployments": {
         parameters: {
             query?: never;
@@ -218,6 +276,15 @@ export interface paths {
          *     읽히려면 그 사건이 각각 남아야 한다.
          *
          *     업로드가 성공하면 새 배포가 즉시 live 가 된다.
+         *
+         *     **출처 헤더** (선택). 본문이 번들 그 자체라 메타는 헤더로 온다. CLI 가
+         *     배포하는 폴더의 git 을 읽어 싣고, git 이 없으면 안 싣는다. CP 는 검증할
+         *     수 없으므로 표시용이다 — 인가·배치의 근거가 되지 않는다.
+         *
+         *         X-Runlot-Git-Commit    HEAD 해시 (16 진수 7~64)
+         *         X-Runlot-Git-Message   커밋 메시지 첫 줄, percent-encoded (200 자에서 자른다)
+         *         X-Runlot-Git-Branch    브랜치 이름, percent-encoded
+         *         X-Runlot-Git-Dirty     `true`|`false` — 커밋 안 된 변경이 있었는가
          */
         post: operations["createDeployment"];
         delete?: never;
@@ -1186,6 +1253,87 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/orgs/{orgSlug}/billing": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orgSlug: components["parameters"]["OrgSlug"];
+            };
+            cookie?: never;
+        };
+        /**
+         * 조직의 요금제와 결제 상태 (docs/billing.md)
+         * @description 요금제(`plan`)와, 프로면 그 상태(`status`: active · past_due · canceled)와
+         *     현재 기간의 끝(`periodEnd`)을 준다. `enabled` 가 거짓이면 이 배치에
+         *     결제가 설정되지 않은 것이다 — 화면은 문의 주소만 둔다. `sandbox` 가 참이면
+         *     Polar 의 테스트 환경이라 실제 청구가 없다.
+         *
+         *     `limits` 는 두 요금제의 한도 표다 (cp/internal/plan). 화면에 숫자를 두지
+         *     않는 이유는 `OrgMembership.projectLimit` 과 같다. viewer 이상.
+         */
+        get: operations["getBilling"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/orgs/{orgSlug}/billing/checkout": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orgSlug: components["parameters"]["OrgSlug"];
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * 프로 요금제 체크아웃 세션을 만든다
+         * @description Polar 체크아웃 세션 하나를 만들고 그 `url` 을 준다 — 브라우저가 거기로
+         *     간다. 결제가 끝나면 `returnTo` 로 돌아오지만 **그 되돌아옴이 요금제를
+         *     바꾸지는 않는다**: 요금제는 웹훅(`/v1/hooks/polar`)이 바꾼다. 화면은
+         *     돌아온 뒤 상태를 다시 읽는다.
+         *
+         *     `returnTo` 는 서버의 `RUNLOT_PUBLIC_URL` 아래여야 한다 (아니면 400).
+         *     이미 프로면 409 `already_pro` — 포털을 열어야 한다. admin.
+         */
+        post: operations["createBillingCheckout"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/orgs/{orgSlug}/billing/portal": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orgSlug: components["parameters"]["OrgSlug"];
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * 고객 포털 세션을 만든다 (결제 수단·영수증·해지)
+         * @description Polar 고객 포털의 일회용 `url` 을 준다. 결제 수단 변경·영수증·해지는
+         *     전부 거기서 한다 — 우리 화면에 그 폼을 두지 않는다 (카드 번호가 우리
+         *     서버를 지나지 않는 것이 MoR 의 값이다). 한 번도 결제한 적 없는 org 는
+         *     404. admin.
+         */
+        post: operations["createBillingPortal"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/orgs/{orgSlug}/members": {
         parameters: {
             query?: never;
@@ -2380,6 +2528,61 @@ export interface components {
              */
             suspended: boolean;
         };
+        /** @description 프로젝트 첫 화면 (getProjectOverview). */
+        ProjectOverview: {
+            /** @description 지금 서비스 중인 배포. 첫 배포 전에는 null 이다. */
+            live: components["schemas"]["OverviewDeployment"] | null;
+            /** @description 최근 배포, 최신이 먼저. 최대 5 개 — 전부는 `listDeployments`. */
+            deployments: components["schemas"]["OverviewDeployment"][];
+            /**
+             * Format: int64
+             * @description 이 프로젝트의 배포 수 전체.
+             */
+            deploymentCount: number;
+            database: components["schemas"]["OverviewDatabase"];
+            features: components["schemas"]["OverviewFeatures"];
+            /**
+             * Format: int64
+             * @description 커스텀 도메인 행의 수. 검증 중인 것도 센다.
+             */
+            customHostnames: number;
+            /**
+             * Format: int64
+             * @description 이 프로젝트의 저장소 수.
+             */
+            repos: number;
+            /** @description 이 프로젝트의 최근 알림, 최신이 먼저. 최대 5 개. */
+            notifications: components["schemas"]["Notification"][];
+        };
+        /** @description 개요의 배포 행. `Deployment` 와 같은 모양이다 (`actor` 포함). */
+        OverviewDeployment: components["schemas"]["Deployment"];
+        OverviewDatabase: {
+            /** @description `"database": true` 로 켜졌는가 */
+            granted: boolean;
+            /**
+             * Format: date-time
+             * @description 마지막 세대의 시각. 세대가 없으면 없다.
+             */
+            lastBackupAt?: string;
+            /**
+             * Format: date-time
+             * @description 무변경 스킵의 마지막 하트비트 (`DatabaseGenerations.lastCheckedAt`).
+             *     세대가 안 늘어도 이 값이 움직이면 백업은 살아 있다.
+             */
+            lastCheckedAt?: string;
+            /**
+             * Format: int64
+             * @description 세대 수
+             */
+            generations: number;
+        };
+        /** @description 선언으로 켜는 자원의 부여 여부 (docs/provisioning.md). 첫 화면의 "다음 단계" 가 이것으로 안 켠 것을 고른다. */
+        OverviewFeatures: {
+            database: boolean;
+            storage: boolean;
+            email: boolean;
+            auth: boolean;
+        };
         Deployment: {
             /** Format: uuid */
             deploymentId: string;
@@ -2391,6 +2594,28 @@ export interface components {
             /** Format: uuid */
             createdBy?: string | null;
             live: boolean;
+            /**
+             * @description 배포한 사람의 표시 이름 (이름 → 이메일 → 프로바이더 subject 순).
+             *     `createdBy` 는 uuid 라 화면이 사람으로 못 바꾼다. 목록·개요에만
+             *     실리고, 사용자 행이 없으면 비어 있다.
+             */
+            actor?: string;
+            /** @description 검증을 통과한 매니페스트 그대로. 0040 이전의 배포에는 없다. */
+            manifest?: components["schemas"]["Manifest"];
+            /**
+             * Format: int64
+             * @description 푼 뒤의 번들 크기. 압축 크기가 아니다.
+             */
+            bundleBytes?: number;
+            /** @description 번들 항목 수 (파일 + 디렉토리). */
+            bundleFiles?: number;
+            /** @description CLI 가 보낸 HEAD 해시. 표시용 — CP 는 검증하지 않는다. */
+            gitCommit?: string;
+            /** @description 커밋 메시지 첫 줄, 200 자까지. */
+            gitMessage?: string;
+            gitBranch?: string;
+            /** @description 커밋 안 된 변경을 품고 배포했는가. 참이면 `gitCommit` 이 곧 코드가 아니다. */
+            gitDirty?: boolean;
         };
         DatabaseEndpoint: {
             host: string;
@@ -2937,6 +3162,40 @@ export interface components {
             /** @description 이 org 의 보관 일수 */
             keepDays: number;
         };
+        BillingStatus: {
+            /** @description 이 배치에 결제가 설정돼 있다 */
+            enabled: boolean;
+            /** @description Polar 테스트 환경 — 실제 청구 없음 */
+            sandbox: boolean;
+            /** @enum {string} */
+            plan: "free" | "pro";
+            /**
+             * @description 프로의 상태. canceled 는 기간 끝까지 프로. free 는 없다
+             * @enum {string}
+             */
+            status?: "active" | "past_due" | "canceled";
+            /**
+             * Format: date-time
+             * @description 현재 결제 기간의 끝
+             */
+            periodEnd?: string;
+            /** @description 결제 이력이 있어 포털을 열 수 있다 */
+            hasPortal: boolean;
+            limits: {
+                free: components["schemas"]["PlanLimits"];
+                pro: components["schemas"]["PlanLimits"];
+            };
+        };
+        /** @description 요금제 하나의 한도 (docs/limits.md §1) */
+        PlanLimits: {
+            projects: number;
+            /** Format: int64 */
+            storageBytes: number;
+            /** @description 보존 세대 수 (= 시간) */
+            backupKeep: number;
+            crons: number;
+            mailPerHour: number;
+        };
         /**
          * @description 프로젝트 전용 오브젝트 스토리지 상태다 (docs/storage.md §7).
          *
@@ -3559,6 +3818,43 @@ export interface operations {
             };
         };
     };
+    polarHook: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": Record<string, never>;
+            };
+        };
+        responses: {
+            /** @description 받았다 (`applied` 가 참이면 요금제를 바꿨다) */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            400: components["responses"]["BadRequest"];
+            /** @description 서명이 맞지 않는다 */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description 결제가 꺼져 있다 */
+            501: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     getMe: {
         parameters: {
             query?: never;
@@ -3732,6 +4028,31 @@ export interface operations {
             404: components["responses"]["NotFound"];
         };
     };
+    getProjectOverview: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orgSlug: components["parameters"]["OrgSlug"];
+                projectName: components["parameters"]["ProjectName"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description 개요 */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProjectOverview"];
+                };
+            };
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+        };
+    };
     listDeployments: {
         parameters: {
             query?: never;
@@ -3764,7 +4085,12 @@ export interface operations {
     createDeployment: {
         parameters: {
             query?: never;
-            header?: never;
+            header?: {
+                "X-Runlot-Git-Commit"?: string;
+                "X-Runlot-Git-Message"?: string;
+                "X-Runlot-Git-Branch"?: string;
+                "X-Runlot-Git-Dirty"?: boolean;
+            };
             path: {
                 orgSlug: components["parameters"]["OrgSlug"];
                 projectName: components["parameters"]["ProjectName"];
@@ -5265,6 +5591,138 @@ export interface operations {
             404: components["responses"]["NotFound"];
         };
     };
+    getBilling: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orgSlug: components["parameters"]["OrgSlug"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description 결제 상태 */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["BillingStatus"];
+                };
+            };
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+        };
+    };
+    createBillingCheckout: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orgSlug: components["parameters"]["OrgSlug"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /** Format: uri */
+                    returnTo: string;
+                };
+            };
+        };
+        responses: {
+            /** @description 체크아웃 세션 */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** Format: uri */
+                        url: string;
+                        checkoutId: string;
+                    };
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            /** @description `already_pro` */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description `billing_off` — 결제가 설정되지 않았다 */
+            501: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description `billing_unavailable` — Polar 가 응답하지 않는다 */
+            502: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    createBillingPortal: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orgSlug: components["parameters"]["OrgSlug"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /** Format: uri */
+                    returnTo: string;
+                };
+            };
+        };
+        responses: {
+            /** @description 포털 세션 */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** Format: uri */
+                        url: string;
+                    };
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            /** @description `billing_off` */
+            501: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description `billing_unavailable` */
+            502: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     listMembers: {
         parameters: {
             query?: never;