convex-cms 0.0.1

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

@@ -0,0 +1,401 @@
+/**
+ * Schema-Aware Typed CMS Client
+ *
+ * This module provides type-safe access to content entries when a schema
+ * is configured. The types are inferred from the Convex validators defined
+ * in the schema.
+ *
+ * @example
+ * ```typescript
+ * import { v } from "convex/values";
+ * import { defineContentType, createContentSchema, createTypedCmsClient } from "@convex-cms/core";
+ * import { components } from "./_generated/api";
+ *
+ * // Define content types with validators
+ * const blogPost = defineContentType({
+ *   name: "blog_post",
+ *   validator: v.object({ title: v.string(), content: v.string() }),
+ *   meta: { displayName: "Blog Post" },
+ * });
+ *
+ * const contentSchema = createContentSchema({ blogPost });
+ *
+ * // Create a typed CMS client
+ * export const cms = createTypedCmsClient(components.convexCms, {
+ *   schema: contentSchema,
+ * });
+ *
+ * // Now methods return typed data
+ * const post = await cms.contentEntries.get<"blog_post">(ctx, id);
+ * post.data.title    // ✅ string - TypeScript knows the type
+ * post.data.typo     // ❌ Error: Property 'typo' does not exist
+ * ```
+ */
+import type { ContentTypeDefinition, InferSchema, SchemaContentTypeNames } from "./types.js";
+import type { ContentEntry, ContentStatus, PaginationOpts } from "../types.js";
+import type { ContentSchemaInstance } from "./defineContentType.js";
+import type { ConvexContext } from "../wrapper.js";
+/**
+ * A content entry with typed data based on the schema.
+ *
+ * @typeParam TData - The inferred data type from the content type's validator
+ */
+export interface TypedContentEntry<TData extends Record<string, unknown>> extends Omit<ContentEntry, "data"> {
+    /**
+     * The content data with full type inference.
+     */
+    data: TData;
+}
+/**
+ * A paginated result with typed content entries.
+ */
+export interface TypedPaginationResult<TData extends Record<string, unknown>> {
+    page: TypedContentEntry<TData>[];
+    continueCursor: string | null;
+    isDone: boolean;
+}
+/**
+ * Extract the data type for a content type name from a schema.
+ */
+export type SchemaDataType<TSchema extends ContentSchemaInstance<Record<string, ContentTypeDefinition>>, TName extends string> = TSchema extends ContentSchemaInstance<infer TDefs> ? TName extends keyof InferSchema<TDefs> ? InferSchema<TDefs>[TName] extends Record<string, unknown> ? InferSchema<TDefs>[TName] : Record<string, unknown> : Record<string, unknown> : Record<string, unknown>;
+/**
+ * Extract all valid content type names from a schema.
+ */
+export type ValidContentTypeName<TSchema extends ContentSchemaInstance<Record<string, ContentTypeDefinition>>> = TSchema extends ContentSchemaInstance<infer TDefs> ? SchemaContentTypeNames<TDefs> : string;
+/**
+ * Typed content entries API methods.
+ *
+ * These methods provide full type inference for content data when a schema
+ * is configured.
+ *
+ * @typeParam TSchema - The content schema instance type
+ */
+export interface TypedContentEntriesApi<TSchema extends ContentSchemaInstance<Record<string, ContentTypeDefinition>>> {
+    /**
+     * Get a content entry by ID with typed data.
+     *
+     * @param ctx - Convex context
+     * @param id - The content entry ID
+     * @returns The entry with typed data, or null if not found
+     *
+     * @example
+     * ```typescript
+     * const post = await cms.contentEntries.get<"blog_post">(ctx, id);
+     * if (post) {
+     *   console.log(post.data.title);  // ✅ TypeScript knows title is string
+     * }
+     * ```
+     */
+    get<TName extends ValidContentTypeName<TSchema>>(ctx: ConvexContext, id: string): Promise<TypedContentEntry<SchemaDataType<TSchema, TName>> | null>;
+    /**
+     * Get a content entry by slug with typed data.
+     *
+     * @param ctx - Convex context
+     * @param options - Query options including contentTypeName and slug
+     * @returns The entry with typed data, or null if not found
+     */
+    getBySlug<TName extends ValidContentTypeName<TSchema>>(ctx: ConvexContext, options: {
+        contentTypeName: TName;
+        slug: string;
+        locale?: string;
+        status?: ContentStatus | ContentStatus[];
+    }): Promise<TypedContentEntry<SchemaDataType<TSchema, TName>> | null>;
+    /**
+     * Create a new content entry with typed data.
+     *
+     * @param ctx - Convex context
+     * @param options - Creation options including typed data
+     * @returns The created entry with typed data
+     *
+     * @example
+     * ```typescript
+     * const post = await cms.contentEntries.create<"blog_post">(ctx, {
+     *   contentTypeName: "blog_post",
+     *   data: {
+     *     title: "Hello World",  // ✅ TypeScript validates this
+     *     typo: "oops",          // ❌ Error: 'typo' does not exist
+     *   },
+     * });
+     * ```
+     */
+    create<TName extends ValidContentTypeName<TSchema>>(ctx: ConvexContext, options: TypedCreateEntryOptions<TSchema, TName>): Promise<TypedContentEntry<SchemaDataType<TSchema, TName>>>;
+    /**
+     * Update an existing content entry with typed data.
+     *
+     * @param ctx - Convex context
+     * @param options - Update options including partial typed data
+     * @returns The updated entry with typed data
+     */
+    update<TName extends ValidContentTypeName<TSchema>>(ctx: ConvexContext, options: TypedUpdateEntryOptions<TSchema, TName>): Promise<TypedContentEntry<SchemaDataType<TSchema, TName>>>;
+    /**
+     * List content entries with typed data.
+     *
+     * @param ctx - Convex context
+     * @param options - List options
+     * @returns Paginated results with typed entries
+     */
+    list<TName extends ValidContentTypeName<TSchema>>(ctx: ConvexContext, options: TypedListEntriesOptions<TName>): Promise<TypedPaginationResult<SchemaDataType<TSchema, TName>>>;
+}
+/**
+ * Options for creating a content entry with typed data.
+ */
+export interface TypedCreateEntryOptions<TSchema extends ContentSchemaInstance<Record<string, ContentTypeDefinition>>, TName extends ValidContentTypeName<TSchema>> {
+    /**
+     * The content type name (must match a type in the schema).
+     */
+    contentTypeName: TName;
+    /**
+     * The content data (fully typed based on the content type's validator).
+     */
+    data: SchemaDataType<TSchema, TName>;
+    /**
+     * Optional slug (auto-generated if not provided).
+     */
+    slug?: string;
+    /**
+     * Optional locale for localized content.
+     */
+    locale?: string;
+    /**
+     * User ID of the creator.
+     */
+    createdBy?: string;
+}
+/**
+ * Options for updating a content entry with typed data.
+ */
+export interface TypedUpdateEntryOptions<TSchema extends ContentSchemaInstance<Record<string, ContentTypeDefinition>>, TName extends ValidContentTypeName<TSchema>> {
+    /**
+     * The content entry ID.
+     */
+    id: string;
+    /**
+     * Partial content data (typed based on the content type).
+     */
+    data?: Partial<SchemaDataType<TSchema, TName>>;
+    /**
+     * Optional updated slug.
+     */
+    slug?: string;
+    /**
+     * User ID of the updater.
+     */
+    updatedBy?: string;
+}
+/**
+ * Options for listing content entries with typed results.
+ */
+export interface TypedListEntriesOptions<TName extends string> {
+    /**
+     * Filter by content type name.
+     */
+    contentTypeName?: TName;
+    /**
+     * Filter by status.
+     */
+    status?: ContentStatus;
+    /**
+     * Filter by multiple statuses.
+     */
+    statusIn?: ContentStatus[];
+    /**
+     * Filter by locale.
+     */
+    locale?: string;
+    /**
+     * Search query.
+     */
+    search?: string;
+    /**
+     * Include soft-deleted entries.
+     */
+    includeDeleted?: boolean;
+    /**
+     * Pagination options.
+     */
+    paginationOpts: PaginationOpts;
+}
+/**
+ * Helper type to check if a schema has a specific content type.
+ */
+export type HasContentType<TSchema extends ContentSchemaInstance<Record<string, ContentTypeDefinition>>, TName extends string> = TName extends ValidContentTypeName<TSchema> ? true : false;
+/**
+ * Utility type to get the definition for a specific content type.
+ */
+export type GetContentTypeDefinition<TSchema extends ContentSchemaInstance<Record<string, ContentTypeDefinition>>, TName extends string> = TSchema extends ContentSchemaInstance<infer TDefs> ? {
+    [K in keyof TDefs]: TDefs[K] extends ContentTypeDefinition<TName, infer _V> ? TDefs[K] : never;
+}[keyof TDefs] : never;
+import type { ComponentConfig } from "../types.js";
+import type { TypedComponentApi, CmsClient } from "../wrapper.js";
+/**
+ * Configuration for creating a typed CMS client.
+ */
+export interface TypedCmsClientConfig<TSchema extends ContentSchemaInstance<Record<string, ContentTypeDefinition>>> extends ComponentConfig {
+    /**
+     * The content schema instance containing type definitions.
+     * Created using `createContentSchema()`.
+     */
+    schema: TSchema;
+}
+/**
+ * A typed CMS client with schema-aware content entry methods.
+ *
+ * @typeParam TSchema - The content schema instance type
+ */
+export interface TypedCmsClient<TSchema extends ContentSchemaInstance<Record<string, ContentTypeDefinition>>> extends CmsClient {
+    /**
+     * The content schema configured for this client.
+     */
+    readonly schema: TSchema;
+    /**
+     * Typed content entries API with methods that return properly typed data.
+     */
+    readonly typedContentEntries: TypedContentEntriesApiImpl<TSchema>;
+}
+/**
+ * Implementation of typed content entries API.
+ *
+ * This provides typed wrappers around the base content entries API that
+ * cast results to the appropriate types based on the schema.
+ *
+ * @typeParam TSchema - The content schema instance type
+ */
+export declare class TypedContentEntriesApiImpl<TSchema extends ContentSchemaInstance<Record<string, ContentTypeDefinition>>> {
+    private baseClient;
+    private schema;
+    constructor(baseClient: CmsClient, schema: TSchema);
+    /**
+     * Get a content entry by ID with typed data.
+     *
+     * @param ctx - Convex context
+     * @param id - The content entry ID
+     * @returns The entry with typed data, or null if not found
+     *
+     * @example
+     * ```typescript
+     * const post = await cms.typedContentEntries.get<"blog_post">(ctx, id);
+     * if (post) {
+     *   console.log(post.data.title);  // ✅ TypeScript knows title is string
+     * }
+     * ```
+     */
+    get<TName extends ValidContentTypeName<TSchema>>(ctx: ConvexContext, id: string): Promise<TypedContentEntry<SchemaDataType<TSchema, TName>> | null>;
+    /**
+     * Get a content entry by slug with typed data.
+     *
+     * @param ctx - Convex context
+     * @param options - Query options including contentTypeName and slug
+     * @returns The entry with typed data, or null if not found
+     */
+    getBySlug<TName extends ValidContentTypeName<TSchema>>(ctx: ConvexContext, options: {
+        contentTypeName: TName;
+        slug: string;
+        locale?: string;
+    }): Promise<TypedContentEntry<SchemaDataType<TSchema, TName>> | null>;
+    /**
+     * Create a new content entry with typed data.
+     *
+     * @param ctx - Convex context
+     * @param options - Creation options including typed data
+     * @returns The created entry with typed data
+     *
+     * @example
+     * ```typescript
+     * const post = await cms.typedContentEntries.create<"blog_post">(ctx, {
+     *   contentTypeName: "blog_post",
+     *   data: {
+     *     title: "Hello World",  // ✅ TypeScript validates this
+     *     content: "...",
+     *   },
+     * });
+     * ```
+     */
+    create<TName extends ValidContentTypeName<TSchema>>(ctx: ConvexContext, options: TypedCreateEntryOptions<TSchema, TName>): Promise<TypedContentEntry<SchemaDataType<TSchema, TName>>>;
+    /**
+     * Update an existing content entry with typed data.
+     *
+     * @param ctx - Convex context
+     * @param options - Update options including partial typed data
+     * @returns The updated entry with typed data
+     */
+    update<TName extends ValidContentTypeName<TSchema>>(ctx: ConvexContext, options: TypedUpdateEntryOptions<TSchema, TName>): Promise<TypedContentEntry<SchemaDataType<TSchema, TName>>>;
+    /**
+     * List content entries with typed data.
+     *
+     * @param ctx - Convex context
+     * @param options - List options
+     * @returns Paginated results with typed entries
+     */
+    list<TName extends ValidContentTypeName<TSchema>>(ctx: ConvexContext, options: TypedListEntriesOptions<TName>): Promise<TypedPaginationResult<SchemaDataType<TSchema, TName>>>;
+    /**
+     * Publish a content entry.
+     *
+     * @param ctx - Convex context
+     * @param id - The entry ID to publish
+     * @param updatedBy - Optional user ID who triggered the publish
+     * @returns The published entry with typed data
+     */
+    publish<TName extends ValidContentTypeName<TSchema>>(ctx: ConvexContext, id: string, updatedBy?: string): Promise<TypedContentEntry<SchemaDataType<TSchema, TName>>>;
+    /**
+     * Unpublish a content entry.
+     *
+     * @param ctx - Convex context
+     * @param id - The entry ID to unpublish
+     * @param updatedBy - Optional user ID who triggered the unpublish
+     * @returns The unpublished entry with typed data
+     */
+    unpublish<TName extends ValidContentTypeName<TSchema>>(ctx: ConvexContext, id: string, updatedBy?: string): Promise<TypedContentEntry<SchemaDataType<TSchema, TName>>>;
+    /**
+     * Get the schema configured for this typed client.
+     */
+    getSchema(): TSchema;
+    /**
+     * Validate that a content type exists in the schema.
+     *
+     * @param name - The content type name to validate
+     * @returns true if the content type exists
+     */
+    hasContentType(name: string): boolean;
+}
+/**
+ * Creates a typed CMS client with schema-aware content entry methods.
+ *
+ * This is the main entry point for using type-safe content operations.
+ * The returned client extends the base `CmsClient` with additional
+ * `typedContentEntries` methods that provide full TypeScript inference.
+ *
+ * @param componentApi - The component API from `components.convexCms`
+ * @param config - Configuration including the content schema
+ * @returns A typed CMS client instance
+ *
+ * @example
+ * ```typescript
+ * import { v } from "convex/values";
+ * import { defineContentType, createContentSchema, createTypedCmsClient } from "@convex-cms/core";
+ * import { components } from "./_generated/api";
+ *
+ * // Define content types
+ * const blogPost = defineContentType({
+ *   name: "blog_post",
+ *   validator: v.object({
+ *     title: v.string(),
+ *     content: v.string(),
+ *   }),
+ *   meta: { displayName: "Blog Post" },
+ * });
+ *
+ * const contentSchema = createContentSchema({ blogPost });
+ *
+ * // Create a typed client
+ * export const cms = createTypedCmsClient(components.convexCms, {
+ *   schema: contentSchema,
+ * });
+ *
+ * // Use with full type inference
+ * const post = await cms.typedContentEntries.get<"blog_post">(ctx, id);
+ * post.data.title;  // ✅ string
+ * post.data.typo;   // ❌ Error: Property 'typo' does not exist
+ * ```
+ */
+export declare function createTypedCmsClient<TSchema extends ContentSchemaInstance<Record<string, ContentTypeDefinition>>>(componentApi: TypedComponentApi, config: TypedCmsClientConfig<TSchema>): TypedCmsClient<TSchema>;
+//# sourceMappingURL=typedClient.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"typedClient.d.ts","sourceRoot":"","sources":["../../../src/client/schema/typedClient.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAEH,OAAO,KAAK,EACX,qBAAqB,EACrB,WAAW,EACX,sBAAsB,EACtB,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC/E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AACpE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAMnD;;;;GAIG;AACH,MAAM,WAAW,iBAAiB,CAAC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CACvE,SAAQ,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC;IAClC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB,CAAC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAC3E,IAAI,EAAE,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC;IACjC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,MAAM,EAAE,OAAO,CAAC;CAChB;AAMD;;GAEG;AACH,MAAM,MAAM,cAAc,CACzB,OAAO,SAAS,qBAAqB,CAAC,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC,EAC5E,KAAK,SAAS,MAAM,IACjB,OAAO,SAAS,qBAAqB,CAAC,MAAM,KAAK,CAAC,GACnD,KAAK,SAAS,MAAM,WAAW,CAAC,KAAK,CAAC,GACrC,WAAW,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACxD,WAAW,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,GACzB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACxB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACxB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE3B;;GAEG;AACH,MAAM,MAAM,oBAAoB,CAC/B,OAAO,SAAS,qBAAqB,CAAC,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC,IACzE,OAAO,SAAS,qBAAqB,CAAC,MAAM,KAAK,CAAC,GACnD,sBAAsB,CAAC,KAAK,CAAC,GAC7B,MAAM,CAAC;AAMV;;;;;;;GAOG;AACH,MAAM,WAAW,sBAAsB,CACtC,OAAO,SAAS,qBAAqB,CAAC,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IAE5E;;;;;;;;;;;;;;OAcG;IACH,GAAG,CAAC,KAAK,SAAS,oBAAoB,CAAC,OAAO,CAAC,EAC9C,GAAG,EAAE,aAAa,EAClB,EAAE,EAAE,MAAM,GACR,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IAErE;;;;;;OAMG;IACH,SAAS,CAAC,KAAK,SAAS,oBAAoB,CAAC,OAAO,CAAC,EACpD,GAAG,EAAE,aAAa,EAClB,OAAO,EAAE;QACR,eAAe,EAAE,KAAK,CAAC;QACvB,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,aAAa,GAAG,aAAa,EAAE,CAAC;KACzC,GACC,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IAErE;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,KAAK,SAAS,oBAAoB,CAAC,OAAO,CAAC,EACjD,GAAG,EAAE,aAAa,EAClB,OAAO,EAAE,uBAAuB,CAAC,OAAO,EAAE,KAAK,CAAC,GAC9C,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAE9D;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,SAAS,oBAAoB,CAAC,OAAO,CAAC,EACjD,GAAG,EAAE,aAAa,EAClB,OAAO,EAAE,uBAAuB,CAAC,OAAO,EAAE,KAAK,CAAC,GAC9C,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAE9D;;;;;;OAMG;IACH,IAAI,CAAC,KAAK,SAAS,oBAAoB,CAAC,OAAO,CAAC,EAC/C,GAAG,EAAE,aAAa,EAClB,OAAO,EAAE,uBAAuB,CAAC,KAAK,CAAC,GACrC,OAAO,CAAC,qBAAqB,CAAC,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;CAClE;AAMD;;GAEG;AACH,MAAM,WAAW,uBAAuB,CACvC,OAAO,SAAS,qBAAqB,CAAC,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC,EAC5E,KAAK,SAAS,oBAAoB,CAAC,OAAO,CAAC;IAE3C;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAErC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB,CACvC,OAAO,SAAS,qBAAqB,CAAC,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC,EAC5E,KAAK,SAAS,oBAAoB,CAAC,OAAO,CAAC;IAE3C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;IAE/C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB,CAAC,KAAK,SAAS,MAAM;IAC5D;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,cAAc,EAAE,cAAc,CAAC;CAC/B;AAMD;;GAEG;AACH,MAAM,MAAM,cAAc,CACzB,OAAO,SAAS,qBAAqB,CAAC,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC,EAC5E,KAAK,SAAS,MAAM,IACjB,KAAK,SAAS,oBAAoB,CAAC,OAAO,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,wBAAwB,CACnC,OAAO,SAAS,qBAAqB,CAAC,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC,EAC5E,KAAK,SAAS,MAAM,IACjB,OAAO,SAAS,qBAAqB,CAAC,MAAM,KAAK,CAAC,GACnD;KACC,CAAC,IAAI,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,SAAS,qBAAqB,CACzD,KAAK,EACL,MAAM,EAAE,CACR,GACE,KAAK,CAAC,CAAC,CAAC,GACR,KAAK;CACP,CAAC,MAAM,KAAK,CAAC,GACd,KAAK,CAAC;AAMT,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,KAAK,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAElE;;GAEG;AACH,MAAM,WAAW,oBAAoB,CACpC,OAAO,SAAS,qBAAqB,CAAC,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC,CAC3E,SAAQ,eAAe;IACxB;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc,CAC9B,OAAO,SAAS,qBAAqB,CAAC,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC,CAC3E,SAAQ,SAAS;IAClB;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,mBAAmB,EAAE,0BAA0B,CAAC,OAAO,CAAC,CAAC;CAClE;AAED;;;;;;;GAOG;AACH,qBAAa,0BAA0B,CACtC,OAAO,SAAS,qBAAqB,CAAC,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IAE5E,OAAO,CAAC,UAAU,CAAY;IAC9B,OAAO,CAAC,MAAM,CAAU;gBAEZ,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO;IAKlD;;;;;;;;;;;;;;OAcG;IACG,GAAG,CAAC,KAAK,SAAS,oBAAoB,CAAC,OAAO,CAAC,EACpD,GAAG,EAAE,aAAa,EAClB,EAAE,EAAE,MAAM,GACR,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC;IAUpE;;;;;;OAMG;IACG,SAAS,CAAC,KAAK,SAAS,oBAAoB,CAAC,OAAO,CAAC,EAC1D,GAAG,EAAE,aAAa,EAClB,OAAO,EAAE;QACR,eAAe,EAAE,KAAK,CAAC;QACvB,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,CAAC,EAAE,MAAM,CAAC;KAChB,GACC,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC;IAapE;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CAAC,KAAK,SAAS,oBAAoB,CAAC,OAAO,CAAC,EACvD,GAAG,EAAE,aAAa,EAClB,OAAO,EAAE,uBAAuB,CAAC,OAAO,EAAE,KAAK,CAAC,GAC9C,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;IAwB7D;;;;;;OAMG;IACG,MAAM,CAAC,KAAK,SAAS,oBAAoB,CAAC,OAAO,CAAC,EACvD,GAAG,EAAE,aAAa,EAClB,OAAO,EAAE,uBAAuB,CAAC,OAAO,EAAE,KAAK,CAAC,GAC9C,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;IAa7D;;;;;;OAMG;IACG,IAAI,CAAC,KAAK,SAAS,oBAAoB,CAAC,OAAO,CAAC,EACrD,GAAG,EAAE,aAAa,EAClB,OAAO,EAAE,uBAAuB,CAAC,KAAK,CAAC,GACrC,OAAO,CAAC,qBAAqB,CAAC,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;IAgCjE;;;;;;;OAOG;IACG,OAAO,CAAC,KAAK,SAAS,oBAAoB,CAAC,OAAO,CAAC,EACxD,GAAG,EAAE,aAAa,EAClB,EAAE,EAAE,MAAM,EACV,SAAS,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;IAW7D;;;;;;;OAOG;IACG,SAAS,CAAC,KAAK,SAAS,oBAAoB,CAAC,OAAO,CAAC,EAC1D,GAAG,EAAE,aAAa,EAClB,EAAE,EAAE,MAAM,EACV,SAAS,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;IAW7D;;OAEG;IACH,SAAS,IAAI,OAAO;IAIpB;;;;;OAKG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;CAGrC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,wBAAgB,oBAAoB,CACnC,OAAO,SAAS,qBAAqB,CAAC,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC,EAE5E,YAAY,EAAE,iBAAiB,EAC/B,MAAM,EAAE,oBAAoB,CAAC,OAAO,CAAC,GACnC,cAAc,CAAC,OAAO,CAAC,CAyBzB"}

