@fluidframework/merge-tree 2.1.0-281041 → 2.1.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @fluidframework/merge-tree
 
+## 2.1.0
+
+### Minor Changes
+
+-   The Marker.fromJSONObject and TextSegment.fromJSONObject argument types have been corrected ([#21684](https://github.com/microsoft/FluidFramework/pull/21684)) [d2d472bd88](https://github.com/microsoft/FluidFramework/commit/d2d472bd88d8360bb77303079eebef16d5a69131)
+
+    Previously, the arguments of `Marker.fromJSONObject` and `TextSegment.fromJSONObject` were of type `any`. However, at
+    runtime only certain types were expected and using other types would cause errors.
+
+    Now, the argument for the Marker implementation is of type `IJSONSegment` and the argument for the TextSegment
+    implementation is of type `string | IJSONSegment`. This reflects actual runtime support.
+
+    This change should have no impact on existing code unless the code is using incorrect types. Such code already does not
+    function and should be corrected.
+
 ## 2.0.0-rc.5.0.0
 
 ### Minor Changes

package/README.md

@@ -35,6 +35,10 @@ To access the `public` ([SemVer](https://semver.org/)) APIs, import via `@fluidf
 
 To access the `legacy` APIs, import via `@fluidframework/merge-tree/legacy`.
 
+## API Documentation
+
+API documentation for **@fluidframework/merge-tree** is available at <https://fluidframework.com/docs/apis/merge-tree>.
+
 <!-- prettier-ignore-end -->
 
 <!-- AUTO-GENERATED-CONTENT:END -->
@@ -137,10 +141,6 @@ remote clients and should be ignored when processing remote ops.
 <!-- prettier-ignore-start -->
 <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
 
-## API Documentation
-
-API documentation for **@fluidframework/merge-tree** is available at <https://fluidframework.com/docs/apis/merge-tree>.
-
 ## Minimum Client Requirements
 
 These are the platform requirements for the current version of Fluid Framework Client Packages.

package/dist/ordinal.js

@@ -21,7 +21,7 @@ function computeHierarchicalOrdinal(maxCount, actualCount, parentOrdinal, previo
     else {
         // eslint-disable-next-line unicorn/prefer-code-point
         const prevOrdCode = previousOrdinal.charCodeAt(previousOrdinal.length - 1);
-        (0, internal_1.assert)(prevOrdCode !== undefined, "previous ordinal should not be empty");
+        (0, internal_1.assert)(prevOrdCode !== undefined, 0x9ad /* previous ordinal should not be empty */);
         const localOrdinal = prevOrdCode + ordinalWidth;
         // eslint-disable-next-line unicorn/prefer-code-point
         ordinal = parentOrdinal + String.fromCharCode(localOrdinal);

package/dist/ordinal.js.map

@@ -1 +1 @@
-{"version":3,"file":"ordinal.js","sourceRoot":"","sources":["../src/ordinal.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+BAA+B;AAC/B,kEAA6D;AAE7D,SAAgB,0BAA0B,CACzC,QAAgB,EAChB,WAAmB,EACnB,aAAqB,EACrB,eAAmC;IAEnC,IAAA,iBAAM,EACL,QAAQ,IAAI,EAAE,IAAI,WAAW,IAAI,QAAQ,EACzC,KAAK,CAAC,6DAA6D,CACnE,CAAC;IAEF,MAAM,YAAY,GAAG,CAAC,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC,CAAC;IACnD,IAAI,OAAe,CAAC;IACpB,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;QACnC,qHAAqH;QACrH,iGAAiG;QACjG,kEAAkE;QAClE,qDAAqD;QACrD,OAAO,GAAG,aAAa,GAAG,MAAM,CAAC,YAAY,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;IACjE,CAAC;SAAM,CAAC;QACP,qDAAqD;QACrD,MAAM,WAAW,GAAG,eAAe,CAAC,UAAU,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC3E,IAAA,iBAAM,EAAC,WAAW,KAAK,SAAS,EAAE,sCAAsC,CAAC,CAAC;QAC1E,MAAM,YAAY,GAAG,WAAW,GAAG,YAAY,CAAC;QAChD,qDAAqD;QACrD,OAAO,GAAG,aAAa,GAAG,MAAM,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;IAC7D,CAAC;IAED,OAAO,OAAO,CAAC;AAChB,CAAC;AA7BD,gEA6BC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/* eslint-disable no-bitwise */\nimport { assert } from \"@fluidframework/core-utils/internal\";\n\nexport function computeHierarchicalOrdinal(\n\tmaxCount: number,\n\tactualCount: number,\n\tparentOrdinal: string,\n\tpreviousOrdinal: string | undefined,\n): string {\n\tassert(\n\t\tmaxCount <= 16 && actualCount <= maxCount,\n\t\t0x3f0 /* count must be less than max, and max must be 16 or less */,\n\t);\n\n\tconst ordinalWidth = 1 << (maxCount - actualCount);\n\tlet ordinal: string;\n\tif (previousOrdinal === undefined) {\n\t\t// Ordinals exist purely for lexicographical sort order and use a small set of valid bytes for each string character.\n\t\t// The extra handling fromCodePoint has for things like surrogate pairs is therefore unnecessary.\n\t\t// disable the rule to use code points when dealing with ordinals.\n\t\t// eslint-disable-next-line unicorn/prefer-code-point\n\t\tordinal = parentOrdinal + String.fromCharCode(ordinalWidth - 1);\n\t} else {\n\t\t// eslint-disable-next-line unicorn/prefer-code-point\n\t\tconst prevOrdCode = previousOrdinal.charCodeAt(previousOrdinal.length - 1);\n\t\tassert(prevOrdCode !== undefined, \"previous ordinal should not be empty\");\n\t\tconst localOrdinal = prevOrdCode + ordinalWidth;\n\t\t// eslint-disable-next-line unicorn/prefer-code-point\n\t\tordinal = parentOrdinal + String.fromCharCode(localOrdinal);\n\t}\n\n\treturn ordinal;\n}\n"]}
+{"version":3,"file":"ordinal.js","sourceRoot":"","sources":["../src/ordinal.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+BAA+B;AAC/B,kEAA6D;AAE7D,SAAgB,0BAA0B,CACzC,QAAgB,EAChB,WAAmB,EACnB,aAAqB,EACrB,eAAmC;IAEnC,IAAA,iBAAM,EACL,QAAQ,IAAI,EAAE,IAAI,WAAW,IAAI,QAAQ,EACzC,KAAK,CAAC,6DAA6D,CACnE,CAAC;IAEF,MAAM,YAAY,GAAG,CAAC,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC,CAAC;IACnD,IAAI,OAAe,CAAC;IACpB,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;QACnC,qHAAqH;QACrH,iGAAiG;QACjG,kEAAkE;QAClE,qDAAqD;QACrD,OAAO,GAAG,aAAa,GAAG,MAAM,CAAC,YAAY,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;IACjE,CAAC;SAAM,CAAC;QACP,qDAAqD;QACrD,MAAM,WAAW,GAAG,eAAe,CAAC,UAAU,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC3E,IAAA,iBAAM,EAAC,WAAW,KAAK,SAAS,EAAE,KAAK,CAAC,0CAA0C,CAAC,CAAC;QACpF,MAAM,YAAY,GAAG,WAAW,GAAG,YAAY,CAAC;QAChD,qDAAqD;QACrD,OAAO,GAAG,aAAa,GAAG,MAAM,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;IAC7D,CAAC;IAED,OAAO,OAAO,CAAC;AAChB,CAAC;AA7BD,gEA6BC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/* eslint-disable no-bitwise */\nimport { assert } from \"@fluidframework/core-utils/internal\";\n\nexport function computeHierarchicalOrdinal(\n\tmaxCount: number,\n\tactualCount: number,\n\tparentOrdinal: string,\n\tpreviousOrdinal: string | undefined,\n): string {\n\tassert(\n\t\tmaxCount <= 16 && actualCount <= maxCount,\n\t\t0x3f0 /* count must be less than max, and max must be 16 or less */,\n\t);\n\n\tconst ordinalWidth = 1 << (maxCount - actualCount);\n\tlet ordinal: string;\n\tif (previousOrdinal === undefined) {\n\t\t// Ordinals exist purely for lexicographical sort order and use a small set of valid bytes for each string character.\n\t\t// The extra handling fromCodePoint has for things like surrogate pairs is therefore unnecessary.\n\t\t// disable the rule to use code points when dealing with ordinals.\n\t\t// eslint-disable-next-line unicorn/prefer-code-point\n\t\tordinal = parentOrdinal + String.fromCharCode(ordinalWidth - 1);\n\t} else {\n\t\t// eslint-disable-next-line unicorn/prefer-code-point\n\t\tconst prevOrdCode = previousOrdinal.charCodeAt(previousOrdinal.length - 1);\n\t\tassert(prevOrdCode !== undefined, 0x9ad /* previous ordinal should not be empty */);\n\t\tconst localOrdinal = prevOrdCode + ordinalWidth;\n\t\t// eslint-disable-next-line unicorn/prefer-code-point\n\t\tordinal = parentOrdinal + String.fromCharCode(localOrdinal);\n\t}\n\n\treturn ordinal;\n}\n"]}

package/lib/ordinal.js

@@ -18,7 +18,7 @@ export function computeHierarchicalOrdinal(maxCount, actualCount, parentOrdinal,
     else {
         // eslint-disable-next-line unicorn/prefer-code-point
         const prevOrdCode = previousOrdinal.charCodeAt(previousOrdinal.length - 1);
-        assert(prevOrdCode !== undefined, "previous ordinal should not be empty");
+        assert(prevOrdCode !== undefined, 0x9ad /* previous ordinal should not be empty */);
         const localOrdinal = prevOrdCode + ordinalWidth;
         // eslint-disable-next-line unicorn/prefer-code-point
         ordinal = parentOrdinal + String.fromCharCode(localOrdinal);

package/lib/ordinal.js.map

@@ -1 +1 @@
-{"version":3,"file":"ordinal.js","sourceRoot":"","sources":["../src/ordinal.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,+BAA+B;AAC/B,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAE7D,MAAM,UAAU,0BAA0B,CACzC,QAAgB,EAChB,WAAmB,EACnB,aAAqB,EACrB,eAAmC;IAEnC,MAAM,CACL,QAAQ,IAAI,EAAE,IAAI,WAAW,IAAI,QAAQ,EACzC,KAAK,CAAC,6DAA6D,CACnE,CAAC;IAEF,MAAM,YAAY,GAAG,CAAC,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC,CAAC;IACnD,IAAI,OAAe,CAAC;IACpB,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;QACnC,qHAAqH;QACrH,iGAAiG;QACjG,kEAAkE;QAClE,qDAAqD;QACrD,OAAO,GAAG,aAAa,GAAG,MAAM,CAAC,YAAY,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;IACjE,CAAC;SAAM,CAAC;QACP,qDAAqD;QACrD,MAAM,WAAW,GAAG,eAAe,CAAC,UAAU,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC3E,MAAM,CAAC,WAAW,KAAK,SAAS,EAAE,sCAAsC,CAAC,CAAC;QAC1E,MAAM,YAAY,GAAG,WAAW,GAAG,YAAY,CAAC;QAChD,qDAAqD;QACrD,OAAO,GAAG,aAAa,GAAG,MAAM,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;IAC7D,CAAC;IAED,OAAO,OAAO,CAAC;AAChB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/* eslint-disable no-bitwise */\nimport { assert } from \"@fluidframework/core-utils/internal\";\n\nexport function computeHierarchicalOrdinal(\n\tmaxCount: number,\n\tactualCount: number,\n\tparentOrdinal: string,\n\tpreviousOrdinal: string | undefined,\n): string {\n\tassert(\n\t\tmaxCount <= 16 && actualCount <= maxCount,\n\t\t0x3f0 /* count must be less than max, and max must be 16 or less */,\n\t);\n\n\tconst ordinalWidth = 1 << (maxCount - actualCount);\n\tlet ordinal: string;\n\tif (previousOrdinal === undefined) {\n\t\t// Ordinals exist purely for lexicographical sort order and use a small set of valid bytes for each string character.\n\t\t// The extra handling fromCodePoint has for things like surrogate pairs is therefore unnecessary.\n\t\t// disable the rule to use code points when dealing with ordinals.\n\t\t// eslint-disable-next-line unicorn/prefer-code-point\n\t\tordinal = parentOrdinal + String.fromCharCode(ordinalWidth - 1);\n\t} else {\n\t\t// eslint-disable-next-line unicorn/prefer-code-point\n\t\tconst prevOrdCode = previousOrdinal.charCodeAt(previousOrdinal.length - 1);\n\t\tassert(prevOrdCode !== undefined, \"previous ordinal should not be empty\");\n\t\tconst localOrdinal = prevOrdCode + ordinalWidth;\n\t\t// eslint-disable-next-line unicorn/prefer-code-point\n\t\tordinal = parentOrdinal + String.fromCharCode(localOrdinal);\n\t}\n\n\treturn ordinal;\n}\n"]}
+{"version":3,"file":"ordinal.js","sourceRoot":"","sources":["../src/ordinal.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,+BAA+B;AAC/B,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAE7D,MAAM,UAAU,0BAA0B,CACzC,QAAgB,EAChB,WAAmB,EACnB,aAAqB,EACrB,eAAmC;IAEnC,MAAM,CACL,QAAQ,IAAI,EAAE,IAAI,WAAW,IAAI,QAAQ,EACzC,KAAK,CAAC,6DAA6D,CACnE,CAAC;IAEF,MAAM,YAAY,GAAG,CAAC,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC,CAAC;IACnD,IAAI,OAAe,CAAC;IACpB,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;QACnC,qHAAqH;QACrH,iGAAiG;QACjG,kEAAkE;QAClE,qDAAqD;QACrD,OAAO,GAAG,aAAa,GAAG,MAAM,CAAC,YAAY,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;IACjE,CAAC;SAAM,CAAC;QACP,qDAAqD;QACrD,MAAM,WAAW,GAAG,eAAe,CAAC,UAAU,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC3E,MAAM,CAAC,WAAW,KAAK,SAAS,EAAE,KAAK,CAAC,0CAA0C,CAAC,CAAC;QACpF,MAAM,YAAY,GAAG,WAAW,GAAG,YAAY,CAAC;QAChD,qDAAqD;QACrD,OAAO,GAAG,aAAa,GAAG,MAAM,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;IAC7D,CAAC;IAED,OAAO,OAAO,CAAC;AAChB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/* eslint-disable no-bitwise */\nimport { assert } from \"@fluidframework/core-utils/internal\";\n\nexport function computeHierarchicalOrdinal(\n\tmaxCount: number,\n\tactualCount: number,\n\tparentOrdinal: string,\n\tpreviousOrdinal: string | undefined,\n): string {\n\tassert(\n\t\tmaxCount <= 16 && actualCount <= maxCount,\n\t\t0x3f0 /* count must be less than max, and max must be 16 or less */,\n\t);\n\n\tconst ordinalWidth = 1 << (maxCount - actualCount);\n\tlet ordinal: string;\n\tif (previousOrdinal === undefined) {\n\t\t// Ordinals exist purely for lexicographical sort order and use a small set of valid bytes for each string character.\n\t\t// The extra handling fromCodePoint has for things like surrogate pairs is therefore unnecessary.\n\t\t// disable the rule to use code points when dealing with ordinals.\n\t\t// eslint-disable-next-line unicorn/prefer-code-point\n\t\tordinal = parentOrdinal + String.fromCharCode(ordinalWidth - 1);\n\t} else {\n\t\t// eslint-disable-next-line unicorn/prefer-code-point\n\t\tconst prevOrdCode = previousOrdinal.charCodeAt(previousOrdinal.length - 1);\n\t\tassert(prevOrdCode !== undefined, 0x9ad /* previous ordinal should not be empty */);\n\t\tconst localOrdinal = prevOrdCode + ordinalWidth;\n\t\t// eslint-disable-next-line unicorn/prefer-code-point\n\t\tordinal = parentOrdinal + String.fromCharCode(localOrdinal);\n\t}\n\n\treturn ordinal;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/merge-tree",
-  "version": "2.1.0-281041",
+  "version": "2.1.0",
   "description": "Merge tree",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -79,30 +79,30 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "2.1.0-281041",
-    "@fluidframework/container-definitions": "2.1.0-281041",
-    "@fluidframework/core-interfaces": "2.1.0-281041",
-    "@fluidframework/core-utils": "2.1.0-281041",
-    "@fluidframework/datastore-definitions": "2.1.0-281041",
-    "@fluidframework/driver-definitions": "2.1.0-281041",
-    "@fluidframework/runtime-definitions": "2.1.0-281041",
-    "@fluidframework/runtime-utils": "2.1.0-281041",
-    "@fluidframework/shared-object-base": "2.1.0-281041",
-    "@fluidframework/telemetry-utils": "2.1.0-281041"
+    "@fluid-internal/client-utils": "~2.1.0",
+    "@fluidframework/container-definitions": "~2.1.0",
+    "@fluidframework/core-interfaces": "~2.1.0",
+    "@fluidframework/core-utils": "~2.1.0",
+    "@fluidframework/datastore-definitions": "~2.1.0",
+    "@fluidframework/driver-definitions": "~2.1.0",
+    "@fluidframework/runtime-definitions": "~2.1.0",
+    "@fluidframework/runtime-utils": "~2.1.0",
+    "@fluidframework/shared-object-base": "~2.1.0",
+    "@fluidframework/telemetry-utils": "~2.1.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
     "@biomejs/biome": "~1.8.3",
-    "@fluid-internal/mocha-test-setup": "2.1.0-281041",
-    "@fluid-private/stochastic-test-utils": "2.1.0-281041",
-    "@fluid-private/test-pairwise-generator": "2.1.0-281041",
+    "@fluid-internal/mocha-test-setup": "~2.1.0",
+    "@fluid-private/stochastic-test-utils": "~2.1.0",
+    "@fluid-private/test-pairwise-generator": "~2.1.0",
     "@fluid-tools/benchmark": "^0.48.0",
-    "@fluid-tools/build-cli": "^0.40.0",
+    "@fluid-tools/build-cli": "^0.41.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.40.0",
+    "@fluidframework/build-tools": "^0.41.0",
     "@fluidframework/eslint-config-fluid": "^5.3.0",
     "@fluidframework/merge-tree-previous": "npm:@fluidframework/merge-tree@2.0.0",
-    "@fluidframework/test-runtime-utils": "2.1.0-281041",
+    "@fluidframework/test-runtime-utils": "~2.1.0",
     "@microsoft/api-extractor": "^7.45.1",
     "@types/diff": "^3.5.1",
     "@types/mocha": "^9.1.1",

package/src/ordinal.ts

@@ -28,7 +28,7 @@ export function computeHierarchicalOrdinal(
 	} else {
 		// eslint-disable-next-line unicorn/prefer-code-point
 		const prevOrdCode = previousOrdinal.charCodeAt(previousOrdinal.length - 1);
-		assert(prevOrdCode !== undefined, "previous ordinal should not be empty");
+		assert(prevOrdCode !== undefined, 0x9ad /* previous ordinal should not be empty */);
 		const localOrdinal = prevOrdCode + ordinalWidth;
 		// eslint-disable-next-line unicorn/prefer-code-point
 		ordinal = parentOrdinal + String.fromCharCode(localOrdinal);