convex-cms 0.0.6 → 0.0.7

package/dist/client/admin/contentTypes.d.ts

@@ -2,411 +2,445 @@
  * Content Types Operations
  *
  * CRUD operations for content type management with optional entry counts.
+ * Supports merging code-defined types with database-defined types.
  */
 import type { ComponentApi } from "../../component/_generated/component.js";
 import type { AuthContext, AdminOperation } from "./types.js";
+/**
+ * Content type source indicator.
+ * - "code": Defined in code via defineContentType or cms.defineContent
+ * - "database": Defined in the database via admin UI
+ */
+export type ContentTypeSource = "code" | "database";
+/**
+ * Drift severity levels.
+ */
+export type DriftSeverity = "error" | "warning" | "info";
+/**
+ * Types of schema drift that can be detected.
+ */
+export type DriftType = "CONTENT_TYPE_MISSING_IN_DB" | "CONTENT_TYPE_MISSING_IN_CODE" | "FIELD_MISSING_IN_DB" | "FIELD_MISSING_IN_CODE" | "FIELD_TYPE_MISMATCH" | "FIELD_REQUIRED_MISMATCH";
+/**
+ * A single schema drift issue.
+ */
+export interface DriftIssue {
+    type: DriftType;
+    severity: DriftSeverity;
+    contentTypeName: string;
+    fieldName?: string;
+    message: string;
+}
+export interface SyncResult {
+    created: number;
+    updated: number;
+    unchanged: number;
+}
 export declare function createContentTypesOperations(component: ComponentApi, checkAuth: (ctx: AuthContext, operation: AdminOperation) => Promise<string | null>): {
+    syncCodeDefinedTypes: import("convex/server").RegisteredMutation<"public", {}, Promise<SyncResult>>;
+    checkSchemaDrift: import("convex/server").RegisteredQuery<"public", {}, Promise<DriftIssue[]>>;
     listContentTypes: import("convex/server").RegisteredQuery<"public", {
         isActive?: boolean | undefined;
         includeEntryCounts?: boolean | undefined;
     }, Promise<{
-        continueCursor: string | null;
-        isDone: boolean;
-        page: Array<{
-            _creationTime: number;
-            _id: string;
-            createdBy: string;
-            deletedAt?: number;
-            description?: string;
-            displayName: string;
-            fields: Array<{
-                defaultValue?: any;
-                description?: string;
-                label: string;
-                localized?: boolean;
-                name: string;
+        page: {
+            description?: string | undefined;
+            deletedAt?: number | undefined;
+            updatedBy?: string | undefined;
+            sortOrder?: number | undefined;
+            icon?: string | undefined;
+            singleton?: boolean | undefined;
+            slugField?: string | undefined;
+            titleField?: string | undefined;
+            fields: ({
                 options?: {
-                    maxLength?: number;
-                    minLength?: number;
-                    pattern?: string;
-                };
+                    minLength?: number | undefined;
+                    maxLength?: number | undefined;
+                    pattern?: string | undefined;
+                } | undefined;
+                searchable?: boolean | undefined;
+                localized?: boolean | undefined;
+                description?: string | undefined;
+                defaultValue?: any;
                 required: boolean;
-                searchable?: boolean;
                 type: "text";
-            } | {
-                defaultValue?: any;
-                description?: string;
-                label: string;
-                localized?: boolean;
                 name: string;
+                label: string;
+            } | {
                 options?: {
-                    max?: number;
-                    min?: number;
-                    precision?: number;
-                    step?: number;
-                };
+                    min?: number | undefined;
+                    max?: number | undefined;
+                    step?: number | undefined;
+                    precision?: number | undefined;
+                } | undefined;
+                searchable?: boolean | undefined;
+                localized?: boolean | undefined;
+                description?: string | undefined;
+                defaultValue?: any;
                 required: boolean;
-                searchable?: boolean;
                 type: "number";
-            } | {
-                defaultValue?: any;
-                description?: string;
-                label: string;
-                localized?: boolean;
                 name: string;
+                label: string;
+            } | {
                 options?: {
-                    falseLabel?: string;
-                    trueLabel?: string;
-                };
+                    trueLabel?: string | undefined;
+                    falseLabel?: string | undefined;
+                } | undefined;
+                searchable?: boolean | undefined;
+                localized?: boolean | undefined;
+                description?: string | undefined;
+                defaultValue?: any;
                 required: boolean;
-                searchable?: boolean;
                 type: "boolean";
-            } | {
-                defaultValue?: any;
-                description?: string;
-                label: string;
-                localized?: boolean;
                 name: string;
+                label: string;
+            } | {
                 options?: {
-                    allowedBlocks?: Array<string>;
-                    allowedMarks?: Array<string>;
-                };
+                    allowedBlocks?: string[] | undefined;
+                    allowedMarks?: string[] | undefined;
+                } | undefined;
+                searchable?: boolean | undefined;
+                localized?: boolean | undefined;
+                description?: string | undefined;
+                defaultValue?: any;
                 required: boolean;
-                searchable?: boolean;
                 type: "richText";
-            } | {
-                defaultValue?: any;
-                description?: string;
-                label: string;
-                localized?: boolean;
                 name: string;
+                label: string;
+            } | {
                 options?: {
-                    allowedMimeTypes?: Array<string>;
-                    maxFileSize?: number;
-                    mediaType?: "image" | "video" | "audio" | "document" | "other";
-                    multiple?: boolean;
-                };
+                    mediaType?: "image" | "video" | "audio" | "document" | "other" | undefined;
+                    allowedMimeTypes?: string[] | undefined;
+                    maxFileSize?: number | undefined;
+                    multiple?: boolean | undefined;
+                } | undefined;
+                searchable?: boolean | undefined;
+                localized?: boolean | undefined;
+                description?: string | undefined;
+                defaultValue?: any;
                 required: boolean;
-                searchable?: boolean;
                 type: "media";
-            } | {
-                defaultValue?: any;
-                description?: string;
-                label: string;
-                localized?: boolean;
                 name: string;
+                label: string;
+            } | {
                 options?: {
-                    options?: Array<{
+                    options?: {
                         label: string;
                         value: string;
-                    }>;
-                };
+                    }[] | undefined;
+                } | undefined;
+                searchable?: boolean | undefined;
+                localized?: boolean | undefined;
+                description?: string | undefined;
+                defaultValue?: any;
                 required: boolean;
-                searchable?: boolean;
                 type: "select";
-            } | {
-                defaultValue?: any;
-                description?: string;
-                label: string;
-                localized?: boolean;
                 name: string;
-                options?: {
-                    options?: Array<{
-                        label: string;
-                        value: string;
-                    }>;
-                };
-                required: boolean;
-                searchable?: boolean;
-                type: "multiSelect";
-            } | {
-                defaultValue?: any;
-                description?: string;
                 label: string;
-                localized?: boolean;
-                name: string;
-                options?: {
-                    allowCreate?: boolean;
-                    maxTags?: number;
-                    minTags?: number;
-                    taxonomyId?: string;
-                };
-                required: boolean;
-                searchable?: boolean;
-                type: "tags";
             } | {
-                defaultValue?: any;
-                description?: string;
-                label: string;
-                localized?: boolean;
-                name: string;
                 options?: {
-                    allowMultiple?: boolean;
-                };
+                    allowMultiple?: boolean | undefined;
+                } | undefined;
+                searchable?: boolean | undefined;
+                localized?: boolean | undefined;
+                description?: string | undefined;
+                defaultValue?: any;
                 required: boolean;
