@columnus/shared 0.1.47

package/dist/schemaTypes.d.ts

@@ -0,0 +1,454 @@
+import { z } from "zod";
+export { EMPTY_MARKDOWN_DOC } from "./richDoc.ts";
+export declare const RESERVED_TABLE_NAMES: Set<string>;
+export declare const displayTemplatesSchema: z.ZodObject<{
+    id: z.ZodOptional<z.ZodString>;
+    preview: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    id?: string | undefined;
+    preview?: string | undefined;
+}, {
+    id?: string | undefined;
+    preview?: string | undefined;
+}>;
+/**
+ * Drive-style table colors. These are semantic identifiers rather than CSS
+ * values so manifests remain portable across themes and clients.
+ */
+export declare const TABLE_COLORS: readonly ["brown", "muted-red", "red", "coral", "orange", "amber", "yellow", "gold", "blue", "light-blue", "cyan", "mint", "green", "dark-green", "lime", "light-green", "charcoal", "gray", "mauve", "pink", "purple", "deep-purple", "periwinkle", "lavender"];
+export type TableColor = (typeof TABLE_COLORS)[number];
+export declare const tableColorSchema: z.ZodEnum<["brown", "muted-red", "red", "coral", "orange", "amber", "yellow", "gold", "blue", "light-blue", "cyan", "mint", "green", "dark-green", "lime", "light-green", "charcoal", "gray", "mauve", "pink", "purple", "deep-purple", "periwinkle", "lavender"]>;
+export declare const fieldTypeSchema: z.ZodType<FieldType>;
+export declare const fieldSchema: z.ZodObject<{
+    name: z.ZodString;
+    label: z.ZodOptional<z.ZodString>;
+    type: z.ZodType<FieldType, z.ZodTypeDef, FieldType>;
+    optional: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    type: FieldType;
+    name: string;
+    optional: boolean;
+    label?: string | undefined;
+}, {
+    type: FieldType;
+    name: string;
+    optional: boolean;
+    label?: string | undefined;
+}>;
+export declare const indexSchema: z.ZodObject<{
+    name: z.ZodString;
+    fields: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    fields: string[];
+}, {
+    name: string;
+    fields: string[];
+}>;
+export declare const searchIndexSchema: z.ZodObject<{
+    name: z.ZodString;
+    searchField: z.ZodString;
+    filterFields: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    searchField: string;
+    filterFields?: string[] | undefined;
+}, {
+    name: string;
+    searchField: string;
+    filterFields?: string[] | undefined;
+}>;
+export declare const tableSchema: z.ZodObject<{
+    name: z.ZodEffects<z.ZodString, string, string>;
+    label: z.ZodOptional<z.ZodString>;
+    color: z.ZodOptional<z.ZodEnum<["brown", "muted-red", "red", "coral", "orange", "amber", "yellow", "gold", "blue", "light-blue", "cyan", "mint", "green", "dark-green", "lime", "light-green", "charcoal", "gray", "mauve", "pink", "purple", "deep-purple", "periwinkle", "lavender"]>>;
+    fields: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        label: z.ZodOptional<z.ZodString>;
+        type: z.ZodType<FieldType, z.ZodTypeDef, FieldType>;
+        optional: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        type: FieldType;
+        name: string;
+        optional: boolean;
+        label?: string | undefined;
+    }, {
+        type: FieldType;
+        name: string;
+        optional: boolean;
+        label?: string | undefined;
+    }>, "many">;
+    indexes: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        fields: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        fields: string[];
+    }, {
+        name: string;
+        fields: string[];
+    }>, "many">>;
+    searchIndexes: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        searchField: z.ZodString;
+        filterFields: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        searchField: string;
+        filterFields?: string[] | undefined;
+    }, {
+        name: string;
+        searchField: string;
+        filterFields?: string[] | undefined;
+    }>, "many">>;
+    displayTemplates: z.ZodOptional<z.ZodObject<{
+        id: z.ZodOptional<z.ZodString>;
+        preview: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        id?: string | undefined;
+        preview?: string | undefined;
+    }, {
+        id?: string | undefined;
+        preview?: string | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    fields: {
+        type: FieldType;
+        name: string;
+        optional: boolean;
+        label?: string | undefined;
+    }[];
+    indexes: {
+        name: string;
+        fields: string[];
+    }[];
+    searchIndexes: {
+        name: string;
+        searchField: string;
+        filterFields?: string[] | undefined;
+    }[];
+    label?: string | undefined;
+    color?: "brown" | "muted-red" | "red" | "coral" | "orange" | "amber" | "yellow" | "gold" | "blue" | "light-blue" | "cyan" | "mint" | "green" | "dark-green" | "lime" | "light-green" | "charcoal" | "gray" | "mauve" | "pink" | "purple" | "deep-purple" | "periwinkle" | "lavender" | undefined;
+    displayTemplates?: {
+        id?: string | undefined;
+        preview?: string | undefined;
+    } | undefined;
+}, {
+    name: string;
+    fields: {
+        type: FieldType;
+        name: string;
+        optional: boolean;
+        label?: string | undefined;
+    }[];
+    indexes?: {
+        name: string;
+        fields: string[];
+    }[] | undefined;
+    searchIndexes?: {
+        name: string;
+        searchField: string;
+        filterFields?: string[] | undefined;
+    }[] | undefined;
+    label?: string | undefined;
+    color?: "brown" | "muted-red" | "red" | "coral" | "orange" | "amber" | "yellow" | "gold" | "blue" | "light-blue" | "cyan" | "mint" | "green" | "dark-green" | "lime" | "light-green" | "charcoal" | "gray" | "mauve" | "pink" | "purple" | "deep-purple" | "periwinkle" | "lavender" | undefined;
+    displayTemplates?: {
+        id?: string | undefined;
+        preview?: string | undefined;
+    } | undefined;
+}>;
+export declare const manifestSchema: z.ZodEffects<z.ZodObject<{
+    tables: z.ZodArray<z.ZodObject<{
+        name: z.ZodEffects<z.ZodString, string, string>;
+        label: z.ZodOptional<z.ZodString>;
+        color: z.ZodOptional<z.ZodEnum<["brown", "muted-red", "red", "coral", "orange", "amber", "yellow", "gold", "blue", "light-blue", "cyan", "mint", "green", "dark-green", "lime", "light-green", "charcoal", "gray", "mauve", "pink", "purple", "deep-purple", "periwinkle", "lavender"]>>;
+        fields: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            label: z.ZodOptional<z.ZodString>;
+            type: z.ZodType<FieldType, z.ZodTypeDef, FieldType>;
+            optional: z.ZodBoolean;
+        }, "strip", z.ZodTypeAny, {
+            type: FieldType;
+            name: string;
+            optional: boolean;
+            label?: string | undefined;
+        }, {
+            type: FieldType;
+            name: string;
+            optional: boolean;
+            label?: string | undefined;
+        }>, "many">;
+        indexes: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            fields: z.ZodArray<z.ZodString, "many">;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            fields: string[];
+        }, {
+            name: string;
+            fields: string[];
+        }>, "many">>;
+        searchIndexes: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            searchField: z.ZodString;
+            filterFields: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            searchField: string;
+            filterFields?: string[] | undefined;
+        }, {
+            name: string;
+            searchField: string;
+            filterFields?: string[] | undefined;
+        }>, "many">>;
+        displayTemplates: z.ZodOptional<z.ZodObject<{
+            id: z.ZodOptional<z.ZodString>;
+            preview: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            id?: string | undefined;
+            preview?: string | undefined;
+        }, {
+            id?: string | undefined;
+            preview?: string | undefined;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        fields: {
+            type: FieldType;
+            name: string;
+            optional: boolean;
+            label?: string | undefined;
+        }[];
+        indexes: {
+            name: string;
+            fields: string[];
+        }[];
+        searchIndexes: {
+            name: string;
+            searchField: string;
+            filterFields?: string[] | undefined;
+        }[];
+        label?: string | undefined;
+        color?: "brown" | "muted-red" | "red" | "coral" | "orange" | "amber" | "yellow" | "gold" | "blue" | "light-blue" | "cyan" | "mint" | "green" | "dark-green" | "lime" | "light-green" | "charcoal" | "gray" | "mauve" | "pink" | "purple" | "deep-purple" | "periwinkle" | "lavender" | undefined;
+        displayTemplates?: {
+            id?: string | undefined;
+            preview?: string | undefined;
+        } | undefined;
+    }, {
+        name: string;
+        fields: {
+            type: FieldType;
+            name: string;
+            optional: boolean;
+            label?: string | undefined;
+        }[];
+        indexes?: {
+            name: string;
+            fields: string[];
+        }[] | undefined;
+        searchIndexes?: {
+            name: string;
+            searchField: string;
+            filterFields?: string[] | undefined;
+        }[] | undefined;
+        label?: string | undefined;
+        color?: "brown" | "muted-red" | "red" | "coral" | "orange" | "amber" | "yellow" | "gold" | "blue" | "light-blue" | "cyan" | "mint" | "green" | "dark-green" | "lime" | "light-green" | "charcoal" | "gray" | "mauve" | "pink" | "purple" | "deep-purple" | "periwinkle" | "lavender" | undefined;
+        displayTemplates?: {
+            id?: string | undefined;
+            preview?: string | undefined;
+        } | undefined;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    tables: {
+        name: string;
+        fields: {
+            type: FieldType;
+            name: string;
+            optional: boolean;
+            label?: string | undefined;
+        }[];
+        indexes: {
+            name: string;
+            fields: string[];
+        }[];
+        searchIndexes: {
+            name: string;
+            searchField: string;
+            filterFields?: string[] | undefined;
+        }[];
+        label?: string | undefined;
+        color?: "brown" | "muted-red" | "red" | "coral" | "orange" | "amber" | "yellow" | "gold" | "blue" | "light-blue" | "cyan" | "mint" | "green" | "dark-green" | "lime" | "light-green" | "charcoal" | "gray" | "mauve" | "pink" | "purple" | "deep-purple" | "periwinkle" | "lavender" | undefined;
+        displayTemplates?: {
+            id?: string | undefined;
+            preview?: string | undefined;
+        } | undefined;
+    }[];
+}, {
+    tables: {
+        name: string;
+        fields: {
+            type: FieldType;
+            name: string;
+            optional: boolean;
+            label?: string | undefined;
+        }[];
+        indexes?: {
+            name: string;
+            fields: string[];
+        }[] | undefined;
+        searchIndexes?: {
+            name: string;
+            searchField: string;
+            filterFields?: string[] | undefined;
+        }[] | undefined;
+        label?: string | undefined;
+        color?: "brown" | "muted-red" | "red" | "coral" | "orange" | "amber" | "yellow" | "gold" | "blue" | "light-blue" | "cyan" | "mint" | "green" | "dark-green" | "lime" | "light-green" | "charcoal" | "gray" | "mauve" | "pink" | "purple" | "deep-purple" | "periwinkle" | "lavender" | undefined;
+        displayTemplates?: {
+            id?: string | undefined;
+            preview?: string | undefined;
+        } | undefined;
+    }[];
+}>, {
+    tables: {
+        name: string;
+        fields: {
+            type: FieldType;
+            name: string;
+            optional: boolean;
+            label?: string | undefined;
+        }[];
+        indexes: {
+            name: string;
+            fields: string[];
+        }[];
+        searchIndexes: {
+            name: string;
+            searchField: string;
+            filterFields?: string[] | undefined;
+        }[];
+        label?: string | undefined;
+        color?: "brown" | "muted-red" | "red" | "coral" | "orange" | "amber" | "yellow" | "gold" | "blue" | "light-blue" | "cyan" | "mint" | "green" | "dark-green" | "lime" | "light-green" | "charcoal" | "gray" | "mauve" | "pink" | "purple" | "deep-purple" | "periwinkle" | "lavender" | undefined;
+        displayTemplates?: {
+            id?: string | undefined;
+            preview?: string | undefined;
+        } | undefined;
+    }[];
+}, {
+    tables: {
+        name: string;
+        fields: {
+            type: FieldType;
+            name: string;
+            optional: boolean;
+            label?: string | undefined;
+        }[];
+        indexes?: {
+            name: string;
+            fields: string[];
+        }[] | undefined;
+        searchIndexes?: {
+            name: string;
+            searchField: string;
+            filterFields?: string[] | undefined;
+        }[] | undefined;
+        label?: string | undefined;
+        color?: "brown" | "muted-red" | "red" | "coral" | "orange" | "amber" | "yellow" | "gold" | "blue" | "light-blue" | "cyan" | "mint" | "green" | "dark-green" | "lime" | "light-green" | "charcoal" | "gray" | "mauve" | "pink" | "purple" | "deep-purple" | "periwinkle" | "lavender" | undefined;
+        displayTemplates?: {
+            id?: string | undefined;
+            preview?: string | undefined;
+        } | undefined;
+    }[];
+}>;
+export type FieldType = {
+    kind: "string";
+} | {
+    kind: "markdown";
+} | {
+    kind: "number";
+} | {
+    kind: "boolean";
+} | {
+    kind: "bigint";
+} | {
+    kind: "null";
+} | {
+    kind: "any";
+} | {
+    kind: "bytes";
+} | {
+    kind: "file";
+} | {
+    kind: "image";
+} | {
+    kind: "date";
+} | {
+    kind: "datetime";
+} | {
+    kind: "id";
+    table: string;
+} | {
+    kind: "literal";
+    value: string | number | boolean;
+} | {
+    kind: "array";
+    element: FieldType;
+} | {
+    kind: "object";
+    fields: Field[];
+} | {
+    kind: "union";
+    options: FieldType[];
+};
+export type Field = {
+    name: string;
+    label?: string;
+    type: FieldType;
+    optional: boolean;
+};
+export type Index = {
+    name: string;
+    fields: string[];
+};
+export type SearchIndex = {
+    name: string;
+    searchField: string;
+    filterFields?: string[];
+};
+export type DisplayTemplates = {
+    id?: string;
+    preview?: string;
+};
+export type DisplayValueType = "id" | "preview";
+export type Table = {
+    name: string;
+    label?: string;
+    color?: TableColor;
+    fields: Field[];
+    indexes: Index[];
+    searchIndexes: SearchIndex[];
+    displayTemplates?: DisplayTemplates;
+};
+export type Manifest = {
+    tables: Table[];
+};
+export declare const EMPTY_MANIFEST: Manifest;
+export declare function tableDisplayName(t: Table): string;
+export declare function fieldDisplayName(f: Field): string;
+export declare function isSystemField(key: string): boolean;
+export declare function stripSystemFields(row: Record<string, unknown>): Record<string, unknown>;
+export declare function isPrimitiveKind(t: FieldType): boolean;
+export declare function isInlinePrimitive(t: FieldType): boolean;
+export declare function isEditableKind(t: FieldType): boolean;
+export declare function isMarkdownField(t: FieldType): boolean;
+export declare function isReferenceFieldType(t: FieldType): boolean;
+export declare function isFileFieldType(t: FieldType): boolean;
+export declare function isFileArrayFieldType(t: FieldType): boolean;
+export declare function isImageFieldType(t: FieldType): boolean;
+/** Scalar or array file/image — opens upload dialog on double-click. */
+export declare function isStorageFieldType(t: FieldType): boolean;
+export declare function isTextScalarKind(t: FieldType): boolean;
+export declare function describeFieldType(t: FieldType): string;
+export declare function validateFieldValue(value: unknown, type: FieldType, optional?: boolean): string | null;
+export declare function validatePatch(patch: Record<string, unknown>, fields: readonly Field[]): Record<string, string>;
+export declare function defaultValueForType(t: FieldType): unknown;