@kya-os/cli 2.0.0 → 2.0.2

package/node_modules/@kya-os/contracts/dist/cli-read/settings.d.ts

@@ -0,0 +1,274 @@
+import { z } from "zod";
+/**
+ * `GET /api/v1/cli/settings` -- the CLI's "Settings" + "API keys" tabs.
+ *
+ * A thin re-exposure of `SettingsData.usage`/`.planLimits` (checkpoint
+ * `packages/checkpoint-shared/src/api/internal.ts`) and a redacted slice of
+ * `ApiKeyWithProject` for the key list. `CliApiKeySummarySchema`
+ * deliberately has no `key`/secret field at all: `ApiKeyWithProject`
+ * carries the live key value, but a READ-ONLY plane meant for routine
+ * polling by potentially many operators must never put ANY project's key
+ * material on the wire, including keys other than the one the CLI itself
+ * already holds -- there is no legitimate reason for this view to need it,
+ * and "the client never logs the key" (this PR's own acceptance bar) is
+ * easiest to guarantee for a value the client never receives at all.
+ *
+ * @module contracts/cli-read/settings
+ */
+export declare const CliApiKeySummarySchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    permissions: z.ZodArray<z.ZodEnum<["read", "write", "admin"]>, "many">;
+    lastUsedAt: z.ZodNullable<z.ZodString>;
+    expiresAt: z.ZodNullable<z.ZodString>;
+    revokedAt: z.ZodNullable<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    id: string;
+    expiresAt: string | null;
+    revokedAt: string | null;
+    permissions: ("read" | "write" | "admin")[];
+    lastUsedAt: string | null;
+}, {
+    name: string;
+    id: string;
+    expiresAt: string | null;
+    revokedAt: string | null;
+    permissions: ("read" | "write" | "admin")[];
+    lastUsedAt: string | null;
+}>;
+export type CliApiKeySummary = z.infer<typeof CliApiKeySummarySchema>;
+export declare const CliSettingsUsageSchema: z.ZodObject<{
+    projects: z.ZodObject<{
+        used: z.ZodNumber;
+        limit: z.ZodNullable<z.ZodNumber>;
+        percentage: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        used: number;
+        limit: number | null;
+        percentage?: number | undefined;
+    }, {
+        used: number;
+        limit: number | null;
+        percentage?: number | undefined;
+    }>;
+    pixels: z.ZodObject<{
+        used: z.ZodNumber;
+        limit: z.ZodNullable<z.ZodNumber>;
+        percentage: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        used: number;
+        limit: number | null;
+        percentage?: number | undefined;
+    }, {
+        used: number;
+        limit: number | null;
+        percentage?: number | undefined;
+    }>;
+    apiKeys: z.ZodObject<{
+        used: z.ZodNumber;
+        limit: z.ZodNullable<z.ZodNumber>;
+        percentage: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        used: number;
+        limit: number | null;
+        percentage?: number | undefined;
+    }, {
+        used: number;
+        limit: number | null;
+        percentage?: number | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    projects: {
+        used: number;
+        limit: number | null;
+        percentage?: number | undefined;
+    };
+    pixels: {
+        used: number;
+        limit: number | null;
+        percentage?: number | undefined;
+    };
+    apiKeys: {
+        used: number;
+        limit: number | null;
+        percentage?: number | undefined;
+    };
+}, {
+    projects: {
+        used: number;
+        limit: number | null;
+        percentage?: number | undefined;
+    };
+    pixels: {
+        used: number;
+        limit: number | null;
+        percentage?: number | undefined;
+    };
+    apiKeys: {
+        used: number;
+        limit: number | null;
+        percentage?: number | undefined;
+    };
+}>;
+export type CliSettingsUsage = z.infer<typeof CliSettingsUsageSchema>;
+export declare const CliSettingsSummarySchema: z.ZodObject<{
+    generatedAt: z.ZodString;
+    plan: z.ZodNullable<z.ZodString>;
+    usage: z.ZodObject<{
+        projects: z.ZodObject<{
+            used: z.ZodNumber;
+            limit: z.ZodNullable<z.ZodNumber>;
+            percentage: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            used: number;
+            limit: number | null;
+            percentage?: number | undefined;
+        }, {
+            used: number;
+            limit: number | null;
+            percentage?: number | undefined;
+        }>;
+        pixels: z.ZodObject<{
+            used: z.ZodNumber;
+            limit: z.ZodNullable<z.ZodNumber>;
+            percentage: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            used: number;
+            limit: number | null;
+            percentage?: number | undefined;
+        }, {
+            used: number;
+            limit: number | null;
+            percentage?: number | undefined;
+        }>;
+        apiKeys: z.ZodObject<{
+            used: z.ZodNumber;
+            limit: z.ZodNullable<z.ZodNumber>;
+            percentage: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            used: number;
+            limit: number | null;
+            percentage?: number | undefined;
+        }, {
+            used: number;
+            limit: number | null;
+            percentage?: number | undefined;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        projects: {
+            used: number;
+            limit: number | null;
+            percentage?: number | undefined;
+        };
+        pixels: {
+            used: number;
+            limit: number | null;
+            percentage?: number | undefined;
+        };
+        apiKeys: {
+            used: number;
+            limit: number | null;
+            percentage?: number | undefined;
+        };
+    }, {
+        projects: {
+            used: number;
+            limit: number | null;
+            percentage?: number | undefined;
+        };
+        pixels: {
+            used: number;
+            limit: number | null;
+            percentage?: number | undefined;
+        };
+        apiKeys: {
+            used: number;
+            limit: number | null;
+            percentage?: number | undefined;
+        };
+    }>;
+    apiKeys: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        permissions: z.ZodArray<z.ZodEnum<["read", "write", "admin"]>, "many">;
+        lastUsedAt: z.ZodNullable<z.ZodString>;
+        expiresAt: z.ZodNullable<z.ZodString>;
+        revokedAt: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        id: string;
+        expiresAt: string | null;
+        revokedAt: string | null;
+        permissions: ("read" | "write" | "admin")[];
+        lastUsedAt: string | null;
+    }, {
+        name: string;
+        id: string;
+        expiresAt: string | null;
+        revokedAt: string | null;
+        permissions: ("read" | "write" | "admin")[];
+        lastUsedAt: string | null;
+    }>, "many">;
+    /** Link-out target for the "Documentation" tab, which has no summary endpoint of its own (P24 plan discovery). Restricted to http(s) -- see `isHttpUrl` above. */
+    docsUrl: z.ZodEffects<z.ZodString, string, string>;
+}, "strip", z.ZodTypeAny, {
+    usage: {
+        projects: {
+            used: number;
+            limit: number | null;
+            percentage?: number | undefined;
+        };
+        pixels: {
+            used: number;
+            limit: number | null;
+            percentage?: number | undefined;
+        };
+        apiKeys: {
+            used: number;
+            limit: number | null;
+            percentage?: number | undefined;
+        };
+    };
+    generatedAt: string;
+    apiKeys: {
+        name: string;
+        id: string;
+        expiresAt: string | null;
+        revokedAt: string | null;
+        permissions: ("read" | "write" | "admin")[];
+        lastUsedAt: string | null;
+    }[];
+    plan: string | null;
+    docsUrl: string;
+}, {
+    usage: {
+        projects: {
+            used: number;
+            limit: number | null;
+            percentage?: number | undefined;
+        };
+        pixels: {
+            used: number;
+            limit: number | null;
+            percentage?: number | undefined;
+        };
+        apiKeys: {
+            used: number;
+            limit: number | null;
+            percentage?: number | undefined;
+        };
+    };
+    generatedAt: string;
+    apiKeys: {
+        name: string;
+        id: string;
+        expiresAt: string | null;
+        revokedAt: string | null;
+        permissions: ("read" | "write" | "admin")[];
+        lastUsedAt: string | null;
+    }[];
+    plan: string | null;
+    docsUrl: string;
+}>;
+export type CliSettingsSummary = z.infer<typeof CliSettingsSummarySchema>;

package/node_modules/@kya-os/contracts/dist/cli-read/settings.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CliSettingsSummarySchema = exports.CliSettingsUsageSchema = exports.CliApiKeySummarySchema = void 0;
+const zod_1 = require("zod");
+const common_js_1 = require("./common.js");
+// Guards docsUrl below against a non-http(s) scheme an OS handler might act
+// on unexpectedly if a future change wires "press Enter to open docsUrl"
+// onto this field. Imported from `../cli.ts`, not a third hand-kept copy
+// (an `/sm2` finding on PR #715): "contracts must stay dependency-free"
+// is about not reaching into `@kya-os/cli`, a downstream consumer -- it
+// was never a reason for two files inside `@kya-os/contracts` itself to
+// duplicate the same check, any more than `CLI_OPAQUE_TOKEN_RE` below
+// (imported from the same file) should have been.
+const cli_js_1 = require("../cli.js");
+/**
+ * `GET /api/v1/cli/settings` -- the CLI's "Settings" + "API keys" tabs.
+ *
+ * A thin re-exposure of `SettingsData.usage`/`.planLimits` (checkpoint
+ * `packages/checkpoint-shared/src/api/internal.ts`) and a redacted slice of
+ * `ApiKeyWithProject` for the key list. `CliApiKeySummarySchema`
+ * deliberately has no `key`/secret field at all: `ApiKeyWithProject`
+ * carries the live key value, but a READ-ONLY plane meant for routine
+ * polling by potentially many operators must never put ANY project's key
+ * material on the wire, including keys other than the one the CLI itself
+ * already holds -- there is no legitimate reason for this view to need it,
+ * and "the client never logs the key" (this PR's own acceptance bar) is
+ * easiest to guarantee for a value the client never receives at all.
+ *
+ * @module contracts/cli-read/settings
+ */
+exports.CliApiKeySummarySchema = zod_1.z.object({
+    id: zod_1.z.string().min(1),
+    name: zod_1.z.string().min(1),
+    // Closed enum, not z.string() (an `/sm2` compatibility note on PR #715,
+    // same tradeoff as `cli-read/monitor.ts`'s `outcome` field): a new
+    // permission value on the checkpoint side is a schema change that
+    // should land with a matching update here in the same PR, not a value
+    // this client silently accepts and mis-renders.
+    permissions: zod_1.z.array(zod_1.z.enum(["read", "write", "admin"])),
+    lastUsedAt: common_js_1.IsoTimestampSchema.nullable(),
+    expiresAt: common_js_1.IsoTimestampSchema.nullable(),
+    revokedAt: common_js_1.IsoTimestampSchema.nullable(),
+});
+exports.CliSettingsUsageSchema = zod_1.z.object({
+    projects: common_js_1.CliUsageMetricSchema,
+    pixels: common_js_1.CliUsageMetricSchema,
+    apiKeys: common_js_1.CliUsageMetricSchema,
+});
+exports.CliSettingsSummarySchema = zod_1.z.object({
+    generatedAt: common_js_1.IsoTimestampSchema,
+    plan: zod_1.z.string().nullable(),
+    usage: exports.CliSettingsUsageSchema,
+    apiKeys: zod_1.z.array(exports.CliApiKeySummarySchema).max(common_js_1.CLI_READ_MAX_ROWS),
+    /** Link-out target for the "Documentation" tab, which has no summary endpoint of its own (P24 plan discovery). Restricted to http(s) -- see `isHttpUrl` above. */
+    docsUrl: zod_1.z.string().url().refine(cli_js_1.isHttpUrl, "docsUrl must be an http(s) URL"),
+});