emdash-vibe-editor 0.1.0 → 0.2.0

package/dist/lib/store.js

@@ -1,16 +1,65 @@
 import { mayPublish } from './access.js';
 import { publishIfLive } from './fields.js';
+import { resolve, setAt, textProblem } from './blocks.js';
+import { blocksProblem } from './blockTypes.js';
+import { readEntry } from './guard.js';
 import { json } from './respond.js';
 const PENDING_DRAFT = 'Lagret som utkast: innlegget har andre endringer som ikke er publisert. Publiser i EmDash.';
-/** Stores `value` in the checked field; the answer's body, or the answer for a failed write. */
-export async function storeField(ctx, opts, checked, value) {
-    const { item, collection, id, field } = checked;
+const GONE = 'Seksjonen er endret eller fjernet i mellomtiden. Last siden på nytt.';
+/** A route's `update` refusing the change, with the answer's status and message. */
+export class Refusal {
+    constructor(status, error) {
+        this.status = status;
+        this.error = error;
+    }
+}
+const refuse = (status, error) => ({ refused: json({ error }, status) });
+/**
+ * Stores what `update` makes of the checked field's value now; the answer's
+ * body, or the answer for a refused or failed write.
+ */
+export async function storeField(ctx, opts, checked, update) {
+    const { collection, id, field, blocks } = checked;
+    const fresh = await readEntry(ctx, collection, id);
+    if ('error' in fresh)
+        return refuse(fresh.status, fresh.error);
+    const item = fresh;
+    let data;
+    if (!blocks) {
+        const next = update(item.data[field]);
+        if (next instanceof Refusal)
+            return refuse(next.status, next.error);
+        data = { [field]: next };
+    }
+    else {
+        const before = item.data[field];
+        const found = resolve(before, blocks.path, blocks.schema);
+        if (!('kind' in found) || found.kind !== checked.kind)
+            return refuse(409, GONE);
+        const next = update(found.value);
+        if (next instanceof Refusal)
+            return refuse(next.status, next.error);
+        if (found.kind === 'text') {
+            const problem = textProblem(found.rules, typeof next === 'string' ? next : '');
+            if (problem)
+                return refuse(400, problem);
+        }
+        const after = setAt(before, blocks.path, next);
+        if (!after)
+            return refuse(409, GONE);
+        const problem = blocks.schema.types ? await blocksProblem(blocks.field, after, before, blocks.schema.types) : null;
+        if (problem) {
+            ctx.log.warn('EmDash would refuse the blocks value', { collection, id, field, problem });
+            return refuse(422, `EmDash godtar ikke endringen (${problem}).`);
+        }
+        data = { [field]: after };
+    }
     const wasPublished = item.status === 'published';
     const otherDraft = !!item.draftRevisionId;
     // The plugin declares content:write and content:publish, so EmDash gives it these.
     const content = ctx.content;
     try {
-        await content.update(collection, id, { [field]: value });
+        await content.update(collection, id, data);
         let published = false;
         if (opts.publish !== false && !otherDraft && mayPublish(ctx.user, item)) {
             published = await publishIfLive(content, collection, id, wasPublished);
@@ -18,7 +67,7 @@ export async function storeField(ctx, opts, checked, value) {
         return { ok: true, published, ...(wasPublished && otherDraft ? { warning: PENDING_DRAFT } : {}) };
     }
     catch (err) {
-        ctx.log.warn('Saving a field failed', { collection, id, field, error: err instanceof Error ? err.message : String(err) });
-        return { refused: json({ error: 'Klarte ikke å lagre. Prøv igjen.' }, 409) };
+        ctx.log.warn('Saving a field failed', { collection, id, field: blocks ? `${field}.${blocks.path.key}` : field, error: err instanceof Error ? err.message : String(err) });
+        return refuse(409, 'Klarte ikke å lagre. Prøv igjen.');
     }
 }

package/dist/routes/generate-image.js

@@ -1,6 +1,6 @@
 import { resolveKey } from '../lib/access.js';
 import { checkField, str } from '../lib/guard.js';
-import { asImage, libraryId, libraryValue } from '../lib/images.js';
+import { asImage, FILE_ROUTE, libraryId, libraryValue } from '../lib/images.js';
 import { json } from '../lib/respond.js';
 import { createService, failure, REFERENCE_MAX } from '../lib/service.js';
 import { storeField } from '../lib/store.js';
@@ -26,7 +26,7 @@ export function generateImageRoute(opts) {
             const checked = await checkField(ctx, opts, input, ['image']);
             if ('refused' in checked)
                 return checked.refused;
-            const current = asImage(checked.item.data[checked.field]);
+            const current = asImage(checked.current);
             const media = ctx.media;
             let reference = null;
             const refId = libraryId(current);
@@ -65,9 +65,8 @@ export function generateImageRoute(opts) {
             }
             // EmDash measured the picture on upload; its size goes in the field as for any library picture.
             const item = (await media.get(uploaded.mediaId).catch(() => null)) || { id: uploaded.mediaId, mimeType: picture.mime };
-            const value = libraryValue(current, item, uploaded.storageKey, current.alt || '');
-            const stored = await storeField(ctx, opts, checked, value);
-            return 'refused' in stored ? stored.refused : json({ ...stored, url: value.src, mode: picture.mode });
+            const stored = await storeField(ctx, opts, checked, (now) => libraryValue(now, item, uploaded.storageKey, asImage(now).alt || ''));
+            return 'refused' in stored ? stored.refused : json({ ...stored, url: FILE_ROUTE + uploaded.storageKey, mode: picture.mode });
         },
     };
 }

package/dist/routes/save.d.ts

@@ -4,7 +4,8 @@ import type { VibeEditorOptions } from '../types.js';
  * POST save { collection, id, field, value, original? }
  * POST save { collection, id, field, alt }  (an image's alt text)
  * Saves a text, or a picture's alt text, to the entry; see storeField for
- * when it goes live.
+ * when it goes live. `field` may be a path inside a blocks field
+ * ("sections.<blockKey>.title"); see lib/blocks.ts.
  */
 export declare function saveRoute(opts: VibeEditorOptions): {
     permission: "content:edit_own";

package/dist/routes/save.js

@@ -2,13 +2,14 @@ import { applyText } from '../lib/fields.js';
 import { checkField, str } from '../lib/guard.js';
 import { asImage } from '../lib/images.js';
 import { json } from '../lib/respond.js';
-import { storeField } from '../lib/store.js';
+import { Refusal, storeField } from '../lib/store.js';
 import { TEXT_KINDS } from './suggest.js';
 /**
  * POST save { collection, id, field, value, original? }
  * POST save { collection, id, field, alt }  (an image's alt text)
  * Saves a text, or a picture's alt text, to the entry; see storeField for
- * when it goes live.
+ * when it goes live. `field` may be a path inside a blocks field
+ * ("sections.<blockKey>.title"); see lib/blocks.ts.
  */
 export function saveRoute(opts) {
     return {
@@ -21,19 +22,19 @@ export function saveRoute(opts) {
             const checked = await checkField(ctx, opts, input, isAlt ? ['image'] : TEXT_KINDS);
             if ('refused' in checked)
                 return checked.refused;
-            const current = checked.item.data[checked.field];
-            let next;
-            if (isAlt) {
-                if (!asImage(current).src && !asImage(current).id)
-                    return json({ error: 'Feltet har ikke noe bilde.' }, 400);
-                next = { ...asImage(current), alt: str(input.alt).trim() };
-            }
-            else {
-                next = applyText(current, str(input.original), str(input.value), checked.kind);
-                if (next === null)
-                    return json({ error: 'Fant ikke teksten i innholdet. Last siden på nytt.' }, 400);
-            }
-            const stored = await storeField(ctx, opts, checked, next);
+            const alt = str(input.alt).trim();
+            const original = str(input.original);
+            const value = str(input.value);
+            // Made from the field as it is at the write, so a change made meanwhile isn't undone.
+            const stored = await storeField(ctx, opts, checked, (current) => {
+                if (isAlt) {
+                    if (!asImage(current).src && !asImage(current).id)
+                        return new Refusal(400, 'Feltet har ikke noe bilde.');
+                    return { ...asImage(current), alt };
+                }
+                const next = applyText(current, original, value, checked.kind);
+                return next === null ? new Refusal(400, 'Fant ikke teksten i innholdet. Last siden på nytt.') : next;
+            });
             return 'refused' in stored ? stored.refused : json(stored);
         },
     };

package/dist/routes/status.js

@@ -1,8 +1,10 @@
 import { isAllowed, resolveKey } from '../lib/access.js';
 import { json } from '../lib/respond.js';
 import { createService, NOT_CONNECTED } from '../lib/service.js';
-// Field types the overlay can edit: plain text, rich text (Portable Text) and images.
-export const EDITABLE_TYPES = ['string', 'text', 'portableText', 'image'];
+// Field types the overlay can edit: plain text, rich text (Portable Text) and
+// images, and page-builder sections (`blocks`), whose texts and images are
+// marked with a dotted path (see lib/blocks.ts).
+export const EDITABLE_TYPES = ['string', 'text', 'portableText', 'image', 'blocks'];
 /**
  * Per collection: whether its SEO title and description can be edited here,
  * and its editable fields with their types. The allow list names SEO as the

package/dist/routes/suggest.js

@@ -20,7 +20,7 @@ export function suggestRoute(opts) {
         response: 'raw',
         handler: async (ctx) => {
             const input = (ctx.input || {});
-            const instruction = str(input.instruction).trim();
+            let instruction = str(input.instruction).trim();
             if (!instruction)
                 return json({ error: 'Skriv hva som skal endres.' }, 400);
             let original = str(input.original);
@@ -39,7 +39,7 @@ export function suggestRoute(opts) {
                 const checked = await checkField(ctx, opts, input, TEXT_KINDS);
                 if ('refused' in checked)
                     return checked.refused;
-                const current = checked.item.data[checked.field];
+                const current = checked.current;
                 if (checked.kind === 'portableText') {
                     if (findBlock(current, original) < 0)
                         return json({ error: 'Fant ikke teksten i innholdet. Last siden på nytt.' }, 400);
@@ -47,7 +47,11 @@ export function suggestRoute(opts) {
                 else {
                     original = textOf(current) || original;
                 }
-                field = `${checked.collection}.${checked.field}`;
+                field = checked.label;
+                // A text in a section may have a length limit in EmDash; the AI is told it.
+                const max = checked.blocks?.rules.maxLength;
+                if (max !== undefined && checked.kind === 'text')
+                    instruction += ` (Høyst ${max} tegn.)`;
             }
             try {
                 const service = createService({ apiKey: await resolveKey(ctx), baseUrl: opts.baseUrl, fetch: ctx.http.fetch.bind(ctx.http) });

package/dist/routes/swap-image.d.ts

@@ -5,7 +5,8 @@ import type { VibeEditorOptions } from '../types.js';
  * Puts another picture in an image field. `uploadId` is either a pick from
  * EmDash's media library, "<mediaId>|<storageKey>" (the overlay lists the
  * library through EmDash's own admin API, which has the storage key), or an
- * http(s) address the editor pasted, kept as it is.
+ * http(s) address the editor pasted, kept as it is (as EmDash's own editor
+ * keeps one: { id: '', provider: 'external', src }).
  */
 export declare function swapImageRoute(opts: VibeEditorOptions): {
     permission: "content:edit_own";

package/dist/routes/swap-image.js

@@ -1,5 +1,5 @@
 import { checkField, str } from '../lib/guard.js';
-import { asImage, isStorageKey, keyFits, libraryValue, parsePick, webAddress } from '../lib/images.js';
+import { asImage, FILE_ROUTE, isStorageKey, keyFits, libraryValue, parsePick, webAddress } from '../lib/images.js';
 import { json } from '../lib/respond.js';
 import { storeField } from '../lib/store.js';
 /**
@@ -7,7 +7,8 @@ import { storeField } from '../lib/store.js';
  * Puts another picture in an image field. `uploadId` is either a pick from
  * EmDash's media library, "<mediaId>|<storageKey>" (the overlay lists the
  * library through EmDash's own admin API, which has the storage key), or an
- * http(s) address the editor pasted, kept as it is.
+ * http(s) address the editor pasted, kept as it is (as EmDash's own editor
+ * keeps one: { id: '', provider: 'external', src }).
  */
 export function swapImageRoute(opts) {
     return {
@@ -20,8 +21,8 @@ export function swapImageRoute(opts) {
             const checked = await checkField(ctx, opts, input, ['image']);
             if ('refused' in checked)
                 return checked.refused;
-            const current = checked.item.data[checked.field];
             let value;
+            let url;
             const pick = parsePick(uploadId);
             const address = pick ? null : webAddress(uploadId);
             if (pick) {
@@ -32,16 +33,19 @@ export function swapImageRoute(opts) {
                     return json({ error: 'Fant ikke bildet i mediebiblioteket.' }, 404);
                 if (!keyFits(pick.storageKey, media))
                     return json({ error: 'Ugyldig bilde.' }, 400);
-                value = libraryValue(current, media, pick.storageKey);
+                value = (current) => libraryValue(current, media, pick.storageKey);
+                url = FILE_ROUTE + pick.storageKey;
             }
             else if (address) {
-                value = { src: address, alt: asImage(current).alt || '' };
+                // The shape EmDash's own editor gives a picture by address: its schema wants an id.
+                value = (current) => ({ id: '', provider: 'external', src: address, alt: asImage(current).alt || '' });
+                url = address;
             }
             else {
                 return json({ error: 'Velg et bilde fra mediebiblioteket eller lim inn en bildeadresse (https://…).' }, 400);
             }
             const stored = await storeField(ctx, opts, checked, value);
-            return 'refused' in stored ? stored.refused : json({ ...stored, url: value.src });
+            return 'refused' in stored ? stored.refused : json({ ...stored, url });
         },
     };
 }

package/dist/types.d.ts

@@ -5,6 +5,14 @@ export interface EditableField {
     /** Field slug, e.g. `title`; `seo` for the entry's title and description in search engines. */
     field: string;
 }
+/** A text field inside a section, with what EmDash requires of it. */
+export interface BlockTextField {
+    type: 'text';
+    maxLength?: number;
+    required?: boolean;
+}
+/** What a field inside a section is: text, rich text or a picture; a repeater as its rows' fields. */
+export type BlockFieldDeclaration = 'text' | 'portableText' | 'image' | BlockTextField | Record<string, 'text' | 'image' | BlockTextField>;
 /**
  * What `vibeEditor()` takes in astro.config. These are written into the
  * site's build, so they never hold a key: the site connects to Vibe Editor
@@ -15,6 +23,14 @@ export interface VibeEditorOptions {
     baseUrl?: string;
     /** Restrict what can be edited. Default: every text and image field, and the SEO title and description, of every collection. */
     allow?: EditableField[] | null;
+    /**
+     * The fields inside page-builder sections that can be edited, per block
+     * type: `{ hero: { title: 'text', bilde: 'image', steg: { tittel: 'text' } } }`.
+     * When EmDash's block types can be read here they decide what each field
+     * is, and this only narrows it; when they can't, only what is declared here
+     * can be edited. Default: every text, rich text and picture field.
+     */
+    blocks?: Record<string, Record<string, BlockFieldDeclaration>> | null;
     /** Publish an entry again after a change, when it was published before. Default: true. */
     publish?: boolean;
 }

package/dist/version.d.ts

@@ -1,2 +1,2 @@
 export declare const PLUGIN_ID = "vibe-editor";
-export declare const VERSION = "0.1.0";
+export declare const VERSION = "0.2.0";

package/dist/version.js

@@ -1,2 +1,2 @@
 export const PLUGIN_ID = 'vibe-editor';
-export const VERSION = '0.1.0';
+export const VERSION = '0.2.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "emdash-vibe-editor",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Front-end \"vibe editing\" for EmDash CMS: click text and images on your live site and edit them with AI, paid from your Vibe Editor credits.",
   "license": "GPL-2.0-or-later",
   "author": "GetOnNet",