@fluidframework/runtime-utils 2.0.0-dev-rc.3.0.0.254513 → 2.0.0-dev-rc.3.0.0.254674

package/dist/alpha.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */
+export {
+	// alpha APIs
+	RequestParser, 
+	RuntimeFactoryHelper, 
+	SummaryTreeBuilder, 
+	convertToSummaryTreeWithStats
+} from "./index.js";

package/dist/beta.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */

package/dist/public.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */

package/lib/alpha.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */
+export {
+	// alpha APIs
+	RequestParser, 
+	RuntimeFactoryHelper, 
+	SummaryTreeBuilder, 
+	convertToSummaryTreeWithStats
+} from "./index.js";

package/lib/beta.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */

package/lib/public.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/runtime-utils",
-  "version": "2.0.0-dev-rc.3.0.0.254513",
+  "version": "2.0.0-dev-rc.3.0.0.254674",
   "description": "Collection of utility functions for Fluid Runtime",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -15,21 +15,21 @@
   "exports": {
     ".": {
       "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": {
       "import": {
-        "types": "./lib/runtime-utils-alpha.d.ts",
+        "types": "./lib/alpha.d.ts",
         "default": "./lib/index.js"
       },
       "require": {
-        "types": "./dist/runtime-utils-alpha.d.ts",
+        "types": "./dist/alpha.d.ts",
         "default": "./dist/index.js"
       }
     },
@@ -45,7 +45,7 @@
     }
   },
   "main": "dist/index.js",
-  "types": "./dist/runtime-utils-public.d.ts",
+  "types": "./dist/public.d.ts",
   "c8": {
     "all": true,
     "cache-dir": "nyc/.cache",
@@ -67,21 +67,21 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "2.0.0-dev-rc.3.0.0.254513",
-    "@fluidframework/container-definitions": "2.0.0-dev-rc.3.0.0.254513",
-    "@fluidframework/container-runtime-definitions": "2.0.0-dev-rc.3.0.0.254513",
-    "@fluidframework/core-interfaces": "2.0.0-dev-rc.3.0.0.254513",
-    "@fluidframework/core-utils": "2.0.0-dev-rc.3.0.0.254513",
-    "@fluidframework/datastore-definitions": "2.0.0-dev-rc.3.0.0.254513",
-    "@fluidframework/driver-utils": "2.0.0-dev-rc.3.0.0.254513",
+    "@fluid-internal/client-utils": "2.0.0-dev-rc.3.0.0.254674",
+    "@fluidframework/container-definitions": "2.0.0-dev-rc.3.0.0.254674",
+    "@fluidframework/container-runtime-definitions": "2.0.0-dev-rc.3.0.0.254674",
+    "@fluidframework/core-interfaces": "2.0.0-dev-rc.3.0.0.254674",
+    "@fluidframework/core-utils": "2.0.0-dev-rc.3.0.0.254674",
+    "@fluidframework/datastore-definitions": "2.0.0-dev-rc.3.0.0.254674",
+    "@fluidframework/driver-utils": "2.0.0-dev-rc.3.0.0.254674",
     "@fluidframework/protocol-definitions": "^3.2.0",
-    "@fluidframework/runtime-definitions": "2.0.0-dev-rc.3.0.0.254513",
-    "@fluidframework/telemetry-utils": "2.0.0-dev-rc.3.0.0.254513"
+    "@fluidframework/runtime-definitions": "2.0.0-dev-rc.3.0.0.254674",
+    "@fluidframework/telemetry-utils": "2.0.0-dev-rc.3.0.0.254674"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
     "@biomejs/biome": "^1.6.2",
-    "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.3.0.0.254513",
+    "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.3.0.0.254674",
     "@fluid-tools/build-cli": "^0.35.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.35.0",
@@ -105,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": {
@@ -127,12 +115,12 @@
   },
   "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 --outDir ./dist",
+    "api-extractor:esnext": "flub generate entrypoints --outDir ./lib",
     "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",

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/internal';
-import { IContainerRuntime } from '@fluidframework/container-runtime-definitions/internal';
-import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions/internal';
-import { IFluidDataStoreRegistry } from '@fluidframework/runtime-definitions/internal';
-import { IFluidHandleContext } from '@fluidframework/core-interfaces';
-import { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
-import { IProvideFluidDataStoreRegistry } from '@fluidframework/runtime-definitions/internal';
-import { IRequest } from '@fluidframework/core-interfaces';
-import { IRequestHeader } from '@fluidframework/core-interfaces';
-import { IResponse } from '@fluidframework/core-interfaces';
-import { IRuntime } from '@fluidframework/container-definitions/internal';
-import { IRuntimeFactory } from '@fluidframework/container-definitions/internal';
-import { ISnapshotTree } from '@fluidframework/protocol-definitions';
-import { ISnapshotTreeWithBlobContents } from '@fluidframework/container-definitions/internal';
-import { ISummarizeResult } from '@fluidframework/runtime-definitions/internal';
-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/internal';
-import { IContainerRuntime } from '@fluidframework/container-runtime-definitions/internal';
-import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions/internal';
-import { IFluidDataStoreRegistry } from '@fluidframework/runtime-definitions/internal';
-import { IFluidHandleContext } from '@fluidframework/core-interfaces';
-import { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
-import { IProvideFluidDataStoreRegistry } from '@fluidframework/runtime-definitions/internal';
-import { IRequest } from '@fluidframework/core-interfaces';
-import { IRequestHeader } from '@fluidframework/core-interfaces';
-import { IResponse } from '@fluidframework/core-interfaces';
-import { IRuntime } from '@fluidframework/container-definitions/internal';
-import { IRuntimeFactory } from '@fluidframework/container-definitions/internal';
-import { ISnapshotTree } from '@fluidframework/protocol-definitions';
-import { ISnapshotTreeWithBlobContents } from '@fluidframework/container-definitions/internal';
-import { ISummarizeResult } from '@fluidframework/runtime-definitions/internal';
-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 { }

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

@@ -1,109 +0,0 @@
-import { IChannelStorageService } from '@fluidframework/datastore-definitions';
-import { IContainerContext } from '@fluidframework/container-definitions/internal';
-import { IContainerRuntime } from '@fluidframework/container-runtime-definitions/internal';
-import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions/internal';
-import { IFluidDataStoreRegistry } from '@fluidframework/runtime-definitions/internal';
-import { IFluidHandleContext } from '@fluidframework/core-interfaces';
-import { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
-import { IProvideFluidDataStoreRegistry } from '@fluidframework/runtime-definitions/internal';
-import { IRequest } from '@fluidframework/core-interfaces';
-import { IRequestHeader } from '@fluidframework/core-interfaces';
-import { IResponse } from '@fluidframework/core-interfaces';
-import { IRuntime } from '@fluidframework/container-definitions/internal';
-import { IRuntimeFactory } from '@fluidframework/container-definitions/internal';
-import { ISnapshotTree } from '@fluidframework/protocol-definitions';
-import { ISnapshotTreeWithBlobContents } from '@fluidframework/container-definitions/internal';
-import { ISummarizeResult } from '@fluidframework/runtime-definitions/internal';
-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 { }