tapimo 0.15.1 → 0.18.1

package/dist/apps/management/routes/cli.d.ts

@@ -0,0 +1,912 @@
+import * as z from 'zod/mini';
+import * as Response from '../../../internal/Response.js';
+import type { Environment } from '../App.js';
+/** Schemas owned by the CLI sign-in routes. */
+export declare namespace schema {
+    /** API permissions approved for this CLI device. */
+    const ApproveRequest: z.ZodMiniObject<{
+        scopes: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
+    }, z.core.$strip>;
+    /** Path parameters naming one sign-in request. */
+    const Params: z.ZodMiniObject<{
+        code: z.ZodMiniString<string>;
+    }, z.core.$strip>;
+    /** Body for starting a CLI sign-in. */
+    const CreateRequest: z.ZodMiniObject<{
+        codeChallenge: z.ZodMiniString<string>;
+        device: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        name: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    }, z.core.$strip>;
+    /** A started CLI sign-in. */
+    const CreateResponse: z.ZodMiniObject<{
+        code: z.ZodMiniString<string>;
+        expiresAt: z.ZodMiniISODateTime;
+        interval: z.ZodMiniNumber<number>;
+        verificationUrl: z.ZodMiniURL;
+    }, z.core.$strip>;
+    /** A sign-in request as shown to the approving user. */
+    const Authorization: z.ZodMiniObject<{
+        client: z.ZodMiniObject<{
+            device: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            name: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        }, z.core.$strip>;
+        code: z.ZodMiniString<string>;
+        createdAt: z.ZodMiniISODateTime;
+        expiresAt: z.ZodMiniISODateTime;
+        ip: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        scopes: z.ZodMiniArray<z.ZodMiniString<string>>;
+        status: z.ZodMiniEnum<{
+            approved: "approved";
+            denied: "denied";
+            pending: "pending";
+        }>;
+    }, z.core.$strip>;
+    /** Outcome of approving or denying a sign-in. */
+    const Decision: z.ZodMiniObject<{
+        code: z.ZodMiniString<string>;
+        status: z.ZodMiniEnum<{
+            approved: "approved";
+            denied: "denied";
+        }>;
+    }, z.core.$strip>;
+    /** Body for exchanging an approved sign-in for a CLI session token. */
+    const TokenRequest: z.ZodMiniObject<{
+        codeVerifier: z.ZodMiniString<string>;
+    }, z.core.$strip>;
+    /** Sign-in state, carrying the session token once approved. */
+    const TokenResponse: z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
+        status: z.ZodMiniLiteral<"pending">;
+    }, z.core.$strip>, z.ZodMiniObject<{
+        status: z.ZodMiniLiteral<"denied">;
+    }, z.core.$strip>, z.ZodMiniObject<{
+        expiresAt: z.ZodMiniISODateTime;
+        scopes: z.ZodMiniArray<z.ZodMiniString<string>>;
+        status: z.ZodMiniLiteral<"approved">;
+        token: z.ZodMiniString<string>;
+    }, z.core.$strip>], "status">;
+}
+/**
+ * CLI sign-in: a CLI starts a PKCE-bound request, a signed-in console user
+ * approves it, and the CLI exchanges the approval for a CLI session token.
+ */
+export declare function cli(options?: cli.Options): import("hono/hono-base").HonoBase<Environment, {
+    "/v1/cli/authorizations": {
+        $post: {
+            output: {
+                error: {
+                    code: "api_key_malformed";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                json: {
+                    codeChallenge: string;
+                    device?: string | undefined;
+                    name?: string | undefined;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "api_key_invalid" | "api_key_missing";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 401;
+            input: {
+                json: {
+                    codeChallenge: string;
+                    device?: string | undefined;
+                    name?: string | undefined;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "api_key_forbidden" | "api_key_ip_forbidden";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 403;
+            input: {
+                json: {
+                    codeChallenge: string;
+                    device?: string | undefined;
+                    name?: string | undefined;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "payment_required" | "rate_limit_exceeded";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 429;
+            input: {
+                json: {
+                    codeChallenge: string;
+                    device?: string | undefined;
+                    name?: string | undefined;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "upstream_error";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 502;
+            input: {
+                json: {
+                    codeChallenge: string;
+                    device?: string | undefined;
+                    name?: string | undefined;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "body_invalid";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                json: {
+                    codeChallenge: string;
+                    device?: string | undefined;
+                    name?: string | undefined;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "cli_auth_not_enabled";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 404;
+            input: {
+                json: {
+                    codeChallenge: string;
+                    device?: string | undefined;
+                    name?: string | undefined;
+                };
+            };
+        } | {
+            output: {
+                code: string;
+                expiresAt: string;
+                interval: number;
+                verificationUrl: string;
+            };
+            outputFormat: "json";
+            status: 200;
+            input: {
+                json: {
+                    codeChallenge: string;
+                    device?: string | undefined;
+                    name?: string | undefined;
+                };
+            };
+        };
+    };
+} & {
+    "/v1/cli/authorizations/:code{[A-Za-z -]+}": {
+        $get: {
+            output: {
+                error: {
+                    code: "api_key_malformed";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                param: {
+                    code: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "api_key_invalid" | "api_key_missing";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 401;
+            input: {
+                param: {
+                    code: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "upstream_error";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 502;
+            input: {
+                param: {
+                    code: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "param_invalid";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                param: {
+                    code: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "cli_auth_not_enabled";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 404;
+            input: {
+                param: {
+                    code: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "forbidden";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 403;
+            input: {
+                param: {
+                    code: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "cli_authorization_not_found";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 404;
+            input: {
+                param: {
+                    code: string;
+                };
+            };
+        } | {
+            output: {
+                client: {
+                    device?: string | undefined;
+                    name?: string | undefined;
+                };
+                code: string;
+                createdAt: string;
+                expiresAt: string;
+                ip?: string | undefined;
+                scopes: string[];
+                status: "approved" | "denied" | "pending";
+            };
+            outputFormat: "json";
+            status: 200;
+            input: {
+                param: {
+                    code: string;
+                };
+            };
+        };
+    };
+} & {
+    "/v1/cli/authorizations/:code{[A-Za-z -]+}/approve": {
+        $post: {
+            output: {
+                error: {
+                    code: "api_key_malformed";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                param: {
+                    code: string;
+                };
+            } & {
+                json: {
+                    scopes?: string[] | undefined;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "api_key_invalid" | "api_key_missing";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 401;
+            input: {
+                param: {
+                    code: string;
+                };
+            } & {
+                json: {
+                    scopes?: string[] | undefined;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "upstream_error";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 502;
+            input: {
+                param: {
+                    code: string;
+                };
+            } & {
+                json: {
+                    scopes?: string[] | undefined;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "body_invalid";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                param: {
+                    code: string;
+                };
+            } & {
+                json: {
+                    scopes?: string[] | undefined;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "param_invalid";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                param: {
+                    code: string;
+                };
+            } & {
+                json: {
+                    scopes?: string[] | undefined;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "cli_auth_not_enabled";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 404;
+            input: {
+                param: {
+                    code: string;
+                };
+            } & {
+                json: {
+                    scopes?: string[] | undefined;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "forbidden";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 403;
+            input: {
+                param: {
+                    code: string;
+                };
+            } & {
+                json: {
+                    scopes?: string[] | undefined;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "cli_authorization_not_found";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 404;
+            input: {
+                param: {
+                    code: string;
+                };
+            } & {
+                json: {
+                    scopes?: string[] | undefined;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "cli_authorization_decided";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 409;
+            input: {
+                param: {
+                    code: string;
+                };
+            } & {
+                json: {
+                    scopes?: string[] | undefined;
+                };
+            };
+        } | {
+            output: {
+                code: string;
+                status: "approved" | "denied";
+            };
+            outputFormat: "json";
+            status: 200;
+            input: {
+                param: {
+                    code: string;
+                };
+            } & {
+                json: {
+                    scopes?: string[] | undefined;
+                };
+            };
+        };
+    };
+} & {
+    "/v1/cli/authorizations/:code{[A-Za-z -]+}/deny": {
+        $post: {
+            output: {
+                error: {
+                    code: "api_key_malformed";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                param: {
+                    code: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "api_key_invalid" | "api_key_missing";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 401;
+            input: {
+                param: {
+                    code: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "upstream_error";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 502;
+            input: {
+                param: {
+                    code: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "param_invalid";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                param: {
+                    code: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "cli_auth_not_enabled";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 404;
+            input: {
+                param: {
+                    code: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "forbidden";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 403;
+            input: {
+                param: {
+                    code: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "cli_authorization_not_found";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 404;
+            input: {
+                param: {
+                    code: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "cli_authorization_decided";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 409;
+            input: {
+                param: {
+                    code: string;
+                };
+            };
+        } | {
+            output: {
+                code: string;
+                status: "approved" | "denied";
+            };
+            outputFormat: "json";
+            status: 200;
+            input: {
+                param: {
+                    code: string;
+                };
+            };
+        };
+    };
+} & {
+    "/v1/cli/authorizations/:code{[A-Za-z -]+}/token": {
+        $post: {
+            output: {
+                error: {
+                    code: "api_key_malformed";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                param: {
+                    code: string;
+                };
+            } & {
+                json: {
+                    codeVerifier: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "api_key_invalid" | "api_key_missing";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 401;
+            input: {
+                param: {
+                    code: string;
+                };
+            } & {
+                json: {
+                    codeVerifier: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "api_key_forbidden" | "api_key_ip_forbidden";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 403;
+            input: {
+                param: {
+                    code: string;
+                };
+            } & {
+                json: {
+                    codeVerifier: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "payment_required" | "rate_limit_exceeded";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 429;
+            input: {
+                param: {
+                    code: string;
+                };
+            } & {
+                json: {
+                    codeVerifier: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "upstream_error";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 502;
+            input: {
+                param: {
+                    code: string;
+                };
+            } & {
+                json: {
+                    codeVerifier: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "body_invalid";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                param: {
+                    code: string;
+                };
+            } & {
+                json: {
+                    codeVerifier: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "param_invalid";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 400;
+            input: {
+                param: {
+                    code: string;
+                };
+            } & {
+                json: {
+                    codeVerifier: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "cli_auth_not_enabled";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 404;
+            input: {
+                param: {
+                    code: string;
+                };
+            } & {
+                json: {
+                    codeVerifier: string;
+                };
+            };
+        } | {
+            output: {
+                error: {
+                    code: "cli_authorization_not_found";
+                    details?: readonly Response.error.Detail[] | undefined;
+                    message: string;
+                };
+                requestId: string;
+            };
+            outputFormat: "json";
+            status: 404;
+            input: {
+                param: {
+                    code: string;
+                };
+            } & {
+                json: {
+                    codeVerifier: string;
+                };
+            };
+        } | {
+            output: {
+                status: "pending";
+            } | {
+                status: "denied";
+            } | {
+                expiresAt: string;
+                scopes: string[];
+                status: "approved";
+                token: string;
+            };
+            outputFormat: "json";
+            status: 200;
+            input: {
+                param: {
+                    code: string;
+                };
+            } & {
+                json: {
+                    codeVerifier: string;
+                };
+            };
+        };
+    };
+}, "/", "/v1/cli/authorizations/:code{[A-Za-z -]+}/token">;
+export declare namespace cli {
+    /** Options for the CLI sign-in routes. */
+    type Options = {
+        /** Console origin hosting the approval page. @default 'https://console.tempo.xyz' */
+        consoleUrl?: string | undefined;
+    };
+}
+//# sourceMappingURL=cli.d.ts.map