@fluid-internal/presence-runtime 2.93.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/LICENSE +21 -0
- package/README.md +72 -0
- package/dist/package.json +4 -0
- package/dist/packageVersion.d.ts +9 -0
- package/dist/packageVersion.d.ts.map +1 -0
- package/dist/packageVersion.js +12 -0
- package/dist/packageVersion.js.map +1 -0
- package/dist/runtime/extension/containerPresence.d.ts +53 -0
- package/dist/runtime/extension/containerPresence.d.ts.map +1 -0
- package/dist/runtime/extension/containerPresence.js +90 -0
- package/dist/runtime/extension/containerPresence.js.map +1 -0
- package/dist/runtime/extension/index.d.ts +6 -0
- package/dist/runtime/extension/index.d.ts.map +1 -0
- package/dist/runtime/extension/index.js +11 -0
- package/dist/runtime/extension/index.js.map +1 -0
- package/dist/runtime/presenceDatastoreManager.d.ts +146 -0
- package/dist/runtime/presenceDatastoreManager.d.ts.map +1 -0
- package/dist/runtime/presenceDatastoreManager.js +666 -0
- package/dist/runtime/presenceDatastoreManager.js.map +1 -0
- package/dist/runtime/presenceManager.d.ts +16 -0
- package/dist/runtime/presenceManager.d.ts.map +1 -0
- package/dist/runtime/presenceManager.js +140 -0
- package/dist/runtime/presenceManager.js.map +1 -0
- package/dist/runtime/protocol.d.ts +126 -0
- package/dist/runtime/protocol.d.ts.map +1 -0
- package/dist/runtime/protocol.js +20 -0
- package/dist/runtime/protocol.js.map +1 -0
- package/dist/runtime/runtimeTypes.d.ts +26 -0
- package/dist/runtime/runtimeTypes.d.ts.map +1 -0
- package/dist/runtime/runtimeTypes.js +7 -0
- package/dist/runtime/runtimeTypes.js.map +1 -0
- package/dist/runtime/systemWorkspace.d.ts +39 -0
- package/dist/runtime/systemWorkspace.d.ts.map +1 -0
- package/dist/runtime/systemWorkspace.js +264 -0
- package/dist/runtime/systemWorkspace.js.map +1 -0
- package/dist/runtime/test/presenceDatastoreManager.spec.js +618 -0
- package/dist/runtime/test/presenceDatastoreManager.spec.js.map +1 -0
- package/dist/runtime/test/presenceManager.spec.js +651 -0
- package/dist/runtime/test/presenceManager.spec.js.map +1 -0
- package/dist/runtime/test.d.ts +12 -0
- package/dist/runtime/test.d.ts.map +1 -0
- package/dist/runtime/test.js +15 -0
- package/dist/runtime/test.js.map +1 -0
- package/dist/states/index.d.ts +7 -0
- package/dist/states/index.d.ts.map +1 -0
- package/dist/states/index.js +12 -0
- package/dist/states/index.js.map +1 -0
- package/dist/states/latestMapValueManager.d.ts +10 -0
- package/dist/states/latestMapValueManager.d.ts.map +1 -0
- package/dist/states/latestMapValueManager.js +248 -0
- package/dist/states/latestMapValueManager.js.map +1 -0
- package/dist/states/latestValueManager.d.ts +10 -0
- package/dist/states/latestValueManager.d.ts.map +1 -0
- package/dist/states/latestValueManager.js +115 -0
- package/dist/states/latestValueManager.js.map +1 -0
- package/dist/states/notificationsManager.d.ts +26 -0
- package/dist/states/notificationsManager.d.ts.map +1 -0
- package/dist/states/notificationsManager.js +97 -0
- package/dist/states/notificationsManager.js.map +1 -0
- package/dist/states/presence.d.ts +11 -0
- package/dist/states/presence.d.ts.map +1 -0
- package/dist/states/presence.js +7 -0
- package/dist/states/presence.js.map +1 -0
- package/dist/states/stateFactory.d.ts +18 -0
- package/dist/states/stateFactory.d.ts.map +1 -0
- package/dist/states/stateFactory.js +23 -0
- package/dist/states/stateFactory.js.map +1 -0
- package/dist/states/test/batching.spec.js +843 -0
- package/dist/states/test/batching.spec.js.map +1 -0
- package/dist/states/test/broadcastControlsTests.js +60 -0
- package/dist/states/test/broadcastControlsTests.js.map +1 -0
- package/dist/states/test/eventing.spec.js +576 -0
- package/dist/states/test/eventing.spec.js.map +1 -0
- package/dist/states/test/latestMapValueManager.spec.js +210 -0
- package/dist/states/test/latestMapValueManager.spec.js.map +1 -0
- package/dist/states/test/latestValueManager.spec.js +193 -0
- package/dist/states/test/latestValueManager.spec.js.map +1 -0
- package/dist/states/test/mockEphemeralRuntime.js +11 -0
- package/dist/states/test/mockEphemeralRuntime.js.map +1 -0
- package/dist/states/test/notificationsManager.spec.js +460 -0
- package/dist/states/test/notificationsManager.spec.js.map +1 -0
- package/dist/states/test/presenceStates.spec.js +73 -0
- package/dist/states/test/presenceStates.spec.js.map +1 -0
- package/dist/states/test/schemaValidation/protocol.spec.js +246 -0
- package/dist/states/test/schemaValidation/protocol.spec.js.map +1 -0
- package/dist/states/test/schemaValidation/valueManagers.spec.js +784 -0
- package/dist/states/test/schemaValidation/valueManagers.spec.js.map +1 -0
- package/dist/states/test/testUtils.js +21 -0
- package/dist/states/test/testUtils.js.map +1 -0
- package/dist/states/validatedGetter.d.ts +18 -0
- package/dist/states/validatedGetter.d.ts.map +1 -0
- package/dist/states/validatedGetter.js +43 -0
- package/dist/states/validatedGetter.js.map +1 -0
- package/dist/test/mockEphemeralRuntime.js +175 -0
- package/dist/test/mockEphemeralRuntime.js.map +1 -0
- package/dist/test/testUtils.js +262 -0
- package/dist/test/testUtils.js.map +1 -0
- package/dist/test/utils/index.js +27 -0
- package/dist/test/utils/index.js.map +1 -0
- package/dist/utils/broadcastControls.d.ts +37 -0
- package/dist/utils/broadcastControls.d.ts.map +1 -0
- package/dist/utils/broadcastControls.js +60 -0
- package/dist/utils/broadcastControls.js.map +1 -0
- package/dist/utils/index.d.ts +9 -0
- package/dist/utils/index.d.ts.map +1 -0
- package/dist/utils/index.js +26 -0
- package/dist/utils/index.js.map +1 -0
- package/dist/utils/internalUtils.d.ts +125 -0
- package/dist/utils/internalUtils.d.ts.map +1 -0
- package/dist/utils/internalUtils.js +99 -0
- package/dist/utils/internalUtils.js.map +1 -0
- package/dist/utils/test/timerManager.spec.js +93 -0
- package/dist/utils/test/timerManager.spec.js.map +1 -0
- package/dist/utils/timerManager.d.ts +37 -0
- package/dist/utils/timerManager.d.ts.map +1 -0
- package/dist/utils/timerManager.js +65 -0
- package/dist/utils/timerManager.js.map +1 -0
- package/dist/utils/valueManager.d.ts +14 -0
- package/dist/utils/valueManager.d.ts.map +1 -0
- package/dist/utils/valueManager.js +22 -0
- package/dist/utils/valueManager.js.map +1 -0
- package/dist/workspace/index.d.ts +7 -0
- package/dist/workspace/index.d.ts.map +1 -0
- package/dist/workspace/index.js +14 -0
- package/dist/workspace/index.js.map +1 -0
- package/dist/workspace/presenceStates.d.ts +61 -0
- package/dist/workspace/presenceStates.d.ts.map +1 -0
- package/dist/workspace/presenceStates.js +235 -0
- package/dist/workspace/presenceStates.js.map +1 -0
- package/dist/workspace/stateDatastore.d.ts +17 -0
- package/dist/workspace/stateDatastore.d.ts.map +1 -0
- package/dist/workspace/stateDatastore.js +24 -0
- package/dist/workspace/stateDatastore.js.map +1 -0
- package/lib/packageVersion.d.ts +9 -0
- package/lib/packageVersion.d.ts.map +1 -0
- package/lib/packageVersion.js +9 -0
- package/lib/packageVersion.js.map +1 -0
- package/lib/runtime/extension/containerPresence.d.ts +53 -0
- package/lib/runtime/extension/containerPresence.d.ts.map +1 -0
- package/lib/runtime/extension/containerPresence.js +87 -0
- package/lib/runtime/extension/containerPresence.js.map +1 -0
- package/lib/runtime/extension/index.d.ts +6 -0
- package/lib/runtime/extension/index.d.ts.map +1 -0
- package/lib/runtime/extension/index.js +6 -0
- package/lib/runtime/extension/index.js.map +1 -0
- package/lib/runtime/presenceDatastoreManager.d.ts +146 -0
- package/lib/runtime/presenceDatastoreManager.d.ts.map +1 -0
- package/lib/runtime/presenceDatastoreManager.js +662 -0
- package/lib/runtime/presenceDatastoreManager.js.map +1 -0
- package/lib/runtime/presenceManager.d.ts +16 -0
- package/lib/runtime/presenceManager.d.ts.map +1 -0
- package/lib/runtime/presenceManager.js +136 -0
- package/lib/runtime/presenceManager.js.map +1 -0
- package/lib/runtime/protocol.d.ts +126 -0
- package/lib/runtime/protocol.d.ts.map +1 -0
- package/lib/runtime/protocol.js +17 -0
- package/lib/runtime/protocol.js.map +1 -0
- package/lib/runtime/runtimeTypes.d.ts +26 -0
- package/lib/runtime/runtimeTypes.d.ts.map +1 -0
- package/lib/runtime/runtimeTypes.js +6 -0
- package/lib/runtime/runtimeTypes.js.map +1 -0
- package/lib/runtime/systemWorkspace.d.ts +39 -0
- package/lib/runtime/systemWorkspace.d.ts.map +1 -0
- package/lib/runtime/systemWorkspace.js +260 -0
- package/lib/runtime/systemWorkspace.js.map +1 -0
- package/lib/runtime/test/presenceDatastoreManager.spec.js +616 -0
- package/lib/runtime/test/presenceDatastoreManager.spec.js.map +1 -0
- package/lib/runtime/test/presenceManager.spec.js +649 -0
- package/lib/runtime/test/presenceManager.spec.js.map +1 -0
- package/lib/runtime/test.d.ts +12 -0
- package/lib/runtime/test.d.ts.map +1 -0
- package/lib/runtime/test.js +10 -0
- package/lib/runtime/test.js.map +1 -0
- package/lib/states/index.d.ts +7 -0
- package/lib/states/index.d.ts.map +1 -0
- package/lib/states/index.js +7 -0
- package/lib/states/index.js.map +1 -0
- package/lib/states/latestMapValueManager.d.ts +10 -0
- package/lib/states/latestMapValueManager.d.ts.map +1 -0
- package/lib/states/latestMapValueManager.js +244 -0
- package/lib/states/latestMapValueManager.js.map +1 -0
- package/lib/states/latestValueManager.d.ts +10 -0
- package/lib/states/latestValueManager.d.ts.map +1 -0
- package/lib/states/latestValueManager.js +111 -0
- package/lib/states/latestValueManager.js.map +1 -0
- package/lib/states/notificationsManager.d.ts +26 -0
- package/lib/states/notificationsManager.d.ts.map +1 -0
- package/lib/states/notificationsManager.js +93 -0
- package/lib/states/notificationsManager.js.map +1 -0
- package/lib/states/presence.d.ts +11 -0
- package/lib/states/presence.d.ts.map +1 -0
- package/lib/states/presence.js +6 -0
- package/lib/states/presence.js.map +1 -0
- package/lib/states/stateFactory.d.ts +18 -0
- package/lib/states/stateFactory.d.ts.map +1 -0
- package/lib/states/stateFactory.js +20 -0
- package/lib/states/stateFactory.js.map +1 -0
- package/lib/states/test/batching.spec.js +841 -0
- package/lib/states/test/batching.spec.js.map +1 -0
- package/lib/states/test/broadcastControlsTests.js +56 -0
- package/lib/states/test/broadcastControlsTests.js.map +1 -0
- package/lib/states/test/eventing.spec.js +574 -0
- package/lib/states/test/eventing.spec.js.map +1 -0
- package/lib/states/test/latestMapValueManager.spec.js +206 -0
- package/lib/states/test/latestMapValueManager.spec.js.map +1 -0
- package/lib/states/test/latestValueManager.spec.js +189 -0
- package/lib/states/test/latestValueManager.spec.js.map +1 -0
- package/lib/states/test/mockEphemeralRuntime.js +6 -0
- package/lib/states/test/mockEphemeralRuntime.js.map +1 -0
- package/lib/states/test/notificationsManager.spec.js +456 -0
- package/lib/states/test/notificationsManager.spec.js.map +1 -0
- package/lib/states/test/presenceStates.spec.js +69 -0
- package/lib/states/test/presenceStates.spec.js.map +1 -0
- package/lib/states/test/schemaValidation/protocol.spec.js +244 -0
- package/lib/states/test/schemaValidation/protocol.spec.js.map +1 -0
- package/lib/states/test/schemaValidation/valueManagers.spec.js +782 -0
- package/lib/states/test/schemaValidation/valueManagers.spec.js.map +1 -0
- package/lib/states/test/testUtils.js +6 -0
- package/lib/states/test/testUtils.js.map +1 -0
- package/lib/states/validatedGetter.d.ts +18 -0
- package/lib/states/validatedGetter.d.ts.map +1 -0
- package/lib/states/validatedGetter.js +39 -0
- package/lib/states/validatedGetter.js.map +1 -0
- package/lib/test/mockEphemeralRuntime.js +171 -0
- package/lib/test/mockEphemeralRuntime.js.map +1 -0
- package/lib/test/testUtils.js +251 -0
- package/lib/test/testUtils.js.map +1 -0
- package/lib/test/utils/index.js +8 -0
- package/lib/test/utils/index.js.map +1 -0
- package/lib/utils/broadcastControls.d.ts +37 -0
- package/lib/utils/broadcastControls.d.ts.map +1 -0
- package/lib/utils/broadcastControls.js +55 -0
- package/lib/utils/broadcastControls.js.map +1 -0
- package/lib/utils/index.d.ts +9 -0
- package/lib/utils/index.d.ts.map +1 -0
- package/lib/utils/index.js +9 -0
- package/lib/utils/index.js.map +1 -0
- package/lib/utils/internalUtils.d.ts +125 -0
- package/lib/utils/internalUtils.d.ts.map +1 -0
- package/lib/utils/internalUtils.js +90 -0
- package/lib/utils/internalUtils.js.map +1 -0
- package/lib/utils/test/timerManager.spec.js +91 -0
- package/lib/utils/test/timerManager.spec.js.map +1 -0
- package/lib/utils/timerManager.d.ts +37 -0
- package/lib/utils/timerManager.d.ts.map +1 -0
- package/lib/utils/timerManager.js +61 -0
- package/lib/utils/timerManager.js.map +1 -0
- package/lib/utils/valueManager.d.ts +14 -0
- package/lib/utils/valueManager.d.ts.map +1 -0
- package/lib/utils/valueManager.js +17 -0
- package/lib/utils/valueManager.js.map +1 -0
- package/lib/workspace/index.d.ts +7 -0
- package/lib/workspace/index.d.ts.map +1 -0
- package/lib/workspace/index.js +7 -0
- package/lib/workspace/index.js.map +1 -0
- package/lib/workspace/presenceStates.d.ts +61 -0
- package/lib/workspace/presenceStates.d.ts.map +1 -0
- package/lib/workspace/presenceStates.js +229 -0
- package/lib/workspace/presenceStates.js.map +1 -0
- package/lib/workspace/stateDatastore.d.ts +17 -0
- package/lib/workspace/stateDatastore.d.ts.map +1 -0
- package/lib/workspace/stateDatastore.js +19 -0
- package/lib/workspace/stateDatastore.js.map +1 -0
- package/package.json +158 -0
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
/*!
|
|
2
|
+
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
|
+
* Licensed under the MIT License.
|
|
4
|
+
*/
|
|
5
|
+
import { createEmitter } from "@fluid-internal/client-utils";
|
|
6
|
+
import { shallowCloneObject } from "@fluidframework/core-utils/internal";
|
|
7
|
+
import { asDeeplyReadonly, asDeeplyReadonlyDeserializedJson, brandIVM, objectEntries, OptionalBroadcastControl, toOpaqueJson, } from "@fluid-internal/presence-runtime/utils";
|
|
8
|
+
import { datastoreFromHandle } from "@fluid-internal/presence-runtime/workspace";
|
|
9
|
+
import { createValidatedGetter } from "./validatedGetter.js";
|
|
10
|
+
class LatestValueManagerImpl {
|
|
11
|
+
constructor(key, datastore, value, controlSettings, validator) {
|
|
12
|
+
this.key = key;
|
|
13
|
+
this.datastore = datastore;
|
|
14
|
+
this.value = value;
|
|
15
|
+
this.validator = validator;
|
|
16
|
+
this.events = createEmitter();
|
|
17
|
+
this.controls = new OptionalBroadcastControl(controlSettings);
|
|
18
|
+
}
|
|
19
|
+
get presence() {
|
|
20
|
+
return this.datastore.presence;
|
|
21
|
+
}
|
|
22
|
+
get local() {
|
|
23
|
+
return asDeeplyReadonlyDeserializedJson(this.value.value);
|
|
24
|
+
}
|
|
25
|
+
set local(value) {
|
|
26
|
+
this.value.rev += 1;
|
|
27
|
+
this.value.timestamp = Date.now();
|
|
28
|
+
this.value.value = toOpaqueJson(value);
|
|
29
|
+
this.datastore.localUpdate(this.key, this.value, {
|
|
30
|
+
allowableUpdateLatencyMs: this.controls.allowableUpdateLatencyMs,
|
|
31
|
+
});
|
|
32
|
+
this.events.emit("localUpdated", { value: asDeeplyReadonly(value) });
|
|
33
|
+
}
|
|
34
|
+
*getRemotes() {
|
|
35
|
+
const allKnownStates = this.datastore.knownValues(this.key);
|
|
36
|
+
for (const [attendeeId, clientState] of objectEntries(allKnownStates.states)) {
|
|
37
|
+
if (attendeeId !== allKnownStates.self) {
|
|
38
|
+
yield {
|
|
39
|
+
attendee: this.datastore.presence.attendees.getAttendee(attendeeId),
|
|
40
|
+
value: createValidatedGetter(clientState, this.validator),
|
|
41
|
+
metadata: {
|
|
42
|
+
revision: clientState.rev,
|
|
43
|
+
timestamp: clientState.timestamp,
|
|
44
|
+
},
|
|
45
|
+
};
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
getStateAttendees() {
|
|
50
|
+
const allKnownStates = this.datastore.knownValues(this.key);
|
|
51
|
+
return Object.keys(allKnownStates.states)
|
|
52
|
+
.filter((attendeeId) => attendeeId !== allKnownStates.self)
|
|
53
|
+
.map((attendeeId) => this.datastore.presence.attendees.getAttendee(attendeeId));
|
|
54
|
+
}
|
|
55
|
+
getRemote(attendee) {
|
|
56
|
+
const allKnownStates = this.datastore.knownValues(this.key);
|
|
57
|
+
const clientState = allKnownStates.states[attendee.attendeeId];
|
|
58
|
+
if (clientState === undefined) {
|
|
59
|
+
throw new Error("No entry for attendee");
|
|
60
|
+
}
|
|
61
|
+
return {
|
|
62
|
+
value: createValidatedGetter(clientState, this.validator),
|
|
63
|
+
metadata: { revision: clientState.rev, timestamp: Date.now() },
|
|
64
|
+
};
|
|
65
|
+
}
|
|
66
|
+
update(attendee, _received, value) {
|
|
67
|
+
const allKnownStates = this.datastore.knownValues(this.key);
|
|
68
|
+
const attendeeId = attendee.attendeeId;
|
|
69
|
+
const currentState = allKnownStates.states[attendeeId];
|
|
70
|
+
if (currentState !== undefined && currentState.rev >= value.rev) {
|
|
71
|
+
return [];
|
|
72
|
+
}
|
|
73
|
+
this.datastore.update(this.key, attendeeId, value);
|
|
74
|
+
return [
|
|
75
|
+
() => this.events.emit("remoteUpdated", {
|
|
76
|
+
attendee,
|
|
77
|
+
value: createValidatedGetter(value, this.validator),
|
|
78
|
+
metadata: { revision: value.rev, timestamp: value.timestamp },
|
|
79
|
+
}),
|
|
80
|
+
];
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
/**
|
|
84
|
+
* Shallow clone an object that might be null.
|
|
85
|
+
*
|
|
86
|
+
* @param value - The object to clone
|
|
87
|
+
* @returns A shallow clone of the input value
|
|
88
|
+
*/
|
|
89
|
+
function shallowCloneNullableObject(value) {
|
|
90
|
+
return value === null ? value : shallowCloneObject(value);
|
|
91
|
+
}
|
|
92
|
+
/**
|
|
93
|
+
* Factory for creating a {@link Latest} or {@link LatestRaw} State object.
|
|
94
|
+
*/
|
|
95
|
+
export const latest = (args) => {
|
|
96
|
+
const { local, settings, validator } = args;
|
|
97
|
+
// Latest takes ownership of the initial local value but makes a shallow
|
|
98
|
+
// copy for basic protection.
|
|
99
|
+
const opaqueLocal = toOpaqueJson(local);
|
|
100
|
+
const value = {
|
|
101
|
+
rev: 0,
|
|
102
|
+
timestamp: Date.now(),
|
|
103
|
+
value: shallowCloneNullableObject(opaqueLocal),
|
|
104
|
+
};
|
|
105
|
+
const factory = (key, datastoreHandle) => ({
|
|
106
|
+
initialData: { value, allowableUpdateLatencyMs: settings?.allowableUpdateLatencyMs },
|
|
107
|
+
manager: brandIVM(new LatestValueManagerImpl(key, datastoreFromHandle(datastoreHandle), value, settings, validator)),
|
|
108
|
+
});
|
|
109
|
+
return Object.assign(factory, { instanceBase: LatestValueManagerImpl });
|
|
110
|
+
};
|
|
111
|
+
//# sourceMappingURL=latestValueManager.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"latestValueManager.js","sourceRoot":"","sources":["../../src/states/latestValueManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AA2B7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAGzE,OAAO,EACN,gBAAgB,EAChB,gCAAgC,EAChC,QAAQ,EACR,aAAa,EACb,wBAAwB,EACxB,YAAY,GACZ,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,mBAAmB,EAAE,MAAM,4CAA4C,CAAC;AAEjF,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAE7D,MAAM,sBAAsB;IAS3B,YACkB,GAAQ,EACR,SAAmE,EACpE,KAA0C,EAC1D,eAAqD,EACpC,SAA8C;QAJ9C,QAAG,GAAH,GAAG,CAAK;QACR,cAAS,GAAT,SAAS,CAA0D;QACpE,UAAK,GAAL,KAAK,CAAqC;QAEzC,cAAS,GAAT,SAAS,CAAqC;QARhD,WAAM,GAAG,aAAa,EAAqC,CAAC;QAU3E,IAAI,CAAC,QAAQ,GAAG,IAAI,wBAAwB,CAAC,eAAe,CAAC,CAAC;IAC/D,CAAC;IAED,IAAW,QAAQ;QAClB,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;IAChC,CAAC;IAED,IAAW,KAAK;QACf,OAAO,gCAAgC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC3D,CAAC;IAED,IAAW,KAAK,CAAC,KAA0B;QAC1C,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;QACpB,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAClC,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,YAAY,CAAI,KAAK,CAAC,CAAC;QAC1C,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,EAAE;YAChD,wBAAwB,EAAE,IAAI,CAAC,QAAQ,CAAC,wBAAwB;SAChE,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,KAAK,EAAE,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACtE,CAAC;IAEM,CAAC,UAAU;QACjB,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC5D,KAAK,MAAM,CAAC,UAAU,EAAE,WAAW,CAAC,IAAI,aAAa,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9E,IAAI,UAAU,KAAK,cAAc,CAAC,IAAI,EAAE,CAAC;gBACxC,MAAM;oBACL,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,WAAW,CAAC,UAAU,CAAC;oBACnE,KAAK,EAAE,qBAAqB,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC;oBACzD,QAAQ,EAAE;wBACT,QAAQ,EAAE,WAAW,CAAC,GAAG;wBACzB,SAAS,EAAE,WAAW,CAAC,SAAS;qBAChC;iBACD,CAAC;YACH,CAAC;QACF,CAAC;IACF,CAAC;IAEM,iBAAiB;QACvB,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC5D,OAAO,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC;aACvC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,KAAK,cAAc,CAAC,IAAI,CAAC;aAC1D,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC;IAClF,CAAC;IAEM,SAAS,CAAC,QAAkB;QAClC,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC5D,MAAM,WAAW,GAAG,cAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC/D,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC1C,CAAC;QACD,OAAO;YACN,KAAK,EAAE,qBAAqB,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC;YACzD,QAAQ,EAAE,EAAE,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE;SAC9D,CAAC;IACH,CAAC;IAEM,MAAM,CACZ,QAAkB,EAClB,SAAiB,EACjB,KAA0C;QAE1C,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC5D,MAAM,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC;QACvC,MAAM,YAAY,GAAG,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACvD,IAAI,YAAY,KAAK,SAAS,IAAI,YAAY,CAAC,GAAG,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC;YACjE,OAAO,EAAE,CAAC;QACX,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;QACnD,OAAO;YACN,GAAG,EAAE,CACJ,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,EAAE;gBACjC,QAAQ;gBACR,KAAK,EAAE,qBAAqB,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnD,QAAQ,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,GAAG,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE;aAC7D,CAAC;SACH,CAAC;IACH,CAAC;CACD;AAED;;;;;GAKG;AACH,SAAS,0BAA0B,CAA0B,KAAQ;IACpE,OAAO,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;AAC3D,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAkB,CACpC,IAA2E,EAK1E,EAAE;IACH,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;IAC5C,wEAAwE;IACxE,6BAA6B;IAC7B,MAAM,WAAW,GAAG,YAAY,CAAI,KAAK,CAAC,CAAC;IAC3C,MAAM,KAAK,GAAwC;QAClD,GAAG,EAAE,CAAC;QACN,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;QACrB,KAAK,EAAE,0BAA0B,CAAC,WAAW,CAAC;KAC9C,CAAC;IACF,MAAM,OAAO,GAAG,CACf,GAAQ,EACR,eAGC,EAIA,EAAE,CAAC,CAAC;QACL,WAAW,EAAE,EAAE,KAAK,EAAE,wBAAwB,EAAE,QAAQ,EAAE,wBAAwB,EAAE;QACpF,OAAO,EAAE,QAAQ,CAChB,IAAI,sBAAsB,CACzB,GAAG,EACH,mBAAmB,CAAC,eAAe,CAAC,EACpC,KAAK,EACL,QAAQ,EACR,SAAS,CACT,CACD;KACD,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,YAAY,EAAE,sBAAsB,EAAE,CAAC,CAAC;AACzE,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { createEmitter } from \"@fluid-internal/client-utils\";\nimport type {\n\tAttendee,\n\tBroadcastControlSettings,\n\tLatest,\n\tLatestArguments,\n\tLatestArgumentsRaw,\n\tLatestClientData,\n\tLatestData,\n\tLatestEvents,\n\tLatestFactory,\n\tLatestRaw,\n\tPresence,\n\tStateSchemaValidator,\n\tValueAccessor,\n} from \"@fluid-internal/presence-definitions\";\nimport type {\n\tInternalTypes,\n\tPostUpdateAction,\n\tValueManager,\n} from \"@fluid-internal/presence-definitions/internal\";\nimport type { StateDatastore } from \"@fluid-internal/presence-definitions/internal/workspace-states\";\nimport type {\n\tDeepReadonly,\n\tJsonDeserialized,\n\tJsonSerializable,\n} from \"@fluidframework/core-interfaces/internal/exposedUtilityTypes\";\nimport { shallowCloneObject } from \"@fluidframework/core-utils/internal\";\n\nimport type { FlattenUnionWithOptionals } from \"@fluid-internal/presence-runtime/utils\";\nimport {\n\tasDeeplyReadonly,\n\tasDeeplyReadonlyDeserializedJson,\n\tbrandIVM,\n\tobjectEntries,\n\tOptionalBroadcastControl,\n\ttoOpaqueJson,\n} from \"@fluid-internal/presence-runtime/utils\";\nimport { datastoreFromHandle } from \"@fluid-internal/presence-runtime/workspace\";\n\nimport { createValidatedGetter } from \"./validatedGetter.js\";\n\nclass LatestValueManagerImpl<T, Key extends string>\n\timplements\n\t\tLatestRaw<T>,\n\t\tLatest<T>,\n\t\tRequired<ValueManager<T, InternalTypes.ValueRequiredState<T>>>\n{\n\tpublic readonly events = createEmitter<LatestEvents<T, ValueAccessor<T>>>();\n\tpublic readonly controls: OptionalBroadcastControl;\n\n\tpublic constructor(\n\t\tprivate readonly key: Key,\n\t\tprivate readonly datastore: StateDatastore<Key, InternalTypes.ValueRequiredState<T>>,\n\t\tpublic readonly value: InternalTypes.ValueRequiredState<T>,\n\t\tcontrolSettings: BroadcastControlSettings | undefined,\n\t\tprivate readonly validator: StateSchemaValidator<T> | undefined,\n\t) {\n\t\tthis.controls = new OptionalBroadcastControl(controlSettings);\n\t}\n\n\tpublic get presence(): Presence {\n\t\treturn this.datastore.presence;\n\t}\n\n\tpublic get local(): DeepReadonly<JsonDeserialized<T>> {\n\t\treturn asDeeplyReadonlyDeserializedJson(this.value.value);\n\t}\n\n\tpublic set local(value: JsonSerializable<T>) {\n\t\tthis.value.rev += 1;\n\t\tthis.value.timestamp = Date.now();\n\t\tthis.value.value = toOpaqueJson<T>(value);\n\t\tthis.datastore.localUpdate(this.key, this.value, {\n\t\t\tallowableUpdateLatencyMs: this.controls.allowableUpdateLatencyMs,\n\t\t});\n\n\t\tthis.events.emit(\"localUpdated\", { value: asDeeplyReadonly(value) });\n\t}\n\n\tpublic *getRemotes(): IterableIterator<LatestClientData<T, ValueAccessor<T>>> {\n\t\tconst allKnownStates = this.datastore.knownValues(this.key);\n\t\tfor (const [attendeeId, clientState] of objectEntries(allKnownStates.states)) {\n\t\t\tif (attendeeId !== allKnownStates.self) {\n\t\t\t\tyield {\n\t\t\t\t\tattendee: this.datastore.presence.attendees.getAttendee(attendeeId),\n\t\t\t\t\tvalue: createValidatedGetter(clientState, this.validator),\n\t\t\t\t\tmetadata: {\n\t\t\t\t\t\trevision: clientState.rev,\n\t\t\t\t\t\ttimestamp: clientState.timestamp,\n\t\t\t\t\t},\n\t\t\t\t};\n\t\t\t}\n\t\t}\n\t}\n\n\tpublic getStateAttendees(): Attendee[] {\n\t\tconst allKnownStates = this.datastore.knownValues(this.key);\n\t\treturn Object.keys(allKnownStates.states)\n\t\t\t.filter((attendeeId) => attendeeId !== allKnownStates.self)\n\t\t\t.map((attendeeId) => this.datastore.presence.attendees.getAttendee(attendeeId));\n\t}\n\n\tpublic getRemote(attendee: Attendee): LatestData<T, ValueAccessor<T>> {\n\t\tconst allKnownStates = this.datastore.knownValues(this.key);\n\t\tconst clientState = allKnownStates.states[attendee.attendeeId];\n\t\tif (clientState === undefined) {\n\t\t\tthrow new Error(\"No entry for attendee\");\n\t\t}\n\t\treturn {\n\t\t\tvalue: createValidatedGetter(clientState, this.validator),\n\t\t\tmetadata: { revision: clientState.rev, timestamp: Date.now() },\n\t\t};\n\t}\n\n\tpublic update(\n\t\tattendee: Attendee,\n\t\t_received: number,\n\t\tvalue: InternalTypes.ValueRequiredState<T>,\n\t): PostUpdateAction[] {\n\t\tconst allKnownStates = this.datastore.knownValues(this.key);\n\t\tconst attendeeId = attendee.attendeeId;\n\t\tconst currentState = allKnownStates.states[attendeeId];\n\t\tif (currentState !== undefined && currentState.rev >= value.rev) {\n\t\t\treturn [];\n\t\t}\n\t\tthis.datastore.update(this.key, attendeeId, value);\n\t\treturn [\n\t\t\t() =>\n\t\t\t\tthis.events.emit(\"remoteUpdated\", {\n\t\t\t\t\tattendee,\n\t\t\t\t\tvalue: createValidatedGetter(value, this.validator),\n\t\t\t\t\tmetadata: { revision: value.rev, timestamp: value.timestamp },\n\t\t\t\t}),\n\t\t];\n\t}\n}\n\n/**\n * Shallow clone an object that might be null.\n *\n * @param value - The object to clone\n * @returns A shallow clone of the input value\n */\nfunction shallowCloneNullableObject<T extends object | null>(value: T): T {\n\treturn value === null ? value : shallowCloneObject(value);\n}\n\n/**\n * Factory for creating a {@link Latest} or {@link LatestRaw} State object.\n */\nexport const latest: LatestFactory = <T extends object | null, Key extends string = string>(\n\targs: FlattenUnionWithOptionals<LatestArguments<T> | LatestArgumentsRaw<T>>,\n): InternalTypes.ManagerFactory<\n\tKey,\n\tInternalTypes.ValueRequiredState<T>,\n\tLatestRaw<T> & Latest<T>\n> => {\n\tconst { local, settings, validator } = args;\n\t// Latest takes ownership of the initial local value but makes a shallow\n\t// copy for basic protection.\n\tconst opaqueLocal = toOpaqueJson<T>(local);\n\tconst value: InternalTypes.ValueRequiredState<T> = {\n\t\trev: 0,\n\t\ttimestamp: Date.now(),\n\t\tvalue: shallowCloneNullableObject(opaqueLocal),\n\t};\n\tconst factory = (\n\t\tkey: Key,\n\t\tdatastoreHandle: InternalTypes.StateDatastoreHandle<\n\t\t\tKey,\n\t\t\tInternalTypes.ValueRequiredState<T>\n\t\t>,\n\t): {\n\t\tinitialData: { value: typeof value; allowableUpdateLatencyMs: number | undefined };\n\t\tmanager: InternalTypes.StateValue<LatestRaw<T> & Latest<T>>;\n\t} => ({\n\t\tinitialData: { value, allowableUpdateLatencyMs: settings?.allowableUpdateLatencyMs },\n\t\tmanager: brandIVM<LatestValueManagerImpl<T, Key>, T, InternalTypes.ValueRequiredState<T>>(\n\t\t\tnew LatestValueManagerImpl(\n\t\t\t\tkey,\n\t\t\t\tdatastoreFromHandle(datastoreHandle),\n\t\t\t\tvalue,\n\t\t\t\tsettings,\n\t\t\t\tvalidator,\n\t\t\t),\n\t\t),\n\t});\n\treturn Object.assign(factory, { instanceBase: LatestValueManagerImpl });\n};\n"]}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
/*!
|
|
2
|
+
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
|
+
* Licensed under the MIT License.
|
|
4
|
+
*/
|
|
5
|
+
import type { InternalPresenceUtilityTypes, NotificationsConfiguration, NotificationSubscriberSignatures, NotificationsWithSubscriptionsConfiguration } from "@fluid-internal/presence-definitions";
|
|
6
|
+
/**
|
|
7
|
+
* Factory for creating a {@link @fluid-internal/presence-definitions#NotificationsManager}.
|
|
8
|
+
*
|
|
9
|
+
* @alpha
|
|
10
|
+
*
|
|
11
|
+
* @privateRemarks
|
|
12
|
+
* This overload requires explicit specification of the notification listener
|
|
13
|
+
* types. It is useful when a schema is separately defined.
|
|
14
|
+
*/
|
|
15
|
+
export declare function Notifications<T extends InternalPresenceUtilityTypes.NotificationListeners<T>, Key extends string = string>(initialSubscriptions: Partial<NotificationSubscriberSignatures<T>>): NotificationsConfiguration<T, Key>;
|
|
16
|
+
/**
|
|
17
|
+
* Factory for creating a {@link @fluid-internal/presence-definitions#NotificationsManager}.
|
|
18
|
+
*
|
|
19
|
+
* @alpha
|
|
20
|
+
*
|
|
21
|
+
* @privateRemarks
|
|
22
|
+
* This overload infers the notification listener types from the provided
|
|
23
|
+
* subscriptions, simplifying usage when a schema is not separately defined.
|
|
24
|
+
*/
|
|
25
|
+
export declare function Notifications<TSubscriptions extends InternalPresenceUtilityTypes.NotificationListenersWithSubscriberSignatures<TSubscriptions>, Key extends string = string>(initialSubscriptions: Partial<TSubscriptions>): NotificationsWithSubscriptionsConfiguration<TSubscriptions, Key>;
|
|
26
|
+
//# sourceMappingURL=notificationsManager.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"notificationsManager.d.ts","sourceRoot":"","sources":["../../src/states/notificationsManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAEX,4BAA4B,EAG5B,0BAA0B,EAG1B,gCAAgC,EAChC,2CAA2C,EAE3C,MAAM,sCAAsC,CAAC;AA+H9C;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAC5B,CAAC,SAAS,4BAA4B,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAC/D,GAAG,SAAS,MAAM,GAAG,MAAM,EAE3B,oBAAoB,EAAE,OAAO,CAAC,gCAAgC,CAAC,CAAC,CAAC,CAAC,GAChE,0BAA0B,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;AAEtC;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAC5B,cAAc,SACb,4BAA4B,CAAC,6CAA6C,CAAC,cAAc,CAAC,EAC3F,GAAG,SAAS,MAAM,GAAG,MAAM,EAE3B,oBAAoB,EAAE,OAAO,CAAC,cAAc,CAAC,GAC3C,2CAA2C,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC"}
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
/*!
|
|
2
|
+
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
|
+
* Licensed under the MIT License.
|
|
4
|
+
*/
|
|
5
|
+
import { createEmitter } from "@fluid-internal/client-utils";
|
|
6
|
+
import { brandIVM, revealOpaqueJson, toOpaqueJson, } from "@fluid-internal/presence-runtime/utils";
|
|
7
|
+
import { datastoreFromHandle } from "@fluid-internal/presence-runtime/workspace";
|
|
8
|
+
/**
|
|
9
|
+
* Object.keys retyped to support specific records keys and
|
|
10
|
+
* branded string-based keys.
|
|
11
|
+
*/
|
|
12
|
+
const recordKeys = Object.keys;
|
|
13
|
+
class NotificationsManagerImpl {
|
|
14
|
+
constructor(key, datastore, initialSubscriptions) {
|
|
15
|
+
this.key = key;
|
|
16
|
+
this.datastore = datastore;
|
|
17
|
+
this.events = createEmitter();
|
|
18
|
+
this.emit = {
|
|
19
|
+
broadcast: (name, ...args) => {
|
|
20
|
+
this.datastore.localUpdate(this.key, {
|
|
21
|
+
rev: 0,
|
|
22
|
+
timestamp: 0,
|
|
23
|
+
value: toOpaqueJson({
|
|
24
|
+
name,
|
|
25
|
+
args: [...args],
|
|
26
|
+
}),
|
|
27
|
+
ignoreUnmonitored: true,
|
|
28
|
+
},
|
|
29
|
+
// This is a notification, so we want to send it immediately.
|
|
30
|
+
{ allowableUpdateLatencyMs: 0 });
|
|
31
|
+
},
|
|
32
|
+
unicast: (name, targetAttendee, ...args) => {
|
|
33
|
+
this.datastore.localUpdate(this.key, {
|
|
34
|
+
rev: 0,
|
|
35
|
+
timestamp: 0,
|
|
36
|
+
value: toOpaqueJson({
|
|
37
|
+
name,
|
|
38
|
+
args: [...args],
|
|
39
|
+
}),
|
|
40
|
+
ignoreUnmonitored: true,
|
|
41
|
+
},
|
|
42
|
+
// This is a notification, so we want to send it immediately.
|
|
43
|
+
{ allowableUpdateLatencyMs: 0, targetClientId: targetAttendee.getConnectionId() });
|
|
44
|
+
},
|
|
45
|
+
};
|
|
46
|
+
// Workaround for types
|
|
47
|
+
this.notificationsInternal = createEmitter();
|
|
48
|
+
this.notifications = this.notificationsInternal;
|
|
49
|
+
// Add event listeners provided at instantiation
|
|
50
|
+
for (const subscriptionName of recordKeys(initialSubscriptions)) {
|
|
51
|
+
// Lingering Event typing issues with Notifications specialization requires
|
|
52
|
+
// this cast. The only thing that really matters is that name is a string.
|
|
53
|
+
const name = subscriptionName;
|
|
54
|
+
const value = initialSubscriptions[subscriptionName];
|
|
55
|
+
// This check should not be needed while using exactOptionalPropertyTypes, but
|
|
56
|
+
// typescript appears to ignore that with Partial<>. Good to be defensive
|
|
57
|
+
// against callers sending `undefined` anyway.
|
|
58
|
+
if (value !== undefined) {
|
|
59
|
+
this.notificationsInternal.on(name, value);
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
get presence() {
|
|
64
|
+
return this.datastore.presence;
|
|
65
|
+
}
|
|
66
|
+
update(attendee, _received, updateValue) {
|
|
67
|
+
const postUpdateActions = [];
|
|
68
|
+
const value = revealOpaqueJson(updateValue.value);
|
|
69
|
+
const eventName = value.name;
|
|
70
|
+
if (this.notificationsInternal.hasListeners(eventName)) {
|
|
71
|
+
// Without schema validation, we don't know that the args are the correct type.
|
|
72
|
+
// For now we assume the user is sending the correct types and there is no corruption along the way.
|
|
73
|
+
const args = [attendee, ...value.args];
|
|
74
|
+
postUpdateActions.push(() => this.notificationsInternal.emit(eventName, ...args));
|
|
75
|
+
}
|
|
76
|
+
else {
|
|
77
|
+
postUpdateActions.push(() => this.events.emit("unattendedNotification", value.name, attendee, ...value.args));
|
|
78
|
+
}
|
|
79
|
+
return postUpdateActions;
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* Factory for creating a {@link @fluid-internal/presence-definitions#NotificationsManager}.
|
|
84
|
+
*
|
|
85
|
+
* @alpha
|
|
86
|
+
*/
|
|
87
|
+
export function Notifications(initialSubscriptions) {
|
|
88
|
+
const factory = (key, datastoreHandle) => ({
|
|
89
|
+
manager: brandIVM(new NotificationsManagerImpl(key, datastoreFromHandle(datastoreHandle), initialSubscriptions)),
|
|
90
|
+
});
|
|
91
|
+
return Object.assign(factory, { instanceBase: NotificationsManagerImpl });
|
|
92
|
+
}
|
|
93
|
+
//# sourceMappingURL=notificationsManager.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"notificationsManager.js","sourceRoot":"","sources":["../../src/states/notificationsManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAsB7D,OAAO,EACN,QAAQ,EACR,gBAAgB,EAChB,YAAY,GACZ,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,mBAAmB,EAAE,MAAM,4CAA4C,CAAC;AAEjF;;;GAGG;AACH,MAAM,UAAU,GAAG,MAAM,CAAC,IAAiE,CAAC;AAE5F,MAAM,wBAAwB;IAqD7B,YACkB,GAAQ,EACR,SAGhB,EACD,oBAAkE;QALjD,QAAG,GAAH,GAAG,CAAK;QACR,cAAS,GAAT,SAAS,CAGzB;QAhDc,WAAM,GAAG,aAAa,EAA8B,CAAC;QAErD,SAAI,GAA2B;YAC9C,SAAS,EAAE,CAAC,IAAY,EAAE,GAAG,IAAI,EAAE,EAAE;gBACpC,IAAI,CAAC,SAAS,CAAC,WAAW,CACzB,IAAI,CAAC,GAAG,EACR;oBACC,GAAG,EAAE,CAAC;oBACN,SAAS,EAAE,CAAC;oBACZ,KAAK,EAAE,YAAY,CAAC;wBACnB,IAAI;wBACJ,IAAI,EAAE,CAAC,GAAI,IAA8B,CAAC;qBAC1C,CAAC;oBACF,iBAAiB,EAAE,IAAI;iBACvB;gBACD,6DAA6D;gBAC7D,EAAE,wBAAwB,EAAE,CAAC,EAAE,CAC/B,CAAC;YACH,CAAC;YACD,OAAO,EAAE,CAAC,IAAY,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,EAAE;gBAClD,IAAI,CAAC,SAAS,CAAC,WAAW,CACzB,IAAI,CAAC,GAAG,EACR;oBACC,GAAG,EAAE,CAAC;oBACN,SAAS,EAAE,CAAC;oBACZ,KAAK,EAAE,YAAY,CAAC;wBACnB,IAAI;wBACJ,IAAI,EAAE,CAAC,GAAI,IAA8B,CAAC;qBAC1C,CAAC;oBACF,iBAAiB,EAAE,IAAI;iBACvB;gBACD,6DAA6D;gBAC7D,EAAE,wBAAwB,EAAE,CAAC,EAAE,cAAc,EAAE,cAAc,CAAC,eAAe,EAAE,EAAE,CACjF,CAAC;YACH,CAAC;SACD,CAAC;QAEF,uBAAuB;QACN,0BAAqB,GACrC,aAAa,EAAuC,CAAC;QAEtC,kBAAa,GAA8B,IAAI,CAAC,qBAAqB,CAAC;QAUrF,gDAAgD;QAChD,KAAK,MAAM,gBAAgB,IAAI,UAAU,CAAC,oBAAoB,CAAC,EAAE,CAAC;YACjE,2EAA2E;YAC3E,0EAA0E;YAC1E,MAAM,IAAI,GAAG,gBAAwE,CAAC;YACtF,MAAM,KAAK,GAAG,oBAAoB,CAAC,gBAAgB,CAAC,CAAC;YACrD,8EAA8E;YAC9E,yEAAyE;YACzE,8CAA8C;YAC9C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACzB,IAAI,CAAC,qBAAqB,CAAC,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YAC5C,CAAC;QACF,CAAC;IACF,CAAC;IAED,IAAW,QAAQ;QAClB,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;IAChC,CAAC;IAEM,MAAM,CACZ,QAAkB,EAClB,SAAiB,EACjB,WAA6E;QAE7E,MAAM,iBAAiB,GAAuB,EAAE,CAAC;QACjD,MAAM,KAAK,GAAG,gBAAgB,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAClD,MAAM,SAAS,GAAG,KAAK,CAAC,IAA4D,CAAC;QACrF,IAAI,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,CAAC;YACxD,+EAA+E;YAC/E,oGAAoG;YACpG,MAAM,IAAI,GAAG,CAAC,QAAQ,EAAE,GAAG,KAAK,CAAC,IAAI,CAEpC,CAAC;YACF,iBAAiB,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC;QACnF,CAAC;aAAM,CAAC;YACP,iBAAiB,CAAC,IAAI,CAAC,GAAG,EAAE,CAC3B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,wBAAwB,EAAE,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,CAC/E,CAAC;QACH,CAAC;QACD,OAAO,iBAAiB,CAAC;IAC1B,CAAC;CACD;AAmCD;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAM5B,oBAA6C;IAM7C,MAAM,OAAO,GAAG,CACf,GAAQ,EACR,eAGC,EAGA,EAAE,CAAC,CAAC;QACL,OAAO,EAAE,QAAQ,CAKhB,IAAI,wBAAwB,CAC3B,GAAG,EACH,mBAAmB,CAAC,eAAe,CAAC,EACpC,oBAAoB,CACpB,CACD;KACD,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,YAAY,EAAE,wBAAwB,EAAE,CAAC,CAAC;AAC3E,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { createEmitter } from \"@fluid-internal/client-utils\";\nimport type {\n\tAttendee,\n\tInternalPresenceUtilityTypes,\n\tNotificationEmitter,\n\tNotificationListenable,\n\tNotificationsConfiguration,\n\tNotificationsManager,\n\tNotificationsManagerEvents,\n\tNotificationSubscriberSignatures,\n\tNotificationsWithSubscriptionsConfiguration,\n\tPresenceWithNotifications as Presence,\n} from \"@fluid-internal/presence-definitions\";\nimport type {\n\tInternalTypes,\n\tPostUpdateAction,\n\tValueManager,\n} from \"@fluid-internal/presence-definitions/internal\";\nimport type { StateDatastore } from \"@fluid-internal/presence-definitions/internal/workspace-states\";\nimport type { Listeners } from \"@fluidframework/core-interfaces\";\nimport type { JsonTypeWith } from \"@fluidframework/core-interfaces/internal\";\n\nimport {\n\tbrandIVM,\n\trevealOpaqueJson,\n\ttoOpaqueJson,\n} from \"@fluid-internal/presence-runtime/utils\";\nimport { datastoreFromHandle } from \"@fluid-internal/presence-runtime/workspace\";\n\n/**\n * Object.keys retyped to support specific records keys and\n * branded string-based keys.\n */\nconst recordKeys = Object.keys as <K extends string>(o: Partial<Record<K, unknown>>) => K[];\n\nclass NotificationsManagerImpl<\n\tT extends InternalPresenceUtilityTypes.NotificationListeners<T>,\n\tKey extends string,\n> implements\n\t\tNotificationsManager<T>,\n\t\tValueManager<\n\t\t\tInternalTypes.NotificationType,\n\t\t\tInternalTypes.ValueRequiredState<InternalTypes.NotificationType>\n\t\t>\n{\n\tpublic readonly events = createEmitter<NotificationsManagerEvents>();\n\n\tpublic readonly emit: NotificationEmitter<T> = {\n\t\tbroadcast: (name: string, ...args) => {\n\t\t\tthis.datastore.localUpdate(\n\t\t\t\tthis.key,\n\t\t\t\t{\n\t\t\t\t\trev: 0,\n\t\t\t\t\ttimestamp: 0,\n\t\t\t\t\tvalue: toOpaqueJson({\n\t\t\t\t\t\tname,\n\t\t\t\t\t\targs: [...(args as JsonTypeWith<never>[])],\n\t\t\t\t\t}),\n\t\t\t\t\tignoreUnmonitored: true,\n\t\t\t\t},\n\t\t\t\t// This is a notification, so we want to send it immediately.\n\t\t\t\t{ allowableUpdateLatencyMs: 0 },\n\t\t\t);\n\t\t},\n\t\tunicast: (name: string, targetAttendee, ...args) => {\n\t\t\tthis.datastore.localUpdate(\n\t\t\t\tthis.key,\n\t\t\t\t{\n\t\t\t\t\trev: 0,\n\t\t\t\t\ttimestamp: 0,\n\t\t\t\t\tvalue: toOpaqueJson({\n\t\t\t\t\t\tname,\n\t\t\t\t\t\targs: [...(args as JsonTypeWith<never>[])],\n\t\t\t\t\t}),\n\t\t\t\t\tignoreUnmonitored: true,\n\t\t\t\t},\n\t\t\t\t// This is a notification, so we want to send it immediately.\n\t\t\t\t{ allowableUpdateLatencyMs: 0, targetClientId: targetAttendee.getConnectionId() },\n\t\t\t);\n\t\t},\n\t};\n\n\t// Workaround for types\n\tprivate readonly notificationsInternal =\n\t\tcreateEmitter<NotificationSubscriberSignatures<T>>();\n\n\tpublic readonly notifications: NotificationListenable<T> = this.notificationsInternal;\n\n\tpublic constructor(\n\t\tprivate readonly key: Key,\n\t\tprivate readonly datastore: StateDatastore<\n\t\t\tKey,\n\t\t\tInternalTypes.ValueRequiredState<InternalTypes.NotificationType>\n\t\t>,\n\t\tinitialSubscriptions: Partial<NotificationSubscriberSignatures<T>>,\n\t) {\n\t\t// Add event listeners provided at instantiation\n\t\tfor (const subscriptionName of recordKeys(initialSubscriptions)) {\n\t\t\t// Lingering Event typing issues with Notifications specialization requires\n\t\t\t// this cast. The only thing that really matters is that name is a string.\n\t\t\tconst name = subscriptionName as keyof Listeners<NotificationSubscriberSignatures<T>>;\n\t\t\tconst value = initialSubscriptions[subscriptionName];\n\t\t\t// This check should not be needed while using exactOptionalPropertyTypes, but\n\t\t\t// typescript appears to ignore that with Partial<>. Good to be defensive\n\t\t\t// against callers sending `undefined` anyway.\n\t\t\tif (value !== undefined) {\n\t\t\t\tthis.notificationsInternal.on(name, value);\n\t\t\t}\n\t\t}\n\t}\n\n\tpublic get presence(): Presence {\n\t\treturn this.datastore.presence;\n\t}\n\n\tpublic update(\n\t\tattendee: Attendee,\n\t\t_received: number,\n\t\tupdateValue: InternalTypes.ValueRequiredState<InternalTypes.NotificationType>,\n\t): PostUpdateAction[] {\n\t\tconst postUpdateActions: PostUpdateAction[] = [];\n\t\tconst value = revealOpaqueJson(updateValue.value);\n\t\tconst eventName = value.name as keyof Listeners<NotificationSubscriberSignatures<T>>;\n\t\tif (this.notificationsInternal.hasListeners(eventName)) {\n\t\t\t// Without schema validation, we don't know that the args are the correct type.\n\t\t\t// For now we assume the user is sending the correct types and there is no corruption along the way.\n\t\t\tconst args = [attendee, ...value.args] as Parameters<\n\t\t\t\tNotificationSubscriberSignatures<T>[typeof eventName]\n\t\t\t>;\n\t\t\tpostUpdateActions.push(() => this.notificationsInternal.emit(eventName, ...args));\n\t\t} else {\n\t\t\tpostUpdateActions.push(() =>\n\t\t\t\tthis.events.emit(\"unattendedNotification\", value.name, attendee, ...value.args),\n\t\t\t);\n\t\t}\n\t\treturn postUpdateActions;\n\t}\n}\n\n/**\n * Factory for creating a {@link @fluid-internal/presence-definitions#NotificationsManager}.\n *\n * @alpha\n *\n * @privateRemarks\n * This overload requires explicit specification of the notification listener\n * types. It is useful when a schema is separately defined.\n */\nexport function Notifications<\n\tT extends InternalPresenceUtilityTypes.NotificationListeners<T>,\n\tKey extends string = string,\n>(\n\tinitialSubscriptions: Partial<NotificationSubscriberSignatures<T>>,\n): NotificationsConfiguration<T, Key>;\n\n/**\n * Factory for creating a {@link @fluid-internal/presence-definitions#NotificationsManager}.\n *\n * @alpha\n *\n * @privateRemarks\n * This overload infers the notification listener types from the provided\n * subscriptions, simplifying usage when a schema is not separately defined.\n */\nexport function Notifications<\n\tTSubscriptions extends\n\t\tInternalPresenceUtilityTypes.NotificationListenersWithSubscriberSignatures<TSubscriptions>,\n\tKey extends string = string,\n>(\n\tinitialSubscriptions: Partial<TSubscriptions>,\n): NotificationsWithSubscriptionsConfiguration<TSubscriptions, Key>;\n\n/**\n * Factory for creating a {@link @fluid-internal/presence-definitions#NotificationsManager}.\n *\n * @alpha\n */\nexport function Notifications<\n\tT extends InternalPresenceUtilityTypes.NotificationListeners<T>,\n\tKey extends string = string,\n\tTSubscriptions extends\n\t\tNotificationSubscriberSignatures<T> = NotificationSubscriberSignatures<T>,\n>(\n\tinitialSubscriptions: Partial<TSubscriptions>,\n): InternalTypes.ManagerFactory<\n\tKey,\n\tInternalTypes.ValueRequiredState<InternalTypes.NotificationType>,\n\tNotificationsManager<T>\n> {\n\tconst factory = (\n\t\tkey: Key,\n\t\tdatastoreHandle: InternalTypes.StateDatastoreHandle<\n\t\t\tKey,\n\t\t\tInternalTypes.ValueRequiredState<InternalTypes.NotificationType>\n\t\t>,\n\t): {\n\t\tmanager: InternalTypes.StateValue<NotificationsManager<T>>;\n\t} => ({\n\t\tmanager: brandIVM<\n\t\t\tNotificationsManagerImpl<T, Key>,\n\t\t\tInternalTypes.NotificationType,\n\t\t\tInternalTypes.ValueRequiredState<InternalTypes.NotificationType>\n\t\t>(\n\t\t\tnew NotificationsManagerImpl(\n\t\t\t\tkey,\n\t\t\t\tdatastoreFromHandle(datastoreHandle),\n\t\t\t\tinitialSubscriptions,\n\t\t\t),\n\t\t),\n\t});\n\treturn Object.assign(factory, { instanceBase: NotificationsManagerImpl });\n}\n"]}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/*!
|
|
2
|
+
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
|
+
* Licensed under the MIT License.
|
|
4
|
+
*/
|
|
5
|
+
import type { Attendee, AttendeeId } from "@fluid-internal/presence-definitions";
|
|
6
|
+
/**
|
|
7
|
+
* Utility type limiting to a specific attendee. (An attendee with
|
|
8
|
+
* a specific session ID - not just any session ID.)
|
|
9
|
+
*/
|
|
10
|
+
export type SpecificAttendee<SpecificAttendeeId extends AttendeeId> = string extends SpecificAttendeeId ? never : Attendee<SpecificAttendeeId>;
|
|
11
|
+
//# sourceMappingURL=presence.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"presence.d.ts","sourceRoot":"","sources":["../../src/states/presence.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AAEjF;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAAC,kBAAkB,SAAS,UAAU,IACjE,MAAM,SAAS,kBAAkB,GAAG,KAAK,GAAG,QAAQ,CAAC,kBAAkB,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"presence.js","sourceRoot":"","sources":["../../src/states/presence.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { Attendee, AttendeeId } from \"@fluid-internal/presence-definitions\";\n\n/**\n * Utility type limiting to a specific attendee. (An attendee with\n * a specific session ID - not just any session ID.)\n */\nexport type SpecificAttendee<SpecificAttendeeId extends AttendeeId> =\n\tstring extends SpecificAttendeeId ? never : Attendee<SpecificAttendeeId>;\n"]}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/*!
|
|
2
|
+
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
|
+
* Licensed under the MIT License.
|
|
4
|
+
*/
|
|
5
|
+
/**
|
|
6
|
+
* Factory for creating presence State objects.
|
|
7
|
+
*
|
|
8
|
+
* @remarks
|
|
9
|
+
* Use `latest` to create a {@link @fluidframework/presence#LatestRaw} State object.
|
|
10
|
+
* Use `latestMap` to create a {@link @fluidframework/presence#LatestMapRaw} State object.
|
|
11
|
+
*
|
|
12
|
+
* @public
|
|
13
|
+
*/
|
|
14
|
+
export declare const StateFactory: {
|
|
15
|
+
readonly latest: import("@fluid-internal/presence-definitions").LatestFactory;
|
|
16
|
+
readonly latestMap: import("@fluid-internal/presence-definitions").LatestMapFactory;
|
|
17
|
+
};
|
|
18
|
+
//# sourceMappingURL=stateFactory.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"stateFactory.d.ts","sourceRoot":"","sources":["../../src/states/stateFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAcH;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY;;;CAGf,CAAC"}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/*!
|
|
2
|
+
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
|
+
* Licensed under the MIT License.
|
|
4
|
+
*/
|
|
5
|
+
import { latestMap } from "./latestMapValueManager.js";
|
|
6
|
+
import { latest } from "./latestValueManager.js";
|
|
7
|
+
/**
|
|
8
|
+
* Factory for creating presence State objects.
|
|
9
|
+
*
|
|
10
|
+
* @remarks
|
|
11
|
+
* Use `latest` to create a {@link @fluidframework/presence#LatestRaw} State object.
|
|
12
|
+
* Use `latestMap` to create a {@link @fluidframework/presence#LatestMapRaw} State object.
|
|
13
|
+
*
|
|
14
|
+
* @public
|
|
15
|
+
*/
|
|
16
|
+
export const StateFactory = {
|
|
17
|
+
latest,
|
|
18
|
+
latestMap,
|
|
19
|
+
};
|
|
20
|
+
//# sourceMappingURL=stateFactory.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"stateFactory.js","sourceRoot":"","sources":["../../src/states/stateFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAWH,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AACvD,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAEjD;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC3B,MAAM;IACN,SAAS;CACA,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// These \"unused\" imports are specified to workaround an api-extractor limitation.\n// @ts-expect-error -- Unused import is for type only\nimport type {\n\t// eslint-disable-next-line unused-imports/no-unused-imports\n\tLatest,\n\t// eslint-disable-next-line unused-imports/no-unused-imports\n\tLatestMap,\n} from \"@fluid-internal/presence-definitions\";\n\nimport { latestMap } from \"./latestMapValueManager.js\";\nimport { latest } from \"./latestValueManager.js\";\n\n/**\n * Factory for creating presence State objects.\n *\n * @remarks\n * Use `latest` to create a {@link @fluidframework/presence#LatestRaw} State object.\n * Use `latestMap` to create a {@link @fluidframework/presence#LatestMapRaw} State object.\n *\n * @public\n */\nexport const StateFactory = {\n\tlatest,\n\tlatestMap,\n} as const;\n"]}
|