@openpresentation/opf-editor 0.12.1 → 0.15.0

package/dist/galleries.js

@@ -1,5 +1,4 @@
 import { assertOpf, unwrapOpf, MAX_OPF_BYTES } from "./transfer.js";
-import { catalogs } from "@openpresentation/opf";
 export function galleryUrl(input, base) {
   const url = new URL(input, base);
   if (
@@ -119,44 +118,29 @@ export async function loadOpfGallery(input, options = {}) {
 }
 const FONT_SCHEME_ENUMS = {
   type: ["sans-serif", "serif", "monospace"],
-  app: ["PowerPoint", "Google Slides"],
-  languageFamily: ["latin", "ea", "cs"],
+  app: ["powerpoint", "google-slides"],
+  languageFamily: ["latin", "ea", "cs", "eastAsian", "complexScript"],
 };
-// A Font role object ({ family, weight?, style?, letterSpacing? }), or undefined.
+// A font role is a family name (a non-empty string), or undefined.
 function fontRole(value) {
-  if (typeof value === "string") return value ? { family: value } : undefined;
-  if (!value || typeof value !== "object" || typeof value.family !== "string")
-    return undefined;
-  const role = { family: value.family };
-  if (typeof value.weight === "number" && Number.isFinite(value.weight))
-    role.weight = value.weight;
-  if (value.style === "normal" || value.style === "italic")
-    role.style = value.style;
-  if (
-    typeof value.letterSpacing === "number" &&
-    Number.isFinite(value.letterSpacing)
-  )
-    role.letterSpacing = value.letterSpacing;
-  return role;
+  return typeof value === "string" && value ? value : undefined;
 }
 // Keep every font-scheme role that the catalog record schema defines: the OOXML
-// pair and `code`. Gallery `heading`/`body` (string or Font object) map onto
+// pair and `code`. Gallery `heading`/`body` (family names) map onto
 // major/minor only, never role objects, so a later inline design.fontScheme
 // major/minor override still wins (resolveFontFamilies checks roles before the
 // pair). `accent` is not part of the record schema and is dropped.
 function fontSchemeRecord(source, id) {
   const record = {
-    $schema: "https://openpresentation.org/schema/opf-font-scheme/v1",
-    id,
     name: source.name ?? id,
     major:
       typeof source.major === "string"
         ? source.major
-        : fontRole(source.heading)?.family,
+        : fontRole(source.heading),
     minor:
       typeof source.minor === "string"
         ? source.minor
-        : fontRole(source.body)?.family,
+        : fontRole(source.body),
   };
   for (const [field, values] of Object.entries(FONT_SCHEME_ENUMS))
     if (values.includes(source[field])) record[field] = source[field];
@@ -164,10 +148,25 @@ function fontSchemeRecord(source, id) {
   if (code) record.code = code;
   return record;
 }
-function attachDefinition(document, descriptor) {
+const isPlain = (value) => Boolean(value) && typeof value === "object" && !Array.isArray(value);
+// Embedded records carry no `$schema`, `id` or `x-*` display metadata (OPF 0.15): the key is the id.
+function embeddedRecord(source) {
+  return Object.fromEntries(
+    Object.entries(structuredClone(source)).filter(
+      ([key]) => key !== "$schema" && key !== "id" && key !== "slug" && !key.startsWith("x-"),
+    ),
+  );
+}
+/**
+ * A gallery item that describes one catalog record (a layout, theme, colour or font scheme) is embedded in the
+ * document it previews: under `default` with the gallery's origin as its `source` when the document has no default
+ * group (or its default is that gallery), else under `custom` (an item with no gallery URL, or another default
+ * catalog). Records the document already embeds are kept.
+ */
+function attachDefinition(presentation, descriptor, gallerySource) {
   const source = descriptor.metadata?.source,
     category = descriptor.category ?? descriptor.metadata?.category;
-  if (!source) return;
+  if (!isPlain(source)) return;
   const kind = {
     layouts: "layouts",
     "font-schemes": "fontSchemes",
@@ -176,49 +175,31 @@ function attachDefinition(document, descriptor) {
   }[category];
   if (!kind) return;
   const id = source.id ?? source.slug;
-  if (!id) return;
-  if (
-    catalogs[kind]?.some((record) => record.id === id) ||
-    document.catalogs?.[kind]?.records?.some((record) => record.id === id)
-  )
-    return;
+  if (typeof id !== "string" || !/^[a-z][a-z0-9-]*$/.test(id)) return;
+  const groups = (presentation.catalogs ??= {});
+  if (groups.custom?.[kind]?.[id] !== undefined || groups.default?.[kind]?.[id] !== undefined) return;
+  const group = gallerySource && (groups.default === undefined || groups.default?.source === gallerySource) ? "default" : "custom";
+  if (group === "default") groups.default ??= { source: gallerySource };
+  else groups.custom ??= {};
+  groups[group][kind] ??= {};
   let record;
   if (kind === "layouts") {
-    const n = Math.min(
-      12,
-      Number(String(source.contentMultiple ?? "").replace("x", "")) || 1,
-    );
-    const type =
-      { Image: "picture", Chart: "chart", List: "list" }[source.contentType] ??
-      "text";
+    // A gallery layout item is a layout record: its placeholders, design hints and composition are the
+    // record's own. Only an item that declares no placeholders gets the default title and text.
+    const placeholders = Array.isArray(source.placeholders)
+      ? source.placeholders
+          .filter((placeholder) => typeof placeholder?.type === "string")
+          .map((placeholder) => structuredClone(placeholder))
+      : [{ type: "title" }, { type: "text" }];
     record = {
-      $schema: "https://openpresentation.org/schema/opf-layout/v1",
-      id,
       name: source.label ?? source.name ?? id,
-      placeholders: [
-        { type: "title" },
-        ...Array.from({ length: n }, () => ({ type })),
-      ],
-      ...(n > 1
-        ? {
-            composition: {
-              mode: n <= 3 ? "row" : "grid",
-              ...(n > 3 ? { columns: 2 } : {}),
-            },
-          }
-        : {}),
+      ...(isPlain(source.design) ? { design: structuredClone(source.design) } : {}),
+      placeholders,
+      ...(isPlain(source.composition) ? { composition: structuredClone(source.composition) } : {}),
     };
   } else if (kind === "fontSchemes") record = fontSchemeRecord(source, id);
-  else {
-    record = {
-      ...source,
-      $schema: `https://openpresentation.org/schema/opf-${kind === "themes" ? "theme" : "color-scheme"}/v1`,
-    };
-  }
-  document.catalogs ??= {};
-  document.catalogs[kind] ??= { records: [] };
-  document.catalogs[kind].records ??= [];
-  document.catalogs[kind].records.push(record);
+  else record = embeddedRecord(source);
+  groups[group][kind][id] = record;
 }
 export async function loadOpfGalleryItem(item, { gallery, ...options } = {}) {
   const base = gallery ?? options.base;
@@ -234,44 +215,12 @@ export async function loadOpfGalleryItem(item, { gallery, ...options } = {}) {
     );
     if (!descriptor) throw new Error("This gallery item was not found.");
   }
-  const document = structuredClone(unwrapOpf(descriptor));
-  if (!document?.slides)
+  const presentation = structuredClone(unwrapOpf(descriptor));
+  if (!presentation?.slides)
     throw new Error("This gallery item does not include a presentation.");
-  attachDefinition(document, descriptor);
-  // PPTX.gallery's older descriptors omit inline layout records. Resolve only named
-  // layout references from its known, same-origin registry; no arbitrary dependency crawl.
-  if (
-    url &&
-    ["www.pptx.gallery", "pptx.gallery"].includes(new URL(url).hostname)
-  ) {
-    const missing = [
-      ...new Set(
-        document.slides
-          .map((slide) => slide.layout)
-          .filter(
-            (id) =>
-              typeof id === "string" &&
-              !catalogs.layouts.some((record) => record.id === id) &&
-              !document.catalogs?.layouts?.records?.some(
-                (record) => record.id === id,
-              ),
-          ),
-      ),
-    ];
-    if (missing.length > 12)
-      throw new Error(
-        "This item needs too many layout definitions. Supply self-contained OPF.",
-      );
-    for (const id of missing) {
-      if (!/^[a-z][a-z0-9-]*$/.test(id))
-        throw new Error("Unsupported layout reference.");
-      const dependency = await fetchGalleryJson(
-        `/registry/layouts/${id}.json`,
-        { ...options, base: url, origin: new URL(url).origin },
-      );
-      attachDefinition(document, dependency);
-    }
-  }
-  assertOpf(document);
-  return document;
+  // A gallery publishes self-contained OPF (every record a document uses is embedded, FA-23); the item's own record is
+  // embedded too when the snippet omits it. Nothing else is fetched.
+  attachDefinition(presentation, descriptor, url ? new URL(url).origin : undefined);
+  assertOpf(presentation);
+  return presentation;
 }

package/dist/grid-model.d.ts

@@ -34,18 +34,18 @@ export interface PreparedGridChange {
   path: string;
   /** The id of the shared dataset the edit changes, when the chart or table shows one (RR-54). */
   dataset?: string;
-  document: unknown;
+  presentation: unknown;
   patches: JsonPatchOperation[];
   changed: boolean;
   [key: string]: unknown;
 }
-export interface GridChange extends Omit<EditorChange, "document" | "patches"> {
+export interface GridChange extends Omit<EditorChange, "presentation" | "patches"> {
   action: string;
   kind: "chart" | "table";
   path: string;
   /** The id of the shared dataset the edit changed, when the chart or table shows one. */
   dataset?: string;
-  document: unknown;
+  presentation: unknown;
   patches: JsonPatchOperation[];
   changed: boolean;
   [key: string]: unknown;
@@ -136,11 +136,11 @@ export declare function chartColumnRoles(columnCount: number, chartType?: string
 /** The text a cell shows. */
 export declare function cellText(raw: unknown, kind: "chart" | "table", decimal?: "." | ","): string;
 /**
- * Find the data a path points at (`…chart`, `…chart.data`, `…table`). Throws `grid-target-not-found`, `table-not-found`, `chart-data-source` or
+ * Find the data a path points at (`…chart`, `…chart.data`, `…table`). Throws `grid-target-not-found`, `table-not-found` or
  * `dataset-unavailable`. For a chart or table that shows a shared dataset, `data` is the dataset, `dataParts` is `["datasets", id]` and `dataset`
  * says which columns `fields` selects (`indices`, into the dataset's own columns) and where the reference is (`refParts`).
  */
-export declare function locateGridData(document: unknown, path: string | string[]): {
+export declare function locateGridData(presentation: unknown, path: string | string[]): {
   kind: "chart" | "table";
   parts: string[];
   dataParts: string[];
@@ -150,48 +150,46 @@ export declare function locateGridData(document: unknown, path: string | string[
   dataset?: { id: string; fields?: string[]; indices: number[]; refParts: string[]; ref: Record<string, unknown> };
 };
 /** The chart or table a selection path belongs to, or undefined. */
-export declare function resolveDataGridTarget(document: unknown, selectedPath: string): DataGridTarget | undefined;
+export declare function resolveDataGridTarget(presentation: unknown, selectedPath: string): DataGridTarget | undefined;
 /** The grid view of a chart or table: lines of cells with spans, covered positions, text, warnings. */
-export declare function describeDataGrid(document: unknown, path: string, options?: GridOptions): DataGridDescription;
+export declare function describeDataGrid(presentation: unknown, path: string, options?: GridOptions): DataGridDescription;
 /** The smallest guarded patch from `before` to `after` at `parts`. */
 export declare function gridPatches(parts: string[], before: unknown, after: unknown): JsonPatchOperation[];
 /** The problems the edits would have, without applying them or validating the document. */
-export declare function gridCellIssues(document: unknown, path: string, edits: GridCellEdit[], options?: GridOptions): GridIssue[];
+export declare function gridCellIssues(presentation: unknown, path: string, edits: GridCellEdit[], options?: GridOptions): GridIssue[];
 /** The text of a range (`{ from, to }` addresses; the whole grid when omitted) as TSV, or another delimiter. */
-export declare function gridRangeText(document: unknown, path: string, range?: { from: GridAddress; to: GridAddress }, options?: GridOptions): string;
+export declare function gridRangeText(presentation: unknown, path: string, range?: { from: GridAddress; to: GridAddress }, options?: GridOptions): string;
 
-export declare function prepareGridCells(document: unknown, path: string, edits: GridCellEdit[], options?: GridOptions): PreparedGridChange;
-export declare function preparePaste(document: unknown, path: string, anchor: GridAddress, source: string | string[][], options?: GridOptions): PreparedGridChange;
-export declare function prepareInsertRows(document: unknown, path: string, at: number, count?: number, options?: GridOptions): PreparedGridChange;
-export declare function prepareDeleteRows(document: unknown, path: string, indices: number[], options?: GridOptions): PreparedGridChange;
-export declare function prepareMoveRows(document: unknown, path: string, from: number, to: number, count?: number, options?: GridOptions): PreparedGridChange;
-export declare function prepareInsertColumns(document: unknown, path: string, at: number, count?: number, options?: GridOptions): PreparedGridChange;
-export declare function prepareDeleteColumns(document: unknown, path: string, indices: number[], options?: GridOptions): PreparedGridChange;
-export declare function prepareMoveColumns(document: unknown, path: string, from: number, to: number, count?: number, options?: GridOptions): PreparedGridChange;
-export declare function prepareSortRows(document: unknown, path: string, column: number, options?: GridSortOptions): PreparedGridChange;
-export declare function prepareSetHeader(document: unknown, path: string, enabled: boolean, options?: { use?: "first-row" | "new" }): PreparedGridChange;
-export declare function prepareTranspose(document: unknown, path: string): PreparedGridChange;
+export declare function prepareGridCells(presentation: unknown, path: string, edits: GridCellEdit[], options?: GridOptions): PreparedGridChange;
+export declare function preparePaste(presentation: unknown, path: string, anchor: GridAddress, source: string | string[][], options?: GridOptions): PreparedGridChange;
+export declare function prepareInsertRows(presentation: unknown, path: string, at: number, count?: number, options?: GridOptions): PreparedGridChange;
+export declare function prepareDeleteRows(presentation: unknown, path: string, indices: number[], options?: GridOptions): PreparedGridChange;
+export declare function prepareMoveRows(presentation: unknown, path: string, from: number, to: number, count?: number, options?: GridOptions): PreparedGridChange;
+export declare function prepareInsertColumns(presentation: unknown, path: string, at: number, count?: number, options?: GridOptions): PreparedGridChange;
+export declare function prepareDeleteColumns(presentation: unknown, path: string, indices: number[], options?: GridOptions): PreparedGridChange;
+export declare function prepareMoveColumns(presentation: unknown, path: string, from: number, to: number, count?: number, options?: GridOptions): PreparedGridChange;
+export declare function prepareSortRows(presentation: unknown, path: string, column: number, options?: GridSortOptions): PreparedGridChange;
+export declare function prepareSetHeader(presentation: unknown, path: string, enabled: boolean, options?: { use?: "first-row" | "new" }): PreparedGridChange;
+export declare function prepareTranspose(presentation: unknown, path: string): PreparedGridChange;
 /** Why `format` is not a valid number format ("#,##0", "0.0%", "$#,##0.00"), or undefined when it is valid or empty (empty clears the format). */
 export declare function columnFormatError(format: unknown): string | undefined;
-/** Whether the installed core has the RR-54 chart and table data contract (number formats, datasets, strict chart numbers). An older core edits documents that use none of it. */
-export declare const supportsChartTableData: boolean;
 /**
  * Set or clear (`null` or "") the number format of column `column` (its header cell). A string header becomes `{ name, format }` and returns to a string
  * when the format is cleared. Throws `number-format-invalid` with the reason, or `grid-no-header` for a table without a header row.
  */
-export declare function prepareGridColumnFormat(document: unknown, path: string, column: number, format: string | null | undefined, options?: GridOptions): PreparedGridChange;
+export declare function prepareGridColumnFormat(presentation: unknown, path: string, column: number, format: string | null | undefined, options?: GridOptions): PreparedGridChange;
 /** The columns a chart plots and how they got that role (the chart's `mapping`, or core's positional default). */
-export declare function describeChartMapping(document: unknown, path: string): ChartMappingDescription;
+export declare function describeChartMapping(presentation: unknown, path: string): ChartMappingDescription;
 /**
  * Set a chart's category, X and series columns by name; what `wanted` leaves out keeps its current value. A field that equals the default is not
  * written, and `chart.mapping` is removed when nothing is left. One patch. Throws `chart-mapping-unknown-column`, `chart-mapping-x-unsupported`,
  * `chart-mapping-conflict` or `chart-mapping-no-series`.
  */
-export declare function prepareChartMapping(document: unknown, path: string, wanted?: ChartMappingColumns): PreparedGridChange;
+export declare function prepareChartMapping(presentation: unknown, path: string, wanted?: ChartMappingColumns): PreparedGridChange;
 /** Replace the chart's or table's dataset reference with its own inline copy of the data. The dataset stays for the other items. One patch. */
-export declare function prepareDetachDataset(document: unknown, path: string): PreparedGridChange;
+export declare function prepareDetachDataset(presentation: unknown, path: string): PreparedGridChange;
 /** The charts and tables that use dataset `id`, in document order. */
-export declare function datasetUsage(document: unknown, id: string): Array<{ kind: "chart" | "table"; path: string; parts: string[] }>;
+export declare function datasetUsage(presentation: unknown, id: string): Array<{ kind: "chart" | "table"; path: string; parts: string[] }>;
 
 export declare function setGridCells(editor: EditorSession, path: string, edits: GridCellEdit[], options?: GridOptions): GridChange;
 export declare function pasteGridText(editor: EditorSession, path: string, anchor: GridAddress, source: string | string[][], options?: GridOptions): GridChange;