@fluidframework/runtime-utils 2.30.0 → 2.31.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/runtime-utils",
-  "version": "2.30.0",
+  "version": "2.31.0",
   "description": "Collection of utility functions for Fluid Runtime",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -69,27 +69,27 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.30.0",
-    "@fluidframework/container-definitions": "~2.30.0",
-    "@fluidframework/container-runtime-definitions": "~2.30.0",
-    "@fluidframework/core-interfaces": "~2.30.0",
-    "@fluidframework/core-utils": "~2.30.0",
-    "@fluidframework/datastore-definitions": "~2.30.0",
-    "@fluidframework/driver-definitions": "~2.30.0",
-    "@fluidframework/driver-utils": "~2.30.0",
-    "@fluidframework/runtime-definitions": "~2.30.0",
-    "@fluidframework/telemetry-utils": "~2.30.0"
+    "@fluid-internal/client-utils": "~2.31.0",
+    "@fluidframework/container-definitions": "~2.31.0",
+    "@fluidframework/container-runtime-definitions": "~2.31.0",
+    "@fluidframework/core-interfaces": "~2.31.0",
+    "@fluidframework/core-utils": "~2.31.0",
+    "@fluidframework/datastore-definitions": "~2.31.0",
+    "@fluidframework/driver-definitions": "~2.31.0",
+    "@fluidframework/driver-utils": "~2.31.0",
+    "@fluidframework/runtime-definitions": "~2.31.0",
+    "@fluidframework/telemetry-utils": "~2.31.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "~2.30.0",
+    "@fluid-internal/mocha-test-setup": "~2.31.0",
     "@fluid-tools/build-cli": "^0.54.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.54.0",
     "@fluidframework/eslint-config-fluid": "^5.7.3",
-    "@fluidframework/runtime-utils-previous": "npm:@fluidframework/runtime-utils@2.23.0",
-    "@microsoft/api-extractor": "7.47.8",
+    "@fluidframework/runtime-utils-previous": "npm:@fluidframework/runtime-utils@2.30.0",
+    "@microsoft/api-extractor": "7.50.1",
     "@types/mocha": "^10.0.10",
     "@types/node": "^18.19.0",
     "@types/sinon": "^17.0.3",
@@ -101,7 +101,6 @@
     "mocha": "^10.8.2",
     "mocha-multi-reporters": "^1.5.1",
     "moment": "^2.21.0",
-    "prettier": "~3.0.3",
     "rimraf": "^4.4.0",
     "sinon": "^18.0.1",
     "ts-node": "^10.9.1",
@@ -135,7 +134,6 @@
     "check:exports:esm:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.esm.json",
     "check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
     "check:format": "npm run check:biome",
-    "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
     "ci:build:api-reports": "concurrently \"npm:ci:build:api-reports:*\"",
     "ci:build:api-reports:current": "api-extractor run --config api-extractor/api-extractor.current.json",
     "ci:build:api-reports:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
@@ -145,7 +143,6 @@
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "format": "npm run format:biome",
     "format:biome": "biome check . --write",
-    "format:prettier": "prettier --write . --cache --ignore-path ../../../.prettierignore",
     "lint": "fluid-build . --task lint",
     "lint:fix": "fluid-build . --task eslint:fix --task format",
     "test": "npm run test:mocha",

package/src/summaryUtils.ts

