@fluid-experimental/data-objects 1.2.2 → 2.0.0-internal.1.0.0.82159

package/dist/index.d.ts

@@ -2,5 +2,5 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export * from "./signalManager";
+export * from "./signaler";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,YAAY,CAAC"}

package/dist/index.js

@@ -2,5 +2,5 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export * from "./signalManager";
+export * from "./signaler";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,iBAAiB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport * from \"./signalManager\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,YAAY,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport * from \"./signaler\";\n"]}

package/{lib/signalManager → dist/signaler}/index.d.ts

@@ -2,5 +2,5 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export * from "./signalManager";
+export * from "./signaler";
 //# sourceMappingURL=index.d.ts.map

package/dist/signaler/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/signaler/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,YAAY,CAAC"}

package/dist/{signalManager → signaler}/index.js

@@ -2,5 +2,5 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export * from "./signalManager";
+export * from "./signaler";
 //# sourceMappingURL=index.js.map

package/dist/signaler/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/signaler/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,YAAY,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport * from \"./signaler\";\n"]}

package/dist/{signalManager/signalManager.d.ts → signaler/signaler.d.ts}

@@ -6,7 +6,6 @@
 import { EventEmitter } from "events";
 import { DataObject, DataObjectFactory } from "@fluidframework/aqueduct";
 import { IErrorEvent } from "@fluidframework/common-definitions";
-import { TypedEventEmitter } from "@fluidframework/common-utils";
 import { Jsonable } from "@fluidframework/datastore-definitions";
 import { IInboundSignalMessage } from "@fluidframework/runtime-definitions";
 export declare type SignalListener = (clientId: string, local: boolean, payload: Jsonable) => void;
@@ -49,51 +48,16 @@ export interface IRuntimeSignaler {
     submitSignal(type: string, content: any): void;
 }
 /**
- * Note: currently experimental and under development
- *
- * Helper class to assist common scenarios around working with signals.  Signaler wraps a runtime
- * object with signaling functionality (e.g. ContainerRuntime or FluidDataStoreRuntime) and can
- * then be used in place of the original signaler.  It uses a separate internal EventEmitter to
- * manage callbacks, and thus will reflect that behavior with regards to callback registration and
- * deregistration.
- */
-export declare class Signaler extends TypedEventEmitter<IErrorEvent> implements ISignaler {
-    /**
-     * Object to wrap that can submit and listen to signals
-     */
-    private readonly signaler;
-    private readonly emitter;
-    private readonly managerId;
-    constructor(
-    /**
-     * Object to wrap that can submit and listen to signals
-     */
-    signaler: IRuntimeSignaler, 
-    /**
-     * Optional id to assign to this manager that will be attached to
-     * signal names.  Useful to avoid collisions if there are multiple
-     * signal users at the Container level
-     */
-    managerId?: string);
-    private getManagerSignalName;
-    onSignal(signalName: string, listener: SignalListener): ISignaler;
-    offSignal(signalName: string, listener: SignalListener): ISignaler;
-    submitSignal(signalName: string, payload?: Jsonable): void;
-}
-/**
- * Note: currently experimental and under development
- *
  * DataObject implementation of ISignaler for fluid-static plug-and-play.  Allows fluid-static
- * users to get an ISignaler without a custom DO.  Where possible, consumers should instead
- * create a Signaler themselves instead of using the DO wrapper to avoid the DO overhead.
+ * users to get an ISignaler without a custom DO.
  */
