document-drive 1.3.3 → 1.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "document-drive",
-  "version": "1.3.3",
+  "version": "1.4.0",
   "license": "AGPL-3.0-only",
   "type": "module",
   "module": "./src/index.ts",
@@ -26,34 +26,32 @@
     "./src"
   ],
   "peerDependencies": {
+    "@powerhousedao/scalars": "latest",
+    "change-case": "^5.4.4",
     "document-model": "^2.3.1",
     "document-model-libs": "^1.104.0",
-    "@powerhousedao/scalars": "latest"
+    "graphql": "^16.9.0",
+    "graphql-request": "^6.1.0",
+    "json-stringify-deterministic": "^1.0.12",
+    "nanoevents": "^9.0.0",
+    "sanitize-filename": "^1.6.3",
+    "uuid": "^9.0.1"
   },
   "optionalDependencies": {
     "@prisma/client": "^5.18.0",
+    "exponential-backoff": "^3.1.1",
     "localforage": "^1.10.0",
     "redis": "^4.6.15",
     "sequelize": "^6.37.3",
     "sqlite3": "^5.1.7"
   },
-  "dependencies": {
-    "change-case": "^5.4.4",
-    "exponential-backoff": "^3.1.1",
-    "graphql": "^16.9.0",
-    "graphql-request": "^6.1.0",
-    "json-stringify-deterministic": "^1.0.12",
-    "nanoevents": "^9.0.0",
-    "sanitize-filename": "^1.6.3",
-    "uuid": "^9.0.1"
-  },
   "devDependencies": {
     "@powerhousedao/scalars": "latest",
     "@prisma/client": "5.17.0",
     "@types/node": "^20.14.11",
     "@types/uuid": "^9.0.8",
     "document-model": "^2.6.0",
-    "document-model-libs": "^1.109.1",
+    "document-model-libs": "^1.110.1",
     "fake-indexeddb": "^5.0.2",
     "localforage": "^1.10.0",
     "msw": "^2.3.1",
@@ -61,7 +59,15 @@
     "sequelize": "^6.37.2",
     "sqlite3": "^5.1.7",
     "webdriverio": "^9.0.9",
-    "vitest-fetch-mock": "^0.3.0"
+    "vitest-fetch-mock": "^0.3.0",
+    "change-case": "^5.4.4",
+    "exponential-backoff": "^3.1.1",
+    "graphql": "^16.9.0",
+    "graphql-request": "^6.1.0",
+    "json-stringify-deterministic": "^1.0.12",
+    "nanoevents": "^9.0.0",
+    "sanitize-filename": "^1.6.3",
+    "uuid": "^9.0.1"
   },
   "scripts": {
     "check-types": "tsc --noEmit",

package/src/server/index.ts

@@ -136,7 +136,7 @@ export class BaseDocumentDriveServer
     storage: IDriveStorage = new MemoryStorage(),
     cache: ICache = new InMemoryCache(),
     queueManager: IQueueManager = new BaseQueueManager(),
-    options?: DocumentDriveServerOptions
+    options?: DocumentDriveServerOptions,
   ) {
     super();
     this.options = {
@@ -157,7 +157,7 @@ export class BaseDocumentDriveServer
     this.listenerStateManager = new ListenerManager(
       this,
       undefined,
-      options?.listenerManager
+      options?.listenerManager,
     );
     this.documentModels = documentModels;
     this.storage = storage;
@@ -166,7 +166,7 @@ export class BaseDocumentDriveServer
     this.defaultDrivesManager = new DefaultDrivesManager(
       this,
       this.defaultDrivesManagerDelegate,
-      options
+      options,
     );
 
     this.storage.setStorageDelegate?.({
@@ -210,7 +210,7 @@ export class BaseDocumentDriveServer
   }
 
   private getCombinedSyncUnitStatus(
-    syncUnitStatus: SyncUnitStatusObject
+    syncUnitStatus: SyncUnitStatusObject,
   ): SyncStatus {
     if (!syncUnitStatus.pull && !syncUnitStatus.push) return "INITIAL_SYNC";
     if (syncUnitStatus.pull === "INITIAL_SYNC") return "INITIAL_SYNC";
@@ -225,7 +225,7 @@ export class BaseDocumentDriveServer
       "SUCCESS",
     ];
     const sortedStatus = Object.values(syncUnitStatus).sort(
-      (a, b) => order.indexOf(a) - order.indexOf(b)
+      (a, b) => order.indexOf(a) - order.indexOf(b),
     );
 
     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
@@ -234,10 +234,10 @@ export class BaseDocumentDriveServer
 
   private initSyncStatus(
     syncUnitId: string,
-    status: Partial<SyncUnitStatusObject>
+    status: Partial<SyncUnitStatusObject>,
   ) {
     const defaultSyncUnitStatus: SyncUnitStatusObject = Object.entries(
-      status
+      status,
     ).reduce((acc, [key, _status]) => {
       return {
         ...acc,
@@ -251,13 +251,13 @@ export class BaseDocumentDriveServer
       syncUnitId,
       this.getCombinedSyncUnitStatus(defaultSyncUnitStatus),
       undefined,
-      defaultSyncUnitStatus
+      defaultSyncUnitStatus,
     );
   }
 
   private async initializeDriveSyncStatus(
     driveId: string,
-    drive: DocumentDriveDocument
+    drive: DocumentDriveDocument,
   ) {
     const syncUnits = await this.getSynchronizationUnitsIds(driveId);
     const syncStatus: SyncUnitStatusObject = {
@@ -277,7 +277,7 @@ export class BaseDocumentDriveServer
   private updateSyncUnitStatus(
     syncUnitId: string,
     status: Partial<SyncUnitStatusObject> | null,
-    error?: Error
+    error?: Error,
   ) {
     if (status === null) {
       this.syncStatus.delete(syncUnitId);
@@ -293,7 +293,7 @@ export class BaseDocumentDriveServer
 
     const shouldUpdateStatus = Object.entries(status).some(
       ([key, _status]) =>
-        syncUnitStatus[key as keyof SyncUnitStatusObject] !== _status
+        syncUnitStatus[key as keyof SyncUnitStatusObject] !== _status,
     );
 
     if (shouldUpdateStatus) {
@@ -321,7 +321,7 @@ export class BaseDocumentDriveServer
           syncUnitId,
           this.getCombinedSyncUnitStatus(newstatus),
           error,
-          newstatus
+          newstatus,
         );
       }
     }
@@ -338,7 +338,7 @@ export class BaseDocumentDriveServer
       ? this.queueDriveOperations(
           strand.driveId,
           operations as Operation<DocumentDriveAction | BaseAction>[],
-          { source }
+          { source },
         )
       : this.queueOperations(strand.driveId, strand.documentId, operations, {
           source,
@@ -352,7 +352,7 @@ export class BaseDocumentDriveServer
                 strand.driveId,
                 [strand.documentId],
                 [strand.scope],
-                [strand.branch]
+                [strand.branch],
               )
             ).map((s) => s.syncId)
           : [strand.driveId];
@@ -363,7 +363,7 @@ export class BaseDocumentDriveServer
         this.updateSyncUnitStatus(
           syncUnit,
           { [operationSource]: result.status },
-          result.error
+          result.error,
         );
       }
     }
@@ -374,11 +374,11 @@ export class BaseDocumentDriveServer
   private handleListenerError(
     error: Error,
     driveId: string,
-    listener: ListenerState
+    listener: ListenerState,
   ) {
     logger.error(
       `Listener ${listener.listener.label ?? listener.listener.listenerId} error:`,
-      error
+      error,
     );
 
     const status = error instanceof OperationError ? error.status : "ERROR";
@@ -403,7 +403,7 @@ export class BaseDocumentDriveServer
       undefined,
       undefined,
       undefined,
-      drive
+      drive,
     );
 
     for (const trigger of drive.state.local.triggers) {
@@ -439,13 +439,13 @@ export class BaseDocumentDriveServer
                 driveId,
                 trigger,
                 error.response.status,
-                error.message
+                error.message,
               );
             }
           },
           (revisions) => {
             const errorRevision = revisions.filter(
-              (r) => r.status !== "SUCCESS"
+              (r) => r.status !== "SUCCESS",
             );
 
             if (errorRevision.length < 1) {
@@ -462,14 +462,14 @@ export class BaseDocumentDriveServer
               .then((revSyncUnits) => {
                 for (const syncUnit of revSyncUnits) {
                   const fileErrorRevision = errorRevision.find(
-                    (r) => r.documentId === syncUnit.documentId
+                    (r) => r.documentId === syncUnit.documentId,
                   );
 
                   if (fileErrorRevision) {
                     this.updateSyncUnitStatus(
                       syncUnit.syncId,
                       { pull: fileErrorRevision.status },
-                      fileErrorRevision.error
+                      fileErrorRevision.error,
                     );
                   } else {
                     this.updateSyncUnitStatus(syncUnit.syncId, {
@@ -485,7 +485,7 @@ export class BaseDocumentDriveServer
             if (firstPull) {
               firstPull = false;
               const pushListener = drive.state.local.listeners.find(
-                (listener) => trigger.data.url === listener.callInfo?.data
+                (listener) => trigger.data.url === listener.callInfo?.data,
               );
               if (pushListener) {
                 this.getSynchronizationUnitsRevision(driveId, syncUnits)
@@ -496,7 +496,7 @@ export class BaseDocumentDriveServer
                           pushListener.listenerId,
                           driveId,
                           revision.syncId,
-                          revision.revision
+                          revision.revision,
                         )
                         .catch(logger.error);
                     }
@@ -504,7 +504,7 @@ export class BaseDocumentDriveServer
                   .catch(logger.error);
               }
             }
-          }
+          },
         );
         driveTriggers.set(trigger.id, cancelPullLoop);
         this.triggerMap.set(driveId, driveTriggers);
@@ -537,7 +537,7 @@ export class BaseDocumentDriveServer
   private queueDelegate = {
     checkDocumentExists: (
       driveId: string,
-      documentId: string
+      documentId: string,
     ): Promise<boolean> =>
       this.storage.checkDocumentExists(driveId, documentId),
     processOperationJob: async ({
@@ -551,7 +551,7 @@ export class BaseDocumentDriveServer
         : this.addDriveOperations(
             driveId,
             operations as Operation<DocumentDriveAction | BaseAction>[],
-            options
+            options,
           );
     },
     processActionJob: async ({
@@ -565,7 +565,7 @@ export class BaseDocumentDriveServer
         : this.addDriveActions(
             driveId,
             actions as Operation<DocumentDriveAction | BaseAction>[],
-            options
+            options,
           );
     },
     processJob: async (job: Job) => {
@@ -616,7 +616,7 @@ export class BaseDocumentDriveServer
           .triggerUpdate(
             false,
             { type: "local" },
-            this.handleListenerError.bind(this)
+            this.handleListenerError.bind(this),
           )
           .catch((error) => {
             logger.error("Non handled error updating listeners", error);
@@ -644,7 +644,7 @@ export class BaseDocumentDriveServer
     scope?: string[],
     branch?: string[],
     documentType?: string[],
-    loadedDrive?: DocumentDriveDocument
+    loadedDrive?: DocumentDriveDocument,
   ) {
     const drive = loadedDrive || (await this.getDrive(driveId));
 
@@ -654,19 +654,19 @@ export class BaseDocumentDriveServer
       scope,
       branch,
       documentType,
-      drive
+      drive,
     );
     return this.getSynchronizationUnitsRevision(
       driveId,
       synchronizationUnitsQuery,
-      drive
+      drive,
     );
   }
 
   public async getSynchronizationUnitsRevision(
     driveId: string,
     syncUnitsQuery: SynchronizationUnitQuery[],
-    loadedDrive?: DocumentDriveDocument
+    loadedDrive?: DocumentDriveDocument,
   ): Promise<SynchronizationUnit[]> {
     const drive = loadedDrive || (await this.getDrive(driveId));
 
@@ -678,7 +678,7 @@ export class BaseDocumentDriveServer
         ...s,
         lastUpdated: drive.created,
         revision: -1,
-      })
+      }),
     );
     for (const revision of revisions) {
       const syncUnit = synchronizationUnits.find(
@@ -686,7 +686,7 @@ export class BaseDocumentDriveServer
           revision.driveId === s.driveId &&
           revision.documentId === s.documentId &&
           revision.scope === s.scope &&
-          revision.branch === s.branch
+          revision.branch === s.branch,
       );
       if (syncUnit) {
         syncUnit.revision = revision.revision;
@@ -702,7 +702,7 @@ export class BaseDocumentDriveServer
     scope?: string[],
     branch?: string[],
     documentType?: string[],
-    loadedDrive?: DocumentDriveDocument
+    loadedDrive?: DocumentDriveDocument,
   ): Promise<SynchronizationUnitQuery[]> {
     const drive = loadedDrive ?? (await this.getDrive(driveId));
     const nodes = drive.state.global.nodes.filter(
@@ -713,7 +713,7 @@ export class BaseDocumentDriveServer
           documentId.includes("*")) &&
         (!documentType?.length ||
           documentType.includes(node.documentType) ||
-          documentType.includes("*"))
+          documentType.includes("*")),
     ) as Pick<FileNode, "id" | "documentType" | "synchronizationUnits">[];
 
     // checks if document drive synchronization unit should be added
@@ -750,7 +750,7 @@ export class BaseDocumentDriveServer
                   scope.includes("*")) &&
                 (!branch?.length ||
                   branch.includes(unit.branch) ||
-                  branch.includes("*"))
+                  branch.includes("*")),
             )
           : node.synchronizationUnits;
       if (!nodeUnits.length) {
@@ -764,7 +764,7 @@ export class BaseDocumentDriveServer
           documentType: node.documentType,
           scope: n.scope,
           branch: n.branch,
-        }))
+        })),
       );
     }
     return synchronizationUnitsQuery;
