ooxml-core 0.13.0 → 0.14.0

package/dist/collab/broadcast-transport.d.ts

@@ -0,0 +1,21 @@
+import type { Transport } from './provider.js';
+/** Structural BroadcastChannel, so the area needs no DOM types. */
+export interface BroadcastChannelLike {
+    postMessage: (message: unknown) => void;
+    close: () => void;
+    onmessage: ((event: {
+        data: unknown;
+    }) => void) | null;
+}
+export type BroadcastChannelConstructor = new (name: string) => BroadcastChannelLike;
+export interface BroadcastTransportOptions {
+    roomId: string;
+    /** Channel name prefix; one channel per room. Default `ooxml-collab:`. */
+    prefix?: string;
+    /** Defaults to `globalThis.BroadcastChannel`. */
+    BroadcastChannel?: BroadcastChannelConstructor;
+}
+/** Whether this environment can create a BroadcastChannel transport. */
+export declare function canBroadcast(scope?: object): boolean;
+export declare function createBroadcastTransport(options: BroadcastTransportOptions): Transport;
+//# sourceMappingURL=broadcast-transport.d.ts.map

package/dist/collab/broadcast-transport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"broadcast-transport.d.ts","sourceRoot":"","sources":["../../src/collab/broadcast-transport.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,SAAS,EAAqB,MAAM,eAAe,CAAC;AAGlE,mEAAmE;AACnE,MAAM,WAAW,oBAAoB;IACpC,WAAW,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;IACxC,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,SAAS,EAAE,CAAC,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,OAAO,CAAA;KAAE,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC;CACvD;AACD,MAAM,MAAM,2BAA2B,GAAG,KAAK,IAAI,EAAE,MAAM,KAAK,oBAAoB,CAAC;AAErF,MAAM,WAAW,yBAAyB;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,0EAA0E;IAC1E,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iDAAiD;IACjD,gBAAgB,CAAC,EAAE,2BAA2B,CAAC;CAC/C;AAaD,wEAAwE;AACxE,wBAAgB,YAAY,CAAC,KAAK,GAAE,MAAmB,GAAG,OAAO,CAEhE;AAED,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,yBAAyB,GAAG,SAAS,CAmDtF"}

package/dist/collab/index.cjs

@@ -485,6 +485,62 @@ function bindDocument(session, adapter, options) {
     }
   };
 }
+
+// src/collab/broadcast-transport.ts
+var isEnvelope = (value) => {
+  const envelope = value;
+  return !!envelope && typeof envelope.from === "string" && (envelope.kind === "hello" || envelope.kind === "data" && envelope.data instanceof Uint8Array);
+};
+function canBroadcast(scope = globalThis) {
+  return typeof scope.BroadcastChannel === "function";
+}
+function createBroadcastTransport(options) {
+  const roomId = validateRoomId(options.roomId);
+  const Channel = options.BroadcastChannel ?? globalThis.BroadcastChannel;
+  const self = Math.random().toString(36).slice(2) + Date.now().toString(36);
+  let channel = null;
+  let handlers = null;
+  const close = () => {
+    if (!channel) return;
+    channel.onmessage = null;
+    channel.close();
+    channel = null;
+  };
+  return {
+    connect(next) {
+      close();
+      handlers = next;
+      if (!Channel) {
+        next.error(new Error("BroadcastChannel is not available in this environment."));
+        next.close("unavailable");
+        return;
+      }
+      const open = new Channel(`${options.prefix ?? "ooxml-collab:"}${roomId}`);
+      channel = open;
+      open.onmessage = ({ data }) => {
+        if (channel !== open || !isEnvelope(data) || data.from === self) return;
+        if (data.kind === "hello") handlers?.peer?.();
+        else handlers?.message(data.data);
+      };
+      next.open();
+      open.postMessage({ kind: "hello", from: self });
+    },
+    send(data) {
+      try {
+        channel?.postMessage({ kind: "data", from: self, data });
+      } catch (cause) {
+        handlers?.error(cause instanceof Error ? cause : new Error(String(cause)));
+      }
+    },
+    disconnect() {
+      const was = handlers;
+      const open = channel !== null;
+      close();
+      handlers = null;
+      if (open) was?.close("disconnected");
+    }
+  };
+}
 var MAX_UPDATE_BYTES = 32 * 1024 * 1024;
 function encodeSnapshot(doc) {
   return Y__namespace.encodeStateAsUpdate(doc);
@@ -801,6 +857,49 @@ function createMemoryHub(options = {}) {
   };
 }
 
