@fluidframework/container-loader 1.4.0-121020 → 2.0.0-dev-rc.1.0.0.224419

package/lib/container.d.ts

@@ -1,238 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { IRequest, IResponse, IFluidRouter } from "@fluidframework/core-interfaces";
-import { IAudience, IContainer, IContainerEvents, IDeltaManager, ICriticalContainerError, AttachState, ReadOnlyInfo, IContainerLoadMode, IFluidCodeDetails } from "@fluidframework/container-definitions";
-import { IDocumentStorageService, IFluidResolvedUrl, IResolvedUrl } from "@fluidframework/driver-definitions";
-import { IClientConfiguration, IClientDetails, IDocumentMessage, IProtocolState, IQuorumClients, ISequencedDocumentMessage, IVersion } from "@fluidframework/protocol-definitions";
-import { EventEmitterWithErrorHandling, TelemetryLogger } from "@fluidframework/telemetry-utils";
-import { ILoaderOptions, Loader } from "./loader";
-import { ConnectionState } from "./connectionState";
-export interface IContainerLoadOptions {
-    /**
-     * Disables the Container from reconnecting if false, allows reconnect otherwise.
-     */
-    canReconnect?: boolean;
-    /**
-     * Client details provided in the override will be merged over the default client.
-     */
-    clientDetailsOverride?: IClientDetails;
-    resolvedUrl: IFluidResolvedUrl;
-    /**
-     * Control which snapshot version to load from.  See IParsedUrl for detailed information.
-     */
-    version: string | undefined;
-    /**
-     * Loads the Container in paused state if true, unpaused otherwise.
-     */
-    loadMode?: IContainerLoadMode;
-}
-export interface IContainerConfig {
-    resolvedUrl?: IFluidResolvedUrl;
-    canReconnect?: boolean;
-    /**
-     * Client details provided in the override will be merged over the default client.
-     */
-    clientDetailsOverride?: IClientDetails;
-    /**
-     * Serialized state from a previous instance of this container
-     */
-    serializedContainerState?: IPendingContainerState;
-}
-/**
- * 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.
- */
-export declare function waitContainerToCatchUp(container: IContainer): Promise<boolean>;
-/**
- * State saved by a container at close time, to be used to load a new instance
- * of the container to the same state
- */
-export interface IPendingContainerState {
-    pendingRuntimeState: unknown;
-    url: string;
-    protocol: IProtocolState;
-    term: number;
-    clientId?: string;
-}
-export declare class Container extends EventEmitterWithErrorHandling<IContainerEvents> implements IContainer {
-    private readonly loader;
-    static version: string;
-    /**
-     * Load an existing container.
-     */
-    static load(loader: Loader, loadOptions: IContainerLoadOptions, pendingLocalState?: IPendingContainerState): Promise<Container>;
-    /**
-     * Create a new container in a detached state.
-     */
-    static createDetached(loader: Loader, codeDetails: IFluidCodeDetails): Promise<Container>;
-    /**
-     * Create a new container in a detached state that is initialized with a
-     * snapshot from a previous detached container.
-     */
-    static rehydrateDetachedFromSnapshot(loader: Loader, snapshot: string): Promise<Container>;
-    subLogger: TelemetryLogger;
-    private readonly _canReconnect;
-    private readonly mc;
-    private _lifecycleState;
-    private setLoaded;
-    get closed(): boolean;
-    private _attachState;
-    private readonly _storage;
-    get storage(): IDocumentStorageService;
-    private _storageService;
-    private get storageService();
-    private readonly clientDetailsOverride;
-    private readonly _deltaManager;
-    private service;
-    private readonly _audience;
-    private _context;
-    private get context();
-    private _protocolHandler;
-    private get protocolHandler();
-    /** During initialization we pause the inbound queues. We track this state to ensure we only call resume once */
-    private inboundQueuePausedFromInit;
-    private firstConnection;
-    private readonly connectionTransitionTimes;
-    private messageCountAfterDisconnection;
-    private _loadedFromVersion;
-    private _resolvedUrl;
-    private attachStarted;
-    private _dirtyContainer;
-    private lastVisible;
-    private readonly visibilityEventHandler;
-    private readonly connectionStateHandler;
-    private setAutoReconnectTime;
-    private collabWindowTracker;
-    private get connectionMode();
-    get IFluidRouter(): IFluidRouter;
-    get resolvedUrl(): IResolvedUrl | undefined;
-    get loadedFromVersion(): IVersion | undefined;
-    get readOnlyInfo(): ReadOnlyInfo;
-    get closeSignal(): AbortSignal;
-    /**
-     * Tracks host requiring read-only mode.
-     */
-    forceReadonly(readonly: boolean): void;
-    get deltaManager(): IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
-    get connectionState(): ConnectionState;
-    get connected(): boolean;
-    /**
-     * Service configuration details. If running in offline mode will be undefined otherwise will contain service
-     * configuration details returned as part of the initial connection.
-     */
-    get serviceConfiguration(): IClientConfiguration | undefined;
-    /**
-     * The server provided id of the client.
-     * Set once this.connected is true, otherwise undefined
-     */
-    get clientId(): string | undefined;
-    /**
-     * The server provided claims of the client.
-     * Set once this.connected is true, otherwise undefined
-     */
-    get scopes(): string[] | undefined;
-    get clientDetails(): IClientDetails;
-    /**
-     * Get the code details that are currently specified for the container.
-     * @returns The current code details if any are specified, undefined if none are specified.
-     */
-    getSpecifiedCodeDetails(): IFluidCodeDetails | undefined;
-    /**
-     * Get the code details that were used to load the container.
-     * @returns The code details that were used to load the container if it is loaded, undefined if it is not yet
-     * loaded.
-     */
-    getLoadedCodeDetails(): IFluidCodeDetails | undefined;
-    /**
-     * Retrieves the audience associated with the document
-     */
-    get audience(): IAudience;
-    /**
-     * Returns true if container is dirty.
-     * Which means data loss if container is closed at that same moment
-     * Most likely that happens when there is no network connection to ordering service
-     */
-    get isDirty(): boolean;
-    private get serviceFactory();
-    private get urlResolver();
-    readonly options: ILoaderOptions;
-    private get scope();
-    private get codeLoader();
-    constructor(loader: Loader, config: IContainerConfig);
-    /**
-     * Retrieves the quorum associated with the document
-     */
-    getQuorum(): IQuorumClients;
-    close(error?: ICriticalContainerError): void;
-    private closeCore;
-    closeAndGetPendingLocalState(): string;
-    get attachState(): AttachState;
-    serialize(): string;
-    attach(request: IRequest): Promise<void>;
-    request(path: IRequest): Promise<IResponse>;
-    private setAutoReconnectInternal;
-    connect(): void;
-    private connectInternal;
-    disconnect(): void;
-    private disconnectInternal;
-    private resumeInternal;
-    getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;
-    proposeCodeDetails(codeDetails: IFluidCodeDetails): Promise<boolean>;
-    private processCodeProposal;
-    private getVersion;
-    private recordConnectStartTime;
-    private connectToDeltaStream;
-    /**
-     * Load container.
-     *
-     * @param specifiedVersion - one of the following
-     *   - undefined - fetch latest snapshot
-     *   - otherwise, version sha to load snapshot
-     */
-    private load;
-    private createDetached;
-    private rehydrateDetachedFromSnapshot;
-    private connectStorageService;
-    private getDocumentAttributes;
-    private initializeProtocolStateFromSnapshot;
-    private initializeProtocolState;
-    private captureProtocolSummary;
-    private getCodeDetailsFromQuorum;
-    private get client();
-    /**
-     * Returns true if connection is active, i.e. it's "write" connection and
-     * container runtime was notified about this connection (i.e. we are up-to-date and could send ops).
-     * This happens after client received its own joinOp and thus is in the quorum.
-     * If it's not true, runtime is not in position to send ops.
-     */
-    private activeConnection;
-    private createDeltaManager;
-    private attachDeltaManagerOpHandler;
-    private logConnectionStateChangeTelemetry;
-    private propagateConnectionState;
-    private submitContainerMessage;
-    private submitMessage;
-    private processRemoteMessage;
-    private submitSignal;
-    private processSignal;
-    /**
-     * Get the most recent snapshot, or a specific version.
-     * @param specifiedVersion - The specific version of the snapshot to retrieve
-     * @returns The snapshot requested, or the latest snapshot if no version was specified, plus version ID
-     */
-    private fetchSnapshotTree;
-    private instantiateContextDetached;
-    private instantiateContext;
-    private updateDirtyContainerState;
-    private logContainerError;
-}
-//# sourceMappingURL=container.d.ts.map