@@ -773,13 +773,13 @@ export class BaseDocumentDriveServer
   public async getSynchronizationUnitIdInfo(
     driveId: string,
     syncId: string,
-    loadedDrive?: DocumentDriveDocument
+    loadedDrive?: DocumentDriveDocument,
   ): Promise<SynchronizationUnitQuery | undefined> {
     const drive = loadedDrive || (await this.getDrive(driveId));
     const node = drive.state.global.nodes.find(
       (node) =>
         isFileNode(node) &&
-        node.synchronizationUnits.find((unit) => unit.syncId === syncId)
+        node.synchronizationUnits.find((unit) => unit.syncId === syncId),
     );
 
     if (!node || !isFileNode(node)) {
@@ -787,7 +787,7 @@ export class BaseDocumentDriveServer
     }
 
     const syncUnit = node.synchronizationUnits.find(
-      (unit) => unit.syncId === syncId
+      (unit) => unit.syncId === syncId,
     );
     if (!syncUnit) {
       return undefined;
@@ -806,12 +806,12 @@ export class BaseDocumentDriveServer
   public async getSynchronizationUnit(
     driveId: string,
     syncId: string,
-    loadedDrive?: DocumentDriveDocument
+    loadedDrive?: DocumentDriveDocument,
   ): Promise<SynchronizationUnit | undefined> {
     const syncUnit = await this.getSynchronizationUnitIdInfo(
       driveId,
       syncId,
-      loadedDrive
+      loadedDrive,
     );
 
     if (!syncUnit) {
@@ -841,7 +841,7 @@ export class BaseDocumentDriveServer
     driveId: string,
     syncId: string,
     filter: GetStrandsOptions,
-    loadedDrive?: DocumentDriveDocument
+    loadedDrive?: DocumentDriveDocument,
   ): Promise<OperationUpdate[]> {
     const syncUnit =
       syncId === "0"
@@ -866,7 +866,7 @@ export class BaseDocumentDriveServer
         ((filter.since === undefined ||
           isBefore(filter.since, operation.timestamp)) &&
           (filter.fromRevision === undefined ||
-            operation.index > filter.fromRevision))
+            operation.index > filter.fromRevision)),
     );
 
     const limitedOperations = filter.limit
@@ -887,7 +887,7 @@ export class BaseDocumentDriveServer
 
   protected getDocumentModel(documentType: string) {
     const documentModel = this.documentModels.find(
-      (model) => model.documentModel.id === documentType
+      (model) => model.documentModel.id === documentType,
     );
     if (!documentModel) {
       throw new Error(`Document type ${documentType} not supported`);
@@ -929,7 +929,7 @@ export class BaseDocumentDriveServer
 
   async addRemoteDrive(
     url: string,
-    options: RemoteDriveOptions
+    options: RemoteDriveOptions,
   ): Promise<DocumentDriveDocument> {
     const { id, name, slug, icon } =
       options.expectedDriveInfo || (await requestPublicDrive(url));
@@ -968,13 +968,13 @@ export class BaseDocumentDriveServer
   public async registerPullResponderTrigger(
     id: string,
     url: string,
-    options: Pick<RemoteDriveOptions, "pullFilter" | "pullInterval">
+    options: Pick<RemoteDriveOptions, "pullFilter" | "pullInterval">,
   ) {
     const pullTrigger =
       await PullResponderTransmitter.createPullResponderTrigger(
         id,
         url,
-        options
+        options,
       );
 
     return pullTrigger;
@@ -1106,14 +1106,14 @@ export class BaseDocumentDriveServer
         await this.storage.addDriveOperations(
           driveId,
           operations as Operation<DocumentDriveAction>[],
-          document
+          document,
         );
       } else {
         await this.storage.addDocumentOperations(
           driveId,
           input.id,
           operations,
-          document
+          document,
         );
       }
     }
@@ -1141,7 +1141,7 @@ export class BaseDocumentDriveServer
     drive: string,
     documentId: string | undefined,
     documentStorage: DocumentStorage<T>,
-    operations: Operation<A | BaseAction>[]
+    operations: Operation<A | BaseAction>[],
   ) {
     const operationsApplied: Operation<A | BaseAction>[] = [];
     const signals: SignalResult[] = [];
@@ -1149,7 +1149,7 @@ export class BaseDocumentDriveServer
     const documentStorageWithState = await this._addDocumentResultingStage(
       documentStorage,
       drive,
-      documentId
+      documentId,
     );
 
     let document: T = this._buildDocument(documentStorageWithState);
@@ -1163,7 +1163,7 @@ export class BaseDocumentDriveServer
       // TODO two equal operations done by two clients will be considered the same, ie: { type: "INCREMENT" }
       const branch = removeExistingOperations(
         operationsByScope[scope as OperationScope] || [],
-        storageDocumentOperations
+        storageDocumentOperations,
       );
 
       // No operations to apply
@@ -1181,7 +1181,7 @@ export class BaseDocumentDriveServer
           : merge(trunk, invertedTrunk, reshuffleByTimestamp);
 
       const newOperations = newHistory.filter(
-        (op) => trunk.length < 1 || precedes(trunk[trunk.length - 1]!, op)
+        (op) => trunk.length < 1 || precedes(trunk[trunk.length - 1]!, op),
       );
 
       for (const nextOperation of newOperations) {
@@ -1191,7 +1191,7 @@ export class BaseDocumentDriveServer
         // for the operations that were re-indexed (previous hash becomes invalid due the new position in the history)
         if (tail.length > 0) {
           const sourceOperation = operations.find(
-            (op) => op.hash === nextOperation.hash
+            (op) => op.hash === nextOperation.hash,
           );
 
           skipHashValidation =
@@ -1209,7 +1209,7 @@ export class BaseDocumentDriveServer
               documentId,
               document,
               nextOperation,
-              skipHashValidation
+              skipHashValidation,
             );
           const appliedResult = await (taskQueueMethod
             ? runAsapAsync(task, taskQueueMethod)
@@ -1227,7 +1227,7 @@ export class BaseDocumentDriveServer
                   "ERROR",
                   nextOperation,
                   (e as Error).message,
-                  (e as Error).cause
+                  (e as Error).cause,
                 );
 
           // TODO: don't break on errors...
@@ -1248,7 +1248,7 @@ export class BaseDocumentDriveServer
     document: DocumentStorage<T>,
     drive: string,
     documentId?: string,
-    options?: GetDocumentOptions
+    options?: GetDocumentOptions,
   ): Promise<DocumentStorage<T>> {
     // apply skip header operations to all scopes
     const operations =
@@ -1257,7 +1257,7 @@ export class BaseDocumentDriveServer
         : document.operations;
     const documentOperations =
       DocumentUtils.documentHelpers.garbageCollectDocumentOperations(
-        operations
+        operations,
       );
 
     for (const scope of Object.keys(documentOperations)) {
@@ -1272,13 +1272,13 @@ export class BaseDocumentDriveServer
               documentId,
               lastRemainingOperation.index,
               lastRemainingOperation.scope,
-              "main"
+              "main",
             )
           : this.storage.getDriveOperationResultingState?.(
               drive,
               lastRemainingOperation.index,
               lastRemainingOperation.scope,
-              "main"
+              "main",
             ));
       }
     }
@@ -1291,7 +1291,7 @@ export class BaseDocumentDriveServer
 
   private _buildDocument<T extends Document>(
     documentStorage: DocumentStorage<T>,
-    options?: GetDocumentOptions
+    options?: GetDocumentOptions,
   ): T {
     if (documentStorage.state && (!options || options.checkHashes === false)) {
       return documentStorage as T;
@@ -1303,12 +1303,12 @@ export class BaseDocumentDriveServer
       options?.revisions !== undefined
         ? filterOperationsByRevision(
             documentStorage.operations,
-            options.revisions
+            options.revisions,
           )
         : documentStorage.operations;
     const operations =
       baseUtils.documentHelpers.garbageCollectDocumentOperations(
-        revisionOperations
+        revisionOperations,
       );
 
     return baseUtils.replayDocument(
@@ -1322,7 +1322,7 @@ export class BaseDocumentDriveServer
         ...options,
         checkHashes: options?.checkHashes ?? true,
         reuseOperationResultingState: options?.checkHashes ?? true,
-      }
+      },
     ) as T;
   }
 
