npm - @fluidframework/container-definitions - Versions diffs - 2.0.0-internal.5.1.0 → 2.0.0-internal.5.2.0 - Mend

@fluidframework/container-definitions 2.0.0-internal.5.1.0 → 2.0.0-internal.5.2.0

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

Files changed (16) hide show

package/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,25 @@
 # @fluidframework/container-definitions
+## 2.0.0-internal.5.2.0
+### Minor Changes
+-   IContainerContext members deprecated ([#16180](https://github.com/microsoft/FluidFramework/issues/16180)) [bf6a26cfe6](https://github.com/microsoft/FluidFramework/commits/bf6a26cfe6ac58386f2c9af260603a15b03ba84f)
+    IContainerContext members disposed, dispose(), serviceConfiguration, and id have been deprecated and will be removed in an upcoming release.
+    disposed - The disposed state on the IContainerContext is not meaningful to the runtime.
+    dispose() - The runtime is not permitted to dispose the IContainerContext, this results in an inconsistent system state.
+    serviceConfiguration - This property is redundant, and is unused by the runtime. The same information can be found via `deltaManager.serviceConfiguration` on this object if it is necessary.
+    id - The docId is already logged by the IContainerContext.taggedLogger for telemetry purposes, so this is generally unnecessary for telemetry. If the id is needed for other purposes it should be passed to the consumer explicitly.
+-   IConnectionDetailsInternal and IDeltaHandlerStrategy deprecated ([#16081](https://github.com/microsoft/FluidFramework/issues/16081)) [279dcd5563](https://github.com/microsoft/FluidFramework/commits/279dcd55635b650494cf2347f21cf0e2b979413a)
+    The IConnectionDetailsInternal and IDeltaHandlerStrategy interfaces from the @fluidframework/container-definitions package have been deprecated and will be removed in a future release. These are internal-only interfaces and should not be used.
 ## 2.0.0-internal.5.1.0
 Dependency updates only.

package/dist/deltas.d.ts CHANGED Viewed

@@ -2,7 +2,8 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { IDisposable, IEventProvider, IEvent, IErrorEvent } from "@fluidframework/common-definitions";
+import { IEventProvider, IEvent, IErrorEvent } from "@fluidframework/common-definitions";
+import { IDisposable } from "@fluidframework/core-interfaces";
 import { IAnyDriverError } from "@fluidframework/driver-definitions";
 import { ConnectionMode, IClientConfiguration, IClientDetails, IDocumentMessage, ISequencedDocumentMessage, ISignalClient, ISignalMessage, ITokenClaims } from "@fluidframework/protocol-definitions";
 /**
@@ -26,23 +27,39 @@ export interface IConnectionDetails {
 }
 /**
  * Internal version of IConnectionDetails with props are only exposed internally
+ * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.
  */
 export interface IConnectionDetailsInternal extends IConnectionDetails {
+    /**
+     * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.
+     */
     mode: ConnectionMode;
+    /**
+     * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.
+     */
     version: string;
+    /**
+     * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.
+     */
     initialClients: ISignalClient[];
+    /**
+     * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.
+     */
     reason: string;
 }
 /**
  * Interface used to define a strategy for handling incoming delta messages
+ * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.
  */
 export interface IDeltaHandlerStrategy {
     /**
      * Processes the message.
+     * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.
      */
     process: (message: ISequencedDocumentMessage) => void;
     /**
      * Processes the signal.
+     * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.
      */
     processSignal: (message: ISignalMessage) => void;
 }

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

	@@ -1 +1 @@
1	- {"version":3,"file":"deltas.d.ts","sourceRoot":"","sources":["../src/deltas.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,~~EACN~~,~~WAAW,EACX,~~cAAc,~~EACd~~,MAAM,~~EACN~~,WAAW,~~EACX~~,MAAM,oCAAoC,CAAC;~~AAC5C~~,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AACrE,OAAO,EACN,cAAc,EACd,oBAAoB,EACpB,cAAc,EACd,gBAAgB,EAChB,yBAAyB,EACzB,aAAa,EACb,cAAc,EACd,YAAY,EACZ,MAAM,sCAAsC,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;IACrB,oBAAoB,EAAE,oBAAoB,CAAC;IAE3C;;;;;;;;;OASG;IACH,wBAAwB,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7C;AAED~~;;GAEG~~;AACH,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB;IACrE,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,aAAa,EAAE,CAAC;IAChC,MAAM,EAAE,MAAM,CAAC;CACf;AAED~~;;GAEG~~;AACH,MAAM,WAAW,qBAAqB;IACrC~~;;OAEG~~;IACH,OAAO,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,CAAC;IAEtD~~;;OAEG~~;IACH,aAAa,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,CAAC;CACjD;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,MAAM;IAClD;;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;;;;;;;OAOG;IACH,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,eAAe,KAAK,IAAI,OAAE;IAEnF;;;;;;OAMG;IACH,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,OAAE;CAC3D;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,EAAE,CAAC,CAClC,SAAQ,cAAc,CAAC,mBAAmB,CAAC,EAC1C,YAAY,EACZ,WAAW;IACZ,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;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAAC,CAAC,CAAE,SAAQ,WAAW;IACxD;;;;;;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;CACrE;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,CAAE,SAAQ,cAAc,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,EAAE,WAAW;IACxF;;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,CAAA;KAAE,CAAC,CAAC;CACvE;AAED,oBAAY,YAAY,GACrB;IACA,QAAQ,CAAC,QAAQ,EAAE,KAAK,GAAG,SAAS,CAAC;CACpC,GACD;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;IAC9B;uCACmC;IACnC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CACnC,CAAC"}
1	+ {"version":3,"file":"deltas.d.ts","sourceRoot":"","sources":["../src/deltas.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACzF,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AACrE,OAAO,EACN,cAAc,EACd,oBAAoB,EACpB,cAAc,EACd,gBAAgB,EAChB,yBAAyB,EACzB,aAAa,EACb,cAAc,EACd,YAAY,EACZ,MAAM,sCAAsC,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;IACrB,oBAAoB,EAAE,oBAAoB,CAAC;IAE3C;;;;;;;;;OASG;IACH,wBAAwB,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7C;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB;IACrE;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IACrB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,cAAc,EAAE,aAAa,EAAE,CAAC;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACrC;;;OAGG;IACH,OAAO,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,CAAC;IAEtD;;;OAGG;IACH,aAAa,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,CAAC;CACjD;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,MAAM;IAClD;;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;;;;;;;OAOG;IACH,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,eAAe,KAAK,IAAI,OAAE;IAEnF;;;;;;OAMG;IACH,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,OAAE;CAC3D;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,EAAE,CAAC,CAClC,SAAQ,cAAc,CAAC,mBAAmB,CAAC,EAC1C,YAAY,EACZ,WAAW;IACZ,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;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAAC,CAAC,CAAE,SAAQ,WAAW;IACxD;;;;;;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;CACrE;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,CAAE,SAAQ,cAAc,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,EAAE,WAAW;IACxF;;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,CAAA;KAAE,CAAC,CAAC;CACvE;AAED,oBAAY,YAAY,GACrB;IACA,QAAQ,CAAC,QAAQ,EAAE,KAAK,GAAG,SAAS,CAAC;CACpC,GACD;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;IAC9B;uCACmC;IACnC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CACnC,CAAC"}

package/dist/deltas.js.map CHANGED Viewed

	@@ -1 +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 {\n\tIDisposable,\n\tIEventProvider,\n\tIEvent,\n\tIErrorEvent,\n} from \"@fluidframework/common-definitions\";\nimport { IAnyDriverError } from \"@fluidframework/driver-definitions\";\nimport {\n\tConnectionMode,\n\tIClientConfiguration,\n\tIClientDetails,\n\tIDocumentMessage,\n\tISequencedDocumentMessage,\n\tISignalClient,\n\tISignalMessage,\n\tITokenClaims,\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\tclientId: string;\n\tclaims: ITokenClaims;\n\tserviceConfiguration: IClientConfiguration;\n\n\t/\n\t Last known sequence number to ordering service at the time of connection.\n\t \n\t @remarks\n\t \n\t It may lap actual last sequence number (quite a bit, if container is very active).\n\t * But it's the best information for client to figure out how far it is behind, at least\n\t * for \"read\" connections. \"write\" connections may use own \"join\" op to similar information,\n\t * that is likely to be more up-to-date.\n\t /\n\tcheckpointSequenceNumber: number \| undefined;\n}\n\n/\n Internal version of IConnectionDetails with props are only exposed internally\n /\nexport interface IConnectionDetailsInternal extends IConnectionDetails {\n\tmode: ConnectionMode;\n\tversion: string;\n\tinitialClients: ISignalClient[];\n\treason: string;\n}\n\n/\n Interface used to define a strategy for handling incoming delta messages\n /\nexport interface IDeltaHandlerStrategy {\n\t/\n\t Processes the message.\n\t /\n\tprocess: (message: ISequencedDocumentMessage) => void;\n\n\t/\n\t Processes the signal.\n\t /\n\tprocessSignal: (message: ISignalMessage) => void;\n}\n\n/\n Contract supporting delivery of outbound messages to the server\n /\nexport interface IDeltaSender {\n\t/\n\t Flush all pending messages through the outbound queue\n\t /\n\tflush(): void;\n}\n\n/\n Events emitted by {@link IDeltaManager}.\n /\nexport interface IDeltaManagerEvents extends IEvent {\n\t/\n\t @deprecated No replacement API recommended.\n\t /\n\t(event: \"prepareSend\", listener: (messageBuffer: any[]) => void);\n\n\t/\n\t @deprecated No replacement API recommended.\n\t /\n\t(event: \"submitOp\", listener: (message: IDocumentMessage) => void);\n\n\t/\n\t Emitted immediately after processing an incoming operation (op).\n\t \n\t @remarks\n\t \n\t Note: this event is not intended for general use.\n\t * Prefer to listen to events on the appropriate ultimate recipients of the ops, rather than listening to the\n\t * ops directly on the {@link IDeltaManager}.\n\t \n\t Listener parameters:\n\t \n\t - `message`: The op that was processed.\n\t \n\t - `processingTime`: The amount of time it took to process the inbound operation (op), expressed in milliseconds.\n\t /\n\t(event: \"op\", listener: (message: ISequencedDocumentMessage, processingTime: number) => void);\n\n\t/\n\t @deprecated No replacement API recommended.\n\t /\n\t(event: \"allSentOpsAckd\", listener: () => void);\n\n\t/\n\t @deprecated No replacement API recommended.\n\t /\n\t(event: \"pong\", listener: (latency: number) => void);\n\n\t/\n\t @deprecated No replacement API recommended.\n\t /\n\t(event: \"processTime\", listener: (latency: number) => void);\n\n\t/\n\t Emitted when the {@link IDeltaManager} completes connecting to the Fluid service.\n\t \n\t @remarks\n\t * This occurs once we've received the connect_document_success message from the server,\n\t * and happens prior to the client's join message (if there is a join message).\n\t \n\t Listener parameters:\n\t \n\t - `details`: Connection metadata.\n\t \n\t - `opsBehind`: An estimate of far behind the client is relative to the service in terms of ops.\n\t * Will not be specified if an estimate cannot be determined.\n\t /\n\t(event: \"connect\", listener: (details: IConnectionDetails, opsBehind?: number) => void);\n\n\t/\n\t Emitted when the {@link IDeltaManager} becomes disconnected from the Fluid service.\n\t \n\t @remarks Listener parameters:\n\t \n\t - `reason`: Describes the reason for which the delta manager was disconnected.\n\t * - `error` : error if any for the disconnect.\n\t /\n\t(event: \"disconnect\", listener: (reason: string, error?: IAnyDriverError) => void);\n\n\t/\n\t Emitted when read/write permissions change.\n\t \n\t @remarks Listener parameters:\n\t \n\t - `readonly`: Whether or not the delta manager is now read-only.\n\t /\n\t(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>\n\textends IEventProvider<IDeltaManagerEvents>,\n\t\tIDeltaSender,\n\t\tIDisposable {\n\t/* The queue of inbound delta messages /\n\treadonly inbound: IDeltaQueue<T>;\n\n\t/* The queue of outbound delta messages /\n\treadonly outbound: IDeltaQueue<U[]>;\n\n\t/* The queue of inbound delta signals /\n\treadonly inboundSignal: IDeltaQueue<ISignalMessage>;\n\n\t/* The current minimum sequence number /\n\treadonly minimumSequenceNumber: number;\n\n\t/* The last sequence number processed by the delta manager /\n\treadonly lastSequenceNumber: number;\n\n\t/* The last message processed by the delta manager /\n\treadonly lastMessage: ISequencedDocumentMessage \| undefined;\n\n\t/* The latest sequence number the delta manager is aware of /\n\treadonly lastKnownSeqNumber: number;\n\n\t/* The initial sequence number set when attaching the op handler /\n\treadonly initialSequenceNumber: number;\n\n\t/\n\t Tells if current connection has checkpoint information.\n\t * I.e. we know how far behind the client was at the time of establishing connection\n\t /\n\treadonly hasCheckpointSequenceNumber: boolean;\n\n\t/* Details of client /\n\treadonly clientDetails: IClientDetails;\n\n\t/* Protocol version being used to communicate with the service /\n\treadonly version: string;\n\n\t/* Max message size allowed to the delta manager /\n\treadonly maxMessageSize: number;\n\n\t/* Service configuration provided by the service. /\n\treadonly serviceConfiguration: IClientConfiguration \| undefined;\n\n\t/* Flag to indicate whether the client can write or not. /\n\treadonly active: boolean;\n\n\treadonly readOnlyInfo: ReadOnlyInfo;\n\n\t/* Submit a signal to the service to be broadcast to other connected clients, but not persisted /\n\tsubmitSignal(content: any): void;\n}\n\n/\n Events emitted by {@link IDeltaQueue}.\n /\nexport interface IDeltaQueueEvents<T> extends IErrorEvent {\n\t/\n\t Emitted when a task is enqueued.\n\t \n\t @remarks Listener parameters:\n\t \n\t - `task`: The task being enqueued.\n\t /\n\t(event: \"push\", listener: (task: T) => void);\n\n\t/\n\t Emitted immediately after processing an enqueued task and removing it from the queue.\n\t \n\t @remarks\n\t \n\t Note: this event is not intended for general use.\n\t * Prefer to listen to events on the appropriate ultimate recipients of the ops, rather than listening to the\n\t * ops directly on the {@link IDeltaQueue}.\n\t \n\t Listener parameters:\n\t \n\t - `task`: The task that was processed.\n\t /\n\t(event: \"op\", listener: (task: T) => void);\n\n\t/\n\t Emitted when the queue of tasks to process is emptied.\n\t \n\t @remarks Listener parameters:\n\t \n\t - `count`: The number of events (`T`) processed before becoming idle.\n\t \n\t - `duration`: The amount of time it took to process elements (in milliseconds).\n\t \n\t @see {@link IDeltaQueue.idle}\n\t /\n\t(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\t/\n\t Flag indicating whether or not the queue was paused\n\t /\n\tpaused: boolean;\n\n\t/\n\t The number of messages remaining in the queue\n\t /\n\tlength: number;\n\n\t/\n\t Flag indicating whether or not the queue is idle.\n\t * I.e. there are no remaining messages to processes.\n\t /\n\tidle: boolean;\n\n\t/\n\t Pauses processing on the queue.\n\t \n\t @returns A promise which resolves when processing has been paused.\n\t /\n\tpause(): Promise<void>;\n\n\t/\n\t Resumes processing on the queue\n\t /\n\tresume(): void;\n\n\t/\n\t Peeks at the next message in the queue\n\t /\n\tpeek(): T \| undefined;\n\n\t/\n\t Returns all the items in the queue as an array. Does not remove them from the queue.\n\t /\n\ttoArray(): T[];\n\n\t/\n\t returns number of ops processed and time it took to process these ops.\n\t * Zeros if queue did not process anything (had no messages, was paused or had hit an error before)\n\t /\n\twaitTillProcessingDone(): Promise<{ count: number; duration: number }>;\n}\n\nexport type ReadOnlyInfo =\n\t\| {\n\t\t\treadonly readonly: false \| undefined;\n\t }\n\t\| {\n\t\t\treadonly readonly: true;\n\t\t\t/* read-only because forceReadOnly() was called /\n\t\t\treadonly forced: boolean;\n\t\t\t/* read-only because client does not have write permissions for document /\n\t\t\treadonly permissions: boolean \| undefined;\n\t\t\t/* read-only with no delta stream connection /\n\t\t\treadonly storageOnly: boolean;\n\t\t\t/* extra info on why connection to delta stream is not possible. This info might be provided\n\t\t\t * if storageOnly is set to true */\n\t\t\treadonly storageOnlyReason?: string;\n\t };\n"]}
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 { IEventProvider, IEvent, IErrorEvent } from \"@fluidframework/common-definitions\";\nimport { IDisposable } from \"@fluidframework/core-interfaces\";\nimport { IAnyDriverError } from \"@fluidframework/driver-definitions\";\nimport {\n\tConnectionMode,\n\tIClientConfiguration,\n\tIClientDetails,\n\tIDocumentMessage,\n\tISequencedDocumentMessage,\n\tISignalClient,\n\tISignalMessage,\n\tITokenClaims,\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\tclientId: string;\n\tclaims: ITokenClaims;\n\tserviceConfiguration: IClientConfiguration;\n\n\t/\n\t Last known sequence number to ordering service at the time of connection.\n\t \n\t @remarks\n\t \n\t It may lap actual last sequence number (quite a bit, if container is very active).\n\t * But it's the best information for client to figure out how far it is behind, at least\n\t * for \"read\" connections. \"write\" connections may use own \"join\" op to similar information,\n\t * that is likely to be more up-to-date.\n\t /\n\tcheckpointSequenceNumber: number \| undefined;\n}\n\n/\n Internal version of IConnectionDetails with props are only exposed internally\n * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.\n /\nexport interface IConnectionDetailsInternal extends IConnectionDetails {\n\t/\n\t @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.\n\t /\n\tmode: ConnectionMode;\n\t/\n\t @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.\n\t /\n\tversion: string;\n\t/\n\t @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.\n\t /\n\tinitialClients: ISignalClient[];\n\t/\n\t @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.\n\t /\n\treason: string;\n}\n\n/\n Interface used to define a strategy for handling incoming delta messages\n * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.\n /\nexport interface IDeltaHandlerStrategy {\n\t/\n\t Processes the message.\n\t * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.\n\t /\n\tprocess: (message: ISequencedDocumentMessage) => void;\n\n\t/\n\t Processes the signal.\n\t * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.\n\t /\n\tprocessSignal: (message: ISignalMessage) => void;\n}\n\n/\n Contract supporting delivery of outbound messages to the server\n /\nexport interface IDeltaSender {\n\t/\n\t Flush all pending messages through the outbound queue\n\t /\n\tflush(): void;\n}\n\n/\n Events emitted by {@link IDeltaManager}.\n /\nexport interface IDeltaManagerEvents extends IEvent {\n\t/\n\t @deprecated No replacement API recommended.\n\t /\n\t(event: \"prepareSend\", listener: (messageBuffer: any[]) => void);\n\n\t/\n\t @deprecated No replacement API recommended.\n\t /\n\t(event: \"submitOp\", listener: (message: IDocumentMessage) => void);\n\n\t/\n\t Emitted immediately after processing an incoming operation (op).\n\t \n\t @remarks\n\t \n\t Note: this event is not intended for general use.\n\t * Prefer to listen to events on the appropriate ultimate recipients of the ops, rather than listening to the\n\t * ops directly on the {@link IDeltaManager}.\n\t \n\t Listener parameters:\n\t \n\t - `message`: The op that was processed.\n\t \n\t - `processingTime`: The amount of time it took to process the inbound operation (op), expressed in milliseconds.\n\t /\n\t(event: \"op\", listener: (message: ISequencedDocumentMessage, processingTime: number) => void);\n\n\t/\n\t @deprecated No replacement API recommended.\n\t /\n\t(event: \"allSentOpsAckd\", listener: () => void);\n\n\t/\n\t @deprecated No replacement API recommended.\n\t /\n\t(event: \"pong\", listener: (latency: number) => void);\n\n\t/\n\t @deprecated No replacement API recommended.\n\t /\n\t(event: \"processTime\", listener: (latency: number) => void);\n\n\t/\n\t Emitted when the {@link IDeltaManager} completes connecting to the Fluid service.\n\t \n\t @remarks\n\t * This occurs once we've received the connect_document_success message from the server,\n\t * and happens prior to the client's join message (if there is a join message).\n\t \n\t Listener parameters:\n\t \n\t - `details`: Connection metadata.\n\t \n\t - `opsBehind`: An estimate of far behind the client is relative to the service in terms of ops.\n\t * Will not be specified if an estimate cannot be determined.\n\t /\n\t(event: \"connect\", listener: (details: IConnectionDetails, opsBehind?: number) => void);\n\n\t/\n\t Emitted when the {@link IDeltaManager} becomes disconnected from the Fluid service.\n\t \n\t @remarks Listener parameters:\n\t \n\t - `reason`: Describes the reason for which the delta manager was disconnected.\n\t * - `error` : error if any for the disconnect.\n\t /\n\t(event: \"disconnect\", listener: (reason: string, error?: IAnyDriverError) => void);\n\n\t/\n\t Emitted when read/write permissions change.\n\t \n\t @remarks Listener parameters:\n\t \n\t - `readonly`: Whether or not the delta manager is now read-only.\n\t /\n\t(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>\n\textends IEventProvider<IDeltaManagerEvents>,\n\t\tIDeltaSender,\n\t\tIDisposable {\n\t/* The queue of inbound delta messages /\n\treadonly inbound: IDeltaQueue<T>;\n\n\t/* The queue of outbound delta messages /\n\treadonly outbound: IDeltaQueue<U[]>;\n\n\t/* The queue of inbound delta signals /\n\treadonly inboundSignal: IDeltaQueue<ISignalMessage>;\n\n\t/* The current minimum sequence number /\n\treadonly minimumSequenceNumber: number;\n\n\t/* The last sequence number processed by the delta manager /\n\treadonly lastSequenceNumber: number;\n\n\t/* The last message processed by the delta manager /\n\treadonly lastMessage: ISequencedDocumentMessage \| undefined;\n\n\t/* The latest sequence number the delta manager is aware of /\n\treadonly lastKnownSeqNumber: number;\n\n\t/* The initial sequence number set when attaching the op handler /\n\treadonly initialSequenceNumber: number;\n\n\t/\n\t Tells if current connection has checkpoint information.\n\t * I.e. we know how far behind the client was at the time of establishing connection\n\t /\n\treadonly hasCheckpointSequenceNumber: boolean;\n\n\t/* Details of client /\n\treadonly clientDetails: IClientDetails;\n\n\t/* Protocol version being used to communicate with the service /\n\treadonly version: string;\n\n\t/* Max message size allowed to the delta manager /\n\treadonly maxMessageSize: number;\n\n\t/* Service configuration provided by the service. /\n\treadonly serviceConfiguration: IClientConfiguration \| undefined;\n\n\t/* Flag to indicate whether the client can write or not. /\n\treadonly active: boolean;\n\n\treadonly readOnlyInfo: ReadOnlyInfo;\n\n\t/* Submit a signal to the service to be broadcast to other connected clients, but not persisted /\n\tsubmitSignal(content: any): void;\n}\n\n/\n Events emitted by {@link IDeltaQueue}.\n /\nexport interface IDeltaQueueEvents<T> extends IErrorEvent {\n\t/\n\t Emitted when a task is enqueued.\n\t \n\t @remarks Listener parameters:\n\t \n\t - `task`: The task being enqueued.\n\t /\n\t(event: \"push\", listener: (task: T) => void);\n\n\t/\n\t Emitted immediately after processing an enqueued task and removing it from the queue.\n\t \n\t @remarks\n\t \n\t Note: this event is not intended for general use.\n\t * Prefer to listen to events on the appropriate ultimate recipients of the ops, rather than listening to the\n\t * ops directly on the {@link IDeltaQueue}.\n\t \n\t Listener parameters:\n\t \n\t - `task`: The task that was processed.\n\t /\n\t(event: \"op\", listener: (task: T) => void);\n\n\t/\n\t Emitted when the queue of tasks to process is emptied.\n\t \n\t @remarks Listener parameters:\n\t \n\t - `count`: The number of events (`T`) processed before becoming idle.\n\t \n\t - `duration`: The amount of time it took to process elements (in milliseconds).\n\t \n\t @see {@link IDeltaQueue.idle}\n\t /\n\t(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\t/\n\t Flag indicating whether or not the queue was paused\n\t /\n\tpaused: boolean;\n\n\t/\n\t The number of messages remaining in the queue\n\t /\n\tlength: number;\n\n\t/\n\t Flag indicating whether or not the queue is idle.\n\t * I.e. there are no remaining messages to processes.\n\t /\n\tidle: boolean;\n\n\t/\n\t Pauses processing on the queue.\n\t \n\t @returns A promise which resolves when processing has been paused.\n\t /\n\tpause(): Promise<void>;\n\n\t/\n\t Resumes processing on the queue\n\t /\n\tresume(): void;\n\n\t/\n\t Peeks at the next message in the queue\n\t /\n\tpeek(): T \| undefined;\n\n\t/\n\t Returns all the items in the queue as an array. Does not remove them from the queue.\n\t /\n\ttoArray(): T[];\n\n\t/\n\t returns number of ops processed and time it took to process these ops.\n\t * Zeros if queue did not process anything (had no messages, was paused or had hit an error before)\n\t /\n\twaitTillProcessingDone(): Promise<{ count: number; duration: number }>;\n}\n\nexport type ReadOnlyInfo =\n\t\| {\n\t\t\treadonly readonly: false \| undefined;\n\t }\n\t\| {\n\t\t\treadonly readonly: true;\n\t\t\t/* read-only because forceReadOnly() was called /\n\t\t\treadonly forced: boolean;\n\t\t\t/* read-only because client does not have write permissions for document /\n\t\t\treadonly permissions: boolean \| undefined;\n\t\t\t/* read-only with no delta stream connection /\n\t\t\treadonly storageOnly: boolean;\n\t\t\t/* extra info on why connection to delta stream is not possible. This info might be provided\n\t\t\t * if storageOnly is set to true */\n\t\t\treadonly storageOnlyReason?: string;\n\t };\n"]}

package/dist/runtime.d.ts CHANGED Viewed

@@ -2,8 +2,8 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { ITelemetryBaseLogger, IDisposable } from "@fluidframework/common-definitions";
-import { FluidObject, IRequest, IResponse } from "@fluidframework/core-interfaces";
+import { ITelemetryBaseLogger } from "@fluidframework/common-definitions";
+import { IDisposable, FluidObject, IRequest, IResponse } from "@fluidframework/core-interfaces";
 import { IDocumentStorageService } from "@fluidframework/driver-definitions";
 import { IClientConfiguration, IClientDetails, ISequencedDocumentMessage, ISnapshotTree, MessageType, ISummaryTree, IVersion, IDocumentMessage, IQuorumClients, ISummaryContent } from "@fluidframework/protocol-definitions";
 import { IAudience } from "./audience";
@@ -103,14 +103,11 @@ export interface IBatchMessage {
     referenceSequenceNumber?: number;
 }
 /**
- * The ContainerContext is a proxy standing between the Container and the Container's IRuntime.
- * This allows the Container to terminate the connection to the IRuntime.
- *
- * Specifically, there is an event on Container, onContextChanged, which mean a new code proposal has been loaded,
- * so the old IRuntime is no longer valid, as its ContainerContext has been revoked,
- * and the Container has created a new ContainerContext.
+ * IContainerContext is fundamentally just the set of things that an IRuntimeFactory (and IRuntime) will consume from the
+ * loader layer.  It gets passed into the IRuntimeFactory.instantiateRuntime call.  Only include members on this interface
+ * if you intend them to be consumed/called from the runtime layer.
  */
-export interface IContainerContext extends IDisposable {
+export interface IContainerContext {
     /** @deprecated Please pass in existing directly in instantiateRuntime */
     readonly existing: boolean | undefined;
     readonly options: ILoaderOptions;
@@ -140,6 +137,10 @@ export interface IContainerContext extends IDisposable {
     readonly audience: IAudience | undefined;
     readonly loader: ILoader;
     readonly taggedLogger: ITelemetryBaseLogger;
+    /**
+     * @deprecated - 2.0.0-internal.5.2.0 - This property is redundant, and is unused by the runtime. The same information can be found via
+     * deltaManager.serviceConfiguration on this object if it is necessary.
+     */
     readonly serviceConfiguration: IClientConfiguration | undefined;
     pendingLocalState?: unknown;
     /**
@@ -164,14 +165,21 @@ export interface IContainerContext extends IDisposable {
      * WARNING: this id is meant for telemetry usages ONLY, not recommended for other consumption
      * This id is not supposed to be exposed anywhere else. It is dependant on usage or drivers
      * and scenarios which can change in the future.
+     * @deprecated - 2.0.0-internal.5.2.0 - The docId is already logged by the IContainerContext.taggedLogger for
+     * telemetry purposes, so this is generally unnecessary for telemetry.  If the id is needed for other purposes
+     * it should be passed to the consumer explicitly.  This member will be removed in an upcoming release.
      */
     readonly id: string;
     /**
-     * Proxy for {@link IRuntime.getEntryPoint}, the entryPoint defined in the container's runtime.
-     *
-     * @see {@link IContainer.getEntryPoint}
+     * @deprecated - 2.0.0-internal.5.2.0 - The disposed state on the IContainerContext is not meaningful to the runtime.
+     * This member will be removed in an upcoming release.
      */
-    getEntryPoint?(): Promise<FluidObject | undefined>;
+    readonly disposed: boolean;
+    /**
+     * @deprecated - 2.0.0-internal.5.2.0 - The runtime is not permitted to dispose the IContainerContext, this results
+     * in an inconsistent system state.  This member will be removed in an upcoming release.
+     */
+    dispose(error?: Error): void;
 }
 export declare const IRuntimeFactory: keyof IProvideRuntimeFactory;
 export interface IProvideRuntimeFactory {

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

	@@ -1 +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,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;~~AACnF~~,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,EACN,oBAAoB,EACpB,cAAc,EACd,yBAAyB,EACzB,aAAa,EACb,WAAW,EACX,YAAY,EACZ,QAAQ,EACR,gBAAgB,EAChB,cAAc,EACd,eAAe,EACf,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;IACtB;;;OAGG;IACH,QAAQ,aAAa;IAErB;;OAEG;IACH,SAAS,cAAc;IAEvB;;;OAGG;IACH,QAAQ,aAAa;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,QAAS,SAAQ,WAAW;IAC5C;;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;;;;OAIG;IACH,oBAAoB,IAAI,OAAO,CAAC;IAEhC;;;;OAIG;IACH,eAAe,CAAC,QAAQ,EAAE,6BAA6B,GAAG,IAAI,CAAC;IAE/D;;;OAGG;IACH,cAAc,CAAC,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnE;;;;;;;;OAQG;IACH,aAAa,CAAC,IAAI,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,CAAC;CACnD;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uBAAuB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED~~;;;;;;;GAOG~~;AACH,MAAM,WAAW,~~iBAAkB,SAAQ,WAAW~~;~~IACrD~~,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,EAAE,uBAAuB,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;IAC7F,QAAQ,CAAC,eAAe,EAAE,CACzB,SAAS,EAAE,eAAe,EAC1B,uBAAuB,CAAC,EAAE,MAAM,KAC5B,MAAM,CAAC;IACZ,QAAQ,CAAC,cAAc,EAAE,CAAC,QAAQ,EAAE,GAAG,KAAK,IAAI,CAAC;IACjD,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,uBAAuB,KAAK,IAAI,CAAC;IAC/D,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;IAEhD,QAAQ,CAAC,iBAAiB,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE1D~~;;;;OAIG~~;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB~~;;;;OAIG~~;IACH,~~aAAa~~,CAAC,~~IAAI~~,OAAO,CAAC,~~WAAW~~,~~GAAG~~,~~SAAS~~,CAAC,CAAC;~~CACnD~~;AAED,eAAO,MAAM,eAAe,EAAE,MAAM,sBAA0C,CAAC;AAE/E,MAAM,WAAW,sBAAsB;IACtC,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;CAC1C;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAgB,SAAQ,sBAAsB;IAC9D;;;;;;OAMG;IACH,kBAAkB,CAAC,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CACrF"}
1	+ {"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AAChG,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,EACN,oBAAoB,EACpB,cAAc,EACd,yBAAyB,EACzB,aAAa,EACb,WAAW,EACX,YAAY,EACZ,QAAQ,EACR,gBAAgB,EAChB,cAAc,EACd,eAAe,EACf,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;IACtB;;;OAGG;IACH,QAAQ,aAAa;IAErB;;OAEG;IACH,SAAS,cAAc;IAEvB;;;OAGG;IACH,QAAQ,aAAa;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,QAAS,SAAQ,WAAW;IAC5C;;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;;;;OAIG;IACH,oBAAoB,IAAI,OAAO,CAAC;IAEhC;;;;OAIG;IACH,eAAe,CAAC,QAAQ,EAAE,6BAA6B,GAAG,IAAI,CAAC;IAE/D;;;OAGG;IACH,cAAc,CAAC,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnE;;;;;;;;OAQG;IACH,aAAa,CAAC,IAAI,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,CAAC;CACnD;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uBAAuB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IACjC,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,EAAE,uBAAuB,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;IAC7F,QAAQ,CAAC,eAAe,EAAE,CACzB,SAAS,EAAE,eAAe,EAC1B,uBAAuB,CAAC,EAAE,MAAM,KAC5B,MAAM,CAAC;IACZ,QAAQ,CAAC,cAAc,EAAE,CAAC,QAAQ,EAAE,GAAG,KAAK,IAAI,CAAC;IACjD,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,uBAAuB,KAAK,IAAI,CAAC;IAC/D,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;;;OAGG;IACH,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;IAEhD,QAAQ,CAAC,iBAAiB,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE1D;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B;;;OAGG;IACH,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;CAC7B;AAED,eAAO,MAAM,eAAe,EAAE,MAAM,sBAA0C,CAAC;AAE/E,MAAM,WAAW,sBAAsB;IACtC,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;CAC1C;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAgB,SAAQ,sBAAsB;IAC9D;;;;;;OAMG;IACH,kBAAkB,CAAC,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CACrF"}

package/dist/runtime.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"runtime.js","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAuBH;;;GAGG;AACH,IAAY,WAiBX;AAjBD,WAAY,WAAW;IACtB;;;OAGG;IACH,oCAAqB,CAAA;IAErB;;OAEG;IACH,sCAAuB,CAAA;IAEvB;;;OAGG;IACH,oCAAqB,CAAA;AACtB,CAAC,EAjBW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAiBtB;AAwKY,QAAA,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 { FluidObject, IRequest, IResponse } from \"@fluidframework/core-interfaces\";\nimport { IDocumentStorageService } from \"@fluidframework/driver-definitions\";\nimport {\n\tIClientConfiguration,\n\tIClientDetails,\n\tISequencedDocumentMessage,\n\tISnapshotTree,\n\tMessageType,\n\tISummaryTree,\n\tIVersion,\n\tIDocumentMessage,\n\tIQuorumClients,\n\tISummaryContent,\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\t/\n\t In detached state, the data is only present on the local client's machine. It has not yet been uploaded\n\t * to the service.\n\t /\n\tDetached = \"Detached\",\n\n\t/\n\t In attaching state, the data has started the upload to the service, but has not yet completed.\n\t /\n\tAttaching = \"Attaching\",\n\n\t/\n\t In attached state, the data has completed upload to the service. It can be accessed by other clients after\n\t * reaching attached state.\n\t /\n\tAttached = \"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\t/\n\t Executes a request against the runtime\n\t /\n\trequest(request: IRequest): Promise<IResponse>;\n\n\t/\n\t Notifies the runtime of a change in the connection state\n\t /\n\tsetConnectionState(connected: boolean, clientId?: string);\n\n\t/\n\t Processes the given op (message)\n\t /\n\tprocess(message: ISequencedDocumentMessage, local: boolean);\n\n\t/\n\t Processes the given signal\n\t /\n\tprocessSignal(message: any, local: boolean);\n\n\t/\n\t Create a summary. Used when attaching or serializing a detached container.\n\t \n\t @param blobRedirectTable - A table passed during the attach process. While detached, blob upload is supported\n\t * using IDs generated locally. After attach, these IDs cannot be used, so this table maps the old local IDs to the\n\t * new storage IDs so requests can be redirected.\n\t /\n\tcreateSummary(blobRedirectTable?: Map<string, string>): ISummaryTree;\n\n\t/\n\t Propagate the container state when container is attaching or attached.\n\t * @param attachState - State of the container.\n\t /\n\tsetAttachState(attachState: AttachState.Attaching \| AttachState.Attached): void;\n\n\t/\n\t Get pending local state in a serializable format to be given back to a newly loaded container\n\t * @experimental\n\t * {@link https://github.com/microsoft/FluidFramework/packages/tree/main/loader/container-loader/closeAndGetPendingLocalState.md}\n\t /\n\tgetPendingLocalState(): unknown;\n\n\t/\n\t Notify runtime that container is moving to \"Attaching\" state\n\t * @param snapshot - snapshot created at attach time\n\t * @deprecated - not necessary after op replay moved to Container\n\t /\n\tnotifyAttaching(snapshot: ISnapshotTreeWithBlobContents): void;\n\n\t/\n\t Notify runtime that we have processed a saved message, so that it can do async work (applying\n\t * stashed ops) after having processed it.\n\t /\n\tnotifyOpReplay?(message: ISequencedDocumentMessage): Promise<void>;\n\n\t/\n\t Exposes the entryPoint for the container runtime.\n\t * Use this as the primary way of getting access to the user-defined logic within the container runtime.\n\t \n\t @see {@link IContainer.getEntryPoint}\n\t \n\t @remarks The plan is that eventually IRuntime will no longer have a request() method, this method will no\n\t * longer be optional, and it will become the only way to access the entryPoint for the runtime.\n\t /\n\tgetEntryPoint?(): Promise<FluidObject \| undefined>;\n}\n\n/\n Payload type for IContainerContext.submitBatchFn()\n /\nexport interface IBatchMessage {\n\tcontents?: string;\n\tmetadata: Record<string, unknown> \| undefined;\n\tcompression?: string;\n\treferenceSequenceNumber?: number;\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\t/* @deprecated Please pass in existing directly in instantiateRuntime /\n\treadonly existing: boolean \| undefined;\n\treadonly options: ILoaderOptions;\n\treadonly clientId: string \| undefined;\n\treadonly clientDetails: IClientDetails;\n\treadonly storage: IDocumentStorageService;\n\treadonly connected: boolean;\n\treadonly baseSnapshot: ISnapshotTree \| undefined;\n\t/* @deprecated Please use submitBatchFn & submitSummaryFn /\n\treadonly submitFn: (type: MessageType, contents: any, batch: boolean, appData?: any) => number;\n\t/* @returns clientSequenceNumber of last message in a batch /\n\treadonly submitBatchFn: (batch: IBatchMessage[], referenceSequenceNumber?: number) => number;\n\treadonly submitSummaryFn: (\n\t\tsummaryOp: ISummaryContent,\n\t\treferenceSequenceNumber?: number,\n\t) => number;\n\treadonly submitSignalFn: (contents: any) => void;\n\treadonly disposeFn?: (error?: ICriticalContainerError) => void;\n\treadonly closeFn: (error?: ICriticalContainerError) => void;\n\treadonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;\n\treadonly quorum: IQuorumClients;\n\t/\n\t @deprecated This method is provided as a migration tool for customers currently reading the code details\n\t * from within the Container by directly accessing the Quorum proposals. The code details should not be accessed\n\t * from within the Container as this requires coupling between the container contents and the code loader.\n\t * Direct access to Quorum proposals will be removed in an upcoming release, and in a further future release this\n\t * migration tool will be removed.\n\t /\n\tgetSpecifiedCodeDetails?(): IFluidCodeDetails \| undefined;\n\treadonly audience: IAudience \| undefined;\n\treadonly loader: ILoader;\n\t// The logger implementation, which would support tagged events, should be provided by the loader.\n\treadonly taggedLogger: ITelemetryBaseLogger;\n\treadonly serviceConfiguration: IClientConfiguration \| undefined;\n\tpendingLocalState?: unknown;\n\n\t/\n\t Ambient services provided with the context\n\t /\n\treadonly scope: FluidObject;\n\n\t/\n\t Get an absolute url for a provided container-relative request.\n\t * @param relativeUrl - A relative request within the container\n\t \n\t TODO: Optional for backwards compatibility. Make non-optional in version 0.19\n\t /\n\tgetAbsoluteUrl?(relativeUrl: string): Promise<string \| undefined>;\n\n\t/\n\t Indicates the attachment state of the container to a host service.\n\t /\n\treadonly attachState: AttachState;\n\n\tgetLoadedFromVersion(): IVersion \| undefined;\n\n\tupdateDirtyContainerState(dirty: boolean): void;\n\n\treadonly supportedFeatures?: ReadonlyMap<string, unknown>;\n\n\t/\n\t WARNING: this id is meant for telemetry usages ONLY, not recommended for other consumption\n\t * This id is not supposed to be exposed anywhere else. It is dependant on usage or drivers\n\t * and scenarios which can change in the future.\n\t /\n\treadonly id: string;\n\n\t/\n\t Proxy for {@link IRuntime.getEntryPoint}, the entryPoint defined in the container's runtime.\n\t \n\t @see {@link IContainer.getEntryPoint}\n\t /\n\tgetEntryPoint?(): Promise<FluidObject \| undefined>;\n}\n\nexport const IRuntimeFactory: keyof IProvideRuntimeFactory = \"IRuntimeFactory\";\n\nexport interface IProvideRuntimeFactory {\n\treadonly 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\t/\n\t Instantiates a new IRuntime for the given IContainerContext to proxy to\n\t * This is the main entry point to the Container's business logic\n\t \n\t @param context - container context to be supplied to the runtime\n\t * @param existing - whether to instantiate for the first time or from an existing context\n\t */\n\tinstantiateRuntime(context: IContainerContext, existing: boolean): Promise<IRuntime>;\n}\n"]}
1	+ {"version":3,"file":"runtime.js","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAuBH;;;GAGG;AACH,IAAY,WAiBX;AAjBD,WAAY,WAAW;IACtB;;;OAGG;IACH,oCAAqB,CAAA;IAErB;;OAEG;IACH,sCAAuB,CAAA;IAEvB;;;OAGG;IACH,oCAAqB,CAAA;AACtB,CAAC,EAjBW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAiBtB;AAgLY,QAAA,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 } from \"@fluidframework/common-definitions\";\nimport { IDisposable, FluidObject, IRequest, IResponse } from \"@fluidframework/core-interfaces\";\nimport { IDocumentStorageService } from \"@fluidframework/driver-definitions\";\nimport {\n\tIClientConfiguration,\n\tIClientDetails,\n\tISequencedDocumentMessage,\n\tISnapshotTree,\n\tMessageType,\n\tISummaryTree,\n\tIVersion,\n\tIDocumentMessage,\n\tIQuorumClients,\n\tISummaryContent,\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\t/\n\t In detached state, the data is only present on the local client's machine. It has not yet been uploaded\n\t * to the service.\n\t /\n\tDetached = \"Detached\",\n\n\t/\n\t In attaching state, the data has started the upload to the service, but has not yet completed.\n\t /\n\tAttaching = \"Attaching\",\n\n\t/\n\t In attached state, the data has completed upload to the service. It can be accessed by other clients after\n\t * reaching attached state.\n\t /\n\tAttached = \"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\t/\n\t Executes a request against the runtime\n\t /\n\trequest(request: IRequest): Promise<IResponse>;\n\n\t/\n\t Notifies the runtime of a change in the connection state\n\t /\n\tsetConnectionState(connected: boolean, clientId?: string);\n\n\t/\n\t Processes the given op (message)\n\t /\n\tprocess(message: ISequencedDocumentMessage, local: boolean);\n\n\t/\n\t Processes the given signal\n\t /\n\tprocessSignal(message: any, local: boolean);\n\n\t/\n\t Create a summary. Used when attaching or serializing a detached container.\n\t \n\t @param blobRedirectTable - A table passed during the attach process. While detached, blob upload is supported\n\t * using IDs generated locally. After attach, these IDs cannot be used, so this table maps the old local IDs to the\n\t * new storage IDs so requests can be redirected.\n\t /\n\tcreateSummary(blobRedirectTable?: Map<string, string>): ISummaryTree;\n\n\t/\n\t Propagate the container state when container is attaching or attached.\n\t * @param attachState - State of the container.\n\t /\n\tsetAttachState(attachState: AttachState.Attaching \| AttachState.Attached): void;\n\n\t/\n\t Get pending local state in a serializable format to be given back to a newly loaded container\n\t * @experimental\n\t * {@link https://github.com/microsoft/FluidFramework/packages/tree/main/loader/container-loader/closeAndGetPendingLocalState.md}\n\t /\n\tgetPendingLocalState(): unknown;\n\n\t/\n\t Notify runtime that container is moving to \"Attaching\" state\n\t * @param snapshot - snapshot created at attach time\n\t * @deprecated - not necessary after op replay moved to Container\n\t /\n\tnotifyAttaching(snapshot: ISnapshotTreeWithBlobContents): void;\n\n\t/\n\t Notify runtime that we have processed a saved message, so that it can do async work (applying\n\t * stashed ops) after having processed it.\n\t /\n\tnotifyOpReplay?(message: ISequencedDocumentMessage): Promise<void>;\n\n\t/\n\t Exposes the entryPoint for the container runtime.\n\t * Use this as the primary way of getting access to the user-defined logic within the container runtime.\n\t \n\t @see {@link IContainer.getEntryPoint}\n\t \n\t @remarks The plan is that eventually IRuntime will no longer have a request() method, this method will no\n\t * longer be optional, and it will become the only way to access the entryPoint for the runtime.\n\t /\n\tgetEntryPoint?(): Promise<FluidObject \| undefined>;\n}\n\n/\n Payload type for IContainerContext.submitBatchFn()\n /\nexport interface IBatchMessage {\n\tcontents?: string;\n\tmetadata: Record<string, unknown> \| undefined;\n\tcompression?: string;\n\treferenceSequenceNumber?: number;\n}\n\n/\n IContainerContext is fundamentally just the set of things that an IRuntimeFactory (and IRuntime) will consume from the\n * loader layer. It gets passed into the IRuntimeFactory.instantiateRuntime call. Only include members on this interface\n * if you intend them to be consumed/called from the runtime layer.\n /\nexport interface IContainerContext {\n\t/* @deprecated Please pass in existing directly in instantiateRuntime /\n\treadonly existing: boolean \| undefined;\n\treadonly options: ILoaderOptions;\n\treadonly clientId: string \| undefined;\n\treadonly clientDetails: IClientDetails;\n\treadonly storage: IDocumentStorageService;\n\treadonly connected: boolean;\n\treadonly baseSnapshot: ISnapshotTree \| undefined;\n\t/* @deprecated Please use submitBatchFn & submitSummaryFn /\n\treadonly submitFn: (type: MessageType, contents: any, batch: boolean, appData?: any) => number;\n\t/* @returns clientSequenceNumber of last message in a batch /\n\treadonly submitBatchFn: (batch: IBatchMessage[], referenceSequenceNumber?: number) => number;\n\treadonly submitSummaryFn: (\n\t\tsummaryOp: ISummaryContent,\n\t\treferenceSequenceNumber?: number,\n\t) => number;\n\treadonly submitSignalFn: (contents: any) => void;\n\treadonly disposeFn?: (error?: ICriticalContainerError) => void;\n\treadonly closeFn: (error?: ICriticalContainerError) => void;\n\treadonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;\n\treadonly quorum: IQuorumClients;\n\t/\n\t @deprecated This method is provided as a migration tool for customers currently reading the code details\n\t * from within the Container by directly accessing the Quorum proposals. The code details should not be accessed\n\t * from within the Container as this requires coupling between the container contents and the code loader.\n\t * Direct access to Quorum proposals will be removed in an upcoming release, and in a further future release this\n\t * migration tool will be removed.\n\t /\n\tgetSpecifiedCodeDetails?(): IFluidCodeDetails \| undefined;\n\treadonly audience: IAudience \| undefined;\n\treadonly loader: ILoader;\n\t// The logger implementation, which would support tagged events, should be provided by the loader.\n\treadonly taggedLogger: ITelemetryBaseLogger;\n\t/\n\t @deprecated - 2.0.0-internal.5.2.0 - This property is redundant, and is unused by the runtime. The same information can be found via\n\t * deltaManager.serviceConfiguration on this object if it is necessary.\n\t /\n\treadonly serviceConfiguration: IClientConfiguration \| undefined;\n\tpendingLocalState?: unknown;\n\n\t/\n\t Ambient services provided with the context\n\t /\n\treadonly scope: FluidObject;\n\n\t/\n\t Get an absolute url for a provided container-relative request.\n\t * @param relativeUrl - A relative request within the container\n\t \n\t TODO: Optional for backwards compatibility. Make non-optional in version 0.19\n\t /\n\tgetAbsoluteUrl?(relativeUrl: string): Promise<string \| undefined>;\n\n\t/\n\t Indicates the attachment state of the container to a host service.\n\t /\n\treadonly attachState: AttachState;\n\n\tgetLoadedFromVersion(): IVersion \| undefined;\n\n\tupdateDirtyContainerState(dirty: boolean): void;\n\n\treadonly supportedFeatures?: ReadonlyMap<string, unknown>;\n\n\t/\n\t WARNING: this id is meant for telemetry usages ONLY, not recommended for other consumption\n\t * This id is not supposed to be exposed anywhere else. It is dependant on usage or drivers\n\t * and scenarios which can change in the future.\n\t * @deprecated - 2.0.0-internal.5.2.0 - The docId is already logged by the IContainerContext.taggedLogger for\n\t * telemetry purposes, so this is generally unnecessary for telemetry. If the id is needed for other purposes\n\t * it should be passed to the consumer explicitly. This member will be removed in an upcoming release.\n\t /\n\treadonly id: string;\n\n\t/\n\t @deprecated - 2.0.0-internal.5.2.0 - The disposed state on the IContainerContext is not meaningful to the runtime.\n\t * This member will be removed in an upcoming release.\n\t /\n\treadonly disposed: boolean;\n\t/\n\t @deprecated - 2.0.0-internal.5.2.0 - The runtime is not permitted to dispose the IContainerContext, this results\n\t * in an inconsistent system state. This member will be removed in an upcoming release.\n\t /\n\tdispose(error?: Error): void;\n}\n\nexport const IRuntimeFactory: keyof IProvideRuntimeFactory = \"IRuntimeFactory\";\n\nexport interface IProvideRuntimeFactory {\n\treadonly 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\t/\n\t Instantiates a new IRuntime for the given IContainerContext to proxy to\n\t * This is the main entry point to the Container's business logic\n\t \n\t @param context - container context to be supplied to the runtime\n\t * @param existing - whether to instantiate for the first time or from an existing context\n\t */\n\tinstantiateRuntime(context: IContainerContext, existing: boolean): Promise<IRuntime>;\n}\n"]}

package/lib/deltas.d.ts CHANGED Viewed

@@ -2,7 +2,8 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { IDisposable, IEventProvider, IEvent, IErrorEvent } from "@fluidframework/common-definitions";
+import { IEventProvider, IEvent, IErrorEvent } from "@fluidframework/common-definitions";
+import { IDisposable } from "@fluidframework/core-interfaces";
 import { IAnyDriverError } from "@fluidframework/driver-definitions";
 import { ConnectionMode, IClientConfiguration, IClientDetails, IDocumentMessage, ISequencedDocumentMessage, ISignalClient, ISignalMessage, ITokenClaims } from "@fluidframework/protocol-definitions";
 /**
@@ -26,23 +27,39 @@ export interface IConnectionDetails {
 }
 /**
  * Internal version of IConnectionDetails with props are only exposed internally
+ * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.
  */
 export interface IConnectionDetailsInternal extends IConnectionDetails {
+    /**
+     * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.
+     */
     mode: ConnectionMode;
+    /**
+     * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.
+     */
     version: string;
+    /**
+     * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.
+     */
     initialClients: ISignalClient[];
+    /**
+     * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.
+     */
     reason: string;
 }
 /**
  * Interface used to define a strategy for handling incoming delta messages
+ * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.
  */
 export interface IDeltaHandlerStrategy {
     /**
      * Processes the message.
+     * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.
      */
     process: (message: ISequencedDocumentMessage) => void;
     /**
      * Processes the signal.
+     * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.
      */
     processSignal: (message: ISignalMessage) => void;
 }

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

	@@ -1 +1 @@
1	- {"version":3,"file":"deltas.d.ts","sourceRoot":"","sources":["../src/deltas.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,~~EACN~~,~~WAAW,EACX,~~cAAc,~~EACd~~,MAAM,~~EACN~~,WAAW,~~EACX~~,MAAM,oCAAoC,CAAC;~~AAC5C~~,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AACrE,OAAO,EACN,cAAc,EACd,oBAAoB,EACpB,cAAc,EACd,gBAAgB,EAChB,yBAAyB,EACzB,aAAa,EACb,cAAc,EACd,YAAY,EACZ,MAAM,sCAAsC,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;IACrB,oBAAoB,EAAE,oBAAoB,CAAC;IAE3C;;;;;;;;;OASG;IACH,wBAAwB,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7C;AAED~~;;GAEG~~;AACH,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB;IACrE,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,aAAa,EAAE,CAAC;IAChC,MAAM,EAAE,MAAM,CAAC;CACf;AAED~~;;GAEG~~;AACH,MAAM,WAAW,qBAAqB;IACrC~~;;OAEG~~;IACH,OAAO,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,CAAC;IAEtD~~;;OAEG~~;IACH,aAAa,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,CAAC;CACjD;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,MAAM;IAClD;;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;;;;;;;OAOG;IACH,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,eAAe,KAAK,IAAI,OAAE;IAEnF;;;;;;OAMG;IACH,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,OAAE;CAC3D;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,EAAE,CAAC,CAClC,SAAQ,cAAc,CAAC,mBAAmB,CAAC,EAC1C,YAAY,EACZ,WAAW;IACZ,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;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAAC,CAAC,CAAE,SAAQ,WAAW;IACxD;;;;;;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;CACrE;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,CAAE,SAAQ,cAAc,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,EAAE,WAAW;IACxF;;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,CAAA;KAAE,CAAC,CAAC;CACvE;AAED,oBAAY,YAAY,GACrB;IACA,QAAQ,CAAC,QAAQ,EAAE,KAAK,GAAG,SAAS,CAAC;CACpC,GACD;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;IAC9B;uCACmC;IACnC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CACnC,CAAC"}
1	+ {"version":3,"file":"deltas.d.ts","sourceRoot":"","sources":["../src/deltas.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACzF,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AACrE,OAAO,EACN,cAAc,EACd,oBAAoB,EACpB,cAAc,EACd,gBAAgB,EAChB,yBAAyB,EACzB,aAAa,EACb,cAAc,EACd,YAAY,EACZ,MAAM,sCAAsC,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;IACrB,oBAAoB,EAAE,oBAAoB,CAAC;IAE3C;;;;;;;;;OASG;IACH,wBAAwB,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7C;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB;IACrE;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IACrB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,cAAc,EAAE,aAAa,EAAE,CAAC;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACrC;;;OAGG;IACH,OAAO,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,CAAC;IAEtD;;;OAGG;IACH,aAAa,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,CAAC;CACjD;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,MAAM;IAClD;;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;;;;;;;OAOG;IACH,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,eAAe,KAAK,IAAI,OAAE;IAEnF;;;;;;OAMG;IACH,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,OAAE;CAC3D;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,EAAE,CAAC,CAClC,SAAQ,cAAc,CAAC,mBAAmB,CAAC,EAC1C,YAAY,EACZ,WAAW;IACZ,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;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAAC,CAAC,CAAE,SAAQ,WAAW;IACxD;;;;;;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;CACrE;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,CAAE,SAAQ,cAAc,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,EAAE,WAAW;IACxF;;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,CAAA;KAAE,CAAC,CAAC;CACvE;AAED,oBAAY,YAAY,GACrB;IACA,QAAQ,CAAC,QAAQ,EAAE,KAAK,GAAG,SAAS,CAAC;CACpC,GACD;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;IAC9B;uCACmC;IACnC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CACnC,CAAC"}

package/lib/deltas.js.map CHANGED Viewed

	@@ -1 +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 {\n\tIDisposable,\n\tIEventProvider,\n\tIEvent,\n\tIErrorEvent,\n} from \"@fluidframework/common-definitions\";\nimport { IAnyDriverError } from \"@fluidframework/driver-definitions\";\nimport {\n\tConnectionMode,\n\tIClientConfiguration,\n\tIClientDetails,\n\tIDocumentMessage,\n\tISequencedDocumentMessage,\n\tISignalClient,\n\tISignalMessage,\n\tITokenClaims,\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\tclientId: string;\n\tclaims: ITokenClaims;\n\tserviceConfiguration: IClientConfiguration;\n\n\t/\n\t Last known sequence number to ordering service at the time of connection.\n\t \n\t @remarks\n\t \n\t It may lap actual last sequence number (quite a bit, if container is very active).\n\t * But it's the best information for client to figure out how far it is behind, at least\n\t * for \"read\" connections. \"write\" connections may use own \"join\" op to similar information,\n\t * that is likely to be more up-to-date.\n\t /\n\tcheckpointSequenceNumber: number \| undefined;\n}\n\n/\n Internal version of IConnectionDetails with props are only exposed internally\n /\nexport interface IConnectionDetailsInternal extends IConnectionDetails {\n\tmode: ConnectionMode;\n\tversion: string;\n\tinitialClients: ISignalClient[];\n\treason: string;\n}\n\n/\n Interface used to define a strategy for handling incoming delta messages\n /\nexport interface IDeltaHandlerStrategy {\n\t/\n\t Processes the message.\n\t /\n\tprocess: (message: ISequencedDocumentMessage) => void;\n\n\t/\n\t Processes the signal.\n\t /\n\tprocessSignal: (message: ISignalMessage) => void;\n}\n\n/\n Contract supporting delivery of outbound messages to the server\n /\nexport interface IDeltaSender {\n\t/\n\t Flush all pending messages through the outbound queue\n\t /\n\tflush(): void;\n}\n\n/\n Events emitted by {@link IDeltaManager}.\n /\nexport interface IDeltaManagerEvents extends IEvent {\n\t/\n\t @deprecated No replacement API recommended.\n\t /\n\t(event: \"prepareSend\", listener: (messageBuffer: any[]) => void);\n\n\t/\n\t @deprecated No replacement API recommended.\n\t /\n\t(event: \"submitOp\", listener: (message: IDocumentMessage) => void);\n\n\t/\n\t Emitted immediately after processing an incoming operation (op).\n\t \n\t @remarks\n\t \n\t Note: this event is not intended for general use.\n\t * Prefer to listen to events on the appropriate ultimate recipients of the ops, rather than listening to the\n\t * ops directly on the {@link IDeltaManager}.\n\t \n\t Listener parameters:\n\t \n\t - `message`: The op that was processed.\n\t \n\t - `processingTime`: The amount of time it took to process the inbound operation (op), expressed in milliseconds.\n\t /\n\t(event: \"op\", listener: (message: ISequencedDocumentMessage, processingTime: number) => void);\n\n\t/\n\t @deprecated No replacement API recommended.\n\t /\n\t(event: \"allSentOpsAckd\", listener: () => void);\n\n\t/\n\t @deprecated No replacement API recommended.\n\t /\n\t(event: \"pong\", listener: (latency: number) => void);\n\n\t/\n\t @deprecated No replacement API recommended.\n\t /\n\t(event: \"processTime\", listener: (latency: number) => void);\n\n\t/\n\t Emitted when the {@link IDeltaManager} completes connecting to the Fluid service.\n\t \n\t @remarks\n\t * This occurs once we've received the connect_document_success message from the server,\n\t * and happens prior to the client's join message (if there is a join message).\n\t \n\t Listener parameters:\n\t \n\t - `details`: Connection metadata.\n\t \n\t - `opsBehind`: An estimate of far behind the client is relative to the service in terms of ops.\n\t * Will not be specified if an estimate cannot be determined.\n\t /\n\t(event: \"connect\", listener: (details: IConnectionDetails, opsBehind?: number) => void);\n\n\t/\n\t Emitted when the {@link IDeltaManager} becomes disconnected from the Fluid service.\n\t \n\t @remarks Listener parameters:\n\t \n\t - `reason`: Describes the reason for which the delta manager was disconnected.\n\t * - `error` : error if any for the disconnect.\n\t /\n\t(event: \"disconnect\", listener: (reason: string, error?: IAnyDriverError) => void);\n\n\t/\n\t Emitted when read/write permissions change.\n\t \n\t @remarks Listener parameters:\n\t \n\t - `readonly`: Whether or not the delta manager is now read-only.\n\t /\n\t(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>\n\textends IEventProvider<IDeltaManagerEvents>,\n\t\tIDeltaSender,\n\t\tIDisposable {\n\t/* The queue of inbound delta messages /\n\treadonly inbound: IDeltaQueue<T>;\n\n\t/* The queue of outbound delta messages /\n\treadonly outbound: IDeltaQueue<U[]>;\n\n\t/* The queue of inbound delta signals /\n\treadonly inboundSignal: IDeltaQueue<ISignalMessage>;\n\n\t/* The current minimum sequence number /\n\treadonly minimumSequenceNumber: number;\n\n\t/* The last sequence number processed by the delta manager /\n\treadonly lastSequenceNumber: number;\n\n\t/* The last message processed by the delta manager /\n\treadonly lastMessage: ISequencedDocumentMessage \| undefined;\n\n\t/* The latest sequence number the delta manager is aware of /\n\treadonly lastKnownSeqNumber: number;\n\n\t/* The initial sequence number set when attaching the op handler /\n\treadonly initialSequenceNumber: number;\n\n\t/\n\t Tells if current connection has checkpoint information.\n\t * I.e. we know how far behind the client was at the time of establishing connection\n\t /\n\treadonly hasCheckpointSequenceNumber: boolean;\n\n\t/* Details of client /\n\treadonly clientDetails: IClientDetails;\n\n\t/* Protocol version being used to communicate with the service /\n\treadonly version: string;\n\n\t/* Max message size allowed to the delta manager /\n\treadonly maxMessageSize: number;\n\n\t/* Service configuration provided by the service. /\n\treadonly serviceConfiguration: IClientConfiguration \| undefined;\n\n\t/* Flag to indicate whether the client can write or not. /\n\treadonly active: boolean;\n\n\treadonly readOnlyInfo: ReadOnlyInfo;\n\n\t/* Submit a signal to the service to be broadcast to other connected clients, but not persisted /\n\tsubmitSignal(content: any): void;\n}\n\n/\n Events emitted by {@link IDeltaQueue}.\n /\nexport interface IDeltaQueueEvents<T> extends IErrorEvent {\n\t/\n\t Emitted when a task is enqueued.\n\t \n\t @remarks Listener parameters:\n\t \n\t - `task`: The task being enqueued.\n\t /\n\t(event: \"push\", listener: (task: T) => void);\n\n\t/\n\t Emitted immediately after processing an enqueued task and removing it from the queue.\n\t \n\t @remarks\n\t \n\t Note: this event is not intended for general use.\n\t * Prefer to listen to events on the appropriate ultimate recipients of the ops, rather than listening to the\n\t * ops directly on the {@link IDeltaQueue}.\n\t \n\t Listener parameters:\n\t \n\t - `task`: The task that was processed.\n\t /\n\t(event: \"op\", listener: (task: T) => void);\n\n\t/\n\t Emitted when the queue of tasks to process is emptied.\n\t \n\t @remarks Listener parameters:\n\t \n\t - `count`: The number of events (`T`) processed before becoming idle.\n\t \n\t - `duration`: The amount of time it took to process elements (in milliseconds).\n\t \n\t @see {@link IDeltaQueue.idle}\n\t /\n\t(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\t/\n\t Flag indicating whether or not the queue was paused\n\t /\n\tpaused: boolean;\n\n\t/\n\t The number of messages remaining in the queue\n\t /\n\tlength: number;\n\n\t/\n\t Flag indicating whether or not the queue is idle.\n\t * I.e. there are no remaining messages to processes.\n\t /\n\tidle: boolean;\n\n\t/\n\t Pauses processing on the queue.\n\t \n\t @returns A promise which resolves when processing has been paused.\n\t /\n\tpause(): Promise<void>;\n\n\t/\n\t Resumes processing on the queue\n\t /\n\tresume(): void;\n\n\t/\n\t Peeks at the next message in the queue\n\t /\n\tpeek(): T \| undefined;\n\n\t/\n\t Returns all the items in the queue as an array. Does not remove them from the queue.\n\t /\n\ttoArray(): T[];\n\n\t/\n\t returns number of ops processed and time it took to process these ops.\n\t * Zeros if queue did not process anything (had no messages, was paused or had hit an error before)\n\t /\n\twaitTillProcessingDone(): Promise<{ count: number; duration: number }>;\n}\n\nexport type ReadOnlyInfo =\n\t\| {\n\t\t\treadonly readonly: false \| undefined;\n\t }\n\t\| {\n\t\t\treadonly readonly: true;\n\t\t\t/* read-only because forceReadOnly() was called /\n\t\t\treadonly forced: boolean;\n\t\t\t/* read-only because client does not have write permissions for document /\n\t\t\treadonly permissions: boolean \| undefined;\n\t\t\t/* read-only with no delta stream connection /\n\t\t\treadonly storageOnly: boolean;\n\t\t\t/* extra info on why connection to delta stream is not possible. This info might be provided\n\t\t\t * if storageOnly is set to true */\n\t\t\treadonly storageOnlyReason?: string;\n\t };\n"]}
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 { IEventProvider, IEvent, IErrorEvent } from \"@fluidframework/common-definitions\";\nimport { IDisposable } from \"@fluidframework/core-interfaces\";\nimport { IAnyDriverError } from \"@fluidframework/driver-definitions\";\nimport {\n\tConnectionMode,\n\tIClientConfiguration,\n\tIClientDetails,\n\tIDocumentMessage,\n\tISequencedDocumentMessage,\n\tISignalClient,\n\tISignalMessage,\n\tITokenClaims,\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\tclientId: string;\n\tclaims: ITokenClaims;\n\tserviceConfiguration: IClientConfiguration;\n\n\t/\n\t Last known sequence number to ordering service at the time of connection.\n\t \n\t @remarks\n\t \n\t It may lap actual last sequence number (quite a bit, if container is very active).\n\t * But it's the best information for client to figure out how far it is behind, at least\n\t * for \"read\" connections. \"write\" connections may use own \"join\" op to similar information,\n\t * that is likely to be more up-to-date.\n\t /\n\tcheckpointSequenceNumber: number \| undefined;\n}\n\n/\n Internal version of IConnectionDetails with props are only exposed internally\n * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.\n /\nexport interface IConnectionDetailsInternal extends IConnectionDetails {\n\t/\n\t @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.\n\t /\n\tmode: ConnectionMode;\n\t/\n\t @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.\n\t /\n\tversion: string;\n\t/\n\t @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.\n\t /\n\tinitialClients: ISignalClient[];\n\t/\n\t @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.\n\t /\n\treason: string;\n}\n\n/\n Interface used to define a strategy for handling incoming delta messages\n * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.\n /\nexport interface IDeltaHandlerStrategy {\n\t/\n\t Processes the message.\n\t * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.\n\t /\n\tprocess: (message: ISequencedDocumentMessage) => void;\n\n\t/\n\t Processes the signal.\n\t * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.\n\t /\n\tprocessSignal: (message: ISignalMessage) => void;\n}\n\n/\n Contract supporting delivery of outbound messages to the server\n /\nexport interface IDeltaSender {\n\t/\n\t Flush all pending messages through the outbound queue\n\t /\n\tflush(): void;\n}\n\n/\n Events emitted by {@link IDeltaManager}.\n /\nexport interface IDeltaManagerEvents extends IEvent {\n\t/\n\t @deprecated No replacement API recommended.\n\t /\n\t(event: \"prepareSend\", listener: (messageBuffer: any[]) => void);\n\n\t/\n\t @deprecated No replacement API recommended.\n\t /\n\t(event: \"submitOp\", listener: (message: IDocumentMessage) => void);\n\n\t/\n\t Emitted immediately after processing an incoming operation (op).\n\t \n\t @remarks\n\t \n\t Note: this event is not intended for general use.\n\t * Prefer to listen to events on the appropriate ultimate recipients of the ops, rather than listening to the\n\t * ops directly on the {@link IDeltaManager}.\n\t \n\t Listener parameters:\n\t \n\t - `message`: The op that was processed.\n\t \n\t - `processingTime`: The amount of time it took to process the inbound operation (op), expressed in milliseconds.\n\t /\n\t(event: \"op\", listener: (message: ISequencedDocumentMessage, processingTime: number) => void);\n\n\t/\n\t @deprecated No replacement API recommended.\n\t /\n\t(event: \"allSentOpsAckd\", listener: () => void);\n\n\t/\n\t @deprecated No replacement API recommended.\n\t /\n\t(event: \"pong\", listener: (latency: number) => void);\n\n\t/\n\t @deprecated No replacement API recommended.\n\t /\n\t(event: \"processTime\", listener: (latency: number) => void);\n\n\t/\n\t Emitted when the {@link IDeltaManager} completes connecting to the Fluid service.\n\t \n\t @remarks\n\t * This occurs once we've received the connect_document_success message from the server,\n\t * and happens prior to the client's join message (if there is a join message).\n\t \n\t Listener parameters:\n\t \n\t - `details`: Connection metadata.\n\t \n\t - `opsBehind`: An estimate of far behind the client is relative to the service in terms of ops.\n\t * Will not be specified if an estimate cannot be determined.\n\t /\n\t(event: \"connect\", listener: (details: IConnectionDetails, opsBehind?: number) => void);\n\n\t/\n\t Emitted when the {@link IDeltaManager} becomes disconnected from the Fluid service.\n\t \n\t @remarks Listener parameters:\n\t \n\t - `reason`: Describes the reason for which the delta manager was disconnected.\n\t * - `error` : error if any for the disconnect.\n\t /\n\t(event: \"disconnect\", listener: (reason: string, error?: IAnyDriverError) => void);\n\n\t/\n\t Emitted when read/write permissions change.\n\t \n\t @remarks Listener parameters:\n\t \n\t - `readonly`: Whether or not the delta manager is now read-only.\n\t /\n\t(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>\n\textends IEventProvider<IDeltaManagerEvents>,\n\t\tIDeltaSender,\n\t\tIDisposable {\n\t/* The queue of inbound delta messages /\n\treadonly inbound: IDeltaQueue<T>;\n\n\t/* The queue of outbound delta messages /\n\treadonly outbound: IDeltaQueue<U[]>;\n\n\t/* The queue of inbound delta signals /\n\treadonly inboundSignal: IDeltaQueue<ISignalMessage>;\n\n\t/* The current minimum sequence number /\n\treadonly minimumSequenceNumber: number;\n\n\t/* The last sequence number processed by the delta manager /\n\treadonly lastSequenceNumber: number;\n\n\t/* The last message processed by the delta manager /\n\treadonly lastMessage: ISequencedDocumentMessage \| undefined;\n\n\t/* The latest sequence number the delta manager is aware of /\n\treadonly lastKnownSeqNumber: number;\n\n\t/* The initial sequence number set when attaching the op handler /\n\treadonly initialSequenceNumber: number;\n\n\t/\n\t Tells if current connection has checkpoint information.\n\t * I.e. we know how far behind the client was at the time of establishing connection\n\t /\n\treadonly hasCheckpointSequenceNumber: boolean;\n\n\t/* Details of client /\n\treadonly clientDetails: IClientDetails;\n\n\t/* Protocol version being used to communicate with the service /\n\treadonly version: string;\n\n\t/* Max message size allowed to the delta manager /\n\treadonly maxMessageSize: number;\n\n\t/* Service configuration provided by the service. /\n\treadonly serviceConfiguration: IClientConfiguration \| undefined;\n\n\t/* Flag to indicate whether the client can write or not. /\n\treadonly active: boolean;\n\n\treadonly readOnlyInfo: ReadOnlyInfo;\n\n\t/* Submit a signal to the service to be broadcast to other connected clients, but not persisted /\n\tsubmitSignal(content: any): void;\n}\n\n/\n Events emitted by {@link IDeltaQueue}.\n /\nexport interface IDeltaQueueEvents<T> extends IErrorEvent {\n\t/\n\t Emitted when a task is enqueued.\n\t \n\t @remarks Listener parameters:\n\t \n\t - `task`: The task being enqueued.\n\t /\n\t(event: \"push\", listener: (task: T) => void);\n\n\t/\n\t Emitted immediately after processing an enqueued task and removing it from the queue.\n\t \n\t @remarks\n\t \n\t Note: this event is not intended for general use.\n\t * Prefer to listen to events on the appropriate ultimate recipients of the ops, rather than listening to the\n\t * ops directly on the {@link IDeltaQueue}.\n\t \n\t Listener parameters:\n\t \n\t - `task`: The task that was processed.\n\t /\n\t(event: \"op\", listener: (task: T) => void);\n\n\t/\n\t Emitted when the queue of tasks to process is emptied.\n\t \n\t @remarks Listener parameters:\n\t \n\t - `count`: The number of events (`T`) processed before becoming idle.\n\t \n\t - `duration`: The amount of time it took to process elements (in milliseconds).\n\t \n\t @see {@link IDeltaQueue.idle}\n\t /\n\t(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\t/\n\t Flag indicating whether or not the queue was paused\n\t /\n\tpaused: boolean;\n\n\t/\n\t The number of messages remaining in the queue\n\t /\n\tlength: number;\n\n\t/\n\t Flag indicating whether or not the queue is idle.\n\t * I.e. there are no remaining messages to processes.\n\t /\n\tidle: boolean;\n\n\t/\n\t Pauses processing on the queue.\n\t \n\t @returns A promise which resolves when processing has been paused.\n\t /\n\tpause(): Promise<void>;\n\n\t/\n\t Resumes processing on the queue\n\t /\n\tresume(): void;\n\n\t/\n\t Peeks at the next message in the queue\n\t /\n\tpeek(): T \| undefined;\n\n\t/\n\t Returns all the items in the queue as an array. Does not remove them from the queue.\n\t /\n\ttoArray(): T[];\n\n\t/\n\t returns number of ops processed and time it took to process these ops.\n\t * Zeros if queue did not process anything (had no messages, was paused or had hit an error before)\n\t /\n\twaitTillProcessingDone(): Promise<{ count: number; duration: number }>;\n}\n\nexport type ReadOnlyInfo =\n\t\| {\n\t\t\treadonly readonly: false \| undefined;\n\t }\n\t\| {\n\t\t\treadonly readonly: true;\n\t\t\t/* read-only because forceReadOnly() was called /\n\t\t\treadonly forced: boolean;\n\t\t\t/* read-only because client does not have write permissions for document /\n\t\t\treadonly permissions: boolean \| undefined;\n\t\t\t/* read-only with no delta stream connection /\n\t\t\treadonly storageOnly: boolean;\n\t\t\t/* extra info on why connection to delta stream is not possible. This info might be provided\n\t\t\t * if storageOnly is set to true */\n\t\t\treadonly storageOnlyReason?: string;\n\t };\n"]}

