document-drive 1.19.1 → 1.20.1

package/src/server/types.ts

@@ -1,596 +0,0 @@
-import type {
-  DocumentDriveAction,
-  DocumentDriveDocument,
-  DocumentDriveLocalState,
-  DocumentDriveState,
-  ListenerCallInfo,
-  ListenerFilter,
-  Trigger,
-} from "document-model-libs/document-drive";
-import type {
-  Action,
-  ActionContext,
-  BaseAction,
-  CreateChildDocumentInput,
-  Document,
-  DocumentModel,
-  Operation,
-  OperationScope,
-  ReducerOptions,
-  Signal,
-  State,
-} from "document-model/document";
-import { Unsubscribe } from "nanoevents";
-import { BaseDocumentDriveServer } from ".";
-import { IReadModeDriveServer } from "../read-mode/types";
-import { RunAsap } from "../utils";
-import { IDefaultDrivesManager } from "../utils/default-drives-manager";
-import { DriveInfo } from "../utils/graphql";
-import { OperationError, SynchronizationUnitNotFoundError } from "./error";
-import {
-  IReceiver as IInternalListener,
-  IInternalTransmitter,
-} from "./listener/transmitter/internal";
-import {
-  ITransmitter,
-  PullResponderTrigger,
-  StrandUpdateSource,
-} from "./listener/transmitter/types";
-
-export type Constructor<T = object> = new (...args: any[]) => T;
-
-export type DocumentDriveServerConstructor =
-  Constructor<BaseDocumentDriveServer>;
-
-// Mixin type that returns a type extending both the base class and the interface
-export type Mixin<T extends Constructor, I> = T &
-  Constructor<InstanceType<T> & I>;
-
-export type DocumentDriveServerMixin<I> = Mixin<
-  typeof BaseDocumentDriveServer,
-  I
->;
-
-export type DriveInput = State<
-  Omit<DocumentDriveState, "__typename" | "id" | "nodes"> & { id?: string },
-  DocumentDriveLocalState
->;
-
-export type RemoteDriveAccessLevel = "READ" | "WRITE";
-
-export type RemoteDriveOptions = DocumentDriveLocalState & {
-  // TODO make local state optional
-  pullFilter?: ListenerFilter;
-  pullInterval?: number;
-  expectedDriveInfo?: DriveInfo;
-  accessLevel?: RemoteDriveAccessLevel;
-};
-
-export type CreateDocumentInput = CreateChildDocumentInput;
-
-export type SignalResult = {
-  signal: Signal;
-  result: unknown; // infer from return types on document-model
-};
-
-export type IOperationResult<T extends Document = Document> = {
-  status: UpdateStatus;
-  error?: OperationError;
-  operations: Operation[];
-  document: T | undefined;
-  signals: SignalResult[];
-};
-
-export type SynchronizationUnit = {
-  syncId: string;
-  driveId: string;
-  documentId: string;
-  documentType: string;
-  scope: string;
-  branch: string;
-  lastUpdated: string;
-  revision: number;
-};
-
-export type SynchronizationUnitQuery = Omit<
-  SynchronizationUnit,
-  "revision" | "lastUpdated"
->;
-
-export type Listener = {
-  driveId: string;
-  listenerId: string;
-  label?: string;
-  block: boolean;
-  system: boolean;
-  filter: ListenerFilter;
-  callInfo?: ListenerCallInfo;
-  transmitter?: ITransmitter;
-};
-
-export type CreateListenerInput = {
-  driveId: string;
-  label?: string;
-  block: boolean;
-  system: boolean;
-  filter: ListenerFilter;
-  callInfo?: ListenerCallInfo;
-};
-
-export enum TransmitterType {
-  Internal,
-  SwitchboardPush,
-  PullResponder,
-  SecureConnect,
-  MatrixConnect,
-  RESTWebhook,
-}
-
-export type ListenerRevision = {
-  driveId: string;
-  documentId: string;
-  scope: string;
-  branch: string;
-  status: UpdateStatus;
-  revision: number;
-  error?: string;
-};
-
-export type ListenerRevisionWithError = Omit<ListenerRevision, "error"> & {
-  error?: Error;
-};
-
-export type ListenerUpdate = {
-  listenerId: string;
-  listenerRevisions: ListenerRevision[];
-};
-
-export type UpdateStatus = "SUCCESS" | "CONFLICT" | "MISSING" | "ERROR";
-export type ErrorStatus = Exclude<UpdateStatus, "SUCCESS">;
-
-export type OperationUpdate = {
-  timestamp: string;
-  index: number;
-  skip: number;
-  type: string;
-  input: object;
-  hash: string;
-  context?: ActionContext;
-  id?: string;
-};
-
-export type StrandUpdate = {
-  driveId: string;
-  documentId: string;
-  scope: OperationScope;
-  branch: string;
-  operations: OperationUpdate[];
-};
-
-export type SyncStatus = "INITIAL_SYNC" | "SYNCING" | UpdateStatus;
-
-export type PullSyncStatus = SyncStatus;
-export type PushSyncStatus = SyncStatus;
-
-export type SyncUnitStatusObject = {
-  push?: PushSyncStatus;
-  pull?: PullSyncStatus;
-};
-
-export type AddRemoteDriveStatus =
-  | "SUCCESS"
-  | "ERROR"
-  | "PENDING"
-  | "ADDING"
-  | "ALREADY_ADDED";
-
-export interface DriveEvents {
-  syncStatus: (
-    driveId: string,
-    status: SyncStatus,
-    error?: Error,
-    syncUnitStatus?: SyncUnitStatusObject,
-  ) => void;
-  defaultRemoteDrive: (
-    status: AddRemoteDriveStatus,
-    defaultDrives: Map<string, DefaultRemoteDriveInfo>,
-    driveInput: DefaultRemoteDriveInput,
-    driveId?: string,
-    driveName?: string,
-    error?: Error,
-  ) => void;
-  strandUpdate: (update: StrandUpdate) => void;
-  clientStrandsError: (
-    driveId: string,
-    trigger: Trigger,
-    status: number,
-    errorMessage: string,
-  ) => void;
-  documentModels: (documentModels: DocumentModel[]) => void;
-  driveAdded: (drive: DocumentDriveDocument) => void;
-  driveDeleted: (driveId: string) => void;
-}
-
-export type PartialRecord<K extends keyof any, T> = {
-  [P in K]?: T;
-};
-
-export type RevisionsFilter = PartialRecord<OperationScope, number>;
-
-export type GetDocumentOptions = ReducerOptions & {
-  revisions?: RevisionsFilter;
-  checkHashes?: boolean;
-};
-
-export type AddOperationOptions = {
-  forceSync?: boolean;
-  source: StrandUpdateSource;
-};
-
-export type DefaultRemoteDriveInput = {
-  url: string;
-  options: RemoteDriveOptions;
-};
-
-export type DefaultRemoteDriveInfo = DefaultRemoteDriveInput & {
-  status: AddRemoteDriveStatus;
-  metadata?: DriveInfo;
-};
-
-export type RemoveDriveStrategy = "remove" | "detach";
-
-/**
- * Options for removing old remote drives.
- *
- * Allows specifying different strategies for handling old remote drives:
- *
- * - `remove-all`: Remove all remote drives.
- * - `preserve-all`: Preserve all remote drives (this is the default behavior).
- * - `remove-by-id`: Remove the remote drives specified by their IDs.
- * - `remove-by-url`: Remove the remote drives specified by their URLs.
- * - `preserve-by-id`: Preserve remote drives by their IDs and remove the rest.
- * - `preserve-by-url`: Preserve remote drives by their URLs and remove the rest.
- * - `detach-by-id`: Detach remote drives by their IDs (changes the remote drive to a local drive).
- * - `detach-by-url`: Detach remote drives by their URLs (changes the remote drive to a local drive).
- * - `preserve-by-id-and-detach`: Preserve the remote drives specified by their IDs and detach the rest.
- * - `preserve-by-url-and-detach`: Preserve the remote drives specified by their URLs and detach the rest.
- *
- * Each strategy is represented by an object with a `strategy` property and,
- * depending on the strategy, additional properties such as `ids` or `urls`.
- */
-export type RemoveOldRemoteDrivesOption =
-  | {
-      strategy: "remove-all";
-    }
-  | {
-      strategy: "preserve-all";
-    }
-  | {
-      strategy: "remove-by-id";
-      ids: string[];
-    }
-  | {
-      strategy: "remove-by-url";
-      urls: string[];
-    }
-  | {
-      strategy: "preserve-by-id";
-      ids: string[];
-    }
-  | {
-      strategy: "preserve-by-url";
-      urls: string[];
-    }
-  | {
-      strategy: "detach-by-id";
-      ids: string[];
-    }
-  | {
-      strategy: "detach-by-url";
-      urls: string[];
-    }
-  | {
-      strategy: "preserve-by-id-and-detach";
-      ids: string[];
-    }
-  | {
-      strategy: "preserve-by-url-and-detach";
-      urls: string[];
-    };
-
-export type DocumentDriveServerOptions = {
-  defaultDrives: {
-    loadOnInit?: boolean; // defaults to true
-    remoteDrives?: Array<DefaultRemoteDriveInput>;
-    removeOldRemoteDrives?: RemoveOldRemoteDrivesOption;
-  };
-  /* method to queue heavy tasks that might block the event loop.
-   * If set to null then it will queued as micro task.
-   * Defaults to the most appropriate method according to the system
-   */
-  taskQueueMethod?: RunAsap.RunAsap<unknown> | null;
-  listenerManager?: ListenerManagerOptions;
-};
-
-export type GetStrandsOptions = {
-  limit?: number;
-  since?: string;
-  fromRevision?: number;
-};
-
-export type ListenerManagerOptions = {
-  sequentialUpdates?: boolean;
-};
-
-export const DefaultListenerManagerOptions = {
-  sequentialUpdates: true,
-};
-
-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 interface IBaseDocumentDriveServer {
-  initialize(): Promise<Error[] | null>;
-  setDocumentModels(models: DocumentModel[]): void;
-  getDrives(): Promise<string[]>;
-  addDrive(input: DriveInput): Promise<DocumentDriveDocument>;
-  addRemoteDrive(
-    url: string,
-    options: RemoteDriveOptions,
-  ): Promise<DocumentDriveDocument>;
-  deleteDrive(driveId: string): Promise<void>;
-  getDrive(
-    driveId: string,
-    options?: GetDocumentOptions,
-  ): Promise<DocumentDriveDocument>;
-
-  getDriveBySlug(slug: string): Promise<DocumentDriveDocument>;
-
-  getDocuments(driveId: string): Promise<string[]>;
-  getDocument(
-    driveId: string,
-    documentId: string,
-    options?: GetDocumentOptions,
-  ): Promise<Document>;
-
-  addOperation(
-    driveId: string,
-    documentId: string,
-    operation: Operation,
-    options?: AddOperationOptions,
-  ): Promise<IOperationResult>;
-
-  addOperations(
-    driveId: string,
-    documentId: string,
-    operations: Operation[],
-    options?: AddOperationOptions,
-  ): Promise<IOperationResult>;
-
-  queueOperation(
-    driveId: string,
-    documentId: string,
-    operation: Operation,
-    options?: AddOperationOptions,
-  ): Promise<IOperationResult>;
-
-  queueOperations(
-    driveId: string,
-    documentId: string,
-    operations: Operation[],
-    options?: AddOperationOptions,
-  ): Promise<IOperationResult>;
-
-  queueAction(
-    driveId: string,
-    documentId: string,
-    action: Action,
-    options?: AddOperationOptions,
-  ): Promise<IOperationResult>;
-
-  queueActions(
-    driveId: string,
-    documentId: string,
-    actions: Action[],
-    options?: AddOperationOptions,
-  ): Promise<IOperationResult>;
-
-  addDriveOperation(
-    driveId: string,
-    operation: Operation<DocumentDriveAction | BaseAction>,
-    options?: AddOperationOptions,
-  ): Promise<IOperationResult<DocumentDriveDocument>>;
-  addDriveOperations(
-    driveId: string,
-    operations: Operation<DocumentDriveAction | BaseAction>[],
-    options?: AddOperationOptions,
-  ): Promise<IOperationResult<DocumentDriveDocument>>;
-
-  queueDriveOperation(
-    driveId: string,
-    operation: Operation<DocumentDriveAction | BaseAction>,
-    options?: AddOperationOptions,
-  ): Promise<IOperationResult<DocumentDriveDocument>>;
-
-  queueDriveOperations(
-    driveId: string,
-    operations: Operation<DocumentDriveAction | BaseAction>[],
-    options?: AddOperationOptions,
-  ): Promise<IOperationResult<DocumentDriveDocument>>;
-
-  queueDriveAction(
-    driveId: string,
-    action: DocumentDriveAction | BaseAction,
-    options?: AddOperationOptions,
-  ): Promise<IOperationResult<DocumentDriveDocument>>;
-
-  queueDriveActions(
-    driveId: string,
-    actions: Array<DocumentDriveAction | BaseAction>,
-    options?: AddOperationOptions,
-  ): Promise<IOperationResult<DocumentDriveDocument>>;
-
-  addAction(
-    driveId: string,
-    documentId: string,
-    action: Action,
-    options?: AddOperationOptions,
-  ): Promise<IOperationResult>;
-  addActions(
-    driveId: string,
-    documentId: string,
-    actions: Action[],
-    options?: AddOperationOptions,
-  ): Promise<IOperationResult>;
-
-  addDriveAction(
-    driveId: string,
-    action: DocumentDriveAction | BaseAction,
-    options?: AddOperationOptions,
-  ): Promise<IOperationResult<DocumentDriveDocument>>;
-  addDriveActions(
-    driveId: string,
-    actions: (DocumentDriveAction | BaseAction)[],
-    options?: AddOperationOptions,
-  ): Promise<IOperationResult<DocumentDriveDocument>>;
-
-  getSyncStatus(
-    syncUnitId: string,
-  ): SyncStatus | SynchronizationUnitNotFoundError;
-
-  addInternalListener(
-    driveId: string,
-    receiver: IInternalListener,
-    options: {
-      listenerId: string;
-      label: string;
-      block: boolean;
-      filter: ListenerFilter;
-    },
-  ): Promise<IInternalTransmitter>;
-
-  /** Synchronization methods */
-  getSynchronizationUnits(
-    driveId: string,
-    documentId?: string[],
-    scope?: string[],
-    branch?: string[],
-    documentType?: string[],
-    loadedDrive?: DocumentDriveDocument,
-  ): Promise<SynchronizationUnit[]>;
-
-  getSynchronizationUnit(
-    driveId: string,
-    syncId: string,
-    loadedDrive?: DocumentDriveDocument,
-  ): Promise<SynchronizationUnit | undefined>;
-
-  getSynchronizationUnitsIds(
-    driveId: string,
-    documentId?: string[],
-    scope?: string[],
-    branch?: string[],
-    documentType?: string[],
-  ): Promise<SynchronizationUnitQuery[]>;
-
-  getOperationData(
-    driveId: string,
-    syncId: string,
-    filter: GetStrandsOptions,
-    loadedDrive?: DocumentDriveDocument,
-  ): Promise<OperationUpdate[]>;
-
-  /** Internal methods **/
-  getDocumentModels(): DocumentModel[];
-
-  getTransmitter(
-    driveId: string,
-    listenerId: string,
-  ): Promise<ITransmitter | undefined>;
-
-  clearStorage(): Promise<void>;
-
-  registerPullResponderTrigger(
-    id: string,
-    url: string,
-    options: Pick<RemoteDriveOptions, "pullFilter" | "pullInterval">,
-  ): Promise<PullResponderTrigger>;
-
-  on<K extends keyof DriveEvents>(event: K, cb: DriveEvents[K]): Unsubscribe;
-}
-
-export type IDocumentDriveServer = IBaseDocumentDriveServer &
-  IDefaultDrivesManager &
-  IReadModeDriveServer;
-
-export type DriveUpdateErrorHandler = (
-  error: Error,
-  driveId: string,
-  listener: ListenerState,
-) => void;
-
-export interface IListenerManager {
-  initialize(handler: DriveUpdateErrorHandler): Promise<void>;
-
-  removeDrive(driveId: DocumentDriveState["id"]): Promise<void>;
-  driveHasListeners(driveId: string): boolean;
-
-  setListener(driveId: string, listener: Listener): Promise<void>;
-  removeListener(driveId: string, listenerId: string): Promise<boolean>;
-  getListenerState(driveId: string, listenerId: string): ListenerState;
-
-  getStrands(
-    driveId: string,
-    listenerId: string,
-    options?: GetStrandsOptions,
-  ): Promise<StrandUpdate[]>;
-  updateSynchronizationRevisions(
-    driveId: string,
-    syncUnits: SynchronizationUnit[],
-    source: StrandUpdateSource,
-    willUpdate?: (listeners: Listener[]) => void,
-    onError?: (error: Error, driveId: string, listener: ListenerState) => void,
-    forceSync?: boolean,
-  ): Promise<ListenerUpdate[]>;
-  updateListenerRevision(
-    listenerId: string,
-    driveId: string,
-    syncId: string,
-    listenerRev: number,
-  ): Promise<void>;
-
-  // todo: re-evaluate
-  getListenerSyncUnitIds(
-    driveId: string,
-    listenerId: string,
-  ): Promise<SynchronizationUnitQuery[]>;
-  removeSyncUnits(
-    driveId: string,
-    syncUnits: Pick<SynchronizationUnit, "syncId">[],
-  ): Promise<void>;
-}
-
-export type ListenerStatus =
-  | "CREATED"
-  | "PENDING"
-  | "SUCCESS"
-  | "MISSING"
-  | "CONFLICT"
-  | "ERROR";
-
-export interface ListenerState {
-  driveId: string;
-  block: boolean;
-  pendingTimeout: string;
-  listener: Listener;
-  syncUnits: Map<SynchronizationUnit["syncId"], SyncronizationUnitState>;
-  listenerStatus: ListenerStatus;
-}
-
-export interface SyncronizationUnitState {
-  listenerRev: number;
-  lastUpdated: string;
-}

