document-model 2.20.0 → 2.21.0

package/dist/browser/cjs/internal/object-C3OfcOUa.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"object-C3OfcOUa.js","sources":["../../../../src/document/object.ts"],"sourcesContent":["import { loadState, prune, redo, setName, undo } from \"./actions\";\nimport type { BaseAction } from \"./actions/types\";\nimport type { SignalDispatch } from \"./signal\";\nimport type {\n  Action,\n  AttachmentRef,\n  Document,\n  ExtendedState,\n  OperationScope,\n  Reducer,\n  ReducerOptions,\n} from \"./types\";\nimport { loadFromFile, readOnly, saveToFile } from \"./utils\";\n\n/**\n * This is an abstract class representing a document and provides methods\n * for creating and manipulating documents.\n * @typeparam T - The type of data stored in the document.\n * @typeparam A - The type of action the document can take.\n */\nexport abstract class BaseDocument<T, A extends Action, L = unknown> {\n  protected _document: Document<T, A, L>;\n  private _reducer: Reducer<T, A, L>;\n  private _signalDispatch?: SignalDispatch;\n\n  /**\n   * Constructs a BaseDocument instance with an initial state.\n   * @param reducer - The reducer function that updates the state.\n   * @param document - The initial state of the document.\n   */\n  constructor(\n    reducer: Reducer<T, A, L>,\n    document: Document<T, A, L>,\n    signalDispatch?: SignalDispatch,\n  ) {\n    this._reducer = reducer;\n    this._document = document;\n    this._signalDispatch = signalDispatch;\n  }\n\n  /**\n   * Dispatches an action to update the state of the document.\n   * @param action - The action to dispatch.\n   * @returns The Document instance.\n   */\n  protected dispatch(action: A | BaseAction, options?: ReducerOptions) {\n    this._document = this._reducer(\n      this._document,\n      action,\n      this._signalDispatch,\n      options,\n    );\n    return this;\n  }\n\n  /**\n   * Saves the state of the document to a file.\n   * @param path - The file path where the state should be saved.\n   * @param extension - The file extension to use when saving the state.\n   * @returns The file path where the state was saved.\n   */\n  protected saveToFile(path: string, extension: string, name?: string) {\n    return saveToFile(this._document, path, extension, name);\n  }\n\n  /**\n   * Loads the state of the document from a file.\n   * @param path - The file path where the state is stored.\n   */\n  async loadFromFile(path: string) {\n    this._document = await loadFromFile<T, A, L>(path, this._reducer);\n  }\n\n  /**\n   * Loads the state of the document from a file and returns it.\n   * @param path - The file path where the state is stored.\n   * @param reducer - The reducer function that updates the state.\n   * @returns The state of the document.\n   */\n  protected static async stateFromFile<T, A extends Action, L>(\n    path: string,\n    reducer: Reducer<T, A, L>,\n  ) {\n    const state = await loadFromFile<T, A, L>(path, reducer);\n    return state;\n  }\n\n  /**\n   *    Gets the current state of the document.\n   */\n  get state() {\n    return readOnly(this._document.state);\n  }\n\n  /**\n   *    Gets the list of operations performed on the document.\n   */\n  get operations() {\n    return readOnly(this._document.operations);\n  }\n\n  /**\n   * Gets the name of the document.\n   */\n  get name() {\n    return this._document.name;\n  }\n\n  /**\n   * Gets the type of document.\n   */\n  get documentType() {\n    return this._document.documentType;\n  }\n\n  /**\n   * Gets the timestamp of the date the document was created.\n   */\n  get created() {\n    return this._document.created;\n  }\n\n  /**\n   * Gets the timestamp of the date the document was last modified.\n   */\n  get lastModified() {\n    return this._document.lastModified;\n  }\n\n  /**\n   * Gets the global revision number of the document.\n   */\n  get revision() {\n    return this._document.revision.global;\n  }\n\n  getRevision(scope: OperationScope) {\n    return this._document.revision[scope];\n  }\n\n  /**\n   * Gets the initial state of the document.\n   */\n  get initialState() {\n    return readOnly(this._document.initialState);\n  }\n\n  /**\n   * Returns the current document as an object\n   */\n  public toDocument() {\n    return readOnly(this._document);\n  }\n\n  /**\n   * Gets the attachment associated with the given key.\n   * @param attachment - The key of the attachment to retrieve.\n   */\n  public getAttachment(attachment: AttachmentRef) {\n    return this._document.attachments[attachment];\n  }\n\n  /**\n   * Sets the name of the document.\n   * @param name - The new name of the document.\n   */\n  public setName(name: string) {\n    this.dispatch(setName(name));\n    return this;\n  }\n\n  /**\n   * Reverts a number of actions from the document.\n   * @param count - The number of actions to revert.\n   */\n  public undo(count: number) {\n    this.dispatch(undo(count));\n    return this;\n  }\n\n  /**\n   * Reapplies a number of actions to the document.\n   * @param count - The number of actions to reapply.\n   */\n  public redo(count: number) {\n    this.dispatch(redo(count));\n    return this;\n  }\n  /**\n   * Removes a range of operations from the document.\n   * @param start - The starting index of the range to remove.\n   * @param end - The ending index of the range to remove.\n   */\n  public prune(start?: number | undefined, end?: number | undefined) {\n    this.dispatch(prune(start, end));\n    return this;\n  }\n\n  /**\n   * Loads a document state and a set of operations.\n   * @param state - The state to load.\n   * @param operations - The operations to apply to the document.\n   */\n  public loadState(\n    state: Pick<ExtendedState<T, L>, \"state\" | \"name\">,\n    operations: number,\n  ) {\n    this.dispatch(loadState(state, operations));\n    return this;\n  }\n}\n/**\n * Applies multiple mixins to a base class.\n * Used to have separate mixins to group methods by actions.\n *\n * @remarks\n * {@link https://www.typescriptlang.org/docs/handbook/mixins.html#alternative-pattern}\n *\n * @param derivedCtor - The class to apply the mixins to.\n * @param constructors - The constructors of the mixins.\n */\n\nexport function applyMixins(derivedCtor: any, constructors: any[]) {\n  constructors.forEach((baseCtor) => {\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access\n    Object.getOwnPropertyNames(baseCtor.prototype).forEach((name) => {\n      Object.defineProperty(\n        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access\n        derivedCtor.prototype,\n        name,\n        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-member-access\n        Object.getOwnPropertyDescriptor(baseCtor.prototype, name) ||\n          Object.create(null),\n      );\n    });\n  });\n}\n"],"names":["saveToFile","loadFromFile","readOnly","setName","undo","redo","prune","loadState"],"mappings":";;;;;;AAoBO,MAAe,aAA+C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUnE,YACE,SACA,UACA,gBACA;AAbQ;AACF;AACA;AAYN,SAAK,WAAW;AAChB,SAAK,YAAY;AACjB,SAAK,kBAAkB;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQf,SAAS,QAAwB,SAA0B;AACnE,SAAK,YAAY,KAAK;AAAA,MACpB,KAAK;AAAA,MACL;AAAA,MACA,KAAK;AAAA,MACL;AAAA,IACF;AACO,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASC,WAAW,MAAc,WAAmB,MAAe;AACnE,WAAOA,SAAAA,WAAW,KAAK,WAAW,MAAM,WAAW,IAAI;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOzD,MAAM,aAAa,MAAc;AAC/B,SAAK,YAAY,MAAMC,SAAAA,aAAsB,MAAM,KAAK,QAAQ;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASlE,aAAuB,cACrB,MACA,SACA;AACA,UAAM,QAAQ,MAAMA,sBAAsB,MAAM,OAAO;AAChD,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMT,IAAI,QAAQ;AACH,WAAAC,kBAAS,KAAK,UAAU,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMtC,IAAI,aAAa;AACR,WAAAA,kBAAS,KAAK,UAAU,UAAU;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAM3C,IAAI,OAAO;AACT,WAAO,KAAK,UAAU;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMxB,IAAI,eAAe;AACjB,WAAO,KAAK,UAAU;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMxB,IAAI,UAAU;AACZ,WAAO,KAAK,UAAU;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMxB,IAAI,eAAe;AACjB,WAAO,KAAK,UAAU;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMxB,IAAI,WAAW;AACN,WAAA,KAAK,UAAU,SAAS;AAAA,EAAA;AAAA,EAGjC,YAAY,OAAuB;AAC1B,WAAA,KAAK,UAAU,SAAS,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMtC,IAAI,eAAe;AACV,WAAAA,kBAAS,KAAK,UAAU,YAAY;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMtC,aAAa;AACX,WAAAA,SAAA,SAAS,KAAK,SAAS;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOzB,cAAc,YAA2B;AACvC,WAAA,KAAK,UAAU,YAAY,UAAU;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOvC,QAAQ,MAAc;AACtB,SAAA,SAASC,iBAAQ,IAAI,CAAC;AACpB,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOF,KAAK,OAAe;AACpB,SAAA,SAASC,cAAK,KAAK,CAAC;AAClB,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOF,KAAK,OAAe;AACpB,SAAA,SAASC,cAAK,KAAK,CAAC;AAClB,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOF,MAAM,OAA4B,KAA0B;AACjE,SAAK,SAASC,SAAAA,MAAM,OAAO,GAAG,CAAC;AACxB,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQF,UACL,OACA,YACA;AACA,SAAK,SAASC,SAAAA,UAAU,OAAO,UAAU,CAAC;AACnC,WAAA;AAAA,EAAA;AAEX;AAYgB,SAAA,YAAY,aAAkB,cAAqB;AACpD,eAAA,QAAQ,CAAC,aAAa;AAEjC,WAAO,oBAAoB,SAAS,SAAS,EAAE,QAAQ,CAAC,SAAS;AACxD,aAAA;AAAA;AAAA,QAEL,YAAY;AAAA,QACZ;AAAA;AAAA,QAEA,OAAO,yBAAyB,SAAS,WAAW,IAAI,KACtD,uBAAO,OAAO,IAAI;AAAA,MACtB;AAAA,IAAA,CACD;AAAA,EAAA,CACF;AACH;;;"}

