@fluidframework/shared-object-base 2.33.1 → 2.40.0-336023

package/api-report/shared-object-base.legacy.alpha.api.md

@@ -39,7 +39,8 @@ export function parseHandles(value: unknown, serializer: IFluidSerializer): unkn
 
 // @alpha @legacy
 export abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents> extends SharedObjectCore<TEvent> {
-    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, telemetryContextPrefix: string);
+    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes,
+    telemetryContextPrefix: string);
     getAttachSummary(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
     getGCData(fullGC?: boolean): IGarbageCollectionData;
     protected processGCDataCore(serializer: IFluidSerializer): void;
@@ -51,9 +52,11 @@ export abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedO
 
 // @alpha @legacy
 export abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISharedObjectEvents> extends EventEmitterWithErrorHandling<TEvent> implements ISharedObject<TEvent> {
-    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
+    constructor(
+    id: string,
+    runtime: IFluidDataStoreRuntime,
+    attributes: IChannelAttributes);
     protected abstract applyStashedOp(content: unknown): void;
-    // (undocumented)
     readonly attributes: IChannelAttributes;
     bindToContext(): void;
     connect(services: IChannelServices): void;
@@ -65,7 +68,6 @@ export abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISha
     abstract getAttachSummary(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
     abstract getGCData(fullGC?: boolean): IGarbageCollectionData;
     readonly handle: IFluidHandleInternal;
-    // (undocumented)
     id: string;
     // (undocumented)
     get IFluidLoadable(): this;
@@ -83,7 +85,6 @@ export abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISha
     protected processMessagesCore?(messagesCollection: IRuntimeMessageCollection): void;
     protected reSubmitCore(content: unknown, localOpMetadata: unknown): void;
     protected rollback(content: unknown, localOpMetadata: unknown): void;
-    // (undocumented)
     protected runtime: IFluidDataStoreRuntime;
     protected abstract get serializer(): IFluidSerializer;
     protected submitLocalMessage(content: unknown, localOpMetadata?: unknown): void;

package/dist/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/shared-object-base";
-export declare const pkgVersion = "2.33.1";
+export declare const pkgVersion = "2.40.0-336023";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,uCAAuC,CAAC;AAC5D,eAAO,MAAM,UAAU,WAAW,CAAC"}
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,uCAAuC,CAAC;AAC5D,eAAO,MAAM,UAAU,kBAAkB,CAAC"}

package/dist/packageVersion.js

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/shared-object-base";
-exports.pkgVersion = "2.33.1";
+exports.pkgVersion = "2.40.0-336023";
 //# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,oCAAoC,CAAC;AAC/C,QAAA,UAAU,GAAG,QAAQ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/shared-object-base\";\nexport const pkgVersion = \"2.33.1\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,oCAAoC,CAAC;AAC/C,QAAA,UAAU,GAAG,eAAe,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/shared-object-base\";\nexport const pkgVersion = \"2.40.0-336023\";\n"]}

package/dist/sharedObject.d.ts

@@ -13,13 +13,33 @@ import { ITelemetryLoggerExt, EventEmitterWithErrorHandling } from "@fluidframew
 import { IFluidSerializer } from "./serializer.js";
 import { ISharedObject, ISharedObjectEvents } from "./types.js";
 /**
- * Base class from which all shared objects derive.
+ * Base class from which all {@link ISharedObject|shared objects} derive.
+ * @remarks
+ * This class implements common behaviors that implementations of {@link ISharedObject} may want to reuse.
+ * Even more such behaviors are implemented in the {@link SharedObject} class.
+ * @privateRemarks
+ * Currently some documentation (like the above) implies that this is supposed to be the only implementation of ISharedObject, which is both package-exported and not `@sealed`.
+ * This situation should be clarified to indicate if other implementations of ISharedObject are allowed and just currently don't exist,
+ * or if the intention is that no other implementations should exist and creating some might break things.
+ * As part of this, any existing implementations of ISharedObject (via SharedObjectCore or otherwise) in use by legacy API users will need to be considered.
+ *
+ * TODO:
+ * This class should eventually be made internal, as custom subclasses of it outside this repository are intended to be made unsupported in the future.
  * @legacy
  * @alpha
  */
 export declare abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISharedObjectEvents> extends EventEmitterWithErrorHandling<TEvent> implements ISharedObject<TEvent> {
+    /**
+     * The ID of the shared object.
+     */
     id: string;
+    /**
+     * The runtime instance that contains the Shared Object.
+     */
     protected runtime: IFluidDataStoreRuntime;
+    /**
+     * The attributes of the Shared Object.
+     */
     readonly attributes: IChannelAttributes;
     get IFluidLoadable(): this;
     private readonly opProcessingHelper;
@@ -54,12 +74,19 @@ export declare abstract class SharedObjectCore<TEvent extends ISharedObjectEvent
      * @returns The state of the connection
      */
     get connected(): boolean;
+    constructor(
     /**
-     * @param id - The id of the shared object
-     * @param runtime - The IFluidDataStoreRuntime which contains the shared object
-     * @param attributes - Attributes of the shared object
+     * The ID of the shared object.
      */
-    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
+    id: string, 
+    /**
+     * The runtime instance that contains the Shared Object.
+     */
+    runtime: IFluidDataStoreRuntime, 
+    /**
+     * The attributes of the Shared Object.
+     */
+    attributes: IChannelAttributes);
     /**
      * Accessor for `this.runtime`'s {@link @fluidframework/datastore-definitions#IFluidDataStoreRuntime.deltaManager} as a {@link @fluidframework/container-definitions/internal#IDeltaManager}
      */
@@ -295,12 +322,21 @@ export declare abstract class SharedObjectCore<TEvent extends ISharedObjectEvent
     private emitInternal;
 }
 /**
- * SharedObject with simplified, synchronous summarization and GC.
- * DDS implementations with async and incremental summarization should extend SharedObjectCore directly instead.
+ * Helper for implementing {@link ISharedObject} with simplified, synchronous summarization and garbage collection.
+ * @remarks
+ * DDS implementations with async and incremental summarization should extend {@link SharedObjectCore} directly instead.
+ * @privateRemarks
+ * TODO:
+ * This class is badly named.
+ * Once it becomes `@internal` "SharedObjectCore" should probably become "SharedObject"
+ * and this class should be renamed to something like "SharedObjectSynchronous".
  * @legacy
  * @alpha
  */
 export declare abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents> extends SharedObjectCore<TEvent> {
+    /**
+     * The prefix to use for telemetry events emitted by this object.
+     */
     private readonly telemetryContextPrefix;
     /**
      * True while we are garbage collecting this object's data.
@@ -311,12 +347,11 @@ export declare abstract class SharedObject<TEvent extends ISharedObjectEvents =
      */
     private readonly _serializer;
     protected get serializer(): IFluidSerializer;
+    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, 
     /**
-     * @param id - The id of the shared object
-     * @param runtime - The IFluidDataStoreRuntime which contains the shared object
-     * @param attributes - Attributes of the shared object
+     * The prefix to use for telemetry events emitted by this object.
      */
-    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, telemetryContextPrefix: string);
+    telemetryContextPrefix: string);
     /**
      * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}
      */

package/dist/sharedObject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sharedObject.d.ts","sourceRoot":"","sources":["../src/sharedObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAErE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gDAAgD,CAAC;AACpF,OAAO,EAA4B,KAAK,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC5F,OAAO,EACN,KAAK,oBAAoB,EACzB,KAAK,cAAc,EACnB,MAAM,0CAA0C,CAAC;AAElD,OAAO,EACN,gBAAgB,EAChB,sBAAsB,EAEtB,kBAAkB,EAClB,KAAK,eAAe,EACpB,sBAAsB,EAGtB,MAAM,gDAAgD,CAAC;AACxD,OAAO,EACN,KAAK,gBAAgB,EACrB,yBAAyB,EACzB,MAAM,6CAA6C,CAAC;AACrD,OAAO,EACN,sCAAsC,EACtC,qBAAqB,EACrB,iBAAiB,EACjB,sBAAsB,EAGtB,KAAK,yBAAyB,EAE9B,MAAM,8CAA8C,CAAC;AAKtD,OAAO,EACN,mBAAmB,EAEnB,6BAA6B,EAQ7B,MAAM,0CAA0C,CAAC;AAKlD,OAAO,EAAmB,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAYhE;;;;GAIG;AACH,8BAAsB,gBAAgB,CACpC,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,CAEzD,SAAQ,6BAA6B,CAAC,MAAM,CAC5C,YAAW,aAAa,CAAC,MAAM,CAAC;IAyDxB,EAAE,EAAE,MAAM;IACjB,SAAS,CAAC,OAAO,EAAE,sBAAsB;aACzB,UAAU,EAAE,kBAAkB;IAzD/C,IAAW,cAAc,IAAI,IAAI,CAEhC;IAED,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAGjC;IACF,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAkC;IAElE;;OAEG;IACH,SAAgB,MAAM,EAAE,oBAAoB,CAAC;IAE7C;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;IAC/C,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAoB;IAEvC;;OAEG;IACH,OAAO,CAAC,UAAU,CAAS;IAE3B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAA+B;IAE/C;;OAEG;IACH,OAAO,CAAC,iBAAiB,CAAkB;IAE3C;;OAEG;IACH,OAAO,CAAC,UAAU,CAAC,CAA4D;IAE/E;;;OAGG;IACH,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED;;;;OAIG;gBAEK,EAAE,EAAE,MAAM,EACP,OAAO,EAAE,sBAAsB,EACzB,UAAU,EAAE,kBAAkB;IA0C/C;;OAEG;IACH,SAAS,KAAK,YAAY,IAAI,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,CAEvF;IAED;;;;;OAKG;IACH,OAAO,CAAC,4BAA4B;IAuCpC;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAMtB;;OAEG;IACH,OAAO,CAAC,eAAe;IAMvB;;;;;;;;;OASG;IACH,OAAO,CAAC,yBAAyB;IAWjC,OAAO,CAAC,uBAAuB;IAmB/B;;;;OAIG;IACU,IAAI,CAAC,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAU5D;;;OAGG;IACI,eAAe,IAAI,IAAI;IAI9B;;OAEG;IACI,aAAa,IAAI,IAAI;IAY5B;;OAEG;IACI,OAAO,CAAC,QAAQ,EAAE,gBAAgB,GAAG,IAAI;IAWhD;;OAEG;IACI,UAAU,IAAI,OAAO;IAI5B;;OAEG;aACa,gBAAgB,CAC/B,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,qBAAqB;IAExB;;OAEG;aACa,SAAS,CACxB,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,OAAO,CAAC,qBAAqB,CAAC;IAEjC;;OAEG;aACa,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,sBAAsB;IAEnE;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAE5E;;OAEG;IACH,SAAS,CAAC,mBAAmB,IAAI,IAAI;IAIrC;;;OAGG;IACH,SAAS,CAAC,SAAS,IAAI,IAAI;IAI3B;;;;;;;;OAQG;IACH,SAAS,CAAC,QAAQ,CAAC,WAAW,CAC7B,OAAO,EAAE,yBAAyB,EAClC,KAAK,EAAE,OAAO,EACd,eAAe,EAAE,OAAO,GACtB,IAAI;IAGP;;;;;;;;;;;;;;OAcG;IAEH,SAAS,CAAC,mBAAmB,CAAC,CAAC,kBAAkB,EAAE,yBAAyB,GAAG,IAAI;IAEnF;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAE5B;IAEV;;OAEG;IAEH,SAAS,CAAC,QAAQ,CAAC,YAAY,IAAI,IAAI;IAEvC;;OAEG;IACH,SAAS,CAAC,QAAQ,KAAK,UAAU,IAAI,gBAAgB,CAAC;IAEtD;;;;;;;OAOG;IACH,SAAS,CAAC,kBAAkB,CAAC,OAAO,EAAE,OAAO,EAAE,eAAe,GAAE,OAAmB,GAAG,IAAI;IAiB1F;;;OAGG;IACH,SAAS,CAAC,KAAK,IAAI,IAAI;IASvB;;;OAGG;IACH,SAAS,CAAC,SAAS,IAAI,IAAI;IAE3B;;;;;;;OAOG;IACH,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI;IAIxE;;;;;OAKG;cACa,kBAAkB,CAAC,CAAC,EACnC,QAAQ,EAAE,CACT,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,EAC5C,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,KAAK,IAAI,KAC9B,IAAI,GACP,OAAO,CAAC,CAAC,CAAC;IAqBb,OAAO,CAAC,kBAAkB;IA0B1B;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IA0B1B;;;;;;;;OAQG;IACH,OAAO,CAAC,OAAO;IAyBf;;;;;;;;;;OAUG;IAEH,OAAO,CAAC,eAAe;IAyBvB;;;;;OAKG;IACH,OAAO,CAAC,QAAQ;IAIhB;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI;IAIpE;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAEzD;;;;;;;;;OASG;IACI,IAAI,CAAC,KAAK,EAAE,qBAAqB,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO;IAOlE;;;;;;OAMG;IACH,OAAO,CAAC,YAAY;CAGpB;AAED;;;;;GAKG;AACH,8BAAsB,YAAY,CACjC,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,CACvD,SAAQ,gBAAgB,CAAC,MAAM,CAAC;IAmChC,OAAO,CAAC,QAAQ,CAAC,sBAAsB;IAlCxC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAkB;IAElC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAmB;IAE/C,SAAS,KAAK,UAAU,IAAI,gBAAgB,CAa3C;IAED;;;;OAIG;gBAEF,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB,EACb,sBAAsB,EAAE,MAAM;IAOhD;;OAEG;IACI,gBAAgB,CACtB,QAAQ,GAAE,OAAe,EACzB,UAAU,GAAE,OAAe,EAC3B,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,qBAAqB;IAexB;;OAEG;IACU,SAAS,CACrB,QAAQ,GAAE,OAAe,EACzB,UAAU,GAAE,OAAe,EAC3B,gBAAgB,CAAC,EAAE,iBAAiB,EACpC,yBAAyB,CAAC,EAAE,sCAAsC,GAChE,OAAO,CAAC,qBAAqB,CAAC;IAmBjC;;OAEG;IACI,SAAS,CAAC,MAAM,GAAE,OAAe,GAAG,sBAAsB;IA0BjE;;;;;;;;;OASG;IACH,SAAS,CAAC,iBAAiB,CAAC,UAAU,EAAE,gBAAgB,GAAG,IAAI;IAO/D;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,aAAa,CAC/B,UAAU,EAAE,gBAAgB,EAC5B,gBAAgB,CAAC,EAAE,iBAAiB,EACpC,yBAAyB,CAAC,EAAE,sCAAsC,GAChE,qBAAqB;IAExB,OAAO,CAAC,wBAAwB;CAmBhC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,iBAAiB,CAAC,aAAa;IAC/C;;;;;;;;;OASG;IACH,UAAU,IAAI,eAAe,CAAC,aAAa,CAAC,CAAC;IAE7C;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC;CACpE;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,gBAAgB,CAAC,GAAG,CAAC,aAAa,GAAG,OAAO,CAC5D,SAAQ,UAAU,CAAC,SAAS,CAAC,kBAAkB,EAAE,aAAa,CAAC,CAAC;IAChE;;;OAGG;IACH,EAAE,CAAC,KAAK,EAAE,cAAc,GAAG,KAAK,IAAI,cAAc,GAAG,aAAa,CAAC;CACnE;AAED;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,CAAC,aAAa,EACnD,OAAO,EAAE,CAAC,UAAU,eAAe,CAAC,aAAa,CAAC,CAAC,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC7E,iBAAiB,CAAC,aAAa,CAAC,GAAG,gBAAgB,CAAC,aAAa,CAAC,CAiBpE"}
+{"version":3,"file":"sharedObject.d.ts","sourceRoot":"","sources":["../src/sharedObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAErE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gDAAgD,CAAC;AACpF,OAAO,EAA4B,KAAK,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC5F,OAAO,EACN,KAAK,oBAAoB,EACzB,KAAK,cAAc,EACnB,MAAM,0CAA0C,CAAC;AAElD,OAAO,EACN,gBAAgB,EAChB,sBAAsB,EAEtB,kBAAkB,EAClB,KAAK,eAAe,EACpB,sBAAsB,EAGtB,MAAM,gDAAgD,CAAC;AACxD,OAAO,EACN,KAAK,gBAAgB,EACrB,yBAAyB,EACzB,MAAM,6CAA6C,CAAC;AACrD,OAAO,EACN,sCAAsC,EACtC,qBAAqB,EACrB,iBAAiB,EACjB,sBAAsB,EAGtB,KAAK,yBAAyB,EAE9B,MAAM,8CAA8C,CAAC;AAKtD,OAAO,EACN,mBAAmB,EAEnB,6BAA6B,EAQ7B,MAAM,0CAA0C,CAAC;AAKlD,OAAO,EAAmB,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAYhE;;;;;;;;;;;;;;;GAeG;AACH,8BAAsB,gBAAgB,CACpC,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,CAEzD,SAAQ,6BAA6B,CAAC,MAAM,CAC5C,YAAW,aAAa,CAAC,MAAM,CAAC;IAoD/B;;OAEG;IACI,EAAE,EAAE,MAAM;IACjB;;OAEG;IACH,SAAS,CAAC,OAAO,EAAE,sBAAsB;IACzC;;OAEG;aACa,UAAU,EAAE,kBAAkB;IA7D/C,IAAW,cAAc,IAAI,IAAI,CAEhC;IAED,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAGjC;IACF,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAkC;IAElE;;OAEG;IACH,SAAgB,MAAM,EAAE,oBAAoB,CAAC;IAE7C;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;IAC/C,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAoB;IAEvC;;OAEG;IACH,OAAO,CAAC,UAAU,CAAS;IAE3B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAA+B;IAE/C;;OAEG;IACH,OAAO,CAAC,iBAAiB,CAAkB;IAE3C;;OAEG;IACH,OAAO,CAAC,UAAU,CAAC,CAA4D;IAE/E;;;OAGG;IACH,IAAW,SAAS,IAAI,OAAO,CAE9B;;IAGA;;OAEG;IACI,EAAE,EAAE,MAAM;IACjB;;OAEG;IACO,OAAO,EAAE,sBAAsB;IACzC;;OAEG;IACa,UAAU,EAAE,kBAAkB;IA0C/C;;OAEG;IACH,SAAS,KAAK,YAAY,IAAI,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,CAEvF;IAED;;;;;OAKG;IACH,OAAO,CAAC,4BAA4B;IAuCpC;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAMtB;;OAEG;IACH,OAAO,CAAC,eAAe;IAMvB;;;;;;;;;OASG;IACH,OAAO,CAAC,yBAAyB;IAWjC,OAAO,CAAC,uBAAuB;IAmB/B;;;;OAIG;IACU,IAAI,CAAC,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAU5D;;;OAGG;IACI,eAAe,IAAI,IAAI;IAI9B;;OAEG;IACI,aAAa,IAAI,IAAI;IAY5B;;OAEG;IACI,OAAO,CAAC,QAAQ,EAAE,gBAAgB,GAAG,IAAI;IAWhD;;OAEG;IACI,UAAU,IAAI,OAAO;IAI5B;;OAEG;aACa,gBAAgB,CAC/B,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,qBAAqB;IAExB;;OAEG;aACa,SAAS,CACxB,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,OAAO,CAAC,qBAAqB,CAAC;IAEjC;;OAEG;aACa,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,sBAAsB;IAEnE;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAE5E;;OAEG;IACH,SAAS,CAAC,mBAAmB,IAAI,IAAI;IAIrC;;;OAGG;IACH,SAAS,CAAC,SAAS,IAAI,IAAI;IAI3B;;;;;;;;OAQG;IACH,SAAS,CAAC,QAAQ,CAAC,WAAW,CAC7B,OAAO,EAAE,yBAAyB,EAClC,KAAK,EAAE,OAAO,EACd,eAAe,EAAE,OAAO,GACtB,IAAI;IAGP;;;;;;;;;;;;;;OAcG;IAEH,SAAS,CAAC,mBAAmB,CAAC,CAAC,kBAAkB,EAAE,yBAAyB,GAAG,IAAI;IAEnF;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAE5B;IAEV;;OAEG;IAEH,SAAS,CAAC,QAAQ,CAAC,YAAY,IAAI,IAAI;IAEvC;;OAEG;IACH,SAAS,CAAC,QAAQ,KAAK,UAAU,IAAI,gBAAgB,CAAC;IAEtD;;;;;;;OAOG;IACH,SAAS,CAAC,kBAAkB,CAAC,OAAO,EAAE,OAAO,EAAE,eAAe,GAAE,OAAmB,GAAG,IAAI;IAiB1F;;;OAGG;IACH,SAAS,CAAC,KAAK,IAAI,IAAI;IASvB;;;OAGG;IACH,SAAS,CAAC,SAAS,IAAI,IAAI;IAE3B;;;;;;;OAOG;IACH,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI;IAIxE;;;;;OAKG;cACa,kBAAkB,CAAC,CAAC,EACnC,QAAQ,EAAE,CACT,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,EAC5C,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,KAAK,IAAI,KAC9B,IAAI,GACP,OAAO,CAAC,CAAC,CAAC;IAqBb,OAAO,CAAC,kBAAkB;IA0B1B;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IA0B1B;;;;;;;;OAQG;IACH,OAAO,CAAC,OAAO;IAyBf;;;;;;;;;;OAUG;IAEH,OAAO,CAAC,eAAe;IAyBvB;;;;;OAKG;IACH,OAAO,CAAC,QAAQ;IAIhB;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI;IAIpE;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAEzD;;;;;;;;;OASG;IACI,IAAI,CAAC,KAAK,EAAE,qBAAqB,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO;IAOlE;;;;;;OAMG;IACH,OAAO,CAAC,YAAY;CAGpB;AAED;;;;;;;;;;;GAWG;AACH,8BAAsB,YAAY,CACjC,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,CACvD,SAAQ,gBAAgB,CAAC,MAAM,CAAC;IA8BhC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,sBAAsB;IAhCxC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAkB;IAElC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAmB;IAE/C,SAAS,KAAK,UAAU,IAAI,gBAAgB,CAa3C;gBAGA,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB;IAC9B;;OAEG;IACc,sBAAsB,EAAE,MAAM;IAOhD;;OAEG;IACI,gBAAgB,CACtB,QAAQ,GAAE,OAAe,EACzB,UAAU,GAAE,OAAe,EAC3B,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,qBAAqB;IAexB;;OAEG;IACU,SAAS,CACrB,QAAQ,GAAE,OAAe,EACzB,UAAU,GAAE,OAAe,EAC3B,gBAAgB,CAAC,EAAE,iBAAiB,EACpC,yBAAyB,CAAC,EAAE,sCAAsC,GAChE,OAAO,CAAC,qBAAqB,CAAC;IAmBjC;;OAEG;IACI,SAAS,CAAC,MAAM,GAAE,OAAe,GAAG,sBAAsB;IA0BjE;;;;;;;;;OASG;IACH,SAAS,CAAC,iBAAiB,CAAC,UAAU,EAAE,gBAAgB,GAAG,IAAI;IAO/D;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,aAAa,CAC/B,UAAU,EAAE,gBAAgB,EAC5B,gBAAgB,CAAC,EAAE,iBAAiB,EACpC,yBAAyB,CAAC,EAAE,sCAAsC,GAChE,qBAAqB;IAExB,OAAO,CAAC,wBAAwB;CAmBhC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,iBAAiB,CAAC,aAAa;IAC/C;;;;;;;;;OASG;IACH,UAAU,IAAI,eAAe,CAAC,aAAa,CAAC,CAAC;IAE7C;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC;CACpE;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,gBAAgB,CAAC,GAAG,CAAC,aAAa,GAAG,OAAO,CAC5D,SAAQ,UAAU,CAAC,SAAS,CAAC,kBAAkB,EAAE,aAAa,CAAC,CAAC;IAChE;;;OAGG;IACH,EAAE,CAAC,KAAK,EAAE,cAAc,GAAG,KAAK,IAAI,cAAc,GAAG,aAAa,CAAC;CACnE;AAED;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,CAAC,aAAa,EACnD,OAAO,EAAE,CAAC,UAAU,eAAe,CAAC,aAAa,CAAC,CAAC,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC7E,iBAAiB,CAAC,aAAa,CAAC,GAAG,gBAAgB,CAAC,aAAa,CAAC,CAiBpE"}

package/dist/sharedObject.js

@@ -16,7 +16,18 @@ const handle_js_1 = require("./handle.js");
 const serializer_js_1 = require("./serializer.js");
 const utils_js_1 = require("./utils.js");
 /**
- * Base class from which all shared objects derive.
+ * Base class from which all {@link ISharedObject|shared objects} derive.
+ * @remarks
+ * This class implements common behaviors that implementations of {@link ISharedObject} may want to reuse.
+ * Even more such behaviors are implemented in the {@link SharedObject} class.
+ * @privateRemarks
+ * Currently some documentation (like the above) implies that this is supposed to be the only implementation of ISharedObject, which is both package-exported and not `@sealed`.
+ * This situation should be clarified to indicate if other implementations of ISharedObject are allowed and just currently don't exist,
+ * or if the intention is that no other implementations should exist and creating some might break things.
+ * As part of this, any existing implementations of ISharedObject (via SharedObjectCore or otherwise) in use by legacy API users will need to be considered.
+ *
+ * TODO:
+ * This class should eventually be made internal, as custom subclasses of it outside this repository are intended to be made unsupported in the future.
  * @legacy
  * @alpha
  */
@@ -31,12 +42,19 @@ class SharedObjectCore extends internal_4.EventEmitterWithErrorHandling {
     get connected() {
         return this._connected;
     }
+    constructor(
+    /**
+     * The ID of the shared object.
+     */
+    id, 
     /**
-     * @param id - The id of the shared object
-     * @param runtime - The IFluidDataStoreRuntime which contains the shared object
-     * @param attributes - Attributes of the shared object
+     * The runtime instance that contains the Shared Object.
      */
-    constructor(id, runtime, attributes) {
+    runtime, 
+    /**
+     * The attributes of the Shared Object.
+     */
+    attributes) {
         super((event, e) => this.eventListenerErrorHandler(event, e));
         this.id = id;
         this.runtime = runtime;
@@ -442,8 +460,14 @@ class SharedObjectCore extends internal_4.EventEmitterWithErrorHandling {
 }
 exports.SharedObjectCore = SharedObjectCore;
 /**
- * SharedObject with simplified, synchronous summarization and GC.
- * DDS implementations with async and incremental summarization should extend SharedObjectCore directly instead.
+ * Helper for implementing {@link ISharedObject} with simplified, synchronous summarization and garbage collection.
+ * @remarks
+ * DDS implementations with async and incremental summarization should extend {@link SharedObjectCore} directly instead.
+ * @privateRemarks
+ * TODO:
+ * This class is badly named.
+ * Once it becomes `@internal` "SharedObjectCore" should probably become "SharedObject"
+ * and this class should be renamed to something like "SharedObjectSynchronous".
  * @legacy
  * @alpha
  */
@@ -459,12 +483,11 @@ class SharedObject extends SharedObjectCore {
         (0, internal_1.assert)(!this._isGCing, 0x075 /* "SummarySerializer should be used for serializing data during summary." */);
         return this._serializer;
     }
+    constructor(id, runtime, attributes, 
     /**
-     * @param id - The id of the shared object
-     * @param runtime - The IFluidDataStoreRuntime which contains the shared object
-     * @param attributes - Attributes of the shared object
+     * The prefix to use for telemetry events emitted by this object.
      */
-    constructor(id, runtime, attributes, telemetryContextPrefix) {
+    telemetryContextPrefix) {
         super(id, runtime, attributes);
         this.telemetryContextPrefix = telemetryContextPrefix;
         /**

package/dist/sharedObject.js.map

@@ -1 +1 @@
-{"version":3,"file":"sharedObject.js","sourceRoot":"","sources":["../src/sharedObject.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,iFAAoE;AAOpE,kEAA6D;AAe7D,2EASsD;AACtD,qEAGgD;AAChD,uEAWkD;AAClD,+BAAkC;AAElC,6DAAuD;AACvD,2CAAiD;AACjD,mDAAoE;AAEpE,yCAAgF;AAWhF;;;;GAIG;AACH,MAAsB,gBAGrB,SAAQ,wCAAqC;IAG7C,IAAW,cAAc;QACxB,OAAO,IAAI,CAAC;IACb,CAAC;IAuCD;;;OAGG;IACH,IAAW,SAAS;QACnB,OAAO,IAAI,CAAC,UAAU,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACH,YACQ,EAAU,EACP,OAA+B,EACzB,UAA8B;QAE9C,KAAK,CAAC,CAAC,KAA4B,EAAE,CAAU,EAAE,EAAE,CAClD,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,CAAC,CAAC,CACxC,CAAC;QANK,OAAE,GAAF,EAAE,CAAQ;QACP,YAAO,GAAP,OAAO,CAAwB;QACzB,eAAU,GAAV,UAAU,CAAoB;QApC/C;;WAEG;QACK,eAAU,GAAG,KAAK,CAAC;QAO3B;;WAEG;QACK,sBAAiB,GAAY,KAAK,CAAC;QA6B1C,IAAA,iBAAM,EAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,+BAA+B,CAAC,CAAC;QAEjE,IAAI,CAAC,MAAM,GAAG,IAAI,8BAAkB,CAAC,IAAI,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;QAExD,IAAI,CAAC,MAAM,GAAG,IAAA,4BAAiB,EAAC;YAC/B,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,UAAU,EAAE;gBACX,GAAG,EAAE;oBACJ,cAAc,EAAE,IAAA,SAAI,GAAE;oBACtB,GAAG,IAAA,2BAAgB,EAAC;wBACnB,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI;qBAC7B,CAAC;iBACF;aACD;SACD,CAAC,CAAC;QACH,IAAI,CAAC,EAAE,GAAG,IAAA,oCAAyB,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEjD,MAAM,EAAE,kBAAkB,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC,4BAA4B,EAAE,CAAC;QACpF,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC7C,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QAEvC,MAAM,mBAAmB,GAAG,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACjE,IAAI,CAAC,qBAAqB;YACzB,mBAAmB,KAAK,SAAS;gBAChC,CAAC,CAAC,CAAC,kBAA6C,EAAE,EAAE,CAClD,aAAa,CAAC,kBAAkB,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC5D,CAAC,CAAC,CAAC,kBAA6C,EAAE,EAAE;oBAClD,yBAAyB,CACxB,kBAAkB,EAClB,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAC5B,mBAAmB,CACnB,CAAC;gBACH,CAAC,CAAC;IACN,CAAC;IAED;;OAEG;IACH,IAAc,YAAY;QACzB,OAAO,IAAA,iCAAsB,EAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;OAKG;IACK,4BAA4B;QAInC,IAAA,iBAAM,EACL,IAAI,CAAC,EAAE,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAClD,KAAK,CAAC,iDAAiD,CACvD,CAAC;QACF,MAAM,kBAAkB,GAAG,IAAI,iCAAsB,CACpD;YACC,SAAS,EAAE,iBAAiB;YAC5B,QAAQ,EAAE,aAAa;SACvB,EACD,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,kDAAkD,CAAC,IAAI,IAAI,EACpF,IAAI,EACJ,IAAI,GAAG,CAAmC;YACzC,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;YAC5B,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;SAC9B,CAAC,CACF,CAAC;QACF,MAAM,eAAe,GAAG,IAAI,iCAAsB,CACjD;YACC,SAAS,EAAE,mBAAmB;YAC9B,QAAQ,EAAE,aAAa;SACvB,EACD,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,kDAAkD,CAAC,IAAI,IAAI,EACpF,IAAI,CACJ,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE;YACjC,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC;YAC/B,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,CAAC;QACnC,CAAC,CAAC,CAAC;QAEH,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACK,cAAc,CAAC,KAAkC;QACxD,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACnC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QACzB,CAAC;IACF,CAAC;IAED;;OAEG;IACK,eAAe;QACtB,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACnC,MAAM,IAAI,CAAC,UAAU,CAAC;QACvB,CAAC;IACF,CAAC;IAED;;;;;;;;;OASG;IACK,yBAAyB,CAAC,KAA4B,EAAE,CAAU;QACzE,MAAM,KAAK,GAAG,8BAAmB,CAAC,kBAAkB,CACnD,CAAC,EACD,oCAAoC,CACpC,CAAC;QACF,KAAK,CAAC,sBAAsB,CAAC,EAAE,gBAAgB,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAElE,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAC3B,MAAM,KAAK,CAAC;IACb,CAAC;IAEO,uBAAuB;QAC9B,4EAA4E;QAC5E,mEAAmE;QACnE,oCAAoC;QACpC,IAAI,CAAC,uBAAuB,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACrF,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAC9B,+DAA+D;QAC/D,MAAM,YAAY,GAAe,GAAG,EAAE;YACrC,gEAAgE;YAChE,IAAI,CAAC,SAAS,EAAE,CAAC;YACjB,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACjD,CAAC,CAAC;QACF,IAAI,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;YACvB,YAAY,EAAE,CAAC;QAChB,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;QAC9C,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,CAAC,QAA0B;QAC3C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,kDAAkD;QAClD,kDAAkD;QAClD,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAC9B,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QAC5C,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,IAAI,CAAC,uBAAuB,EAAE,CAAC;IAChC,CAAC;IAED;;;OAGG;IACI,eAAe;QACrB,IAAI,CAAC,mBAAmB,EAAE,CAAC;IAC5B,CAAC;IAED;;OAEG;IACI,aAAa;QACnB,kEAAkE;QAClE,0DAA0D;QAC1D,IAAI,CAAC,aAAa,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC;QAC9B,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC7B,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YAC/B,gEAAgE;YAChE,6BAA6B;YAC7B,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAChC,CAAC;IACF,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,QAA0B;QACxC,uCAAuC;QACvC,+CAA+C;QAC/C,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACjC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;YACzB,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC3B,CAAC;QAED,IAAI,CAAC,uBAAuB,EAAE,CAAC;IAChC,CAAC;IAED;;OAEG;IACI,UAAU;QAChB,OAAO,IAAI,CAAC,iBAAiB,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,mCAAW,CAAC,QAAQ,CAAC;IACpF,CAAC;IA+BD;;OAEG;IACO,mBAAmB;QAC5B,OAAO;IACR,CAAC;IAED;;;OAGG;IACO,SAAS;QAClB,OAAO;IACR,CAAC;IAwDD;;;;;;;OAOG;IACO,kBAAkB,CAAC,OAAgB,EAAE,kBAA2B,SAAS;QAClF,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,IAAI,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;YACvB,+DAA+D;YAC/D,0FAA0F;YAC1F,MAAM,QAAQ,GACZ,IAAI,CAAC,OAAgD;iBACpD,oCAAoC,KAAK,IAAI,CAAC;YACjD,MAAM,eAAe,GAAG,QAAQ;gBAC/B,CAAC,CAAC,IAAA,sBAAW,EAAC,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC;gBACpD,CAAC,CAAC,IAAA,kCAAuB,EAAC,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YAElE,oEAAoE;YACpE,IAAI,CAAC,QAAS,CAAC,eAAe,CAAC,MAAM,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;QACzE,CAAC;IACF,CAAC;IAED;;;OAGG;IACO,KAAK;QACd,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;YACxB,OAAO;QACR,CAAC;QAED,oEAAoE;QACpE,IAAI,CAAC,QAAS,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;IACxC,CAAC;IAED;;;OAGG;IACO,SAAS,KAAU,CAAC;IAE9B;;;;;;;OAOG;IACO,YAAY,CAAC,OAAgB,EAAE,eAAwB;QAChE,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IACnD,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,kBAAkB,CACjC,QAGS;QAET,IAAI,oBAAgC,CAAC;QACrC,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACzC,oBAAoB,GAAG,GAAG,EAAE,CAC3B,MAAM,CACL,IAAI,KAAK,CAAC,yEAAyE,CAAC,CACpF,CAAC;YAEH,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;gBAC3B,oBAAoB,EAAE,CAAC;gBACvB,OAAO;YACR,CAAC;YAED,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC;YACjD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE;YACf,0DAA0D;YAC1D,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;IACJ,CAAC;IAEO,kBAAkB;QACzB,2EAA2E;QAC3E,IAAA,iBAAM,EACL,IAAI,CAAC,QAAQ,KAAK,SAAS,EAC3B,KAAK,CAAC,wDAAwD,CAC9D,CAAC;QACF,+DAA+D;QAC/D,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,MAAM,CAAC;YACpC,eAAe,EAAE,CAAC,kBAA6C,EAAE,EAAE;gBAClE,IAAI,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC;YAC1C,CAAC;YACD,kBAAkB,EAAE,CAAC,SAAkB,EAAE,EAAE;gBAC1C,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;YACpC,CAAC;YACD,QAAQ,EAAE,CAAC,OAAgB,EAAE,eAAwB,EAAE,EAAE;gBACxD,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;YACzC,CAAC;YACD,cAAc,EAAE,CAAC,OAAgB,EAAQ,EAAE;gBAC1C,IAAI,CAAC,cAAc,CAAC,IAAA,uBAAY,EAAC,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;YAC7D,CAAC;YACD,QAAQ,EAAE,CAAC,OAAgB,EAAE,eAAwB,EAAE,EAAE;gBACxD,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;YACzC,CAAC;SACuB,CAAC,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACK,kBAAkB,CAAC,SAAkB;QAC5C,oDAAoD;QACpD,8CAA8C;QAC9C,oDAAoD;QACpD,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACzD,wCAAwC;YACxC,OAAO;QACR,CAAC;QAED,8FAA8F;QAC9F,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAE5B,IAAI,SAAS,EAAE,CAAC;YACf,kGAAkG;YAClG,sBAAsB;YACtB,IAAI,CAAC,SAAS,EAAE,CAAC;QAClB,CAAC;aAAM,CAAC;YACP,8BAA8B;YAC9B,kEAAkE;YAClE,4FAA4F;YAC5F,EAAE;YACF,oEAAoE;YACpE,IAAI,CAAC,YAAY,EAAE,CAAC;QACrB,CAAC;IACF,CAAC;IAED;;;;;;;;OAQG;IACK,OAAO,CACd,OAAkC,EAClC,KAAc,EACd,eAAwB;QAExB,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC,yCAAyC;QACjE,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;QAElD,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAC9B,GAA4C,EAAE;YAC7C,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,EAAE,eAAe,CAAC,CAAC;YAClD,MAAM,mBAAmB,GAA+B;gBACvD,kBAAkB,EAAE,OAAO,CAAC,cAAc,GAAG,OAAO,CAAC,uBAAuB;aAC5E,CAAC;YACF,OAAO;gBACN,UAAU,EAAE,mBAAmB;aAC/B,CAAC;QACH,CAAC,EACD,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAC1B,CAAC;QAEF,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED,4CAA4C;IAC5C;;;;;;;;;;OAUG;IACH,2CAA2C;IACnC,eAAe,CAAC,kBAA6C;QACpE,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC,yCAAyC;QAEjE,qEAAqE;QACrE,MAAM,sBAAsB,GAA8B,EAAE,CAAC;QAC7D,KAAK,MAAM,EACV,QAAQ,EACR,eAAe,EACf,oBAAoB,GACpB,IAAI,kBAAkB,CAAC,eAAe,EAAE,CAAC;YACzC,MAAM,qBAAqB,GAA4B;gBACtD,QAAQ,EAAE,IAAA,uBAAY,EAAC,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC;gBACjD,eAAe;gBACf,oBAAoB;aACpB,CAAC;YACF,sBAAsB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QACpD,CAAC;QAED,MAAM,yBAAyB,GAA8B;YAC5D,GAAG,kBAAkB;YACrB,eAAe,EAAE,sBAAsB;SACvC,CAAC;QACF,IAAI,CAAC,qBAAqB,CAAC,yBAAyB,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACK,QAAQ,CAAC,OAAgB,EAAE,eAAwB;QAC1D,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IAC7C,CAAC;IAED;;OAEG;IACO,QAAQ,CAAC,OAAgB,EAAE,eAAwB;QAC5D,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC3C,CAAC;IAqBD;;;;;;;;;OASG;IACI,IAAI,CAAC,KAA4B,EAAE,GAAG,IAAW;QACvD,OAAO,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,EAAE;YACxC,iEAAiE;YACjE,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACK,YAAY,CAAC,KAA4B,EAAE,GAAG,IAAe;QACpE,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;IACnC,CAAC;CACD;AA5oBD,4CA4oBC;AAED;;;;;GAKG;AACH,MAAsB,YAEpB,SAAQ,gBAAwB;IAWjC,IAAc,UAAU;QACvB;;;;;;WAMG;QACH,IAAA,iBAAM,EACL,CAAC,IAAI,CAAC,QAAQ,EACd,KAAK,CAAC,6EAA6E,CACnF,CAAC;QACF,OAAO,IAAI,CAAC,WAAW,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,YACC,EAAU,EACV,OAA+B,EAC/B,UAA8B,EACb,sBAA8B;QAE/C,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAFd,2BAAsB,GAAtB,sBAAsB,CAAQ;QAlChD;;WAEG;QACK,aAAQ,GAAY,KAAK,CAAC;QAmCjC,IAAI,CAAC,WAAW,GAAG,IAAI,+BAAe,CAAC,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACI,gBAAgB,CACtB,WAAoB,KAAK,EACzB,aAAsB,KAAK,EAC3B,gBAAoC;QAEpC,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;QACrE,IAAI,CAAC,wBAAwB,CAC5B,gCAAqB,EACrB,MAAM,CAAC,KAAK,CAAC,aAAa,EAC1B,gBAAgB,CAChB,CAAC;QACF,IAAI,CAAC,wBAAwB,CAC5B,oCAAyB,EACzB,MAAM,CAAC,KAAK,CAAC,aAAa,EAC1B,gBAAgB,CAChB,CAAC;QACF,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,SAAS,CACrB,WAAoB,KAAK,EACzB,aAAsB,KAAK,EAC3B,gBAAoC,EACpC,yBAAkE;QAElE,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAChC,IAAI,CAAC,UAAU,EACf,gBAAgB,EAChB,yBAAyB,CACzB,CAAC;QACF,IAAI,CAAC,wBAAwB,CAC5B,gCAAqB,EACrB,MAAM,CAAC,KAAK,CAAC,aAAa,EAC1B,gBAAgB,CAChB,CAAC;QACF,IAAI,CAAC,wBAAwB,CAC5B,oCAAyB,EACzB,MAAM,CAAC,KAAK,CAAC,aAAa,EAC1B,gBAAgB,CAChB,CAAC;QACF,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,SAAkB,KAAK;QACvC,8IAA8I;QAC9I,IAAA,iBAAM,EACL,CAAC,IAAI,CAAC,QAAQ,EACd,KAAK,CAAC,wEAAwE,CAC9E,CAAC;QACF,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QAErB,IAAI,MAA8B,CAAC;QACnC,IAAI,CAAC;YACJ,MAAM,aAAa,GAAG,IAAI,oCAAe,CAAC,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;YAC/E,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;YACtC,yGAAyG;YACzG,qDAAqD;YACrD,MAAM,GAAG,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,aAAa,CAAC,qBAAqB,EAAE,EAAE,EAAE,CAAC;YACrE,IAAA,iBAAM,EACL,IAAI,CAAC,QAAQ,EACb,KAAK,CAAC,mEAAmE,CACzE,CAAC;QACH,CAAC;gBAAS,CAAC;YACV,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACvB,CAAC;QAED,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;;;;;;;OASG;IACO,iBAAiB,CAAC,UAA4B;QACvD,wGAAwG;QACxG,2GAA2G;QAC3G,+DAA+D;QAC/D,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IAChC,CAAC;IAYO,wBAAwB,CAC/B,YAAoB,EACpB,WAAmB,EACnB,gBAAoC;QAEpC,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;YACpC,oDAAoD;YACpD,IAAA,iBAAM,EACL,KAAK,IAAI,gBAAgB,IAAI,OAAO,gBAAgB,CAAC,GAAG,KAAK,UAAU,EACvE,KAAK,CAAC,+CAA+C,CACrD,CAAC;YAEF,MAAM,SAAS,GAAG,CAAE,gBAAqC,CAAC,GAAG,CAC5D,IAAI,CAAC,sBAAsB,EAC3B,YAAY,CACZ,IAAI,CAAC,CAAW,CAAC;YAClB,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,sBAAsB,EAAE,YAAY,EAAE,SAAS,GAAG,WAAW,CAAC,CAAC;QAC1F,CAAC;IACF,CAAC;CACD;AAxKD,oCAwKC;AA0ED;;;;;;;;GAQG;AACH,SAAgB,sBAAsB,CACrC,OAA+E;IAE/E,MAAM,MAAM,GACsC;QACjD,UAAU;YACT,OAAO,IAAI,OAAO,EAAE,CAAC;QACtB,CAAC;QAED,MAAM,CAAC,OAA+B,EAAE,EAAW;YAClD,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,CAAkB,CAAC;QACjE,CAAC;QAED,EAAE,CAAC,KAAqB;YACvB,OAAO,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC;QACnE,CAAC;KACD,CAAC;IAEF,OAAO,MAAyD,CAAC;AAClE,CAAC;AAnBD,wDAmBC;AAED,SAAS,SAAS,CAAC,QAAwB;IAC1C,oGAAoG;IACpG,OAAQ,QAAqB,CAAC,UAAU,KAAK,SAAS,CAAC;AACxD,CAAC;AAED;;;GAGG;AACH,SAAS,yBAAyB,CACjC,kBAA6C,EAC7C,kBAA4E,EAC5E,YAIS,EACT,mBAA4E;IAE5E,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,eAAe,EAAE,GAAG,kBAAkB,CAAC;IAEhE,MAAM,UAAU,GAAG,CAClB,KAAsB,EACtB,uBAA2D,EACpD,EAAE;QACT,KAAK,MAAM,EAAE,QAAQ,EAAE,oBAAoB,EAAE,IAAI,uBAAuB,EAAE,CAAC;YAC1E,MAAM,OAAO,GAA8B;gBAC1C,GAAG,QAAQ;gBACX,QAAQ;gBACR,oBAAoB;aACpB,CAAC;YACF,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QACrC,CAAC;IACF,CAAC,CAAC;IAEF,UAAU,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;IACtC,kBAAkB,CAAC,OAAO,CACzB,GAA4C,EAAE;QAC7C,mBAAmB,CAAC,kBAAkB,CAAC,CAAC;QACxC,MAAM,mBAAmB,GAA+B;YACvD,kBAAkB,EAAE,QAAQ,CAAC,cAAc,GAAG,QAAQ,CAAC,uBAAuB;SAC9E,CAAC;QACF,OAAO;YACN,UAAU,EAAE,mBAAmB;SAC/B,CAAC;IACH,CAAC,EACD,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAC1B,CAAC;IACF,UAAU,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;AACnC,CAAC;AAED;;;GAGG;AACH,SAAS,aAAa,CACrB,kBAA6C,EAC7C,OAIS;IAET,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,eAAe,EAAE,GAAG,kBAAkB,CAAC;IAChE,KAAK,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,oBAAoB,EAAE,IAAI,eAAe,EAAE,CAAC;QACnF,OAAO,CACN;YACC,GAAG,QAAQ;YACX,QAAQ;YACR,oBAAoB;SACpB,EACD,KAAK,EACL,eAAe,CACf,CAAC;IACH,CAAC;AACF,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { EventEmitterEventType } from \"@fluid-internal/client-utils\";\nimport { AttachState } from \"@fluidframework/container-definitions\";\nimport type { IDeltaManager } from \"@fluidframework/container-definitions/internal\";\nimport { ITelemetryBaseProperties, type ErasedType } from \"@fluidframework/core-interfaces\";\nimport {\n\ttype IFluidHandleInternal,\n\ttype IFluidLoadable,\n} from \"@fluidframework/core-interfaces/internal\";\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport {\n\tIChannelServices,\n\tIChannelStorageService,\n\ttype IChannel,\n\tIChannelAttributes,\n\ttype IChannelFactory,\n\tIFluidDataStoreRuntime,\n\ttype IDeltaHandler,\n\ttype IFluidDataStoreRuntimeInternalConfig,\n} from \"@fluidframework/datastore-definitions/internal\";\nimport {\n\ttype IDocumentMessage,\n\tISequencedDocumentMessage,\n} from \"@fluidframework/driver-definitions/internal\";\nimport {\n\tIExperimentalIncrementalSummaryContext,\n\tISummaryTreeWithStats,\n\tITelemetryContext,\n\tIGarbageCollectionData,\n\tblobCountPropertyName,\n\ttotalBlobSizePropertyName,\n\ttype IRuntimeMessageCollection,\n\ttype IRuntimeMessagesContent,\n} from \"@fluidframework/runtime-definitions/internal\";\nimport {\n\ttoDeltaManagerInternal,\n\tTelemetryContext,\n} from \"@fluidframework/runtime-utils/internal\";\nimport {\n\tITelemetryLoggerExt,\n\tDataProcessingError,\n\tEventEmitterWithErrorHandling,\n\tMonitoringContext,\n\tSampledTelemetryHelper,\n\tcreateChildLogger,\n\tloggerToMonitoringContext,\n\ttagCodeArtifacts,\n\ttype ICustomData,\n\ttype IFluidErrorBase,\n} from \"@fluidframework/telemetry-utils/internal\";\nimport { v4 as uuid } from \"uuid\";\n\nimport { GCHandleVisitor } from \"./gcHandleVisitor.js\";\nimport { SharedObjectHandle } from \"./handle.js\";\nimport { FluidSerializer, IFluidSerializer } from \"./serializer.js\";\nimport { ISharedObject, ISharedObjectEvents } from \"./types.js\";\nimport { bindHandles, makeHandlesSerializable, parseHandles } from \"./utils.js\";\n\n/**\n * Custom telemetry properties used in {@link SharedObjectCore} to instantiate {@link TelemetryEventBatcher} class.\n * This interface is used to define the properties that will be passed to the {@link TelemetryEventBatcher.measure} function\n * which is called in the {@link SharedObjectCore.process} method.\n */\ninterface ProcessTelemetryProperties {\n\tsequenceDifference: number;\n}\n\n/**\n * Base class from which all shared objects derive.\n * @legacy\n * @alpha\n */\nexport abstract class SharedObjectCore<\n\t\tTEvent extends ISharedObjectEvents = ISharedObjectEvents,\n\t>\n\textends EventEmitterWithErrorHandling<TEvent>\n\timplements ISharedObject<TEvent>\n{\n\tpublic get IFluidLoadable(): this {\n\t\treturn this;\n\t}\n\n\tprivate readonly opProcessingHelper: SampledTelemetryHelper<\n\t\tvoid,\n\t\tProcessTelemetryProperties\n\t>;\n\tprivate readonly callbacksHelper: SampledTelemetryHelper<boolean>;\n\n\t/**\n\t * The handle referring to this SharedObject\n\t */\n\tpublic readonly handle: IFluidHandleInternal;\n\n\t/**\n\t * Telemetry logger for the shared object\n\t */\n\tprotected readonly logger: ITelemetryLoggerExt;\n\tprivate readonly mc: MonitoringContext;\n\n\t/**\n\t * Connection state\n\t */\n\tprivate _connected = false;\n\n\t/**\n\t * Services used by the shared object\n\t */\n\tprivate services: IChannelServices | undefined;\n\n\t/**\n\t * True if the dds is bound to its parent.\n\t */\n\tprivate _isBoundToContext: boolean = false;\n\n\t/**\n\t * Tracks error that closed this object.\n\t */\n\tprivate closeError?: ReturnType<typeof DataProcessingError.wrapIfUnrecognized>;\n\n\t/**\n\t * Gets the connection state\n\t * @returns The state of the connection\n\t */\n\tpublic get connected(): boolean {\n\t\treturn this._connected;\n\t}\n\n\t/**\n\t * @param id - The id of the shared object\n\t * @param runtime - The IFluidDataStoreRuntime which contains the shared object\n\t * @param attributes - Attributes of the shared object\n\t */\n\tconstructor(\n\t\tpublic id: string,\n\t\tprotected runtime: IFluidDataStoreRuntime,\n\t\tpublic readonly attributes: IChannelAttributes,\n\t) {\n\t\tsuper((event: EventEmitterEventType, e: unknown) =>\n\t\t\tthis.eventListenerErrorHandler(event, e),\n\t\t);\n\n\t\tassert(!id.includes(\"/\"), 0x304 /* Id cannot contain slashes */);\n\n\t\tthis.handle = new SharedObjectHandle(this, id, runtime);\n\n\t\tthis.logger = createChildLogger({\n\t\t\tlogger: runtime.logger,\n\t\t\tproperties: {\n\t\t\t\tall: {\n\t\t\t\t\tsharedObjectId: uuid(),\n\t\t\t\t\t...tagCodeArtifacts({\n\t\t\t\t\t\tddsType: this.attributes.type,\n\t\t\t\t\t}),\n\t\t\t\t},\n\t\t\t},\n\t\t});\n\t\tthis.mc = loggerToMonitoringContext(this.logger);\n\n\t\tconst { opProcessingHelper, callbacksHelper } = this.setUpSampledTelemetryHelpers();\n\t\tthis.opProcessingHelper = opProcessingHelper;\n\t\tthis.callbacksHelper = callbacksHelper;\n\n\t\tconst processMessagesCore = this.processMessagesCore?.bind(this);\n\t\tthis.processMessagesHelper =\n\t\t\tprocessMessagesCore === undefined\n\t\t\t\t? (messagesCollection: IRuntimeMessageCollection) =>\n\t\t\t\t\t\tprocessHelper(messagesCollection, this.process.bind(this))\n\t\t\t\t: (messagesCollection: IRuntimeMessageCollection) => {\n\t\t\t\t\t\tprocessMessagesCoreHelper(\n\t\t\t\t\t\t\tmessagesCollection,\n\t\t\t\t\t\t\tthis.opProcessingHelper,\n\t\t\t\t\t\t\tthis.emitInternal.bind(this),\n\t\t\t\t\t\t\tprocessMessagesCore,\n\t\t\t\t\t\t);\n\t\t\t\t\t};\n\t}\n\n\t/**\n\t * Accessor for `this.runtime`'s {@link @fluidframework/datastore-definitions#IFluidDataStoreRuntime.deltaManager} as a {@link @fluidframework/container-definitions/internal#IDeltaManager}\n\t */\n\tprotected get deltaManager(): IDeltaManager<ISequencedDocumentMessage, IDocumentMessage> {\n\t\treturn toDeltaManagerInternal(this.runtime.deltaManager);\n\t}\n\n\t/**\n\t * This function is only supposed to be called from SharedObjectCore's constructor and\n\t * depends on a few things being set already. assert() calls make sure of it.\n\t * @returns The telemetry sampling helpers, so the constructor can be the one to assign them\n\t * to variables to avoid complaints from TypeScript.\n\t */\n\tprivate setUpSampledTelemetryHelpers(): {\n\t\topProcessingHelper: SampledTelemetryHelper<void, ProcessTelemetryProperties>;\n\t\tcallbacksHelper: SampledTelemetryHelper<boolean>;\n\t} {\n\t\tassert(\n\t\t\tthis.mc !== undefined && this.logger !== undefined,\n\t\t\t0x349 /* this.mc and/or this.logger has not been set */,\n\t\t);\n\t\tconst opProcessingHelper = new SampledTelemetryHelper<void, ProcessTelemetryProperties>(\n\t\t\t{\n\t\t\t\teventName: \"ddsOpProcessing\",\n\t\t\t\tcategory: \"performance\",\n\t\t\t},\n\t\t\tthis.logger,\n\t\t\tthis.mc.config.getNumber(\"Fluid.SharedObject.OpProcessingTelemetrySampling\") ?? 1000,\n\t\t\ttrue,\n\t\t\tnew Map<string, ITelemetryBaseProperties>([\n\t\t\t\t[\"local\", { localOp: true }],\n\t\t\t\t[\"remote\", { localOp: false }],\n\t\t\t]),\n\t\t);\n\t\tconst callbacksHelper = new SampledTelemetryHelper<boolean>(\n\t\t\t{\n\t\t\t\teventName: \"ddsEventCallbacks\",\n\t\t\t\tcategory: \"performance\",\n\t\t\t},\n\t\t\tthis.logger,\n\t\t\tthis.mc.config.getNumber(\"Fluid.SharedObject.DdsCallbacksTelemetrySampling\") ?? 1000,\n\t\t\ttrue,\n\t\t);\n\n\t\tthis.runtime.once(\"dispose\", () => {\n\t\t\tthis.callbacksHelper.dispose();\n\t\t\tthis.opProcessingHelper.dispose();\n\t\t});\n\n\t\treturn { opProcessingHelper, callbacksHelper };\n\t}\n\n\t/**\n\t * Marks this objects as closed. Any attempt to change it (local changes or processing remote ops)\n\t * would result in same error thrown. If called multiple times, only first error is remembered.\n\t * @param error - error object that is thrown whenever an attempt is made to modify this object\n\t */\n\tprivate closeWithError(error: IFluidErrorBase | undefined): void {\n\t\tif (this.closeError === undefined) {\n\t\t\tthis.closeError = error;\n\t\t}\n\t}\n\n\t/**\n\t * Verifies that this object is not closed via closeWithError(). If it is, throws an error used to close it.\n\t */\n\tprivate verifyNotClosed(): void {\n\t\tif (this.closeError !== undefined) {\n\t\t\tthrow this.closeError;\n\t\t}\n\t}\n\n\t/**\n\t * Event listener handler helper that can be used to react to exceptions thrown from event listeners\n\t * It wraps error with DataProcessingError, closes this object and throws resulting error.\n\t * See closeWithError() for more details\n\t * Ideally such situation never happens, as consumers of DDS should never throw exceptions\n\t * in event listeners (i.e. catch any of the issues and make determination on how to handle it).\n\t * When such exceptions propagate through, most likely data model is no longer consistent, i.e.\n\t * DDS state does not match what user sees. Because of it DDS moves to \"corrupted state\" and does not\n\t * allow processing of ops or local changes, which very quickly results in container closure.\n\t */\n\tprivate eventListenerErrorHandler(event: EventEmitterEventType, e: unknown): void {\n\t\tconst error = DataProcessingError.wrapIfUnrecognized(\n\t\t\te,\n\t\t\t\"SharedObjectEventListenerException\",\n\t\t);\n\t\terror.addTelemetryProperties({ emittedEventName: String(event) });\n\n\t\tthis.closeWithError(error);\n\t\tthrow error;\n\t}\n\n\tprivate setBoundAndHandleAttach(): void {\n\t\t// Ensure didAttach is only called once, and we only register a single event\n\t\t// but we still call setConnectionState as our existing mocks don't\n\t\t// always propagate connection state\n\t\tthis.setBoundAndHandleAttach = () => this.setConnectionState(this.runtime.connected);\n\t\tthis._isBoundToContext = true;\n\t\t// eslint-disable-next-line unicorn/consistent-function-scoping\n\t\tconst runDidAttach: () => void = () => {\n\t\t\t// Allows objects to do any custom processing if it is attached.\n\t\t\tthis.didAttach();\n\t\t\tthis.setConnectionState(this.runtime.connected);\n\t\t};\n\t\tif (this.isAttached()) {\n\t\t\trunDidAttach();\n\t\t} else {\n\t\t\tthis.runtime.once(\"attaching\", runDidAttach);\n\t\t}\n\t}\n\n\t/**\n\t * A shared object, after construction, can either be loaded in the case that it is already part of\n\t * a shared document. Or later attached if it is being newly added.\n\t * @param services - Services used by the shared object\n\t */\n\tpublic async load(services: IChannelServices): Promise<void> {\n\t\tthis.services = services;\n\t\t// set this before load so that isAttached is true\n\t\t// for attached runtimes when load core is running\n\t\tthis._isBoundToContext = true;\n\t\tawait this.loadCore(services.objectStorage);\n\t\tthis.attachDeltaHandler();\n\t\tthis.setBoundAndHandleAttach();\n\t}\n\n\t/**\n\t * Initializes the object as a local, non-shared object. This object can become shared after\n\t * it is attached to the document.\n\t */\n\tpublic initializeLocal(): void {\n\t\tthis.initializeLocalCore();\n\t}\n\n\t/**\n\t * {@inheritDoc (ISharedObject:interface).bindToContext}\n\t */\n\tpublic bindToContext(): void {\n\t\t// ensure the method only runs once by removing the implementation\n\t\t// without this the method suffers from re-entrancy issues\n\t\tthis.bindToContext = () => {};\n\t\tif (!this._isBoundToContext) {\n\t\t\tthis.runtime.bindChannel(this);\n\t\t\t// must set after bind channel so isAttached doesn't report true\n\t\t\t// before binding is complete\n\t\t\tthis.setBoundAndHandleAttach();\n\t\t}\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).connect}\n\t */\n\tpublic connect(services: IChannelServices): void {\n\t\t// handle the case where load is called\n\t\t// before connect; loading detached data stores\n\t\tif (this.services === undefined) {\n\t\t\tthis.services = services;\n\t\t\tthis.attachDeltaHandler();\n\t\t}\n\n\t\tthis.setBoundAndHandleAttach();\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).isAttached}\n\t */\n\tpublic isAttached(): boolean {\n\t\treturn this._isBoundToContext && this.runtime.attachState !== AttachState.Detached;\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}\n\t */\n\tpublic abstract getAttachSummary(\n\t\tfullTree?: boolean,\n\t\ttrackState?: boolean,\n\t\ttelemetryContext?: ITelemetryContext,\n\t): ISummaryTreeWithStats;\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}\n\t */\n\tpublic abstract summarize(\n\t\tfullTree?: boolean,\n\t\ttrackState?: boolean,\n\t\ttelemetryContext?: ITelemetryContext,\n\t): Promise<ISummaryTreeWithStats>;\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getGCData}\n\t */\n\tpublic abstract getGCData(fullGC?: boolean): IGarbageCollectionData;\n\n\t/**\n\t * Allows the distributed data type to perform custom loading\n\t * @param services - Storage used by the shared object\n\t */\n\tprotected abstract loadCore(services: IChannelStorageService): Promise<void>;\n\n\t/**\n\t * Allows the distributed data type to perform custom local loading.\n\t */\n\tprotected initializeLocalCore(): void {\n\t\treturn;\n\t}\n\n\t/**\n\t * Allows the distributive data type the ability to perform custom processing once an attach has happened.\n\t * Also called after non-local data type get loaded.\n\t */\n\tprotected didAttach(): void {\n\t\treturn;\n\t}\n\n\t/**\n\t * Derived classes must override this to do custom processing on a remote message.\n\t * @param message - The message to process\n\t * @param local - True if the shared object is local\n\t * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.\n\t * For messages from a remote client, this will be undefined.\n\t *\n\t * @deprecated Replaced by {@link SharedObjectCore.processMessagesCore}.\n\t */\n\tprotected abstract processCore(\n\t\tmessage: ISequencedDocumentMessage,\n\t\tlocal: boolean,\n\t\tlocalOpMetadata: unknown,\n\t): void;\n\n\t/* eslint-disable jsdoc/check-indentation */\n\t/**\n\t * Process a 'bunch' of messages for this shared object.\n\t *\n\t * @remarks\n\t * A 'bunch' is a group of messages that have the following properties:\n\t * - They are all part of the same grouped batch, which entails:\n\t *   - They are contiguous in sequencing order.\n\t *   - They are all from the same client.\n\t *   - They are all based on the same reference sequence number.\n\t *   - They are not interleaved with messages from other clients.\n\t * - They are not interleaved with messages from other DDS in the container.\n\t * Derived classes should override this if they need to do custom processing on a 'bunch' of remote messages.\n\t * @param messageCollection - The collection of messages to process.\n\t *\n\t */\n\t/* eslint-enable jsdoc/check-indentation */\n\tprotected processMessagesCore?(messagesCollection: IRuntimeMessageCollection): void;\n\n\t/**\n\t * Calls {@link SharedObjectCore.processCore} or {@link SharedObjectCore.processMessagesCore} depending on whether\n\t * processMessagesCore is defined. This helper is used to keep the code cleaner while we have to support both these\n\t * function.\n\t */\n\tprivate readonly processMessagesHelper: (\n\t\tmessagesCollection: IRuntimeMessageCollection,\n\t) => void;\n\n\t/**\n\t * Called when the object has disconnected from the delta stream.\n\t */\n\n\tprotected abstract onDisconnect(): void;\n\n\t/**\n\t * The serializer to serialize / parse handles.\n\t */\n\tprotected abstract get serializer(): IFluidSerializer;\n\n\t/**\n\t * Submits a message by the local client to the runtime.\n\t * @param content - Content of the message. Note: handles contained in the\n\t * message object should not be encoded in any way\n\t * @param localOpMetadata - The local metadata associated with the message. This is kept locally by the runtime\n\t * and not sent to the server. This will be sent back when this message is received back from the server. This is\n\t * also sent if we are asked to resubmit the message.\n\t */\n\tprotected submitLocalMessage(content: unknown, localOpMetadata: unknown = undefined): void {\n\t\tthis.verifyNotClosed();\n\t\tif (this.isAttached()) {\n\t\t\t// NOTE: We may also be encoding in the ContainerRuntime layer.\n\t\t\t// Once the layer-compat window passes we can remove the encoding codepath here altogether\n\t\t\tconst onlyBind =\n\t\t\t\t(this.runtime as IFluidDataStoreRuntimeInternalConfig)\n\t\t\t\t\t.submitMessagesWithoutEncodingHandles === true;\n\t\t\tconst contentToSubmit = onlyBind\n\t\t\t\t? bindHandles(content, this.serializer, this.handle)\n\t\t\t\t: makeHandlesSerializable(content, this.serializer, this.handle);\n\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\t\tthis.services!.deltaConnection.submit(contentToSubmit, localOpMetadata);\n\t\t}\n\t}\n\n\t/**\n\t * Marks this object as dirty so that it is part of the next summary. It is called by a SharedSummaryBlock\n\t * that want to be part of summary but does not generate ops.\n\t */\n\tprotected dirty(): void {\n\t\tif (!this.isAttached()) {\n\t\t\treturn;\n\t\t}\n\n\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\tthis.services!.deltaConnection.dirty();\n\t}\n\n\t/**\n\t * Called when the object has fully connected to the delta stream\n\t * Default implementation for DDS, override if different behavior is required.\n\t */\n\tprotected onConnect(): void {}\n\n\t/**\n\t * Called when a message has to be resubmitted. This typically happens after a reconnection for unacked messages.\n\t * The default implementation here is to resubmit the same message. The client can override if different behavior\n\t * is required. It can choose to resubmit the same message, submit different / multiple messages or not submit\n\t * anything at all.\n\t * @param content - The content of the original message.\n\t * @param localOpMetadata - The local metadata associated with the original message.\n\t */\n\tprotected reSubmitCore(content: unknown, localOpMetadata: unknown): void {\n\t\tthis.submitLocalMessage(content, localOpMetadata);\n\t}\n\n\t/**\n\t * Promises that are waiting for an ack from the server before resolving should use this instead of new Promise.\n\t * It ensures that if something changes that will interrupt that ack (e.g. the FluidDataStoreRuntime disposes),\n\t * the Promise will reject.\n\t * If runtime is disposed when this call is made, executor is not run and promise is rejected right away.\n\t */\n\tprotected async newAckBasedPromise<T>(\n\t\texecutor: (\n\t\t\tresolve: (value: T | PromiseLike<T>) => void,\n\t\t\treject: (reason?: unknown) => void,\n\t\t) => void,\n\t): Promise<T> {\n\t\tlet rejectBecauseDispose: () => void;\n\t\treturn new Promise<T>((resolve, reject) => {\n\t\t\trejectBecauseDispose = () =>\n\t\t\t\treject(\n\t\t\t\t\tnew Error(\"FluidDataStoreRuntime disposed while this ack-based Promise was pending\"),\n\t\t\t\t);\n\n\t\t\tif (this.runtime.disposed) {\n\t\t\t\trejectBecauseDispose();\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\tthis.runtime.on(\"dispose\", rejectBecauseDispose);\n\t\t\texecutor(resolve, reject);\n\t\t}).finally(() => {\n\t\t\t// Note: rejectBecauseDispose will never be undefined here\n\t\t\tthis.runtime.off(\"dispose\", rejectBecauseDispose);\n\t\t});\n\t}\n\n\tprivate attachDeltaHandler(): void {\n\t\t// Services should already be there in case we are attaching delta handler.\n\t\tassert(\n\t\t\tthis.services !== undefined,\n\t\t\t0x07a /* \"Services should be there to attach delta handler\" */,\n\t\t);\n\t\t// attachDeltaHandler is only called after services is assigned\n\t\tthis.services.deltaConnection.attach({\n\t\t\tprocessMessages: (messagesCollection: IRuntimeMessageCollection) => {\n\t\t\t\tthis.processMessages(messagesCollection);\n\t\t\t},\n\t\t\tsetConnectionState: (connected: boolean) => {\n\t\t\t\tthis.setConnectionState(connected);\n\t\t\t},\n\t\t\treSubmit: (content: unknown, localOpMetadata: unknown) => {\n\t\t\t\tthis.reSubmit(content, localOpMetadata);\n\t\t\t},\n\t\t\tapplyStashedOp: (content: unknown): void => {\n\t\t\t\tthis.applyStashedOp(parseHandles(content, this.serializer));\n\t\t\t},\n\t\t\trollback: (content: unknown, localOpMetadata: unknown) => {\n\t\t\t\tthis.rollback(content, localOpMetadata);\n\t\t\t},\n\t\t} satisfies IDeltaHandler);\n\t}\n\n\t/**\n\t * Set the state of connection to services.\n\t * @param connected - true if connected, false otherwise.\n\t */\n\tprivate setConnectionState(connected: boolean): void {\n\t\t// only an attached shared object can transition its\n\t\t// connected state. This is defensive, as some\n\t\t// of our test harnesses don't handle this correctly\n\t\tif (!this.isAttached() || this._connected === connected) {\n\t\t\t// Not changing state, nothing the same.\n\t\t\treturn;\n\t\t}\n\n\t\t// Should I change the state at the end? So that we *can't* send new stuff before we send old?\n\t\tthis._connected = connected;\n\n\t\tif (connected) {\n\t\t\t// Call this for now so that DDSes like ConsensusOrderedCollection that maintain their own pending\n\t\t\t// messages will work.\n\t\t\tthis.onConnect();\n\t\t} else {\n\t\t\t// Things that are true now...\n\t\t\t// - if we had a connection we can no longer send messages over it\n\t\t\t// - if we had outbound messages some may or may not be ACK'd. Won't know until next message\n\t\t\t//\n\t\t\t// - nack could get a new msn - but might as well do it in the join?\n\t\t\tthis.onDisconnect();\n\t\t}\n\t}\n\n\t/**\n\t * Handles a message being received from the remote delta server.\n\t * @param message - The message to process\n\t * @param local - Whether the message originated from the local client\n\t * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.\n\t * For messages from a remote client, this will be undefined.\n\t *\n\t * @deprecated Replaced by {@link SharedObjectCore.processMessages}.\n\t */\n\tprivate process(\n\t\tmessage: ISequencedDocumentMessage,\n\t\tlocal: boolean,\n\t\tlocalOpMetadata: unknown,\n\t): void {\n\t\tthis.verifyNotClosed(); // This will result in container closure.\n\t\tthis.emitInternal(\"pre-op\", message, local, this);\n\n\t\tthis.opProcessingHelper.measure(\n\t\t\t(): ICustomData<ProcessTelemetryProperties> => {\n\t\t\t\tthis.processCore(message, local, localOpMetadata);\n\t\t\t\tconst telemetryProperties: ProcessTelemetryProperties = {\n\t\t\t\t\tsequenceDifference: message.sequenceNumber - message.referenceSequenceNumber,\n\t\t\t\t};\n\t\t\t\treturn {\n\t\t\t\t\tcustomData: telemetryProperties,\n\t\t\t\t};\n\t\t\t},\n\t\t\tlocal ? \"local\" : \"remote\",\n\t\t);\n\n\t\tthis.emitInternal(\"op\", message, local, this);\n\t}\n\n\t/* eslint-disable jsdoc/check-indentation */\n\t/**\n\t * Process a bunch of messages for this shared object. A bunch is group of messages that have the following properties:\n\t * - They are all part of the same grouped batch, which entails:\n\t *   - They are contiguous in sequencing order.\n\t *   - They are all from the same client.\n\t *   - They are all based on the same reference sequence number.\n\t *   - They are not interleaved with messages from other clients.\n\t * - They are not interleaved with messages from other DDS in the container.\n\t * @param messageCollection - The collection of messages to process.\n\t *\n\t */\n\t/* eslint-enable jsdoc/check-indentation */\n\tprivate processMessages(messagesCollection: IRuntimeMessageCollection): void {\n\t\tthis.verifyNotClosed(); // This will result in container closure.\n\n\t\t// Decode any handles in the contents before processing the messages.\n\t\tconst decodedMessagesContent: IRuntimeMessagesContent[] = [];\n\t\tfor (const {\n\t\t\tcontents,\n\t\t\tlocalOpMetadata,\n\t\t\tclientSequenceNumber,\n\t\t} of messagesCollection.messagesContent) {\n\t\t\tconst decodedMessageContent: IRuntimeMessagesContent = {\n\t\t\t\tcontents: parseHandles(contents, this.serializer),\n\t\t\t\tlocalOpMetadata,\n\t\t\t\tclientSequenceNumber,\n\t\t\t};\n\t\t\tdecodedMessagesContent.push(decodedMessageContent);\n\t\t}\n\n\t\tconst decodedMessagesCollection: IRuntimeMessageCollection = {\n\t\t\t...messagesCollection,\n\t\t\tmessagesContent: decodedMessagesContent,\n\t\t};\n\t\tthis.processMessagesHelper(decodedMessagesCollection);\n\t}\n\n\t/**\n\t * Called when a message has to be resubmitted. This typically happens for unacked messages after a\n\t * reconnection.\n\t * @param content - The content of the original message.\n\t * @param localOpMetadata - The local metadata associated with the original message.\n\t */\n\tprivate reSubmit(content: unknown, localOpMetadata: unknown): void {\n\t\tthis.reSubmitCore(content, localOpMetadata);\n\t}\n\n\t/**\n\t * Revert an op\n\t */\n\tprotected rollback(content: unknown, localOpMetadata: unknown): void {\n\t\tthrow new Error(\"rollback not supported\");\n\t}\n\n\t/**\n\t * Apply changes from the provided op content just as if a local client has made the change,\n\t * including submitting the op. Used when rehydrating an attached container\n\t * with pending changes. The rehydration process replays all remote ops\n\t * and applies stashed ops after the remote op with a sequence number\n\t * that matches that of the stashed op is applied. This ensures\n\t * stashed ops are applied at the same state they were originally created.\n\t *\n\t * It is possible that stashed ops have been sent in the past, and will be found when\n\t * the shared object catches up with remotes ops.\n\t * So this prepares the SharedObject for seeing potentially seeing the ACK.\n\t * If no matching remote op is found, all the applied stashed ops will go\n\t * through the normal resubmit flow upon reconnection, which allows the dds\n\t * to rebase them to the latest state, and then resubmit them.\n\t *\n\t * @param content - Contents of a stashed op.\n\t */\n\tprotected abstract applyStashedOp(content: unknown): void;\n\n\t/**\n\t * Emit an event. This function is only intended for use by DDS classes that extend SharedObject/SharedObjectCore,\n\t * specifically to emit events that are part of the public interface of the DDS (i.e. those that can have listeners\n\t * attached to them by the consumers of the DDS). It should not be called from outside the class or to emit events\n\t * which are only internal to the DDS. Support for calling it from outside the DDS instance might be removed in the\n\t * future.\n\t * @param event - The event to emit.\n\t * @param args - Arguments to pass to the event listeners.\n\t * @returns `true` if the event had listeners, `false` otherwise.\n\t */\n\tpublic emit(event: EventEmitterEventType, ...args: any[]): boolean {\n\t\treturn this.callbacksHelper.measure(() => {\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-argument\n\t\t\treturn super.emit(event, ...args);\n\t\t});\n\t}\n\n\t/**\n\t * Use to emit events inside {@link SharedObjectCore}, with no telemetry measurement\n\t * done on the duration of the callbacks. Simply calls `super.emit()`.\n\t * @param event - Event to emit\n\t * @param args - Arguments for the event\n\t * @returns Whatever `super.emit()` returns.\n\t */\n\tprivate emitInternal(event: EventEmitterEventType, ...args: unknown[]): boolean {\n\t\treturn super.emit(event, ...args);\n\t}\n}\n\n/**\n * SharedObject with simplified, synchronous summarization and GC.\n * DDS implementations with async and incremental summarization should extend SharedObjectCore directly instead.\n * @legacy\n * @alpha\n */\nexport abstract class SharedObject<\n\tTEvent extends ISharedObjectEvents = ISharedObjectEvents,\n> extends SharedObjectCore<TEvent> {\n\t/**\n\t * True while we are garbage collecting this object's data.\n\t */\n\tprivate _isGCing: boolean = false;\n\n\t/**\n\t * The serializer to use to serialize / parse handles, if any.\n\t */\n\tprivate readonly _serializer: IFluidSerializer;\n\n\tprotected get serializer(): IFluidSerializer {\n\t\t/**\n\t\t * During garbage collection, the GCHandleVisitor \"serializer\" keeps track of IFluidHandles that are serialized. These\n\t\t * handles represent references to other Fluid objects.\n\t\t *\n\t\t * This is fine for now. However, if we implement delay loading in DDSes, they may load and de-serialize content\n\t\t * in summarize. When that happens, they may incorrectly hit this assert and we will have to change this.\n\t\t */\n\t\tassert(\n\t\t\t!this._isGCing,\n\t\t\t0x075 /* \"SummarySerializer should be used for serializing data during summary.\" */,\n\t\t);\n\t\treturn this._serializer;\n\t}\n\n\t/**\n\t * @param id - The id of the shared object\n\t * @param runtime - The IFluidDataStoreRuntime which contains the shared object\n\t * @param attributes - Attributes of the shared object\n\t */\n\tconstructor(\n\t\tid: string,\n\t\truntime: IFluidDataStoreRuntime,\n\t\tattributes: IChannelAttributes,\n\t\tprivate readonly telemetryContextPrefix: string,\n\t) {\n\t\tsuper(id, runtime, attributes);\n\n\t\tthis._serializer = new FluidSerializer(this.runtime.channelsRoutingContext);\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}\n\t */\n\tpublic getAttachSummary(\n\t\tfullTree: boolean = false,\n\t\ttrackState: boolean = false,\n\t\ttelemetryContext?: ITelemetryContext,\n\t): ISummaryTreeWithStats {\n\t\tconst result = this.summarizeCore(this.serializer, telemetryContext);\n\t\tthis.incrementTelemetryMetric(\n\t\t\tblobCountPropertyName,\n\t\t\tresult.stats.blobNodeCount,\n\t\t\ttelemetryContext,\n\t\t);\n\t\tthis.incrementTelemetryMetric(\n\t\t\ttotalBlobSizePropertyName,\n\t\t\tresult.stats.totalBlobSize,\n\t\t\ttelemetryContext,\n\t\t);\n\t\treturn result;\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}\n\t */\n\tpublic async summarize(\n\t\tfullTree: boolean = false,\n\t\ttrackState: boolean = false,\n\t\ttelemetryContext?: ITelemetryContext,\n\t\tincrementalSummaryContext?: IExperimentalIncrementalSummaryContext,\n\t): Promise<ISummaryTreeWithStats> {\n\t\tconst result = this.summarizeCore(\n\t\t\tthis.serializer,\n\t\t\ttelemetryContext,\n\t\t\tincrementalSummaryContext,\n\t\t);\n\t\tthis.incrementTelemetryMetric(\n\t\t\tblobCountPropertyName,\n\t\t\tresult.stats.blobNodeCount,\n\t\t\ttelemetryContext,\n\t\t);\n\t\tthis.incrementTelemetryMetric(\n\t\t\ttotalBlobSizePropertyName,\n\t\t\tresult.stats.totalBlobSize,\n\t\t\ttelemetryContext,\n\t\t);\n\t\treturn result;\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getGCData}\n\t */\n\tpublic getGCData(fullGC: boolean = false): IGarbageCollectionData {\n\t\t// Set _isGCing to true. This flag is used to ensure that we only use GCHandleVisitor in this codepath and not when trying to truly serialize.\n\t\tassert(\n\t\t\t!this._isGCing,\n\t\t\t0x078 /* \"Possible re-entrancy! Summary should not already be in progress.\" */,\n\t\t);\n\t\tthis._isGCing = true;\n\n\t\tlet gcData: IGarbageCollectionData;\n\t\ttry {\n\t\t\tconst handleVisitor = new GCHandleVisitor(this.runtime.channelsRoutingContext);\n\t\t\tthis.processGCDataCore(handleVisitor);\n\t\t\t// The GC data for this shared object contains a single GC node. The outbound routes of this node are the\n\t\t\t// routes of handles serialized during summarization.\n\t\t\tgcData = { gcNodes: { \"/\": handleVisitor.getVisitedHandlePaths() } };\n\t\t\tassert(\n\t\t\t\tthis._isGCing,\n\t\t\t\t0x079 /* \"Possible re-entrancy! Summary should have been in progress.\" */,\n\t\t\t);\n\t\t} finally {\n\t\t\tthis._isGCing = false;\n\t\t}\n\n\t\treturn gcData;\n\t}\n\n\t/**\n\t * Calls the serializer over all data in this object that reference other GC nodes.\n\t * Derived classes must override this to provide custom list of references to other GC nodes.\n\t *\n\t * @remarks Serialization itself doesn't matter (the result is ignored). We're tapping into the serialization infrastructure\n\t * as a way to visit all the content in this content that may reference other objects via handle.\n\t *\n\t * @param serializer - The \"serializer\" (more like handle visitor) to use.\n\t * Implementations should ensure that serialize is called on all handles, as the way to visit them.\n\t */\n\tprotected processGCDataCore(serializer: IFluidSerializer): void {\n\t\t// We run the full summarize logic to get the list of outbound routes from this object. This is a little\n\t\t// expensive but its okay for now. It will be updated to not use full summarize and make it more efficient.\n\t\t// See: https://github.com/microsoft/FluidFramework/issues/4547\n\t\tthis.summarizeCore(serializer);\n\t}\n\n\t/**\n\t * Gets a form of the object that can be serialized.\n\t * @returns A tree representing the snapshot of the shared object.\n\t */\n\tprotected abstract summarizeCore(\n\t\tserializer: IFluidSerializer,\n\t\ttelemetryContext?: ITelemetryContext,\n\t\tincrementalSummaryContext?: IExperimentalIncrementalSummaryContext,\n\t): ISummaryTreeWithStats;\n\n\tprivate incrementTelemetryMetric(\n\t\tpropertyName: string,\n\t\tincrementBy: number,\n\t\ttelemetryContext?: ITelemetryContext,\n\t): void {\n\t\tif (telemetryContext !== undefined) {\n\t\t\t// TelemetryContext needs to implment a get function\n\t\t\tassert(\n\t\t\t\t\"get\" in telemetryContext && typeof telemetryContext.get === \"function\",\n\t\t\t\t0x97e /* received context must have a get function */,\n\t\t\t);\n\n\t\t\tconst prevTotal = ((telemetryContext as TelemetryContext).get(\n\t\t\t\tthis.telemetryContextPrefix,\n\t\t\t\tpropertyName,\n\t\t\t) ?? 0) as number;\n\t\t\ttelemetryContext.set(this.telemetryContextPrefix, propertyName, prevTotal + incrementBy);\n\t\t}\n\t}\n}\n\n/**\n * Defines a kind of shared object.\n * Used in containers to register a shared object implementation, and to create new instances of a given type of shared object.\n *\n * @remarks\n * For use internally and in the \"encapsulated API\".\n * See {@link SharedObjectKind} for the type erased version for use in the public declarative API.\n *\n * @privateRemarks\n * This does not extend {@link SharedObjectKind} since doing so would prevent implementing this interface in type safe code.\n * Any implementation of this can safely be used as a {@link SharedObjectKind} with an explicit type conversion,\n * but doing so is typically not needed as {@link createSharedObjectKind} is used to produce values that are both types simultaneously.\n * @legacy\n * @alpha\n */\nexport interface ISharedObjectKind<TSharedObject> {\n\t/**\n\t * Get a factory which can be used by the Fluid Framework to programmatically instantiate shared objects within containers.\n\t * @remarks\n\t * The produced factory is intended for use with the FluidDataStoreRegistry and is used by the Fluid Framework to instantiate already existing Channels.\n\t * To create new shared objects use:\n\t *\n\t * - {@link @fluidframework/fluid-static#IFluidContainer.create} if using `@fluidframework/fluid-static`, for example via `@fluidframework/azure-client`.\n\t *\n\t * - {@link ISharedObjectKind.create} if using a custom container definitions (and thus not using {@link @fluidframework/fluid-static#IFluidContainer}).\n\t */\n\tgetFactory(): IChannelFactory<TSharedObject>;\n\n\t/**\n\t * Create a shared object.\n\t * @param runtime - The data store runtime that the new shared object belongs to.\n\t * @param id - Optional name of the shared object.\n\t * @returns Newly created shared object.\n\t *\n\t * @example\n\t * To create a `SharedTree`, call the static create method:\n\t *\n\t * ```typescript\n\t * const myTree = SharedTree.create(this.runtime, id);\n\t * ```\n\t * @remarks\n\t * The created object is local (detached): insert a handle to it into an attached object to share (attach) it.\n\t * If using `@fluidframework/fluid-static` (for example via `@fluidframework/azure-client`), use {@link @fluidframework/fluid-static#IFluidContainer.create} instead of calling this directly.\n\t *\n\t * @privateRemarks\n\t * This can only be used with a `MockFluidDataStoreRuntime` when that mock is created with a `registry` containing a factory for this shared object.\n\t */\n\tcreate(runtime: IFluidDataStoreRuntime, id?: string): TSharedObject;\n}\n\n/**\n * Defines a kind of shared object.\n * @remarks\n * Used in containers to register a shared object implementation, and to create new instances of a given type of shared object.\n * See {@link @fluidframework/fluid-static#IFluidContainer.create} and {@link @fluidframework/fluid-static#ContainerSchema} for details.\n * @privateRemarks\n * Part of the \"declarative API\".\n * Type erased reference to an {@link ISharedObjectKind} or a DataObject class in for use in\n * `fluid-static`'s `IFluidContainer` and `ContainerSchema`.\n * Use {@link createSharedObjectKind} to creating an instance of this type.\n * @sealed\n * @public\n */\nexport interface SharedObjectKind<out TSharedObject = unknown>\n\textends ErasedType<readonly [\"SharedObjectKind\", TSharedObject]> {\n\t/**\n\t * Check whether an {@link @fluidframework/core-interfaces#IFluidLoadable} is an instance of this shared object kind.\n\t * @remarks This should be used in place of `instanceof` checks for shared objects, as their actual classes are not exported in Fluid's public API.\n\t */\n\tis(value: IFluidLoadable): value is IFluidLoadable & TSharedObject;\n}\n\n/**\n * Utility for creating ISharedObjectKind instances.\n * @remarks\n * This takes in a class which implements IChannelFactory,\n * and uses it to return a a single value which is intended to be used as the API entry point for the corresponding shared object type.\n * The returned value implements {@link ISharedObjectKind} for use in the encapsulated API, as well as the type erased {@link SharedObjectKind} used by the declarative API.\n * See {@link @fluidframework/fluid-static#ContainerSchema} for how this is used in the declarative API.\n * @internal\n */\nexport function createSharedObjectKind<TSharedObject>(\n\tfactory: (new () => IChannelFactory<TSharedObject>) & { readonly Type: string },\n): ISharedObjectKind<TSharedObject> & SharedObjectKind<TSharedObject> {\n\tconst result: ISharedObjectKind<TSharedObject> &\n\t\tOmit<SharedObjectKind<TSharedObject>, \"brand\"> = {\n\t\tgetFactory(): IChannelFactory<TSharedObject> {\n\t\t\treturn new factory();\n\t\t},\n\n\t\tcreate(runtime: IFluidDataStoreRuntime, id?: string): TSharedObject {\n\t\t\treturn runtime.createChannel(id, factory.Type) as TSharedObject;\n\t\t},\n\n\t\tis(value: IFluidLoadable): value is IFluidLoadable & TSharedObject {\n\t\t\treturn isChannel(value) && value.attributes.type === factory.Type;\n\t\t},\n\t};\n\n\treturn result as typeof result & SharedObjectKind<TSharedObject>;\n}\n\nfunction isChannel(loadable: IFluidLoadable): loadable is IChannel {\n\t// This assumes no other IFluidLoadable has an `attributes` field, and thus may not be fully robust.\n\treturn (loadable as IChannel).attributes !== undefined;\n}\n\n/**\n * Utility that processes the given messages in the message collection together by calling `processMessagesCore`.\n * This will be called when {@link SharedObjectCore.processMessagesCore} is defined.\n */\nfunction processMessagesCoreHelper(\n\tmessagesCollection: IRuntimeMessageCollection,\n\topProcessingHelper: SampledTelemetryHelper<void, ProcessTelemetryProperties>,\n\temitInternal: (\n\t\tevent: \"pre-op\" | \"op\",\n\t\top: ISequencedDocumentMessage,\n\t\tlocal: boolean,\n\t) => void,\n\tprocessMessagesCore: (messagesCollection: IRuntimeMessageCollection) => void,\n): void {\n\tconst { envelope, local, messagesContent } = messagesCollection;\n\n\tconst emitEvents = (\n\t\tevent: \"pre-op\" | \"op\",\n\t\tmessagesContentForEvent: readonly IRuntimeMessagesContent[],\n\t): void => {\n\t\tfor (const { contents, clientSequenceNumber } of messagesContentForEvent) {\n\t\t\tconst message: ISequencedDocumentMessage = {\n\t\t\t\t...envelope,\n\t\t\t\tcontents,\n\t\t\t\tclientSequenceNumber,\n\t\t\t};\n\t\t\temitInternal(event, message, local);\n\t\t}\n\t};\n\n\temitEvents(\"pre-op\", messagesContent);\n\topProcessingHelper.measure(\n\t\t(): ICustomData<ProcessTelemetryProperties> => {\n\t\t\tprocessMessagesCore(messagesCollection);\n\t\t\tconst telemetryProperties: ProcessTelemetryProperties = {\n\t\t\t\tsequenceDifference: envelope.sequenceNumber - envelope.referenceSequenceNumber,\n\t\t\t};\n\t\t\treturn {\n\t\t\t\tcustomData: telemetryProperties,\n\t\t\t};\n\t\t},\n\t\tlocal ? \"local\" : \"remote\",\n\t);\n\temitEvents(\"op\", messagesContent);\n}\n\n/**\n * Utility that processes the given messages in the message collection one by one by calling `process`. This will\n * be called when {@link SharedObjectCore.processMessagesCore} is not defined.\n */\nfunction processHelper(\n\tmessagesCollection: IRuntimeMessageCollection,\n\tprocess: (\n\t\tmessage: ISequencedDocumentMessage,\n\t\tlocal: boolean,\n\t\tlocalOpMetadata: unknown,\n\t) => void,\n): void {\n\tconst { envelope, local, messagesContent } = messagesCollection;\n\tfor (const { contents, localOpMetadata, clientSequenceNumber } of messagesContent) {\n\t\tprocess(\n\t\t\t{\n\t\t\t\t...envelope,\n\t\t\t\tcontents,\n\t\t\t\tclientSequenceNumber,\n\t\t\t},\n\t\t\tlocal,\n\t\t\tlocalOpMetadata,\n\t\t);\n\t}\n}\n"]}
+{"version":3,"file":"sharedObject.js","sourceRoot":"","sources":["../src/sharedObject.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,iFAAoE;AAOpE,kEAA6D;AAe7D,2EASsD;AACtD,qEAGgD;AAChD,uEAWkD;AAClD,+BAAkC;AAElC,6DAAuD;AACvD,2CAAiD;AACjD,mDAAoE;AAEpE,yCAAgF;AAWhF;;;;;;;;;;;;;;;GAeG;AACH,MAAsB,gBAGrB,SAAQ,wCAAqC;IAG7C,IAAW,cAAc;QACxB,OAAO,IAAI,CAAC;IACb,CAAC;IAuCD;;;OAGG;IACH,IAAW,SAAS;QACnB,OAAO,IAAI,CAAC,UAAU,CAAC;IACxB,CAAC;IAED;IACC;;OAEG;IACI,EAAU;IACjB;;OAEG;IACO,OAA+B;IACzC;;OAEG;IACa,UAA8B;QAE9C,KAAK,CAAC,CAAC,KAA4B,EAAE,CAAU,EAAE,EAAE,CAClD,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,CAAC,CAAC,CACxC,CAAC;QAZK,OAAE,GAAF,EAAE,CAAQ;QAIP,YAAO,GAAP,OAAO,CAAwB;QAIzB,eAAU,GAAV,UAAU,CAAoB;QAxC/C;;WAEG;QACK,eAAU,GAAG,KAAK,CAAC;QAO3B;;WAEG;QACK,sBAAiB,GAAY,KAAK,CAAC;QAiC1C,IAAA,iBAAM,EAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,+BAA+B,CAAC,CAAC;QAEjE,IAAI,CAAC,MAAM,GAAG,IAAI,8BAAkB,CAAC,IAAI,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;QAExD,IAAI,CAAC,MAAM,GAAG,IAAA,4BAAiB,EAAC;YAC/B,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,UAAU,EAAE;gBACX,GAAG,EAAE;oBACJ,cAAc,EAAE,IAAA,SAAI,GAAE;oBACtB,GAAG,IAAA,2BAAgB,EAAC;wBACnB,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI;qBAC7B,CAAC;iBACF;aACD;SACD,CAAC,CAAC;QACH,IAAI,CAAC,EAAE,GAAG,IAAA,oCAAyB,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEjD,MAAM,EAAE,kBAAkB,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC,4BAA4B,EAAE,CAAC;QACpF,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC7C,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QAEvC,MAAM,mBAAmB,GAAG,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACjE,IAAI,CAAC,qBAAqB;YACzB,mBAAmB,KAAK,SAAS;gBAChC,CAAC,CAAC,CAAC,kBAA6C,EAAE,EAAE,CAClD,aAAa,CAAC,kBAAkB,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC5D,CAAC,CAAC,CAAC,kBAA6C,EAAE,EAAE;oBAClD,yBAAyB,CACxB,kBAAkB,EAClB,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAC5B,mBAAmB,CACnB,CAAC;gBACH,CAAC,CAAC;IACN,CAAC;IAED;;OAEG;IACH,IAAc,YAAY;QACzB,OAAO,IAAA,iCAAsB,EAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;OAKG;IACK,4BAA4B;QAInC,IAAA,iBAAM,EACL,IAAI,CAAC,EAAE,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAClD,KAAK,CAAC,iDAAiD,CACvD,CAAC;QACF,MAAM,kBAAkB,GAAG,IAAI,iCAAsB,CACpD;YACC,SAAS,EAAE,iBAAiB;YAC5B,QAAQ,EAAE,aAAa;SACvB,EACD,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,kDAAkD,CAAC,IAAI,IAAI,EACpF,IAAI,EACJ,IAAI,GAAG,CAAmC;YACzC,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;YAC5B,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;SAC9B,CAAC,CACF,CAAC;QACF,MAAM,eAAe,GAAG,IAAI,iCAAsB,CACjD;YACC,SAAS,EAAE,mBAAmB;YAC9B,QAAQ,EAAE,aAAa;SACvB,EACD,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,kDAAkD,CAAC,IAAI,IAAI,EACpF,IAAI,CACJ,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE;YACjC,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC;YAC/B,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,CAAC;QACnC,CAAC,CAAC,CAAC;QAEH,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACK,cAAc,CAAC,KAAkC;QACxD,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACnC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QACzB,CAAC;IACF,CAAC;IAED;;OAEG;IACK,eAAe;QACtB,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACnC,MAAM,IAAI,CAAC,UAAU,CAAC;QACvB,CAAC;IACF,CAAC;IAED;;;;;;;;;OASG;IACK,yBAAyB,CAAC,KAA4B,EAAE,CAAU;QACzE,MAAM,KAAK,GAAG,8BAAmB,CAAC,kBAAkB,CACnD,CAAC,EACD,oCAAoC,CACpC,CAAC;QACF,KAAK,CAAC,sBAAsB,CAAC,EAAE,gBAAgB,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAElE,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAC3B,MAAM,KAAK,CAAC;IACb,CAAC;IAEO,uBAAuB;QAC9B,4EAA4E;QAC5E,mEAAmE;QACnE,oCAAoC;QACpC,IAAI,CAAC,uBAAuB,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACrF,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAC9B,+DAA+D;QAC/D,MAAM,YAAY,GAAe,GAAG,EAAE;YACrC,gEAAgE;YAChE,IAAI,CAAC,SAAS,EAAE,CAAC;YACjB,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACjD,CAAC,CAAC;QACF,IAAI,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;YACvB,YAAY,EAAE,CAAC;QAChB,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;QAC9C,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,CAAC,QAA0B;QAC3C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,kDAAkD;QAClD,kDAAkD;QAClD,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAC9B,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QAC5C,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,IAAI,CAAC,uBAAuB,EAAE,CAAC;IAChC,CAAC;IAED;;;OAGG;IACI,eAAe;QACrB,IAAI,CAAC,mBAAmB,EAAE,CAAC;IAC5B,CAAC;IAED;;OAEG;IACI,aAAa;QACnB,kEAAkE;QAClE,0DAA0D;QAC1D,IAAI,CAAC,aAAa,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC;QAC9B,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC7B,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YAC/B,gEAAgE;YAChE,6BAA6B;YAC7B,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAChC,CAAC;IACF,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,QAA0B;QACxC,uCAAuC;QACvC,+CAA+C;QAC/C,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACjC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;YACzB,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC3B,CAAC;QAED,IAAI,CAAC,uBAAuB,EAAE,CAAC;IAChC,CAAC;IAED;;OAEG;IACI,UAAU;QAChB,OAAO,IAAI,CAAC,iBAAiB,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,mCAAW,CAAC,QAAQ,CAAC;IACpF,CAAC;IA+BD;;OAEG;IACO,mBAAmB;QAC5B,OAAO;IACR,CAAC;IAED;;;OAGG;IACO,SAAS;QAClB,OAAO;IACR,CAAC;IAwDD;;;;;;;OAOG;IACO,kBAAkB,CAAC,OAAgB,EAAE,kBAA2B,SAAS;QAClF,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,IAAI,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;YACvB,+DAA+D;YAC/D,0FAA0F;YAC1F,MAAM,QAAQ,GACZ,IAAI,CAAC,OAAgD;iBACpD,oCAAoC,KAAK,IAAI,CAAC;YACjD,MAAM,eAAe,GAAG,QAAQ;gBAC/B,CAAC,CAAC,IAAA,sBAAW,EAAC,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC;gBACpD,CAAC,CAAC,IAAA,kCAAuB,EAAC,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YAElE,oEAAoE;YACpE,IAAI,CAAC,QAAS,CAAC,eAAe,CAAC,MAAM,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;QACzE,CAAC;IACF,CAAC;IAED;;;OAGG;IACO,KAAK;QACd,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;YACxB,OAAO;QACR,CAAC;QAED,oEAAoE;QACpE,IAAI,CAAC,QAAS,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;IACxC,CAAC;IAED;;;OAGG;IACO,SAAS,KAAU,CAAC;IAE9B;;;;;;;OAOG;IACO,YAAY,CAAC,OAAgB,EAAE,eAAwB;QAChE,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IACnD,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,kBAAkB,CACjC,QAGS;QAET,IAAI,oBAAgC,CAAC;QACrC,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACzC,oBAAoB,GAAG,GAAG,EAAE,CAC3B,MAAM,CACL,IAAI,KAAK,CAAC,yEAAyE,CAAC,CACpF,CAAC;YAEH,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;gBAC3B,oBAAoB,EAAE,CAAC;gBACvB,OAAO;YACR,CAAC;YAED,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC;YACjD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE;YACf,0DAA0D;YAC1D,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;IACJ,CAAC;IAEO,kBAAkB;QACzB,2EAA2E;QAC3E,IAAA,iBAAM,EACL,IAAI,CAAC,QAAQ,KAAK,SAAS,EAC3B,KAAK,CAAC,wDAAwD,CAC9D,CAAC;QACF,+DAA+D;QAC/D,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,MAAM,CAAC;YACpC,eAAe,EAAE,CAAC,kBAA6C,EAAE,EAAE;gBAClE,IAAI,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC;YAC1C,CAAC;YACD,kBAAkB,EAAE,CAAC,SAAkB,EAAE,EAAE;gBAC1C,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;YACpC,CAAC;YACD,QAAQ,EAAE,CAAC,OAAgB,EAAE,eAAwB,EAAE,EAAE;gBACxD,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;YACzC,CAAC;YACD,cAAc,EAAE,CAAC,OAAgB,EAAQ,EAAE;gBAC1C,IAAI,CAAC,cAAc,CAAC,IAAA,uBAAY,EAAC,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;YAC7D,CAAC;YACD,QAAQ,EAAE,CAAC,OAAgB,EAAE,eAAwB,EAAE,EAAE;gBACxD,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;YACzC,CAAC;SACuB,CAAC,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACK,kBAAkB,CAAC,SAAkB;QAC5C,oDAAoD;QACpD,8CAA8C;QAC9C,oDAAoD;QACpD,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACzD,wCAAwC;YACxC,OAAO;QACR,CAAC;QAED,8FAA8F;QAC9F,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAE5B,IAAI,SAAS,EAAE,CAAC;YACf,kGAAkG;YAClG,sBAAsB;YACtB,IAAI,CAAC,SAAS,EAAE,CAAC;QAClB,CAAC;aAAM,CAAC;YACP,8BAA8B;YAC9B,kEAAkE;YAClE,4FAA4F;YAC5F,EAAE;YACF,oEAAoE;YACpE,IAAI,CAAC,YAAY,EAAE,CAAC;QACrB,CAAC;IACF,CAAC;IAED;;;;;;;;OAQG;IACK,OAAO,CACd,OAAkC,EAClC,KAAc,EACd,eAAwB;QAExB,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC,yCAAyC;QACjE,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;QAElD,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAC9B,GAA4C,EAAE;YAC7C,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,EAAE,eAAe,CAAC,CAAC;YAClD,MAAM,mBAAmB,GAA+B;gBACvD,kBAAkB,EAAE,OAAO,CAAC,cAAc,GAAG,OAAO,CAAC,uBAAuB;aAC5E,CAAC;YACF,OAAO;gBACN,UAAU,EAAE,mBAAmB;aAC/B,CAAC;QACH,CAAC,EACD,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAC1B,CAAC;QAEF,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED,4CAA4C;IAC5C;;;;;;;;;;OAUG;IACH,2CAA2C;IACnC,eAAe,CAAC,kBAA6C;QACpE,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC,yCAAyC;QAEjE,qEAAqE;QACrE,MAAM,sBAAsB,GAA8B,EAAE,CAAC;QAC7D,KAAK,MAAM,EACV,QAAQ,EACR,eAAe,EACf,oBAAoB,GACpB,IAAI,kBAAkB,CAAC,eAAe,EAAE,CAAC;YACzC,MAAM,qBAAqB,GAA4B;gBACtD,QAAQ,EAAE,IAAA,uBAAY,EAAC,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC;gBACjD,eAAe;gBACf,oBAAoB;aACpB,CAAC;YACF,sBAAsB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QACpD,CAAC;QAED,MAAM,yBAAyB,GAA8B;YAC5D,GAAG,kBAAkB;YACrB,eAAe,EAAE,sBAAsB;SACvC,CAAC;QACF,IAAI,CAAC,qBAAqB,CAAC,yBAAyB,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACK,QAAQ,CAAC,OAAgB,EAAE,eAAwB;QAC1D,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IAC7C,CAAC;IAED;;OAEG;IACO,QAAQ,CAAC,OAAgB,EAAE,eAAwB;QAC5D,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC3C,CAAC;IAqBD;;;;;;;;;OASG;IACI,IAAI,CAAC,KAA4B,EAAE,GAAG,IAAW;QACvD,OAAO,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,EAAE;YACxC,iEAAiE;YACjE,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACK,YAAY,CAAC,KAA4B,EAAE,GAAG,IAAe;QACpE,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;IACnC,CAAC;CACD;AAhpBD,4CAgpBC;AAED;;;;;;;;;;;GAWG;AACH,MAAsB,YAEpB,SAAQ,gBAAwB;IAWjC,IAAc,UAAU;QACvB;;;;;;WAMG;QACH,IAAA,iBAAM,EACL,CAAC,IAAI,CAAC,QAAQ,EACd,KAAK,CAAC,6EAA6E,CACnF,CAAC;QACF,OAAO,IAAI,CAAC,WAAW,CAAC;IACzB,CAAC;IAED,YACC,EAAU,EACV,OAA+B,EAC/B,UAA8B;IAC9B;;OAEG;IACc,sBAA8B;QAE/C,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAFd,2BAAsB,GAAtB,sBAAsB,CAAQ;QAhChD;;WAEG;QACK,aAAQ,GAAY,KAAK,CAAC;QAiCjC,IAAI,CAAC,WAAW,GAAG,IAAI,+BAAe,CAAC,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACI,gBAAgB,CACtB,WAAoB,KAAK,EACzB,aAAsB,KAAK,EAC3B,gBAAoC;QAEpC,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;QACrE,IAAI,CAAC,wBAAwB,CAC5B,gCAAqB,EACrB,MAAM,CAAC,KAAK,CAAC,aAAa,EAC1B,gBAAgB,CAChB,CAAC;QACF,IAAI,CAAC,wBAAwB,CAC5B,oCAAyB,EACzB,MAAM,CAAC,KAAK,CAAC,aAAa,EAC1B,gBAAgB,CAChB,CAAC;QACF,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,SAAS,CACrB,WAAoB,KAAK,EACzB,aAAsB,KAAK,EAC3B,gBAAoC,EACpC,yBAAkE;QAElE,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAChC,IAAI,CAAC,UAAU,EACf,gBAAgB,EAChB,yBAAyB,CACzB,CAAC;QACF,IAAI,CAAC,wBAAwB,CAC5B,gCAAqB,EACrB,MAAM,CAAC,KAAK,CAAC,aAAa,EAC1B,gBAAgB,CAChB,CAAC;QACF,IAAI,CAAC,wBAAwB,CAC5B,oCAAyB,EACzB,MAAM,CAAC,KAAK,CAAC,aAAa,EAC1B,gBAAgB,CAChB,CAAC;QACF,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,SAAkB,KAAK;QACvC,8IAA8I;QAC9I,IAAA,iBAAM,EACL,CAAC,IAAI,CAAC,QAAQ,EACd,KAAK,CAAC,wEAAwE,CAC9E,CAAC;QACF,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QAErB,IAAI,MAA8B,CAAC;QACnC,IAAI,CAAC;YACJ,MAAM,aAAa,GAAG,IAAI,oCAAe,CAAC,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;YAC/E,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;YACtC,yGAAyG;YACzG,qDAAqD;YACrD,MAAM,GAAG,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,aAAa,CAAC,qBAAqB,EAAE,EAAE,EAAE,CAAC;YACrE,IAAA,iBAAM,EACL,IAAI,CAAC,QAAQ,EACb,KAAK,CAAC,mEAAmE,CACzE,CAAC;QACH,CAAC;gBAAS,CAAC;YACV,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACvB,CAAC;QAED,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;;;;;;;OASG;IACO,iBAAiB,CAAC,UAA4B;QACvD,wGAAwG;QACxG,2GAA2G;QAC3G,+DAA+D;QAC/D,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IAChC,CAAC;IAYO,wBAAwB,CAC/B,YAAoB,EACpB,WAAmB,EACnB,gBAAoC;QAEpC,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;YACpC,oDAAoD;YACpD,IAAA,iBAAM,EACL,KAAK,IAAI,gBAAgB,IAAI,OAAO,gBAAgB,CAAC,GAAG,KAAK,UAAU,EACvE,KAAK,CAAC,+CAA+C,CACrD,CAAC;YAEF,MAAM,SAAS,GAAG,CAAE,gBAAqC,CAAC,GAAG,CAC5D,IAAI,CAAC,sBAAsB,EAC3B,YAAY,CACZ,IAAI,CAAC,CAAW,CAAC;YAClB,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,sBAAsB,EAAE,YAAY,EAAE,SAAS,GAAG,WAAW,CAAC,CAAC;QAC1F,CAAC;IACF,CAAC;CACD;AAtKD,oCAsKC;AA0ED;;;;;;;;GAQG;AACH,SAAgB,sBAAsB,CACrC,OAA+E;IAE/E,MAAM,MAAM,GACsC;QACjD,UAAU;YACT,OAAO,IAAI,OAAO,EAAE,CAAC;QACtB,CAAC;QAED,MAAM,CAAC,OAA+B,EAAE,EAAW;YAClD,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,CAAkB,CAAC;QACjE,CAAC;QAED,EAAE,CAAC,KAAqB;YACvB,OAAO,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC;QACnE,CAAC;KACD,CAAC;IAEF,OAAO,MAAyD,CAAC;AAClE,CAAC;AAnBD,wDAmBC;AAED,SAAS,SAAS,CAAC,QAAwB;IAC1C,oGAAoG;IACpG,OAAQ,QAAqB,CAAC,UAAU,KAAK,SAAS,CAAC;AACxD,CAAC;AAED;;;GAGG;AACH,SAAS,yBAAyB,CACjC,kBAA6C,EAC7C,kBAA4E,EAC5E,YAIS,EACT,mBAA4E;IAE5E,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,eAAe,EAAE,GAAG,kBAAkB,CAAC;IAEhE,MAAM,UAAU,GAAG,CAClB,KAAsB,EACtB,uBAA2D,EACpD,EAAE;QACT,KAAK,MAAM,EAAE,QAAQ,EAAE,oBAAoB,EAAE,IAAI,uBAAuB,EAAE,CAAC;YAC1E,MAAM,OAAO,GAA8B;gBAC1C,GAAG,QAAQ;gBACX,QAAQ;gBACR,oBAAoB;aACpB,CAAC;YACF,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QACrC,CAAC;IACF,CAAC,CAAC;IAEF,UAAU,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;IACtC,kBAAkB,CAAC,OAAO,CACzB,GAA4C,EAAE;QAC7C,mBAAmB,CAAC,kBAAkB,CAAC,CAAC;QACxC,MAAM,mBAAmB,GAA+B;YACvD,kBAAkB,EAAE,QAAQ,CAAC,cAAc,GAAG,QAAQ,CAAC,uBAAuB;SAC9E,CAAC;QACF,OAAO;YACN,UAAU,EAAE,mBAAmB;SAC/B,CAAC;IACH,CAAC,EACD,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAC1B,CAAC;IACF,UAAU,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;AACnC,CAAC;AAED;;;GAGG;AACH,SAAS,aAAa,CACrB,kBAA6C,EAC7C,OAIS;IAET,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,eAAe,EAAE,GAAG,kBAAkB,CAAC;IAChE,KAAK,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,oBAAoB,EAAE,IAAI,eAAe,EAAE,CAAC;QACnF,OAAO,CACN;YACC,GAAG,QAAQ;YACX,QAAQ;YACR,oBAAoB;SACpB,EACD,KAAK,EACL,eAAe,CACf,CAAC;IACH,CAAC;AACF,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { EventEmitterEventType } from \"@fluid-internal/client-utils\";\nimport { AttachState } from \"@fluidframework/container-definitions\";\nimport type { IDeltaManager } from \"@fluidframework/container-definitions/internal\";\nimport { ITelemetryBaseProperties, type ErasedType } from \"@fluidframework/core-interfaces\";\nimport {\n\ttype IFluidHandleInternal,\n\ttype IFluidLoadable,\n} from \"@fluidframework/core-interfaces/internal\";\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport {\n\tIChannelServices,\n\tIChannelStorageService,\n\ttype IChannel,\n\tIChannelAttributes,\n\ttype IChannelFactory,\n\tIFluidDataStoreRuntime,\n\ttype IDeltaHandler,\n\ttype IFluidDataStoreRuntimeInternalConfig,\n} from \"@fluidframework/datastore-definitions/internal\";\nimport {\n\ttype IDocumentMessage,\n\tISequencedDocumentMessage,\n} from \"@fluidframework/driver-definitions/internal\";\nimport {\n\tIExperimentalIncrementalSummaryContext,\n\tISummaryTreeWithStats,\n\tITelemetryContext,\n\tIGarbageCollectionData,\n\tblobCountPropertyName,\n\ttotalBlobSizePropertyName,\n\ttype IRuntimeMessageCollection,\n\ttype IRuntimeMessagesContent,\n} from \"@fluidframework/runtime-definitions/internal\";\nimport {\n\ttoDeltaManagerInternal,\n\tTelemetryContext,\n} from \"@fluidframework/runtime-utils/internal\";\nimport {\n\tITelemetryLoggerExt,\n\tDataProcessingError,\n\tEventEmitterWithErrorHandling,\n\tMonitoringContext,\n\tSampledTelemetryHelper,\n\tcreateChildLogger,\n\tloggerToMonitoringContext,\n\ttagCodeArtifacts,\n\ttype ICustomData,\n\ttype IFluidErrorBase,\n} from \"@fluidframework/telemetry-utils/internal\";\nimport { v4 as uuid } from \"uuid\";\n\nimport { GCHandleVisitor } from \"./gcHandleVisitor.js\";\nimport { SharedObjectHandle } from \"./handle.js\";\nimport { FluidSerializer, IFluidSerializer } from \"./serializer.js\";\nimport { ISharedObject, ISharedObjectEvents } from \"./types.js\";\nimport { bindHandles, makeHandlesSerializable, parseHandles } from \"./utils.js\";\n\n/**\n * Custom telemetry properties used in {@link SharedObjectCore} to instantiate {@link TelemetryEventBatcher} class.\n * This interface is used to define the properties that will be passed to the {@link TelemetryEventBatcher.measure} function\n * which is called in the {@link SharedObjectCore.process} method.\n */\ninterface ProcessTelemetryProperties {\n\tsequenceDifference: number;\n}\n\n/**\n * Base class from which all {@link ISharedObject|shared objects} derive.\n * @remarks\n * This class implements common behaviors that implementations of {@link ISharedObject} may want to reuse.\n * Even more such behaviors are implemented in the {@link SharedObject} class.\n * @privateRemarks\n * Currently some documentation (like the above) implies that this is supposed to be the only implementation of ISharedObject, which is both package-exported and not `@sealed`.\n * This situation should be clarified to indicate if other implementations of ISharedObject are allowed and just currently don't exist,\n * or if the intention is that no other implementations should exist and creating some might break things.\n * As part of this, any existing implementations of ISharedObject (via SharedObjectCore or otherwise) in use by legacy API users will need to be considered.\n *\n * TODO:\n * This class should eventually be made internal, as custom subclasses of it outside this repository are intended to be made unsupported in the future.\n * @legacy\n * @alpha\n */\nexport abstract class SharedObjectCore<\n\t\tTEvent extends ISharedObjectEvents = ISharedObjectEvents,\n\t>\n\textends EventEmitterWithErrorHandling<TEvent>\n\timplements ISharedObject<TEvent>\n{\n\tpublic get IFluidLoadable(): this {\n\t\treturn this;\n\t}\n\n\tprivate readonly opProcessingHelper: SampledTelemetryHelper<\n\t\tvoid,\n\t\tProcessTelemetryProperties\n\t>;\n\tprivate readonly callbacksHelper: SampledTelemetryHelper<boolean>;\n\n\t/**\n\t * The handle referring to this SharedObject\n\t */\n\tpublic readonly handle: IFluidHandleInternal;\n\n\t/**\n\t * Telemetry logger for the shared object\n\t */\n\tprotected readonly logger: ITelemetryLoggerExt;\n\tprivate readonly mc: MonitoringContext;\n\n\t/**\n\t * Connection state\n\t */\n\tprivate _connected = false;\n\n\t/**\n\t * Services used by the shared object\n\t */\n\tprivate services: IChannelServices | undefined;\n\n\t/**\n\t * True if the dds is bound to its parent.\n\t */\n\tprivate _isBoundToContext: boolean = false;\n\n\t/**\n\t * Tracks error that closed this object.\n\t */\n\tprivate closeError?: ReturnType<typeof DataProcessingError.wrapIfUnrecognized>;\n\n\t/**\n\t * Gets the connection state\n\t * @returns The state of the connection\n\t */\n\tpublic get connected(): boolean {\n\t\treturn this._connected;\n\t}\n\n\tconstructor(\n\t\t/**\n\t\t * The ID of the shared object.\n\t\t */\n\t\tpublic id: string,\n\t\t/**\n\t\t * The runtime instance that contains the Shared Object.\n\t\t */\n\t\tprotected runtime: IFluidDataStoreRuntime,\n\t\t/**\n\t\t * The attributes of the Shared Object.\n\t\t */\n\t\tpublic readonly attributes: IChannelAttributes,\n\t) {\n\t\tsuper((event: EventEmitterEventType, e: unknown) =>\n\t\t\tthis.eventListenerErrorHandler(event, e),\n\t\t);\n\n\t\tassert(!id.includes(\"/\"), 0x304 /* Id cannot contain slashes */);\n\n\t\tthis.handle = new SharedObjectHandle(this, id, runtime);\n\n\t\tthis.logger = createChildLogger({\n\t\t\tlogger: runtime.logger,\n\t\t\tproperties: {\n\t\t\t\tall: {\n\t\t\t\t\tsharedObjectId: uuid(),\n\t\t\t\t\t...tagCodeArtifacts({\n\t\t\t\t\t\tddsType: this.attributes.type,\n\t\t\t\t\t}),\n\t\t\t\t},\n\t\t\t},\n\t\t});\n\t\tthis.mc = loggerToMonitoringContext(this.logger);\n\n\t\tconst { opProcessingHelper, callbacksHelper } = this.setUpSampledTelemetryHelpers();\n\t\tthis.opProcessingHelper = opProcessingHelper;\n\t\tthis.callbacksHelper = callbacksHelper;\n\n\t\tconst processMessagesCore = this.processMessagesCore?.bind(this);\n\t\tthis.processMessagesHelper =\n\t\t\tprocessMessagesCore === undefined\n\t\t\t\t? (messagesCollection: IRuntimeMessageCollection) =>\n\t\t\t\t\t\tprocessHelper(messagesCollection, this.process.bind(this))\n\t\t\t\t: (messagesCollection: IRuntimeMessageCollection) => {\n\t\t\t\t\t\tprocessMessagesCoreHelper(\n\t\t\t\t\t\t\tmessagesCollection,\n\t\t\t\t\t\t\tthis.opProcessingHelper,\n\t\t\t\t\t\t\tthis.emitInternal.bind(this),\n\t\t\t\t\t\t\tprocessMessagesCore,\n\t\t\t\t\t\t);\n\t\t\t\t\t};\n\t}\n\n\t/**\n\t * Accessor for `this.runtime`'s {@link @fluidframework/datastore-definitions#IFluidDataStoreRuntime.deltaManager} as a {@link @fluidframework/container-definitions/internal#IDeltaManager}\n\t */\n\tprotected get deltaManager(): IDeltaManager<ISequencedDocumentMessage, IDocumentMessage> {\n\t\treturn toDeltaManagerInternal(this.runtime.deltaManager);\n\t}\n\n\t/**\n\t * This function is only supposed to be called from SharedObjectCore's constructor and\n\t * depends on a few things being set already. assert() calls make sure of it.\n\t * @returns The telemetry sampling helpers, so the constructor can be the one to assign them\n\t * to variables to avoid complaints from TypeScript.\n\t */\n\tprivate setUpSampledTelemetryHelpers(): {\n\t\topProcessingHelper: SampledTelemetryHelper<void, ProcessTelemetryProperties>;\n\t\tcallbacksHelper: SampledTelemetryHelper<boolean>;\n\t} {\n\t\tassert(\n\t\t\tthis.mc !== undefined && this.logger !== undefined,\n\t\t\t0x349 /* this.mc and/or this.logger has not been set */,\n\t\t);\n\t\tconst opProcessingHelper = new SampledTelemetryHelper<void, ProcessTelemetryProperties>(\n\t\t\t{\n\t\t\t\teventName: \"ddsOpProcessing\",\n\t\t\t\tcategory: \"performance\",\n\t\t\t},\n\t\t\tthis.logger,\n\t\t\tthis.mc.config.getNumber(\"Fluid.SharedObject.OpProcessingTelemetrySampling\") ?? 1000,\n\t\t\ttrue,\n\t\t\tnew Map<string, ITelemetryBaseProperties>([\n\t\t\t\t[\"local\", { localOp: true }],\n\t\t\t\t[\"remote\", { localOp: false }],\n\t\t\t]),\n\t\t);\n\t\tconst callbacksHelper = new SampledTelemetryHelper<boolean>(\n\t\t\t{\n\t\t\t\teventName: \"ddsEventCallbacks\",\n\t\t\t\tcategory: \"performance\",\n\t\t\t},\n\t\t\tthis.logger,\n\t\t\tthis.mc.config.getNumber(\"Fluid.SharedObject.DdsCallbacksTelemetrySampling\") ?? 1000,\n\t\t\ttrue,\n\t\t);\n\n\t\tthis.runtime.once(\"dispose\", () => {\n\t\t\tthis.callbacksHelper.dispose();\n\t\t\tthis.opProcessingHelper.dispose();\n\t\t});\n\n\t\treturn { opProcessingHelper, callbacksHelper };\n\t}\n\n\t/**\n\t * Marks this objects as closed. Any attempt to change it (local changes or processing remote ops)\n\t * would result in same error thrown. If called multiple times, only first error is remembered.\n\t * @param error - error object that is thrown whenever an attempt is made to modify this object\n\t */\n\tprivate closeWithError(error: IFluidErrorBase | undefined): void {\n\t\tif (this.closeError === undefined) {\n\t\t\tthis.closeError = error;\n\t\t}\n\t}\n\n\t/**\n\t * Verifies that this object is not closed via closeWithError(). If it is, throws an error used to close it.\n\t */\n\tprivate verifyNotClosed(): void {\n\t\tif (this.closeError !== undefined) {\n\t\t\tthrow this.closeError;\n\t\t}\n\t}\n\n\t/**\n\t * Event listener handler helper that can be used to react to exceptions thrown from event listeners\n\t * It wraps error with DataProcessingError, closes this object and throws resulting error.\n\t * See closeWithError() for more details\n\t * Ideally such situation never happens, as consumers of DDS should never throw exceptions\n\t * in event listeners (i.e. catch any of the issues and make determination on how to handle it).\n\t * When such exceptions propagate through, most likely data model is no longer consistent, i.e.\n\t * DDS state does not match what user sees. Because of it DDS moves to \"corrupted state\" and does not\n\t * allow processing of ops or local changes, which very quickly results in container closure.\n\t */\n\tprivate eventListenerErrorHandler(event: EventEmitterEventType, e: unknown): void {\n\t\tconst error = DataProcessingError.wrapIfUnrecognized(\n\t\t\te,\n\t\t\t\"SharedObjectEventListenerException\",\n\t\t);\n\t\terror.addTelemetryProperties({ emittedEventName: String(event) });\n\n\t\tthis.closeWithError(error);\n\t\tthrow error;\n\t}\n\n\tprivate setBoundAndHandleAttach(): void {\n\t\t// Ensure didAttach is only called once, and we only register a single event\n\t\t// but we still call setConnectionState as our existing mocks don't\n\t\t// always propagate connection state\n\t\tthis.setBoundAndHandleAttach = () => this.setConnectionState(this.runtime.connected);\n\t\tthis._isBoundToContext = true;\n\t\t// eslint-disable-next-line unicorn/consistent-function-scoping\n\t\tconst runDidAttach: () => void = () => {\n\t\t\t// Allows objects to do any custom processing if it is attached.\n\t\t\tthis.didAttach();\n\t\t\tthis.setConnectionState(this.runtime.connected);\n\t\t};\n\t\tif (this.isAttached()) {\n\t\t\trunDidAttach();\n\t\t} else {\n\t\t\tthis.runtime.once(\"attaching\", runDidAttach);\n\t\t}\n\t}\n\n\t/**\n\t * A shared object, after construction, can either be loaded in the case that it is already part of\n\t * a shared document. Or later attached if it is being newly added.\n\t * @param services - Services used by the shared object\n\t */\n\tpublic async load(services: IChannelServices): Promise<void> {\n\t\tthis.services = services;\n\t\t// set this before load so that isAttached is true\n\t\t// for attached runtimes when load core is running\n\t\tthis._isBoundToContext = true;\n\t\tawait this.loadCore(services.objectStorage);\n\t\tthis.attachDeltaHandler();\n\t\tthis.setBoundAndHandleAttach();\n\t}\n\n\t/**\n\t * Initializes the object as a local, non-shared object. This object can become shared after\n\t * it is attached to the document.\n\t */\n\tpublic initializeLocal(): void {\n\t\tthis.initializeLocalCore();\n\t}\n\n\t/**\n\t * {@inheritDoc (ISharedObject:interface).bindToContext}\n\t */\n\tpublic bindToContext(): void {\n\t\t// ensure the method only runs once by removing the implementation\n\t\t// without this the method suffers from re-entrancy issues\n\t\tthis.bindToContext = () => {};\n\t\tif (!this._isBoundToContext) {\n\t\t\tthis.runtime.bindChannel(this);\n\t\t\t// must set after bind channel so isAttached doesn't report true\n\t\t\t// before binding is complete\n\t\t\tthis.setBoundAndHandleAttach();\n\t\t}\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).connect}\n\t */\n\tpublic connect(services: IChannelServices): void {\n\t\t// handle the case where load is called\n\t\t// before connect; loading detached data stores\n\t\tif (this.services === undefined) {\n\t\t\tthis.services = services;\n\t\t\tthis.attachDeltaHandler();\n\t\t}\n\n\t\tthis.setBoundAndHandleAttach();\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).isAttached}\n\t */\n\tpublic isAttached(): boolean {\n\t\treturn this._isBoundToContext && this.runtime.attachState !== AttachState.Detached;\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}\n\t */\n\tpublic abstract getAttachSummary(\n\t\tfullTree?: boolean,\n\t\ttrackState?: boolean,\n\t\ttelemetryContext?: ITelemetryContext,\n\t): ISummaryTreeWithStats;\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}\n\t */\n\tpublic abstract summarize(\n\t\tfullTree?: boolean,\n\t\ttrackState?: boolean,\n\t\ttelemetryContext?: ITelemetryContext,\n\t): Promise<ISummaryTreeWithStats>;\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getGCData}\n\t */\n\tpublic abstract getGCData(fullGC?: boolean): IGarbageCollectionData;\n\n\t/**\n\t * Allows the distributed data type to perform custom loading\n\t * @param services - Storage used by the shared object\n\t */\n\tprotected abstract loadCore(services: IChannelStorageService): Promise<void>;\n\n\t/**\n\t * Allows the distributed data type to perform custom local loading.\n\t */\n\tprotected initializeLocalCore(): void {\n\t\treturn;\n\t}\n\n\t/**\n\t * Allows the distributive data type the ability to perform custom processing once an attach has happened.\n\t * Also called after non-local data type get loaded.\n\t */\n\tprotected didAttach(): void {\n\t\treturn;\n\t}\n\n\t/**\n\t * Derived classes must override this to do custom processing on a remote message.\n\t * @param message - The message to process\n\t * @param local - True if the shared object is local\n\t * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.\n\t * For messages from a remote client, this will be undefined.\n\t *\n\t * @deprecated Replaced by {@link SharedObjectCore.processMessagesCore}.\n\t */\n\tprotected abstract processCore(\n\t\tmessage: ISequencedDocumentMessage,\n\t\tlocal: boolean,\n\t\tlocalOpMetadata: unknown,\n\t): void;\n\n\t/* eslint-disable jsdoc/check-indentation */\n\t/**\n\t * Process a 'bunch' of messages for this shared object.\n\t *\n\t * @remarks\n\t * A 'bunch' is a group of messages that have the following properties:\n\t * - They are all part of the same grouped batch, which entails:\n\t *   - They are contiguous in sequencing order.\n\t *   - They are all from the same client.\n\t *   - They are all based on the same reference sequence number.\n\t *   - They are not interleaved with messages from other clients.\n\t * - They are not interleaved with messages from other DDS in the container.\n\t * Derived classes should override this if they need to do custom processing on a 'bunch' of remote messages.\n\t * @param messageCollection - The collection of messages to process.\n\t *\n\t */\n\t/* eslint-enable jsdoc/check-indentation */\n\tprotected processMessagesCore?(messagesCollection: IRuntimeMessageCollection): void;\n\n\t/**\n\t * Calls {@link SharedObjectCore.processCore} or {@link SharedObjectCore.processMessagesCore} depending on whether\n\t * processMessagesCore is defined. This helper is used to keep the code cleaner while we have to support both these\n\t * function.\n\t */\n\tprivate readonly processMessagesHelper: (\n\t\tmessagesCollection: IRuntimeMessageCollection,\n\t) => void;\n\n\t/**\n\t * Called when the object has disconnected from the delta stream.\n\t */\n\n\tprotected abstract onDisconnect(): void;\n\n\t/**\n\t * The serializer to serialize / parse handles.\n\t */\n\tprotected abstract get serializer(): IFluidSerializer;\n\n\t/**\n\t * Submits a message by the local client to the runtime.\n\t * @param content - Content of the message. Note: handles contained in the\n\t * message object should not be encoded in any way\n\t * @param localOpMetadata - The local metadata associated with the message. This is kept locally by the runtime\n\t * and not sent to the server. This will be sent back when this message is received back from the server. This is\n\t * also sent if we are asked to resubmit the message.\n\t */\n\tprotected submitLocalMessage(content: unknown, localOpMetadata: unknown = undefined): void {\n\t\tthis.verifyNotClosed();\n\t\tif (this.isAttached()) {\n\t\t\t// NOTE: We may also be encoding in the ContainerRuntime layer.\n\t\t\t// Once the layer-compat window passes we can remove the encoding codepath here altogether\n\t\t\tconst onlyBind =\n\t\t\t\t(this.runtime as IFluidDataStoreRuntimeInternalConfig)\n\t\t\t\t\t.submitMessagesWithoutEncodingHandles === true;\n\t\t\tconst contentToSubmit = onlyBind\n\t\t\t\t? bindHandles(content, this.serializer, this.handle)\n\t\t\t\t: makeHandlesSerializable(content, this.serializer, this.handle);\n\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\t\tthis.services!.deltaConnection.submit(contentToSubmit, localOpMetadata);\n\t\t}\n\t}\n\n\t/**\n\t * Marks this object as dirty so that it is part of the next summary. It is called by a SharedSummaryBlock\n\t * that want to be part of summary but does not generate ops.\n\t */\n\tprotected dirty(): void {\n\t\tif (!this.isAttached()) {\n\t\t\treturn;\n\t\t}\n\n\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\tthis.services!.deltaConnection.dirty();\n\t}\n\n\t/**\n\t * Called when the object has fully connected to the delta stream\n\t * Default implementation for DDS, override if different behavior is required.\n\t */\n\tprotected onConnect(): void {}\n\n\t/**\n\t * Called when a message has to be resubmitted. This typically happens after a reconnection for unacked messages.\n\t * The default implementation here is to resubmit the same message. The client can override if different behavior\n\t * is required. It can choose to resubmit the same message, submit different / multiple messages or not submit\n\t * anything at all.\n\t * @param content - The content of the original message.\n\t * @param localOpMetadata - The local metadata associated with the original message.\n\t */\n\tprotected reSubmitCore(content: unknown, localOpMetadata: unknown): void {\n\t\tthis.submitLocalMessage(content, localOpMetadata);\n\t}\n\n\t/**\n\t * Promises that are waiting for an ack from the server before resolving should use this instead of new Promise.\n\t * It ensures that if something changes that will interrupt that ack (e.g. the FluidDataStoreRuntime disposes),\n\t * the Promise will reject.\n\t * If runtime is disposed when this call is made, executor is not run and promise is rejected right away.\n\t */\n\tprotected async newAckBasedPromise<T>(\n\t\texecutor: (\n\t\t\tresolve: (value: T | PromiseLike<T>) => void,\n\t\t\treject: (reason?: unknown) => void,\n\t\t) => void,\n\t): Promise<T> {\n\t\tlet rejectBecauseDispose: () => void;\n\t\treturn new Promise<T>((resolve, reject) => {\n\t\t\trejectBecauseDispose = () =>\n\t\t\t\treject(\n\t\t\t\t\tnew Error(\"FluidDataStoreRuntime disposed while this ack-based Promise was pending\"),\n\t\t\t\t);\n\n\t\t\tif (this.runtime.disposed) {\n\t\t\t\trejectBecauseDispose();\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\tthis.runtime.on(\"dispose\", rejectBecauseDispose);\n\t\t\texecutor(resolve, reject);\n\t\t}).finally(() => {\n\t\t\t// Note: rejectBecauseDispose will never be undefined here\n\t\t\tthis.runtime.off(\"dispose\", rejectBecauseDispose);\n\t\t});\n\t}\n\n\tprivate attachDeltaHandler(): void {\n\t\t// Services should already be there in case we are attaching delta handler.\n\t\tassert(\n\t\t\tthis.services !== undefined,\n\t\t\t0x07a /* \"Services should be there to attach delta handler\" */,\n\t\t);\n\t\t// attachDeltaHandler is only called after services is assigned\n\t\tthis.services.deltaConnection.attach({\n\t\t\tprocessMessages: (messagesCollection: IRuntimeMessageCollection) => {\n\t\t\t\tthis.processMessages(messagesCollection);\n\t\t\t},\n\t\t\tsetConnectionState: (connected: boolean) => {\n\t\t\t\tthis.setConnectionState(connected);\n\t\t\t},\n\t\t\treSubmit: (content: unknown, localOpMetadata: unknown) => {\n\t\t\t\tthis.reSubmit(content, localOpMetadata);\n\t\t\t},\n\t\t\tapplyStashedOp: (content: unknown): void => {\n\t\t\t\tthis.applyStashedOp(parseHandles(content, this.serializer));\n\t\t\t},\n\t\t\trollback: (content: unknown, localOpMetadata: unknown) => {\n\t\t\t\tthis.rollback(content, localOpMetadata);\n\t\t\t},\n\t\t} satisfies IDeltaHandler);\n\t}\n\n\t/**\n\t * Set the state of connection to services.\n\t * @param connected - true if connected, false otherwise.\n\t */\n\tprivate setConnectionState(connected: boolean): void {\n\t\t// only an attached shared object can transition its\n\t\t// connected state. This is defensive, as some\n\t\t// of our test harnesses don't handle this correctly\n\t\tif (!this.isAttached() || this._connected === connected) {\n\t\t\t// Not changing state, nothing the same.\n\t\t\treturn;\n\t\t}\n\n\t\t// Should I change the state at the end? So that we *can't* send new stuff before we send old?\n\t\tthis._connected = connected;\n\n\t\tif (connected) {\n\t\t\t// Call this for now so that DDSes like ConsensusOrderedCollection that maintain their own pending\n\t\t\t// messages will work.\n\t\t\tthis.onConnect();\n\t\t} else {\n\t\t\t// Things that are true now...\n\t\t\t// - if we had a connection we can no longer send messages over it\n\t\t\t// - if we had outbound messages some may or may not be ACK'd. Won't know until next message\n\t\t\t//\n\t\t\t// - nack could get a new msn - but might as well do it in the join?\n\t\t\tthis.onDisconnect();\n\t\t}\n\t}\n\n\t/**\n\t * Handles a message being received from the remote delta server.\n\t * @param message - The message to process\n\t * @param local - Whether the message originated from the local client\n\t * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.\n\t * For messages from a remote client, this will be undefined.\n\t *\n\t * @deprecated Replaced by {@link SharedObjectCore.processMessages}.\n\t */\n\tprivate process(\n\t\tmessage: ISequencedDocumentMessage,\n\t\tlocal: boolean,\n\t\tlocalOpMetadata: unknown,\n\t): void {\n\t\tthis.verifyNotClosed(); // This will result in container closure.\n\t\tthis.emitInternal(\"pre-op\", message, local, this);\n\n\t\tthis.opProcessingHelper.measure(\n\t\t\t(): ICustomData<ProcessTelemetryProperties> => {\n\t\t\t\tthis.processCore(message, local, localOpMetadata);\n\t\t\t\tconst telemetryProperties: ProcessTelemetryProperties = {\n\t\t\t\t\tsequenceDifference: message.sequenceNumber - message.referenceSequenceNumber,\n\t\t\t\t};\n\t\t\t\treturn {\n\t\t\t\t\tcustomData: telemetryProperties,\n\t\t\t\t};\n\t\t\t},\n\t\t\tlocal ? \"local\" : \"remote\",\n\t\t);\n\n\t\tthis.emitInternal(\"op\", message, local, this);\n\t}\n\n\t/* eslint-disable jsdoc/check-indentation */\n\t/**\n\t * Process a bunch of messages for this shared object. A bunch is group of messages that have the following properties:\n\t * - They are all part of the same grouped batch, which entails:\n\t *   - They are contiguous in sequencing order.\n\t *   - They are all from the same client.\n\t *   - They are all based on the same reference sequence number.\n\t *   - They are not interleaved with messages from other clients.\n\t * - They are not interleaved with messages from other DDS in the container.\n\t * @param messageCollection - The collection of messages to process.\n\t *\n\t */\n\t/* eslint-enable jsdoc/check-indentation */\n\tprivate processMessages(messagesCollection: IRuntimeMessageCollection): void {\n\t\tthis.verifyNotClosed(); // This will result in container closure.\n\n\t\t// Decode any handles in the contents before processing the messages.\n\t\tconst decodedMessagesContent: IRuntimeMessagesContent[] = [];\n\t\tfor (const {\n\t\t\tcontents,\n\t\t\tlocalOpMetadata,\n\t\t\tclientSequenceNumber,\n\t\t} of messagesCollection.messagesContent) {\n\t\t\tconst decodedMessageContent: IRuntimeMessagesContent = {\n\t\t\t\tcontents: parseHandles(contents, this.serializer),\n\t\t\t\tlocalOpMetadata,\n\t\t\t\tclientSequenceNumber,\n\t\t\t};\n\t\t\tdecodedMessagesContent.push(decodedMessageContent);\n\t\t}\n\n\t\tconst decodedMessagesCollection: IRuntimeMessageCollection = {\n\t\t\t...messagesCollection,\n\t\t\tmessagesContent: decodedMessagesContent,\n\t\t};\n\t\tthis.processMessagesHelper(decodedMessagesCollection);\n\t}\n\n\t/**\n\t * Called when a message has to be resubmitted. This typically happens for unacked messages after a\n\t * reconnection.\n\t * @param content - The content of the original message.\n\t * @param localOpMetadata - The local metadata associated with the original message.\n\t */\n\tprivate reSubmit(content: unknown, localOpMetadata: unknown): void {\n\t\tthis.reSubmitCore(content, localOpMetadata);\n\t}\n\n\t/**\n\t * Revert an op\n\t */\n\tprotected rollback(content: unknown, localOpMetadata: unknown): void {\n\t\tthrow new Error(\"rollback not supported\");\n\t}\n\n\t/**\n\t * Apply changes from the provided op content just as if a local client has made the change,\n\t * including submitting the op. Used when rehydrating an attached container\n\t * with pending changes. The rehydration process replays all remote ops\n\t * and applies stashed ops after the remote op with a sequence number\n\t * that matches that of the stashed op is applied. This ensures\n\t * stashed ops are applied at the same state they were originally created.\n\t *\n\t * It is possible that stashed ops have been sent in the past, and will be found when\n\t * the shared object catches up with remotes ops.\n\t * So this prepares the SharedObject for seeing potentially seeing the ACK.\n\t * If no matching remote op is found, all the applied stashed ops will go\n\t * through the normal resubmit flow upon reconnection, which allows the dds\n\t * to rebase them to the latest state, and then resubmit them.\n\t *\n\t * @param content - Contents of a stashed op.\n\t */\n\tprotected abstract applyStashedOp(content: unknown): void;\n\n\t/**\n\t * Emit an event. This function is only intended for use by DDS classes that extend SharedObject/SharedObjectCore,\n\t * specifically to emit events that are part of the public interface of the DDS (i.e. those that can have listeners\n\t * attached to them by the consumers of the DDS). It should not be called from outside the class or to emit events\n\t * which are only internal to the DDS. Support for calling it from outside the DDS instance might be removed in the\n\t * future.\n\t * @param event - The event to emit.\n\t * @param args - Arguments to pass to the event listeners.\n\t * @returns `true` if the event had listeners, `false` otherwise.\n\t */\n\tpublic emit(event: EventEmitterEventType, ...args: any[]): boolean {\n\t\treturn this.callbacksHelper.measure(() => {\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-argument\n\t\t\treturn super.emit(event, ...args);\n\t\t});\n\t}\n\n\t/**\n\t * Use to emit events inside {@link SharedObjectCore}, with no telemetry measurement\n\t * done on the duration of the callbacks. Simply calls `super.emit()`.\n\t * @param event - Event to emit\n\t * @param args - Arguments for the event\n\t * @returns Whatever `super.emit()` returns.\n\t */\n\tprivate emitInternal(event: EventEmitterEventType, ...args: unknown[]): boolean {\n\t\treturn super.emit(event, ...args);\n\t}\n}\n\n/**\n * Helper for implementing {@link ISharedObject} with simplified, synchronous summarization and garbage collection.\n * @remarks\n * DDS implementations with async and incremental summarization should extend {@link SharedObjectCore} directly instead.\n * @privateRemarks\n * TODO:\n * This class is badly named.\n * Once it becomes `@internal` \"SharedObjectCore\" should probably become \"SharedObject\"\n * and this class should be renamed to something like \"SharedObjectSynchronous\".\n * @legacy\n * @alpha\n */\nexport abstract class SharedObject<\n\tTEvent extends ISharedObjectEvents = ISharedObjectEvents,\n> extends SharedObjectCore<TEvent> {\n\t/**\n\t * True while we are garbage collecting this object's data.\n\t */\n\tprivate _isGCing: boolean = false;\n\n\t/**\n\t * The serializer to use to serialize / parse handles, if any.\n\t */\n\tprivate readonly _serializer: IFluidSerializer;\n\n\tprotected get serializer(): IFluidSerializer {\n\t\t/**\n\t\t * During garbage collection, the GCHandleVisitor \"serializer\" keeps track of IFluidHandles that are serialized. These\n\t\t * handles represent references to other Fluid objects.\n\t\t *\n\t\t * This is fine for now. However, if we implement delay loading in DDSes, they may load and de-serialize content\n\t\t * in summarize. When that happens, they may incorrectly hit this assert and we will have to change this.\n\t\t */\n\t\tassert(\n\t\t\t!this._isGCing,\n\t\t\t0x075 /* \"SummarySerializer should be used for serializing data during summary.\" */,\n\t\t);\n\t\treturn this._serializer;\n\t}\n\n\tconstructor(\n\t\tid: string,\n\t\truntime: IFluidDataStoreRuntime,\n\t\tattributes: IChannelAttributes,\n\t\t/**\n\t\t * The prefix to use for telemetry events emitted by this object.\n\t\t */\n\t\tprivate readonly telemetryContextPrefix: string,\n\t) {\n\t\tsuper(id, runtime, attributes);\n\n\t\tthis._serializer = new FluidSerializer(this.runtime.channelsRoutingContext);\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}\n\t */\n\tpublic getAttachSummary(\n\t\tfullTree: boolean = false,\n\t\ttrackState: boolean = false,\n\t\ttelemetryContext?: ITelemetryContext,\n\t): ISummaryTreeWithStats {\n\t\tconst result = this.summarizeCore(this.serializer, telemetryContext);\n\t\tthis.incrementTelemetryMetric(\n\t\t\tblobCountPropertyName,\n\t\t\tresult.stats.blobNodeCount,\n\t\t\ttelemetryContext,\n\t\t);\n\t\tthis.incrementTelemetryMetric(\n\t\t\ttotalBlobSizePropertyName,\n\t\t\tresult.stats.totalBlobSize,\n\t\t\ttelemetryContext,\n\t\t);\n\t\treturn result;\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}\n\t */\n\tpublic async summarize(\n\t\tfullTree: boolean = false,\n\t\ttrackState: boolean = false,\n\t\ttelemetryContext?: ITelemetryContext,\n\t\tincrementalSummaryContext?: IExperimentalIncrementalSummaryContext,\n\t): Promise<ISummaryTreeWithStats> {\n\t\tconst result = this.summarizeCore(\n\t\t\tthis.serializer,\n\t\t\ttelemetryContext,\n\t\t\tincrementalSummaryContext,\n\t\t);\n\t\tthis.incrementTelemetryMetric(\n\t\t\tblobCountPropertyName,\n\t\t\tresult.stats.blobNodeCount,\n\t\t\ttelemetryContext,\n\t\t);\n\t\tthis.incrementTelemetryMetric(\n\t\t\ttotalBlobSizePropertyName,\n\t\t\tresult.stats.totalBlobSize,\n\t\t\ttelemetryContext,\n\t\t);\n\t\treturn result;\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getGCData}\n\t */\n\tpublic getGCData(fullGC: boolean = false): IGarbageCollectionData {\n\t\t// Set _isGCing to true. This flag is used to ensure that we only use GCHandleVisitor in this codepath and not when trying to truly serialize.\n\t\tassert(\n\t\t\t!this._isGCing,\n\t\t\t0x078 /* \"Possible re-entrancy! Summary should not already be in progress.\" */,\n\t\t);\n\t\tthis._isGCing = true;\n\n\t\tlet gcData: IGarbageCollectionData;\n\t\ttry {\n\t\t\tconst handleVisitor = new GCHandleVisitor(this.runtime.channelsRoutingContext);\n\t\t\tthis.processGCDataCore(handleVisitor);\n\t\t\t// The GC data for this shared object contains a single GC node. The outbound routes of this node are the\n\t\t\t// routes of handles serialized during summarization.\n\t\t\tgcData = { gcNodes: { \"/\": handleVisitor.getVisitedHandlePaths() } };\n\t\t\tassert(\n\t\t\t\tthis._isGCing,\n\t\t\t\t0x079 /* \"Possible re-entrancy! Summary should have been in progress.\" */,\n\t\t\t);\n\t\t} finally {\n\t\t\tthis._isGCing = false;\n\t\t}\n\n\t\treturn gcData;\n\t}\n\n\t/**\n\t * Calls the serializer over all data in this object that reference other GC nodes.\n\t * Derived classes must override this to provide custom list of references to other GC nodes.\n\t *\n\t * @remarks Serialization itself doesn't matter (the result is ignored). We're tapping into the serialization infrastructure\n\t * as a way to visit all the content in this content that may reference other objects via handle.\n\t *\n\t * @param serializer - The \"serializer\" (more like handle visitor) to use.\n\t * Implementations should ensure that serialize is called on all handles, as the way to visit them.\n\t */\n\tprotected processGCDataCore(serializer: IFluidSerializer): void {\n\t\t// We run the full summarize logic to get the list of outbound routes from this object. This is a little\n\t\t// expensive but its okay for now. It will be updated to not use full summarize and make it more efficient.\n\t\t// See: https://github.com/microsoft/FluidFramework/issues/4547\n\t\tthis.summarizeCore(serializer);\n\t}\n\n\t/**\n\t * Gets a form of the object that can be serialized.\n\t * @returns A tree representing the snapshot of the shared object.\n\t */\n\tprotected abstract summarizeCore(\n\t\tserializer: IFluidSerializer,\n\t\ttelemetryContext?: ITelemetryContext,\n\t\tincrementalSummaryContext?: IExperimentalIncrementalSummaryContext,\n\t): ISummaryTreeWithStats;\n\n\tprivate incrementTelemetryMetric(\n\t\tpropertyName: string,\n\t\tincrementBy: number,\n\t\ttelemetryContext?: ITelemetryContext,\n\t): void {\n\t\tif (telemetryContext !== undefined) {\n\t\t\t// TelemetryContext needs to implment a get function\n\t\t\tassert(\n\t\t\t\t\"get\" in telemetryContext && typeof telemetryContext.get === \"function\",\n\t\t\t\t0x97e /* received context must have a get function */,\n\t\t\t);\n\n\t\t\tconst prevTotal = ((telemetryContext as TelemetryContext).get(\n\t\t\t\tthis.telemetryContextPrefix,\n\t\t\t\tpropertyName,\n\t\t\t) ?? 0) as number;\n\t\t\ttelemetryContext.set(this.telemetryContextPrefix, propertyName, prevTotal + incrementBy);\n\t\t}\n\t}\n}\n\n/**\n * Defines a kind of shared object.\n * Used in containers to register a shared object implementation, and to create new instances of a given type of shared object.\n *\n * @remarks\n * For use internally and in the \"encapsulated API\".\n * See {@link SharedObjectKind} for the type erased version for use in the public declarative API.\n *\n * @privateRemarks\n * This does not extend {@link SharedObjectKind} since doing so would prevent implementing this interface in type safe code.\n * Any implementation of this can safely be used as a {@link SharedObjectKind} with an explicit type conversion,\n * but doing so is typically not needed as {@link createSharedObjectKind} is used to produce values that are both types simultaneously.\n * @legacy\n * @alpha\n */\nexport interface ISharedObjectKind<TSharedObject> {\n\t/**\n\t * Get a factory which can be used by the Fluid Framework to programmatically instantiate shared objects within containers.\n\t * @remarks\n\t * The produced factory is intended for use with the FluidDataStoreRegistry and is used by the Fluid Framework to instantiate already existing Channels.\n\t * To create new shared objects use:\n\t *\n\t * - {@link @fluidframework/fluid-static#IFluidContainer.create} if using `@fluidframework/fluid-static`, for example via `@fluidframework/azure-client`.\n\t *\n\t * - {@link ISharedObjectKind.create} if using a custom container definitions (and thus not using {@link @fluidframework/fluid-static#IFluidContainer}).\n\t */\n\tgetFactory(): IChannelFactory<TSharedObject>;\n\n\t/**\n\t * Create a shared object.\n\t * @param runtime - The data store runtime that the new shared object belongs to.\n\t * @param id - Optional name of the shared object.\n\t * @returns Newly created shared object.\n\t *\n\t * @example\n\t * To create a `SharedTree`, call the static create method:\n\t *\n\t * ```typescript\n\t * const myTree = SharedTree.create(this.runtime, id);\n\t * ```\n\t * @remarks\n\t * The created object is local (detached): insert a handle to it into an attached object to share (attach) it.\n\t * If using `@fluidframework/fluid-static` (for example via `@fluidframework/azure-client`), use {@link @fluidframework/fluid-static#IFluidContainer.create} instead of calling this directly.\n\t *\n\t * @privateRemarks\n\t * This can only be used with a `MockFluidDataStoreRuntime` when that mock is created with a `registry` containing a factory for this shared object.\n\t */\n\tcreate(runtime: IFluidDataStoreRuntime, id?: string): TSharedObject;\n}\n\n/**\n * Defines a kind of shared object.\n * @remarks\n * Used in containers to register a shared object implementation, and to create new instances of a given type of shared object.\n * See {@link @fluidframework/fluid-static#IFluidContainer.create} and {@link @fluidframework/fluid-static#ContainerSchema} for details.\n * @privateRemarks\n * Part of the \"declarative API\".\n * Type erased reference to an {@link ISharedObjectKind} or a DataObject class in for use in\n * `fluid-static`'s `IFluidContainer` and `ContainerSchema`.\n * Use {@link createSharedObjectKind} to creating an instance of this type.\n * @sealed\n * @public\n */\nexport interface SharedObjectKind<out TSharedObject = unknown>\n\textends ErasedType<readonly [\"SharedObjectKind\", TSharedObject]> {\n\t/**\n\t * Check whether an {@link @fluidframework/core-interfaces#IFluidLoadable} is an instance of this shared object kind.\n\t * @remarks This should be used in place of `instanceof` checks for shared objects, as their actual classes are not exported in Fluid's public API.\n\t */\n\tis(value: IFluidLoadable): value is IFluidLoadable & TSharedObject;\n}\n\n/**\n * Utility for creating ISharedObjectKind instances.\n * @remarks\n * This takes in a class which implements IChannelFactory,\n * and uses it to return a a single value which is intended to be used as the API entry point for the corresponding shared object type.\n * The returned value implements {@link ISharedObjectKind} for use in the encapsulated API, as well as the type erased {@link SharedObjectKind} used by the declarative API.\n * See {@link @fluidframework/fluid-static#ContainerSchema} for how this is used in the declarative API.\n * @internal\n */\nexport function createSharedObjectKind<TSharedObject>(\n\tfactory: (new () => IChannelFactory<TSharedObject>) & { readonly Type: string },\n): ISharedObjectKind<TSharedObject> & SharedObjectKind<TSharedObject> {\n\tconst result: ISharedObjectKind<TSharedObject> &\n\t\tOmit<SharedObjectKind<TSharedObject>, \"brand\"> = {\n\t\tgetFactory(): IChannelFactory<TSharedObject> {\n\t\t\treturn new factory();\n\t\t},\n\n\t\tcreate(runtime: IFluidDataStoreRuntime, id?: string): TSharedObject {\n\t\t\treturn runtime.createChannel(id, factory.Type) as TSharedObject;\n\t\t},\n\n\t\tis(value: IFluidLoadable): value is IFluidLoadable & TSharedObject {\n\t\t\treturn isChannel(value) && value.attributes.type === factory.Type;\n\t\t},\n\t};\n\n\treturn result as typeof result & SharedObjectKind<TSharedObject>;\n}\n\nfunction isChannel(loadable: IFluidLoadable): loadable is IChannel {\n\t// This assumes no other IFluidLoadable has an `attributes` field, and thus may not be fully robust.\n\treturn (loadable as IChannel).attributes !== undefined;\n}\n\n/**\n * Utility that processes the given messages in the message collection together by calling `processMessagesCore`.\n * This will be called when {@link SharedObjectCore.processMessagesCore} is defined.\n */\nfunction processMessagesCoreHelper(\n\tmessagesCollection: IRuntimeMessageCollection,\n\topProcessingHelper: SampledTelemetryHelper<void, ProcessTelemetryProperties>,\n\temitInternal: (\n\t\tevent: \"pre-op\" | \"op\",\n\t\top: ISequencedDocumentMessage,\n\t\tlocal: boolean,\n\t) => void,\n\tprocessMessagesCore: (messagesCollection: IRuntimeMessageCollection) => void,\n): void {\n\tconst { envelope, local, messagesContent } = messagesCollection;\n\n\tconst emitEvents = (\n\t\tevent: \"pre-op\" | \"op\",\n\t\tmessagesContentForEvent: readonly IRuntimeMessagesContent[],\n\t): void => {\n\t\tfor (const { contents, clientSequenceNumber } of messagesContentForEvent) {\n\t\t\tconst message: ISequencedDocumentMessage = {\n\t\t\t\t...envelope,\n\t\t\t\tcontents,\n\t\t\t\tclientSequenceNumber,\n\t\t\t};\n\t\t\temitInternal(event, message, local);\n\t\t}\n\t};\n\n\temitEvents(\"pre-op\", messagesContent);\n\topProcessingHelper.measure(\n\t\t(): ICustomData<ProcessTelemetryProperties> => {\n\t\t\tprocessMessagesCore(messagesCollection);\n\t\t\tconst telemetryProperties: ProcessTelemetryProperties = {\n\t\t\t\tsequenceDifference: envelope.sequenceNumber - envelope.referenceSequenceNumber,\n\t\t\t};\n\t\t\treturn {\n\t\t\t\tcustomData: telemetryProperties,\n\t\t\t};\n\t\t},\n\t\tlocal ? \"local\" : \"remote\",\n\t);\n\temitEvents(\"op\", messagesContent);\n}\n\n/**\n * Utility that processes the given messages in the message collection one by one by calling `process`. This will\n * be called when {@link SharedObjectCore.processMessagesCore} is not defined.\n */\nfunction processHelper(\n\tmessagesCollection: IRuntimeMessageCollection,\n\tprocess: (\n\t\tmessage: ISequencedDocumentMessage,\n\t\tlocal: boolean,\n\t\tlocalOpMetadata: unknown,\n\t) => void,\n): void {\n\tconst { envelope, local, messagesContent } = messagesCollection;\n\tfor (const { contents, localOpMetadata, clientSequenceNumber } of messagesContent) {\n\t\tprocess(\n\t\t\t{\n\t\t\t\t...envelope,\n\t\t\t\tcontents,\n\t\t\t\tclientSequenceNumber,\n\t\t\t},\n\t\t\tlocal,\n\t\t\tlocalOpMetadata,\n\t\t);\n\t}\n}\n"]}

package/dist/types.d.ts

@@ -31,7 +31,19 @@ export interface ISharedObjectEvents extends IErrorEvent {
     (event: "op", listener: (op: ISequencedDocumentMessage, local: boolean, target: IEventThisPlaceHolder) => void): any;
 }
 /**
- * Base interface for shared objects from which other interfaces derive. Implemented by SharedObject
+ * Base interface for shared objects from which other interfaces extend.
+ * @remarks
+ * This interface is not intended to be implemented outside this repository:
+ * implementers should migrate to using an existing implementation instead.
+ * @privateRemarks
+ * Implemented by {@link SharedObjectCore}.
+ *
+ * TODO:
+ * The relationship between the "shared object" abstraction and "channel" abstraction should be clarified and/or unified.
+ * Either there should be a single named abstraction or the docs here need to make it clear why adding events and bindToContext to a channel makes it a "shared object".
+ * Additionally the docs here need to define what a shared object is, not just claim this interface is for them.
+ * If the intention is that the "shared object" concept `IFluidLoadable` mentions is only ever implemented by this interface then even more concept unification should be done.
+ * If not then more clarity is needed on what this interface specifically is, what the other "shared object" concept means and how they relate.
  * @legacy
  * @alpha
  */

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,WAAW,EACX,cAAc,EACd,qBAAqB,EACrB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,gDAAgD,CAAC;AAC1E,OAAO,EAAE,yBAAyB,EAAE,MAAM,6CAA6C,CAAC;AAExF;;;;GAIG;AACH,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACvD;;;;;;;OAOG;IACH,CACC,KAAK,EAAE,QAAQ,EACf,QAAQ,EAAE,CACT,EAAE,EAAE,yBAAyB,EAC7B,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,qBAAqB,KACzB,IAAI,OACR;IAEF;;;;;;;OAOG;IACH,CACC,KAAK,EAAE,IAAI,EACX,QAAQ,EAAE,CACT,EAAE,EAAE,yBAAyB,EAC7B,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,qBAAqB,KACzB,IAAI,OACR;CACF;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa,CAAC,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,CACtF,SAAQ,QAAQ,EACf,cAAc,CAAC,MAAM,CAAC;IACvB;;;OAGG;IACH,aAAa,IAAI,IAAI,CAAC;CACtB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,WAAW,EACX,cAAc,EACd,qBAAqB,EACrB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,gDAAgD,CAAC;AAC1E,OAAO,EAAE,yBAAyB,EAAE,MAAM,6CAA6C,CAAC;AAExF;;;;GAIG;AACH,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACvD;;;;;;;OAOG;IACH,CACC,KAAK,EAAE,QAAQ,EACf,QAAQ,EAAE,CACT,EAAE,EAAE,yBAAyB,EAC7B,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,qBAAqB,KACzB,IAAI,OACR;IAEF;;;;;;;OAOG;IACH,CACC,KAAK,EAAE,IAAI,EACX,QAAQ,EAAE,CACT,EAAE,EAAE,yBAAyB,EAC7B,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,qBAAqB,KACzB,IAAI,OACR;CACF;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,aAAa,CAAC,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,CACtF,SAAQ,QAAQ,EACf,cAAc,CAAC,MAAM,CAAC;IACvB;;;OAGG;IACH,aAAa,IAAI,IAAI,CAAC;CACtB"}

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.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\tIErrorEvent,\n\tIEventProvider,\n\tIEventThisPlaceHolder,\n} from \"@fluidframework/core-interfaces\";\nimport { IChannel } from \"@fluidframework/datastore-definitions/internal\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/driver-definitions/internal\";\n\n/**\n * Events emitted by {@link ISharedObject}.\n * @legacy\n * @alpha\n */\nexport interface ISharedObjectEvents extends IErrorEvent {\n\t/**\n\t * Fires before an incoming operation (op) is applied to the shared object.\n\t *\n\t * @remarks Note: this should be considered an internal implementation detail. It is not recommended for external\n\t * use.\n\t *\n\t * @eventProperty\n\t */\n\t(\n\t\tevent: \"pre-op\",\n\t\tlistener: (\n\t\t\top: ISequencedDocumentMessage,\n\t\t\tlocal: boolean,\n\t\t\ttarget: IEventThisPlaceHolder,\n\t\t) => void,\n\t);\n\n\t/**\n\t * Fires after an incoming op is applied to the shared object.\n\t *\n\t * @remarks Note: this should be considered an internal implementation detail. It is not recommended for external\n\t * use.\n\t *\n\t * @eventProperty\n\t */\n\t(\n\t\tevent: \"op\",\n\t\tlistener: (\n\t\t\top: ISequencedDocumentMessage,\n\t\t\tlocal: boolean,\n\t\t\ttarget: IEventThisPlaceHolder,\n\t\t) => void,\n\t);\n}\n\n/**\n * Base interface for shared objects from which other interfaces derive. Implemented by SharedObject\n * @legacy\n * @alpha\n */\nexport interface ISharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents>\n\textends IChannel,\n\t\tIEventProvider<TEvent> {\n\t/**\n\t * Binds the given shared object to its containing data store runtime, causing it to attach once\n\t * the runtime attaches.\n\t */\n\tbindToContext(): void;\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.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\tIErrorEvent,\n\tIEventProvider,\n\tIEventThisPlaceHolder,\n} from \"@fluidframework/core-interfaces\";\nimport { IChannel } from \"@fluidframework/datastore-definitions/internal\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/driver-definitions/internal\";\n\n/**\n * Events emitted by {@link ISharedObject}.\n * @legacy\n * @alpha\n */\nexport interface ISharedObjectEvents extends IErrorEvent {\n\t/**\n\t * Fires before an incoming operation (op) is applied to the shared object.\n\t *\n\t * @remarks Note: this should be considered an internal implementation detail. It is not recommended for external\n\t * use.\n\t *\n\t * @eventProperty\n\t */\n\t(\n\t\tevent: \"pre-op\",\n\t\tlistener: (\n\t\t\top: ISequencedDocumentMessage,\n\t\t\tlocal: boolean,\n\t\t\ttarget: IEventThisPlaceHolder,\n\t\t) => void,\n\t);\n\n\t/**\n\t * Fires after an incoming op is applied to the shared object.\n\t *\n\t * @remarks Note: this should be considered an internal implementation detail. It is not recommended for external\n\t * use.\n\t *\n\t * @eventProperty\n\t */\n\t(\n\t\tevent: \"op\",\n\t\tlistener: (\n\t\t\top: ISequencedDocumentMessage,\n\t\t\tlocal: boolean,\n\t\t\ttarget: IEventThisPlaceHolder,\n\t\t) => void,\n\t);\n}\n\n/**\n * Base interface for shared objects from which other interfaces extend.\n * @remarks\n * This interface is not intended to be implemented outside this repository:\n * implementers should migrate to using an existing implementation instead.\n * @privateRemarks\n * Implemented by {@link SharedObjectCore}.\n *\n * TODO:\n * The relationship between the \"shared object\" abstraction and \"channel\" abstraction should be clarified and/or unified.\n * Either there should be a single named abstraction or the docs here need to make it clear why adding events and bindToContext to a channel makes it a \"shared object\".\n * Additionally the docs here need to define what a shared object is, not just claim this interface is for them.\n * If the intention is that the \"shared object\" concept `IFluidLoadable` mentions is only ever implemented by this interface then even more concept unification should be done.\n * If not then more clarity is needed on what this interface specifically is, what the other \"shared object\" concept means and how they relate.\n * @legacy\n * @alpha\n */\nexport interface ISharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents>\n\textends IChannel,\n\t\tIEventProvider<TEvent> {\n\t/**\n\t * Binds the given shared object to its containing data store runtime, causing it to attach once\n\t * the runtime attaches.\n\t */\n\tbindToContext(): void;\n}\n"]}

package/lib/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/shared-object-base";
-export declare const pkgVersion = "2.33.1";
+export declare const pkgVersion = "2.40.0-336023";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,uCAAuC,CAAC;AAC5D,eAAO,MAAM,UAAU,WAAW,CAAC"}
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,uCAAuC,CAAC;AAC5D,eAAO,MAAM,UAAU,kBAAkB,CAAC"}

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/shared-object-base";
-export const pkgVersion = "2.33.1";
+export const pkgVersion = "2.40.0-336023";
 //# sourceMappingURL=packageVersion.js.map