@arbidocs/coedit 0.5.29 → 0.5.31

package/dist/server.d.cts

@@ -6,16 +6,29 @@ import { TreePackageStore, PackageTransactResult, HeadlessDocumentView, ImageDec
 import { R as ReferencesPort } from './port-BbN5OZHx.cjs';
 import { R as Revision } from './track-eYC94jTp.cjs';
 import { D as DocxCollaborationSession } from './session-WGvWs6yO.cjs';
-export { C as COLLAB_PROTOCOL, D as DOCUMENT_COLLABORATION_VERSIONS } from './versions-XSYTVmOU.cjs';
+export { C as COLLAB_PROTOCOL, D as DOCUMENT_COLLABORATION_VERSIONS, F as FORMAT_REFUSAL } from './versions-ClPpc7Sg.cjs';
 import 'y-protocols/awareness';
 import '@docx-editor.dev/core/collaboration/replication';
 
 declare class CollaborationCompatibilityError extends Error {
-    constructor(message: string);
+    /** What Hocuspocus sends the refused client (`onAuthenticationFailed`'s reason). */
+    readonly reason: string;
+    constructor(message: string, reason?: string);
 }
+/**
+ * Throws unless the client runs this build's room format and protocol. The refusal's `reason` names
+ * this server's format (`formatRefusal` on the client), so the editor can reload into the matching
+ * build, or wait for this server's update, instead of failing.
+ */
 declare function assertCompatibleVersions(versions: unknown): void;
-/** Throws unless the room was written in the format this build reads. */
+/** Throws unless the room is in this build's format. */
 declare function assertRoomFormat(doc: Y.Doc): void;
+/**
+ * A stored room state of an earlier room format, re-encoded in this one: its package is read out
+ * (elements are read the same way whatever form an earlier format gave them) and seeded again, so
+ * nothing the room held is lost. Throws `MaterializeError` when the state cannot be read.
+ */
+declare function reencodeRoom(doc: Y.Doc, state: Uint8Array): void;
 /**
  * DOCX bytes as the editor would save them. Saving stamps a `w14:paraId` on every paragraph that
  * lacks one; seeding from the stamped bytes puts those ids in the room, so every participant
@@ -79,4 +92,4 @@ declare function roomCommandsPort(room: RoomStore, { revision, actorId }?: {
     actorId?: string;
 }): ReferencesPort;
 
-export { CollaborationCompatibilityError, type RoomAutomation, type RoomStore, assertCompatibleVersions, assertRoomFormat, normalizeDocx, openRoomAutomation, openRoomStore, readRoom, roomCommandsPort, seedRoom };
+export { CollaborationCompatibilityError, type RoomAutomation, type RoomStore, assertCompatibleVersions, assertRoomFormat, normalizeDocx, openRoomAutomation, openRoomStore, readRoom, reencodeRoom, roomCommandsPort, seedRoom };

package/dist/server.d.ts

@@ -6,16 +6,29 @@ import { TreePackageStore, PackageTransactResult, HeadlessDocumentView, ImageDec
 import { R as ReferencesPort } from './port-BbN5OZHx.js';
 import { R as Revision } from './track-eYC94jTp.js';
 import { D as DocxCollaborationSession } from './session-WGvWs6yO.js';
-export { C as COLLAB_PROTOCOL, D as DOCUMENT_COLLABORATION_VERSIONS } from './versions-XSYTVmOU.js';
+export { C as COLLAB_PROTOCOL, D as DOCUMENT_COLLABORATION_VERSIONS, F as FORMAT_REFUSAL } from './versions-ClPpc7Sg.js';
 import 'y-protocols/awareness';
 import '@docx-editor.dev/core/collaboration/replication';
 
 declare class CollaborationCompatibilityError extends Error {
-    constructor(message: string);
+    /** What Hocuspocus sends the refused client (`onAuthenticationFailed`'s reason). */
+    readonly reason: string;
+    constructor(message: string, reason?: string);
 }
+/**
+ * Throws unless the client runs this build's room format and protocol. The refusal's `reason` names
+ * this server's format (`formatRefusal` on the client), so the editor can reload into the matching
+ * build, or wait for this server's update, instead of failing.
+ */
 declare function assertCompatibleVersions(versions: unknown): void;
-/** Throws unless the room was written in the format this build reads. */
+/** Throws unless the room is in this build's format. */
 declare function assertRoomFormat(doc: Y.Doc): void;
