@bettercms-ai/sdk 1.10.0 → 1.11.0

package/dist/index.d.cts

@@ -274,6 +274,14 @@ interface CreateModelInput {
     description?: string;
     fields?: ContentModelField[];
     projectId?: string;
+    /**
+     * 'model' (default) = a collection with entries of its own. 'block' = a type instantiable
+     * only inside another model's `modular` field; entry creation against it is refused.
+     *
+     * CREATE-ONLY, and absent from UpdateModelInput on purpose: flipping a populated model into
+     * a block would orphan every entry it already has.
+     */
+    kind?: "model" | "block";
 }
 interface UpdateModelInput {
     name?: string;
@@ -584,6 +592,27 @@ interface ManagedComponentInput {
     blockJson?: unknown[];
     props?: unknown[];
 }
+/**
+ * A set of sections that repeat across the project's pages, proposed as one component.
+ * Derived per request from the pages' DRAFT blocks — never stored.
+ */
+interface ExtractionCandidate {
+    /** Identifies the shape. Pass it back to `extractComponent`; it is re-verified server-side. */
+    hash: string;
+    blockType: string;
+    uses: number;
+    suggestedName: string;
+    blockJson: unknown[];
+    /** The leaves that differ between copies, which become the component's editable props. */
+    props: unknown[];
+    sites: {
+        pageId: string;
+        title: string;
+        slug: string;
+        blockId: string;
+        overrides: Record<string, unknown>;
+    }[];
+}
 
 /**
  * Management API SDK methods — AI content + SEO actions (Option B, portable skill).
@@ -687,6 +716,18 @@ declare class BetterCMSManagementClient extends BetterCMSDeliveryClient {
     getComponent(id: string): Promise<ManagedComponent>;
     createComponent(input: ManagedComponentInput): Promise<ManagedComponent>;
     updateComponent(id: string, input: ManagedComponentInput): Promise<ManagedComponent>;
+    /** Sections repeating across the project's pages, proposed as components. */
+    listExtractionCandidates(projectId?: string): Promise<ExtractionCandidate[]>;
+    /** Fold one candidate into a component and repoint every occurrence at it. */
+    extractComponent(input: {
+        hash: string;
+        name: string;
+        slug: string;
+        projectId?: string;
+    }): Promise<{
+        component: ManagedComponent;
+        replaced: number;
+    }>;
     /** Write, rewrite, or translate a piece of copy. Returns the suggested text. */
     writeContent(input: WriteContentInput): Promise<string>;
     /** Generate SEO metadata for a piece of content (title, description, keywords, JSON-LD). */
@@ -887,12 +928,42 @@ declare function stripStega(value: string): string;
  *   <h1 dangerouslySetInnerHTML={{ __html: rich(f.heroTitle) }}/> // React
  *   seo({ title: plain(page.heroTitle) })
  */
+/**
+ * A block in a Body field's `doc`. Bounded vocabulary — the server only emits what it can
+ * parse back, so an unknown `type` means your SDK is older than the content, not that the
+ * content is malformed. Handle the default case rather than exhausting on it.
+ */
+type DocBlock = {
+    /**
+     * Stable within THIS document only — never a global key. Two different entries both have a
+     * block called "0.0". A cross-document anchor is (entryId, fieldKey, id).
+     *
+     * Ids on content authored before block ids existed are derived from position, so they SHIFT
+     * when that document is edited. Do not persist an id as a bookmark unless you know it came
+     * from the editor rather than from the positional fallback.
+     */
+    readonly id: string;
+    readonly type: string;
+    readonly [key: string]: unknown;
+};
+/** The `doc` rendition of a Body field — a versioned block array. */
+type DocValue = {
+    readonly version: 1;
+    readonly blocks: readonly DocBlock[];
+};
 /** 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;
+    /**
+     * Structured blocks — present on `document` (Body) fields only, and NOT guaranteed even
+     * there: it is derived at write time, so an entry saved before this existed carries none
+     * until its next save. There is no backfill. Always branch on its absence; `html` is the
+     * field that is always there.
+     */
+    readonly doc?: DocValue;
 }
 /**
  * A field that may arrive as either shape. Type author-editable text fields with this and the
@@ -1191,4 +1262,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, 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 };
+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 ExtractionCandidate, 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

@@ -274,6 +274,14 @@ interface CreateModelInput {
     description?: string;
     fields?: ContentModelField[];
     projectId?: string;
+    /**
+     * 'model' (default) = a collection with entries of its own. 'block' = a type instantiable
+     * only inside another model's `modular` field; entry creation against it is refused.
+     *
+     * CREATE-ONLY, and absent from UpdateModelInput on purpose: flipping a populated model into
+     * a block would orphan every entry it already has.
+     */
+    kind?: "model" | "block";
 }
 interface UpdateModelInput {
     name?: string;
@@ -584,6 +592,27 @@ interface ManagedComponentInput {
     blockJson?: unknown[];
     props?: unknown[];
 }
+/**
+ * A set of sections that repeat across the project's pages, proposed as one component.
+ * Derived per request from the pages' DRAFT blocks — never stored.
+ */
+interface ExtractionCandidate {
+    /** Identifies the shape. Pass it back to `extractComponent`; it is re-verified server-side. */
+    hash: string;
+    blockType: string;
+    uses: number;
+    suggestedName: string;
+    blockJson: unknown[];
+    /** The leaves that differ between copies, which become the component's editable props. */
+    props: unknown[];
+    sites: {
+        pageId: string;
+        title: string;
+        slug: string;
+        blockId: string;
+        overrides: Record<string, unknown>;
+    }[];
+}
 
 /**
  * Management API SDK methods — AI content + SEO actions (Option B, portable skill).
@@ -687,6 +716,18 @@ declare class BetterCMSManagementClient extends BetterCMSDeliveryClient {
     getComponent(id: string): Promise<ManagedComponent>;
     createComponent(input: ManagedComponentInput): Promise<ManagedComponent>;
     updateComponent(id: string, input: ManagedComponentInput): Promise<ManagedComponent>;
+    /** Sections repeating across the project's pages, proposed as components. */
+    listExtractionCandidates(projectId?: string): Promise<ExtractionCandidate[]>;
+    /** Fold one candidate into a component and repoint every occurrence at it. */
+    extractComponent(input: {
+        hash: string;
+        name: string;
+        slug: string;
+        projectId?: string;
+    }): Promise<{
+        component: ManagedComponent;
+        replaced: number;
+    }>;
     /** Write, rewrite, or translate a piece of copy. Returns the suggested text. */
     writeContent(input: WriteContentInput): Promise<string>;
     /** Generate SEO metadata for a piece of content (title, description, keywords, JSON-LD). */
@@ -887,12 +928,42 @@ declare function stripStega(value: string): string;
  *   <h1 dangerouslySetInnerHTML={{ __html: rich(f.heroTitle) }}/> // React
  *   seo({ title: plain(page.heroTitle) })
  */
+/**
+ * A block in a Body field's `doc`. Bounded vocabulary — the server only emits what it can
+ * parse back, so an unknown `type` means your SDK is older than the content, not that the
+ * content is malformed. Handle the default case rather than exhausting on it.
+ */
+type DocBlock = {
+    /**
+     * Stable within THIS document only — never a global key. Two different entries both have a
+     * block called "0.0". A cross-document anchor is (entryId, fieldKey, id).
+     *
+     * Ids on content authored before block ids existed are derived from position, so they SHIFT
+     * when that document is edited. Do not persist an id as a bookmark unless you know it came
+     * from the editor rather than from the positional fallback.
+     */
+    readonly id: string;
+    readonly type: string;
+    readonly [key: string]: unknown;
+};
+/** The `doc` rendition of a Body field — a versioned block array. */
+type DocValue = {
+    readonly version: 1;
+    readonly blocks: readonly DocBlock[];
+};
 /** 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;
+    /**
+     * Structured blocks — present on `document` (Body) fields only, and NOT guaranteed even
+     * there: it is derived at write time, so an entry saved before this existed carries none
+     * until its next save. There is no backfill. Always branch on its absence; `html` is the
+     * field that is always there.
+     */
+    readonly doc?: DocValue;
 }
 /**
  * A field that may arrive as either shape. Type author-editable text fields with this and the
@@ -1191,4 +1262,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, 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 };
+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 ExtractionCandidate, 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

@@ -664,6 +664,21 @@ async function createComponent(client, input) {
   });
   return res.data;
 }
+async function listExtractionCandidates(client, projectId) {
+  const qs3 = projectId ? `?projectId=${encodeURIComponent(projectId)}` : "";
+  const res = await client.fetchJSON(
+    client.url(`/management/components/extraction-candidates${qs3}`),
+    { method: "GET" }
+  );
+  return res.data;
+}
+async function extractComponent(client, input) {
+  const res = await client.fetchJSON(
+    client.url("/management/components/extract"),
+    { method: "POST", body: JSON.stringify(input) }
+  );
+  return { component: res.data, replaced: res.replaced };
+}
 async function updateComponent(client, id, input) {
   const res = await client.fetchJSON(
     client.url(`/management/components/${id}`),
@@ -852,6 +867,14 @@ var BetterCMSManagementClient = class extends BetterCMSDeliveryClient {
   updateComponent(id, input) {
     return updateComponent(this, id, input);
   }
+  /** Sections repeating across the project's pages, proposed as components. */
+  listExtractionCandidates(projectId) {
+    return listExtractionCandidates(this, projectId);
+  }
+  /** Fold one candidate into a component and repoint every occurrence at it. */
+  extractComponent(input) {
+    return extractComponent(this, input);
+  }
   // ── AI (Option B): write/rewrite/translate copy + generate SEO meta (BYOK-metered) ──
   /** Write, rewrite, or translate a piece of copy. Returns the suggested text. */
   writeContent(input) {