convex-cms 0.0.6 → 0.0.7

package/dist/client/registry.d.ts

@@ -0,0 +1,77 @@
+/**
+ * In-Memory Type Registry for Code-Defined Content Types
+ *
+ * This registry stores content type definitions in memory, enabling the
+ * "no-sync" architecture where code-defined types don't need database records.
+ *
+ * Key concepts:
+ * - Code-defined types live here (registered via `defineContentType`)
+ * - DB-defined types live in the `contentTypes` table
+ * - Lookup by slug checks code first, then DB
+ *
+ * @example
+ * ```typescript
+ * import { registerContentType, getCodeDefinedType } from "./registry";
+ *
+ * // Register a content type (done automatically by defineContentType)
+ * registerContentType(blogPostDefinition);
+ *
+ * // Look up a type by slug
+ * const def = getCodeDefinedType("blog_post");
+ * if (def) {
+ *   console.log(def.meta.displayName); // "Blog Post"
+ *   console.log(def.slug);             // "blog_post"
+ * }
+ * ```
+ */
+import type { ContentTypeDefinition } from "./schema/types.js";
+/**
+ * Register a content type definition in the in-memory registry.
+ *
+ * This is called automatically by `defineContentType` when `register: true`
+ * is passed (the default). You typically don't need to call this directly.
+ *
+ * @param definition - The content type definition to register
+ * @throws Error if a type with the same slug is already registered
+ */
+export declare function registerContentType(definition: ContentTypeDefinition): void;
+/**
+ * Get a code-defined content type by slug.
+ *
+ * @param slug - The content type slug (e.g., "blog_post")
+ * @returns The definition, or null if not found in the code registry
+ */
+export declare function getCodeDefinedType(slug: string): ContentTypeDefinition | null;
+/**
+ * Get all code-defined content types.
+ *
+ * @returns Array of all registered content type definitions
+ */
+export declare function getAllCodeDefinedTypes(): ContentTypeDefinition[];
+/**
+ * Get all code-defined content type slugs.
+ *
+ * @returns Array of registered content type slugs
+ */
+export declare function getCodeDefinedTypeNames(): string[];
+/**
+ * Check if a content type slug is registered in code.
+ *
+ * @param slug - The content type slug to check
+ * @returns true if the type is code-defined
+ */
+export declare function isCodeDefinedType(slug: string): boolean;
+/**
+ * Clear all registered content types.
+ *
+ * **Warning**: This is primarily for testing. In production, content types
+ * are registered at module load time and should remain stable.
+ */
+export declare function clearRegistry(): void;
+/**
+ * Get the count of registered content types.
+ *
+ * @returns Number of code-defined content types
+ */
+export declare function getRegistrySize(): number;
+//# sourceMappingURL=registry.d.ts.map

package/dist/client/registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../src/client/registry.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAI/D;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,qBAAqB,GAAG,IAAI,CAQ3E;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,IAAI,CAE7E;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,IAAI,qBAAqB,EAAE,CAEhE;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,IAAI,MAAM,EAAE,CAElD;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEvD;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,IAAI,IAAI,CAEpC;AAED;;;;GAIG;AACH,wBAAgB,eAAe,IAAI,MAAM,CAExC"}

package/dist/client/registry.js

@@ -0,0 +1,95 @@
+/**
+ * In-Memory Type Registry for Code-Defined Content Types
+ *
+ * This registry stores content type definitions in memory, enabling the
+ * "no-sync" architecture where code-defined types don't need database records.
+ *
+ * Key concepts:
+ * - Code-defined types live here (registered via `defineContentType`)
+ * - DB-defined types live in the `contentTypes` table
+ * - Lookup by slug checks code first, then DB
+ *
+ * @example
+ * ```typescript
+ * import { registerContentType, getCodeDefinedType } from "./registry";
+ *
+ * // Register a content type (done automatically by defineContentType)
+ * registerContentType(blogPostDefinition);
+ *
+ * // Look up a type by slug
+ * const def = getCodeDefinedType("blog_post");
+ * if (def) {
+ *   console.log(def.meta.displayName); // "Blog Post"
+ *   console.log(def.slug);             // "blog_post"
+ * }
+ * ```
+ */
+const codeDefinedTypes = new Map();
+/**
+ * Register a content type definition in the in-memory registry.
+ *
+ * This is called automatically by `defineContentType` when `register: true`
+ * is passed (the default). You typically don't need to call this directly.
+ *
+ * @param definition - The content type definition to register
+ * @throws Error if a type with the same slug is already registered
+ */
+export function registerContentType(definition) {
+    if (codeDefinedTypes.has(definition.slug)) {
+        throw new Error(`Content type "${definition.slug}" is already registered. ` +
+            `Content type slugs must be unique across all code-defined types.`);
+    }
+    codeDefinedTypes.set(definition.slug, definition);
+}
+/**
+ * Get a code-defined content type by slug.
+ *
+ * @param slug - The content type slug (e.g., "blog_post")
+ * @returns The definition, or null if not found in the code registry
+ */
+export function getCodeDefinedType(slug) {
+    return codeDefinedTypes.get(slug) ?? null;
+}
+/**
+ * Get all code-defined content types.
+ *
+ * @returns Array of all registered content type definitions
+ */
+export function getAllCodeDefinedTypes() {
+    return Array.from(codeDefinedTypes.values());
+}
+/**
+ * Get all code-defined content type slugs.
+ *
+ * @returns Array of registered content type slugs
+ */
+export function getCodeDefinedTypeNames() {
+    return Array.from(codeDefinedTypes.keys());
+}
+/**
+ * Check if a content type slug is registered in code.
+ *
+ * @param slug - The content type slug to check
+ * @returns true if the type is code-defined
+ */
+export function isCodeDefinedType(slug) {
+    return codeDefinedTypes.has(slug);
+}
+/**
+ * Clear all registered content types.
+ *
+ * **Warning**: This is primarily for testing. In production, content types
+ * are registered at module load time and should remain stable.
+ */
+export function clearRegistry() {
+    codeDefinedTypes.clear();
+}
+/**
+ * Get the count of registered content types.
+ *
+ * @returns Number of code-defined content types
+ */
+export function getRegistrySize() {
+    return codeDefinedTypes.size;
+}
+//# sourceMappingURL=registry.js.map

