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

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

@@ -0,0 +1,137 @@
+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';
+
+/* Excluded from this release type: addBlobToSummary */
+
+/* Excluded from this release type: addSummarizeResultToSummary */
+
+/* Excluded from this release type: addTreeToSummary */
+
+/* Excluded from this release type: calculateStats */
+
+/* Excluded from this release type: convertSnapshotTreeToSummaryTree */
+
+/* Excluded from this release type: convertSummaryTreeToITree */
+
+/* Excluded from this release type: convertToSummaryTree */
+
+/* Excluded from this release type: convertToSummaryTreeWithStats */
+
+/* Excluded from this release type: create404Response */
+
+/* Excluded from this release type: createDataStoreFactory */
+
+/* Excluded from this release type: createResponseError */
+
+/* Excluded from this release type: exceptionToResponse */
+
+/* Excluded from this release type: Factory */
+
+/* Excluded from this release type: GCDataBuilder */
+
+/* Excluded from this release type: generateHandleContextPath */
+
+/* Excluded from this release type: getBlobSize */
+
+/* Excluded from this release type: getNormalizedObjectStoragePathParts */
+
+/* Excluded from this release type: 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 */
+
+/**
+ * The Request Parser takes an IRequest provides parsing and sub request creation
+ * @alpha
+ */
+export declare class RequestParser implements IRequest {
+    private readonly request;
+    /**
+     * Splits the path of the url and decodes each path part
+     * @param url - the url to get path parts of
+     */
+    static getPathParts(url: string): readonly string[];
+    private requestPathParts;
+    readonly query: string;
+    static create(request: Readonly<IRequest>): RequestParser;
+    protected constructor(request: Readonly<IRequest>);
+    get url(): string;
+    get headers(): IRequestHeader | undefined;
+    /**
+     * Returns the decoded path parts of the request's url
+     */
+    get pathParts(): readonly string[];
+    /**
+     * Returns true if it's a terminating path, i.e. no more elements after `elements` entries and empty query.
+     * @param elements - number of elements in path
+     */
+    isLeaf(elements: number): boolean;
+    /**
+     * Creates a sub request starting at a specific path part of this request's url
+     * The sub request url always has a leading slash, and always include query params if original url has any
+     * e.g. original url is /a/b/?queryParams, createSubRequest(0) is /a/b/?queryParams
+     * createSubRequest(1) is /b/?queryParams
+     * createSubRequest(2) is /?queryParams
+     * createSubRequest(n) where n is bigger than parts length, e.g. 2, or n is less than 0 will throw an exception
+     *
+     * note: query params are not counted towards path parts.
+     *
+     * @param startingPathIndex - The index of the first path part of the sub request
+     */
+    createSubRequest(startingPathIndex: number): IRequest;
+}
+
+/* Excluded from this release type: responseToException */
+
+/**
+ * @alpha
+ */
+export declare abstract class RuntimeFactoryHelper<T = IContainerRuntime> implements IRuntimeFactory {
+    get IRuntimeFactory(): this;
+    instantiateRuntime(context: IContainerContext, existing: boolean): Promise<IRuntime>;
+    abstract preInitialize(context: IContainerContext, existing: boolean): Promise<IRuntime & T>;
+    instantiateFirstTime(_runtime: T): Promise<void>;
+    instantiateFromExisting(_runtime: T): Promise<void>;
+    hasInitialized(_runtime: T): Promise<void>;
+}
+
+/* Excluded from this release type: seqFromTree */
+
+/* Excluded from this release type: SummaryTreeBuilder */
+
+/* Excluded from this release type: TelemetryContext */
+
+/* Excluded from this release type: unpackChildNodesUsedRoutes */
+
+/* Excluded from this release type: utf8ByteLength */
+
+export { }

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

@@ -0,0 +1,126 @@
+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';
+
+/* Excluded from this release type: addBlobToSummary */
+
+/* Excluded from this release type: addSummarizeResultToSummary */
+
+/* Excluded from this release type: addTreeToSummary */
+
+/* Excluded from this release type: calculateStats */
+
+/* Excluded from this release type: convertSnapshotTreeToSummaryTree */
+
+/* Excluded from this release type: convertSummaryTreeToITree */
+
+/* Excluded from this release type: convertToSummaryTree */
+
+/* Excluded from this release type: convertToSummaryTreeWithStats */
+
+/* Excluded from this release type: create404Response */
+
+/* Excluded from this release type: createDataStoreFactory */
+
+/* Excluded from this release type: createResponseError */
+
+/* Excluded from this release type: exceptionToResponse */
+
+/* Excluded from this release type: Factory */
+
+/* Excluded from this release type: FluidObject */
+
+/* Excluded from this release type: GCDataBuilder */
+
+/* Excluded from this release type: generateHandleContextPath */
+
+/* Excluded from this release type: getBlobSize */
+
+/* Excluded from this release type: getNormalizedObjectStoragePathParts */
+
+/* Excluded from this release type: 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/dist/runtime-utils-public.d.ts

@@ -0,0 +1,126 @@
+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';
+
+/* Excluded from this release type: addBlobToSummary */
+
+/* Excluded from this release type: addSummarizeResultToSummary */
+
+/* Excluded from this release type: addTreeToSummary */
+
+/* Excluded from this release type: calculateStats */
+
+/* Excluded from this release type: convertSnapshotTreeToSummaryTree */
+
+/* Excluded from this release type: convertSummaryTreeToITree */
+
+/* Excluded from this release type: convertToSummaryTree */
+
+/* Excluded from this release type: convertToSummaryTreeWithStats */
+
+/* Excluded from this release type: create404Response */
+
+/* Excluded from this release type: createDataStoreFactory */
+
+/* Excluded from this release type: createResponseError */
+
+/* Excluded from this release type: exceptionToResponse */
+
+/* Excluded from this release type: Factory */
+
+/* Excluded from this release type: FluidObject */
+
+/* Excluded from this release type: GCDataBuilder */
+
+/* Excluded from this release type: generateHandleContextPath */
+
+/* Excluded from this release type: getBlobSize */
+
+/* Excluded from this release type: getNormalizedObjectStoragePathParts */
+
+/* Excluded from this release type: 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 { }