package/dist/client/schema/typedClient.js

@@ -0,0 +1,269 @@
+/**
+ * Schema-Aware Typed CMS Client
+ *
+ * This module provides type-safe access to content entries when a schema
+ * is configured. The types are inferred from the Convex validators defined
+ * in the schema.
+ *
+ * @example
+ * ```typescript
+ * import { v } from "convex/values";
+ * import { defineContentType, createContentSchema, createTypedCmsClient } from "@convex-cms/core";
+ * import { components } from "./_generated/api";
+ *
+ * // Define content types with validators
+ * const blogPost = defineContentType({
+ *   name: "blog_post",
+ *   validator: v.object({ title: v.string(), content: v.string() }),
+ *   meta: { displayName: "Blog Post" },
+ * });
+ *
+ * const contentSchema = createContentSchema({ blogPost });
+ *
+ * // Create a typed CMS client
+ * export const cms = createTypedCmsClient(components.convexCms, {
+ *   schema: contentSchema,
+ * });
+ *
+ * // Now methods return typed data
+ * const post = await cms.contentEntries.get<"blog_post">(ctx, id);
+ * post.data.title    // ✅ string - TypeScript knows the type
+ * post.data.typo     // ❌ Error: Property 'typo' does not exist
+ * ```
+ */
+/**
+ * Implementation of typed content entries API.
+ *
+ * This provides typed wrappers around the base content entries API that
+ * cast results to the appropriate types based on the schema.
+ *
+ * @typeParam TSchema - The content schema instance type
+ */
+export class TypedContentEntriesApiImpl {
+    baseClient;
+    schema;
+    constructor(baseClient, schema) {
+        this.baseClient = baseClient;
+        this.schema = schema;
+    }
+    /**
+     * Get a content entry by ID with typed data.
+     *
+     * @param ctx - Convex context
+     * @param id - The content entry ID
+     * @returns The entry with typed data, or null if not found
+     *
+     * @example
+     * ```typescript
+     * const post = await cms.typedContentEntries.get<"blog_post">(ctx, id);
+     * if (post) {
+     *   console.log(post.data.title);  // ✅ TypeScript knows title is string
+     * }
+     * ```
+     */
+    async get(ctx, id) {
+        const entry = await this.baseClient.contentEntries.get(ctx, { id });
+        if (!entry)
+            return null;
+        // Cast to typed entry - the data shape is validated at write time
+        return entry;
+    }
+    /**
+     * Get a content entry by slug with typed data.
+     *
+     * @param ctx - Convex context
+     * @param options - Query options including contentTypeName and slug
+     * @returns The entry with typed data, or null if not found
+     */
+    async getBySlug(ctx, options) {
+        const entry = await this.baseClient.contentEntries.getBySlug(ctx, {
+            contentTypeName: options.contentTypeName,
+            slug: options.slug,
+            locale: options.locale,
+        });
+        if (!entry)
+            return null;
+        return entry;
+    }
+    /**
+     * Create a new content entry with typed data.
+     *
+     * @param ctx - Convex context
+     * @param options - Creation options including typed data
+     * @returns The created entry with typed data
+     *
+     * @example
+     * ```typescript
+     * const post = await cms.typedContentEntries.create<"blog_post">(ctx, {
+     *   contentTypeName: "blog_post",
+     *   data: {
+     *     title: "Hello World",  // ✅ TypeScript validates this
+     *     content: "...",
+     *   },
+     * });
+     * ```
+     */
+    async create(ctx, options) {
+        // Look up the content type by name to get its ID
+        const contentType = await this.baseClient.contentTypes.getByName(ctx, options.contentTypeName);
+        if (!contentType) {
+            throw new Error(`Content type "${options.contentTypeName}" not found`);
+        }
+        const entry = await this.baseClient.contentEntries.create(ctx, {
+            contentTypeId: contentType._id,
+            data: options.data,
+            slug: options.slug,
+            locale: options.locale,
+            createdBy: options.createdBy,
+        });
+        return entry;
+    }
+    /**
+     * Update an existing content entry with typed data.
+     *
+     * @param ctx - Convex context
+     * @param options - Update options including partial typed data
+     * @returns The updated entry with typed data
+     */
+    async update(ctx, options) {
+        const entry = await this.baseClient.contentEntries.update(ctx, {
+            id: options.id,
+            data: options.data,
+            slug: options.slug,
+            updatedBy: options.updatedBy,
+        });
+        return entry;
+    }
+    /**
+     * List content entries with typed data.
+     *
+     * @param ctx - Convex context
+     * @param options - List options
+     * @returns Paginated results with typed entries
+     */
+    async list(ctx, options) {
+        // If filtering by content type name, look up the content type ID
+        let contentTypeId;
+        if (options.contentTypeName) {
+            const contentType = await this.baseClient.contentTypes.getByName(ctx, options.contentTypeName);
+            if (contentType) {
+                contentTypeId = contentType._id;
+            }
+        }
+        const result = await this.baseClient.contentEntries.list(ctx, {
+            contentTypeId,
+            status: options.status,
+            statusIn: options.statusIn,
+            locale: options.locale,
+            search: options.search,
+            includeDeleted: options.includeDeleted,
+            paginationOpts: options.paginationOpts,
+        });
+        return {
+            page: result.page,
+            continueCursor: result.continueCursor,
+            isDone: result.isDone,
+        };
+    }
+    /**
+     * Publish a content entry.
+     *
+     * @param ctx - Convex context
+     * @param id - The entry ID to publish
+     * @param updatedBy - Optional user ID who triggered the publish
+     * @returns The published entry with typed data
+     */
+    async publish(ctx, id, updatedBy) {
+        const entry = await this.baseClient.contentEntries.publish(ctx, {
+            id,
+            updatedBy,
+        });
+        return entry;
+    }
+    /**
+     * Unpublish a content entry.
+     *
+     * @param ctx - Convex context
+     * @param id - The entry ID to unpublish
+     * @param updatedBy - Optional user ID who triggered the unpublish
+     * @returns The unpublished entry with typed data
+     */
+    async unpublish(ctx, id, updatedBy) {
+        const entry = await this.baseClient.contentEntries.unpublish(ctx, {
+            id,
+            updatedBy,
+        });
+        return entry;
+    }
+    /**
+     * Get the schema configured for this typed client.
+     */
+    getSchema() {
+        return this.schema;
+    }
+    /**
+     * Validate that a content type exists in the schema.
+     *
+     * @param name - The content type name to validate
+     * @returns true if the content type exists
+     */
+    hasContentType(name) {
+        return this.schema.hasContentType(name);
+    }
+}
+/**
+ * Creates a typed CMS client with schema-aware content entry methods.
+ *
+ * This is the main entry point for using type-safe content operations.
+ * The returned client extends the base `CmsClient` with additional
+ * `typedContentEntries` methods that provide full TypeScript inference.
+ *
+ * @param componentApi - The component API from `components.convexCms`
+ * @param config - Configuration including the content schema
+ * @returns A typed CMS client instance
+ *
+ * @example
+ * ```typescript
+ * import { v } from "convex/values";
+ * import { defineContentType, createContentSchema, createTypedCmsClient } from "@convex-cms/core";
+ * import { components } from "./_generated/api";
+ *
+ * // Define content types
+ * const blogPost = defineContentType({
+ *   name: "blog_post",
+ *   validator: v.object({
+ *     title: v.string(),
+ *     content: v.string(),
+ *   }),
+ *   meta: { displayName: "Blog Post" },
+ * });
+ *
+ * const contentSchema = createContentSchema({ blogPost });
+ *
+ * // Create a typed client
+ * export const cms = createTypedCmsClient(components.convexCms, {
+ *   schema: contentSchema,
+ * });
+ *
+ * // Use with full type inference
+ * const post = await cms.typedContentEntries.get<"blog_post">(ctx, id);
+ * post.data.title;  // ✅ string
+ * post.data.typo;   // ❌ Error: Property 'typo' does not exist
+ * ```
+ */
+export function createTypedCmsClient(componentApi, config) {
+    // Import createCmsClient dynamically to avoid circular imports
+    // The actual import happens at runtime
+    const { createCmsClient } = require("../index.js");
+    // Create the base client with the provided config
+    const baseClient = createCmsClient(componentApi, config);
+    // Create the typed content entries API
+    const typedContentEntries = new TypedContentEntriesApiImpl(baseClient, config.schema);
+    // Return an extended client with the typed API
+    return {
+        ...baseClient,
+        schema: config.schema,
+        typedContentEntries,
+    };
+}
+//# sourceMappingURL=typedClient.js.map

