@bettercms-ai/sdk 1.13.0 → 1.13.2

package/dist/index.d.cts

@@ -680,6 +680,7 @@ interface SeoMeta {
 
 type ManagedLayoutDocument = {
     scope: "global";
+    copy?: "draft" | "published";
     revision: number;
     etag: string;
     status: string;
@@ -687,6 +688,7 @@ type ManagedLayoutDocument = {
     data: LayoutDataDocument;
 } | {
     scope: "page";
+    copy?: "draft" | "published";
     pageId: string;
     pageSlug: string;
     revision: number;
@@ -703,6 +705,9 @@ interface ManagedLayoutClient {
 interface GetManagedLayoutOptions {
     scope?: "global" | "page";
     pageId?: string;
+    /** Which copy to read — default draft. A publish claim verifies ONLY against the
+     *  published copy; check the response's `copy` echo (FLO-1188). */
+    copy?: "draft" | "published";
     /** Required when the management credential is workspace-scoped. */
     projectId?: string;
 }
@@ -1043,6 +1048,24 @@ interface RichTextValue {
      */
     readonly doc?: DocValue;
 }
+/** The marker on a Portable Text envelope. `format` is a plain string, never a union — see below. */
+declare const PORTABLE_TEXT_FORMAT = "portable-text-1";
+/**
+ * Structured blocks, when the field stores Portable Text.
+ *
+ * ── The compatibility guarantee, stated once ────────────────────────────────────────────
+ * Portable Text did NOT change this envelope. `format`, `value` and `html` are the same three
+ * keys they always were, so `isRichText`, `plain()` and `rich()` keep working untouched — and
+ * they have to, because sites compiled months ago read `.html` directly and cannot be
+ * rebuilt. `bettercms-starter-modern/lib/cms.ts` even carries its OWN copy of `rich()`, baked
+ * into deployments nobody can reach. Storing a bare array instead would have made
+ * `isRichText` return false (it rejects arrays), every shipped `rich()` call return "", and
+ * every one of those pages go blank at 200 OK.
+ *
+ * `portableText()` is therefore ADDITIVE: `html` remains the always-present field, and this is
+ * the opt-in for consumers that want to render structure with `@portabletext/react` instead.
+ */
+declare function portableText(value: TextOrRich): readonly unknown[] | null;
 /**
  * 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
@@ -1357,4 +1380,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 CommandManagedLayoutInput, type CreateApiKeyInput, type CreateClientOptions, type CreateEntryInput, type CreateFormInput, type CreateManagedPageInput, type CreateModelInput, type CreatePageInput, type CreateWorkspaceInput, type DeliveryForm, type DeliveryFormField, type DeliveryFormFieldType, ErrorCodes, type ExtractionCandidate, type FormFieldInput, type FormListOptions, type FormSubmitError, type FormValue, type FormValues, type GetEntryOptions, type GetManagedLayoutOptions, type ListContentAllOptions, type ListContentOptions, type ListEntriesFilter, type ListEntriesOptions, type ListPagesOptions, type ManagedComponent, type ManagedComponentInput, type ManagedContentEntry, type ManagedContentModel, type ManagedForm, type ManagedFormInput, type ManagedLayoutClient, type ManagedLayoutDocument, 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 SeoLocation, 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, asStringArray, commandManagedLayout, createApiKey, createClient, createEntry, createForm, createManagedPage, createModel, createPage, createWorkspace, decodeStega, deleteForm, deleteMedia, deletePage, deleteSubmission, deleteWorkspace, encodeStega, formInitialValues, getApiKeyUsage, getEntry, getForm, getManagedLayout, getManagedPage, getMedia, getMember, getModel, getPage, getSubmission, getWorkspace, inviteMember, isMultiValueField, 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, toggleOption, 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 CommandManagedLayoutInput, type CreateApiKeyInput, type CreateClientOptions, type CreateEntryInput, type CreateFormInput, type CreateManagedPageInput, type CreateModelInput, type CreatePageInput, type CreateWorkspaceInput, type DeliveryForm, type DeliveryFormField, type DeliveryFormFieldType, ErrorCodes, type ExtractionCandidate, type FormFieldInput, type FormListOptions, type FormSubmitError, type FormValue, type FormValues, type GetEntryOptions, type GetManagedLayoutOptions, type ListContentAllOptions, type ListContentOptions, type ListEntriesFilter, type ListEntriesOptions, type ListPagesOptions, type ManagedComponent, type ManagedComponentInput, type ManagedContentEntry, type ManagedContentModel, type ManagedForm, type ManagedFormInput, type ManagedLayoutClient, type ManagedLayoutDocument, type ManagedPage, type ManagementClient, type MediaListOptions, type MediaMetadata, type Member, type MemberRole, PORTABLE_TEXT_FORMAT, type PageListOptions, type PendingInvite, type ResolvedSeo, type RichTextValue, type SearchHit, type SearchOptions, type SeoInput, type SeoLocation, 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, asStringArray, commandManagedLayout, createApiKey, createClient, createEntry, createForm, createManagedPage, createModel, createPage, createWorkspace, decodeStega, deleteForm, deleteMedia, deletePage, deleteSubmission, deleteWorkspace, encodeStega, formInitialValues, getApiKeyUsage, getEntry, getForm, getManagedLayout, getManagedPage, getMedia, getMember, getModel, getPage, getSubmission, getWorkspace, inviteMember, isMultiValueField, isRichText, listApiKeys, listEntries, listForms, listManagedPages, listMedia, listMembers, listModels, listPages, listSubmissions, listWorkspaces, plain, portableText, publishPage, regenerateApiKey, removeMember, resolveSeo, revokeApiKey, rich, search, setPageContent, shouldShowField, signIn, signInWithGithub, signInWithGoogle, signUp, stripStega, submitForm, toggleOption, updateApiKey, updateEntry, updateForm, updateMemberRole, updateModel, updatePage, updateWorkspace, uploadMedia };

package/dist/index.d.ts

@@ -680,6 +680,7 @@ interface SeoMeta {
 
 type ManagedLayoutDocument = {
     scope: "global";
+    copy?: "draft" | "published";
     revision: number;
     etag: string;
     status: string;
@@ -687,6 +688,7 @@ type ManagedLayoutDocument = {
     data: LayoutDataDocument;
 } | {
     scope: "page";
+    copy?: "draft" | "published";
     pageId: string;
     pageSlug: string;
     revision: number;
@@ -703,6 +705,9 @@ interface ManagedLayoutClient {
 interface GetManagedLayoutOptions {
     scope?: "global" | "page";
     pageId?: string;
+    /** Which copy to read — default draft. A publish claim verifies ONLY against the
+     *  published copy; check the response's `copy` echo (FLO-1188). */
+    copy?: "draft" | "published";
     /** Required when the management credential is workspace-scoped. */
     projectId?: string;
 }
@@ -1043,6 +1048,24 @@ interface RichTextValue {
      */
     readonly doc?: DocValue;
 }
+/** The marker on a Portable Text envelope. `format` is a plain string, never a union — see below. */
+declare const PORTABLE_TEXT_FORMAT = "portable-text-1";
+/**
+ * Structured blocks, when the field stores Portable Text.
+ *
+ * ── The compatibility guarantee, stated once ────────────────────────────────────────────
+ * Portable Text did NOT change this envelope. `format`, `value` and `html` are the same three
+ * keys they always were, so `isRichText`, `plain()` and `rich()` keep working untouched — and
+ * they have to, because sites compiled months ago read `.html` directly and cannot be
+ * rebuilt. `bettercms-starter-modern/lib/cms.ts` even carries its OWN copy of `rich()`, baked
+ * into deployments nobody can reach. Storing a bare array instead would have made
+ * `isRichText` return false (it rejects arrays), every shipped `rich()` call return "", and
+ * every one of those pages go blank at 200 OK.
+ *
+ * `portableText()` is therefore ADDITIVE: `html` remains the always-present field, and this is
+ * the opt-in for consumers that want to render structure with `@portabletext/react` instead.
+ */
+declare function portableText(value: TextOrRich): readonly unknown[] | null;
 /**
  * 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
@@ -1357,4 +1380,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 CommandManagedLayoutInput, type CreateApiKeyInput, type CreateClientOptions, type CreateEntryInput, type CreateFormInput, type CreateManagedPageInput, type CreateModelInput, type CreatePageInput, type CreateWorkspaceInput, type DeliveryForm, type DeliveryFormField, type DeliveryFormFieldType, ErrorCodes, type ExtractionCandidate, type FormFieldInput, type FormListOptions, type FormSubmitError, type FormValue, type FormValues, type GetEntryOptions, type GetManagedLayoutOptions, type ListContentAllOptions, type ListContentOptions, type ListEntriesFilter, type ListEntriesOptions, type ListPagesOptions, type ManagedComponent, type ManagedComponentInput, type ManagedContentEntry, type ManagedContentModel, type ManagedForm, type ManagedFormInput, type ManagedLayoutClient, type ManagedLayoutDocument, 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 SeoLocation, 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, asStringArray, commandManagedLayout, createApiKey, createClient, createEntry, createForm, createManagedPage, createModel, createPage, createWorkspace, decodeStega, deleteForm, deleteMedia, deletePage, deleteSubmission, deleteWorkspace, encodeStega, formInitialValues, getApiKeyUsage, getEntry, getForm, getManagedLayout, getManagedPage, getMedia, getMember, getModel, getPage, getSubmission, getWorkspace, inviteMember, isMultiValueField, 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, toggleOption, 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 CommandManagedLayoutInput, type CreateApiKeyInput, type CreateClientOptions, type CreateEntryInput, type CreateFormInput, type CreateManagedPageInput, type CreateModelInput, type CreatePageInput, type CreateWorkspaceInput, type DeliveryForm, type DeliveryFormField, type DeliveryFormFieldType, ErrorCodes, type ExtractionCandidate, type FormFieldInput, type FormListOptions, type FormSubmitError, type FormValue, type FormValues, type GetEntryOptions, type GetManagedLayoutOptions, type ListContentAllOptions, type ListContentOptions, type ListEntriesFilter, type ListEntriesOptions, type ListPagesOptions, type ManagedComponent, type ManagedComponentInput, type ManagedContentEntry, type ManagedContentModel, type ManagedForm, type ManagedFormInput, type ManagedLayoutClient, type ManagedLayoutDocument, type ManagedPage, type ManagementClient, type MediaListOptions, type MediaMetadata, type Member, type MemberRole, PORTABLE_TEXT_FORMAT, type PageListOptions, type PendingInvite, type ResolvedSeo, type RichTextValue, type SearchHit, type SearchOptions, type SeoInput, type SeoLocation, 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, asStringArray, commandManagedLayout, createApiKey, createClient, createEntry, createForm, createManagedPage, createModel, createPage, createWorkspace, decodeStega, deleteForm, deleteMedia, deletePage, deleteSubmission, deleteWorkspace, encodeStega, formInitialValues, getApiKeyUsage, getEntry, getForm, getManagedLayout, getManagedPage, getMedia, getMember, getModel, getPage, getSubmission, getWorkspace, inviteMember, isMultiValueField, isRichText, listApiKeys, listEntries, listForms, listManagedPages, listMedia, listMembers, listModels, listPages, listSubmissions, listWorkspaces, plain, portableText, publishPage, regenerateApiKey, removeMember, resolveSeo, revokeApiKey, rich, search, setPageContent, shouldShowField, signIn, signInWithGithub, signInWithGoogle, signUp, stripStega, submitForm, toggleOption, updateApiKey, updateEntry, updateForm, updateMemberRole, updateModel, updatePage, updateWorkspace, uploadMedia };

package/dist/index.js

@@ -508,7 +508,14 @@ var MIME_BY_EXT = {
   avif: "image/avif",
   mp4: "video/mp4",
   webm: "video/webm",
-  pdf: "application/pdf"
+  pdf: "application/pdf",
+  // mp3/ogg were server-allowed all along; the SDK sent application/octet-stream for them,
+  // which the allowlist then refused — so an agent could never upload audio.
+  mp3: "audio/mpeg",
+  ogg: "audio/ogg",
+  txt: "text/plain",
+  md: "text/markdown",
+  markdown: "text/markdown"
 };
 function basenameOf(p) {
   const clean = p.split(/[?#]/)[0] ?? p;
@@ -717,6 +724,7 @@ async function getManagedLayout(client, opts) {
   const query = new URLSearchParams();
   if (opts?.scope) query.set("scope", opts.scope);
   if (opts?.pageId) query.set("pageId", opts.pageId);
+  if (opts?.copy) query.set("preview", opts.copy);
   const result = await client.fetchJSON(
     client.url(`/management/layout${query.size ? `?${query}` : ""}`),
     opts?.projectId ? { headers: { "X-BCMS-Project": opts.projectId } } : void 0
@@ -1223,6 +1231,12 @@ function stripStega(value) {
 }
 
 // src/richtext.ts
+var PORTABLE_TEXT_FORMAT = "portable-text-1";
+function portableText(value) {
+  if (!isRichText(value)) return null;
+  const v = value;
+  return v.format === PORTABLE_TEXT_FORMAT && Array.isArray(v.value) ? v.value : null;
+}
 function isRichText(value) {
   return typeof value === "object" && value !== null && !Array.isArray(value) && ("html" in value || "format" in value);
 }
@@ -1610,6 +1624,7 @@ export {
   BetterCMSError,
   BetterCMSManagementClient,
   ErrorCodes,
+  PORTABLE_TEXT_FORMAT,
   addModelFields,
   addPageFields,
   asStringArray,
@@ -1659,6 +1674,7 @@ export {
   listSubmissions,
   listWorkspaces,
   plain,
+  portableText,
   publishPage,
   regenerateApiKey,
   removeMember,