cms-renderer 0.6.5 → 0.6.7

package/README.md

@@ -6,7 +6,7 @@ It provides:
 
 - A catch-all route component that fetches CMS routes and blocks from the CMS API and renders them with your React component registry
 - A proxy helper for mounting the CMS admin and API behind your app
-- Schema-fetching utilities for headless document access
+- Component-fetching utilities for headless document access
 - Docs-oriented markdown rendering and styles
 - Type exports for block registries and route params
 
@@ -27,8 +27,8 @@ Main entry points:
 - `cms-renderer/lib/renderer` for catch-all route rendering
 - `cms-renderer/lib/types` for block and route types
 - `cms-renderer/lib/proxy` for proxying CMS admin and API traffic
-- `cms-renderer/lib/schema` for headless schema-based reads
-- `cms-renderer/lib/custom-schemas` for fetching custom schema metadata and generating Zod code
+- `cms-renderer/lib/schema` for headless component-based reads
+- `cms-renderer/lib/custom-schemas` for fetching custom component metadata and generating Zod code
 - `cms-renderer/lib/docs-markdown` and `cms-renderer/styles/docs-markdown.css` for docs markdown rendering
 - `cms-renderer/lib/refresher` for client-side refresh on CMS updates
 
@@ -147,7 +147,7 @@ NEXT_PUBLIC_CMS_API_URL=https://cms.example.com
 
 Use `CMS_API_KEY` when your CMS requires authenticated access.
 
-`NEXT_PUBLIC_CMS_API_URL` is only used by the default `schema` export from `cms-renderer/lib/schema`. If you call `configureSchema(...)` directly, pass `cmsUrl` explicitly instead.
+The default `schema` / `component` exports from `cms-renderer/lib/schema` read `NEXT_PUBLIC_CMS_API_URL` on **first use** (lazy), not when the module loads — so importing only `configureSchema` never touches that env. If you call `configureSchema(...)` directly, pass `cmsUrl` explicitly instead.
 
 If no website ID is available, `ParametricRoutePage` throws at runtime.
 
@@ -181,9 +181,9 @@ The proxy helper:
 - Rewrites cookies for the current deployment host
 - Proxies admin-originated static asset requests
 
-## Headless Schema Access
+## Headless Component Access
 
