@powerhousedao/shared 6.0.0-dev.47

package/README.md

@@ -0,0 +1,15 @@
+# Shared code for the Powerhouse monorepo
+
+This directory is an npm package which is intended for sharing code across packages in the monorepo.
+
+This package is excluded from the release workflow and is never intended to be published ("private": true) in package.json.
+
+It also doesn't define anything in the "files" field of the `package.json` for the same reason.
+
+This package should **never depend on any other package in this monorepo**. We want to be able to use the code kept here in any of the other monorepo packages without circular imports.
+
+This is a great place to put your:
+
+- simple constants you want to be able to use anywhere
+- base types you want to share easily (**not** derived types that require imports from elsewhere)
+- simple utility functions that **do not depend on code from elsewhere in the monorepo**

package/dist/document-model/core/actions.d.ts

@@ -0,0 +1,62 @@
+import type { ActionSigner } from "./signatures.js";
+/**
+ * The context of an action.
+ */
+export type ActionContext = {
+    /** The index of the previous operation, showing intended ordering. */
+    prevOpIndex?: number;
+    /** The hash of the previous operation, showing intended state. */
+    prevOpHash?: string;
+    /** A nonce, to cover specific signing attacks and to prevent replay attacks from no-ops. */
+    nonce?: string;
+    /** The signer of the action. */
+    signer?: ActionSigner;
+};
+/**
+ * Defines the basic structure of an action.
+ */
+export type Action = {
+    /** The id of the action. This is distinct from the operation id. */
+    id: string;
+    /** The name of the action. */
+    type: string;
+    /** The timestamp of the action. */
+    timestampUtcMs: string;
+    /** The payload of the action. */
+    input: unknown;
+    /** The scope of the action */
+    scope: string;
+    /**
+     * The attachments included in the action.
+     *
+     * This will be refactored in a future release.
+     */
+    attachments?: AttachmentInput[];
+    /** The context of the action. */
+    context?: ActionContext;
+};
+/**
+ * The attributes stored for a file. Namely, attachments of a document.
+ */
+export type Attachment = {
+    /** The binary data of the attachment in Base64 */
+    data: string;
+    /** The MIME type of the attachment */
+    mimeType: string;
+    extension?: string | null;
+    fileName?: string | null;
+};
+export type AttachmentInput = Attachment & {
+    hash: string;
+};
+export type ActionWithAttachment = Action & {
+    attachments: AttachmentInput[];
+};
+/**
+ * String type representing an attachment in a Document.
+ *
+ * @remarks
+ * Attachment string is formatted as `attachment://<filename>`.
+ */
+export type AttachmentRef = string;
+//# sourceMappingURL=actions.d.ts.map

package/dist/document-model/core/actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../../document-model/core/actions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,sEAAsE;IACtE,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,kEAAkE;IAClE,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,4FAA4F;IAC5F,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,gCAAgC;IAChC,MAAM,CAAC,EAAE,YAAY,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,oEAAoE;IACpE,EAAE,EAAE,MAAM,CAAC;IAEX,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;IAEb,mCAAmC;IACnC,cAAc,EAAE,MAAM,CAAC;IAEvB,iCAAiC;IACjC,KAAK,EAAE,OAAO,CAAC;IAEf,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,WAAW,CAAC,EAAE,eAAe,EAAE,CAAC;IAEhC,iCAAiC;IACjC,OAAO,CAAC,EAAE,aAAa,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,kDAAkD;IAClD,IAAI,EAAE,MAAM,CAAC;IAEb,sCAAsC;IACtC,QAAQ,EAAE,MAAM,CAAC;IAGjB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAG1B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,UAAU,GAAG;IACzC,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG;IAC1C,WAAW,EAAE,eAAe,EAAE,CAAC;CAChC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC"}

package/dist/document-model/core/actions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=actions.js.map

package/dist/document-model/core/actions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.js","sourceRoot":"","sources":["../../../document-model/core/actions.ts"],"names":[],"mappings":""}

package/dist/document-model/core/constants.d.ts