package/dist/client/registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.js","sourceRoot":"","sources":["../../src/client/registry.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAIH,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAiC,CAAC;AAElE;;;;;;;;GAQG;AACH,MAAM,UAAU,mBAAmB,CAAC,UAAiC;IACnE,IAAI,gBAAgB,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1C,MAAM,IAAI,KAAK,CACb,iBAAiB,UAAU,CAAC,IAAI,2BAA2B;YACzD,kEAAkE,CACrE,CAAC;IACJ,CAAC;IACD,gBAAgB,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;AACpD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAY;IAC7C,OAAO,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;AAC5C,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,sBAAsB;IACpC,OAAO,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC,CAAC;AAC/C,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uBAAuB;IACrC,OAAO,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,IAAY;IAC5C,OAAO,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AACpC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa;IAC3B,gBAAgB,CAAC,KAAK,EAAE,CAAC;AAC3B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe;IAC7B,OAAO,gBAAgB,CAAC,IAAI,CAAC;AAC/B,CAAC"}

package/dist/client/schema/defineContentType.d.ts

@@ -5,37 +5,49 @@
  * using Convex validators. Types are automatically inferred via Convex's
  * native `Infer<typeof validator>` pattern.
  *
- * @example
+ * You can use either display names ("Blog Post") or slug format ("blog_post"):
+ * - Display names are automatically converted to slugs
+ * - Slugs are used for queries and code references
+ *
+ * @example Using a display name (recommended)
  * ```typescript
  * import { v } from "convex/values";
  * import { defineContentType } from "convex-cms";
  *
  * export const blogPost = defineContentType({
- *   name: "blog_post",
+ *   name: "Blog Post", // → slug: "blog_post"
+ *   validator: v.object({
+ *     title: v.string(),
+ *     content: v.string(),
+ *   }),
+ *   meta: {
+ *     displayName: "Blog Post",
+ *     titleField: "title",
+ *   },
+ * });
+ *
+ * // blogPost.slug === "blog_post"
+ * // blogPost.name === "Blog Post"
+ * ```
+ *
+ * @example Using slug format directly
+ * ```typescript
+ * export const blogPost = defineContentType({
+ *   name: "blog_post", // Already a valid slug
  *   validator: v.object({
  *     title: v.string(),
- *     slug: v.string(),
  *     content: v.string(),
- *     author: v.id("contentEntries"),
- *     category: v.optional(v.union(v.literal("tech"), v.literal("news"))),
- *     publishedAt: v.optional(v.number()),
  *   }),
  *   meta: {
  *     displayName: "Blog Post",
  *     titleField: "title",
- *     slugField: "slug",
- *     fields: {
- *       title: { label: "Title", maxLength: 200 },
- *       content: { label: "Content", renderAs: "richText", searchable: true },
- *       author: { label: "Author", renderAs: "reference" },
- *       category: { label: "Category", renderAs: "select" },
- *     },
  *   },
  * });
  * ```
  */
 import type { Validator } from "convex/values";
 import type { ContentTypeConfig, ContentTypeDefinition } from "./types.js";
