@fluidframework/runtime-utils 2.0.0-rc.2.0.2 → 2.0.0-rc.3.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/runtime-utils",
-  "version": "2.0.0-rc.2.0.2",
+  "version": "2.0.0-rc.3.0.1",
   "description": "Collection of utility functions for Fluid Runtime",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -15,31 +15,21 @@
   "exports": {
     ".": {
       "import": {
-        "types": "./lib/index.d.ts",
-        "default": "./lib/index.js"
-      },
-      "require": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      }
-    },
-    "./public": {
-      "import": {
-        "types": "./lib/runtime-utils-public.d.ts",
+        "types": "./lib/public.d.ts",
         "default": "./lib/index.js"
       },
       "require": {
-        "types": "./dist/runtime-utils-public.d.ts",
+        "types": "./dist/public.d.ts",
         "default": "./dist/index.js"
       }
     },
-    "./alpha": {
+    "./legacy": {
       "import": {
-        "types": "./lib/runtime-utils-alpha.d.ts",
+        "types": "./lib/legacy.d.ts",
         "default": "./lib/index.js"
       },
       "require": {
-        "types": "./dist/runtime-utils-alpha.d.ts",
+        "types": "./dist/legacy.d.ts",
         "default": "./dist/index.js"
       }
     },
@@ -54,8 +44,8 @@
       }
     }
   },
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "lib/index.js",
+  "types": "lib/public.d.ts",
   "c8": {
     "all": true,
     "cache-dir": "nyc/.cache",
@@ -77,24 +67,25 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": ">=2.0.0-rc.2.0.2 <2.0.0-rc.2.1.0",
-    "@fluidframework/container-definitions": ">=2.0.0-rc.2.0.2 <2.0.0-rc.2.1.0",
-    "@fluidframework/container-runtime-definitions": ">=2.0.0-rc.2.0.2 <2.0.0-rc.2.1.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-rc.2.0.2 <2.0.0-rc.2.1.0",
-    "@fluidframework/core-utils": ">=2.0.0-rc.2.0.2 <2.0.0-rc.2.1.0",
-    "@fluidframework/datastore-definitions": ">=2.0.0-rc.2.0.2 <2.0.0-rc.2.1.0",
-    "@fluidframework/driver-utils": ">=2.0.0-rc.2.0.2 <2.0.0-rc.2.1.0",
+    "@fluid-internal/client-utils": ">=2.0.0-rc.3.0.1 <2.0.0-rc.3.1.0",
+    "@fluidframework/container-definitions": ">=2.0.0-rc.3.0.1 <2.0.0-rc.3.1.0",
+    "@fluidframework/container-runtime-definitions": ">=2.0.0-rc.3.0.1 <2.0.0-rc.3.1.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-rc.3.0.1 <2.0.0-rc.3.1.0",
+    "@fluidframework/core-utils": ">=2.0.0-rc.3.0.1 <2.0.0-rc.3.1.0",
+    "@fluidframework/datastore-definitions": ">=2.0.0-rc.3.0.1 <2.0.0-rc.3.1.0",
+    "@fluidframework/driver-utils": ">=2.0.0-rc.3.0.1 <2.0.0-rc.3.1.0",
     "@fluidframework/protocol-definitions": "^3.2.0",
-    "@fluidframework/runtime-definitions": ">=2.0.0-rc.2.0.2 <2.0.0-rc.2.1.0",
-    "@fluidframework/telemetry-utils": ">=2.0.0-rc.2.0.2 <2.0.0-rc.2.1.0"
+    "@fluidframework/runtime-definitions": ">=2.0.0-rc.3.0.1 <2.0.0-rc.3.1.0",
+    "@fluidframework/telemetry-utils": ">=2.0.0-rc.3.0.1 <2.0.0-rc.3.1.0"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.13.3",
-    "@fluid-internal/mocha-test-setup": ">=2.0.0-rc.2.0.2 <2.0.0-rc.2.1.0",
-    "@fluid-tools/build-cli": "^0.34.0",
+    "@arethetypeswrong/cli": "^0.15.2",
+    "@biomejs/biome": "^1.6.2",
+    "@fluid-internal/mocha-test-setup": ">=2.0.0-rc.3.0.1 <2.0.0-rc.3.1.0",
+    "@fluid-tools/build-cli": "^0.37.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.34.0",
-    "@fluidframework/eslint-config-fluid": "^4.0.0",
+    "@fluidframework/build-tools": "^0.37.0",
+    "@fluidframework/eslint-config-fluid": "^5.1.0",
     "@fluidframework/runtime-utils-previous": "npm:@fluidframework/runtime-utils@2.0.0-internal.8.0.0",
     "@microsoft/api-extractor": "^7.42.3",
     "@types/mocha": "^9.1.1",
@@ -114,18 +105,6 @@
     "ts-node": "^10.9.1",
     "typescript": "~5.1.6"
   },
