convex-cms 0.0.1

package/dist/component/contentTypes.js

@@ -0,0 +1,304 @@
+/**
+ * Content Type Query Functions
+ *
+ * Provides query functions for retrieving content type definitions from the CMS.
+ * Content types are schema blueprints that define the structure of content entries.
+ *
+ * Available queries:
+ * - `get`: Retrieve a single content type by ID or name
+ * - `list`: List all content types with optional filtering, sorting, and pagination
+ */
+import { v } from "convex/values";
+import { isDeleted } from "./lib/softDelete.js";
+import { paginationOptsValidator } from "convex/server";
+import { query } from "./_generated/server.js";
+import { contentTypeDoc } from "./validators.js";
+// =============================================================================
+// Constants
+// =============================================================================
+/**
+ * Default number of items per page when not specified.
+ */
+const DEFAULT_NUM_ITEMS = 50;
+/**
+ * Maximum items per page to prevent excessive data fetching.
+ */
+const MAX_NUM_ITEMS = 250;
+// =============================================================================
+// Get Content Type Query
+// =============================================================================
+/**
+ * Arguments for retrieving a single content type.
+ *
+ * Either `id` or `name` must be provided, but not both.
+ * - Use `id` for direct document lookup (most efficient)
+ * - Use `name` for lookup by machine-readable name (uses by_name index)
+ */
+const getContentTypeArgs = v.object({
+    /** The ID of the content type to retrieve (direct lookup) */
+    id: v.optional(v.id("contentTypes")),
+    /** The machine-readable name of the content type (e.g., "blog_post") */
+    name: v.optional(v.string()),
+    /** Whether to include soft-deleted content types (default: false) */
+    includeDeleted: v.optional(v.boolean()),
+});
+/**
+ * Query to retrieve a single content type by ID or name.
+ *
+ * Returns the full content type definition including all field configurations.
+ * This is useful for:
+ * - Loading a content type's schema before creating entries
+ * - Displaying content type information in admin interfaces
+ * - Validating content against the type's field definitions
+ *
+ * @param id - The content type ID for direct lookup (most efficient)
+ * @param name - The machine-readable name for index-based lookup
+ * @param includeDeleted - Whether to return soft-deleted types (default: false)
+ *
+ * @returns The content type document, or null if not found
+ *
+ * @example
+ * ```typescript
+ * // Get by ID (fastest - direct document lookup)
+ * const type = await ctx.runQuery(api.contentTypes.get, {
+ *   id: contentTypeId,
+ * });
+ *
+ * // Get by name (uses by_name index)
+ * const blogType = await ctx.runQuery(api.contentTypes.get, {
+ *   name: "blog_post",
+ * });
+ *
+ * // Access field definitions
+ * if (blogType) {
+ *   console.log("Fields:", blogType.fields);
+ *   console.log("Is singleton:", blogType.singleton);
+ * }
+ * ```
+ */
+export const get = query({
+    args: getContentTypeArgs.fields,
+    returns: v.union(contentTypeDoc, v.null()),
+    handler: async (ctx, args) => {
+        const { id, name, includeDeleted = false } = args;
+        // Validate that at least one identifier is provided
+        if (!id && !name) {
+            // Return null if neither id nor name is provided
+            // This matches the pattern used in other get functions
+            return null;
+        }
+        let contentType;
+        // Lookup by ID (direct document access - O(1))
+        if (id) {
+            contentType = await ctx.db.get(id);
+        }
+        // Lookup by name using the by_name index
+        else if (name) {
+            contentType = await ctx.db
+                .query("contentTypes")
+                .withIndex("by_name", (q) => q.eq("name", name))
+                .first();
+        }
+        // Return null if not found
+        if (!contentType) {
+            return null;
+        }
+        // Filter out soft-deleted types unless explicitly requested
+        if (!includeDeleted && isDeleted(contentType)) {
+            return null;
+        }
+        return contentType;
+    },
+});
+// =============================================================================
+// List Content Types Query
+// =============================================================================
+/**
+ * Sort field options for content type listing.
+ */
+const sortByValidator = v.optional(v.union(v.literal("name"), v.literal("createdAt")));
+/**
+ * Sort direction options.
+ */
+const sortDirectionValidator = v.optional(v.union(v.literal("asc"), v.literal("desc")));
+/**
+ * Arguments for listing content types with filtering and pagination.
+ */
+const listContentTypesArgs = v.object({
+    /** Filter by active status: true = active only, false = inactive only, undefined = all */
+    isActive: v.optional(v.boolean()),
+    /** Whether to include soft-deleted content types (default: false) */
+    includeDeleted: v.optional(v.boolean()),
+    /** Field to sort by: "name" (alphabetical) or "createdAt" (by creation date). Default: "name" */
+    sortBy: sortByValidator,
+    /** Sort direction: "asc" (ascending) or "desc" (descending). Default: "asc" for name, "desc" for createdAt */
+    sortDirection: sortDirectionValidator,
+    /**
+     * Pagination options using standard Convex pagination format.
+     * Compatible with usePaginatedQuery hook on the client.
+     * If not provided, returns all matching results (non-paginated).
+     */
+    paginationOpts: v.optional(paginationOptsValidator),
+});
+/**
+ * Paginated response using standard Convex PaginationResult format.
+ */
+const paginatedContentTypesResponse = v.object({
+    /** Array of content type documents for this page */
+    page: v.array(contentTypeDoc),
+    /** Cursor for fetching the next page (pass to next query's paginationOpts.cursor) */
+    continueCursor: v.union(v.string(), v.null()),
+    /** Whether this is the last page (no more results) */
+    isDone: v.boolean(),
+});
+/**
+ * Query to list all defined content types with optional filtering and sorting.
+ *
+ * Returns content type definitions sorted by name (alphabetically) or creation date.
+ * Supports filtering by active status, soft-delete status, and cursor-based pagination.
+ *
+ * **Index Usage:**
+ * - When filtering by `isActive`: Uses the `by_active` index for efficient filtering
+ * - Without active filter: Performs a table scan (acceptable since content types are few)
+ *
+ * **Sorting Behavior:**
+ * - `sortBy: "name"` (default): Sorts alphabetically by the machine-readable name
+ * - `sortBy: "createdAt"`: Sorts by creation timestamp
+ * - Default sort direction is "asc" for name, "desc" for createdAt
+ *
+ * @param isActive - Optional filter: true = active only, false = inactive only, undefined = all
+ * @param includeDeleted - Whether to include soft-deleted types (default: false)
+ * @param sortBy - Sort field: "name" (default) or "createdAt"
+ * @param sortDirection - Sort direction: "asc" or "desc"
+ * @param paginationOpts - Optional Convex pagination options (numItems, cursor)
+ *
+ * @returns PaginationResult with page, continueCursor, and isDone
+ *
+ * @example
+ * ```typescript
+ * // List all active content types sorted by name (most common use case)
+ * const { page, continueCursor, isDone } = await ctx.runQuery(
+ *   components.convexCms.contentTypes.list,
+ *   {
+ *     isActive: true,
+ *     paginationOpts: { numItems: 20 },
+ *   }
+ * );
+ *
+ * // List all content types sorted by creation date (newest first)
+ * const newest = await ctx.runQuery(
+ *   components.convexCms.contentTypes.list,
+ *   {
+ *     sortBy: "createdAt",
+ *     sortDirection: "desc",
+ *     paginationOpts: { numItems: 10 },
+ *   }
+ * );
+ *
+ * // List inactive content types only (for admin cleanup views)
+ * const inactive = await ctx.runQuery(
+ *   components.convexCms.contentTypes.list,
+ *   {
+ *     isActive: false,
+ *     paginationOpts: { numItems: 50 },
+ *   }
+ * );
+ *
+ * // Paginate through results using cursor
+ * const page2 = await ctx.runQuery(
+ *   components.convexCms.contentTypes.list,
+ *   {
+ *     isActive: true,
+ *     paginationOpts: {
+ *       numItems: 20,
+ *       cursor: previousResult.continueCursor,
+ *     },
+ *   }
+ * );
+ *
+ * // Use with usePaginatedQuery React hook
+ * const { results, status, loadMore } = usePaginatedQuery(
+ *   api.contentTypes.list,
+ *   { isActive: true, sortBy: "name" },
+ *   { initialNumItems: 20 }
+ * );
+ *
+ * // Non-paginated mode (returns all matching content types)
+ * const allTypes = await ctx.runQuery(
+ *   components.convexCms.contentTypes.list,
+ *   { isActive: true }
+ * );
+ * console.log("Total types:", allTypes.page.length);
+ * ```
+ */
+export const list = query({
+    args: listContentTypesArgs.fields,
+    returns: paginatedContentTypesResponse,
+    handler: async (ctx, args) => {
+        const { isActive, includeDeleted = false, sortBy = "name", sortDirection, paginationOpts, } = args;
+        // Determine default sort direction based on sortBy field
+        // For name sorting, ascending (A-Z) is most intuitive
+        // For date sorting, descending (newest first) is most intuitive
+        const resolvedSortDirection = sortDirection ?? (sortBy === "name" ? "asc" : "desc");
+        // Clamp numItems to valid range if pagination is requested
+        const numItems = paginationOpts
+            ? Math.min(Math.max(1, paginationOpts.numItems ?? DEFAULT_NUM_ITEMS), MAX_NUM_ITEMS)
+            : MAX_NUM_ITEMS; // When not paginating, fetch up to max
+        // Build and execute query - choose strategy based on isActive filter
+        let results;
+        if (isActive !== undefined) {
+            // Use by_active index for efficient filtering by active status
+            results = await ctx.db
+                .query("contentTypes")
+                .withIndex("by_active", (q) => q.eq("isActive", isActive))
+                .collect();
+        }
+        else {
+            // Fetch all content types (no filter)
+            results = await ctx.db.query("contentTypes").collect();
+        }
+        // Filter out soft-deleted types unless explicitly requested
+        if (!includeDeleted) {
+            results = results.filter((ct) => !isDeleted(ct));
+        }
+        // Apply sorting based on sortBy parameter
+        if (sortBy === "name") {
+            // Sort alphabetically by name (case-insensitive)
+            results.sort((a, b) => {
+                const nameA = a.name.toLowerCase();
+                const nameB = b.name.toLowerCase();
+                const comparison = nameA.localeCompare(nameB);
+                return resolvedSortDirection === "asc" ? comparison : -comparison;
+            });
+        }
+        else {
+            // Sort by creation time
+            results.sort((a, b) => {
+                const comparison = a._creationTime - b._creationTime;
+                return resolvedSortDirection === "asc" ? comparison : -comparison;
+            });
+        }
+        // Handle cursor-based pagination
+        let startIndex = 0;
+        const cursor = paginationOpts?.cursor;
+        if (cursor) {
+            // Find the index of the cursor in results
+            const cursorIndex = results.findIndex((ct) => ct._id === cursor);
+            if (cursorIndex !== -1) {
+                startIndex = cursorIndex + 1;
+            }
+        }
+        // Get the page of results (fetch one extra to determine if there's more)
+        const pageResults = results.slice(startIndex, startIndex + numItems + 1);
+        const isDone = pageResults.length <= numItems;
+        const page = isDone ? pageResults : pageResults.slice(0, numItems);
+        // Calculate continuation cursor
+        const continueCursor = !isDone && page.length > 0 ? page[page.length - 1]._id : null;
+        return {
+            page,
+            continueCursor,
+            isDone,
+        };
+    },
+});
+//# sourceMappingURL=contentTypes.js.map