-export declare class SignalManager extends DataObject<{
+export declare class Signaler extends DataObject<{
     Events: IErrorEvent;
 }> implements EventEmitter, ISignaler {
-    private _manager;
-    private get manager();
+    private _signaler;
+    private get signaler();
     static get Name(): string;
-    static readonly factory: DataObjectFactory<SignalManager, {
+    static readonly factory: DataObjectFactory<Signaler, {
         Events: IErrorEvent;
     }>;
     protected hasInitialized(): Promise<void>;
@@ -101,4 +65,4 @@ export declare class SignalManager extends DataObject<{
     offSignal(signalName: string, listener: SignalListener): ISignaler;
     submitSignal(signalName: string, payload?: Jsonable): void;
 }
-//# sourceMappingURL=signalManager.d.ts.map
+//# sourceMappingURL=signaler.d.ts.map

package/dist/signaler/signaler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signaler.d.ts","sourceRoot":"","sources":["../../src/signaler/signaler.ts"],"names":[],"mappings":"AAAA;;;GAGG;;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AACzE,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AAEjE,OAAO,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAM5E,oBAAY,cAAc,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,KAAK,IAAI,CAAC;AAE3F;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACtB;;;;;;OAMG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,GAAG,SAAS,CAAC;IACjE;;;;;;MAME;IACH,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,GAAG,SAAS,CAAC;IACnE;;;;OAIG;IACH,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,OAAE;CACxD;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC7B,SAAS,EAAE,OAAO,CAAC;IACnB,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,qBAAqB,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,OAAE;IACxF,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;CAClD;AA+ED;;;GAGG;AACH,qBAAa,QAAS,SAAQ,UAAU,CAAC;IAAE,MAAM,EAAE,WAAW,CAAC;CAAE,CAAE,YAAW,YAAY,EAAE,SAAS;IACjG,OAAO,CAAC,SAAS,CAA+B;IAChD,OAAO,KAAK,QAAQ,GAGnB;IAED,WAAkB,IAAI,WAAwC;IAE9D,gBAAuB,OAAO;gBATiB,WAAW;OAcxD;cAEc,cAAc;IASvB,QAAQ,CACX,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,cAAc,GACzB,SAAS;IAKL,SAAS,CACZ,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,cAAc,GACzB,SAAS;IAKL,YAAY,CACf,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,QAAQ;CAIzB"}

package/dist/{signalManager/signalManager.js → signaler/signaler.js}

@@ -8,13 +8,13 @@ import { assert, TypedEventEmitter } from "@fluidframework/common-utils";
 /**
  * Note: currently experimental and under development
  *
- * Helper class to assist common scenarios around working with signals.  Signaler wraps a runtime
+ * Helper class to assist common scenarios around working with signals.  InternalSignaler wraps a runtime
  * object with signaling functionality (e.g. ContainerRuntime or FluidDataStoreRuntime) and can
  * then be used in place of the original signaler.  It uses a separate internal EventEmitter to
  * manage callbacks, and thus will reflect that behavior with regards to callback registration and
  * deregistration.
  */
-export class Signaler extends TypedEventEmitter {
+class InternalSignaler extends TypedEventEmitter {
     constructor(
     /**
      * Object to wrap that can submit and listen to signals
@@ -25,14 +25,14 @@ export class Signaler extends TypedEventEmitter {
      * signal names.  Useful to avoid collisions if there are multiple
      * signal users at the Container level
      */
-    managerId) {
+    signalerId) {
         super();
         this.signaler = signaler;
         this.emitter = new EventEmitter();
         this.emitter.on("error", (error) => {
             this.emit("error", error);
         });
-        this.managerId = managerId ? `#${managerId}` : undefined;
+        this.signalerId = signalerId ? `#${signalerId}` : undefined;
         this.signaler.on("signal", (message, local) => {
             const clientId = message.clientId;
             // Only call listeners when the runtime is connected and if the signal has an
@@ -43,58 +43,55 @@ export class Signaler extends TypedEventEmitter {
             }
         });
     }
-    getManagerSignalName(signalName) {
-        return this.managerId ? `${signalName}${this.managerId}` : signalName;
+    getSignalerSignalName(signalName) {
+        return this.signalerId ? `${signalName}${this.signalerId}` : signalName;
     }
     // ISignaler methods
     onSignal(signalName, listener) {
-        const managerSignalName = this.getManagerSignalName(signalName);
-        this.emitter.on(managerSignalName, listener);
+        const signalerSignalName = this.getSignalerSignalName(signalName);
+        this.emitter.on(signalerSignalName, listener);
         return this;
     }
     offSignal(signalName, listener) {
-        const managerSignalName = this.getManagerSignalName(signalName);
-        this.emitter.off(managerSignalName, listener);
+        const signalerSignalName = this.getSignalerSignalName(signalName);
+        this.emitter.off(signalerSignalName, listener);
         return this;
     }
     submitSignal(signalName, payload) {
-        const managerSignalName = this.getManagerSignalName(signalName);
+        const signalerSignalName = this.getSignalerSignalName(signalName);
         if (this.signaler.connected) {
-            this.signaler.submitSignal(managerSignalName, payload);
+            this.signaler.submitSignal(signalerSignalName, payload);
         }
     }
 }
 /**
- * Note: currently experimental and under development
- *
  * DataObject implementation of ISignaler for fluid-static plug-and-play.  Allows fluid-static
- * users to get an ISignaler without a custom DO.  Where possible, consumers should instead
- * create a Signaler themselves instead of using the DO wrapper to avoid the DO overhead.
+ * users to get an ISignaler without a custom DO.
  */
-export class SignalManager extends DataObject {
-    get manager() {
-        assert(this._manager !== undefined, 0x24b /* "internal signaler should be defined" */);
-        return this._manager;
+export class Signaler extends DataObject {
+    get signaler() {
+        assert(this._signaler !== undefined, 0x24b /* "internal signaler should be defined" */);
+        return this._signaler;
     }
-    static get Name() { return "@fluid-example/signal-manager"; }
+    static get Name() { return "@fluid-example/signaler"; }
     async hasInitialized() {
-        this._manager = new Signaler(this.runtime);
-        this.manager.on("error", (error) => {
+        this._signaler = new InternalSignaler(this.runtime);
+        this.signaler.on("error", (error) => {
             this.emit("error", error);
         });
     }
     // ISignaler methods  Note these are all passthroughs
     onSignal(signalName, listener) {
-        this.manager.onSignal(signalName, listener);
+        this.signaler.onSignal(signalName, listener);
         return this;
     }
     offSignal(signalName, listener) {
-        this.manager.offSignal(signalName, listener);
+        this.signaler.offSignal(signalName, listener);
         return this;
     }
     submitSignal(signalName, payload) {
-        this.manager.submitSignal(signalName, payload);
+        this.signaler.submitSignal(signalName, payload);
     }
 }
-SignalManager.factory = new DataObjectFactory(SignalManager.Name, SignalManager, [], {});
-//# sourceMappingURL=signalManager.js.map
+Signaler.factory = new DataObjectFactory(Signaler.Name, Signaler, [], {});
+//# sourceMappingURL=signaler.js.map

package/dist/signaler/signaler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"signaler.js","sourceRoot":"","sources":["../../src/signaler/signaler.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAEzE,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAkDzE;;;;;;;;GAQG;AACF,MAAM,gBAAiB,SAAQ,iBAA8B;IAK1D;IACI;;OAEG;IACc,QAA0B;IAC3C;;;;OAIG;IACH,UAAmB;QAEnB,KAAK,EAAE,CAAC;QARS,aAAQ,GAAR,QAAQ,CAAkB;QAR9B,YAAO,GAAG,IAAI,YAAY,EAAE,CAAC;QAiB1C,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC/B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAC5D,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,OAA8B,EAAE,KAAc,EAAE,EAAE;YAC1E,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;YAClC,6EAA6E;YAC7E,8EAA8E;YAC9E,0CAA0C;YAC1C,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,IAAI,QAAQ,KAAK,IAAI,EAAE;gBAC9C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;aACrE;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,qBAAqB,CAAC,UAAkB;QAC5C,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC;IAC5E,CAAC;IAED,oBAAoB;IAEb,QAAQ,CACX,UAAkB,EAClB,QAAwB;QAExB,MAAM,kBAAkB,GAAG,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;QAClE,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,SAAS,CACZ,UAAkB,EAClB,QAAwB;QAExB,MAAM,kBAAkB,GAAG,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;QAClE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,YAAY,CACf,UAAkB,EAClB,OAAkB;QAElB,MAAM,kBAAkB,GAAG,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;QAClE,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE;YACzB,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;SAC3D;IACL,CAAC;CACJ;AAED;;;GAGG;AACH,MAAM,OAAO,QAAS,SAAQ,UAAoC;IAE9D,IAAY,QAAQ;QAChB,MAAM,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE,KAAK,CAAC,2CAA2C,CAAC,CAAC;QACxF,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAEM,MAAM,KAAK,IAAI,KAAK,OAAO,yBAAyB,CAAC,CAAC,CAAC;IASpD,KAAK,CAAC,cAAc;QAC1B,IAAI,CAAC,SAAS,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpD,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAChC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACP,CAAC;IAED,qDAAqD;IAE9C,QAAQ,CACX,UAAkB,EAClB,QAAwB;QAExB,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,SAAS,CACZ,UAAkB,EAClB,QAAwB;QAExB,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,YAAY,CACf,UAAkB,EAClB,OAAkB;QAElB,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;;AArCsB,gBAAO,GAAG,IAAI,iBAAiB,CAClD,QAAQ,CAAC,IAAI,EACb,QAAQ,EACR,EAAE,EACF,EAAE,CACL,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { EventEmitter } from \"events\";\nimport { DataObject, DataObjectFactory } from \"@fluidframework/aqueduct\";\nimport { IErrorEvent } from \"@fluidframework/common-definitions\";\nimport { assert, TypedEventEmitter } from \"@fluidframework/common-utils\";\nimport { Jsonable } from \"@fluidframework/datastore-definitions\";\nimport { IInboundSignalMessage } from \"@fluidframework/runtime-definitions\";\n\n// TODO:\n// add way to mark with current sequence number for ordering signals relative to ops\n// throttling and batching\n\nexport type SignalListener = (clientId: string, local: boolean, payload: Jsonable) => void;\n\n/**\n * ISignaler defines an interface for working with signals that is similar to the more common\n * eventing patterns of EventEmitter.  In addition to sending and responding to signals, it\n * provides explicit methods around signal requests to other connected clients.\n */\nexport interface ISignaler {\n    /**\n     * Adds a listener for the specified signal.  It behaves in the same way as EventEmitter's `on`\n     * method regarding multiple registrations, callback order, etc.\n     * @param signalName - The name of the signal\n     * @param listener - The callback signal handler to add\n     * @returns This ISignaler\n     */\n    onSignal(signalName: string, listener: SignalListener): ISignaler;\n     /**\n     * Remove a listener for the specified signal.  It behaves in the same way as EventEmitter's\n     * `off` method regarding multiple registrations, removal order, etc.\n     * @param signalName - The name of the signal\n     * @param listener - The callback signal handler to remove\n     * @returns This ISignaler\n     */\n    offSignal(signalName: string, listener: SignalListener): ISignaler;\n    /**\n     * Send a signal with payload to its connected listeners.\n     * @param signalName - The name of the signal\n     * @param payload - The data to send with the signal\n     */\n    submitSignal(signalName: string, payload?: Jsonable);\n}\n\n/**\n * Duck type of something that provides the expected signalling functionality:\n * A way to verify we can signal, a way to send a signal, and a way to listen for incoming signals\n */\nexport interface IRuntimeSignaler {\n    connected: boolean;\n    on(event: \"signal\", listener: (message: IInboundSignalMessage, local: boolean) => void);\n    submitSignal(type: string, content: any): void;\n}\n\n/**\n * Note: currently experimental and under development\n *\n * Helper class to assist common scenarios around working with signals.  InternalSignaler wraps a runtime\n * object with signaling functionality (e.g. ContainerRuntime or FluidDataStoreRuntime) and can\n * then be used in place of the original signaler.  It uses a separate internal EventEmitter to\n * manage callbacks, and thus will reflect that behavior with regards to callback registration and\n * deregistration.\n */\n class InternalSignaler extends TypedEventEmitter<IErrorEvent> implements ISignaler {\n    private readonly emitter = new EventEmitter();\n\n    private readonly signalerId: string | undefined;\n\n    constructor(\n        /**\n         * Object to wrap that can submit and listen to signals\n         */\n        private readonly signaler: IRuntimeSignaler,\n        /**\n         * Optional id to assign to this manager that will be attached to\n         * signal names.  Useful to avoid collisions if there are multiple\n         * signal users at the Container level\n         */\n        signalerId?: string,\n    ) {\n        super();\n        this.emitter.on(\"error\", (error) => {\n            this.emit(\"error\", error);\n        });\n        this.signalerId = signalerId ? `#${signalerId}` : undefined;\n        this.signaler.on(\"signal\", (message: IInboundSignalMessage, local: boolean) => {\n            const clientId = message.clientId;\n            // Only call listeners when the runtime is connected and if the signal has an\n            // identifiable sender clientId.  The listener is responsible for deciding how\n            // it wants to handle local/remote signals\n            if (this.signaler.connected && clientId !== null) {\n                this.emitter.emit(message.type, clientId, local, message.content);\n            }\n        });\n    }\n\n    private getSignalerSignalName(signalName: string): string {\n        return this.signalerId ? `${signalName}${this.signalerId}` : signalName;\n    }\n\n    // ISignaler methods\n\n    public onSignal(\n        signalName: string,\n        listener: SignalListener,\n    ): ISignaler {\n        const signalerSignalName = this.getSignalerSignalName(signalName);\n        this.emitter.on(signalerSignalName, listener);\n        return this;\n    }\n\n    public offSignal(\n        signalName: string,\n        listener: SignalListener,\n    ): ISignaler {\n        const signalerSignalName = this.getSignalerSignalName(signalName);\n        this.emitter.off(signalerSignalName, listener);\n        return this;\n    }\n\n    public submitSignal(\n        signalName: string,\n        payload?: Jsonable,\n    ) {\n        const signalerSignalName = this.getSignalerSignalName(signalName);\n        if (this.signaler.connected) {\n            this.signaler.submitSignal(signalerSignalName, payload);\n        }\n    }\n}\n\n/**\n * DataObject implementation of ISignaler for fluid-static plug-and-play.  Allows fluid-static\n * users to get an ISignaler without a custom DO.\n */\nexport class Signaler extends DataObject<{ Events: IErrorEvent; }> implements EventEmitter, ISignaler {\n    private _signaler: InternalSignaler | undefined;\n    private get signaler(): InternalSignaler {\n        assert(this._signaler !== undefined, 0x24b /* \"internal signaler should be defined\" */);\n        return this._signaler;\n    }\n\n    public static get Name() { return \"@fluid-example/signaler\"; }\n\n    public static readonly factory = new DataObjectFactory(\n        Signaler.Name,\n        Signaler,\n        [],\n        {},\n    );\n\n    protected async hasInitialized() {\n        this._signaler = new InternalSignaler(this.runtime);\n        this.signaler.on(\"error\", (error) => {\n            this.emit(\"error\", error);\n        });\n    }\n\n    // ISignaler methods  Note these are all passthroughs\n\n    public onSignal(\n        signalName: string,\n        listener: SignalListener,\n    ): ISignaler {\n        this.signaler.onSignal(signalName, listener);\n        return this;\n    }\n\n    public offSignal(\n        signalName: string,\n        listener: SignalListener,\n    ): ISignaler {\n        this.signaler.offSignal(signalName, listener);\n        return this;\n    }\n\n    public submitSignal(\n        signalName: string,\n        payload?: Jsonable,\n    ) {\n        this.signaler.submitSignal(signalName, payload);\n    }\n}\n"]}

package/lib/index.d.ts

@@ -2,5 +2,5 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export * from "./signalManager";
+export * from "./signaler";
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,YAAY,CAAC"}

package/lib/index.js

@@ -2,5 +2,5 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export * from "./signalManager";
+export * from "./signaler";
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,iBAAiB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport * from \"./signalManager\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,YAAY,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport * from \"./signaler\";\n"]}

package/lib/signaler/index.d.ts

@@ -0,0 +1,6 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export * from "./signaler";
+//# sourceMappingURL=index.d.ts.map

package/lib/signaler/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/signaler/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,YAAY,CAAC"}

package/lib/{signalManager → signaler}/index.js

@@ -2,5 +2,5 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export * from "./signalManager";
+export * from "./signaler";
 //# sourceMappingURL=index.js.map

package/lib/signaler/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/signaler/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,YAAY,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport * from \"./signaler\";\n"]}

package/lib/{signalManager/signalManager.d.ts → signaler/signaler.d.ts}

@@ -6,7 +6,6 @@
 import { EventEmitter } from "events";
 import { DataObject, DataObjectFactory } from "@fluidframework/aqueduct";
 import { IErrorEvent } from "@fluidframework/common-definitions";
-import { TypedEventEmitter } from "@fluidframework/common-utils";
 import { Jsonable } from "@fluidframework/datastore-definitions";
 import { IInboundSignalMessage } from "@fluidframework/runtime-definitions";
 export declare type SignalListener = (clientId: string, local: boolean, payload: Jsonable) => void;
@@ -49,51 +48,16 @@ export interface IRuntimeSignaler {
     submitSignal(type: string, content: any): void;
 }
 /**
- * Note: currently experimental and under development
- *
- * Helper class to assist common scenarios around working with signals.  Signaler wraps a runtime
- * object with signaling functionality (e.g. ContainerRuntime or FluidDataStoreRuntime) and can
- * then be used in place of the original signaler.  It uses a separate internal EventEmitter to
- * manage callbacks, and thus will reflect that behavior with regards to callback registration and
- * deregistration.
- */
-export declare class Signaler extends TypedEventEmitter<IErrorEvent> implements ISignaler {
-    /**
-     * Object to wrap that can submit and listen to signals
-     */
-    private readonly signaler;
-    private readonly emitter;
-    private readonly managerId;
-    constructor(
-    /**
-     * Object to wrap that can submit and listen to signals
-     */
-    signaler: IRuntimeSignaler, 
-    /**
-     * Optional id to assign to this manager that will be attached to
-     * signal names.  Useful to avoid collisions if there are multiple
-     * signal users at the Container level
-     */
-    managerId?: string);
-    private getManagerSignalName;
-    onSignal(signalName: string, listener: SignalListener): ISignaler;
-    offSignal(signalName: string, listener: SignalListener): ISignaler;
-    submitSignal(signalName: string, payload?: Jsonable): void;
-}
-/**
- * Note: currently experimental and under development
- *
  * DataObject implementation of ISignaler for fluid-static plug-and-play.  Allows fluid-static
- * users to get an ISignaler without a custom DO.  Where possible, consumers should instead
- * create a Signaler themselves instead of using the DO wrapper to avoid the DO overhead.
+ * users to get an ISignaler without a custom DO.
  */
-export declare class SignalManager extends DataObject<{
+export declare class Signaler extends DataObject<{
     Events: IErrorEvent;
 }> implements EventEmitter, ISignaler {
-    private _manager;
-    private get manager();
+    private _signaler;
+    private get signaler();
     static get Name(): string;
-    static readonly factory: DataObjectFactory<SignalManager, {
+    static readonly factory: DataObjectFactory<Signaler, {
         Events: IErrorEvent;
     }>;
     protected hasInitialized(): Promise<void>;
@@ -101,4 +65,4 @@ export declare class SignalManager extends DataObject<{
     offSignal(signalName: string, listener: SignalListener): ISignaler;
     submitSignal(signalName: string, payload?: Jsonable): void;
 }
-//# sourceMappingURL=signalManager.d.ts.map
+//# sourceMappingURL=signaler.d.ts.map

package/lib/signaler/signaler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signaler.d.ts","sourceRoot":"","sources":["../../src/signaler/signaler.ts"],"names":[],"mappings":"AAAA;;;GAGG;;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AACzE,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AAEjE,OAAO,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAM5E,oBAAY,cAAc,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,KAAK,IAAI,CAAC;AAE3F;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACtB;;;;;;OAMG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,GAAG,SAAS,CAAC;IACjE;;;;;;MAME;IACH,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,GAAG,SAAS,CAAC;IACnE;;;;OAIG;IACH,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,OAAE;CACxD;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC7B,SAAS,EAAE,OAAO,CAAC;IACnB,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,qBAAqB,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,OAAE;IACxF,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;CAClD;AA+ED;;;GAGG;AACH,qBAAa,QAAS,SAAQ,UAAU,CAAC;IAAE,MAAM,EAAE,WAAW,CAAC;CAAE,CAAE,YAAW,YAAY,EAAE,SAAS;IACjG,OAAO,CAAC,SAAS,CAA+B;IAChD,OAAO,KAAK,QAAQ,GAGnB;IAED,WAAkB,IAAI,WAAwC;IAE9D,gBAAuB,OAAO;gBATiB,WAAW;OAcxD;cAEc,cAAc;IASvB,QAAQ,CACX,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,cAAc,GACzB,SAAS;IAKL,SAAS,CACZ,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,cAAc,GACzB,SAAS;IAKL,YAAY,CACf,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,QAAQ;CAIzB"}

package/lib/{signalManager/signalManager.js → signaler/signaler.js}

@@ -8,13 +8,13 @@ import { assert, TypedEventEmitter } from "@fluidframework/common-utils";
 /**
  * Note: currently experimental and under development
  *
- * Helper class to assist common scenarios around working with signals.  Signaler wraps a runtime
+ * Helper class to assist common scenarios around working with signals.  InternalSignaler wraps a runtime
  * object with signaling functionality (e.g. ContainerRuntime or FluidDataStoreRuntime) and can
  * then be used in place of the original signaler.  It uses a separate internal EventEmitter to
  * manage callbacks, and thus will reflect that behavior with regards to callback registration and
  * deregistration.
  */
-export class Signaler extends TypedEventEmitter {
+class InternalSignaler extends TypedEventEmitter {
     constructor(
     /**
      * Object to wrap that can submit and listen to signals
@@ -25,14 +25,14 @@ export class Signaler extends TypedEventEmitter {
      * signal names.  Useful to avoid collisions if there are multiple
      * signal users at the Container level
      */
-    managerId) {
+    signalerId) {
         super();
         this.signaler = signaler;
         this.emitter = new EventEmitter();
         this.emitter.on("error", (error) => {
             this.emit("error", error);
         });
-        this.managerId = managerId ? `#${managerId}` : undefined;
+        this.signalerId = signalerId ? `#${signalerId}` : undefined;
         this.signaler.on("signal", (message, local) => {
             const clientId = message.clientId;
             // Only call listeners when the runtime is connected and if the signal has an
@@ -43,58 +43,55 @@ export class Signaler extends TypedEventEmitter {
             }
         });
     }
-    getManagerSignalName(signalName) {
-        return this.managerId ? `${signalName}${this.managerId}` : signalName;
+    getSignalerSignalName(signalName) {
+        return this.signalerId ? `${signalName}${this.signalerId}` : signalName;
     }
     // ISignaler methods
     onSignal(signalName, listener) {
-        const managerSignalName = this.getManagerSignalName(signalName);
-        this.emitter.on(managerSignalName, listener);
+        const signalerSignalName = this.getSignalerSignalName(signalName);
+        this.emitter.on(signalerSignalName, listener);
         return this;
     }
     offSignal(signalName, listener) {
-        const managerSignalName = this.getManagerSignalName(signalName);
-        this.emitter.off(managerSignalName, listener);
+        const signalerSignalName = this.getSignalerSignalName(signalName);
+        this.emitter.off(signalerSignalName, listener);
         return this;
     }
     submitSignal(signalName, payload) {
-        const managerSignalName = this.getManagerSignalName(signalName);
+        const signalerSignalName = this.getSignalerSignalName(signalName);
         if (this.signaler.connected) {
-            this.signaler.submitSignal(managerSignalName, payload);
+            this.signaler.submitSignal(signalerSignalName, payload);
         }
     }
 }
 /**
- * Note: currently experimental and under development
- *
  * DataObject implementation of ISignaler for fluid-static plug-and-play.  Allows fluid-static
- * users to get an ISignaler without a custom DO.  Where possible, consumers should instead
- * create a Signaler themselves instead of using the DO wrapper to avoid the DO overhead.
+ * users to get an ISignaler without a custom DO.
  */
-export class SignalManager extends DataObject {
-    get manager() {
-        assert(this._manager !== undefined, 0x24b /* "internal signaler should be defined" */);
-        return this._manager;
+export class Signaler extends DataObject {
+    get signaler() {
+        assert(this._signaler !== undefined, 0x24b /* "internal signaler should be defined" */);
+        return this._signaler;
     }
-    static get Name() { return "@fluid-example/signal-manager"; }
+    static get Name() { return "@fluid-example/signaler"; }
     async hasInitialized() {
-        this._manager = new Signaler(this.runtime);
-        this.manager.on("error", (error) => {
+        this._signaler = new InternalSignaler(this.runtime);
+        this.signaler.on("error", (error) => {
             this.emit("error", error);
         });
     }
     // ISignaler methods  Note these are all passthroughs
     onSignal(signalName, listener) {
-        this.manager.onSignal(signalName, listener);
+        this.signaler.onSignal(signalName, listener);
         return this;
     }
     offSignal(signalName, listener) {
-        this.manager.offSignal(signalName, listener);
+        this.signaler.offSignal(signalName, listener);
         return this;
     }
     submitSignal(signalName, payload) {
-        this.manager.submitSignal(signalName, payload);
+        this.signaler.submitSignal(signalName, payload);
     }
 }
-SignalManager.factory = new DataObjectFactory(SignalManager.Name, SignalManager, [], {});
-//# sourceMappingURL=signalManager.js.map
+Signaler.factory = new DataObjectFactory(Signaler.Name, Signaler, [], {});
+//# sourceMappingURL=signaler.js.map

package/lib/signaler/signaler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"signaler.js","sourceRoot":"","sources":["../../src/signaler/signaler.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAEzE,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAkDzE;;;;;;;;GAQG;AACF,MAAM,gBAAiB,SAAQ,iBAA8B;IAK1D;IACI;;OAEG;IACc,QAA0B;IAC3C;;;;OAIG;IACH,UAAmB;QAEnB,KAAK,EAAE,CAAC;QARS,aAAQ,GAAR,QAAQ,CAAkB;QAR9B,YAAO,GAAG,IAAI,YAAY,EAAE,CAAC;QAiB1C,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC/B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAC5D,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,OAA8B,EAAE,KAAc,EAAE,EAAE;YAC1E,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;YAClC,6EAA6E;YAC7E,8EAA8E;YAC9E,0CAA0C;YAC1C,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,IAAI,QAAQ,KAAK,IAAI,EAAE;gBAC9C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;aACrE;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,qBAAqB,CAAC,UAAkB;QAC5C,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC;IAC5E,CAAC;IAED,oBAAoB;IAEb,QAAQ,CACX,UAAkB,EAClB,QAAwB;QAExB,MAAM,kBAAkB,GAAG,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;QAClE,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,SAAS,CACZ,UAAkB,EAClB,QAAwB;QAExB,MAAM,kBAAkB,GAAG,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;QAClE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,YAAY,CACf,UAAkB,EAClB,OAAkB;QAElB,MAAM,kBAAkB,GAAG,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;QAClE,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE;YACzB,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;SAC3D;IACL,CAAC;CACJ;AAED;;;GAGG;AACH,MAAM,OAAO,QAAS,SAAQ,UAAoC;IAE9D,IAAY,QAAQ;QAChB,MAAM,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE,KAAK,CAAC,2CAA2C,CAAC,CAAC;QACxF,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAEM,MAAM,KAAK,IAAI,KAAK,OAAO,yBAAyB,CAAC,CAAC,CAAC;IASpD,KAAK,CAAC,cAAc;QAC1B,IAAI,CAAC,SAAS,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpD,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAChC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACP,CAAC;IAED,qDAAqD;IAE9C,QAAQ,CACX,UAAkB,EAClB,QAAwB;QAExB,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,SAAS,CACZ,UAAkB,EAClB,QAAwB;QAExB,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,YAAY,CACf,UAAkB,EAClB,OAAkB;QAElB,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;;AArCsB,gBAAO,GAAG,IAAI,iBAAiB,CAClD,QAAQ,CAAC,IAAI,EACb,QAAQ,EACR,EAAE,EACF,EAAE,CACL,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { EventEmitter } from \"events\";\nimport { DataObject, DataObjectFactory } from \"@fluidframework/aqueduct\";\nimport { IErrorEvent } from \"@fluidframework/common-definitions\";\nimport { assert, TypedEventEmitter } from \"@fluidframework/common-utils\";\nimport { Jsonable } from \"@fluidframework/datastore-definitions\";\nimport { IInboundSignalMessage } from \"@fluidframework/runtime-definitions\";\n\n// TODO:\n// add way to mark with current sequence number for ordering signals relative to ops\n// throttling and batching\n\nexport type SignalListener = (clientId: string, local: boolean, payload: Jsonable) => void;\n\n/**\n * ISignaler defines an interface for working with signals that is similar to the more common\n * eventing patterns of EventEmitter.  In addition to sending and responding to signals, it\n * provides explicit methods around signal requests to other connected clients.\n */\nexport interface ISignaler {\n    /**\n     * Adds a listener for the specified signal.  It behaves in the same way as EventEmitter's `on`\n     * method regarding multiple registrations, callback order, etc.\n     * @param signalName - The name of the signal\n     * @param listener - The callback signal handler to add\n     * @returns This ISignaler\n     */\n    onSignal(signalName: string, listener: SignalListener): ISignaler;\n     /**\n     * Remove a listener for the specified signal.  It behaves in the same way as EventEmitter's\n     * `off` method regarding multiple registrations, removal order, etc.\n     * @param signalName - The name of the signal\n     * @param listener - The callback signal handler to remove\n     * @returns This ISignaler\n     */\n    offSignal(signalName: string, listener: SignalListener): ISignaler;\n    /**\n     * Send a signal with payload to its connected listeners.\n     * @param signalName - The name of the signal\n     * @param payload - The data to send with the signal\n     */\n    submitSignal(signalName: string, payload?: Jsonable);\n}\n\n/**\n * Duck type of something that provides the expected signalling functionality:\n * A way to verify we can signal, a way to send a signal, and a way to listen for incoming signals\n */\nexport interface IRuntimeSignaler {\n    connected: boolean;\n    on(event: \"signal\", listener: (message: IInboundSignalMessage, local: boolean) => void);\n    submitSignal(type: string, content: any): void;\n}\n\n/**\n * Note: currently experimental and under development\n *\n * Helper class to assist common scenarios around working with signals.  InternalSignaler wraps a runtime\n * object with signaling functionality (e.g. ContainerRuntime or FluidDataStoreRuntime) and can\n * then be used in place of the original signaler.  It uses a separate internal EventEmitter to\n * manage callbacks, and thus will reflect that behavior with regards to callback registration and\n * deregistration.\n */\n class InternalSignaler extends TypedEventEmitter<IErrorEvent> implements ISignaler {\n    private readonly emitter = new EventEmitter();\n\n    private readonly signalerId: string | undefined;\n\n    constructor(\n        /**\n         * Object to wrap that can submit and listen to signals\n         */\n        private readonly signaler: IRuntimeSignaler,\n        /**\n         * Optional id to assign to this manager that will be attached to\n         * signal names.  Useful to avoid collisions if there are multiple\n         * signal users at the Container level\n         */\n        signalerId?: string,\n    ) {\n        super();\n        this.emitter.on(\"error\", (error) => {\n            this.emit(\"error\", error);\n        });\n        this.signalerId = signalerId ? `#${signalerId}` : undefined;\n        this.signaler.on(\"signal\", (message: IInboundSignalMessage, local: boolean) => {\n            const clientId = message.clientId;\n            // Only call listeners when the runtime is connected and if the signal has an\n            // identifiable sender clientId.  The listener is responsible for deciding how\n            // it wants to handle local/remote signals\n            if (this.signaler.connected && clientId !== null) {\n                this.emitter.emit(message.type, clientId, local, message.content);\n            }\n        });\n    }\n\n    private getSignalerSignalName(signalName: string): string {\n        return this.signalerId ? `${signalName}${this.signalerId}` : signalName;\n    }\n\n    // ISignaler methods\n\n    public onSignal(\n        signalName: string,\n        listener: SignalListener,\n    ): ISignaler {\n        const signalerSignalName = this.getSignalerSignalName(signalName);\n        this.emitter.on(signalerSignalName, listener);\n        return this;\n    }\n\n    public offSignal(\n        signalName: string,\n        listener: SignalListener,\n    ): ISignaler {\n        const signalerSignalName = this.getSignalerSignalName(signalName);\n        this.emitter.off(signalerSignalName, listener);\n        return this;\n    }\n\n    public submitSignal(\n        signalName: string,\n        payload?: Jsonable,\n    ) {\n        const signalerSignalName = this.getSignalerSignalName(signalName);\n        if (this.signaler.connected) {\n            this.signaler.submitSignal(signalerSignalName, payload);\n        }\n    }\n}\n\n/**\n * DataObject implementation of ISignaler for fluid-static plug-and-play.  Allows fluid-static\n * users to get an ISignaler without a custom DO.\n */\nexport class Signaler extends DataObject<{ Events: IErrorEvent; }> implements EventEmitter, ISignaler {\n    private _signaler: InternalSignaler | undefined;\n    private get signaler(): InternalSignaler {\n        assert(this._signaler !== undefined, 0x24b /* \"internal signaler should be defined\" */);\n        return this._signaler;\n    }\n\n    public static get Name() { return \"@fluid-example/signaler\"; }\n\n    public static readonly factory = new DataObjectFactory(\n        Signaler.Name,\n        Signaler,\n        [],\n        {},\n    );\n\n    protected async hasInitialized() {\n        this._signaler = new InternalSignaler(this.runtime);\n        this.signaler.on(\"error\", (error) => {\n            this.emit(\"error\", error);\n        });\n    }\n\n    // ISignaler methods  Note these are all passthroughs\n\n    public onSignal(\n        signalName: string,\n        listener: SignalListener,\n    ): ISignaler {\n        this.signaler.onSignal(signalName, listener);\n        return this;\n    }\n\n    public offSignal(\n        signalName: string,\n        listener: SignalListener,\n    ): ISignaler {\n        this.signaler.offSignal(signalName, listener);\n        return this;\n    }\n\n    public submitSignal(\n        signalName: string,\n        payload?: Jsonable,\n    ) {\n        this.signaler.submitSignal(signalName, payload);\n    }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-experimental/data-objects",
-  "version": "1.2.2",
+  "version": "2.0.0-internal.1.0.0.82159",
   "description": "A collection of ready to use Fluid Data Objects",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -31,12 +31,12 @@
     "tsfmt:fix": "tsfmt --replace"
   },
   "dependencies": {
-    "@fluidframework/aqueduct": "^1.2.2",
+    "@fluidframework/aqueduct": "2.0.0-internal.1.0.0.82159",
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/datastore-definitions": "^1.2.2",
-    "@fluidframework/map": "^1.2.2",
-    "@fluidframework/runtime-definitions": "^1.2.2"
+    "@fluidframework/datastore-definitions": "2.0.0-internal.1.0.0.82159",
+    "@fluidframework/map": "2.0.0-internal.1.0.0.82159",
+    "@fluidframework/runtime-definitions": "2.0.0-internal.1.0.0.82159"
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.24.0",

package/src/index.ts

@@ -3,4 +3,4 @@
  * Licensed under the MIT License.
  */
 
-export * from "./signalManager";
+export * from "./signaler";

package/src/signaler/README.md

@@ -0,0 +1,76 @@
+# Signaler
+The `Signaler` is a DataObject that can be used to communicate transient data via signals. Transient data refers to impermanent information that is not persisted with the container.
+
+## Usage
+User presence scenarios are well-suited for `Signaler`, as users are required to tell other users their own information and their past data is mostly irrelavant. Using `Signaler` over other distributed data structures in these scenarios is beneficial, as its usage does not result in the storage of data that is not useful in the long-term.
+
+### Creation
+Just like with DDSes, you can include `Signaler` as a shared object you would like to load in your `FluidContainer` schema.
+
+Here is a look at how you would go about loading `Signaler` as part of the initial objects of the container:
+
+```typescript
+const containerSchema: ContainerSchema = {
+    initialObjects: {
+        signaler: Signaler,
+    },
+};
+
+const { container, services } = await client.createContainer(containerSchema);
+
+const signaler = container.initialObjects.signaler as Signaler;
+```
+
+`signaler` can then be directly used in your Fluid application!
+
+For more information on using `ContainerSchema` to create objects please see [Data modeling](https://fluidframework.com/docs/build/data-modeling/).
+
+## API
+`Signaler` provides a few simple methods to send signals and add/remove listeners to specific signals as well:
+- `submitSignal(signalName: string, payload?: Jsonable)` - Sends a signal with a payload to its connected listeners
+- `onSignal(signalName: string, listener: SignalListener)` - Adds a listener for the specified signal. Same behavior as EventEmitter's `on` method.
+- `offSignal(signalName: string, listener: SignalListener)` - Removes a listener for the specified signal. Same behavior as EventEmitter's `off` method.
+
+## Common Patterns
+### Signal Request
+When a client joins a collaboration session, they may need to receive pertinent information immediately after connecting the container.  To support this, they can request a specific signal be sent to them from other connected clients within the application. For example, in the [PresenceTracker](https://github.com/microsoft/FluidFramework/tree/main/examples/data-objects/presence-tracker) we define a "focusRequest" signal type that a newly joining client uses to request the focus-state of each currently connected client:
+
+```typescript
+private static readonly focusRequestType = "focusRequest";
+```
+
+```typescript
+container.on("connected", () => {
+    this.signaler.submitSignal(FocusTracker.focusRequestType);
+});
+```
+
+The connected clients are listening to this focus request signal, and they respond with their current focus state:
+
+```typescript
+this.signaler.onSignal(FocusTracker.focusRequestType, () => {
+    this.sendFocusSignal(document.hasFocus());
+});
+```
+When there are a lot of connected clients, usage of this request pattern can lead to high signal costs incurred from large amounts of signals being submitted all at the same time. While this pattern is helpful when a client is in need of relevant information, to limit signal costs it would be beneficial to examine whether or not the requested data will be quickly avaiable from other events being listened to within the application. The mouse tracking in [PresenceTracker](https://github.com/microsoft/FluidFramework/tree/main/examples/data-objects/presence-tracker) is an example where a newly connecting client is not required to request a signal to receive every current mouse position on the document. Since mouse movements are frequent, the newly connecting client can simply wait to recieve other users mouse positions on their mousemove events.
+### Grouping Signal Types
+
+Rather than submitting multiple signal types in response to one specific event, it is more cost-effective to create one seperate signal type for that particular event and listen to that single signal instead. For example, imagine an application using the `Signal Request` pattern where a newly connected client requests for the color, focus state, and currently selected object of every other connected client on the page. If you submit a signal for each type of data requested, it would look something like this:
+
+```typescript
+container.on("connected", () => {
+    this.signaler.submitSignal("colorRequest");
+    this.signaler.submitSignal("focusRequest");
+    this.signaler.submitSignal("currentlySelectedObjectRequest");
+});
+```
+
+This approach is costly since the amount of signals sent back on request grows linearly with the amount of connected users. So if there are three signals requested as opposed to one, there are 3 times as many total signals being submitted on every connect. To avoid this costly scenario we can group the signal types into one single signal that captures all the required information:
+
+```typescript
+container.on("connected", () => {
+    this.signaler.submitSignal("connectRequest");
+});
+```
+
+The idea is that the payload sent back on the `connectRequest` will include all the relevant information the newly connected user needs.

package/src/{signalManager → signaler}/index.ts

@@ -3,4 +3,4 @@
  * Licensed under the MIT License.
  */
 
-export * from "./signalManager";
+export * from "./signaler";

package/src/{signalManager/signalManager.ts → signaler/signaler.ts}

@@ -59,16 +59,16 @@ export interface IRuntimeSignaler {
 /**
  * Note: currently experimental and under development
  *
- * Helper class to assist common scenarios around working with signals.  Signaler wraps a runtime
+ * Helper class to assist common scenarios around working with signals.  InternalSignaler wraps a runtime
  * object with signaling functionality (e.g. ContainerRuntime or FluidDataStoreRuntime) and can
  * then be used in place of the original signaler.  It uses a separate internal EventEmitter to
  * manage callbacks, and thus will reflect that behavior with regards to callback registration and
  * deregistration.
  */
-export class Signaler extends TypedEventEmitter<IErrorEvent> implements ISignaler {
+ class InternalSignaler extends TypedEventEmitter<IErrorEvent> implements ISignaler {
     private readonly emitter = new EventEmitter();
 
-    private readonly managerId: string | undefined;
+    private readonly signalerId: string | undefined;
 
     constructor(
         /**
@@ -80,13 +80,13 @@ export class Signaler extends TypedEventEmitter<IErrorEvent> implements ISignale
          * signal names.  Useful to avoid collisions if there are multiple
          * signal users at the Container level
          */
-        managerId?: string,
+        signalerId?: string,
     ) {
         super();
         this.emitter.on("error", (error) => {
             this.emit("error", error);
         });
-        this.managerId = managerId ? `#${managerId}` : undefined;
+        this.signalerId = signalerId ? `#${signalerId}` : undefined;
         this.signaler.on("signal", (message: IInboundSignalMessage, local: boolean) => {
             const clientId = message.clientId;
             // Only call listeners when the runtime is connected and if the signal has an
@@ -98,8 +98,8 @@ export class Signaler extends TypedEventEmitter<IErrorEvent> implements ISignale
         });
     }
 
-    private getManagerSignalName(signalName: string): string {
-        return this.managerId ? `${signalName}${this.managerId}` : signalName;
+    private getSignalerSignalName(signalName: string): string {
+        return this.signalerId ? `${signalName}${this.signalerId}` : signalName;
     }
 
     // ISignaler methods
@@ -108,8 +108,8 @@ export class Signaler extends TypedEventEmitter<IErrorEvent> implements ISignale
         signalName: string,
         listener: SignalListener,
     ): ISignaler {
-        const managerSignalName = this.getManagerSignalName(signalName);
-        this.emitter.on(managerSignalName, listener);
+        const signalerSignalName = this.getSignalerSignalName(signalName);
+        this.emitter.on(signalerSignalName, listener);
         return this;
     }
 
@@ -117,8 +117,8 @@ export class Signaler extends TypedEventEmitter<IErrorEvent> implements ISignale
         signalName: string,
         listener: SignalListener,
     ): ISignaler {
-        const managerSignalName = this.getManagerSignalName(signalName);
-        this.emitter.off(managerSignalName, listener);
+        const signalerSignalName = this.getSignalerSignalName(signalName);
+        this.emitter.off(signalerSignalName, listener);
         return this;
     }
 
@@ -126,39 +126,36 @@ export class Signaler extends TypedEventEmitter<IErrorEvent> implements ISignale
         signalName: string,
         payload?: Jsonable,
     ) {
-        const managerSignalName = this.getManagerSignalName(signalName);
+        const signalerSignalName = this.getSignalerSignalName(signalName);
         if (this.signaler.connected) {
-            this.signaler.submitSignal(managerSignalName, payload);
+            this.signaler.submitSignal(signalerSignalName, payload);
         }
     }
 }
 
 /**
- * Note: currently experimental and under development
- *
  * DataObject implementation of ISignaler for fluid-static plug-and-play.  Allows fluid-static
- * users to get an ISignaler without a custom DO.  Where possible, consumers should instead
- * create a Signaler themselves instead of using the DO wrapper to avoid the DO overhead.
+ * users to get an ISignaler without a custom DO.
  */
-export class SignalManager extends DataObject<{ Events: IErrorEvent; }> implements EventEmitter, ISignaler {
-    private _manager: Signaler | undefined;
-    private get manager(): Signaler {
-        assert(this._manager !== undefined, 0x24b /* "internal signaler should be defined" */);
-        return this._manager;
+export class Signaler extends DataObject<{ Events: IErrorEvent; }> implements EventEmitter, ISignaler {
+    private _signaler: InternalSignaler | undefined;
+    private get signaler(): InternalSignaler {
+        assert(this._signaler !== undefined, 0x24b /* "internal signaler should be defined" */);
+        return this._signaler;
     }
 
-    public static get Name() { return "@fluid-example/signal-manager"; }
+    public static get Name() { return "@fluid-example/signaler"; }
 
     public static readonly factory = new DataObjectFactory(
-        SignalManager.Name,
-        SignalManager,
+        Signaler.Name,
+        Signaler,
         [],
         {},
     );
 
     protected async hasInitialized() {
-        this._manager = new Signaler(this.runtime);
-        this.manager.on("error", (error) => {
+        this._signaler = new InternalSignaler(this.runtime);
+        this.signaler.on("error", (error) => {
             this.emit("error", error);
         });
     }
@@ -169,7 +166,7 @@ export class SignalManager extends DataObject<{ Events: IErrorEvent; }> implemen
         signalName: string,
         listener: SignalListener,
     ): ISignaler {
-        this.manager.onSignal(signalName, listener);
+        this.signaler.onSignal(signalName, listener);
         return this;
     }
 
@@ -177,7 +174,7 @@ export class SignalManager extends DataObject<{ Events: IErrorEvent; }> implemen
         signalName: string,
         listener: SignalListener,
     ): ISignaler {
-        this.manager.offSignal(signalName, listener);
+        this.signaler.offSignal(signalName, listener);
         return this;
     }
 
@@ -185,6 +182,6 @@ export class SignalManager extends DataObject<{ Events: IErrorEvent; }> implemen
         signalName: string,
         payload?: Jsonable,
     ) {
-        this.manager.submitSignal(signalName, payload);
+        this.signaler.submitSignal(signalName, payload);
     }
 }

package/dist/signalManager/index.d.ts

@@ -1,6 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-export * from "./signalManager";
-//# sourceMappingURL=index.d.ts.map

package/dist/signalManager/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/signalManager/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,iBAAiB,CAAC"}

package/dist/signalManager/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/signalManager/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,iBAAiB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport * from \"./signalManager\";\n"]}

package/dist/signalManager/signalManager.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"signalManager.d.ts","sourceRoot":"","sources":["../../src/signalManager/signalManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AACzE,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACjE,OAAO,EAAU,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAM5E,oBAAY,cAAc,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,KAAK,IAAI,CAAC;AAE3F;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACtB;;;;;;OAMG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,GAAG,SAAS,CAAC;IACjE;;;;;;MAME;IACH,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,GAAG,SAAS,CAAC;IACnE;;;;OAIG;IACH,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,OAAE;CACxD;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC7B,SAAS,EAAE,OAAO,CAAC;IACnB,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,qBAAqB,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,OAAE;IACxF,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;CAClD;AAED;;;;;;;;GAQG;AACH,qBAAa,QAAS,SAAQ,iBAAiB,CAAC,WAAW,CAAE,YAAW,SAAS;IAMzE;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAR7B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAsB;IAE9C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAqB;;IAG3C;;OAEG;IACc,QAAQ,EAAE,gBAAgB;IAC3C;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM;IAkBtB,OAAO,CAAC,oBAAoB;IAMrB,QAAQ,CACX,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,cAAc,GACzB,SAAS;IAML,SAAS,CACZ,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,cAAc,GACzB,SAAS;IAML,YAAY,CACf,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,QAAQ;CAOzB;AAED;;;;;;GAMG;AACH,qBAAa,aAAc,SAAQ,UAAU,CAAC;IAAE,MAAM,EAAE,WAAW,CAAC;CAAE,CAAE,YAAW,YAAY,EAAE,SAAS;IACtG,OAAO,CAAC,QAAQ,CAAuB;IACvC,OAAO,KAAK,OAAO,GAGlB;IAED,WAAkB,IAAI,WAA8C;IAEpE,gBAAuB,OAAO;gBATsB,WAAW;OAc7D;cAEc,cAAc;IASvB,QAAQ,CACX,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,cAAc,GACzB,SAAS;IAKL,SAAS,CACZ,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,cAAc,GACzB,SAAS;IAKL,YAAY,CACf,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,QAAQ;CAIzB"}

package/dist/signalManager/signalManager.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"signalManager.js","sourceRoot":"","sources":["../../src/signalManager/signalManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAEzE,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAkDzE;;;;;;;;GAQG;AACH,MAAM,OAAO,QAAS,SAAQ,iBAA8B;IAKxD;IACI;;OAEG;IACc,QAA0B;IAC3C;;;;OAIG;IACH,SAAkB;QAElB,KAAK,EAAE,CAAC;QARS,aAAQ,GAAR,QAAQ,CAAkB;QAR9B,YAAO,GAAG,IAAI,YAAY,EAAE,CAAC;QAiB1C,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC/B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACzD,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,OAA8B,EAAE,KAAc,EAAE,EAAE;YAC1E,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;YAClC,6EAA6E;YAC7E,8EAA8E;YAC9E,0CAA0C;YAC1C,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,IAAI,QAAQ,KAAK,IAAI,EAAE;gBAC9C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;aACrE;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,oBAAoB,CAAC,UAAkB;QAC3C,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,UAAU,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC;IAC1E,CAAC;IAED,oBAAoB;IAEb,QAAQ,CACX,UAAkB,EAClB,QAAwB;QAExB,MAAM,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QAChE,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,SAAS,CACZ,UAAkB,EAClB,QAAwB;QAExB,MAAM,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QAChE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,YAAY,CACf,UAAkB,EAClB,OAAkB;QAElB,MAAM,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QAChE,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE;YACzB,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;SAC1D;IACL,CAAC;CACJ;AAED;;;;;;GAMG;AACH,MAAM,OAAO,aAAc,SAAQ,UAAoC;IAEnE,IAAY,OAAO;QACf,MAAM,CAAC,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,KAAK,CAAC,2CAA2C,CAAC,CAAC;QACvF,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAEM,MAAM,KAAK,IAAI,KAAK,OAAO,+BAA+B,CAAC,CAAC,CAAC;IAS1D,KAAK,CAAC,cAAc;QAC1B,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3C,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC/B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACP,CAAC;IAED,qDAAqD;IAE9C,QAAQ,CACX,UAAkB,EAClB,QAAwB;QAExB,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,SAAS,CACZ,UAAkB,EAClB,QAAwB;QAExB,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,YAAY,CACf,UAAkB,EAClB,OAAkB;QAElB,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;;AArCsB,qBAAO,GAAG,IAAI,iBAAiB,CAClD,aAAa,CAAC,IAAI,EAClB,aAAa,EACb,EAAE,EACF,EAAE,CACL,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { EventEmitter } from \"events\";\nimport { DataObject, DataObjectFactory } from \"@fluidframework/aqueduct\";\nimport { IErrorEvent } from \"@fluidframework/common-definitions\";\nimport { assert, TypedEventEmitter } from \"@fluidframework/common-utils\";\nimport { Jsonable } from \"@fluidframework/datastore-definitions\";\nimport { IInboundSignalMessage } from \"@fluidframework/runtime-definitions\";\n\n// TODO:\n// add way to mark with current sequence number for ordering signals relative to ops\n// throttling and batching\n\nexport type SignalListener = (clientId: string, local: boolean, payload: Jsonable) => void;\n\n/**\n * ISignaler defines an interface for working with signals that is similar to the more common\n * eventing patterns of EventEmitter.  In addition to sending and responding to signals, it\n * provides explicit methods around signal requests to other connected clients.\n */\nexport interface ISignaler {\n    /**\n     * Adds a listener for the specified signal.  It behaves in the same way as EventEmitter's `on`\n     * method regarding multiple registrations, callback order, etc.\n     * @param signalName - The name of the signal\n     * @param listener - The callback signal handler to add\n     * @returns This ISignaler\n     */\n    onSignal(signalName: string, listener: SignalListener): ISignaler;\n     /**\n     * Remove a listener for the specified signal.  It behaves in the same way as EventEmitter's\n     * `off` method regarding multiple registrations, removal order, etc.\n     * @param signalName - The name of the signal\n     * @param listener - The callback signal handler to remove\n     * @returns This ISignaler\n     */\n    offSignal(signalName: string, listener: SignalListener): ISignaler;\n    /**\n     * Send a signal with payload to its connected listeners.\n     * @param signalName - The name of the signal\n     * @param payload - The data to send with the signal\n     */\n    submitSignal(signalName: string, payload?: Jsonable);\n}\n\n/**\n * Duck type of something that provides the expected signalling functionality:\n * A way to verify we can signal, a way to send a signal, and a way to listen for incoming signals\n */\nexport interface IRuntimeSignaler {\n    connected: boolean;\n    on(event: \"signal\", listener: (message: IInboundSignalMessage, local: boolean) => void);\n    submitSignal(type: string, content: any): void;\n}\n\n/**\n * Note: currently experimental and under development\n *\n * Helper class to assist common scenarios around working with signals.  Signaler wraps a runtime\n * object with signaling functionality (e.g. ContainerRuntime or FluidDataStoreRuntime) and can\n * then be used in place of the original signaler.  It uses a separate internal EventEmitter to\n * manage callbacks, and thus will reflect that behavior with regards to callback registration and\n * deregistration.\n */\nexport class Signaler extends TypedEventEmitter<IErrorEvent> implements ISignaler {\n    private readonly emitter = new EventEmitter();\n\n    private readonly managerId: string | undefined;\n\n    constructor(\n        /**\n         * Object to wrap that can submit and listen to signals\n         */\n        private readonly signaler: IRuntimeSignaler,\n        /**\n         * Optional id to assign to this manager that will be attached to\n         * signal names.  Useful to avoid collisions if there are multiple\n         * signal users at the Container level\n         */\n        managerId?: string,\n    ) {\n        super();\n        this.emitter.on(\"error\", (error) => {\n            this.emit(\"error\", error);\n        });\n        this.managerId = managerId ? `#${managerId}` : undefined;\n        this.signaler.on(\"signal\", (message: IInboundSignalMessage, local: boolean) => {\n            const clientId = message.clientId;\n            // Only call listeners when the runtime is connected and if the signal has an\n            // identifiable sender clientId.  The listener is responsible for deciding how\n            // it wants to handle local/remote signals\n            if (this.signaler.connected && clientId !== null) {\n                this.emitter.emit(message.type, clientId, local, message.content);\n            }\n        });\n    }\n\n    private getManagerSignalName(signalName: string): string {\n        return this.managerId ? `${signalName}${this.managerId}` : signalName;\n    }\n\n    // ISignaler methods\n\n    public onSignal(\n        signalName: string,\n        listener: SignalListener,\n    ): ISignaler {\n        const managerSignalName = this.getManagerSignalName(signalName);\n        this.emitter.on(managerSignalName, listener);\n        return this;\n    }\n\n    public offSignal(\n        signalName: string,\n        listener: SignalListener,\n    ): ISignaler {\n        const managerSignalName = this.getManagerSignalName(signalName);\n        this.emitter.off(managerSignalName, listener);\n        return this;\n    }\n\n    public submitSignal(\n        signalName: string,\n        payload?: Jsonable,\n    ) {\n        const managerSignalName = this.getManagerSignalName(signalName);\n        if (this.signaler.connected) {\n            this.signaler.submitSignal(managerSignalName, payload);\n        }\n    }\n}\n\n/**\n * Note: currently experimental and under development\n *\n * DataObject implementation of ISignaler for fluid-static plug-and-play.  Allows fluid-static\n * users to get an ISignaler without a custom DO.  Where possible, consumers should instead\n * create a Signaler themselves instead of using the DO wrapper to avoid the DO overhead.\n */\nexport class SignalManager extends DataObject<{ Events: IErrorEvent; }> implements EventEmitter, ISignaler {\n    private _manager: Signaler | undefined;\n    private get manager(): Signaler {\n        assert(this._manager !== undefined, 0x24b /* \"internal signaler should be defined\" */);\n        return this._manager;\n    }\n\n    public static get Name() { return \"@fluid-example/signal-manager\"; }\n\n    public static readonly factory = new DataObjectFactory(\n        SignalManager.Name,\n        SignalManager,\n        [],\n        {},\n    );\n\n    protected async hasInitialized() {\n        this._manager = new Signaler(this.runtime);\n        this.manager.on(\"error\", (error) => {\n            this.emit(\"error\", error);\n        });\n    }\n\n    // ISignaler methods  Note these are all passthroughs\n\n    public onSignal(\n        signalName: string,\n        listener: SignalListener,\n    ): ISignaler {\n        this.manager.onSignal(signalName, listener);\n        return this;\n    }\n\n    public offSignal(\n        signalName: string,\n        listener: SignalListener,\n    ): ISignaler {\n        this.manager.offSignal(signalName, listener);\n        return this;\n    }\n\n    public submitSignal(\n        signalName: string,\n        payload?: Jsonable,\n    ) {\n        this.manager.submitSignal(signalName, payload);\n    }\n}\n"]}

package/lib/signalManager/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/signalManager/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,iBAAiB,CAAC"}

package/lib/signalManager/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/signalManager/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,iBAAiB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport * from \"./signalManager\";\n"]}

package/lib/signalManager/signalManager.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"signalManager.d.ts","sourceRoot":"","sources":["../../src/signalManager/signalManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AACzE,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACjE,OAAO,EAAU,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAM5E,oBAAY,cAAc,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,KAAK,IAAI,CAAC;AAE3F;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACtB;;;;;;OAMG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,GAAG,SAAS,CAAC;IACjE;;;;;;MAME;IACH,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,GAAG,SAAS,CAAC;IACnE;;;;OAIG;IACH,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,OAAE;CACxD;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC7B,SAAS,EAAE,OAAO,CAAC;IACnB,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,qBAAqB,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,OAAE;IACxF,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;CAClD;AAED;;;;;;;;GAQG;AACH,qBAAa,QAAS,SAAQ,iBAAiB,CAAC,WAAW,CAAE,YAAW,SAAS;IAMzE;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAR7B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAsB;IAE9C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAqB;;IAG3C;;OAEG;IACc,QAAQ,EAAE,gBAAgB;IAC3C;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM;IAkBtB,OAAO,CAAC,oBAAoB;IAMrB,QAAQ,CACX,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,cAAc,GACzB,SAAS;IAML,SAAS,CACZ,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,cAAc,GACzB,SAAS;IAML,YAAY,CACf,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,QAAQ;CAOzB;AAED;;;;;;GAMG;AACH,qBAAa,aAAc,SAAQ,UAAU,CAAC;IAAE,MAAM,EAAE,WAAW,CAAC;CAAE,CAAE,YAAW,YAAY,EAAE,SAAS;IACtG,OAAO,CAAC,QAAQ,CAAuB;IACvC,OAAO,KAAK,OAAO,GAGlB;IAED,WAAkB,IAAI,WAA8C;IAEpE,gBAAuB,OAAO;gBATsB,WAAW;OAc7D;cAEc,cAAc;IASvB,QAAQ,CACX,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,cAAc,GACzB,SAAS;IAKL,SAAS,CACZ,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,cAAc,GACzB,SAAS;IAKL,YAAY,CACf,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,QAAQ;CAIzB"}

package/lib/signalManager/signalManager.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"signalManager.js","sourceRoot":"","sources":["../../src/signalManager/signalManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAEzE,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAkDzE;;;;;;;;GAQG;AACH,MAAM,OAAO,QAAS,SAAQ,iBAA8B;IAKxD;IACI;;OAEG;IACc,QAA0B;IAC3C;;;;OAIG;IACH,SAAkB;QAElB,KAAK,EAAE,CAAC;QARS,aAAQ,GAAR,QAAQ,CAAkB;QAR9B,YAAO,GAAG,IAAI,YAAY,EAAE,CAAC;QAiB1C,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC/B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACzD,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,OAA8B,EAAE,KAAc,EAAE,EAAE;YAC1E,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;YAClC,6EAA6E;YAC7E,8EAA8E;YAC9E,0CAA0C;YAC1C,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,IAAI,QAAQ,KAAK,IAAI,EAAE;gBAC9C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;aACrE;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,oBAAoB,CAAC,UAAkB;QAC3C,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,UAAU,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC;IAC1E,CAAC;IAED,oBAAoB;IAEb,QAAQ,CACX,UAAkB,EAClB,QAAwB;QAExB,MAAM,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QAChE,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,SAAS,CACZ,UAAkB,EAClB,QAAwB;QAExB,MAAM,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QAChE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,YAAY,CACf,UAAkB,EAClB,OAAkB;QAElB,MAAM,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QAChE,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE;YACzB,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;SAC1D;IACL,CAAC;CACJ;AAED;;;;;;GAMG;AACH,MAAM,OAAO,aAAc,SAAQ,UAAoC;IAEnE,IAAY,OAAO;QACf,MAAM,CAAC,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,KAAK,CAAC,2CAA2C,CAAC,CAAC;QACvF,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAEM,MAAM,KAAK,IAAI,KAAK,OAAO,+BAA+B,CAAC,CAAC,CAAC;IAS1D,KAAK,CAAC,cAAc;QAC1B,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3C,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC/B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACP,CAAC;IAED,qDAAqD;IAE9C,QAAQ,CACX,UAAkB,EAClB,QAAwB;QAExB,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,SAAS,CACZ,UAAkB,EAClB,QAAwB;QAExB,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,YAAY,CACf,UAAkB,EAClB,OAAkB;QAElB,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;;AArCsB,qBAAO,GAAG,IAAI,iBAAiB,CAClD,aAAa,CAAC,IAAI,EAClB,aAAa,EACb,EAAE,EACF,EAAE,CACL,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { EventEmitter } from \"events\";\nimport { DataObject, DataObjectFactory } from \"@fluidframework/aqueduct\";\nimport { IErrorEvent } from \"@fluidframework/common-definitions\";\nimport { assert, TypedEventEmitter } from \"@fluidframework/common-utils\";\nimport { Jsonable } from \"@fluidframework/datastore-definitions\";\nimport { IInboundSignalMessage } from \"@fluidframework/runtime-definitions\";\n\n// TODO:\n// add way to mark with current sequence number for ordering signals relative to ops\n// throttling and batching\n\nexport type SignalListener = (clientId: string, local: boolean, payload: Jsonable) => void;\n\n/**\n * ISignaler defines an interface for working with signals that is similar to the more common\n * eventing patterns of EventEmitter.  In addition to sending and responding to signals, it\n * provides explicit methods around signal requests to other connected clients.\n */\nexport interface ISignaler {\n    /**\n     * Adds a listener for the specified signal.  It behaves in the same way as EventEmitter's `on`\n     * method regarding multiple registrations, callback order, etc.\n     * @param signalName - The name of the signal\n     * @param listener - The callback signal handler to add\n     * @returns This ISignaler\n     */\n    onSignal(signalName: string, listener: SignalListener): ISignaler;\n     /**\n     * Remove a listener for the specified signal.  It behaves in the same way as EventEmitter's\n     * `off` method regarding multiple registrations, removal order, etc.\n     * @param signalName - The name of the signal\n     * @param listener - The callback signal handler to remove\n     * @returns This ISignaler\n     */\n    offSignal(signalName: string, listener: SignalListener): ISignaler;\n    /**\n     * Send a signal with payload to its connected listeners.\n     * @param signalName - The name of the signal\n     * @param payload - The data to send with the signal\n     */\n    submitSignal(signalName: string, payload?: Jsonable);\n}\n\n/**\n * Duck type of something that provides the expected signalling functionality:\n * A way to verify we can signal, a way to send a signal, and a way to listen for incoming signals\n */\nexport interface IRuntimeSignaler {\n    connected: boolean;\n    on(event: \"signal\", listener: (message: IInboundSignalMessage, local: boolean) => void);\n    submitSignal(type: string, content: any): void;\n}\n\n/**\n * Note: currently experimental and under development\n *\n * Helper class to assist common scenarios around working with signals.  Signaler wraps a runtime\n * object with signaling functionality (e.g. ContainerRuntime or FluidDataStoreRuntime) and can\n * then be used in place of the original signaler.  It uses a separate internal EventEmitter to\n * manage callbacks, and thus will reflect that behavior with regards to callback registration and\n * deregistration.\n */\nexport class Signaler extends TypedEventEmitter<IErrorEvent> implements ISignaler {\n    private readonly emitter = new EventEmitter();\n\n    private readonly managerId: string | undefined;\n\n    constructor(\n        /**\n         * Object to wrap that can submit and listen to signals\n         */\n        private readonly signaler: IRuntimeSignaler,\n        /**\n         * Optional id to assign to this manager that will be attached to\n         * signal names.  Useful to avoid collisions if there are multiple\n         * signal users at the Container level\n         */\n        managerId?: string,\n    ) {\n        super();\n        this.emitter.on(\"error\", (error) => {\n            this.emit(\"error\", error);\n        });\n        this.managerId = managerId ? `#${managerId}` : undefined;\n        this.signaler.on(\"signal\", (message: IInboundSignalMessage, local: boolean) => {\n            const clientId = message.clientId;\n            // Only call listeners when the runtime is connected and if the signal has an\n            // identifiable sender clientId.  The listener is responsible for deciding how\n            // it wants to handle local/remote signals\n            if (this.signaler.connected && clientId !== null) {\n                this.emitter.emit(message.type, clientId, local, message.content);\n            }\n        });\n    }\n\n    private getManagerSignalName(signalName: string): string {\n        return this.managerId ? `${signalName}${this.managerId}` : signalName;\n    }\n\n    // ISignaler methods\n\n    public onSignal(\n        signalName: string,\n        listener: SignalListener,\n    ): ISignaler {\n        const managerSignalName = this.getManagerSignalName(signalName);\n        this.emitter.on(managerSignalName, listener);\n        return this;\n    }\n\n    public offSignal(\n        signalName: string,\n        listener: SignalListener,\n    ): ISignaler {\n        const managerSignalName = this.getManagerSignalName(signalName);\n        this.emitter.off(managerSignalName, listener);\n        return this;\n    }\n\n    public submitSignal(\n        signalName: string,\n        payload?: Jsonable,\n    ) {\n        const managerSignalName = this.getManagerSignalName(signalName);\n        if (this.signaler.connected) {\n            this.signaler.submitSignal(managerSignalName, payload);\n        }\n    }\n}\n\n/**\n * Note: currently experimental and under development\n *\n * DataObject implementation of ISignaler for fluid-static plug-and-play.  Allows fluid-static\n * users to get an ISignaler without a custom DO.  Where possible, consumers should instead\n * create a Signaler themselves instead of using the DO wrapper to avoid the DO overhead.\n */\nexport class SignalManager extends DataObject<{ Events: IErrorEvent; }> implements EventEmitter, ISignaler {\n    private _manager: Signaler | undefined;\n    private get manager(): Signaler {\n        assert(this._manager !== undefined, 0x24b /* \"internal signaler should be defined\" */);\n        return this._manager;\n    }\n\n    public static get Name() { return \"@fluid-example/signal-manager\"; }\n\n    public static readonly factory = new DataObjectFactory(\n        SignalManager.Name,\n        SignalManager,\n        [],\n        {},\n    );\n\n    protected async hasInitialized() {\n        this._manager = new Signaler(this.runtime);\n        this.manager.on(\"error\", (error) => {\n            this.emit(\"error\", error);\n        });\n    }\n\n    // ISignaler methods  Note these are all passthroughs\n\n    public onSignal(\n        signalName: string,\n        listener: SignalListener,\n    ): ISignaler {\n        this.manager.onSignal(signalName, listener);\n        return this;\n    }\n\n    public offSignal(\n        signalName: string,\n        listener: SignalListener,\n    ): ISignaler {\n        this.manager.offSignal(signalName, listener);\n        return this;\n    }\n\n    public submitSignal(\n        signalName: string,\n        payload?: Jsonable,\n    ) {\n        this.manager.submitSignal(signalName, payload);\n    }\n}\n"]}

package/src/signalManager/README.md

@@ -1,55 +0,0 @@
-# SignalManager
-The `SignalManager` is a DataObject that can be used to communicate transient data via signals. Transient data refers to impermanent information that is not persisted with the container.
-
-## Usage
-User presence scenarios are well-suited for `SignalManager`, as users are required to tell other users their own information and their past data is mostly irrelavant. Using `SignalManager` over other distributed data structures in these scenarios is beneficial, as its usage does not result in the storage of data that is not useful in the long-term.
-
-### Creation
-Just like with DDSes, you can include `SignalManager` as a shared object you would like to load in your `FluidContainer` schema.
-
-Here is a look at how you would go about loading `SignalManager` as part of the initial objects of the container:
-
-```typescript
-const containerSchema: ContainerSchema = {
-    initialObjects: {
-        signalManager: SignalManager,
-    },
-};
-
-const { container, services } = await client.createContainer(containerSchema);
-
-const signalManager = container.initialObjects.signalManager as SignalManager;
-```
-
-`signalManager` can then be directly used in your Fluid application!
-
-For more information on using `ContainerSchema` to create objects please see [Data modeling](https://fluidframework.com/docs/build/data-modeling/).
-
-## API
-`SignalManager` provides a few simple methods to send signals and add/remove listeners to specific signals as well:
-- `submitSignal(signalName: string, payload?: Jsonable)` - Sends a signal with a payload to its connected listeners
-- `onSignal(signalName: string, listener: SignalListener)` - Adds a listener for the specified signal. Same behavior as EventEmitter's `on` method.
-- `offSignal(signalName: string, listener: SignalListener)` - Removes a listener for the specified signal. Same behavior as EventEmitter's `off` method.
-
-## Common Patterns
-### Signal Request
-When a client joins a collaboration session, they may need to receive pertinent information immediately after connecting the container.  To support this, they can request a specific signal be sent to them from other connected clients within the application. For example, in the [FocusTracker](https://github.com/microsoft/FluidFramework/tree/main/examples/data-objects/focus-tracker) we define a "focusRequest" signal type that a newly joining client uses to request the focus-state of each currently connected client:
-
-```typescript
-private static readonly focusRequestType = "focusRequest";
-```
-
-```typescript
-container.on("connected", () => {
-    this.signalManager.submitSignal(FocusTracker.focusRequestType);
-});
-```
-
-The connected clients are listening to this focus request signal, and they respond with their current focus state:
-
-```typescript
-this.signalManager.onSignal(FocusTracker.focusRequestType, () => {
-    this.sendFocusSignal(document.hasFocus());
-});
-```
-When there are a lot of connected clients, usage of this request pattern can lead to high signal costs incurred from large amounts of signals being submitted all at the same time. While this pattern is helpful when a client is in need of relevant information, to limit signal costs it would be beneficial to examine whether or not the requested data will be quickly avaiable from other events being listened to within the application. Take [MouseTracker]() as an example, a newly connecting client is not required to request a signal to receive every current mouse position on the document. Since mouse movements are frequent, the newly connecting client can simply wait to recieve other users mouse positions on their mousemove events.