@fluidframework/container-definitions 2.0.0-internal.2.1.1 → 2.0.0-internal.2.2.0

package/lib/loader.d.ts

@@ -34,7 +34,7 @@ export interface IFluidModuleWithDetails {
  */
 export interface ICodeDetailsLoader extends Partial<IProvideFluidCodeDetailsComparer> {
     /**
-     * Load the code module (package) that is capable to interact with the document.
+     * Load the code module (package) that can interact with the document.
      *
      * @param source - Code proposal that articulates the current schema the document is written in.
      * @returns - Code module entry point along with the code details associated with it.
@@ -42,7 +42,7 @@ export interface ICodeDetailsLoader extends Partial<IProvideFluidCodeDetailsComp
     load(source: IFluidCodeDetails): Promise<IFluidModuleWithDetails>;
 }
 /**
-* The interface returned from a IFluidCodeResolver which represents IFluidCodeDetails
+ * The interface returned from a IFluidCodeResolver which represents IFluidCodeDetails
  * that have been resolved and are ready to load
  */
 export interface IResolvedFluidCodeDetails extends IFluidCodeDetails {
@@ -78,22 +78,134 @@ export interface ICodeAllowList {
     testSource(source: IResolvedFluidCodeDetails): Promise<boolean>;
 }
 /**
- * Events emitted by the Container "upwards" to the Loader and Host
+ * Events emitted by the {@link IContainer} "upwards" to the Loader and Host.
  */
 export interface IContainerEvents extends IEvent {
+    /**
+     * Emitted when the readonly state of the container changes.
+     *
+     * @remarks Listener parameters:
+     *
+     * - `readonly`: Whether or not the container is now in a readonly state.
+     *
+     * @see {@link IContainer.readOnlyInfo}
+     */
     (event: "readonly", listener: (readonly: boolean) => void): void;
+    /**
+     * Emitted when the {@link IContainer} completes connecting to the Fluid service.
+     *
+     * @remarks Reflects connection state changes against the (delta) service acknowledging ops/edits.
+     *
+     * @see
+     *
+     * - {@link IContainer.connectionState}
+     *
+     * - {@link IContainer.connect}
+     */
     (event: "connected", listener: (clientId: string) => void): any;
+    /**
+     * Fires when new container code details have been proposed, prior to acceptance.
+     *
+     * @remarks Listener parameters:
+     *
+     * - `codeDetails`: The code details being proposed.
+     *
+     * - `proposal`: NOT RECOMMENDED FOR USE.
+     *
+     * @see {@link IContainer.proposeCodeDetails}
+     */
     (event: "codeDetailsProposed", listener: (codeDetails: IFluidCodeDetails, proposal: ISequencedProposal) => void): any;
+    /**
+     * @deprecated No replacement API recommended.
+     */
     (event: "contextChanged", listener: (codeDetails: IFluidCodeDetails) => void): any;
-    (event: "disconnected" | "attached", listener: () => void): any;
+    /**
+     * Emitted when the {@link IContainer} becomes disconnected from the Fluid service.
+     *
+     * @remarks Reflects connection state changes against the (delta) service acknowledging ops/edits.
+     *
+     * @see
+     *
+     * - {@link IContainer.connectionState}
+     *
+     * - {@link IContainer.disconnect}
+     */
+    (event: "disconnected", listener: () => void): any;
+    /**
+     * Emitted when a {@link AttachState.Detached | detached} container is
+     * {@link AttachState.Attached | attached} to the Fluid service.
+     *
+     * @see
+     *
+     * - {@link IContainer.attachState}
+     *
+     * - {@link IContainer.attach}
+     */
+    (event: "attached", listener: () => void): any;
+    /**
+     * Emitted when the {@link IContainer} is closed, which permanently disables it.
+     *
+     * @remarks Listener parameters:
+     *
+     * - `error`: If the container was closed due to error, this will contain details about the error that caused it.
+     *
+     * @see {@link IContainer.close}
+     */
     (event: "closed", listener: (error?: ICriticalContainerError) => void): any;
+    /**
+     * Emitted when the container encounters a state which may lead to errors, which may be actionable by the consumer.
+     *
+     * @remarks
+     *
+     * Note: this event is not intended for general use.
+     * The longer-term intention is to surface warnings more directly on the APIs that produce them.
+     * For now, use of this should be avoided when possible.
+     *
+     * Listener parameters:
+     *
+     * - `error`: The warning describing the encountered state.
+     */
     (event: "warning", listener: (error: ContainerWarning) => void): any;
+    /**
+     * Emitted immediately after processing an incoming operation (op).
+     *
+     * @remarks
+     *
+     * Note: this event is not intended for general use.
+     * Prefer to listen to events on the appropriate ultimate recipients of the ops, rather than listening to the
+     * ops directly on the {@link IContainer}.
+     *
+     * Listener parameters:
+     *
+     * - `message`: The op that was processed.
+     */
     (event: "op", listener: (message: ISequencedDocumentMessage) => void): any;
-    (event: "dirty" | "saved", listener: (dirty: boolean) => void): any;
+    /**
+     * Emitted upon the first local change while the Container is in the "saved" state.
+     * That is, when {@link IContainer.isDirty} transitions from `true` to `false`.
+     *
+     * @remarks Listener parameters:
+     *
+     * - `dirty`: DEPRECATED. This parameter will be removed in a future release.
+     *
+     * @see {@link IContainer.isDirty}
+     */
+    (event: "dirty", listener: (dirty: boolean) => void): any;
+    /**
+     * Emitted when all local changes/edits have been acknowledged by the service.
+     * I.e., when {@link IContainer.isDirty} transitions from `false` to `true`.
+     *
+     * @remarks Listener parameters:
+     *
+     * - `dirty`: DEPRECATED. This parameter will be removed in a future release.
+     *
+     * @see {@link IContainer.isDirty}
+     */
+    (event: "saved", listener: (dirty: boolean) => void): any;
 }
 /**
- * Namespace for the different connection states a container can be in
- * PLEASE NOTE: The sequence of the numerical values does no correspond to the typical connection state progression
+ * Namespace for the different connection states a container can be in.
+ * PLEASE NOTE: The sequence of the numerical values does no correspond to the typical connection state progression.
  */
 export declare namespace ConnectionState {
     /**
@@ -117,11 +229,11 @@ export declare namespace ConnectionState {
     type Connected = 2;
 }
 /**
- * Type defining the different states of connectivity a container can be in.
+ * Type defining the different states of connectivity a Container can be in.
  */
 export declare type ConnectionState = ConnectionState.Disconnected | ConnectionState.EstablishingConnection | ConnectionState.CatchingUp | ConnectionState.Connected;
 /**
- * The Host's view of the Container and its connection to storage
+ * The Host's view of a Container and its connection to storage
  */
 export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRouter {
     /**
@@ -134,7 +246,7 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
      */
     getQuorum(): IQuorumClients;
     /**
-     * Represents the resolved url to the Container
+     * Represents the resolved url to the Container.
      * Will be undefined only when the container is in the {@link AttachState.Detached | detatched} state.
      */
     resolvedUrl: IResolvedUrl | undefined;
@@ -154,47 +266,50 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
      */
     getLoadedCodeDetails(): IFluidCodeDetails | undefined;
     /**
-     * Returns true if the container has been closed, otherwise false
+     * Returns true if the container has been closed, otherwise false.
      */
     readonly closed: boolean;
     /**
-     * Returns true if the container is dirty, i.e. there are user changes that has not been saved
-     * Closing container in this state results in data loss for user.
-     * Container usually gets into this situation due to loss of connectivity.
+     * Whether or not there are any local changes that have not been saved.
      */
     readonly isDirty: boolean;
     /**
-     * Closes the container
+     * Closes the container.
+     *
+     * @param error - If the container is being closed due to error, this provides details about the error that
+     * resulted in closing it.
      */
     close(error?: ICriticalContainerError): void;
     /**
      * Closes the container and returns serialized local state intended to be
-     * given to a newly loaded container
+     * given to a newly loaded container.
      */
     closeAndGetPendingLocalState(): string;
     /**
-     * Propose new code details that define the code to be loaded
-     * for this container's runtime. The returned promise will
-     * be true when the proposal is accepted, and false if
-     * the proposal is rejected.
+     * Propose new code details that define the code to be loaded for this container's runtime.
+     *
+     * The returned promise will be true when the proposal is accepted, and false if the proposal is rejected.
      */
     proposeCodeDetails(codeDetails: IFluidCodeDetails): Promise<boolean>;
     /**
      * Attaches the Container to the Container specified by the given Request.
      *
-     * TODO - in the case of failure options should give a retry policy. Or some continuation function
-     * that allows attachment to a secondary document.
+     * @privateRemarks
+     *
+     * TODO - in the case of failure options should give a retry policy.
+     * Or some continuation function that allows attachment to a secondary document.
      */
     attach(request: IRequest): Promise<void>;
     /**
-     * Extract the snapshot from the detached container.
+     * Extract a snapshot of the container as long as it is in detached state. Calling this on an attached container
+     * is an error.
      */
     serialize(): string;
     /**
-     * Get an absolute url for a provided container-relative request url.
+     * Get an absolute URL for a provided container-relative request URL.
      * If the container is not attached, this will return undefined.
      *
-     * @param relativeUrl - A container-relative request URL
+     * @param relativeUrl - A container-relative request URL.
      */
     getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;
     /**
@@ -203,29 +318,45 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
      */
     request(request: IRequest): Promise<IResponse>;
     /**
-     * Provides the current state of the container's connection to the ordering service
+     * Provides the current state of the container's connection to the ordering service.
+     *
+     * @remarks Consumers can listen for state changes via the "connected" and "disconnected" events.
      */
     readonly connectionState: ConnectionState;
     /**
-     * Attempts to connect the container to the delta stream and process ops
+     * Attempts to connect the container to the delta stream and process ops.
+     *
+     * @remarks
+     *
+     * {@link IContainer.connectionState} will be set to {@link (ConnectionState:namespace).Connected}, and the
+     * "connected" event will be fired if/when connection succeeds.
      */
     connect(): void;
     /**
-     * Disconnects the container from the delta stream and stops processing ops
+     * Disconnects the container from the delta stream and stops processing ops.
+     *
+     * @remarks
+     *
+     * {@link IContainer.connectionState} will be set to {@link (ConnectionState:namespace).Disconnected}, and the
+     * "disconnected" event will be fired when disconnection completes.
      */
     disconnect(): void;
     /**
-     * The audience information for all clients currently associated with the document in the current session
+     * 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.connectionState === ConnectionState.Connected is true, otherwise undefined
-     * @alpha
+     *
+     * Set once {@link IContainer.connectionState} is {@link (ConnectionState:namespace).Connected},
+     * otherwise will be `undefined`.
      */
     readonly clientId?: string | undefined;
     /**
      * Tells if container is in read-only mode.
+     *
+     * @remarks
+     *
      * 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.
@@ -252,6 +383,8 @@ export interface ILoader extends IFluidRouter, Partial<IProvideLoader> {
      * Resolves the resource specified by the URL + headers contained in the request object
      * to the underlying container that will resolve the request.
      *
+     * @remarks
+     *
      * An analogy for this is resolve is a DNS resolve of a Fluid container. Request then executes
      * a request against the server found from the resolve step.
      */
@@ -276,25 +409,25 @@ export declare type ILoaderOptions = {
     [key in string | number]: any;
 } & {
     /**
-     * Set caching behavior for the loader.  If true, we will load a container from cache if one
+     * Set caching behavior for the loader. If true, we will load a container from cache if one
      * with the same id/version exists or create a new container and cache it if it does not. If
      * false, always load a new container and don't cache it. If the container has already been
-     * closed, it will not be cached.  A cache option in the LoaderHeader for an individual
+     * closed, it will not be cached. A cache option in the LoaderHeader for an individual
      * request will override the Loader's value.
      * Defaults to true.
      */
     cache?: boolean;
     /**
-     * Provide the current Loader through the scope object when creating Containers.  It is added
+     * Provide the current Loader through the scope object when creating Containers. It is added
      * as the `ILoader` property, and will overwrite an existing property of the same name on the
-     * scope.  Useful for when the host wants to provide the current Loader's functionality to
+     * scope. Useful for when the host wants to provide the current Loader's functionality to
      * individual Data Stores, which is typically expected when creating with a Loader.
      * Defaults to true.
      */
     provideScopeLoader?: boolean;
     /**
-     * Max time(in ms) container will wait for a leave message of a disconnected client.
-    */
+     * Max time (in ms) container will wait for a leave message of a disconnected client.
+     */
     maxClientLeaveWaitTime?: number;
 };
 /**
@@ -341,7 +474,7 @@ export interface IProvideLoader {
 /**
  * @deprecated 0.48, This API will be removed in 0.50
  * No replacement since it is not expected anyone will depend on this outside container-loader
- * See https://github.com/microsoft/FluidFramework/issues/9711 for context
+ * See {@link https://github.com/microsoft/FluidFramework/issues/9711} for context.
  */
 export interface IPendingLocalState {
     url: string;
@@ -349,8 +482,9 @@ export interface IPendingLocalState {
 }
 /**
  * This is used when we rehydrate a container from the snapshot. Here we put the blob contents
- * in separate property: blobContents. This is used as the ContainerContext's base snapshot
- * when attaching.
+ * in separate property: {@link ISnapshotTreeWithBlobContents.blobsContents}.
+ *
+ * @remarks This is used as the `ContainerContext`'s base snapshot when attaching.
  */
 export interface ISnapshotTreeWithBlobContents extends ISnapshotTree {
     blobsContents: {

package/lib/loader.d.ts.map

@@ -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,EACf,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,cAAc,EACd,gBAAgB,EAChB,cAAc,EACd,yBAAyB,EACzB,kBAAkB,EAClB,aAAa,EAChB,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;AACxC,OAAO,EACH,iBAAiB,EACjB,aAAa,EACb,gCAAgC,EACnC,MAAM,gBAAgB,CAAC;AAExB;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;;;;OAKG;IACH,OAAO,EAAE,iBAAiB,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,kBACb,SAAQ,OAAO,CAAC,gCAAgC,CAAC;IACjD;;;;;OAKG;IACH,IAAI,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;CACrE;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;;;;;OAKG;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,kBAAkB,KAAK,IAAI,OAAE;IACjH,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;;;GAGG;AAEH,yBAAiB,eAAe,CAAC;IAC7B;;;;OAIG;IACH,KAAY,YAAY,GAAG,CAAC,CAAC;IAE7B;;;OAGG;IACH,KAAY,sBAAsB,GAAG,CAAC,CAAC;IAEvC;;MAEE;IACF,KAAY,UAAU,GAAG,CAAC,CAAC;IAE3B;;OAEG;IACH,KAAY,SAAS,GAAG,CAAC,CAAC;CAC7B;AAED;;GAEG;AACH,oBAAY,eAAe,GACrB,eAAe,CAAC,YAAY,GAC5B,eAAe,CAAC,sBAAsB,GACtC,eAAe,CAAC,UAAU,GAC1B,eAAe,CAAC,SAAS,CAAC;AAEhC;;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,cAAc,CAAC;IAE5B;;;OAGG;IACH,WAAW,EAAE,YAAY,GAAG,SAAS,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC;;;OAGG;IACH,uBAAuB,IAAI,iBAAiB,GAAG,SAAS,CAAC;IAEzD;;;;OAIG;IACH,oBAAoB,IAAI,iBAAiB,GAAG,SAAS,CAAC;IAEtD;;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,CAAC;IAErE;;;;;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,EAAE,eAAe,CAAC;IAE1C;;OAEG;IACH,OAAO,IAAI,IAAI,CAAC;IAEhB;;OAEG;IACH,UAAU,IAAI,IAAI,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;IAE7B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEvC;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IAEpC;;;;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;IAE7B;;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,EAKd,SAAS,GAOT,QAAQ,GAOR,KAAK,CAAC;IACR,eAAe,CAAC,EAKd,MAAM,GAON,SAAS,GAMT,SAAS,CAAC;CACf;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;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,mBAAmB,EAAE,OAAO,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,6BAA8B,SAAQ,aAAa;IAChE,aAAa,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,CAAC;KAAE,CAAC;IACpD,KAAK,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,6BAA6B,CAAC;KAAE,CAAC;CAC7D"}
+{"version":3,"file":"loader.d.ts","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,QAAQ,EACR,SAAS,EACT,YAAY,EACf,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,cAAc,EACd,gBAAgB,EAChB,cAAc,EACd,yBAAyB,EACzB,kBAAkB,EAClB,aAAa,EAChB,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;AACxC,OAAO,EACH,iBAAiB,EACjB,aAAa,EACb,gCAAgC,EACnC,MAAM,gBAAgB,CAAC;AAExB;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;;;;OAKG;IACH,OAAO,EAAE,iBAAiB,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,kBACb,SAAQ,OAAO,CAAC,gCAAgC,CAAC;IACjD;;;;;OAKG;IACH,IAAI,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;CACrE;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;;;;;OAKG;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;AAEH,MAAM,WAAW,gBAAiB,SAAQ,MAAM;IAC5C;;;;;;;;OAQG;IACH,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,GAAG,IAAI,CAAC;IAEjE;;;;;;;;;;OAUG;IACH,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;IAE3D;;;;;;;;;;OAUG;IACH,CAAC,KAAK,EAAE,qBAAqB,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,iBAAiB,EAAE,QAAQ,EAAE,kBAAkB,KAAK,IAAI,OAAE;IAEjH;;OAEG;IACH,CAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,iBAAiB,KAAK,IAAI,OAAE;IAE9E;;;;;;;;;;OAUG;IACH,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAE9C;;;;;;;;;OASG;IACH,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAE1C;;;;;;;;OAQG;IACH,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,KAAK,CAAC,EAAE,uBAAuB,KAAK,IAAI,OAAE;IAEvE;;;;;;;;;;;;OAYG;IACH,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI,OAAE;IAEhE;;;;;;;;;;;;OAYG;IACH,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,OAAE;IAEtE;;;;;;;;;OASG;IACH,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,OAAE;IAErD;;;;;;;;;OASG;IACH,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,OAAE;CACxD;AAGD;;;GAGG;AAEH,yBAAiB,eAAe,CAAC;IAC7B;;;;OAIG;IACH,KAAY,YAAY,GAAG,CAAC,CAAC;IAE7B;;;OAGG;IACH,KAAY,sBAAsB,GAAG,CAAC,CAAC;IAEvC;;MAEE;IACF,KAAY,UAAU,GAAG,CAAC,CAAC;IAE3B;;OAEG;IACH,KAAY,SAAS,GAAG,CAAC,CAAC;CAC7B;AAED;;GAEG;AACH,oBAAY,eAAe,GACrB,eAAe,CAAC,YAAY,GAC5B,eAAe,CAAC,sBAAsB,GACtC,eAAe,CAAC,UAAU,GAC1B,eAAe,CAAC,SAAS,CAAC;AAEhC;;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,cAAc,CAAC;IAE5B;;;OAGG;IACH,WAAW,EAAE,YAAY,GAAG,SAAS,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC;;;OAGG;IACH,uBAAuB,IAAI,iBAAiB,GAAG,SAAS,CAAC;IAEzD;;;;OAIG;IACH,oBAAoB,IAAI,iBAAiB,GAAG,SAAS,CAAC;IAEtD;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAC;IAE7C;;;OAGG;IACH,4BAA4B,IAAI,MAAM,CAAC;IAEvC;;;;OAIG;IACH,kBAAkB,CAAC,WAAW,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAErE;;;;;;;OAOG;IACH,MAAM,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;;OAGG;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;;;;OAIG;IACH,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;IAE1C;;;;;;;OAOG;IACH,OAAO,IAAI,IAAI,CAAC;IAEhB;;;;;;;OAOG;IACH,UAAU,IAAI,IAAI,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;IAE7B;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEvC;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IAEpC;;;;OAIG;IACH,aAAa,CAAC,CAAC,QAAQ,EAAE,OAAO,OAAE;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,OAAQ,SAAQ,YAAY,EAAE,OAAO,CAAC,cAAc,CAAC;IAClE;;;;;;;;OAQG;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;IAE7B;;OAEG;IACH,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,EAKd,SAAS,GAOT,QAAQ,GAOR,KAAK,CAAC;IAER,eAAe,CAAC,EAKd,MAAM,GAON,SAAS,GAMT,SAAS,CAAC;CACf;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;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,mBAAmB,EAAE,OAAO,CAAC;CAChC;AAED;;;;;GAKG;AACH,MAAM,WAAW,6BAA8B,SAAQ,aAAa;IAChE,aAAa,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,CAAC;KAAE,CAAC;IACpD,KAAK,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,6BAA6B,CAAC;KAAE,CAAC;CAC7D"}

package/lib/loader.js.map

@@ -1 +1 @@
-{"version":3,"file":"loader.js","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAwWH;;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} from \"@fluidframework/core-interfaces\";\nimport {\n    IClientDetails,\n    IDocumentMessage,\n    IQuorumClients,\n    ISequencedDocumentMessage,\n    ISequencedProposal,\n    ISnapshotTree,\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\";\nimport {\n    IFluidCodeDetails,\n    IFluidPackage,\n    IProvideFluidCodeDetailsComparer,\n} from \"./fluidPackage\";\n\n/**\n * Encapsulates a module entry point with corresponding code details.\n */\nexport interface IFluidModuleWithDetails {\n    /**\n     * Fluid code module that implements the runtime factory needed to instantiate the container runtime.\n     */\n    module: IFluidModule;\n\n    /**\n     * Code details associated with the module. Represents a document schema this module supports.\n     * If the code loader implements the {@link @fluidframework/core-interfaces#(IFluidCodeDetailsComparer:interface)}\n     * interface, it'll be called to determine whether the module code details satisfy the new code proposal in the\n     * quorum.\n     */\n    details: IFluidCodeDetails;\n}\n\n/**\n * Fluid code loader resolves a code module matching the document schema, i.e. code details, such as\n * a package name and package version range.\n */\nexport interface ICodeDetailsLoader\n    extends Partial<IProvideFluidCodeDetailsComparer> {\n    /**\n     * Load the code module (package) that is capable to interact with the document.\n     *\n     * @param source - Code proposal that articulates the current schema the document is written in.\n     * @returns - Code module entry point along with the code details associated with it.\n     */\n    load(source: IFluidCodeDetails): Promise<IFluidModuleWithDetails>;\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 resolvedPackage's Fluid file entries are absolute urls, and\n     * an optional resolvedPackageCacheId if the loaded package should be 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: ISequencedProposal) => 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 * PLEASE NOTE: The sequence of the numerical values does no correspond to the typical connection state progression\n */\n// eslint-disable-next-line @typescript-eslint/no-namespace\nexport namespace ConnectionState {\n    /**\n     * The container is not connected to the delta server.\n     * Note - When in this state the container may be about to reconnect,\n     * or may remain disconnected until explicitly told to connect.\n     */\n    export type Disconnected = 0;\n\n    /**\n     * The container is disconnected but actively trying to establish a new connection.\n     * PLEASE NOTE that this numerical value falls out of the order you may expect for this state.\n     */\n    export type EstablishingConnection = 3;\n\n    /**\n    * The container has an inbound connection only, and is catching up to the latest known state from the service.\n    */\n    export type CatchingUp = 1;\n\n    /**\n     * The container is fully connected and syncing.\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 =\n    | ConnectionState.Disconnected\n    | ConnectionState.EstablishingConnection\n    | ConnectionState.CatchingUp\n    | 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(): IQuorumClients;\n\n    /**\n     * Represents the resolved url to the Container\n     * Will be undefined only when the container is in the {@link AttachState.Detached | detatched} state.\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     * 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 state of the container's connection to the ordering service\n     */\n    readonly connectionState: ConnectionState;\n\n    /**\n     * Attempts to connect the container to the delta stream and process ops\n     */\n    connect(): void;\n\n    /**\n     * Disconnects the container from the delta stream and stops processing ops\n     */\n    disconnect(): 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.connectionState === ConnectionState.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    /**\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.connect() call is made. Op processing\n     * is paused (when container is returned from Loader.resolve()) until Container.connect() call is made.\n     */\n    | \"none\"\n    /*\n     * Connection to delta stream is made only when Container.connect() 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\n/**\n * @deprecated 0.48, This API will be removed in 0.50\n * No replacement since it is not expected anyone will depend on this outside container-loader\n * See https://github.com/microsoft/FluidFramework/issues/9711 for context\n */\nexport interface IPendingLocalState {\n    url: string;\n    pendingRuntimeState: unknown;\n}\n\n/**\n * This is used when we rehydrate a container from the snapshot. Here we put the blob contents\n * in separate property: blobContents. This is used as the ContainerContext's base snapshot\n * when attaching.\n */\nexport interface ISnapshotTreeWithBlobContents extends ISnapshotTree {\n    blobsContents: { [path: string]: ArrayBufferLike; };\n    trees: { [path: string]: ISnapshotTreeWithBlobContents; };\n}\n"]}
+{"version":3,"file":"loader.js","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAyfH;;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} from \"@fluidframework/core-interfaces\";\nimport {\n    IClientDetails,\n    IDocumentMessage,\n    IQuorumClients,\n    ISequencedDocumentMessage,\n    ISequencedProposal,\n    ISnapshotTree,\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\";\nimport {\n    IFluidCodeDetails,\n    IFluidPackage,\n    IProvideFluidCodeDetailsComparer,\n} from \"./fluidPackage\";\n\n/**\n * Encapsulates a module entry point with corresponding code details.\n */\nexport interface IFluidModuleWithDetails {\n    /**\n     * Fluid code module that implements the runtime factory needed to instantiate the container runtime.\n     */\n    module: IFluidModule;\n\n    /**\n     * Code details associated with the module. Represents a document schema this module supports.\n     * If the code loader implements the {@link @fluidframework/core-interfaces#(IFluidCodeDetailsComparer:interface)}\n     * interface, it'll be called to determine whether the module code details satisfy the new code proposal in the\n     * quorum.\n     */\n    details: IFluidCodeDetails;\n}\n\n/**\n * Fluid code loader resolves a code module matching the document schema, i.e. code details, such as\n * a package name and package version range.\n */\nexport interface ICodeDetailsLoader\n    extends Partial<IProvideFluidCodeDetailsComparer> {\n    /**\n     * Load the code module (package) that can interact with the document.\n     *\n     * @param source - Code proposal that articulates the current schema the document is written in.\n     * @returns - Code module entry point along with the code details associated with it.\n     */\n    load(source: IFluidCodeDetails): Promise<IFluidModuleWithDetails>;\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 resolvedPackage's Fluid file entries are absolute urls, and\n     * an optional resolvedPackageCacheId if the loaded package should be 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 {@link IContainer} \"upwards\" to the Loader and Host.\n */\n/* eslint-disable @typescript-eslint/unified-signatures */\nexport interface IContainerEvents extends IEvent {\n    /**\n     * Emitted when the readonly state of the container changes.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `readonly`: Whether or not the container is now in a readonly state.\n     *\n     * @see {@link IContainer.readOnlyInfo}\n     */\n    (event: \"readonly\", listener: (readonly: boolean) => void): void;\n\n    /**\n     * Emitted when the {@link IContainer} completes connecting to the Fluid service.\n     *\n     * @remarks Reflects connection state changes against the (delta) service acknowledging ops/edits.\n     *\n     * @see\n     *\n     * - {@link IContainer.connectionState}\n     *\n     * - {@link IContainer.connect}\n     */\n    (event: \"connected\", listener: (clientId: string) => void);\n\n    /**\n     * Fires when new container code details have been proposed, prior to acceptance.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `codeDetails`: The code details being proposed.\n     *\n     * - `proposal`: NOT RECOMMENDED FOR USE.\n     *\n     * @see {@link IContainer.proposeCodeDetails}\n     */\n    (event: \"codeDetailsProposed\", listener: (codeDetails: IFluidCodeDetails, proposal: ISequencedProposal) => void);\n\n    /**\n     * @deprecated No replacement API recommended.\n     */\n    (event: \"contextChanged\", listener: (codeDetails: IFluidCodeDetails) => void);\n\n    /**\n     * Emitted when the {@link IContainer} becomes disconnected from the Fluid service.\n     *\n     * @remarks Reflects connection state changes against the (delta) service acknowledging ops/edits.\n     *\n     * @see\n     *\n     * - {@link IContainer.connectionState}\n     *\n     * - {@link IContainer.disconnect}\n     */\n    (event: \"disconnected\", listener: () => void);\n\n    /**\n     * Emitted when a {@link AttachState.Detached | detached} container is\n     * {@link AttachState.Attached | attached} to the Fluid service.\n     *\n     * @see\n     *\n     * - {@link IContainer.attachState}\n     *\n     * - {@link IContainer.attach}\n     */\n    (event: \"attached\", listener: () => void);\n\n    /**\n     * Emitted when the {@link IContainer} is closed, which permanently disables it.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `error`: If the container was closed due to error, this will contain details about the error that caused it.\n     *\n     * @see {@link IContainer.close}\n     */\n    (event: \"closed\", listener: (error?: ICriticalContainerError) => void);\n\n    /**\n     * Emitted when the container encounters a state which may lead to errors, which may be actionable by the consumer.\n     *\n     * @remarks\n     *\n     * Note: this event is not intended for general use.\n     * The longer-term intention is to surface warnings more directly on the APIs that produce them.\n     * For now, use of this should be avoided when possible.\n     *\n     * Listener parameters:\n     *\n     * - `error`: The warning describing the encountered state.\n     */\n    (event: \"warning\", listener: (error: ContainerWarning) => void);\n\n    /**\n     * Emitted immediately after processing an incoming operation (op).\n     *\n     * @remarks\n     *\n     * Note: this event is not intended for general use.\n     * Prefer to listen to events on the appropriate ultimate recipients of the ops, rather than listening to the\n     * ops directly on the {@link IContainer}.\n     *\n     * Listener parameters:\n     *\n     * - `message`: The op that was processed.\n     */\n    (event: \"op\", listener: (message: ISequencedDocumentMessage) => void);\n\n    /**\n     * Emitted upon the first local change while the Container is in the \"saved\" state.\n     * That is, when {@link IContainer.isDirty} transitions from `true` to `false`.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `dirty`: DEPRECATED. This parameter will be removed in a future release.\n     *\n     * @see {@link IContainer.isDirty}\n     */\n    (event: \"dirty\", listener: (dirty: boolean) => void);\n\n    /**\n     * Emitted when all local changes/edits have been acknowledged by the service.\n     * I.e., when {@link IContainer.isDirty} transitions from `false` to `true`.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `dirty`: DEPRECATED. This parameter will be removed in a future release.\n     *\n     * @see {@link IContainer.isDirty}\n     */\n    (event: \"saved\", listener: (dirty: boolean) => void);\n}\n/* eslint-enable @typescript-eslint/unified-signatures */\n\n/**\n * Namespace for the different connection states a container can be in.\n * PLEASE NOTE: The sequence of the numerical values does no correspond to the typical connection state progression.\n */\n// eslint-disable-next-line @typescript-eslint/no-namespace\nexport namespace ConnectionState {\n    /**\n     * The container is not connected to the delta server.\n     * Note - When in this state the container may be about to reconnect,\n     * or may remain disconnected until explicitly told to connect.\n     */\n    export type Disconnected = 0;\n\n    /**\n     * The container is disconnected but actively trying to establish a new connection.\n     * PLEASE NOTE that this numerical value falls out of the order you may expect for this state.\n     */\n    export type EstablishingConnection = 3;\n\n    /**\n    * The container has an inbound connection only, and is catching up to the latest known state from the service.\n    */\n    export type CatchingUp = 1;\n\n    /**\n     * The container is fully connected and syncing.\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 =\n    | ConnectionState.Disconnected\n    | ConnectionState.EstablishingConnection\n    | ConnectionState.CatchingUp\n    | ConnectionState.Connected;\n\n/**\n * The Host's view of a 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(): IQuorumClients;\n\n    /**\n     * Represents the resolved url to the Container.\n     * Will be undefined only when the container is in the {@link AttachState.Detached | detatched} state.\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     * 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     * Whether or not there are any local changes that have not been saved.\n     */\n    readonly isDirty: boolean;\n\n    /**\n     * Closes the container.\n     *\n     * @param error - If the container is being closed due to error, this provides details about the error that\n     * resulted in closing it.\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 for this container's runtime.\n     *\n     * The returned promise will be true when the proposal is accepted, and false if 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     * @privateRemarks\n     *\n     * TODO - in the case of failure options should give a retry policy.\n     * Or some continuation function that allows attachment to a secondary document.\n     */\n    attach(request: IRequest): Promise<void>;\n\n    /**\n     * Extract a snapshot of the container as long as it is in detached state. Calling this on an attached container\n     * is an error.\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 state of the container's connection to the ordering service.\n     *\n     * @remarks Consumers can listen for state changes via the \"connected\" and \"disconnected\" events.\n     */\n    readonly connectionState: ConnectionState;\n\n    /**\n     * Attempts to connect the container to the delta stream and process ops.\n     *\n     * @remarks\n     *\n     * {@link IContainer.connectionState} will be set to {@link (ConnectionState:namespace).Connected}, and the\n     * \"connected\" event will be fired if/when connection succeeds.\n     */\n    connect(): void;\n\n    /**\n     * Disconnects the container from the delta stream and stops processing ops.\n     *\n     * @remarks\n     *\n     * {@link IContainer.connectionState} will be set to {@link (ConnectionState:namespace).Disconnected}, and the\n     * \"disconnected\" event will be fired when disconnection completes.\n     */\n    disconnect(): 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     *\n     * Set once {@link IContainer.connectionState} is {@link (ConnectionState:namespace).Connected},\n     * otherwise will be `undefined`.\n     */\n    readonly clientId?: string | undefined;\n\n    /**\n     * Tells if container is in read-only mode.\n     *\n     * @remarks\n     *\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     * @remarks\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    /**\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\n    deltaConnection?:\n    /*\n     * Connection to delta stream is made only when Container.connect() call is made. Op processing\n     * is paused (when container is returned from Loader.resolve()) until Container.connect() call is made.\n     */\n    | \"none\"\n    /*\n     * Connection to delta stream is made only when Container.connect() 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\n/**\n * @deprecated 0.48, This API will be removed in 0.50\n * No replacement since it is not expected anyone will depend on this outside container-loader\n * See {@link https://github.com/microsoft/FluidFramework/issues/9711} for context.\n */\nexport interface IPendingLocalState {\n    url: string;\n    pendingRuntimeState: unknown;\n}\n\n/**\n * This is used when we rehydrate a container from the snapshot. Here we put the blob contents\n * in separate property: {@link ISnapshotTreeWithBlobContents.blobsContents}.\n *\n * @remarks This is used as the `ContainerContext`'s base snapshot when attaching.\n */\nexport interface ISnapshotTreeWithBlobContents extends ISnapshotTree {\n    blobsContents: { [path: string]: ArrayBufferLike; };\n    trees: { [path: string]: ISnapshotTreeWithBlobContents; };\n}\n"]}

package/lib/runtime.d.ts

@@ -79,8 +79,9 @@ export interface IRuntime extends IDisposable {
  * Payload type for IContainerContext.submitBatchFn()
  */
 export interface IBatchMessage {
-    contents: string;
+    contents?: string;
     metadata: Record<string, unknown> | undefined;
+    compression?: string;
 }
 /**
  * The ContainerContext is a proxy standing between the Container and the Container's IRuntime.

package/lib/runtime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACvF,OAAO,EACH,WAAW,EACX,QAAQ,EACR,SAAS,EACZ,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,EACH,oBAAoB,EACpB,cAAc,EACd,yBAAyB,EACzB,aAAa,EACb,WAAW,EACX,YAAY,EACZ,QAAQ,EACR,gBAAgB,EAChB,cAAc,EACd,eAAe,EAClB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,6BAA6B,EAAE,MAAM,UAAU,CAAC;AAClF,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAEnD;;;GAGG;AACH,oBAAY,WAAW;IACnB;;;OAGG;IACH,QAAQ,aAAa;IAErB;;OAEG;IACH,SAAS,cAAc;IAEvB;;;OAGG;IACH,QAAQ,aAAa;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,QAAS,SAAQ,WAAW;IAEzC;;OAEG;IACH,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAE/C;;OAEG;IACH,kBAAkB,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,OAAE;IAE1D;;OAEG;IACH,OAAO,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,OAAE;IAE5D;;OAEG;IACH,aAAa,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,OAAE;IAE5C;;;;;;OAMG;IACH,aAAa,CAAC,iBAAiB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC;IAErE;;;OAGG;IACH,cAAc,CAAC,WAAW,EAAE,WAAW,CAAC,SAAS,GAAG,WAAW,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEhF;;OAEG;IACH,oBAAoB,IAAI,OAAO,CAAC;IAEhC;;;OAGG;IACH,eAAe,CAAC,QAAQ,EAAE,6BAA6B,GAAG,IAAI,CAAC;CAClE;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;CACjD;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IAClD,yEAAyE;IACzE,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;IACvC,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IACjC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAC;IACvC,QAAQ,CAAC,OAAO,EAAE,uBAAuB,CAAC;IAC1C,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,YAAY,EAAE,aAAa,GAAG,SAAS,CAAC;IACjD,6DAA6D;IAC7D,QAAQ,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,GAAG,KAAK,MAAM,CAAC;IAC/F,+DAA+D;IAC/D,QAAQ,CAAC,aAAa,EAAE,CAAC,KAAK,EAAE,aAAa,EAAE,KAAK,MAAM,CAAC;IAC3D,QAAQ,CAAC,eAAe,EAAE,CAAC,SAAS,EAAE,eAAe,KAAK,MAAM,CAAC;IACjE,QAAQ,CAAC,cAAc,EAAE,CAAC,QAAQ,EAAE,GAAG,KAAK,IAAI,CAAC;IACjD,QAAQ,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,EAAE,uBAAuB,KAAK,IAAI,CAAC;IAC5D,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,CAAC;IAClF,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;IAChC;;;;;;OAMG;IACH,uBAAuB,CAAC,IAAI,iBAAiB,GAAG,SAAS,CAAC;IAC1D,QAAQ,CAAC,QAAQ,EAAE,SAAS,GAAG,SAAS,CAAC;IACzC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IAEzB,QAAQ,CAAC,YAAY,EAAE,oBAAoB,CAAC;IAC5C,QAAQ,CAAC,oBAAoB,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAChE,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;IAE5B;;;;;OAKG;IACH,cAAc,CAAC,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAElE;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC,oBAAoB,IAAI,QAAQ,GAAG,SAAS,CAAC;IAE7C,yBAAyB,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;IAChD;;;;OAIG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;CACvB;AAED,eAAO,MAAM,eAAe,EAAE,MAAM,sBAA0C,CAAC;AAE/E,MAAM,WAAW,sBAAsB;IACnC,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;CAC7C;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAgB,SAAQ,sBAAsB;IAC3D;;;;;;OAMG;IACH,kBAAkB,CAAC,OAAO,EAAE,iBAAiB,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CACzF"}
+{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACvF,OAAO,EACH,WAAW,EACX,QAAQ,EACR,SAAS,EACZ,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,EACH,oBAAoB,EACpB,cAAc,EACd,yBAAyB,EACzB,aAAa,EACb,WAAW,EACX,YAAY,EACZ,QAAQ,EACR,gBAAgB,EAChB,cAAc,EACd,eAAe,EAClB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,6BAA6B,EAAE,MAAM,UAAU,CAAC;AAClF,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAEnD;;;GAGG;AACH,oBAAY,WAAW;IACnB;;;OAGG;IACH,QAAQ,aAAa;IAErB;;OAEG;IACH,SAAS,cAAc;IAEvB;;;OAGG;IACH,QAAQ,aAAa;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,QAAS,SAAQ,WAAW;IAEzC;;OAEG;IACH,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAE/C;;OAEG;IACH,kBAAkB,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,OAAE;IAE1D;;OAEG;IACH,OAAO,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,OAAE;IAE5D;;OAEG;IACH,aAAa,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,OAAE;IAE5C;;;;;;OAMG;IACH,aAAa,CAAC,iBAAiB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC;IAErE;;;OAGG;IACH,cAAc,CAAC,WAAW,EAAE,WAAW,CAAC,SAAS,GAAG,WAAW,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEhF;;OAEG;IACH,oBAAoB,IAAI,OAAO,CAAC;IAEhC;;;OAGG;IACH,eAAe,CAAC,QAAQ,EAAE,6BAA6B,GAAG,IAAI,CAAC;CAClE;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IAClD,yEAAyE;IACzE,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;IACvC,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IACjC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAC;IACvC,QAAQ,CAAC,OAAO,EAAE,uBAAuB,CAAC;IAC1C,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,YAAY,EAAE,aAAa,GAAG,SAAS,CAAC;IACjD,6DAA6D;IAC7D,QAAQ,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,GAAG,KAAK,MAAM,CAAC;IAC/F,+DAA+D;IAC/D,QAAQ,CAAC,aAAa,EAAE,CAAC,KAAK,EAAE,aAAa,EAAE,KAAK,MAAM,CAAC;IAC3D,QAAQ,CAAC,eAAe,EAAE,CAAC,SAAS,EAAE,eAAe,KAAK,MAAM,CAAC;IACjE,QAAQ,CAAC,cAAc,EAAE,CAAC,QAAQ,EAAE,GAAG,KAAK,IAAI,CAAC;IACjD,QAAQ,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,EAAE,uBAAuB,KAAK,IAAI,CAAC;IAC5D,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,CAAC;IAClF,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;IAChC;;;;;;OAMG;IACH,uBAAuB,CAAC,IAAI,iBAAiB,GAAG,SAAS,CAAC;IAC1D,QAAQ,CAAC,QAAQ,EAAE,SAAS,GAAG,SAAS,CAAC;IACzC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IAEzB,QAAQ,CAAC,YAAY,EAAE,oBAAoB,CAAC;IAC5C,QAAQ,CAAC,oBAAoB,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAChE,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;IAE5B;;;;;OAKG;IACH,cAAc,CAAC,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAElE;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC,oBAAoB,IAAI,QAAQ,GAAG,SAAS,CAAC;IAE7C,yBAAyB,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;IAChD;;;;OAIG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;CACvB;AAED,eAAO,MAAM,eAAe,EAAE,MAAM,sBAA0C,CAAC;AAE/E,MAAM,WAAW,sBAAsB;IACnC,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;CAC7C;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAgB,SAAQ,sBAAsB;IAC3D;;;;;;OAMG;IACH,kBAAkB,CAAC,OAAO,EAAE,iBAAiB,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CACzF"}

package/lib/runtime.js.map

@@ -1 +1 @@
-{"version":3,"file":"runtime.js","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA2BH;;;GAGG;AACH,MAAM,CAAN,IAAY,WAiBX;AAjBD,WAAY,WAAW;IACnB;;;OAGG;IACH,oCAAqB,CAAA;IAErB;;OAEG;IACH,sCAAuB,CAAA;IAEvB;;;OAGG;IACH,oCAAqB,CAAA;AACzB,CAAC,EAjBW,WAAW,KAAX,WAAW,QAiBtB;AAqID,MAAM,CAAC,MAAM,eAAe,GAAiC,iBAAiB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryBaseLogger, IDisposable } from \"@fluidframework/common-definitions\";\nimport {\n    FluidObject,\n    IRequest,\n    IResponse,\n} from \"@fluidframework/core-interfaces\";\nimport { IDocumentStorageService } from \"@fluidframework/driver-definitions\";\nimport {\n    IClientConfiguration,\n    IClientDetails,\n    ISequencedDocumentMessage,\n    ISnapshotTree,\n    MessageType,\n    ISummaryTree,\n    IVersion,\n    IDocumentMessage,\n    IQuorumClients,\n    ISummaryContent,\n} from \"@fluidframework/protocol-definitions\";\nimport { IAudience } from \"./audience\";\nimport { IDeltaManager } from \"./deltas\";\nimport { ICriticalContainerError } from \"./error\";\nimport { ILoader, ILoaderOptions, ISnapshotTreeWithBlobContents } from \"./loader\";\nimport { IFluidCodeDetails } from \"./fluidPackage\";\n\n/**\n * The attachment state of some Fluid data (e.g. a container or data store), denoting whether it is uploaded to the\n * service.  The transition from detached to attached state is a one-way transition.\n */\nexport enum AttachState {\n    /**\n     * In detached state, the data is only present on the local client's machine.  It has not yet been uploaded\n     * to the service.\n     */\n    Detached = \"Detached\",\n\n    /**\n     * In attaching state, the data has started the upload to the service, but has not yet completed.\n     */\n    Attaching = \"Attaching\",\n\n    /**\n     * In attached state, the data has completed upload to the service.  It can be accessed by other clients after\n     * reaching attached state.\n     */\n    Attached = \"Attached\",\n}\n\n/**\n * The IRuntime represents an instantiation of a code package within a Container.\n * Primarily held by the ContainerContext to be able to interact with the running instance of the Container.\n */\nexport interface IRuntime extends IDisposable {\n\n    /**\n     * Executes a request against the runtime\n     */\n    request(request: IRequest): Promise<IResponse>;\n\n    /**\n     * Notifies the runtime of a change in the connection state\n     */\n    setConnectionState(connected: boolean, clientId?: string);\n\n    /**\n     * Processes the given op (message)\n     */\n    process(message: ISequencedDocumentMessage, local: boolean);\n\n    /**\n     * Processes the given signal\n     */\n    processSignal(message: any, local: boolean);\n\n    /**\n     * Create a summary. Used when attaching or serializing a detached container.\n     *\n     * @param blobRedirectTable - A table passed during the attach process. While detached, blob upload is supported\n     * using IDs generated locally. After attach, these IDs cannot be used, so this table maps the old local IDs to the\n     * new storage IDs so requests can be redirected.\n     */\n    createSummary(blobRedirectTable?: Map<string, string>): ISummaryTree;\n\n    /**\n     * Propagate the container state when container is attaching or attached.\n     * @param attachState - State of the container.\n     */\n    setAttachState(attachState: AttachState.Attaching | AttachState.Attached): void;\n\n    /**\n     * Get pending local state in a serializable format to be given back to a newly loaded container\n     */\n    getPendingLocalState(): unknown;\n\n    /**\n     * Notify runtime that container is moving to \"Attaching\" state\n     * @param snapshot - snapshot created at attach time\n     */\n    notifyAttaching(snapshot: ISnapshotTreeWithBlobContents): void;\n}\n\n/**\n * Payload type for IContainerContext.submitBatchFn()\n */\nexport interface IBatchMessage {\n    contents: string;\n    metadata: Record<string, unknown> | undefined;\n}\n\n/**\n * The ContainerContext is a proxy standing between the Container and the Container's IRuntime.\n * This allows the Container to terminate the connection to the IRuntime.\n *\n * Specifically, there is an event on Container, onContextChanged, which mean a new code proposal has been loaded,\n * so the old IRuntime is no longer valid, as its ContainerContext has been revoked,\n * and the Container has created a new ContainerContext.\n */\nexport interface IContainerContext extends IDisposable {\n    /** @deprecated Please pass in existing directly in instantiateRuntime */\n    readonly existing: boolean | undefined;\n    readonly options: ILoaderOptions;\n    readonly clientId: string | undefined;\n    readonly clientDetails: IClientDetails;\n    readonly storage: IDocumentStorageService;\n    readonly connected: boolean;\n    readonly baseSnapshot: ISnapshotTree | undefined;\n    /** @deprecated Please use submitBatchFn & submitSummaryFn */\n    readonly submitFn: (type: MessageType, contents: any, batch: boolean, appData?: any) => number;\n    /** @returns clientSequenceNumber of last message in a batch */\n    readonly submitBatchFn: (batch: IBatchMessage[]) => number;\n    readonly submitSummaryFn: (summaryOp: ISummaryContent) => number;\n    readonly submitSignalFn: (contents: any) => void;\n    readonly closeFn: (error?: ICriticalContainerError) => void;\n    readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;\n    readonly quorum: IQuorumClients;\n    /**\n     * @deprecated This method is provided as a migration tool for customers currently reading the code details\n     * from within the Container by directly accessing the Quorum proposals.  The code details should not be accessed\n     * from within the Container as this requires coupling between the container contents and the code loader.\n     * Direct access to Quorum proposals will be removed in an upcoming release, and in a further future release this\n     * migration tool will be removed.\n     */\n    getSpecifiedCodeDetails?(): IFluidCodeDetails | undefined;\n    readonly audience: IAudience | undefined;\n    readonly loader: ILoader;\n    // The logger implementation, which would support tagged events, should be provided by the loader.\n    readonly taggedLogger: ITelemetryBaseLogger;\n    readonly serviceConfiguration: IClientConfiguration | undefined;\n    pendingLocalState?: unknown;\n\n    /**\n     * Ambient services provided with the context\n     */\n    readonly scope: FluidObject;\n\n    /**\n     * Get an absolute url for a provided container-relative request.\n     * @param relativeUrl - A relative request within the container\n     *\n     * TODO: Optional for backwards compatibility. Make non-optional in version 0.19\n     */\n    getAbsoluteUrl?(relativeUrl: string): Promise<string | undefined>;\n\n    /**\n     * Indicates the attachment state of the container to a host service.\n     */\n    readonly attachState: AttachState;\n\n    getLoadedFromVersion(): IVersion | undefined;\n\n    updateDirtyContainerState(dirty: boolean): void;\n    /**\n     * WARNING: this id is meant for telemetry usages ONLY, not recommended for other consumption\n     * This id is not supposed to be exposed anywhere else. It is dependant on usage or drivers\n     * and scenarios which can change in the future.\n     */\n    readonly id: string;\n}\n\nexport const IRuntimeFactory: keyof IProvideRuntimeFactory = \"IRuntimeFactory\";\n\nexport interface IProvideRuntimeFactory {\n    readonly IRuntimeFactory: IRuntimeFactory;\n}\n\n/**\n * Exported module definition\n *\n * Provides the entry point for the ContainerContext to load the proper IRuntime\n * to start up the running instance of the Container.\n */\nexport interface IRuntimeFactory extends IProvideRuntimeFactory {\n    /**\n     * Instantiates a new IRuntime for the given IContainerContext to proxy to\n     * This is the main entry point to the Container's business logic\n     *\n     * @param context - container context to be supplied to the runtime\n     * @param existing - whether to instantiate for the first time or from an existing context\n     */\n    instantiateRuntime(context: IContainerContext, existing?: boolean): Promise<IRuntime>;\n}\n"]}
+{"version":3,"file":"runtime.js","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA2BH;;;GAGG;AACH,MAAM,CAAN,IAAY,WAiBX;AAjBD,WAAY,WAAW;IACnB;;;OAGG;IACH,oCAAqB,CAAA;IAErB;;OAEG;IACH,sCAAuB,CAAA;IAEvB;;;OAGG;IACH,oCAAqB,CAAA;AACzB,CAAC,EAjBW,WAAW,KAAX,WAAW,QAiBtB;AAsID,MAAM,CAAC,MAAM,eAAe,GAAiC,iBAAiB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryBaseLogger, IDisposable } from \"@fluidframework/common-definitions\";\nimport {\n    FluidObject,\n    IRequest,\n    IResponse,\n} from \"@fluidframework/core-interfaces\";\nimport { IDocumentStorageService } from \"@fluidframework/driver-definitions\";\nimport {\n    IClientConfiguration,\n    IClientDetails,\n    ISequencedDocumentMessage,\n    ISnapshotTree,\n    MessageType,\n    ISummaryTree,\n    IVersion,\n    IDocumentMessage,\n    IQuorumClients,\n    ISummaryContent,\n} from \"@fluidframework/protocol-definitions\";\nimport { IAudience } from \"./audience\";\nimport { IDeltaManager } from \"./deltas\";\nimport { ICriticalContainerError } from \"./error\";\nimport { ILoader, ILoaderOptions, ISnapshotTreeWithBlobContents } from \"./loader\";\nimport { IFluidCodeDetails } from \"./fluidPackage\";\n\n/**\n * The attachment state of some Fluid data (e.g. a container or data store), denoting whether it is uploaded to the\n * service.  The transition from detached to attached state is a one-way transition.\n */\nexport enum AttachState {\n    /**\n     * In detached state, the data is only present on the local client's machine.  It has not yet been uploaded\n     * to the service.\n     */\n    Detached = \"Detached\",\n\n    /**\n     * In attaching state, the data has started the upload to the service, but has not yet completed.\n     */\n    Attaching = \"Attaching\",\n\n    /**\n     * In attached state, the data has completed upload to the service.  It can be accessed by other clients after\n     * reaching attached state.\n     */\n    Attached = \"Attached\",\n}\n\n/**\n * The IRuntime represents an instantiation of a code package within a Container.\n * Primarily held by the ContainerContext to be able to interact with the running instance of the Container.\n */\nexport interface IRuntime extends IDisposable {\n\n    /**\n     * Executes a request against the runtime\n     */\n    request(request: IRequest): Promise<IResponse>;\n\n    /**\n     * Notifies the runtime of a change in the connection state\n     */\n    setConnectionState(connected: boolean, clientId?: string);\n\n    /**\n     * Processes the given op (message)\n     */\n    process(message: ISequencedDocumentMessage, local: boolean);\n\n    /**\n     * Processes the given signal\n     */\n    processSignal(message: any, local: boolean);\n\n    /**\n     * Create a summary. Used when attaching or serializing a detached container.\n     *\n     * @param blobRedirectTable - A table passed during the attach process. While detached, blob upload is supported\n     * using IDs generated locally. After attach, these IDs cannot be used, so this table maps the old local IDs to the\n     * new storage IDs so requests can be redirected.\n     */\n    createSummary(blobRedirectTable?: Map<string, string>): ISummaryTree;\n\n    /**\n     * Propagate the container state when container is attaching or attached.\n     * @param attachState - State of the container.\n     */\n    setAttachState(attachState: AttachState.Attaching | AttachState.Attached): void;\n\n    /**\n     * Get pending local state in a serializable format to be given back to a newly loaded container\n     */\n    getPendingLocalState(): unknown;\n\n    /**\n     * Notify runtime that container is moving to \"Attaching\" state\n     * @param snapshot - snapshot created at attach time\n     */\n    notifyAttaching(snapshot: ISnapshotTreeWithBlobContents): void;\n}\n\n/**\n * Payload type for IContainerContext.submitBatchFn()\n */\nexport interface IBatchMessage {\n    contents?: string;\n    metadata: Record<string, unknown> | undefined;\n    compression?: string;\n}\n\n/**\n * The ContainerContext is a proxy standing between the Container and the Container's IRuntime.\n * This allows the Container to terminate the connection to the IRuntime.\n *\n * Specifically, there is an event on Container, onContextChanged, which mean a new code proposal has been loaded,\n * so the old IRuntime is no longer valid, as its ContainerContext has been revoked,\n * and the Container has created a new ContainerContext.\n */\nexport interface IContainerContext extends IDisposable {\n    /** @deprecated Please pass in existing directly in instantiateRuntime */\n    readonly existing: boolean | undefined;\n    readonly options: ILoaderOptions;\n    readonly clientId: string | undefined;\n    readonly clientDetails: IClientDetails;\n    readonly storage: IDocumentStorageService;\n    readonly connected: boolean;\n    readonly baseSnapshot: ISnapshotTree | undefined;\n    /** @deprecated Please use submitBatchFn & submitSummaryFn */\n    readonly submitFn: (type: MessageType, contents: any, batch: boolean, appData?: any) => number;\n    /** @returns clientSequenceNumber of last message in a batch */\n    readonly submitBatchFn: (batch: IBatchMessage[]) => number;\n    readonly submitSummaryFn: (summaryOp: ISummaryContent) => number;\n    readonly submitSignalFn: (contents: any) => void;\n    readonly closeFn: (error?: ICriticalContainerError) => void;\n    readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;\n    readonly quorum: IQuorumClients;\n    /**\n     * @deprecated This method is provided as a migration tool for customers currently reading the code details\n     * from within the Container by directly accessing the Quorum proposals.  The code details should not be accessed\n     * from within the Container as this requires coupling between the container contents and the code loader.\n     * Direct access to Quorum proposals will be removed in an upcoming release, and in a further future release this\n     * migration tool will be removed.\n     */\n    getSpecifiedCodeDetails?(): IFluidCodeDetails | undefined;\n    readonly audience: IAudience | undefined;\n    readonly loader: ILoader;\n    // The logger implementation, which would support tagged events, should be provided by the loader.\n    readonly taggedLogger: ITelemetryBaseLogger;\n    readonly serviceConfiguration: IClientConfiguration | undefined;\n    pendingLocalState?: unknown;\n\n    /**\n     * Ambient services provided with the context\n     */\n    readonly scope: FluidObject;\n\n    /**\n     * Get an absolute url for a provided container-relative request.\n     * @param relativeUrl - A relative request within the container\n     *\n     * TODO: Optional for backwards compatibility. Make non-optional in version 0.19\n     */\n    getAbsoluteUrl?(relativeUrl: string): Promise<string | undefined>;\n\n    /**\n     * Indicates the attachment state of the container to a host service.\n     */\n    readonly attachState: AttachState;\n\n    getLoadedFromVersion(): IVersion | undefined;\n\n    updateDirtyContainerState(dirty: boolean): void;\n    /**\n     * WARNING: this id is meant for telemetry usages ONLY, not recommended for other consumption\n     * This id is not supposed to be exposed anywhere else. It is dependant on usage or drivers\n     * and scenarios which can change in the future.\n     */\n    readonly id: string;\n}\n\nexport const IRuntimeFactory: keyof IProvideRuntimeFactory = \"IRuntimeFactory\";\n\nexport interface IProvideRuntimeFactory {\n    readonly IRuntimeFactory: IRuntimeFactory;\n}\n\n/**\n * Exported module definition\n *\n * Provides the entry point for the ContainerContext to load the proper IRuntime\n * to start up the running instance of the Container.\n */\nexport interface IRuntimeFactory extends IProvideRuntimeFactory {\n    /**\n     * Instantiates a new IRuntime for the given IContainerContext to proxy to\n     * This is the main entry point to the Container's business logic\n     *\n     * @param context - container context to be supplied to the runtime\n     * @param existing - whether to instantiate for the first time or from an existing context\n     */\n    instantiateRuntime(context: IContainerContext, existing?: boolean): Promise<IRuntime>;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-definitions",
-  "version": "2.0.0-internal.2.1.1",
+  "version": "2.0.0-internal.2.2.0",
   "description": "Fluid container definitions",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -32,33 +32,43 @@
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "lint": "npm run eslint",
     "lint:fix": "npm run eslint:fix",
+    "prettier": "prettier --check . --ignore-path ../../../.prettierignore",
+    "prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
     "tsc": "tsc",
     "tsc:watch": "tsc --watch",
-    "typetests:gen": "fluid-type-validator -g -d ."
+    "typetests:gen": "flub generate typetests --generate --dir .",
+    "typetests:prepare": "flub generate typetests --prepare --dir . --pin"
   },
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/core-interfaces": ">=2.0.0-internal.2.1.1 <2.0.0-internal.3.0.0",
-    "@fluidframework/driver-definitions": ">=2.0.0-internal.2.1.1 <2.0.0-internal.3.0.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-internal.2.2.0 <2.0.0-internal.3.0.0",
+    "@fluidframework/driver-definitions": ">=2.0.0-internal.2.2.0 <2.0.0-internal.3.0.0",
     "@fluidframework/protocol-definitions": "^1.1.0"
   },
   "devDependencies": {
-    "@fluid-tools/build-cli": "^0.5.0",
+    "@fluid-tools/build-cli": "^0.7.0",
     "@fluidframework/build-common": "^1.1.0",
-    "@fluidframework/build-tools": "^0.5.0",
-    "@fluidframework/container-definitions-previous": "npm:@fluidframework/container-definitions@2.0.0-internal.2.0.0",
-    "@fluidframework/eslint-config-fluid": "^1.1.0",
+    "@fluidframework/build-tools": "^0.7.0",
+    "@fluidframework/container-definitions-previous": "npm:@fluidframework/container-definitions@2.0.0-internal.2.1.0",
+    "@fluidframework/eslint-config-fluid": "^1.2.0",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/node": "^14.18.0",
     "concurrently": "^6.2.0",
     "copyfiles": "^2.4.1",
     "eslint": "~8.6.0",
+    "prettier": "~2.6.2",
     "rimraf": "^2.6.2",
     "typescript": "~4.5.5"
   },
   "typeValidation": {
-    "version": "2.0.0-internal.2.1.0",
-    "broken": {}
+    "version": "2.0.0-internal.2.2.0",
+    "baselineRange": ">=2.0.0-internal.2.1.0 <2.0.0-internal.2.2.0",
+    "baselineVersion": "2.0.0-internal.2.1.0",
+    "broken": {
+      "InterfaceDeclaration_IBatchMessage": {
+        "backCompat": false
+      }
+    }
   }
 }

package/prettier.config.cjs

@@ -0,0 +1,8 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+    ...require("@fluidframework/build-common/prettier.config.cjs"),
+};