package/dist/component/contentTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contentTypes.js","sourceRoot":"","sources":["../../src/component/contentTypes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,eAAe,CAAC;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAC;AACxD,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEjD,gFAAgF;AAChF,YAAY;AACZ,gFAAgF;AAEhF;;GAEG;AACH,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAE7B;;GAEG;AACH,MAAM,aAAa,GAAG,GAAG,CAAC;AAE1B,gFAAgF;AAChF,yBAAyB;AACzB,gFAAgF;AAEhF;;;;;;GAMG;AACH,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACnC,6DAA6D;IAC7D,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,cAAc,CAAC,CAAC;IACpC,wEAAwE;IACxE,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC5B,qEAAqE;IACrE,cAAc,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;CACvC,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,KAAK,CAAC;IACxB,IAAI,EAAE,kBAAkB,CAAC,MAAM;IAC/B,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAC1C,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QAC5B,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,cAAc,GAAG,KAAK,EAAE,GAAG,IAAI,CAAC;QAElD,oDAAoD;QACpD,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,iDAAiD;YACjD,uDAAuD;YACvD,OAAO,IAAI,CAAC;QACb,CAAC;QAED,IAAI,WAAW,CAAC;QAEhB,+CAA+C;QAC/C,IAAI,EAAE,EAAE,CAAC;YACR,WAAW,GAAG,MAAM,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACpC,CAAC;QACD,yCAAyC;aACpC,IAAI,IAAI,EAAE,CAAC;YACf,WAAW,GAAG,MAAM,GAAG,CAAC,EAAE;iBACxB,KAAK,CAAC,cAAc,CAAC;iBACrB,SAAS,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;iBAC/C,KAAK,EAAE,CAAC;QACX,CAAC;QAED,2BAA2B;QAC3B,IAAI,CAAC,WAAW,EAAE,CAAC;YAClB,OAAO,IAAI,CAAC;QACb,CAAC;QAED,4DAA4D;QAC5D,IAAI,CAAC,cAAc,IAAI,SAAS,CAAC,WAAW,CAAC,EAAE,CAAC;YAC/C,OAAO,IAAI,CAAC;QACb,CAAC;QAED,OAAO,WAAW,CAAC;IACpB,CAAC;CACD,CAAC,CAAC;AAEH,gFAAgF;AAChF,2BAA2B;AAC3B,gFAAgF;AAEhF;;GAEG;AACH,MAAM,eAAe,GAAG,CAAC,CAAC,QAAQ,CACjC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAClD,CAAC;AAEF;;GAEG;AACH,MAAM,sBAAsB,GAAG,CAAC,CAAC,QAAQ,CACxC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAC5C,CAAC;AAEF;;GAEG;AACH,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,0FAA0F;IAC1F,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IACjC,qEAAqE;IACrE,cAAc,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IACvC,iGAAiG;IACjG,MAAM,EAAE,eAAe;IACvB,8GAA8G;IAC9G,aAAa,EAAE,sBAAsB;IACrC;;;;OAIG;IACH,cAAc,EAAE,CAAC,CAAC,QAAQ,CAAC,uBAAuB,CAAC;CACnD,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,6BAA6B,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,oDAAoD;IACpD,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC;IAC7B,qFAAqF;IACrF,cAAc,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAC7C,sDAAsD;IACtD,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE;CACnB,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+EG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,KAAK,CAAC;IACzB,IAAI,EAAE,oBAAoB,CAAC,MAAM;IACjC,OAAO,EAAE,6BAA6B;IACtC,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QAC5B,MAAM,EACL,QAAQ,EACR,cAAc,GAAG,KAAK,EACtB,MAAM,GAAG,MAAM,EACf,aAAa,EACb,cAAc,GACd,GAAG,IAAI,CAAC;QAET,yDAAyD;QACzD,sDAAsD;QACtD,gEAAgE;QAChE,MAAM,qBAAqB,GAC1B,aAAa,IAAI,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QAEvD,2DAA2D;QAC3D,MAAM,QAAQ,GAAG,cAAc;YAC9B,CAAC,CAAC,IAAI,CAAC,GAAG,CACR,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,cAAc,CAAC,QAAQ,IAAI,iBAAiB,CAAC,EACzD,aAAa,CACZ;YACH,CAAC,CAAC,aAAa,CAAC,CAAC,uCAAuC;QAEzD,qEAAqE;QACrE,IAAI,OAAO,CAAC;QAEZ,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC5B,+DAA+D;YAC/D,OAAO,GAAG,MAAM,GAAG,CAAC,EAAE;iBACpB,KAAK,CAAC,cAAc,CAAC;iBACrB,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;iBACzD,OAAO,EAAE,CAAC;QACb,CAAC;aAAM,CAAC;YACP,sCAAsC;YACtC,OAAO,GAAG,MAAM,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,OAAO,EAAE,CAAC;QACxD,CAAC;QAED,4DAA4D;QAC5D,IAAI,CAAC,cAAc,EAAE,CAAC;YACrB,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QAClD,CAAC;QAED,0CAA0C;QAC1C,IAAI,MAAM,KAAK,MAAM,EAAE,CAAC;YACvB,iDAAiD;YACjD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;gBACrB,MAAM,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;gBACnC,MAAM,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;gBACnC,MAAM,UAAU,GAAG,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;gBAC9C,OAAO,qBAAqB,KAAK,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;YACnE,CAAC,CAAC,CAAC;QACJ,CAAC;aAAM,CAAC;YACP,wBAAwB;YACxB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;gBACrB,MAAM,UAAU,GAAG,CAAC,CAAC,aAAa,GAAG,CAAC,CAAC,aAAa,CAAC;gBACrD,OAAO,qBAAqB,KAAK,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;YACnE,CAAC,CAAC,CAAC;QACJ,CAAC;QAED,iCAAiC;QACjC,IAAI,UAAU,GAAG,CAAC,CAAC;QACnB,MAAM,MAAM,GAAG,cAAc,EAAE,MAAM,CAAC;QAEtC,IAAI,MAAM,EAAE,CAAC;YACZ,0CAA0C;YAC1C,MAAM,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,KAAK,MAAM,CAAC,CAAC;YACjE,IAAI,WAAW,KAAK,CAAC,CAAC,EAAE,CAAC;gBACxB,UAAU,GAAG,WAAW,GAAG,CAAC,CAAC;YAC9B,CAAC;QACF,CAAC;QAED,yEAAyE;QACzE,MAAM,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC,UAAU,EAAE,UAAU,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC;QACzE,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,IAAI,QAAQ,CAAC;QAC9C,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;QAEnE,gCAAgC;QAChC,MAAM,cAAc,GACnB,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;QAE/D,OAAO;YACN,IAAI;YACJ,cAAc;YACd,MAAM;SACN,CAAC;IACH,CAAC;CACD,CAAC,CAAC"}

