document-drive 1.19.0 → 1.20.0

package/src/utils/index.ts

@@ -1,90 +0,0 @@
-import {
-  DocumentDriveDocument,
-  documentModel as DocumentDriveModel,
-} from "document-model-libs/document-drive";
-import {
-  Action,
-  BaseAction,
-  Document,
-  DocumentOperations,
-  Operation,
-  OperationScope,
-} from "document-model/document";
-import { generateId } from "document-model/utils";
-import { OperationError } from "../server/error";
-import { DocumentDriveStorage, DocumentStorage } from "../storage";
-import { RunAsap } from "./run-asap";
-export * from "./run-asap";
-
-export const runAsap = RunAsap.runAsap;
-export const runAsapAsync = RunAsap.runAsapAsync;
-
-export function isDocumentDriveStorage(
-  document: DocumentStorage,
-): document is DocumentDriveStorage {
-  return document.documentType === DocumentDriveModel.id;
-}
-
-export function isDocumentDrive(
-  document: Document,
-): document is DocumentDriveDocument {
-  return document.documentType === DocumentDriveModel.id;
-}
-
-export function mergeOperations<A extends Action = Action>(
-  currentOperations: DocumentOperations<A>,
-  newOperations: Operation<A | BaseAction>[],
-): DocumentOperations<A> {
-  const minIndexByScope = Object.keys(currentOperations).reduce<
-    Partial<Record<OperationScope, number>>
-  >((acc, curr) => {
-    const scope = curr as OperationScope;
-    acc[scope] = currentOperations[scope].at(-1)?.index ?? 0;
-    return acc;
-  }, {});
-
-  const conflictOp = newOperations.find(
-    (op) => op.index < (minIndexByScope[op.scope] ?? 0),
-  );
-  if (conflictOp) {
-    throw new OperationError(
-      "ERROR",
-      conflictOp,
-      `Tried to add operation with index ${conflictOp.index} and document is at index ${minIndexByScope[conflictOp.scope]}`,
-    );
-  }
-
-  return newOperations
-    .sort((a, b) => a.index - b.index)
-    .reduce<DocumentOperations<A>>((acc, curr) => {
-      const existingOperations = acc[curr.scope] || [];
-      return { ...acc, [curr.scope]: [...existingOperations, curr] };
-    }, currentOperations);
-}
-
-export function generateUUID(): string {
-  return generateId();
-}
-
-export function isNoopUpdate(
-  operation: Operation,
-  latestOperation?: Operation,
-) {
-  if (!latestOperation) {
-    return false;
-  }
-
-  const isNoopOp = operation.type === "NOOP";
-  const isNoopLatestOp = latestOperation.type === "NOOP";
-  const isSameIndexOp = operation.index === latestOperation.index;
-  const isSkipOpGreaterThanLatestOp = operation.skip > latestOperation.skip;
-
-  return (
-    isNoopOp && isNoopLatestOp && isSameIndexOp && isSkipOpGreaterThanLatestOp
-  );
-}
-
-// return true if dateA is before dateB
-export function isBefore(dateA: Date | string, dateB: Date | string) {
-  return new Date(dateA) < new Date(dateB);
-}

package/src/utils/logger.ts

@@ -1,38 +0,0 @@
-export type ILogger = Pick<
-  Console,
-  "log" | "info" | "warn" | "error" | "debug" | "trace"
->;
-class Logger implements ILogger {
-  #logger: ILogger = console;
-
-  constructor() {
-    // Bind methods to avoid losing `this`
-    this.log = this.log.bind(this);
-    this.info = this.info.bind(this);
-    this.warn = this.warn.bind(this);
-    this.error = this.error.bind(this);
-    this.debug = this.debug.bind(this);
-    this.trace = this.trace.bind(this);
-  }
-
-  set logger(logger: ILogger) {
-    this.#logger = logger;
-  }
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-  log = (...data: any[]) => this.#logger.log(...data);
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-  info = (...data: any[]) => this.#logger.info(...data);
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-  warn = (...data: any[]) => this.#logger.warn(...data);
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-  error = (...data: any[]) => this.#logger.error(...data);
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-  debug = (...data: any[]) => this.#logger.debug(...data);
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-  trace = (...data: any[]) => this.#logger.trace(...data);
-}
-
-const loggerInstance = new Logger();
-
-export const logger: ILogger = loggerInstance;
-export const setLogger = (logger: ILogger) => (loggerInstance.logger = logger);

package/src/utils/migrations.ts