-Use `configureSchema` or the default `schema` export when you want published documents for a custom schema outside the block renderer.
+Use `configureSchema` or the default `component` export when you want published documents for a custom component outside the block renderer.
 
 ```ts
 import { configureSchema } from 'cms-renderer/lib/schema';
@@ -206,11 +206,11 @@ Available methods:
 - `fetchSingleById(id)`
 - `translation(language)`
 
-If you use the default `schema` export, it reads `NEXT_PUBLIC_CMS_API_URL` from the environment. If your app already has a CMS base URL under a different variable name, prefer `configureSchema(...)` and pass `cmsUrl` explicitly.
+If you use the default `component` export, it reads `NEXT_PUBLIC_CMS_API_URL` from the environment on first access. If you call `configureSchema(...)` directly, pass the CMS origin/base URL as `cmsUrl`.
 
-## Custom Schema Code Generation
+## Custom Component Code Generation
 
-Use `cms-renderer/lib/custom-schemas` to fetch custom schema metadata and generate typed Zod schema code for your app.
+Use `cms-renderer/lib/custom-schemas` to fetch custom component metadata and generate typed Zod component code for your app. The helper names in this module still use `Schema` for compatibility.
 
 ```ts
 import {
@@ -218,13 +218,13 @@ import {
   saveZodSchemaCode,
 } from 'cms-renderer/lib/custom-schemas';
 
-const schemas = await fetchAllCustomSchemaFields({
+const components = await fetchAllCustomSchemaFields({
   cmsUrl: process.env.NEXT_PUBLIC_CMS_URL!,
   apiKey: process.env.CMS_API_KEY,
   websiteId: process.env.NEXT_PUBLIC_WEBSITE_ID!,
 });
 
-await saveZodSchemaCode(schemas, 'generated/cms-schemas.ts');
+await saveZodSchemaCode(components, 'generated/cms-schemas.ts');
 ```
 
 Also exported:

package/dist/lib/cms-api.d.ts

@@ -21,6 +21,7 @@ interface CmsConfig {
 }
 /**
  * Get a CMS client for the specified CMS URL.
+ * Uses a singleton cache to avoid recreating clients with identical configuration.
  */
 declare function getCmsClient(options: CmsConfig): CmsClient;
 

package/dist/lib/cms-api.js

@@ -33,8 +33,18 @@ function createCmsClient(options) {
     ]
   });
 }
+var clientCache = /* @__PURE__ */ new Map();
+function getClientCacheKey(options) {
+  return `${options.cmsUrl}|${options.apiKey ?? ""}|${options.websiteId ?? ""}`;
+}
 function getCmsClient(options) {
-  return createCmsClient(options);
+  const cacheKey = getClientCacheKey(options);
+  let client = clientCache.get(cacheKey);
+  if (!client) {
+    client = createCmsClient(options);
+    clientCache.set(cacheKey, client);
+  }
+  return client;
 }
 export {
   getCmsClient

package/dist/lib/cms-api.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../lib/cms-api.ts"],"sourcesContent":["/**\n * CMS API Client\n *\n * Creates an HTTP-based tRPC client for calling the CMS API.\n * Used in Server Components to fetch routes and blocks from the CMS.\n */\n\nimport type { AppRouter } from '@repo/cms-schema/trpc';\nimport { type CreateTRPCClient, createTRPCClient, httpBatchLink } from '@trpc/client';\nimport superjson from 'superjson';\n\n/** Type alias for the CMS API client */\ntype CmsClient = CreateTRPCClient<AppRouter>;\n\n/**\n * Get the CMS API URL from the provided base URL.\n */\nfunction getCmsApiUrl(cmsUrl: string): string {\n  return new URL('/api/trpc', cmsUrl).toString();\n}\n\n/** Unified configuration for all CMS API access */\nexport interface CmsConfig {\n  /** CMS API base URL (e.g., 'http://localhost:3000') */\n  cmsUrl: string;\n  /** API key for authentication */\n  apiKey?: string;\n  /** Website ID to scope API requests */\n  websiteId?: string;\n}\n\n/**\n * Create a custom fetch function that appends API key as query parameter.\n */\nfunction createFetchWithApiKey(apiKey?: string, websiteId?: string) {\n  return async (url: URL | RequestInfo, options?: RequestInit): Promise<Response> => {\n    let finalUrl = url;\n\n    const urlObj = new URL(url.toString());\n    if (apiKey) {\n      urlObj.searchParams.set('api_key', apiKey);\n    }\n    if (websiteId) {\n      urlObj.searchParams.set('website_id', websiteId);\n    }\n    if (apiKey || websiteId) {\n      finalUrl = urlObj.toString();\n    }\n\n    const response = await fetch(finalUrl, options);\n\n    return response;\n  };\n}\n\n/**\n * Create a tRPC client for the CMS API.\n */\nfunction createCmsClient(options: CmsConfig): CmsClient {\n  const url = getCmsApiUrl(options.cmsUrl);\n\n  return createTRPCClient<AppRouter>({\n    links: [\n      httpBatchLink({\n        url,\n        transformer: superjson,\n        fetch: createFetchWithApiKey(options.apiKey, options.websiteId),\n      }),\n    ],\n  });\n}\n\n/**\n * Get a CMS client for the specified CMS URL.\n */\nexport function getCmsClient(options: CmsConfig): CmsClient {\n  return createCmsClient(options);\n}\n"],"mappings":";AAQA,SAAgC,kBAAkB,qBAAqB;AACvE,OAAO,eAAe;AAQtB,SAAS,aAAa,QAAwB;AAC5C,SAAO,IAAI,IAAI,aAAa,MAAM,EAAE,SAAS;AAC/C;AAeA,SAAS,sBAAsB,QAAiB,WAAoB;AAClE,SAAO,OAAO,KAAwB,YAA6C;AACjF,QAAI,WAAW;AAEf,UAAM,SAAS,IAAI,IAAI,IAAI,SAAS,CAAC;AACrC,QAAI,QAAQ;AACV,aAAO,aAAa,IAAI,WAAW,MAAM;AAAA,IAC3C;AACA,QAAI,WAAW;AACb,aAAO,aAAa,IAAI,cAAc,SAAS;AAAA,IACjD;AACA,QAAI,UAAU,WAAW;AACvB,iBAAW,OAAO,SAAS;AAAA,IAC7B;AAEA,UAAM,WAAW,MAAM,MAAM,UAAU,OAAO;AAE9C,WAAO;AAAA,EACT;AACF;AAKA,SAAS,gBAAgB,SAA+B;AACtD,QAAM,MAAM,aAAa,QAAQ,MAAM;AAEvC,SAAO,iBAA4B;AAAA,IACjC,OAAO;AAAA,MACL,cAAc;AAAA,QACZ;AAAA,QACA,aAAa;AAAA,QACb,OAAO,sBAAsB,QAAQ,QAAQ,QAAQ,SAAS;AAAA,MAChE,CAAC;AAAA,IACH;AAAA,EACF,CAAC;AACH;AAKO,SAAS,aAAa,SAA+B;AAC1D,SAAO,gBAAgB,OAAO;AAChC;","names":[]}
+{"version":3,"sources":["../../lib/cms-api.ts"],"sourcesContent":["/**\n * CMS API Client\n *\n * Creates an HTTP-based tRPC client for calling the CMS API.\n * Used in Server Components to fetch routes and blocks from the CMS.\n */\n\nimport type { AppRouter } from '@repo/cms-schema/trpc';\nimport { type CreateTRPCClient, createTRPCClient, httpBatchLink } from '@trpc/client';\nimport superjson from 'superjson';\n\n/** Type alias for the CMS API client */\ntype CmsClient = CreateTRPCClient<AppRouter>;\n\n/**\n * Get the CMS API URL from the provided base URL.\n */\nfunction getCmsApiUrl(cmsUrl: string): string {\n  return new URL('/api/trpc', cmsUrl).toString();\n}\n\n/** Unified configuration for all CMS API access */\nexport interface CmsConfig {\n  /** CMS API base URL (e.g., 'http://localhost:3000') */\n  cmsUrl: string;\n  /** API key for authentication */\n  apiKey?: string;\n  /** Website ID to scope API requests */\n  websiteId?: string;\n}\n\n/**\n * Create a custom fetch function that appends API key as query parameter.\n */\nfunction createFetchWithApiKey(apiKey?: string, websiteId?: string) {\n  return async (url: URL | RequestInfo, options?: RequestInit): Promise<Response> => {\n    let finalUrl = url;\n\n    const urlObj = new URL(url.toString());\n    if (apiKey) {\n      urlObj.searchParams.set('api_key', apiKey);\n    }\n    if (websiteId) {\n      urlObj.searchParams.set('website_id', websiteId);\n    }\n    if (apiKey || websiteId) {\n      finalUrl = urlObj.toString();\n    }\n\n    const response = await fetch(finalUrl, options);\n\n    return response;\n  };\n}\n\n/**\n * Create a tRPC client for the CMS API.\n */\nfunction createCmsClient(options: CmsConfig): CmsClient {\n  const url = getCmsApiUrl(options.cmsUrl);\n\n  return createTRPCClient<AppRouter>({\n    links: [\n      httpBatchLink({\n        url,\n        transformer: superjson,\n        fetch: createFetchWithApiKey(options.apiKey, options.websiteId),\n      }),\n    ],\n  });\n}\n\nconst clientCache = new Map<string, CmsClient>();\n\nfunction getClientCacheKey(options: CmsConfig): string {\n  return `${options.cmsUrl}|${options.apiKey ?? ''}|${options.websiteId ?? ''}`;\n}\n\n/**\n * Get a CMS client for the specified CMS URL.\n * Uses a singleton cache to avoid recreating clients with identical configuration.\n */\nexport function getCmsClient(options: CmsConfig): CmsClient {\n  const cacheKey = getClientCacheKey(options);\n\n  let client = clientCache.get(cacheKey);\n  if (!client) {\n    client = createCmsClient(options);\n    clientCache.set(cacheKey, client);\n  }\n\n  return client;\n}\n"],"mappings":";AAQA,SAAgC,kBAAkB,qBAAqB;AACvE,OAAO,eAAe;AAQtB,SAAS,aAAa,QAAwB;AAC5C,SAAO,IAAI,IAAI,aAAa,MAAM,EAAE,SAAS;AAC/C;AAeA,SAAS,sBAAsB,QAAiB,WAAoB;AAClE,SAAO,OAAO,KAAwB,YAA6C;AACjF,QAAI,WAAW;AAEf,UAAM,SAAS,IAAI,IAAI,IAAI,SAAS,CAAC;AACrC,QAAI,QAAQ;AACV,aAAO,aAAa,IAAI,WAAW,MAAM;AAAA,IAC3C;AACA,QAAI,WAAW;AACb,aAAO,aAAa,IAAI,cAAc,SAAS;AAAA,IACjD;AACA,QAAI,UAAU,WAAW;AACvB,iBAAW,OAAO,SAAS;AAAA,IAC7B;AAEA,UAAM,WAAW,MAAM,MAAM,UAAU,OAAO;AAE9C,WAAO;AAAA,EACT;AACF;AAKA,SAAS,gBAAgB,SAA+B;AACtD,QAAM,MAAM,aAAa,QAAQ,MAAM;AAEvC,SAAO,iBAA4B;AAAA,IACjC,OAAO;AAAA,MACL,cAAc;AAAA,QACZ;AAAA,QACA,aAAa;AAAA,QACb,OAAO,sBAAsB,QAAQ,QAAQ,QAAQ,SAAS;AAAA,MAChE,CAAC;AAAA,IACH;AAAA,EACF,CAAC;AACH;AAEA,IAAM,cAAc,oBAAI,IAAuB;AAE/C,SAAS,kBAAkB,SAA4B;AACrD,SAAO,GAAG,QAAQ,MAAM,IAAI,QAAQ,UAAU,EAAE,IAAI,QAAQ,aAAa,EAAE;AAC7E;AAMO,SAAS,aAAa,SAA+B;AAC1D,QAAM,WAAW,kBAAkB,OAAO;AAE1C,MAAI,SAAS,YAAY,IAAI,QAAQ;AACrC,MAAI,CAAC,QAAQ;AACX,aAAS,gBAAgB,OAAO;AAChC,gBAAY,IAAI,UAAU,MAAM;AAAA,EAClC;AAEA,SAAO;AACT;","names":[]}

package/dist/lib/custom-schemas.js

@@ -988,6 +988,8 @@ var RehydrationError = class extends Error {
     this.fieldType = fieldType;
     this.name = "RehydrationError";
   }
+  fieldName;
+  fieldType;
 };
 function rehydrateField(field) {
   try {
@@ -1016,6 +1018,8 @@ function createBaseSchema(type, constraints) {
       return z7.boolean();
     case "image":
       return ImageReferenceSchema;
+    case "icon":
+      return z7.string().max(50);
     case "date":
       return z7.iso.date("Invalid date format. Expected YYYY-MM-DD");
     case "datetime":
@@ -1183,7 +1187,8 @@ var fieldDefinitionSchema = z9.object({
     "enum",
     "reference",
     "array",
-    "image"
+    "image",
+    "icon"
   ]),
   displayName: z9.string().optional(),
   description: z9.string().optional(),
@@ -1234,8 +1239,18 @@ function createCmsClient(options) {
     ]
   });
 }
+var clientCache = /* @__PURE__ */ new Map();
+function getClientCacheKey(options) {
+  return `${options.cmsUrl}|${options.apiKey ?? ""}|${options.websiteId ?? ""}`;
+}
 function getCmsClient(options) {
-  return createCmsClient(options);
+  const cacheKey = getClientCacheKey(options);
+  let client = clientCache.get(cacheKey);
+  if (!client) {
+    client = createCmsClient(options);
+    clientCache.set(cacheKey, client);
+  }
+  return client;
 }
 
 // lib/custom-schemas.ts