@fluid-experimental/data-objects 2.0.0-internal.7.3.0 → 2.0.0-internal.8.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/api-extractor-lint.json +13 -0
- package/dist/signaler/signaler.d.ts +14 -8
- package/dist/signaler/signaler.d.ts.map +1 -1
- package/dist/signaler/signaler.js +1 -0
- package/dist/signaler/signaler.js.map +1 -1
- package/lib/signaler/signaler.d.ts +14 -8
- package/lib/signaler/signaler.d.ts.map +1 -1
- package/lib/signaler/signaler.js +1 -0
- package/lib/signaler/signaler.js.map +1 -1
- package/package.json +13 -12
- package/src/signaler/signaler.ts +17 -11
- package/api-extractor.json +0 -4
package/CHANGELOG.md
CHANGED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
|
3
|
+
"extends": "../../../common/build/build-common/api-extractor-lint.json",
|
|
4
|
+
"messages": {
|
|
5
|
+
"extractorMessageReporting": {
|
|
6
|
+
// TODO: remove once base config has this enabled as an error
|
|
7
|
+
"ae-incompatible-release-tags": {
|
|
8
|
+
"logLevel": "error",
|
|
9
|
+
"addToApiReportFile": false
|
|
10
|
+
}
|
|
11
|
+
}
|
|
12
|
+
}
|
|
13
|
+
}
|
|
@@ -8,11 +8,15 @@ import { DataObject, DataObjectFactory } from "@fluidframework/aqueduct";
|
|
|
8
8
|
import { Jsonable } from "@fluidframework/datastore-definitions";
|
|
9
9
|
import { IInboundSignalMessage } from "@fluidframework/runtime-definitions";
|
|
10
10
|
import { IErrorEvent } from "@fluidframework/core-interfaces";
|
|
11
|
-
|
|
11
|
+
/**
|
|
12
|
+
* @internal
|
|
13
|
+
*/
|
|
14
|
+
export type SignalListener<T> = (clientId: string, local: boolean, payload: Jsonable<T>) => void;
|
|
12
15
|
/**
|
|
13
16
|
* ISignaler defines an interface for working with signals that is similar to the more common
|
|
14
17
|
* eventing patterns of EventEmitter. In addition to sending and responding to signals, it
|
|
15
18
|
* provides explicit methods around signal requests to other connected clients.
|
|
19
|
+
* @internal
|
|
16
20
|
*/
|
|
17
21
|
export interface ISignaler {
|
|
18
22
|
/**
|
|
@@ -22,7 +26,7 @@ export interface ISignaler {
|
|
|
22
26
|
* @param listener - The callback signal handler to add
|
|
23
27
|
* @returns This ISignaler
|
|
24
28
|
*/
|
|
25
|
-
onSignal(signalName: string, listener: SignalListener): ISignaler;
|
|
29
|
+
onSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler;
|
|
26
30
|
/**
|
|
27
31
|
* Remove a listener for the specified signal. It behaves in the same way as EventEmitter's
|
|
28
32
|
* `off` method regarding multiple registrations, removal order, etc.
|
|
@@ -30,26 +34,28 @@ export interface ISignaler {
|
|
|
30
34
|
* @param listener - The callback signal handler to remove
|
|
31
35
|
* @returns This ISignaler
|
|
32
36
|
*/
|
|
33
|
-
offSignal(signalName: string, listener: SignalListener): ISignaler;
|
|
37
|
+
offSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler;
|
|
34
38
|
/**
|
|
35
39
|
* Send a signal with payload to its connected listeners.
|
|
36
40
|
* @param signalName - The name of the signal
|
|
37
41
|
* @param payload - The data to send with the signal
|
|
38
42
|
*/
|
|
39
|
-
submitSignal(signalName: string, payload?: Jsonable): any;
|
|
43
|
+
submitSignal<T>(signalName: string, payload?: Jsonable<T>): any;
|
|
40
44
|
}
|
|
41
45
|
/**
|
|
42
46
|
* Duck type of something that provides the expected signalling functionality:
|
|
43
47
|
* A way to verify we can signal, a way to send a signal, and a way to listen for incoming signals
|
|
48
|
+
* @internal
|
|
44
49
|
*/
|
|
45
50
|
export interface IRuntimeSignaler {
|
|
46
51
|
connected: boolean;
|
|
47
52
|
on(event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void): any;
|
|
48
|
-
submitSignal(type: string, content:
|
|
53
|
+
submitSignal(type: string, content: Jsonable<unknown>): void;
|
|
49
54
|
}
|
|
50
55
|
/**
|
|
51
56
|
* DataObject implementation of ISignaler for fluid-static plug-and-play. Allows fluid-static
|
|
52
57
|
* users to get an ISignaler without a custom DO.
|
|
58
|
+
* @internal
|
|
53
59
|
*/
|
|
54
60
|
export declare class Signaler extends DataObject<{
|
|
55
61
|
Events: IErrorEvent;
|
|
@@ -61,8 +67,8 @@ export declare class Signaler extends DataObject<{
|
|
|
61
67
|
Events: IErrorEvent;
|
|
62
68
|
}>;
|
|
63
69
|
protected hasInitialized(): Promise<void>;
|
|
64
|
-
onSignal(signalName: string, listener: SignalListener): ISignaler;
|
|
65
|
-
offSignal(signalName: string, listener: SignalListener): ISignaler;
|
|
66
|
-
submitSignal(signalName: string, payload?: Jsonable): void;
|
|
70
|
+
onSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler;
|
|
71
|
+
offSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler;
|
|
72
|
+
submitSignal<T>(signalName: string, payload?: Jsonable<T>): void;
|
|
67
73
|
}
|
|
68
74
|
//# sourceMappingURL=signaler.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
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;AAGzE,OAAO,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAM9D,MAAM,MAAM,cAAc,
|
|
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;AAGzE,OAAO,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAM9D;;GAEG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AAEjG;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACzB;;;;;;OAMG;IACH,QAAQ,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IACxE;;;;;;OAMG;IACH,SAAS,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IACzE;;;;OAIG;IACH,YAAY,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,OAAE;CAC3D;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAChC,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,QAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;CAC7D;AAsED;;;;GAIG;AACH,qBAAa,QACZ,SAAQ,UAAU,CAAC;IAAE,MAAM,EAAE,WAAW,CAAA;CAAE,CAC1C,YAAW,YAAY,EAAE,SAAS;IAElC,OAAO,CAAC,SAAS,CAA+B;IAChD,OAAO,KAAK,QAAQ,GAGnB;IAED,gBAAuB,IAAI,6BAA6B;IAExD,gBAAuB,OAAO;gBAXD,WAAW;OAWgD;cAExE,cAAc;IASvB,QAAQ,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,SAAS;IAKvE,SAAS,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,SAAS;IAKxE,YAAY,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;CAGhE"}
|
|
@@ -68,6 +68,7 @@ class InternalSignaler extends TypedEventEmitter {
|
|
|
68
68
|
/**
|
|
69
69
|
* DataObject implementation of ISignaler for fluid-static plug-and-play. Allows fluid-static
|
|
70
70
|
* users to get an ISignaler without a custom DO.
|
|
71
|
+
* @internal
|
|
71
72
|
*/
|
|
72
73
|
export class Signaler extends DataObject {
|
|
73
74
|
get signaler() {
|
|
@@ -1 +1 @@
|
|
|
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;AACzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;
|
|
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;AACzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAwDpD;;;;;;;;GAQG;AACH,MAAM,gBAAiB,SAAQ,iBAA8B;IAK5D;IACC;;OAEG;IACc,QAA0B;IAC3C;;;;OAIG;IACH,UAAmB;QAEnB,KAAK,EAAE,CAAC;QARS,aAAQ,GAAR,QAAQ,CAAkB;QAR3B,YAAO,GAAG,IAAI,YAAY,EAAE,CAAC;QAiB7C,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAClC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC3B,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;YAC7E,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;gBACjD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;aAClE;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;IAEO,qBAAqB,CAAC,UAAkB;QAC/C,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC;IACzE,CAAC;IAED,oBAAoB;IAEb,QAAQ,CAAI,UAAkB,EAAE,QAA2B;QACjE,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;IACb,CAAC;IAEM,SAAS,CAAI,UAAkB,EAAE,QAA2B;QAClE,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;IACb,CAAC;IAEM,YAAY,CAAI,UAAkB,EAAE,OAAqB;QAC/D,MAAM,kBAAkB,GAAG,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;QAClE,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE;YAC5B,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;SACxD;IACF,CAAC;CACD;AAED;;;;GAIG;AACH,MAAM,OAAO,QACZ,SAAQ,UAAmC;IAI3C,IAAY,QAAQ;QACnB,MAAM,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE,KAAK,CAAC,2CAA2C,CAAC,CAAC;QACxF,OAAO,IAAI,CAAC,SAAS,CAAC;IACvB,CAAC;IAMS,KAAK,CAAC,cAAc;QAC7B,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;YACnC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACJ,CAAC;IAED,qDAAqD;IAE9C,QAAQ,CAAI,UAAkB,EAAE,QAA2B;QACjE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,SAAS,CAAI,UAAkB,EAAE,QAA2B;QAClE,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,YAAY,CAAI,UAAkB,EAAE,OAAqB;QAC/D,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;;AAzBsB,aAAI,GAAG,yBAAyB,CAAC;AAEjC,gBAAO,GAAG,IAAI,iBAAiB,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,EAAE,CAAC,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 { TypedEventEmitter } from \"@fluid-internal/client-utils\";\nimport { assert } from \"@fluidframework/core-utils\";\nimport { Jsonable } from \"@fluidframework/datastore-definitions\";\nimport { IInboundSignalMessage } from \"@fluidframework/runtime-definitions\";\nimport { IErrorEvent } from \"@fluidframework/core-interfaces\";\n\n// TODO:\n// add way to mark with current sequence number for ordering signals relative to ops\n// throttling and batching\n\n/**\n * @internal\n */\nexport type SignalListener<T> = (clientId: string, local: boolean, payload: Jsonable<T>) => 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 * @internal\n */\nexport interface ISignaler {\n\t/**\n\t * Adds a listener for the specified signal. It behaves in the same way as EventEmitter's `on`\n\t * method regarding multiple registrations, callback order, etc.\n\t * @param signalName - The name of the signal\n\t * @param listener - The callback signal handler to add\n\t * @returns This ISignaler\n\t */\n\tonSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler;\n\t/**\n\t * Remove a listener for the specified signal. It behaves in the same way as EventEmitter's\n\t * `off` method regarding multiple registrations, removal order, etc.\n\t * @param signalName - The name of the signal\n\t * @param listener - The callback signal handler to remove\n\t * @returns This ISignaler\n\t */\n\toffSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler;\n\t/**\n\t * Send a signal with payload to its connected listeners.\n\t * @param signalName - The name of the signal\n\t * @param payload - The data to send with the signal\n\t */\n\tsubmitSignal<T>(signalName: string, payload?: Jsonable<T>);\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 * @internal\n */\nexport interface IRuntimeSignaler {\n\tconnected: boolean;\n\ton(event: \"signal\", listener: (message: IInboundSignalMessage, local: boolean) => void);\n\tsubmitSignal(type: string, content: Jsonable<unknown>): 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 */\nclass InternalSignaler extends TypedEventEmitter<IErrorEvent> implements ISignaler {\n\tprivate readonly emitter = new EventEmitter();\n\n\tprivate readonly signalerId: string | undefined;\n\n\tconstructor(\n\t\t/**\n\t\t * Object to wrap that can submit and listen to signals\n\t\t */\n\t\tprivate readonly signaler: IRuntimeSignaler,\n\t\t/**\n\t\t * Optional id to assign to this manager that will be attached to\n\t\t * signal names. Useful to avoid collisions if there are multiple\n\t\t * signal users at the Container level\n\t\t */\n\t\tsignalerId?: string,\n\t) {\n\t\tsuper();\n\t\tthis.emitter.on(\"error\", (error) => {\n\t\t\tthis.emit(\"error\", error);\n\t\t});\n\t\tthis.signalerId = signalerId ? `#${signalerId}` : undefined;\n\t\tthis.signaler.on(\"signal\", (message: IInboundSignalMessage, local: boolean) => {\n\t\t\tconst clientId = message.clientId;\n\t\t\t// Only call listeners when the runtime is connected and if the signal has an\n\t\t\t// identifiable sender clientId. The listener is responsible for deciding how\n\t\t\t// it wants to handle local/remote signals\n\t\t\tif (this.signaler.connected && clientId !== null) {\n\t\t\t\tthis.emitter.emit(message.type, clientId, local, message.content);\n\t\t\t}\n\t\t});\n\t}\n\n\tprivate getSignalerSignalName(signalName: string): string {\n\t\treturn this.signalerId ? `${signalName}${this.signalerId}` : signalName;\n\t}\n\n\t// ISignaler methods\n\n\tpublic onSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler {\n\t\tconst signalerSignalName = this.getSignalerSignalName(signalName);\n\t\tthis.emitter.on(signalerSignalName, listener);\n\t\treturn this;\n\t}\n\n\tpublic offSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler {\n\t\tconst signalerSignalName = this.getSignalerSignalName(signalName);\n\t\tthis.emitter.off(signalerSignalName, listener);\n\t\treturn this;\n\t}\n\n\tpublic submitSignal<T>(signalName: string, payload?: Jsonable<T>) {\n\t\tconst signalerSignalName = this.getSignalerSignalName(signalName);\n\t\tif (this.signaler.connected) {\n\t\t\tthis.signaler.submitSignal(signalerSignalName, payload);\n\t\t}\n\t}\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 * @internal\n */\nexport class Signaler\n\textends DataObject<{ Events: IErrorEvent }>\n\timplements EventEmitter, ISignaler\n{\n\tprivate _signaler: InternalSignaler | undefined;\n\tprivate get signaler(): InternalSignaler {\n\t\tassert(this._signaler !== undefined, 0x24b /* \"internal signaler should be defined\" */);\n\t\treturn this._signaler;\n\t}\n\n\tpublic static readonly Name = \"@fluid-example/signaler\";\n\n\tpublic static readonly factory = new DataObjectFactory(Signaler.Name, Signaler, [], {});\n\n\tprotected async hasInitialized() {\n\t\tthis._signaler = new InternalSignaler(this.runtime);\n\t\tthis.signaler.on(\"error\", (error) => {\n\t\t\tthis.emit(\"error\", error);\n\t\t});\n\t}\n\n\t// ISignaler methods Note these are all passthroughs\n\n\tpublic onSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler {\n\t\tthis.signaler.onSignal(signalName, listener);\n\t\treturn this;\n\t}\n\n\tpublic offSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler {\n\t\tthis.signaler.offSignal(signalName, listener);\n\t\treturn this;\n\t}\n\n\tpublic submitSignal<T>(signalName: string, payload?: Jsonable<T>) {\n\t\tthis.signaler.submitSignal(signalName, payload);\n\t}\n}\n"]}
|
|
@@ -8,11 +8,15 @@ import { DataObject, DataObjectFactory } from "@fluidframework/aqueduct";
|
|
|
8
8
|
import { Jsonable } from "@fluidframework/datastore-definitions";
|
|
9
9
|
import { IInboundSignalMessage } from "@fluidframework/runtime-definitions";
|
|
10
10
|
import { IErrorEvent } from "@fluidframework/core-interfaces";
|
|
11
|
-
|
|
11
|
+
/**
|
|
12
|
+
* @internal
|
|
13
|
+
*/
|
|
14
|
+
export type SignalListener<T> = (clientId: string, local: boolean, payload: Jsonable<T>) => void;
|
|
12
15
|
/**
|
|
13
16
|
* ISignaler defines an interface for working with signals that is similar to the more common
|
|
14
17
|
* eventing patterns of EventEmitter. In addition to sending and responding to signals, it
|
|
15
18
|
* provides explicit methods around signal requests to other connected clients.
|
|
19
|
+
* @internal
|
|
16
20
|
*/
|
|
17
21
|
export interface ISignaler {
|
|
18
22
|
/**
|
|
@@ -22,7 +26,7 @@ export interface ISignaler {
|
|
|
22
26
|
* @param listener - The callback signal handler to add
|
|
23
27
|
* @returns This ISignaler
|
|
24
28
|
*/
|
|
25
|
-
onSignal(signalName: string, listener: SignalListener): ISignaler;
|
|
29
|
+
onSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler;
|
|
26
30
|
/**
|
|
27
31
|
* Remove a listener for the specified signal. It behaves in the same way as EventEmitter's
|
|
28
32
|
* `off` method regarding multiple registrations, removal order, etc.
|
|
@@ -30,26 +34,28 @@ export interface ISignaler {
|
|
|
30
34
|
* @param listener - The callback signal handler to remove
|
|
31
35
|
* @returns This ISignaler
|
|
32
36
|
*/
|
|
33
|
-
offSignal(signalName: string, listener: SignalListener): ISignaler;
|
|
37
|
+
offSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler;
|
|
34
38
|
/**
|
|
35
39
|
* Send a signal with payload to its connected listeners.
|
|
36
40
|
* @param signalName - The name of the signal
|
|
37
41
|
* @param payload - The data to send with the signal
|
|
38
42
|
*/
|
|
39
|
-
submitSignal(signalName: string, payload?: Jsonable): any;
|
|
43
|
+
submitSignal<T>(signalName: string, payload?: Jsonable<T>): any;
|
|
40
44
|
}
|
|
41
45
|
/**
|
|
42
46
|
* Duck type of something that provides the expected signalling functionality:
|
|
43
47
|
* A way to verify we can signal, a way to send a signal, and a way to listen for incoming signals
|
|
48
|
+
* @internal
|
|
44
49
|
*/
|
|
45
50
|
export interface IRuntimeSignaler {
|
|
46
51
|
connected: boolean;
|
|
47
52
|
on(event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void): any;
|
|
48
|
-
submitSignal(type: string, content:
|
|
53
|
+
submitSignal(type: string, content: Jsonable<unknown>): void;
|
|
49
54
|
}
|
|
50
55
|
/**
|
|
51
56
|
* DataObject implementation of ISignaler for fluid-static plug-and-play. Allows fluid-static
|
|
52
57
|
* users to get an ISignaler without a custom DO.
|
|
58
|
+
* @internal
|
|
53
59
|
*/
|
|
54
60
|
export declare class Signaler extends DataObject<{
|
|
55
61
|
Events: IErrorEvent;
|
|
@@ -61,8 +67,8 @@ export declare class Signaler extends DataObject<{
|
|
|
61
67
|
Events: IErrorEvent;
|
|
62
68
|
}>;
|
|
63
69
|
protected hasInitialized(): Promise<void>;
|
|
64
|
-
onSignal(signalName: string, listener: SignalListener): ISignaler;
|
|
65
|
-
offSignal(signalName: string, listener: SignalListener): ISignaler;
|
|
66
|
-
submitSignal(signalName: string, payload?: Jsonable): void;
|
|
70
|
+
onSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler;
|
|
71
|
+
offSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler;
|
|
72
|
+
submitSignal<T>(signalName: string, payload?: Jsonable<T>): void;
|
|
67
73
|
}
|
|
68
74
|
//# sourceMappingURL=signaler.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
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;AAGzE,OAAO,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAM9D,MAAM,MAAM,cAAc,
|
|
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;AAGzE,OAAO,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAM9D;;GAEG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AAEjG;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACzB;;;;;;OAMG;IACH,QAAQ,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IACxE;;;;;;OAMG;IACH,SAAS,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IACzE;;;;OAIG;IACH,YAAY,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,OAAE;CAC3D;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAChC,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,QAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;CAC7D;AAsED;;;;GAIG;AACH,qBAAa,QACZ,SAAQ,UAAU,CAAC;IAAE,MAAM,EAAE,WAAW,CAAA;CAAE,CAC1C,YAAW,YAAY,EAAE,SAAS;IAElC,OAAO,CAAC,SAAS,CAA+B;IAChD,OAAO,KAAK,QAAQ,GAGnB;IAED,gBAAuB,IAAI,6BAA6B;IAExD,gBAAuB,OAAO;gBAXD,WAAW;OAWgD;cAExE,cAAc;IASvB,QAAQ,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,SAAS;IAKvE,SAAS,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,SAAS;IAKxE,YAAY,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;CAGhE"}
|
package/lib/signaler/signaler.js
CHANGED
|
@@ -68,6 +68,7 @@ class InternalSignaler extends TypedEventEmitter {
|
|
|
68
68
|
/**
|
|
69
69
|
* DataObject implementation of ISignaler for fluid-static plug-and-play. Allows fluid-static
|
|
70
70
|
* users to get an ISignaler without a custom DO.
|
|
71
|
+
* @internal
|
|
71
72
|
*/
|
|
72
73
|
export class Signaler extends DataObject {
|
|
73
74
|
get signaler() {
|
|
@@ -1 +1 @@
|
|
|
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;AACzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;
|
|
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;AACzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAwDpD;;;;;;;;GAQG;AACH,MAAM,gBAAiB,SAAQ,iBAA8B;IAK5D;IACC;;OAEG;IACc,QAA0B;IAC3C;;;;OAIG;IACH,UAAmB;QAEnB,KAAK,EAAE,CAAC;QARS,aAAQ,GAAR,QAAQ,CAAkB;QAR3B,YAAO,GAAG,IAAI,YAAY,EAAE,CAAC;QAiB7C,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAClC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC3B,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;YAC7E,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;gBACjD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;aAClE;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;IAEO,qBAAqB,CAAC,UAAkB;QAC/C,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC;IACzE,CAAC;IAED,oBAAoB;IAEb,QAAQ,CAAI,UAAkB,EAAE,QAA2B;QACjE,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;IACb,CAAC;IAEM,SAAS,CAAI,UAAkB,EAAE,QAA2B;QAClE,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;IACb,CAAC;IAEM,YAAY,CAAI,UAAkB,EAAE,OAAqB;QAC/D,MAAM,kBAAkB,GAAG,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;QAClE,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE;YAC5B,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;SACxD;IACF,CAAC;CACD;AAED;;;;GAIG;AACH,MAAM,OAAO,QACZ,SAAQ,UAAmC;IAI3C,IAAY,QAAQ;QACnB,MAAM,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE,KAAK,CAAC,2CAA2C,CAAC,CAAC;QACxF,OAAO,IAAI,CAAC,SAAS,CAAC;IACvB,CAAC;IAMS,KAAK,CAAC,cAAc;QAC7B,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;YACnC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACJ,CAAC;IAED,qDAAqD;IAE9C,QAAQ,CAAI,UAAkB,EAAE,QAA2B;QACjE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,SAAS,CAAI,UAAkB,EAAE,QAA2B;QAClE,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,YAAY,CAAI,UAAkB,EAAE,OAAqB;QAC/D,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;;AAzBsB,aAAI,GAAG,yBAAyB,CAAC;AAEjC,gBAAO,GAAG,IAAI,iBAAiB,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,EAAE,CAAC,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 { TypedEventEmitter } from \"@fluid-internal/client-utils\";\nimport { assert } from \"@fluidframework/core-utils\";\nimport { Jsonable } from \"@fluidframework/datastore-definitions\";\nimport { IInboundSignalMessage } from \"@fluidframework/runtime-definitions\";\nimport { IErrorEvent } from \"@fluidframework/core-interfaces\";\n\n// TODO:\n// add way to mark with current sequence number for ordering signals relative to ops\n// throttling and batching\n\n/**\n * @internal\n */\nexport type SignalListener<T> = (clientId: string, local: boolean, payload: Jsonable<T>) => 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 * @internal\n */\nexport interface ISignaler {\n\t/**\n\t * Adds a listener for the specified signal. It behaves in the same way as EventEmitter's `on`\n\t * method regarding multiple registrations, callback order, etc.\n\t * @param signalName - The name of the signal\n\t * @param listener - The callback signal handler to add\n\t * @returns This ISignaler\n\t */\n\tonSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler;\n\t/**\n\t * Remove a listener for the specified signal. It behaves in the same way as EventEmitter's\n\t * `off` method regarding multiple registrations, removal order, etc.\n\t * @param signalName - The name of the signal\n\t * @param listener - The callback signal handler to remove\n\t * @returns This ISignaler\n\t */\n\toffSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler;\n\t/**\n\t * Send a signal with payload to its connected listeners.\n\t * @param signalName - The name of the signal\n\t * @param payload - The data to send with the signal\n\t */\n\tsubmitSignal<T>(signalName: string, payload?: Jsonable<T>);\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 * @internal\n */\nexport interface IRuntimeSignaler {\n\tconnected: boolean;\n\ton(event: \"signal\", listener: (message: IInboundSignalMessage, local: boolean) => void);\n\tsubmitSignal(type: string, content: Jsonable<unknown>): 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 */\nclass InternalSignaler extends TypedEventEmitter<IErrorEvent> implements ISignaler {\n\tprivate readonly emitter = new EventEmitter();\n\n\tprivate readonly signalerId: string | undefined;\n\n\tconstructor(\n\t\t/**\n\t\t * Object to wrap that can submit and listen to signals\n\t\t */\n\t\tprivate readonly signaler: IRuntimeSignaler,\n\t\t/**\n\t\t * Optional id to assign to this manager that will be attached to\n\t\t * signal names. Useful to avoid collisions if there are multiple\n\t\t * signal users at the Container level\n\t\t */\n\t\tsignalerId?: string,\n\t) {\n\t\tsuper();\n\t\tthis.emitter.on(\"error\", (error) => {\n\t\t\tthis.emit(\"error\", error);\n\t\t});\n\t\tthis.signalerId = signalerId ? `#${signalerId}` : undefined;\n\t\tthis.signaler.on(\"signal\", (message: IInboundSignalMessage, local: boolean) => {\n\t\t\tconst clientId = message.clientId;\n\t\t\t// Only call listeners when the runtime is connected and if the signal has an\n\t\t\t// identifiable sender clientId. The listener is responsible for deciding how\n\t\t\t// it wants to handle local/remote signals\n\t\t\tif (this.signaler.connected && clientId !== null) {\n\t\t\t\tthis.emitter.emit(message.type, clientId, local, message.content);\n\t\t\t}\n\t\t});\n\t}\n\n\tprivate getSignalerSignalName(signalName: string): string {\n\t\treturn this.signalerId ? `${signalName}${this.signalerId}` : signalName;\n\t}\n\n\t// ISignaler methods\n\n\tpublic onSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler {\n\t\tconst signalerSignalName = this.getSignalerSignalName(signalName);\n\t\tthis.emitter.on(signalerSignalName, listener);\n\t\treturn this;\n\t}\n\n\tpublic offSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler {\n\t\tconst signalerSignalName = this.getSignalerSignalName(signalName);\n\t\tthis.emitter.off(signalerSignalName, listener);\n\t\treturn this;\n\t}\n\n\tpublic submitSignal<T>(signalName: string, payload?: Jsonable<T>) {\n\t\tconst signalerSignalName = this.getSignalerSignalName(signalName);\n\t\tif (this.signaler.connected) {\n\t\t\tthis.signaler.submitSignal(signalerSignalName, payload);\n\t\t}\n\t}\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 * @internal\n */\nexport class Signaler\n\textends DataObject<{ Events: IErrorEvent }>\n\timplements EventEmitter, ISignaler\n{\n\tprivate _signaler: InternalSignaler | undefined;\n\tprivate get signaler(): InternalSignaler {\n\t\tassert(this._signaler !== undefined, 0x24b /* \"internal signaler should be defined\" */);\n\t\treturn this._signaler;\n\t}\n\n\tpublic static readonly Name = \"@fluid-example/signaler\";\n\n\tpublic static readonly factory = new DataObjectFactory(Signaler.Name, Signaler, [], {});\n\n\tprotected async hasInitialized() {\n\t\tthis._signaler = new InternalSignaler(this.runtime);\n\t\tthis.signaler.on(\"error\", (error) => {\n\t\t\tthis.emit(\"error\", error);\n\t\t});\n\t}\n\n\t// ISignaler methods Note these are all passthroughs\n\n\tpublic onSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler {\n\t\tthis.signaler.onSignal(signalName, listener);\n\t\treturn this;\n\t}\n\n\tpublic offSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler {\n\t\tthis.signaler.offSignal(signalName, listener);\n\t\treturn this;\n\t}\n\n\tpublic submitSignal<T>(signalName: string, payload?: Jsonable<T>) {\n\t\tthis.signaler.submitSignal(signalName, payload);\n\t}\n}\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluid-experimental/data-objects",
|
|
3
|
-
"version": "2.0.0-internal.
|
|
3
|
+
"version": "2.0.0-internal.8.0.0",
|
|
4
4
|
"description": "A collection of ready to use Fluid Data Objects",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -15,13 +15,13 @@
|
|
|
15
15
|
"module": "lib/index.js",
|
|
16
16
|
"types": "dist/index.d.ts",
|
|
17
17
|
"dependencies": {
|
|
18
|
-
"@fluid-internal/client-utils": ">=2.0.0-internal.
|
|
19
|
-
"@fluidframework/aqueduct": ">=2.0.0-internal.
|
|
20
|
-
"@fluidframework/core-interfaces": ">=2.0.0-internal.
|
|
21
|
-
"@fluidframework/core-utils": ">=2.0.0-internal.
|
|
22
|
-
"@fluidframework/datastore-definitions": ">=2.0.0-internal.
|
|
23
|
-
"@fluidframework/map": ">=2.0.0-internal.
|
|
24
|
-
"@fluidframework/runtime-definitions": ">=2.0.0-internal.
|
|
18
|
+
"@fluid-internal/client-utils": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
|
|
19
|
+
"@fluidframework/aqueduct": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
|
|
20
|
+
"@fluidframework/core-interfaces": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
|
|
21
|
+
"@fluidframework/core-utils": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
|
|
22
|
+
"@fluidframework/datastore-definitions": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
|
|
23
|
+
"@fluidframework/map": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
|
|
24
|
+
"@fluidframework/runtime-definitions": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
|
|
25
25
|
"events": "^3.1.0"
|
|
26
26
|
},
|
|
27
27
|
"devDependencies": {
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
"@fluidframework/build-tools": "^0.28.0",
|
|
31
31
|
"@fluidframework/eslint-config-fluid": "^3.1.0",
|
|
32
32
|
"@microsoft/api-extractor": "^7.38.3",
|
|
33
|
-
"@types/node": "^
|
|
33
|
+
"@types/node": "^18.19.0",
|
|
34
34
|
"cross-env": "^7.0.3",
|
|
35
35
|
"eslint": "~8.50.0",
|
|
36
36
|
"prettier": "~3.0.3",
|
|
@@ -46,14 +46,15 @@
|
|
|
46
46
|
"build:commonjs": "fluid-build . --task commonjs",
|
|
47
47
|
"build:compile": "fluid-build . --task compile",
|
|
48
48
|
"build:esnext": "tsc --project ./tsconfig.esnext.json",
|
|
49
|
+
"check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
|
|
49
50
|
"clean": "rimraf --glob dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\"",
|
|
50
51
|
"eslint": "eslint --format stylish src",
|
|
51
52
|
"eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
|
|
52
53
|
"format": "npm run prettier:fix",
|
|
53
|
-
"lint": "npm run prettier && npm run eslint",
|
|
54
|
+
"lint": "npm run prettier && npm run check:release-tags && npm run eslint",
|
|
54
55
|
"lint:fix": "npm run prettier:fix && npm run eslint:fix",
|
|
55
|
-
"prettier": "prettier --check . --ignore-path ../../../.prettierignore",
|
|
56
|
-
"prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
|
|
56
|
+
"prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
|
|
57
|
+
"prettier:fix": "prettier --write . --cache --ignore-path ../../../.prettierignore",
|
|
57
58
|
"tsc": "tsc"
|
|
58
59
|
}
|
|
59
60
|
}
|
package/src/signaler/signaler.ts
CHANGED
|
@@ -15,12 +15,16 @@ import { IErrorEvent } from "@fluidframework/core-interfaces";
|
|
|
15
15
|
// add way to mark with current sequence number for ordering signals relative to ops
|
|
16
16
|
// throttling and batching
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
/**
|
|
19
|
+
* @internal
|
|
20
|
+
*/
|
|
21
|
+
export type SignalListener<T> = (clientId: string, local: boolean, payload: Jsonable<T>) => void;
|
|
19
22
|
|
|
20
23
|
/**
|
|
21
24
|
* ISignaler defines an interface for working with signals that is similar to the more common
|
|
22
25
|
* eventing patterns of EventEmitter. In addition to sending and responding to signals, it
|
|
23
26
|
* provides explicit methods around signal requests to other connected clients.
|
|
27
|
+
* @internal
|
|
24
28
|
*/
|
|
25
29
|
export interface ISignaler {
|
|
26
30
|
/**
|
|
@@ -30,7 +34,7 @@ export interface ISignaler {
|
|
|
30
34
|
* @param listener - The callback signal handler to add
|
|
31
35
|
* @returns This ISignaler
|
|
32
36
|
*/
|
|
33
|
-
onSignal(signalName: string, listener: SignalListener): ISignaler;
|
|
37
|
+
onSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler;
|
|
34
38
|
/**
|
|
35
39
|
* Remove a listener for the specified signal. It behaves in the same way as EventEmitter's
|
|
36
40
|
* `off` method regarding multiple registrations, removal order, etc.
|
|
@@ -38,23 +42,24 @@ export interface ISignaler {
|
|
|
38
42
|
* @param listener - The callback signal handler to remove
|
|
39
43
|
* @returns This ISignaler
|
|
40
44
|
*/
|
|
41
|
-
offSignal(signalName: string, listener: SignalListener): ISignaler;
|
|
45
|
+
offSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler;
|
|
42
46
|
/**
|
|
43
47
|
* Send a signal with payload to its connected listeners.
|
|
44
48
|
* @param signalName - The name of the signal
|
|
45
49
|
* @param payload - The data to send with the signal
|
|
46
50
|
*/
|
|
47
|
-
submitSignal(signalName: string, payload?: Jsonable);
|
|
51
|
+
submitSignal<T>(signalName: string, payload?: Jsonable<T>);
|
|
48
52
|
}
|
|
49
53
|
|
|
50
54
|
/**
|
|
51
55
|
* Duck type of something that provides the expected signalling functionality:
|
|
52
56
|
* A way to verify we can signal, a way to send a signal, and a way to listen for incoming signals
|
|
57
|
+
* @internal
|
|
53
58
|
*/
|
|
54
59
|
export interface IRuntimeSignaler {
|
|
55
60
|
connected: boolean;
|
|
56
61
|
on(event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void);
|
|
57
|
-
submitSignal(type: string, content:
|
|
62
|
+
submitSignal(type: string, content: Jsonable<unknown>): void;
|
|
58
63
|
}
|
|
59
64
|
|
|
60
65
|
/**
|
|
@@ -105,19 +110,19 @@ class InternalSignaler extends TypedEventEmitter<IErrorEvent> implements ISignal
|
|
|
105
110
|
|
|
106
111
|
// ISignaler methods
|
|
107
112
|
|
|
108
|
-
public onSignal(signalName: string, listener: SignalListener): ISignaler {
|
|
113
|
+
public onSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler {
|
|
109
114
|
const signalerSignalName = this.getSignalerSignalName(signalName);
|
|
110
115
|
this.emitter.on(signalerSignalName, listener);
|
|
111
116
|
return this;
|
|
112
117
|
}
|
|
113
118
|
|
|
114
|
-
public offSignal(signalName: string, listener: SignalListener): ISignaler {
|
|
119
|
+
public offSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler {
|
|
115
120
|
const signalerSignalName = this.getSignalerSignalName(signalName);
|
|
116
121
|
this.emitter.off(signalerSignalName, listener);
|
|
117
122
|
return this;
|
|
118
123
|
}
|
|
119
124
|
|
|
120
|
-
public submitSignal(signalName: string, payload?: Jsonable) {
|
|
125
|
+
public submitSignal<T>(signalName: string, payload?: Jsonable<T>) {
|
|
121
126
|
const signalerSignalName = this.getSignalerSignalName(signalName);
|
|
122
127
|
if (this.signaler.connected) {
|
|
123
128
|
this.signaler.submitSignal(signalerSignalName, payload);
|
|
@@ -128,6 +133,7 @@ class InternalSignaler extends TypedEventEmitter<IErrorEvent> implements ISignal
|
|
|
128
133
|
/**
|
|
129
134
|
* DataObject implementation of ISignaler for fluid-static plug-and-play. Allows fluid-static
|
|
130
135
|
* users to get an ISignaler without a custom DO.
|
|
136
|
+
* @internal
|
|
131
137
|
*/
|
|
132
138
|
export class Signaler
|
|
133
139
|
extends DataObject<{ Events: IErrorEvent }>
|
|
@@ -152,17 +158,17 @@ export class Signaler
|
|
|
152
158
|
|
|
153
159
|
// ISignaler methods Note these are all passthroughs
|
|
154
160
|
|
|
155
|
-
public onSignal(signalName: string, listener: SignalListener): ISignaler {
|
|
161
|
+
public onSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler {
|
|
156
162
|
this.signaler.onSignal(signalName, listener);
|
|
157
163
|
return this;
|
|
158
164
|
}
|
|
159
165
|
|
|
160
|
-
public offSignal(signalName: string, listener: SignalListener): ISignaler {
|
|
166
|
+
public offSignal<T>(signalName: string, listener: SignalListener<T>): ISignaler {
|
|
161
167
|
this.signaler.offSignal(signalName, listener);
|
|
162
168
|
return this;
|
|
163
169
|
}
|
|
164
170
|
|
|
165
|
-
public submitSignal(signalName: string, payload?: Jsonable) {
|
|
171
|
+
public submitSignal<T>(signalName: string, payload?: Jsonable<T>) {
|
|
166
172
|
this.signaler.submitSignal(signalName, payload);
|
|
167
173
|
}
|
|
168
174
|
}
|
package/api-extractor.json
DELETED