@spacefast/common 0.0.5 → 0.0.7

package/dist/contracts/deployments.d.ts

@@ -1,11 +1,11 @@
 import { z } from "zod";
 export declare const deploymentStatusSchema: z.ZodEnum<{
     failed: "failed";
-    queued: "queued";
     canceled: "canceled";
-    ready: "ready";
     building: "building";
+    ready: "ready";
     waiting_for_source: "waiting_for_source";
+    queued: "queued";
     skipped: "skipped";
 }>;
 export declare const DeploymentSourceSchema: z.ZodObject<{
@@ -29,11 +29,11 @@ export declare const DeploymentSourceSchema: z.ZodObject<{
     commitAuthorLogin: z.ZodNullable<z.ZodString>;
     pullRequestNumber: z.ZodNullable<z.ZodNumber>;
     actorType: z.ZodNullable<z.ZodEnum<{
+        system: "system";
         user: "user";
         api_key: "api_key";
         oauth_client: "oauth_client";
         anonymous_claim: "anonymous_claim";
-        system: "system";
     }>>;
     actorId: z.ZodNullable<z.ZodString>;
 }, z.core.$strip>;
@@ -74,9 +74,9 @@ export declare const DeploymentChannelStateSchema: z.ZodObject<{
 export declare const DeploymentActivityGroupSchema: z.ZodObject<{
     kind: z.ZodEnum<{
         channel: "channel";
+        source: "source";
         version: "version";
         branch: "branch";
-        source: "source";
         pull_request: "pull_request";
     }>;
     key: z.ZodString;
@@ -105,9 +105,9 @@ export declare const DeploymentSchema: z.ZodObject<{
     activityGroup: z.ZodObject<{
         kind: z.ZodEnum<{
             channel: "channel";
+            source: "source";
             version: "version";
             branch: "branch";
-            source: "source";
             pull_request: "pull_request";
         }>;
         key: z.ZodString;
@@ -115,17 +115,16 @@ export declare const DeploymentSchema: z.ZodObject<{
     }, z.core.$strip>;
     status: z.ZodEnum<{
         failed: "failed";
-        queued: "queued";
         canceled: "canceled";
-        ready: "ready";
         building: "building";
+        ready: "ready";
         waiting_for_source: "waiting_for_source";
+        queued: "queued";
         skipped: "skipped";
     }>;
     versionStatus: z.ZodNullable<z.ZodEnum<{
         failed: "failed";
         canceled: "canceled";
-        ready: "ready";
         expired: "expired";
         building: "building";
         prepared: "prepared";
@@ -133,15 +132,16 @@ export declare const DeploymentSchema: z.ZodObject<{
         uploading: "uploading";
         uploaded: "uploaded";
         finalizing: "finalizing";
+        ready: "ready";
     }>>;
     buildStatus: z.ZodNullable<z.ZodEnum<{
         failed: "failed";
-        queued: "queued";
-        running: "running";
-        succeeded: "succeeded";
         canceled: "canceled";
         waiting_for_source: "waiting_for_source";
         uploading_source: "uploading_source";
+        queued: "queued";
+        running: "running";
+        succeeded: "succeeded";
         skipped: "skipped";
     }>>;
     input: z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
@@ -190,11 +190,11 @@ export declare const DeploymentSchema: z.ZodObject<{
         commitAuthorLogin: z.ZodNullable<z.ZodString>;
         pullRequestNumber: z.ZodNullable<z.ZodNumber>;
         actorType: z.ZodNullable<z.ZodEnum<{
+            system: "system";
             user: "user";
             api_key: "api_key";
             oauth_client: "oauth_client";
             anonymous_claim: "anonymous_claim";
-            system: "system";
         }>>;
         actorId: z.ZodNullable<z.ZodString>;
     }, z.core.$strip>;
@@ -216,16 +216,16 @@ export declare const DeploymentSchema: z.ZodObject<{
     diagnostics: z.ZodArray<z.ZodObject<{
         code: z.ZodString;
         severity: z.ZodEnum<{
+            info: "info";
             warning: "warning";
             error: "error";
-            info: "info";
         }>;
         message: z.ZodString;
         path: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         provider: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+            registrar: "registrar";
             wpcloud: "wpcloud";
             dns: "dns";
-            registrar: "registrar";
             runtime: "runtime";
         }>>>;
         details: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
@@ -269,9 +269,9 @@ export declare const deploymentListResponseSchema: z.ZodObject<{
         activityGroup: z.ZodObject<{
             kind: z.ZodEnum<{
                 channel: "channel";
+                source: "source";
                 version: "version";
                 branch: "branch";
-                source: "source";
                 pull_request: "pull_request";
             }>;
             key: z.ZodString;
@@ -279,17 +279,16 @@ export declare const deploymentListResponseSchema: z.ZodObject<{
         }, z.core.$strip>;
         status: z.ZodEnum<{
             failed: "failed";
-            queued: "queued";
             canceled: "canceled";
-            ready: "ready";
             building: "building";
+            ready: "ready";
             waiting_for_source: "waiting_for_source";
+            queued: "queued";
             skipped: "skipped";
         }>;
         versionStatus: z.ZodNullable<z.ZodEnum<{
             failed: "failed";
             canceled: "canceled";
-            ready: "ready";
             expired: "expired";
             building: "building";
             prepared: "prepared";
@@ -297,15 +296,16 @@ export declare const deploymentListResponseSchema: z.ZodObject<{
             uploading: "uploading";
             uploaded: "uploaded";
             finalizing: "finalizing";
+            ready: "ready";
         }>>;
         buildStatus: z.ZodNullable<z.ZodEnum<{
             failed: "failed";
-            queued: "queued";
-            running: "running";
-            succeeded: "succeeded";
             canceled: "canceled";
             waiting_for_source: "waiting_for_source";
             uploading_source: "uploading_source";
+            queued: "queued";
+            running: "running";
+            succeeded: "succeeded";
             skipped: "skipped";
         }>>;
         input: z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
@@ -354,11 +354,11 @@ export declare const deploymentListResponseSchema: z.ZodObject<{
             commitAuthorLogin: z.ZodNullable<z.ZodString>;
             pullRequestNumber: z.ZodNullable<z.ZodNumber>;
             actorType: z.ZodNullable<z.ZodEnum<{
+                system: "system";
                 user: "user";
                 api_key: "api_key";
                 oauth_client: "oauth_client";
                 anonymous_claim: "anonymous_claim";
-                system: "system";
             }>>;
             actorId: z.ZodNullable<z.ZodString>;
         }, z.core.$strip>;
@@ -380,16 +380,16 @@ export declare const deploymentListResponseSchema: z.ZodObject<{
         diagnostics: z.ZodArray<z.ZodObject<{
             code: z.ZodString;
             severity: z.ZodEnum<{
+                info: "info";
                 warning: "warning";
                 error: "error";
-                info: "info";
             }>;
             message: z.ZodString;
             path: z.ZodOptional<z.ZodNullable<z.ZodString>>;
             provider: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+                registrar: "registrar";
                 wpcloud: "wpcloud";
                 dns: "dns";
-                registrar: "registrar";
                 runtime: "runtime";
             }>>>;
             details: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
@@ -434,9 +434,9 @@ export declare const deploymentGetResponseSchema: z.ZodObject<{
         activityGroup: z.ZodObject<{
             kind: z.ZodEnum<{
                 channel: "channel";
+                source: "source";
                 version: "version";
                 branch: "branch";
-                source: "source";
                 pull_request: "pull_request";
             }>;
             key: z.ZodString;
@@ -444,17 +444,16 @@ export declare const deploymentGetResponseSchema: z.ZodObject<{
         }, z.core.$strip>;
         status: z.ZodEnum<{
             failed: "failed";
-            queued: "queued";
             canceled: "canceled";
-            ready: "ready";
             building: "building";
+            ready: "ready";
             waiting_for_source: "waiting_for_source";
+            queued: "queued";
             skipped: "skipped";
         }>;
         versionStatus: z.ZodNullable<z.ZodEnum<{
             failed: "failed";
             canceled: "canceled";
-            ready: "ready";
             expired: "expired";
             building: "building";
             prepared: "prepared";
@@ -462,15 +461,16 @@ export declare const deploymentGetResponseSchema: z.ZodObject<{
             uploading: "uploading";
             uploaded: "uploaded";
             finalizing: "finalizing";
+            ready: "ready";
         }>>;
         buildStatus: z.ZodNullable<z.ZodEnum<{
             failed: "failed";
-            queued: "queued";
-            running: "running";
-            succeeded: "succeeded";
             canceled: "canceled";
             waiting_for_source: "waiting_for_source";
             uploading_source: "uploading_source";
+            queued: "queued";
+            running: "running";
+            succeeded: "succeeded";
             skipped: "skipped";
         }>>;
         input: z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
@@ -519,11 +519,11 @@ export declare const deploymentGetResponseSchema: z.ZodObject<{
             commitAuthorLogin: z.ZodNullable<z.ZodString>;
             pullRequestNumber: z.ZodNullable<z.ZodNumber>;
             actorType: z.ZodNullable<z.ZodEnum<{
+                system: "system";
                 user: "user";
                 api_key: "api_key";
                 oauth_client: "oauth_client";
                 anonymous_claim: "anonymous_claim";
-                system: "system";
             }>>;
             actorId: z.ZodNullable<z.ZodString>;
         }, z.core.$strip>;
@@ -545,16 +545,16 @@ export declare const deploymentGetResponseSchema: z.ZodObject<{
         diagnostics: z.ZodArray<z.ZodObject<{
             code: z.ZodString;
             severity: z.ZodEnum<{
+                info: "info";
                 warning: "warning";
                 error: "error";
-                info: "info";
             }>;
             message: z.ZodString;
             path: z.ZodOptional<z.ZodNullable<z.ZodString>>;
             provider: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+                registrar: "registrar";
                 wpcloud: "wpcloud";
                 dns: "dns";
-                registrar: "registrar";
                 runtime: "runtime";
             }>>>;
             details: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;

package/dist/contracts/device-auth.d.ts

@@ -19,21 +19,19 @@ export type DeviceAuthorizationStartResponse = z.infer<typeof DeviceAuthorizatio
 export declare const DeviceAuthorizationPollRequestSchema: z.ZodObject<{
     deviceCode: z.ZodString;
 }, z.core.$strip>;
-export type DeviceAuthorizationPollRequest = z.infer<typeof DeviceAuthorizationPollRequestSchema>;
 export declare const DeviceAuthorizationStatusSchema: z.ZodEnum<{
     expired: "expired";
     pending: "pending";
-    denied: "denied";
     approved: "approved";
+    denied: "denied";
     consumed: "consumed";
 }>;
-export type DeviceAuthorizationStatus = z.infer<typeof DeviceAuthorizationStatusSchema>;
 export declare const DeviceAuthorizationPollResponseSchema: z.ZodObject<{
     status: z.ZodEnum<{
         expired: "expired";
         pending: "pending";
-        denied: "denied";
         approved: "approved";
+        denied: "denied";
         consumed: "consumed";
     }>;
     apiKey: z.ZodOptional<z.ZodObject<{
@@ -145,13 +143,12 @@ export type DeviceAuthorizationPollResponse = z.infer<typeof DeviceAuthorization
 export declare const DeviceAuthorizationVerifyQuerySchema: z.ZodObject<{
     user_code: z.ZodString;
 }, z.core.$strip>;
-export type DeviceAuthorizationVerifyQuery = z.infer<typeof DeviceAuthorizationVerifyQuerySchema>;
 export declare const DeviceAuthorizationVerifyResponseSchema: z.ZodObject<{
     status: z.ZodEnum<{
         expired: "expired";
         pending: "pending";
-        denied: "denied";
         approved: "approved";
+        denied: "denied";
         consumed: "consumed";
     }>;
     clientId: z.ZodNullable<z.ZodString>;
@@ -164,7 +161,6 @@ export declare const DeviceAuthorizationVerifyResponseSchema: z.ZodObject<{
         liveUrl: z.ZodNullable<z.ZodString>;
     }, z.core.$strict>>;
 }, z.core.$strip>;
-export type DeviceAuthorizationVerifyResponse = z.infer<typeof DeviceAuthorizationVerifyResponseSchema>;
 export declare const DeviceAuthorizationApproveRequestSchema: z.ZodObject<{
     userCode: z.ZodString;
     teamId: z.ZodString;
@@ -177,18 +173,15 @@ export declare const DeviceAuthorizationApproveRequestSchema: z.ZodObject<{
         team_admin: "team_admin";
         billing_viewer: "billing_viewer";
     }>;
+    agentContinuation: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strict>;
-export type DeviceAuthorizationApproveRequest = z.infer<typeof DeviceAuthorizationApproveRequestSchema>;
 export declare const DeviceAuthorizationApproveResponseSchema: z.ZodObject<{
     status: z.ZodLiteral<"approved">;
     claimedSpaceId: z.ZodNullable<z.ZodString>;
 }, z.core.$strict>;
-export type DeviceAuthorizationApproveResponse = z.infer<typeof DeviceAuthorizationApproveResponseSchema>;
 export declare const DeviceAuthorizationDenyRequestSchema: z.ZodObject<{
     userCode: z.ZodString;
 }, z.core.$strip>;
-export type DeviceAuthorizationDenyRequest = z.infer<typeof DeviceAuthorizationDenyRequestSchema>;
 export declare const DeviceAuthorizationDenyResponseSchema: z.ZodObject<{
     status: z.ZodLiteral<"denied">;
 }, z.core.$strip>;
-export type DeviceAuthorizationDenyResponse = z.infer<typeof DeviceAuthorizationDenyResponseSchema>;

package/dist/contracts/device-auth.js

@@ -138,6 +138,10 @@ export const DeviceAuthorizationApproveRequestSchema = z
         .min(1)
         .describe("Team the minted API key will belong to. The approver must be a member."),
     preset: ApiKeyPresetSchema.describe("Policy preset for the minted key. Its compiled policy must be a subset of the approver's team-role policy."),
+    agentContinuation: z
+        .boolean()
+        .optional()
+        .describe("Applies when the device flow carries an anonymous-space claim: keep the publishing agent authorized after the claim (default false unless explicitly granted) via the one-time claim-token exchange."),
 })
     .strict();
 export const DeviceAuthorizationApproveResponseSchema = z

package/dist/contracts/docs.d.ts

@@ -0,0 +1,119 @@
+import { z } from "zod";
+/** Disclosure tiers an entry can carry, default `essential` for listings. */
+export declare const DOC_TIERS: readonly ["essential", "full", "reference"];
+export declare const docsIndexQuerySchema: z.ZodObject<{
+    q: z.ZodOptional<z.ZodString>;
+    tier: z.ZodDefault<z.ZodEnum<{
+        essential: "essential";
+        full: "full";
+        reference: "reference";
+    }>>;
+    category: z.ZodOptional<z.ZodEnum<{
+        api: "api";
+        guide: "guide";
+        cli: "cli";
+        error: "error";
+        recipe: "recipe";
+        workflow: "workflow";
+    }>>;
+}, z.core.$strip>;
+/** Links carried by every docs entry. */
+export declare const DocsLinksSchema: z.ZodObject<{
+    doc: z.ZodString;
+    self: z.ZodString;
+}, z.core.$strip>;
+/** One entry in the docs index. */
+export declare const DocsEntrySchema: z.ZodObject<{
+    slug: z.ZodString;
+    title: z.ZodString;
+    summary: z.ZodString;
+    category: z.ZodEnum<{
+        api: "api";
+        guide: "guide";
+        cli: "cli";
+        error: "error";
+        recipe: "recipe";
+        workflow: "workflow";
+    }>;
+    tier: z.ZodEnum<{
+        essential: "essential";
+        full: "full";
+        reference: "reference";
+    }>;
+    keywords: z.ZodArray<z.ZodString>;
+    url: z.ZodString;
+    links: z.ZodObject<{
+        doc: z.ZodString;
+        self: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type DocsEntry = z.infer<typeof DocsEntrySchema>;
+/** A single doc, which additionally carries its printable body. */
+export declare const DocsDocSchema: z.ZodObject<{
+    slug: z.ZodString;
+    title: z.ZodString;
+    summary: z.ZodString;
+    category: z.ZodEnum<{
+        api: "api";
+        guide: "guide";
+        cli: "cli";
+        error: "error";
+        recipe: "recipe";
+        workflow: "workflow";
+    }>;
+    tier: z.ZodEnum<{
+        essential: "essential";
+        full: "full";
+        reference: "reference";
+    }>;
+    keywords: z.ZodArray<z.ZodString>;
+    url: z.ZodString;
+    links: z.ZodObject<{
+        doc: z.ZodString;
+        self: z.ZodString;
+    }, z.core.$strip>;
+    body: z.ZodString;
+}, z.core.$strip>;
+export type DocsDoc = z.infer<typeof DocsDocSchema>;
+/** The GET /v1/docs index payload (inside the `{ data }` envelope). */
+export declare const DocsIndexResponseSchema: z.ZodObject<{
+    tier: z.ZodEnum<{
+        essential: "essential";
+        full: "full";
+        reference: "reference";
+    }>;
+    query: z.ZodNullable<z.ZodString>;
+    category: z.ZodNullable<z.ZodEnum<{
+        api: "api";
+        guide: "guide";
+        cli: "cli";
+        error: "error";
+        recipe: "recipe";
+        workflow: "workflow";
+    }>>;
+    count: z.ZodNumber;
+    entries: z.ZodArray<z.ZodObject<{
+        slug: z.ZodString;
+        title: z.ZodString;
+        summary: z.ZodString;
+        category: z.ZodEnum<{
+            api: "api";
+            guide: "guide";
+            cli: "cli";
+            error: "error";
+            recipe: "recipe";
+            workflow: "workflow";
+        }>;
+        tier: z.ZodEnum<{
+            essential: "essential";
+            full: "full";
+            reference: "reference";
+        }>;
+        keywords: z.ZodArray<z.ZodString>;
+        url: z.ZodString;
+        links: z.ZodObject<{
+            doc: z.ZodString;
+            self: z.ZodString;
+        }, z.core.$strip>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;

package/dist/contracts/docs.js

@@ -0,0 +1,51 @@
+// Public contract for the machine-readable docs index API (GET /v1/docs and
+// GET /v1/docs/:slug). Tier values come from the shared CLI disclosure tiers and
+// categories from the shared docs catalog, so the API can never describe a tier
+// or category the catalog does not produce.
+import { z } from "zod";
+import { DOC_KINDS } from "../docs/catalog.js";
+import { CLI_DISCLOSURE_TIER_ORDER } from "../vocabulary.js";
+/** Disclosure tiers an entry can carry, default `essential` for listings. */
+export const DOC_TIERS = CLI_DISCLOSURE_TIER_ORDER;
+const docTierEnum = z.enum([...DOC_TIERS]);
+const docCategoryEnum = z.enum([...DOC_KINDS]);
+// Query for GET /v1/docs. Tier-aware: defaults to `essential`; pass
+// `tier=reference` to get EVERYTHING (tiers are cumulative). Optional `q`
+// free-text search and `category` filter compose with the tier.
+export const docsIndexQuerySchema = z.object({
+    q: z.string().optional().describe("Free-text search across slug, title, summary, and keywords."),
+    tier: docTierEnum
+        .default("essential")
+        .describe("Disclosure tier to list. `essential` (default) shows the core pages; `full` adds advanced pages; `reference` returns everything."),
+    category: docCategoryEnum
+        .optional()
+        .describe("Restrict to one docs area: guide, cli, api, recipe, workflow, or error."),
+});
+/** Links carried by every docs entry. */
+export const DocsLinksSchema = z.object({
+    doc: z.string().url().describe("Canonical human-readable docs URL."),
+    self: z.string().describe("API-relative link to this entry's JSON (`/v1/docs/{slug}`)."),
+});
+/** One entry in the docs index. */
+export const DocsEntrySchema = z.object({
+    slug: z.string().describe("Stable topic id, e.g. `publishing` or `api/spaces`."),
+    title: z.string(),
+    summary: z.string(),
+    category: docCategoryEnum,
+    tier: docTierEnum,
+    keywords: z.array(z.string()).describe("Extra search terms that match this page."),
+    url: z.string().url().describe("Canonical human-readable docs URL."),
+    links: DocsLinksSchema,
+});
+/** A single doc, which additionally carries its printable body. */
+export const DocsDocSchema = DocsEntrySchema.extend({
+    body: z.string().describe("Short printable explanation of the topic."),
+});
+/** The GET /v1/docs index payload (inside the `{ data }` envelope). */
+export const DocsIndexResponseSchema = z.object({
+    tier: docTierEnum.describe("The tier the listing ran at."),
+    query: z.string().nullable().describe("The trimmed `q` query, or null when listing."),
+    category: docCategoryEnum.nullable().describe("The applied category filter, or null."),
+    count: z.number().int().describe("Number of entries returned."),
+    entries: z.array(DocsEntrySchema),
+});