@bettercms-ai/sdk 1.14.0 → 1.15.0

package/README.md

@@ -85,6 +85,40 @@ try {
 }
 ```
 
+## Draft previews and visual editing
+
+A client created with `perspective: "drafts"` reads unpublished content — through a
+`content:read:draft` API key, or through a `previewToken` minted for one document.
+
+Draft reads also carry **stega provenance**: invisible zero-width characters appended to every
+prose value, naming the entry and field it came from. That is what lets the dashboard's canvas
+(and the `<VisualEditing>` overlay) map a rendered string back to its editor without guessing at
+its text. It is **on by default for `perspective: "drafts"` from 1.15.0** — before that it had to
+be asked for, and a preview build that did not know to ask rendered anonymous strings.
+
+```ts
+const draft = createClient({
+  apiUrl,
+  workspace: "my-workspace",
+  apiKey: process.env.BETTERCMS_DRAFT_KEY,
+  perspective: "drafts", // stega is on
+});
+
+// Opt out — e.g. when diffing or checksumming draft content, where the invisible
+// characters would show up as differences.
+const plain = createClient({
+  apiUrl,
+  workspace: "my-workspace",
+  apiKey: process.env.BETTERCMS_DRAFT_KEY,
+  perspective: "drafts",
+  stega: false,
+});
+```
+
+Published reads never carry provenance, whatever `stega` is set to: the payload must not reach a
+production build. Strip it yourself with `stripStega(value)` if you need the clean string, and
+decode it with `decodeStega(value)`.
+
 ## API
 
 ### `BetterCMS.site(options)`

package/dist/index.cjs

@@ -1307,6 +1307,7 @@ function createClient(options) {
     throw lastError ?? new BetterCMSError("Unreachable", 0, "NETWORK_ERROR");
   }
   const draft = perspective === "drafts";
+  const stega = options.stega ?? draft;
   return {
     perspective,
     async getEntry(slug, opts) {
@@ -1314,12 +1315,12 @@ function createClient(options) {
         token: previewToken,
         depth: opts?.depth,
         select: opts?.select?.join(","),
-        stega: options.stega ? "1" : void 0
+        stega: stega ? "1" : void 0
       })}` : `${base}/content-entries/${encodeURIComponent(slug)}${qs({
         depth: opts?.depth,
         select: opts?.select?.join(","),
         perspective: draft ? "draft" : void 0,
-        stega: draft && options.stega ? "1" : void 0
+        stega: draft && stega ? "1" : void 0
       })}`;
       return unwrap(await fetchJSON(url));
     },
@@ -1331,7 +1332,7 @@ function createClient(options) {
         depth: opts?.depth,
         select: opts?.select?.join(","),
         perspective: draft ? "draft" : void 0,
-        stega: draft && options.stega ? "1" : void 0
+        stega: draft && stega ? "1" : void 0
       })}`;
       return unwrap(await fetchJSON(url));
     },