@openpresentation/opf-editor 0.14.2 → 0.16.0

package/dist/review-panel.js

@@ -6,6 +6,7 @@
 // document state: every fix is an undoable edit through the editor session. Importing this module does not need a DOM;
 // mounting does.
 import { validate } from "@openpresentation/opf";
+import { mergeCatalogs } from "./catalogs.js";
 import {
   applyReviewFix,
   countFindings,
@@ -115,6 +116,11 @@ function summaryText(counts, scopeLabel) {
  */
 export function createReviewPanel(container, options) {
   const { editor, getSlideIndex, getValidateOptions, onGoTo, onFocusField, onStatus, onIgnoredChange, onChange, review } = options;
+  // Core resolves the deck's references with the session's registered catalogs (and any the host adds): the same list as the preview.
+  const validateOptions = () => {
+    const host = getValidateOptions?.(editor.presentation) ?? {};
+    return { ...host, catalogs: mergeCatalogs(editor.catalogs, host.catalogs) };
+  };
   if (review !== undefined && typeof review !== "function") throw new TypeError("The Review panel's review hook must be a function (presentation, options) returning a FindingReport.");
   if (!editor || typeof editor.subscribe !== "function") throw new Error("The Review panel needs an editor session created by createEditorSession.");
   const doc = container.ownerDocument;
@@ -171,7 +177,7 @@ export function createReviewPanel(container, options) {
   function validateNow() {
     lastAuditError = undefined;
     try {
-      coreReport = validate(editor.presentation, getValidateOptions?.(editor.presentation) ?? {});
+      coreReport = validate(editor.presentation, validateOptions());
     } catch (error) {
       coreReport = undefined;
       lastAuditError = error;
@@ -204,7 +210,7 @@ export function createReviewPanel(container, options) {
     if (!coreReport && !lastAuditError) validateNow();
     renderList();
     try {
-      const result = await review(editor.presentation, { signal: controller.signal, report: coreReport, validateOptions: getValidateOptions?.(editor.presentation) ?? {} });
+      const result = await review(editor.presentation, { signal: controller.signal, report: coreReport, validateOptions: validateOptions() });
       if (destroyed || hookRunning !== running) return;
       if (!result || !Array.isArray(result.findings)) throw new TypeError("The review hook must resolve a FindingReport ({ valid, findings, counts }).");
       hookRunning = undefined;

package/dist/schema-inspector.js

@@ -18,7 +18,7 @@ export function createSchemaInspector(container, {editor,path='',onDraft,onCommi
   function showError(message){errorBox.textContent=message;}
   function check(){
     // The draft must be valid OPF (the format category, as every edit); unresolved references (an unknown variable, a missing asset) are listed as notes.
-    const report=validate(draft,{only:['format','references']});
+    const report=validate(draft,{only:['format','references'],...(editor?.catalogs?.length?{catalogs:editor.catalogs}:{})});
     const errors=report.findings.filter(finding=>finding.severity==='error'&&finding.category==='format'),warnings=report.findings.filter(finding=>finding.category!=='format'&&finding.severity!=='info');
     const validation={valid:!errors.length};
     apply.disabled=!dirty||!validation.valid;

package/dist/schema.js

@@ -69,7 +69,7 @@ export function schemaAtPath(presentation, path, root = schemas.presentation) {
   const parts=splitOpfPath(path);let current=root,value=presentation;
   for(let index=0; index<parts.length;index++) {
     const key=parts[index], resolved=activeSchema(current,value,root);
-    if(parts[0]==='catalogs' && parts[2]==='records' && index===3) current=schemas[catalogSchemaNames[parts[1]]]??{};
+    if(parts[0]==='catalogs' && index===3 && catalogSchemaNames[parts[2]]) current=schemas[catalogSchemaNames[parts[2]]]??{};
     else current=Array.isArray(value)||resolved.type==='array' ? resolved.items??{} : resolved.properties?.[key] ?? Object.entries(resolved.patternProperties??{}).find(([pattern])=>new RegExp(pattern).test(key))?.[1] ?? (typeof resolved.additionalProperties==='object'?resolved.additionalProperties:{});
     value=value?.[key];
   }

package/dist/slide-manager.js

@@ -7,6 +7,7 @@ import {
   addSection, addSlide, duplicateSlides, hasSections, listSections, moveSection, moveSlides, moveSlidesBy, removeSection, removeSlides, renameSection, setHidden, setSection, slideTitle,
 } from "./slides.js";
 import { listSwitchOptions } from "./switches.js";
+import { layoutSlotSummary } from "./layout-placeholders.js";
 
 let instances = 0;
 const SVG_NS = "http://www.w3.org/2000/svg";
@@ -482,7 +483,7 @@ export function createSlideManager(container, options) {
     });
   }
   function layoutChoices() {
-    return options.layoutOptions ? options.layoutOptions(deck()) : listSwitchOptions(deck(), "layouts");
+    return options.layoutOptions ? options.layoutOptions(deck()) : listSwitchOptions(deck(), "layouts", { catalogs: editor.catalogs });
   }
   function openLayoutPicker() {
     const choices = layoutChoices();
@@ -503,7 +504,8 @@ export function createSlideManager(container, options) {
     };
     const describe = () => {
       const choice = choices.find((entry) => entry.id === select.value);
-      const slots = Array.isArray(choice?.record?.placeholders) ? choice.record.placeholders.map((slot) => slot.type).join(", ") : "";
+      // FA-26: nested placeholder groups show with their mode, for example `title, column (text, text), chart`.
+      const slots = layoutSlotSummary(choice?.record);
       detail.textContent = choice ? `${choice.record?.description ?? ""}${slots ? ` Slots: ${slots}.` : choice.record?.placeholders ? " An empty slide." : ""}`.trim() : "No layout matches.";
     };
     const form = el("form", { method: "dialog" },

package/dist/slides.d.ts

@@ -48,7 +48,7 @@ export type MoveSectionMode = "adopt" | "keep" | string | null;
 export interface AddSlideOptions {
   /** The index the slide takes (default: the end). */
   at?: number;
-  /** A layouts catalog id; the layout's placeholders are added as empty slots. */
+  /** A layout reference (`id` or `name:id`); the layout's placeholders are added as empty slots. */
   layout?: string;
   title?: string;
   text?: string;

package/dist/slides.js

@@ -11,6 +11,7 @@
 import { checkedDocument, fail, same } from "./edit-helpers.js";
 import { collectReservedPresentationIds, remapSlideTreeIds } from "./presentation-ids.js";
 import { prepareDimensionSwitch } from "./switches.js";
+import { mergeCatalogs } from "./catalogs.js";
 import { checkFormat } from "./checks.js";
 
 const isIndex = (value) => Number.isInteger(value) && value >= 0;
@@ -130,10 +131,10 @@ function newSlideId(presentation) {
 }
 
 /**
- * Compute adding a slide. Options: `at` (the index the slide takes, default the end), `layout` (a layouts
- * catalog id; the layout's placeholders are added as empty slots, exactly like switching a slide's layout),
+ * Compute adding a slide. Options: `at` (the index the slide takes, default the end), `layout` (a layout
+ * reference, `id` or `name:id`; the layout's placeholders are added as empty slots, exactly like switching a slide's layout),
  * `title`, `text`, `id`, `section` (default: the section of the slide before it), `slide` (a ready slide to
- * insert, for hosts that build their own), `catalogs`/`record` for catalog lookup (as `prepareDimensionSwitch`).
+ * insert, for hosts that build their own), `catalogs`/`record`/`recordSource` for catalog lookup (as `prepareDimensionSwitch`).
  */
 export function prepareAddSlide(presentation, options = {}) {
   const slides = requireSlides(presentation);
@@ -153,7 +154,7 @@ export function prepareAddSlide(presentation, options = {}) {
     // Switch the layout on a scratch copy to reuse the placeholder rules and the catalog lookup.
     const scratch = { ...clone(presentation), slides: [...clone(slides)] };
     scratch.slides.splice(at, 0, slide);
-    const switched = prepareDimensionSwitch(scratch, "layouts", options.layout, { slideIndex: at, catalogs: options.catalogs, record: options.record });
+    const switched = prepareDimensionSwitch(scratch, "layouts", options.layout, { slideIndex: at, catalogs: options.catalogs, record: options.record, recordSource: options.recordSource });
     const catalogOps = switched.patches.filter((patch) => !patch.path.startsWith("/slides/"));
     slide = switched.presentation.slides[at];
     const patches = [...catalogOps, { op: "add", path: slidePointer(at), value: slide }];
@@ -164,7 +165,7 @@ export function prepareAddSlide(presentation, options = {}) {
 /** Add a slide (see `prepareAddSlide`) as one undoable step. The change reports `index`, `id` and `selection`. */
 export function addSlide(editor, options = {}, meta) {
   requireEditor(editor);
-  return apply(editor, prepareAddSlide(editor.presentation, options), meta, "add");
+  return apply(editor, prepareAddSlide(editor.presentation, { ...options, catalogs: mergeCatalogs(editor.catalogs, options.catalogs) }), meta, "add");
 }
 
 // --- duplicate -------------------------------------------------------------------------------------

package/dist/svelte.d.ts

@@ -11,6 +11,7 @@ export interface OPFCatalogSelectActionParams extends CatalogOptionsInput {
   path: string;
   catalogKind: string;
   label?: string;
+  onError?: (error: Error) => void;
 }
 
 export interface OPFTraceActionParams extends SvgTraceBindingOptions {

package/dist/svelte.js

@@ -1,3 +1,4 @@
+import { commitCatalogControl } from "./catalog-control.js";
 import {
   createSvgTraceBinding,
   getCatalogOptions,
@@ -50,8 +51,8 @@ export function opfCatalogSelect(node, params) {
     node.setAttribute?.("data-opf-catalog-kind", catalogKind);
     if (label) node.setAttribute?.("aria-label", label);
     replaceOptions(node, getCatalogOptions(catalogKind, {
+      editor,
       catalogs: nextParams.catalogs,
-      catalogSources: nextParams.catalogSources,
       presentation: nextParams.presentation ?? editor.presentation
     }));
 
@@ -59,12 +60,11 @@ export function opfCatalogSelect(node, params) {
       const value = editor.get(path);
       node.value = value && typeof value === "object" ? value.id : value ?? "";
     };
-    const onChange = () => setCatalogId(editor, path, catalogKind, node.value, {
+    const onChange = () => commitCatalogControl(node, nextParams.onError, sync, () => setCatalogId(editor, path, catalogKind, node.value, {
       catalogs: nextParams.catalogs,
-      catalogSources: nextParams.catalogSources,
       presentation: nextParams.presentation,
       source: "svelte-catalog-select"
-    });
+    }));
     const unsubscribe = editor.subscribe(sync);
 
     node.addEventListener?.("change", onChange);

package/dist/switches.d.ts

@@ -1,6 +1,14 @@
 import type { ConvertOptions } from "@openpresentation/opf/convert";
+import type { Catalog } from "@openpresentation/opf";
 import type { EditorChange, EditorSession, JsonPatchOperation } from "./index.js";
 
+/** Display metadata for the engine vocabularies, in the shape of `catalogDisplay` (`@openpresentation/opf/catalog`): records by id, or a list of records with `id` (`bcp47` for a language). */
+export interface SwitchVocabularies {
+  languages?: unknown;
+  chartTypes?: unknown;
+  socialPlatforms?: unknown;
+}
+
 /** The schema's DimensionPreset values: the values of the slide-sizes switch. */
 export declare const SLIDE_SIZE_PRESETS: readonly ["16:9", "4:3", "16:10", "1:1", "4:5", "9:16", "letter", "a4", "widescreen", "standard"];
 export type SlideSizePreset = (typeof SLIDE_SIZE_PRESETS)[number];
@@ -29,14 +37,17 @@ export type SwitchDimension = (typeof SWITCH_DIMENSIONS)[number];
 export interface DimensionSwitchOptions {
   /** Required for layouts and charts; for design dimensions it scopes the switch to one slide (default: the deck). */
   slideIndex?: number;
-  /** blocks: the complete block (`slides.0.blocks.1`) or one-payload slide/region to replace. charts: the block holding the chart (default: the slide's first chart). */
+  /** blocks: the complete block (`slides.0.blocks.1`) or one-payload slide/region to replace. charts: the block holding the chart (default: the slide's first chart). image-treatments: the image block. */
   path?: string | string[];
-  /** A gallery item's catalog record, added inline in the same transaction when the id is not already defined. */
+  /** A gallery item's catalog record, embedded in the same transaction (under the group of `recordSource`, else `custom`) when it is not embedded yet. */
   record?: Record<string, unknown> & { id: string };
-  /** Extra caller-loaded catalog records by kind. */
-  catalogs?: Record<string, unknown>;
-  catalogSources?: Record<string, unknown>;
-  /** themes: also write the theme's color scheme, font scheme and background (and, for the deck, dimensions) to the design (default true). A slide's design cannot set dimensions. */
+  /** The catalog source of `record` (for example "https://www.pptx.gallery"). */
+  recordSource?: string;
+  /** Host catalogs (`Catalog[]`): references resolve in the document, then in these. */
+  catalogs?: readonly Catalog[];
+  /** Display metadata for languages, chart types and social platforms (labels in pickers). */
+  vocabularies?: SwitchVocabularies;
+  /** themes: the theme's own color scheme, font scheme and background (and, for the deck, dimensions) apply: overrides of those at the switched scope are removed; on a slide whose deck sets one, the theme's value is written on the slide (default true). */
   bundle?: boolean;
   /** Deck-scope design switches: remove slide-level values that would hide the switch. */
   clearSlideOverrides?: boolean;
@@ -55,12 +66,11 @@ export interface DimensionSwitchOptions {
 
 export type DimensionSwitchValue =
   | null /* backgrounds: remove it */
-  | string /* slide-sizes: a SlideSizePreset. purposes: a catalog id or free-form goal text. */
-  | string[] /* audiences: catalog ids */
+  | string /* slide-sizes: a SlideSizePreset. purposes: a catalog reference or free-form goal text. languages: a BCP-47 tag. Catalog dimensions: a reference, `id` or `name:id`. */
+  | string[] /* audiences: catalog references */
   | { platform: string; handle: string }
   | { header?: unknown; footer?: unknown }
-  | { slideImage?: unknown; imageFill?: string | null }
-  | Record<string, unknown>;
+  | Record<string, unknown> /* image-treatments: fit, focus, aspectRatio, shape, cornerRadius, border, opacity, recolor, overlay, placement (null removes) */;
 
 export interface PreparedDimensionSwitch {
   dimension: SwitchDimension;
@@ -92,18 +102,23 @@ export declare function prepareDimensionSwitch(presentation: unknown, dimension:
 export declare function switchDimension(editor: EditorSession, dimension: SwitchDimension, value: DimensionSwitchValue, options?: DimensionSwitchOptions): DimensionSwitchChange;
 
 export interface SwitchOption {
+  /** The value to switch to: for a catalog dimension the reference, `id` or `name:id`. */
   id: string;
   label: string;
   record?: Record<string, unknown>;
+  reference?: string;
+  group?: string;
+  source?: string;
+  origin?: "document" | "host";
 }
 export interface CompatibleChartType extends SwitchOption {
   /** True for the chart's present type, which is always listed. */
   current: boolean;
 }
-/** Values a picker can offer for a catalog-backed dimension (document inline records, caller catalogs, then the bundled catalog, without duplicates); `blocks` lists the content kinds and `slide-sizes` the presets (labelled with their inches). `purposes` lists the catalog; any other goal text is also a valid switch value. */
-export declare function listSwitchOptions(presentation: unknown, dimension: SwitchDimension, options?: Pick<DimensionSwitchOptions, "catalogs" | "catalogSources">): SwitchOption[];
-/** Chart types the chart's inline data can use as it is (data-shape compatibility, not an engine-support claim). `path` or `slideIndex` picks the chart. */
-export declare function compatibleChartTypes(presentation: unknown, options?: Pick<DimensionSwitchOptions, "slideIndex" | "path" | "catalogs" | "catalogSources">): CompatibleChartType[];
-/** The value a dimension currently has: `{ value, scope }`, with the catalog id for catalog dimensions. `slide-sizes` reads the deck's design.dimensions, else its theme's (a preset string, or the object for a custom size); `purposes` reads the goal text or Purpose id. */
-export declare function currentSwitchValue(presentation: unknown, dimension: SwitchDimension, options?: Pick<DimensionSwitchOptions, "slideIndex" | "path" | "owner" | "index">): { value: unknown; scope: "deck" | "slide" | "block" };
+/** Values a picker can offer: a catalog dimension lists core's `catalogRecords` (embedded records, then `catalogs`); `charts` and `socials` list core's vocabularies, `languages` core's `LANGUAGES` tags; `blocks` lists the content kinds and `slide-sizes` the presets. `purposes` lists the catalogs; any other goal text is also a valid switch value. */
+export declare function listSwitchOptions(presentation: unknown, dimension: SwitchDimension, options?: Pick<DimensionSwitchOptions, "catalogs" | "vocabularies">): SwitchOption[];
+/** Chart types the chart's inline data can use as it is (data-shape compatibility from `vocabularies.chartTypes`, not an engine-support claim). `path` or `slideIndex` picks the chart. */
+export declare function compatibleChartTypes(presentation: unknown, options?: Pick<DimensionSwitchOptions, "slideIndex" | "path" | "catalogs" | "vocabularies">): CompatibleChartType[];
+/** The value a dimension currently has: `{ value, scope }`, with the reference (`id` or `name:id`) for catalog dimensions. `slide-sizes` reads the deck's design.dimensions, else its theme's (a preset string, or the object for a custom size); `purposes` reads the goal text or Purpose id. */
+export declare function currentSwitchValue(presentation: unknown, dimension: SwitchDimension, options?: Pick<DimensionSwitchOptions, "slideIndex" | "path" | "owner" | "index" | "catalogs">): { value: unknown; scope: "deck" | "slide" | "block" };
 export { blockConversionTargets } from "./block-convert.js";