npm - @fluidframework/container-definitions - Versions diffs - 0.42.0 → 0.43.0-45414 - Mend

@fluidframework/container-definitions 0.42.0 → 0.43.0-45414

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

package/api-report/container-definitions.api.md +23 -1
package/dist/loader.d.ts +74 -2
package/dist/loader.d.ts.map +1 -1
package/dist/loader.js.map +1 -1
package/lib/loader.d.ts +74 -2
package/lib/loader.d.ts.map +1 -1
package/lib/loader.js.map +1 -1
package/package.json +60 -4
package/src/loader.ts +86 -2

package/api-report/container-definitions.api.md CHANGED Viewed

@@ -58,6 +58,16 @@ export enum BindState {
     NotBound = "NotBound"
 }
+// @public
+export namespace ConnectionState {
+    export type Connected = 2;
+    export type Connecting = 1;
+    export type Disconnected = 0;
+}
+// @public
+export type ConnectionState = ConnectionState.Disconnected | ConnectionState.Connecting | ConnectionState.Connected;
 // @public
 export enum ContainerErrorType {
     dataCorruptionError = "dataCorruptionError",
@@ -116,21 +126,33 @@ export interface IConnectionDetails {
 export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRouter {
     attach(request: IRequest): Promise<void>;
     readonly attachState: AttachState;
+    readonly audience?: IAudience;
+    // @alpha
+    readonly clientId?: string | undefined;
     close(error?: ICriticalContainerError): void;
     closeAndGetPendingLocalState(): string;
     readonly closed: boolean;
     // @deprecated
-    readonly codeDetails: IFluidCodeDetails | undefined;
+    readonly codeDetails?: IFluidCodeDetails | undefined;
+    readonly connected?: boolean;
+    readonly connectionState?: ConnectionState;
     deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
+    // @alpha
+    forceReadonly?(readonly: boolean): any;
     getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;
     getLoadedCodeDetails?(): IFluidCodeDetails | undefined;
     getQuorum(): IQuorum;
     getSpecifiedCodeDetails?(): IFluidCodeDetails | undefined;
     readonly isDirty: boolean;
     proposeCodeDetails(codeDetails: IFluidCodeDetails): Promise<boolean>;
+    readonly readOnlyInfo?: ReadOnlyInfo;
     request(request: IRequest): Promise<IResponse>;
     resolvedUrl: IResolvedUrl | undefined;
+    // @alpha
+    resume?(): void;
     serialize(): string;
+    // @alpha
+    setAutoReconnect?(reconnect: boolean): void;
 }
 // @public

package/dist/loader.d.ts CHANGED Viewed

@@ -6,7 +6,8 @@ import { IRequest, IResponse, IFluidRouter, IFluidCodeDetails, IFluidPackage, IP
 import { IClientDetails, IDocumentMessage, IPendingProposal, IQuorum, ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
 import { IResolvedUrl } from "@fluidframework/driver-definitions";
 import { IEvent, IEventProvider } from "@fluidframework/common-definitions";
-import { IDeltaManager } from "./deltas";
+import { IAudience } from "./audience";
+import { IDeltaManager, ReadOnlyInfo } from "./deltas";
 import { ICriticalContainerError, ContainerWarning } from "./error";
 import { IFluidModule } from "./fluidModule";
 import { AttachState } from "./runtime";
@@ -73,6 +74,27 @@ export interface IContainerEvents extends IEvent {
     (event: "op", listener: (message: ISequencedDocumentMessage) => void): any;
     (event: "dirty" | "saved", listener: (dirty: boolean) => void): any;
 }
+/**
+ * Namespace for the different connection states a container can be in
+ */
+export declare namespace ConnectionState {
+    /**
+     * The document is no longer connected to the delta server
+     */
+    type Disconnected = 0;
+    /**
+     * The document has an inbound connection but is still pending for outbound deltas
+     */
+    type Connecting = 1;
+    /**
+     * The document is fully connected
+     */
+    type Connected = 2;
+}
+/**
+ * Type defining the different states of connectivity a container can be in
+ */
+export declare type ConnectionState = ConnectionState.Disconnected | ConnectionState.Connecting | ConnectionState.Connected;
 /**
  * The Host's view of the Container and its connection to storage
  */
@@ -99,8 +121,9 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
      * @deprecated use getSpecifiedCodeDetails for the code details currently specified for this container, or
      * getLoadedCodeDetails for the code details that the container's context was loaded with.
      * To be removed after getSpecifiedCodeDetails and getLoadedCodeDetails become ubiquitous.
+     * This is now marked as optional and due to be removed in next release.
      */
-    readonly codeDetails: IFluidCodeDetails | undefined;
+    readonly codeDetails?: IFluidCodeDetails | undefined;
     /**
      * 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.
@@ -161,6 +184,55 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
      * @param request - The request to be issued against the container
      */
     request(request: IRequest): Promise<IResponse>;
+    /**
+     * Provides the current connected state of the container
+     */
+    readonly connectionState?: ConnectionState;
+    /**
+     * Boolean indicating whether the container is currently connected or not
+     */
+    readonly connected?: boolean;
+    /**
+     * Dictates whether or not the current container will automatically attempt to reconnect to the delta stream
+     * after receiving a disconnect event
+     * @param reconnect - Boolean indicating if reconnect should automatically occur
+     * @alpha
+     */
+    setAutoReconnect?(reconnect: boolean): void;
+    /**
+     * Have the container attempt to resume processing ops
+     * @alpha
+     */
+    resume?(): void;
+    /**
+     * The audience information for all clients currently associated with the document in the current session
+     */
+    readonly audience?: IAudience;
+    /**
+     * The server provided ID of the client.
+     * Set once this.connected is true, otherwise undefined
+     * @alpha
+     */
+    readonly clientId?: string | undefined;
+    /**
+     * Tells if container is in read-only mode.
+     * Data stores should listen for "readonly" notifications and disallow user making changes to data stores.
+     * Readonly state can be because of no storage write permission,
+     * or due to host forcing readonly mode for container.
+     *
+     * We do not differentiate here between no write access to storage vs. host disallowing changes to container -
+     * in all cases container runtime and data stores should respect readonly state and not allow local changes.
+     *
+     * It is undefined if we have not yet established websocket connection
+     * and do not know if user has write access to a file.
+     */
+    readonly readOnlyInfo?: ReadOnlyInfo;
+    /**
+     * Allows the host to have the container force to be in read-only mode
+     * @param readonly - Boolean that toggles if read-only policies will be enforced
+     * @alpha
+     */
+    forceReadonly?(readonly: boolean): any;
 }
 /**
  * The Runtime's view of the Loader, used for loading Containers

package/dist/loader.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"loader.d.ts","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,QAAQ,EACR,SAAS,EACT,YAAY,EACZ,iBAAiB,EACjB,aAAa,EACb,gCAAgC,EACnC,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,OAAO,EACP,yBAAyB,EAC5B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;~~AACzC~~,OAAO,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAExC;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,OAAO,CAAC,gCAAgC,CAAC;IAC1E;;OAEG;IACH,IAAI,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CAC1D;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB;IAChE;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC;IAClD;;OAEG;IACH,QAAQ,CAAC,sBAAsB,EAAE,MAAM,GAAG,SAAS,CAAC;CACvD;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;;;;;;OAOG;IACH,kBAAkB,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAC;CACtF;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B,UAAU,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACnE;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,MAAM;IAC5C,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,GAAG,IAAI,CAAC;IACjE,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;IAC3D,CAAC,KAAK,EAAE,qBAAqB,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,iBAAiB,EAAE,QAAQ,EAAE,gBAAgB,KAAK,IAAI,OAAE;IAC/G,CAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,iBAAiB,KAAK,IAAI,OAAE;IAC9E,CAAC,KAAK,EAAE,cAAc,GAAG,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC3D,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,KAAK,CAAC,EAAE,uBAAuB,KAAK,IAAI,OAAE;IACvE,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI,OAAE;IAChE,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,OAAE;IACtE,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,OAAE;CAClE;AAED;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,cAAc,CAAC,gBAAgB,CAAC,EAAE,YAAY;IAE9E;;OAEG;IACH,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,CAAC;IAEzE;;;OAGG;IACH,SAAS,IAAI,OAAO,CAAC;IAErB;;OAEG;IACH,WAAW,EAAE,YAAY,GAAG,SAAS,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC~~;;;;;OAKG~~;IACH,QAAQ,CAAC,WAAW,EAAE,iBAAiB,GAAG,SAAS,CAAC;~~IAEpD~~;;;OAGG;IACH,uBAAuB,CAAC,IAAI,iBAAiB,GAAG,SAAS,CAAC;IAE1D;;;;OAIG;IACH,oBAAoB,CAAC,IAAI,iBAAiB,GAAG,SAAS,CAAC;IAEvD;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IAEzB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,KAAK,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAC;IAE7C;;;OAGG;IACH,4BAA4B,IAAI,MAAM,CAAC;IAEvC;;;;;OAKG;IACH,kBAAkB,CAAC,WAAW,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAEpE;;;;;OAKG;IACH,MAAM,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;OAEG;IACH,SAAS,IAAI,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAEjE;;;OAGG;IACH,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;~~CAClD~~;AAED;;GAEG;AACH,MAAM,WAAW,OAAQ,SAAQ,YAAY,EAAE,OAAO,CAAC,cAAc,CAAC;IAClE;;;;;;OAMG;IACH,OAAO,CAAC,OAAO,EAAE,QAAQ,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CAC/E;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,OAAO;IACxC;;;OAGG;IACH,uBAAuB,CAAC,WAAW,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAE7E;;;OAGG;IACH,sCAAsC,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CACjF;AAED,oBAAY,cAAc,GAAG;KACxB,GAAG,IAAI,MAAM,GAAG,MAAM,GAAG,GAAG;CAChC,GAAG;IACA;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAK7B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;MAEE;IACF,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACnC,CAAC;AAEF;;GAEG;AACH,oBAAY,YAAY;IACpB;;OAEG;IACH,KAAK,gBAAgB;IAErB,aAAa,yBAAyB;IAEtC;;OAEG;IACH,QAAQ,aAAa;IACrB,SAAS,oBAAoB;IAC7B,cAAc,0BAA0B;IAExC;;;;;OAKG;IACH,OAAO,YAAY;CACtB;AAED,MAAM,WAAW,kBAAkB;IAC/B,eAAe,CAAC,EAKV,SAAS,GAOT,QAAQ,GAOR,KAAK,CAAA;IACX,eAAe,CAAC,EAKV,MAAM,GAON,SAAS,GAMT,SAAS,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IAC9B,CAAC,YAAY,CAAC,aAAa,CAAC,EAAE,cAAc,CAAC;IAC7C,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC5C,CAAC,YAAY,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACtC,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAClC,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9C;AAED,MAAM,WAAW,cAAc;IAC3B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC7B;AAED,OAAO,QAAQ,iCAAiC,CAAC;IAE7C,UAAiB,cAAe,SAAQ,OAAO,CAAC,aAAa,CAAC;KAAI;IAElE,UAAiB,YAAY;QACzB;;WAEG;QACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;KAC9B;CACJ;AAED,MAAM,WAAW,kBAAkB;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,mBAAmB,EAAE,OAAO,CAAC;CAChC"}
1	+ {"version":3,"file":"loader.d.ts","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,QAAQ,EACR,SAAS,EACT,YAAY,EACZ,iBAAiB,EACjB,aAAa,EACb,gCAAgC,EACnC,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,OAAO,EACP,yBAAyB,EAC5B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACvD,OAAO,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAExC;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,OAAO,CAAC,gCAAgC,CAAC;IAC1E;;OAEG;IACH,IAAI,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CAC1D;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB;IAChE;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC;IAClD;;OAEG;IACH,QAAQ,CAAC,sBAAsB,EAAE,MAAM,GAAG,SAAS,CAAC;CACvD;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;;;;;;OAOG;IACH,kBAAkB,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAC;CACtF;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B,UAAU,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACnE;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,MAAM;IAC5C,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,GAAG,IAAI,CAAC;IACjE,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;IAC3D,CAAC,KAAK,EAAE,qBAAqB,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,iBAAiB,EAAE,QAAQ,EAAE,gBAAgB,KAAK,IAAI,OAAE;IAC/G,CAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,iBAAiB,KAAK,IAAI,OAAE;IAC9E,CAAC,KAAK,EAAE,cAAc,GAAG,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC3D,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,KAAK,CAAC,EAAE,uBAAuB,KAAK,IAAI,OAAE;IACvE,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI,OAAE;IAChE,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,OAAE;IACtE,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,OAAE;CAClE;AAED;;GAEG;AACH,yBAAiB,eAAe,CAAC;IAC7B;;OAEG;IACH,KAAY,YAAY,GAAG,CAAC,CAAC;IAE7B;;OAEG;IACH,KAAY,UAAU,GAAG,CAAC,CAAC;IAE3B;;OAEG;IACF,KAAY,SAAS,GAAG,CAAC,CAAC;CAC9B;AAED;;GAEG;AACH,oBAAY,eAAe,GAAG,eAAe,CAAC,YAAY,GAAG,eAAe,CAAC,UAAU,GAAG,eAAe,CAAC,SAAS,CAAC;AAEpH;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,cAAc,CAAC,gBAAgB,CAAC,EAAE,YAAY;IAE9E;;OAEG;IACH,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,CAAC;IAEzE;;;OAGG;IACH,SAAS,IAAI,OAAO,CAAC;IAErB;;OAEG;IACH,WAAW,EAAE,YAAY,GAAG,SAAS,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC;;;;;;OAMG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAErD;;;OAGG;IACH,uBAAuB,CAAC,IAAI,iBAAiB,GAAG,SAAS,CAAC;IAE1D;;;;OAIG;IACH,oBAAoB,CAAC,IAAI,iBAAiB,GAAG,SAAS,CAAC;IAEvD;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IAEzB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,KAAK,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAC;IAE7C;;;OAGG;IACH,4BAA4B,IAAI,MAAM,CAAC;IAEvC;;;;;OAKG;IACH,kBAAkB,CAAC,WAAW,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAEpE;;;;;OAKG;IACH,MAAM,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;OAEG;IACH,SAAS,IAAI,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAEjE;;;OAGG;IACH,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAE/C;;OAEG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,eAAe,CAAC;IAE3C;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAE7B;;;;;OAKG;IACH,gBAAgB,CAAC,CAAC,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,MAAM,CAAC,IAAI,IAAI,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC;IAE9B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEvC;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC;IAErC;;;;OAIG;IACH,aAAa,CAAC,CAAC,QAAQ,EAAE,OAAO,OAAE;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,OAAQ,SAAQ,YAAY,EAAE,OAAO,CAAC,cAAc,CAAC;IAClE;;;;;;OAMG;IACH,OAAO,CAAC,OAAO,EAAE,QAAQ,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CAC/E;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,OAAO;IACxC;;;OAGG;IACH,uBAAuB,CAAC,WAAW,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAE7E;;;OAGG;IACH,sCAAsC,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CACjF;AAED,oBAAY,cAAc,GAAG;KACxB,GAAG,IAAI,MAAM,GAAG,MAAM,GAAG,GAAG;CAChC,GAAG;IACA;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAK7B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;MAEE;IACF,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACnC,CAAC;AAEF;;GAEG;AACH,oBAAY,YAAY;IACpB;;OAEG;IACH,KAAK,gBAAgB;IAErB,aAAa,yBAAyB;IAEtC;;OAEG;IACH,QAAQ,aAAa;IACrB,SAAS,oBAAoB;IAC7B,cAAc,0BAA0B;IAExC;;;;;OAKG;IACH,OAAO,YAAY;CACtB;AAED,MAAM,WAAW,kBAAkB;IAC/B,eAAe,CAAC,EAKV,SAAS,GAOT,QAAQ,GAOR,KAAK,CAAA;IACX,eAAe,CAAC,EAKV,MAAM,GAON,SAAS,GAMT,SAAS,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IAC9B,CAAC,YAAY,CAAC,aAAa,CAAC,EAAE,cAAc,CAAC;IAC7C,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC5C,CAAC,YAAY,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACtC,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAClC,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9C;AAED,MAAM,WAAW,cAAc;IAC3B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC7B;AAED,OAAO,QAAQ,iCAAiC,CAAC;IAE7C,UAAiB,cAAe,SAAQ,OAAO,CAAC,aAAa,CAAC;KAAI;IAElE,UAAiB,YAAY;QACzB;;WAEG;QACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;KAC9B;CACJ;AAED,MAAM,WAAW,kBAAkB;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,mBAAmB,EAAE,OAAO,CAAC;CAChC"}

package/dist/loader.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"loader.js","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA+QH;;GAEG;AACH,IAAY,YAsBX;AAtBD,WAAY,YAAY;IACpB;;OAEG;IACH,qCAAqB,CAAA;IAErB,sDAAsC,CAAA;IAEtC;;OAEG;IACH,qCAAqB,CAAA;IACrB,6CAA6B,CAAA;IAC7B,wDAAwC,CAAA;IAExC;;;;;OAKG;IACH,mCAAmB,CAAA;AACvB,CAAC,EAtBW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAsBvB","sourcesContent":["/!\n Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n /\n\nimport {\n IRequest,\n IResponse,\n IFluidRouter,\n IFluidCodeDetails,\n IFluidPackage,\n IProvideFluidCodeDetailsComparer,\n} from \"@fluidframework/core-interfaces\";\nimport {\n IClientDetails,\n IDocumentMessage,\n IPendingProposal,\n IQuorum,\n ISequencedDocumentMessage,\n} from \"@fluidframework/protocol-definitions\";\nimport { IResolvedUrl } from \"@fluidframework/driver-definitions\";\nimport { IEvent, IEventProvider } from \"@fluidframework/common-definitions\";\nimport { IDeltaManager } from \"./deltas\";\nimport { ICriticalContainerError, ContainerWarning } from \"./error\";\nimport { IFluidModule } from \"./fluidModule\";\nimport { AttachState } from \"./runtime\";\n\n/\n Code loading interface\n \n @deprecated in favor of {@link @fluidframework/container-loader#ICodeDetailsLoader}\n /\nexport interface ICodeLoader extends Partial<IProvideFluidCodeDetailsComparer> {\n /\n Loads the package specified by code details and returns a promise to its entry point exports.\n /\n load(source: IFluidCodeDetails): Promise<IFluidModule>;\n}\n\n/\n The interface returned from a IFluidCodeResolver which represents IFluidCodeDetails\n * that have been resolved and are ready to load\n /\nexport interface IResolvedFluidCodeDetails extends IFluidCodeDetails {\n /\n A resolved version of the Fluid package. All Fluid browser file entries should be absolute urls.\n /\n readonly resolvedPackage: Readonly<IFluidPackage>;\n /\n If not undefined, this id will be used to cache the entry point for the code package\n /\n readonly resolvedPackageCacheId: string \| undefined;\n}\n\n/\n Fluid code resolvers take a Fluid code details, and resolve the\n * full Fluid package including absolute urls for the browser file entries.\n * The Fluid code resolver is coupled to a specific cdn and knows how to resolve\n * the code detail for loading from that cdn. This include resolving to the most recent\n * version of package that supports the provided code details.\n /\nexport interface IFluidCodeResolver {\n /\n Resolves a Fluid code details into a form that can be loaded\n * @param details - The Fluid code details to resolve\n * @returns - A IResolvedFluidCodeDetails where the\n * resolvedPackage's Fluid file entries are absolute urls, and\n * an optional resolvedPackageCacheId if the loaded package should be\n * cached.\n /\n resolveCodeDetails(details: IFluidCodeDetails): Promise<IResolvedFluidCodeDetails>;\n}\n\n/\n Code AllowListing Interface\n /\nexport interface ICodeAllowList {\n testSource(source: IResolvedFluidCodeDetails): Promise<boolean>;\n}\n\n/\n Events emitted by the Container \"upwards\" to the Loader and Host\n /\nexport interface IContainerEvents extends IEvent {\n (event: \"readonly\", listener: (readonly: boolean) => void): void;\n (event: \"connected\", listener: (clientId: string) => void);\n (event: \"codeDetailsProposed\", listener: (codeDetails: IFluidCodeDetails, proposal: IPendingProposal) => void);\n (event: \"contextChanged\", listener: (codeDetails: IFluidCodeDetails) => void);\n (event: \"disconnected\" \| \"attached\", listener: () => void);\n (event: \"closed\", listener: (error?: ICriticalContainerError) => void);\n (event: \"warning\", listener: (error: ContainerWarning) => void);\n (event: \"op\", listener: (message: ISequencedDocumentMessage) => void);\n (event: \"dirty\" \| \"saved\", listener: (dirty: boolean) => void);\n}\n\n/\n The Host's view of the Container and its connection to storage\n /\nexport interface IContainer extends IEventProvider<IContainerEvents>, IFluidRouter {\n\n /\n The Delta Manager supporting the op stream for this Container\n /\n deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;\n\n /\n The collection of write clients which were connected as of the current sequence number.\n * Also contains a map of key-value pairs that must be agreed upon by all clients before being accepted.\n /\n getQuorum(): IQuorum;\n\n /\n Represents the resolved url to the Container\n /\n resolvedUrl: IResolvedUrl \| undefined;\n\n /\n Indicates the attachment state of the container to a host service.\n /\n readonly attachState: AttachState;\n\n /\n The current code details for the container's runtime\n * @deprecated use getSpecifiedCodeDetails for the code details currently specified for this container, or\n * getLoadedCodeDetails for the code details that the container's context was loaded with.\n * To be removed after getSpecifiedCodeDetails and getLoadedCodeDetails become ubiquitous.\n /\n readonly codeDetails: IFluidCodeDetails \| undefined;\n\n /\n Get the code details that are currently specified for the container.\n * @returns The current code details if any are specified, undefined if none are specified.\n /\n getSpecifiedCodeDetails?(): IFluidCodeDetails \| undefined;\n\n /\n Get the code details that were used to load the container.\n * @returns The code details that were used to load the container if it is loaded, undefined if it is not yet\n * loaded.\n /\n getLoadedCodeDetails?(): IFluidCodeDetails \| undefined;\n\n /\n Returns true if the container has been closed, otherwise false\n /\n readonly closed: boolean;\n\n /\n Returns true if the container is dirty, i.e. there are user changes that has not been saved\n * Closing container in this state results in data loss for user.\n * Container usually gets into this situation due to loss of connectivity.\n /\n readonly isDirty: boolean;\n\n /\n Closes the container\n /\n close(error?: ICriticalContainerError): void;\n\n /\n Closes the container and returns serialized local state intended to be\n * given to a newly loaded container\n /\n closeAndGetPendingLocalState(): string;\n\n /\n Propose new code details that define the code to be loaded\n * for this container's runtime. The returned promise will\n * be true when the proposal is accepted, and false if\n * the proposal is rejected.\n /\n proposeCodeDetails(codeDetails: IFluidCodeDetails): Promise<boolean>\n\n /\n Attaches the Container to the Container specified by the given Request.\n \n TODO - in the case of failure options should give a retry policy. Or some continuation function\n * that allows attachment to a secondary document.\n /\n attach(request: IRequest): Promise<void>;\n\n /\n Extract the snapshot from the detached container.\n /\n serialize(): string;\n\n /\n Get an absolute url for a provided container-relative request url.\n * If the container is not attached, this will return undefined.\n \n @param relativeUrl - A container-relative request URL\n /\n getAbsoluteUrl(relativeUrl: string): Promise<string \| undefined>;\n\n /\n Issue a request against the container for a resource.\n * @param request - The request to be issued against the container\n /\n request(request: IRequest): Promise<IResponse>;\n}\n\n/\n The Runtime's view of the Loader, used for loading Containers\n /\nexport interface ILoader extends IFluidRouter, Partial<IProvideLoader> {\n /\n Resolves the resource specified by the URL + headers contained in the request object\n * to the underlying container that will resolve the request.\n \n An analogy for this is resolve is a DNS resolve of a Fluid container. Request then executes\n * a request against the server found from the resolve step.\n /\n resolve(request: IRequest, pendingLocalState?: string): Promise<IContainer>;\n}\n\n/\n The Host's view of the Loader, used for loading Containers\n /\nexport interface IHostLoader extends ILoader {\n /\n Creates a new container using the specified chaincode but in an unattached state. While unattached all\n * updates will only be local until the user explicitly attaches the container to a service provider.\n /\n createDetachedContainer(codeDetails: IFluidCodeDetails): Promise<IContainer>;\n\n /\n Creates a new container using the specified snapshot but in an unattached state. While unattached all\n * updates will only be local until the user explicitly attaches the container to a service provider.\n /\n rehydrateDetachedContainerFromSnapshot(snapshot: string): Promise<IContainer>;\n}\n\nexport type ILoaderOptions = {\n [key in string \| number]: any;\n} & {\n /\n Set caching behavior for the loader. If true, we will load a container from cache if one\n * with the same id/version exists or create a new container and cache it if it does not. If\n * false, always load a new container and don't cache it. If the container has already been\n * closed, it will not be cached. A cache option in the LoaderHeader for an individual\n * request will override the Loader's value.\n * Defaults to true.\n /\n cache?: boolean;\n\n /\n Provide the current Loader through the scope object when creating Containers. It is added\n * as the `ILoader` property, and will overwrite an existing property of the same name on the\n * scope. Useful for when the host wants to provide the current Loader's functionality to\n * individual Data Stores, which is typically expected when creating with a Loader.\n * Defaults to true.\n /\n provideScopeLoader?: boolean;\n\n // Below two are the options based on which we decide how often client needs to send noops in case of active\n // connection which is not sending any op. The end result is the \"AND\" of these 2 options. So the client\n // should hit the min time and count to send the noop.\n /\n Set min time(in ms) frequency with which noops would be sent in case of active connection which is\n * not sending any op.\n /\n noopTimeFrequency?: number;\n\n /\n Set min op frequency with which noops would be sent in case of active connection which is not sending any op.\n /\n noopCountFrequency?: number;\n\n /\n Max time(in ms) container will wait for a leave message of a disconnected client.\n /\n maxClientLeaveWaitTime?: number,\n};\n\n/\n Accepted header keys for requests coming to the Loader\n /\nexport enum LoaderHeader {\n /\n Override the Loader's default caching behavior for this container.\n /\n cache = \"fluid-cache\",\n\n clientDetails = \"fluid-client-details\",\n\n /\n Start the container in a paused, unconnected state. Defaults to false\n /\n loadMode = \"loadMode\",\n reconnect = \"fluid-reconnect\",\n sequenceNumber = \"fluid-sequence-number\",\n\n /\n One of the following:\n * null or \"null\": use ops, no snapshots\n * undefined: fetch latest snapshot\n * otherwise, version sha to load snapshot\n /\n version = \"version\",\n}\n\nexport interface IContainerLoadMode {\n opsBeforeReturn?:\n /\n * No trailing ops are applied before container is returned.\n * Default value.\n /\n \| undefined\n /\n * Only cached trailing ops are applied before returning container.\n * Caching is optional and could be implemented by the driver.\n * If driver does not implement any kind of local caching strategy, this is same as above.\n * Driver may cache a lot of ops, so care needs to be exercised (see below).\n /\n \| \"cached\"\n /\n * All trailing ops in storage are fetched and applied before container is returned\n * This mode might have significant impact on boot speed (depends on storage perf characteristics)\n * Also there might be a lot of trailing ops and applying them might take time, so hosts are\n * recommended to have some progress UX / cancellation built into loading flow when using this option.\n /\n \| \"all\"\n deltaConnection?:\n /\n * Connection to delta stream is made only when Container.resume() call is made. Op processing\n * is paused (when container is returned from Loader.resolve()) until Container.resume() call is made.\n /\n \| \"none\"\n /\n * Connection to delta stream is made only when Container.resume() call is made.\n * Op fetching from storage is performed and ops are applied as they come in.\n * This is useful option if connection to delta stream is expensive and thus it's beneficial to move it\n * out from critical boot sequence, but it's beneficial to allow catch up to happen as fast as possible.\n /\n \| \"delayed\"\n /\n * Connection to delta stream is made right away.\n * Ops processing is enabled and ops are flowing through the system.\n * Default value.\n /\n \| undefined\n}\n\n/\n Set of Request Headers that the Loader understands and may inspect or modify\n /\nexport interface ILoaderHeader {\n [LoaderHeader.cache]: boolean;\n [LoaderHeader.clientDetails]: IClientDetails;\n [LoaderHeader.loadMode]: IContainerLoadMode;\n [LoaderHeader.sequenceNumber]: number;\n [LoaderHeader.reconnect]: boolean;\n [LoaderHeader.version]: string \| undefined;\n}\n\nexport interface IProvideLoader {\n readonly ILoader: ILoader;\n}\n\ndeclare module \"@fluidframework/core-interfaces\" {\n // eslint-disable-next-line @typescript-eslint/no-empty-interface\n export interface IRequestHeader extends Partial<ILoaderHeader> { }\n\n export interface IFluidObject {\n /\n @deprecated - use `FluidObject<ILoader>` instead\n */\n readonly ILoader?: ILoader;\n }\n}\n\nexport interface IPendingLocalState {\n url: string;\n pendingRuntimeState: unknown;\n}\n"]}
1	+ {"version":3,"file":"loader.js","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAmWH;;GAEG;AACH,IAAY,YAsBX;AAtBD,WAAY,YAAY;IACpB;;OAEG;IACH,qCAAqB,CAAA;IAErB,sDAAsC,CAAA;IAEtC;;OAEG;IACH,qCAAqB,CAAA;IACrB,6CAA6B,CAAA;IAC7B,wDAAwC,CAAA;IAExC;;;;;OAKG;IACH,mCAAmB,CAAA;AACvB,CAAC,EAtBW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAsBvB","sourcesContent":["/!\n Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n /\n\nimport {\n IRequest,\n IResponse,\n IFluidRouter,\n IFluidCodeDetails,\n IFluidPackage,\n IProvideFluidCodeDetailsComparer,\n} from \"@fluidframework/core-interfaces\";\nimport {\n IClientDetails,\n IDocumentMessage,\n IPendingProposal,\n IQuorum,\n ISequencedDocumentMessage,\n} from \"@fluidframework/protocol-definitions\";\nimport { IResolvedUrl } from \"@fluidframework/driver-definitions\";\nimport { IEvent, IEventProvider } from \"@fluidframework/common-definitions\";\nimport { IAudience } from \"./audience\";\nimport { IDeltaManager, ReadOnlyInfo } from \"./deltas\";\nimport { ICriticalContainerError, ContainerWarning } from \"./error\";\nimport { IFluidModule } from \"./fluidModule\";\nimport { AttachState } from \"./runtime\";\n\n/\n Code loading interface\n \n @deprecated in favor of {@link @fluidframework/container-loader#ICodeDetailsLoader}\n /\nexport interface ICodeLoader extends Partial<IProvideFluidCodeDetailsComparer> {\n /\n Loads the package specified by code details and returns a promise to its entry point exports.\n /\n load(source: IFluidCodeDetails): Promise<IFluidModule>;\n}\n\n/\n The interface returned from a IFluidCodeResolver which represents IFluidCodeDetails\n * that have been resolved and are ready to load\n /\nexport interface IResolvedFluidCodeDetails extends IFluidCodeDetails {\n /\n A resolved version of the Fluid package. All Fluid browser file entries should be absolute urls.\n /\n readonly resolvedPackage: Readonly<IFluidPackage>;\n /\n If not undefined, this id will be used to cache the entry point for the code package\n /\n readonly resolvedPackageCacheId: string \| undefined;\n}\n\n/\n Fluid code resolvers take a Fluid code details, and resolve the\n * full Fluid package including absolute urls for the browser file entries.\n * The Fluid code resolver is coupled to a specific cdn and knows how to resolve\n * the code detail for loading from that cdn. This include resolving to the most recent\n * version of package that supports the provided code details.\n /\nexport interface IFluidCodeResolver {\n /\n Resolves a Fluid code details into a form that can be loaded\n * @param details - The Fluid code details to resolve\n * @returns - A IResolvedFluidCodeDetails where the\n * resolvedPackage's Fluid file entries are absolute urls, and\n * an optional resolvedPackageCacheId if the loaded package should be\n * cached.\n /\n resolveCodeDetails(details: IFluidCodeDetails): Promise<IResolvedFluidCodeDetails>;\n}\n\n/\n Code AllowListing Interface\n /\nexport interface ICodeAllowList {\n testSource(source: IResolvedFluidCodeDetails): Promise<boolean>;\n}\n\n/\n Events emitted by the Container \"upwards\" to the Loader and Host\n /\nexport interface IContainerEvents extends IEvent {\n (event: \"readonly\", listener: (readonly: boolean) => void): void;\n (event: \"connected\", listener: (clientId: string) => void);\n (event: \"codeDetailsProposed\", listener: (codeDetails: IFluidCodeDetails, proposal: IPendingProposal) => void);\n (event: \"contextChanged\", listener: (codeDetails: IFluidCodeDetails) => void);\n (event: \"disconnected\" \| \"attached\", listener: () => void);\n (event: \"closed\", listener: (error?: ICriticalContainerError) => void);\n (event: \"warning\", listener: (error: ContainerWarning) => void);\n (event: \"op\", listener: (message: ISequencedDocumentMessage) => void);\n (event: \"dirty\" \| \"saved\", listener: (dirty: boolean) => void);\n}\n\n/\n Namespace for the different connection states a container can be in\n /\nexport namespace ConnectionState {\n /\n The document is no longer connected to the delta server\n /\n export type Disconnected = 0;\n\n /\n The document has an inbound connection but is still pending for outbound deltas\n /\n export type Connecting = 1;\n\n /\n The document is fully connected\n /\n export type Connected = 2;\n}\n\n/\n Type defining the different states of connectivity a container can be in\n /\nexport type ConnectionState = ConnectionState.Disconnected \| ConnectionState.Connecting \| ConnectionState.Connected;\n\n/\n The Host's view of the Container and its connection to storage\n /\nexport interface IContainer extends IEventProvider<IContainerEvents>, IFluidRouter {\n\n /\n The Delta Manager supporting the op stream for this Container\n /\n deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;\n\n /\n The collection of write clients which were connected as of the current sequence number.\n * Also contains a map of key-value pairs that must be agreed upon by all clients before being accepted.\n /\n getQuorum(): IQuorum;\n\n /\n Represents the resolved url to the Container\n /\n resolvedUrl: IResolvedUrl \| undefined;\n\n /\n Indicates the attachment state of the container to a host service.\n /\n readonly attachState: AttachState;\n\n /\n The current code details for the container's runtime\n * @deprecated use getSpecifiedCodeDetails for the code details currently specified for this container, or\n * getLoadedCodeDetails for the code details that the container's context was loaded with.\n * To be removed after getSpecifiedCodeDetails and getLoadedCodeDetails become ubiquitous.\n * This is now marked as optional and due to be removed in next release.\n /\n readonly codeDetails?: IFluidCodeDetails \| undefined;\n\n /\n Get the code details that are currently specified for the container.\n * @returns The current code details if any are specified, undefined if none are specified.\n /\n getSpecifiedCodeDetails?(): IFluidCodeDetails \| undefined;\n\n /\n Get the code details that were used to load the container.\n * @returns The code details that were used to load the container if it is loaded, undefined if it is not yet\n * loaded.\n /\n getLoadedCodeDetails?(): IFluidCodeDetails \| undefined;\n\n /\n Returns true if the container has been closed, otherwise false\n /\n readonly closed: boolean;\n\n /\n Returns true if the container is dirty, i.e. there are user changes that has not been saved\n * Closing container in this state results in data loss for user.\n * Container usually gets into this situation due to loss of connectivity.\n /\n readonly isDirty: boolean;\n\n /\n Closes the container\n /\n close(error?: ICriticalContainerError): void;\n\n /\n Closes the container and returns serialized local state intended to be\n * given to a newly loaded container\n /\n closeAndGetPendingLocalState(): string;\n\n /\n Propose new code details that define the code to be loaded\n * for this container's runtime. The returned promise will\n * be true when the proposal is accepted, and false if\n * the proposal is rejected.\n /\n proposeCodeDetails(codeDetails: IFluidCodeDetails): Promise<boolean>\n\n /\n Attaches the Container to the Container specified by the given Request.\n \n TODO - in the case of failure options should give a retry policy. Or some continuation function\n * that allows attachment to a secondary document.\n /\n attach(request: IRequest): Promise<void>;\n\n /\n Extract the snapshot from the detached container.\n /\n serialize(): string;\n\n /\n Get an absolute url for a provided container-relative request url.\n * If the container is not attached, this will return undefined.\n \n @param relativeUrl - A container-relative request URL\n /\n getAbsoluteUrl(relativeUrl: string): Promise<string \| undefined>;\n\n /\n Issue a request against the container for a resource.\n * @param request - The request to be issued against the container\n /\n request(request: IRequest): Promise<IResponse>;\n\n /\n Provides the current connected state of the container\n /\n readonly connectionState?: ConnectionState;\n\n /\n Boolean indicating whether the container is currently connected or not\n /\n readonly connected?: boolean;\n\n /\n Dictates whether or not the current container will automatically attempt to reconnect to the delta stream\n * after receiving a disconnect event\n * @param reconnect - Boolean indicating if reconnect should automatically occur\n * @alpha\n /\n setAutoReconnect?(reconnect: boolean): void;\n\n /\n Have the container attempt to resume processing ops\n * @alpha\n /\n resume?(): void;\n\n /\n The audience information for all clients currently associated with the document in the current session\n /\n readonly audience?: IAudience;\n\n /\n The server provided ID of the client.\n * Set once this.connected is true, otherwise undefined\n * @alpha\n /\n readonly clientId?: string \| undefined;\n\n /\n Tells if container is in read-only mode.\n * Data stores should listen for \"readonly\" notifications and disallow user making changes to data stores.\n * Readonly state can be because of no storage write permission,\n * or due to host forcing readonly mode for container.\n \n We do not differentiate here between no write access to storage vs. host disallowing changes to container -\n * in all cases container runtime and data stores should respect readonly state and not allow local changes.\n \n It is undefined if we have not yet established websocket connection\n * and do not know if user has write access to a file.\n /\n readonly readOnlyInfo?: ReadOnlyInfo;\n\n /\n Allows the host to have the container force to be in read-only mode\n * @param readonly - Boolean that toggles if read-only policies will be enforced\n * @alpha\n /\n forceReadonly?(readonly: boolean);\n}\n\n/\n The Runtime's view of the Loader, used for loading Containers\n /\nexport interface ILoader extends IFluidRouter, Partial<IProvideLoader> {\n /\n Resolves the resource specified by the URL + headers contained in the request object\n * to the underlying container that will resolve the request.\n \n An analogy for this is resolve is a DNS resolve of a Fluid container. Request then executes\n * a request against the server found from the resolve step.\n /\n resolve(request: IRequest, pendingLocalState?: string): Promise<IContainer>;\n}\n\n/\n The Host's view of the Loader, used for loading Containers\n /\nexport interface IHostLoader extends ILoader {\n /\n Creates a new container using the specified chaincode but in an unattached state. While unattached all\n * updates will only be local until the user explicitly attaches the container to a service provider.\n /\n createDetachedContainer(codeDetails: IFluidCodeDetails): Promise<IContainer>;\n\n /\n Creates a new container using the specified snapshot but in an unattached state. While unattached all\n * updates will only be local until the user explicitly attaches the container to a service provider.\n /\n rehydrateDetachedContainerFromSnapshot(snapshot: string): Promise<IContainer>;\n}\n\nexport type ILoaderOptions = {\n [key in string \| number]: any;\n} & {\n /\n Set caching behavior for the loader. If true, we will load a container from cache if one\n * with the same id/version exists or create a new container and cache it if it does not. If\n * false, always load a new container and don't cache it. If the container has already been\n * closed, it will not be cached. A cache option in the LoaderHeader for an individual\n * request will override the Loader's value.\n * Defaults to true.\n /\n cache?: boolean;\n\n /\n Provide the current Loader through the scope object when creating Containers. It is added\n * as the `ILoader` property, and will overwrite an existing property of the same name on the\n * scope. Useful for when the host wants to provide the current Loader's functionality to\n * individual Data Stores, which is typically expected when creating with a Loader.\n * Defaults to true.\n /\n provideScopeLoader?: boolean;\n\n // Below two are the options based on which we decide how often client needs to send noops in case of active\n // connection which is not sending any op. The end result is the \"AND\" of these 2 options. So the client\n // should hit the min time and count to send the noop.\n /\n Set min time(in ms) frequency with which noops would be sent in case of active connection which is\n * not sending any op.\n /\n noopTimeFrequency?: number;\n\n /\n Set min op frequency with which noops would be sent in case of active connection which is not sending any op.\n /\n noopCountFrequency?: number;\n\n /\n Max time(in ms) container will wait for a leave message of a disconnected client.\n /\n maxClientLeaveWaitTime?: number,\n};\n\n/\n Accepted header keys for requests coming to the Loader\n /\nexport enum LoaderHeader {\n /\n Override the Loader's default caching behavior for this container.\n /\n cache = \"fluid-cache\",\n\n clientDetails = \"fluid-client-details\",\n\n /\n Start the container in a paused, unconnected state. Defaults to false\n /\n loadMode = \"loadMode\",\n reconnect = \"fluid-reconnect\",\n sequenceNumber = \"fluid-sequence-number\",\n\n /\n One of the following:\n * null or \"null\": use ops, no snapshots\n * undefined: fetch latest snapshot\n * otherwise, version sha to load snapshot\n /\n version = \"version\",\n}\n\nexport interface IContainerLoadMode {\n opsBeforeReturn?:\n /\n * No trailing ops are applied before container is returned.\n * Default value.\n /\n \| undefined\n /\n * Only cached trailing ops are applied before returning container.\n * Caching is optional and could be implemented by the driver.\n * If driver does not implement any kind of local caching strategy, this is same as above.\n * Driver may cache a lot of ops, so care needs to be exercised (see below).\n /\n \| \"cached\"\n /\n * All trailing ops in storage are fetched and applied before container is returned\n * This mode might have significant impact on boot speed (depends on storage perf characteristics)\n * Also there might be a lot of trailing ops and applying them might take time, so hosts are\n * recommended to have some progress UX / cancellation built into loading flow when using this option.\n /\n \| \"all\"\n deltaConnection?:\n /\n * Connection to delta stream is made only when Container.resume() call is made. Op processing\n * is paused (when container is returned from Loader.resolve()) until Container.resume() call is made.\n /\n \| \"none\"\n /\n * Connection to delta stream is made only when Container.resume() call is made.\n * Op fetching from storage is performed and ops are applied as they come in.\n * This is useful option if connection to delta stream is expensive and thus it's beneficial to move it\n * out from critical boot sequence, but it's beneficial to allow catch up to happen as fast as possible.\n /\n \| \"delayed\"\n /\n * Connection to delta stream is made right away.\n * Ops processing is enabled and ops are flowing through the system.\n * Default value.\n /\n \| undefined\n}\n\n/\n Set of Request Headers that the Loader understands and may inspect or modify\n /\nexport interface ILoaderHeader {\n [LoaderHeader.cache]: boolean;\n [LoaderHeader.clientDetails]: IClientDetails;\n [LoaderHeader.loadMode]: IContainerLoadMode;\n [LoaderHeader.sequenceNumber]: number;\n [LoaderHeader.reconnect]: boolean;\n [LoaderHeader.version]: string \| undefined;\n}\n\nexport interface IProvideLoader {\n readonly ILoader: ILoader;\n}\n\ndeclare module \"@fluidframework/core-interfaces\" {\n // eslint-disable-next-line @typescript-eslint/no-empty-interface\n export interface IRequestHeader extends Partial<ILoaderHeader> { }\n\n export interface IFluidObject {\n /\n @deprecated - use `FluidObject<ILoader>` instead\n */\n readonly ILoader?: ILoader;\n }\n}\n\nexport interface IPendingLocalState {\n url: string;\n pendingRuntimeState: unknown;\n}\n"]}

package/lib/loader.d.ts CHANGED Viewed

@@ -6,7 +6,8 @@ import { IRequest, IResponse, IFluidRouter, IFluidCodeDetails, IFluidPackage, IP
 import { IClientDetails, IDocumentMessage, IPendingProposal, IQuorum, ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
 import { IResolvedUrl } from "@fluidframework/driver-definitions";
 import { IEvent, IEventProvider } from "@fluidframework/common-definitions";
-import { IDeltaManager } from "./deltas";
+import { IAudience } from "./audience";
+import { IDeltaManager, ReadOnlyInfo } from "./deltas";
 import { ICriticalContainerError, ContainerWarning } from "./error";
 import { IFluidModule } from "./fluidModule";
 import { AttachState } from "./runtime";
@@ -73,6 +74,27 @@ export interface IContainerEvents extends IEvent {
     (event: "op", listener: (message: ISequencedDocumentMessage) => void): any;
     (event: "dirty" | "saved", listener: (dirty: boolean) => void): any;
 }
+/**
+ * Namespace for the different connection states a container can be in
+ */
+export declare namespace ConnectionState {
+    /**
+     * The document is no longer connected to the delta server
+     */
+    type Disconnected = 0;
+    /**
+     * The document has an inbound connection but is still pending for outbound deltas
+     */
+    type Connecting = 1;
+    /**
+     * The document is fully connected
+     */
+    type Connected = 2;
+}
+/**
+ * Type defining the different states of connectivity a container can be in
+ */
+export declare type ConnectionState = ConnectionState.Disconnected | ConnectionState.Connecting | ConnectionState.Connected;
 /**
  * The Host's view of the Container and its connection to storage
  */
@@ -99,8 +121,9 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
      * @deprecated use getSpecifiedCodeDetails for the code details currently specified for this container, or
      * getLoadedCodeDetails for the code details that the container's context was loaded with.
      * To be removed after getSpecifiedCodeDetails and getLoadedCodeDetails become ubiquitous.
+     * This is now marked as optional and due to be removed in next release.
      */
-    readonly codeDetails: IFluidCodeDetails | undefined;
+    readonly codeDetails?: IFluidCodeDetails | undefined;
     /**
      * 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.
@@ -161,6 +184,55 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
      * @param request - The request to be issued against the container
      */
     request(request: IRequest): Promise<IResponse>;
+    /**
+     * Provides the current connected state of the container
+     */
+    readonly connectionState?: ConnectionState;
+    /**
+     * Boolean indicating whether the container is currently connected or not
+     */
+    readonly connected?: boolean;
+    /**
+     * Dictates whether or not the current container will automatically attempt to reconnect to the delta stream
+     * after receiving a disconnect event
+     * @param reconnect - Boolean indicating if reconnect should automatically occur
+     * @alpha
+     */
+    setAutoReconnect?(reconnect: boolean): void;
+    /**
+     * Have the container attempt to resume processing ops
+     * @alpha
+     */
+    resume?(): void;
+    /**
+     * The audience information for all clients currently associated with the document in the current session
+     */
+    readonly audience?: IAudience;
+    /**
+     * The server provided ID of the client.
+     * Set once this.connected is true, otherwise undefined
+     * @alpha
+     */
+    readonly clientId?: string | undefined;
+    /**
+     * Tells if container is in read-only mode.
+     * Data stores should listen for "readonly" notifications and disallow user making changes to data stores.
+     * Readonly state can be because of no storage write permission,
+     * or due to host forcing readonly mode for container.
+     *
+     * We do not differentiate here between no write access to storage vs. host disallowing changes to container -
+     * in all cases container runtime and data stores should respect readonly state and not allow local changes.
+     *
+     * It is undefined if we have not yet established websocket connection
+     * and do not know if user has write access to a file.
+     */
+    readonly readOnlyInfo?: ReadOnlyInfo;
+    /**
+     * Allows the host to have the container force to be in read-only mode
+     * @param readonly - Boolean that toggles if read-only policies will be enforced
+     * @alpha
+     */
+    forceReadonly?(readonly: boolean): any;
 }
 /**
  * The Runtime's view of the Loader, used for loading Containers

package/lib/loader.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"loader.d.ts","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,QAAQ,EACR,SAAS,EACT,YAAY,EACZ,iBAAiB,EACjB,aAAa,EACb,gCAAgC,EACnC,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,OAAO,EACP,yBAAyB,EAC5B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;~~AACzC~~,OAAO,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAExC;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,OAAO,CAAC,gCAAgC,CAAC;IAC1E;;OAEG;IACH,IAAI,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CAC1D;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB;IAChE;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC;IAClD;;OAEG;IACH,QAAQ,CAAC,sBAAsB,EAAE,MAAM,GAAG,SAAS,CAAC;CACvD;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;;;;;;OAOG;IACH,kBAAkB,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAC;CACtF;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B,UAAU,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACnE;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,MAAM;IAC5C,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,GAAG,IAAI,CAAC;IACjE,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;IAC3D,CAAC,KAAK,EAAE,qBAAqB,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,iBAAiB,EAAE,QAAQ,EAAE,gBAAgB,KAAK,IAAI,OAAE;IAC/G,CAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,iBAAiB,KAAK,IAAI,OAAE;IAC9E,CAAC,KAAK,EAAE,cAAc,GAAG,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC3D,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,KAAK,CAAC,EAAE,uBAAuB,KAAK,IAAI,OAAE;IACvE,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI,OAAE;IAChE,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,OAAE;IACtE,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,OAAE;CAClE;AAED;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,cAAc,CAAC,gBAAgB,CAAC,EAAE,YAAY;IAE9E;;OAEG;IACH,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,CAAC;IAEzE;;;OAGG;IACH,SAAS,IAAI,OAAO,CAAC;IAErB;;OAEG;IACH,WAAW,EAAE,YAAY,GAAG,SAAS,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC~~;;;;;OAKG~~;IACH,QAAQ,CAAC,WAAW,EAAE,iBAAiB,GAAG,SAAS,CAAC;~~IAEpD~~;;;OAGG;IACH,uBAAuB,CAAC,IAAI,iBAAiB,GAAG,SAAS,CAAC;IAE1D;;;;OAIG;IACH,oBAAoB,CAAC,IAAI,iBAAiB,GAAG,SAAS,CAAC;IAEvD;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IAEzB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,KAAK,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAC;IAE7C;;;OAGG;IACH,4BAA4B,IAAI,MAAM,CAAC;IAEvC;;;;;OAKG;IACH,kBAAkB,CAAC,WAAW,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAEpE;;;;;OAKG;IACH,MAAM,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;OAEG;IACH,SAAS,IAAI,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAEjE;;;OAGG;IACH,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;~~CAClD~~;AAED;;GAEG;AACH,MAAM,WAAW,OAAQ,SAAQ,YAAY,EAAE,OAAO,CAAC,cAAc,CAAC;IAClE;;;;;;OAMG;IACH,OAAO,CAAC,OAAO,EAAE,QAAQ,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CAC/E;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,OAAO;IACxC;;;OAGG;IACH,uBAAuB,CAAC,WAAW,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAE7E;;;OAGG;IACH,sCAAsC,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CACjF;AAED,oBAAY,cAAc,GAAG;KACxB,GAAG,IAAI,MAAM,GAAG,MAAM,GAAG,GAAG;CAChC,GAAG;IACA;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAK7B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;MAEE;IACF,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACnC,CAAC;AAEF;;GAEG;AACH,oBAAY,YAAY;IACpB;;OAEG;IACH,KAAK,gBAAgB;IAErB,aAAa,yBAAyB;IAEtC;;OAEG;IACH,QAAQ,aAAa;IACrB,SAAS,oBAAoB;IAC7B,cAAc,0BAA0B;IAExC;;;;;OAKG;IACH,OAAO,YAAY;CACtB;AAED,MAAM,WAAW,kBAAkB;IAC/B,eAAe,CAAC,EAKV,SAAS,GAOT,QAAQ,GAOR,KAAK,CAAA;IACX,eAAe,CAAC,EAKV,MAAM,GAON,SAAS,GAMT,SAAS,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IAC9B,CAAC,YAAY,CAAC,aAAa,CAAC,EAAE,cAAc,CAAC;IAC7C,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC5C,CAAC,YAAY,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACtC,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAClC,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9C;AAED,MAAM,WAAW,cAAc;IAC3B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC7B;AAED,OAAO,QAAQ,iCAAiC,CAAC;IAE7C,UAAiB,cAAe,SAAQ,OAAO,CAAC,aAAa,CAAC;KAAI;IAElE,UAAiB,YAAY;QACzB;;WAEG;QACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;KAC9B;CACJ;AAED,MAAM,WAAW,kBAAkB;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,mBAAmB,EAAE,OAAO,CAAC;CAChC"}
1	+ {"version":3,"file":"loader.d.ts","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,QAAQ,EACR,SAAS,EACT,YAAY,EACZ,iBAAiB,EACjB,aAAa,EACb,gCAAgC,EACnC,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,OAAO,EACP,yBAAyB,EAC5B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACvD,OAAO,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAExC;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,OAAO,CAAC,gCAAgC,CAAC;IAC1E;;OAEG;IACH,IAAI,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CAC1D;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB;IAChE;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC;IAClD;;OAEG;IACH,QAAQ,CAAC,sBAAsB,EAAE,MAAM,GAAG,SAAS,CAAC;CACvD;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;;;;;;OAOG;IACH,kBAAkB,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAC;CACtF;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B,UAAU,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACnE;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,MAAM;IAC5C,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,GAAG,IAAI,CAAC;IACjE,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;IAC3D,CAAC,KAAK,EAAE,qBAAqB,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,iBAAiB,EAAE,QAAQ,EAAE,gBAAgB,KAAK,IAAI,OAAE;IAC/G,CAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,iBAAiB,KAAK,IAAI,OAAE;IAC9E,CAAC,KAAK,EAAE,cAAc,GAAG,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC3D,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,KAAK,CAAC,EAAE,uBAAuB,KAAK,IAAI,OAAE;IACvE,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI,OAAE;IAChE,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,OAAE;IACtE,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,OAAE;CAClE;AAED;;GAEG;AACH,yBAAiB,eAAe,CAAC;IAC7B;;OAEG;IACH,KAAY,YAAY,GAAG,CAAC,CAAC;IAE7B;;OAEG;IACH,KAAY,UAAU,GAAG,CAAC,CAAC;IAE3B;;OAEG;IACF,KAAY,SAAS,GAAG,CAAC,CAAC;CAC9B;AAED;;GAEG;AACH,oBAAY,eAAe,GAAG,eAAe,CAAC,YAAY,GAAG,eAAe,CAAC,UAAU,GAAG,eAAe,CAAC,SAAS,CAAC;AAEpH;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,cAAc,CAAC,gBAAgB,CAAC,EAAE,YAAY;IAE9E;;OAEG;IACH,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,CAAC;IAEzE;;;OAGG;IACH,SAAS,IAAI,OAAO,CAAC;IAErB;;OAEG;IACH,WAAW,EAAE,YAAY,GAAG,SAAS,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC;;;;;;OAMG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAErD;;;OAGG;IACH,uBAAuB,CAAC,IAAI,iBAAiB,GAAG,SAAS,CAAC;IAE1D;;;;OAIG;IACH,oBAAoB,CAAC,IAAI,iBAAiB,GAAG,SAAS,CAAC;IAEvD;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IAEzB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,KAAK,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAC;IAE7C;;;OAGG;IACH,4BAA4B,IAAI,MAAM,CAAC;IAEvC;;;;;OAKG;IACH,kBAAkB,CAAC,WAAW,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAEpE;;;;;OAKG;IACH,MAAM,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;OAEG;IACH,SAAS,IAAI,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAEjE;;;OAGG;IACH,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAE/C;;OAEG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,eAAe,CAAC;IAE3C;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAE7B;;;;;OAKG;IACH,gBAAgB,CAAC,CAAC,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,MAAM,CAAC,IAAI,IAAI,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC;IAE9B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEvC;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC;IAErC;;;;OAIG;IACH,aAAa,CAAC,CAAC,QAAQ,EAAE,OAAO,OAAE;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,OAAQ,SAAQ,YAAY,EAAE,OAAO,CAAC,cAAc,CAAC;IAClE;;;;;;OAMG;IACH,OAAO,CAAC,OAAO,EAAE,QAAQ,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CAC/E;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,OAAO;IACxC;;;OAGG;IACH,uBAAuB,CAAC,WAAW,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAE7E;;;OAGG;IACH,sCAAsC,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CACjF;AAED,oBAAY,cAAc,GAAG;KACxB,GAAG,IAAI,MAAM,GAAG,MAAM,GAAG,GAAG;CAChC,GAAG;IACA;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAK7B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;MAEE;IACF,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACnC,CAAC;AAEF;;GAEG;AACH,oBAAY,YAAY;IACpB;;OAEG;IACH,KAAK,gBAAgB;IAErB,aAAa,yBAAyB;IAEtC;;OAEG;IACH,QAAQ,aAAa;IACrB,SAAS,oBAAoB;IAC7B,cAAc,0BAA0B;IAExC;;;;;OAKG;IACH,OAAO,YAAY;CACtB;AAED,MAAM,WAAW,kBAAkB;IAC/B,eAAe,CAAC,EAKV,SAAS,GAOT,QAAQ,GAOR,KAAK,CAAA;IACX,eAAe,CAAC,EAKV,MAAM,GAON,SAAS,GAMT,SAAS,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IAC9B,CAAC,YAAY,CAAC,aAAa,CAAC,EAAE,cAAc,CAAC;IAC7C,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC5C,CAAC,YAAY,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACtC,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAClC,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9C;AAED,MAAM,WAAW,cAAc;IAC3B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC7B;AAED,OAAO,QAAQ,iCAAiC,CAAC;IAE7C,UAAiB,cAAe,SAAQ,OAAO,CAAC,aAAa,CAAC;KAAI;IAElE,UAAiB,YAAY;QACzB;;WAEG;QACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;KAC9B;CACJ;AAED,MAAM,WAAW,kBAAkB;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,mBAAmB,EAAE,OAAO,CAAC;CAChC"}

package/lib/loader.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"loader.js","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA+QH;;GAEG;AACH,MAAM,CAAN,IAAY,YAsBX;AAtBD,WAAY,YAAY;IACpB;;OAEG;IACH,qCAAqB,CAAA;IAErB,sDAAsC,CAAA;IAEtC;;OAEG;IACH,qCAAqB,CAAA;IACrB,6CAA6B,CAAA;IAC7B,wDAAwC,CAAA;IAExC;;;;;OAKG;IACH,mCAAmB,CAAA;AACvB,CAAC,EAtBW,YAAY,KAAZ,YAAY,QAsBvB","sourcesContent":["/!\n Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n /\n\nimport {\n IRequest,\n IResponse,\n IFluidRouter,\n IFluidCodeDetails,\n IFluidPackage,\n IProvideFluidCodeDetailsComparer,\n} from \"@fluidframework/core-interfaces\";\nimport {\n IClientDetails,\n IDocumentMessage,\n IPendingProposal,\n IQuorum,\n ISequencedDocumentMessage,\n} from \"@fluidframework/protocol-definitions\";\nimport { IResolvedUrl } from \"@fluidframework/driver-definitions\";\nimport { IEvent, IEventProvider } from \"@fluidframework/common-definitions\";\nimport { IDeltaManager } from \"./deltas\";\nimport { ICriticalContainerError, ContainerWarning } from \"./error\";\nimport { IFluidModule } from \"./fluidModule\";\nimport { AttachState } from \"./runtime\";\n\n/\n Code loading interface\n \n @deprecated in favor of {@link @fluidframework/container-loader#ICodeDetailsLoader}\n /\nexport interface ICodeLoader extends Partial<IProvideFluidCodeDetailsComparer> {\n /\n Loads the package specified by code details and returns a promise to its entry point exports.\n /\n load(source: IFluidCodeDetails): Promise<IFluidModule>;\n}\n\n/\n The interface returned from a IFluidCodeResolver which represents IFluidCodeDetails\n * that have been resolved and are ready to load\n /\nexport interface IResolvedFluidCodeDetails extends IFluidCodeDetails {\n /\n A resolved version of the Fluid package. All Fluid browser file entries should be absolute urls.\n /\n readonly resolvedPackage: Readonly<IFluidPackage>;\n /\n If not undefined, this id will be used to cache the entry point for the code package\n /\n readonly resolvedPackageCacheId: string \| undefined;\n}\n\n/\n Fluid code resolvers take a Fluid code details, and resolve the\n * full Fluid package including absolute urls for the browser file entries.\n * The Fluid code resolver is coupled to a specific cdn and knows how to resolve\n * the code detail for loading from that cdn. This include resolving to the most recent\n * version of package that supports the provided code details.\n /\nexport interface IFluidCodeResolver {\n /\n Resolves a Fluid code details into a form that can be loaded\n * @param details - The Fluid code details to resolve\n * @returns - A IResolvedFluidCodeDetails where the\n * resolvedPackage's Fluid file entries are absolute urls, and\n * an optional resolvedPackageCacheId if the loaded package should be\n * cached.\n /\n resolveCodeDetails(details: IFluidCodeDetails): Promise<IResolvedFluidCodeDetails>;\n}\n\n/\n Code AllowListing Interface\n /\nexport interface ICodeAllowList {\n testSource(source: IResolvedFluidCodeDetails): Promise<boolean>;\n}\n\n/\n Events emitted by the Container \"upwards\" to the Loader and Host\n /\nexport interface IContainerEvents extends IEvent {\n (event: \"readonly\", listener: (readonly: boolean) => void): void;\n (event: \"connected\", listener: (clientId: string) => void);\n (event: \"codeDetailsProposed\", listener: (codeDetails: IFluidCodeDetails, proposal: IPendingProposal) => void);\n (event: \"contextChanged\", listener: (codeDetails: IFluidCodeDetails) => void);\n (event: \"disconnected\" \| \"attached\", listener: () => void);\n (event: \"closed\", listener: (error?: ICriticalContainerError) => void);\n (event: \"warning\", listener: (error: ContainerWarning) => void);\n (event: \"op\", listener: (message: ISequencedDocumentMessage) => void);\n (event: \"dirty\" \| \"saved\", listener: (dirty: boolean) => void);\n}\n\n/\n The Host's view of the Container and its connection to storage\n /\nexport interface IContainer extends IEventProvider<IContainerEvents>, IFluidRouter {\n\n /\n The Delta Manager supporting the op stream for this Container\n /\n deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;\n\n /\n The collection of write clients which were connected as of the current sequence number.\n * Also contains a map of key-value pairs that must be agreed upon by all clients before being accepted.\n /\n getQuorum(): IQuorum;\n\n /\n Represents the resolved url to the Container\n /\n resolvedUrl: IResolvedUrl \| undefined;\n\n /\n Indicates the attachment state of the container to a host service.\n /\n readonly attachState: AttachState;\n\n /\n The current code details for the container's runtime\n * @deprecated use getSpecifiedCodeDetails for the code details currently specified for this container, or\n * getLoadedCodeDetails for the code details that the container's context was loaded with.\n * To be removed after getSpecifiedCodeDetails and getLoadedCodeDetails become ubiquitous.\n /\n readonly codeDetails: IFluidCodeDetails \| undefined;\n\n /\n Get the code details that are currently specified for the container.\n * @returns The current code details if any are specified, undefined if none are specified.\n /\n getSpecifiedCodeDetails?(): IFluidCodeDetails \| undefined;\n\n /\n Get the code details that were used to load the container.\n * @returns The code details that were used to load the container if it is loaded, undefined if it is not yet\n * loaded.\n /\n getLoadedCodeDetails?(): IFluidCodeDetails \| undefined;\n\n /\n Returns true if the container has been closed, otherwise false\n /\n readonly closed: boolean;\n\n /\n Returns true if the container is dirty, i.e. there are user changes that has not been saved\n * Closing container in this state results in data loss for user.\n * Container usually gets into this situation due to loss of connectivity.\n /\n readonly isDirty: boolean;\n\n /\n Closes the container\n /\n close(error?: ICriticalContainerError): void;\n\n /\n Closes the container and returns serialized local state intended to be\n * given to a newly loaded container\n /\n closeAndGetPendingLocalState(): string;\n\n /\n Propose new code details that define the code to be loaded\n * for this container's runtime. The returned promise will\n * be true when the proposal is accepted, and false if\n * the proposal is rejected.\n /\n proposeCodeDetails(codeDetails: IFluidCodeDetails): Promise<boolean>\n\n /\n Attaches the Container to the Container specified by the given Request.\n \n TODO - in the case of failure options should give a retry policy. Or some continuation function\n * that allows attachment to a secondary document.\n /\n attach(request: IRequest): Promise<void>;\n\n /\n Extract the snapshot from the detached container.\n /\n serialize(): string;\n\n /\n Get an absolute url for a provided container-relative request url.\n * If the container is not attached, this will return undefined.\n \n @param relativeUrl - A container-relative request URL\n /\n getAbsoluteUrl(relativeUrl: string): Promise<string \| undefined>;\n\n /\n Issue a request against the container for a resource.\n * @param request - The request to be issued against the container\n /\n request(request: IRequest): Promise<IResponse>;\n}\n\n/\n The Runtime's view of the Loader, used for loading Containers\n /\nexport interface ILoader extends IFluidRouter, Partial<IProvideLoader> {\n /\n Resolves the resource specified by the URL + headers contained in the request object\n * to the underlying container that will resolve the request.\n \n An analogy for this is resolve is a DNS resolve of a Fluid container. Request then executes\n * a request against the server found from the resolve step.\n /\n resolve(request: IRequest, pendingLocalState?: string): Promise<IContainer>;\n}\n\n/\n The Host's view of the Loader, used for loading Containers\n /\nexport interface IHostLoader extends ILoader {\n /\n Creates a new container using the specified chaincode but in an unattached state. While unattached all\n * updates will only be local until the user explicitly attaches the container to a service provider.\n /\n createDetachedContainer(codeDetails: IFluidCodeDetails): Promise<IContainer>;\n\n /\n Creates a new container using the specified snapshot but in an unattached state. While unattached all\n * updates will only be local until the user explicitly attaches the container to a service provider.\n /\n rehydrateDetachedContainerFromSnapshot(snapshot: string): Promise<IContainer>;\n}\n\nexport type ILoaderOptions = {\n [key in string \| number]: any;\n} & {\n /\n Set caching behavior for the loader. If true, we will load a container from cache if one\n * with the same id/version exists or create a new container and cache it if it does not. If\n * false, always load a new container and don't cache it. If the container has already been\n * closed, it will not be cached. A cache option in the LoaderHeader for an individual\n * request will override the Loader's value.\n * Defaults to true.\n /\n cache?: boolean;\n\n /\n Provide the current Loader through the scope object when creating Containers. It is added\n * as the `ILoader` property, and will overwrite an existing property of the same name on the\n * scope. Useful for when the host wants to provide the current Loader's functionality to\n * individual Data Stores, which is typically expected when creating with a Loader.\n * Defaults to true.\n /\n provideScopeLoader?: boolean;\n\n // Below two are the options based on which we decide how often client needs to send noops in case of active\n // connection which is not sending any op. The end result is the \"AND\" of these 2 options. So the client\n // should hit the min time and count to send the noop.\n /\n Set min time(in ms) frequency with which noops would be sent in case of active connection which is\n * not sending any op.\n /\n noopTimeFrequency?: number;\n\n /\n Set min op frequency with which noops would be sent in case of active connection which is not sending any op.\n /\n noopCountFrequency?: number;\n\n /\n Max time(in ms) container will wait for a leave message of a disconnected client.\n /\n maxClientLeaveWaitTime?: number,\n};\n\n/\n Accepted header keys for requests coming to the Loader\n /\nexport enum LoaderHeader {\n /\n Override the Loader's default caching behavior for this container.\n /\n cache = \"fluid-cache\",\n\n clientDetails = \"fluid-client-details\",\n\n /\n Start the container in a paused, unconnected state. Defaults to false\n /\n loadMode = \"loadMode\",\n reconnect = \"fluid-reconnect\",\n sequenceNumber = \"fluid-sequence-number\",\n\n /\n One of the following:\n * null or \"null\": use ops, no snapshots\n * undefined: fetch latest snapshot\n * otherwise, version sha to load snapshot\n /\n version = \"version\",\n}\n\nexport interface IContainerLoadMode {\n opsBeforeReturn?:\n /\n * No trailing ops are applied before container is returned.\n * Default value.\n /\n \| undefined\n /\n * Only cached trailing ops are applied before returning container.\n * Caching is optional and could be implemented by the driver.\n * If driver does not implement any kind of local caching strategy, this is same as above.\n * Driver may cache a lot of ops, so care needs to be exercised (see below).\n /\n \| \"cached\"\n /\n * All trailing ops in storage are fetched and applied before container is returned\n * This mode might have significant impact on boot speed (depends on storage perf characteristics)\n * Also there might be a lot of trailing ops and applying them might take time, so hosts are\n * recommended to have some progress UX / cancellation built into loading flow when using this option.\n /\n \| \"all\"\n deltaConnection?:\n /\n * Connection to delta stream is made only when Container.resume() call is made. Op processing\n * is paused (when container is returned from Loader.resolve()) until Container.resume() call is made.\n /\n \| \"none\"\n /\n * Connection to delta stream is made only when Container.resume() call is made.\n * Op fetching from storage is performed and ops are applied as they come in.\n * This is useful option if connection to delta stream is expensive and thus it's beneficial to move it\n * out from critical boot sequence, but it's beneficial to allow catch up to happen as fast as possible.\n /\n \| \"delayed\"\n /\n * Connection to delta stream is made right away.\n * Ops processing is enabled and ops are flowing through the system.\n * Default value.\n /\n \| undefined\n}\n\n/\n Set of Request Headers that the Loader understands and may inspect or modify\n /\nexport interface ILoaderHeader {\n [LoaderHeader.cache]: boolean;\n [LoaderHeader.clientDetails]: IClientDetails;\n [LoaderHeader.loadMode]: IContainerLoadMode;\n [LoaderHeader.sequenceNumber]: number;\n [LoaderHeader.reconnect]: boolean;\n [LoaderHeader.version]: string \| undefined;\n}\n\nexport interface IProvideLoader {\n readonly ILoader: ILoader;\n}\n\ndeclare module \"@fluidframework/core-interfaces\" {\n // eslint-disable-next-line @typescript-eslint/no-empty-interface\n export interface IRequestHeader extends Partial<ILoaderHeader> { }\n\n export interface IFluidObject {\n /\n @deprecated - use `FluidObject<ILoader>` instead\n */\n readonly ILoader?: ILoader;\n }\n}\n\nexport interface IPendingLocalState {\n url: string;\n pendingRuntimeState: unknown;\n}\n"]}
1	+ {"version":3,"file":"loader.js","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAmWH;;GAEG;AACH,MAAM,CAAN,IAAY,YAsBX;AAtBD,WAAY,YAAY;IACpB;;OAEG;IACH,qCAAqB,CAAA;IAErB,sDAAsC,CAAA;IAEtC;;OAEG;IACH,qCAAqB,CAAA;IACrB,6CAA6B,CAAA;IAC7B,wDAAwC,CAAA;IAExC;;;;;OAKG;IACH,mCAAmB,CAAA;AACvB,CAAC,EAtBW,YAAY,KAAZ,YAAY,QAsBvB","sourcesContent":["/!\n Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n /\n\nimport {\n IRequest,\n IResponse,\n IFluidRouter,\n IFluidCodeDetails,\n IFluidPackage,\n IProvideFluidCodeDetailsComparer,\n} from \"@fluidframework/core-interfaces\";\nimport {\n IClientDetails,\n IDocumentMessage,\n IPendingProposal,\n IQuorum,\n ISequencedDocumentMessage,\n} from \"@fluidframework/protocol-definitions\";\nimport { IResolvedUrl } from \"@fluidframework/driver-definitions\";\nimport { IEvent, IEventProvider } from \"@fluidframework/common-definitions\";\nimport { IAudience } from \"./audience\";\nimport { IDeltaManager, ReadOnlyInfo } from \"./deltas\";\nimport { ICriticalContainerError, ContainerWarning } from \"./error\";\nimport { IFluidModule } from \"./fluidModule\";\nimport { AttachState } from \"./runtime\";\n\n/\n Code loading interface\n \n @deprecated in favor of {@link @fluidframework/container-loader#ICodeDetailsLoader}\n /\nexport interface ICodeLoader extends Partial<IProvideFluidCodeDetailsComparer> {\n /\n Loads the package specified by code details and returns a promise to its entry point exports.\n /\n load(source: IFluidCodeDetails): Promise<IFluidModule>;\n}\n\n/\n The interface returned from a IFluidCodeResolver which represents IFluidCodeDetails\n * that have been resolved and are ready to load\n /\nexport interface IResolvedFluidCodeDetails extends IFluidCodeDetails {\n /\n A resolved version of the Fluid package. All Fluid browser file entries should be absolute urls.\n /\n readonly resolvedPackage: Readonly<IFluidPackage>;\n /\n If not undefined, this id will be used to cache the entry point for the code package\n /\n readonly resolvedPackageCacheId: string \| undefined;\n}\n\n/\n Fluid code resolvers take a Fluid code details, and resolve the\n * full Fluid package including absolute urls for the browser file entries.\n * The Fluid code resolver is coupled to a specific cdn and knows how to resolve\n * the code detail for loading from that cdn. This include resolving to the most recent\n * version of package that supports the provided code details.\n /\nexport interface IFluidCodeResolver {\n /\n Resolves a Fluid code details into a form that can be loaded\n * @param details - The Fluid code details to resolve\n * @returns - A IResolvedFluidCodeDetails where the\n * resolvedPackage's Fluid file entries are absolute urls, and\n * an optional resolvedPackageCacheId if the loaded package should be\n * cached.\n /\n resolveCodeDetails(details: IFluidCodeDetails): Promise<IResolvedFluidCodeDetails>;\n}\n\n/\n Code AllowListing Interface\n /\nexport interface ICodeAllowList {\n testSource(source: IResolvedFluidCodeDetails): Promise<boolean>;\n}\n\n/\n Events emitted by the Container \"upwards\" to the Loader and Host\n /\nexport interface IContainerEvents extends IEvent {\n (event: \"readonly\", listener: (readonly: boolean) => void): void;\n (event: \"connected\", listener: (clientId: string) => void);\n (event: \"codeDetailsProposed\", listener: (codeDetails: IFluidCodeDetails, proposal: IPendingProposal) => void);\n (event: \"contextChanged\", listener: (codeDetails: IFluidCodeDetails) => void);\n (event: \"disconnected\" \| \"attached\", listener: () => void);\n (event: \"closed\", listener: (error?: ICriticalContainerError) => void);\n (event: \"warning\", listener: (error: ContainerWarning) => void);\n (event: \"op\", listener: (message: ISequencedDocumentMessage) => void);\n (event: \"dirty\" \| \"saved\", listener: (dirty: boolean) => void);\n}\n\n/\n Namespace for the different connection states a container can be in\n /\nexport namespace ConnectionState {\n /\n The document is no longer connected to the delta server\n /\n export type Disconnected = 0;\n\n /\n The document has an inbound connection but is still pending for outbound deltas\n /\n export type Connecting = 1;\n\n /\n The document is fully connected\n /\n export type Connected = 2;\n}\n\n/\n Type defining the different states of connectivity a container can be in\n /\nexport type ConnectionState = ConnectionState.Disconnected \| ConnectionState.Connecting \| ConnectionState.Connected;\n\n/\n The Host's view of the Container and its connection to storage\n /\nexport interface IContainer extends IEventProvider<IContainerEvents>, IFluidRouter {\n\n /\n The Delta Manager supporting the op stream for this Container\n /\n deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;\n\n /\n The collection of write clients which were connected as of the current sequence number.\n * Also contains a map of key-value pairs that must be agreed upon by all clients before being accepted.\n /\n getQuorum(): IQuorum;\n\n /\n Represents the resolved url to the Container\n /\n resolvedUrl: IResolvedUrl \| undefined;\n\n /\n Indicates the attachment state of the container to a host service.\n /\n readonly attachState: AttachState;\n\n /\n The current code details for the container's runtime\n * @deprecated use getSpecifiedCodeDetails for the code details currently specified for this container, or\n * getLoadedCodeDetails for the code details that the container's context was loaded with.\n * To be removed after getSpecifiedCodeDetails and getLoadedCodeDetails become ubiquitous.\n * This is now marked as optional and due to be removed in next release.\n /\n readonly codeDetails?: IFluidCodeDetails \| undefined;\n\n /\n Get the code details that are currently specified for the container.\n * @returns The current code details if any are specified, undefined if none are specified.\n /\n getSpecifiedCodeDetails?(): IFluidCodeDetails \| undefined;\n\n /\n Get the code details that were used to load the container.\n * @returns The code details that were used to load the container if it is loaded, undefined if it is not yet\n * loaded.\n /\n getLoadedCodeDetails?(): IFluidCodeDetails \| undefined;\n\n /\n Returns true if the container has been closed, otherwise false\n /\n readonly closed: boolean;\n\n /\n Returns true if the container is dirty, i.e. there are user changes that has not been saved\n * Closing container in this state results in data loss for user.\n * Container usually gets into this situation due to loss of connectivity.\n /\n readonly isDirty: boolean;\n\n /\n Closes the container\n /\n close(error?: ICriticalContainerError): void;\n\n /\n Closes the container and returns serialized local state intended to be\n * given to a newly loaded container\n /\n closeAndGetPendingLocalState(): string;\n\n /\n Propose new code details that define the code to be loaded\n * for this container's runtime. The returned promise will\n * be true when the proposal is accepted, and false if\n * the proposal is rejected.\n /\n proposeCodeDetails(codeDetails: IFluidCodeDetails): Promise<boolean>\n\n /\n Attaches the Container to the Container specified by the given Request.\n \n TODO - in the case of failure options should give a retry policy. Or some continuation function\n * that allows attachment to a secondary document.\n /\n attach(request: IRequest): Promise<void>;\n\n /\n Extract the snapshot from the detached container.\n /\n serialize(): string;\n\n /\n Get an absolute url for a provided container-relative request url.\n * If the container is not attached, this will return undefined.\n \n @param relativeUrl - A container-relative request URL\n /\n getAbsoluteUrl(relativeUrl: string): Promise<string \| undefined>;\n\n /\n Issue a request against the container for a resource.\n * @param request - The request to be issued against the container\n /\n request(request: IRequest): Promise<IResponse>;\n\n /\n Provides the current connected state of the container\n /\n readonly connectionState?: ConnectionState;\n\n /\n Boolean indicating whether the container is currently connected or not\n /\n readonly connected?: boolean;\n\n /\n Dictates whether or not the current container will automatically attempt to reconnect to the delta stream\n * after receiving a disconnect event\n * @param reconnect - Boolean indicating if reconnect should automatically occur\n * @alpha\n /\n setAutoReconnect?(reconnect: boolean): void;\n\n /\n Have the container attempt to resume processing ops\n * @alpha\n /\n resume?(): void;\n\n /\n The audience information for all clients currently associated with the document in the current session\n /\n readonly audience?: IAudience;\n\n /\n The server provided ID of the client.\n * Set once this.connected is true, otherwise undefined\n * @alpha\n /\n readonly clientId?: string \| undefined;\n\n /\n Tells if container is in read-only mode.\n * Data stores should listen for \"readonly\" notifications and disallow user making changes to data stores.\n * Readonly state can be because of no storage write permission,\n * or due to host forcing readonly mode for container.\n \n We do not differentiate here between no write access to storage vs. host disallowing changes to container -\n * in all cases container runtime and data stores should respect readonly state and not allow local changes.\n \n It is undefined if we have not yet established websocket connection\n * and do not know if user has write access to a file.\n /\n readonly readOnlyInfo?: ReadOnlyInfo;\n\n /\n Allows the host to have the container force to be in read-only mode\n * @param readonly - Boolean that toggles if read-only policies will be enforced\n * @alpha\n /\n forceReadonly?(readonly: boolean);\n}\n\n/\n The Runtime's view of the Loader, used for loading Containers\n /\nexport interface ILoader extends IFluidRouter, Partial<IProvideLoader> {\n /\n Resolves the resource specified by the URL + headers contained in the request object\n * to the underlying container that will resolve the request.\n \n An analogy for this is resolve is a DNS resolve of a Fluid container. Request then executes\n * a request against the server found from the resolve step.\n /\n resolve(request: IRequest, pendingLocalState?: string): Promise<IContainer>;\n}\n\n/\n The Host's view of the Loader, used for loading Containers\n /\nexport interface IHostLoader extends ILoader {\n /\n Creates a new container using the specified chaincode but in an unattached state. While unattached all\n * updates will only be local until the user explicitly attaches the container to a service provider.\n /\n createDetachedContainer(codeDetails: IFluidCodeDetails): Promise<IContainer>;\n\n /\n Creates a new container using the specified snapshot but in an unattached state. While unattached all\n * updates will only be local until the user explicitly attaches the container to a service provider.\n /\n rehydrateDetachedContainerFromSnapshot(snapshot: string): Promise<IContainer>;\n}\n\nexport type ILoaderOptions = {\n [key in string \| number]: any;\n} & {\n /\n Set caching behavior for the loader. If true, we will load a container from cache if one\n * with the same id/version exists or create a new container and cache it if it does not. If\n * false, always load a new container and don't cache it. If the container has already been\n * closed, it will not be cached. A cache option in the LoaderHeader for an individual\n * request will override the Loader's value.\n * Defaults to true.\n /\n cache?: boolean;\n\n /\n Provide the current Loader through the scope object when creating Containers. It is added\n * as the `ILoader` property, and will overwrite an existing property of the same name on the\n * scope. Useful for when the host wants to provide the current Loader's functionality to\n * individual Data Stores, which is typically expected when creating with a Loader.\n * Defaults to true.\n /\n provideScopeLoader?: boolean;\n\n // Below two are the options based on which we decide how often client needs to send noops in case of active\n // connection which is not sending any op. The end result is the \"AND\" of these 2 options. So the client\n // should hit the min time and count to send the noop.\n /\n Set min time(in ms) frequency with which noops would be sent in case of active connection which is\n * not sending any op.\n /\n noopTimeFrequency?: number;\n\n /\n Set min op frequency with which noops would be sent in case of active connection which is not sending any op.\n /\n noopCountFrequency?: number;\n\n /\n Max time(in ms) container will wait for a leave message of a disconnected client.\n /\n maxClientLeaveWaitTime?: number,\n};\n\n/\n Accepted header keys for requests coming to the Loader\n /\nexport enum LoaderHeader {\n /\n Override the Loader's default caching behavior for this container.\n /\n cache = \"fluid-cache\",\n\n clientDetails = \"fluid-client-details\",\n\n /\n Start the container in a paused, unconnected state. Defaults to false\n /\n loadMode = \"loadMode\",\n reconnect = \"fluid-reconnect\",\n sequenceNumber = \"fluid-sequence-number\",\n\n /\n One of the following:\n * null or \"null\": use ops, no snapshots\n * undefined: fetch latest snapshot\n * otherwise, version sha to load snapshot\n /\n version = \"version\",\n}\n\nexport interface IContainerLoadMode {\n opsBeforeReturn?:\n /\n * No trailing ops are applied before container is returned.\n * Default value.\n /\n \| undefined\n /\n * Only cached trailing ops are applied before returning container.\n * Caching is optional and could be implemented by the driver.\n * If driver does not implement any kind of local caching strategy, this is same as above.\n * Driver may cache a lot of ops, so care needs to be exercised (see below).\n /\n \| \"cached\"\n /\n * All trailing ops in storage are fetched and applied before container is returned\n * This mode might have significant impact on boot speed (depends on storage perf characteristics)\n * Also there might be a lot of trailing ops and applying them might take time, so hosts are\n * recommended to have some progress UX / cancellation built into loading flow when using this option.\n /\n \| \"all\"\n deltaConnection?:\n /\n * Connection to delta stream is made only when Container.resume() call is made. Op processing\n * is paused (when container is returned from Loader.resolve()) until Container.resume() call is made.\n /\n \| \"none\"\n /\n * Connection to delta stream is made only when Container.resume() call is made.\n * Op fetching from storage is performed and ops are applied as they come in.\n * This is useful option if connection to delta stream is expensive and thus it's beneficial to move it\n * out from critical boot sequence, but it's beneficial to allow catch up to happen as fast as possible.\n /\n \| \"delayed\"\n /\n * Connection to delta stream is made right away.\n * Ops processing is enabled and ops are flowing through the system.\n * Default value.\n /\n \| undefined\n}\n\n/\n Set of Request Headers that the Loader understands and may inspect or modify\n /\nexport interface ILoaderHeader {\n [LoaderHeader.cache]: boolean;\n [LoaderHeader.clientDetails]: IClientDetails;\n [LoaderHeader.loadMode]: IContainerLoadMode;\n [LoaderHeader.sequenceNumber]: number;\n [LoaderHeader.reconnect]: boolean;\n [LoaderHeader.version]: string \| undefined;\n}\n\nexport interface IProvideLoader {\n readonly ILoader: ILoader;\n}\n\ndeclare module \"@fluidframework/core-interfaces\" {\n // eslint-disable-next-line @typescript-eslint/no-empty-interface\n export interface IRequestHeader extends Partial<ILoaderHeader> { }\n\n export interface IFluidObject {\n /\n @deprecated - use `FluidObject<ILoader>` instead\n */\n readonly ILoader?: ILoader;\n }\n}\n\nexport interface IPendingLocalState {\n url: string;\n pendingRuntimeState: unknown;\n}\n"]}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-definitions",
-  "version": "0.42.0",
+  "version": "0.43.0-45414",
   "description": "Fluid container definitions",
   "homepage": "https://fluidframework.com",
   "repository": "https://github.com/microsoft/FluidFramework",
