ooxml-core 1.23.0 → 1.24.0

package/dist/embedding/index.cjs

@@ -0,0 +1,229 @@
+'use strict';
+
+// embedding/storage.ts
+var FILE_COMMAND_EVENT = "file-command";
+function fileCommandDetail(command, fileName) {
+  return fileName === void 0 ? { command } : { command, fileName };
+}
+function recoveryStoreOf(storage) {
+  if (!storage?.readRecovery || !storage.writeRecovery || !storage.clearRecovery) return void 0;
+  return storage;
+}
+function isDocumentStorage(value) {
+  return typeof value === "object" && value !== null && typeof value.save === "function";
+}
+var MIME_TYPES = {
+  docx: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+  docm: "application/vnd.ms-word.document.macroEnabled.12",
+  dotx: "application/vnd.openxmlformats-officedocument.wordprocessingml.template",
+  doc: "application/msword",
+  xlsx: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+  xlsm: "application/vnd.ms-excel.sheet.macroEnabled.12",
+  xltx: "application/vnd.openxmlformats-officedocument.spreadsheetml.template",
+  xls: "application/vnd.ms-excel",
+  csv: "text/csv",
+  pptx: "application/vnd.openxmlformats-officedocument.presentationml.presentation",
+  pptm: "application/vnd.ms-powerpoint.presentation.macroEnabled.12",
+  ppsx: "application/vnd.openxmlformats-officedocument.presentationml.slideshow",
+  potx: "application/vnd.openxmlformats-officedocument.presentationml.template",
+  ppt: "application/vnd.ms-powerpoint",
+  vsdx: "application/vnd.ms-visio.drawing",
+  vsdm: "application/vnd.ms-visio.drawing.macroEnabled.12",
+  vsd: "application/vnd.visio",
+  txt: "text/plain",
+  json: "application/json"
+};
+function documentMimeType(fileName) {
+  const extension = /\.([^./\\]+)$/.exec(fileName)?.[1]?.toLowerCase() ?? "";
+  return MIME_TYPES[extension] ?? "application/octet-stream";
+}
+function documentSaveMeta(fileName, reason = "save", mimeType = documentMimeType(fileName)) {
+  return { fileName, mimeType, reason };
+}
+async function saveToStorage(storage, bytes, meta) {
+  const result = await storage.save(bytes, meta);
+  const name = result?.fileName?.trim();
+  return name ? name : meta.fileName;
+}
+
+// embedding/backstage.ts
+function hostBackstageItemId(id) {
+  return `host.${id}`;
+}
+function hostBackstagePageId(itemId) {
+  return itemId.startsWith("host.") ? itemId.slice(5) : void 0;
+}
+function acceptedHostBackstagePages(pages) {
+  const seen = /* @__PURE__ */ new Set();
+  const accepted = [];
+  for (const page of pages ?? []) {
+    if (!page || typeof page.id !== "string" || !page.id || seen.has(page.id)) continue;
+    seen.add(page.id);
+    accepted.push({ page, index: accepted.length });
+  }
+  return accepted.sort((a, b) => (a.page.order ?? 0) - (b.page.order ?? 0) || a.index - b.index).map(({ page }) => page);
+}
+function placeHostBackstagePages(items, pages, toEntry) {
+  const entries = [...items];
+  for (const page of acceptedHostBackstagePages(pages)) {
+    const group = page.group ?? "main";
+    let at = entries.length;
+    while (at > 0 && (entries[at - 1]?.group ?? "main") !== group) at--;
+    entries.splice(at === 0 ? entries.length : at, 0, toEntry(page));
+  }
+  return entries;
+}
+
+// embedding/capabilities.ts
+var EDITOR_CAPABILITY_IDS = [
+  /** Changing the document. `false` opens it read-only, whatever the edit prop says. */
+  "edit",
+  /** Saving a copy in another format (File > Export, Save As, Download). */
+  "export",
+  /** Printing (File > Print, the Print commands and Ctrl+P). */
+  "print",
+  /** Sharing the document with other people (File > Share, Share buttons). */
+  "share",
+  /** Copying content out (Copy, Cut and their shortcuts). */
+  "copy",
+  /** Adding and editing comments. */
+  "comment",
+  /** Tracked changes: turning tracking on, accepting and rejecting. */
+  "review",
+  /** Find and Replace. */
+  "find",
+  /** File > New and File > Open. */
+  "open",
+  /** File > Save. */
+  "save",
+  /** File > Options and Customize Ribbon. */
+  "settings"
+];
+function isCapabilityEnabled(capabilities, id) {
+  return capabilities?.[id] !== false;
+}
+function disabledCapabilities(capabilities) {
+  if (!capabilities) return [];
+  return Object.keys(capabilities).filter((id) => capabilities[id] === false);
+}
+function capabilityHiddenActions(capabilities, map) {
+  const hidden = /* @__PURE__ */ new Set();
+  for (const id of disabledCapabilities(capabilities))
+    for (const action of map[id] ?? []) hidden.add(action);
+  return [...hidden];
+}
+function mergeHiddenActions(...lists) {
+  const merged = /* @__PURE__ */ new Set();
+  for (const list of lists) for (const action of list ?? []) merged.add(action);
+  return [...merged];
+}
+
+// embedding/menu-commands.ts
+function hostMenuEntryId(id) {
+  return `host:${id}`;
+}
+function isHostMenuEntry(entry) {
+  return typeof entry === "object" && entry !== null && entry.host === true;
+}
+function resolveHostMenuCommands(commands, context) {
+  const top = [];
+  const bottom = [];
+  const seen = /* @__PURE__ */ new Set();
+  for (const command of commands ?? []) {
+    if (!command?.id || seen.has(command.id)) continue;
+    seen.add(command.id);
+    if (command.when && !command.when(context)) continue;
+    const disabled = typeof command.disabled === "function" ? command.disabled(context) : command.disabled === true;
+    const entry = {
+      id: hostMenuEntryId(command.id),
+      host: true,
+      label: command.label,
+      labelKey: "",
+      disabled,
+      onSelect: () => {
+        if (!disabled) command.onSelect(context);
+      }
+    };
+    if (command.icon) entry.icon = command.icon;
+    (command.group === "bottom" ? bottom : top).push(entry);
+  }
+  return { top, bottom };
+}
+function withHostMenuCommands(entries, commands, context) {
+  const { top, bottom } = resolveHostMenuCommands(commands, context);
+  const middle = entries.map(
+    (entry, index) => index === 0 ? { ...entry, separatorBefore: top.length > 0 } : entry
+  );
+  const first = bottom[0];
+  if (first && top.length + middle.length > 0) first.separatorBefore = true;
+  return [...top, ...middle, ...bottom];
+}
+function withoutHiddenEntries(entries, hidden) {
+  const kept = [];
+  let separator = false;
+  for (const entry of entries) {
+    separator ||= entry.separatorBefore === true;
+    if (hidden(entry)) continue;
+    const starts = separator && kept.length > 0;
+    kept.push(
+      entry.separatorBefore === true === starts ? entry : { ...entry, separatorBefore: starts }
+    );
+    separator = false;
+  }
+  return kept;
+}
+
+// embedding/regions.ts
+function hostBackstageRegionId(id) {
+  return `backstage.host.${id}`;
+}
+function sameRenderer(a, b) {
+  if (a === b) return true;
+  if (!a || !b || typeof a !== "object" || typeof b !== "object" || a.element !== b.element)
+    return false;
+  const left = a.properties ?? {};
+  const right = b.properties ?? {};
+  const keys = Object.keys(left);
+  return keys.length === Object.keys(right).length && keys.every((key) => Object.is(left[key], right[key]));
+}
+function sameRegionContext(a, b, callbackKeys = /* @__PURE__ */ new Set(["close"])) {
+  const left = a;
+  const right = b;
+  for (const key of /* @__PURE__ */ new Set([...Object.keys(left), ...Object.keys(right)])) {
+    if (callbackKeys.has(key)) continue;
+    const x = left[key];
+    const y = right[key];
+    if (Array.isArray(x) && Array.isArray(y)) {
+      if (!sameItems(x, y)) return false;
+    } else if (!Object.is(x, y)) return false;
+  }
+  return true;
+}
+function sameItems(a, b) {
+  return a === b || a.length === b.length && a.every((item, index) => Object.is(item, b[index]));
+}
+
+exports.EDITOR_CAPABILITY_IDS = EDITOR_CAPABILITY_IDS;
+exports.FILE_COMMAND_EVENT = FILE_COMMAND_EVENT;
+exports.acceptedHostBackstagePages = acceptedHostBackstagePages;
+exports.capabilityHiddenActions = capabilityHiddenActions;
+exports.disabledCapabilities = disabledCapabilities;
+exports.documentMimeType = documentMimeType;
+exports.documentSaveMeta = documentSaveMeta;
+exports.fileCommandDetail = fileCommandDetail;
+exports.hostBackstageItemId = hostBackstageItemId;
+exports.hostBackstagePageId = hostBackstagePageId;
+exports.hostBackstageRegionId = hostBackstageRegionId;
+exports.hostMenuEntryId = hostMenuEntryId;
+exports.isCapabilityEnabled = isCapabilityEnabled;
+exports.isDocumentStorage = isDocumentStorage;
+exports.isHostMenuEntry = isHostMenuEntry;
+exports.mergeHiddenActions = mergeHiddenActions;
+exports.placeHostBackstagePages = placeHostBackstagePages;
+exports.recoveryStoreOf = recoveryStoreOf;
+exports.resolveHostMenuCommands = resolveHostMenuCommands;
+exports.sameRegionContext = sameRegionContext;
+exports.sameRenderer = sameRenderer;
+exports.saveToStorage = saveToStorage;
+exports.withHostMenuCommands = withHostMenuCommands;
+exports.withoutHiddenEntries = withoutHiddenEntries;

