@spacefast/common 0.0.26 → 0.2.1

package/dist/contracts/route-inventory.d.ts

@@ -0,0 +1,358 @@
+import { z } from "zod";
+export declare const routeInventoryEdgeAuthV1Schema: z.ZodLiteral<"inherit">;
+export type RouteInventoryEdgeAuthV1 = z.infer<typeof routeInventoryEdgeAuthV1Schema>;
+export declare const routeInventoryRecordV1Schema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    kind: z.ZodLiteral<"redirect">;
+    status: z.ZodUnion<readonly [z.ZodLiteral<301>, z.ZodLiteral<302>, z.ZodLiteral<303>, z.ZodLiteral<307>, z.ZodLiteral<308>]>;
+    runtime: z.ZodLiteral<"routing">;
+    destination: z.ZodString;
+    id: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+    source: z.ZodString;
+    host: z.ZodString;
+    path: z.ZodString;
+    methods: z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"*">, z.ZodEnum<{
+        POST: "POST";
+        PUT: "PUT";
+        GET: "GET";
+        HEAD: "HEAD";
+        PATCH: "PATCH";
+        DELETE: "DELETE";
+        OPTIONS: "OPTIONS";
+    }>]>>;
+    auth: z.ZodLiteral<"inherit">;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"rewrite">;
+    status: z.ZodLiteral<200>;
+    runtime: z.ZodLiteral<"routing">;
+    destination: z.ZodString;
+    id: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+    source: z.ZodString;
+    host: z.ZodString;
+    path: z.ZodString;
+    methods: z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"*">, z.ZodEnum<{
+        POST: "POST";
+        PUT: "PUT";
+        GET: "GET";
+        HEAD: "HEAD";
+        PATCH: "PATCH";
+        DELETE: "DELETE";
+        OPTIONS: "OPTIONS";
+    }>]>>;
+    auth: z.ZodLiteral<"inherit">;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"proxy">;
+    status: z.ZodLiteral<200>;
+    cache: z.ZodOptional<z.ZodLiteral<"shared">>;
+    runtime: z.ZodLiteral<"routing">;
+    destination: z.ZodString;
+    id: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+    source: z.ZodString;
+    host: z.ZodString;
+    path: z.ZodString;
+    methods: z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"*">, z.ZodEnum<{
+        POST: "POST";
+        PUT: "PUT";
+        GET: "GET";
+        HEAD: "HEAD";
+        PATCH: "PATCH";
+        DELETE: "DELETE";
+        OPTIONS: "OPTIONS";
+    }>]>>;
+    auth: z.ZodLiteral<"inherit">;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"not-found">;
+    status: z.ZodLiteral<404>;
+    runtime: z.ZodLiteral<"routing">;
+    destination: z.ZodString;
+    id: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+    source: z.ZodString;
+    host: z.ZodString;
+    path: z.ZodString;
+    methods: z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"*">, z.ZodEnum<{
+        POST: "POST";
+        PUT: "PUT";
+        GET: "GET";
+        HEAD: "HEAD";
+        PATCH: "PATCH";
+        DELETE: "DELETE";
+        OPTIONS: "OPTIONS";
+    }>]>>;
+    auth: z.ZodLiteral<"inherit">;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"functions">;
+    runtime: z.ZodLiteral<"cloudflare-worker">;
+    id: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+    source: z.ZodString;
+    host: z.ZodString;
+    path: z.ZodString;
+    methods: z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"*">, z.ZodEnum<{
+        POST: "POST";
+        PUT: "PUT";
+        GET: "GET";
+        HEAD: "HEAD";
+        PATCH: "PATCH";
+        DELETE: "DELETE";
+        OPTIONS: "OPTIONS";
+    }>]>>;
+    auth: z.ZodLiteral<"inherit">;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"php-function">;
+    runtime: z.ZodLiteral<"php">;
+    id: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+    source: z.ZodString;
+    host: z.ZodString;
+    path: z.ZodString;
+    methods: z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"*">, z.ZodEnum<{
+        POST: "POST";
+        PUT: "PUT";
+        GET: "GET";
+        HEAD: "HEAD";
+        PATCH: "PATCH";
+        DELETE: "DELETE";
+        OPTIONS: "OPTIONS";
+    }>]>>;
+    auth: z.ZodLiteral<"inherit">;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"zero-control">;
+    runtime: z.ZodLiteral<"php">;
+    id: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+    source: z.ZodString;
+    host: z.ZodString;
+    path: z.ZodString;
+    methods: z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"*">, z.ZodEnum<{
+        POST: "POST";
+        PUT: "PUT";
+        GET: "GET";
+        HEAD: "HEAD";
+        PATCH: "PATCH";
+        DELETE: "DELETE";
+        OPTIONS: "OPTIONS";
+    }>]>>;
+    auth: z.ZodLiteral<"inherit">;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"zero-endpoint">;
+    runtime: z.ZodLiteral<"quick-js">;
+    id: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+    source: z.ZodString;
+    host: z.ZodString;
+    path: z.ZodString;
+    methods: z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"*">, z.ZodEnum<{
+        POST: "POST";
+        PUT: "PUT";
+        GET: "GET";
+        HEAD: "HEAD";
+        PATCH: "PATCH";
+        DELETE: "DELETE";
+        OPTIONS: "OPTIONS";
+    }>]>>;
+    auth: z.ZodLiteral<"inherit">;
+}, z.core.$strict>], "kind">;
+export type RouteInventoryRecordV1 = z.infer<typeof routeInventoryRecordV1Schema>;
+export declare const routeInventoryV1Schema: z.ZodObject<{
+    format: z.ZodLiteral<"stattic.route-inventory.v1">;
+    routes: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"redirect">;
+        status: z.ZodUnion<readonly [z.ZodLiteral<301>, z.ZodLiteral<302>, z.ZodLiteral<303>, z.ZodLiteral<307>, z.ZodLiteral<308>]>;
+        runtime: z.ZodLiteral<"routing">;
+        destination: z.ZodString;
+        id: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+        source: z.ZodString;
+        host: z.ZodString;
+        path: z.ZodString;
+        methods: z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"*">, z.ZodEnum<{
+            POST: "POST";
+            PUT: "PUT";
+            GET: "GET";
+            HEAD: "HEAD";
+            PATCH: "PATCH";
+            DELETE: "DELETE";
+            OPTIONS: "OPTIONS";
+        }>]>>;
+        auth: z.ZodLiteral<"inherit">;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"rewrite">;
+        status: z.ZodLiteral<200>;
+        runtime: z.ZodLiteral<"routing">;
+        destination: z.ZodString;
+        id: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+        source: z.ZodString;
+        host: z.ZodString;
+        path: z.ZodString;
+        methods: z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"*">, z.ZodEnum<{
+            POST: "POST";
+            PUT: "PUT";
+            GET: "GET";
+            HEAD: "HEAD";
+            PATCH: "PATCH";
+            DELETE: "DELETE";
+            OPTIONS: "OPTIONS";
+        }>]>>;
+        auth: z.ZodLiteral<"inherit">;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"proxy">;
+        status: z.ZodLiteral<200>;
+        cache: z.ZodOptional<z.ZodLiteral<"shared">>;
+        runtime: z.ZodLiteral<"routing">;
+        destination: z.ZodString;
+        id: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+        source: z.ZodString;
+        host: z.ZodString;
+        path: z.ZodString;
+        methods: z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"*">, z.ZodEnum<{
+            POST: "POST";
+            PUT: "PUT";
+            GET: "GET";
+            HEAD: "HEAD";
+            PATCH: "PATCH";
+            DELETE: "DELETE";
+            OPTIONS: "OPTIONS";
+        }>]>>;
+        auth: z.ZodLiteral<"inherit">;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"not-found">;
+        status: z.ZodLiteral<404>;
+        runtime: z.ZodLiteral<"routing">;
+        destination: z.ZodString;
+        id: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+        source: z.ZodString;
+        host: z.ZodString;
+        path: z.ZodString;
+        methods: z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"*">, z.ZodEnum<{
+            POST: "POST";
+            PUT: "PUT";
+            GET: "GET";
+            HEAD: "HEAD";
+            PATCH: "PATCH";
+            DELETE: "DELETE";
+            OPTIONS: "OPTIONS";
+        }>]>>;
+        auth: z.ZodLiteral<"inherit">;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"functions">;
+        runtime: z.ZodLiteral<"cloudflare-worker">;
+        id: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+        source: z.ZodString;
+        host: z.ZodString;
+        path: z.ZodString;
+        methods: z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"*">, z.ZodEnum<{
+            POST: "POST";
+            PUT: "PUT";
+            GET: "GET";
+            HEAD: "HEAD";
+            PATCH: "PATCH";
+            DELETE: "DELETE";
+            OPTIONS: "OPTIONS";
+        }>]>>;
+        auth: z.ZodLiteral<"inherit">;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"php-function">;
+        runtime: z.ZodLiteral<"php">;
+        id: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+        source: z.ZodString;
+        host: z.ZodString;
+        path: z.ZodString;
+        methods: z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"*">, z.ZodEnum<{
+            POST: "POST";
+            PUT: "PUT";
+            GET: "GET";
+            HEAD: "HEAD";
+            PATCH: "PATCH";
+            DELETE: "DELETE";
+            OPTIONS: "OPTIONS";
+        }>]>>;
+        auth: z.ZodLiteral<"inherit">;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"zero-control">;
+        runtime: z.ZodLiteral<"php">;
+        id: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+        source: z.ZodString;
+        host: z.ZodString;
+        path: z.ZodString;
+        methods: z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"*">, z.ZodEnum<{
+            POST: "POST";
+            PUT: "PUT";
+            GET: "GET";
+            HEAD: "HEAD";
+            PATCH: "PATCH";
+            DELETE: "DELETE";
+            OPTIONS: "OPTIONS";
+        }>]>>;
+        auth: z.ZodLiteral<"inherit">;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"zero-endpoint">;
+        runtime: z.ZodLiteral<"quick-js">;
+        id: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+        source: z.ZodString;
+        host: z.ZodString;
+        path: z.ZodString;
+        methods: z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"*">, z.ZodEnum<{
+            POST: "POST";
+            PUT: "PUT";
+            GET: "GET";
+            HEAD: "HEAD";
+            PATCH: "PATCH";
+            DELETE: "DELETE";
+            OPTIONS: "OPTIONS";
+        }>]>>;
+        auth: z.ZodLiteral<"inherit">;
+    }, z.core.$strict>], "kind">>;
+}, z.core.$strict>;
+export type RouteInventoryV1 = z.infer<typeof routeInventoryV1Schema>;
+export declare const spaceRouteSnapshotRouteV1Schema: z.ZodObject<{
+    id: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+    sourceRuleId: z.ZodNumber;
+    priority: z.ZodNumber;
+    host: z.ZodString;
+    methods: z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"*">, z.ZodEnum<{
+        POST: "POST";
+        PUT: "PUT";
+        GET: "GET";
+        HEAD: "HEAD";
+        PATCH: "PATCH";
+        DELETE: "DELETE";
+        OPTIONS: "OPTIONS";
+    }>]>>;
+    match: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"exact">;
+        path: z.ZodString;
+    }, z.core.$strict>, z.ZodObject<{
+        kind: z.ZodLiteral<"pattern">;
+        pattern: z.ZodString;
+    }, z.core.$strict>], "kind">;
+    destination: z.ZodString;
+    status: z.ZodUnion<readonly [z.ZodLiteral<301>, z.ZodLiteral<302>, z.ZodLiteral<303>, z.ZodLiteral<307>, z.ZodLiteral<308>]>;
+}, z.core.$strict>;
+export type SpaceRouteSnapshotRouteV1 = z.infer<typeof spaceRouteSnapshotRouteV1Schema>;
+export declare const spaceRouteSnapshotV1Schema: z.ZodObject<{
+    format: z.ZodLiteral<"spacefast.space-route-snapshot">;
+    version: z.ZodLiteral<1>;
+    spaceId: z.ZodTemplateLiteral<`spc_${string}`>;
+    source: z.ZodLiteral<"wordpress-redirection">;
+    capturedAt: z.ZodString;
+    revision: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+    routes: z.ZodArray<z.ZodObject<{
+        id: z.core.$ZodBranded<z.ZodString, "ContentProgramSha256", "out">;
+        sourceRuleId: z.ZodNumber;
+        priority: z.ZodNumber;
+        host: z.ZodString;
+        methods: z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"*">, z.ZodEnum<{
+            POST: "POST";
+            PUT: "PUT";
+            GET: "GET";
+            HEAD: "HEAD";
+            PATCH: "PATCH";
+            DELETE: "DELETE";
+            OPTIONS: "OPTIONS";
+        }>]>>;
+        match: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            kind: z.ZodLiteral<"exact">;
+            path: z.ZodString;
+        }, z.core.$strict>, z.ZodObject<{
+            kind: z.ZodLiteral<"pattern">;
+            pattern: z.ZodString;
+        }, z.core.$strict>], "kind">;
+        destination: z.ZodString;
+        status: z.ZodUnion<readonly [z.ZodLiteral<301>, z.ZodLiteral<302>, z.ZodLiteral<303>, z.ZodLiteral<307>, z.ZodLiteral<308>]>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type SpaceRouteSnapshotV1 = z.infer<typeof spaceRouteSnapshotV1Schema>;

