@spacefast/common 0.2.1 → 0.4.1

package/dist/contracts/space-config-spacefast.js

@@ -0,0 +1,70 @@
+import { z } from "zod";
+import { defaultPlanNameSchema, planCatalogSchema } from "./commerce.js";
+import { spaceConfigFileSchema, spaceSystemManifestSchema, stripHiddenSpaceConfigKeys, SPACE_CONFIG_ROUTING_SCHEMA_PROPERTIES, SPACE_CONFIG_SCHEMA_URL, } from "./space-config.js";
+// The Spacefast overlay on the space config format: the parts of `sf.jsonc` that
+// only mean something to this host. Today that is the tenant plan catalog a
+// partner's system space declares, and the published JSON Schema artifact that
+// has to describe it.
+/**
+ * The system manifest as Spacefast parses it: the format's manifest plus the
+ * per-tenant plan catalog. Metering is host material, so `plans` lives here
+ * rather than in the format.
+ */
+export const spacefastSpaceSystemManifestSchema = spaceSystemManifestSchema
+    .extend({
+    plans: planCatalogSchema
+        .optional()
+        .describe("Per-tenant plan catalog: plan name → { features, quotas.spaces, quotaPolicy }. Feature keys validated against the live vocabulary; plan names are arbitrary."),
+    defaultPlan: defaultPlanNameSchema
+        .optional()
+        .describe("Plan unassigned principals fall back to. Must be a key in `plans`."),
+})
+    .superRefine((manifest, ctx) => {
+    if (manifest.defaultPlan === undefined) {
+        return;
+    }
+    // A defaultPlan is only meaningful against a declared catalog: it must name a
+    // plan the same manifest declares, or gate resolution would fall back to a
+    // plan that does not exist.
+    if (manifest.plans === undefined || !(manifest.defaultPlan in manifest.plans)) {
+        ctx.addIssue({
+            code: z.ZodIssueCode.custom,
+            path: ["defaultPlan"],
+            message: "defaultPlan must be one of the plan names declared in `plans`.",
+        });
+    }
+});
+/**
+ * The `sf.jsonc` FILE shape as Spacefast parses it. Every intake seam that may
+ * receive a partner's system manifest — finalize, the CLI's project config —
+ * parses through this; the format's own schema rejects `system.plans` outright,
+ * so a seam that forgets fails loudly instead of dropping the catalog.
+ */
+export const spacefastSpaceConfigFileSchema = spaceConfigFileSchema.extend({
+    system: spacefastSpaceSystemManifestSchema
+        .optional()
+        .describe("Control-plane system-space manifest. Honored only for a tenant's designated system space; other spaces' declarations are ignored."),
+});
+const spaceConfigJsonValueSchema = z.json();
+const spaceConfigJsonObjectSchema = z.record(z.string(), spaceConfigJsonValueSchema);
+/**
+ * The published JSON Schema artifact for `sf.jsonc`, generated from the zod file
+ * schema. Served at SPACE_CONFIG_SCHEMA_URL so editors and agents get
+ * autocomplete and validation — including the host keys, since the document an
+ * editor resolves describes what this host accepts.
+ */
+export function spaceConfigJsonSchema() {
+    const schema = spaceConfigJsonObjectSchema.parse(stripHiddenSpaceConfigKeys({
+        ...z.toJSONSchema(spacefastSpaceConfigFileSchema, { target: "draft-7", io: "input" }),
+        $id: SPACE_CONFIG_SCHEMA_URL,
+        title: "Spacefast space configuration (sf.jsonc)",
+    }));
+    const properties = spaceConfigJsonObjectSchema.parse(schema.properties);
+    return {
+        ...schema,
+        properties: {
+            ...properties,
+            ...SPACE_CONFIG_ROUTING_SCHEMA_PROPERTIES,
+        },
+    };
+}

package/dist/contracts/space-config.d.ts