@@ -1331,7 +1331,7 @@ export class BaseDocumentDriveServer
     id: string | undefined,
     document: T,
     operation: Operation,
-    skipHashValidation = false
+    skipHashValidation = false,
   ) {
     const documentModel = this.getDocumentModel(document.documentType);
 
@@ -1344,7 +1344,7 @@ export class BaseDocumentDriveServer
         ...document.operations,
         [scope]: DocumentUtils.documentHelpers.skipHeaderOperations(
           document.operations[scope],
-          operation
+          operation,
         ),
       });
 
@@ -1358,13 +1358,13 @@ export class BaseDocumentDriveServer
             id,
             lastRemainingOperation.index,
             lastRemainingOperation.scope,
-            "main"
+            "main",
           )
         : this.storage.getDriveOperationResultingState?.(
             drive,
             lastRemainingOperation.index,
             lastRemainingOperation.scope,
-            "main"
+            "main",
           ));
     }
 
@@ -1389,21 +1389,21 @@ export class BaseDocumentDriveServer
                   documentType: documentToCopy.documentType,
                   document: documentToCopy,
                   synchronizationUnits: signal.input.synchronizationUnits,
-                })
+                }),
               );
             break;
         }
         if (handler) {
           operationSignals.push(() =>
-            handler().then((result) => ({ signal, result }))
+            handler().then((result) => ({ signal, result })),
           );
         }
       },
