cms-renderer 0.2.9 → 0.3.0

package/dist/lib/custom-schemas.d.ts

@@ -0,0 +1,94 @@
+import { FieldDefinition } from '@repo/cms-schema/documents';
+import { ZodObject, ZodRawShape } from 'zod';
+import { CmsConfig } from './cms-api.js';
+import '@repo/cms-schema/trpc';
+import '@trpc/client';
+
+/**
+ * Custom Schema Fetcher
+ *
+ * Fetches custom schema definitions (field metadata as JSON) from the CMS API
+ * for a given website. Uses the tRPC client to call the customSchema router.
+ */
+
+interface CustomSchemaFields {
+    name: string;
+    displayName: string;
+    description: string | null;
+    fields: FieldDefinition[];
+    routeSlugField: string | null;
+    version: number;
+}
+type FetchCustomSchemasOptions = CmsConfig & {
+    websiteId: string;
+};
+/**
+ * Fetches all custom schemas with their field definitions for a website.
+ *
+ * @example
+ * ```ts
+ * const schemas = await fetchAllCustomSchemaFields({
+ *   cmsUrl: 'http://localhost:3000',
+ *   apiKey: 'my-api-key',
+ *   websiteId: 'uuid-here',
+ * });
+ *
+ * for (const schema of schemas) {
+ *   console.log(schema.name, schema.fields);
+ * }
+ * ```
+ */
+declare function fetchAllCustomSchemaFields(options: FetchCustomSchemasOptions): Promise<CustomSchemaFields[]>;
+/**
+ * Fetches a single custom schema's field definitions by name.
+ *
+ * @example
+ * ```ts
+ * const schema = await fetchCustomSchemaFields({
+ *   cmsUrl: 'http://localhost:3000',
+ *   apiKey: 'my-api-key',
+ *   websiteId: 'uuid-here',
+ * }, 'blog_post');
+ *
+ * console.log(schema.fields);
+ * ```
+ */
+declare function fetchCustomSchemaFields(options: FetchCustomSchemasOptions, schemaName: string): Promise<CustomSchemaFields>;
+/**
+ * Converts an array of custom schema definitions into a record of Zod schemas,
+ * keyed by schema name.
+ *
+ * @example
+ * ```ts
+ * const schemas = await fetchAllCustomSchemaFields(options);
+ * const zodSchemas = buildZodSchemas(schemas);
+ *
+ * // Validate a blog post document
+ * const result = zodSchemas['blog_post'].safeParse(data);
+ * ```
+ */
+declare function buildZodSchemas(schemas: CustomSchemaFields[]): Record<string, ZodObject<ZodRawShape>>;
+/**
+ * Converts an array of custom schema definitions into a record of Zod source
+ * code strings, keyed by schema name.
+ *
+ * @example
+ * ```ts
+ * const schemas = await fetchAllCustomSchemaFields(options);
+ * const codeMap = buildZodSchemaCode(schemas);
+ *
+ * // Write blog_post schema to a file
+ * fs.writeFileSync('blog-post.ts', codeMap['blog_post']);
+ * ```
+ */
+declare function buildZodSchemaCode(schemas: CustomSchemaFields[]): Record<string, string>;
+/**
+ * Generates combined Zod schema code from all custom schemas and writes it
+ * to the specified file path.
+ *
+ * @param schemas - Array of custom schema definitions
+ * @param filePath - Absolute or relative path to write the generated file
+ */
+declare function saveZodSchemaCode(schemas: CustomSchemaFields[], filePath: string): Promise<void>;
+
+export { type CustomSchemaFields, type FetchCustomSchemasOptions, buildZodSchemaCode, buildZodSchemas, fetchAllCustomSchemaFields, fetchCustomSchemaFields, saveZodSchemaCode };