@@ -0,0 +1,6 @@
+export declare const HASH_ALGORITHM_SHA1 = "sha1";
+export declare const HASH_ALGORITHM_SHA256 = "sha256";
+export declare const HASH_ALGORITHM_SHA512 = "sha512";
+export declare const HASH_ENCODING_BASE64 = "base64";
+export declare const HASH_ENCODING_HEX = "hex";
+//# sourceMappingURL=constants.d.ts.map

package/dist/document-model/core/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../document-model/core/constants.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,mBAAmB,SAAS,CAAC;AAC1C,eAAO,MAAM,qBAAqB,WAAW,CAAC;AAC9C,eAAO,MAAM,qBAAqB,WAAW,CAAC;AAG9C,eAAO,MAAM,oBAAoB,WAAW,CAAC;AAC7C,eAAO,MAAM,iBAAiB,QAAQ,CAAC"}

package/dist/document-model/core/constants.js

@@ -0,0 +1,8 @@
+// Known hash algorithms (can be extended without breaking changes)
+export const HASH_ALGORITHM_SHA1 = "sha1";
+export const HASH_ALGORITHM_SHA256 = "sha256";
+export const HASH_ALGORITHM_SHA512 = "sha512";
+// Known encodings (can be extended without breaking changes)
+export const HASH_ENCODING_BASE64 = "base64";
+export const HASH_ENCODING_HEX = "hex";
+//# sourceMappingURL=constants.js.map

package/dist/document-model/core/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../document-model/core/constants.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,MAAM,CAAC,MAAM,mBAAmB,GAAG,MAAM,CAAC;AAC1C,MAAM,CAAC,MAAM,qBAAqB,GAAG,QAAQ,CAAC;AAC9C,MAAM,CAAC,MAAM,qBAAqB,GAAG,QAAQ,CAAC;AAE9C,6DAA6D;AAC7D,MAAM,CAAC,MAAM,oBAAoB,GAAG,QAAQ,CAAC;AAC7C,MAAM,CAAC,MAAM,iBAAiB,GAAG,KAAK,CAAC"}

package/dist/document-model/core/documents.d.ts

@@ -0,0 +1,102 @@
+import type { DocumentOperations, Operation } from "./operations.js";
+import type { PHDocumentSignatureInfo } from "./signatures.js";
+import type { PHBaseState } from "./state.js";
+/** Meta information about the document. */
+export type PHDocumentMeta = {
+    /** The preferred editor for the document. */
+    preferredEditor?: string;
+};
+/**
+ * The header of a document.
+ */
+export type PHDocumentHeader = {
+    /**
+     * The id of the document.
+     *
+     * This is a Ed25519 signature and is immutable.
+     **/
+    id: string;
+    /**
+     * Information to verify the document creator.
+     *
+     * This is immutable.
+     **/
+    sig: PHDocumentSignatureInfo;
+    /**
+     * The type of the document.
+     *
+     * This is used as part of the signature payload and thus, cannot be changed
+     * after the document header has been created.
+     **/
+    documentType: string;
+    /**
+     * The timestamp of the creation date of the document, in UTC ISO format.
+     *
+     * This is used as part of the signature payload and thus, cannot be changed
+     * after the document header has been created.
+     **/
+    createdAtUtcIso: string;
+    /** The slug of the document. */
+    slug: string;
+    /** The name of the document. */
+    name: string;
+    /** The branch of this document. */
+    branch: string;
+    /**
+     * The revision of each scope of the document. This object is updated every
+     * time any _other_ scope is updated.
+     */
+    revision: {
+        [scope: string]: number;
+    };
+    /**
+     * The timestamp of the last change in the document, in UTC ISO format.
+     **/
+    lastModifiedAtUtcIso: string;
+    /**
+     * This is a map from protocol name to version. A protocol can be any set of
+     * rules that are applied to the document.
+     *
+     * Examples of protocols include:
+     *
+     * - "base-reducer"
+     */
+    protocolVersions?: {
+        [key: string]: number;
+    };
+    /** Meta information about the document. */
+    meta?: PHDocumentMeta;
+};
+/**
+ * The base type of a document model.
+ *
+ * @remarks
+ * This type is extended by all Document models.
+ *
+ * @typeParam TState - The type of the document state.
+ */
+export type PHDocument<TState extends PHBaseState = PHBaseState> = {
+    /** The header of the document. */
+    header: PHDocumentHeader;
+    /** The document model specific state. */
+    state: TState;
+    /**
+     * The initial state of the document, enabling replaying operations.
+     *
+     * This will be removed in a future release.
+     */
+    initialState: TState;
+    /**
+     * The operations history of the document.
+     *
+     * This will be removed in a future release.
+     */
+    operations: DocumentOperations;
+    /**
+     * A list of undone operations
+     *
+     * This will be removed in a future release.
+     */
+    clipboard: Operation[];
+};
+//# sourceMappingURL=documents.d.ts.map