package/dist/embedding/index.d.ts

@@ -0,0 +1,7 @@
+export * from './storage.js';
+export * from './backstage.js';
+export * from './capabilities.js';
+export * from './customization.js';
+export * from './menu-commands.js';
+export * from './regions.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/embedding/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../embedding/index.ts"],"names":[],"mappings":"AAEA,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,WAAW,CAAC"}

package/dist/embedding/index.mjs

@@ -0,0 +1,204 @@
+// embedding/storage.ts
+var FILE_COMMAND_EVENT = "file-command";
+function fileCommandDetail(command, fileName) {
+  return fileName === void 0 ? { command } : { command, fileName };
+}
+function recoveryStoreOf(storage) {
+  if (!storage?.readRecovery || !storage.writeRecovery || !storage.clearRecovery) return void 0;
+  return storage;
+}
+function isDocumentStorage(value) {
+  return typeof value === "object" && value !== null && typeof value.save === "function";
+}
+var MIME_TYPES = {
+  docx: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+  docm: "application/vnd.ms-word.document.macroEnabled.12",
+  dotx: "application/vnd.openxmlformats-officedocument.wordprocessingml.template",
+  doc: "application/msword",
+  xlsx: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+  xlsm: "application/vnd.ms-excel.sheet.macroEnabled.12",
+  xltx: "application/vnd.openxmlformats-officedocument.spreadsheetml.template",
+  xls: "application/vnd.ms-excel",
+  csv: "text/csv",
+  pptx: "application/vnd.openxmlformats-officedocument.presentationml.presentation",
+  pptm: "application/vnd.ms-powerpoint.presentation.macroEnabled.12",
+  ppsx: "application/vnd.openxmlformats-officedocument.presentationml.slideshow",
+  potx: "application/vnd.openxmlformats-officedocument.presentationml.template",
+  ppt: "application/vnd.ms-powerpoint",
+  vsdx: "application/vnd.ms-visio.drawing",
+  vsdm: "application/vnd.ms-visio.drawing.macroEnabled.12",
+  vsd: "application/vnd.visio",
+  txt: "text/plain",
+  json: "application/json"
+};
+function documentMimeType(fileName) {
+  const extension = /\.([^./\\]+)$/.exec(fileName)?.[1]?.toLowerCase() ?? "";
+  return MIME_TYPES[extension] ?? "application/octet-stream";
+}
+function documentSaveMeta(fileName, reason = "save", mimeType = documentMimeType(fileName)) {
+  return { fileName, mimeType, reason };
+}
+async function saveToStorage(storage, bytes, meta) {
+  const result = await storage.save(bytes, meta);
+  const name = result?.fileName?.trim();
+  return name ? name : meta.fileName;
+}
+
+// embedding/backstage.ts
+function hostBackstageItemId(id) {
+  return `host.${id}`;
+}
+function hostBackstagePageId(itemId) {
+  return itemId.startsWith("host.") ? itemId.slice(5) : void 0;
+}
+function acceptedHostBackstagePages(pages) {
+  const seen = /* @__PURE__ */ new Set();
+  const accepted = [];
+  for (const page of pages ?? []) {
+    if (!page || typeof page.id !== "string" || !page.id || seen.has(page.id)) continue;
+    seen.add(page.id);
+    accepted.push({ page, index: accepted.length });
+  }
+  return accepted.sort((a, b) => (a.page.order ?? 0) - (b.page.order ?? 0) || a.index - b.index).map(({ page }) => page);
+}
+function placeHostBackstagePages(items, pages, toEntry) {
+  const entries = [...items];
+  for (const page of acceptedHostBackstagePages(pages)) {
+    const group = page.group ?? "main";
+    let at = entries.length;
+    while (at > 0 && (entries[at - 1]?.group ?? "main") !== group) at--;
+    entries.splice(at === 0 ? entries.length : at, 0, toEntry(page));
+  }
+  return entries;
+}
+
+// embedding/capabilities.ts
+var EDITOR_CAPABILITY_IDS = [
+  /** Changing the document. `false` opens it read-only, whatever the edit prop says. */
+  "edit",
+  /** Saving a copy in another format (File > Export, Save As, Download). */
+  "export",
+  /** Printing (File > Print, the Print commands and Ctrl+P). */
+  "print",
+  /** Sharing the document with other people (File > Share, Share buttons). */
+  "share",
+  /** Copying content out (Copy, Cut and their shortcuts). */
+  "copy",
+  /** Adding and editing comments. */
+  "comment",
+  /** Tracked changes: turning tracking on, accepting and rejecting. */
+  "review",
+  /** Find and Replace. */
+  "find",
+  /** File > New and File > Open. */
+  "open",
+  /** File > Save. */
+  "save",
+  /** File > Options and Customize Ribbon. */
+  "settings"
+];
+function isCapabilityEnabled(capabilities, id) {
+  return capabilities?.[id] !== false;
+}
+function disabledCapabilities(capabilities) {
+  if (!capabilities) return [];
+  return Object.keys(capabilities).filter((id) => capabilities[id] === false);
+}
+function capabilityHiddenActions(capabilities, map) {
+  const hidden = /* @__PURE__ */ new Set();
+  for (const id of disabledCapabilities(capabilities))
+    for (const action of map[id] ?? []) hidden.add(action);
+  return [...hidden];
+}
+function mergeHiddenActions(...lists) {
+  const merged = /* @__PURE__ */ new Set();
+  for (const list of lists) for (const action of list ?? []) merged.add(action);
+  return [...merged];
+}
+
+// embedding/menu-commands.ts
+function hostMenuEntryId(id) {
+  return `host:${id}`;
+}
+function isHostMenuEntry(entry) {
+  return typeof entry === "object" && entry !== null && entry.host === true;
+}
+function resolveHostMenuCommands(commands, context) {
+  const top = [];
+  const bottom = [];
+  const seen = /* @__PURE__ */ new Set();
+  for (const command of commands ?? []) {
+    if (!command?.id || seen.has(command.id)) continue;
+    seen.add(command.id);
+    if (command.when && !command.when(context)) continue;
+    const disabled = typeof command.disabled === "function" ? command.disabled(context) : command.disabled === true;
+    const entry = {
+      id: hostMenuEntryId(command.id),
+      host: true,
+      label: command.label,
+      labelKey: "",
+      disabled,
+      onSelect: () => {
+        if (!disabled) command.onSelect(context);
+      }
+    };
+    if (command.icon) entry.icon = command.icon;
+    (command.group === "bottom" ? bottom : top).push(entry);
+  }
+  return { top, bottom };
+}
+function withHostMenuCommands(entries, commands, context) {
+  const { top, bottom } = resolveHostMenuCommands(commands, context);
+  const middle = entries.map(
+    (entry, index) => index === 0 ? { ...entry, separatorBefore: top.length > 0 } : entry
+  );
+  const first = bottom[0];
+  if (first && top.length + middle.length > 0) first.separatorBefore = true;
+  return [...top, ...middle, ...bottom];
+}
+function withoutHiddenEntries(entries, hidden) {
+  const kept = [];
+  let separator = false;
+  for (const entry of entries) {
+    separator ||= entry.separatorBefore === true;
+    if (hidden(entry)) continue;
+    const starts = separator && kept.length > 0;
+    kept.push(
+      entry.separatorBefore === true === starts ? entry : { ...entry, separatorBefore: starts }
+    );
+    separator = false;
+  }
+  return kept;
+}
+
+// embedding/regions.ts
+function hostBackstageRegionId(id) {
+  return `backstage.host.${id}`;
+}
+function sameRenderer(a, b) {
+  if (a === b) return true;
+  if (!a || !b || typeof a !== "object" || typeof b !== "object" || a.element !== b.element)
+    return false;
+  const left = a.properties ?? {};
+  const right = b.properties ?? {};
+  const keys = Object.keys(left);
+  return keys.length === Object.keys(right).length && keys.every((key) => Object.is(left[key], right[key]));
+}
+function sameRegionContext(a, b, callbackKeys = /* @__PURE__ */ new Set(["close"])) {
+  const left = a;
+  const right = b;
+  for (const key of /* @__PURE__ */ new Set([...Object.keys(left), ...Object.keys(right)])) {
+    if (callbackKeys.has(key)) continue;
+    const x = left[key];
+    const y = right[key];
+    if (Array.isArray(x) && Array.isArray(y)) {
+      if (!sameItems(x, y)) return false;
+    } else if (!Object.is(x, y)) return false;
+  }
+  return true;
+}
+function sameItems(a, b) {
+  return a === b || a.length === b.length && a.every((item, index) => Object.is(item, b[index]));
+}
+
+export { EDITOR_CAPABILITY_IDS, FILE_COMMAND_EVENT, acceptedHostBackstagePages, capabilityHiddenActions, disabledCapabilities, documentMimeType, documentSaveMeta, fileCommandDetail, hostBackstageItemId, hostBackstagePageId, hostBackstageRegionId, hostMenuEntryId, isCapabilityEnabled, isDocumentStorage, isHostMenuEntry, mergeHiddenActions, placeHostBackstagePages, recoveryStoreOf, resolveHostMenuCommands, sameRegionContext, sameRenderer, saveToStorage, withHostMenuCommands, withoutHiddenEntries };

