@fluidframework/runtime-utils 2.0.0-internal.7.3.0 → 2.0.0-internal.7.4.0

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

@@ -0,0 +1,313 @@
+import { FluidObject } from '@fluidframework/core-interfaces';
+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 { IFluidRouter } 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 { 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
+ */
+export declare function addBlobToSummary(summary: ISummaryTreeWithStats, key: string, content: string | Uint8Array): void;
+
+/**
+ * @internal
+ */
+export declare function addSummarizeResultToSummary(summary: ISummaryTreeWithStats, key: string, summarizeResult: ISummarizeResult): void;
+
+/**
+ * @internal
+ */
+export declare function addTreeToSummary(summary: ISummaryTreeWithStats, key: string, summarizeResult: ISummarizeResult): void;
+
+/**
+ * @internal
+ */
+export declare function calculateStats(summary: SummaryObject): ISummaryStats;
+
+/**
+ * Converts ISnapshotTree to ISummaryTree format and tracks stats. This snapshot tree was
+ * was taken by serialize api in detached container.
+ * @param snapshot - snapshot in ISnapshotTree format
+ * @internal
+ */
+export declare function convertSnapshotTreeToSummaryTree(snapshot: ISnapshotTree): ISummaryTreeWithStats;
+
+/**
+ * Converts ISummaryTree to ITree format. This is needed for back-compat while we get rid of snapshot.
+ * @param summaryTree - summary tree in ISummaryTree format
+ * @internal
+ */
+export declare function convertSummaryTreeToITree(summaryTree: ISummaryTree): ITree;
+
+/**
+ * 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
+ * @internal
+ */
+export declare function convertToSummaryTree(snapshot: ITree, fullTree?: boolean): ISummarizeResult;
+
+/**
+ * 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
+ * @internal
+ */
+export declare function convertToSummaryTreeWithStats(snapshot: ITree, fullTree?: boolean): ISummaryTreeWithStats;
+
+/**
+ * @internal
+ */
+export declare const create404Response: (request: IRequest) => IResponse;
+
+/**
+ * @internal
+ */
+export declare function createDataStoreFactory(type: string, factory: Factory | Promise<Factory>): IFluidDataStoreFactory & IFluidDataStoreRegistry;
+
+/**
+ * @internal
+ */
+export declare function createResponseError(status: number, value: string, request: IRequest, headers?: {
+    [key: string]: any;
+}): IResponse;
+
+/**
+ * @internal
+ */
+export declare function exceptionToResponse(err: any): IResponse;
+
+/**
+ * @internal
+ */
+export declare type Factory = IFluidDataStoreFactory & Partial<IProvideFluidDataStoreRegistry>;
+
+/**
+ * Helper class to build the garbage collection data of a node by combining the data from multiple nodes.
+ * @internal
+ */
+export declare class GCDataBuilder implements IGarbageCollectionData {
+    private readonly gcNodesSet;
+    get gcNodes(): {
+        [id: string]: string[];
+    };
+    addNode(id: string, outboundRoutes: string[]): void;
+    /**
+     * Adds the given GC nodes. It does the following:
+     * - Normalizes the ids of the given nodes.
+     * - Prefixes the given `prefixId` to the given nodes' ids.
+     * - Adds the outbound routes of the nodes against the normalized and prefixed id.
+     */
+    prefixAndAddNodes(prefixId: string, gcNodes: {
+        [id: string]: string[];
+    }): void;
+    addNodes(gcNodes: {
+        [id: string]: string[];
+    }): void;
+    /**
+     * Adds the given outbound route to the outbound routes of all GC nodes.
+     */
+    addRouteToAllNodes(outboundRoute: string): void;
+    getGCData(): IGarbageCollectionData;
+}
+
+/**
+ * Generates the absolute path for a Fluid object given its path and its parent routeContext.
+ * @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;
+
+/**
+ * @internal
+ */
+export declare function getBlobSize(content: ISummaryBlob["content"]): number;
+
+/**
+ * @internal
+ */
+export declare function getNormalizedObjectStoragePathParts(path: string): string[];
+
+/**
+ * @internal
+ */
+export declare function listBlobsAtTreePath(inputTree: ITree | undefined, path: string): Promise<string[]>;
+
+/**
+ * Combines summary stats by adding their totals together.
+ * Returns empty stats if called without args.
+ * @param stats - stats to merge
+ * @internal
+ */
+export declare function mergeStats(...stats: ISummaryStats[]): ISummaryStats;
+
+/**
+ * Returns a new IChannelStorageService that resolves the given `path` as root.
+ * @internal
+ */
+export declare class ObjectStoragePartition implements IChannelStorageService {
+    private readonly storage;
+    private readonly path;
+    constructor(storage: IChannelStorageService, path: string);
+    readBlob(path: string): Promise<ArrayBufferLike>;
+    contains(path: string): Promise<boolean>;
+    list(path: string): Promise<string[]>;
+}
+
+/**
+ * Reads a blob from storage and parses it from JSON.
+ *
+ * @internal
+ */
+export declare type ReadAndParseBlob = <T>(id: string) => Promise<T>;
+
+/**
+ * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
+ * @internal
+ */
+export declare function requestFluidObject<T = FluidObject>(router: IFluidRouter, url: string | IRequest): Promise<T>;
+
+/**
+ * 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;
+}
+
+/**
+ * @internal
+ */
+export declare function responseToException(response: IResponse, request: IRequest): Error;
+
+/**
+ * @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>;
+}
+
+/**
+ * Fetches the sequence number of the snapshot tree by examining the protocol.
+ * @param tree - snapshot tree to examine
+ * @param readAndParseBlob - function to read blob contents from storage
+ * and parse the result from JSON.
+ * @internal
+ */
+export declare function seqFromTree(tree: ISnapshotTree, readAndParseBlob: ReadAndParseBlob): Promise<number>;
+
+/**
+ * @internal
+ */
+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;
+}
+
+/**
+ * @internal
+ */
+export declare class TelemetryContext implements ITelemetryContext {
+    private readonly telemetry;
+    /**
+     * {@inheritDoc @fluidframework/runtime-definitions#ITelemetryContext.set}
+     */
+    set(prefix: string, property: string, value: TelemetryEventPropertyType): void;
+    /**
+     * {@inheritDoc @fluidframework/runtime-definitions#ITelemetryContext.setMultiple}
+     */
+    setMultiple(prefix: string, property: string, values: Record<string, TelemetryEventPropertyType>): void;
+    /**
+     * {@inheritDoc @fluidframework/runtime-definitions#ITelemetryContext.get}
+     */
+    get(prefix: string, property: string): TelemetryEventPropertyType;
+    /**
+     * {@inheritDoc @fluidframework/runtime-definitions#ITelemetryContext.serialize}
+     */
+    serialize(): string;
+}
+
+/**
+ * Helper function that unpacks the used routes of children from a given node's used routes.
+ * @param usedRoutes - The used routes of a node.
+ * @returns A map of used routes of each children of the the given node.
+ * @internal
+ */
+export declare function unpackChildNodesUsedRoutes(usedRoutes: readonly string[]): Map<string, string[]>;
+
+/**
+ * @internal
+ */
+export declare function utf8ByteLength(str: string): number;
+
+export { }

