@fluidframework/runtime-utils 2.0.0-dev.7.4.0.215930 → 2.0.0-dev.7.4.0.216897

package/lib/requestParser.js.map

@@ -1 +1 @@
-{"version":3,"file":"requestParser.js","sourceRoot":"","sources":["../src/requestParser.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,MAAM,OAAO,aAAa;IACzB;;;OAGG;IACI,MAAM,CAAC,YAAY,CAAC,GAAW;QACrC,MAAM,eAAe,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACzC,OAAO,GAAG;aACR,SAAS,CAAC,CAAC,EAAE,eAAe,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,eAAe,CAAC;aAChE,KAAK,CAAC,GAAG,CAAC;aACV,MAAM,CAAW,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE;YAC5B,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE;gBACtC,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC;aAChC;YACD,OAAO,EAAE,CAAC;QACX,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC;IAKM,MAAM,CAAC,MAAM,CAAC,OAA2B;QAC/C,sBAAsB;QACtB,IAAI,OAAO,YAAY,aAAa,EAAE;YACrC,OAAO,OAAO,CAAC;SACf;QACD,OAAO,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IAED,YAAuC,OAA2B;QAA3B,YAAO,GAAP,OAAO,CAAoB;QACjE,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACtD,IAAI,CAAC,KAAK,GAAG,eAAe,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACtF,CAAC;IAED,IAAW,GAAG;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC;IACzB,CAAC;IAED,IAAW,OAAO;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QACnB,IAAI,IAAI,CAAC,gBAAgB,KAAK,SAAS,EAAE;YACxC,IAAI,CAAC,gBAAgB,GAAG,aAAa,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SAC7D;QACD,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,QAAgB;QAC7B,OAAO,IAAI,CAAC,KAAK,KAAK,EAAE,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,QAAQ,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;OAWG;IACI,gBAAgB,CAAC,iBAAyB;QAChD,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;QACtC,IAAI,iBAAiB,GAAG,CAAC,IAAI,iBAAiB,GAAG,OAAO,EAAE;YACzD,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;SACzC;QACD,IAAI,iBAAiB,KAAK,OAAO,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC5D,OAAO;gBACN,GAAG,EAAE,IAAI,IAAI,CAAC,KAAK,EAAE;gBACrB,OAAO,EAAE,IAAI,CAAC,OAAO;aACrB,CAAC;SACF;QACD,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACrE,OAAO;YACN,GAAG,EAAE,IAAI,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE;YACvD,OAAO,EAAE,IAAI,CAAC,OAAO;SACrB,CAAC;IACH,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { IRequest, IRequestHeader } from \"@fluidframework/core-interfaces\";\n\n/**\n * The Request Parser takes an IRequest provides parsing and sub request creation\n */\nexport class RequestParser implements IRequest {\n\t/**\n\t * Splits the path of the url and decodes each path part\n\t * @param url - the url to get path parts of\n\t */\n\tpublic static getPathParts(url: string): readonly string[] {\n\t\tconst queryStartIndex = url.indexOf(\"?\");\n\t\treturn url\n\t\t\t.substring(0, queryStartIndex < 0 ? url.length : queryStartIndex)\n\t\t\t.split(\"/\")\n\t\t\t.reduce<string[]>((pv, cv) => {\n\t\t\t\tif (cv !== undefined && cv.length > 0) {\n\t\t\t\t\tpv.push(decodeURIComponent(cv));\n\t\t\t\t}\n\t\t\t\treturn pv;\n\t\t\t}, []);\n\t}\n\n\tprivate requestPathParts: readonly string[] | undefined;\n\tpublic readonly query: string;\n\n\tpublic static create(request: Readonly<IRequest>) {\n\t\t// Perf optimizations.\n\t\tif (request instanceof RequestParser) {\n\t\t\treturn request;\n\t\t}\n\t\treturn new RequestParser(request);\n\t}\n\n\tprotected constructor(private readonly request: Readonly<IRequest>) {\n\t\tconst queryStartIndex = this.request.url.indexOf(\"?\");\n\t\tthis.query = queryStartIndex >= 0 ? this.request.url.substring(queryStartIndex) : \"\";\n\t}\n\n\tpublic get url(): string {\n\t\treturn this.request.url;\n\t}\n\n\tpublic get headers(): IRequestHeader | undefined {\n\t\treturn this.request.headers;\n\t}\n\n\t/**\n\t * Returns the decoded path parts of the request's url\n\t */\n\tpublic get pathParts(): readonly string[] {\n\t\tif (this.requestPathParts === undefined) {\n\t\t\tthis.requestPathParts = RequestParser.getPathParts(this.url);\n\t\t}\n\t\treturn this.requestPathParts;\n\t}\n\n\t/**\n\t * Returns true if it's a terminating path, i.e. no more elements after `elements` entries and empty query.\n\t * @param elements - number of elements in path\n\t */\n\tpublic isLeaf(elements: number) {\n\t\treturn this.query === \"\" && this.pathParts.length === elements;\n\t}\n\n\t/**\n\t * Creates a sub request starting at a specific path part of this request's url\n\t * The sub request url always has a leading slash, and always include query params if original url has any\n\t * e.g. original url is /a/b/?queryParams, createSubRequest(0) is /a/b/?queryParams\n\t * createSubRequest(1) is /b/?queryParams\n\t * createSubRequest(2) is /?queryParams\n\t * createSubRequest(n) where n is bigger than parts length, e.g. 2, or n is less than 0 will throw an exception\n\t *\n\t * note: query params are not counted towards path parts.\n\t *\n\t * @param startingPathIndex - The index of the first path part of the sub request\n\t */\n\tpublic createSubRequest(startingPathIndex: number): IRequest {\n\t\tconst pathLen = this.pathParts.length;\n\t\tif (startingPathIndex < 0 || startingPathIndex > pathLen) {\n\t\t\tthrow new Error(\"incorrect sub-request\");\n\t\t}\n\t\tif (startingPathIndex === pathLen && this.url.includes(\"?\")) {\n\t\t\treturn {\n\t\t\t\turl: `/${this.query}`,\n\t\t\t\theaders: this.headers,\n\t\t\t};\n\t\t}\n\t\tconst path = `/${this.pathParts.slice(startingPathIndex).join(\"/\")}`;\n\t\treturn {\n\t\t\turl: this.query === \"\" ? path : `${path}/${this.query}`,\n\t\t\theaders: this.headers,\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"requestParser.js","sourceRoot":"","sources":["../src/requestParser.ts"],"names":[],"mappings":"AAMA;;;GAGG;AACH,MAAM,OAAO,aAAa;IACzB;;;OAGG;IACI,MAAM,CAAC,YAAY,CAAC,GAAW;QACrC,MAAM,eAAe,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACzC,OAAO,GAAG;aACR,SAAS,CAAC,CAAC,EAAE,eAAe,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,eAAe,CAAC;aAChE,KAAK,CAAC,GAAG,CAAC;aACV,MAAM,CAAW,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE;YAC5B,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE;gBACtC,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC;aAChC;YACD,OAAO,EAAE,CAAC;QACX,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC;IAKM,MAAM,CAAC,MAAM,CAAC,OAA2B;QAC/C,sBAAsB;QACtB,IAAI,OAAO,YAAY,aAAa,EAAE;YACrC,OAAO,OAAO,CAAC;SACf;QACD,OAAO,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IAED,YAAuC,OAA2B;QAA3B,YAAO,GAAP,OAAO,CAAoB;QACjE,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACtD,IAAI,CAAC,KAAK,GAAG,eAAe,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACtF,CAAC;IAED,IAAW,GAAG;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC;IACzB,CAAC;IAED,IAAW,OAAO;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QACnB,IAAI,IAAI,CAAC,gBAAgB,KAAK,SAAS,EAAE;YACxC,IAAI,CAAC,gBAAgB,GAAG,aAAa,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SAC7D;QACD,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,QAAgB;QAC7B,OAAO,IAAI,CAAC,KAAK,KAAK,EAAE,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,QAAQ,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;OAWG;IACI,gBAAgB,CAAC,iBAAyB;QAChD,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;QACtC,IAAI,iBAAiB,GAAG,CAAC,IAAI,iBAAiB,GAAG,OAAO,EAAE;YACzD,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;SACzC;QACD,IAAI,iBAAiB,KAAK,OAAO,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC5D,OAAO;gBACN,GAAG,EAAE,IAAI,IAAI,CAAC,KAAK,EAAE;gBACrB,OAAO,EAAE,IAAI,CAAC,OAAO;aACrB,CAAC;SACF;QACD,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACrE,OAAO;YACN,GAAG,EAAE,IAAI,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE;YACvD,OAAO,EAAE,IAAI,CAAC,OAAO;SACrB,CAAC;IACH,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { IRequest, IRequestHeader } from \"@fluidframework/core-interfaces\";\n\n/**\n * The Request Parser takes an IRequest provides parsing and sub request creation\n * @internal\n */\nexport class RequestParser implements IRequest {\n\t/**\n\t * Splits the path of the url and decodes each path part\n\t * @param url - the url to get path parts of\n\t */\n\tpublic static getPathParts(url: string): readonly string[] {\n\t\tconst queryStartIndex = url.indexOf(\"?\");\n\t\treturn url\n\t\t\t.substring(0, queryStartIndex < 0 ? url.length : queryStartIndex)\n\t\t\t.split(\"/\")\n\t\t\t.reduce<string[]>((pv, cv) => {\n\t\t\t\tif (cv !== undefined && cv.length > 0) {\n\t\t\t\t\tpv.push(decodeURIComponent(cv));\n\t\t\t\t}\n\t\t\t\treturn pv;\n\t\t\t}, []);\n\t}\n\n\tprivate requestPathParts: readonly string[] | undefined;\n\tpublic readonly query: string;\n\n\tpublic static create(request: Readonly<IRequest>) {\n\t\t// Perf optimizations.\n\t\tif (request instanceof RequestParser) {\n\t\t\treturn request;\n\t\t}\n\t\treturn new RequestParser(request);\n\t}\n\n\tprotected constructor(private readonly request: Readonly<IRequest>) {\n\t\tconst queryStartIndex = this.request.url.indexOf(\"?\");\n\t\tthis.query = queryStartIndex >= 0 ? this.request.url.substring(queryStartIndex) : \"\";\n\t}\n\n\tpublic get url(): string {\n\t\treturn this.request.url;\n\t}\n\n\tpublic get headers(): IRequestHeader | undefined {\n\t\treturn this.request.headers;\n\t}\n\n\t/**\n\t * Returns the decoded path parts of the request's url\n\t */\n\tpublic get pathParts(): readonly string[] {\n\t\tif (this.requestPathParts === undefined) {\n\t\t\tthis.requestPathParts = RequestParser.getPathParts(this.url);\n\t\t}\n\t\treturn this.requestPathParts;\n\t}\n\n\t/**\n\t * Returns true if it's a terminating path, i.e. no more elements after `elements` entries and empty query.\n\t * @param elements - number of elements in path\n\t */\n\tpublic isLeaf(elements: number) {\n\t\treturn this.query === \"\" && this.pathParts.length === elements;\n\t}\n\n\t/**\n\t * Creates a sub request starting at a specific path part of this request's url\n\t * The sub request url always has a leading slash, and always include query params if original url has any\n\t * e.g. original url is /a/b/?queryParams, createSubRequest(0) is /a/b/?queryParams\n\t * createSubRequest(1) is /b/?queryParams\n\t * createSubRequest(2) is /?queryParams\n\t * createSubRequest(n) where n is bigger than parts length, e.g. 2, or n is less than 0 will throw an exception\n\t *\n\t * note: query params are not counted towards path parts.\n\t *\n\t * @param startingPathIndex - The index of the first path part of the sub request\n\t */\n\tpublic createSubRequest(startingPathIndex: number): IRequest {\n\t\tconst pathLen = this.pathParts.length;\n\t\tif (startingPathIndex < 0 || startingPathIndex > pathLen) {\n\t\t\tthrow new Error(\"incorrect sub-request\");\n\t\t}\n\t\tif (startingPathIndex === pathLen && this.url.includes(\"?\")) {\n\t\t\treturn {\n\t\t\t\turl: `/${this.query}`,\n\t\t\t\theaders: this.headers,\n\t\t\t};\n\t\t}\n\t\tconst path = `/${this.pathParts.slice(startingPathIndex).join(\"/\")}`;\n\t\treturn {\n\t\t\turl: this.query === \"\" ? path : `${path}/${this.query}`,\n\t\t\theaders: this.headers,\n\t\t};\n\t}\n}\n"]}

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