+// src/collab/package-adapter.ts
+var DEFAULT_MAX_PACKAGE_BYTES = 32 * 1024 * 1024;
+function packageAdapter(options = {}) {
+  const name = options.name ?? "package";
+  const maxBytes = options.maxBytes ?? DEFAULT_MAX_PACKAGE_BYTES;
+  const map = (doc) => doc.getMap(name);
+  const check = (bytes) => {
+    if (!(bytes instanceof Uint8Array)) throw new Error("The shared package is not binary data.");
+    if (bytes.byteLength > maxBytes)
+      throw new Error(`The shared package exceeds ${Math.round(maxBytes / 1024 / 1024)} MiB.`);
+    return bytes;
+  };
+  return {
+    isEmpty: (doc) => !(map(doc).get("bytes") instanceof Uint8Array),
+    read: (doc) => {
+      const shared = map(doc);
+      const revision = shared.get("revision");
+      return {
+        bytes: check(shared.get("bytes")).slice(),
+        revision: typeof revision === "number" && Number.isSafeInteger(revision) ? revision : 0
+      };
+    },
+    write: (doc, model, origin) => {
+      const bytes = check(model.bytes);
+      doc.transact(() => {
+        const shared = map(doc);
+        const current = shared.get("revision");
+        const revision = Math.max(model.revision, typeof current === "number" ? current : 0) + 1;
+        shared.set("bytes", bytes.slice());
+        shared.set("revision", revision);
+      }, origin);
+    },
+    observe: (doc, onChange) => {
+      const shared = map(doc);
+      const handler = (event) => {
+        if (event.keysChanged.has("bytes")) onChange(event.transaction.origin);
+      };
+      shared.observe(handler);
+      return () => shared.unobserve(handler);
+    }
+  };
+}
+
 // src/collab/ordering.ts
 function classifyVersion(messageVersion, currentVersion) {
   if (!isNonNegativeSafeInteger(messageVersion) || !isNonNegativeSafeInteger(currentVersion))
@@ -1253,6 +1352,7 @@ exports.COLLAB_LEAVE_MESSAGE = COLLAB_LEAVE_MESSAGE;
 exports.CONNECTION_TIMEOUT_MS = CONNECTION_TIMEOUT_MS;
 exports.CURSOR_PALETTE = CURSOR_PALETTE;
 exports.DEFAULT_COLOR = DEFAULT_COLOR;
+exports.DEFAULT_MAX_PACKAGE_BYTES = DEFAULT_MAX_PACKAGE_BYTES;
 exports.DEPARTURE_CHANNEL = DEPARTURE_CHANNEL;
 exports.Emitter = Emitter;
 exports.INITIAL_SYNC_GRACE_MS = INITIAL_SYNC_GRACE_MS;
@@ -1276,11 +1376,13 @@ exports.assignUserColor = assignUserColor;
 exports.bindDocument = bindDocument;
 exports.borrowAwareness = borrowAwareness;
 exports.buildRoster = buildRoster;
+exports.canBroadcast = canBroadcast;
 exports.canWrite = canWrite;
 exports.clampCoordinate = clampCoordinate;
 exports.classifyVersion = classifyVersion;
 exports.clearLocalAwareness = clearLocalAwareness;
 exports.createAssetSync = createAssetSync;
+exports.createBroadcastTransport = createBroadcastTransport;
 exports.createClientId = createClientId;
 exports.createCollabSession = createCollabSession;
 exports.createDepartureChannel = createDepartureChannel;
@@ -1306,6 +1408,7 @@ exports.isValidId = isValidId;
 exports.isValidRoomId = isValidRoomId;
 exports.mergeUpdates = mergeUpdates2;
 exports.observeExternalSession = observeExternalSession;
+exports.packageAdapter = packageAdapter;
 exports.presenceToCursors = presenceToCursors;
 exports.registerTeardown = registerTeardown;
 exports.removeAwarenessStatesLocally = removeAwarenessStatesLocally;

package/dist/collab/index.d.ts

@@ -1,12 +1,14 @@
 export * from './assets.js';
 export * from './awareness.js';
 export * from './binding.js';
+export * from './broadcast-transport.js';
 export * from './codec.js';
 export * from './emitter.js';
 export * from './external-provider.js';
 export * from './identity.js';
 export * from './lifecycle.js';
 export * from './memory-transport.js';
+export * from './package-adapter.js';
 export * from './ordering.js';
 export * from './policy.js';
 export * from './presence.js';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/collab/index.ts"],"names":[],"mappings":"AAIA,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,wBAAwB,CAAC;AACvC,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC;AACtC,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,0BAA0B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/collab/index.ts"],"names":[],"mappings":"AAIA,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,0BAA0B,CAAC;AACzC,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,wBAAwB,CAAC;AACvC,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,0BAA0B,CAAC"}

package/dist/collab/index.mjs

@@ -461,6 +461,62 @@ function bindDocument(session, adapter, options) {
     }
   };
 }