package/dist/client/schema/typedClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typedClient.js","sourceRoot":"","sources":["../../../src/client/schema/typedClient.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAiVH;;;;;;;GAOG;AACH,MAAM,OAAO,0BAA0B;IAG9B,UAAU,CAAY;IACtB,MAAM,CAAU;IAExB,YAAY,UAAqB,EAAE,MAAe;QACjD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,GAAG,CACR,GAAkB,EAClB,EAAU;QAEV,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC;QAExB,kEAAkE;QAClE,OAAQ,KAEP,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,SAAS,CACd,GAAkB,EAClB,OAIC;QAED,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,SAAS,CAAC,GAAG,EAAE;YACjE,eAAe,EAAE,OAAO,CAAC,eAAe;YACxC,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,MAAM,EAAE,OAAO,CAAC,MAAM;SACtB,CAAC,CAAC;QACH,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC;QAExB,OAAQ,KAEP,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,MAAM,CACX,GAAkB,EAClB,OAAgD;QAEhD,iDAAiD;QACjD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,SAAS,CAC/D,GAAG,EACH,OAAO,CAAC,eAAyB,CACjC,CAAC;QAEF,IAAI,CAAC,WAAW,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,iBAAiB,OAAO,CAAC,eAAe,aAAa,CAAC,CAAC;QACxE,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,EAAE;YAC9D,aAAa,EAAE,WAAW,CAAC,GAAG;YAC9B,IAAI,EAAE,OAAO,CAAC,IAA+B;YAC7C,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,SAAS,EAAE,OAAO,CAAC,SAAS;SAC5B,CAAC,CAAC;QAEH,OAAQ,KAEP,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CACX,GAAkB,EAClB,OAAgD;QAEhD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,EAAE;YAC9D,EAAE,EAAE,OAAO,CAAC,EAAE;YACd,IAAI,EAAE,OAAO,CAAC,IAA2C;YACzD,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,SAAS,EAAE,OAAO,CAAC,SAAS;SAC5B,CAAC,CAAC;QAEH,OAAQ,KAEP,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CACT,GAAkB,EAClB,OAAuC;QAEvC,iEAAiE;QACjE,IAAI,aAAiC,CAAC;QACtC,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;YAC7B,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,SAAS,CAC/D,GAAG,EACH,OAAO,CAAC,eAAyB,CACjC,CAAC;YACF,IAAI,WAAW,EAAE,CAAC;gBACjB,aAAa,GAAG,WAAW,CAAC,GAAG,CAAC;YACjC,CAAC;QACF,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE;YAC7D,aAAa;YACb,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,cAAc,EAAE,OAAO,CAAC,cAAc;YACtC,cAAc,EAAE,OAAO,CAAC,cAAc;SACtC,CAAC,CAAC;QAEH,OAAO;YACN,IAAI,EAAG,MAAM,CAAC,IAEX;YACH,cAAc,EAAE,MAAM,CAAC,cAAc;YACrC,MAAM,EAAE,MAAM,CAAC,MAAM;SACrB,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,OAAO,CACZ,GAAkB,EAClB,EAAU,EACV,SAAkB;QAElB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,EAAE;YAC/D,EAAE;YACF,SAAS;SACT,CAAC,CAAC;QAEH,OAAQ,KAEP,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,SAAS,CACd,GAAkB,EAClB,EAAU,EACV,SAAkB;QAElB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,SAAS,CAAC,GAAG,EAAE;YACjE,EAAE;YACF,SAAS;SACT,CAAC,CAAC;QAEH,OAAQ,KAEP,CAAC;IACH,CAAC;IAED;;OAEG;IACH,SAAS;QACR,OAAO,IAAI,CAAC,MAAM,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACH,cAAc,CAAC,IAAY;QAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;CACD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,UAAU,oBAAoB,CAGnC,YAA+B,EAC/B,MAAqC;IAErC,+DAA+D;IAC/D,uCAAuC;IACvC,MAAM,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,aAAa,CAKhD,CAAC;IAEF,kDAAkD;IAClD,MAAM,UAAU,GAAG,eAAe,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IAEzD,uCAAuC;IACvC,MAAM,mBAAmB,GAAG,IAAI,0BAA0B,CACzD,UAAU,EACV,MAAM,CAAC,MAAM,CACb,CAAC;IAEF,+CAA+C;IAC/C,OAAO;QACN,GAAG,UAAU;QACb,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,mBAAmB;KACnB,CAAC;AACH,CAAC"}