@fluid-experimental/tree 0.58.2002 → 0.59.1000

package/lib/Transaction.js

@@ -0,0 +1,68 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { EditStatus } from './persisted-types';
+import { newEditId } from './EditUtilities';
+import { GenericTransaction, TransactionInternal } from './TransactionInternal';
+import { CachingLogViewer } from './LogViewer';
+/**
+ * Buffers changes to be applied to an isolated view of a `SharedTree` over time before applying them directly to the tree itself as a
+ * single edit
+ */
+export class Transaction {
+    /**
+     * Create a new transaction over the given tree. The tree's `currentView` at this time will become the `startingView` for this
+     * transaction.
+     * @param tree - the `SharedTree` that this transaction applies changes to
+     */
+    constructor(tree) {
+        this.tree = tree;
+        const { currentView } = tree;
+        this.transaction = new GenericTransaction(currentView, new TransactionInternal.Policy());
+        this.startingView = currentView;
+    }
+    /**
+     * True if this transaction is open, false if it is closed. A transaction may be closed manually via `closeAndApplyEdit()`, or may
+     * be automatically closed by a change in this transaction failing to apply (see `applyChange()`).
+     */
+    get isOpen() {
+        return this.transaction.isOpen && this.status === EditStatus.Applied;
+    }
+    /**
+     * The status of the most recently applied change in this transaction
+     */
+    get status() {
+        return this.transaction.status;
+    }
+    /**
+     * The state of the tree following the most change that was successfully applied. If no changes have been applied, this is the same as
+     * `startingView`.
+     */
+    get currentView() {
+        return this.transaction.view;
+    }
+    apply(headOrChanges, ...tail) {
+        if (this.isOpen) {
+            const changes = Array.isArray(headOrChanges) ? headOrChanges : [headOrChanges, ...tail];
+            this.transaction.applyChanges(changes.map((c) => this.tree.internalizeChange(c)));
+        }
+        return this.status;
+    }
+    /**
+     * Close this transaction and apply its changes to the `SharedTree`. If this transaction is already closed, this method has no effect.
+     */
+    closeAndCommit() {
+        if (this.isOpen) {
+            if (this.transaction.changes.length > 0) {
+                const edit = { id: newEditId(), changes: this.transaction.changes };
+                const result = this.transaction.close();
+                if (this.tree.editsInternal instanceof CachingLogViewer) {
+                    this.tree.editsInternal.setKnownEditingResult(edit, result);
+                }
+                this.tree.applyEditInternal(edit);
+            }
+        }
+    }
+}
+//# sourceMappingURL=Transaction.js.map