package/dist/document-model/core/documents.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"documents.d.ts","sourceRoot":"","sources":["../../../document-model/core/documents.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACrE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,iBAAiB,CAAC;AAC/D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C,2CAA2C;AAC3C,MAAM,MAAM,cAAc,GAAG;IAC3B,6CAA6C;IAC7C,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;;;QAII;IACJ,EAAE,EAAE,MAAM,CAAC;IAEX;;;;QAII;IACJ,GAAG,EAAE,uBAAuB,CAAC;IAE7B;;;;;QAKI;IACJ,YAAY,EAAE,MAAM,CAAC;IAErB;;;;;QAKI;IACJ,eAAe,EAAE,MAAM,CAAC;IAExB,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IAEb,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IAEb,mCAAmC;IACnC,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,QAAQ,EAAE;QACR,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;KACzB,CAAC;IAEF;;QAEI;IACJ,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;;;;;;OAOG;IACH,gBAAgB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAE7C,2CAA2C;IAC3C,IAAI,CAAC,EAAE,cAAc,CAAC;CACvB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,UAAU,CAAC,MAAM,SAAS,WAAW,GAAG,WAAW,IAAI;IACjE,kCAAkC;IAClC,MAAM,EAAE,gBAAgB,CAAC;IAEzB,yCAAyC;IACzC,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,UAAU,EAAE,kBAAkB,CAAC;IAE/B;;;;OAIG;IACH,SAAS,EAAE,SAAS,EAAE,CAAC;CACxB,CAAC"}

package/dist/document-model/core/documents.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=documents.js.map

package/dist/document-model/core/documents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documents.js","sourceRoot":"","sources":["../../../document-model/core/documents.ts"],"names":[],"mappings":""}

package/dist/document-model/core/operations.d.ts

