@spacefast/common 0.0.24 → 0.2.1

package/dist/contracts/content.d.ts

@@ -0,0 +1,432 @@
+import { z } from "zod";
+export declare const CONTENT_SCHEMA_FORMAT: "spacefast.content.schema";
+export declare const CONTENT_QUERY_FORMAT: "spacefast.content.query";
+export declare const CONTENT_SOURCE_FORMAT: "spacefast.content.source";
+export declare const CONTENT_RENDER_FORMAT: "spacefast.content.render";
+export declare const CONTENT_API_VERSION: 1;
+export declare const CONTENT_CONFIG_FILE: "content.config.ts";
+export declare const CONTENT_CONFIG_DIRECTORY: "content/";
+export declare const CONTENT_CAPS: {
+    readonly batchQueries: 25;
+    readonly collections: 50;
+    readonly fieldsPerCollection: 100;
+    readonly filterClauses: 24;
+    readonly pageSize: 100;
+    readonly selectFields: 100;
+    readonly sourceBytes: number;
+    readonly sourceFiles: 64;
+};
+export declare const contentSourceBundleSchema: z.ZodObject<{
+    format: z.ZodLiteral<"spacefast.content.source">;
+    version: z.ZodLiteral<1>;
+    entry: z.ZodDefault<z.ZodString>;
+    files: z.ZodRecord<z.ZodString, z.ZodString>;
+    phpOnly: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strict>;
+export declare const contentCompileResponseSchema: z.ZodObject<{
+    revision: z.ZodString;
+    schemaVersion: z.ZodNumber;
+    collections: z.ZodNumber;
+    fields: z.ZodNumber;
+    hooks: z.ZodNumber;
+    quickJsHooks: z.ZodNumber;
+}, z.core.$strict>;
+export declare const contentReleaseActivateResponseSchema: z.ZodObject<{
+    revision: z.ZodNullable<z.ZodString>;
+}, z.core.$strict>;
+export declare const contentRenderInputSchema: z.ZodObject<{
+    format: z.ZodLiteral<"spacefast.content.render">;
+    version: z.ZodLiteral<1>;
+    collection: z.ZodDefault<z.ZodString>;
+    id: z.ZodOptional<z.ZodNumber>;
+    slug: z.ZodOptional<z.ZodString>;
+    field: z.ZodDefault<z.ZodString>;
+    output: z.ZodDefault<z.ZodEnum<{
+        blocks: "blocks";
+        html: "html";
+    }>>;
+}, z.core.$strict>;
+export declare const contentRenderResponseSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    content: z.ZodString;
+    output: z.ZodEnum<{
+        blocks: "blocks";
+        html: "html";
+    }>;
+}, z.core.$strict>;
+export declare const contentFieldSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    label: z.ZodString;
+    required: z.ZodDefault<z.ZodBoolean>;
+    description: z.ZodOptional<z.ZodString>;
+    type: z.ZodLiteral<"text">;
+    multiline: z.ZodDefault<z.ZodBoolean>;
+    maxLength: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>, z.ZodObject<{
+    label: z.ZodString;
+    required: z.ZodDefault<z.ZodBoolean>;
+    description: z.ZodOptional<z.ZodString>;
+    type: z.ZodLiteral<"markdown">;
+}, z.core.$strip>, z.ZodObject<{
+    label: z.ZodString;
+    required: z.ZodDefault<z.ZodBoolean>;
+    description: z.ZodOptional<z.ZodString>;
+    type: z.ZodLiteral<"richText">;
+}, z.core.$strip>, z.ZodObject<{
+    label: z.ZodString;
+    required: z.ZodDefault<z.ZodBoolean>;
+    description: z.ZodOptional<z.ZodString>;
+    type: z.ZodLiteral<"number">;
+}, z.core.$strip>, z.ZodObject<{
+    label: z.ZodString;
+    required: z.ZodDefault<z.ZodBoolean>;
+    description: z.ZodOptional<z.ZodString>;
+    type: z.ZodLiteral<"boolean">;
+}, z.core.$strip>, z.ZodObject<{
+    label: z.ZodString;
+    required: z.ZodDefault<z.ZodBoolean>;
+    description: z.ZodOptional<z.ZodString>;
+    type: z.ZodLiteral<"date">;
+}, z.core.$strip>, z.ZodObject<{
+    label: z.ZodString;
+    required: z.ZodDefault<z.ZodBoolean>;
+    description: z.ZodOptional<z.ZodString>;
+    type: z.ZodLiteral<"media">;
+    multiple: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>, z.ZodObject<{
+    label: z.ZodString;
+    required: z.ZodDefault<z.ZodBoolean>;
+    description: z.ZodOptional<z.ZodString>;
+    type: z.ZodLiteral<"relation">;
+    collection: z.ZodString;
+    multiple: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>, z.ZodObject<{
+    label: z.ZodString;
+    required: z.ZodDefault<z.ZodBoolean>;
+    description: z.ZodOptional<z.ZodString>;
+    type: z.ZodLiteral<"select">;
+    options: z.ZodArray<z.ZodString>;
+    multiple: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>], "type">;
+export declare const contentCollectionSchema: z.ZodObject<{
+    resourceId: z.ZodString;
+    name: z.ZodString;
+    label: z.ZodString;
+    singularLabel: z.ZodString;
+    public: z.ZodDefault<z.ZodBoolean>;
+    fields: z.ZodRecord<z.ZodString, z.ZodDiscriminatedUnion<[z.ZodObject<{
+        label: z.ZodString;
+        required: z.ZodDefault<z.ZodBoolean>;
+        description: z.ZodOptional<z.ZodString>;
+        type: z.ZodLiteral<"text">;
+        multiline: z.ZodDefault<z.ZodBoolean>;
+        maxLength: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>, z.ZodObject<{
+        label: z.ZodString;
+        required: z.ZodDefault<z.ZodBoolean>;
+        description: z.ZodOptional<z.ZodString>;
+        type: z.ZodLiteral<"markdown">;
+    }, z.core.$strip>, z.ZodObject<{
+        label: z.ZodString;
+        required: z.ZodDefault<z.ZodBoolean>;
+        description: z.ZodOptional<z.ZodString>;
+        type: z.ZodLiteral<"richText">;
+    }, z.core.$strip>, z.ZodObject<{
+        label: z.ZodString;
+        required: z.ZodDefault<z.ZodBoolean>;
+        description: z.ZodOptional<z.ZodString>;
+        type: z.ZodLiteral<"number">;
+    }, z.core.$strip>, z.ZodObject<{
+        label: z.ZodString;
+        required: z.ZodDefault<z.ZodBoolean>;
+        description: z.ZodOptional<z.ZodString>;
+        type: z.ZodLiteral<"boolean">;
+    }, z.core.$strip>, z.ZodObject<{
+        label: z.ZodString;
+        required: z.ZodDefault<z.ZodBoolean>;
+        description: z.ZodOptional<z.ZodString>;
+        type: z.ZodLiteral<"date">;
+    }, z.core.$strip>, z.ZodObject<{
+        label: z.ZodString;
+        required: z.ZodDefault<z.ZodBoolean>;
+        description: z.ZodOptional<z.ZodString>;
+        type: z.ZodLiteral<"media">;
+        multiple: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>, z.ZodObject<{
+        label: z.ZodString;
+        required: z.ZodDefault<z.ZodBoolean>;
+        description: z.ZodOptional<z.ZodString>;
+        type: z.ZodLiteral<"relation">;
+        collection: z.ZodString;
+        multiple: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>, z.ZodObject<{
+        label: z.ZodString;
+        required: z.ZodDefault<z.ZodBoolean>;
+        description: z.ZodOptional<z.ZodString>;
+        type: z.ZodLiteral<"select">;
+        options: z.ZodArray<z.ZodString>;
+        multiple: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>], "type">>;
+}, z.core.$strict>;
+export declare const contentManifestSchema: z.ZodObject<{
+    format: z.ZodLiteral<"spacefast.content.schema">;
+    version: z.ZodLiteral<1>;
+    collections: z.ZodRecord<z.ZodString, z.ZodObject<{
+        resourceId: z.ZodString;
+        name: z.ZodString;
+        label: z.ZodString;
+        singularLabel: z.ZodString;
+        public: z.ZodDefault<z.ZodBoolean>;
+        fields: z.ZodRecord<z.ZodString, z.ZodDiscriminatedUnion<[z.ZodObject<{
+            label: z.ZodString;
+            required: z.ZodDefault<z.ZodBoolean>;
+            description: z.ZodOptional<z.ZodString>;
+            type: z.ZodLiteral<"text">;
+            multiline: z.ZodDefault<z.ZodBoolean>;
+            maxLength: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>, z.ZodObject<{
+            label: z.ZodString;
+            required: z.ZodDefault<z.ZodBoolean>;
+            description: z.ZodOptional<z.ZodString>;
+            type: z.ZodLiteral<"markdown">;
+        }, z.core.$strip>, z.ZodObject<{
+            label: z.ZodString;
+            required: z.ZodDefault<z.ZodBoolean>;
+            description: z.ZodOptional<z.ZodString>;
+            type: z.ZodLiteral<"richText">;
+        }, z.core.$strip>, z.ZodObject<{
+            label: z.ZodString;
+            required: z.ZodDefault<z.ZodBoolean>;
+            description: z.ZodOptional<z.ZodString>;
+            type: z.ZodLiteral<"number">;
+        }, z.core.$strip>, z.ZodObject<{
+            label: z.ZodString;
+            required: z.ZodDefault<z.ZodBoolean>;
+            description: z.ZodOptional<z.ZodString>;
+            type: z.ZodLiteral<"boolean">;
+        }, z.core.$strip>, z.ZodObject<{
+            label: z.ZodString;
+            required: z.ZodDefault<z.ZodBoolean>;
+            description: z.ZodOptional<z.ZodString>;
+            type: z.ZodLiteral<"date">;
+        }, z.core.$strip>, z.ZodObject<{
+            label: z.ZodString;
+            required: z.ZodDefault<z.ZodBoolean>;
+            description: z.ZodOptional<z.ZodString>;
+            type: z.ZodLiteral<"media">;
+            multiple: z.ZodDefault<z.ZodBoolean>;
+        }, z.core.$strip>, z.ZodObject<{
+            label: z.ZodString;
+            required: z.ZodDefault<z.ZodBoolean>;
+            description: z.ZodOptional<z.ZodString>;
+            type: z.ZodLiteral<"relation">;
+            collection: z.ZodString;
+            multiple: z.ZodDefault<z.ZodBoolean>;
+        }, z.core.$strip>, z.ZodObject<{
+            label: z.ZodString;
+            required: z.ZodDefault<z.ZodBoolean>;
+            description: z.ZodOptional<z.ZodString>;
+            type: z.ZodLiteral<"select">;
+            options: z.ZodArray<z.ZodString>;
+            multiple: z.ZodDefault<z.ZodBoolean>;
+        }, z.core.$strip>], "type">>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export declare const contentScalarSchema: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>;
+export declare const contentFilterSchema: z.ZodObject<{
+    field: z.ZodString;
+    operator: z.ZodEnum<{
+        gt: "gt";
+        in: "in";
+        lt: "lt";
+        eq: "eq";
+        neq: "neq";
+        notIn: "notIn";
+        gte: "gte";
+        lte: "lte";
+        contains: "contains";
+        exists: "exists";
+    }>;
+    value: z.ZodOptional<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>]>>;
+}, z.core.$strict>;
+export declare const contentOrderSchema: z.ZodObject<{
+    field: z.ZodString;
+    direction: z.ZodDefault<z.ZodEnum<{
+        asc: "asc";
+        desc: "desc";
+    }>>;
+}, z.core.$strict>;
+export declare const contentQuerySchema: z.ZodObject<{
+    collection: z.ZodString;
+    where: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        field: z.ZodString;
+        operator: z.ZodEnum<{
+            gt: "gt";
+            in: "in";
+            lt: "lt";
+            eq: "eq";
+            neq: "neq";
+            notIn: "notIn";
+            gte: "gte";
+            lte: "lte";
+            contains: "contains";
+            exists: "exists";
+        }>;
+        value: z.ZodOptional<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>]>>;
+    }, z.core.$strict>>>;
+    orderBy: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        field: z.ZodString;
+        direction: z.ZodDefault<z.ZodEnum<{
+            asc: "asc";
+            desc: "desc";
+        }>>;
+    }, z.core.$strict>>>;
+    limit: z.ZodDefault<z.ZodNumber>;
+    cursor: z.ZodOptional<z.ZodString>;
+    select: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    status: z.ZodDefault<z.ZodEnum<{
+        any: "any";
+        publish: "publish";
+        draft: "draft";
+    }>>;
+}, z.core.$strict>;
+export declare const contentBatchQueryRequestSchema: z.ZodObject<{
+    format: z.ZodLiteral<"spacefast.content.query">;
+    version: z.ZodLiteral<1>;
+    queries: z.ZodRecord<z.ZodString, z.ZodObject<{
+        collection: z.ZodString;
+        where: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            field: z.ZodString;
+            operator: z.ZodEnum<{
+                gt: "gt";
+                in: "in";
+                lt: "lt";
+                eq: "eq";
+                neq: "neq";
+                notIn: "notIn";
+                gte: "gte";
+                lte: "lte";
+                contains: "contains";
+                exists: "exists";
+            }>;
+            value: z.ZodOptional<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>]>>;
+        }, z.core.$strict>>>;
+        orderBy: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            field: z.ZodString;
+            direction: z.ZodDefault<z.ZodEnum<{
+                asc: "asc";
+                desc: "desc";
+            }>>;
+        }, z.core.$strict>>>;
+        limit: z.ZodDefault<z.ZodNumber>;
+        cursor: z.ZodOptional<z.ZodString>;
+        select: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        status: z.ZodDefault<z.ZodEnum<{
+            any: "any";
+            publish: "publish";
+            draft: "draft";
+        }>>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export declare const contentItemSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    slug: z.ZodString;
+    status: z.ZodString;
+    title: z.ZodString;
+    createdAt: z.ZodString;
+    updatedAt: z.ZodString;
+    fields: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+}, z.core.$loose>;
+export declare const contentQueryResultSchema: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        slug: z.ZodString;
+        status: z.ZodString;
+        title: z.ZodString;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+        fields: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    }, z.core.$loose>>;
+    total: z.ZodNumber;
+    nextCursor: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export declare const contentBatchQueryResponseSchema: z.ZodObject<{
+    format: z.ZodLiteral<"spacefast.content.query">;
+    version: z.ZodLiteral<1>;
+    results: z.ZodRecord<z.ZodString, z.ZodObject<{
+        items: z.ZodArray<z.ZodObject<{
+            id: z.ZodNumber;
+            slug: z.ZodString;
+            status: z.ZodString;
+            title: z.ZodString;
+            createdAt: z.ZodString;
+            updatedAt: z.ZodString;
+            fields: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        }, z.core.$loose>>;
+        total: z.ZodNumber;
+        nextCursor: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strict>;
+export declare const contentDocumentInputSchema: z.ZodUnion<readonly [z.ZodObject<{
+    id: z.ZodNumber;
+    collection: z.ZodString;
+    slug: z.ZodString;
+    title: z.ZodString;
+    status: z.ZodDefault<z.ZodEnum<{
+        publish: "publish";
+        draft: "draft";
+    }>>;
+    fields: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strict>, z.ZodObject<{
+    externalId: z.ZodString;
+    collection: z.ZodString;
+    slug: z.ZodString;
+    title: z.ZodString;
+    status: z.ZodDefault<z.ZodEnum<{
+        publish: "publish";
+        draft: "draft";
+    }>>;
+    fields: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strict>]>;
+export declare const contentAdminSessionSchema: z.ZodObject<{
+    url: z.ZodString;
+    expiresAt: z.ZodString;
+}, z.core.$strict>;
+export declare const contentMarkdownSyncInputSchema: z.ZodObject<{
+    collection: z.ZodDefault<z.ZodString>;
+    markdown: z.ZodString;
+    slug: z.ZodString;
+    source: z.ZodString;
+    status: z.ZodDefault<z.ZodEnum<{
+        publish: "publish";
+        draft: "draft";
+    }>>;
+    title: z.ZodString;
+}, z.core.$strict>;
+export type ContentField = z.infer<typeof contentFieldSchema>;
+export type ContentCollection = z.infer<typeof contentCollectionSchema>;
+export type ContentManifest = z.infer<typeof contentManifestSchema>;
+export type ContentFilter = z.infer<typeof contentFilterSchema>;
+export type ContentOrder = z.infer<typeof contentOrderSchema>;
+export type ContentQuery = z.infer<typeof contentQuerySchema>;
+export type ContentQueryInput = z.input<typeof contentQuerySchema>;
+export type ContentBatchQueryRequest = z.infer<typeof contentBatchQueryRequestSchema>;
+export type ContentBatchQueryRequestInput = z.input<typeof contentBatchQueryRequestSchema>;
+export type ContentItem = z.infer<typeof contentItemSchema>;
+export type ContentQueryResult = z.infer<typeof contentQueryResultSchema>;
+export type ContentBatchQueryResponse = z.infer<typeof contentBatchQueryResponseSchema>;
+export type ContentDocumentInput = z.infer<typeof contentDocumentInputSchema>;
+export type ContentMarkdownSyncInput = z.infer<typeof contentMarkdownSyncInputSchema>;
+export type ContentAdminSession = z.infer<typeof contentAdminSessionSchema>;
+export type ContentSourceBundle = z.infer<typeof contentSourceBundleSchema>;
+export type ContentSourceBundleInput = z.input<typeof contentSourceBundleSchema>;
+export type ContentCompileResponse = z.infer<typeof contentCompileResponseSchema>;
+export type ContentReleaseActivateResponse = z.infer<typeof contentReleaseActivateResponseSchema>;
+export type ContentRenderInput = z.infer<typeof contentRenderInputSchema>;
+export type ContentRenderInputOptions = z.input<typeof contentRenderInputSchema>;
+export type ContentRenderResponse = z.infer<typeof contentRenderResponseSchema>;
+export type ContentRead = {
+    batch<TQueries extends Record<string, ContentQueryInput>>(queries: TQueries): Promise<{
+        [TKey in keyof TQueries]: ContentQueryResult;
+    }>;
+    query(collection: string, options?: Omit<ContentQueryInput, "collection">): Promise<ContentQueryResult>;
+};