@bettercms-ai/sdk 1.9.0 → 1.10.0

package/dist/index.d.cts

@@ -444,13 +444,21 @@ declare class BetterCMSError extends Error {
  * vanilla embed and the React component never drift.
  */
 
-/** Field types the delivery API serializes (superset of the admin builder). */
-type DeliveryFormFieldType = "text" | "email" | "phone" | "url" | "number" | "date" | "textarea" | "select" | "checkbox" | "consent" | "hidden";
+/**
+ * Field types the delivery API serializes. Must stay equal to the authoring
+ * vocabulary in `packages/db/src/schema/forms.ts` — this list is what every site
+ * renderer switches on, so a type missing HERE renders as a plain text input on
+ * every published site while the builder happily offers it. `radio`/`checkboxes`
+ * were exactly that gap.
+ */
+type DeliveryFormFieldType = "text" | "email" | "phone" | "url" | "number" | "date" | "textarea" | "select" | "radio" | "checkboxes" | "checkbox" | "consent" | "hidden";
 interface DeliveryFormField {
     key: string;
     label: string;
     type: DeliveryFormFieldType;
     placeholder?: string;
+    /** Hint rendered under the control. */
+    helpText?: string;
     required?: boolean;
     options?: string[];
     defaultValue?: string;
@@ -460,6 +468,8 @@ interface DeliveryFormField {
         equals: string;
     };
 }
+/** The pick-many type, whose value is an array rather than a scalar. */
+declare function isMultiValueField(type: DeliveryFormFieldType): boolean;
 /** A form as delivered to a published/imported site. Mirrors the delivery `/forms` payload. */
 interface DeliveryForm {
     id: string;
@@ -471,8 +481,13 @@ interface DeliveryForm {
     turnstileEnabled?: boolean;
     honeypotField?: string | null;
 }
-type FormValue = string | boolean;
+/** `string[]` is the `checkboxes` (pick-many) value; every other type is scalar. */
+type FormValue = string | boolean | string[];
 type FormValues = Record<string, FormValue>;
+/** Read a `checkboxes` value defensively — stored data may predate the array shape. */
+declare function asStringArray(value: FormValue | undefined): string[];
+/** Add/remove `option` from a `checkboxes` value, preserving the field's option order. */
+declare function toggleOption(value: FormValue | undefined, option: string, on: boolean): string[];
 /**
  * Conditional visibility. A `showIf` field is shown only when its trigger field's
  * current value equals the target; non-conditional fields are always shown. The
@@ -481,8 +496,9 @@ type FormValues = Record<string, FormValue>;
  */
 declare function shouldShowField(field: DeliveryFormField, values: FormValues): boolean;
 /**
- * Build the initial value map: checkbox/consent default to false, every other field
- * to its `defaultValue`, with `prefill` (e.g. URL query params) taking precedence.
+ * Build the initial value map: checkbox/consent default to false, checkboxes to an
+ * empty array, every other field to its `defaultValue`, with `prefill` (e.g. URL
+ * query params) taking precedence.
  */
 declare function formInitialValues(form: DeliveryForm, prefill?: Record<string, string>): FormValues;
 interface SubmitFormOptions {
@@ -1175,4 +1191,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 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 };
+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, asStringArray, 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, 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 };

package/dist/index.d.ts

@@ -444,13 +444,21 @@ declare class BetterCMSError extends Error {
  * vanilla embed and the React component never drift.
  */
 
-/** Field types the delivery API serializes (superset of the admin builder). */
-type DeliveryFormFieldType = "text" | "email" | "phone" | "url" | "number" | "date" | "textarea" | "select" | "checkbox" | "consent" | "hidden";
+/**
+ * Field types the delivery API serializes. Must stay equal to the authoring
+ * vocabulary in `packages/db/src/schema/forms.ts` — this list is what every site
+ * renderer switches on, so a type missing HERE renders as a plain text input on
+ * every published site while the builder happily offers it. `radio`/`checkboxes`
+ * were exactly that gap.
+ */
+type DeliveryFormFieldType = "text" | "email" | "phone" | "url" | "number" | "date" | "textarea" | "select" | "radio" | "checkboxes" | "checkbox" | "consent" | "hidden";
 interface DeliveryFormField {
     key: string;
     label: string;
     type: DeliveryFormFieldType;
     placeholder?: string;
+    /** Hint rendered under the control. */
+    helpText?: string;
     required?: boolean;
     options?: string[];
     defaultValue?: string;
@@ -460,6 +468,8 @@ interface DeliveryFormField {
         equals: string;
     };
 }
+/** The pick-many type, whose value is an array rather than a scalar. */
+declare function isMultiValueField(type: DeliveryFormFieldType): boolean;
 /** A form as delivered to a published/imported site. Mirrors the delivery `/forms` payload. */
 interface DeliveryForm {
     id: string;
@@ -471,8 +481,13 @@ interface DeliveryForm {
     turnstileEnabled?: boolean;
     honeypotField?: string | null;
 }
-type FormValue = string | boolean;
+/** `string[]` is the `checkboxes` (pick-many) value; every other type is scalar. */
+type FormValue = string | boolean | string[];
 type FormValues = Record<string, FormValue>;
+/** Read a `checkboxes` value defensively — stored data may predate the array shape. */
+declare function asStringArray(value: FormValue | undefined): string[];
+/** Add/remove `option` from a `checkboxes` value, preserving the field's option order. */
+declare function toggleOption(value: FormValue | undefined, option: string, on: boolean): string[];
 /**
  * Conditional visibility. A `showIf` field is shown only when its trigger field's
  * current value equals the target; non-conditional fields are always shown. The
@@ -481,8 +496,9 @@ type FormValues = Record<string, FormValue>;
  */
 declare function shouldShowField(field: DeliveryFormField, values: FormValues): boolean;
 /**
- * Build the initial value map: checkbox/consent default to false, every other field
- * to its `defaultValue`, with `prefill` (e.g. URL query params) taking precedence.
+ * Build the initial value map: checkbox/consent default to false, checkboxes to an
+ * empty array, every other field to its `defaultValue`, with `prefill` (e.g. URL
+ * query params) taking precedence.
  */
 declare function formInitialValues(form: DeliveryForm, prefill?: Record<string, string>): FormValues;
 interface SubmitFormOptions {
@@ -1175,4 +1191,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 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 };
+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, asStringArray, 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, 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 };

package/dist/index.js

@@ -1457,16 +1457,33 @@ async function removeMember(client, workspaceId, memberId) {
 }
 
 // src/forms.ts
+function isMultiValueField(type) {
+  return type === "checkboxes";
+}
+function asStringArray(value) {
+  if (Array.isArray(value)) return value;
+  return value ? [String(value)] : [];
+}
+function toggleOption(value, option, on) {
+  const current = asStringArray(value);
+  if (on) return current.includes(option) ? current : [...current, option];
+  return current.filter((v) => v !== option);
+}
 var DEFAULT_BASE_URL5 = "https://api.bettercms.ai";
 function shouldShowField(field, values) {
   if (!field.showIf) return true;
-  return String(values[field.showIf.field] ?? "") === field.showIf.equals;
+  const trigger = values[field.showIf.field];
+  if (Array.isArray(trigger)) return trigger.includes(field.showIf.equals);
+  return String(trigger ?? "") === field.showIf.equals;
 }
 function formInitialValues(form, prefill = {}) {
   const values = {};
   for (const field of form.fields) {
     if (field.type === "checkbox" || field.type === "consent") {
       values[field.key] = false;
+    } else if (field.type === "checkboxes") {
+      const seed = prefill[field.key] ?? field.defaultValue ?? "";
+      values[field.key] = seed ? seed.split(",").map((v) => v.trim()).filter(Boolean) : [];
     } else {
       values[field.key] = prefill[field.key] ?? field.defaultValue ?? "";
     }
@@ -1515,6 +1532,7 @@ export {
   ErrorCodes,
   addModelFields,
   addPageFields,
+  asStringArray,
   createApiKey,
   createClient,
   createEntry,
@@ -1546,6 +1564,7 @@ export {
   default2 as imageUrlBuilder,
   inviteMember,
   isBlock,
+  isMultiValueField,
   isRichText,
   listApiKeys,
   listEntries,
@@ -1573,6 +1592,7 @@ export {
   signUp,
   stripStega,
   submitForm,
+  toggleOption,
   updateApiKey,
   updateEntry,
   updateForm2 as updateForm,