package/lib/Transaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Transaction.js","sourceRoot":"","sources":["../src/Transaction.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAwB,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAI5C,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAChF,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/C;;;GAGG;AACH,MAAM,OAAO,WAAW;IAKvB;;;;OAIG;IACH,YAAmC,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;QAClD,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;QAC7B,IAAI,CAAC,WAAW,GAAG,IAAI,kBAAkB,CAAC,WAAW,EAAE,IAAI,mBAAmB,CAAC,MAAM,EAAE,CAAC,CAAC;QACzF,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IACjC,CAAC;IAED;;;OAGG;IACH,IAAW,MAAM;QAChB,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,KAAK,UAAU,CAAC,OAAO,CAAC;IACtE,CAAC;IAED;;OAEG;IACH,IAAW,MAAM;QAChB,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC;IAChC,CAAC;IAED;;;OAGG;IACH,IAAW,WAAW;QACrB,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IAC9B,CAAC;IAWM,KAAK,CAAC,aAAgC,EAAE,GAAG,IAAc;QAC/D,IAAI,IAAI,CAAC,MAAM,EAAE;YAChB,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,GAAG,IAAI,CAAC,CAAC;YACxF,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SAClF;QACD,OAAO,IAAI,CAAC,MAAM,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,cAAc;QACpB,IAAI,IAAI,CAAC,MAAM,EAAE;YAChB,IAAI,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;gBACxC,MAAM,IAAI,GAAyB,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;gBAC1F,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;gBACxC,IAAI,IAAI,CAAC,IAAI,CAAC,aAAa,YAAY,gBAAgB,EAAE;oBACxD,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,qBAAqB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;iBAC5D;gBACD,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;aAClC;SACD;IACF,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ChangeInternal, Edit, EditStatus } from './persisted-types';\nimport { newEditId } from './EditUtilities';\nimport { TreeView } from './TreeView';\nimport { Change } from './ChangeTypes';\nimport { SharedTree } from './SharedTree';\nimport { GenericTransaction, TransactionInternal } from './TransactionInternal';\nimport { CachingLogViewer } from './LogViewer';\n\n/**\n * Buffers changes to be applied to an isolated view of a `SharedTree` over time before applying them directly to the tree itself as a\n * single edit\n */\nexport class Transaction {\n\t/** The view of the tree when this transaction was created */\n\tpublic readonly startingView: TreeView;\n\tprivate readonly transaction: GenericTransaction;\n\n\t/**\n\t * Create a new transaction over the given tree. The tree's `currentView` at this time will become the `startingView` for this\n\t * transaction.\n\t * @param tree - the `SharedTree` that this transaction applies changes to\n\t */\n\tpublic constructor(public readonly tree: SharedTree) {\n\t\tconst { currentView } = tree;\n\t\tthis.transaction = new GenericTransaction(currentView, new TransactionInternal.Policy());\n\t\tthis.startingView = currentView;\n\t}\n\n\t/**\n\t * True if this transaction is open, false if it is closed. A transaction may be closed manually via `closeAndApplyEdit()`, or may\n\t * be automatically closed by a change in this transaction failing to apply (see `applyChange()`).\n\t */\n\tpublic get isOpen(): boolean {\n\t\treturn this.transaction.isOpen && this.status === EditStatus.Applied;\n\t}\n\n\t/**\n\t * The status of the most recently applied change in this transaction\n\t */\n\tpublic get status(): EditStatus {\n\t\treturn this.transaction.status;\n\t}\n\n\t/**\n\t * The state of the tree following the most change that was successfully applied. If no changes have been applied, this is the same as\n\t * `startingView`.\n\t */\n\tpublic get currentView(): TreeView {\n\t\treturn this.transaction.view;\n\t}\n\n\t/**\n\t * Attempt to apply a sequence of changes in this transaction. The `currentView` will be updated to reflect the new tree state after all\n\t * applied changes. If any change fails to apply, the remaining changes will be ignored and this transaction will be automatically\n\t * closed (see `isOpen`). If this transaction is already closed, this method has no effect.\n\t * @param changes - the changes to apply\n\t * @returns either the `EditStatus` of the given changes or the `EditStatus` of the last change before the transaction was closed\n\t */\n\tpublic apply(...changes: Change[]): EditStatus;\n\tpublic apply(changes: Change[]): EditStatus;\n\tpublic apply(headOrChanges: Change | Change[], ...tail: Change[]): EditStatus {\n\t\tif (this.isOpen) {\n\t\t\tconst changes = Array.isArray(headOrChanges) ? headOrChanges : [headOrChanges, ...tail];\n\t\t\tthis.transaction.applyChanges(changes.map((c) => this.tree.internalizeChange(c)));\n\t\t}\n\t\treturn this.status;\n\t}\n\n\t/**\n\t * Close this transaction and apply its changes to the `SharedTree`. If this transaction is already closed, this method has no effect.\n\t */\n\tpublic closeAndCommit(): void {\n\t\tif (this.isOpen) {\n\t\t\tif (this.transaction.changes.length > 0) {\n\t\t\t\tconst edit: Edit<ChangeInternal> = { id: newEditId(), changes: this.transaction.changes };\n\t\t\t\tconst result = this.transaction.close();\n\t\t\t\tif (this.tree.editsInternal instanceof CachingLogViewer) {\n\t\t\t\t\tthis.tree.editsInternal.setKnownEditingResult(edit, result);\n\t\t\t\t}\n\t\t\t\tthis.tree.applyEditInternal(edit);\n\t\t\t}\n\t\t}\n\t}\n}\n"]}

package/lib/TransactionInternal.d.ts