package/dist/contracts/route-inventory.js

@@ -0,0 +1,141 @@
+import { z } from "zod";
+import { contentProgramSha256Schema } from "./content-program.js";
+import { httpMethodSchema } from "./execution.js";
+import { registeredIdSchema } from "./ids.js";
+const routeInventoryMethodsSchema = z
+    .array(z.union([z.literal("*"), httpMethodSchema]))
+    .min(1)
+    .refine((methods) => new Set(methods).size === methods.length, {
+    message: "route methods must be unique",
+})
+    .refine((methods) => !methods.includes("*") || methods.length === 1, {
+    message: "the wildcard method cannot be combined with explicit methods",
+});
+// This is mutable edge policy inherited by an immutable Version. Ability
+// endpoint admission is a separate dispatcher-owned contract.
+export const routeInventoryEdgeAuthV1Schema = z.literal("inherit");
+const routeInventoryRecordFields = {
+    id: contentProgramSha256Schema,
+    source: z.string().min(1).max(2_048),
+    host: z.string().min(1).max(255),
+    path: z.string().min(1).max(2_048).startsWith("/"),
+    methods: routeInventoryMethodsSchema,
+    auth: routeInventoryEdgeAuthV1Schema,
+};
+const routingRecordFields = {
+    ...routeInventoryRecordFields,
+    runtime: z.literal("routing"),
+    destination: z.string(),
+};
+const redirectStatusSchema = z.union([
+    z.literal(301),
+    z.literal(302),
+    z.literal(303),
+    z.literal(307),
+    z.literal(308),
+]);
+export const routeInventoryRecordV1Schema = z.discriminatedUnion("kind", [
+    z
+        .object({ ...routingRecordFields, kind: z.literal("redirect"), status: redirectStatusSchema })
+        .strict(),
+    z.object({ ...routingRecordFields, kind: z.literal("rewrite"), status: z.literal(200) }).strict(),
+    z
+        .object({
+        ...routingRecordFields,
+        kind: z.literal("proxy"),
+        status: z.literal(200),
+        cache: z.literal("shared").optional(),
+    })
+        .strict(),
+    z
+        .object({ ...routingRecordFields, kind: z.literal("not-found"), status: z.literal(404) })
+        .strict(),
+    z
+        .object({
+        ...routeInventoryRecordFields,
+        kind: z.literal("functions"),
+        runtime: z.literal("cloudflare-worker"),
+    })
+        .strict(),
+    z
+        .object({
+        ...routeInventoryRecordFields,
+        kind: z.literal("php-function"),
+        runtime: z.literal("php"),
+    })
+        .strict(),
+    z
+        .object({
+        ...routeInventoryRecordFields,
+        kind: z.literal("zero-control"),
+        runtime: z.literal("php"),
+    })
+        .strict(),
+    z
+        .object({
+        ...routeInventoryRecordFields,
+        kind: z.literal("zero-endpoint"),
+        runtime: z.literal("quick-js"),
+    })
+        .strict(),
+]);
+export const routeInventoryV1Schema = z
+    .object({
+    format: z.literal("stattic.route-inventory.v1"),
+    routes: z.array(routeInventoryRecordV1Schema).max(100_000),
+})
+    .strict()
+    .refine((inventory) => new Set(inventory.routes.map((route) => route.id)).size === inventory.routes.length, {
+    path: ["routes"],
+    message: "route inventory ids must be unique",
+});
+const spaceRouteSnapshotMatchV1Schema = z.discriminatedUnion("kind", [
+    z
+        .object({ kind: z.literal("exact"), path: z.string().min(1).max(2_048).startsWith("/") })
+        .strict(),
+    z
+        .object({
+        kind: z.literal("pattern"),
+        pattern: z.string().min(1).max(2_048),
+    })
+        .strict(),
+]);
+export const spaceRouteSnapshotRouteV1Schema = z
+    .object({
+    id: contentProgramSha256Schema,
+    sourceRuleId: z.number().int().positive(),
+    priority: z.number().int().nonnegative(),
+    host: z.string().min(1).max(255),
+    methods: routeInventoryMethodsSchema,
+    match: spaceRouteSnapshotMatchV1Schema,
+    destination: z.string().min(1).max(8_192),
+    status: redirectStatusSchema,
+})
+    .strict();
+export const spaceRouteSnapshotV1Schema = z
+    .object({
+    format: z.literal("spacefast.space-route-snapshot"),
+    version: z.literal(1),
+    spaceId: registeredIdSchema("spc"),
+    source: z.literal("wordpress-redirection"),
+    capturedAt: z.string().datetime({ offset: true }),
+    revision: contentProgramSha256Schema,
+    routes: z.array(spaceRouteSnapshotRouteV1Schema).max(100_000),
+})
+    .strict()
+    .superRefine((snapshot, context) => {
+    if (new Set(snapshot.routes.map((route) => route.id)).size !== snapshot.routes.length) {
+        context.addIssue({
+            code: "custom",
+            path: ["routes"],
+            message: "route snapshot ids must be unique",
+        });
+    }
+    if (new Set(snapshot.routes.map((route) => route.sourceRuleId)).size !== snapshot.routes.length) {
+        context.addIssue({
+            code: "custom",
+            path: ["routes"],
+            message: "route snapshot source rule ids must be unique",
+        });
+    }
+});