+
+// src/collab/broadcast-transport.ts
+var isEnvelope = (value) => {
+  const envelope = value;
+  return !!envelope && typeof envelope.from === "string" && (envelope.kind === "hello" || envelope.kind === "data" && envelope.data instanceof Uint8Array);
+};
+function canBroadcast(scope = globalThis) {
+  return typeof scope.BroadcastChannel === "function";
+}
+function createBroadcastTransport(options) {
+  const roomId = validateRoomId(options.roomId);
+  const Channel = options.BroadcastChannel ?? globalThis.BroadcastChannel;
+  const self = Math.random().toString(36).slice(2) + Date.now().toString(36);
+  let channel = null;
+  let handlers = null;
+  const close = () => {
+    if (!channel) return;
+    channel.onmessage = null;
+    channel.close();
+    channel = null;
+  };
+  return {
+    connect(next) {
+      close();
+      handlers = next;
+      if (!Channel) {
+        next.error(new Error("BroadcastChannel is not available in this environment."));
+        next.close("unavailable");
+        return;
+      }
+      const open = new Channel(`${options.prefix ?? "ooxml-collab:"}${roomId}`);
+      channel = open;
+      open.onmessage = ({ data }) => {
+        if (channel !== open || !isEnvelope(data) || data.from === self) return;
+        if (data.kind === "hello") handlers?.peer?.();
+        else handlers?.message(data.data);
+      };
+      next.open();
+      open.postMessage({ kind: "hello", from: self });
+    },
+    send(data) {
+      try {
+        channel?.postMessage({ kind: "data", from: self, data });
+      } catch (cause) {
+        handlers?.error(cause instanceof Error ? cause : new Error(String(cause)));
+      }
+    },
+    disconnect() {
+      const was = handlers;
+      const open = channel !== null;
+      close();
+      handlers = null;
+      if (open) was?.close("disconnected");
+    }
+  };
+}
 var MAX_UPDATE_BYTES = 32 * 1024 * 1024;
 function encodeSnapshot(doc) {
   return Y.encodeStateAsUpdate(doc);
@@ -777,6 +833,49 @@ function createMemoryHub(options = {}) {
   };
 }
 