@@ -1,220 +1,107 @@
-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';
 
-export declare function addBlobToSummary(summary: ISummaryTreeWithStats, key: string, content: string | Uint8Array): void;
+/* Excluded from this release type: addBlobToSummary */
 
-export declare function addSummarizeResultToSummary(summary: ISummaryTreeWithStats, key: string, summarizeResult: ISummarizeResult): void;
+/* Excluded from this release type: addSummarizeResultToSummary */
 
-export declare function addTreeToSummary(summary: ISummaryTreeWithStats, key: string, summarizeResult: ISummarizeResult): void;
+/* Excluded from this release type: addTreeToSummary */
 
-export declare function calculateStats(summary: SummaryObject): ISummaryStats;
+/* Excluded from this release type: calculateStats */
 
-/**
- * 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
- */
-export declare function convertSnapshotTreeToSummaryTree(snapshot: ISnapshotTree): ISummaryTreeWithStats;
+/* Excluded from this release type: 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
- */
-export declare function convertSummaryTreeToITree(summaryTree: ISummaryTree): ITree;
+/* Excluded from this release type: convertSummaryTreeToITree */
 
-/**
- * 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
- */
-export declare function convertToSummaryTree(snapshot: ITree, fullTree?: boolean): ISummarizeResult;
+/* 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
- */
-export declare function convertToSummaryTreeWithStats(snapshot: ITree, fullTree?: boolean): ISummaryTreeWithStats;
+/* Excluded from this release type: convertToSummaryTreeWithStats */
 