package/dist/component/convex.config.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Convex CMS Component
+ *
+ * A developer-first content management system component with:
+ * - Content type definitions with typed fields
+ * - Content versioning and publishing workflows
+ * - Media asset management
+ * - Flexible RBAC
+ * - Built-in AI tools for content management
+ *
+ *
+ * @example
+ * ```typescript
+ * // In your app's convex/convex.config.ts:
+ * import { defineApp } from "convex/server";
+ * import convexCms from "@convex-cms/core/convex.config";
+ *
+ * const app = defineApp();
+ * app.use(convexCms);
+ *
+ * export default app;
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Using the component with configuration:
+ * import { createCmsClient, type ComponentConfig } from "@convex-cms/core";
+ *
+ * const config: ComponentConfig = {
+ *   defaultLocale: "en-US",
+ *   features: {
+ *     versioning: true,
+ *     localization: true,
+ *   },
+ * };
+ *
+ * export const cms = createCmsClient(components.convexCms, config);
+ * ```
+ */
+declare const component: import("convex/server").ComponentDefinition<any>;
+export default component;
+//# sourceMappingURL=convex.config.d.ts.map

package/dist/component/convex.config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"convex.config.d.ts","sourceRoot":"","sources":["../../src/component/convex.config.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,QAAA,MAAM,SAAS,kDAA+B,CAAC;AAE/C,eAAe,SAAS,CAAC"}