package/dist/embedding/menu-commands.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Host context-menu commands: entries a host adds to an editor's right-click menu. Each command
+ * is plain data plus callbacks, so one descriptor works in every editor and framework binding.
+ * The context `C` is a product's immutable snapshot of what the menu was opened on (the
+ * selection, the slide, the cell range); the product documents its shape.
+ */
+/** One host command. Labels are plain text the host has already localised. */
+export interface HostMenuCommand<C> {
+    /** Unique among the host commands of one menu; a repeated or empty id is ignored. */
+    id: string;
+    label: string;
+    /** A name from the shared icon set, for products whose menus show icons. */
+    icon?: string;
+    /** `top` (the default) is a group above the built-in entries; `bottom` one below them. */
+    group?: 'top' | 'bottom';
+    /** Shown only when this returns true (or is omitted). */
+    when?: (context: C) => boolean;
+    /** A disabled command is shown greyed out and never runs. */
+    disabled?: boolean | ((context: C) => boolean);
+    /** Runs after the menu closes, with the context the menu was opened on. */
+    onSelect: (context: C) => void;
+}
+/** A host command resolved for one opening of a menu. */
+export interface HostMenuEntry {
+    /** `host:<id>`, so a host id can never collide with a built-in entry. */
+    id: `host:${string}`;
+    host: true;
+    label: string;
+    /** Kept for menus that look labels up by key; always empty for a host entry. */
+    labelKey: string;
+    icon?: string;
+    separatorBefore?: boolean;
+    disabled: boolean;
+    danger?: boolean;
+    checked?: boolean;
+    /** Runs the command (a no-op when disabled). */
+    onSelect: () => void;
+}
+/** The menu id of host command `id`. */
+export declare function hostMenuEntryId(id: string): `host:${string}`;
+/** True for an entry made from a host command. */
+export declare function isHostMenuEntry(entry: unknown): entry is HostMenuEntry;
+/** The host entries for one opening of a menu, split by group, in the host's order. */
+export declare function resolveHostMenuCommands<C>(commands: readonly HostMenuCommand<C>[] | null | undefined, context: C): {
+    top: HostMenuEntry[];
+    bottom: HostMenuEntry[];
+};
+/**
+ * A menu with the host commands placed: the `top` group before the built-in entries and the
+ * `bottom` group after them, each separated from its neighbours, with no leading or trailing
+ * separator.
+ */
+export declare function withHostMenuCommands<E extends {
+    id: string;
+    separatorBefore?: boolean;
+}, C>(entries: readonly E[], commands: readonly HostMenuCommand<C>[] | null | undefined, context: C): Array<E | HostMenuEntry>;
+/**
+ * A menu without its hidden entries, with its groups intact: a hidden entry that starts a group
+ * (`separatorBefore`) passes the separator on to the next kept entry, and the first kept entry
+ * never starts with one. So hiding entries never merges two groups, never doubles a separator
+ * and never leaves one at the top. `entries` is not changed.
+ */
+export declare function withoutHiddenEntries<E extends {
+    separatorBefore?: boolean;
+}>(entries: readonly E[], hidden: (entry: E) => boolean): E[];
+//# sourceMappingURL=menu-commands.d.ts.map