-                searchable?: boolean;
                 type: "category";
-            } | {
-                defaultValue?: any;
-                description?: string;
-                label: string;
-                localized?: boolean;
                 name: string;
+                label: string;
+            } | {
                 options?: {
                     schema?: any;
-                };
+                } | undefined;
+                searchable?: boolean | undefined;
+                localized?: boolean | undefined;
+                description?: string | undefined;
+                defaultValue?: any;
                 required: boolean;
-                searchable?: boolean;
                 type: "json";
+                name: string;
+                label: string;
             } | {
+                options?: {
+                    multiple?: boolean | undefined;
+                    allowedContentTypes?: string[] | undefined;
+                    minItems?: number | undefined;
+                } | undefined;
+                searchable?: boolean | undefined;
+                localized?: boolean | undefined;
+                description?: string | undefined;
                 defaultValue?: any;
-                description?: string;
-                label: string;
-                localized?: boolean;
+                required: boolean;
+                type: "reference";
                 name: string;
+                label: string;
+            } | {
                 options?: {
-                    max?: number;
-                    min?: number;
-                };
+                    options?: {
+                        label: string;
+                        value: string;
+                    }[] | undefined;
+                } | undefined;
+                searchable?: boolean | undefined;
+                localized?: boolean | undefined;
+                description?: string | undefined;
+                defaultValue?: any;
                 required: boolean;