@@ -38,15 +38,16 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.0",
     "@fluidframework/core-interfaces": "^0.41.0",
-    "@fluidframework/driver-definitions": "^0.42.0",
+    "@fluidframework/driver-definitions": "^0.43.0-0",
     "@fluidframework/protocol-definitions": "^0.1026.0"
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/build-tools": "^0.2.44421",
+    "@fluidframework/build-tools": "^0.2.44827",
     "@fluidframework/container-definitions-0.39.8": "npm:@fluidframework/container-definitions@0.39.8",
     "@fluidframework/container-definitions-0.40.0": "npm:@fluidframework/container-definitions@0.40.0",
     "@fluidframework/container-definitions-0.41.0": "npm:@fluidframework/container-definitions@0.41.0",
+    "@fluidframework/container-definitions-0.42.0": "npm:@fluidframework/container-definitions@0.42.0",
     "@fluidframework/eslint-config-fluid": "^0.24.0",
     "@microsoft/api-extractor": "^7.16.1",
     "@types/mocha": "^8.2.2",
@@ -67,7 +68,7 @@
     "typescript-formatter": "7.1.0"
   },
   "typeValidation": {
-    "version": "0.42.0",
+    "version": "0.43.0",
     "broken": {
       "0.39.8": {
         "EnumDeclaration_ContainerErrorType": {
@@ -143,6 +144,61 @@
         "InterfaceDeclaration_IRuntimeFactory": {
           "forwardCompat": false,
           "backCompat": false
+        },
+        "InterfaceDeclaration_ILoader": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IProxyLoaderFactory": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IHostLoader": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IContainer": {
+          "backCompat": false
+        }
+      },
+      "0.41.0": {
+        "InterfaceDeclaration_ILoader": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IProxyLoaderFactory": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IHostLoader": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IFluidModule": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IContainerContext": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IContainer": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_ICodeLoader": {
+          "backCompat": false
+        }
+      },
+      "0.42.0": {
+        "InterfaceDeclaration_ILoader": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IProxyLoaderFactory": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IHostLoader": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IContainerContext": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IContainer": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IProvideLoader": {
+          "backCompat": false
         }
       }
     }