-export declare const create404Response: (request: IRequest) => IResponse;
+/* Excluded from this release type: create404Response */
 
-export declare function createDataStoreFactory(type: string, factory: Factory | Promise<Factory>): IFluidDataStoreFactory & IFluidDataStoreRegistry;
+/* Excluded from this release type: createDataStoreFactory */
 
-export declare function createResponseError(status: number, value: string, request: IRequest, headers?: {
-    [key: string]: any;
-}): IResponse;
+/* Excluded from this release type: createResponseError */
 
-export declare function exceptionToResponse(err: any): IResponse;
+/* Excluded from this release type: exceptionToResponse */
 
-export declare type Factory = IFluidDataStoreFactory & Partial<IProvideFluidDataStoreRegistry>;
+/* Excluded from this release type: Factory */
+
+/* Excluded from this release type: FluidObject */
 
 /* Excluded from this release type: GCDataBuilder */
 
-/**
- * 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.
- */
-export declare function generateHandleContextPath(path: string, routeContext?: IFluidHandleContext): string;
-
-export declare function getBlobSize(content: ISummaryBlob["content"]): number;
-
-export declare function getNormalizedObjectStoragePathParts(path: string): string[];
-
-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
- */
-export declare function mergeStats(...stats: ISummaryStats[]): ISummaryStats;
-
-/**
- * Returns a new IChannelStorageService that resolves the given `path` as root.
- */
-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. */
-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
- */
-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
- */
-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;
-}
-
-export declare function responseToException(response: IResponse, request: IRequest): Error;
-
-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.
- */
-export declare function seqFromTree(tree: ISnapshotTree, readAndParseBlob: ReadAndParseBlob): Promise<number>;
-
-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;
-}
-
-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.
- */
-export declare function unpackChildNodesUsedRoutes(usedRoutes: string[]): Map<string, string[]>;
-
-export declare function utf8ByteLength(str: string): number;
+/* Excluded from this release type: generateHandleContextPath */
+
+/* Excluded from this release type: getBlobSize */
+
+/* Excluded from this release type: getNormalizedObjectStoragePathParts */
+
+/* Excluded from this release type: IChannelStorageService */
+
+/* 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: IFluidHandleContext */
+
+/* Excluded from this release type: IFluidRouter */
+
+/* Excluded from this release type: IGarbageCollectionData */
+
+/* Excluded from this release type: IProvideFluidDataStoreRegistry */
+
+/* Excluded from this release type: IRequest */
+
+/* Excluded from this release type: IResponse */
+
+/* Excluded from this release type: IRuntime */
+
+/* Excluded from this release type: IRuntimeFactory */
+
+/* Excluded from this release type: ISummarizeResult */
+
+/* Excluded from this release type: ISummaryStats */
+
+/* Excluded from this release type: ISummaryTreeWithStats */
+
+/* Excluded from this release type: ITelemetryContext */
+
+/* Excluded from this release type: listBlobsAtTreePath */
+
+/* Excluded from this release type: mergeStats */
+
+/* Excluded from this release type: ObjectStoragePartition */
+
+/* Excluded from this release type: ReadAndParseBlob */
+
+/* Excluded from this release type: requestFluidObject */
+
+/* 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: TelemetryEventPropertyType */
+
+/* Excluded from this release type: unpackChildNodesUsedRoutes */
+
+/* Excluded from this release type: utf8ByteLength */
 
 export { }

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