-      { skip: operation.skip, reuseOperationResultingState: true }
+      { skip: operation.skip, reuseOperationResultingState: true },
     ) as T;
 
     const appliedOperations = newDocument.operations[operation.scope].filter(
-      (op) => op.index == operation.index && op.skip == operation.skip
+      (op) => op.index == operation.index && op.skip == operation.skip,
     );
     const appliedOperation = appliedOperations.at(0);
 
@@ -1411,7 +1411,7 @@ export class BaseDocumentDriveServer
       throw new OperationError(
         "ERROR",
         operation,
-        `Operation with index ${operation.index}:${operation.skip} was not applied.`
+        `Operation with index ${operation.index}:${operation.skip} was not applied.`,
       );
     }
     if (
@@ -1438,7 +1438,7 @@ export class BaseDocumentDriveServer
     drive: string,
     id: string,
     operation: Operation,
-    options?: AddOperationOptions
+    options?: AddOperationOptions,
   ): Promise<IOperationResult> {
     return this.addOperations(drive, id, [operation], options);
   }
@@ -1449,7 +1449,7 @@ export class BaseDocumentDriveServer
     callback: (document: DocumentStorage) => Promise<{
       operations: Operation[];
       header: DocumentHeader;
-    }>
+    }>,
   ) {
     if (!this.storage.addDocumentOperationsWithTransaction) {
       const documentStorage = await this.storage.getDocument(drive, id);
@@ -1460,14 +1460,14 @@ export class BaseDocumentDriveServer
           drive,
           id,
           result.operations,
-          result.header
+          result.header,
         );
       }
     } else {
       await this.storage.addDocumentOperationsWithTransaction(
         drive,
         id,
-        callback
+        callback,
       );
     }
   }