package/lib/container.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"container.d.ts","sourceRoot":"","sources":["../src/container.ts"],"names":[],"mappings":"AAAA;;;GAGG;AASH,OAAO,EACH,QAAQ,EACR,SAAS,EACT,YAAY,EACf,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,SAAS,EAET,UAAU,EACV,gBAAgB,EAChB,aAAa,EACb,uBAAuB,EAEvB,WAAW,EAEX,YAAY,EACZ,kBAAkB,EAClB,iBAAiB,EAEpB,MAAM,uCAAuC,CAAC;AAO/C,OAAO,EAEH,uBAAuB,EACvB,iBAAiB,EACjB,YAAY,EACf,MAAM,oCAAoC,CAAC;AAgB5C,OAAO,EAEH,oBAAoB,EACpB,cAAc,EAGd,gBAAgB,EAEhB,cAAc,EACd,cAAc,EAGd,yBAAyB,EAOzB,QAAQ,EAGX,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAEH,6BAA6B,EAG7B,eAAe,EAOlB,MAAM,iCAAiC,CAAC;AAMzC,OAAO,EAAE,cAAc,EAAE,MAAM,EAAkB,MAAM,UAAU,CAAC;AAUlE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAOpD,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,qBAAqB,CAAC,EAAE,cAAc,CAAC;IACvC,WAAW,EAAE,iBAAiB,CAAC;IAC/B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,EAAE,kBAAkB,CAAC;CACjC;AAED,MAAM,WAAW,gBAAgB;IAC7B,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,qBAAqB,CAAC,EAAE,cAAc,CAAC;IACvC;;OAEG;IACH,wBAAwB,CAAC,EAAE,sBAAsB,CAAC;CACrD;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,sBAAsB,CAAC,SAAS,EAAE,UAAU,oBA+DjE;AAwBD;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACnC,mBAAmB,EAAE,OAAO,CAAC;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,cAAc,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAID,qBAAa,SAAU,SAAQ,6BAA6B,CAAC,gBAAgB,CAAE,YAAW,UAAU;IA+R5F,OAAO,CAAC,QAAQ,CAAC,MAAM;IA9R3B,OAAc,OAAO,SAAY;IAEjC;;OAEG;WACiB,IAAI,CACpB,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,qBAAqB,EAClC,iBAAiB,CAAC,EAAE,sBAAsB,GAC3C,OAAO,CAAC,SAAS,CAAC;IAkDrB;;OAEG;WACiB,cAAc,CAC9B,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,iBAAiB,GAC/B,OAAO,CAAC,SAAS,CAAC;IAerB;;;OAGG;WACiB,6BAA6B,CAC7C,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,GACjB,OAAO,CAAC,SAAS,CAAC;IAed,SAAS,EAAE,eAAe,CAAC;IAIlC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAiB;IAE/C,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAoB;IAEvC,OAAO,CAAC,eAAe,CAA0D;IAEjF,OAAO,CAAC,SAAS;IAUjB,IAAW,MAAM,IAAI,OAAO,CAE3B;IAED,OAAO,CAAC,YAAY,CAAwB;IAE5C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA0B;IACnD,IAAW,OAAO,IAAI,uBAAuB,CAE5C;IAED,OAAO,CAAC,eAAe,CAAoD;IAC3E,OAAO,KAAK,cAAc,GAKzB;IAED,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAA6B;IACnE,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAkC;IAChE,OAAO,CAAC,OAAO,CAA+B;IAC9C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAW;IAErC,OAAO,CAAC,QAAQ,CAA+B;IAC/C,OAAO,KAAK,OAAO,GAKlB;IACD,OAAO,CAAC,gBAAgB,CAA+B;IACvD,OAAO,KAAK,eAAe,GAK1B;IAED,gHAAgH;IAChH,OAAO,CAAC,0BAA0B,CAAQ;IAC1C,OAAO,CAAC,eAAe,CAAQ;IAC/B,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CAAgB;IAC1D,OAAO,CAAC,8BAA8B,CAAa;IACnD,OAAO,CAAC,kBAAkB,CAAuB;IACjD,OAAO,CAAC,YAAY,CAAgC;IACpD,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,eAAe,CAAS;IAEhC,OAAO,CAAC,WAAW,CAAqB;IACxC,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAA2B;IAClE,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAyB;IAEhE,OAAO,CAAC,oBAAoB,CAAqB;IAEjD,OAAO,CAAC,mBAAmB,CAAkC;IAE7D,OAAO,KAAK,cAAc,GAAkE;IAE5F,IAAW,YAAY,IAAI,YAAY,CAAiB;IAExD,IAAW,WAAW,IAAI,YAAY,GAAG,SAAS,CAEjD;IAED,IAAW,iBAAiB,IAAI,QAAQ,GAAG,SAAS,CAEnD;IAED,IAAW,YAAY,IAAI,YAAY,CAEtC;IAED,IAAW,WAAW,IAAI,WAAW,CAEpC;IAED;;OAEG;IACI,aAAa,CAAC,QAAQ,EAAE,OAAO;IAItC,IAAW,YAAY,IAAI,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,CAEpF;IAED,IAAW,eAAe,IAAI,eAAe,CAE5C;IAED,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED;;;OAGG;IACH,IAAW,oBAAoB,IAAI,oBAAoB,GAAG,SAAS,CAElE;IAED;;;OAGG;IACH,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAExC;IAED;;;OAGG;IACH,IAAW,MAAM,IAAI,MAAM,EAAE,GAAG,SAAS,CAExC;IAED,IAAW,aAAa,IAAI,cAAc,CAEzC;IAED;;;OAGG;IACI,uBAAuB,IAAI,iBAAiB,GAAG,SAAS;IAI/D;;;;OAIG;IACI,oBAAoB,IAAI,iBAAiB,GAAG,SAAS;IAI5D;;OAEG;IACH,IAAW,QAAQ,IAAI,SAAS,CAE/B;IAED;;;;OAIG;IACH,IAAW,OAAO,YAEjB;IAED,OAAO,KAAK,cAAc,GAA0D;IACpF,OAAO,KAAK,WAAW,GAA+C;IACtE,SAAgB,OAAO,EAAE,cAAc,CAAC;IACxC,OAAO,KAAK,KAAK,GAAyC;IAC1D,OAAO,KAAK,UAAU,GAA8C;gBAG/C,MAAM,EAAE,MAAM,EAC/B,MAAM,EAAE,gBAAgB;IA2K5B;;OAEG;IACI,SAAS,IAAI,cAAc;IAI3B,KAAK,CAAC,KAAK,CAAC,EAAE,uBAAuB;IAY5C,OAAO,CAAC,SAAS;IA6CV,4BAA4B,IAAI,MAAM;IAwB7C,IAAW,WAAW,IAAI,WAAW,CAEpC;IAEM,SAAS,IAAI,MAAM;IAab,MAAM,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAoHxC,OAAO,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC;IASxD,OAAO,CAAC,wBAAwB;IAqBzB,OAAO;IAad,OAAO,CAAC,eAAe;IAahB,UAAU;IAQjB,OAAO,CAAC,kBAAkB;IAQ1B,OAAO,CAAC,cAAc;IAcT,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAWhE,kBAAkB,CAAC,WAAW,EAAE,iBAAiB;YAmBhD,mBAAmB;YAiBnB,UAAU;IAKxB,OAAO,CAAC,sBAAsB;IAM9B,OAAO,CAAC,oBAAoB;IAW5B;;;;;;OAMG;YACW,IAAI;YAmJJ,cAAc;YA0Bd,6BAA6B;YAmC7B,qBAAqB;YAsBrB,qBAAqB;YA2BrB,mCAAmC;YA2BnC,uBAAuB;IAkDrC,OAAO,CAAC,sBAAsB;IA2B9B,OAAO,CAAC,wBAAwB;IAQhC,OAAO,KAAK,MAAM,GAkBjB;IAED;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;IAKxB,OAAO,CAAC,kBAAkB;YA4DZ,2BAA2B;IAgBzC,OAAO,CAAC,iCAAiC;IA0DzC,OAAO,CAAC,wBAAwB;IAyBhC,OAAO,CAAC,sBAAsB;IA4B9B,OAAO,CAAC,aAAa;IAWrB,OAAO,CAAC,oBAAoB;IAmD5B,OAAO,CAAC,YAAY;IAIpB,OAAO,CAAC,aAAa;IAiBrB;;;;OAIG;YACW,iBAAiB;YAiBjB,0BAA0B;YAgB1B,kBAAkB;IAgChC,OAAO,CAAC,yBAAyB;IAQjC,OAAO,CAAC,iBAAiB;CAG5B"}