package/dist/browser/cjs/package.json

@@ -1 +0,0 @@
-{"type":"commonjs"}

package/dist/browser/cjs/utils.js

@@ -1,44 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const creators = require("./internal/creators-DJg3Kd1P.js");
-exports.InvalidActionInputError = creators.InvalidActionInputError;
-exports.InvalidActionInputZodError = creators.InvalidActionInputZodError;
-exports.ab2hex = creators.ab2hex;
-exports.buildOperationSignature = creators.buildOperationSignature;
-exports.buildOperationSignatureMessage = creators.buildOperationSignatureMessage;
-exports.buildOperationSignatureParams = creators.buildOperationSignatureParams;
-exports.buildSignedOperation = creators.buildSignedOperation;
-exports.createAction = creators.createAction;
-exports.createDocument = creators.createDocument;
-exports.createExtendedState = creators.createExtendedState;
-exports.createReducer = creators.createReducer;
-exports.createUnsafeReducer = creators.createUnsafeReducer;
-exports.createZip = creators.createZip;
-exports.documentHelpers = creators.documentHelpers;
-exports.generateId = creators.generateId;
-exports.getDocumentLastModified = creators.getDocumentLastModified;
-exports.getLocalFile = creators.getLocalFile;
-exports.getRemoteFile = creators.getRemoteFile;
-exports.getUnixTimestamp = creators.getUnixTimestamp;
-exports.hashDocument = creators.hashDocument;
-exports.hashKey = creators.hashKey;
-exports.hex2ab = creators.hex2ab;
-exports.isBaseAction = creators.isBaseAction;
-exports.isNoopOperation = creators.isNoopOperation;
-exports.isSameDocument = creators.isSameDocument;
-exports.isUndo = creators.isUndo;
-exports.isUndoRedo = creators.isUndoRedo;
-exports.loadFromFile = creators.loadFromFile;
-exports.loadFromInput = creators.loadFromInput;
-exports.mapSkippedOperations = creators.mapSkippedOperations;
-exports.parseResultingState = creators.parseResultingState;
-exports.readOnly = creators.readOnly;
-exports.replayDocument = creators.replayDocument;
-exports.replayOperations = creators.replayOperations;
-exports.saveToFile = creators.saveToFile;
-exports.saveToFileHandle = creators.saveToFileHandle;
-exports.sortMappedOperations = creators.sortMappedOperations;
-exports.sortOperations = creators.sortOperations;
-exports.validateOperations = creators.validateOperations;
-exports.verifyOperationSignature = creators.verifyOperationSignature;
-//# sourceMappingURL=utils.js.map

