@fluid-experimental/data-objects 0.47.1 → 0.48.1

package/dist/index.d.ts

@@ -3,4 +3,5 @@
  * Licensed under the MIT License.
  */
 export * from "./kvpair";
+export * from "./signalManager";
 //# 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,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC"}

package/dist/index.js

@@ -3,4 +3,5 @@
  * Licensed under the MIT License.
  */
 export * from "./kvpair";
+export * from "./signalManager";
 //# 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,UAAU,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport * from \"./kvpair\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport * from \"./kvpair\";\nexport * from \"./signalManager\";\n"]}

package/dist/signalManager/index.d.ts

@@ -0,0 +1,6 @@
+/*!
+ * 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

@@ -0,0 +1 @@
+{"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

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

package/dist/signalManager/index.js.map

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,131 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/// <reference types="node" />
+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;
+/**
+ * ISignaler defines an interface for working with signals that is similar to the more common
+ * eventing patterns of EventEmitter.  In addition to sending and responding to signals, it
+ * provides explicit methods around signal requests to other connected clients.
+ */
+export interface ISignaler {
+    /**
+     * Adds a listener for the specified signal.  It behaves in the same way as EventEmitter's `on`
+     * method regarding multiple registrations, callback order, etc.
+     * @param signalName - The name of the signal
+     * @param listener - The callback signal handler to add
+     * @returns This ISignaler
+     */
+    onSignal(signalName: string, listener: SignalListener): ISignaler;
+    /**
+    * Remove a listener for the specified signal.  It behaves in the same way as EventEmitter's
+    * `off` method regarding multiple registrations, removal order, etc.
+    * @param signalName - The name of the signal
+    * @param listener - The callback signal handler to remove
+    * @returns This ISignaler
+    */
+    offSignal(signalName: string, listener: SignalListener | ((message: any) => void)): ISignaler;
+    /**
+     * Send a signal with payload to its connected listeners.
+     * @param signalName - The name of the signal
+     * @param payload - The data to send with the signal
+     */
+    submitSignal(signalName: string, payload?: Jsonable): any;
+    /**
+     * Adds a listener for a broadcast request.  The listener is called when a client calls
+     * `requestBroadcast` for that signal.  It behaves in the same way as EventEmitter's `on`
+     * method regarding multiple registrations, callback order, etc.
+     * @param signalName - The signal for which broadcast is requested
+     * @param listener - The callback for the broadcast request to add
+     * @returns This ISignaler
+     */
+    onBroadcastRequested(signalName: string, listener: SignalListener): ISignaler;
+    /**
+     * Remove a listener for a broadcast request.  It behaves in the same way as EventEmitter's
+     * `off` method regarding multiple registrations, removal order, etc.
+     * @param signalName  - The signal for which broadcast is requested
+     * @param listener - The callback for the broadcast request to remove
+     * @returns This ISignaler
+     */
+    offBroadcastRequested(signalName: string, listener: SignalListener): ISignaler;
+    /**
+     * Request broadcast of a signal from other connected clients.  Other clients must have
+     * registered to respond to broadcast requests using the `onBroadcastRequested` method.
+     * @param signalName - The signal for which broadcast is requested
+     * @param payload - A payload to send with the broadcast request
+     */
+    requestBroadcast(signalName: string, payload?: Jsonable): any;
+}
+/**
+ * Duck type of something that provides the expected signalling functionality:
+ * A way to verify we can signal, a way to send a signal, and a way to listen for incoming signals
+ */
+export interface IRuntimeSignaler {
+    connected: boolean;
+    on(event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void): any;
+    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;
+    private getBroadcastSignalName;
+    onSignal(signalName: string, listener: SignalListener): ISignaler;
+    offSignal(signalName: string, listener: SignalListener): ISignaler;
+    submitSignal(signalName: string, payload?: Jsonable): void;
+    onBroadcastRequested(signalName: string, listener: SignalListener): ISignaler;
+    offBroadcastRequested(signalName: string, listener: SignalListener): ISignaler;
+    requestBroadcast(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.
+ */
+export declare class SignalManager extends DataObject<{}, undefined, IErrorEvent> implements EventEmitter, ISignaler {
+    private _manager;
+    private get manager();
+    static get Name(): string;
+    static readonly factory: DataObjectFactory<SignalManager, undefined, undefined, IErrorEvent>;
+    protected hasInitialized(): Promise<void>;
+    onSignal(signalName: string, listener: SignalListener): ISignaler;
+    offSignal(signalName: string, listener: SignalListener): ISignaler;
+    submitSignal(signalName: string, payload?: Jsonable): void;
+    onBroadcastRequested(signalName: string, listener: SignalListener): ISignaler;
+    offBroadcastRequested(signalName: string, listener: SignalListener): ISignaler;
+    requestBroadcast(signalName: string, payload?: Jsonable): void;
+}
+//# sourceMappingURL=signalManager.d.ts.map

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

@@ -0,0 +1 @@
+{"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,CAAC,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAC9F;;;;OAIG;IACH,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,OAAE;IAErD;;;;;;;OAOG;IACH,oBAAoB,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,GAAG,SAAS,CAAC;IAC9E;;;;;;OAMG;IACH,qBAAqB,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,GAAG,SAAS,CAAC;IAC/E;;;;;OAKG;IACH,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,OAAE;CAC5D;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,CAAuB;IAE/C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAqB;;IAG3C;;OAEG;IACc,QAAQ,EAAE,gBAAgB;IAC3C;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM;IAmBtB,OAAO,CAAC,oBAAoB;IAI5B,OAAO,CAAC,sBAAsB;IAMvB,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;IAQf,oBAAoB,CACvB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,cAAc,GACzB,SAAS;IAKL,qBAAqB,CACxB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,cAAc,GACzB,SAAS;IAKL,gBAAgB,CACnB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,QAAQ;CAKzB;AAED;;;;;;GAMG;AAEH,qBAAa,aAAc,SAAQ,UAAU,CAAC,EAAE,EAAE,SAAS,EAAE,WAAW,CAAE,YAAW,YAAY,EAAE,SAAS;IACxG,OAAO,CAAC,QAAQ,CAAuB;IACvC,OAAO,KAAK,OAAO,GAGlB;IAED,WAAkB,IAAI,WAA8C;IAEpE,gBAAuB,OAAO,sEAM5B;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;IAKf,oBAAoB,CACvB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,cAAc,GACzB,SAAS;IAKL,qBAAqB,CACxB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,cAAc,GACzB,SAAS;IAKL,gBAAgB,CACnB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,QAAQ;CAIzB"}

package/dist/signalManager/signalManager.js

@@ -0,0 +1,128 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { EventEmitter } from "events";
+import { DataObject, DataObjectFactory } from "@fluidframework/aqueduct";
+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
+ * 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 {
+    constructor(
+    /**
+     * Object to wrap that can submit and listen to signals
+     */
+    signaler, 
+    /**
+     * 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) {
+        super();
+        this.signaler = signaler;
+        this.emitter = new EventEmitter();
+        this.emitter.on("error", (error) => {
+            this.emit("error", error);
+        });
+        this.managerId = managerId ? `#${managerId}` : 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
+            // identifiable sender clientId.  The listener is responsible for deciding how
+            // it wants to handle local/remote signals
+            // eslint-disable-next-line no-null/no-null
+            if (this.signaler.connected && clientId !== null) {
+                this.emitter.emit(message.type, clientId, local, message.content);
+            }
+        });
+    }
+    getManagerSignalName(signalName) {
+        return this.managerId ? `${signalName}${this.managerId}` : signalName;
+    }
+    getBroadcastSignalName(signalName) {
+        return `${signalName}#req`;
+    }
+    // ISignaler methods
+    onSignal(signalName, listener) {
+        const managerSignalName = this.getManagerSignalName(signalName);
+        this.emitter.on(managerSignalName, listener);
+        return this;
+    }
+    offSignal(signalName, listener) {
+        const managerSignalName = this.getManagerSignalName(signalName);
+        this.emitter.off(managerSignalName, listener);
+        return this;
+    }
+    submitSignal(signalName, payload) {
+        const managerSignalName = this.getManagerSignalName(signalName);
+        if (this.signaler.connected) {
+            this.signaler.submitSignal(managerSignalName, payload);
+        }
+    }
+    onBroadcastRequested(signalName, listener) {
+        const broadcastSignalName = this.getBroadcastSignalName(signalName);
+        return this.onSignal(broadcastSignalName, listener);
+    }
+    offBroadcastRequested(signalName, listener) {
+        const broadcastSignalName = this.getBroadcastSignalName(signalName);
+        return this.offSignal(broadcastSignalName, listener);
+    }
+    requestBroadcast(signalName, payload) {
+        const broadcastSignalName = this.getBroadcastSignalName(signalName);
+        this.submitSignal(broadcastSignalName, 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.
+ */
+// eslint-disable-next-line @typescript-eslint/ban-types
+export class SignalManager extends DataObject {
+    get manager() {
+        assert(this._manager !== undefined, 0x24b /* "internal signaler should be defined" */);
+        return this._manager;
+    }
+    static get Name() { return "@fluid-example/signal-manager"; }
+    async hasInitialized() {
+        this._manager = new Signaler(this.runtime);
+        this.manager.on("error", (error) => {
+            this.emit("error", error);
+        });
+    }
+    // ISignaler methods  Note these are all passthroughs
+    onSignal(signalName, listener) {
+        this.manager.onSignal(signalName, listener);
+        return this;
+    }
+    offSignal(signalName, listener) {
+        this.manager.offSignal(signalName, listener);
+        return this;
+    }
+    submitSignal(signalName, payload) {
+        this.manager.submitSignal(signalName, payload);
+    }
+    onBroadcastRequested(signalName, listener) {
+        this.manager.onBroadcastRequested(signalName, listener);
+        return this;
+    }
+    offBroadcastRequested(signalName, listener) {
+        this.manager.offBroadcastRequested(signalName, listener);
+        return this;
+    }
+    requestBroadcast(signalName, payload) {
+        this.manager.requestBroadcast(signalName, payload);
+    }
+}
+SignalManager.factory = new DataObjectFactory(SignalManager.Name, SignalManager, [], {});
+//# sourceMappingURL=signalManager.js.map

package/dist/signalManager/signalManager.js.map

@@ -0,0 +1 @@
+{"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;AA2EzE;;;;;;;;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,GAAI,IAAI,YAAY,EAAE,CAAC;QAiB3C,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,2CAA2C;YAC3C,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;IAEO,sBAAsB,CAAC,UAAkB;QAC7C,OAAO,GAAG,UAAU,MAAM,CAAC;IAC/B,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;IAEM,oBAAoB,CACvB,UAAkB,EAClB,QAAwB;QAExB,MAAM,mBAAmB,GAAG,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;QACpE,OAAO,IAAI,CAAC,QAAQ,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;IACxD,CAAC;IAEM,qBAAqB,CACxB,UAAkB,EAClB,QAAwB;QAExB,MAAM,mBAAmB,GAAG,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;QACpE,OAAO,IAAI,CAAC,SAAS,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;IAEM,gBAAgB,CACnB,UAAkB,EAClB,OAAkB;QAElB,MAAM,mBAAmB,GAAG,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;QACpE,IAAI,CAAC,YAAY,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;CACJ;AAED;;;;;;GAMG;AACH,wDAAwD;AACxD,MAAM,OAAO,aAAc,SAAQ,UAAsC;IAErE,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;IAU1D,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;IAEM,oBAAoB,CACvB,UAAkB,EAClB,QAAwB;QAExB,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACxD,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,qBAAqB,CACxB,UAAkB,EAClB,QAAwB;QAExB,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACzD,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,gBAAgB,CACnB,UAAkB,EAClB,OAAkB;QAElB,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;;AA7DsB,qBAAO,GAAG,IAAI,iBAAiB,CAElD,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 | ((message: any) => void)): 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     * Adds a listener for a broadcast request.  The listener is called when a client calls\n     * `requestBroadcast` for that signal.  It behaves in the same way as EventEmitter's `on`\n     * method regarding multiple registrations, callback order, etc.\n     * @param signalName - The signal for which broadcast is requested\n     * @param listener - The callback for the broadcast request to add\n     * @returns This ISignaler\n     */\n    onBroadcastRequested(signalName: string, listener: SignalListener): ISignaler;\n    /**\n     * Remove a listener for a broadcast request.  It behaves in the same way as EventEmitter's\n     * `off` method regarding multiple registrations, removal order, etc.\n     * @param signalName  - The signal for which broadcast is requested\n     * @param listener - The callback for the broadcast request to remove\n     * @returns This ISignaler\n     */\n    offBroadcastRequested(signalName: string, listener: SignalListener): ISignaler;\n    /**\n     * Request broadcast of a signal from other connected clients.  Other clients must have\n     * registered to respond to broadcast requests using the `onBroadcastRequested` method.\n     * @param signalName - The signal for which broadcast is requested\n     * @param payload - A payload to send with the broadcast request\n     */\n    requestBroadcast(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            // eslint-disable-next-line no-null/no-null\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    private getBroadcastSignalName(signalName: string): string {\n        return `${signalName}#req`;\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    public onBroadcastRequested(\n        signalName: string,\n        listener: SignalListener,\n    ): ISignaler {\n        const broadcastSignalName = this.getBroadcastSignalName(signalName);\n        return this.onSignal(broadcastSignalName, listener);\n    }\n\n    public offBroadcastRequested(\n        signalName: string,\n        listener: SignalListener,\n    ): ISignaler {\n        const broadcastSignalName = this.getBroadcastSignalName(signalName);\n        return this.offSignal(broadcastSignalName, listener);\n    }\n\n    public requestBroadcast(\n        signalName: string,\n        payload?: Jsonable,\n    ) {\n        const broadcastSignalName = this.getBroadcastSignalName(signalName);\n        this.submitSignal(broadcastSignalName, payload);\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 */\n// eslint-disable-next-line @typescript-eslint/ban-types\nexport class SignalManager extends DataObject<{}, undefined, 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<SignalManager, undefined, undefined, IErrorEvent>\n    (\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    public onBroadcastRequested(\n        signalName: string,\n        listener: SignalListener,\n    ): ISignaler {\n        this.manager.onBroadcastRequested(signalName, listener);\n        return this;\n    }\n\n    public offBroadcastRequested(\n        signalName: string,\n        listener: SignalListener,\n    ): ISignaler {\n        this.manager.offBroadcastRequested(signalName, listener);\n        return this;\n    }\n\n    public requestBroadcast(\n        signalName: string,\n        payload?: Jsonable,\n    ) {\n        this.manager.requestBroadcast(signalName, payload);\n    }\n}\n"]}

package/lib/index.d.ts

@@ -3,4 +3,5 @@
  * Licensed under the MIT License.
  */
 export * from "./kvpair";
+export * from "./signalManager";
 //# 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,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC"}

package/lib/index.js

@@ -3,4 +3,5 @@
  * Licensed under the MIT License.
  */
 export * from "./kvpair";
+export * from "./signalManager";
 //# 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,UAAU,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport * from \"./kvpair\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport * from \"./kvpair\";\nexport * from \"./signalManager\";\n"]}

package/lib/signalManager/index.d.ts

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

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

@@ -0,0 +1 @@
+{"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

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

package/lib/signalManager/index.js.map

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,131 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/// <reference types="node" />
+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;
+/**
+ * ISignaler defines an interface for working with signals that is similar to the more common
+ * eventing patterns of EventEmitter.  In addition to sending and responding to signals, it
+ * provides explicit methods around signal requests to other connected clients.
+ */
+export interface ISignaler {
+    /**
+     * Adds a listener for the specified signal.  It behaves in the same way as EventEmitter's `on`
+     * method regarding multiple registrations, callback order, etc.
+     * @param signalName - The name of the signal
+     * @param listener - The callback signal handler to add
+     * @returns This ISignaler
+     */
+    onSignal(signalName: string, listener: SignalListener): ISignaler;
+    /**
+    * Remove a listener for the specified signal.  It behaves in the same way as EventEmitter's
+    * `off` method regarding multiple registrations, removal order, etc.
+    * @param signalName - The name of the signal
+    * @param listener - The callback signal handler to remove
+    * @returns This ISignaler
+    */
+    offSignal(signalName: string, listener: SignalListener | ((message: any) => void)): ISignaler;
+    /**
+     * Send a signal with payload to its connected listeners.
+     * @param signalName - The name of the signal
+     * @param payload - The data to send with the signal
+     */
+    submitSignal(signalName: string, payload?: Jsonable): any;
+    /**
+     * Adds a listener for a broadcast request.  The listener is called when a client calls
+     * `requestBroadcast` for that signal.  It behaves in the same way as EventEmitter's `on`
+     * method regarding multiple registrations, callback order, etc.
+     * @param signalName - The signal for which broadcast is requested
+     * @param listener - The callback for the broadcast request to add
+     * @returns This ISignaler
+     */
+    onBroadcastRequested(signalName: string, listener: SignalListener): ISignaler;
+    /**
+     * Remove a listener for a broadcast request.  It behaves in the same way as EventEmitter's
+     * `off` method regarding multiple registrations, removal order, etc.
+     * @param signalName  - The signal for which broadcast is requested
+     * @param listener - The callback for the broadcast request to remove
+     * @returns This ISignaler
+     */
+    offBroadcastRequested(signalName: string, listener: SignalListener): ISignaler;
+    /**
+     * Request broadcast of a signal from other connected clients.  Other clients must have
+     * registered to respond to broadcast requests using the `onBroadcastRequested` method.
+     * @param signalName - The signal for which broadcast is requested
+     * @param payload - A payload to send with the broadcast request
+     */
+    requestBroadcast(signalName: string, payload?: Jsonable): any;
+}
+/**
+ * Duck type of something that provides the expected signalling functionality:
+ * A way to verify we can signal, a way to send a signal, and a way to listen for incoming signals
+ */
+export interface IRuntimeSignaler {
+    connected: boolean;
+    on(event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void): any;
+    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;
+    private getBroadcastSignalName;
+    onSignal(signalName: string, listener: SignalListener): ISignaler;
+    offSignal(signalName: string, listener: SignalListener): ISignaler;
+    submitSignal(signalName: string, payload?: Jsonable): void;
+    onBroadcastRequested(signalName: string, listener: SignalListener): ISignaler;
+    offBroadcastRequested(signalName: string, listener: SignalListener): ISignaler;
+    requestBroadcast(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.
+ */
+export declare class SignalManager extends DataObject<{}, undefined, IErrorEvent> implements EventEmitter, ISignaler {
+    private _manager;
+    private get manager();
+    static get Name(): string;
+    static readonly factory: DataObjectFactory<SignalManager, undefined, undefined, IErrorEvent>;
+    protected hasInitialized(): Promise<void>;
+    onSignal(signalName: string, listener: SignalListener): ISignaler;
+    offSignal(signalName: string, listener: SignalListener): ISignaler;
+    submitSignal(signalName: string, payload?: Jsonable): void;
+    onBroadcastRequested(signalName: string, listener: SignalListener): ISignaler;
+    offBroadcastRequested(signalName: string, listener: SignalListener): ISignaler;
+    requestBroadcast(signalName: string, payload?: Jsonable): void;
+}
+//# sourceMappingURL=signalManager.d.ts.map

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

@@ -0,0 +1 @@
+{"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,CAAC,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAC9F;;;;OAIG;IACH,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,OAAE;IAErD;;;;;;;OAOG;IACH,oBAAoB,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,GAAG,SAAS,CAAC;IAC9E;;;;;;OAMG;IACH,qBAAqB,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,GAAG,SAAS,CAAC;IAC/E;;;;;OAKG;IACH,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,OAAE;CAC5D;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,CAAuB;IAE/C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAqB;;IAG3C;;OAEG;IACc,QAAQ,EAAE,gBAAgB;IAC3C;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM;IAmBtB,OAAO,CAAC,oBAAoB;IAI5B,OAAO,CAAC,sBAAsB;IAMvB,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;IAQf,oBAAoB,CACvB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,cAAc,GACzB,SAAS;IAKL,qBAAqB,CACxB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,cAAc,GACzB,SAAS;IAKL,gBAAgB,CACnB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,QAAQ;CAKzB;AAED;;;;;;GAMG;AAEH,qBAAa,aAAc,SAAQ,UAAU,CAAC,EAAE,EAAE,SAAS,EAAE,WAAW,CAAE,YAAW,YAAY,EAAE,SAAS;IACxG,OAAO,CAAC,QAAQ,CAAuB;IACvC,OAAO,KAAK,OAAO,GAGlB;IAED,WAAkB,IAAI,WAA8C;IAEpE,gBAAuB,OAAO,sEAM5B;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;IAKf,oBAAoB,CACvB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,cAAc,GACzB,SAAS;IAKL,qBAAqB,CACxB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,cAAc,GACzB,SAAS;IAKL,gBAAgB,CACnB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,QAAQ;CAIzB"}

package/lib/signalManager/signalManager.js

@@ -0,0 +1,128 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { EventEmitter } from "events";
+import { DataObject, DataObjectFactory } from "@fluidframework/aqueduct";
+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
+ * 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 {
+    constructor(
+    /**
+     * Object to wrap that can submit and listen to signals
+     */
+    signaler, 
+    /**
+     * 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) {
+        super();
+        this.signaler = signaler;
+        this.emitter = new EventEmitter();
+        this.emitter.on("error", (error) => {
+            this.emit("error", error);
+        });
+        this.managerId = managerId ? `#${managerId}` : 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
+            // identifiable sender clientId.  The listener is responsible for deciding how
+            // it wants to handle local/remote signals
+            // eslint-disable-next-line no-null/no-null
+            if (this.signaler.connected && clientId !== null) {
+                this.emitter.emit(message.type, clientId, local, message.content);
+            }
+        });
+    }
+    getManagerSignalName(signalName) {
+        return this.managerId ? `${signalName}${this.managerId}` : signalName;
+    }
+    getBroadcastSignalName(signalName) {
+        return `${signalName}#req`;
+    }
+    // ISignaler methods
+    onSignal(signalName, listener) {
+        const managerSignalName = this.getManagerSignalName(signalName);
+        this.emitter.on(managerSignalName, listener);
+        return this;
+    }
+    offSignal(signalName, listener) {
+        const managerSignalName = this.getManagerSignalName(signalName);
+        this.emitter.off(managerSignalName, listener);
+        return this;
+    }
+    submitSignal(signalName, payload) {
+        const managerSignalName = this.getManagerSignalName(signalName);
+        if (this.signaler.connected) {
+            this.signaler.submitSignal(managerSignalName, payload);
+        }
+    }
+    onBroadcastRequested(signalName, listener) {
+        const broadcastSignalName = this.getBroadcastSignalName(signalName);
+        return this.onSignal(broadcastSignalName, listener);
+    }
+    offBroadcastRequested(signalName, listener) {
+        const broadcastSignalName = this.getBroadcastSignalName(signalName);
+        return this.offSignal(broadcastSignalName, listener);
+    }
+    requestBroadcast(signalName, payload) {
+        const broadcastSignalName = this.getBroadcastSignalName(signalName);
+        this.submitSignal(broadcastSignalName, 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.
+ */
+// eslint-disable-next-line @typescript-eslint/ban-types
+export class SignalManager extends DataObject {
+    get manager() {
+        assert(this._manager !== undefined, 0x24b /* "internal signaler should be defined" */);
+        return this._manager;
+    }
+    static get Name() { return "@fluid-example/signal-manager"; }
+    async hasInitialized() {
+        this._manager = new Signaler(this.runtime);
+        this.manager.on("error", (error) => {
+            this.emit("error", error);
+        });
+    }
+    // ISignaler methods  Note these are all passthroughs
+    onSignal(signalName, listener) {
+        this.manager.onSignal(signalName, listener);
+        return this;
+    }
+    offSignal(signalName, listener) {
+        this.manager.offSignal(signalName, listener);
+        return this;
+    }
+    submitSignal(signalName, payload) {
+        this.manager.submitSignal(signalName, payload);
+    }
+    onBroadcastRequested(signalName, listener) {
+        this.manager.onBroadcastRequested(signalName, listener);
+        return this;
+    }
+    offBroadcastRequested(signalName, listener) {
+        this.manager.offBroadcastRequested(signalName, listener);
+        return this;
+    }
+    requestBroadcast(signalName, payload) {
+        this.manager.requestBroadcast(signalName, payload);
+    }
+}
+SignalManager.factory = new DataObjectFactory(SignalManager.Name, SignalManager, [], {});
+//# sourceMappingURL=signalManager.js.map

package/lib/signalManager/signalManager.js.map

@@ -0,0 +1 @@
+{"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;AA2EzE;;;;;;;;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,GAAI,IAAI,YAAY,EAAE,CAAC;QAiB3C,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,2CAA2C;YAC3C,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;IAEO,sBAAsB,CAAC,UAAkB;QAC7C,OAAO,GAAG,UAAU,MAAM,CAAC;IAC/B,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;IAEM,oBAAoB,CACvB,UAAkB,EAClB,QAAwB;QAExB,MAAM,mBAAmB,GAAG,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;QACpE,OAAO,IAAI,CAAC,QAAQ,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;IACxD,CAAC;IAEM,qBAAqB,CACxB,UAAkB,EAClB,QAAwB;QAExB,MAAM,mBAAmB,GAAG,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;QACpE,OAAO,IAAI,CAAC,SAAS,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;IAEM,gBAAgB,CACnB,UAAkB,EAClB,OAAkB;QAElB,MAAM,mBAAmB,GAAG,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;QACpE,IAAI,CAAC,YAAY,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;CACJ;AAED;;;;;;GAMG;AACH,wDAAwD;AACxD,MAAM,OAAO,aAAc,SAAQ,UAAsC;IAErE,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;IAU1D,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;IAEM,oBAAoB,CACvB,UAAkB,EAClB,QAAwB;QAExB,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACxD,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,qBAAqB,CACxB,UAAkB,EAClB,QAAwB;QAExB,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACzD,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,gBAAgB,CACnB,UAAkB,EAClB,OAAkB;QAElB,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;;AA7DsB,qBAAO,GAAG,IAAI,iBAAiB,CAElD,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 | ((message: any) => void)): 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     * Adds a listener for a broadcast request.  The listener is called when a client calls\n     * `requestBroadcast` for that signal.  It behaves in the same way as EventEmitter's `on`\n     * method regarding multiple registrations, callback order, etc.\n     * @param signalName - The signal for which broadcast is requested\n     * @param listener - The callback for the broadcast request to add\n     * @returns This ISignaler\n     */\n    onBroadcastRequested(signalName: string, listener: SignalListener): ISignaler;\n    /**\n     * Remove a listener for a broadcast request.  It behaves in the same way as EventEmitter's\n     * `off` method regarding multiple registrations, removal order, etc.\n     * @param signalName  - The signal for which broadcast is requested\n     * @param listener - The callback for the broadcast request to remove\n     * @returns This ISignaler\n     */\n    offBroadcastRequested(signalName: string, listener: SignalListener): ISignaler;\n    /**\n     * Request broadcast of a signal from other connected clients.  Other clients must have\n     * registered to respond to broadcast requests using the `onBroadcastRequested` method.\n     * @param signalName - The signal for which broadcast is requested\n     * @param payload - A payload to send with the broadcast request\n     */\n    requestBroadcast(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            // eslint-disable-next-line no-null/no-null\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    private getBroadcastSignalName(signalName: string): string {\n        return `${signalName}#req`;\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    public onBroadcastRequested(\n        signalName: string,\n        listener: SignalListener,\n    ): ISignaler {\n        const broadcastSignalName = this.getBroadcastSignalName(signalName);\n        return this.onSignal(broadcastSignalName, listener);\n    }\n\n    public offBroadcastRequested(\n        signalName: string,\n        listener: SignalListener,\n    ): ISignaler {\n        const broadcastSignalName = this.getBroadcastSignalName(signalName);\n        return this.offSignal(broadcastSignalName, listener);\n    }\n\n    public requestBroadcast(\n        signalName: string,\n        payload?: Jsonable,\n    ) {\n        const broadcastSignalName = this.getBroadcastSignalName(signalName);\n        this.submitSignal(broadcastSignalName, payload);\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 */\n// eslint-disable-next-line @typescript-eslint/ban-types\nexport class SignalManager extends DataObject<{}, undefined, 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<SignalManager, undefined, undefined, IErrorEvent>\n    (\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    public onBroadcastRequested(\n        signalName: string,\n        listener: SignalListener,\n    ): ISignaler {\n        this.manager.onBroadcastRequested(signalName, listener);\n        return this;\n    }\n\n    public offBroadcastRequested(\n        signalName: string,\n        listener: SignalListener,\n    ): ISignaler {\n        this.manager.offBroadcastRequested(signalName, listener);\n        return this;\n    }\n\n    public requestBroadcast(\n        signalName: string,\n        payload?: Jsonable,\n    ) {\n        this.manager.requestBroadcast(signalName, payload);\n    }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-experimental/data-objects",
-  "version": "0.47.1",
+  "version": "0.48.1",
   "description": "A collection of ready to use Fluid Data Objects",
   "homepage": "https://fluidframework.com",
   "repository": "https://github.com/microsoft/FluidFramework",
@@ -27,9 +27,12 @@
     "tsfmt:fix": "tsfmt --replace"
   },
   "dependencies": {
-    "@fluidframework/aqueduct": "^0.47.1",
+    "@fluidframework/aqueduct": "^0.48.1",
     "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/map": "^0.47.1"
+    "@fluidframework/common-utils": "^0.32.1",
+    "@fluidframework/datastore-definitions": "^0.48.1",
+    "@fluidframework/map": "^0.48.1",
+    "@fluidframework/runtime-definitions": "^0.48.1"
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",

package/src/index.ts

@@ -4,3 +4,4 @@
  */
 
 export * from "./kvpair";
+export * from "./signalManager";

package/src/signalManager/index.ts

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

package/src/signalManager/signalManager.ts

@@ -0,0 +1,269 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { EventEmitter } from "events";
+import { DataObject, DataObjectFactory } from "@fluidframework/aqueduct";
+import { IErrorEvent } from "@fluidframework/common-definitions";
+import { assert, TypedEventEmitter } from "@fluidframework/common-utils";
+import { Jsonable } from "@fluidframework/datastore-definitions";
+import { IInboundSignalMessage } from "@fluidframework/runtime-definitions";
+
+// TODO:
+// add way to mark with current sequence number for ordering signals relative to ops
+// throttling and batching
+
+export type SignalListener = (clientId: string, local: boolean, payload: Jsonable) => void;
+
+/**
+ * ISignaler defines an interface for working with signals that is similar to the more common
+ * eventing patterns of EventEmitter.  In addition to sending and responding to signals, it
+ * provides explicit methods around signal requests to other connected clients.
+ */
+export interface ISignaler {
+    /**
+     * Adds a listener for the specified signal.  It behaves in the same way as EventEmitter's `on`
+     * method regarding multiple registrations, callback order, etc.
+     * @param signalName - The name of the signal
+     * @param listener - The callback signal handler to add
+     * @returns This ISignaler
+     */
+    onSignal(signalName: string, listener: SignalListener): ISignaler;
+     /**
+     * Remove a listener for the specified signal.  It behaves in the same way as EventEmitter's
+     * `off` method regarding multiple registrations, removal order, etc.
+     * @param signalName - The name of the signal
+     * @param listener - The callback signal handler to remove
+     * @returns This ISignaler
+     */
+    offSignal(signalName: string, listener: SignalListener | ((message: any) => void)): ISignaler;
+    /**
+     * Send a signal with payload to its connected listeners.
+     * @param signalName - The name of the signal
+     * @param payload - The data to send with the signal
+     */
+    submitSignal(signalName: string, payload?: Jsonable);
+
+    /**
+     * Adds a listener for a broadcast request.  The listener is called when a client calls
+     * `requestBroadcast` for that signal.  It behaves in the same way as EventEmitter's `on`
+     * method regarding multiple registrations, callback order, etc.
+     * @param signalName - The signal for which broadcast is requested
+     * @param listener - The callback for the broadcast request to add
+     * @returns This ISignaler
+     */
+    onBroadcastRequested(signalName: string, listener: SignalListener): ISignaler;
+    /**
+     * Remove a listener for a broadcast request.  It behaves in the same way as EventEmitter's
+     * `off` method regarding multiple registrations, removal order, etc.
+     * @param signalName  - The signal for which broadcast is requested
+     * @param listener - The callback for the broadcast request to remove
+     * @returns This ISignaler
+     */
+    offBroadcastRequested(signalName: string, listener: SignalListener): ISignaler;
+    /**
+     * Request broadcast of a signal from other connected clients.  Other clients must have
+     * registered to respond to broadcast requests using the `onBroadcastRequested` method.
+     * @param signalName - The signal for which broadcast is requested
+     * @param payload - A payload to send with the broadcast request
+     */
+    requestBroadcast(signalName: string, payload?: Jsonable);
+}
+
+/**
+ * Duck type of something that provides the expected signalling functionality:
+ * A way to verify we can signal, a way to send a signal, and a way to listen for incoming signals
+ */
+export interface IRuntimeSignaler {
+    connected: boolean;
+    on(event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void);
+    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 class Signaler extends TypedEventEmitter<IErrorEvent> implements ISignaler {
+    private readonly emitter  = new EventEmitter();
+
+    private readonly managerId: string | undefined;
+
+    constructor(
+        /**
+         * Object to wrap that can submit and listen to signals
+         */
+        private readonly 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,
+    ) {
+        super();
+        this.emitter.on("error", (error) => {
+            this.emit("error", error);
+        });
+        this.managerId = managerId ? `#${managerId}` : 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
+            // identifiable sender clientId.  The listener is responsible for deciding how
+            // it wants to handle local/remote signals
+            // eslint-disable-next-line no-null/no-null
+            if (this.signaler.connected && clientId !== null) {
+                this.emitter.emit(message.type, clientId, local, message.content);
+            }
+        });
+    }
+
+    private getManagerSignalName(signalName: string): string {
+        return this.managerId ? `${signalName}${this.managerId}` : signalName;
+    }
+
+    private getBroadcastSignalName(signalName: string): string {
+        return `${signalName}#req`;
+    }
+
+    // ISignaler methods
+
+    public onSignal(
+        signalName: string,
+        listener: SignalListener,
+    ): ISignaler {
+        const managerSignalName = this.getManagerSignalName(signalName);
+        this.emitter.on(managerSignalName, listener);
+        return this;
+    }
+
+    public offSignal(
+        signalName: string,
+        listener: SignalListener,
+    ): ISignaler {
+        const managerSignalName = this.getManagerSignalName(signalName);
+        this.emitter.off(managerSignalName, listener);
+        return this;
+    }
+
+    public submitSignal(
+        signalName: string,
+        payload?: Jsonable,
+    ) {
+        const managerSignalName = this.getManagerSignalName(signalName);
+        if (this.signaler.connected) {
+            this.signaler.submitSignal(managerSignalName, payload);
+        }
+    }
+
+    public onBroadcastRequested(
+        signalName: string,
+        listener: SignalListener,
+    ): ISignaler {
+        const broadcastSignalName = this.getBroadcastSignalName(signalName);
+        return this.onSignal(broadcastSignalName, listener);
+    }
+
+    public offBroadcastRequested(
+        signalName: string,
+        listener: SignalListener,
+    ): ISignaler {
+        const broadcastSignalName = this.getBroadcastSignalName(signalName);
+        return this.offSignal(broadcastSignalName, listener);
+    }
+
+    public requestBroadcast(
+        signalName: string,
+        payload?: Jsonable,
+    ) {
+        const broadcastSignalName = this.getBroadcastSignalName(signalName);
+        this.submitSignal(broadcastSignalName, 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.
+ */
+// eslint-disable-next-line @typescript-eslint/ban-types
+export class SignalManager extends DataObject<{}, undefined, 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;
+    }
+
+    public static get Name() { return "@fluid-example/signal-manager"; }
+
+    public static readonly factory = new DataObjectFactory<SignalManager, undefined, undefined, IErrorEvent>
+    (
+        SignalManager.Name,
+        SignalManager,
+        [],
+        {},
+    );
+
+    protected async hasInitialized() {
+        this._manager = new Signaler(this.runtime);
+        this.manager.on("error", (error) => {
+            this.emit("error", error);
+        });
+    }
+
+    // ISignaler methods  Note these are all passthroughs
+
+    public onSignal(
+        signalName: string,
+        listener: SignalListener,
+    ): ISignaler {
+        this.manager.onSignal(signalName, listener);
+        return this;
+    }
+
+    public offSignal(
+        signalName: string,
+        listener: SignalListener,
+    ): ISignaler {
+        this.manager.offSignal(signalName, listener);
+        return this;
+    }
+
+    public submitSignal(
+        signalName: string,
+        payload?: Jsonable,
+    ) {
+        this.manager.submitSignal(signalName, payload);
+    }
+
+    public onBroadcastRequested(
+        signalName: string,
+        listener: SignalListener,
+    ): ISignaler {
+        this.manager.onBroadcastRequested(signalName, listener);
+        return this;
+    }
+
+    public offBroadcastRequested(
+        signalName: string,
+        listener: SignalListener,
+    ): ISignaler {
+        this.manager.offBroadcastRequested(signalName, listener);
+        return this;
+    }
+
+    public requestBroadcast(
+        signalName: string,
+        payload?: Jsonable,
+    ) {
+        this.manager.requestBroadcast(signalName, payload);
+    }
+}