@openpresentation/opf-editor 0.15.0 → 0.17.0

package/dist/table-options.js

@@ -394,6 +394,44 @@ export function readTableStyleOfTable(table) {
 // Table structure (RR-24): insert, delete, move and sort rows and columns, the header row, cell values.
 export * from "./table-structure.js";
 
+// --- text alternative (FA-27) -----------------------------------------------------------------
+
+/**
+ * The table's text alternative as form state, like a chart's: `alt` is the text (empty when absent or decorative) and `decorative`
+ * is the empty alt, a reviewed choice and not a missing one.
+ */
+export function readTableAlt(table) {
+  return { alt: typeof table?.alt === "string" ? table.alt : "", decorative: table?.alt === "" };
+}
+
+/**
+ * Compute the patch that changes the table's text alternative. `change` is `{ alt?, decorative? }`: `alt` is trimmed and an empty string
+ * or `null` removes it, `decorative: true` writes the empty alt (and wins over `alt`), `decorative: false` removes an empty alt. It works
+ * on an inline table and on a table that shows a shared dataset, because `alt` belongs to the table and not to its data. The document
+ * is not modified.
+ */
+export function prepareTableAlt(presentation, tablePath, change) {
+  const before = checkFormat(presentation);
+  const parts = splitOpfPath(tablePath);
+  const table = getValueAtPath(presentation, parts);
+  if (!isObject(table) || (!Array.isArray(table.rows) && typeof table.dataset !== "string")) throw fail("table-not-found", "Choose a table (a path ending in .table).", { tablePath });
+  if (!isObject(change)) throw fail("invalid-table-option", "A table alt change is { alt?, decorative? }.", { change });
+  let wanted;
+  if (change.decorative === true) wanted = "";
+  else if (change.alt !== undefined) wanted = typeof change.alt === "string" && change.alt.trim() ? change.alt.trim() : undefined;
+  else if (change.decorative === false && table.alt === "") wanted = undefined;
+  else wanted = table.alt;
+  const pointer = opfPathToJsonPointer([...parts, "alt"]);
+  const present = Object.hasOwn(table, "alt");
+  const patches = [];
+  if (wanted === undefined) {
+    if (present) patches.push({ op: "remove", path: pointer });
+  } else if (!present) patches.push({ op: "add", path: pointer, value: wanted });
+  else if (table.alt !== wanted) patches.push({ op: "replace", path: pointer, value: wanted });
+  const next = checkedDocument(presentation, patches, before);
+  return { action: "table-alt", tablePath: parts.join("."), changed: patches.length > 0, patches, presentation: clone(next) };
+}
+
 // --- session forms ----------------------------------------------------------------------------
 
 function commit(editor, prepared, meta = {}) {
@@ -423,6 +461,11 @@ export function setTableCellStyle(editor, tablePath, cells, style, meta = {}) {
   checkEditor(editor);
   return commit(editor, prepareTableCellStyle(editor.presentation, tablePath, cells, style), meta);
 }
+/** Change the table's text alternative as one undoable transaction. See {@link prepareTableAlt}. */
+export function setTableAlt(editor, tablePath, change, meta = {}) {
+  checkEditor(editor);
+  return commit(editor, prepareTableAlt(editor.presentation, tablePath, change), meta);
+}
 /** Apply a table style as one undoable transaction. See {@link prepareTableStyle}. */
 export function setTableStyle(editor, tablePath, preset, meta = {}) {
   checkEditor(editor);

package/dist/template-panel.js

@@ -67,7 +67,7 @@ export function createTemplatePanel(container, options) {
   const builtinList = h(doc, "ul", { class: "opf-template-builtin-list" });
   const builtinSection = h(doc, "details", { class: "opf-template-builtins", "data-opf-component": "template-builtins" },
     h(doc, "summary", { text: "Built-in variables" }),
-    h(doc, "p", { class: "opf-template-help", text: "Read from the presentation's own speaker, organization and deck fields; edit those fields to change them. Use them like any variable: {{speaker.name}} inside text, or var:speaker.photo as a whole image field." }),
+    h(doc, "p", { class: "opf-template-help", text: "Read from the presentation's own speaker, organization and deck fields; edit those fields to change them. Use them like any variable: {{speaker.name}} inside text, or var:speaker.photo as a whole image field. Slide number, section and slide count vary per slide: write them as {{slide.number}}, {{slide.section}} and {{deck.slideCount}} inside any text, not as a whole var: field." }),
     builtinList);
   const live = h(doc, "p", { class: "opf-template-live", role: "status", "aria-live": "polite" });
   const applyButton = h(doc, "button", { type: "button", class: "opf-template-apply primary", text: "Fill the presentation" });
@@ -234,10 +234,12 @@ export function createTemplatePanel(container, options) {
     );
     builtinSection.hidden = !builtins.length;
     builtinList.replaceChildren(...builtins.map((entry) => {
-      const shown = builtinValueText(entry);
       const uses = entry.uses.length;
-      return h(doc, "li", { "data-builtin": entry.name, "data-kind": entry.kind, "data-available": entry.available ? "true" : "false" },
-        h(doc, "code", { text: `{{${entry.name}}}` }), ` ${entry.label}: `, entry.available ? shown : h(doc, "em", { text: "not set" }), uses ? ` (used ${uses} time${uses === 1 ? "" : "s"})` : "");
+      // A slide-scoped built-in has no single value: each slide gets its own when it is drawn or exported (FA-31).
+      const slideScoped = entry.scope === "slide";
+      const shown = slideScoped ? h(doc, "em", { text: "varies per slide" }) : entry.available ? builtinValueText(entry) : h(doc, "em", { text: "not set" });
+      return h(doc, "li", { "data-builtin": entry.name, "data-kind": entry.kind, "data-scope": entry.scope, "data-available": entry.available ? "true" : "false" },
+        h(doc, "code", { text: `{{${entry.name}}}` }), ` ${entry.label}: `, shown, slideScoped && !entry.available ? " (no slide has one yet)" : "", uses ? ` (used ${uses} time${uses === 1 ? "" : "s"})` : "");
     }));
     slideSelect.replaceChildren(...(editor.presentation.slides ?? []).map((slide, index) => h(doc, "option", { value: String(index), text: `${index + 1}. ${slideTitle(slide) || "Untitled"}` })));
     previewSlide = Math.min(previewSlide, Math.max(0, (editor.presentation.slides?.length ?? 1) - 1));

package/dist/templates.d.ts

@@ -109,7 +109,9 @@ export interface BuiltinInfo {
   name: string;
   kind: "text" | "image" | "list";
   label: string;
-  /** The source value, when the document has one. */
+  /** `deck` for a value read once from the document; `slide` for `slide.number`, `slide.section` and `deck.slideCount`, which vary per slide. */
+  scope: "deck" | "slide";
+  /** The source value, when the document has one. Never set for a slide-scoped built-in. */
   value?: unknown;
   available: boolean;
   uses: { id: string; path: string; form: "token" | "reference" }[];

package/dist/templates.js

@@ -8,7 +8,7 @@ import { OPFEditorError, getValueAtPath, opfPathToJsonPointer } from "./index.js
 
 const VARIABLE_ID = /^[a-z][a-z0-9-]*$/;
 // A built-in variable name (core FA-04): `speakers`, or deck/speaker/organization plus one or two dotted segments.
-const BUILTIN_NAME = /^(?:speakers|(?:deck|speaker|organization)(?:.[A-Za-z0-9_-]+){1,2})$/;
+const BUILTIN_NAME = /^(?:speakers|(?:deck|slide|speaker|organization)(?:\.[A-Za-z0-9_-]+){1,2})$/;
 const KINDS = ["color", "text", "number", "date", "image", "url", "list"];
 
 /** The form control each variable kind uses. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openpresentation/opf-editor",
-  "version": "0.15.0",
+  "version": "0.17.0",
   "description": "Embeddable local OPF editor primitives built on the deterministic renderer.",
   "license": "MIT",
   "type": "module",
@@ -226,6 +226,7 @@
     "test:code-browser": "node test/code-browser.mjs",
     "test:selection-browser": "node test/selection-browser.mjs",
     "test:click-entry-browser": "node test/click-entry-browser.mjs",
+    "test:canvas-a11y-browser": "node test/canvas-a11y-browser.mjs",
     "test:metric-browser": "node test/metric-browser.mjs",
     "test:rich-input-browser": "node test/rich-input-browser.mjs",
     "test:json": "npm run build && node test/json-source.mjs && node test/json-options.mjs",
@@ -257,11 +258,11 @@
     "@codemirror/state": "6.7.6",
     "@codemirror/view": "6.43.13",
     "@lezer/highlight": "1.2.4",
-    "@openpresentation/opf": "^0.15.1",
+    "@openpresentation/opf": "^0.17.0",
     "jsonc-parser": "3.3.1"
   },
   "peerDependencies": {
-    "@openpresentation/opf-render": "^0.15.0"
+    "@openpresentation/opf-render": "^0.17.0"
   },
   "peerDependenciesMeta": {
     "@openpresentation/opf-render": {
@@ -269,6 +270,12 @@
     }
   },
   "devDependencies": {
+    "@expo-google-fonts/arimo": "0.4.3",
+    "@expo-google-fonts/caladea": "0.4.2",
+    "@expo-google-fonts/cousine": "0.4.3",
+    "@expo-google-fonts/gelasio": "0.4.1",
+    "@expo-google-fonts/noto-color-emoji": "0.4.6",
+    "@expo-google-fonts/noto-emoji": "0.4.7",
     "@expo-google-fonts/noto-naskh-arabic": "0.4.5",
     "@expo-google-fonts/noto-nastaliq-urdu": "0.4.2",
     "@expo-google-fonts/noto-sans": "0.4.2",
@@ -303,15 +310,17 @@
     "@expo-google-fonts/noto-sans-thai": "0.4.2",
     "@expo-google-fonts/noto-serif-hebrew": "0.4.2",
     "@expo-google-fonts/noto-serif-tibetan": "0.4.2",
-    "@openpresentation/opf-pptx": "^0.15.0",
-    "@openpresentation/opf-render": "^0.15.0",
+    "@expo-google-fonts/roboto": "0.4.3",
+    "@expo-google-fonts/roboto-mono": "0.4.2",
+    "@expo-google-fonts/stix-two-math": "0.4.0",
+    "@expo-google-fonts/tinos": "0.4.2",
+    "@openpresentation/opf-pptx": "^0.17.0",
+    "@openpresentation/opf-render": "^0.17.0",
     "axe-core": "4.13.0",
     "esbuild": "0.28.2",
     "jszip": "3.10.2",
+    "pdf-lib": "1.17.1",
     "pdfjs-dist": "6.3.289",
-    "playwright": "1.63.0",
-    "@expo-google-fonts/noto-color-emoji": "0.4.6",
-    "@expo-google-fonts/noto-emoji": "0.4.7",
-    "@expo-google-fonts/stix-two-math": "0.4.0"
+    "playwright": "1.63.0"
   }
 }