@bettercms-ai/sdk 1.17.0 → 1.18.0

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import * as _bettercms_ai_types from '@bettercms-ai/types';
-import { ContentPageResult, Content, DeliveredLayout, ContentModelField, BetterCMSErrorCode, LayoutStructureDocument, LayoutDataDocument, PageLayoutOverrideDocument, ManagementLayoutCommand, AuthUser, AuthSession, SignInInput, SignUpInput, Perspective, DeliveryEntry, DeliveryList, DeliveryPage, PageMetaJson, SiteSeoDefaults, Page, MediaAsset, Form, FormSubmission, Workspace, ApiKey, ApiKeyPermission, ApiKeyTokenType } from '@bettercms-ai/types';
-export { ApiError, ApiKey, ApiKeyPermission, ApiKeyTokenType, AssertEqual, AuthSession, AuthUser, BetterCMSErrorCode, BlockType, ButtonBlock, ButtonProps, ColumnsBlock, ColumnsProps, Content, ContentBlock, ContentEntry, ContentModel, ContentModelField, ContentPageResult, ContentResponse, DeepReadonly, DeliveryEntry, DeliveryList, DeliveryPage, Form, FormBlock, FormField, FormProps, FormSubmission, HeadingBlock, HeadingProps, ImageBlock, ImageProps, MediaAsset, Page, PageMetaJson, PaginatedResult, Perspective, Redirect, SignInInput, SignUpInput, SiteSeoDefaults, SpacerBlock, SpacerProps, TextBlock, TextProps, VideoBlock, VideoProps, Workspace, getBlockType, isBlock } from '@bettercms-ai/types';
+import { ContentPageResult, Content, DeliveredLayout, ContentModelField, BetterCMSErrorCode, LayoutStructureDocument, LayoutDataDocument, PageLayoutOverrideDocument, ManagementLayoutCommand, AuthUser, AuthSession, SignInInput, SignUpInput, Perspective, DeliveryEntry, DeliveryList, DeliveryPage, DeliveryComponent, PageMetaJson, SiteSeoDefaults, Page, MediaAsset, Form, FormSubmission, Workspace, ApiKey, ApiKeyPermission, ApiKeyTokenType } from '@bettercms-ai/types';
+export { ApiError, ApiKey, ApiKeyPermission, ApiKeyTokenType, AssertEqual, AuthSession, AuthUser, BetterCMSErrorCode, BlockType, ButtonBlock, ButtonProps, ColumnsBlock, ColumnsProps, Content, ContentBlock, ContentEntry, ContentModel, ContentModelField, ContentPageResult, ContentResponse, DeepReadonly, DeliveryComponent, DeliveryEntry, DeliveryList, DeliveryPage, Form, FormBlock, FormField, FormProps, FormSubmission, HeadingBlock, HeadingProps, ImageBlock, ImageProps, MediaAsset, Page, PageMetaJson, PaginatedResult, Perspective, Redirect, SignInInput, SignUpInput, SiteSeoDefaults, SpacerBlock, SpacerProps, TextBlock, TextProps, VideoBlock, VideoProps, Workspace, getBlockType, isBlock } from '@bettercms-ai/types';
 export { ImageFit, ImageFormat, ImageSource, ImageUrlBuilder, ImageUrlOptions, imageUrl, default as imageUrlBuilder } from '@bettercms-ai/image-url';
 
 /**
@@ -1007,6 +1007,12 @@ interface BetterCMSReadClient {
     listEntries<T = Record<string, unknown>>(opts?: ListEntriesOptions): Promise<DeliveryList<DeliveryEntry<T>>>;
     getPage(slug: string): Promise<DeliveryPage | null>;
     listPages(opts?: ListPagesOptions): Promise<DeliveryList<DeliveryPage>>;
+    /**
+     * The workspace's reusable component definitions, for resolving `component` blocks.
+     * Under `perspective: "drafts"` this is the DRAFT definition — what makes an SSR render
+     * of a draft page look like the page the editor is showing.
+     */
+    listComponents(): Promise<DeliveryComponent[]>;
     /** Fetch the project-scoped Global Layout for the active perspective. */
     getLayout(): Promise<DeliveredLayout | null>;
     listForms(opts?: {

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as _bettercms_ai_types from '@bettercms-ai/types';
-import { ContentPageResult, Content, DeliveredLayout, ContentModelField, BetterCMSErrorCode, LayoutStructureDocument, LayoutDataDocument, PageLayoutOverrideDocument, ManagementLayoutCommand, AuthUser, AuthSession, SignInInput, SignUpInput, Perspective, DeliveryEntry, DeliveryList, DeliveryPage, PageMetaJson, SiteSeoDefaults, Page, MediaAsset, Form, FormSubmission, Workspace, ApiKey, ApiKeyPermission, ApiKeyTokenType } from '@bettercms-ai/types';
-export { ApiError, ApiKey, ApiKeyPermission, ApiKeyTokenType, AssertEqual, AuthSession, AuthUser, BetterCMSErrorCode, BlockType, ButtonBlock, ButtonProps, ColumnsBlock, ColumnsProps, Content, ContentBlock, ContentEntry, ContentModel, ContentModelField, ContentPageResult, ContentResponse, DeepReadonly, DeliveryEntry, DeliveryList, DeliveryPage, Form, FormBlock, FormField, FormProps, FormSubmission, HeadingBlock, HeadingProps, ImageBlock, ImageProps, MediaAsset, Page, PageMetaJson, PaginatedResult, Perspective, Redirect, SignInInput, SignUpInput, SiteSeoDefaults, SpacerBlock, SpacerProps, TextBlock, TextProps, VideoBlock, VideoProps, Workspace, getBlockType, isBlock } from '@bettercms-ai/types';
+import { ContentPageResult, Content, DeliveredLayout, ContentModelField, BetterCMSErrorCode, LayoutStructureDocument, LayoutDataDocument, PageLayoutOverrideDocument, ManagementLayoutCommand, AuthUser, AuthSession, SignInInput, SignUpInput, Perspective, DeliveryEntry, DeliveryList, DeliveryPage, DeliveryComponent, PageMetaJson, SiteSeoDefaults, Page, MediaAsset, Form, FormSubmission, Workspace, ApiKey, ApiKeyPermission, ApiKeyTokenType } from '@bettercms-ai/types';
+export { ApiError, ApiKey, ApiKeyPermission, ApiKeyTokenType, AssertEqual, AuthSession, AuthUser, BetterCMSErrorCode, BlockType, ButtonBlock, ButtonProps, ColumnsBlock, ColumnsProps, Content, ContentBlock, ContentEntry, ContentModel, ContentModelField, ContentPageResult, ContentResponse, DeepReadonly, DeliveryComponent, DeliveryEntry, DeliveryList, DeliveryPage, Form, FormBlock, FormField, FormProps, FormSubmission, HeadingBlock, HeadingProps, ImageBlock, ImageProps, MediaAsset, Page, PageMetaJson, PaginatedResult, Perspective, Redirect, SignInInput, SignUpInput, SiteSeoDefaults, SpacerBlock, SpacerProps, TextBlock, TextProps, VideoBlock, VideoProps, Workspace, getBlockType, isBlock } from '@bettercms-ai/types';
 export { ImageFit, ImageFormat, ImageSource, ImageUrlBuilder, ImageUrlOptions, imageUrl, default as imageUrlBuilder } from '@bettercms-ai/image-url';
 
 /**
@@ -1007,6 +1007,12 @@ interface BetterCMSReadClient {
     listEntries<T = Record<string, unknown>>(opts?: ListEntriesOptions): Promise<DeliveryList<DeliveryEntry<T>>>;
     getPage(slug: string): Promise<DeliveryPage | null>;
     listPages(opts?: ListPagesOptions): Promise<DeliveryList<DeliveryPage>>;
+    /**
+     * The workspace's reusable component definitions, for resolving `component` blocks.
+     * Under `perspective: "drafts"` this is the DRAFT definition — what makes an SSR render
+     * of a draft page look like the page the editor is showing.
+     */
+    listComponents(): Promise<DeliveryComponent[]>;
     /** Fetch the project-scoped Global Layout for the active perspective. */
     getLayout(): Promise<DeliveredLayout | null>;
     listForms(opts?: {

package/dist/index.js

@@ -1130,6 +1130,16 @@ function unwrap(json) {
   }
   return json;
 }
+function tokenSlug(token) {
+  try {
+    const part = token.split(".")[1];
+    if (!part) return null;
+    const json = atob(part.replace(/-/g, "+").replace(/_/g, "/"));
+    return JSON.parse(json).entrySlug ?? null;
+  } catch {
+    return null;
+  }
+}
 function createRequestCache() {
   const inflight = /* @__PURE__ */ new Map();
   const settled = /* @__PURE__ */ new Map();
@@ -1230,6 +1240,23 @@ function createClient(options) {
       return unwrap(await fetchJSON(url));
     },
     async getPage(slug) {
+      if (draft && previewToken && tokenSlug(previewToken) === slug) {
+        const url = `${apiUrl}/api/v1/preview/${encodeURIComponent(slug)}${qs({
+          token: previewToken,
+          stega: stega ? "1" : void 0
+        })}`;
+        const d = unwrap(await fetchJSON(url));
+        return {
+          slug: d.slug,
+          title: d.title,
+          metaTitle: d.metaTitle ?? null,
+          metaDescription: d.metaDescription ?? null,
+          metaJson: d.metaJson ?? null,
+          blocks: d.blockJson ?? [],
+          updatedAt: d.updatedAt ?? null,
+          publishedAt: d.publishedAt ?? null
+        };
+      }
       let page = 1;
       for (; ; ) {
         const list = await this.listPages({ page, perPage: 100 });
@@ -1246,6 +1273,13 @@ function createClient(options) {
       })}`;
       return unwrap(await fetchJSON(url));
     },
+    async listComponents() {
+      const url = `${base}/components${qs({
+        perspective: draft ? "draft" : void 0,
+        token: draft ? previewToken : void 0
+      })}`;
+      return unwrap(await fetchJSON(url));
+    },
     async getLayout() {
       const url = `${base}/layout${draft ? "?perspective=draft" : ""}`;
       try {