-                searchable?: boolean;
-                type: "date";
+                type: "multiSelect";
+                name: string;
+                label: string;
             } | {
+                options?: {
+                    min?: number | undefined;
+                    max?: number | undefined;
+                } | undefined;
+                searchable?: boolean | undefined;
+                localized?: boolean | undefined;
+                description?: string | undefined;
                 defaultValue?: any;
-                description?: string;
-                label: string;
-                localized?: boolean;
+                required: boolean;
+                type: "date";
                 name: string;
+                label: string;
+            } | {
                 options?: {
-                    max?: number;
-                    min?: number;
-                };
+                    min?: number | undefined;
+                    max?: number | undefined;
+                } | undefined;
+                searchable?: boolean | undefined;
+                localized?: boolean | undefined;
+                description?: string | undefined;
+                defaultValue?: any;
                 required: boolean;
-                searchable?: boolean;
                 type: "datetime";
-            } | {
-                defaultValue?: any;
-                description?: string;
-                label: string;
-                localized?: boolean;
                 name: string;
+                label: string;
+            } | {
                 options?: {
-                    allowedContentTypes?: Array<string>;
-                    minItems?: number;
-                    multiple?: boolean;
-                };
+                    taxonomyId?: string | undefined;
+                    allowCreate?: boolean | undefined;
+                    maxTags?: number | undefined;
+                    minTags?: number | undefined;
+                } | undefined;
+                searchable?: boolean | undefined;
+                localized?: boolean | undefined;
+                description?: string | undefined;
+                defaultValue?: any;
                 required: boolean;
-                searchable?: boolean;
-                type: "reference";
-            }>;
-            icon?: string;
-            isActive: boolean;
+                type: "tags";
+                name: string;
+                label: string;
+            })[];
             name: string;