@@ -53,16 +53,16 @@ export declare const SPACE_CONFIG_CAPS: {
     /** Max `system.api.allowedOrigins` entries. */
     readonly systemApiAllowedOrigins: 32;
     /** Max `system.tokenIssuers` entries. */
-    readonly systemTokenIssuers: 16;
+    readonly systemTokenIssuers: 1;
     /** Max `system.tokenIssuers[].issuer` length. */
     readonly systemIssuerChars: 512;
     /** Max `system.tokenIssuers[].keys` entries. */
-    readonly systemIssuerKeys: 16;
+    readonly systemIssuerKeys: 5;
     /** Max `system.tokenIssuers[].keys[].kid` length. */
     readonly systemKeyIdChars: 64;
     /** Exact raw Ed25519 public-key length after base64url encoding. */
     readonly systemPublicKeyChars: 43;
-    /** Max `system.tokenIssuers[].proof` length. */
+    /** Max `system.tokenIssuers[].proofs[]` length. */
     readonly systemProofChars: 4096;
     /** Max `system.subscriptions` entries. */
     readonly systemSubscriptions: 32;
@@ -71,8 +71,15 @@ export declare const SPACE_CONFIG_CAPS: {
     /** Max length of a `system.subscriptions[].events` name. */
     readonly systemEventChars: 128;
 };
-/** Published JSON Schema URL for `sf.jsonc` ($schema autocomplete). */
-export declare const SPACE_CONFIG_SCHEMA_URL: string;
+/**
+ * Published JSON Schema URL for `sf.jsonc` ($schema autocomplete).
+ *
+ * A format identifier, not a brand string: the `$schema` an editor resolves is
+ * one document at one URL for every space, so it is compiled in rather than
+ * resolved through the hostname registry. The literal is checked against that
+ * registry in `config/domains.test.ts`.
+ */
+export declare const SPACE_CONFIG_SCHEMA_URL = "https://spacefast.com/schemas/sf.json";
 export declare const spacePageThemeSchema: z.ZodObject<{
     accent: z.ZodOptional<z.ZodString>;
     background: z.ZodOptional<z.ZodString>;
@@ -178,7 +185,6 @@ export declare const spaceConfigSchema: z.ZodObject<{
         burstable: z.ZodOptional<z.ZodBoolean>;
     }, z.core.$strict>>;
     markdownNegotiation: z.ZodOptional<z.ZodBoolean>;
-    experimental_gutenberg: z.ZodOptional<z.ZodBoolean>;
     inject: z.ZodOptional<z.ZodObject<{
         head: z.ZodOptional<z.ZodArray<z.ZodString>>;
         bodyStart: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -306,21 +312,33 @@ export declare const systemHostnamesSchema: z.ZodObject<{
     apex: z.ZodOptional<z.ZodString>;
 }, z.core.$strict>;
 export declare const systemApiSchema: z.ZodObject<{
-    origin: z.ZodOptional<z.ZodString>;
-    allowedOrigins: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    origin: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>;
+    allowedOrigins: z.ZodOptional<z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
 }, z.core.$strict>;
+export declare const systemTokenIssuerKeysSchema: z.ZodArray<z.ZodObject<{
+    kid: z.ZodString;
+    publicKey: z.ZodString;
+}, z.core.$strict>>;
+export declare const systemTokenIssuerProofsSchema: z.ZodArray<z.ZodString>;
 export declare const systemTokenIssuerSchema: z.ZodObject<{
     issuer: z.ZodString;
     keys: z.ZodArray<z.ZodObject<{
         kid: z.ZodString;
         publicKey: z.ZodString;
     }, z.core.$strict>>;
-    proof: z.ZodOptional<z.ZodString>;
+    proofs: z.ZodOptional<z.ZodArray<z.ZodString>>;
 }, z.core.$strict>;
 export declare const systemSubscriptionSchema: z.ZodObject<{
     url: z.ZodString;
     events: z.ZodArray<z.ZodString>;
 }, z.core.$strict>;
+/**
+ * Metering is the host's, not the format's: what a plan is, what it costs and
+ * which quotas it carries is Spacefast's commerce model. The manifest's plan
+ * catalog is therefore declared in `./space-config-spacefast.js`, which extends
+ * this object — parse an sf.jsonc that may declare plans through
+ * `spacefastSpaceConfigFileSchema` there, never through the schema below.
+ */
 export declare const spaceSystemManifestSchema: z.ZodObject<{
     presentation: z.ZodOptional<z.ZodObject<{
         name: z.ZodOptional<z.ZodString>;
@@ -335,8 +353,8 @@ export declare const spaceSystemManifestSchema: z.ZodObject<{
         apex: z.ZodOptional<z.ZodString>;
     }, z.core.$strict>>;
     api: z.ZodOptional<z.ZodObject<{
-        origin: z.ZodOptional<z.ZodString>;
-        allowedOrigins: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        origin: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>;
+        allowedOrigins: z.ZodOptional<z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
     }, z.core.$strict>>;
     tokenIssuers: z.ZodOptional<z.ZodArray<z.ZodObject<{
         issuer: z.ZodString;
@@ -344,47 +362,12 @@ export declare const spaceSystemManifestSchema: z.ZodObject<{
             kid: z.ZodString;
             publicKey: z.ZodString;
         }, z.core.$strict>>;
-        proof: z.ZodOptional<z.ZodString>;
+        proofs: z.ZodOptional<z.ZodArray<z.ZodString>>;
     }, z.core.$strict>>>;
     subscriptions: z.ZodOptional<z.ZodArray<z.ZodObject<{
         url: z.ZodString;
         events: z.ZodArray<z.ZodString>;
     }, z.core.$strict>>>;
-    plans: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
-        features: z.ZodArray<z.ZodEnum<{
-            zero: "zero";
-            "plans.paid.available": "plans.paid.available";
-            "anonymous.publishing": "anonymous.publishing";
-            "beta.enrollment_gate": "beta.enrollment_gate";
-            "domains.search": "domains.search";
-            "domains.registration": "domains.registration";
-            "domains.dns_management": "domains.dns_management";
-            "domains.wpcom_dns": "domains.wpcom_dns";
-            "domains.domain_connect": "domains.domain_connect";
-            "domains.proxy_bindings": "domains.proxy_bindings";
-            "collab.notices": "collab.notices";
-            "collab.comments": "collab.comments";
-            "content.managed": "content.managed";
-            "sites.dedicated_runtime": "sites.dedicated_runtime";
-            "collab.drawing": "collab.drawing";
-            tags: "tags";
-            functions: "functions";
-            "spaces.slug_rename": "spaces.slug_rename";
-            "pages.templates": "pages.templates";
-            "branding.hide": "branding.hide";
-        }>>;
-        quotas: z.ZodObject<{
-            spaces: z.ZodOptional<z.ZodNumber>;
-            storageBytes: z.ZodOptional<z.ZodNumber>;
-            buildMinutesPerMonth: z.ZodOptional<z.ZodNumber>;
-            customDomains: z.ZodOptional<z.ZodNumber>;
-        }, z.core.$strict>;
-        quotaPolicy: z.ZodOptional<z.ZodEnum<{
-            warn: "warn";
-            block: "block";
-        }>>;
-    }, z.core.$strict>>>;
-    defaultPlan: z.ZodOptional<z.ZodString>;
 }, z.core.$strict>;
 export type SpaceSystemManifest = z.infer<typeof spaceSystemManifestSchema>;
 /**
@@ -478,7 +461,6 @@ export declare const spaceConfigFileSchema: z.ZodObject<{
         burstable: z.ZodOptional<z.ZodBoolean>;
     }, z.core.$strict>>;
     markdownNegotiation: z.ZodOptional<z.ZodBoolean>;
-    experimental_gutenberg: z.ZodOptional<z.ZodBoolean>;
     inject: z.ZodOptional<z.ZodObject<{
         head: z.ZodOptional<z.ZodArray<z.ZodString>>;
         bodyStart: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -522,8 +504,8 @@ export declare const spaceConfigFileSchema: z.ZodObject<{
             apex: z.ZodOptional<z.ZodString>;
         }, z.core.$strict>>;
         api: z.ZodOptional<z.ZodObject<{
-            origin: z.ZodOptional<z.ZodString>;
-            allowedOrigins: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            origin: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>;
+            allowedOrigins: z.ZodOptional<z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
         }, z.core.$strict>>;
         tokenIssuers: z.ZodOptional<z.ZodArray<z.ZodObject<{
             issuer: z.ZodString;
@@ -531,54 +513,159 @@ export declare const spaceConfigFileSchema: z.ZodObject<{
                 kid: z.ZodString;
                 publicKey: z.ZodString;
             }, z.core.$strict>>;
-            proof: z.ZodOptional<z.ZodString>;
+            proofs: z.ZodOptional<z.ZodArray<z.ZodString>>;
         }, z.core.$strict>>>;
         subscriptions: z.ZodOptional<z.ZodArray<z.ZodObject<{
             url: z.ZodString;
             events: z.ZodArray<z.ZodString>;
         }, z.core.$strict>>>;
-        plans: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
-            features: z.ZodArray<z.ZodEnum<{
-                zero: "zero";
-                "plans.paid.available": "plans.paid.available";
-                "anonymous.publishing": "anonymous.publishing";
-                "beta.enrollment_gate": "beta.enrollment_gate";
-                "domains.search": "domains.search";
-                "domains.registration": "domains.registration";
-                "domains.dns_management": "domains.dns_management";
-                "domains.wpcom_dns": "domains.wpcom_dns";
-                "domains.domain_connect": "domains.domain_connect";
-                "domains.proxy_bindings": "domains.proxy_bindings";
-                "collab.notices": "collab.notices";
-                "collab.comments": "collab.comments";
-                "content.managed": "content.managed";
-                "sites.dedicated_runtime": "sites.dedicated_runtime";
-                "collab.drawing": "collab.drawing";
-                tags: "tags";
-                functions: "functions";
-                "spaces.slug_rename": "spaces.slug_rename";
-                "pages.templates": "pages.templates";
-                "branding.hide": "branding.hide";
-            }>>;
-            quotas: z.ZodObject<{
-                spaces: z.ZodOptional<z.ZodNumber>;
-                storageBytes: z.ZodOptional<z.ZodNumber>;
-                buildMinutesPerMonth: z.ZodOptional<z.ZodNumber>;
-                customDomains: z.ZodOptional<z.ZodNumber>;
-            }, z.core.$strict>;
-            quotaPolicy: z.ZodOptional<z.ZodEnum<{
-                warn: "warn";
-                block: "block";
-            }>>;
-        }, z.core.$strict>>>;
-        defaultPlan: z.ZodOptional<z.ZodString>;
     }, z.core.$strict>>;
 }, z.core.$strip>;
 export type SpaceConfigFile = z.infer<typeof spaceConfigFileSchema>;
 /**
- * The published JSON Schema artifact for `sf.jsonc`, generated from the
- * zod file schema. Served at SPACE_CONFIG_SCHEMA_URL so editors and agents get
- * autocomplete and validation.
+ * Routing keys as JSON Schema. `redirects`, `rewrites` and `headers` are real
+ * sf.jsonc keys owned by the routing compiler rather than by the serving shape
+ * above, so a generated schema has to describe them separately or an editor
+ * reads the documented routing examples as unknown keys.
  */
-export declare function spaceConfigJsonSchema(): Record<string, unknown>;
+export declare const SPACE_CONFIG_ROUTING_SCHEMA_PROPERTIES: {
+    readonly redirects: {
+        readonly type: "array";
+        readonly description: "Browser redirect rules. Same matcher grammar as _redirects, and _redirects rules match first.";
+        readonly items: {
+            readonly type: "object";
+            readonly properties: {
+                readonly source: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "Request path to match. * is a splat, :name captures a segment.";
+                };
+                readonly destination: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "Path or absolute URL. :splat and :name from the source are substituted.";
+                };
+                readonly status: {
+                    readonly enum: readonly [301, 302, 303, 307, 308];
+                    readonly default: 302;
+                    readonly description: "Redirect status. To serve other content under this URL, use rewrites.";
+                };
+                readonly force: {
+                    readonly type: "boolean";
+                    readonly default: false;
+                    readonly description: "Answer even when the request path resolves to a committed file, the ! of a _redirects rule.";
+                };
+                readonly query: {
+                    readonly type: "object";
+                    readonly description: "Query parameters the request must carry, as parameter name to capture name: { \"id\": \"id\" } is the name=:capture token id=:id.";
+                    readonly propertyNames: {
+                        readonly pattern: "^[A-Za-z_][A-Za-z0-9_-]*$";
+                    };
+                    readonly additionalProperties: {
+                        readonly type: "string";
+                        readonly pattern: "^[A-Za-z][A-Za-z0-9_]*$";
+                    };
+                };
+            };
+            readonly required: readonly ["source", "destination"];
+            readonly additionalProperties: false;
+        };
+    };
+    readonly rewrites: {
+        readonly type: "array";
+        readonly description: "Rewrite and proxy rules: the URL stays, the content comes from the destination. _redirects rules match first, then redirects.";
+        readonly items: {
+            readonly type: "object";
+            readonly properties: {
+                readonly source: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "Request path to match. * is a splat, :name captures a segment.";
+                };
+                readonly destination: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "Path to serve under this URL, or an absolute URL to proxy. :splat and :name from the source are substituted.";
+                };
+                readonly cache: {
+                    readonly const: "shared";
+                    readonly description: "Let shared caches store the proxy response. Absolute-URL destinations only.";
+                };
+                readonly force: {
+                    readonly type: "boolean";
+                    readonly default: false;
+                    readonly description: "Answer even when the request path resolves to a committed file, the ! of a _redirects rule.";
+                };
+                readonly query: {
+                    readonly type: "object";
+                    readonly description: "Query parameters the request must carry, as parameter name to capture name: { \"id\": \"id\" } is the name=:capture token id=:id.";
+                    readonly propertyNames: {
+                        readonly pattern: "^[A-Za-z_][A-Za-z0-9_-]*$";
+                    };
+                    readonly additionalProperties: {
+                        readonly type: "string";
+                        readonly pattern: "^[A-Za-z][A-Za-z0-9_]*$";
+                    };
+                };
+                readonly notFound: {
+                    readonly type: "boolean";
+                    readonly default: false;
+                    readonly description: "Serve the destination with status 404, the 404 of a _redirects rule. The destination must be a path.";
+                };
+            };
+            readonly required: readonly ["source", "destination"];
+            readonly additionalProperties: false;
+        };
+    };
+    readonly headers: {
+        readonly type: "array";
+        readonly description: "Response headers to set or remove on matching requests. A _headers rule wins on the same header name.";
+        readonly items: {
+            readonly type: "object";
+            readonly properties: {
+                readonly source: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "Request path to match.";
+                };
+                readonly headers: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly items: {
+                        readonly oneOf: readonly [{
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly key: {
+                                    readonly type: "string";
+                                    readonly minLength: 1;
+                                };
+                                readonly value: {
+                                    readonly type: "string";
+                                };
+                            };
+                            readonly required: readonly ["key", "value"];
+                            readonly additionalProperties: false;
+                        }, {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly key: {
+                                    readonly type: "string";
+                                    readonly minLength: 1;
+                                };
+                                readonly remove: {
+                                    readonly const: true;
+                                    readonly description: "Remove this header instead of setting it, the !Name line of a _headers block.";
+                                };
+                            };
+                            readonly required: readonly ["key", "remove"];
+                            readonly additionalProperties: false;
+                        }];
+                    };
+                };
+            };
+            readonly required: readonly ["source", "headers"];
+            readonly additionalProperties: false;
+        };
+    };
+};
 export declare function stripHiddenSpaceConfigKeys(schema: unknown): unknown;