package/dist/browser/cjs/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/browser/document-model.d.ts

@@ -1,2 +0,0 @@
-export * from './src/document-model/index'
-export {}

package/dist/browser/document.d.ts

@@ -1,2 +0,0 @@
-export * from './src/document/index'
-export {}

package/dist/browser/es/document-model.js

@@ -1,21 +0,0 @@
-import "./internal/creators-Dir4K_-h.js";
-import "mutative";
-import "zod";
-import "jszip";
-import { b, a, c, d, m, r, u, v, g, h, f, e, z } from "./internal/index-HlkIVQZ6.js";
-export {
-  b as Document,
-  a as DocumentModel,
-  c as actions,
-  d as documentModel,
-  m as module,
-  r as reducer,
-  u as utils,
-  v as validateInitialState,
-  g as validateModule,
-  h as validateModuleOperation,
-  f as validateModules,
-  e as validateStateSchemaName,
-  z
-};
-//# sourceMappingURL=document-model.js.map

package/dist/browser/es/document-model.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"document-model.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;"}

package/dist/browser/es/document.js

@@ -1,16 +0,0 @@
-import { B, g, m, p, u, h, z } from "./internal/creators-Dir4K_-h.js";
-import { B as B2, a } from "./internal/object-CzFSgK3q.js";
-import { i } from "./internal/index-BxCiP58y.js";
-export {
-  B2 as BaseDocument,
-  B as actions,
-  a as applyMixins,
-  g as baseReducer,
-  m as mutableBaseReducer,
-  p as processUndoRedo,
-  u as updateDocument,
-  h as updateHeader,
-  i as utils,
-  z
-};
-//# sourceMappingURL=document.js.map