+/**
+ * A stored room state of an earlier room format, re-encoded in this one: its package is read out
+ * (elements are read the same way whatever form an earlier format gave them) and seeded again, so
+ * nothing the room held is lost. Throws `MaterializeError` when the state cannot be read.
+ */
+declare function reencodeRoom(doc: Y.Doc, state: Uint8Array): void;
 /**
  * DOCX bytes as the editor would save them. Saving stamps a `w14:paraId` on every paragraph that
  * lacks one; seeding from the stamped bytes puts those ids in the room, so every participant
@@ -79,4 +92,4 @@ declare function roomCommandsPort(room: RoomStore, { revision, actorId }?: {
     actorId?: string;
 }): ReferencesPort;
 
-export { CollaborationCompatibilityError, type RoomAutomation, type RoomStore, assertCompatibleVersions, assertRoomFormat, normalizeDocx, openRoomAutomation, openRoomStore, readRoom, roomCommandsPort, seedRoom };
+export { CollaborationCompatibilityError, type RoomAutomation, type RoomStore, assertCompatibleVersions, assertRoomFormat, normalizeDocx, openRoomAutomation, openRoomStore, readRoom, reencodeRoom, roomCommandsPort, seedRoom };

package/dist/server.js

@@ -1,10 +1,10 @@
+import * as Y from 'yjs';
 import { Awareness } from 'y-protocols/awareness';
 import { createServerAutomationHost } from '@docx-editor.dev/core/automation';
 import { createCollaborationDocumentPort, historyGroupOfJournal, mapOffsetAcrossText } from '@docx-editor.dev/core/collaboration/replication';
 import { TreePackageStore, validateRasterHeader, headlessViewOfStore, ORIGIN_IDS, readOoxmlPackage, writeOoxmlPackage, readOoxmlPart, validateExternalTarget, relsPartNameFor, contentTypesPartBytes, withContentTypeOverride, readXml, XML_NAMESPACE_URI } from '@docx-editor.dev/core/store';
 import { resolveNumberingLevel, resolveStoryListItems, buildStyleCascadeTable, withNumberingStyleLinks, buildNumberingIndex } from '@docx-editor.dev/core/layout';
 import { zipSync, strToU8, strFromU8, unzipSync } from 'fflate';
-import * as Y from 'yjs';
 import { createCollaborationStatusTracker, safeParticipantColor } from '@docx-editor.dev/core/collaboration';
 
 // src/server.ts
@@ -1077,10 +1077,6 @@ function serializeLive(el2, scope) {
 
 // src/encoding.ts
 var COLLAB_FORMAT = "arbi-docx/2";
-var READABLE_FORMATS = /* @__PURE__ */ new Set(["arbi-docx/1", COLLAB_FORMAT]);
-function isReadableFormat(format) {
-  return format !== void 0 && READABLE_FORMATS.has(format);
-}
 function isText(node) {
   return node.kind === "textValue";
 }
@@ -2202,7 +2198,7 @@ var DocxCollaborationSession = class {
       this.setStatus("error", "not-initialized");
       return;
     }
-    if (!isReadableFormat(readFormat(this.doc))) {
+    if (readFormat(this.doc) !== COLLAB_FORMAT) {
       this.setStatus("error", "collaboration-format-mismatch", readFormat(this.doc));
       return;
     }
@@ -2490,29 +2486,45 @@ var DOCUMENT_COLLABORATION_VERSIONS = {
   format: COLLAB_FORMAT,
   protocol: COLLAB_PROTOCOL
 };
+var FORMAT_REFUSAL = "collaboration-format:";
 
 // src/server.ts
 var CollaborationCompatibilityError = class extends Error {
-  constructor(message) {
+  /** What Hocuspocus sends the refused client (`onAuthenticationFailed`'s reason). */
+  reason;
+  constructor(message, reason = "permission-denied") {
     super(message);
     this.name = "CollaborationCompatibilityError";
+    this.reason = reason;
   }
 };
 function assertCompatibleVersions(versions) {
   const v = versions;
   if (!v || v.format !== COLLAB_FORMAT || v.protocol !== COLLAB_PROTOCOL) {
     throw new CollaborationCompatibilityError(
-      "This editor build is not compatible with the collaboration server. Reload the page."
+      "This editor build is not compatible with the collaboration server. Reload the page.",
+      FORMAT_REFUSAL + COLLAB_FORMAT
     );
   }
 }
 function assertRoomFormat(doc) {
   if (!isBootstrapped(doc)) throw new CollaborationCompatibilityError("The room holds no document.");
   const format = readFormat(doc);
-  if (!isReadableFormat(format)) {
+  if (format !== COLLAB_FORMAT) {
     throw new CollaborationCompatibilityError(`Unsupported room format ${String(format)}.`);
   }
 }
+function reencodeRoom(doc, state) {
+  if (isBootstrapped(doc)) throw new CollaborationCompatibilityError("The room is already seeded.");
+  const stored = new Y.Doc();
+  Y.applyUpdate(stored, state);
+  try {
+    if (!isBootstrapped(stored)) throw new MaterializeError("the stored state holds no document");
+    bootstrapFromBytes(doc, materializeBytes(stored));
+  } finally {
+    stored.destroy();
+  }
+}
 function normalizeDocx(bytes) {
   const opened = createServerAutomationHost(bytes);
   if (!opened.ok) throw new MaterializeError(`not a readable DOCX: ${opened.reason}`);
@@ -2711,6 +2723,6 @@ function roomCommandsPort(room, { revision, actorId } = {}) {
   };
 }
 
-export { COLLAB_PROTOCOL, CollaborationCompatibilityError, DOCUMENT_COLLABORATION_VERSIONS, assertCompatibleVersions, assertRoomFormat, normalizeDocx, openRoomAutomation, openRoomStore, readRoom, roomCommandsPort, seedRoom };
+export { COLLAB_PROTOCOL, CollaborationCompatibilityError, DOCUMENT_COLLABORATION_VERSIONS, FORMAT_REFUSAL, assertCompatibleVersions, assertRoomFormat, normalizeDocx, openRoomAutomation, openRoomStore, readRoom, reencodeRoom, roomCommandsPort, seedRoom };
 //# sourceMappingURL=server.js.map
 //# sourceMappingURL=server.js.map