package/dist/embedding/menu-commands.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"menu-commands.d.ts","sourceRoot":"","sources":["../../embedding/menu-commands.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,8EAA8E;AAC9E,MAAM,WAAW,eAAe,CAAC,CAAC;IACjC,qFAAqF;IACrF,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,4EAA4E;IAC5E,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,0FAA0F;IAC1F,KAAK,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC;IACzB,yDAAyD;IACzD,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,OAAO,CAAC;IAC/B,6DAA6D;IAC7D,QAAQ,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC;IAC/C,2EAA2E;IAC3E,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,IAAI,CAAC;CAC/B;AAED,yDAAyD;AACzD,MAAM,WAAW,aAAa;IAC7B,yEAAyE;IACzE,EAAE,EAAE,QAAQ,MAAM,EAAE,CAAC;IACrB,IAAI,EAAE,IAAI,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,gFAAgF;IAChF,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,gDAAgD;IAChD,QAAQ,EAAE,MAAM,IAAI,CAAC;CACrB;AAED,wCAAwC;AACxC,wBAAgB,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,QAAQ,MAAM,EAAE,CAE5D;AAED,kDAAkD;AAClD,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,aAAa,CAEtE;AAED,uFAAuF;AACvF,wBAAgB,uBAAuB,CAAC,CAAC,EACxC,QAAQ,EAAE,SAAS,eAAe,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,GAAG,SAAS,EAC1D,OAAO,EAAE,CAAC,GACR;IAAE,GAAG,EAAE,aAAa,EAAE,CAAC;IAAC,MAAM,EAAE,aAAa,EAAE,CAAA;CAAE,CA0BnD;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,SAAS;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,eAAe,CAAC,EAAE,OAAO,CAAA;CAAE,EAAE,CAAC,EAC1F,OAAO,EAAE,SAAS,CAAC,EAAE,EACrB,QAAQ,EAAE,SAAS,eAAe,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,GAAG,SAAS,EAC1D,OAAO,EAAE,CAAC,GACR,KAAK,CAAC,CAAC,GAAG,aAAa,CAAC,CAQ1B;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,SAAS;IAAE,eAAe,CAAC,EAAE,OAAO,CAAA;CAAE,EAC3E,OAAO,EAAE,SAAS,CAAC,EAAE,EACrB,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,GAC3B,CAAC,EAAE,CAaL"}