package/dist/browser/es/document.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"document.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;"}

package/dist/browser/es/index.js

@@ -1,14 +0,0 @@
-import { D as Document } from "./internal/index-qYp7hG3r.js";
-import { D as DocumentModel } from "./internal/index-HlkIVQZ6.js";
-const DocumentModels = {
-  "powerhouse/document": Document,
-  "powerhouse/document-model": DocumentModel
-};
-const index = { Document, DocumentModel };
-export {
-  Document,
-  DocumentModel,
-  DocumentModels,
-  index as default
-};
-//# sourceMappingURL=index.js.map

package/dist/browser/es/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sources":["../../../src/index.ts"],"sourcesContent":["import * as Document from \"./document\";\nimport * as DocumentModel from \"./document-model\";\n\n/**\n * This module exports all the public types, functions, and objects\n * from the document module. It provides an easy-to-use interface\n * for managing documents, and can be used in any Redux-based\n * application. This module exports:\n * - All action creators for the base document actions.\n * - The Document object, which is used to for creating and\n * manipulating documents in an object-oriented way.\n * - The baseReducer function, which is a reducer for managing\n * documents\n * - Various utility functions to be used by Document Models.\n */\nexport { Document, DocumentModel };\n\nexport const DocumentModels = {\n  \"powerhouse/document\": Document,\n  \"powerhouse/document-model\": DocumentModel,\n};\n\nexport default { Document, DocumentModel };\n"],"names":[],"mappings":";;AAiBO,MAAM,iBAAiB;AAAA,EAC5B,uBAAuB;AAAA,EACvB,6BAA6B;AAC/B;AAEA,MAAA,QAAe,EAAE,UAAU,cAAc;"}