package/src/loader.ts CHANGED Viewed

@@ -20,7 +20,8 @@ import {
 } from "@fluidframework/protocol-definitions";
 import { IResolvedUrl } from "@fluidframework/driver-definitions";
 import { IEvent, IEventProvider } from "@fluidframework/common-definitions";
-import { IDeltaManager } from "./deltas";
+import { IAudience } from "./audience";
+import { IDeltaManager, ReadOnlyInfo } from "./deltas";
 import { ICriticalContainerError, ContainerWarning } from "./error";
 import { IFluidModule } from "./fluidModule";
 import { AttachState } from "./runtime";
@@ -93,6 +94,31 @@ export interface IContainerEvents extends IEvent {
     (event: "dirty" | "saved", listener: (dirty: boolean) => void);
 }
+/**
+ * Namespace for the different connection states a container can be in
+ */
+export namespace ConnectionState {
+    /**
+     * The document is no longer connected to the delta server
+     */
+    export type Disconnected = 0;
+    /**
+     * The document has an inbound connection but is still pending for outbound deltas
+     */
+    export type Connecting = 1;
+    /**
+     * The document is fully connected
+     */
+     export type Connected = 2;
+}
+/**
+ * Type defining the different states of connectivity a container can be in
+ */
+export type ConnectionState = ConnectionState.Disconnected | ConnectionState.Connecting | ConnectionState.Connected;
 /**
  * The Host's view of the Container and its connection to storage
  */
