@fluidframework/runtime-utils 2.0.0-rc.2.0.1 → 2.0.0-rc.3.0.0

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

@@ -1,109 +0,0 @@
-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 type { TelemetryBaseEventPropertyType } from '@fluidframework/core-interfaces';
-
-/* Excluded from this release type: addBlobToSummary */
-
-/* Excluded from this release type: addSummarizeResultToSummary */
-
-/* Excluded from this release type: calculateStats */
-
-/* Excluded from this release type: convertSnapshotTreeToSummaryTree */
-
-/* Excluded from this release type: convertSummaryTreeToITree */
-
-/* Excluded from this release type: convertToSummaryTree */
-
-/* Excluded from this release type: convertToSummaryTreeWithStats */
-
-/* Excluded from this release type: create404Response */
-
-/* Excluded from this release type: createDataStoreFactory */
-
-/* Excluded from this release type: createResponseError */
-
-/* Excluded from this release type: encodeCompactIdToString */
-
-/* Excluded from this release type: exceptionToResponse */
-
-/* Excluded from this release type: Factory */
-
-/* Excluded from this release type: GCDataBuilder */
-
-/* Excluded from this release type: generateHandleContextPath */
-
-/* Excluded from this release type: getBlobSize */
-
-/* Excluded from this release type: getNormalizedObjectStoragePathParts */
-
-/* Excluded from this release type: IContainerContext */
-
-/* Excluded from this release type: IContainerRuntime */
-
-/* Excluded from this release type: IFluidDataStoreFactory */
-
-/* Excluded from this release type: IFluidDataStoreRegistry */
-
-/* Excluded from this release type: IProvideFluidDataStoreRegistry */
-
-/* Excluded from this release type: IRuntime */
-
-/* Excluded from this release type: IRuntimeFactory */
-
-/* Excluded from this release type: ISerializedHandle */
-
-/* Excluded from this release type: ISnapshotTreeWithBlobContents */
-
-/* Excluded from this release type: isSerializedHandle */
-
-/* Excluded from this release type: ISummarizeResult */
-
-/* Excluded from this release type: listBlobsAtTreePath */
-
-/* Excluded from this release type: mergeStats */
-
-/* Excluded from this release type: ObjectStoragePartition */
-
-/* Excluded from this release type: processAttachMessageGCData */
-
-/* Excluded from this release type: ReadAndParseBlob */
-
-/* Excluded from this release type: RequestParser */
-
-/* Excluded from this release type: responseToException */
-
-/* Excluded from this release type: RuntimeFactoryHelper */
-
-/* Excluded from this release type: seqFromTree */
-
-/* Excluded from this release type: SummaryTreeBuilder */
-
-/* Excluded from this release type: TelemetryContext */
-
-/* Excluded from this release type: unpackChildNodesUsedRoutes */
-
-/* Excluded from this release type: utf8ByteLength */
-
-export { }

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