package/lib/runtime.d.ts CHANGED Viewed

@@ -2,8 +2,8 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { ITelemetryBaseLogger, IDisposable } from "@fluidframework/common-definitions";
-import { FluidObject, IRequest, IResponse } from "@fluidframework/core-interfaces";
+import { ITelemetryBaseLogger } from "@fluidframework/common-definitions";
+import { IDisposable, FluidObject, IRequest, IResponse } from "@fluidframework/core-interfaces";
 import { IDocumentStorageService } from "@fluidframework/driver-definitions";
 import { IClientConfiguration, IClientDetails, ISequencedDocumentMessage, ISnapshotTree, MessageType, ISummaryTree, IVersion, IDocumentMessage, IQuorumClients, ISummaryContent } from "@fluidframework/protocol-definitions";
 import { IAudience } from "./audience";
@@ -103,14 +103,11 @@ export interface IBatchMessage {
     referenceSequenceNumber?: number;
 }
 /**
- * The ContainerContext is a proxy standing between the Container and the Container's IRuntime.
- * This allows the Container to terminate the connection to the IRuntime.
- *
- * Specifically, there is an event on Container, onContextChanged, which mean a new code proposal has been loaded,
- * so the old IRuntime is no longer valid, as its ContainerContext has been revoked,
- * and the Container has created a new ContainerContext.
+ * IContainerContext is fundamentally just the set of things that an IRuntimeFactory (and IRuntime) will consume from the
+ * loader layer.  It gets passed into the IRuntimeFactory.instantiateRuntime call.  Only include members on this interface
+ * if you intend them to be consumed/called from the runtime layer.
  */