+// src/collab/package-adapter.ts
+var DEFAULT_MAX_PACKAGE_BYTES = 32 * 1024 * 1024;
+function packageAdapter(options = {}) {
+  const name = options.name ?? "package";
+  const maxBytes = options.maxBytes ?? DEFAULT_MAX_PACKAGE_BYTES;
+  const map = (doc) => doc.getMap(name);
+  const check = (bytes) => {
+    if (!(bytes instanceof Uint8Array)) throw new Error("The shared package is not binary data.");
+    if (bytes.byteLength > maxBytes)
+      throw new Error(`The shared package exceeds ${Math.round(maxBytes / 1024 / 1024)} MiB.`);
+    return bytes;
+  };
+  return {
+    isEmpty: (doc) => !(map(doc).get("bytes") instanceof Uint8Array),
+    read: (doc) => {
+      const shared = map(doc);
+      const revision = shared.get("revision");
+      return {
+        bytes: check(shared.get("bytes")).slice(),
+        revision: typeof revision === "number" && Number.isSafeInteger(revision) ? revision : 0
+      };
+    },
+    write: (doc, model, origin) => {
+      const bytes = check(model.bytes);
+      doc.transact(() => {
+        const shared = map(doc);
+        const current = shared.get("revision");
+        const revision = Math.max(model.revision, typeof current === "number" ? current : 0) + 1;
+        shared.set("bytes", bytes.slice());
+        shared.set("revision", revision);
+      }, origin);
+    },
+    observe: (doc, onChange) => {
+      const shared = map(doc);
+      const handler = (event) => {
+        if (event.keysChanged.has("bytes")) onChange(event.transaction.origin);
+      };
+      shared.observe(handler);
+      return () => shared.unobserve(handler);
+    }
+  };
+}
+
 // src/collab/ordering.ts
 function classifyVersion(messageVersion, currentVersion) {
   if (!isNonNegativeSafeInteger(messageVersion) || !isNonNegativeSafeInteger(currentVersion))
@@ -1222,4 +1321,4 @@ function createWebSocketTransport(options) {
   };
 }
 