@@ -0,0 +1,74 @@
+import type { Action } from "./actions.js";
+/**
+ * An operation that was applied to a {@link BaseDocument}.
+ *
+ * @remarks
+ * Wraps an action with an index, to be added to the operations history of a Document.
+ * The `index` field is used to keep all operations in order and enable replaying the
+ * document's history from the beginning. Note that indices and skips are relative to
+ * a specific reactor. Example below:
+ *
+ * For (index, skip, ts, action)
+ * A - [(0, 0, 1, "A0"), (1, 0, 2, "A1")]
+ * B - [(0, 0, 0, "B0"), (1, 0, 3, "B1")]
+ * ...
+ * B gets A's Operations Scenario:
+ * B' - [(0, 0, 0, "B0"), (1, 0, 3, "B1"), (2, 1, 1, "A0"), (3, 0, 2, "A1"), (4, 0, 3, "B1")]
+ * Then A needs to end up with:
+ * A' - [(0, 0, 1, "A0"), (1, 0, 2, "A1"), (2, 2, 0, "B0"), (3, 0, 1, "A0"), (4, 0, 2, "A1"), (5, 0, 3, "B1")]
+ * So that both A and B end up with the stream of actions (action):
+ * [("B0"), ("A0"), ("A1"), ("B1")]
+ *
+ * @typeParam A - The type of the action.
+ */
+export type Operation = {
+    /**
+     * This is a stable id, derived from various document and action properties
+     * in deriveOperationId().
+     *
+     * It _cannot_ be an arbitrary string.
+     *
+     * It it also not unique per operation, as reshuffled operations will keep'
+     * the same id they had before they were reshuffled. This means that the
+     * IOperationStore may have multiple operations with the same operation id.
+     **/
+    id: string;
+    /** Position of the operation in the history. This is relative to a specific reactor -- they may not all agree on this value. */
+    index: number;
+    /** The number of operations skipped with this Operation. This is relative to a specific reactor -- they may not all agree on this value. */
+    skip: number;
+    /** Timestamp of when the operation was added */
+    timestampUtcMs: string;
+    /** Hash of the resulting document data after the operation */
+    hash: string;
+    /** Error message for a failed action */
+    error?: string;
+    /** The resulting state after the operation */
+    resultingState?: string;
+    /**
+     * The action that was applied to the document to produce this operation.
+     */
+    action: Action;
+};
+/**
+ * The operations history of the document by scope.
+ *
+ * This will be removed in a future release.
+ *
+ * TODO: Type should be Partial<Record<string, Operation[]>>,
+ * but that is a breaking change for codegen + external doc models.
+ */
+export type DocumentOperations = Record<string, Operation[]>;
+export type OperationContext = {
+    documentId: string;
+    documentType: string;
+    scope: string;
+    branch: string;
+    resultingState?: string;
+    ordinal: number;
+};
+export type OperationWithContext = {
+    operation: Operation;
+    context: OperationContext;
+};
+//# sourceMappingURL=operations.d.ts.map

package/dist/document-model/core/operations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"operations.d.ts","sourceRoot":"","sources":["../../../document-model/core/operations.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB;;;;;;;;;QASI;IACJ,EAAE,EAAE,MAAM,CAAC;IAEX,gIAAgI;IAChI,KAAK,EAAE,MAAM,CAAC;IAEd,4IAA4I;IAC5I,IAAI,EAAE,MAAM,CAAC;IAEb,gDAAgD;IAChD,cAAc,EAAE,MAAM,CAAC;IAEvB,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAC;IAEb,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,8CAA8C;IAC9C,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;AAE7D,MAAM,MAAM,gBAAgB,GAAG;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,MAAM,CAAC;IAGxB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,SAAS,EAAE,SAAS,CAAC;IACrB,OAAO,EAAE,gBAAgB,CAAC;CAC3B,CAAC"}

package/dist/document-model/core/operations.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=operations.js.map

package/dist/document-model/core/operations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operations.js","sourceRoot":"","sources":["../../../document-model/core/operations.ts"],"names":[],"mappings":""}

package/dist/document-model/core/ph-types.d.ts

@@ -0,0 +1,7 @@
+export type * from "./actions.js";
+export type * from "./documents.js";
+export type * from "./operations.js";
+export type * from "./signatures.js";
+export type * from "./state.js";
+export type * from "./upgrades.js";
+//# sourceMappingURL=ph-types.d.ts.map

package/dist/document-model/core/ph-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ph-types.d.ts","sourceRoot":"","sources":["../../../document-model/core/ph-types.ts"],"names":[],"mappings":"AAOA,mBAAmB,cAAc,CAAC;AAClC,mBAAmB,gBAAgB,CAAC;AACpC,mBAAmB,iBAAiB,CAAC;AACrC,mBAAmB,iBAAiB,CAAC;AACrC,mBAAmB,YAAY,CAAC;AAChC,mBAAmB,eAAe,CAAC"}

package/dist/document-model/core/ph-types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ph-types.js.map

package/dist/document-model/core/ph-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ph-types.js","sourceRoot":"","sources":["../../../document-model/core/ph-types.ts"],"names":[],"mappings":""}

package/dist/document-model/core/signatures.d.ts

