@fluidframework/tree 2.80.0 → 2.81.0

package/src/util/bTreeUtils.ts

@@ -3,43 +3,54 @@
  * Licensed under the MIT License.
  */
 
-import { BTree } from "@tylerbu/sorted-btree-es6";
+import { debugAssert } from "@fluidframework/core-utils/internal";
+import { BTree, defaultComparator, type DefaultComparable } from "@tylerbu/sorted-btree-es6";
 
 import { brand, type Brand } from "./brand.js";
 
-export type TupleBTree<K, V> = Brand<BTree<K, V>, "TupleBTree">;
+/**
+ * A BTree which uses tuples (arrays) as the key.
+ * @remarks
+ * All keys must be the same length.
+ */
+export type TupleBTree<K extends readonly DefaultComparable[], V> = Brand<
+	BTree<K, V>,
+	"TupleBTree"
+>;
 
-export function newTupleBTree<K extends readonly unknown[], V>(
+/**
+ * Create a new {@link TupleBTree}.
+ */
+export function newTupleBTree<const K extends readonly DefaultComparable[], V>(
 	entries?: [K, V][],
 ): TupleBTree<K, V> {
 	return brand(new BTree<K, V>(entries, compareTuples));
 }
 
-// This assumes that the arrays are the same length.
-function compareTuples(arrayA: readonly unknown[], arrayB: readonly unknown[]): number {
+/**
+ * Compares two tuples (arrays) element by element.
+ * @param arrayA - The first tuple to compare.
+ * @param arrayB - The second tuple to compare.
+ * @returns A negative number if arrayA \< arrayB, a positive number if arrayA \> arrayB, or 0 if they are equal.
+ */
+function compareTuples(
+	arrayA: readonly DefaultComparable[],
+	arrayB: readonly DefaultComparable[],
+): number {
+	debugAssert(
+		() =>
+			arrayA.length === arrayB.length || "compareTuples requires arrays of the same length",
+	);
 	for (let i = 0; i < arrayA.length; i++) {
-		// eslint-disable-next-line @typescript-eslint/no-explicit-any
-		const a = arrayA[i] as any;
-		// eslint-disable-next-line @typescript-eslint/no-explicit-any
-		const b = arrayB[i] as any;
-
-		// Less-than and greater-than always return false if either value is undefined,
-		// so we handle undefined separately, treating it as less than all other values.
-		if (a === undefined && b !== undefined) {
-			return -1;
-		} else if (b === undefined && a !== undefined) {
-			return 1;
-		} else if (a < b) {
-			return -1;
-		} else if (a > b) {
-			return 1;
+		const result = defaultComparator(arrayA[i], arrayB[i]);
+		if (result !== 0) {
+			return result;
 		}
 	}
-
 	return 0;
 }
 
-export function mergeTupleBTrees<K extends readonly unknown[], V>(
+export function mergeTupleBTrees<K extends readonly DefaultComparable[], V>(
 	tree1: TupleBTree<K, V> | undefined,
 	tree2: TupleBTree<K, V> | undefined,
 	preferLeft = true,

package/src/util/nestedMap.ts

@@ -177,11 +177,11 @@ export function nestedMapToFlatList<Key1, Key2, Value>(
 	map: ReadonlyNestedMap<Key1, Key2, Value>,
 ): [Key1, Key2, Value][] {
 	const list: [Key1, Key2, Value][] = [];
-	map.forEach((innerMap, key1) => {
-		innerMap.forEach((val, key2) => {
+	for (const [key1, innerMap] of map) {
+		for (const [key2, val] of innerMap) {
 			list.push([key1, key2, val]);
-		});
-	});
+		}
+	}
 	return list;
 }
 
@@ -202,11 +202,11 @@ export function forEachInNestedMap<Key1, Key2, Value>(
 	map: ReadonlyNestedMap<Key1, Key2, Value>,
 	delegate: (value: Value, key1: Key1, key2: Key2) => void,
 ): void {
-	map.forEach((innerMap, keyFirst) => {
-		innerMap.forEach((val, keySecond) => {
+	for (const [keyFirst, innerMap] of map) {
+		for (const [keySecond, val] of innerMap) {
 			delegate(val, keyFirst, keySecond);
-		});
-	});
+		}
+	}
 }
 
 /**
@@ -221,14 +221,14 @@ export function mapNestedMap<Key1, Key2, ValueIn, ValueOut = ValueIn>(
 	delegate: (value: ValueIn, key1: Key1, key2: Key2) => ValueOut,
 ): NestedMap<Key1, Key2, ValueOut> {
 	const output = new Map<Key1, Map<Key2, ValueOut>>();
-	input.forEach((inputInnerMap, keyFirst) => {
+	for (const [keyFirst, inputInnerMap] of input) {
 		const outputInnerMap = new Map<Key2, ValueOut>();
-		inputInnerMap.forEach((val, keySecond) => {
+		for (const [keySecond, val] of inputInnerMap) {
 			const mappedValue = delegate(val, keyFirst, keySecond);
 			outputInnerMap.set(keySecond, mappedValue);
-		});
+		}
 		output.set(keyFirst, outputInnerMap);
-	});
+	}
 	return output;
 }
 

package/src/util/readSnapshotBlob.ts

@@ -3,12 +3,14 @@
  * Licensed under the MIT License.
  */
 
+import { bufferToString } from "@fluid-internal/client-utils";
 import type { IFluidHandle } from "@fluidframework/core-interfaces";
 import type { IChannelStorageService } from "@fluidframework/datastore-definitions/internal";
-import type { JsonCompatible } from "./utils.js";
-import { bufferToString } from "@fluid-internal/client-utils";
+
 import type { SummaryElementParser } from "../shared-tree-core/index.js";
 
+import type { JsonCompatible } from "./utils.js";
+
 /**
  * Reads and parses a snapshot blob from storage service.
  */

package/.eslintrc.cjs

@@ -1,125 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-module.exports = {
-	extends: [require.resolve("@fluidframework/eslint-config-fluid"), "prettier"],
-	parserOptions: {
-		project: ["./tsconfig.json"],
-	},
-	rules: {
-		"@typescript-eslint/no-namespace": "off",
-
-		// This library leverages empty, derived interface definitions to capture concepts
-		// in a nicely reusable way.
-		"@typescript-eslint/no-empty-interface": "off",
-		"@typescript-eslint/no-empty-object-type": "off",
-
-		"@fluid-internal/fluid/no-unchecked-record-access": "warn",
-
-		// This package is build with noUnusedLocals disabled for a specific use case (see note in tsconfig.json),
-		// but should reject other cases using this rule:
-		"@typescript-eslint/no-unused-vars": [
-			"error",
-			{
-				argsIgnorePattern: "^",
-				varsIgnorePattern: "^_",
-				caughtErrorsIgnorePattern: "^_",
-			},
-		],
-
-		// TODO: Remove this override once this config has been updated to extend the "strict" base config.
-		"@typescript-eslint/explicit-member-accessibility": "error",
-
-		// #region TODO: remove these once eslint-config-fluid has been updated to 5.8.0
-		"@typescript-eslint/consistent-type-exports": [
-			"error",
-			{ fixMixedExportsWithInlineTypeSpecifier: true },
-		],
-		"@typescript-eslint/consistent-type-imports": [
-			"error",
-			{ fixStyle: "inline-type-imports" },
-		],
-		"@typescript-eslint/no-import-type-side-effects": "error",
-
-		// #endregion
-
-		// #region TODO:AB#6983: Remove these overrides and fix violations
-
-		"@typescript-eslint/explicit-module-boundary-types": "off",
-
-		// Causes eslint to stack-overflow in this package. Will need investigation.
-		"@typescript-eslint/no-unsafe-argument": "off",
-
-		// Causes eslint to stack-overflow in this package. Will need investigation.
-		"@typescript-eslint/no-unsafe-assignment": "off",
-
-		"@typescript-eslint/no-unsafe-call": "off",
-		"@typescript-eslint/no-unsafe-member-access": "off",
-
-		"import-x/order": "off",
-
-		"jsdoc/multiline-blocks": "off",
-
-		// Set to a warning to encourage adding docs :)
-		"jsdoc/require-description": "warn",
-
-		"unicorn/consistent-function-scoping": "off",
-		"unicorn/no-array-callback-reference": "off",
-		"unicorn/no-array-for-each": "off",
-		"unicorn/no-array-method-this-argument": "off",
-		"unicorn/no-array-reduce": "off",
-		"unicorn/no-await-expression-member": "off",
-		"unicorn/no-new-array": "off",
-		"unicorn/no-null": "off",
-		"unicorn/no-object-as-default-parameter": "off",
-		"unicorn/no-useless-fallback-in-spread": "off",
-		"unicorn/no-zero-fractions": "off",
-		"unicorn/prefer-export-from": "off",
-		"unicorn/text-encoding-identifier-case": "off",
-
-		// #endregion
-	},
-	overrides: [
-		{
-			files: ["src/test/**/*"],
-			parserOptions: {
-				project: ["./src/test/tsconfig.json"],
-			},
-			rules: {
-				"@typescript-eslint/no-unused-vars": ["off"],
-				"@typescript-eslint/explicit-function-return-type": "off",
-			},
-		},
-	],
-	settings: {
-		"import/extensions": [".ts", ".tsx", ".d.ts", ".js", ".jsx"],
-		"import/parsers": {
-			"@typescript-eslint/parser": [".ts", ".tsx", ".d.ts"],
-		},
-		"import/resolver": {
-			typescript: {
-				extensions: [".ts", ".tsx", ".d.ts", ".js", ".jsx"],
-				conditionNames: [
-					"allow-ff-test-exports",
-
-					// Default condition names below, see https://www.npmjs.com/package/eslint-import-resolver-typescript#conditionnames
-					"types",
-					"import",
-
-					// APF: https://angular.io/guide/angular-package-format
-					"esm2020",
-					"es2020",
-					"es2015",
-
-					"require",
-					"node",
-					"node-addons",
-					"browser",
-					"default",
-				],
-			},
-		},
-	},
-};

package/assertTagging.config.mjs

@@ -1,14 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-/**
- * @type {import("@fluid-tools/build-cli").AssertTaggingPackageConfig}
- */
-export default {
-	assertionFunctions: {
-		"assert": 1,
-		"fail": 0,
-	},
-};

package/dist/shared-tree-core/transactionEnricher.d.ts

@@ -1,23 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import type { ChangeRebaser, GraphCommit } from "../core/index.js";
-import type { ChangeEnricherReadonlyCheckout } from "./changeEnricher.js";
-/**
- * Utility for producing an enriched commit out of multiple transaction steps
- */
-export declare class TransactionEnricher<TChange> {
-    #private;
-    constructor(rebaser: ChangeRebaser<TChange>, enricher: ChangeEnricherReadonlyCheckout<TChange>);
-    isTransacting(): boolean;
-    startTransaction(): void;
-    /**
-     * Commits the current transaction.
-     * @returns A function which can be used to compute the composed change for that transaction's commits. Undefined if the transaction is still ongoing or contained no committed changes.
-     */
-    commitTransaction(): (() => TChange) | undefined;
-    abortTransaction(): void;
-    addTransactionStep(commit: GraphCommit<TChange>): void;
-}
-//# sourceMappingURL=transactionEnricher.d.ts.map

package/dist/shared-tree-core/transactionEnricher.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"transactionEnricher.d.ts","sourceRoot":"","sources":["../../src/shared-tree-core/transactionEnricher.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEnE,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,qBAAqB,CAAC;AAE1E;;GAEG;AACH,qBAAa,mBAAmB,CAAC,OAAO;;gBAatC,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC,EAC/B,QAAQ,EAAE,8BAA8B,CAAC,OAAO,CAAC;IAM3C,aAAa,IAAI,OAAO;IAIxB,gBAAgB,IAAI,IAAI;IAI/B;;;OAGG;IACI,iBAAiB,IAAI,CAAC,MAAM,OAAO,CAAC,GAAG,SAAS;IAahD,gBAAgB,IAAI,IAAI;IAMxB,kBAAkB,CAAC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,GAAG,IAAI;CAQ7D"}

package/dist/shared-tree-core/transactionEnricher.js

@@ -1,74 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _TransactionEnricher_rebaser, _TransactionEnricher_enricher, _TransactionEnricher_transactionCommits, _TransactionEnricher_transactionScopesStart;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TransactionEnricher = void 0;
-const internal_1 = require("@fluidframework/core-utils/internal");
-/**
- * Utility for producing an enriched commit out of multiple transaction steps
- */
-class TransactionEnricher {
-    constructor(rebaser, enricher) {
-        _TransactionEnricher_rebaser.set(this, void 0);
-        _TransactionEnricher_enricher.set(this, void 0);
-        _TransactionEnricher_transactionCommits.set(this, []);
-        /**
-         * The number of commits before the start of each active transaction scope.
-         * For a stack of `n` transaction scopes, the array will contain `n` integers,
-         * where the integer at index `i` is the number of commits made before the start of the `i`th transaction scope
-         * (therefore, the first element in the array, if present, is always 0)
-         */
-        _TransactionEnricher_transactionScopesStart.set(this, []);
-        __classPrivateFieldSet(this, _TransactionEnricher_rebaser, rebaser, "f");
-        __classPrivateFieldSet(this, _TransactionEnricher_enricher, enricher, "f");
-    }
-    isTransacting() {
-        return __classPrivateFieldGet(this, _TransactionEnricher_transactionScopesStart, "f").length > 0;
-    }
-    startTransaction() {
-        __classPrivateFieldGet(this, _TransactionEnricher_transactionScopesStart, "f").push(__classPrivateFieldGet(this, _TransactionEnricher_transactionCommits, "f").length);
-    }
-    /**
-     * Commits the current transaction.
-     * @returns A function which can be used to compute the composed change for that transaction's commits. Undefined if the transaction is still ongoing or contained no committed changes.
-     */
-    commitTransaction() {
-        const commitsCommitted = __classPrivateFieldGet(this, _TransactionEnricher_transactionScopesStart, "f").pop();
-        (0, internal_1.assert)(commitsCommitted !== undefined, 0x985 /* No transaction to commit */);
-        if (__classPrivateFieldGet(this, _TransactionEnricher_transactionScopesStart, "f").length === 0) {
-            if (__classPrivateFieldGet(this, _TransactionEnricher_transactionCommits, "f").length === 0) {
-                return undefined;
-            }
-            const transactionCommits = __classPrivateFieldGet(this, _TransactionEnricher_transactionCommits, "f");
-            __classPrivateFieldSet(this, _TransactionEnricher_transactionCommits, [], "f");
-            return () => __classPrivateFieldGet(this, _TransactionEnricher_rebaser, "f").compose(transactionCommits);
-        }
-    }
-    abortTransaction() {
-        const scopeStart = __classPrivateFieldGet(this, _TransactionEnricher_transactionScopesStart, "f").pop();
-        (0, internal_1.assert)(scopeStart !== undefined, 0x986 /* No transaction to abort */);
-        __classPrivateFieldGet(this, _TransactionEnricher_transactionCommits, "f").length = scopeStart;
-    }
-    addTransactionStep(commit) {
-        (0, internal_1.assert)(__classPrivateFieldGet(this, _TransactionEnricher_transactionScopesStart, "f").length > 0, 0x987 /* No transaction to add a step to */);
-        const change = __classPrivateFieldGet(this, _TransactionEnricher_enricher, "f").updateChangeEnrichments(commit.change, commit.revision);
-        __classPrivateFieldGet(this, _TransactionEnricher_transactionCommits, "f").push({ ...commit, change });
-    }
-}
-exports.TransactionEnricher = TransactionEnricher;
-_TransactionEnricher_rebaser = new WeakMap(), _TransactionEnricher_enricher = new WeakMap(), _TransactionEnricher_transactionCommits = new WeakMap(), _TransactionEnricher_transactionScopesStart = new WeakMap();
-//# sourceMappingURL=transactionEnricher.js.map

package/dist/shared-tree-core/transactionEnricher.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"transactionEnricher.js","sourceRoot":"","sources":["../../src/shared-tree-core/transactionEnricher.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;AAEH,kEAA6D;AAM7D;;GAEG;AACH,MAAa,mBAAmB;IAY/B,YACC,OAA+B,EAC/B,QAAiD;QAbzC,+CAAiC;QACjC,gDAAmD;QAC5D,kDAA8C,EAAE,EAAC;QACjD;;;;;WAKG;QACM,sDAAoC,EAAE,EAAC;QAM/C,uBAAA,IAAI,gCAAY,OAAO,MAAA,CAAC;QACxB,uBAAA,IAAI,iCAAa,QAAQ,MAAA,CAAC;IAC3B,CAAC;IAEM,aAAa;QACnB,OAAO,uBAAA,IAAI,mDAAwB,CAAC,MAAM,GAAG,CAAC,CAAC;IAChD,CAAC;IAEM,gBAAgB;QACtB,uBAAA,IAAI,mDAAwB,CAAC,IAAI,CAAC,uBAAA,IAAI,+CAAoB,CAAC,MAAM,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACI,iBAAiB;QACvB,MAAM,gBAAgB,GAAG,uBAAA,IAAI,mDAAwB,CAAC,GAAG,EAAE,CAAC;QAC5D,IAAA,iBAAM,EAAC,gBAAgB,KAAK,SAAS,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAC7E,IAAI,uBAAA,IAAI,mDAAwB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/C,IAAI,uBAAA,IAAI,+CAAoB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC3C,OAAO,SAAS,CAAC;YAClB,CAAC;YACD,MAAM,kBAAkB,GAAG,uBAAA,IAAI,+CAAoB,CAAC;YACpD,uBAAA,IAAI,2CAAuB,EAAE,MAAA,CAAC;YAC9B,OAAO,GAAG,EAAE,CAAC,uBAAA,IAAI,oCAAS,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACxD,CAAC;IACF,CAAC;IAEM,gBAAgB;QACtB,MAAM,UAAU,GAAG,uBAAA,IAAI,mDAAwB,CAAC,GAAG,EAAE,CAAC;QACtD,IAAA,iBAAM,EAAC,UAAU,KAAK,SAAS,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACtE,uBAAA,IAAI,+CAAoB,CAAC,MAAM,GAAG,UAAU,CAAC;IAC9C,CAAC;IAEM,kBAAkB,CAAC,MAA4B;QACrD,IAAA,iBAAM,EACL,uBAAA,IAAI,mDAAwB,CAAC,MAAM,GAAG,CAAC,EACvC,KAAK,CAAC,qCAAqC,CAC3C,CAAC;QACF,MAAM,MAAM,GAAG,uBAAA,IAAI,qCAAU,CAAC,uBAAuB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;QACtF,uBAAA,IAAI,+CAAoB,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACtD,CAAC;CACD;AA3DD,kDA2DC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils/internal\";\n\nimport type { ChangeRebaser, GraphCommit } from \"../core/index.js\";\n\nimport type { ChangeEnricherReadonlyCheckout } from \"./changeEnricher.js\";\n\n/**\n * Utility for producing an enriched commit out of multiple transaction steps\n */\nexport class TransactionEnricher<TChange> {\n\treadonly #rebaser: ChangeRebaser<TChange>;\n\treadonly #enricher: ChangeEnricherReadonlyCheckout<TChange>;\n\t#transactionCommits: GraphCommit<TChange>[] = [];\n\t/**\n\t * The number of commits before the start of each active transaction scope.\n\t * For a stack of `n` transaction scopes, the array will contain `n` integers,\n\t * where the integer at index `i` is the number of commits made before the start of the `i`th transaction scope\n\t * (therefore, the first element in the array, if present, is always 0)\n\t */\n\treadonly #transactionScopesStart: number[] = [];\n\n\tpublic constructor(\n\t\trebaser: ChangeRebaser<TChange>,\n\t\tenricher: ChangeEnricherReadonlyCheckout<TChange>,\n\t) {\n\t\tthis.#rebaser = rebaser;\n\t\tthis.#enricher = enricher;\n\t}\n\n\tpublic isTransacting(): boolean {\n\t\treturn this.#transactionScopesStart.length > 0;\n\t}\n\n\tpublic startTransaction(): void {\n\t\tthis.#transactionScopesStart.push(this.#transactionCommits.length);\n\t}\n\n\t/**\n\t * Commits the current transaction.\n\t * @returns A function which can be used to compute the composed change for that transaction's commits. Undefined if the transaction is still ongoing or contained no committed changes.\n\t */\n\tpublic commitTransaction(): (() => TChange) | undefined {\n\t\tconst commitsCommitted = this.#transactionScopesStart.pop();\n\t\tassert(commitsCommitted !== undefined, 0x985 /* No transaction to commit */);\n\t\tif (this.#transactionScopesStart.length === 0) {\n\t\t\tif (this.#transactionCommits.length === 0) {\n\t\t\t\treturn undefined;\n\t\t\t}\n\t\t\tconst transactionCommits = this.#transactionCommits;\n\t\t\tthis.#transactionCommits = [];\n\t\t\treturn () => this.#rebaser.compose(transactionCommits);\n\t\t}\n\t}\n\n\tpublic abortTransaction(): void {\n\t\tconst scopeStart = this.#transactionScopesStart.pop();\n\t\tassert(scopeStart !== undefined, 0x986 /* No transaction to abort */);\n\t\tthis.#transactionCommits.length = scopeStart;\n\t}\n\n\tpublic addTransactionStep(commit: GraphCommit<TChange>): void {\n\t\tassert(\n\t\t\tthis.#transactionScopesStart.length > 0,\n\t\t\t0x987 /* No transaction to add a step to */,\n\t\t);\n\t\tconst change = this.#enricher.updateChangeEnrichments(commit.change, commit.revision);\n\t\tthis.#transactionCommits.push({ ...commit, change });\n\t}\n}\n"]}

package/lib/shared-tree-core/transactionEnricher.d.ts

@@ -1,23 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import type { ChangeRebaser, GraphCommit } from "../core/index.js";
-import type { ChangeEnricherReadonlyCheckout } from "./changeEnricher.js";
-/**
- * Utility for producing an enriched commit out of multiple transaction steps
- */
-export declare class TransactionEnricher<TChange> {
-    #private;
-    constructor(rebaser: ChangeRebaser<TChange>, enricher: ChangeEnricherReadonlyCheckout<TChange>);
-    isTransacting(): boolean;
-    startTransaction(): void;
-    /**
-     * Commits the current transaction.
-     * @returns A function which can be used to compute the composed change for that transaction's commits. Undefined if the transaction is still ongoing or contained no committed changes.
-     */
-    commitTransaction(): (() => TChange) | undefined;
-    abortTransaction(): void;
-    addTransactionStep(commit: GraphCommit<TChange>): void;
-}
-//# sourceMappingURL=transactionEnricher.d.ts.map

package/lib/shared-tree-core/transactionEnricher.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"transactionEnricher.d.ts","sourceRoot":"","sources":["../../src/shared-tree-core/transactionEnricher.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEnE,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,qBAAqB,CAAC;AAE1E;;GAEG;AACH,qBAAa,mBAAmB,CAAC,OAAO;;gBAatC,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC,EAC/B,QAAQ,EAAE,8BAA8B,CAAC,OAAO,CAAC;IAM3C,aAAa,IAAI,OAAO;IAIxB,gBAAgB,IAAI,IAAI;IAI/B;;;OAGG;IACI,iBAAiB,IAAI,CAAC,MAAM,OAAO,CAAC,GAAG,SAAS;IAahD,gBAAgB,IAAI,IAAI;IAMxB,kBAAkB,CAAC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,GAAG,IAAI;CAQ7D"}

package/lib/shared-tree-core/transactionEnricher.js

@@ -1,70 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _TransactionEnricher_rebaser, _TransactionEnricher_enricher, _TransactionEnricher_transactionCommits, _TransactionEnricher_transactionScopesStart;
-import { assert } from "@fluidframework/core-utils/internal";
-/**
- * Utility for producing an enriched commit out of multiple transaction steps
- */
-export class TransactionEnricher {
-    constructor(rebaser, enricher) {
-        _TransactionEnricher_rebaser.set(this, void 0);
-        _TransactionEnricher_enricher.set(this, void 0);
-        _TransactionEnricher_transactionCommits.set(this, []);
-        /**
-         * The number of commits before the start of each active transaction scope.
-         * For a stack of `n` transaction scopes, the array will contain `n` integers,
-         * where the integer at index `i` is the number of commits made before the start of the `i`th transaction scope
-         * (therefore, the first element in the array, if present, is always 0)
-         */
-        _TransactionEnricher_transactionScopesStart.set(this, []);
-        __classPrivateFieldSet(this, _TransactionEnricher_rebaser, rebaser, "f");
-        __classPrivateFieldSet(this, _TransactionEnricher_enricher, enricher, "f");
-    }
-    isTransacting() {
-        return __classPrivateFieldGet(this, _TransactionEnricher_transactionScopesStart, "f").length > 0;
-    }
-    startTransaction() {
-        __classPrivateFieldGet(this, _TransactionEnricher_transactionScopesStart, "f").push(__classPrivateFieldGet(this, _TransactionEnricher_transactionCommits, "f").length);
-    }
-    /**
-     * Commits the current transaction.
-     * @returns A function which can be used to compute the composed change for that transaction's commits. Undefined if the transaction is still ongoing or contained no committed changes.
-     */
-    commitTransaction() {
-        const commitsCommitted = __classPrivateFieldGet(this, _TransactionEnricher_transactionScopesStart, "f").pop();
-        assert(commitsCommitted !== undefined, 0x985 /* No transaction to commit */);
-        if (__classPrivateFieldGet(this, _TransactionEnricher_transactionScopesStart, "f").length === 0) {
-            if (__classPrivateFieldGet(this, _TransactionEnricher_transactionCommits, "f").length === 0) {
-                return undefined;
-            }
-            const transactionCommits = __classPrivateFieldGet(this, _TransactionEnricher_transactionCommits, "f");
-            __classPrivateFieldSet(this, _TransactionEnricher_transactionCommits, [], "f");
-            return () => __classPrivateFieldGet(this, _TransactionEnricher_rebaser, "f").compose(transactionCommits);
-        }
-    }
-    abortTransaction() {
-        const scopeStart = __classPrivateFieldGet(this, _TransactionEnricher_transactionScopesStart, "f").pop();
-        assert(scopeStart !== undefined, 0x986 /* No transaction to abort */);
-        __classPrivateFieldGet(this, _TransactionEnricher_transactionCommits, "f").length = scopeStart;
-    }
-    addTransactionStep(commit) {
-        assert(__classPrivateFieldGet(this, _TransactionEnricher_transactionScopesStart, "f").length > 0, 0x987 /* No transaction to add a step to */);
-        const change = __classPrivateFieldGet(this, _TransactionEnricher_enricher, "f").updateChangeEnrichments(commit.change, commit.revision);
-        __classPrivateFieldGet(this, _TransactionEnricher_transactionCommits, "f").push({ ...commit, change });
-    }
-}
-_TransactionEnricher_rebaser = new WeakMap(), _TransactionEnricher_enricher = new WeakMap(), _TransactionEnricher_transactionCommits = new WeakMap(), _TransactionEnricher_transactionScopesStart = new WeakMap();
-//# sourceMappingURL=transactionEnricher.js.map

package/lib/shared-tree-core/transactionEnricher.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"transactionEnricher.js","sourceRoot":"","sources":["../../src/shared-tree-core/transactionEnricher.ts"],"names":[],"mappings":"AAAA;;;GAGG;;;;;;;;;;;;;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAM7D;;GAEG;AACH,MAAM,OAAO,mBAAmB;IAY/B,YACC,OAA+B,EAC/B,QAAiD;QAbzC,+CAAiC;QACjC,gDAAmD;QAC5D,kDAA8C,EAAE,EAAC;QACjD;;;;;WAKG;QACM,sDAAoC,EAAE,EAAC;QAM/C,uBAAA,IAAI,gCAAY,OAAO,MAAA,CAAC;QACxB,uBAAA,IAAI,iCAAa,QAAQ,MAAA,CAAC;IAC3B,CAAC;IAEM,aAAa;QACnB,OAAO,uBAAA,IAAI,mDAAwB,CAAC,MAAM,GAAG,CAAC,CAAC;IAChD,CAAC;IAEM,gBAAgB;QACtB,uBAAA,IAAI,mDAAwB,CAAC,IAAI,CAAC,uBAAA,IAAI,+CAAoB,CAAC,MAAM,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACI,iBAAiB;QACvB,MAAM,gBAAgB,GAAG,uBAAA,IAAI,mDAAwB,CAAC,GAAG,EAAE,CAAC;QAC5D,MAAM,CAAC,gBAAgB,KAAK,SAAS,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAC7E,IAAI,uBAAA,IAAI,mDAAwB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/C,IAAI,uBAAA,IAAI,+CAAoB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC3C,OAAO,SAAS,CAAC;YAClB,CAAC;YACD,MAAM,kBAAkB,GAAG,uBAAA,IAAI,+CAAoB,CAAC;YACpD,uBAAA,IAAI,2CAAuB,EAAE,MAAA,CAAC;YAC9B,OAAO,GAAG,EAAE,CAAC,uBAAA,IAAI,oCAAS,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACxD,CAAC;IACF,CAAC;IAEM,gBAAgB;QACtB,MAAM,UAAU,GAAG,uBAAA,IAAI,mDAAwB,CAAC,GAAG,EAAE,CAAC;QACtD,MAAM,CAAC,UAAU,KAAK,SAAS,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACtE,uBAAA,IAAI,+CAAoB,CAAC,MAAM,GAAG,UAAU,CAAC;IAC9C,CAAC;IAEM,kBAAkB,CAAC,MAA4B;QACrD,MAAM,CACL,uBAAA,IAAI,mDAAwB,CAAC,MAAM,GAAG,CAAC,EACvC,KAAK,CAAC,qCAAqC,CAC3C,CAAC;QACF,MAAM,MAAM,GAAG,uBAAA,IAAI,qCAAU,CAAC,uBAAuB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;QACtF,uBAAA,IAAI,+CAAoB,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACtD,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils/internal\";\n\nimport type { ChangeRebaser, GraphCommit } from \"../core/index.js\";\n\nimport type { ChangeEnricherReadonlyCheckout } from \"./changeEnricher.js\";\n\n/**\n * Utility for producing an enriched commit out of multiple transaction steps\n */\nexport class TransactionEnricher<TChange> {\n\treadonly #rebaser: ChangeRebaser<TChange>;\n\treadonly #enricher: ChangeEnricherReadonlyCheckout<TChange>;\n\t#transactionCommits: GraphCommit<TChange>[] = [];\n\t/**\n\t * The number of commits before the start of each active transaction scope.\n\t * For a stack of `n` transaction scopes, the array will contain `n` integers,\n\t * where the integer at index `i` is the number of commits made before the start of the `i`th transaction scope\n\t * (therefore, the first element in the array, if present, is always 0)\n\t */\n\treadonly #transactionScopesStart: number[] = [];\n\n\tpublic constructor(\n\t\trebaser: ChangeRebaser<TChange>,\n\t\tenricher: ChangeEnricherReadonlyCheckout<TChange>,\n\t) {\n\t\tthis.#rebaser = rebaser;\n\t\tthis.#enricher = enricher;\n\t}\n\n\tpublic isTransacting(): boolean {\n\t\treturn this.#transactionScopesStart.length > 0;\n\t}\n\n\tpublic startTransaction(): void {\n\t\tthis.#transactionScopesStart.push(this.#transactionCommits.length);\n\t}\n\n\t/**\n\t * Commits the current transaction.\n\t * @returns A function which can be used to compute the composed change for that transaction's commits. Undefined if the transaction is still ongoing or contained no committed changes.\n\t */\n\tpublic commitTransaction(): (() => TChange) | undefined {\n\t\tconst commitsCommitted = this.#transactionScopesStart.pop();\n\t\tassert(commitsCommitted !== undefined, 0x985 /* No transaction to commit */);\n\t\tif (this.#transactionScopesStart.length === 0) {\n\t\t\tif (this.#transactionCommits.length === 0) {\n\t\t\t\treturn undefined;\n\t\t\t}\n\t\t\tconst transactionCommits = this.#transactionCommits;\n\t\t\tthis.#transactionCommits = [];\n\t\t\treturn () => this.#rebaser.compose(transactionCommits);\n\t\t}\n\t}\n\n\tpublic abortTransaction(): void {\n\t\tconst scopeStart = this.#transactionScopesStart.pop();\n\t\tassert(scopeStart !== undefined, 0x986 /* No transaction to abort */);\n\t\tthis.#transactionCommits.length = scopeStart;\n\t}\n\n\tpublic addTransactionStep(commit: GraphCommit<TChange>): void {\n\t\tassert(\n\t\t\tthis.#transactionScopesStart.length > 0,\n\t\t\t0x987 /* No transaction to add a step to */,\n\t\t);\n\t\tconst change = this.#enricher.updateChangeEnrichments(commit.change, commit.revision);\n\t\tthis.#transactionCommits.push({ ...commit, change });\n\t}\n}\n"]}

package/src/shared-tree-core/transactionEnricher.ts

@@ -1,74 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { assert } from "@fluidframework/core-utils/internal";
-
-import type { ChangeRebaser, GraphCommit } from "../core/index.js";
-
-import type { ChangeEnricherReadonlyCheckout } from "./changeEnricher.js";
-
-/**
- * Utility for producing an enriched commit out of multiple transaction steps
- */
-export class TransactionEnricher<TChange> {
-	readonly #rebaser: ChangeRebaser<TChange>;
-	readonly #enricher: ChangeEnricherReadonlyCheckout<TChange>;
-	#transactionCommits: GraphCommit<TChange>[] = [];
-	/**
-	 * The number of commits before the start of each active transaction scope.
-	 * For a stack of `n` transaction scopes, the array will contain `n` integers,
-	 * where the integer at index `i` is the number of commits made before the start of the `i`th transaction scope
-	 * (therefore, the first element in the array, if present, is always 0)
-	 */
-	readonly #transactionScopesStart: number[] = [];
-
-	public constructor(
-		rebaser: ChangeRebaser<TChange>,
-		enricher: ChangeEnricherReadonlyCheckout<TChange>,
-	) {
-		this.#rebaser = rebaser;
-		this.#enricher = enricher;
-	}
-
-	public isTransacting(): boolean {
-		return this.#transactionScopesStart.length > 0;
-	}
-
-	public startTransaction(): void {
-		this.#transactionScopesStart.push(this.#transactionCommits.length);
-	}
-
-	/**
-	 * Commits the current transaction.
-	 * @returns A function which can be used to compute the composed change for that transaction's commits. Undefined if the transaction is still ongoing or contained no committed changes.
-	 */
-	public commitTransaction(): (() => TChange) | undefined {
-		const commitsCommitted = this.#transactionScopesStart.pop();
-		assert(commitsCommitted !== undefined, 0x985 /* No transaction to commit */);
-		if (this.#transactionScopesStart.length === 0) {
-			if (this.#transactionCommits.length === 0) {
-				return undefined;
-			}
-			const transactionCommits = this.#transactionCommits;
-			this.#transactionCommits = [];
-			return () => this.#rebaser.compose(transactionCommits);
-		}
-	}
-
-	public abortTransaction(): void {
-		const scopeStart = this.#transactionScopesStart.pop();
-		assert(scopeStart !== undefined, 0x986 /* No transaction to abort */);
-		this.#transactionCommits.length = scopeStart;
-	}
-
-	public addTransactionStep(commit: GraphCommit<TChange>): void {
-		assert(
-			this.#transactionScopesStart.length > 0,
-			0x987 /* No transaction to add a step to */,
-		);
-		const change = this.#enricher.updateChangeEnrichments(commit.change, commit.revision);
-		this.#transactionCommits.push({ ...commit, change });
-	}
-}