@@ -0,0 +1,540 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { Result } from './Common';
+import { NodeId, DetachedSequenceId, TraitLabel } from './Identifiers';
+import { BuildNodeInternal, ChangeInternal, ConstraintInternal, EditStatus, StablePlaceInternal, StableRangeInternal } from './persisted-types';
+import { BadPlaceValidationResult, BadRangeValidationResult } from './EditUtilities';
+import { RevisionView, TransactionView } from './RevisionView';
+import { ReconciliationChange, ReconciliationPath } from './ReconciliationPath';
+import { TreeViewNode } from './TreeView';
+/**
+ * Result of applying a transaction.
+ * @public
+ */
+export declare type EditingResult = FailedEditingResult | ValidEditingResult;
+/**
+ * Basic result of applying a transaction.
+ * @public
+ */
+export interface EditingResultBase {
+    /**
+     * The final status of the transaction.
+     */
+    readonly status: EditStatus;
+    /**
+     * The valid changes applied as part of the transaction.
+     */
+    readonly changes: readonly ChangeInternal[];
+    /**
+     * The editing steps applied as part of the transaction.
+     */
+    readonly steps: readonly ReconciliationChange[];
+    /**
+     * The revision preceding the transaction.
+     */
+    readonly before: RevisionView;
+}
+/**
+ * Result of applying an invalid or malformed transaction.
+ * @public
+ */
+export interface FailedEditingResult extends EditingResultBase {
+    /**
+     * {@inheritDoc EditingResultBase.status}
+     */
+    readonly status: EditStatus.Invalid | EditStatus.Malformed;
+    /**
+     * Information about what caused the transaction to fail.
+     */
+    readonly failure: TransactionInternal.Failure;
+    /**
+     * The valid changes applied as part of the transaction.
+     * Those were ultimately abandoned due to the transaction failure.
+     */
+    readonly changes: readonly ChangeInternal[];
+    /**
+     * The editing steps applied as part of the transaction.
+     * Those were ultimately abandoned due to the transaction failure.
+     */
+    readonly steps: readonly ReconciliationChange[];
+}
+/**
+ * Result of applying a valid transaction.
+ * @public
+ */
+export interface ValidEditingResult extends EditingResultBase {
+    /**
+     * {@inheritDoc EditingResultBase.status}
+     */
+    readonly status: EditStatus.Applied;
+    /**
+     * The new revision produced by the transaction.
+     */
+    readonly after: RevisionView;
+}
+/**
+ * The result of applying a change within a transaction.
+ * @public
+ */
+export declare type ChangeResult = Result<TransactionView, TransactionFailure>;
+/**
+ * The ongoing state of a transaction.
+ * @public
+ */
+export declare type TransactionState = SucceedingTransactionState | FailingTransactionState;
+/**
+ * The state of a transaction that has not encountered an error.
+ */
+export interface SucceedingTransactionState {
+    /**
+     * The current status of the transaction.
+     */
+    readonly status: EditStatus.Applied;
+    /**
+     * The view reflecting the latest applied change.
+     */
+    readonly view: TransactionView;
+    /**
+     * The applied changes so far.
+     */
+    readonly changes: readonly ChangeInternal[];
+    /**
+     * The editing steps applied so far.
+     */
+    readonly steps: readonly ReconciliationChange[];
+}
+/**
+ * The state of a transaction that has encountered an error.
+ */
+export interface FailingTransactionState extends TransactionFailure {
+    /**
+     * The view reflecting the latest applied change.
+     */
+    readonly view: TransactionView;
+    /**
+     * The applied changes so far.
+     */
+    readonly changes: readonly ChangeInternal[];
+    /**
+     * The editing steps applied so far.
+     */
+    readonly steps: readonly ReconciliationChange[];
+}
+/**
+ * The failure state of a transaction.
+ */
+export interface TransactionFailure {
+    /**
+     * The status indicating the kind of failure encountered.
+     */
+    readonly status: EditStatus.Invalid | EditStatus.Malformed;
+    /**
+     * Information about what caused the transaction to fail.
+     */
+    readonly failure: TransactionInternal.Failure;
+}
+/**
+ * A mutable transaction for applying sequences of changes to a TreeView.
+ * Allows viewing the intermediate states.
+ *
+ * Contains necessary state to apply changes within an edit to a TreeView.
+ *
+ * May have any number of changes applied to make up the edit.
+ * Use `close` to complete the transaction, returning the array of changes and an EditingResult showing the
+ * results of applying the changes as an Edit to the initial TreeView (passed to the constructor).
+ *
+ * No data outside the Transaction is modified by Transaction:
+ * the results from `close` must be used to actually submit an `Edit`.
+ */
+export declare class GenericTransaction {
+    private readonly policy;
+    protected readonly before: RevisionView;
+    private state;
+    private open;
+    /**
+     * Create and open an edit of the provided `TreeView`. After applying 0 or more changes, this editor should be closed via `close()`.
+     * @param view - the `TreeView` at which this edit begins. The first change will be applied against this view.
+     */
+    constructor(view: RevisionView, policy: GenericTransactionPolicy);
+    /** Whether or not this transaction has been closed via `close()` */
+    get isOpen(): boolean;
+    /**
+     * The most up-to-date `TreeView` for this edit. This is the state of the tree after all changes applied so far.
+     */
+    get view(): TransactionView;
+    /**
+     * The status code of the most recent attempted change.
+     */
+    get status(): EditStatus;
+    /**
+     * The status code of the most recent attempted change.
+     */
+    get changes(): readonly ChangeInternal[];
+    /**
+     * The status code of the most recent attempted change.
+     */
+    get steps(): readonly ReconciliationChange[];
+    /** @returns the final `EditStatus` and `TreeView` after all changes are applied. */
+    close(): EditingResult;
+    /**
+     * A helper to apply a sequence of changes. Changes will be applied one after the other. If a change fails to apply,
+     * the remaining changes in `changes` will be ignored.
+     * @param changes - the sequence of changes to apply.
+     * @param path - the reconciliation path for the first change.
+     * @returns this
+     */
+    applyChanges(changes: Iterable<ChangeInternal>, path?: ReconciliationPath): this;
+    /**
+     * Attempt to apply the given change as part of this edit. This method should not be called if a previous change in this edit failed to
+     * apply.
+     * @param change - the change to apply
+     * @param path - the reconciliation path for the change.
+     * @returns this
+     */
+    applyChange(change: ChangeInternal, path?: ReconciliationPath): this;
+}
+/**
+ * An object that encapsulates the rules and state pertaining to a specific subclass of {@link GenericTransaction}.
+ * The characteristics that define such a subclass (and an implementation of this interface) are:
+ * - The type of change that can be applied
+ * - How those changes impact the state of the tree
+ * - How those changes are resolved in the face of concurrent changes
+ * - What makes a transaction valid
+ * - The kind of situations that might lead to a transaction failure
+ *
+ * Instances of this type are passed to the {@link GenericTransaction} constructor.
+ */
+export interface GenericTransactionPolicy {
+    /**
+     * Given a change, attempts to derive an equivalent change which can be applied to the current state even if the given change was issued
+     * over a different state. This can be used to apply a sequence of changes that were issued concurrently, i.e., without knowledge of
+     * each other.
+     * @param state - The current state on which the returned change will be applied.
+     * @param change - The original change issued.
+     * @param path - The reconciliation path for the change.
+     * @returns The change to be applied to the current state, or a failure if the change cannot be resolved.
+     */
+    tryResolveChange(state: SucceedingTransactionState, change: ChangeInternal, path: ReconciliationPath): Result<ChangeInternal, TransactionFailure>;
+    /**
+     * Provides a new state given the current state and a change to apply.
+     * @param state - The current state on which the change is applied.
+     * @param change - The change to apply to the current state.
+     * @returns The new state reflecting the applied change, or a failure.
+     */
+    dispatchChange(state: SucceedingTransactionState, change: ChangeInternal): ChangeResult;
+    /**
+     * Additional transaction validation when the transaction is closed.
+     * @param state - The current state of the transaction.
+     * @returns The new state reflecting the closed transaction, or a failure if the transaction cannot be closed.
+     */
+    validateOnClose(state: SucceedingTransactionState): ChangeResult;
+}
+/**
+ * A mutable transaction for applying sequences of changes to a TreeView.
+ * Allows viewing the intermediate states.
+ *
+ * Contains necessary state to apply changes within an edit to a TreeView.
+ *
+ * May have any number of changes applied to make up the edit.
+ * Use `close` to complete the transaction, returning the array of changes and an EditingResult showing the
+ * results of applying the changes as an Edit to the initial TreeView (passed to the constructor).
+ *
+ * No data outside the Transaction is modified by Transaction:
+ * the results from `close` must be used to actually submit an `Edit`.
+ * @public
+ */
+export declare namespace TransactionInternal {
+    /**
+     * Makes a new {@link GenericTransaction} that follows the {@link TransactionInternal.Policy} policy.
+     */
+    export function factory(view: RevisionView): GenericTransaction;
+    type ValidState = SucceedingTransactionState;
+    /**
+     * The policy followed by a {@link TransactionInternal}.
+     */
+    export class Policy implements GenericTransactionPolicy {
+        /**
+         * Maps detached sequences of nodes to their NodeIds
+         */
+        protected readonly detached: Map<DetachedSequenceId, readonly NodeId[]>;
+        /**
+         * Resolves change with Result.Ok
+         *
+         * @param state - Unused
+         * @param change - Change to resolve
+         * @returns Result.Ok which contains change
+         */
+        tryResolveChange(state: ValidState, change: ChangeInternal): Result.Ok<ChangeInternal>;
+        /**
+         * Validates the transaction when it is closed
+         *
+         * @param state - Current state
+         * @returns a {@link ChangeResult} containing either the change result or a Failure
+         */
+        validateOnClose(state: ValidState): ChangeResult;
+        /**
+         * Applies a given change
+         *
+         * @param state - Current state
+         * @param change - Change to apply
+         * @returns a {@link ChangeResult} containing either the change result or a Failure
+         */
+        dispatchChange(state: ValidState, change: ChangeInternal): ChangeResult;
+        private applyBuild;
+        private applyInsert;
+        private applyDetach;
+        private applyConstraint;
+        private applySetValue;
+        /**
+         * Generates tree view nodes from the supplied edit nodes.
+         * Invokes onCreateNode for each new node, and halts creation early if it returns true.
+         * Invokes onInvalidDetachedId and halts early for any invalid detached IDs referenced in the edit node sequence.
+         * @returns all the top-level node IDs in `sequence` (both from nodes and from detached sequences).
+         */
+        protected createViewNodesForTree(sequence: Iterable<BuildNodeInternal>, onCreateNode: (stableId: NodeId, node: TreeViewNode) => boolean, onInvalidDetachedId: (sequenceId: DetachedSequenceId) => void): NodeId[] | undefined;
+        private getDetachedNodeIds;
+    }
+    /**
+     * The kinds of failures that a transaction might encounter.
+     */
+    export enum FailureKind {
+        /**
+         * Transaction has an unused DetachedSequenceId
+         */
+        UnusedDetachedSequence = "UnusedDetachedSequence",
+        /**
+         * Transaction has a build operation using an already in use DetachedSequenceID.
+         */
+        DetachedSequenceIdAlreadyInUse = "DetachedSequenceIdAlreadyInUse",
+        /**
+         * Transaction tries to operate on an unknown DetachedSequenceID
+         */
+        DetachedSequenceNotFound = "DetachedSequenceNotFound",
+        /**
+         * Transaction has a build which uses a duplicated NodeId
+         */
+        DuplicateIdInBuild = "DuplicateIdInBuild",
+        /**
+         * Transaction tries to build a node using an ID which is already used in the current state
+         */
+        IdAlreadyInUse = "IdAlreadyInUse",
+        /**
+         * Transaction tries to set value of an unknown node
+         */
+        UnknownId = "UnknownId",
+        /**
+         * Transaction tries to insert in an invalid Place
+         */
+        BadPlace = "BadPlace",
+        /**
+         * Transaction tries to detach an invalid Range
+         */
+        BadRange = "BadRange",
+        /**
+         * Transaction has an invalid constraint
+         */
+        ConstraintViolation = "ConstraintViolation"
+    }
+    /**
+     * A failure encountered by a transaction.
+     */
+    export type Failure = UnusedDetachedSequenceFailure | DetachedSequenceIdAlreadyInUseFailure | DetachedSequenceNotFoundFailure | DuplicateIdInBuildFailure | IdAlreadyInUseFailure | UnknownIdFailure | BadPlaceFailure | BadRangeFailure | ConstraintViolationFailure;
+    /**
+     * Error returned when a transaction is closed while there is an unused detached sequence.
+     */
+    export interface UnusedDetachedSequenceFailure {
+        /**
+         * Failure kind (will always be FailureKind.UnusedDetachedSequence)
+         */
+        readonly kind: FailureKind.UnusedDetachedSequence;
+        /**
+         * The unused DetachedSequenceId
+         */
+        readonly sequenceId: DetachedSequenceId;
+    }
+    /**
+     * Error thrown when a transaction encounters a build operation using an already in use DetachedSequenceID.
+     */
+    export interface DetachedSequenceIdAlreadyInUseFailure {
+        /**
+         * Failure kind (will always be FailureKind.DetachedSequenceIdAlreadyInUse)
+         */
+        readonly kind: FailureKind.DetachedSequenceIdAlreadyInUse;
+        /**
+         * Faulting Change
+         */
+        readonly change: ChangeInternal;
+        /**
+         * The DetachedSequenceId that is already in use
+         */
+        readonly sequenceId: DetachedSequenceId;
+    }
+    /**
+     * Error thrown when a transaction tries to operate on an unknown DetachedSequenceID
+     */
+    export interface DetachedSequenceNotFoundFailure {
+        /**
+         * Failure kind (will always be FailureKind.DetachedSequenceNotFound)
+         */
+        readonly kind: FailureKind.DetachedSequenceNotFound;
+        /**
+         * Faulting Change
+         */
+        readonly change: ChangeInternal;
+        /**
+         * The DetachedSequenceId that wasn't found
+         */
+        readonly sequenceId: DetachedSequenceId;
+    }
+    /**
+     * Error thrown when a build uses a duplicated NodeId
+     */
+    export interface DuplicateIdInBuildFailure {
+        /**
+         * Failure kind (will always be FailureKind.DuplicateIdInBuild)
+         */
+        readonly kind: FailureKind.DuplicateIdInBuild;
+        /**
+         * Faulting Change
+         */
+        readonly change: ChangeInternal;
+        /**
+         * ID of duplicated node
+         */
+        readonly id: NodeId;
+    }
+    /**
+     * Error thrown when a build node ID is already used in the current state
+     */
+    export interface IdAlreadyInUseFailure {
+        /**
+         * Failure kind (will always be FailureKind.IdAlreadyInUse)
+         */
+        readonly kind: FailureKind.IdAlreadyInUse;
+        /**
+         * Faulting Change
+         */
+        readonly change: ChangeInternal;
+        /**
+         * ID of already in use node
+         */
+        readonly id: NodeId;
+    }
+    /**
+     * Error thrown when a change is attempted on an unknown NodeId
+     */
+    export interface UnknownIdFailure {
+        /**
+         * Failure kind (will always be FailureKind.UnknownId)
+         */
+        readonly kind: FailureKind.UnknownId;
+        /**
+         * Faulting Change
+         */
+        readonly change: ChangeInternal;
+        /**
+         * The unknown ID
+         */
+        readonly id: NodeId;
+    }
+    /**
+     * Error thrown when an insert change uses an invalid Place
+     */
+    export interface BadPlaceFailure {
+        /**
+         * Failure kind (will always be FailureKind.BadPlace)
+         */
+        readonly kind: FailureKind.BadPlace;
+        /**
+         * Faulting Change
+         */
+        readonly change: ChangeInternal;
+        /**
+         * The faulting place
+         */
+        readonly place: StablePlaceInternal;
+        /**
+         * The reason for the failure
+         */
+        readonly placeFailure: BadPlaceValidationResult;
+    }
+    /**
+     * Error thrown when a detach operation is given an invalid or malformed Range
+     */
+    export interface BadRangeFailure {
+        /**
+         * Failure kind (will always be FailureKind.BadRange)
+         */
+        readonly kind: FailureKind.BadRange;
+        /**
+         * Faulting Change
+         */
+        readonly change: ChangeInternal;
+        /**
+         * Faulting range
+         */
+        readonly range: StableRangeInternal;
+        /**
+         * The reason for the failure
+         */
+        readonly rangeFailure: BadRangeValidationResult;
+    }
+    /**
+     * Error thrown when a constraint fails to apply
+     */
+    export interface ConstraintViolationFailure {
+        /**
+         * Failure kind (will always be FailureKind.ConstraintViolation)
+         */
+        readonly kind: FailureKind.ConstraintViolation;
+        /**
+         * Faulting Change
+         */
+        readonly constraint: ConstraintInternal;
+        /**
+         * The first violation the constraint encounters (there may be others).
+         */
+        readonly violation: ConstraintViolationResult;
+    }
+    /**
+     * The details of what kind of constraint was violated and caused a ConstraintViolationFailure error to occur
+     */
+    export type ConstraintViolationResult = {
+        readonly kind: ConstraintViolationKind.BadRange;
+        readonly rangeFailure: BadRangeValidationResult;
+    } | {
+        readonly kind: ConstraintViolationKind.BadLength;
+        readonly actual: number;
+    } | {
+        readonly kind: ConstraintViolationKind.BadParent;
+        readonly actual: NodeId;
+    } | {
+        readonly kind: ConstraintViolationKind.BadLabel;
+        readonly actual: TraitLabel;
+    };
+    /**
+     * Enum of possible kinds of constraint violations that can be encountered
+     */
+    export enum ConstraintViolationKind {
+        /**
+         * The constraint failed because it applies to an invalid range
+         */
+        BadRange = "BadRange",
+        /**
+         * The constraint failed because the length prescribed by the constraint does not match the length of range being constrained
+         */
+        BadLength = "BadLength",
+        /**
+         * The constraint failed because the parent prescribed by the constraint does not match the actual parent of the range being constrained
+         */
+        BadParent = "BadParent",
+        /**
+         * The constraint failed because the trait label prescribed by the constraint does not match the actual trait label of the range being constrained
+         */
+        BadLabel = "BadLabel"
+    }
+    export {};
+}
+//# sourceMappingURL=TransactionInternal.d.ts.map