-export { BROADCAST_THROTTLE_MS, BoundedMap, COLLABORATION_ROLES, COLLAB_LEAVE_MESSAGE, CONNECTION_TIMEOUT_MS, CURSOR_PALETTE, DEFAULT_COLOR, DEPARTURE_CHANNEL, Emitter, INITIAL_SYNC_GRACE_MS, IdempotencyCache, LEGACY_PPTX_DEPARTURE_CHANNEL, LEGACY_PPTX_LEAVE_MESSAGE, LOCAL_ORIGIN, MAX_LABEL_CHARS, MAX_UPDATE_BYTES, MESSAGE_AWARENESS, MESSAGE_QUERY_AWARENESS, MESSAGE_SYNC, PRESENCE_FIELD, PRESENCE_HEARTBEAT_MS, STALE_PRESENCE_MS, SequenceTracker, adaptYjsProvider, applyUpdateSafe, asSelectionIds, assignUserColor, bindDocument, borrowAwareness, buildRoster, canWrite, clampCoordinate, classifyVersion, clearLocalAwareness, createAssetSync, createClientId, createCollabSession, createDepartureChannel, createIdGenerator, createMemoryHub, createPresencePublisher, createSyncGate, createTransportProvider, createWebSocketTransport, deriveCanvasPresence, derivePresence, encodeDiff, encodeSnapshot, encodeStateVector2 as encodeStateVector, formatCursorLabel, freezeDeep, fromBase64, getUserInitials, isMixedContentBlocked, isNonNegativeSafeInteger, isPresenceFresh, isValidId, isValidRoomId, mergeUpdates2 as mergeUpdates, observeExternalSession, presenceToCursors, registerTeardown, removeAwarenessStatesLocally, restoreSnapshot, roomUrl, sanitizeAvatarUrl, sanitizeCanvasPayload, sanitizeColor, sanitizeIdentity, sanitizeIndex, sanitizeRole, sanitizeUserName, shouldAutoFollowBroadcaster, shouldRoomReplaceLoad, stripHtmlTags, toBase64, transportProvider, validateDisplayName, validateRoomId, validateUpdate };
+export { BROADCAST_THROTTLE_MS, BoundedMap, COLLABORATION_ROLES, COLLAB_LEAVE_MESSAGE, CONNECTION_TIMEOUT_MS, CURSOR_PALETTE, DEFAULT_COLOR, DEFAULT_MAX_PACKAGE_BYTES, DEPARTURE_CHANNEL, Emitter, INITIAL_SYNC_GRACE_MS, IdempotencyCache, LEGACY_PPTX_DEPARTURE_CHANNEL, LEGACY_PPTX_LEAVE_MESSAGE, LOCAL_ORIGIN, MAX_LABEL_CHARS, MAX_UPDATE_BYTES, MESSAGE_AWARENESS, MESSAGE_QUERY_AWARENESS, MESSAGE_SYNC, PRESENCE_FIELD, PRESENCE_HEARTBEAT_MS, STALE_PRESENCE_MS, SequenceTracker, adaptYjsProvider, applyUpdateSafe, asSelectionIds, assignUserColor, bindDocument, borrowAwareness, buildRoster, canBroadcast, canWrite, clampCoordinate, classifyVersion, clearLocalAwareness, createAssetSync, createBroadcastTransport, createClientId, createCollabSession, createDepartureChannel, createIdGenerator, createMemoryHub, createPresencePublisher, createSyncGate, createTransportProvider, createWebSocketTransport, deriveCanvasPresence, derivePresence, encodeDiff, encodeSnapshot, encodeStateVector2 as encodeStateVector, formatCursorLabel, freezeDeep, fromBase64, getUserInitials, isMixedContentBlocked, isNonNegativeSafeInteger, isPresenceFresh, isValidId, isValidRoomId, mergeUpdates2 as mergeUpdates, observeExternalSession, packageAdapter, presenceToCursors, registerTeardown, removeAwarenessStatesLocally, restoreSnapshot, roomUrl, sanitizeAvatarUrl, sanitizeCanvasPayload, sanitizeColor, sanitizeIdentity, sanitizeIndex, sanitizeRole, sanitizeUserName, shouldAutoFollowBroadcaster, shouldRoomReplaceLoad, stripHtmlTags, toBase64, transportProvider, validateDisplayName, validateRoomId, validateUpdate };

package/dist/collab/package-adapter.d.ts

@@ -0,0 +1,15 @@
+import type { DocumentAdapter } from './binding.js';
+export interface PackageAdapterOptions {
+    /** Y.Map name. Default `package`. */
+    name?: string;
+    /** Refuse to publish or adopt packages larger than this. Default 32 MiB. */
+    maxBytes?: number;
+}
+export declare const DEFAULT_MAX_PACKAGE_BYTES: number;
+/** One shared package: its bytes and a revision counter peers can display or compare. */
+export interface SharedPackage {
+    bytes: Uint8Array;
+    revision: number;
+}
+export declare function packageAdapter(options?: PackageAdapterOptions): DocumentAdapter<SharedPackage>;
+//# sourceMappingURL=package-adapter.d.ts.map

package/dist/collab/package-adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-adapter.d.ts","sourceRoot":"","sources":["../../src/collab/package-adapter.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAEpD,MAAM,WAAW,qBAAqB;IACrC,qCAAqC;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4EAA4E;IAC5E,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,eAAO,MAAM,yBAAyB,QAAmB,CAAC;AAE1D,yFAAyF;AACzF,MAAM,WAAW,aAAa;IAC7B,KAAK,EAAE,UAAU,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CACjB;AAED,wBAAgB,cAAc,CAC7B,OAAO,GAAE,qBAA0B,GACjC,eAAe,CAAC,aAAa,CAAC,CAwChC"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "ooxml-core",
-	"version": "0.13.0",
+	"version": "0.14.0",
 	"description": "Shared OOXML logic for the Word, PowerPoint and Excel viewers: everything except the UI",
 	"keywords": [
 		"charts",