convex-cms 0.0.16 → 0.0.17

package/admin/dist/types/src/client/schema/defineContentType.d.ts

@@ -1,233 +0,0 @@
-/**
- * Content Type Schema Definition
- *
- * The `defineContentType` function creates type-safe content type definitions
- * using Convex validators. Types are automatically inferred via Convex's
- * native `Infer<typeof validator>` pattern.
- *
- * 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", // → 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(),
- *     content: v.string(),
- *   }),
- *   meta: {
- *     displayName: "Blog Post",
- *     titleField: "title",
- *   },
- * });
- * ```
- */
-import type { CmsObjectValidator, ContentTypeConfig, ContentTypeDefinition } from "./types.js";
-import { type ToSlugType } from "../utils/toSlug.js";
-/**
- * Creates a type-safe content type definition.
- *
- * This function accepts a Convex validator and CMS metadata, returning a
- * definition object that can be used for:
- * 1. **Type inference**: `Infer<typeof definition.validator>` gives the data type
- * 2. **Runtime validation**: The validator is used to validate content at runtime
- * 3. **Admin UI configuration**: Metadata provides display hints and field labels
- *
- * ## Why Convex Validators?
- *
- * Using Convex validators directly (instead of custom schema builders) provides:
- * - **Native type inference** via `Infer<typeof>` - no custom type machinery
- * - **Familiarity** - same validators used in Convex functions
- * - **Full power** - supports unions, literals, nested objects, arrays, IDs
- * - **Maintenance-free** - types are maintained by Convex
- *
- * ## Example: Basic Blog Post
- *
- * ```typescript
- * import { v, Infer } from "convex/values";
- * import { defineContentType } from "convex-cms";
- *
- * export const blogPost = defineContentType({
- *   name: "Blog Post", // Display name → auto-converted to slug "blog_post"
- *   validator: v.object({
- *     title: v.string(),
- *     content: v.string(),
- *     publishedAt: v.optional(v.number()),
- *   }),
- *   meta: {
- *     displayName: "Blog Post",
- *     titleField: "title",
- *   },
- * });
- *
- * // Type is automatically inferred
- * type BlogPostData = Infer<typeof blogPost.validator>;
- * // { title: string; content: string; publishedAt?: number }
- * ```
- *
- * ## Example: Product with Variants
- *
- * ```typescript
- * export const product = defineContentType({
- *   name: "Product",
- *   validator: v.object({
- *     name: v.string(),
- *     price: v.number(),
- *     description: v.optional(v.string()),
- *     variants: v.array(v.object({
- *       sku: v.string(),
- *       name: v.string(),
- *       price: v.number(),
- *       attributes: v.record(v.string(), v.string()),
- *     })),
- *     seo: v.optional(v.object({
- *       title: v.string(),
- *       description: v.string(),
- *       keywords: v.array(v.string()),
- *     })),
- *   }),
- *   meta: {
- *     displayName: "Product",
- *     titleField: "name",
- *     fields: {
- *       name: { label: "Product Name", searchable: true },
- *       price: { label: "Base Price" },
- *       variants: { label: "Variants", renderAs: "json" },
- *       seo: { label: "SEO Settings", renderAs: "json" },
- *     },
- *   },
- * });
- * ```
- *
- * @param config - The content type configuration
- * @returns A frozen content type definition object
- *
- * @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 CmsObjectValidator>(config: ContentTypeConfig<TValidator> & {
-    name: TName;
-}): ContentTypeDefinition<ToSlugType<TName>, TValidator>;
-/**
- * Creates a content schema from multiple content type definitions.
- *
- * This is a convenience function that validates the schema and provides
- * runtime utilities for working with multiple content types.
- *
- * @example
- * ```typescript
- * import { createContentSchema } from "convex-cms";
- *
- * export const contentSchema = createContentSchema({
- *   blogPost,
- *   author,
- *   product,
- * });
- *
- * // Get a specific definition
- * const blogDef = contentSchema.getDefinition("blog_post");
- *
- * // List all content type names
- * const names = contentSchema.getContentTypeNames();
- * // ["blog_post", "author", "product"]
- * ```
- *
- * @param definitions - An object containing content type definitions
- * @returns A schema object with utility methods
- */
-export declare function createContentSchema<T extends Record<string, ContentTypeDefinition>>(definitions: T): ContentSchemaInstance<T>;
-/**
- * A content schema instance with utility methods.
- */
-export interface ContentSchemaInstance<T extends Record<string, ContentTypeDefinition>> {
-    /**
-     * The raw definitions object.
-     */
-    readonly definitions: T;
-    /**
-     * Get a content type definition by its slug.
-     *
-     * @param slug - The content type slug (e.g., "blog_post")
-     * @returns The definition or undefined if not found
-     */
-    getDefinition(slug: string): ContentTypeDefinition | undefined;
-    /**
-     * Get all content type slugs in the schema.
-     *
-     * @returns Array of content type slugs
-     */
-    getContentTypeNames(): string[];
-    /**
-     * Check if a content type exists in the schema.
-     *
-     * @param slug - The content type slug to check
-     * @returns true if the content type exists
-     */
-    hasContentType(slug: string): boolean;
-    /**
-     * Get a content type definition by its key in the definitions object.
-     *
-     * @param key - The key used in the definitions object
-     * @returns The definition
-     */
-    getDefinitionByKey<K extends keyof T>(key: K): T[K];
-}
-/**
- * Field definition format expected by the CMS database.
- * This is the format stored in contentTypes.fields.
- */
-export interface DatabaseFieldDefinition {
-    name: string;
-    label: string;
-    type: string;
-    required: boolean;
-    searchable?: boolean;
-    localized?: boolean;
-    description?: string;
-    defaultValue?: unknown;
-    options?: Record<string, unknown>;
-    group?: string;
-}
-/**
- * Converts a content type definition to the database field format.
- *
- * This bridges the gap between the code-defined schema and the
- * database format used by the CMS component.
- *
- * @param definition - The content type definition
- * @returns An array of field definitions for the database
- *
- * @example
- * ```typescript
- * const fields = toFieldDefinitions(blogPost);
- * // [
- * //   { name: "title", label: "Title", type: "text", required: true, ... },
- * //   { name: "content", label: "Content", type: "richText", required: true, ... },
- * // ]
- * ```
- */
-export declare function toFieldDefinitions(definition: ContentTypeDefinition): DatabaseFieldDefinition[];
-//# sourceMappingURL=defineContentType.d.ts.map

package/admin/dist/types/src/client/schema/defineContentType.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"defineContentType.d.ts","sourceRoot":"","sources":["../../../../../../src/client/schema/defineContentType.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AAEH,OAAO,KAAK,EACV,kBAAkB,EAClB,iBAAiB,EACjB,qBAAqB,EAGtB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAuB,KAAK,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAuC1E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgFG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,CAAC,KAAK,SAAS,MAAM,EAC1B,UAAU,SAAS,kBAAkB,EAErC,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;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,kBAAkB,CAChC,UAAU,EAAE,qBAAqB,GAChC,uBAAuB,EAAE,CA2C3B"}