@@ -215,9 +215,6 @@ export class SummaryTreeBuilder implements ISummaryTreeWithStats {
 	/**
 	 * Adds an {@link @fluidframework/driver-definitions#ISummaryHandle} that references a subtree, blob, or attachment in a previous summary.
 	 *
-	 * @remarks
-	 * There are special limitations to both the key and handle parameters: We use encodeURIComponent and decodeURIComponent to encode and decode the key and handle parameters after they are added to the summary tree. This means that the key and handle parameters must be valid URI components. If they are not, the encoding and decoding will fail and the summary will not be generated correctly.
-	 *
 	 * @param key - The key to store the handle at in the current summary tree being generated. Should not contain any "/" characters.
 	 * @param handleType - the type of {@link @fluidframework/driver-definitions#SummaryObject} besides a SummaryHandle, i.e. {@link @fluidframework/driver-definitions#SummaryType.Tree}, {@link @fluidframework/driver-definitions#SummaryType.Blob}, {@link @fluidframework/driver-definitions#SummaryType.Attachment}
 	 * @param handle - The path pointing to the part of the previous summary being used to duplicate the data. Use {@link @fluidframework/driver-definitions#ISummaryHandle.handle} to help generate proper handle strings. Should not contain any "/" characters.

package/src/utils.ts

@@ -34,16 +34,27 @@ export async function seqFromTree(
 	return attrib.sequenceNumber;
 }
 
+/**
+ * The following characters emulates the UTF-16 code sequence from 65 - 123, except for the `[` and `{`
+ * positioned at 91 and 123 respectively - which are changed to '(' and ')'. Used in the `encodeCompactIdToString` utility below.
+ * NOTE: The character set must never be changed - since it could result in collisions with existing ids.
+ * If changing, make sure to choose new characters that have never been
+ * used before, and the characters must not change their encoding with 'encodeURIComponent'.
+ * @internal
+ */
+export const charSetForEncodingIds =
+	"ABCDEFGHIJKLMNOPQRSTUVWXYZ(abcdefghijklmnopqrstuvwxyz)0123456789";
+
 /**
  * Encode compact ID (returned by IContainerRuntime.generateDocumentUniqueId()) to a compact string representation.
  * While this is the main usage pattern, it works with any non-negative integer or a string.
- * Strings are retured as is, and assumed to be UUIDs, i.e. unique enough to never overlap with
+ * Strings are returned as is, and assumed to be UUIDs, i.e. unique enough to never overlap with
  * numbers encoded as strings by this function. Any other strings are likely to run into collisions and should not be used!
  * This function is useful in places where we serialize resulting ID as string and use them as strings, thus we are not
  * gaining any efficiency from having a number type.
- * We do not provide a decode function, so this API is only useful only result is stored and there is no need to go back to origianl form.
+ * We do not provide a decode function, so this API is only useful only result is stored and there is no need to go back to original form.
  * @param idArg - input - either a non-negative integer or a string. Strings are returned as is, while numbers are encoded in compat form
- * @param prefix - optinal string prefix
+ * @param prefix - optional string prefix
  * @returns A string - representation of an input
  * @internal
  */
@@ -51,6 +62,7 @@ export function encodeCompactIdToString(idArg: number | string, prefix = "") {
 	if (typeof idArg === "string") {
 		return idArg;
 	}
+
 	// WARNING: result of this function are stored in storage!
 	// If you ever need to change this function, you will need to ensure that
 	// for any inputs N1 & N2, old(N1) !== new(N2), where old() - is the old implementation,
@@ -63,9 +75,6 @@ export function encodeCompactIdToString(idArg: number | string, prefix = "") {
 	let id = "";
 	let num = idArg;
 	do {
-		// 48-57 -> 0-9
-		// 65-91 > A-Z[
-		// 97-123 -> a-z}
 		// Here are some examples of the input & output:
 		// 0 -> 'A'
 		// 1 -> 'B'
@@ -74,8 +83,7 @@ export function encodeCompactIdToString(idArg: number | string, prefix = "") {
 		// 10000 -> 'BaQ'
 		// 100000 -> 'XZf'
 		const encode = num % 64;
-		const base = encode < 27 ? 65 : encode < 54 ? 97 - 27 : 48 - 54;
-		id = String.fromCharCode(base + encode) + id;
+		id = charSetForEncodingIds[encode] + id;
 		num = Math.floor(num / 64) - 1;
 	} while (num !== -1);
 	return prefix + id;

package/prettier.config.cjs

@@ -1,8 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-module.exports = {
-	...require("@fluidframework/build-common/prettier.config.cjs"),
-};