@fluidframework/container-loader 2.0.0-rc.2.0.2 → 2.0.0-rc.3.0.0

package/dist/container-loader-untrimmed.d.ts

@@ -1,331 +0,0 @@
-import { FluidObject } from '@fluidframework/core-interfaces';
-import { IAudienceOwner } from '@fluidframework/container-definitions';
-import { IClientDetails } from '@fluidframework/protocol-definitions';
-import { IConfigProviderBase } from '@fluidframework/core-interfaces';
-import { IContainer } from '@fluidframework/container-definitions';
-import { IDocumentAttributes } from '@fluidframework/protocol-definitions';
-import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
-import { IDocumentStorageService } from '@fluidframework/driver-definitions';
-import { IFluidCodeDetails } from '@fluidframework/container-definitions';
-import { IFluidModule } from '@fluidframework/container-definitions';
-import { IHostLoader } from '@fluidframework/container-definitions';
-import { ILoaderOptions as ILoaderOptions_2 } from '@fluidframework/container-definitions';
-import { ILocationRedirectionError } from '@fluidframework/driver-definitions';
-import { IProtocolHandler as IProtocolHandler_2 } from '@fluidframework/protocol-base';
-import { IProvideFluidCodeDetailsComparer } from '@fluidframework/container-definitions';
-import { IQuorumSnapshot } from '@fluidframework/protocol-base';
-import { IRequest } from '@fluidframework/core-interfaces';
-import { ISignalMessage } from '@fluidframework/protocol-definitions';
-import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
-import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
-import { IUrlResolver } from '@fluidframework/driver-definitions';
-
-/**
- * The state of the Container's connection to the service.
- * @public
- */
-export declare enum ConnectionState {
-    /**
-     * The container is not connected to the ordering service
-     * Note - When in this state the container may be about to reconnect,
-     * or may remain disconnected until explicitly told to connect.
-     */
-    Disconnected = 0,
-    /**
-     * The container is disconnected but actively trying to establish a new connection
-     * PLEASE NOTE that this numerical value falls out of the order you may expect for this state
-     */
-    EstablishingConnection = 3,
-    /**
-     * The container has an inbound connection only, and is catching up to the latest known state from the service.
-     */
-    CatchingUp = 1,
-    /**
-     * The container is fully connected and syncing
-     */
-    Connected = 2
-}
-
-/**
- * @deprecated ICodeDetailsLoader interface is moved to {@link @fluidframework/container-definitions#ICodeDetailsLoader}
- * to have code loading modules in one package. #8193
- * Fluid code loader resolves a code module matching the document schema, i.e. code details, such as
- * a package name and package version range.
- * @alpha
- */
-export declare interface ICodeDetailsLoader extends Partial<IProvideFluidCodeDetailsComparer> {
-    /**
-     * Load the code module (package) that is capable to interact with the document.
-     *
-     * @param source - Code proposal that articulates the current schema the document is written in.
-     * @returns Code module entry point along with the code details associated with it.
-     */
-    load(source: IFluidCodeDetails): Promise<IFluidModuleWithDetails>;
-}
-
-/**
- * IContainer interface that includes experimental features still under development.
- * @internal
- */
-export declare interface IContainerExperimental extends IContainer {
-    /**
-     * Get pending state from container. WARNING: misuse of this API can result in duplicate op
-     * submission and potential document corruption. The blob returned MUST be deleted if and when this
-     * container emits a "connected" event.
-     * @returns serialized blob that can be passed to Loader.resolve()
-     */
-    getPendingLocalState?(): Promise<string>;
-    /**
-     * Closes the container and returns serialized local state intended to be
-     * given to a newly loaded container.
-     */
-    closeAndGetPendingLocalState?(stopBlobAttachingSignal?: AbortSignal): Promise<string>;
-}
-
-/**
- * Subset of IDocumentStorageService which only supports createBlob() and readBlob(). This is used to support
- * blobs in detached containers.
- * @alpha
- */
-export declare type IDetachedBlobStorage = Pick<IDocumentStorageService, "createBlob" | "readBlob"> & {
-    size: number;
-    /**
-     * Return an array of all blob IDs present in storage
-     */
-    getBlobIds(): string[];
-};
-
-/**
- * @deprecated IFluidModuleWithDetails interface is moved to
- * {@link @fluidframework/container-definitions#IFluidModuleWithDetails}
- * to have all the code loading modules in one package. #8193
- * Encapsulates a module entry point with corresponding code details.
- * @alpha
- */
-export declare interface IFluidModuleWithDetails {
-    /** Fluid code module that implements the runtime factory needed to instantiate the container runtime. */
-    module: IFluidModule;
-    /**
-     * Code details associated with the module. Represents a document schema this module supports.
-     * If the code loader implements the {@link @fluidframework/core-interfaces#IFluidCodeDetailsComparer} interface,
-     * it'll be called to determine whether the module code details satisfy the new code proposal in the quorum.
-     */
-    details: IFluidCodeDetails;
-}
-
-/**
- * @alpha
- */
-export declare interface ILoaderOptions extends ILoaderOptions_2 {
-    summarizeProtocolTree?: boolean;
-}
-
-/**
- * Services and properties necessary for creating a loader
- * @alpha
- */
-export declare interface ILoaderProps {
-    /**
-     * The url resolver used by the loader for resolving external urls
-     * into Fluid urls such that the container specified by the
-     * external url can be loaded.
-     */
-    readonly urlResolver: IUrlResolver;
-    /**
-     * The document service factory take the Fluid url provided
-     * by the resolved url and constructs all the necessary services
-     * for communication with the container's server.
-     */
-    readonly documentServiceFactory: IDocumentServiceFactory;
-    /**
-     * The code loader handles loading the necessary code
-     * for running a container once it is loaded.
-     */
-    readonly codeLoader: ICodeDetailsLoader;
-    /**
-     * A property bag of options used by various layers
-     * to control features
-     */
-    readonly options?: ILoaderOptions;
-    /**
-     * Scope is provided to all container and is a set of shared
-     * services for container's to integrate with their host environment.
-     */
-    readonly scope?: FluidObject;
-    /**
-     * The logger that all telemetry should be pushed to.
-     */
-    readonly logger?: ITelemetryBaseLogger;
-    /**
-     * Blobs storage for detached containers.
-     */
-    readonly detachedBlobStorage?: IDetachedBlobStorage;
-    /**
-     * The configuration provider which may be used to control features.
-     */
-    readonly configProvider?: IConfigProviderBase;
-    /**
-     * Optional property for allowing the container to use a custom
-     * protocol implementation for handling the quorum and/or the audience.
-     */
-    readonly protocolHandlerBuilder?: ProtocolHandlerBuilder;
-}
-
-/**
- * Services and properties used by and exposed by the loader
- * @alpha
- */
-export declare interface ILoaderServices {
-    /**
-     * The url resolver used by the loader for resolving external urls
-     * into Fluid urls such that the container specified by the
-     * external url can be loaded.
-     */
-    readonly urlResolver: IUrlResolver;
-    /**
-     * The document service factory take the Fluid url provided
-     * by the resolved url and constructs all the necessary services
-     * for communication with the container's server.
-     */
-    readonly documentServiceFactory: IDocumentServiceFactory;
-    /**
-     * The code loader handles loading the necessary code
-     * for running a container once it is loaded.
-     */
-    readonly codeLoader: ICodeDetailsLoader;
-    /**
-     * A property bag of options used by various layers
-     * to control features
-     */
-    readonly options: ILoaderOptions;
-    /**
-     * Scope is provided to all container and is a set of shared
-     * services for container's to integrate with their host environment.
-     */
-    readonly scope: FluidObject;
-    /**
-     * The logger downstream consumers should construct their loggers from
-     */
-    readonly subLogger: ITelemetryLoggerExt;
-    /**
-     * Blobs storage for detached containers.
-     */
-    readonly detachedBlobStorage?: IDetachedBlobStorage;
-    /**
-     * Optional property for allowing the container to use a custom
-     * protocol implementation for handling the quorum and/or the audience.
-     */
-    readonly protocolHandlerBuilder?: ProtocolHandlerBuilder;
-}
-
-/**
- * Interface to represent the parsed parts of IResolvedUrl.url to help
- * in getting info about different parts of the url.
- * May not be compatible or relevant for any Url Resolver
- * @internal
- */
-export declare interface IParsedUrl {
-    /**
-     * It is combination of tenantid/docId part of the url.
-     */
-    id: string;
-    /**
-     * It is the deep link path in the url.
-     */
-    path: string;
-    /**
-     * Query string part of the url.
-     */
-    query: string;
-    /**
-     * Undefined means load latest snapshot, otherwise it's version ID passed to IDocumentStorageService.getVersions()
-     * to figure out what snapshot to use.
-     */
-    version: string | undefined;
-}
-
-/**
- * @alpha
- */
-export declare interface IProtocolHandler extends IProtocolHandler_2 {
-    readonly audience: IAudienceOwner;
-    processSignal(message: ISignalMessage): any;
-}
-
-/**
- * Checks if the error is location redirection error.
- * @param error - error whose type is to be determined.
- * @returns `true` is the error is location redirection error, otherwise `false`.
- * @internal
- */
-export declare function isLocationRedirectionError(error: any): error is ILocationRedirectionError;
-
-/**
- * Manages Fluid resource loading
- * @alpha
- */
-export declare class Loader implements IHostLoader {
-    readonly services: ILoaderServices;
-    private readonly mc;
-    constructor(loaderProps: ILoaderProps);
-    createDetachedContainer(codeDetails: IFluidCodeDetails, createDetachedProps?: {
-        canReconnect?: boolean;
-        clientDetailsOverride?: IClientDetails;
-    }): Promise<IContainer>;
-    rehydrateDetachedContainerFromSnapshot(snapshot: string, createDetachedProps?: {
-        canReconnect?: boolean;
-        clientDetailsOverride?: IClientDetails;
-    }): Promise<IContainer>;
-    resolve(request: IRequest, pendingLocalState?: string): Promise<IContainer>;
-    private resolveCore;
-    private loadContainer;
-}
-
-/**
- * Function to be used for creating a protocol handler.
- * @alpha
- */
-export declare type ProtocolHandlerBuilder = (attributes: IDocumentAttributes, snapshot: IQuorumSnapshot, sendProposal: (key: string, value: any) => number) => IProtocolHandler;
-
-/**
- * Handles location redirection while fulfilling the loader request.
- * @param api - Callback in which user can wrap the loader.resolve or loader.request call.
- * @param request - request to be resolved.
- * @param urlResolver - resolver used to resolve the url.
- * @param logger - logger to send events.
- * @returns Response from the API call.
- * @alpha
- */
-export declare function resolveWithLocationRedirectionHandling<T>(api: (request: IRequest) => Promise<T>, request: IRequest, urlResolver: IUrlResolver, logger?: ITelemetryBaseLogger): Promise<T>;
-
-/**
- * Utility api to parse the IResolvedUrl.url into specific parts like querystring, path to get
- * deep link info etc.
- * Warning - This function may not be compatible with any Url Resolver's resolved url. It works
- * with urls of type: protocol://<string>/.../..?<querystring>
- * @param url - This is the IResolvedUrl.url part of the resolved url.
- * @returns The IParsedUrl representing the input URL, or undefined if the format was not supported
- * @internal
- */
-export declare function tryParseCompatibleResolvedUrl(url: string): IParsedUrl | undefined;
-
-/**
- * Waits until container connects to delta storage and gets up-to-date.
- *
- * Useful when resolving URIs and hitting 404, due to container being loaded from (stale) snapshot and not being
- * up to date. Host may chose to wait in such case and retry resolving URI.
- *
- * Warning: Will wait infinitely for connection to establish if there is no connection.
- * May result in deadlock if Container.disconnect() is called and never followed by a call to Container.connect().
- *
- * @returns `true`: container is up to date, it processed all the ops that were know at the time of first connection.
- *
- * `false`: storage does not provide indication of how far the client is. Container processed all the ops known to it,
- * but it maybe still behind.
- *
- * @throws an error beginning with `"Container closed"` if the container is closed before it catches up.
- * @alpha
- */
-export declare function waitContainerToCatchUp(container: IContainer): Promise<boolean>;
-
-export { }