@@ -1476,7 +1476,7 @@ export class BaseDocumentDriveServer
     drive: string,
     id: string,
     operation: Operation,
-    options?: AddOperationOptions
+    options?: AddOperationOptions,
   ): Promise<IOperationResult> {
     return this.queueOperations(drive, id, [operation], options);
   }
@@ -1484,7 +1484,7 @@ export class BaseDocumentDriveServer
   private async resultIfExistingOperations(
     drive: string,
     id: string,
-    operations: Operation[]
+    operations: Operation[],
   ): Promise<IOperationResult | undefined> {
     try {
       const document = await this.getDocument(drive, id);
@@ -1496,8 +1496,8 @@ export class BaseDocumentDriveServer
               existingOp.id === op.id &&
               existingOp.index === op.index &&
               existingOp.type === op.type &&
-              existingOp.hash === op.hash
-          )
+              existingOp.hash === op.hash,
+          ),
       );
       if (!newOperation) {
         return {
@@ -1523,7 +1523,7 @@ export class BaseDocumentDriveServer
     drive: string,
     id: string,
     operations: Operation[],
-    options?: AddOperationOptions
+    options?: AddOperationOptions,
   ) {
     // if operations are already stored then returns cached document
     const result = await this.resultIfExistingOperations(drive, id, operations);
@@ -1547,7 +1547,7 @@ export class BaseDocumentDriveServer
               unsubscribeError();
               resolve(result);
             }
-          }
+          },
         );
         const unsubscribeError = this.queueManager.on(
           "jobFailed",
@@ -1557,7 +1557,7 @@ export class BaseDocumentDriveServer
               unsubscribeError();
               reject(error);
             }
-          }
+          },
         );
       });
     } catch (error) {
@@ -1570,7 +1570,7 @@ export class BaseDocumentDriveServer
     drive: string,
     id: string,
     action: Action,
-    options?: AddOperationOptions
+    options?: AddOperationOptions,
   ): Promise<IOperationResult> {
     return this.queueActions(drive, id, [action], options);
   }