package/dist/component/convex.config.js

@@ -0,0 +1,43 @@
+import { defineComponent } from "convex/server";
+/**
+ * Convex CMS Component
+ *
+ * A developer-first content management system component with:
+ * - Content type definitions with typed fields
+ * - Content versioning and publishing workflows
+ * - Media asset management
+ * - Flexible RBAC
+ * - Built-in AI tools for content management
+ *
+ *
+ * @example
+ * ```typescript
+ * // In your app's convex/convex.config.ts:
+ * import { defineApp } from "convex/server";
+ * import convexCms from "@convex-cms/core/convex.config";
+ *
+ * const app = defineApp();
+ * app.use(convexCms);
+ *
+ * export default app;
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Using the component with configuration:
+ * import { createCmsClient, type ComponentConfig } from "@convex-cms/core";
+ *
+ * const config: ComponentConfig = {
+ *   defaultLocale: "en-US",
+ *   features: {
+ *     versioning: true,
+ *     localization: true,
+ *   },
+ * };
+ *
+ * export const cms = createCmsClient(components.convexCms, config);
+ * ```
+ */
+const component = defineComponent("convexCms");
+export default component;
+//# sourceMappingURL=convex.config.js.map

package/dist/component/convex.config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"convex.config.js","sourceRoot":"","sources":["../../src/component/convex.config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAM,SAAS,GAAG,eAAe,CAAC,WAAW,CAAC,CAAC;AAE/C,eAAe,SAAS,CAAC"}