@@ -0,0 +1,52 @@
+/**
+ * A signature of an action.
+ *
+ * This will be refactored in a future release.
+ */
+export type Signature = [string, string, string, string, string];
+/**
+ * A user action signer.
+ */
+export type UserActionSigner = {
+    address: string;
+    networkId: string;
+    chainId: number;
+};
+/**
+ * An app action signer.
+ */
+export type AppActionSigner = {
+    name: string;
+    key: string;
+};
+/**
+ * An action signer.
+ */
+export type ActionSigner = {
+    user: UserActionSigner;
+    app: AppActionSigner;
+    signatures: Signature[];
+};
+/**
+ * Information to verify the document creator.
+ */
+export type PHDocumentSignatureInfo = {
+    /**
+     * The public key of the document creator.
+     **/
+    publicKey: JsonWebKey;
+    /** The nonce that was appended to the message to create the signature. */
+    nonce: string;
+};
+/**
+ * Configuration for hashing document state in operations.
+ */
+export type HashConfig = {
+    /** The hashing algorithm to use (e.g., "sha1", "sha256") */
+    algorithm: string;
+    /** The encoding format for the hash output (e.g., "base64", "hex") */
+    encoding: string;
+    /** Optional algorithm-specific parameters */
+    params?: Record<string, unknown>;
+};
+//# sourceMappingURL=signatures.d.ts.map

package/dist/document-model/core/signatures.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signatures.d.ts","sourceRoot":"","sources":["../../../document-model/core/signatures.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAOH,MAAM,MAAM,SAAS,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,gBAAgB,CAAC;IACvB,GAAG,EAAE,eAAe,CAAC;IACrB,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;QAEI;IACJ,SAAS,EAAE,UAAU,CAAC;IAEtB,0EAA0E;IAC1E,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,4DAA4D;IAC5D,SAAS,EAAE,MAAM,CAAC;IAElB,sEAAsE;IACtE,QAAQ,EAAE,MAAM,CAAC;IAEjB,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC,CAAC"}

package/dist/document-model/core/signatures.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=signatures.js.map

package/dist/document-model/core/signatures.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"signatures.js","sourceRoot":"","sources":["../../../document-model/core/signatures.ts"],"names":[],"mappings":""}

package/dist/document-model/core/state.d.ts

@@ -0,0 +1,38 @@
+import type { HashConfig } from "./signatures.js";
+/**
+ * The document state of the document.
+ */
+export type PHDocumentState = {
+    /**
+     * The current document model schema version of the document. This is used
+     * with the UPGRADE_DOCUMENT operation to specify the DocumentModelModule
+     * version to use for reducer execution.
+     */
+    version: number;
+    /** Hash configuration for operation state verification */
+    hash: HashConfig;
+    /** True if and only if the document has been deleted */
+    isDeleted?: boolean;
+    /** The timestamp when the document was deleted, in UTC ISO format */
+    deletedAtUtcIso?: string;
+    /** Optional: who deleted the document */
+    deletedBy?: string;
+    /** Optional: reason for deletion */
+    deletionReason?: string;
+};
+/**
+ * The authentication state of the document.
+ *
+ * This has yet to be implemented.
+ */
+export type PHAuthState = {};
+/**
+ * The base state of the document.
+ */
+export type PHBaseState = {
+    /** Carries authentication information. */
+    auth: PHAuthState;
+    /** Carries information about the document. */
+    document: PHDocumentState;
+};
+//# sourceMappingURL=state.d.ts.map

package/dist/document-model/core/state.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../../../document-model/core/state.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAElD;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB,0DAA0D;IAC1D,IAAI,EAAE,UAAU,CAAC;IAEjB,wDAAwD;IACxD,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,qEAAqE;IACrE,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,yCAAyC;IACzC,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,oCAAoC;IACpC,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,EAAE,CAAC;AAE7B;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,0CAA0C;IAC1C,IAAI,EAAE,WAAW,CAAC;IAElB,8CAA8C;IAC9C,QAAQ,EAAE,eAAe,CAAC;CAC3B,CAAC"}

package/dist/document-model/core/state.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=state.js.map

package/dist/document-model/core/state.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.js","sourceRoot":"","sources":["../../../document-model/core/state.ts"],"names":[],"mappings":""}