@@ -124,8 +150,9 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
      * @deprecated use getSpecifiedCodeDetails for the code details currently specified for this container, or
      * getLoadedCodeDetails for the code details that the container's context was loaded with.
      * To be removed after getSpecifiedCodeDetails and getLoadedCodeDetails become ubiquitous.
+     * This is now marked as optional and due to be removed in next release.
      */
-    readonly codeDetails: IFluidCodeDetails | undefined;
+    readonly codeDetails?: IFluidCodeDetails | undefined;
     /**
      * Get the code details that are currently specified for the container.
@@ -197,6 +224,63 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
      * @param request - The request to be issued against the container
      */
     request(request: IRequest): Promise<IResponse>;
+    /**
+     * Provides the current connected state of the container
+     */
+    readonly connectionState?: ConnectionState;
+    /**
+     * Boolean indicating whether the container is currently connected or not
+     */
+    readonly connected?: boolean;
+    /**
+     * Dictates whether or not the current container will automatically attempt to reconnect to the delta stream
+     * after receiving a disconnect event
+     * @param reconnect - Boolean indicating if reconnect should automatically occur
+     * @alpha
+     */
+    setAutoReconnect?(reconnect: boolean): void;
+    /**
+     * Have the container attempt to resume processing ops
+     * @alpha
+     */
+    resume?(): void;
+    /**
+     * The audience information for all clients currently associated with the document in the current session
+     */
+    readonly audience?: IAudience;
+    /**
+     * The server provided ID of the client.
+     * Set once this.connected is true, otherwise undefined
+     * @alpha
+     */
+    readonly clientId?: string | undefined;
+    /**
+     * Tells if container is in read-only mode.
+     * Data stores should listen for "readonly" notifications and disallow user making changes to data stores.
+     * Readonly state can be because of no storage write permission,
+     * or due to host forcing readonly mode for container.
+     *
+     * We do not differentiate here between no write access to storage vs. host disallowing changes to container -
+     * in all cases container runtime and data stores should respect readonly state and not allow local changes.
+     *
+     * It is undefined if we have not yet established websocket connection
+     * and do not know if user has write access to a file.
+     */
+    readonly readOnlyInfo?: ReadOnlyInfo;
+    /**
+     * Allows the host to have the container force to be in read-only mode
+     * @param readonly - Boolean that toggles if read-only policies will be enforced
+     * @alpha
+     */
+    forceReadonly?(readonly: boolean);
 }
 /**