@@ -1579,7 +1579,7 @@ export class BaseDocumentDriveServer
     drive: string,
     id: string,
     actions: Action[],
-    options?: AddOperationOptions
+    options?: AddOperationOptions,
   ): Promise<IOperationResult> {
     try {
       const jobId = await this.queueManager.addJob({
@@ -1598,7 +1598,7 @@ export class BaseDocumentDriveServer
               unsubscribeError();
               resolve(result);
             }
-          }
+          },
         );
         const unsubscribeError = this.queueManager.on(
           "jobFailed",
@@ -1608,7 +1608,7 @@ export class BaseDocumentDriveServer
               unsubscribeError();
               reject(error);
             }
-          }
+          },
         );
       });
     } catch (error) {
@@ -1620,7 +1620,7 @@ export class BaseDocumentDriveServer
   async queueDriveAction(
     drive: string,
     action: DocumentDriveAction | BaseAction,
-    options?: AddOperationOptions
+    options?: AddOperationOptions,
   ): Promise<IOperationResult<DocumentDriveDocument>> {
     return this.queueDriveActions(drive, [action], options);
   }
@@ -1628,7 +1628,7 @@ export class BaseDocumentDriveServer
   async queueDriveActions(
     drive: string,
     actions: (DocumentDriveAction | BaseAction)[],
-    options?: AddOperationOptions
+    options?: AddOperationOptions,
   ): Promise<IOperationResult<DocumentDriveDocument>> {
     try {
       const jobId = await this.queueManager.addJob({
@@ -1646,7 +1646,7 @@ export class BaseDocumentDriveServer
                 unsubscribeError();
                 resolve(result as IOperationResult<DocumentDriveDocument>);
               }
-            }
+            },
           );
           const unsubscribeError = this.queueManager.on(
             "jobFailed",
@@ -1656,9 +1656,9 @@ export class BaseDocumentDriveServer
                 unsubscribeError();
                 reject(error);
               }
-            }
+            },
           );
-        }
+        },
       );
     } catch (error) {
       logger.error("Error adding drive job", error);
@@ -1670,7 +1670,7 @@ export class BaseDocumentDriveServer
     drive: string,
     id: string,
     operations: Operation[],
-    options?: AddOperationOptions
+    options?: AddOperationOptions,
   ) {
     // if operations are already stored then returns the result
     const result = await this.resultIfExistingOperations(drive, id, operations);
@@ -1688,7 +1688,7 @@ export class BaseDocumentDriveServer
           drive,
           id,
           documentStorage,
-          operations
+          operations,
         );
 
         if (!result.document) {
@@ -1720,14 +1720,14 @@ export class BaseDocumentDriveServer
           }
           return acc;
         },
-        { scopes: [] as string[], branches: ["main"] }
+        { scopes: [] as string[], branches: ["main"] },
       );
 
       const syncUnits = await this.getSynchronizationUnits(
         drive,
         [id],
         scopes,
-        branches
+        branches,
       );
 
       // checks if any of the provided operations where reshufled
@@ -1738,8 +1738,8 @@ export class BaseDocumentDriveServer
               o.id === appliedOp.id &&
               o.index === appliedOp.index &&
               o.skip === appliedOp.skip &&
-              o.hash === appliedOp.hash
-          )
+              o.hash === appliedOp.hash,
+          ),
       );
 
       // if there are no new operations then reuses the provided source
@@ -1770,7 +1770,7 @@ export class BaseDocumentDriveServer
             }
           },
           this.handleListenerError.bind(this),
-          options?.forceSync ?? source.type === "local"
+          options?.forceSync ?? source.type === "local",
         )
         .then((updates) => {
           if (updates.length) {
@@ -1792,7 +1792,7 @@ export class BaseDocumentDriveServer
             {
               [operationSource]: "ERROR",
             },
-            error as Error
+            error as Error,
           );
 
           for (const syncUnit of syncUnits) {
@@ -1801,7 +1801,7 @@ export class BaseDocumentDriveServer
               {
                 [operationSource]: "ERROR",
               },
-              error as Error
+              error as Error,
             );
           }
         });
@@ -1826,7 +1826,7 @@ export class BaseDocumentDriveServer
               "ERROR",
               undefined,
               (error as Error).message,
