@fluidframework/runtime-utils 1.4.0-121020 → 2.0.0-dev-rc.1.0.0.224419

package/.eslintrc.js

@@ -4,10 +4,8 @@
  */
 
 module.exports = {
-    "extends": [
-        require.resolve("@fluidframework/eslint-config-fluid")
-    ],
-    "parserOptions": {
-        "project": ["./tsconfig.json", "./src/test/tsconfig.json"]
-    },
-}
+	extends: [require.resolve("@fluidframework/eslint-config-fluid/minimal"), "prettier"],
+	parserOptions: {
+		project: ["./tsconfig.json", "./src/test/tsconfig.json"],
+	},
+};

package/.mocharc.js

@@ -0,0 +1,12 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+"use strict";
+
+const getFluidTestMochaConfig = require("@fluidframework/mocha-test-setup/mocharc-common");
+
+const packageDir = __dirname;
+const config = getFluidTestMochaConfig(packageDir);
+module.exports = config;

package/CHANGELOG.md

@@ -0,0 +1,191 @@
+# @fluidframework/runtime-utils
+
+## 2.0.0-internal.8.0.0
+
+### Major Changes
+
+-   container-definitions: Fix ISnapshotTreeWithBlobContents and mark internal [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
+
+    `ISnapshotTreeWithBlobContents` is an internal type that should not be used externally. Additionally, the type didn't
+    match the usage, specifically in runtime-utils where an `any` cast was used to work around undefined blobContents. The
+    type has been updated to reflect that blobContents can be undefined.
+
+-   runtime-utils: Removed requestFluidObject [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
+
+    The `requestFluidObject` utility has been removed. Please migrate all usage of it to the new `entryPoint` pattern.
+
+    See [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md) for more details.
+
+## 2.0.0-internal.7.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.2.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.0.0
+
+### Major Changes
+
+-   Dependencies on @fluidframework/protocol-definitions package updated to 3.0.0 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    This included the following changes from the protocol-definitions release:
+
+    -   Updating signal interfaces for some planned improvements. The intention is split the interface between signals
+        submitted by clients to the server and the resulting signals sent from the server to clients.
+        -   A new optional type member is available on the ISignalMessage interface and a new ISentSignalMessage interface has
+            been added, which will be the typing for signals sent from the client to the server. Both extend a new
+            ISignalMessageBase interface that contains common members.
+    -   The @fluidframework/common-definitions package dependency has been updated to version 1.0.0.
+
+-   DEPRECATED: container-loader: Various request related APIs have been deprecated [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    Please remove all calls to the following functions and instead use the new `entryPoint` pattern:
+
+    -   `requestFluidObject`
+    -   `requestResolvedObjectFromContainer`
+    -   `getDefaultObjectFromContainer`
+    -   `getObjectWithIdFromContainer`
+    -   `getObjectFromContainer`
+
+    See [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md) for more details.
+
+-   Server upgrade: dependencies on Fluid server packages updated to 2.0.1 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    Dependencies on the following Fluid server package have been updated to version 2.0.1:
+
+    -   @fluidframework/gitresources: 2.0.1
+    -   @fluidframework/server-kafka-orderer: 2.0.1
+    -   @fluidframework/server-lambdas: 2.0.1
+    -   @fluidframework/server-lambdas-driver: 2.0.1
+    -   @fluidframework/server-local-server: 2.0.1
+    -   @fluidframework/server-memory-orderer: 2.0.1
+    -   @fluidframework/protocol-base: 2.0.1
+    -   @fluidframework/server-routerlicious: 2.0.1
+    -   @fluidframework/server-routerlicious-base: 2.0.1
+    -   @fluidframework/server-services: 2.0.1
+    -   @fluidframework/server-services-client: 2.0.1
+    -   @fluidframework/server-services-core: 2.0.1
+    -   @fluidframework/server-services-ordering-kafkanode: 2.0.1
+    -   @fluidframework/server-services-ordering-rdkafka: 2.0.1
+    -   @fluidframework/server-services-ordering-zookeeper: 2.0.1
+    -   @fluidframework/server-services-shared: 2.0.1
+    -   @fluidframework/server-services-telemetry: 2.0.1
+    -   @fluidframework/server-services-utils: 2.0.1
+    -   @fluidframework/server-test-utils: 2.0.1
+    -   tinylicious: 2.0.1
+
+-   Minimum TypeScript version now 5.1.6 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    The minimum supported TypeScript version for Fluid 2.0 clients is now 5.1.6.
+
+## 2.0.0-internal.6.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.2.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.0.0
+
+### Major Changes
+
+-   Upgraded typescript transpilation target to ES2020 [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
+
+    Upgraded typescript transpilation target to ES2020. This is done in order to decrease the bundle sizes of Fluid Framework packages. This has provided size improvements across the board for ex. Loader, Driver, Runtime etc. Reduced bundle sizes helps to load lesser code in apps and hence also helps to improve the perf.If any app wants to target any older versions of browsers with which this target version is not compatible, then they can use packages like babel to transpile to a older target.
+
+-   Remove packagePathToTelemetryProperty Function [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
+
+    packagePathToTelemetryProperty was previously deprecated and is now removed. Use tagCodeArtifacts instead.
+
+## 2.0.0-internal.5.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.2.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.0.0
+
+### Major Changes
+
+-   The `@fluidframework/garbage-collector` package was deprecated in version 2.0.0-internal.4.1.0. [8b242fdc79](https://github.com/microsoft/FluidFramework/commits/8b242fdc796714cf1da9ad3f90d02efb122af0c2)
+    It has now been removed with the following functions, interfaces, and types in it.
+
+    -   `cloneGCData`
+    -   `concatGarbageCollectionData`
+    -   `concatGarbageCollectionStates`
+    -   `GCDataBuilder`
+    -   `getGCDataFromSnapshot`
+    -   `IGCResult`
+    -   `removeRouteFromAllNodes`
+    -   `runGarbageCollection`
+    -   `trimLeadingAndTrailingSlashes`
+    -   `trimLeadingSlashes`
+    -   `trimTrailingSlashes`
+    -   `unpackChildNodesGCDetails`
+    -   `unpackChildNodesUsedRoutes`
+
+## 2.0.0-internal.4.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.4.1.0
+
+### Minor Changes
+
+-   GC interfaces removed from runtime-definitions ([#14750](https://github.com/microsoft/FluidFramework/pull-requests/14750)) [60274eacab](https://github.com/microsoft/FluidFramework/commits/60274eacabf14d42f52f6ad1c2f64356e64ba1a2)
+
+    The following interfaces available in `@fluidframework/runtime-definitions` are internal implementation details and have been deprecated for public use. They will be removed in an upcoming release.
+
+    -   `IGarbageCollectionNodeData`
+    -   `IGarbageCollectionState`
+    -   `IGarbageCollectionSnapshotData`
+    -   `IGarbageCollectionSummaryDetailsLegacy`
+
+-   @fluidframework/garbage-collector deprecated ([#14750](https://github.com/microsoft/FluidFramework/pull-requests/14750)) [60274eacab](https://github.com/microsoft/FluidFramework/commits/60274eacabf14d42f52f6ad1c2f64356e64ba1a2)
+
+    The `@fluidframework/garbage-collector` package is deprecated with the following functions, interfaces, and types in it.
+    These are internal implementation details and have been deprecated for public use. They will be removed in an upcoming
+    release.
+
+    -   `cloneGCData`
+    -   `concatGarbageCollectionData`
+    -   `concatGarbageCollectionStates`
+    -   `GCDataBuilder`
+    -   `getGCDataFromSnapshot`
+    -   `IGCResult`
+    -   `removeRouteFromAllNodes`
+    -   `runGarbageCollection`
+    -   `trimLeadingAndTrailingSlashes`
+    -   `trimLeadingSlashes`
+    -   `trimTrailingSlashes`
+    -   `unpackChildNodesGCDetails`
+    -   `unpackChildNodesUsedRoutes`

package/README.md

@@ -2,4 +2,71 @@
 
 This package contains code for common utilities used by Fluid Framework runtimes.
 
-See [GitHub](https://github.com/microsoft/FluidFramework) for more details on the Fluid Framework and packages within.
+<!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README:scripts=FALSE) -->
+
+<!-- prettier-ignore-start -->
+<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
+
+## Using Fluid Framework libraries
+
+When taking a dependency on a Fluid Framework library, we recommend using a `^` (caret) version range, such as `^1.3.4`.
+While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
+library consumers should always prefer `^`.
+
+Note that when depending on a library version of the form `2.0.0-internal.x.y.z`, called the Fluid internal version scheme,
+you must use a `>= <` dependency range (such as `>=2.0.0-internal.x.y.z <2.0.0-internal.w.0.0` where `w` is `x+1`).
+Standard `^` and `~` ranges will not work as expected.
+See the [@fluid-tools/version-tools](https://github.com/microsoft/FluidFramework/blob/main/build-tools/packages/version-tools/README.md)
+package for more information including tools to convert between version schemes.
+
+## Installation
+
+To get started, install the package by running the following command:
+
+```bash
+npm i @fluidframework/runtime-utils
+```
+
+## API Documentation
+
+API documentation for **@fluidframework/runtime-utils** is available at <https://fluidframework.com/docs/apis/runtime-utils>.
+
+## Contribution Guidelines
+
+There are many ways to [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid.
+
+-   Participate in Q&A in our [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
+-   [Submit bugs](https://github.com/microsoft/FluidFramework/issues) and help us verify fixes as they are checked in.
+-   Review the [source code changes](https://github.com/microsoft/FluidFramework/pulls).
+-   [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
+
+Detailed instructions for working in the repo can be found in the [Wiki](https://github.com/microsoft/FluidFramework/wiki).
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+
+This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
+Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
+Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
+
+## Help
+
+Not finding what you're looking for in this README? Check out our [GitHub
+Wiki](https://github.com/microsoft/FluidFramework/wiki) or [fluidframework.com](https://fluidframework.com/docs/).
+
+Still not finding what you're looking for? Please [file an
+issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
+
+Thank you!
+
+## Trademark
+
+This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
+
+Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
+
+Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
+
+<!-- prettier-ignore-end -->
+
+<!-- AUTO-GENERATED-CONTENT:END -->

package/api-extractor-lint.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-lint.json"
+}

package/api-extractor.json

@@ -1,4 +1,4 @@
 {
-  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  "extends": "@fluidframework/build-common/api-extractor-common-report.json"
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-base.json"
 }

package/api-report/runtime-utils.api.md

@@ -0,0 +1,201 @@
+## API Report File for "@fluidframework/runtime-utils"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+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 { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
+
+// @internal (undocumented)
+export function addBlobToSummary(summary: ISummaryTreeWithStats, key: string, content: string | Uint8Array): void;
+
+// @internal (undocumented)
+export function addSummarizeResultToSummary(summary: ISummaryTreeWithStats, key: string, summarizeResult: ISummarizeResult): void;
+
+// @internal (undocumented)
+export function addTreeToSummary(summary: ISummaryTreeWithStats, key: string, summarizeResult: ISummarizeResult): void;
+
+// @internal (undocumented)
+export function calculateStats(summary: SummaryObject): ISummaryStats;
+
+// @internal
+export function convertSnapshotTreeToSummaryTree(snapshot: ISnapshotTreeWithBlobContents): ISummaryTreeWithStats;
+
+// @internal
+export function convertSummaryTreeToITree(summaryTree: ISummaryTree): ITree;
+
+// @internal
+export function convertToSummaryTree(snapshot: ITree, fullTree?: boolean): ISummarizeResult;
+
+// @alpha
+export function convertToSummaryTreeWithStats(snapshot: ITree, fullTree?: boolean): ISummaryTreeWithStats;
+
+// @internal (undocumented)
+export const create404Response: (request: IRequest) => IResponse;
+
+// @internal (undocumented)
+export function createDataStoreFactory(type: string, factory: Factory | Promise<Factory>): IFluidDataStoreFactory & IFluidDataStoreRegistry;
+
+// @internal (undocumented)
+export function createResponseError(status: number, value: string, request: IRequest, headers?: {
+    [key: string]: any;
+}): IResponse;
+
+// @internal (undocumented)
+export function exceptionToResponse(err: any): IResponse;
+
+// @internal (undocumented)
+export type Factory = IFluidDataStoreFactory & Partial<IProvideFluidDataStoreRegistry>;
+
+// @internal
+export class GCDataBuilder implements IGarbageCollectionData {
+    // (undocumented)
+    addNode(id: string, outboundRoutes: string[]): void;
+    // (undocumented)
+    addNodes(gcNodes: {
+        [id: string]: string[];
+    }): void;
+    addRouteToAllNodes(outboundRoute: string): void;
+    // (undocumented)
+    get gcNodes(): {
+        [id: string]: string[];
+    };
+    // (undocumented)
+    getGCData(): IGarbageCollectionData;
+    prefixAndAddNodes(prefixId: string, gcNodes: {
+        [id: string]: string[];
+    }): void;
+}
+
+// @internal
+export function generateHandleContextPath(path: string, routeContext?: IFluidHandleContext): string;
+
+// @internal (undocumented)
+export function getBlobSize(content: ISummaryBlob["content"]): number;
+
+// @internal (undocumented)
+export function getNormalizedObjectStoragePathParts(path: string): string[];
+
+// @internal (undocumented)
+export function listBlobsAtTreePath(inputTree: ITree | undefined, path: string): Promise<string[]>;
+
+// @internal
+export function mergeStats(...stats: ISummaryStats[]): ISummaryStats;
+
+// @internal
+export class ObjectStoragePartition implements IChannelStorageService {
+    constructor(storage: IChannelStorageService, path: string);
+    // (undocumented)
+    contains(path: string): Promise<boolean>;
+    // (undocumented)
+    list(path: string): Promise<string[]>;
+    // (undocumented)
+    readBlob(path: string): Promise<ArrayBufferLike>;
+}
+
+// @internal
+export type ReadAndParseBlob = <T>(id: string) => Promise<T>;
+
+// @alpha
+export class RequestParser implements IRequest {
+    protected constructor(request: Readonly<IRequest>);
+    // (undocumented)
+    static create(request: Readonly<IRequest>): RequestParser;
+    createSubRequest(startingPathIndex: number): IRequest;
+    static getPathParts(url: string): readonly string[];
+    // (undocumented)
+    get headers(): IRequestHeader | undefined;
+    isLeaf(elements: number): boolean;
+    get pathParts(): readonly string[];
+    // (undocumented)
+    readonly query: string;
+    // (undocumented)
+    get url(): string;
+}
+
+// @internal (undocumented)
+export function responseToException(response: IResponse, request: IRequest): Error;
+
+// @alpha (undocumented)
+export abstract class RuntimeFactoryHelper<T = IContainerRuntime> implements IRuntimeFactory {
+    // (undocumented)
+    hasInitialized(_runtime: T): Promise<void>;
+    // (undocumented)
+    instantiateFirstTime(_runtime: T): Promise<void>;
+    // (undocumented)
+    instantiateFromExisting(_runtime: T): Promise<void>;
+    // (undocumented)
+    instantiateRuntime(context: IContainerContext, existing: boolean): Promise<IRuntime>;
+    // (undocumented)
+    get IRuntimeFactory(): this;
+    // (undocumented)
+    abstract preInitialize(context: IContainerContext, existing: boolean): Promise<IRuntime & T>;
+}
+
+// @internal
+export function seqFromTree(tree: ISnapshotTree, readAndParseBlob: ReadAndParseBlob): Promise<number>;
+
+// @alpha (undocumented)
+export class SummaryTreeBuilder implements ISummaryTreeWithStats {
+    constructor();
+    // (undocumented)
+    addAttachment(id: string): void;
+    // (undocumented)
+    addBlob(key: string, content: string | Uint8Array): void;
+    // (undocumented)
+    addHandle(key: string, handleType: SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment, handle: string): void;
+    // (undocumented)
+    addWithStats(key: string, summarizeResult: ISummarizeResult): void;
+    // (undocumented)
+    getSummaryTree(): ISummaryTreeWithStats;
+    // (undocumented)
+    get stats(): Readonly<ISummaryStats>;
+    // (undocumented)
+    get summary(): ISummaryTree;
+}
+
+// @internal (undocumented)
+export class TelemetryContext implements ITelemetryContext {
+    // (undocumented)
+    get(prefix: string, property: string): TelemetryEventPropertyType;
+    // (undocumented)
+    serialize(): string;
+    // (undocumented)
+    set(prefix: string, property: string, value: TelemetryEventPropertyType): void;
+    // (undocumented)
+    setMultiple(prefix: string, property: string, values: Record<string, TelemetryEventPropertyType>): void;
+}
+
+// @internal
+export function unpackChildNodesUsedRoutes(usedRoutes: readonly string[]): Map<string, string[]>;
+
+// @internal (undocumented)
+export function utf8ByteLength(str: string): number;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/dist/{dataStoreHandleContextUtils.js → dataStoreHandleContextUtils.cjs}

@@ -10,6 +10,7 @@ exports.generateHandleContextPath = void 0;
  * @param path - The path to the Fluid object relative to the route context.
  * @param routeContext - The route context that contains the Fluid object.
  * @returns The absolute path to the Fluid object from the root of the Container.
+ * @internal
  */
 function generateHandleContextPath(path, routeContext) {
     if (path === "") {
@@ -21,7 +22,9 @@ function generateHandleContextPath(path, routeContext) {
     else {
         // Remove beginning and trailing slashes, if any, from the path.
         let normalizedPath = path.startsWith("/") ? path.slice(1) : path;
-        normalizedPath = normalizedPath.endsWith("/") ? normalizedPath.slice(0, -1) : normalizedPath;
+        normalizedPath = normalizedPath.endsWith("/")
+            ? normalizedPath.slice(0, -1)
+            : normalizedPath;
         // If the routeContext does not exist, path is the absolute path.
         // If the routeContext exists, absolute path is routeContext's absolute path plus the path.
         return routeContext === undefined
@@ -30,4 +33,4 @@ function generateHandleContextPath(path, routeContext) {
     }
 }
 exports.generateHandleContextPath = generateHandleContextPath;
-//# sourceMappingURL=dataStoreHandleContextUtils.js.map
+//# sourceMappingURL=dataStoreHandleContextUtils.cjs.map

package/dist/dataStoreHandleContextUtils.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataStoreHandleContextUtils.cjs","sourceRoot":"","sources":["../src/dataStoreHandleContextUtils.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;;;;;GAMG;AACH,SAAgB,yBAAyB,CACxC,IAAY,EACZ,YAAkC;IAElC,IAAI,IAAI,KAAK,EAAE,EAAE;QAChB,uBAAuB;QACvB,wDAAwD;QACxD,yFAAyF;QACzF,OAAO,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,YAAY,CAAC;KACnE;SAAM;QACN,gEAAgE;QAChE,IAAI,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACjE,cAAc,GAAG,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC;YAC5C,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YAC7B,CAAC,CAAC,cAAc,CAAC;QAElB,iEAAiE;QACjE,2FAA2F;QAC3F,OAAO,YAAY,KAAK,SAAS;YAChC,CAAC,CAAC,IAAI,cAAc,EAAE;YACtB,CAAC,CAAC,GACA,YAAY,CAAC,YAAY,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,YACtD,IAAI,cAAc,EAAE,CAAC;KACxB;AACF,CAAC;AAxBD,8DAwBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandleContext } from \"@fluidframework/core-interfaces\";\n\n/**\n * Generates the absolute path for a Fluid object given its path and its parent routeContext.\n * @param path - The path to the Fluid object relative to the route context.\n * @param routeContext - The route context that contains the Fluid object.\n * @returns The absolute path to the Fluid object from the root of the Container.\n * @internal\n */\nexport function generateHandleContextPath(\n\tpath: string,\n\trouteContext?: IFluidHandleContext,\n): string {\n\tif (path === \"\") {\n\t\t// The `path` is empty.\n\t\t// If the routeContext does not exist, this is the root.\n\t\t// If the routeContext exists, the absolute path is the same as that of the routeContext.\n\t\treturn routeContext === undefined ? \"\" : routeContext.absolutePath;\n\t} else {\n\t\t// Remove beginning and trailing slashes, if any, from the path.\n\t\tlet normalizedPath = path.startsWith(\"/\") ? path.slice(1) : path;\n\t\tnormalizedPath = normalizedPath.endsWith(\"/\")\n\t\t\t? normalizedPath.slice(0, -1)\n\t\t\t: normalizedPath;\n\n\t\t// If the routeContext does not exist, path is the absolute path.\n\t\t// If the routeContext exists, absolute path is routeContext's absolute path plus the path.\n\t\treturn routeContext === undefined\n\t\t\t? `/${normalizedPath}`\n\t\t\t: `${\n\t\t\t\t\trouteContext.absolutePath === \"/\" ? \"\" : routeContext.absolutePath\n\t\t\t  }/${normalizedPath}`;\n\t}\n}\n"]}

package/dist/dataStoreHandleContextUtils.d.ts

@@ -8,6 +8,7 @@ import { IFluidHandleContext } from "@fluidframework/core-interfaces";
  * @param path - The path to the Fluid object relative to the route context.
  * @param routeContext - The route context that contains the Fluid object.
  * @returns The absolute path to the Fluid object from the root of the Container.
+ * @internal
  */
 export declare function generateHandleContextPath(path: string, routeContext?: IFluidHandleContext): string;
 //# sourceMappingURL=dataStoreHandleContextUtils.d.ts.map

package/dist/dataStoreHandleContextUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dataStoreHandleContextUtils.d.ts","sourceRoot":"","sources":["../src/dataStoreHandleContextUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAEtE;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,mBAAmB,GAAG,MAAM,CAiBlG"}
+{"version":3,"file":"dataStoreHandleContextUtils.d.ts","sourceRoot":"","sources":["../src/dataStoreHandleContextUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAEtE;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CACxC,IAAI,EAAE,MAAM,EACZ,YAAY,CAAC,EAAE,mBAAmB,GAChC,MAAM,CAqBR"}