@syntaxcircus/cmsify-client 0.2.4 → 0.3.0

package/dist/index.d.cts

@@ -4942,6 +4942,25 @@ declare function getFormatHint(fieldConfig: unknown): TextFormatHint;
  */
 declare function isProseHint(hint: TextFormatHint): boolean;
 
+/**
+ * Renders `${{name}}` placeholder tokens in Cmsify content field text against a caller-supplied
+ * variable dictionary. This is purely a client-side string transform -- the Cmsify server has no
+ * concept of variables and never sees or stores rendered output. Content authors write literal
+ * `${{name}}` tokens into Text/Markdown fields, and each consuming application decides what
+ * values to supply at read time (e.g. from its own configuration).
+ *
+ * A variable name present in `variables` with a `null`/`undefined` value renders as an empty
+ * string -- an explicit "blank this out." A variable name *not* present in `variables` at all is
+ * left untouched in the output as the literal `${{name}}` token. This is deliberate: a typo'd
+ * variable name (e.g. `${{supprtEmail}}`) should be visibly wrong on the rendered page, not
+ * silently disappear.
+ */
+/**
+ * Replaces every recognized `${{name}}` token in `template` with the corresponding value from
+ * `variables`. Tokens whose name is not a key in `variables` are left untouched.
+ */
+declare function renderCmsifyTemplate(template: string, variables: Record<string, string | null | undefined>): string;
+
 declare const createCmsifyFetchClient: (baseUrl: string, fetchImpl?: typeof fetch) => openapi_fetch.Client<paths, `${string}/${string}`>;
 
-export { CmsifyApiError, CmsifyClient, type CmsifyClientOptions, CmsifyTimeoutError, type ContentItem, type ContentListItem, type ContentListOptions, type Delay, ETagStore, type MediaAsset, type PageOptions, type PageResult, type PagedResult, type ProblemDetails, type RequestOptions, TEXT_FORMAT_HINTS, type Template, type TemplateListItem, type TextFormatHint, type TextFormatHintConfig, type Workspace, type components, createCmsifyFetchClient, schema as generated, getFormatHint, isProseHint, listAll, type paths, toMimeType };
+export { CmsifyApiError, CmsifyClient, type CmsifyClientOptions, CmsifyTimeoutError, type ContentItem, type ContentListItem, type ContentListOptions, type Delay, ETagStore, type MediaAsset, type PageOptions, type PageResult, type PagedResult, type ProblemDetails, type RequestOptions, TEXT_FORMAT_HINTS, type Template, type TemplateListItem, type TextFormatHint, type TextFormatHintConfig, type Workspace, type components, createCmsifyFetchClient, schema as generated, getFormatHint, isProseHint, listAll, type paths, renderCmsifyTemplate, toMimeType };

package/dist/index.d.ts

@@ -4942,6 +4942,25 @@ declare function getFormatHint(fieldConfig: unknown): TextFormatHint;
  */
 declare function isProseHint(hint: TextFormatHint): boolean;
 
+/**
+ * Renders `${{name}}` placeholder tokens in Cmsify content field text against a caller-supplied
+ * variable dictionary. This is purely a client-side string transform -- the Cmsify server has no
+ * concept of variables and never sees or stores rendered output. Content authors write literal
+ * `${{name}}` tokens into Text/Markdown fields, and each consuming application decides what
+ * values to supply at read time (e.g. from its own configuration).
+ *
+ * A variable name present in `variables` with a `null`/`undefined` value renders as an empty
+ * string -- an explicit "blank this out." A variable name *not* present in `variables` at all is
+ * left untouched in the output as the literal `${{name}}` token. This is deliberate: a typo'd
+ * variable name (e.g. `${{supprtEmail}}`) should be visibly wrong on the rendered page, not
+ * silently disappear.
+ */
+/**
+ * Replaces every recognized `${{name}}` token in `template` with the corresponding value from
+ * `variables`. Tokens whose name is not a key in `variables` are left untouched.
+ */
+declare function renderCmsifyTemplate(template: string, variables: Record<string, string | null | undefined>): string;
+
 declare const createCmsifyFetchClient: (baseUrl: string, fetchImpl?: typeof fetch) => openapi_fetch.Client<paths, `${string}/${string}`>;
 
-export { CmsifyApiError, CmsifyClient, type CmsifyClientOptions, CmsifyTimeoutError, type ContentItem, type ContentListItem, type ContentListOptions, type Delay, ETagStore, type MediaAsset, type PageOptions, type PageResult, type PagedResult, type ProblemDetails, type RequestOptions, TEXT_FORMAT_HINTS, type Template, type TemplateListItem, type TextFormatHint, type TextFormatHintConfig, type Workspace, type components, createCmsifyFetchClient, schema as generated, getFormatHint, isProseHint, listAll, type paths, toMimeType };
+export { CmsifyApiError, CmsifyClient, type CmsifyClientOptions, CmsifyTimeoutError, type ContentItem, type ContentListItem, type ContentListOptions, type Delay, ETagStore, type MediaAsset, type PageOptions, type PageResult, type PagedResult, type ProblemDetails, type RequestOptions, TEXT_FORMAT_HINTS, type Template, type TemplateListItem, type TextFormatHint, type TextFormatHintConfig, type Workspace, type components, createCmsifyFetchClient, schema as generated, getFormatHint, isProseHint, listAll, type paths, renderCmsifyTemplate, toMimeType };

package/dist/index.js

@@ -264,6 +264,18 @@ function isProseHint(hint) {
   return hint === "plaintext" || hint === "markdown" || hint === "html";
 }
 
+// src/templating.ts
+var TOKEN_PATTERN = /\$\{\{\s*([A-Za-z][A-Za-z0-9_.-]*)\s*\}\}/g;
+function renderCmsifyTemplate(template, variables) {
+  if (!template.includes("${{")) {
+    return template;
+  }
+  return template.replace(
+    TOKEN_PATTERN,
+    (full, name) => Object.prototype.hasOwnProperty.call(variables, name) ? variables[name] ?? "" : full
+  );
+}
+
 // src/generated/schema.ts
 var schema_exports = {};
 
@@ -281,6 +293,7 @@ export {
   getFormatHint,
   isProseHint,
   listAll,
+  renderCmsifyTemplate,
   toMimeType
 };
 //# sourceMappingURL=index.js.map