@@ -1,346 +0,0 @@
-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 type { TelemetryBaseEventPropertyType } 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 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: ISnapshotTreeWithBlobContents): 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
- * @alpha
- */
-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;
-
-/**
- * Encode compact ID (returned by IContainerRuntime.generateDocumentUniqueId()) to a compact string representation.
- * While this is the main usage pattern, it works with any non-negative integer or a string.
- * Strings are retured as is, and assumed to be UUIDs, i.e. unique enough to never overlap with
- * numbers encoded as strings by this function. Any other strings are likely to run into collisions and should not be used!
- * This function is useful in places where we serialize resulting ID as string and use them as strings, thus we are not
- * gaining any efficiency from having a number type.
- * We do not provide a decode function, so this API is only useful only result is stored and there is no need to go back to origianl form.
- * @param idArg - input - either a non-negative integer or a string. Strings are returned as is, while numbers are encoded in compat form
- * @param prefix - optinal string prefix
- * @returns A string - representation of an input
- * @internal
- */
-export declare function encodeCompactIdToString(idArg: number | string, prefix?: string): string;
-
-/**
- * @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[];
-
-/**
- * JSON serialized form of an IFluidHandle
- * @internal
- */
-export declare interface ISerializedHandle {
-    type: "__fluid_handle__";
-    url: string;
-}
-
-/**
- * Is the input object a @see ISerializedHandle?
- * @internal
- */
-export declare const isSerializedHandle: (value: any) => value is ISerializedHandle;
-
-/**
- * @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[]>;
-}
-
-/**
- * Looks in the given attach message snapshot for the .gcdata blob, which would
- * contain the initial GC Data for the node being attached.
- * If it finds it, it notifies GC of all the new outbound routes being added by the attach.
- *
- * @param snapshot - The snapshot from the attach message
- * @param addedGCOutboundRoute - Callback to notify GC of a new outbound route.
- * IMPORTANT: addedGCOutboundRoute's param nodeId is "/" for the attaching node itself, or "/<id>" for its children.
- *
- * @returns true if it found/processed GC Data, false otherwise
- *
- * @internal
- */
-export declare function processAttachMessageGCData(snapshot: ITree | null, addedGCOutboundRoute: (fromNodeId: string, toPath: string) => void): boolean;
-
-/**
- * Reads a blob from storage and parses it from JSON.
- *
- * @internal
- */
-export declare type ReadAndParseBlob = <T>(id: string) => 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>;
-
-/**
- * @alpha
- */
-export declare class SummaryTreeBuilder implements ISummaryTreeWithStats {
-    private attachmentCounter;
-    get summary(): ISummaryTree;
-    get stats(): Readonly<ISummaryStats>;
-    constructor();
-    private readonly summaryTree;
-    private summaryStats;
-    addBlob(key: string, content: string | Uint8Array): void;
-    addHandle(key: string, handleType: SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment, handle: string): void;
-    addWithStats(key: string, summarizeResult: ISummarizeResult): void;
-    addAttachment(id: string): void;
-    getSummaryTree(): ISummaryTreeWithStats;
-}
-
-/**
- * @internal
- */
-export declare class TelemetryContext implements ITelemetryContext {
-    private readonly telemetry;
-    /**
-     * {@inheritDoc @fluidframework/runtime-definitions#ITelemetryContext.set}
-     */
-    set(prefix: string, property: string, value: TelemetryBaseEventPropertyType): void;
-    /**
-     * {@inheritDoc @fluidframework/runtime-definitions#ITelemetryContext.setMultiple}
-     */
-    setMultiple(prefix: string, property: string, values: Record<string, TelemetryBaseEventPropertyType>): void;
-    /**
-     * {@inheritDoc @fluidframework/runtime-definitions#ITelemetryContext.get}
-     */
-    get(prefix: string, property: string): TelemetryBaseEventPropertyType;
-    /**
-     * {@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/lib/runtime-utils-alpha.d.ts

@@ -1,161 +0,0 @@
-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 type { TelemetryBaseEventPropertyType } from '@fluidframework/core-interfaces';
-
-/* Excluded from this release type: addBlobToSummary */
-
-/* Excluded from this release type: addSummarizeResultToSummary */
-
-/* Excluded from this release type: calculateStats */
-
-/* Excluded from this release type: convertSnapshotTreeToSummaryTree */
-
-/* Excluded from this release type: convertSummaryTreeToITree */
-
-/* Excluded from this release type: convertToSummaryTree */
-
-/**
- * Converts snapshot ITree to ISummaryTree format and tracks stats.
- * @param snapshot - snapshot in ITree format
- * @param fullTree - true to never use handles, even if id is specified
- * @alpha
- */
-export declare function convertToSummaryTreeWithStats(snapshot: ITree, fullTree?: boolean): ISummaryTreeWithStats;
-
-/* Excluded from this release type: create404Response */
-
-/* Excluded from this release type: createDataStoreFactory */
-
-/* Excluded from this release type: createResponseError */
-
-/* Excluded from this release type: encodeCompactIdToString */
-
-/* Excluded from this release type: exceptionToResponse */
-
-/* Excluded from this release type: Factory */
-
-/* Excluded from this release type: GCDataBuilder */
-
-/* Excluded from this release type: generateHandleContextPath */
-
-/* Excluded from this release type: getBlobSize */
-
-/* Excluded from this release type: getNormalizedObjectStoragePathParts */
-
-/* Excluded from this release type: ISerializedHandle */
-
-/* Excluded from this release type: isSerializedHandle */
-
-/* Excluded from this release type: listBlobsAtTreePath */
-
-/* Excluded from this release type: mergeStats */
-
-/* Excluded from this release type: ObjectStoragePartition */
-
-/* Excluded from this release type: processAttachMessageGCData */
-
-/* Excluded from this release type: ReadAndParseBlob */
-
-/**
- * The Request Parser takes an IRequest provides parsing and sub request creation
- * @alpha
- */
-export declare class RequestParser implements IRequest {
-    private readonly request;
-    /**
-     * Splits the path of the url and decodes each path part
-     * @param url - the url to get path parts of
-     */
-    static getPathParts(url: string): readonly string[];
-    private requestPathParts;
-    readonly query: string;
-    static create(request: Readonly<IRequest>): RequestParser;
-    protected constructor(request: Readonly<IRequest>);
-    get url(): string;
-    get headers(): IRequestHeader | undefined;
-    /**
-     * Returns the decoded path parts of the request's url
-     */
-    get pathParts(): readonly string[];
-    /**
-     * Returns true if it's a terminating path, i.e. no more elements after `elements` entries and empty query.
-     * @param elements - number of elements in path
-     */
-    isLeaf(elements: number): boolean;
-    /**
-     * Creates a sub request starting at a specific path part of this request's url
-     * The sub request url always has a leading slash, and always include query params if original url has any
-     * e.g. original url is /a/b/?queryParams, createSubRequest(0) is /a/b/?queryParams
-     * createSubRequest(1) is /b/?queryParams
-     * createSubRequest(2) is /?queryParams
-     * createSubRequest(n) where n is bigger than parts length, e.g. 2, or n is less than 0 will throw an exception
-     *
-     * note: query params are not counted towards path parts.
-     *
-     * @param startingPathIndex - The index of the first path part of the sub request
-     */
-    createSubRequest(startingPathIndex: number): IRequest;
-}
-
-/* Excluded from this release type: responseToException */
-
-/**
- * @alpha
- */
-export declare abstract class RuntimeFactoryHelper<T = IContainerRuntime> implements IRuntimeFactory {
-    get IRuntimeFactory(): this;
-    instantiateRuntime(context: IContainerContext, existing: boolean): Promise<IRuntime>;
-    abstract preInitialize(context: IContainerContext, existing: boolean): Promise<IRuntime & T>;
-    instantiateFirstTime(_runtime: T): Promise<void>;
-    instantiateFromExisting(_runtime: T): Promise<void>;
-    hasInitialized(_runtime: T): Promise<void>;
-}
-
-/* Excluded from this release type: seqFromTree */
-
-/**
- * @alpha
- */
-export declare class SummaryTreeBuilder implements ISummaryTreeWithStats {
-    private attachmentCounter;
-    get summary(): ISummaryTree;
-    get stats(): Readonly<ISummaryStats>;
-    constructor();
-    private readonly summaryTree;
-    private summaryStats;
-    addBlob(key: string, content: string | Uint8Array): void;
-    addHandle(key: string, handleType: SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment, handle: string): void;
-    addWithStats(key: string, summarizeResult: ISummarizeResult): void;
-    addAttachment(id: string): void;
-    getSummaryTree(): ISummaryTreeWithStats;
-}
-
-/* Excluded from this release type: TelemetryContext */
-
-/* Excluded from this release type: unpackChildNodesUsedRoutes */
-
-/* Excluded from this release type: utf8ByteLength */
-
-export { }