@@ -1,220 +1,107 @@
-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';
 
-export declare function addBlobToSummary(summary: ISummaryTreeWithStats, key: string, content: string | Uint8Array): void;
+/* Excluded from this release type: addBlobToSummary */
 
-export declare function addSummarizeResultToSummary(summary: ISummaryTreeWithStats, key: string, summarizeResult: ISummarizeResult): void;
+/* Excluded from this release type: addSummarizeResultToSummary */
 
-export declare function addTreeToSummary(summary: ISummaryTreeWithStats, key: string, summarizeResult: ISummarizeResult): void;
+/* Excluded from this release type: addTreeToSummary */
 
-export declare function calculateStats(summary: SummaryObject): ISummaryStats;
+/* Excluded from this release type: calculateStats */
 
-/**
- * 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
- */
-export declare function convertSnapshotTreeToSummaryTree(snapshot: ISnapshotTree): ISummaryTreeWithStats;
+/* Excluded from this release type: 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
- */
-export declare function convertSummaryTreeToITree(summaryTree: ISummaryTree): ITree;
+/* Excluded from this release type: convertSummaryTreeToITree */
 
-/**
- * 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
- */
-export declare function convertToSummaryTree(snapshot: ITree, fullTree?: boolean): ISummarizeResult;
+/* 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
- */
-export declare function convertToSummaryTreeWithStats(snapshot: ITree, fullTree?: boolean): ISummaryTreeWithStats;
+/* Excluded from this release type: convertToSummaryTreeWithStats */
 
