@mjml-agent-editor/editor 0.1.11 → 0.1.14

package/README.md

@@ -98,6 +98,29 @@ satisfying the two interfaces works, including an in-memory object.
 
 Forgetting the provider throws with an explanation rather than failing on a null read.
 
+### Images
+
+The image picker — opened by double-clicking an image, from its toolbar, or from the
+Settings panel — uploads to and picks from an optional `images` library. Where the files
+live is up to the host: S3, R2, a CDN.
+
+```tsx
+const images: ImageLibrary = {
+  list: () => fetch("/api/images").then((r) => r.json()), // { images, quota? }
+  upload: (file) => fetch("/api/images", { method: "POST", body: file }).then((r) => r.json()),
+  remove: (id) => fetch(`/api/images/${id}`, { method: "DELETE" }).then(() => {}),
+};
+
+<EditorStoreProvider stores={{ documents, comments, images }}>
+```
+
+`quota` (`{ used, limit }`) is shown in the picker and stops uploads when reached. Leave
+`remove` out for a read-only gallery — a host that caps uploads but cannot reclaim the
+storage would otherwise be handing out a way round its own cap.
+
+Without a library the picker takes URLs only. The editor never inlines a file as base64:
+most mail clients block `data:` images, and every agent turn would pay for the bytes.
+
 ## Copy
 
 Every word the editor renders comes from a dictionary with English defaults, so a host
@@ -173,6 +196,29 @@ of the message that started it; keep that message somewhere and put it back into
 written, so a host's own sentence about limits or a document that is already busy reaches
 them intact.
 
+## When the host refuses
+
+`onBeforeSend` flushes unsaved canvas changes before a turn, and **a rejection stops the
+turn**, keeping the prompt in the box: the agent reads the stored document, so it would
+otherwise answer about a version the visitor has moved past. The flush writes only when
+the canvas differs from what the store last returned.
+
+While a turn runs, from that flush until the document it left is loaded, the canvas is
+read only, so the agent is the only writer. `ChatPanel` and `EmailEditor` coordinate this
+through `EditorStoreProvider`; nothing needs wiring.
+
+The visitor sees the host's own sentence when the rejection carries one:
+
+| The rejection                            | Shown                       |
+| ---------------------------------------- | --------------------------- |
+| a `status` outside 400–499               | `labels.documentSaveFailed` |
+| message is `{"error": "..."}`            | the `error` string          |
+| a `status` of 400–499, any other message | the `message`, unless HTML  |
+| no status and no recognizable body       | `labels.documentSaveFailed` |
+
+So a `DocumentStore.save` refusing a document over a size cap should throw with
+`status: 413` and a sentence. Autosave reports the same way, under one toast id.
+
 ## A note on field names
 
 The ports are camelCase (`sectionId`, `objectId`, `projectData`); Postgres columns are