package/src/server/utils.ts

@@ -1,82 +0,0 @@
-import type { Document, OperationScope } from "document-model/document";
-import { RevisionsFilter, StrandUpdate } from "./types";
-
-export function buildRevisionsFilter(
-  strands: StrandUpdate[],
-  driveId: string,
-  documentId: string,
-): RevisionsFilter {
-  return strands.reduce<RevisionsFilter>((acc, s) => {
-    if (!(s.driveId === driveId && s.documentId === documentId)) {
-      return acc;
-    }
-    acc[s.scope] = s.operations[s.operations.length - 1]?.index ?? -1;
-    return acc;
-  }, {});
-}
-
-export function buildDocumentRevisionsFilter(
-  document: Document,
-): RevisionsFilter {
-  return Object.entries(document.operations).reduce<RevisionsFilter>(
-    (acc, [scope, operations]) => {
-      acc[scope as OperationScope] = operations.at(-1)?.index ?? -1;
-      return acc;
-    },
-    {} as RevisionsFilter,
-  );
-}
-
-export function filterOperationsByRevision(
-  operations: Document["operations"],
-  revisions?: RevisionsFilter,
-): Document["operations"] {
-  if (!revisions) {
-    return operations;
-  }
-  return (Object.keys(operations) as OperationScope[]).reduce<
-    Document["operations"]
-  >(
-    (acc, scope) => {
-      const revision = revisions[scope];
-      if (revision !== undefined) {
-        acc[scope] = operations[scope].filter((op) => op.index <= revision);
-      }
-      return acc;
-    },
-    { global: [], local: [] } as unknown as Document["operations"],
-  );
-}
-
-export function isAtRevision(
-  document: Document,
-  revisions?: RevisionsFilter,
-): boolean {
-  return (
-    !revisions ||
-    Object.entries(revisions).find(([scope, revision]) => {
-      const operation = document.operations[scope as OperationScope].at(-1);
-      if (revision === -1) {
-        return operation !== undefined;
-      }
-      return operation?.index !== revision;
-    }) === undefined
-  );
-}
-
-export function isAfterRevision(
-  document: Document,
-  revisions?: RevisionsFilter,
-): boolean {
-  return (
-    !revisions ||
-    Object.entries(revisions).every(([scope, revision]) => {
-      const operation = document.operations[scope as OperationScope].at(-1);
-
-      if (revision === -1) {
-        return operation !== undefined;
-      }
-      return operation && operation.index > revision;
-    })
-  );
-}