package/lib/TransactionInternal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransactionInternal.d.ts","sourceRoot":"","sources":["../src/TransactionInternal.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAuC,MAAM,EAAE,MAAM,UAAU,CAAC;AACvE,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,UAAU,EAAwB,MAAM,eAAe,CAAC;AAE7F,OAAO,EAEN,iBAAiB,EACjB,cAAc,EAGd,kBAAkB,EAElB,UAAU,EAGV,mBAAmB,EACnB,mBAAmB,EACnB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAKN,wBAAwB,EACxB,wBAAwB,EAGxB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAC/D,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAChF,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C;;;GAGG;AACH,oBAAY,aAAa,GAAG,mBAAmB,GAAG,kBAAkB,CAAC;AAErE;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IACjC;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,SAAS,cAAc,EAAE,CAAC;IAC5C;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,SAAS,oBAAoB,EAAE,CAAC;IAChD;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,iBAAiB;IAC7D;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC;IAC3D;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC,OAAO,CAAC;IAC9C;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,SAAS,cAAc,EAAE,CAAC;IAC5C;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,SAAS,oBAAoB,EAAE,CAAC;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,iBAAiB;IAC5D;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC;IACpC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC;CAC7B;AAED;;;GAGG;AACH,oBAAY,YAAY,GAAG,MAAM,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAAC;AAEvE;;;GAGG;AACH,oBAAY,gBAAgB,GAAG,0BAA0B,GAAG,uBAAuB,CAAC;AAEpF;;GAEG;AACH,MAAM,WAAW,0BAA0B;IAC1C;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC;IACpC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC;IAC/B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,SAAS,cAAc,EAAE,CAAC;IAC5C;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,SAAS,oBAAoB,EAAE,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,kBAAkB;IAClE;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC;IAC/B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,SAAS,cAAc,EAAE,CAAC;IAC5C;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,SAAS,oBAAoB,EAAE,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC;IAC3D;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC,OAAO,CAAC;CAC9C;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,kBAAkB;IAC9B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA2B;IAClD,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IACxC,OAAO,CAAC,KAAK,CAAmB;IAChC,OAAO,CAAC,IAAI,CAAQ;IAEpB;;;OAGG;gBACgB,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,wBAAwB;IAWvE,oEAAoE;IACpE,IAAW,MAAM,IAAI,OAAO,CAE3B;IAED;;OAEG;IACH,IAAW,IAAI,IAAI,eAAe,CAEjC;IAED;;OAEG;IACH,IAAW,MAAM,IAAI,UAAU,CAE9B;IAED;;OAEG;IACH,IAAW,OAAO,IAAI,SAAS,cAAc,EAAE,CAE9C;IAED;;OAEG;IACH,IAAW,KAAK,IAAI,SAAS,oBAAoB,EAAE,CAElD;IAED,oFAAoF;IAC7E,KAAK,IAAI,aAAa;IAkC7B;;;;;;OAMG;IACI,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,cAAc,CAAC,EAAE,IAAI,GAAE,kBAAuB,GAAG,IAAI;IAkD3F;;;;;;OAMG;IACI,WAAW,CAAC,MAAM,EAAE,cAAc,EAAE,IAAI,GAAE,kBAAuB,GAAG,IAAI;CA2B/E;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,wBAAwB;IACxC;;;;;;;;OAQG;IACH,gBAAgB,CACf,KAAK,EAAE,0BAA0B,EACjC,MAAM,EAAE,cAAc,EACtB,IAAI,EAAE,kBAAkB,GACtB,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;IAE9C;;;;;OAKG;IACH,cAAc,CAAC,KAAK,EAAE,0BAA0B,EAAE,MAAM,EAAE,cAAc,GAAG,YAAY,CAAC;IAExF;;;;OAIG;IACH,eAAe,CAAC,KAAK,EAAE,0BAA0B,GAAG,YAAY,CAAC;CACjE;AAED;;;;;;;;;;;;;GAaG;AACH,yBAAiB,mBAAmB,CAAC;IACpC;;OAEG;IACH,MAAM,UAAU,OAAO,CAAC,IAAI,EAAE,YAAY,GAAG,kBAAkB,CAE9D;IAED,KAAK,UAAU,GAAG,0BAA0B,CAAC;IAE7C;;OAEG;IACH,MAAM,OAAO,MAAO,YAAW,wBAAwB;QACtD;;WAEG;QACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,kBAAkB,EAAE,SAAS,MAAM,EAAE,CAAC,CAAa;QAEpF;;;;;;WAMG;QACI,gBAAgB,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,cAAc,GAAG,MAAM,CAAC,EAAE,CAAC,cAAc,CAAC;QAI7F;;;;;WAKG;QACI,eAAe,CAAC,KAAK,EAAE,UAAU,GAAG,YAAY;QAavD;;;;;;WAMG;QACI,cAAc,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,cAAc,GAAG,YAAY;QAiB9E,OAAO,CAAC,UAAU;QAyElB,OAAO,CAAC,WAAW;QAkCnB,OAAO,CAAC,WAAW;QA0CnB,OAAO,CAAC,eAAe;QAqFvB,OAAO,CAAC,aAAa;QAYrB;;;;;WAKG;QACH,SAAS,CAAC,sBAAsB,CAC/B,QAAQ,EAAE,QAAQ,CAAC,iBAAiB,CAAC,EACrC,YAAY,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,KAAK,OAAO,EAC/D,mBAAmB,EAAE,CAAC,UAAU,EAAE,kBAAkB,KAAK,IAAI,GAC3D,MAAM,EAAE,GAAG,SAAS;QAsDvB,OAAO,CAAC,kBAAkB;KAc1B;IAED;;OAEG;IACH,MAAM,MAAM,WAAW;QACtB;;WAEG;QACH,sBAAsB,2BAA2B;QACjD;;WAEG;QACH,8BAA8B,mCAAmC;QACjE;;WAEG;QACH,wBAAwB,6BAA6B;QACrD;;WAEG;QACH,kBAAkB,uBAAuB;QACzC;;WAEG;QACH,cAAc,mBAAmB;QACjC;;WAEG;QACH,SAAS,cAAc;QACvB;;WAEG;QACH,QAAQ,aAAa;QACrB;;WAEG;QACH,QAAQ,aAAa;QACrB;;WAEG;QACH,mBAAmB,wBAAwB;KAC3C;IAED;;OAEG;IACH,MAAM,MAAM,OAAO,GAChB,6BAA6B,GAC7B,qCAAqC,GACrC,+BAA+B,GAC/B,yBAAyB,GACzB,qBAAqB,GACrB,gBAAgB,GAChB,eAAe,GACf,eAAe,GACf,0BAA0B,CAAC;IAE9B;;OAEG;IACH,MAAM,WAAW,6BAA6B;QAC7C;;WAEG;QACH,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,sBAAsB,CAAC;QAClD;;WAEG;QACH,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC;KACxC;IAED;;OAEG;IACH,MAAM,WAAW,qCAAqC;QACrD;;WAEG;QACH,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,8BAA8B,CAAC;QAC1D;;WAEG;QACH,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;QAChC;;WAEG;QACH,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC;KACxC;IAED;;OAEG;IACH,MAAM,WAAW,+BAA+B;QAC/C;;WAEG;QACH,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,wBAAwB,CAAC;QACpD;;WAEG;QACH,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;QAChC;;WAEG;QACH,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC;KACxC;IAED;;OAEG;IACH,MAAM,WAAW,yBAAyB;QACzC;;WAEG;QACH,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,kBAAkB,CAAC;QAC9C;;WAEG;QACH,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;QAChC;;WAEG;QACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;KACpB;IAED;;OAEG;IACH,MAAM,WAAW,qBAAqB;QACrC;;WAEG;QACH,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,cAAc,CAAC;QAC1C;;WAEG;QACH,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;QAChC;;WAEG;QACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;KACpB;IAED;;OAEG;IACH,MAAM,WAAW,gBAAgB;QAChC;;WAEG;QACH,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC;QACrC;;WAEG;QACH,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;QAChC;;WAEG;QACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;KACpB;IAED;;OAEG;IACH,MAAM,WAAW,eAAe;QAC/B;;WAEG;QACH,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,QAAQ,CAAC;QACpC;;WAEG;QACH,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;QAChC;;WAEG;QACH,QAAQ,CAAC,KAAK,EAAE,mBAAmB,CAAC;QACpC;;WAEG;QACH,QAAQ,CAAC,YAAY,EAAE,wBAAwB,CAAC;KAChD;IAED;;OAEG;IACH,MAAM,WAAW,eAAe;QAC/B;;WAEG;QACH,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,QAAQ,CAAC;QACpC;;WAEG;QACH,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;QAChC;;WAEG;QACH,QAAQ,CAAC,KAAK,EAAE,mBAAmB,CAAC;QACpC;;WAEG;QACH,QAAQ,CAAC,YAAY,EAAE,wBAAwB,CAAC;KAChD;IAED;;OAEG;IACH,MAAM,WAAW,0BAA0B;QAC1C;;WAEG;QACH,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,mBAAmB,CAAC;QAC/C;;WAEG;QACH,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC;QACxC;;WAEG;QACH,QAAQ,CAAC,SAAS,EAAE,yBAAyB,CAAC;KAC9C;IAED;;OAEG;IACH,MAAM,MAAM,yBAAyB,GAClC;QACA,QAAQ,CAAC,IAAI,EAAE,uBAAuB,CAAC,QAAQ,CAAC;QAChD,QAAQ,CAAC,YAAY,EAAE,wBAAwB,CAAC;KAC/C,GACD;QACA,QAAQ,CAAC,IAAI,EAAE,uBAAuB,CAAC,SAAS,CAAC;QACjD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;KACvB,GACD;QACA,QAAQ,CAAC,IAAI,EAAE,uBAAuB,CAAC,SAAS,CAAC;QACjD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;KACvB,GACD;QACA,QAAQ,CAAC,IAAI,EAAE,uBAAuB,CAAC,QAAQ,CAAC;QAChD,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;KAC3B,CAAC;IAEL;;OAEG;IACH,MAAM,MAAM,uBAAuB;QAClC;;WAEG;QACH,QAAQ,aAAa;QACrB;;WAEG;QACH,SAAS,cAAc;QACvB;;WAEG;QACH,SAAS,cAAc;QACvB;;WAEG;QACH,QAAQ,aAAa;KACrB;;CACD"}