@bettercms-ai/sdk 1.8.1 → 1.9.0

package/dist/index.d.cts

@@ -850,6 +850,60 @@ declare function decodeStega(value: string): {
 /** Remove any stega payload, returning the clean string. */
 declare function stripStega(value: string): string;
 
+/**
+ * Reading a rich-text field, for any site.
+ *
+ * A `text` field delivers a bare string. A `richtext` field delivers the canonical envelope
+ * `{ format, value, html }`. Those are different shapes, and switching a field's type in the
+ * CMS switches which one your site receives — the Visual Editor offers exactly that switch,
+ * so it happens on live projects. A template that interpolates the value directly then
+ * renders `[object Object]` (or, in React, throws `Objects are not valid as a React child`).
+ *
+ * No payload can be both structured and safe to interpolate, which is why every headless CMS
+ * requires a renderer for rich text. These are ours:
+ *
+ *   plain(v)  → text, for <title>, meta descriptions, JSON-LD, alt text, aria-label
+ *   rich(v)   → HTML, for `set:html` / `dangerouslySetInnerHTML`
+ *
+ * Both accept a bare string, so a field can be switched in the CMS without touching the site.
+ *
+ *   <h1 set:html={rich(page.heroTitle)} />                       // Astro
+ *   <h1 dangerouslySetInnerHTML={{ __html: rich(f.heroTitle) }}/> // React
+ *   seo({ title: plain(page.heroTitle) })
+ */
+/** The canonical rich-text envelope returned by the Delivery API. */
+interface RichTextValue {
+    readonly format?: string;
+    readonly value?: unknown;
+    /** Server-rendered, sanitized HTML. Computed on write. */
+    readonly html?: string;
+}
+/**
+ * A field that may arrive as either shape. Type author-editable text fields with this and the
+ * compiler routes you through `plain()`/`rich()`, so a type switch in the CMS can never reach
+ * production as `[object Object]`.
+ */
+type TextOrRich = string | RichTextValue | null | undefined;
+/** True when the value is a rich-text envelope rather than a bare string. */
+declare function isRichText(value: unknown): value is RichTextValue;
+/**
+ * Plain text for an attribute context — `<title>`, meta description, JSON-LD, `alt`.
+ * Strips tags and decodes the entities that survive stripping, so the result is text the
+ * consumer can escape once without double-escaping.
+ */
+declare function plain(value: TextOrRich): string;
+/**
+ * Renderable HTML. Rich text keeps its inline marks (the server sanitizes `html` on write);
+ * a bare string is escaped, so a plain field can never inject markup.
+ *
+ * A lone wrapping block is unwrapped: a field switched from `text` stores its value as
+ * `<p>…</p>`, but it renders inside the element that already is the block — and
+ * `<h1><p>…</p></h1>` is invalid, the parser closes the heading at the `<p>` and the text
+ * falls out of it. Values with real block structure (several paragraphs, a list) are left
+ * alone, so a body field still renders as a document.
+ */
+declare function rich(value: TextOrRich, fallback?: string): string;
+
 /**
  * resolveSeo — framework-agnostic page-over-site SEO merge for headless consumers.
  *
@@ -1121,4 +1175,4 @@ declare function inviteMember(client: BetterCMSAdminClient, workspaceId: string,
 declare function updateMemberRole(client: BetterCMSAdminClient, workspaceId: string, memberId: string, role: MemberRole): Promise<Member>;
 declare function removeMember(client: BetterCMSAdminClient, workspaceId: string, memberId: string): Promise<void>;
 
-export { type AddPageFieldsInput, type ApiKeyUsage, type ApiKeyWithRaw, type AuthResult, BetterCMSError as BCMSClientError, ErrorCodes as BCMSErrorCodes, BetterCMS, BetterCMSAdminClient, type BetterCMSAdminOptions, BetterCMSDeliveryClient, BetterCMSError, BetterCMSManagementClient, type BetterCMSManagementOptions, type BetterCMSReadClient, type BetterCMSSiteOptions, type CreateApiKeyInput, type CreateClientOptions, type CreateEntryInput, type CreateFormInput, type CreateManagedPageInput, type CreateModelInput, type CreatePageInput, type CreateWorkspaceInput, type DeliveryForm, type DeliveryFormField, type DeliveryFormFieldType, ErrorCodes, type FormFieldInput, type FormListOptions, type FormSubmitError, type FormValue, type FormValues, type GetEntryOptions, type ListContentAllOptions, type ListContentOptions, type ListEntriesFilter, type ListEntriesOptions, type ListPagesOptions, type ManagedComponent, type ManagedComponentInput, type ManagedContentEntry, type ManagedContentModel, type ManagedForm, type ManagedFormInput, type ManagedPage, type ManagementClient, type MediaListOptions, type MediaMetadata, type Member, type MemberRole, type PageListOptions, type PendingInvite, type ResolvedSeo, type SearchHit, type SearchOptions, type SeoInput, type SeoMeta, type SeoMetaInput, type SetPageContentInput, type StegaPayload, type SubmissionListOptions, type SubmitFormOptions, type SubmitFormResult, type UpdateApiKeyInput, type UpdateEntryInput, type UpdateFormInput, type UpdateModelInput, type UpdatePageInput, type UpdateWorkspaceInput, type UploadAssetInput, type UploadedAsset, type WriteContentInput, addModelFields, addPageFields, createApiKey, createClient, createEntry, createForm, createManagedPage, createModel, createPage, createWorkspace, decodeStega, deleteForm, deleteMedia, deletePage, deleteSubmission, deleteWorkspace, encodeStega, formInitialValues, getApiKeyUsage, getEntry, getForm, getManagedPage, getMedia, getMember, getModel, getPage, getSubmission, getWorkspace, inviteMember, listApiKeys, listEntries, listForms, listManagedPages, listMedia, listMembers, listModels, listPages, listSubmissions, listWorkspaces, publishPage, regenerateApiKey, removeMember, resolveSeo, revokeApiKey, search, setPageContent, shouldShowField, signIn, signInWithGithub, signInWithGoogle, signUp, stripStega, submitForm, updateApiKey, updateEntry, updateForm, updateMemberRole, updateModel, updatePage, updateWorkspace, uploadMedia };
+export { type AddPageFieldsInput, type ApiKeyUsage, type ApiKeyWithRaw, type AuthResult, BetterCMSError as BCMSClientError, ErrorCodes as BCMSErrorCodes, BetterCMS, BetterCMSAdminClient, type BetterCMSAdminOptions, BetterCMSDeliveryClient, BetterCMSError, BetterCMSManagementClient, type BetterCMSManagementOptions, type BetterCMSReadClient, type BetterCMSSiteOptions, type CreateApiKeyInput, type CreateClientOptions, type CreateEntryInput, type CreateFormInput, type CreateManagedPageInput, type CreateModelInput, type CreatePageInput, type CreateWorkspaceInput, type DeliveryForm, type DeliveryFormField, type DeliveryFormFieldType, ErrorCodes, type FormFieldInput, type FormListOptions, type FormSubmitError, type FormValue, type FormValues, type GetEntryOptions, type ListContentAllOptions, type ListContentOptions, type ListEntriesFilter, type ListEntriesOptions, type ListPagesOptions, type ManagedComponent, type ManagedComponentInput, type ManagedContentEntry, type ManagedContentModel, type ManagedForm, type ManagedFormInput, type ManagedPage, type ManagementClient, type MediaListOptions, type MediaMetadata, type Member, type MemberRole, type PageListOptions, type PendingInvite, type ResolvedSeo, type RichTextValue, type SearchHit, type SearchOptions, type SeoInput, type SeoMeta, type SeoMetaInput, type SetPageContentInput, type StegaPayload, type SubmissionListOptions, type SubmitFormOptions, type SubmitFormResult, type TextOrRich, type UpdateApiKeyInput, type UpdateEntryInput, type UpdateFormInput, type UpdateModelInput, type UpdatePageInput, type UpdateWorkspaceInput, type UploadAssetInput, type UploadedAsset, type WriteContentInput, addModelFields, addPageFields, createApiKey, createClient, createEntry, createForm, createManagedPage, createModel, createPage, createWorkspace, decodeStega, deleteForm, deleteMedia, deletePage, deleteSubmission, deleteWorkspace, encodeStega, formInitialValues, getApiKeyUsage, getEntry, getForm, getManagedPage, getMedia, getMember, getModel, getPage, getSubmission, getWorkspace, inviteMember, isRichText, listApiKeys, listEntries, listForms, listManagedPages, listMedia, listMembers, listModels, listPages, listSubmissions, listWorkspaces, plain, publishPage, regenerateApiKey, removeMember, resolveSeo, revokeApiKey, rich, search, setPageContent, shouldShowField, signIn, signInWithGithub, signInWithGoogle, signUp, stripStega, submitForm, updateApiKey, updateEntry, updateForm, updateMemberRole, updateModel, updatePage, updateWorkspace, uploadMedia };

package/dist/index.d.ts

@@ -850,6 +850,60 @@ declare function decodeStega(value: string): {
 /** Remove any stega payload, returning the clean string. */
 declare function stripStega(value: string): string;
 
+/**
+ * Reading a rich-text field, for any site.
+ *
+ * A `text` field delivers a bare string. A `richtext` field delivers the canonical envelope
+ * `{ format, value, html }`. Those are different shapes, and switching a field's type in the
+ * CMS switches which one your site receives — the Visual Editor offers exactly that switch,
+ * so it happens on live projects. A template that interpolates the value directly then
+ * renders `[object Object]` (or, in React, throws `Objects are not valid as a React child`).
+ *
+ * No payload can be both structured and safe to interpolate, which is why every headless CMS
+ * requires a renderer for rich text. These are ours:
+ *
+ *   plain(v)  → text, for <title>, meta descriptions, JSON-LD, alt text, aria-label
+ *   rich(v)   → HTML, for `set:html` / `dangerouslySetInnerHTML`
+ *
+ * Both accept a bare string, so a field can be switched in the CMS without touching the site.
+ *
+ *   <h1 set:html={rich(page.heroTitle)} />                       // Astro
+ *   <h1 dangerouslySetInnerHTML={{ __html: rich(f.heroTitle) }}/> // React
+ *   seo({ title: plain(page.heroTitle) })
+ */
+/** The canonical rich-text envelope returned by the Delivery API. */
+interface RichTextValue {
+    readonly format?: string;
+    readonly value?: unknown;
+    /** Server-rendered, sanitized HTML. Computed on write. */
+    readonly html?: string;
+}
+/**
+ * A field that may arrive as either shape. Type author-editable text fields with this and the
+ * compiler routes you through `plain()`/`rich()`, so a type switch in the CMS can never reach
+ * production as `[object Object]`.
+ */
+type TextOrRich = string | RichTextValue | null | undefined;
+/** True when the value is a rich-text envelope rather than a bare string. */
+declare function isRichText(value: unknown): value is RichTextValue;
+/**
+ * Plain text for an attribute context — `<title>`, meta description, JSON-LD, `alt`.
+ * Strips tags and decodes the entities that survive stripping, so the result is text the
+ * consumer can escape once without double-escaping.
+ */
+declare function plain(value: TextOrRich): string;
+/**
+ * Renderable HTML. Rich text keeps its inline marks (the server sanitizes `html` on write);
+ * a bare string is escaped, so a plain field can never inject markup.
+ *
+ * A lone wrapping block is unwrapped: a field switched from `text` stores its value as
+ * `<p>…</p>`, but it renders inside the element that already is the block — and
+ * `<h1><p>…</p></h1>` is invalid, the parser closes the heading at the `<p>` and the text
+ * falls out of it. Values with real block structure (several paragraphs, a list) are left
+ * alone, so a body field still renders as a document.
+ */
+declare function rich(value: TextOrRich, fallback?: string): string;
+
 /**
  * resolveSeo — framework-agnostic page-over-site SEO merge for headless consumers.
  *
@@ -1121,4 +1175,4 @@ declare function inviteMember(client: BetterCMSAdminClient, workspaceId: string,
 declare function updateMemberRole(client: BetterCMSAdminClient, workspaceId: string, memberId: string, role: MemberRole): Promise<Member>;
 declare function removeMember(client: BetterCMSAdminClient, workspaceId: string, memberId: string): Promise<void>;
 
-export { type AddPageFieldsInput, type ApiKeyUsage, type ApiKeyWithRaw, type AuthResult, BetterCMSError as BCMSClientError, ErrorCodes as BCMSErrorCodes, BetterCMS, BetterCMSAdminClient, type BetterCMSAdminOptions, BetterCMSDeliveryClient, BetterCMSError, BetterCMSManagementClient, type BetterCMSManagementOptions, type BetterCMSReadClient, type BetterCMSSiteOptions, type CreateApiKeyInput, type CreateClientOptions, type CreateEntryInput, type CreateFormInput, type CreateManagedPageInput, type CreateModelInput, type CreatePageInput, type CreateWorkspaceInput, type DeliveryForm, type DeliveryFormField, type DeliveryFormFieldType, ErrorCodes, type FormFieldInput, type FormListOptions, type FormSubmitError, type FormValue, type FormValues, type GetEntryOptions, type ListContentAllOptions, type ListContentOptions, type ListEntriesFilter, type ListEntriesOptions, type ListPagesOptions, type ManagedComponent, type ManagedComponentInput, type ManagedContentEntry, type ManagedContentModel, type ManagedForm, type ManagedFormInput, type ManagedPage, type ManagementClient, type MediaListOptions, type MediaMetadata, type Member, type MemberRole, type PageListOptions, type PendingInvite, type ResolvedSeo, type SearchHit, type SearchOptions, type SeoInput, type SeoMeta, type SeoMetaInput, type SetPageContentInput, type StegaPayload, type SubmissionListOptions, type SubmitFormOptions, type SubmitFormResult, type UpdateApiKeyInput, type UpdateEntryInput, type UpdateFormInput, type UpdateModelInput, type UpdatePageInput, type UpdateWorkspaceInput, type UploadAssetInput, type UploadedAsset, type WriteContentInput, addModelFields, addPageFields, createApiKey, createClient, createEntry, createForm, createManagedPage, createModel, createPage, createWorkspace, decodeStega, deleteForm, deleteMedia, deletePage, deleteSubmission, deleteWorkspace, encodeStega, formInitialValues, getApiKeyUsage, getEntry, getForm, getManagedPage, getMedia, getMember, getModel, getPage, getSubmission, getWorkspace, inviteMember, listApiKeys, listEntries, listForms, listManagedPages, listMedia, listMembers, listModels, listPages, listSubmissions, listWorkspaces, publishPage, regenerateApiKey, removeMember, resolveSeo, revokeApiKey, search, setPageContent, shouldShowField, signIn, signInWithGithub, signInWithGoogle, signUp, stripStega, submitForm, updateApiKey, updateEntry, updateForm, updateMemberRole, updateModel, updatePage, updateWorkspace, uploadMedia };
+export { type AddPageFieldsInput, type ApiKeyUsage, type ApiKeyWithRaw, type AuthResult, BetterCMSError as BCMSClientError, ErrorCodes as BCMSErrorCodes, BetterCMS, BetterCMSAdminClient, type BetterCMSAdminOptions, BetterCMSDeliveryClient, BetterCMSError, BetterCMSManagementClient, type BetterCMSManagementOptions, type BetterCMSReadClient, type BetterCMSSiteOptions, type CreateApiKeyInput, type CreateClientOptions, type CreateEntryInput, type CreateFormInput, type CreateManagedPageInput, type CreateModelInput, type CreatePageInput, type CreateWorkspaceInput, type DeliveryForm, type DeliveryFormField, type DeliveryFormFieldType, ErrorCodes, type FormFieldInput, type FormListOptions, type FormSubmitError, type FormValue, type FormValues, type GetEntryOptions, type ListContentAllOptions, type ListContentOptions, type ListEntriesFilter, type ListEntriesOptions, type ListPagesOptions, type ManagedComponent, type ManagedComponentInput, type ManagedContentEntry, type ManagedContentModel, type ManagedForm, type ManagedFormInput, type ManagedPage, type ManagementClient, type MediaListOptions, type MediaMetadata, type Member, type MemberRole, type PageListOptions, type PendingInvite, type ResolvedSeo, type RichTextValue, type SearchHit, type SearchOptions, type SeoInput, type SeoMeta, type SeoMetaInput, type SetPageContentInput, type StegaPayload, type SubmissionListOptions, type SubmitFormOptions, type SubmitFormResult, type TextOrRich, type UpdateApiKeyInput, type UpdateEntryInput, type UpdateFormInput, type UpdateModelInput, type UpdatePageInput, type UpdateWorkspaceInput, type UploadAssetInput, type UploadedAsset, type WriteContentInput, addModelFields, addPageFields, createApiKey, createClient, createEntry, createForm, createManagedPage, createModel, createPage, createWorkspace, decodeStega, deleteForm, deleteMedia, deletePage, deleteSubmission, deleteWorkspace, encodeStega, formInitialValues, getApiKeyUsage, getEntry, getForm, getManagedPage, getMedia, getMember, getModel, getPage, getSubmission, getWorkspace, inviteMember, isRichText, listApiKeys, listEntries, listForms, listManagedPages, listMedia, listMembers, listModels, listPages, listSubmissions, listWorkspaces, plain, publishPage, regenerateApiKey, removeMember, resolveSeo, revokeApiKey, rich, search, setPageContent, shouldShowField, signIn, signInWithGithub, signInWithGoogle, signUp, stripStega, submitForm, updateApiKey, updateEntry, updateForm, updateMemberRole, updateModel, updatePage, updateWorkspace, uploadMedia };

package/dist/index.js

@@ -1150,6 +1150,30 @@ function stripStega(value) {
   return value.replace(FRAME, "");
 }
 
+// src/richtext.ts
+function isRichText(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value) && ("html" in value || "format" in value);
+}
+function plain(value) {
+  if (typeof value === "string") return value;
+  if (!isRichText(value) || typeof value.html !== "string") return "";
+  return decodeEntities(value.html.replace(/<[^>]+>/g, "")).trim();
+}
+function rich(value, fallback = "") {
+  const html = (typeof value === "string" ? escapeHtml(value) : isRichText(value) ? value.html ?? "" : "").trim();
+  return html ? unwrapLoneBlock(html) : escapeHtml(fallback);
+}
+function unwrapLoneBlock(html) {
+  const m = html.match(/^<(p|div|h[1-6])(?:\s[^>]*)?>([\s\S]*)<\/\1>$/i);
+  return m && !new RegExp(`</${m[1]}>`, "i").test(m[2]) ? m[2] : html;
+}
+function escapeHtml(s) {
+  return s.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
+}
+function decodeEntities(s) {
+  return s.replace(/&lt;/g, "<").replace(/&gt;/g, ">").replace(/&quot;/g, '"').replace(/&#0?39;/g, "'").replace(/&nbsp;/g, " ").replace(/&amp;/g, "&");
+}
+
 // src/seo.ts
 function jsonLdNodes(schema) {
   if (!schema) return [];
@@ -1522,6 +1546,7 @@ export {
   default2 as imageUrlBuilder,
   inviteMember,
   isBlock,
+  isRichText,
   listApiKeys,
   listEntries,
   listForms2 as listForms,
@@ -1532,11 +1557,13 @@ export {
   listPages,
   listSubmissions,
   listWorkspaces,
+  plain,
   publishPage,
   regenerateApiKey,
   removeMember,
   resolveSeo,
   revokeApiKey,
+  rich,
   search,
   setPageContent,
   shouldShowField,