-  "fluidBuild": {
-    "tasks": {
-      "build:docs": {
-        "dependsOn": [
-          "...",
-          "api-extractor:commonjs",
-          "api-extractor:esnext"
-        ],
-        "script": false
-      }
-    }
-  },
   "typeValidation": {
     "broken": {
       "RemovedFunctionDeclaration_addTreeToSummary": {
@@ -136,27 +115,27 @@
   },
   "scripts": {
     "api": "fluid-build . --task api",
-    "api-extractor:commonjs": "api-extractor run --config ./api-extractor-cjs.json",
-    "api-extractor:esnext": "api-extractor run --local",
+    "api-extractor:commonjs": "flub generate entrypoints --outFileAlpha legacy --outDir ./dist",
+    "api-extractor:esnext": "flub generate entrypoints --outFileAlpha legacy --outDir ./lib --node10TypeCompat",
     "build": "fluid-build . --task build",
     "build:commonjs": "fluid-build . --task commonjs",
     "build:compile": "fluid-build . --task compile",
-    "build:docs": "fluid-build . --task api",
+    "build:docs": "api-extractor run --local",
     "build:esnext": "tsc --project ./tsconfig.json",
     "build:test": "npm run build:test:esm && npm run build:test:cjs",
     "build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
     "build:test:esm": "tsc --project ./src/test/tsconfig.json",
-    "check:are-the-types-wrong": "attw --pack . --entrypoints .",
+    "check:are-the-types-wrong": "attw --pack .",
+    "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
     "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
     "ci:build:docs": "api-extractor run",
-    "clean": "rimraf --glob dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
+    "clean": "rimraf --glob dist lib \"*.d.ts\" \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
-    "format": "npm run prettier:fix",
-    "lint": "npm run prettier && npm run check:release-tags && npm run eslint",
-    "lint:fix": "npm run prettier:fix && npm run eslint:fix",
-    "prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
-    "prettier:fix": "prettier --write . --cache --ignore-path ../../../.prettierignore",
+    "format": "fluid-build --task format .",
+    "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",
     "test:coverage": "c8 npm test",
     "test:mocha": "npm run test:mocha:esm && echo skipping cjs to avoid overhead - npm run test:mocha:cjs",

package/src/dataStoreHelpers.ts

@@ -3,14 +3,14 @@
  * Licensed under the MIT License.
  */
 
-import { assert } from "@fluidframework/core-utils";
 import { IRequest, IResponse } from "@fluidframework/core-interfaces";
+import { assert } from "@fluidframework/core-utils/internal";
 import {
 	IFluidDataStoreFactory,
 	IFluidDataStoreRegistry,
 	IProvideFluidDataStoreRegistry,
-} from "@fluidframework/runtime-definitions";
-import { generateErrorWithStack } from "@fluidframework/telemetry-utils";
+} from "@fluidframework/runtime-definitions/internal";
+import { generateErrorWithStack } from "@fluidframework/telemetry-utils/internal";
 
 interface IResponseException extends Error {
 	errorFromRequestFluidObject: true;
@@ -72,7 +72,7 @@ export function responseToException(response: IResponse, request: IRequest): Err
 }
 
 /**
- * @internal
+ * @alpha
  */
 export const create404Response = (request: IRequest) =>
 	createResponseError(404, "not found", request);

package/src/objectstoragepartition.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { assert } from "@fluidframework/core-utils";
+import { assert } from "@fluidframework/core-utils/internal";
 import { IChannelStorageService } from "@fluidframework/datastore-definitions";
 
 /**

package/src/requestParser.ts

@@ -2,6 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+
 import { IRequest, IRequestHeader } from "@fluidframework/core-interfaces";
 
 /**

package/src/runtimeFactoryHelper.ts

@@ -7,8 +7,8 @@ import {
 	IContainerContext,
 	IRuntime,
 	IRuntimeFactory,
-} from "@fluidframework/container-definitions";
-import { IContainerRuntime } from "@fluidframework/container-runtime-definitions";
+} from "@fluidframework/container-definitions/internal";
+import { IContainerRuntime } from "@fluidframework/container-runtime-definitions/internal";
 
 /**
  * @alpha

package/src/summaryUtils.ts

@@ -3,32 +3,36 @@
  * Licensed under the MIT License.
  */
 
-import type { TelemetryBaseEventPropertyType } from "@fluidframework/core-interfaces";
 import {
-	bufferToString,
-	fromBase64ToUtf8,
 	IsoBuffer,
 	Uint8ArrayToString,
+	bufferToString,
+	fromBase64ToUtf8,
 } from "@fluid-internal/client-utils";
-import { assert, unreachableCase } from "@fluidframework/core-utils";
-import { AttachmentTreeEntry, BlobTreeEntry, TreeTreeEntry } from "@fluidframework/driver-utils";
+import { ISnapshotTreeWithBlobContents } from "@fluidframework/container-definitions/internal";
+import type { TelemetryBaseEventPropertyType } from "@fluidframework/core-interfaces";
+import { assert, unreachableCase } from "@fluidframework/core-utils/internal";
 import {
-	ITree,
-	SummaryType,
+	AttachmentTreeEntry,
+	BlobTreeEntry,
+	TreeTreeEntry,
+} from "@fluidframework/driver-utils/internal";
+import {
+	ISummaryBlob,
 	ISummaryTree,
+	ITree,
+	ITreeEntry,
 	SummaryObject,
-	ISummaryBlob,
+	SummaryType,
 	TreeEntry,
-	ITreeEntry,
 } from "@fluidframework/protocol-definitions";
 import {
+	IGarbageCollectionData,
 	ISummaryStats,
-	ISummarizeResult,
 	ISummaryTreeWithStats,
 	ITelemetryContext,
-	IGarbageCollectionData,
 } from "@fluidframework/runtime-definitions";
-import { ISnapshotTreeWithBlobContents } from "@fluidframework/container-definitions";
+import { ISummarizeResult } from "@fluidframework/runtime-definitions/internal";
 
 /**
  * Combines summary stats by adding their totals together.

package/src/unpackUsedRoutes.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { assert } from "@fluidframework/core-utils";
+import { assert } from "@fluidframework/core-utils/internal";
 
 /**
  * Helper function that unpacks the used routes of children from a given node's used routes.

package/src/utils.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { assert } from "@fluidframework/core-utils";
+import { assert } from "@fluidframework/core-utils/internal";
 import { IDocumentAttributes, ISnapshotTree } from "@fluidframework/protocol-definitions";
 
 /**

package/api-extractor-cjs.json

@@ -1,8 +0,0 @@
-{
-	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../../common/build/build-common/api-extractor-base.cjs.primary.json",
-	// CJS is actually secondary; so, no report.
-	"apiReport": {
-		"enabled": false
-	}
-}

package/dist/runtime-utils-alpha.d.ts

@@ -1,161 +0,0 @@
-import { IChannelStorageService } from '@fluidframework/datastore-definitions';
-import { IContainerContext } from '@fluidframework/container-definitions';
-import { IContainerRuntime } from '@fluidframework/container-runtime-definitions';
-import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions';
-import { IFluidDataStoreRegistry } from '@fluidframework/runtime-definitions';
-import { IFluidHandleContext } from '@fluidframework/core-interfaces';
-import { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
-import { IProvideFluidDataStoreRegistry } from '@fluidframework/runtime-definitions';
-import { IRequest } from '@fluidframework/core-interfaces';
-import { IRequestHeader } from '@fluidframework/core-interfaces';
-import { IResponse } from '@fluidframework/core-interfaces';
-import { IRuntime } from '@fluidframework/container-definitions';
-import { IRuntimeFactory } from '@fluidframework/container-definitions';
-import { ISnapshotTree } from '@fluidframework/protocol-definitions';
-import { ISnapshotTreeWithBlobContents } from '@fluidframework/container-definitions';
-import { ISummarizeResult } from '@fluidframework/runtime-definitions';
-import { ISummaryBlob } from '@fluidframework/protocol-definitions';
-import { ISummaryStats } from '@fluidframework/runtime-definitions';
-import { ISummaryTree } from '@fluidframework/protocol-definitions';
-import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
-import { ITelemetryContext } from '@fluidframework/runtime-definitions';
-import { ITree } from '@fluidframework/protocol-definitions';
-import { SummaryObject } from '@fluidframework/protocol-definitions';
-import { SummaryType } from '@fluidframework/protocol-definitions';
-import type { TelemetryBaseEventPropertyType } from '@fluidframework/core-interfaces';
-
-/* Excluded from this release type: addBlobToSummary */
-
-/* Excluded from this release type: addSummarizeResultToSummary */
-
-/* Excluded from this release type: calculateStats */
-
-/* Excluded from this release type: convertSnapshotTreeToSummaryTree */
-
-/* Excluded from this release type: convertSummaryTreeToITree */
-
-/* Excluded from this release type: convertToSummaryTree */
-
-/**
- * Converts snapshot ITree to ISummaryTree format and tracks stats.
- * @param snapshot - snapshot in ITree format
- * @param fullTree - true to never use handles, even if id is specified
- * @alpha
- */
-export declare function convertToSummaryTreeWithStats(snapshot: ITree, fullTree?: boolean): ISummaryTreeWithStats;
-
-/* Excluded from this release type: create404Response */
-
-/* Excluded from this release type: createDataStoreFactory */
-
-/* Excluded from this release type: createResponseError */
-
-/* Excluded from this release type: encodeCompactIdToString */
-
-/* Excluded from this release type: exceptionToResponse */
-
-/* Excluded from this release type: Factory */
-
-/* Excluded from this release type: GCDataBuilder */
-
-/* Excluded from this release type: generateHandleContextPath */
-
-/* Excluded from this release type: getBlobSize */
-
-/* Excluded from this release type: getNormalizedObjectStoragePathParts */
-
-/* Excluded from this release type: ISerializedHandle */
-
-/* Excluded from this release type: isSerializedHandle */
-
-/* Excluded from this release type: listBlobsAtTreePath */
-
-/* Excluded from this release type: mergeStats */
-
-/* Excluded from this release type: ObjectStoragePartition */
-
-/* Excluded from this release type: processAttachMessageGCData */
-
-/* Excluded from this release type: ReadAndParseBlob */
-
-/**
- * The Request Parser takes an IRequest provides parsing and sub request creation
- * @alpha
- */
-export declare class RequestParser implements IRequest {
-    private readonly request;
-    /**
-     * Splits the path of the url and decodes each path part
-     * @param url - the url to get path parts of
-     */
-    static getPathParts(url: string): readonly string[];
-    private requestPathParts;
-    readonly query: string;
-    static create(request: Readonly<IRequest>): RequestParser;
-    protected constructor(request: Readonly<IRequest>);
-    get url(): string;
-    get headers(): IRequestHeader | undefined;
-    /**
-     * Returns the decoded path parts of the request's url
-     */
-    get pathParts(): readonly string[];
-    /**
-     * Returns true if it's a terminating path, i.e. no more elements after `elements` entries and empty query.
-     * @param elements - number of elements in path
-     */
-    isLeaf(elements: number): boolean;
-    /**
-     * Creates a sub request starting at a specific path part of this request's url
-     * The sub request url always has a leading slash, and always include query params if original url has any
-     * e.g. original url is /a/b/?queryParams, createSubRequest(0) is /a/b/?queryParams
-     * createSubRequest(1) is /b/?queryParams
-     * createSubRequest(2) is /?queryParams
-     * createSubRequest(n) where n is bigger than parts length, e.g. 2, or n is less than 0 will throw an exception
-     *
-     * note: query params are not counted towards path parts.
-     *
-     * @param startingPathIndex - The index of the first path part of the sub request
-     */
-    createSubRequest(startingPathIndex: number): IRequest;
-}
-
-/* Excluded from this release type: responseToException */
-
-/**
- * @alpha
- */
-export declare abstract class RuntimeFactoryHelper<T = IContainerRuntime> implements IRuntimeFactory {
-    get IRuntimeFactory(): this;
-    instantiateRuntime(context: IContainerContext, existing: boolean): Promise<IRuntime>;
-    abstract preInitialize(context: IContainerContext, existing: boolean): Promise<IRuntime & T>;
-    instantiateFirstTime(_runtime: T): Promise<void>;
-    instantiateFromExisting(_runtime: T): Promise<void>;
-    hasInitialized(_runtime: T): Promise<void>;
-}
-
-/* Excluded from this release type: seqFromTree */
-
-/**
- * @alpha
- */
-export declare class SummaryTreeBuilder implements ISummaryTreeWithStats {
-    private attachmentCounter;
-    get summary(): ISummaryTree;
-    get stats(): Readonly<ISummaryStats>;
-    constructor();
-    private readonly summaryTree;
-    private summaryStats;
-    addBlob(key: string, content: string | Uint8Array): void;
-    addHandle(key: string, handleType: SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment, handle: string): void;
-    addWithStats(key: string, summarizeResult: ISummarizeResult): void;
-    addAttachment(id: string): void;
-    getSummaryTree(): ISummaryTreeWithStats;
-}
-
-/* Excluded from this release type: TelemetryContext */
-
-/* Excluded from this release type: unpackChildNodesUsedRoutes */
-
-/* Excluded from this release type: utf8ByteLength */
-
-export { }

package/dist/runtime-utils-beta.d.ts

@@ -1,109 +0,0 @@
-import { IChannelStorageService } from '@fluidframework/datastore-definitions';
-import { IContainerContext } from '@fluidframework/container-definitions';
-import { IContainerRuntime } from '@fluidframework/container-runtime-definitions';
-import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions';
-import { IFluidDataStoreRegistry } from '@fluidframework/runtime-definitions';
-import { IFluidHandleContext } from '@fluidframework/core-interfaces';
-import { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
-import { IProvideFluidDataStoreRegistry } from '@fluidframework/runtime-definitions';
-import { IRequest } from '@fluidframework/core-interfaces';
-import { IRequestHeader } from '@fluidframework/core-interfaces';
-import { IResponse } from '@fluidframework/core-interfaces';
-import { IRuntime } from '@fluidframework/container-definitions';
-import { IRuntimeFactory } from '@fluidframework/container-definitions';
-import { ISnapshotTree } from '@fluidframework/protocol-definitions';
-import { ISnapshotTreeWithBlobContents } from '@fluidframework/container-definitions';
-import { ISummarizeResult } from '@fluidframework/runtime-definitions';
-import { ISummaryBlob } from '@fluidframework/protocol-definitions';
-import { ISummaryStats } from '@fluidframework/runtime-definitions';
-import { ISummaryTree } from '@fluidframework/protocol-definitions';
-import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
-import { ITelemetryContext } from '@fluidframework/runtime-definitions';
-import { ITree } from '@fluidframework/protocol-definitions';
-import { SummaryObject } from '@fluidframework/protocol-definitions';
-import { SummaryType } from '@fluidframework/protocol-definitions';
-import type { TelemetryBaseEventPropertyType } from '@fluidframework/core-interfaces';
-
-/* Excluded from this release type: addBlobToSummary */
-
-/* Excluded from this release type: addSummarizeResultToSummary */
-
-/* Excluded from this release type: calculateStats */
-
-/* Excluded from this release type: convertSnapshotTreeToSummaryTree */
-
-/* Excluded from this release type: convertSummaryTreeToITree */
-
-/* Excluded from this release type: convertToSummaryTree */
-
-/* Excluded from this release type: convertToSummaryTreeWithStats */
-
-/* Excluded from this release type: create404Response */
-
-/* Excluded from this release type: createDataStoreFactory */
-
-/* Excluded from this release type: createResponseError */
-
-/* Excluded from this release type: encodeCompactIdToString */
-
-/* Excluded from this release type: exceptionToResponse */
-
-/* Excluded from this release type: Factory */
-
-/* Excluded from this release type: GCDataBuilder */
-
-/* Excluded from this release type: generateHandleContextPath */
-
-/* Excluded from this release type: getBlobSize */
-
-/* Excluded from this release type: getNormalizedObjectStoragePathParts */
-
-/* Excluded from this release type: IContainerContext */
-
-/* Excluded from this release type: IContainerRuntime */
-
-/* Excluded from this release type: IFluidDataStoreFactory */
-
-/* Excluded from this release type: IFluidDataStoreRegistry */
-
-/* Excluded from this release type: IProvideFluidDataStoreRegistry */
-
-/* Excluded from this release type: IRuntime */
-
-/* Excluded from this release type: IRuntimeFactory */
-
-/* Excluded from this release type: ISerializedHandle */
-
-/* Excluded from this release type: ISnapshotTreeWithBlobContents */
-
-/* Excluded from this release type: isSerializedHandle */
-
-/* Excluded from this release type: ISummarizeResult */
-
-/* Excluded from this release type: listBlobsAtTreePath */
-
-/* Excluded from this release type: mergeStats */
-
-/* Excluded from this release type: ObjectStoragePartition */
-
-/* Excluded from this release type: processAttachMessageGCData */
-
-/* Excluded from this release type: ReadAndParseBlob */
-
-/* Excluded from this release type: RequestParser */
-
-/* Excluded from this release type: responseToException */
-
-/* Excluded from this release type: RuntimeFactoryHelper */
-
-/* Excluded from this release type: seqFromTree */
-
-/* Excluded from this release type: SummaryTreeBuilder */
-
-/* Excluded from this release type: TelemetryContext */
-
-/* Excluded from this release type: unpackChildNodesUsedRoutes */
-
-/* Excluded from this release type: utf8ByteLength */
-
-export { }