-            singleton?: boolean;
-            slugField?: string;
-            sortOrder?: number;
-            titleField?: string;
-            updatedBy?: string;
-        }>;
+            createdBy: string;
+            displayName: string;
+            isActive: boolean;
+            _creationTime: number;
+            _id: string;
+            source: "code" | "database";
+        }[];
+        continueCursor: string | null;
+        isDone: boolean;
     }>>;
     getContentType: import("convex/server").RegisteredQuery<"public", {
         id?: string | undefined;
         name?: string | undefined;
     }, Promise<{
-        _creationTime: number;
-        _id: string;
-        createdBy: string;
-        deletedAt?: number;
-        description?: string;
-        displayName: string;
-        fields: Array<{
-            defaultValue?: any;
-            description?: string;
-            label: string;
-            localized?: boolean;
-            name: string;
+        description?: string | undefined;
+        deletedAt?: number | undefined;
+        updatedBy?: string | undefined;
+        sortOrder?: number | undefined;
+        icon?: string | undefined;
+        singleton?: boolean | undefined;
+        slugField?: string | undefined;
+        titleField?: string | undefined;
+        fields: ({
             options?: {
-                maxLength?: number;
-                minLength?: number;
-                pattern?: string;
-            };
+                minLength?: number | undefined;
+                maxLength?: number | undefined;
+                pattern?: string | undefined;
+            } | undefined;
+            searchable?: boolean | undefined;
+            localized?: boolean | undefined;
+            description?: string | undefined;
+            defaultValue?: any;
             required: boolean;
-            searchable?: boolean;
             type: "text";
-        } | {
-            defaultValue?: any;
-            description?: string;
-            label: string;
-            localized?: boolean;
             name: string;
+            label: string;
+        } | {
             options?: {
-                max?: number;
-                min?: number;
-                precision?: number;
-                step?: number;
-            };
+                min?: number | undefined;
+                max?: number | undefined;
+                step?: number | undefined;
+                precision?: number | undefined;
+            } | undefined;
+            searchable?: boolean | undefined;
+            localized?: boolean | undefined;
+            description?: string | undefined;
+            defaultValue?: any;
             required: boolean;
-            searchable?: boolean;
             type: "number";
-        } | {
-            defaultValue?: any;
-            description?: string;
-            label: string;
-            localized?: boolean;
             name: string;
+            label: string;
+        } | {
             options?: {
-                falseLabel?: string;
-                trueLabel?: string;
-            };
+                trueLabel?: string | undefined;
+                falseLabel?: string | undefined;
+            } | undefined;
+            searchable?: boolean | undefined;
+            localized?: boolean | undefined;
+            description?: string | undefined;
+            defaultValue?: any;
             required: boolean;
-            searchable?: boolean;
             type: "boolean";
-        } | {
-            defaultValue?: any;
-            description?: string;
-            label: string;
-            localized?: boolean;
             name: string;
+            label: string;
+        } | {
             options?: {
-                allowedBlocks?: Array<string>;
-                allowedMarks?: Array<string>;
-            };
+                allowedBlocks?: string[] | undefined;
+                allowedMarks?: string[] | undefined;
+            } | undefined;
+            searchable?: boolean | undefined;
+            localized?: boolean | undefined;
+            description?: string | undefined;
+            defaultValue?: any;
             required: boolean;
-            searchable?: boolean;
             type: "richText";
-        } | {
-            defaultValue?: any;
-            description?: string;
-            label: string;
-            localized?: boolean;
             name: string;
+            label: string;
+        } | {
             options?: {
-                allowedMimeTypes?: Array<string>;
-                maxFileSize?: number;
-                mediaType?: "image" | "video" | "audio" | "document" | "other";
-                multiple?: boolean;
-            };
+                mediaType?: "image" | "video" | "audio" | "document" | "other" | undefined;
+                allowedMimeTypes?: string[] | undefined;
+                maxFileSize?: number | undefined;
+                multiple?: boolean | undefined;
+            } | undefined;
+            searchable?: boolean | undefined;
+            localized?: boolean | undefined;
+            description?: string | undefined;
+            defaultValue?: any;
             required: boolean;
-            searchable?: boolean;
             type: "media";
-        } | {
-            defaultValue?: any;
-            description?: string;
-            label: string;
-            localized?: boolean;
             name: string;
+            label: string;
+        } | {
             options?: {
-                options?: Array<{
+                options?: {
                     label: string;
                     value: string;
-                }>;
-            };
+                }[] | undefined;
+            } | undefined;
+            searchable?: boolean | undefined;
+            localized?: boolean | undefined;
+            description?: string | undefined;
+            defaultValue?: any;
             required: boolean;
-            searchable?: boolean;
             type: "select";
-        } | {
-            defaultValue?: any;
-            description?: string;
-            label: string;
-            localized?: boolean;
             name: string;
-            options?: {
-                options?: Array<{
-                    label: string;
-                    value: string;
-                }>;
-            };
-            required: boolean;
-            searchable?: boolean;
-            type: "multiSelect";
-        } | {
-            defaultValue?: any;
-            description?: string;
             label: string;
-            localized?: boolean;
-            name: string;
-            options?: {
-                allowCreate?: boolean;
-                maxTags?: number;
-                minTags?: number;
-                taxonomyId?: string;
-            };
-            required: boolean;
-            searchable?: boolean;
-            type: "tags";
         } | {
-            defaultValue?: any;
-            description?: string;
-            label: string;
-            localized?: boolean;
-            name: string;
             options?: {
-                allowMultiple?: boolean;
-            };
+                allowMultiple?: boolean | undefined;
+            } | undefined;
+            searchable?: boolean | undefined;
+            localized?: boolean | undefined;
+            description?: string | undefined;
+            defaultValue?: any;
             required: boolean;