package/dist/embedding/regions.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Host regions: places in an editor's layout that a host fills with its own UI (a File tab
+ * page, a dialog body, a docked pane). The editor keeps the place and hands it to the host as
+ * an empty container; the host fills it in any framework, or none, through ONE of two forms:
+ *
+ *  - a mount function `(container, context) => cleanup | handle`, or
+ *  - a custom element: its tag name, or `{ element, properties }`. The editor creates it,
+ *    assigns `properties` once, and keeps its `context` property current.
+ *
+ * The contract is DOM-free: the container type is a parameter, which every product binds to
+ * `HTMLElement` in `ooxml-ui`, where the shared region host mounts it.
+ */
+/** A custom element a region creates (the host registers it). */
+export interface HostRegionElement {
+    /** The tag name, for example `acme-policies`. */
+    element: string;
+    /** Properties assigned to the element once, before it is attached. */
+    properties?: Readonly<Record<string, unknown>>;
+}
+/** What a mount function may return to receive context updates and teardown. */
+export interface HostRegionMountResult<Context> {
+    /** Called with the new context whenever it changes. */
+    update?(context: Context): void;
+    /** Called once when the region unmounts. */
+    destroy?(): void;
+}
+/** Fills `container` for one region. Returns nothing, a cleanup function or a handle. */
+export type HostRegionMount<Container, Context> = (container: Container, context: Context) => void | (() => void) | HostRegionMountResult<Context>;
+/** Any renderer form a region accepts. A string is a custom element tag name. */
+export type HostRegionRenderer<Container, Context> = HostRegionMount<Container, Context> | HostRegionElement | string;
+/** The context every product's host region receives, at least. */
+export interface HostRegionContextBase {
+    /** Which region this renderer fills (for a host File tab page, `backstage.host.<id>`). */
+    readonly region: string;
+    /** The active UI locale (BCP 47). */
+    readonly locale: string;
+    /** False when the document is read-only (prop, capability or protection). */
+    readonly canEdit: boolean;
+    /** Dismisses the region: leaves the File tab, closes a dialog. A no-op where nothing closes. */
+    readonly close: () => void;
+}
+/** Region id a host File tab page is mounted under. */
+export type HostBackstageRegionId = `backstage.host.${string}`;
+/** The region id of host File tab page `id`. */
+export declare function hostBackstageRegionId(id: string): HostBackstageRegionId;
+/**
+ * True when two renderers are the same: the same function, the same tag, or element specs with
+ * the same tag and the same property values (so an inline `{ element, properties }` passed
+ * again on every render does not remount).
+ */
+export declare function sameRenderer<Container, Context>(a: HostRegionRenderer<Container, Context> | undefined, b: HostRegionRenderer<Container, Context> | undefined): boolean;
+/**
+ * Shallow equality over two region contexts. Arrays (a selection) compare by value, and the
+ * fields named in `callbackKeys` are skipped: callbacks are recreated on every render and their
+ * identity is not a change.
+ */
+export declare function sameRegionContext(a: object, b: object, callbackKeys?: ReadonlySet<string>): boolean;
+//# sourceMappingURL=regions.d.ts.map