-export declare const create404Response: (request: IRequest) => IResponse;
+/* Excluded from this release type: create404Response */
 
-export declare function createDataStoreFactory(type: string, factory: Factory | Promise<Factory>): IFluidDataStoreFactory & IFluidDataStoreRegistry;
+/* Excluded from this release type: createDataStoreFactory */
 
-export declare function createResponseError(status: number, value: string, request: IRequest, headers?: {
-    [key: string]: any;
-}): IResponse;
+/* Excluded from this release type: createResponseError */
 
-export declare function exceptionToResponse(err: any): IResponse;
+/* Excluded from this release type: exceptionToResponse */
 
-export declare type Factory = IFluidDataStoreFactory & Partial<IProvideFluidDataStoreRegistry>;
+/* Excluded from this release type: Factory */
+
+/* Excluded from this release type: FluidObject */
 
 /* Excluded from this release type: GCDataBuilder */
 
-/**
- * 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.
- */
-export declare function generateHandleContextPath(path: string, routeContext?: IFluidHandleContext): string;
-
-export declare function getBlobSize(content: ISummaryBlob["content"]): number;
-
-export declare function getNormalizedObjectStoragePathParts(path: string): string[];
-
-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
- */
-export declare function mergeStats(...stats: ISummaryStats[]): ISummaryStats;
-
-/**
- * Returns a new IChannelStorageService that resolves the given `path` as root.
- */
-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. */
-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
- */
-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
- */
-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;
-}
-
-export declare function responseToException(response: IResponse, request: IRequest): Error;
-
-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.
- */
-export declare function seqFromTree(tree: ISnapshotTree, readAndParseBlob: ReadAndParseBlob): Promise<number>;
-
-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;
-}
-
-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.
- */
-export declare function unpackChildNodesUsedRoutes(usedRoutes: string[]): Map<string, string[]>;
-
-export declare function utf8ByteLength(str: string): number;
+/* Excluded from this release type: generateHandleContextPath */
+
+/* Excluded from this release type: getBlobSize */
+
+/* Excluded from this release type: getNormalizedObjectStoragePathParts */
+
+/* Excluded from this release type: IChannelStorageService */
+
+/* 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: IFluidHandleContext */
+
+/* Excluded from this release type: IFluidRouter */
+
+/* Excluded from this release type: IGarbageCollectionData */
+
+/* Excluded from this release type: IProvideFluidDataStoreRegistry */
+
+/* Excluded from this release type: IRequest */
+
+/* Excluded from this release type: IResponse */
+
+/* Excluded from this release type: IRuntime */
+
+/* Excluded from this release type: IRuntimeFactory */
+
+/* Excluded from this release type: ISummarizeResult */
+
+/* Excluded from this release type: ISummaryStats */
+
+/* Excluded from this release type: ISummaryTreeWithStats */
+
+/* Excluded from this release type: ITelemetryContext */
+
+/* Excluded from this release type: listBlobsAtTreePath */
+
+/* Excluded from this release type: mergeStats */
+
+/* Excluded from this release type: ObjectStoragePartition */
+
+/* Excluded from this release type: ReadAndParseBlob */
+
+/* Excluded from this release type: requestFluidObject */
+
+/* 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: TelemetryEventPropertyType */
+
+/* Excluded from this release type: unpackChildNodesUsedRoutes */
+
+/* Excluded from this release type: utf8ByteLength */
 
 export { }