package/lib/container-loader-alpha.d.ts

@@ -1,275 +0,0 @@
-import { FluidObject } from '@fluidframework/core-interfaces';
-import { IAudienceOwner } from '@fluidframework/container-definitions';
-import { IClientDetails } from '@fluidframework/protocol-definitions';
-import { IConfigProviderBase } from '@fluidframework/core-interfaces';
-import { IContainer } from '@fluidframework/container-definitions';
-import { IDocumentAttributes } from '@fluidframework/protocol-definitions';
-import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
-import { IDocumentStorageService } from '@fluidframework/driver-definitions';
-import { IFluidCodeDetails } from '@fluidframework/container-definitions';
-import { IFluidModule } from '@fluidframework/container-definitions';
-import { IHostLoader } from '@fluidframework/container-definitions';
-import { ILoaderOptions as ILoaderOptions_2 } from '@fluidframework/container-definitions';
-import { ILocationRedirectionError } from '@fluidframework/driver-definitions';
-import { IProtocolHandler as IProtocolHandler_2 } from '@fluidframework/protocol-base';
-import { IProvideFluidCodeDetailsComparer } from '@fluidframework/container-definitions';
-import { IQuorumSnapshot } from '@fluidframework/protocol-base';
-import { IRequest } from '@fluidframework/core-interfaces';
-import { ISignalMessage } from '@fluidframework/protocol-definitions';
-import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
-import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
-import { IUrlResolver } from '@fluidframework/driver-definitions';
-
-/**
- * The state of the Container's connection to the service.
- * @public
- */
-export declare enum ConnectionState {
-    /**
-     * The container is not connected to the ordering service
-     * Note - When in this state the container may be about to reconnect,
-     * or may remain disconnected until explicitly told to connect.
-     */
-    Disconnected = 0,
-    /**
-     * The container is disconnected but actively trying to establish a new connection
-     * PLEASE NOTE that this numerical value falls out of the order you may expect for this state
-     */
-    EstablishingConnection = 3,
-    /**
-     * The container has an inbound connection only, and is catching up to the latest known state from the service.
-     */
-    CatchingUp = 1,
-    /**
-     * The container is fully connected and syncing
-     */
-    Connected = 2
-}
-
-/**
- * @deprecated ICodeDetailsLoader interface is moved to {@link @fluidframework/container-definitions#ICodeDetailsLoader}
- * to have code loading modules in one package. #8193
- * Fluid code loader resolves a code module matching the document schema, i.e. code details, such as
- * a package name and package version range.
- * @alpha
- */
-export declare interface ICodeDetailsLoader extends Partial<IProvideFluidCodeDetailsComparer> {
-    /**
-     * Load the code module (package) that is capable to interact with the document.
-     *
-     * @param source - Code proposal that articulates the current schema the document is written in.
-     * @returns Code module entry point along with the code details associated with it.
-     */
-    load(source: IFluidCodeDetails): Promise<IFluidModuleWithDetails>;
-}
-
-/* Excluded from this release type: IContainerExperimental */
-
-/**
- * Subset of IDocumentStorageService which only supports createBlob() and readBlob(). This is used to support
- * blobs in detached containers.
- * @alpha
- */
-export declare type IDetachedBlobStorage = Pick<IDocumentStorageService, "createBlob" | "readBlob"> & {
-    size: number;
-    /**
-     * Return an array of all blob IDs present in storage
-     */
-    getBlobIds(): string[];
-};
-
-/**
- * @deprecated IFluidModuleWithDetails interface is moved to
- * {@link @fluidframework/container-definitions#IFluidModuleWithDetails}
- * to have all the code loading modules in one package. #8193
- * Encapsulates a module entry point with corresponding code details.
- * @alpha
- */
-export declare interface IFluidModuleWithDetails {
-    /** Fluid code module that implements the runtime factory needed to instantiate the container runtime. */
-    module: IFluidModule;
-    /**
-     * Code details associated with the module. Represents a document schema this module supports.
-     * If the code loader implements the {@link @fluidframework/core-interfaces#IFluidCodeDetailsComparer} interface,
-     * it'll be called to determine whether the module code details satisfy the new code proposal in the quorum.
-     */
-    details: IFluidCodeDetails;
-}
-
-/**
- * @alpha
- */
-export declare interface ILoaderOptions extends ILoaderOptions_2 {
-    summarizeProtocolTree?: boolean;
-}
-
-/**
- * Services and properties necessary for creating a loader
- * @alpha
- */
-export declare interface ILoaderProps {
-    /**
-     * The url resolver used by the loader for resolving external urls
-     * into Fluid urls such that the container specified by the
-     * external url can be loaded.
-     */
-    readonly urlResolver: IUrlResolver;
-    /**
-     * The document service factory take the Fluid url provided
-     * by the resolved url and constructs all the necessary services
-     * for communication with the container's server.
-     */
-    readonly documentServiceFactory: IDocumentServiceFactory;
-    /**
-     * The code loader handles loading the necessary code
-     * for running a container once it is loaded.
-     */
-    readonly codeLoader: ICodeDetailsLoader;
-    /**
-     * A property bag of options used by various layers
-     * to control features
-     */
-    readonly options?: ILoaderOptions;
-    /**
-     * Scope is provided to all container and is a set of shared
-     * services for container's to integrate with their host environment.
-     */
-    readonly scope?: FluidObject;
-    /**
-     * The logger that all telemetry should be pushed to.
-     */
-    readonly logger?: ITelemetryBaseLogger;
-    /**
-     * Blobs storage for detached containers.
-     */
-    readonly detachedBlobStorage?: IDetachedBlobStorage;
-    /**
-     * The configuration provider which may be used to control features.
-     */
-    readonly configProvider?: IConfigProviderBase;
-    /**
-     * Optional property for allowing the container to use a custom
-     * protocol implementation for handling the quorum and/or the audience.
-     */
-    readonly protocolHandlerBuilder?: ProtocolHandlerBuilder;
-}
-
-/**
- * Services and properties used by and exposed by the loader
- * @alpha
- */
-export declare interface ILoaderServices {
-    /**
-     * The url resolver used by the loader for resolving external urls
-     * into Fluid urls such that the container specified by the
-     * external url can be loaded.
-     */
-    readonly urlResolver: IUrlResolver;
-    /**
-     * The document service factory take the Fluid url provided
-     * by the resolved url and constructs all the necessary services
-     * for communication with the container's server.
-     */
-    readonly documentServiceFactory: IDocumentServiceFactory;
-    /**
-     * The code loader handles loading the necessary code
-     * for running a container once it is loaded.
-     */
-    readonly codeLoader: ICodeDetailsLoader;
-    /**
-     * A property bag of options used by various layers
-     * to control features
-     */
-    readonly options: ILoaderOptions;
-    /**
-     * Scope is provided to all container and is a set of shared
-     * services for container's to integrate with their host environment.
-     */
-    readonly scope: FluidObject;
-    /**
-     * The logger downstream consumers should construct their loggers from
-     */
-    readonly subLogger: ITelemetryLoggerExt;
-    /**
-     * Blobs storage for detached containers.
-     */
-    readonly detachedBlobStorage?: IDetachedBlobStorage;
-    /**
-     * Optional property for allowing the container to use a custom
-     * protocol implementation for handling the quorum and/or the audience.
-     */
-    readonly protocolHandlerBuilder?: ProtocolHandlerBuilder;
-}
-
-/* Excluded from this release type: IParsedUrl */
-
-/**
- * @alpha
- */
-export declare interface IProtocolHandler extends IProtocolHandler_2 {
-    readonly audience: IAudienceOwner;
-    processSignal(message: ISignalMessage): any;
-}
-
-/* Excluded from this release type: isLocationRedirectionError */
-
-/**
- * Manages Fluid resource loading
- * @alpha
- */
-export declare class Loader implements IHostLoader {
-    readonly services: ILoaderServices;
-    private readonly mc;
-    constructor(loaderProps: ILoaderProps);
-    createDetachedContainer(codeDetails: IFluidCodeDetails, createDetachedProps?: {
-        canReconnect?: boolean;
-        clientDetailsOverride?: IClientDetails;
-    }): Promise<IContainer>;
-    rehydrateDetachedContainerFromSnapshot(snapshot: string, createDetachedProps?: {
-        canReconnect?: boolean;
-        clientDetailsOverride?: IClientDetails;
-    }): Promise<IContainer>;
-    resolve(request: IRequest, pendingLocalState?: string): Promise<IContainer>;
-    private resolveCore;
-    private loadContainer;
-}
-
-/**
- * Function to be used for creating a protocol handler.
- * @alpha
- */
-export declare type ProtocolHandlerBuilder = (attributes: IDocumentAttributes, snapshot: IQuorumSnapshot, sendProposal: (key: string, value: any) => number) => IProtocolHandler;
-
-/**
- * Handles location redirection while fulfilling the loader request.
- * @param api - Callback in which user can wrap the loader.resolve or loader.request call.
- * @param request - request to be resolved.
- * @param urlResolver - resolver used to resolve the url.
- * @param logger - logger to send events.
- * @returns Response from the API call.
- * @alpha
- */
-export declare function resolveWithLocationRedirectionHandling<T>(api: (request: IRequest) => Promise<T>, request: IRequest, urlResolver: IUrlResolver, logger?: ITelemetryBaseLogger): Promise<T>;
-
-/* Excluded from this release type: tryParseCompatibleResolvedUrl */
-
-/**
- * Waits until container connects to delta storage and gets up-to-date.
- *
- * Useful when resolving URIs and hitting 404, due to container being loaded from (stale) snapshot and not being
- * up to date. Host may chose to wait in such case and retry resolving URI.
- *
- * Warning: Will wait infinitely for connection to establish if there is no connection.
- * May result in deadlock if Container.disconnect() is called and never followed by a call to Container.connect().
- *
- * @returns `true`: container is up to date, it processed all the ops that were know at the time of first connection.
- *
- * `false`: storage does not provide indication of how far the client is. Container processed all the ops known to it,
- * but it maybe still behind.
- *
- * @throws an error beginning with `"Container closed"` if the container is closed before it catches up.
- * @alpha
- */
-export declare function waitContainerToCatchUp(container: IContainer): Promise<boolean>;
-
-export { }