@@ -1,58 +0,0 @@
-import {
-  Action,
-  Document,
-  DocumentOperations,
-  Operation,
-  OperationScope,
-} from "document-model/document";
-import { DocumentStorage } from "../storage/types";
-
-export function migrateDocumentOperationSigatures<D extends Document>(
-  document: DocumentStorage<D>,
-): DocumentStorage<D> | undefined {
-  let legacy = false;
-  const operations = Object.entries(document.operations).reduce<
-    DocumentOperations<Action>
-  >(
-    (acc, [key, operations]) => {
-      const scope = key as unknown as OperationScope;
-      for (const op of operations) {
-        const newOp = migrateLegacyOperationSignature(op);
-        acc[scope].push(newOp);
-        if (newOp !== op) {
-          legacy = true;
-        }
-      }
-      return acc;
-    },
-    { global: [], local: [] },
-  );
-  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-  return legacy ? { ...document, operations } : document;
-}
-
-export function migrateLegacyOperationSignature<A extends Action>(
-  operation: Operation<A>,
-): Operation<A> {
-  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-  if (!operation.context?.signer || operation.context.signer.signatures) {
-    return operation;
-  }
-  const { signer } = operation.context;
-  if ("signature" in signer) {
-    const signature = signer.signature as string | undefined;
-    return {
-      ...operation,
-      context: {
-        ...operation.context,
-        signer: {
-          user: signer.user,
-          app: signer.app,
-          signatures: signature?.length ? [signature] : [],
-        },
-      },
-    };
-  } else {
-    return operation;
-  }
-}

package/src/utils/run-asap.ts

@@ -1,156 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/no-namespace
-export namespace RunAsap {
-  export type Task<T = void> = () => T;
-  export type AbortTask = () => void;
-  export type RunAsap<T> = (task: Task<T>) => AbortTask;
-
-  export const useMessageChannel = (() => {
-    if (typeof MessageChannel === "undefined") {
-      return new Error("MessageChannel is not supported");
-    }
-
-    return (task: Task) => {
-      const controller = new AbortController();
-      const signal = controller.signal;
-      const mc = new MessageChannel();
-      mc.port1.postMessage(null);
-      mc.port2.addEventListener(
-        "message",
-        () => {
-          task();
-          mc.port1.close();
-          mc.port2.close();
-        },
-        { once: true, signal: signal },
-      );
-      mc.port2.start();
-      return () => controller.abort();
-    };
-  })();
-
-  export const usePostMessage = (() => {
-    const _main: unknown =
-      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-      (typeof window === "object" && window) ||
-      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-      (typeof global === "object" && global) ||
-      (typeof self === "object" && self);
-    if (!_main) {
-      return new Error("No global object found");
-    }
-
-    const main = _main as Window;
-    if (
-      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-      !main.postMessage ||
-      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-      !main.addEventListener ||
-      (main as { importScripts?: unknown }).importScripts // web workers can't this method
-    ) {
-      return new Error("postMessage is not supported");
-    }
-
-    let index = 0;
-    const tasks = new Map<number, Task>();
-
-    function getNewIndex() {
-      if (index === 9007199254740991) {
-        return 0;
-      }
-      return ++index;
-    }
-
-    const MESSAGE_PREFIX = "com.usePostMessage" + Math.random();
-
-    main.addEventListener(
-      "message",
-      (e) => {
-        const event = e as MessageEvent<string>;
-        if (typeof event.data !== "string") {
-          return;
-        }
-        if (event.source !== main || !event.data.startsWith(MESSAGE_PREFIX)) {
-          return;
-        }
-        const index = event.data.split(":").at(1);
-        if (index === undefined) {
-          return;
-        }
-        const i = +index;
-        const task = tasks.get(i);
-        if (task) {
-          task();
-          tasks.delete(i);
-        }
-      },
-      false,
-    );
-
-    return (task: Task) => {
-      const i = getNewIndex();
-      tasks.set(i, task);
-      main.postMessage(MESSAGE_PREFIX + ":" + i, { targetOrigin: "*" });
-      return () => {
-        tasks.delete(i);
-      };
-    };
-  })();
-
-  export const useSetImmediate = (() => {
-    if (typeof window !== "undefined") {
-      return new Error("setImmediate is not supported on the browser");
-    }
-    if (typeof setImmediate === "undefined") {
-      return new Error("setImmediate is not supported");
-    }
-
-    return (task: Task) => {
-      const id = setImmediate(task);
-      return () => clearImmediate(id);
-    };
-  })();
-
-  export const useSetTimeout = (() => {
-    return (task: Task) => {
-      const id = setTimeout(task, 0);
-      return () => clearTimeout(id);
-    };
-  })();
-
-  // queues the task in the macro tasks queue, so it doesn't
-  // prevent the event loop from movin on the next tick
-  export function runAsap<T = void>(task: Task<T>): AbortTask {
-    // if on node use setImmediate
-    if (!(useSetImmediate instanceof Error)) {
-      return useSetImmediate(task);
-    }
-    // on browser use MessageChannel if available
-    else if (!(useMessageChannel instanceof Error)) {
-      return useMessageChannel(task);
-    }
-    // otherwise use window.postMessage
-    else if (!(usePostMessage instanceof Error)) {
-      return usePostMessage(task);
-    }
-    // fallback to setTimeout with 0 delay
-    else {
-      return useSetTimeout(task);
-    }
-  }
-
-  export function runAsapAsync<T = void>(
-    task: RunAsap.Task<Promise<T>>,
-    queueMethod: RunAsap<void> = runAsap,
-  ): Promise<T> {
-    if (queueMethod instanceof Error) {
-      throw new Error("queueMethod is not supported", {
-        cause: queueMethod,
-      });
-    }
-    return new Promise((resolve, reject) => {
-      queueMethod(() => {
-        task().then(resolve).catch(reject);
-      });
-    });
-  }
-}