-export interface IContainerContext extends IDisposable {
+export interface IContainerContext {
     /** @deprecated Please pass in existing directly in instantiateRuntime */
     readonly existing: boolean | undefined;
     readonly options: ILoaderOptions;
@@ -140,6 +137,10 @@ export interface IContainerContext extends IDisposable {
     readonly audience: IAudience | undefined;
     readonly loader: ILoader;
     readonly taggedLogger: ITelemetryBaseLogger;
+    /**
+     * @deprecated - 2.0.0-internal.5.2.0 - This property is redundant, and is unused by the runtime. The same information can be found via
+     * deltaManager.serviceConfiguration on this object if it is necessary.
+     */
     readonly serviceConfiguration: IClientConfiguration | undefined;
     pendingLocalState?: unknown;
     /**
@@ -164,14 +165,21 @@ export interface IContainerContext extends IDisposable {
      * WARNING: this id is meant for telemetry usages ONLY, not recommended for other consumption
      * This id is not supposed to be exposed anywhere else. It is dependant on usage or drivers
      * and scenarios which can change in the future.
+     * @deprecated - 2.0.0-internal.5.2.0 - The docId is already logged by the IContainerContext.taggedLogger for
+     * telemetry purposes, so this is generally unnecessary for telemetry.  If the id is needed for other purposes
+     * it should be passed to the consumer explicitly.  This member will be removed in an upcoming release.
      */
     readonly id: string;
     /**
-     * Proxy for {@link IRuntime.getEntryPoint}, the entryPoint defined in the container's runtime.
-     *
-     * @see {@link IContainer.getEntryPoint}
+     * @deprecated - 2.0.0-internal.5.2.0 - The disposed state on the IContainerContext is not meaningful to the runtime.
+     * This member will be removed in an upcoming release.
      */
-    getEntryPoint?(): Promise<FluidObject | undefined>;
+    readonly disposed: boolean;
+    /**
+     * @deprecated - 2.0.0-internal.5.2.0 - The runtime is not permitted to dispose the IContainerContext, this results
+     * in an inconsistent system state.  This member will be removed in an upcoming release.
+     */
+    dispose(error?: Error): void;
 }
 export declare const IRuntimeFactory: keyof IProvideRuntimeFactory;
 export interface IProvideRuntimeFactory {

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

	@@ -1 +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,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;~~AACnF~~,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,EACN,oBAAoB,EACpB,cAAc,EACd,yBAAyB,EACzB,aAAa,EACb,WAAW,EACX,YAAY,EACZ,QAAQ,EACR,gBAAgB,EAChB,cAAc,EACd,eAAe,EACf,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;IACtB;;;OAGG;IACH,QAAQ,aAAa;IAErB;;OAEG;IACH,SAAS,cAAc;IAEvB;;;OAGG;IACH,QAAQ,aAAa;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,QAAS,SAAQ,WAAW;IAC5C;;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;;;;OAIG;IACH,oBAAoB,IAAI,OAAO,CAAC;IAEhC;;;;OAIG;IACH,eAAe,CAAC,QAAQ,EAAE,6BAA6B,GAAG,IAAI,CAAC;IAE/D;;;OAGG;IACH,cAAc,CAAC,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnE;;;;;;;;OAQG;IACH,aAAa,CAAC,IAAI,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,CAAC;CACnD;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uBAAuB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED~~;;;;;;;GAOG~~;AACH,MAAM,WAAW,~~iBAAkB,SAAQ,WAAW~~;~~IACrD~~,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,EAAE,uBAAuB,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;IAC7F,QAAQ,CAAC,eAAe,EAAE,CACzB,SAAS,EAAE,eAAe,EAC1B,uBAAuB,CAAC,EAAE,MAAM,KAC5B,MAAM,CAAC;IACZ,QAAQ,CAAC,cAAc,EAAE,CAAC,QAAQ,EAAE,GAAG,KAAK,IAAI,CAAC;IACjD,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,uBAAuB,KAAK,IAAI,CAAC;IAC/D,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;IAEhD,QAAQ,CAAC,iBAAiB,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE1D~~;;;;OAIG~~;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB~~;;;;OAIG~~;IACH,~~aAAa~~,CAAC,~~IAAI~~,OAAO,CAAC,~~WAAW~~,~~GAAG~~,~~SAAS~~,CAAC,CAAC;~~CACnD~~;AAED,eAAO,MAAM,eAAe,EAAE,MAAM,sBAA0C,CAAC;AAE/E,MAAM,WAAW,sBAAsB;IACtC,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;CAC1C;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAgB,SAAQ,sBAAsB;IAC9D;;;;;;OAMG;IACH,kBAAkB,CAAC,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CACrF"}
1	+ {"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AAChG,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,EACN,oBAAoB,EACpB,cAAc,EACd,yBAAyB,EACzB,aAAa,EACb,WAAW,EACX,YAAY,EACZ,QAAQ,EACR,gBAAgB,EAChB,cAAc,EACd,eAAe,EACf,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;IACtB;;;OAGG;IACH,QAAQ,aAAa;IAErB;;OAEG;IACH,SAAS,cAAc;IAEvB;;;OAGG;IACH,QAAQ,aAAa;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,QAAS,SAAQ,WAAW;IAC5C;;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;;;;OAIG;IACH,oBAAoB,IAAI,OAAO,CAAC;IAEhC;;;;OAIG;IACH,eAAe,CAAC,QAAQ,EAAE,6BAA6B,GAAG,IAAI,CAAC;IAE/D;;;OAGG;IACH,cAAc,CAAC,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnE;;;;;;;;OAQG;IACH,aAAa,CAAC,IAAI,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,CAAC;CACnD;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uBAAuB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IACjC,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,EAAE,uBAAuB,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;IAC7F,QAAQ,CAAC,eAAe,EAAE,CACzB,SAAS,EAAE,eAAe,EAC1B,uBAAuB,CAAC,EAAE,MAAM,KAC5B,MAAM,CAAC;IACZ,QAAQ,CAAC,cAAc,EAAE,CAAC,QAAQ,EAAE,GAAG,KAAK,IAAI,CAAC;IACjD,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,uBAAuB,KAAK,IAAI,CAAC;IAC/D,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;;;OAGG;IACH,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;IAEhD,QAAQ,CAAC,iBAAiB,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE1D;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B;;;OAGG;IACH,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;CAC7B;AAED,eAAO,MAAM,eAAe,EAAE,MAAM,sBAA0C,CAAC;AAE/E,MAAM,WAAW,sBAAsB;IACtC,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;CAC1C;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAgB,SAAQ,sBAAsB;IAC9D;;;;;;OAMG;IACH,kBAAkB,CAAC,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CACrF"}

package/lib/runtime.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"runtime.js","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAuBH;;;GAGG;AACH,MAAM,CAAN,IAAY,WAiBX;AAjBD,WAAY,WAAW;IACtB;;;OAGG;IACH,oCAAqB,CAAA;IAErB;;OAEG;IACH,sCAAuB,CAAA;IAEvB;;;OAGG;IACH,oCAAqB,CAAA;AACtB,CAAC,EAjBW,WAAW,KAAX,WAAW,QAiBtB;AAwKD,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 { FluidObject, IRequest, IResponse } from \"@fluidframework/core-interfaces\";\nimport { IDocumentStorageService } from \"@fluidframework/driver-definitions\";\nimport {\n\tIClientConfiguration,\n\tIClientDetails,\n\tISequencedDocumentMessage,\n\tISnapshotTree,\n\tMessageType,\n\tISummaryTree,\n\tIVersion,\n\tIDocumentMessage,\n\tIQuorumClients,\n\tISummaryContent,\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\t/\n\t In detached state, the data is only present on the local client's machine. It has not yet been uploaded\n\t * to the service.\n\t /\n\tDetached = \"Detached\",\n\n\t/\n\t In attaching state, the data has started the upload to the service, but has not yet completed.\n\t /\n\tAttaching = \"Attaching\",\n\n\t/\n\t In attached state, the data has completed upload to the service. It can be accessed by other clients after\n\t * reaching attached state.\n\t /\n\tAttached = \"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\t/\n\t Executes a request against the runtime\n\t /\n\trequest(request: IRequest): Promise<IResponse>;\n\n\t/\n\t Notifies the runtime of a change in the connection state\n\t /\n\tsetConnectionState(connected: boolean, clientId?: string);\n\n\t/\n\t Processes the given op (message)\n\t /\n\tprocess(message: ISequencedDocumentMessage, local: boolean);\n\n\t/\n\t Processes the given signal\n\t /\n\tprocessSignal(message: any, local: boolean);\n\n\t/\n\t Create a summary. Used when attaching or serializing a detached container.\n\t \n\t @param blobRedirectTable - A table passed during the attach process. While detached, blob upload is supported\n\t * using IDs generated locally. After attach, these IDs cannot be used, so this table maps the old local IDs to the\n\t * new storage IDs so requests can be redirected.\n\t /\n\tcreateSummary(blobRedirectTable?: Map<string, string>): ISummaryTree;\n\n\t/\n\t Propagate the container state when container is attaching or attached.\n\t * @param attachState - State of the container.\n\t /\n\tsetAttachState(attachState: AttachState.Attaching \| AttachState.Attached): void;\n\n\t/\n\t Get pending local state in a serializable format to be given back to a newly loaded container\n\t * @experimental\n\t * {@link https://github.com/microsoft/FluidFramework/packages/tree/main/loader/container-loader/closeAndGetPendingLocalState.md}\n\t /\n\tgetPendingLocalState(): unknown;\n\n\t/\n\t Notify runtime that container is moving to \"Attaching\" state\n\t * @param snapshot - snapshot created at attach time\n\t * @deprecated - not necessary after op replay moved to Container\n\t /\n\tnotifyAttaching(snapshot: ISnapshotTreeWithBlobContents): void;\n\n\t/\n\t Notify runtime that we have processed a saved message, so that it can do async work (applying\n\t * stashed ops) after having processed it.\n\t /\n\tnotifyOpReplay?(message: ISequencedDocumentMessage): Promise<void>;\n\n\t/\n\t Exposes the entryPoint for the container runtime.\n\t * Use this as the primary way of getting access to the user-defined logic within the container runtime.\n\t \n\t @see {@link IContainer.getEntryPoint}\n\t \n\t @remarks The plan is that eventually IRuntime will no longer have a request() method, this method will no\n\t * longer be optional, and it will become the only way to access the entryPoint for the runtime.\n\t /\n\tgetEntryPoint?(): Promise<FluidObject \| undefined>;\n}\n\n/\n Payload type for IContainerContext.submitBatchFn()\n /\nexport interface IBatchMessage {\n\tcontents?: string;\n\tmetadata: Record<string, unknown> \| undefined;\n\tcompression?: string;\n\treferenceSequenceNumber?: number;\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\t/* @deprecated Please pass in existing directly in instantiateRuntime /\n\treadonly existing: boolean \| undefined;\n\treadonly options: ILoaderOptions;\n\treadonly clientId: string \| undefined;\n\treadonly clientDetails: IClientDetails;\n\treadonly storage: IDocumentStorageService;\n\treadonly connected: boolean;\n\treadonly baseSnapshot: ISnapshotTree \| undefined;\n\t/* @deprecated Please use submitBatchFn & submitSummaryFn /\n\treadonly submitFn: (type: MessageType, contents: any, batch: boolean, appData?: any) => number;\n\t/* @returns clientSequenceNumber of last message in a batch /\n\treadonly submitBatchFn: (batch: IBatchMessage[], referenceSequenceNumber?: number) => number;\n\treadonly submitSummaryFn: (\n\t\tsummaryOp: ISummaryContent,\n\t\treferenceSequenceNumber?: number,\n\t) => number;\n\treadonly submitSignalFn: (contents: any) => void;\n\treadonly disposeFn?: (error?: ICriticalContainerError) => void;\n\treadonly closeFn: (error?: ICriticalContainerError) => void;\n\treadonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;\n\treadonly quorum: IQuorumClients;\n\t/\n\t @deprecated This method is provided as a migration tool for customers currently reading the code details\n\t * from within the Container by directly accessing the Quorum proposals. The code details should not be accessed\n\t * from within the Container as this requires coupling between the container contents and the code loader.\n\t * Direct access to Quorum proposals will be removed in an upcoming release, and in a further future release this\n\t * migration tool will be removed.\n\t /\n\tgetSpecifiedCodeDetails?(): IFluidCodeDetails \| undefined;\n\treadonly audience: IAudience \| undefined;\n\treadonly loader: ILoader;\n\t// The logger implementation, which would support tagged events, should be provided by the loader.\n\treadonly taggedLogger: ITelemetryBaseLogger;\n\treadonly serviceConfiguration: IClientConfiguration \| undefined;\n\tpendingLocalState?: unknown;\n\n\t/\n\t Ambient services provided with the context\n\t /\n\treadonly scope: FluidObject;\n\n\t/\n\t Get an absolute url for a provided container-relative request.\n\t * @param relativeUrl - A relative request within the container\n\t \n\t TODO: Optional for backwards compatibility. Make non-optional in version 0.19\n\t /\n\tgetAbsoluteUrl?(relativeUrl: string): Promise<string \| undefined>;\n\n\t/\n\t Indicates the attachment state of the container to a host service.\n\t /\n\treadonly attachState: AttachState;\n\n\tgetLoadedFromVersion(): IVersion \| undefined;\n\n\tupdateDirtyContainerState(dirty: boolean): void;\n\n\treadonly supportedFeatures?: ReadonlyMap<string, unknown>;\n\n\t/\n\t WARNING: this id is meant for telemetry usages ONLY, not recommended for other consumption\n\t * This id is not supposed to be exposed anywhere else. It is dependant on usage or drivers\n\t * and scenarios which can change in the future.\n\t /\n\treadonly id: string;\n\n\t/\n\t Proxy for {@link IRuntime.getEntryPoint}, the entryPoint defined in the container's runtime.\n\t \n\t @see {@link IContainer.getEntryPoint}\n\t /\n\tgetEntryPoint?(): Promise<FluidObject \| undefined>;\n}\n\nexport const IRuntimeFactory: keyof IProvideRuntimeFactory = \"IRuntimeFactory\";\n\nexport interface IProvideRuntimeFactory {\n\treadonly 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\t/\n\t Instantiates a new IRuntime for the given IContainerContext to proxy to\n\t * This is the main entry point to the Container's business logic\n\t \n\t @param context - container context to be supplied to the runtime\n\t * @param existing - whether to instantiate for the first time or from an existing context\n\t */\n\tinstantiateRuntime(context: IContainerContext, existing: boolean): Promise<IRuntime>;\n}\n"]}
1	+ {"version":3,"file":"runtime.js","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAuBH;;;GAGG;AACH,MAAM,CAAN,IAAY,WAiBX;AAjBD,WAAY,WAAW;IACtB;;;OAGG;IACH,oCAAqB,CAAA;IAErB;;OAEG;IACH,sCAAuB,CAAA;IAEvB;;;OAGG;IACH,oCAAqB,CAAA;AACtB,CAAC,EAjBW,WAAW,KAAX,WAAW,QAiBtB;AAgLD,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 } from \"@fluidframework/common-definitions\";\nimport { IDisposable, FluidObject, IRequest, IResponse } from \"@fluidframework/core-interfaces\";\nimport { IDocumentStorageService } from \"@fluidframework/driver-definitions\";\nimport {\n\tIClientConfiguration,\n\tIClientDetails,\n\tISequencedDocumentMessage,\n\tISnapshotTree,\n\tMessageType,\n\tISummaryTree,\n\tIVersion,\n\tIDocumentMessage,\n\tIQuorumClients,\n\tISummaryContent,\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\t/\n\t In detached state, the data is only present on the local client's machine. It has not yet been uploaded\n\t * to the service.\n\t /\n\tDetached = \"Detached\",\n\n\t/\n\t In attaching state, the data has started the upload to the service, but has not yet completed.\n\t /\n\tAttaching = \"Attaching\",\n\n\t/\n\t In attached state, the data has completed upload to the service. It can be accessed by other clients after\n\t * reaching attached state.\n\t /\n\tAttached = \"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\t/\n\t Executes a request against the runtime\n\t /\n\trequest(request: IRequest): Promise<IResponse>;\n\n\t/\n\t Notifies the runtime of a change in the connection state\n\t /\n\tsetConnectionState(connected: boolean, clientId?: string);\n\n\t/\n\t Processes the given op (message)\n\t /\n\tprocess(message: ISequencedDocumentMessage, local: boolean);\n\n\t/\n\t Processes the given signal\n\t /\n\tprocessSignal(message: any, local: boolean);\n\n\t/\n\t Create a summary. Used when attaching or serializing a detached container.\n\t \n\t @param blobRedirectTable - A table passed during the attach process. While detached, blob upload is supported\n\t * using IDs generated locally. After attach, these IDs cannot be used, so this table maps the old local IDs to the\n\t * new storage IDs so requests can be redirected.\n\t /\n\tcreateSummary(blobRedirectTable?: Map<string, string>): ISummaryTree;\n\n\t/\n\t Propagate the container state when container is attaching or attached.\n\t * @param attachState - State of the container.\n\t /\n\tsetAttachState(attachState: AttachState.Attaching \| AttachState.Attached): void;\n\n\t/\n\t Get pending local state in a serializable format to be given back to a newly loaded container\n\t * @experimental\n\t * {@link https://github.com/microsoft/FluidFramework/packages/tree/main/loader/container-loader/closeAndGetPendingLocalState.md}\n\t /\n\tgetPendingLocalState(): unknown;\n\n\t/\n\t Notify runtime that container is moving to \"Attaching\" state\n\t * @param snapshot - snapshot created at attach time\n\t * @deprecated - not necessary after op replay moved to Container\n\t /\n\tnotifyAttaching(snapshot: ISnapshotTreeWithBlobContents): void;\n\n\t/\n\t Notify runtime that we have processed a saved message, so that it can do async work (applying\n\t * stashed ops) after having processed it.\n\t /\n\tnotifyOpReplay?(message: ISequencedDocumentMessage): Promise<void>;\n\n\t/\n\t Exposes the entryPoint for the container runtime.\n\t * Use this as the primary way of getting access to the user-defined logic within the container runtime.\n\t \n\t @see {@link IContainer.getEntryPoint}\n\t \n\t @remarks The plan is that eventually IRuntime will no longer have a request() method, this method will no\n\t * longer be optional, and it will become the only way to access the entryPoint for the runtime.\n\t /\n\tgetEntryPoint?(): Promise<FluidObject \| undefined>;\n}\n\n/\n Payload type for IContainerContext.submitBatchFn()\n /\nexport interface IBatchMessage {\n\tcontents?: string;\n\tmetadata: Record<string, unknown> \| undefined;\n\tcompression?: string;\n\treferenceSequenceNumber?: number;\n}\n\n/\n IContainerContext is fundamentally just the set of things that an IRuntimeFactory (and IRuntime) will consume from the\n * loader layer. It gets passed into the IRuntimeFactory.instantiateRuntime call. Only include members on this interface\n * if you intend them to be consumed/called from the runtime layer.\n /\nexport interface IContainerContext {\n\t/* @deprecated Please pass in existing directly in instantiateRuntime /\n\treadonly existing: boolean \| undefined;\n\treadonly options: ILoaderOptions;\n\treadonly clientId: string \| undefined;\n\treadonly clientDetails: IClientDetails;\n\treadonly storage: IDocumentStorageService;\n\treadonly connected: boolean;\n\treadonly baseSnapshot: ISnapshotTree \| undefined;\n\t/* @deprecated Please use submitBatchFn & submitSummaryFn /\n\treadonly submitFn: (type: MessageType, contents: any, batch: boolean, appData?: any) => number;\n\t/* @returns clientSequenceNumber of last message in a batch /\n\treadonly submitBatchFn: (batch: IBatchMessage[], referenceSequenceNumber?: number) => number;\n\treadonly submitSummaryFn: (\n\t\tsummaryOp: ISummaryContent,\n\t\treferenceSequenceNumber?: number,\n\t) => number;\n\treadonly submitSignalFn: (contents: any) => void;\n\treadonly disposeFn?: (error?: ICriticalContainerError) => void;\n\treadonly closeFn: (error?: ICriticalContainerError) => void;\n\treadonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;\n\treadonly quorum: IQuorumClients;\n\t/\n\t @deprecated This method is provided as a migration tool for customers currently reading the code details\n\t * from within the Container by directly accessing the Quorum proposals. The code details should not be accessed\n\t * from within the Container as this requires coupling between the container contents and the code loader.\n\t * Direct access to Quorum proposals will be removed in an upcoming release, and in a further future release this\n\t * migration tool will be removed.\n\t /\n\tgetSpecifiedCodeDetails?(): IFluidCodeDetails \| undefined;\n\treadonly audience: IAudience \| undefined;\n\treadonly loader: ILoader;\n\t// The logger implementation, which would support tagged events, should be provided by the loader.\n\treadonly taggedLogger: ITelemetryBaseLogger;\n\t/\n\t @deprecated - 2.0.0-internal.5.2.0 - This property is redundant, and is unused by the runtime. The same information can be found via\n\t * deltaManager.serviceConfiguration on this object if it is necessary.\n\t /\n\treadonly serviceConfiguration: IClientConfiguration \| undefined;\n\tpendingLocalState?: unknown;\n\n\t/\n\t Ambient services provided with the context\n\t /\n\treadonly scope: FluidObject;\n\n\t/\n\t Get an absolute url for a provided container-relative request.\n\t * @param relativeUrl - A relative request within the container\n\t \n\t TODO: Optional for backwards compatibility. Make non-optional in version 0.19\n\t /\n\tgetAbsoluteUrl?(relativeUrl: string): Promise<string \| undefined>;\n\n\t/\n\t Indicates the attachment state of the container to a host service.\n\t /\n\treadonly attachState: AttachState;\n\n\tgetLoadedFromVersion(): IVersion \| undefined;\n\n\tupdateDirtyContainerState(dirty: boolean): void;\n\n\treadonly supportedFeatures?: ReadonlyMap<string, unknown>;\n\n\t/\n\t WARNING: this id is meant for telemetry usages ONLY, not recommended for other consumption\n\t * This id is not supposed to be exposed anywhere else. It is dependant on usage or drivers\n\t * and scenarios which can change in the future.\n\t * @deprecated - 2.0.0-internal.5.2.0 - The docId is already logged by the IContainerContext.taggedLogger for\n\t * telemetry purposes, so this is generally unnecessary for telemetry. If the id is needed for other purposes\n\t * it should be passed to the consumer explicitly. This member will be removed in an upcoming release.\n\t /\n\treadonly id: string;\n\n\t/\n\t @deprecated - 2.0.0-internal.5.2.0 - The disposed state on the IContainerContext is not meaningful to the runtime.\n\t * This member will be removed in an upcoming release.\n\t /\n\treadonly disposed: boolean;\n\t/\n\t @deprecated - 2.0.0-internal.5.2.0 - The runtime is not permitted to dispose the IContainerContext, this results\n\t * in an inconsistent system state. This member will be removed in an upcoming release.\n\t /\n\tdispose(error?: Error): void;\n}\n\nexport const IRuntimeFactory: keyof IProvideRuntimeFactory = \"IRuntimeFactory\";\n\nexport interface IProvideRuntimeFactory {\n\treadonly 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\t/\n\t Instantiates a new IRuntime for the given IContainerContext to proxy to\n\t * This is the main entry point to the Container's business logic\n\t \n\t @param context - container context to be supplied to the runtime\n\t * @param existing - whether to instantiate for the first time or from an existing context\n\t */\n\tinstantiateRuntime(context: IContainerContext, existing: boolean): Promise<IRuntime>;\n}\n"]}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-definitions",
-  "version": "2.0.0-internal.5.1.0",
+  "version": "2.0.0-internal.5.2.0",
   "description": "Fluid container definitions",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -16,15 +16,15 @@
   "types": "dist/index.d.ts",
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/core-interfaces": ">=2.0.0-internal.5.1.0 <2.0.0-internal.5.2.0",
-    "@fluidframework/driver-definitions": ">=2.0.0-internal.5.1.0 <2.0.0-internal.5.2.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-internal.5.2.0 <2.0.0-internal.5.3.0",
+    "@fluidframework/driver-definitions": ">=2.0.0-internal.5.2.0 <2.0.0-internal.5.3.0",
     "@fluidframework/protocol-definitions": "^1.1.0",
     "events": "^3.1.0"
   },
   "devDependencies": {
-    "@fluid-tools/build-cli": "^0.19.0",
+    "@fluid-tools/build-cli": "^0.20.0",
     "@fluidframework/build-common": "^1.2.0",
-    "@fluidframework/build-tools": "^0.19.0",
+    "@fluidframework/build-tools": "^0.20.0",
     "@fluidframework/container-definitions-previous": "npm:@fluidframework/container-definitions@2.0.0-internal.5.0.0",
     "@fluidframework/eslint-config-fluid": "^2.0.0",
     "@microsoft/api-extractor": "^7.34.4",

package/src/deltas.ts CHANGED Viewed

@@ -3,12 +3,8 @@
  * Licensed under the MIT License.
  */
-import {
-	IDisposable,
-	IEventProvider,
-	IEvent,
-	IErrorEvent,
-} from "@fluidframework/common-definitions";
+import { IEventProvider, IEvent, IErrorEvent } from "@fluidframework/common-definitions";
+import { IDisposable } from "@fluidframework/core-interfaces";
 import { IAnyDriverError } from "@fluidframework/driver-definitions";
 import {
 	ConnectionMode,
@@ -44,25 +40,41 @@ export interface IConnectionDetails {
 /**
  * Internal version of IConnectionDetails with props are only exposed internally
+ * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.
  */
 export interface IConnectionDetailsInternal extends IConnectionDetails {
+	/**
+	 * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.
+	 */
 	mode: ConnectionMode;
+	/**
+	 * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.
+	 */
 	version: string;
+	/**
+	 * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.
+	 */
 	initialClients: ISignalClient[];
+	/**
+	 * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.
+	 */
 	reason: string;
 }
 /**
  * Interface used to define a strategy for handling incoming delta messages
+ * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.
  */
 export interface IDeltaHandlerStrategy {
 	/**
 	 * Processes the message.
+	 * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.
 	 */
 	process: (message: ISequencedDocumentMessage) => void;
 	/**
 	 * Processes the signal.
+	 * @deprecated 2.0.0-internal.5.2.0 - Intended for internal use only and will be removed in an upcoming relase.
 	 */
 	processSignal: (message: ISignalMessage) => void;
 }

package/src/runtime.ts CHANGED Viewed

@@ -3,8 +3,8 @@
  * Licensed under the MIT License.
  */
-import { ITelemetryBaseLogger, IDisposable } from "@fluidframework/common-definitions";
-import { FluidObject, IRequest, IResponse } from "@fluidframework/core-interfaces";
+import { ITelemetryBaseLogger } from "@fluidframework/common-definitions";
+import { IDisposable, FluidObject, IRequest, IResponse } from "@fluidframework/core-interfaces";
 import { IDocumentStorageService } from "@fluidframework/driver-definitions";
 import {
 	IClientConfiguration,
@@ -130,14 +130,11 @@ export interface IBatchMessage {
 }
 /**
- * The ContainerContext is a proxy standing between the Container and the Container's IRuntime.
- * This allows the Container to terminate the connection to the IRuntime.
- *
- * Specifically, there is an event on Container, onContextChanged, which mean a new code proposal has been loaded,
- * so the old IRuntime is no longer valid, as its ContainerContext has been revoked,
- * and the Container has created a new ContainerContext.
+ * IContainerContext is fundamentally just the set of things that an IRuntimeFactory (and IRuntime) will consume from the
+ * loader layer.  It gets passed into the IRuntimeFactory.instantiateRuntime call.  Only include members on this interface
+ * if you intend them to be consumed/called from the runtime layer.
  */
-export interface IContainerContext extends IDisposable {
+export interface IContainerContext {
 	/** @deprecated Please pass in existing directly in instantiateRuntime */
 	readonly existing: boolean | undefined;
 	readonly options: ILoaderOptions;
@@ -171,6 +168,10 @@ export interface IContainerContext extends IDisposable {
 	readonly loader: ILoader;
 	// The logger implementation, which would support tagged events, should be provided by the loader.
 	readonly taggedLogger: ITelemetryBaseLogger;
+	/**
+	 * @deprecated - 2.0.0-internal.5.2.0 - This property is redundant, and is unused by the runtime. The same information can be found via
+	 * deltaManager.serviceConfiguration on this object if it is necessary.
+	 */
 	readonly serviceConfiguration: IClientConfiguration | undefined;
 	pendingLocalState?: unknown;
@@ -202,15 +203,22 @@ export interface IContainerContext extends IDisposable {
 	 * WARNING: this id is meant for telemetry usages ONLY, not recommended for other consumption
 	 * This id is not supposed to be exposed anywhere else. It is dependant on usage or drivers
 	 * and scenarios which can change in the future.
+	 * @deprecated - 2.0.0-internal.5.2.0 - The docId is already logged by the IContainerContext.taggedLogger for
+	 * telemetry purposes, so this is generally unnecessary for telemetry.  If the id is needed for other purposes
+	 * it should be passed to the consumer explicitly.  This member will be removed in an upcoming release.
 	 */
 	readonly id: string;
 	/**
-	 * Proxy for {@link IRuntime.getEntryPoint}, the entryPoint defined in the container's runtime.
-	 *
-	 * @see {@link IContainer.getEntryPoint}
+	 * @deprecated - 2.0.0-internal.5.2.0 - The disposed state on the IContainerContext is not meaningful to the runtime.
+	 * This member will be removed in an upcoming release.
 	 */
-	getEntryPoint?(): Promise<FluidObject | undefined>;
+	readonly disposed: boolean;
+	/**
+	 * @deprecated - 2.0.0-internal.5.2.0 - The runtime is not permitted to dispose the IContainerContext, this results
+	 * in an inconsistent system state.  This member will be removed in an upcoming release.
+	 */
+	dispose(error?: Error): void;
 }
 export const IRuntimeFactory: keyof IProvideRuntimeFactory = "IRuntimeFactory";