-              (error as Error).cause
+              (error as Error).cause,
             );
 
       return {
@@ -1842,7 +1842,7 @@ export class BaseDocumentDriveServer
   addDriveOperation(
     drive: string,
     operation: Operation<DocumentDriveAction | BaseAction>,
-    options?: AddOperationOptions
+    options?: AddOperationOptions,
   ) {
     return this.addDriveOperations(drive, [operation], options);
   }
@@ -1860,7 +1860,7 @@ export class BaseDocumentDriveServer
     callback: (document: DocumentDriveStorage) => Promise<{
       operations: Operation<DocumentDriveAction | BaseAction>[];
       header: DocumentHeader;
-    }>
+    }>,
   ) {
     if (!this.storage.addDriveOperationsWithTransaction) {
       const documentStorage = await this.storage.getDrive(drive);
@@ -1870,7 +1870,7 @@ export class BaseDocumentDriveServer
         await this.storage.addDriveOperations(
           drive,
           result.operations,
-          result.header
+          result.header,
         );
       }
       return result;
@@ -1882,14 +1882,14 @@ export class BaseDocumentDriveServer
   queueDriveOperation(
     drive: string,
     operation: Operation<DocumentDriveAction | BaseAction>,
-    options?: AddOperationOptions
+    options?: AddOperationOptions,
   ): Promise<IOperationResult<DocumentDriveDocument>> {
     return this.queueDriveOperations(drive, [operation], options);
   }
 
   private async resultIfExistingDriveOperations(
     driveId: string,
-    operations: Operation<DocumentDriveAction | BaseAction>[]
+    operations: Operation<DocumentDriveAction | BaseAction>[],
   ): Promise<IOperationResult<DocumentDriveDocument> | undefined> {
     try {
       const drive = await this.getDrive(driveId);
@@ -1901,8 +1901,8 @@ export class BaseDocumentDriveServer
               existingOp.id === op.id &&
               existingOp.index === op.index &&
               existingOp.type === op.type &&
-              existingOp.hash === op.hash
-          )
+              existingOp.hash === op.hash,
+          ),
       );
       if (!newOperation) {
         return {
@@ -1923,12 +1923,12 @@ export class BaseDocumentDriveServer
   async queueDriveOperations(
     drive: string,
     operations: Operation<DocumentDriveAction | BaseAction>[],
-    options?: AddOperationOptions
+    options?: AddOperationOptions,
   ): Promise<IOperationResult<DocumentDriveDocument>> {
     // if operations are already stored then returns cached document
     const result = await this.resultIfExistingDriveOperations(
       drive,
-      operations
+      operations,
     );
     if (result) {
       return result;
@@ -1949,7 +1949,7 @@ export class BaseDocumentDriveServer
                 unsubscribeError();
                 resolve(result as IOperationResult<DocumentDriveDocument>);
               }
-            }
+            },
           );
           const unsubscribeError = this.queueManager.on(
             "jobFailed",
@@ -1959,9 +1959,9 @@ export class BaseDocumentDriveServer
                 unsubscribeError();
                 reject(error);
               }
-            }
+            },
           );
-        }
+        },
       );
     } catch (error) {
       logger.error("Error adding drive job", error);
@@ -1972,7 +1972,7 @@ export class BaseDocumentDriveServer
   async addDriveOperations(
     drive: string,
     operations: Operation<DocumentDriveAction | BaseAction>[],
-    options?: AddOperationOptions
+    options?: AddOperationOptions,
   ) {
     let document: DocumentDriveDocument | undefined;
     const operationsApplied: Operation<DocumentDriveAction | BaseAction>[] = [];
@@ -1982,7 +1982,7 @@ export class BaseDocumentDriveServer
     // if operations are already stored then returns cached drive
     const result = await this.resultIfExistingDriveOperations(
       drive,
-      operations
+      operations,
     );
     if (result) {
       return result;
@@ -2039,8 +2039,8 @@ export class BaseDocumentDriveServer
                 o.id === appliedOp.id &&
                 o.index === appliedOp.index &&
                 o.skip === appliedOp.skip &&
-                o.hash === appliedOp.hash
-            )
+                o.hash === appliedOp.hash,
+            ),
         );
 
         // if there are no new operations then reuses the provided source
@@ -2074,7 +2074,7 @@ export class BaseDocumentDriveServer
               });
             },
             this.handleListenerError.bind(this),
-            options?.forceSync ?? source.type === "local"
+            options?.forceSync ?? source.type === "local",
           )
           .then((updates) => {
             if (updates.length) {
@@ -2088,7 +2088,7 @@ export class BaseDocumentDriveServer
             this.updateSyncUnitStatus(
               drive,
               { [operationSource]: "ERROR" },
-              error as Error
+              error as Error,
             );
           });
       }
@@ -2119,7 +2119,7 @@ export class BaseDocumentDriveServer
               "ERROR",
               undefined,
               (error as Error).message,
