@bettercms-ai/sdk 1.12.0 → 1.13.0

package/dist/index.d.cts

@@ -476,6 +476,20 @@ interface DeliveryFormField {
         field: string;
         equals: string;
     };
+    /**
+     * Per-field rules the API enforces on submit. Renderers should mirror them onto the
+     * native control (`min`/`max`/`pattern`) so the browser reports them before the round
+     * trip — the server check is the one that counts.
+     */
+    validation?: DeliveryFormFieldValidation;
+}
+/** @see FormFieldValidation in @bettercms-ai/types — same shape, delivered to the site. */
+interface DeliveryFormFieldValidation {
+    emailPolicy?: "any" | "business";
+    min?: number;
+    max?: number;
+    phoneFormat?: "any" | "e164";
+    pattern?: string;
 }
 /** The pick-many type, whose value is an array rather than a scalar. */
 declare function isMultiValueField(type: DeliveryFormFieldType): boolean;
@@ -1081,7 +1095,11 @@ interface SeoInput {
 interface ResolvedSeo {
     title: string;
     description: string;
-    /** Canonical URL — page's own `canonical`, else "". Consumers may supply their own base. */
+    /**
+     * Canonical URL — the page's own `canonical`, else `siteUrl` + `path` when both are given,
+     * else "". Empty means the consumer must omit the tag: a RELATIVE canonical is worse than
+     * none at all.
+     */
     canonical: string;
     og: {
         title: string;
@@ -1100,11 +1118,24 @@ interface ResolvedSeo {
     /** JSON-LD nodes (site schema first, then the page's), already flattened + de-empted. */
     jsonLd: Array<Record<string, unknown>>;
 }
+/** Where this page lives, so a canonical can be derived when the page sets none. */
+interface SeoLocation {
+    /** Absolute site origin, e.g. `https://acme.com`. Trailing slash optional. */
+    siteUrl?: string;
+    /** This page's path, e.g. `/about` or `/`. */
+    path?: string;
+}
 /**
- * Merge a page's own SEO over the site defaults. Identical precedence to the server's
- * `mergeSeoMeta`: page meta wins, then site defaults, then sensible fallbacks.
+ * Merge a page's own SEO over the site defaults: page meta wins, then site defaults, then
+ * sensible fallbacks.
+ *
+ * The CANONICAL is the one field that cannot be resolved from content alone, and getting this
+ * wrong is silent. The hosted renderer (`mergeSeoMeta` in the backend) falls back to a canonical
+ * it derives from the request's own origin and path — headless consumers have no request, so
+ * they must pass `location`. Without it this returns "" and the caller ships no
+ * `<link rel="canonical">` and no `og:url`, exactly as it did before `location` existed.
  */
-declare function resolveSeo(page: SeoInput, defaults?: SiteSeoDefaults): ResolvedSeo;
+declare function resolveSeo(page: SeoInput, defaults?: SiteSeoDefaults, location?: SeoLocation): ResolvedSeo;
 
 /**
  * Public site search — the headless surface for the visitor-facing search box.
@@ -1326,4 +1357,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 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, 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 };

package/dist/index.d.ts

@@ -476,6 +476,20 @@ interface DeliveryFormField {
         field: string;
         equals: string;
     };
+    /**
+     * Per-field rules the API enforces on submit. Renderers should mirror them onto the
+     * native control (`min`/`max`/`pattern`) so the browser reports them before the round
+     * trip — the server check is the one that counts.
+     */
+    validation?: DeliveryFormFieldValidation;
+}
+/** @see FormFieldValidation in @bettercms-ai/types — same shape, delivered to the site. */
+interface DeliveryFormFieldValidation {
+    emailPolicy?: "any" | "business";
+    min?: number;
+    max?: number;
+    phoneFormat?: "any" | "e164";
+    pattern?: string;
 }
 /** The pick-many type, whose value is an array rather than a scalar. */
 declare function isMultiValueField(type: DeliveryFormFieldType): boolean;
@@ -1081,7 +1095,11 @@ interface SeoInput {
 interface ResolvedSeo {
     title: string;
     description: string;
-    /** Canonical URL — page's own `canonical`, else "". Consumers may supply their own base. */
+    /**
+     * Canonical URL — the page's own `canonical`, else `siteUrl` + `path` when both are given,
+     * else "". Empty means the consumer must omit the tag: a RELATIVE canonical is worse than
+     * none at all.
+     */
     canonical: string;
     og: {
         title: string;
@@ -1100,11 +1118,24 @@ interface ResolvedSeo {
     /** JSON-LD nodes (site schema first, then the page's), already flattened + de-empted. */
     jsonLd: Array<Record<string, unknown>>;
 }
+/** Where this page lives, so a canonical can be derived when the page sets none. */
+interface SeoLocation {
+    /** Absolute site origin, e.g. `https://acme.com`. Trailing slash optional. */
+    siteUrl?: string;
+    /** This page's path, e.g. `/about` or `/`. */
+    path?: string;
+}
 /**
- * Merge a page's own SEO over the site defaults. Identical precedence to the server's
- * `mergeSeoMeta`: page meta wins, then site defaults, then sensible fallbacks.
+ * Merge a page's own SEO over the site defaults: page meta wins, then site defaults, then
+ * sensible fallbacks.
+ *
+ * The CANONICAL is the one field that cannot be resolved from content alone, and getting this
+ * wrong is silent. The hosted renderer (`mergeSeoMeta` in the backend) falls back to a canonical
+ * it derives from the request's own origin and path — headless consumers have no request, so
+ * they must pass `location`. Without it this returns "" and the caller ships no
+ * `<link rel="canonical">` and no `og:url`, exactly as it did before `location` existed.
  */
-declare function resolveSeo(page: SeoInput, defaults?: SiteSeoDefaults): ResolvedSeo;
+declare function resolveSeo(page: SeoInput, defaults?: SiteSeoDefaults, location?: SeoLocation): ResolvedSeo;
 
 /**
  * Public site search — the headless surface for the visitor-facing search box.
@@ -1326,4 +1357,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 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, 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 };

package/dist/index.js

@@ -1247,12 +1247,20 @@ function decodeEntities(s) {
 }
 
 // src/seo.ts
+function derivedCanonical({ siteUrl, path }) {
+  if (!siteUrl || !path) return "";
+  try {
+    return new URL(path, siteUrl.endsWith("/") ? siteUrl : `${siteUrl}/`).toString();
+  } catch {
+    return "";
+  }
+}
 function jsonLdNodes(schema) {
   if (!schema) return [];
   const arr = Array.isArray(schema) ? schema : [schema];
   return arr.filter((node) => node && Object.keys(node).length > 0);
 }
-function resolveSeo(page, defaults = {}) {
+function resolveSeo(page, defaults = {}, location = {}) {
   const meta = page.metaJson ?? {};
   const title = page.metaTitle || page.title || "";
   const description = page.metaDescription || defaults.metaDescription || "";
@@ -1260,7 +1268,7 @@ function resolveSeo(page, defaults = {}) {
   const ogTitle = meta.og?.title || title;
   const ogDescription = meta.og?.description || description;
   const twImage = meta.twitter?.image || ogImage;
-  const canonical = meta.canonical || "";
+  const canonical = meta.canonical || derivedCanonical(location);
   return {
     title,
     description,