package/dist/component/documentTypes.d.ts

@@ -0,0 +1,186 @@
+/**
+ * Derived TypeScript Types for CMS Documents
+ *
+ * This module provides TypeScript types derived from validators using Convex's `Infer<>`.
+ * These types are the single source of truth for document shapes throughout the codebase.
+ *
+ * Two type variants are provided:
+ * 1. **Internal types** (with `Id<TableName>`) - For use within Convex functions
+ * 2. **Client types** (with `string` IDs) - For use at API boundaries where IDs are serialized
+ *
+ * @example
+ * ```typescript
+ * // Internal use (within Convex functions)
+ * import type { ContentTypeInternal } from "./documentTypes.js";
+ * const type: ContentTypeInternal = await ctx.db.get(id);
+ *
+ * // Client use (API boundary)
+ * import type { ContentType } from "./documentTypes.js";
+ * const type: ContentType = await cms.contentTypes.get(ctx, { id });
+ * ```
+ */
+import type { Infer } from "convex/values";
+import type { GenericId } from "convex/values";
+import * as validators from "./validators.js";
+/**
+ * Recursively converts all `Id<T>` types to `string` for API boundary serialization.
+ * This is used when passing documents from Convex functions to client code,
+ * where Convex IDs are serialized as strings.
+ */
+export type StringifyIds<T> = T extends GenericId<infer _TableName> ? string : T extends (infer U)[] ? StringifyIds<U>[] : T extends Record<string, unknown> ? {
+    [K in keyof T]: StringifyIds<T[K]>;
+} : T;
+/**
+ * Content type document - internal use with typed IDs.
+ */
+export type ContentTypeInternal = Infer<typeof validators.contentTypeDoc>;
+/**
+ * Content entry document - internal use with typed IDs.
+ */
+export type ContentEntryInternal = Infer<typeof validators.contentEntryDoc>;
+/**
+ * Content version document - internal use with typed IDs.
+ */
+export type ContentVersionInternal = Infer<typeof validators.contentVersionDoc>;
+/**
+ * Media item document (unified asset/folder) - internal use with typed IDs.
+ */
+export type MediaItemInternal = Infer<typeof validators.mediaItemDoc>;
+/**
+ * Media asset document - internal use with typed IDs.
+ * Extracts only the asset variant from the MediaItem union.
+ */
+export type MediaAssetInternal = Extract<MediaItemInternal, {
+    kind: "asset";
+}>;
+/**
+ * Media folder document - internal use with typed IDs.
+ * Extracts only the folder variant from the MediaItem union.
+ */
+export type MediaFolderInternal = Extract<MediaItemInternal, {
+    kind: "folder";
+}>;
+/**
+ * Media variant document - internal use with typed IDs.
+ */
+export type MediaVariantInternal = Infer<typeof validators.mediaVariantDoc>;
+/**
+ * Taxonomy document - internal use with typed IDs.
+ */
+export type TaxonomyInternal = Infer<typeof validators.taxonomyDoc>;
+/**
+ * Taxonomy term document - internal use with typed IDs.
+ */
+export type TaxonomyTermInternal = Infer<typeof validators.taxonomyTermDoc>;
+/**
+ * Content entry tag junction - internal use with typed IDs.
+ */
+export type ContentEntryTagInternal = Infer<typeof validators.contentEntryTagDoc>;
+/**
+ * CMS event document - internal use with typed IDs.
+ */
+export type CmsEventInternal = Infer<typeof validators.cmsEventDoc>;
+/**
+ * Trash config document - internal use with typed IDs.
+ */
+export type TrashConfigInternal = Infer<typeof validators.trashConfigDoc>;
+/**
+ * Webhook config document - internal use with typed IDs.
+ */
+export type WebhookConfigInternal = Infer<typeof validators.webhookConfigDoc>;
+/**
+ * Webhook delivery document - internal use with typed IDs.
+ */
+export type WebhookDeliveryInternal = Infer<typeof validators.webhookDeliveryDoc>;
+/**
+ * Content type - client-facing with string IDs.
+ */
+export type ContentType = StringifyIds<ContentTypeInternal>;
+/**
+ * Content entry - client-facing with string IDs.
+ */
+export type ContentEntry = StringifyIds<ContentEntryInternal>;
+/**
+ * Content version - client-facing with string IDs.
+ */
+export type ContentVersion = StringifyIds<ContentVersionInternal>;
+/**
+ * Media item (unified asset/folder) - client-facing with string IDs.
+ */
+export type MediaItem = StringifyIds<MediaItemInternal>;
+/**
+ * Media asset - client-facing with string IDs.
+ * Extracts only the asset variant from the MediaItem union.
+ */
+export type MediaAsset = Extract<MediaItem, {
+    kind: "asset";
+}>;
+/**
+ * Media folder - client-facing with string IDs.
+ * Extracts only the folder variant from the MediaItem union.
+ */
+export type MediaFolder = Extract<MediaItem, {
+    kind: "folder";
+}>;
+/**
+ * Media variant - client-facing with string IDs.
+ */
+export type MediaVariant = StringifyIds<MediaVariantInternal>;
+/**
+ * Taxonomy - client-facing with string IDs.
+ */
+export type Taxonomy = StringifyIds<TaxonomyInternal>;
+/**
+ * Taxonomy term - client-facing with string IDs.
+ */
+export type TaxonomyTerm = StringifyIds<TaxonomyTermInternal>;
+/**
+ * Content entry tag - client-facing with string IDs.
+ */
+export type ContentEntryTag = StringifyIds<ContentEntryTagInternal>;
+/**
+ * CMS event - client-facing with string IDs.
+ */
+export type CmsEvent = StringifyIds<CmsEventInternal>;
+/**
+ * Trash config - client-facing with string IDs.
+ */
+export type TrashConfig = StringifyIds<TrashConfigInternal>;
+/**
+ * Webhook config - client-facing with string IDs.
+ */
+export type WebhookConfig = StringifyIds<WebhookConfigInternal>;
+/**
+ * Webhook delivery - client-facing with string IDs.
+ */
+export type WebhookDelivery = StringifyIds<WebhookDeliveryInternal>;
+/**
+ * Internal field definition type (with typed IDs).
+ */
+export type FieldDefinitionInternal = Infer<typeof validators.fieldDefinitionValidator>;
+/**
+ * Client-facing field definition type (IDs as strings).
+ * Used at the API boundary where Convex IDs are serialized as strings.
+ */
+export type FieldDefinition = StringifyIds<FieldDefinitionInternal>;
+/**
+ * Media variant with resolved URL.
+ */
+export type MediaVariantWithUrl = MediaVariant & {
+    url: string | null;
+};
+/**
+ * Trash item with deletion metadata.
+ */
+export type TrashItem = ContentEntry & {
+    deletedDaysAgo: number;
+    expiresAt?: number;
+    contentTypeName?: string;
+};
+/**
+ * Taxonomy term with children (for hierarchical display).
+ */
+export type TaxonomyTermWithChildren = TaxonomyTerm & {
+    children: TaxonomyTermWithChildren[];
+};
+//# sourceMappingURL=documentTypes.d.ts.map