-              (error as Error).cause
+              (error as Error).cause,
             );
 
       return {
@@ -2134,7 +2134,7 @@ export class BaseDocumentDriveServer
 
   private _buildOperations<T extends Action>(
     document: Document,
-    actions: (T | BaseAction)[]
+    actions: (T | BaseAction)[],
   ): Operation<T | BaseAction>[] {
     const operations: Operation<T | BaseAction>[] = [];
     const { reducer } = this.getDocumentModel(document.documentType);
@@ -2153,7 +2153,7 @@ export class BaseDocumentDriveServer
     drive: string,
     id: string,
     action: Action,
-    options?: AddOperationOptions
+    options?: AddOperationOptions,
   ): Promise<IOperationResult> {
     return this.addActions(drive, id, [action], options);
   }
@@ -2162,7 +2162,7 @@ export class BaseDocumentDriveServer
     drive: string,
     id: string,
     actions: Action[],
-    options?: AddOperationOptions
+    options?: AddOperationOptions,
   ): Promise<IOperationResult> {
     const document = await this.getDocument(drive, id);
     const operations = this._buildOperations(document, actions);
@@ -2172,7 +2172,7 @@ export class BaseDocumentDriveServer
   async addDriveAction(
     drive: string,
     action: DocumentDriveAction | BaseAction,
-    options?: AddOperationOptions
+    options?: AddOperationOptions,
   ): Promise<IOperationResult<DocumentDriveDocument>> {
     return this.addDriveActions(drive, [action], options);
   }
@@ -2180,7 +2180,7 @@ export class BaseDocumentDriveServer
   async addDriveActions(
     drive: string,
     actions: (DocumentDriveAction | BaseAction)[],
-    options?: AddOperationOptions
+    options?: AddOperationOptions,
   ): Promise<IOperationResult<DocumentDriveDocument>> {
     const document = await this.getDrive(drive);
     const operations = this._buildOperations(document, actions);
@@ -2196,7 +2196,7 @@ export class BaseDocumentDriveServer
       label: string;
       block: boolean;
       filter: ListenerFilter;
-    }
+    },
   ) {
     const listener: AddListenerInput["listener"] = {
       callInfo: {
@@ -2230,26 +2230,26 @@ export class BaseDocumentDriveServer
     for (const listener of listeners) {
       await this.addDriveAction(
         driveId,
-        actions.removeListener({ listenerId: listener.listenerId })
+        actions.removeListener({ listenerId: listener.listenerId }),
       );
     }
 
     for (const trigger of triggers) {
       await this.addDriveAction(
         driveId,
-        actions.removeTrigger({ triggerId: trigger.id })
+        actions.removeTrigger({ triggerId: trigger.id }),
       );
     }
 
     await this.addDriveAction(
       driveId,
-      actions.setSharingType({ type: "LOCAL" })
+      actions.setSharingType({ type: "LOCAL" }),
     );
   }
 
   private async addListener(
     driveId: string,
-    operation: Operation<Action<"ADD_LISTENER", AddListenerInput>>
+    operation: Operation<Action<"ADD_LISTENER", AddListenerInput>>,
   ) {
     const { listener } = operation.input;
     await this.listenerStateManager.addListener({
@@ -2273,7 +2273,7 @@ export class BaseDocumentDriveServer
 
   private async removeListener(
     driveId: string,
-    operation: Operation<Action<"REMOVE_LISTENER", RemoveListenerInput>>
+    operation: Operation<Action<"REMOVE_LISTENER", RemoveListenerInput>>,
   ) {
     const { listenerId } = operation.input;
     await this.listenerStateManager.removeListener(driveId, listenerId);
@@ -2281,26 +2281,26 @@ export class BaseDocumentDriveServer
 
   getTransmitter(
     driveId: string,
-    listenerId: string
+    listenerId: string,
   ): Promise<ITransmitter | undefined> {
     return this.listenerStateManager.getTransmitter(driveId, listenerId);
   }
 
   getListener(
     driveId: string,
-    listenerId: string
+    listenerId: string,
   ): Promise<ListenerState | undefined> {
     return this.listenerStateManager.getListener(driveId, listenerId);
   }
 
   getSyncStatus(
-    syncUnitId: string
+    syncUnitId: string,
   ): SyncStatus | SynchronizationUnitNotFoundError {
     const status = this.syncStatus.get(syncUnitId);
     if (!status) {
       return new SynchronizationUnitNotFoundError(
         `Sync status not found for syncUnitId: ${syncUnitId}`,
-        syncUnitId
+        syncUnitId,
       );
     }
     return this.getCombinedSyncUnitStatus(status);

package/src/server/listener/transmitter/internal.ts

@@ -27,6 +27,10 @@ export type InternalTransmitterUpdate<
   state: T["state"][S];
 };
 
+export interface IInternalTransmitter extends ITransmitter {
+  setReceiver(receiver: IReceiver): void;
+}
+
 export class InternalTransmitter implements ITransmitter {
   private drive: IBaseDocumentDriveServer;
   private listener: Listener;

package/src/server/types.ts

@@ -22,6 +22,10 @@ import type {
 } from "document-model/document";
 import { Unsubscribe } from "nanoevents";
 import { BaseDocumentDriveServer } from ".";
+import {
+  IReceiver as IInternalListener,
+  IInternalTransmitter,
+} from "./listener/transmitter/internal";
 import { IReadModeDriveServer } from "../read-mode/types";
 import { RunAsap } from "../utils";
 import { IDefaultDrivesManager } from "../utils/default-drives-manager";
@@ -443,6 +447,17 @@ export abstract class AbstractDocumentDriveServer {
     syncUnitId: string,
   ): SyncStatus | SynchronizationUnitNotFoundError;
 
+  abstract addInternalListener(
+    driveId: string,
+    receiver: IInternalListener,
+    options: {
+      listenerId: string;
+      label: string;
+      block: boolean;
+      filter: ListenerFilter;
+    },
+  ): Promise<IInternalTransmitter>;
+
   /** Synchronization methods */
   abstract getSynchronizationUnits(
     driveId: string,
@@ -486,12 +501,10 @@ export abstract class AbstractDocumentDriveServer {
 
   /** Event methods **/
   protected abstract emit<K extends keyof DriveEvents>(
-    this: this,
     event: K,
     ...args: Parameters<DriveEvents[K]>
   ): void;
   abstract on<K extends keyof DriveEvents>(
-    this: this,
     event: K,
     cb: DriveEvents[K],
   ): Unsubscribe;
@@ -518,10 +531,13 @@ export const DefaultListenerManagerOptions = {
   sequentialUpdates: true,
 };
 
-export type IBaseDocumentDriveServer = Pick<
-  AbstractDocumentDriveServer,
-  keyof AbstractDocumentDriveServer
->;
+type PublicKeys<T> = {
+  [K in keyof T]: T extends { [P in K]: T[K] } ? K : never;
+}[keyof T];
+
+type PublicPart<T> = Pick<T, PublicKeys<T>>;
+
+export type IBaseDocumentDriveServer = PublicPart<AbstractDocumentDriveServer>;
 
 export type IDocumentDriveServer = IBaseDocumentDriveServer &
   IDefaultDrivesManager &