-            searchable?: boolean;
             type: "category";
-        } | {
-            defaultValue?: any;
-            description?: string;
-            label: string;
-            localized?: boolean;
             name: string;
+            label: string;
+        } | {
             options?: {
                 schema?: any;
-            };
+            } | undefined;
+            searchable?: boolean | undefined;
+            localized?: boolean | undefined;
+            description?: string | undefined;
+            defaultValue?: any;
             required: boolean;
-            searchable?: boolean;
             type: "json";
+            name: string;
+            label: string;
         } | {
+            options?: {
+                multiple?: boolean | undefined;
+                allowedContentTypes?: string[] | undefined;
+                minItems?: number | undefined;
+            } | undefined;
+            searchable?: boolean | undefined;
+            localized?: boolean | undefined;
+            description?: string | undefined;
             defaultValue?: any;
-            description?: string;
-            label: string;
-            localized?: boolean;
+            required: boolean;
+            type: "reference";
             name: string;
+            label: string;
+        } | {
             options?: {
-                max?: number;
-                min?: number;
-            };
+                options?: {
+                    label: string;
+                    value: string;
+                }[] | undefined;
+            } | undefined;
+            searchable?: boolean | undefined;
+            localized?: boolean | undefined;
+            description?: string | undefined;
+            defaultValue?: any;
             required: boolean;
-            searchable?: boolean;
-            type: "date";
+            type: "multiSelect";
+            name: string;
+            label: string;
         } | {
+            options?: {
+                min?: number | undefined;
+                max?: number | undefined;
+            } | undefined;
+            searchable?: boolean | undefined;
+            localized?: boolean | undefined;
+            description?: string | undefined;
             defaultValue?: any;
-            description?: string;
-            label: string;
-            localized?: boolean;
+            required: boolean;
+            type: "date";
             name: string;
+            label: string;
+        } | {
             options?: {
-                max?: number;
-                min?: number;
-            };
+                min?: number | undefined;
+                max?: number | undefined;
+            } | undefined;
+            searchable?: boolean | undefined;
+            localized?: boolean | undefined;
+            description?: string | undefined;
+            defaultValue?: any;
             required: boolean;
-            searchable?: boolean;
             type: "datetime";
-        } | {
-            defaultValue?: any;
-            description?: string;
-            label: string;
-            localized?: boolean;
             name: string;
+            label: string;
+        } | {
             options?: {
-                allowedContentTypes?: Array<string>;
-                minItems?: number;
-                multiple?: boolean;
-            };
+                taxonomyId?: string | undefined;
+                allowCreate?: boolean | undefined;
+                maxTags?: number | undefined;
+                minTags?: number | undefined;
+            } | undefined;
+            searchable?: boolean | undefined;
+            localized?: boolean | undefined;
+            description?: string | undefined;
+            defaultValue?: any;
             required: boolean;
-            searchable?: boolean;
-            type: "reference";
-        }>;
-        icon?: string;
-        isActive: boolean;
+            type: "tags";
+            name: string;
+            label: string;
+        })[];
         name: string;
-        singleton?: boolean;
-        slugField?: string;
-        sortOrder?: number;
-        titleField?: string;
-        updatedBy?: string;
+        createdBy: string;
+        displayName: string;
+        isActive: boolean;
+        _creationTime: number;
+        _id: string;
+        source: "code" | "database";
     } | null>>;
     createContentType: import("convex/server").RegisteredMutation<"public", {
         description?: string | undefined;
@@ -1200,5 +1234,9 @@ export declare function createContentTypesOperations(component: ComponentApi, ch
         success: boolean;
         wasHardDelete: boolean;
     }>>;
+    /**
+     * Check if a content type is code-defined (read-only).
+     */
+    isCodeDefined: (name: string) => boolean;
 };
 //# sourceMappingURL=contentTypes.d.ts.map