package/dist/component/documentTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentTypes.d.ts","sourceRoot":"","sources":["../../src/component/documentTypes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAC;AAM9C;;;;GAIG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,CAAC,MAAM,UAAU,CAAC,GAChE,MAAM,GACN,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GACpB,YAAY,CAAC,CAAC,CAAC,EAAE,GACjB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GACtC,CAAC,CAAC;AAMP;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC,OAAO,UAAU,CAAC,cAAc,CAAC,CAAC;AAE1E;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,OAAO,UAAU,CAAC,eAAe,CAAC,CAAC;AAE5E;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,OAAO,UAAU,CAAC,iBAAiB,CAAC,CAAC;AAEhF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,KAAK,CAAC,OAAO,UAAU,CAAC,YAAY,CAAC,CAAC;AAEtE;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,EAAE;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAE/E;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC,iBAAiB,EAAE;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC,CAAC;AAEjF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,OAAO,UAAU,CAAC,eAAe,CAAC,CAAC;AAE5E;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,OAAO,UAAU,CAAC,WAAW,CAAC,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,OAAO,UAAU,CAAC,eAAe,CAAC,CAAC;AAE5E;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAC1C,OAAO,UAAU,CAAC,kBAAkB,CACpC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,OAAO,UAAU,CAAC,WAAW,CAAC,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC,OAAO,UAAU,CAAC,cAAc,CAAC,CAAC;AAE1E;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,KAAK,CAAC,OAAO,UAAU,CAAC,gBAAgB,CAAC,CAAC;AAE9E;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAC1C,OAAO,UAAU,CAAC,kBAAkB,CACpC,CAAC;AAMF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,YAAY,CAAC,mBAAmB,CAAC,CAAC;AAE5D;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,YAAY,CAAC,oBAAoB,CAAC,CAAC;AAE9D;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,YAAY,CAAC,sBAAsB,CAAC,CAAC;AAElE;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,YAAY,CAAC,iBAAiB,CAAC,CAAC;AAExD;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,CAAC,SAAS,EAAE;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAE/D;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,SAAS,EAAE;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,YAAY,CAAC,oBAAoB,CAAC,CAAC;AAE9D;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,YAAY,CAAC,gBAAgB,CAAC,CAAC;AAEtD;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,YAAY,CAAC,oBAAoB,CAAC,CAAC;AAE9D;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,YAAY,CAAC,uBAAuB,CAAC,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,YAAY,CAAC,gBAAgB,CAAC,CAAC;AAEtD;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,YAAY,CAAC,mBAAmB,CAAC,CAAC;AAE5D;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,YAAY,CAAC,qBAAqB,CAAC,CAAC;AAEhE;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,YAAY,CAAC,uBAAuB,CAAC,CAAC;AAMpE;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,OAAO,UAAU,CAAC,wBAAwB,CAAC,CAAC;AAExF;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,YAAY,CAAC,uBAAuB,CAAC,CAAC;AAMpE;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAAG;IAChD,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,YAAY,GAAG;IACtC,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,YAAY,GAAG;IACrD,QAAQ,EAAE,wBAAwB,EAAE,CAAC;CACrC,CAAC"}

package/dist/component/documentTypes.js

@@ -0,0 +1,23 @@
+/**
+ * Derived TypeScript Types for CMS Documents
+ *
+ * This module provides TypeScript types derived from validators using Convex's `Infer<>`.
+ * These types are the single source of truth for document shapes throughout the codebase.
+ *
+ * Two type variants are provided:
+ * 1. **Internal types** (with `Id<TableName>`) - For use within Convex functions
+ * 2. **Client types** (with `string` IDs) - For use at API boundaries where IDs are serialized
+ *
+ * @example
+ * ```typescript
+ * // Internal use (within Convex functions)
+ * import type { ContentTypeInternal } from "./documentTypes.js";
+ * const type: ContentTypeInternal = await ctx.db.get(id);
+ *
+ * // Client use (API boundary)
+ * import type { ContentType } from "./documentTypes.js";
+ * const type: ContentType = await cms.contentTypes.get(ctx, { id });
+ * ```
+ */
+export {};
+//# sourceMappingURL=documentTypes.js.map

package/dist/component/documentTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentTypes.js","sourceRoot":"","sources":["../../src/component/documentTypes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG"}