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

package/.eslintrc.js

@@ -5,7 +5,8 @@
 
 module.exports = {
     "extends": [
-        require.resolve("@fluidframework/eslint-config-fluid")
+        require.resolve("@fluidframework/eslint-config-fluid"),
+        "prettier"
     ],
     "parserOptions": {
         "project": ["./tsconfig.json", "./src/test/types/tsconfig.json"]

package/dist/deltas.d.ts

@@ -5,7 +5,7 @@
 import { IDisposable, IEventProvider, IEvent, IErrorEvent } from "@fluidframework/common-definitions";
 import { ConnectionMode, IClientConfiguration, IClientDetails, IDocumentMessage, ISequencedDocumentMessage, ISignalClient, ISignalMessage, ITokenClaims } from "@fluidframework/protocol-definitions";
 /**
- * Contract representing the result of a newly established connection to the server for syncing deltas
+ * Contract representing the result of a newly established connection to the server for syncing deltas.
  */
 export interface IConnectionDetails {
     clientId: string;
@@ -16,8 +16,11 @@ export interface IConnectionDetails {
     initialClients: ISignalClient[];
     serviceConfiguration: IClientConfiguration;
     /**
-     * Last known sequence number to ordering service at the time of connection
-     * It may lap actual last sequence number (quite a bit, if container  is very active).
+     * Last known sequence number to ordering service at the time of connection.
+     *
+     * @remarks
+     *
+     * It may lap actual last sequence number (quite a bit, if container is very active).
      * But it's the best information for client to figure out how far it is behind, at least
      * for "read" connections. "write" connections may use own "join" op to similar information,
      * that is likely to be more up-to-date.
@@ -46,19 +49,76 @@ export interface IDeltaSender {
      */
     flush(): void;
 }
-/** Events emitted by the Delta Manager */
+/**
+ * Events emitted by {@link IDeltaManager}.
+ */
 export interface IDeltaManagerEvents extends IEvent {
+    /**
+     * @deprecated No replacement API recommended.
+     */
     (event: "prepareSend", listener: (messageBuffer: any[]) => void): any;
+    /**
+     * @deprecated No replacement API recommended.
+     */
     (event: "submitOp", listener: (message: IDocumentMessage) => 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 IDeltaManager}.
+     *
+     * Listener parameters:
+     *
+     * - `message`: The op that was processed.
+     *
+     * - `processingTime`: The amount of time it took to process the inbound operation (op), expressed in milliseconds.
+     */
     (event: "op", listener: (message: ISequencedDocumentMessage, processingTime: number) => void): any;
+    /**
+     * @deprecated No replacement API recommended.
+     */
     (event: "allSentOpsAckd", listener: () => void): any;
-    (event: "pong" | "processTime", listener: (latency: number) => void): any;
     /**
-     * The connect event fires once we've received the connect_document_success message from the
-     * server.  This happens prior to the client's join message (if there is a join message).
+     * @deprecated No replacement API recommended.
+     */
+    (event: "pong", listener: (latency: number) => void): any;
+    /**
+     * @deprecated No replacement API recommended.
+     */
+    (event: "processTime", listener: (latency: number) => void): any;
+    /**
+     * Emitted when the {@link IDeltaManager} completes connecting to the Fluid service.
+     *
+     * @remarks
+     * This occurs once we've received the connect_document_success message from the server,
+     * and happens prior to the client's join message (if there is a join message).
+     *
+     * Listener parameters:
+     *
+     * - `details`: Connection metadata.
+     *
+     * - `opsBehind`: An estimate of far behind the client is relative to the service in terms of ops.
+     * Will not be specified if an estimate cannot be determined.
      */
     (event: "connect", listener: (details: IConnectionDetails, opsBehind?: number) => void): any;
+    /**
+     * Emitted when the {@link IDeltaManager} becomes disconnected from the Fluid service.
+     *
+     * @remarks Listener parameters:
+     *
+     * - `reason`: Describes the reason for which the delta manager was disconnected.
+     */
     (event: "disconnect", listener: (reason: string) => void): any;
+    /**
+     * Emitted when read/write permissions change.
+     *
+     * @remarks Listener parameters:
+     *
+     * - `readonly`: Whether or not the delta manager is now read-only.
+     */
     (event: "readonly", listener: (readonly: boolean) => void): any;
 }
 /**
@@ -100,12 +160,42 @@ export interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>
     /** Submit a signal to the service to be broadcast to other connected clients, but not persisted */
     submitSignal(content: any): void;
 }
-/** Events emitted by a Delta Queue */
+/**
+ * Events emitted by {@link IDeltaQueue}.
+ */
 export interface IDeltaQueueEvents<T> extends IErrorEvent {
-    (event: "push" | "op", listener: (task: T) => void): any;
     /**
-     * @param count - number of events (T) processed before becoming idle
-     * @param duration - amount of time it took to process elements (milliseconds).
+     * Emitted when a task is enqueued.
+     *
+     * @remarks Listener parameters:
+     *
+     * - `task`: The task being enqueued.
+     */
+    (event: "push", listener: (task: T) => void): any;
+    /**
+     * Emitted immediately after processing an enqueued task and removing it from the queue.
+     *
+     * @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 IDeltaQueue}.
+     *
+     * Listener parameters:
+     *
+     * - `task`: The task that was processed.
+     */
+    (event: "op", listener: (task: T) => void): any;
+    /**
+     * Emitted when the queue of tasks to process is emptied.
+     *
+     * @remarks Listener parameters:
+     *
+     * - `count`: The number of events (`T`) processed before becoming idle.
+     *
+     * - `duration`: The amount of time it took to process elements (in milliseconds).
+     *
+     * @see {@link IDeltaQueue.idle}
      */
     (event: "idle", listener: (count: number, duration: number) => void): any;
 }
@@ -122,11 +212,13 @@ export interface IDeltaQueue<T> extends IEventProvider<IDeltaQueueEvents<T>>, ID
      */
     length: number;
     /**
-     * Flag indicating whether or not the queue is idle
+     * Flag indicating whether or not the queue is idle.
+     * I.e. there are no remaining messages to processes.
      */
     idle: boolean;
     /**
-     * Pauses processing on the queue
+     * Pauses processing on the queue.
+     *
      * @returns A promise which resolves when processing has been paused.
      */
     pause(): Promise<void>;

package/dist/deltas.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deltas.d.ts","sourceRoot":"","sources":["../src/deltas.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACtG,OAAO,EACH,cAAc,EACd,oBAAoB,EACpB,cAAc,EACd,gBAAgB,EAChB,yBAAyB,EACzB,aAAa,EACb,cAAc,EACd,YAAY,EACf,MAAM,sCAAsC,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,aAAa,EAAE,CAAC;IAChC,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C;;;;;;OAMG;IACH,wBAAwB,EAAE,MAAM,GAAG,SAAS,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,OAAO,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,CAAC;IAEtD;;OAEG;IACH,aAAa,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,CAAC;CACpD;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;CACjB;AAED,0CAA0C;AAC1C,MAAM,WAAW,mBAAoB,SAAQ,MAAM;IAC/C,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,aAAa,EAAE,GAAG,EAAE,KAAK,IAAI,OAAE;IACjE,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,OAAE;IACnE,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,yBAAyB,EAAE,cAAc,EAAE,MAAM,KAAK,IAAI,OAAE;IAC9F,CAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAChD,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,OAAE;IACrE;;;OAGG;IACH,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,kBAAkB,EAAE,SAAS,CAAC,EAAE,MAAM,KAAK,IAAI,OAAE;IACxF,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,OAAE;IAC1D,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,OAAE;CAC9D;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,EAAE,CAAC,CAAE,SAAQ,cAAc,CAAC,mBAAmB,CAAC,EAAE,YAAY,EAAE,WAAW;IACvG,0CAA0C;IAC1C,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAEjC,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC;IAEpC,yCAAyC;IACzC,QAAQ,CAAC,aAAa,EAAE,WAAW,CAAC,cAAc,CAAC,CAAC;IAEpD,0CAA0C;IAC1C,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IAEvC,8DAA8D;IAC9D,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IAEpC,sDAAsD;IACtD,QAAQ,CAAC,WAAW,EAAE,yBAAyB,GAAG,SAAS,CAAC;IAE5D,+DAA+D;IAC/D,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IAEpC,oEAAoE;IACpE,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IAEvC;;;OAGG;IACH,QAAQ,CAAC,2BAA2B,EAAE,OAAO,CAAC;IAE9C,wBAAwB;IACxB,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAC;IAEvC,kEAAkE;IAClE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB,oDAAoD;IACpD,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAEhC,qDAAqD;IACrD,QAAQ,CAAC,oBAAoB,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAEhE,4DAA4D;IAC5D,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IAEzB,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IAEpC,mGAAmG;IACnG,YAAY,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;CACpC;AAED,sCAAsC;AACtC,MAAM,WAAW,iBAAiB,CAAC,CAAC,CAAE,SAAQ,WAAW;IACrD,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,OAAE;IACpD;;;OAGG;IACH,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;CACxE;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,CAAE,SAAQ,cAAc,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,EAAE,WAAW;IACrF;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvB;;OAEG;IACH,MAAM,IAAI,IAAI,CAAC;IAEf;;OAEG;IACH,IAAI,IAAI,CAAC,GAAG,SAAS,CAAC;IAEtB;;OAEG;IACH,OAAO,IAAI,CAAC,EAAE,CAAC;IAEf;;;OAGG;IACH,sBAAsB,IAAI,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;KAAE,CAAC,CAAC;CAC3E;AAED,oBAAY,YAAY,GAAG;IACvB,QAAQ,CAAC,QAAQ,EAAE,KAAK,GAAG,SAAS,CAAC;CACxC,GAAG;IACA,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC;IACxB,mDAAmD;IACnD,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,4EAA4E;IAC5E,QAAQ,CAAC,WAAW,EAAE,OAAO,GAAG,SAAS,CAAC;IAC1C,gDAAgD;IAChD,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;CACjC,CAAC"}
+{"version":3,"file":"deltas.d.ts","sourceRoot":"","sources":["../src/deltas.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACtG,OAAO,EACH,cAAc,EACd,oBAAoB,EACpB,cAAc,EACd,gBAAgB,EAChB,yBAAyB,EACzB,aAAa,EACb,cAAc,EACd,YAAY,EACf,MAAM,sCAAsC,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,aAAa,EAAE,CAAC;IAChC,oBAAoB,EAAE,oBAAoB,CAAC;IAE3C;;;;;;;;;OASG;IACH,wBAAwB,EAAE,MAAM,GAAG,SAAS,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,OAAO,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,CAAC;IAEtD;;OAEG;IACH,aAAa,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,CAAC;CACpD;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;CACjB;AAED;;GAEG;AAEH,MAAM,WAAW,mBAAoB,SAAQ,MAAM;IAC/C;;OAEG;IACH,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,aAAa,EAAE,GAAG,EAAE,KAAK,IAAI,OAAE;IAEjE;;OAEG;IACH,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,OAAE;IAEnE;;;;;;;;;;;;;;OAcG;IACH,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,yBAAyB,EAAE,cAAc,EAAE,MAAM,KAAK,IAAI,OAAE;IAE9F;;OAEG;IACH,CAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAEhD;;OAEG;IACH,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,OAAE;IAErD;;OAEG;IACH,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,OAAE;IAE5D;;;;;;;;;;;;;OAaG;IACH,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,kBAAkB,EAAE,SAAS,CAAC,EAAE,MAAM,KAAK,IAAI,OAAE;IAExF;;;;;;OAMG;IACH,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,OAAE;IAE1D;;;;;;OAMG;IACH,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,OAAE;CAC9D;AAGD;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,EAAE,CAAC,CAAE,SAAQ,cAAc,CAAC,mBAAmB,CAAC,EAAE,YAAY,EAAE,WAAW;IACvG,0CAA0C;IAC1C,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAEjC,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC;IAEpC,yCAAyC;IACzC,QAAQ,CAAC,aAAa,EAAE,WAAW,CAAC,cAAc,CAAC,CAAC;IAEpD,0CAA0C;IAC1C,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IAEvC,8DAA8D;IAC9D,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IAEpC,sDAAsD;IACtD,QAAQ,CAAC,WAAW,EAAE,yBAAyB,GAAG,SAAS,CAAC;IAE5D,+DAA+D;IAC/D,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IAEpC,oEAAoE;IACpE,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IAEvC;;;OAGG;IACH,QAAQ,CAAC,2BAA2B,EAAE,OAAO,CAAC;IAE9C,wBAAwB;IACxB,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAC;IAEvC,kEAAkE;IAClE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB,oDAAoD;IACpD,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAEhC,qDAAqD;IACrD,QAAQ,CAAC,oBAAoB,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAEhE,4DAA4D;IAC5D,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IAEzB,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IAEpC,mGAAmG;IACnG,YAAY,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;CACpC;AAED;;GAEG;AAEH,MAAM,WAAW,iBAAiB,CAAC,CAAC,CAAE,SAAQ,WAAW;IACrD;;;;;;OAMG;IACH,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,OAAE;IAE7C;;;;;;;;;;;;OAYG;IACH,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,OAAE;IAE3C;;;;;;;;;;OAUG;IACH,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;CACxE;AAGD;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,CAAE,SAAQ,cAAc,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,EAAE,WAAW;IACrF;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvB;;OAEG;IACH,MAAM,IAAI,IAAI,CAAC;IAEf;;OAEG;IACH,IAAI,IAAI,CAAC,GAAG,SAAS,CAAC;IAEtB;;OAEG;IACH,OAAO,IAAI,CAAC,EAAE,CAAC;IAEf;;;OAGG;IACH,sBAAsB,IAAI,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;KAAE,CAAC,CAAC;CAC3E;AAED,oBAAY,YAAY,GAAG;IACvB,QAAQ,CAAC,QAAQ,EAAE,KAAK,GAAG,SAAS,CAAC;CACxC,GAAG;IACA,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC;IACxB,mDAAmD;IACnD,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,4EAA4E;IAC5E,QAAQ,CAAC,WAAW,EAAE,OAAO,GAAG,SAAS,CAAC;IAC1C,gDAAgD;IAChD,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;CACjC,CAAC"}

package/dist/deltas.js.map

@@ -1 +1 @@
-{"version":3,"file":"deltas.js","sourceRoot":"","sources":["../src/deltas.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDisposable, IEventProvider, IEvent, IErrorEvent } from \"@fluidframework/common-definitions\";\nimport {\n    ConnectionMode,\n    IClientConfiguration,\n    IClientDetails,\n    IDocumentMessage,\n    ISequencedDocumentMessage,\n    ISignalClient,\n    ISignalMessage,\n    ITokenClaims,\n} from \"@fluidframework/protocol-definitions\";\n\n/**\n * Contract representing the result of a newly established connection to the server for syncing deltas\n */\nexport interface IConnectionDetails {\n    clientId: string;\n    claims: ITokenClaims;\n    existing: boolean;\n    mode: ConnectionMode;\n    version: string;\n    initialClients: ISignalClient[];\n    serviceConfiguration: IClientConfiguration;\n    /**\n     * Last known sequence number to ordering service at the time of connection\n     * It may lap actual last sequence number (quite a bit, if container  is very active).\n     * But it's the best information for client to figure out how far it is behind, at least\n     * for \"read\" connections. \"write\" connections may use own \"join\" op to similar information,\n     * that is likely to be more up-to-date.\n     */\n    checkpointSequenceNumber: number | undefined;\n}\n\n/**\n * Interface used to define a strategy for handling incoming delta messages\n */\nexport interface IDeltaHandlerStrategy {\n    /**\n     * Processes the message.\n     */\n    process: (message: ISequencedDocumentMessage) => void;\n\n    /**\n     * Processes the signal.\n     */\n    processSignal: (message: ISignalMessage) => void;\n}\n\n/**\n * Contract supporting delivery of outbound messages to the server\n */\nexport interface IDeltaSender {\n    /**\n     * Flush all pending messages through the outbound queue\n     */\n    flush(): void;\n}\n\n/** Events emitted by the Delta Manager */\nexport interface IDeltaManagerEvents extends IEvent {\n    (event: \"prepareSend\", listener: (messageBuffer: any[]) => void);\n    (event: \"submitOp\", listener: (message: IDocumentMessage) => void);\n    (event: \"op\", listener: (message: ISequencedDocumentMessage, processingTime: number) => void);\n    (event: \"allSentOpsAckd\", listener: () => void);\n    (event: \"pong\" | \"processTime\", listener: (latency: number) => void);\n    /**\n     * The connect event fires once we've received the connect_document_success message from the\n     * server.  This happens prior to the client's join message (if there is a join message).\n     */\n    (event: \"connect\", listener: (details: IConnectionDetails, opsBehind?: number) => void);\n    (event: \"disconnect\", listener: (reason: string) => void);\n    (event: \"readonly\", listener: (readonly: boolean) => void);\n}\n\n/**\n * Manages the transmission of ops between the runtime and storage.\n */\nexport interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>, IDeltaSender, IDisposable {\n    /** The queue of inbound delta messages */\n    readonly inbound: IDeltaQueue<T>;\n\n    /** The queue of outbound delta messages */\n    readonly outbound: IDeltaQueue<U[]>;\n\n    /** The queue of inbound delta signals */\n    readonly inboundSignal: IDeltaQueue<ISignalMessage>;\n\n    /** The current minimum sequence number */\n    readonly minimumSequenceNumber: number;\n\n    /** The last sequence number processed by the delta manager */\n    readonly lastSequenceNumber: number;\n\n    /** The last message processed by the delta manager */\n    readonly lastMessage: ISequencedDocumentMessage | undefined;\n\n    /** The latest sequence number the delta manager is aware of */\n    readonly lastKnownSeqNumber: number;\n\n    /** The initial sequence number set when attaching the op handler */\n    readonly initialSequenceNumber: number;\n\n    /**\n     * Tells if current connection has checkpoint information.\n     * I.e. we know how far behind the client was at the time of establishing connection\n     */\n    readonly hasCheckpointSequenceNumber: boolean;\n\n    /** Details of client */\n    readonly clientDetails: IClientDetails;\n\n    /** Protocol version being used to communicate with the service */\n    readonly version: string;\n\n    /** Max message size allowed to the delta manager */\n    readonly maxMessageSize: number;\n\n    /** Service configuration provided by the service. */\n    readonly serviceConfiguration: IClientConfiguration | undefined;\n\n    /** Flag to indicate whether the client can write or not. */\n    readonly active: boolean;\n\n    readonly readOnlyInfo: ReadOnlyInfo;\n\n    /** Submit a signal to the service to be broadcast to other connected clients, but not persisted */\n    submitSignal(content: any): void;\n}\n\n/** Events emitted by a Delta Queue */\nexport interface IDeltaQueueEvents<T> extends IErrorEvent {\n    (event: \"push\" | \"op\", listener: (task: T) => void);\n    /**\n     * @param count - number of events (T) processed before becoming idle\n     * @param duration - amount of time it took to process elements (milliseconds).\n     */\n    (event: \"idle\", listener: (count: number, duration: number) => void);\n}\n\n/**\n * Queue of ops to be sent to or processed from storage\n */\nexport interface IDeltaQueue<T> extends IEventProvider<IDeltaQueueEvents<T>>, IDisposable {\n    /**\n     * Flag indicating whether or not the queue was paused\n     */\n    paused: boolean;\n\n    /**\n     * The number of messages remaining in the queue\n     */\n    length: number;\n\n    /**\n     * Flag indicating whether or not the queue is idle\n     */\n    idle: boolean;\n\n    /**\n     * Pauses processing on the queue\n     * @returns A promise which resolves when processing has been paused.\n     */\n    pause(): Promise<void>;\n\n    /**\n     * Resumes processing on the queue\n     */\n    resume(): void;\n\n    /**\n     * Peeks at the next message in the queue\n     */\n    peek(): T | undefined;\n\n    /**\n     * Returns all the items in the queue as an array. Does not remove them from the queue.\n     */\n    toArray(): T[];\n\n    /**\n     * returns number of ops processed and time it took to process these ops.\n     * Zeros if queue did not process anything (had no messages, was paused or had hit an error before)\n     */\n    waitTillProcessingDone(): Promise<{ count: number; duration: number; }>;\n}\n\nexport type ReadOnlyInfo = {\n    readonly readonly: false | undefined;\n} | {\n    readonly readonly: true;\n    /** read-only because forceReadOnly() was called */\n    readonly forced: boolean;\n    /** read-only because client does not have write permissions for document */\n    readonly permissions: boolean | undefined;\n    /** read-only with no delta stream connection */\n    readonly storageOnly: boolean;\n};\n"]}
+{"version":3,"file":"deltas.js","sourceRoot":"","sources":["../src/deltas.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDisposable, IEventProvider, IEvent, IErrorEvent } from \"@fluidframework/common-definitions\";\nimport {\n    ConnectionMode,\n    IClientConfiguration,\n    IClientDetails,\n    IDocumentMessage,\n    ISequencedDocumentMessage,\n    ISignalClient,\n    ISignalMessage,\n    ITokenClaims,\n} from \"@fluidframework/protocol-definitions\";\n\n/**\n * Contract representing the result of a newly established connection to the server for syncing deltas.\n */\nexport interface IConnectionDetails {\n    clientId: string;\n    claims: ITokenClaims;\n    existing: boolean;\n    mode: ConnectionMode;\n    version: string;\n    initialClients: ISignalClient[];\n    serviceConfiguration: IClientConfiguration;\n\n    /**\n     * Last known sequence number to ordering service at the time of connection.\n     *\n     * @remarks\n     *\n     * It may lap actual last sequence number (quite a bit, if container is very active).\n     * But it's the best information for client to figure out how far it is behind, at least\n     * for \"read\" connections. \"write\" connections may use own \"join\" op to similar information,\n     * that is likely to be more up-to-date.\n     */\n    checkpointSequenceNumber: number | undefined;\n}\n\n/**\n * Interface used to define a strategy for handling incoming delta messages\n */\nexport interface IDeltaHandlerStrategy {\n    /**\n     * Processes the message.\n     */\n    process: (message: ISequencedDocumentMessage) => void;\n\n    /**\n     * Processes the signal.\n     */\n    processSignal: (message: ISignalMessage) => void;\n}\n\n/**\n * Contract supporting delivery of outbound messages to the server\n */\nexport interface IDeltaSender {\n    /**\n     * Flush all pending messages through the outbound queue\n     */\n    flush(): void;\n}\n\n/**\n * Events emitted by {@link IDeltaManager}.\n */\n/* eslint-disable @typescript-eslint/unified-signatures */\nexport interface IDeltaManagerEvents extends IEvent {\n    /**\n     * @deprecated No replacement API recommended.\n     */\n    (event: \"prepareSend\", listener: (messageBuffer: any[]) => void);\n\n    /**\n     * @deprecated No replacement API recommended.\n     */\n    (event: \"submitOp\", listener: (message: IDocumentMessage) => 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 IDeltaManager}.\n     *\n     * Listener parameters:\n     *\n     * - `message`: The op that was processed.\n     *\n     * - `processingTime`: The amount of time it took to process the inbound operation (op), expressed in milliseconds.\n     */\n    (event: \"op\", listener: (message: ISequencedDocumentMessage, processingTime: number) => void);\n\n    /**\n     * @deprecated No replacement API recommended.\n     */\n    (event: \"allSentOpsAckd\", listener: () => void);\n\n    /**\n     * @deprecated No replacement API recommended.\n     */\n    (event: \"pong\", listener: (latency: number) => void);\n\n    /**\n     * @deprecated No replacement API recommended.\n     */\n    (event: \"processTime\", listener: (latency: number) => void);\n\n    /**\n     * Emitted when the {@link IDeltaManager} completes connecting to the Fluid service.\n     *\n     * @remarks\n     * This occurs once we've received the connect_document_success message from the server,\n     * and happens prior to the client's join message (if there is a join message).\n     *\n     * Listener parameters:\n     *\n     * - `details`: Connection metadata.\n     *\n     * - `opsBehind`: An estimate of far behind the client is relative to the service in terms of ops.\n     * Will not be specified if an estimate cannot be determined.\n     */\n    (event: \"connect\", listener: (details: IConnectionDetails, opsBehind?: number) => void);\n\n    /**\n     * Emitted when the {@link IDeltaManager} becomes disconnected from the Fluid service.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `reason`: Describes the reason for which the delta manager was disconnected.\n     */\n    (event: \"disconnect\", listener: (reason: string) => void);\n\n    /**\n     * Emitted when read/write permissions change.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `readonly`: Whether or not the delta manager is now read-only.\n     */\n    (event: \"readonly\", listener: (readonly: boolean) => void);\n}\n/* eslint-enable @typescript-eslint/unified-signatures */\n\n/**\n * Manages the transmission of ops between the runtime and storage.\n */\nexport interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>, IDeltaSender, IDisposable {\n    /** The queue of inbound delta messages */\n    readonly inbound: IDeltaQueue<T>;\n\n    /** The queue of outbound delta messages */\n    readonly outbound: IDeltaQueue<U[]>;\n\n    /** The queue of inbound delta signals */\n    readonly inboundSignal: IDeltaQueue<ISignalMessage>;\n\n    /** The current minimum sequence number */\n    readonly minimumSequenceNumber: number;\n\n    /** The last sequence number processed by the delta manager */\n    readonly lastSequenceNumber: number;\n\n    /** The last message processed by the delta manager */\n    readonly lastMessage: ISequencedDocumentMessage | undefined;\n\n    /** The latest sequence number the delta manager is aware of */\n    readonly lastKnownSeqNumber: number;\n\n    /** The initial sequence number set when attaching the op handler */\n    readonly initialSequenceNumber: number;\n\n    /**\n     * Tells if current connection has checkpoint information.\n     * I.e. we know how far behind the client was at the time of establishing connection\n     */\n    readonly hasCheckpointSequenceNumber: boolean;\n\n    /** Details of client */\n    readonly clientDetails: IClientDetails;\n\n    /** Protocol version being used to communicate with the service */\n    readonly version: string;\n\n    /** Max message size allowed to the delta manager */\n    readonly maxMessageSize: number;\n\n    /** Service configuration provided by the service. */\n    readonly serviceConfiguration: IClientConfiguration | undefined;\n\n    /** Flag to indicate whether the client can write or not. */\n    readonly active: boolean;\n\n    readonly readOnlyInfo: ReadOnlyInfo;\n\n    /** Submit a signal to the service to be broadcast to other connected clients, but not persisted */\n    submitSignal(content: any): void;\n}\n\n/**\n * Events emitted by {@link IDeltaQueue}.\n */\n/* eslint-disable @typescript-eslint/unified-signatures */\nexport interface IDeltaQueueEvents<T> extends IErrorEvent {\n    /**\n     * Emitted when a task is enqueued.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `task`: The task being enqueued.\n     */\n    (event: \"push\", listener: (task: T) => void);\n\n    /**\n     * Emitted immediately after processing an enqueued task and removing it from the queue.\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 IDeltaQueue}.\n     *\n     * Listener parameters:\n     *\n     * - `task`: The task that was processed.\n     */\n    (event: \"op\", listener: (task: T) => void);\n\n    /**\n     * Emitted when the queue of tasks to process is emptied.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `count`: The number of events (`T`) processed before becoming idle.\n     *\n     * - `duration`: The amount of time it took to process elements (in milliseconds).\n     *\n     * @see {@link IDeltaQueue.idle}\n     */\n    (event: \"idle\", listener: (count: number, duration: number) => void);\n}\n/* eslint-enable @typescript-eslint/unified-signatures */\n\n/**\n * Queue of ops to be sent to or processed from storage\n */\nexport interface IDeltaQueue<T> extends IEventProvider<IDeltaQueueEvents<T>>, IDisposable {\n    /**\n     * Flag indicating whether or not the queue was paused\n     */\n    paused: boolean;\n\n    /**\n     * The number of messages remaining in the queue\n     */\n    length: number;\n\n    /**\n     * Flag indicating whether or not the queue is idle.\n     * I.e. there are no remaining messages to processes.\n     */\n    idle: boolean;\n\n    /**\n     * Pauses processing on the queue.\n     *\n     * @returns A promise which resolves when processing has been paused.\n     */\n    pause(): Promise<void>;\n\n    /**\n     * Resumes processing on the queue\n     */\n    resume(): void;\n\n    /**\n     * Peeks at the next message in the queue\n     */\n    peek(): T | undefined;\n\n    /**\n     * Returns all the items in the queue as an array. Does not remove them from the queue.\n     */\n    toArray(): T[];\n\n    /**\n     * returns number of ops processed and time it took to process these ops.\n     * Zeros if queue did not process anything (had no messages, was paused or had hit an error before)\n     */\n    waitTillProcessingDone(): Promise<{ count: number; duration: number; }>;\n}\n\nexport type ReadOnlyInfo = {\n    readonly readonly: false | undefined;\n} | {\n    readonly readonly: true;\n    /** read-only because forceReadOnly() was called */\n    readonly forced: boolean;\n    /** read-only because client does not have write permissions for document */\n    readonly permissions: boolean | undefined;\n    /** read-only with no delta stream connection */\n    readonly storageOnly: boolean;\n};\n"]}

package/dist/error.d.ts

@@ -66,7 +66,8 @@ export interface IErrorBase extends Partial<Error> {
 export interface ContainerWarning extends IErrorBase {
     /**
      * Whether this error has already been logged. Used to avoid logging errors twice.
-     * Default is false.
+     *
+     * @defaultValue `false`
      */
     logged?: boolean;
 }

package/dist/error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAE1E;;GAEG;AACH,oBAAY,kBAAkB;IAC1B;;OAEG;IACH,YAAY,iBAAiB;IAE7B;;OAEG;IACH,eAAe,oBAAoB;IAEnC;;OAEG;IACH,mBAAmB,wBAAwB;IAE3C;;OAEG;IACH,mBAAmB,wBAAwB;IAE3C;;OAEG;IACH,UAAU,eAAe;IAEzB;;;OAGG;IACH,yBAAyB,8BAA8B;CAC1D;AAED;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,OAAO,CAAC,KAAK,CAAC;IAC9C;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,qBAAqB;IACrB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,sBAAsB;IACtB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,sBAAsB,CAAC,IAAI,oBAAoB,CAAC;CACnD;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAChD;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,oBAAY,uBAAuB,GAAG,UAAU,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,UAAU;IAC7C,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC,YAAY,CAAC;IACpD,KAAK,CAAC,EAAE,GAAG,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC3C,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC,UAAU,CAAC;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IAClD,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC,eAAe,CAAC;IACvD,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;CACtC"}
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAE1E;;GAEG;AACH,oBAAY,kBAAkB;IAC1B;;OAEG;IACH,YAAY,iBAAiB;IAE7B;;OAEG;IACH,eAAe,oBAAoB;IAEnC;;OAEG;IACH,mBAAmB,wBAAwB;IAE3C;;OAEG;IACH,mBAAmB,wBAAwB;IAE3C;;OAEG;IACH,UAAU,eAAe;IAEzB;;;OAGG;IACH,yBAAyB,8BAA8B;CAC1D;AAED;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,OAAO,CAAC,KAAK,CAAC;IAC9C;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,qBAAqB;IACrB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,sBAAsB;IACtB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,sBAAsB,CAAC,IAAI,oBAAoB,CAAC;CACnD;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAChD;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,oBAAY,uBAAuB,GAAG,UAAU,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,UAAU;IAC7C,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC,YAAY,CAAC;IACpD,KAAK,CAAC,EAAE,GAAG,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC3C,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC,UAAU,CAAC;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IAClD,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC,eAAe,CAAC;IACvD,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;CACtC"}

package/dist/error.js.map

@@ -1 +1 @@
-{"version":3,"file":"error.js","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;GAEG;AACH,IAAY,kBA+BX;AA/BD,WAAY,kBAAkB;IAC1B;;OAEG;IACH,mDAA6B,CAAA;IAE7B;;OAEG;IACH,yDAAmC,CAAA;IAEnC;;OAEG;IACH,iEAA2C,CAAA;IAE3C;;OAEG;IACH,iEAA2C,CAAA;IAE3C;;OAEG;IACH,+CAAyB,CAAA;IAEzB;;;OAGG;IACH,6EAAuD,CAAA;AAC3D,CAAC,EA/BW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QA+B7B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryProperties } from \"@fluidframework/common-definitions\";\n\n/**\n * Different error types the Container may report out to the Host\n */\nexport enum ContainerErrorType {\n    /**\n     * Some error, most likely an exception caught by runtime and propagated to container as critical error\n     */\n    genericError = \"genericError\",\n\n    /**\n     * Throttling error from server. Server is busy and is asking not to reconnect for some time\n     */\n    throttlingError = \"throttlingError\",\n\n    /**\n     * Data loss error detected by Container / DeltaManager. Likely points to storage issue.\n     */\n    dataCorruptionError = \"dataCorruptionError\",\n\n    /**\n     * Error encountered when processing an operation. May correlate with data corruption.\n     */\n    dataProcessingError = \"dataProcessingError\",\n\n    /**\n     * Error indicating an API is being used improperly resulting in an invalid operation.\n     */\n    usageError = \"usageError\",\n\n    /**\n     * Error indicating an client session has expired. Currently this only happens when GC is allowed on a document and\n     * aids in safely deleting unused objects.\n     */\n    clientSessionExpiredError = \"clientSessionExpiredError\",\n}\n\n/**\n * Base interface for all errors and warnings at container level\n */\nexport interface IErrorBase extends Partial<Error> {\n    /** errorType is a union of error types from\n     * - container\n     * - runtime\n     * - drivers\n     */\n    readonly errorType: string;\n\n    /**\n     * See Error.message\n     * Privacy Note - This is a freeform string that we may not control in all cases (e.g. a dependency throws an error)\n     * If there are known cases where this contains privacy-sensitive data it will be tagged and included in the result\n     * of getTelemetryProperties. When logging, consider fetching it that way rather than straight from this field.\n     */\n    readonly message: string;\n    /** See Error.name */\n    readonly name?: string;\n    /** See Error.stack */\n    readonly stack?: string;\n    /**\n     * Returns all properties of this error object that are either safe to log\n     * or explicitly tagged as containing privacy-sensitive data.\n     */\n    getTelemetryProperties?(): ITelemetryProperties;\n}\n\n/**\n * Represents warnings raised on container.\n */\nexport interface ContainerWarning extends IErrorBase {\n    /**\n     * Whether this error has already been logged. Used to avoid logging errors twice.\n     * Default is false.\n     */\n    logged?: boolean;\n}\n\n/**\n * Represents errors raised on container.\n */\nexport type ICriticalContainerError = IErrorBase;\n\n/**\n * Generic wrapper for an unrecognized/uncategorized error object\n */\nexport interface IGenericError extends IErrorBase {\n    readonly errorType: ContainerErrorType.genericError;\n    error?: any;\n}\n\n/**\n * Error indicating an API is being used improperly resulting in an invalid operation.\n */\nexport interface IUsageError extends IErrorBase {\n    readonly errorType: ContainerErrorType.usageError;\n}\n\n/**\n * Warning emitted when requests to storage are being throttled\n */\nexport interface IThrottlingWarning extends IErrorBase {\n    readonly errorType: ContainerErrorType.throttlingError;\n    readonly retryAfterSeconds: number;\n}\n"]}
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;GAEG;AACH,IAAY,kBA+BX;AA/BD,WAAY,kBAAkB;IAC1B;;OAEG;IACH,mDAA6B,CAAA;IAE7B;;OAEG;IACH,yDAAmC,CAAA;IAEnC;;OAEG;IACH,iEAA2C,CAAA;IAE3C;;OAEG;IACH,iEAA2C,CAAA;IAE3C;;OAEG;IACH,+CAAyB,CAAA;IAEzB;;;OAGG;IACH,6EAAuD,CAAA;AAC3D,CAAC,EA/BW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QA+B7B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryProperties } from \"@fluidframework/common-definitions\";\n\n/**\n * Different error types the Container may report out to the Host\n */\nexport enum ContainerErrorType {\n    /**\n     * Some error, most likely an exception caught by runtime and propagated to container as critical error\n     */\n    genericError = \"genericError\",\n\n    /**\n     * Throttling error from server. Server is busy and is asking not to reconnect for some time\n     */\n    throttlingError = \"throttlingError\",\n\n    /**\n     * Data loss error detected by Container / DeltaManager. Likely points to storage issue.\n     */\n    dataCorruptionError = \"dataCorruptionError\",\n\n    /**\n     * Error encountered when processing an operation. May correlate with data corruption.\n     */\n    dataProcessingError = \"dataProcessingError\",\n\n    /**\n     * Error indicating an API is being used improperly resulting in an invalid operation.\n     */\n    usageError = \"usageError\",\n\n    /**\n     * Error indicating an client session has expired. Currently this only happens when GC is allowed on a document and\n     * aids in safely deleting unused objects.\n     */\n    clientSessionExpiredError = \"clientSessionExpiredError\",\n}\n\n/**\n * Base interface for all errors and warnings at container level\n */\nexport interface IErrorBase extends Partial<Error> {\n    /** errorType is a union of error types from\n     * - container\n     * - runtime\n     * - drivers\n     */\n    readonly errorType: string;\n\n    /**\n     * See Error.message\n     * Privacy Note - This is a freeform string that we may not control in all cases (e.g. a dependency throws an error)\n     * If there are known cases where this contains privacy-sensitive data it will be tagged and included in the result\n     * of getTelemetryProperties. When logging, consider fetching it that way rather than straight from this field.\n     */\n    readonly message: string;\n    /** See Error.name */\n    readonly name?: string;\n    /** See Error.stack */\n    readonly stack?: string;\n    /**\n     * Returns all properties of this error object that are either safe to log\n     * or explicitly tagged as containing privacy-sensitive data.\n     */\n    getTelemetryProperties?(): ITelemetryProperties;\n}\n\n/**\n * Represents warnings raised on container.\n */\nexport interface ContainerWarning extends IErrorBase {\n    /**\n     * Whether this error has already been logged. Used to avoid logging errors twice.\n     *\n     * @defaultValue `false`\n     */\n    logged?: boolean;\n}\n\n/**\n * Represents errors raised on container.\n */\nexport type ICriticalContainerError = IErrorBase;\n\n/**\n * Generic wrapper for an unrecognized/uncategorized error object\n */\nexport interface IGenericError extends IErrorBase {\n    readonly errorType: ContainerErrorType.genericError;\n    error?: any;\n}\n\n/**\n * Error indicating an API is being used improperly resulting in an invalid operation.\n */\nexport interface IUsageError extends IErrorBase {\n    readonly errorType: ContainerErrorType.usageError;\n}\n\n/**\n * Warning emitted when requests to storage are being throttled\n */\nexport interface IThrottlingWarning extends IErrorBase {\n    readonly errorType: ContainerErrorType.throttlingError;\n    readonly retryAfterSeconds: number;\n}\n"]}

package/dist/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: {