+import { type ToSlugType } from "../utils/toSlug.js";
 /**
  * Creates a type-safe content type definition.
  *
@@ -60,7 +72,7 @@ import type { ContentTypeConfig, ContentTypeDefinition } from "./types.js";
  * import { defineContentType } from "convex-cms";
  *
  * export const blogPost = defineContentType({
- *   name: "blog_post",
+ *   name: "Blog Post", // Display name → auto-converted to slug "blog_post"
  *   validator: v.object({
  *     title: v.string(),
  *     content: v.string(),
@@ -81,7 +93,7 @@ import type { ContentTypeConfig, ContentTypeDefinition } from "./types.js";
  *
  * ```typescript
  * export const product = defineContentType({
- *   name: "product",
+ *   name: "Product",
  *   validator: v.object({
  *     name: v.string(),
  *     price: v.number(),
@@ -114,12 +126,12 @@ import type { ContentTypeConfig, ContentTypeDefinition } from "./types.js";
  * @param config - The content type configuration
  * @returns A frozen content type definition object
  *
- * @typeParam TName - The literal string type of the content type name
+ * @typeParam TName - The literal string type of the content type name (display or slug)
  * @typeParam TValidator - The Convex validator type
  */
 export declare function defineContentType<const TName extends string, TValidator extends Validator<Record<string, unknown>, "required", string>>(config: ContentTypeConfig<TValidator> & {
     name: TName;
-}): ContentTypeDefinition<TName, TValidator>;
+}): ContentTypeDefinition<ToSlugType<TName>, TValidator>;
 /**
  * Creates a content schema from multiple content type definitions.
  *
@@ -157,25 +169,25 @@ export interface ContentSchemaInstance<T extends Record<string, ContentTypeDefin
      */
     readonly definitions: T;
     /**
-     * Get a content type definition by its name.
+     * Get a content type definition by its slug.
      *
-     * @param name - The content type name (e.g., "blog_post")
+     * @param slug - The content type slug (e.g., "blog_post")
      * @returns The definition or undefined if not found
      */
-    getDefinition(name: string): ContentTypeDefinition | undefined;
+    getDefinition(slug: string): ContentTypeDefinition | undefined;
     /**
-     * Get all content type names in the schema.
+     * Get all content type slugs in the schema.
      *
-     * @returns Array of content type names
+     * @returns Array of content type slugs
      */
     getContentTypeNames(): string[];
     /**
      * Check if a content type exists in the schema.
      *
-     * @param name - The content type name to check
+     * @param slug - The content type slug to check
      * @returns true if the content type exists
      */
-    hasContentType(name: string): boolean;
+    hasContentType(slug: string): boolean;
     /**
      * Get a content type definition by its key in the definitions object.
      *

package/dist/client/schema/defineContentType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"defineContentType.d.ts","sourceRoot":"","sources":["../../../src/client/schema/defineContentType.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,KAAK,EACV,iBAAiB,EACjB,qBAAqB,EAGtB,MAAM,YAAY,CAAC;AAsCpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgFG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,CAAC,KAAK,SAAS,MAAM,EAC1B,UAAU,SAAS,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,EAEzE,MAAM,EAAE,iBAAiB,CAAC,UAAU,CAAC,GAAG;IAAE,IAAI,EAAE,KAAK,CAAA;CAAE,GACtD,qBAAqB,CAAC,KAAK,EAAE,UAAU,CAAC,CAc1C;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,mBAAmB,CACjC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,EAC/C,WAAW,EAAE,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAmC1C;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB,CACpC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC;IAE/C;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;IAExB;;;;;OAKG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS,CAAC;IAE/D;;;;OAIG;IACH,mBAAmB,IAAI,MAAM,EAAE,CAAC;IAEhC;;;;;OAKG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IAEtC;;;;;OAKG;IACH,kBAAkB,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;CACrD;AAMD;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,kBAAkB,CAChC,UAAU,EAAE,qBAAqB,GAChC,uBAAuB,EAAE,CAoB3B"}
+{"version":3,"file":"defineContentType.d.ts","sourceRoot":"","sources":["../../../src/client/schema/defineContentType.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,KAAK,EACV,iBAAiB,EACjB,qBAAqB,EAGtB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAuB,KAAK,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAsC1E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgFG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,CAAC,KAAK,SAAS,MAAM,EAC1B,UAAU,SAAS,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,EAEzE,MAAM,EAAE,iBAAiB,CAAC,UAAU,CAAC,GAAG;IAAE,IAAI,EAAE,KAAK,CAAA;CAAE,GACtD,qBAAqB,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC,CAiCtD;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,mBAAmB,CACjC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,EAC/C,WAAW,EAAE,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAmC1C;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB,CACpC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC;IAE/C;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;IAExB;;;;;OAKG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS,CAAC;IAE/D;;;;OAIG;IACH,mBAAmB,IAAI,MAAM,EAAE,CAAC;IAEhC;;;;;OAKG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IAEtC;;;;;OAKG;IACH,kBAAkB,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;CACrD;AAMD;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,kBAAkB,CAChC,UAAU,EAAE,qBAAqB,GAChC,uBAAuB,EAAE,CAsB3B"}