package/dist/runtimeFactoryHelper.d.ts

@@ -4,6 +4,9 @@
  */
 import { IContainerContext, IRuntime, IRuntimeFactory } from "@fluidframework/container-definitions";
 import { IContainerRuntime } from "@fluidframework/container-runtime-definitions";
+/**
+ * @alpha
+ */
 export declare abstract class RuntimeFactoryHelper<T = IContainerRuntime> implements IRuntimeFactory {
     get IRuntimeFactory(): this;
     instantiateRuntime(context: IContainerContext, existing: boolean): Promise<IRuntime>;

package/dist/runtimeFactoryHelper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runtimeFactoryHelper.d.ts","sourceRoot":"","sources":["../src/runtimeFactoryHelper.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,iBAAiB,EACjB,QAAQ,EACR,eAAe,EACf,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAElF,8BAAsB,oBAAoB,CAAC,CAAC,GAAG,iBAAiB,CAAE,YAAW,eAAe;IAC3F,IAAW,eAAe,SAEzB;IAEY,kBAAkB,CAC9B,OAAO,EAAE,iBAAiB,EAC1B,QAAQ,EAAE,OAAO,GACf,OAAO,CAAC,QAAQ,CAAC;aASJ,aAAa,CAC5B,OAAO,EAAE,iBAAiB,EAC1B,QAAQ,EAAE,OAAO,GACf,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IACX,oBAAoB,CAAC,QAAQ,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAChD,uBAAuB,CAAC,QAAQ,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IACnD,cAAc,CAAC,QAAQ,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CACvD"}
+{"version":3,"file":"runtimeFactoryHelper.d.ts","sourceRoot":"","sources":["../src/runtimeFactoryHelper.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,iBAAiB,EACjB,QAAQ,EACR,eAAe,EACf,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAElF;;GAEG;AACH,8BAAsB,oBAAoB,CAAC,CAAC,GAAG,iBAAiB,CAAE,YAAW,eAAe;IAC3F,IAAW,eAAe,SAEzB;IAEY,kBAAkB,CAC9B,OAAO,EAAE,iBAAiB,EAC1B,QAAQ,EAAE,OAAO,GACf,OAAO,CAAC,QAAQ,CAAC;aASJ,aAAa,CAC5B,OAAO,EAAE,iBAAiB,EAC1B,QAAQ,EAAE,OAAO,GACf,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IACX,oBAAoB,CAAC,QAAQ,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAChD,uBAAuB,CAAC,QAAQ,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IACnD,cAAc,CAAC,QAAQ,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CACvD"}

package/dist/runtimeFactoryHelper.js

@@ -5,6 +5,9 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RuntimeFactoryHelper = void 0;
+/**
+ * @alpha
+ */
 class RuntimeFactoryHelper {
     get IRuntimeFactory() {
         return this;

package/dist/runtimeFactoryHelper.js.map

@@ -1 +1 @@
-{"version":3,"file":"runtimeFactoryHelper.js","sourceRoot":"","sources":["../src/runtimeFactoryHelper.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AASH,MAAsB,oBAAoB;IACzC,IAAW,eAAe;QACzB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAC9B,OAA0B,EAC1B,QAAiB;QAEjB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAC5D,MAAM,CAAC,QAAQ;YACd,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,OAAO,CAAC;YACvC,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,CAAC;QACvC,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACnC,OAAO,OAAO,CAAC;IAChB,CAAC;IAMM,KAAK,CAAC,oBAAoB,CAAC,QAAW,IAAkB,CAAC;IACzD,KAAK,CAAC,uBAAuB,CAAC,QAAW,IAAkB,CAAC;IAC5D,KAAK,CAAC,cAAc,CAAC,QAAW,IAAkB,CAAC;CAC1D;AAxBD,oDAwBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tIContainerContext,\n\tIRuntime,\n\tIRuntimeFactory,\n} from \"@fluidframework/container-definitions\";\nimport { IContainerRuntime } from \"@fluidframework/container-runtime-definitions\";\n\nexport abstract class RuntimeFactoryHelper<T = IContainerRuntime> implements IRuntimeFactory {\n\tpublic get IRuntimeFactory() {\n\t\treturn this;\n\t}\n\n\tpublic async instantiateRuntime(\n\t\tcontext: IContainerContext,\n\t\texisting: boolean,\n\t): Promise<IRuntime> {\n\t\tconst runtime = await this.preInitialize(context, existing);\n\t\tawait (existing\n\t\t\t? this.instantiateFromExisting(runtime)\n\t\t\t: this.instantiateFirstTime(runtime));\n\t\tawait this.hasInitialized(runtime);\n\t\treturn runtime;\n\t}\n\n\tpublic abstract preInitialize(\n\t\tcontext: IContainerContext,\n\t\texisting: boolean,\n\t): Promise<IRuntime & T>;\n\tpublic async instantiateFirstTime(_runtime: T): Promise<void> {}\n\tpublic async instantiateFromExisting(_runtime: T): Promise<void> {}\n\tpublic async hasInitialized(_runtime: T): Promise<void> {}\n}\n"]}
+{"version":3,"file":"runtimeFactoryHelper.js","sourceRoot":"","sources":["../src/runtimeFactoryHelper.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AASH;;GAEG;AACH,MAAsB,oBAAoB;IACzC,IAAW,eAAe;QACzB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAC9B,OAA0B,EAC1B,QAAiB;QAEjB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAC5D,MAAM,CAAC,QAAQ;YACd,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,OAAO,CAAC;YACvC,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,CAAC;QACvC,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACnC,OAAO,OAAO,CAAC;IAChB,CAAC;IAMM,KAAK,CAAC,oBAAoB,CAAC,QAAW,IAAkB,CAAC;IACzD,KAAK,CAAC,uBAAuB,CAAC,QAAW,IAAkB,CAAC;IAC5D,KAAK,CAAC,cAAc,CAAC,QAAW,IAAkB,CAAC;CAC1D;AAxBD,oDAwBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tIContainerContext,\n\tIRuntime,\n\tIRuntimeFactory,\n} from \"@fluidframework/container-definitions\";\nimport { IContainerRuntime } from \"@fluidframework/container-runtime-definitions\";\n\n/**\n * @alpha\n */\nexport abstract class RuntimeFactoryHelper<T = IContainerRuntime> implements IRuntimeFactory {\n\tpublic get IRuntimeFactory() {\n\t\treturn this;\n\t}\n\n\tpublic async instantiateRuntime(\n\t\tcontext: IContainerContext,\n\t\texisting: boolean,\n\t): Promise<IRuntime> {\n\t\tconst runtime = await this.preInitialize(context, existing);\n\t\tawait (existing\n\t\t\t? this.instantiateFromExisting(runtime)\n\t\t\t: this.instantiateFirstTime(runtime));\n\t\tawait this.hasInitialized(runtime);\n\t\treturn runtime;\n\t}\n\n\tpublic abstract preInitialize(\n\t\tcontext: IContainerContext,\n\t\texisting: boolean,\n\t): Promise<IRuntime & T>;\n\tpublic async instantiateFirstTime(_runtime: T): Promise<void> {}\n\tpublic async instantiateFromExisting(_runtime: T): Promise<void> {}\n\tpublic async hasInitialized(_runtime: T): Promise<void> {}\n}\n"]}

package/dist/summaryUtils.d.ts

@@ -9,14 +9,36 @@ import { ISummaryStats, ISummarizeResult, ISummaryTreeWithStats, ITelemetryConte
  * Combines summary stats by adding their totals together.
  * Returns empty stats if called without args.
  * @param stats - stats to merge
+ * @internal
  */
 export declare function mergeStats(...stats: ISummaryStats[]): ISummaryStats;
+/**
+ * @internal
+ */
 export declare function utf8ByteLength(str: string): number;
+/**
+ * @internal
+ */
 export declare function getBlobSize(content: ISummaryBlob["content"]): number;
+/**
+ * @internal
+ */
 export declare function calculateStats(summary: SummaryObject): ISummaryStats;
+/**
+ * @internal
+ */
 export declare function addBlobToSummary(summary: ISummaryTreeWithStats, key: string, content: string | Uint8Array): void;
+/**
+ * @internal
+ */
 export declare function addTreeToSummary(summary: ISummaryTreeWithStats, key: string, summarizeResult: ISummarizeResult): void;
+/**
+ * @internal
+ */
 export declare function addSummarizeResultToSummary(summary: ISummaryTreeWithStats, key: string, summarizeResult: ISummarizeResult): void;
+/**
+ * @internal
+ */
 export declare class SummaryTreeBuilder implements ISummaryTreeWithStats {
     private attachmentCounter;
     get summary(): ISummaryTree;
@@ -34,25 +56,32 @@ export declare class SummaryTreeBuilder implements ISummaryTreeWithStats {
  * 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
+ * @internal
  */
 export declare function convertToSummaryTreeWithStats(snapshot: ITree, fullTree?: boolean): ISummaryTreeWithStats;
 /**
  * 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
+ * @internal
  */
 export declare function convertToSummaryTree(snapshot: ITree, fullTree?: boolean): ISummarizeResult;
 /**
  * Converts ISnapshotTree to ISummaryTree format and tracks stats. This snapshot tree was
  * was taken by serialize api in detached container.
  * @param snapshot - snapshot in ISnapshotTree format
+ * @internal
  */
 export declare function convertSnapshotTreeToSummaryTree(snapshot: ISnapshotTree): ISummaryTreeWithStats;
 /**
  * Converts ISummaryTree to ITree format. This is needed for back-compat while we get rid of snapshot.
  * @param summaryTree - summary tree in ISummaryTree format
+ * @internal
  */
 export declare function convertSummaryTreeToITree(summaryTree: ISummaryTree): ITree;
+/**
+ * @internal
+ */
 export declare class TelemetryContext implements ITelemetryContext {
     private readonly telemetry;
     /**

package/dist/summaryUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"summaryUtils.d.ts","sourceRoot":"","sources":["../src/summaryUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAS7E,OAAO,EACN,KAAK,EACL,WAAW,EACX,YAAY,EACZ,aAAa,EACb,YAAY,EAGZ,aAAa,EACb,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACN,aAAa,EACb,gBAAgB,EAChB,qBAAqB,EACrB,iBAAiB,EACjB,sBAAsB,EACtB,MAAM,qCAAqC,CAAC;AAE7C;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,GAAG,KAAK,EAAE,aAAa,EAAE,GAAG,aAAa,CAgBnE;AAED,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAelD;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC,GAAG,MAAM,CAEpE;AAyBD,wBAAgB,cAAc,CAAC,OAAO,EAAE,aAAa,GAAG,aAAa,CAIpE;AAED,wBAAgB,gBAAgB,CAC/B,OAAO,EAAE,qBAAqB,EAC9B,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,MAAM,GAAG,UAAU,GAC1B,IAAI,CAQN;AAED,wBAAgB,gBAAgB,CAC/B,OAAO,EAAE,qBAAqB,EAC9B,GAAG,EAAE,MAAM,EACX,eAAe,EAAE,gBAAgB,GAC/B,IAAI,CAGN;AAED,wBAAgB,2BAA2B,CAC1C,OAAO,EAAE,qBAAqB,EAC9B,GAAG,EAAE,MAAM,EACX,eAAe,EAAE,gBAAgB,GAC/B,IAAI,CAGN;AAED,qBAAa,kBAAmB,YAAW,qBAAqB;IAC/D,OAAO,CAAC,iBAAiB,CAAa;IAEtC,IAAW,OAAO,IAAI,YAAY,CAKjC;IAED,IAAW,KAAK,IAAI,QAAQ,CAAC,aAAa,CAAC,CAE1C;;IAOD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAyC;IACrE,OAAO,CAAC,YAAY,CAAgB;IAE7B,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI;IAexD,SAAS,CACf,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,UAAU,EACxE,MAAM,EAAE,MAAM,GACZ,IAAI;IASA,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,eAAe,EAAE,gBAAgB,GAAG,IAAI;IAKlE,aAAa,CAAC,EAAE,EAAE,MAAM;IAIxB,cAAc,IAAI,qBAAqB;CAG9C;AAED;;;;GAIG;AACH,wBAAgB,6BAA6B,CAC5C,QAAQ,EAAE,KAAK,EACf,QAAQ,GAAE,OAAe,GACvB,qBAAqB,CAoCvB;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,GAAE,OAAe,GAAG,gBAAgB,CAgBjG;AAED;;;;GAIG;AACH,wBAAgB,gCAAgC,CAAC,QAAQ,EAAE,aAAa,GAAG,qBAAqB,CA2B/F;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CAAC,WAAW,EAAE,YAAY,GAAG,KAAK,CAuC1E;AAED,qBAAa,gBAAiB,YAAW,iBAAiB;IACzD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAiD;IAE3E;;OAEG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,0BAA0B,GAAG,IAAI;IAI9E;;OAEG;IACH,WAAW,CACV,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,GAChD,IAAI;IAOP;;OAEG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,0BAA0B;IAIjE;;OAEG;IACH,SAAS,IAAI,MAAM;CAOnB;AAoBD;;;GAGG;AACH,qBAAa,aAAc,YAAW,sBAAsB;IAC3D,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAqC;IAChE,IAAW,OAAO,IAAI;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE,CAM/C;IAEM,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE;IAInD;;;;;OAKG;IACI,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE;IAevE,QAAQ,CAAC,OAAO,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE;IAMnD;;OAEG;IACI,kBAAkB,CAAC,aAAa,EAAE,MAAM;IAMxC,SAAS,IAAI,sBAAsB;CAK1C"}
+{"version":3,"file":"summaryUtils.d.ts","sourceRoot":"","sources":["../src/summaryUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAS7E,OAAO,EACN,KAAK,EACL,WAAW,EACX,YAAY,EACZ,aAAa,EACb,YAAY,EAGZ,aAAa,EACb,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACN,aAAa,EACb,gBAAgB,EAChB,qBAAqB,EACrB,iBAAiB,EACjB,sBAAsB,EACtB,MAAM,qCAAqC,CAAC;AAE7C;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,KAAK,EAAE,aAAa,EAAE,GAAG,aAAa,CAgBnE;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAelD;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC,GAAG,MAAM,CAEpE;AAyBD;;GAEG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,aAAa,GAAG,aAAa,CAIpE;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC/B,OAAO,EAAE,qBAAqB,EAC9B,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,MAAM,GAAG,UAAU,GAC1B,IAAI,CAQN;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC/B,OAAO,EAAE,qBAAqB,EAC9B,GAAG,EAAE,MAAM,EACX,eAAe,EAAE,gBAAgB,GAC/B,IAAI,CAGN;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CAC1C,OAAO,EAAE,qBAAqB,EAC9B,GAAG,EAAE,MAAM,EACX,eAAe,EAAE,gBAAgB,GAC/B,IAAI,CAGN;AAED;;GAEG;AACH,qBAAa,kBAAmB,YAAW,qBAAqB;IAC/D,OAAO,CAAC,iBAAiB,CAAa;IAEtC,IAAW,OAAO,IAAI,YAAY,CAKjC;IAED,IAAW,KAAK,IAAI,QAAQ,CAAC,aAAa,CAAC,CAE1C;;IAOD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAyC;IACrE,OAAO,CAAC,YAAY,CAAgB;IAE7B,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI;IAexD,SAAS,CACf,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,UAAU,EACxE,MAAM,EAAE,MAAM,GACZ,IAAI;IASA,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,eAAe,EAAE,gBAAgB,GAAG,IAAI;IAKlE,aAAa,CAAC,EAAE,EAAE,MAAM;IAIxB,cAAc,IAAI,qBAAqB;CAG9C;AAED;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAC5C,QAAQ,EAAE,KAAK,EACf,QAAQ,GAAE,OAAe,GACvB,qBAAqB,CAoCvB;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,GAAE,OAAe,GAAG,gBAAgB,CAgBjG;AAED;;;;;GAKG;AACH,wBAAgB,gCAAgC,CAAC,QAAQ,EAAE,aAAa,GAAG,qBAAqB,CA2B/F;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAC,WAAW,EAAE,YAAY,GAAG,KAAK,CAuC1E;AAED;;GAEG;AACH,qBAAa,gBAAiB,YAAW,iBAAiB;IACzD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAiD;IAE3E;;OAEG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,0BAA0B,GAAG,IAAI;IAI9E;;OAEG;IACH,WAAW,CACV,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,GAChD,IAAI;IAOP;;OAEG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,0BAA0B;IAIjE;;OAEG;IACH,SAAS,IAAI,MAAM;CAOnB;AAoBD;;;GAGG;AACH,qBAAa,aAAc,YAAW,sBAAsB;IAC3D,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAqC;IAChE,IAAW,OAAO,IAAI;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE,CAM/C;IAEM,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE;IAInD;;;;;OAKG;IACI,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE;IAevE,QAAQ,CAAC,OAAO,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE;IAMnD;;OAEG;IACI,kBAAkB,CAAC,aAAa,EAAE,MAAM;IAMxC,SAAS,IAAI,sBAAsB;CAK1C"}

package/dist/summaryUtils.js

@@ -13,6 +13,7 @@ const protocol_definitions_1 = require("@fluidframework/protocol-definitions");
  * Combines summary stats by adding their totals together.
  * Returns empty stats if called without args.
  * @param stats - stats to merge
+ * @internal
  */
 function mergeStats(...stats) {
     const results = {
@@ -32,6 +33,9 @@ function mergeStats(...stats) {
     return results;
 }
 exports.mergeStats = mergeStats;
+/**
+ * @internal
+ */
 function utf8ByteLength(str) {
     // returns the byte length of an utf8 string
     let s = str.length;
@@ -50,6 +54,9 @@ function utf8ByteLength(str) {
     return s;
 }
 exports.utf8ByteLength = utf8ByteLength;
+/**
+ * @internal
+ */
 function getBlobSize(content) {
     return typeof content === "string" ? utf8ByteLength(content) : content.byteLength;
 }
@@ -76,12 +83,18 @@ function calculateStatsCore(summaryObject, stats) {
             return;
     }
 }
+/**
+ * @internal
+ */
 function calculateStats(summary) {
     const stats = mergeStats();
     calculateStatsCore(summary, stats);
     return stats;
 }
 exports.calculateStats = calculateStats;
+/**
+ * @internal
+ */
 function addBlobToSummary(summary, key, content) {
     const blob = {
         type: protocol_definitions_1.SummaryType.Blob,
@@ -92,16 +105,25 @@ function addBlobToSummary(summary, key, content) {
     summary.stats.totalBlobSize += getBlobSize(content);
 }
 exports.addBlobToSummary = addBlobToSummary;
+/**
+ * @internal
+ */
 function addTreeToSummary(summary, key, summarizeResult) {
     summary.summary.tree[key] = summarizeResult.summary;
     summary.stats = mergeStats(summary.stats, summarizeResult.stats);
 }
 exports.addTreeToSummary = addTreeToSummary;
+/**
+ * @internal
+ */
 function addSummarizeResultToSummary(summary, key, summarizeResult) {
     summary.summary.tree[key] = summarizeResult.summary;
     summary.stats = mergeStats(summary.stats, summarizeResult.stats);
 }
 exports.addSummarizeResultToSummary = addSummarizeResultToSummary;
+/**
+ * @internal
+ */
 class SummaryTreeBuilder {
     get summary() {
         return {
@@ -152,6 +174,7 @@ exports.SummaryTreeBuilder = SummaryTreeBuilder;
  * 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
+ * @internal
  */
 function convertToSummaryTreeWithStats(snapshot, fullTree = false) {
     const builder = new SummaryTreeBuilder();
@@ -188,6 +211,7 @@ exports.convertToSummaryTreeWithStats = convertToSummaryTreeWithStats;
  * 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
+ * @internal
  */
 function convertToSummaryTree(snapshot, fullTree = false) {
     // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
@@ -212,6 +236,7 @@ exports.convertToSummaryTree = convertToSummaryTree;
  * Converts ISnapshotTree to ISummaryTree format and tracks stats. This snapshot tree was
  * was taken by serialize api in detached container.
  * @param snapshot - snapshot in ISnapshotTree format
+ * @internal
  */
 function convertSnapshotTreeToSummaryTree(snapshot) {
     const builder = new SummaryTreeBuilder();
@@ -244,6 +269,7 @@ exports.convertSnapshotTreeToSummaryTree = convertSnapshotTreeToSummaryTree;
 /**
  * Converts ISummaryTree to ITree format. This is needed for back-compat while we get rid of snapshot.
  * @param summaryTree - summary tree in ISummaryTree format
+ * @internal
  */
 function convertSummaryTreeToITree(summaryTree) {
     const entries = [];
@@ -283,6 +309,9 @@ function convertSummaryTreeToITree(summaryTree) {
     };
 }
 exports.convertSummaryTreeToITree = convertSummaryTreeToITree;
+/**
+ * @internal
+ */
 class TelemetryContext {
     constructor() {
         this.telemetry = new Map();