package/dist/embedding/regions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"regions.d.ts","sourceRoot":"","sources":["../../embedding/regions.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,iEAAiE;AACjE,MAAM,WAAW,iBAAiB;IACjC,iDAAiD;IACjD,OAAO,EAAE,MAAM,CAAC;IAChB,sEAAsE;IACtE,UAAU,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CAC/C;AAED,gFAAgF;AAChF,MAAM,WAAW,qBAAqB,CAAC,OAAO;IAC7C,uDAAuD;IACvD,MAAM,CAAC,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IAChC,4CAA4C;IAC5C,OAAO,CAAC,IAAI,IAAI,CAAC;CACjB;AAED,yFAAyF;AACzF,MAAM,MAAM,eAAe,CAAC,SAAS,EAAE,OAAO,IAAI,CACjD,SAAS,EAAE,SAAS,EACpB,OAAO,EAAE,OAAO,KACZ,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,GAAG,qBAAqB,CAAC,OAAO,CAAC,CAAC;AAE1D,iFAAiF;AACjF,MAAM,MAAM,kBAAkB,CAAC,SAAS,EAAE,OAAO,IAC9C,eAAe,CAAC,SAAS,EAAE,OAAO,CAAC,GACnC,iBAAiB,GACjB,MAAM,CAAC;AAEV,kEAAkE;AAClE,MAAM,WAAW,qBAAqB;IACrC,0FAA0F;IAC1F,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,qCAAqC;IACrC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,6EAA6E;IAC7E,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,gGAAgG;IAChG,QAAQ,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC;CAC3B;AAED,uDAAuD;AACvD,MAAM,MAAM,qBAAqB,GAAG,kBAAkB,MAAM,EAAE,CAAC;AAE/D,gDAAgD;AAChD,wBAAgB,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,qBAAqB,CAEvE;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,OAAO,EAC9C,CAAC,EAAE,kBAAkB,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,SAAS,EACrD,CAAC,EAAE,kBAAkB,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,SAAS,GACnD,OAAO,CAWT;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAChC,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,EACT,YAAY,GAAE,WAAW,CAAC,MAAM,CAAsB,GACpD,OAAO,CAYT"}