@fluidframework/presence 2.10.0-307399

package/lib/notificationsManager.d.ts

@@ -0,0 +1,101 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { ISessionClient } from "./presence.js";
+import type { ISubscribable } from "@fluidframework/presence/internal/events";
+import type { InternalTypes } from "@fluidframework/presence/internal/exposedInternalTypes";
+import type { InternalUtilityTypes } from "@fluidframework/presence/internal/exposedUtilityTypes";
+/**
+ * @sealed
+ * @alpha
+ */
+export interface NotificationsManagerEvents {
+    /**
+     * Raised when notification is received, but no subscribers were found.
+     *
+     * @eventProperty
+     */
+    unattendedNotification: (name: string, sender: ISessionClient, ...content: unknown[]) => void;
+}
+/**
+ * An object which allows the registration of listeners so that subscribers can be
+ * notified when a notification happens.
+ *
+ * @sealed
+ * @alpha
+ */
+export interface NotificationSubscribable<E extends InternalUtilityTypes.NotificationEvents<E>> {
+    /**
+     * Register a notification listener.
+     * @param notificationName - the name of the notification
+     * @param listener - the handler to run when the notification is received from other client
+     * @returns a function which will deregister the listener when run. This function
+     * has undefined behavior if called more than once.
+     */
+    on<K extends keyof InternalUtilityTypes.NotificationEvents<E>>(notificationName: K, listener: (sender: ISessionClient, ...args: InternalUtilityTypes.JsonDeserializedParameters<E[K]>) => void): () => void;
+}
+/**
+ * Record of notification subscriptions.
+ *
+ * @sealed
+ * @alpha
+ */
+export type NotificationSubscriptions<E extends InternalUtilityTypes.NotificationEvents<E>> = {
+    [K in string & keyof InternalUtilityTypes.NotificationEvents<E>]: (sender: ISessionClient, ...args: InternalUtilityTypes.JsonDeserializedParameters<E[K]>) => void;
+};
+/**
+ * Interface for a notification emitter that can send typed notification to other clients.
+ *
+ * @sealed
+ * @alpha
+ */
+export interface NotificationEmitter<E extends InternalUtilityTypes.NotificationEvents<E>> {
+    /**
+     * Emits a notification with the specified name and arguments, notifying all clients.
+     * @param notificationName - the name of the notification to fire
+     * @param args - the arguments sent with the notification
+     */
+    broadcast<K extends string & keyof InternalUtilityTypes.NotificationEvents<E>>(notificationName: K, ...args: Parameters<E[K]>): void;
+    /**
+     * Emits a notification with the specified name and arguments, notifying a single client.
+     * @param notificationName - the name of the notification to fire
+     * @param targetClient - the single client to notify
+     * @param args - the arguments sent with the notification
+     */
+    unicast<K extends string & keyof InternalUtilityTypes.NotificationEvents<E>>(notificationName: K, targetClient: ISessionClient, ...args: Parameters<E[K]>): void;
+}
+/**
+ * Value manager that provides notifications from this client to others and subscription
+ * to their notifications.
+ *
+ * @remarks Create using {@link Notifications} registered to {@link PresenceStates}.
+ *
+ * @sealed
+ * @alpha
+ */
+export interface NotificationsManager<T extends InternalUtilityTypes.NotificationEvents<T>> {
+    /**
+     * Events for Notifications manager.
+     */
+    readonly events: ISubscribable<NotificationsManagerEvents>;
+    /**
+     * Send notifications to other clients.
+     */
+    readonly emit: NotificationEmitter<T>;
+    /**
+     * Provides subscription to notifications from other clients.
+     */
+    readonly notifications: NotificationSubscribable<T>;
+}
+/**
+ * Factory for creating a {@link NotificationsManager}.
+ *
+ * @remarks
+ * Typescript inference for `Notifications` is not working correctly yet.
+ * Explicitly specify generics to make result types usable.
+ *
+ * @alpha
+ */
+export declare function Notifications<T extends InternalUtilityTypes.NotificationEvents<T>, Key extends string = string>(initialSubscriptions: Partial<NotificationSubscriptions<T>>): InternalTypes.ManagerFactory<Key, InternalTypes.ValueRequiredState<InternalTypes.NotificationType>, NotificationsManager<T>>;
+//# sourceMappingURL=notificationsManager.d.ts.map

package/lib/notificationsManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"notificationsManager.d.ts","sourceRoot":"","sources":["../src/notificationsManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAIpD,OAAO,KAAK,EAAU,aAAa,EAAE,MAAM,0CAA0C,CAAC;AAEtF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wDAAwD,CAAC;AAC5F,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,uDAAuD,CAAC;AAElG;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IAC1C;;;;OAIG;IACH,sBAAsB,EAAE,CACvB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,cAAc,EACtB,GAAG,OAAO,EAAE,OAAO,EAAE,KACjB,IAAI,CAAC;CACV;AAED;;;;;;GAMG;AACH,MAAM,WAAW,wBAAwB,CACxC,CAAC,SAAS,oBAAoB,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAEpD;;;;;;OAMG;IACH,EAAE,CAAC,CAAC,SAAS,MAAM,oBAAoB,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAC5D,gBAAgB,EAAE,CAAC,EACnB,QAAQ,EAAE,CACT,MAAM,EAAE,cAAc,EACtB,GAAG,IAAI,EAAE,oBAAoB,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAC1D,IAAI,GACP,MAAM,IAAI,CAAC;CACd;AAED;;;;;GAKG;AACH,MAAM,MAAM,yBAAyB,CAAC,CAAC,SAAS,oBAAoB,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI;KAC5F,CAAC,IAAI,MAAM,GAAG,MAAM,oBAAoB,CAAC,kBAAkB,CAAC,CAAC,CAAC,GAAG,CACjE,MAAM,EAAE,cAAc,EACtB,GAAG,IAAI,EAAE,oBAAoB,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAC1D,IAAI;CACT,CAAC;AAEF;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,oBAAoB,CAAC,kBAAkB,CAAC,CAAC,CAAC;IACxF;;;;OAIG;IACH,SAAS,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,oBAAoB,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAC5E,gBAAgB,EAAE,CAAC,EACnB,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACvB,IAAI,CAAC;IAER;;;;;OAKG;IACH,OAAO,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,oBAAoB,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAC1E,gBAAgB,EAAE,CAAC,EACnB,YAAY,EAAE,cAAc,EAC5B,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACvB,IAAI,CAAC;CACR;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,oBAAoB,CAAC,CAAC,SAAS,oBAAoB,CAAC,kBAAkB,CAAC,CAAC,CAAC;IACzF;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,0BAA0B,CAAC,CAAC;IAE3D;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,wBAAwB,CAAC,CAAC,CAAC,CAAC;CACpD;AA8FD;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAC5B,CAAC,SAAS,oBAAoB,CAAC,kBAAkB,CAAC,CAAC,CAAC,EACpD,GAAG,SAAS,MAAM,GAAG,MAAM,EAE3B,oBAAoB,EAAE,OAAO,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC,GACzD,aAAa,CAAC,cAAc,CAC9B,GAAG,EACH,aAAa,CAAC,kBAAkB,CAAC,aAAa,CAAC,gBAAgB,CAAC,EAChE,oBAAoB,CAAC,CAAC,CAAC,CACvB,CAuBA"}

package/lib/notificationsManager.js

@@ -0,0 +1,78 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { datastoreFromHandle } from "./stateDatastore.js";
+import { brandIVM } from "./valueManager.js";
+import { createEmitter } from "@fluidframework/presence/internal/events";
+/**
+ * Object.keys retyped to support specific records keys and
+ * branded string-based keys.
+ */
+const recordKeys = Object.keys;
+class NotificationsManagerImpl {
+    constructor(key, datastore, initialSubscriptions) {
+        this.key = key;
+        this.datastore = datastore;
+        this.events = createEmitter();
+        this.emit = {
+            broadcast: (name, ...args) => {
+                this.datastore.localUpdate(this.key, 
+                // @ts-expect-error TODO
+                { rev: 0, timestamp: 0, value: { name, args: [...args] }, ignoreUnmonitored: true }, true);
+            },
+            unicast: (name, targetClient, ...args) => {
+                this.datastore.localUpdate(this.key, 
+                // @ts-expect-error TODO
+                { rev: 0, timestamp: 0, value: { name, args: [...args] }, ignoreUnmonitored: true }, targetClient);
+            },
+        };
+        // Workaround for types
+        this.notificationsInternal = 
+        // @ts-expect-error TODO
+        createEmitter();
+        // @ts-expect-error TODO
+        this.notifications = this.notificationsInternal;
+        // Add event listeners provided at instantiation
+        for (const subscriptionName of recordKeys(initialSubscriptions)) {
+            // Lingering Event typing issues with Notifications specialization requires
+            // this cast. The only thing that really matters is that name is a string.
+            const name = subscriptionName;
+            const value = initialSubscriptions[subscriptionName];
+            // This check should not be needed while using exactOptionalPropertyTypes, but
+            // typescript appears to ignore that with Partial<>. Good to be defensive
+            // against callers sending `undefined` anyway.
+            if (value !== undefined) {
+                this.notificationsInternal.on(name, value);
+            }
+        }
+    }
+    update(client, _received, value) {
+        const eventName = value.value.name;
+        if (this.notificationsInternal.hasListeners(eventName)) {
+            // Without schema validation, we don't know that the args are the correct type.
+            // For now we assume the user is sending the correct types and there is no corruption along the way.
+            const args = [client, ...value.value.args];
+            this.notificationsInternal.emit(eventName, ...args);
+        }
+        else {
+            this.events.emit("unattendedNotification", value.value.name, client, ...value.value.args);
+        }
+    }
+}
+/**
+ * Factory for creating a {@link NotificationsManager}.
+ *
+ * @remarks
+ * Typescript inference for `Notifications` is not working correctly yet.
+ * Explicitly specify generics to make result types usable.
+ *
+ * @alpha
+ */
+export function Notifications(initialSubscriptions) {
+    const factory = (key, datastoreHandle) => ({
+        manager: brandIVM(new NotificationsManagerImpl(key, datastoreFromHandle(datastoreHandle), initialSubscriptions)),
+    });
+    return Object.assign(factory, { instanceBase: NotificationsManagerImpl });
+}
+//# sourceMappingURL=notificationsManager.js.map

package/lib/notificationsManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notificationsManager.js","sourceRoot":"","sources":["../src/notificationsManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,mBAAmB,EAAuB,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAG7C,OAAO,EAAE,aAAa,EAAE,MAAM,0CAA0C,CAAC;AAoHzE;;;GAGG;AACH,MAAM,UAAU,GAAG,MAAM,CAAC,IAAiE,CAAC;AAE5F,MAAM,wBAAwB;IAuC7B,YACkB,GAAQ,EACR,SAGhB,EACD,oBAA2D;QAL1C,QAAG,GAAH,GAAG,CAAK;QACR,cAAS,GAAT,SAAS,CAGzB;QAlCc,WAAM,GAAG,aAAa,EAA8B,CAAC;QAErD,SAAI,GAA2B;YAC9C,SAAS,EAAE,CAAC,IAAI,EAAE,GAAG,IAAI,EAAE,EAAE;gBAC5B,IAAI,CAAC,SAAS,CAAC,WAAW,CACzB,IAAI,CAAC,GAAG;gBACR,wBAAwB;gBACxB,EAAE,GAAG,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,EAAE,EAAE,iBAAiB,EAAE,IAAI,EAAE,EACnF,IAAI,CACJ,CAAC;YACH,CAAC;YACD,OAAO,EAAE,CAAC,IAAI,EAAE,YAAY,EAAE,GAAG,IAAI,EAAE,EAAE;gBACxC,IAAI,CAAC,SAAS,CAAC,WAAW,CACzB,IAAI,CAAC,GAAG;gBACR,wBAAwB;gBACxB,EAAE,GAAG,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,EAAE,EAAE,iBAAiB,EAAE,IAAI,EAAE,EACnF,YAAY,CACZ,CAAC;YACH,CAAC;SACD,CAAC;QAEF,uBAAuB;QACN,0BAAqB;QACrC,wBAAwB;QACxB,aAAa,EAAgC,CAAC;QAE/C,wBAAwB;QACR,kBAAa,GAAgC,IAAI,CAAC,qBAAqB,CAAC;QAUvF,gDAAgD;QAChD,KAAK,MAAM,gBAAgB,IAAI,UAAU,CAAC,oBAAoB,CAAC,EAAE,CAAC;YACjE,2EAA2E;YAC3E,0EAA0E;YAC1E,MAAM,IAAI,GAAG,gBAA8D,CAAC;YAC5E,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;IAEM,MAAM,CACZ,MAAsB,EACtB,SAAiB,EACjB,KAAuE;QAEvE,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,IAAkD,CAAC;QACjF,IAAI,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,CAAC;YACxD,+EAA+E;YAC/E,oGAAoG;YACpG,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAExC,CAAC;YACF,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,IAAI,CAAC,CAAC;QACrD,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,MAAM,CAAC,IAAI,CACf,wBAAwB,EACxB,KAAK,CAAC,KAAK,CAAC,IAAI,EAChB,MAAM,EACN,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CACnB,CAAC;QACH,CAAC;IACF,CAAC;CACD;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,aAAa,CAI5B,oBAA2D;IAM3D,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 type { ValueManager } from \"./internalTypes.js\";\nimport type { ISessionClient } from \"./presence.js\";\nimport { datastoreFromHandle, type StateDatastore } from \"./stateDatastore.js\";\nimport { brandIVM } from \"./valueManager.js\";\n\nimport type { Events, ISubscribable } from \"@fluidframework/presence/internal/events\";\nimport { createEmitter } from \"@fluidframework/presence/internal/events\";\nimport type { InternalTypes } from \"@fluidframework/presence/internal/exposedInternalTypes\";\nimport type { InternalUtilityTypes } from \"@fluidframework/presence/internal/exposedUtilityTypes\";\n\n/**\n * @sealed\n * @alpha\n */\nexport interface NotificationsManagerEvents {\n\t/**\n\t * Raised when notification is received, but no subscribers were found.\n\t *\n\t * @eventProperty\n\t */\n\tunattendedNotification: (\n\t\tname: string,\n\t\tsender: ISessionClient,\n\t\t...content: unknown[]\n\t) => void;\n}\n\n/**\n * An object which allows the registration of listeners so that subscribers can be\n * notified when a notification happens.\n *\n * @sealed\n * @alpha\n */\nexport interface NotificationSubscribable<\n\tE extends InternalUtilityTypes.NotificationEvents<E>,\n> {\n\t/**\n\t * Register a notification listener.\n\t * @param notificationName - the name of the notification\n\t * @param listener - the handler to run when the notification is received from other client\n\t * @returns a function which will deregister the listener when run. This function\n\t * has undefined behavior if called more than once.\n\t */\n\ton<K extends keyof InternalUtilityTypes.NotificationEvents<E>>(\n\t\tnotificationName: K,\n\t\tlistener: (\n\t\t\tsender: ISessionClient,\n\t\t\t...args: InternalUtilityTypes.JsonDeserializedParameters<E[K]>\n\t\t) => void,\n\t): () => void;\n}\n\n/**\n * Record of notification subscriptions.\n *\n * @sealed\n * @alpha\n */\nexport type NotificationSubscriptions<E extends InternalUtilityTypes.NotificationEvents<E>> = {\n\t[K in string & keyof InternalUtilityTypes.NotificationEvents<E>]: (\n\t\tsender: ISessionClient,\n\t\t...args: InternalUtilityTypes.JsonDeserializedParameters<E[K]>\n\t) => void;\n};\n\n/**\n * Interface for a notification emitter that can send typed notification to other clients.\n *\n * @sealed\n * @alpha\n */\nexport interface NotificationEmitter<E extends InternalUtilityTypes.NotificationEvents<E>> {\n\t/**\n\t * Emits a notification with the specified name and arguments, notifying all clients.\n\t * @param notificationName - the name of the notification to fire\n\t * @param args - the arguments sent with the notification\n\t */\n\tbroadcast<K extends string & keyof InternalUtilityTypes.NotificationEvents<E>>(\n\t\tnotificationName: K,\n\t\t...args: Parameters<E[K]>\n\t): void;\n\n\t/**\n\t * Emits a notification with the specified name and arguments, notifying a single client.\n\t * @param notificationName - the name of the notification to fire\n\t * @param targetClient - the single client to notify\n\t * @param args - the arguments sent with the notification\n\t */\n\tunicast<K extends string & keyof InternalUtilityTypes.NotificationEvents<E>>(\n\t\tnotificationName: K,\n\t\ttargetClient: ISessionClient,\n\t\t...args: Parameters<E[K]>\n\t): void;\n}\n\n/**\n * Value manager that provides notifications from this client to others and subscription\n * to their notifications.\n *\n * @remarks Create using {@link Notifications} registered to {@link PresenceStates}.\n *\n * @sealed\n * @alpha\n */\nexport interface NotificationsManager<T extends InternalUtilityTypes.NotificationEvents<T>> {\n\t/**\n\t * Events for Notifications manager.\n\t */\n\treadonly events: ISubscribable<NotificationsManagerEvents>;\n\n\t/**\n\t * Send notifications to other clients.\n\t */\n\treadonly emit: NotificationEmitter<T>;\n\n\t/**\n\t * Provides subscription to notifications from other clients.\n\t */\n\treadonly notifications: NotificationSubscribable<T>;\n}\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 InternalUtilityTypes.NotificationEvents<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, ...args) => {\n\t\t\tthis.datastore.localUpdate(\n\t\t\t\tthis.key,\n\t\t\t\t// @ts-expect-error TODO\n\t\t\t\t{ rev: 0, timestamp: 0, value: { name, args: [...args] }, ignoreUnmonitored: true },\n\t\t\t\ttrue,\n\t\t\t);\n\t\t},\n\t\tunicast: (name, targetClient, ...args) => {\n\t\t\tthis.datastore.localUpdate(\n\t\t\t\tthis.key,\n\t\t\t\t// @ts-expect-error TODO\n\t\t\t\t{ rev: 0, timestamp: 0, value: { name, args: [...args] }, ignoreUnmonitored: true },\n\t\t\t\ttargetClient,\n\t\t\t);\n\t\t},\n\t};\n\n\t// Workaround for types\n\tprivate readonly notificationsInternal =\n\t\t// @ts-expect-error TODO\n\t\tcreateEmitter<NotificationSubscriptions<T>>();\n\n\t// @ts-expect-error TODO\n\tpublic readonly notifications: NotificationSubscribable<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<NotificationSubscriptions<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 Events<NotificationSubscriptions<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 update(\n\t\tclient: ISessionClient,\n\t\t_received: number,\n\t\tvalue: InternalTypes.ValueRequiredState<InternalTypes.NotificationType>,\n\t): void {\n\t\tconst eventName = value.value.name as keyof Events<NotificationSubscriptions<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 = [client, ...value.value.args] as Parameters<\n\t\t\t\tNotificationSubscriptions<T>[typeof eventName]\n\t\t\t>;\n\t\t\tthis.notificationsInternal.emit(eventName, ...args);\n\t\t} else {\n\t\t\tthis.events.emit(\n\t\t\t\t\"unattendedNotification\",\n\t\t\t\tvalue.value.name,\n\t\t\t\tclient,\n\t\t\t\t...value.value.args,\n\t\t\t);\n\t\t}\n\t}\n}\n\n/**\n * Factory for creating a {@link NotificationsManager}.\n *\n * @remarks\n * Typescript inference for `Notifications` is not working correctly yet.\n * Explicitly specify generics to make result types usable.\n *\n * @alpha\n */\nexport function Notifications<\n\tT extends InternalUtilityTypes.NotificationEvents<T>,\n\tKey extends string = string,\n>(\n\tinitialSubscriptions: Partial<NotificationSubscriptions<T>>,\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"]}

package/lib/presence.d.ts

@@ -0,0 +1,180 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { SessionId } from "@fluidframework/id-compressor";
+import type { ClientConnectionId } from "./baseTypes.js";
+import type { PresenceNotifications, PresenceNotificationsSchema, PresenceStates, PresenceStatesSchema, PresenceWorkspaceAddress } from "./types.js";
+import type { ISubscribable } from "@fluidframework/presence/internal/events";
+/**
+ * A Fluid client session identifier.
+ *
+ * @remarks
+ * Each client once connected to a session is given a unique identifier for the
+ * duration of the session. If a client disconnects and reconnects, it will
+ * retain its identifier. Prefer use of {@link ISessionClient} as a way to
+ * identify clients in a session. {@link ISessionClient.sessionId} will provide
+ * the session ID.
+ *
+ * @alpha
+ */
+export type ClientSessionId = SessionId & {
+    readonly ClientSessionId: "ClientSessionId";
+};
+/**
+ * The connection status of the {@link ISessionClient}.
+ *
+ * @alpha
+ */
+export declare const SessionClientStatus: {
+    /**
+     * The session client is connected to the Fluid service.
+     */
+    readonly Connected: "Connected";
+    /**
+     * The session client is not connected to the Fluid service.
+     */
+    readonly Disconnected: "Disconnected";
+};
+/**
+ * Represents the connection status of an {@link ISessionClient}.
+ *
+ * This type can be either `'Connected'` or `'Disconnected'`, indicating whether
+ * the session client is currently connected to the Fluid service.
+ *
+ * When `'Disconnected'`:
+ * - State changes are kept locally and communicated to others upon reconnect.
+ * - Notification requests are discarded (silently).
+ *
+ * @alpha
+ */
+export type SessionClientStatus = (typeof SessionClientStatus)[keyof typeof SessionClientStatus];
+/**
+ * A client within a Fluid session (period of container connectivity to service).
+ *
+ * @remarks
+ * Note: This is very preliminary session client representation.
+ *
+ * `ISessionClient` should be used as key to distinguish between different
+ * clients as they join, rejoin, and disconnect from a session. While a
+ * client's {@link ClientConnectionId} from {@link ISessionClient.getConnectionStatus}
+ * may change over time, `ISessionClient` will be fixed.
+ *
+ * @privateRemarks
+ * As this is evolved, pay attention to how this relates to Audience, Service
+ * Audience, and Quorum representations of clients and users.
+ *
+ * @sealed
+ * @alpha
+ */
+export interface ISessionClient<SpecificSessionClientId extends ClientSessionId = ClientSessionId> {
+    /**
+     * The session ID of the client that is stable over all connections.
+     */
+    readonly sessionId: SpecificSessionClientId;
+    /**
+     * Get current client connection ID.
+     *
+     * @returns Current client connection ID.
+     *
+     * @remarks
+     * Connection ID will change on reconnect.
+     *
+     * If {@link ISessionClient.getConnectionStatus} is {@link (SessionClientStatus:variable).Disconnected}, this will represent the last known connection ID.
+     */
+    getConnectionId(): ClientConnectionId;
+    /**
+     * Get connection status of session client.
+     *
+     * @returns Connection status of session client.
+     *
+     */
+    getConnectionStatus(): SessionClientStatus;
+}
+/**
+ * Utility type limiting to a specific session client. (A session client with
+ * a specific session ID - not just any session ID.)
+ *
+ * @internal
+ */
+export type SpecificSessionClient<SpecificSessionClientId extends ClientSessionId> = string extends SpecificSessionClientId ? never : ISessionClient<SpecificSessionClientId>;
+/**
+ * @sealed
+ * @alpha
+ */
+export interface PresenceEvents {
+    /**
+     * Raised when new client joins session.
+     *
+     * @eventProperty
+     */
+    attendeeJoined: (attendee: ISessionClient) => void;
+    /**
+     * Raised when client appears disconnected from session.
+     *
+     * @eventProperty
+     */
+    attendeeDisconnected: (attendee: ISessionClient) => void;
+    /**
+     * Raised when a workspace is activated within the session.
+     *
+     * "Activated" means that a workspace is being used by a client and this
+     * client is seeing information for the first time.
+     *
+     * @remarks
+     * Local workspaces may be passively acquired/registered when this event
+     * is raised. For a notifications workspace, that lazy registration must
+     * be done before the event handler returns to ensure no notifications
+     * are missed.
+     */
+    workspaceActivated: (workspaceAddress: PresenceWorkspaceAddress, type: "States" | "Notifications" | "Unknown") => void;
+}
+/**
+ * Presence represents known clients within a session and their custom states and notifications.
+ *
+ * @sealed
+ * @alpha
+ */
+export interface IPresence {
+    /**
+     * Events for Notifications manager.
+     */
+    readonly events: ISubscribable<PresenceEvents>;
+    /**
+     * Get all attendees in the session.
+     *
+     * @remarks
+     * Attendee states are dynamic and will change as clients join and leave
+     * the session.
+     */
+    getAttendees(): ReadonlySet<ISessionClient>;
+    /**
+     * Lookup a specific attendee in the session.
+     *
+     * @param clientId - Client connection or session ID
+     */
+    getAttendee(clientId: ClientConnectionId | ClientSessionId): ISessionClient;
+    /**
+     * Get this client's session client.
+     *
+     * @returns This client's session client.
+     */
+    getMyself(): ISessionClient;
+    /**
+     * Acquires a PresenceStates workspace from store or adds new one.
+     *
+     * @param workspaceAddress - Address of the requested PresenceStates Workspace
+     * @param requestedContent - Requested states for the workspace
+     * @returns A PresenceStates workspace
+     */
+    getStates<StatesSchema extends PresenceStatesSchema>(workspaceAddress: PresenceWorkspaceAddress, requestedContent: StatesSchema): PresenceStates<StatesSchema>;
+    /**
+     * Acquires a Notifications workspace from store or adds new one.
+     *
+     * @param workspaceAddress - Address of the requested Notifications Workspace
+     * @param requestedContent - Requested notifications for the workspace
+     * @returns A Notifications workspace
+     */
+    getNotifications<NotificationsSchema extends PresenceNotificationsSchema>(notificationsId: PresenceWorkspaceAddress, requestedContent: NotificationsSchema): PresenceNotifications<NotificationsSchema>;
+}
+//# sourceMappingURL=presence.d.ts.map

package/lib/presence.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"presence.d.ts","sourceRoot":"","sources":["../src/presence.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAC;AAE/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,KAAK,EACX,qBAAqB,EACrB,2BAA2B,EAC3B,cAAc,EACd,oBAAoB,EACpB,wBAAwB,EACxB,MAAM,YAAY,CAAC;AAEpB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0CAA0C,CAAC;AAE9E;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG;IAAE,QAAQ,CAAC,eAAe,EAAE,iBAAiB,CAAA;CAAE,CAAC;AAE1F;;;;GAIG;AACH,eAAO,MAAM,mBAAmB;IAC/B;;OAEG;;IAGH;;OAEG;;CAEM,CAAC;AAEX;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,mBAAmB,GAC9B,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,OAAO,mBAAmB,CAAC,CAAC;AAEhE;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,cAAc,CAC9B,uBAAuB,SAAS,eAAe,GAAG,eAAe;IAEjE;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,uBAAuB,CAAC;IAE5C;;;;;;;;;OASG;IACH,eAAe,IAAI,kBAAkB,CAAC;IAEtC;;;;;OAKG;IACH,mBAAmB,IAAI,mBAAmB,CAAC;CAC3C;AAED;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,CAAC,uBAAuB,SAAS,eAAe,IAChF,MAAM,SAAS,uBAAuB,GAAG,KAAK,GAAG,cAAc,CAAC,uBAAuB,CAAC,CAAC;AAE1F;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B;;;;OAIG;IACH,cAAc,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAC;IAEnD;;;;OAIG;IACH,oBAAoB,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAC;IAEzD;;;;;;;;;;;OAWG;IACH,kBAAkB,EAAE,CACnB,gBAAgB,EAAE,wBAAwB,EAC1C,IAAI,EAAE,QAAQ,GAAG,eAAe,GAAG,SAAS,KACxC,IAAI,CAAC;CACV;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACzB;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;IAE/C;;;;;;OAMG;IACH,YAAY,IAAI,WAAW,CAAC,cAAc,CAAC,CAAC;IAE5C;;;;OAIG;IACH,WAAW,CAAC,QAAQ,EAAE,kBAAkB,GAAG,eAAe,GAAG,cAAc,CAAC;IAE5E;;;;OAIG;IACH,SAAS,IAAI,cAAc,CAAC;IAE5B;;;;;;OAMG;IACH,SAAS,CAAC,YAAY,SAAS,oBAAoB,EAClD,gBAAgB,EAAE,wBAAwB,EAC1C,gBAAgB,EAAE,YAAY,GAC5B,cAAc,CAAC,YAAY,CAAC,CAAC;IAEhC;;;;;;OAMG;IACH,gBAAgB,CAAC,mBAAmB,SAAS,2BAA2B,EACvE,eAAe,EAAE,wBAAwB,EACzC,gBAAgB,EAAE,mBAAmB,GACnC,qBAAqB,CAAC,mBAAmB,CAAC,CAAC;CAC9C"}

package/lib/presence.js

@@ -0,0 +1,20 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * The connection status of the {@link ISessionClient}.
+ *
+ * @alpha
+ */
+export const SessionClientStatus = {
+    /**
+     * The session client is connected to the Fluid service.
+     */
+    Connected: "Connected",
+    /**
+     * The session client is not connected to the Fluid service.
+     */
+    Disconnected: "Disconnected",
+};
+//# sourceMappingURL=presence.js.map

package/lib/presence.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"presence.js","sourceRoot":"","sources":["../src/presence.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA6BH;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IAClC;;OAEG;IACH,SAAS,EAAE,WAAW;IAEtB;;OAEG;IACH,YAAY,EAAE,cAAc;CACnB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { SessionId } from \"@fluidframework/id-compressor\";\n\nimport type { ClientConnectionId } from \"./baseTypes.js\";\nimport type {\n\tPresenceNotifications,\n\tPresenceNotificationsSchema,\n\tPresenceStates,\n\tPresenceStatesSchema,\n\tPresenceWorkspaceAddress,\n} from \"./types.js\";\n\nimport type { ISubscribable } from \"@fluidframework/presence/internal/events\";\n\n/**\n * A Fluid client session identifier.\n *\n * @remarks\n * Each client once connected to a session is given a unique identifier for the\n * duration of the session. If a client disconnects and reconnects, it will\n * retain its identifier. Prefer use of {@link ISessionClient} as a way to\n * identify clients in a session. {@link ISessionClient.sessionId} will provide\n * the session ID.\n *\n * @alpha\n */\nexport type ClientSessionId = SessionId & { readonly ClientSessionId: \"ClientSessionId\" };\n\n/**\n * The connection status of the {@link ISessionClient}.\n *\n * @alpha\n */\nexport const SessionClientStatus = {\n\t/**\n\t * The session client is connected to the Fluid service.\n\t */\n\tConnected: \"Connected\",\n\n\t/**\n\t * The session client is not connected to the Fluid service.\n\t */\n\tDisconnected: \"Disconnected\",\n} as const;\n\n/**\n * Represents the connection status of an {@link ISessionClient}.\n *\n * This type can be either `'Connected'` or `'Disconnected'`, indicating whether\n * the session client is currently connected to the Fluid service.\n *\n * When `'Disconnected'`:\n * - State changes are kept locally and communicated to others upon reconnect.\n * - Notification requests are discarded (silently).\n *\n * @alpha\n */\nexport type SessionClientStatus =\n\t(typeof SessionClientStatus)[keyof typeof SessionClientStatus];\n\n/**\n * A client within a Fluid session (period of container connectivity to service).\n *\n * @remarks\n * Note: This is very preliminary session client representation.\n *\n * `ISessionClient` should be used as key to distinguish between different\n * clients as they join, rejoin, and disconnect from a session. While a\n * client's {@link ClientConnectionId} from {@link ISessionClient.getConnectionStatus}\n * may change over time, `ISessionClient` will be fixed.\n *\n * @privateRemarks\n * As this is evolved, pay attention to how this relates to Audience, Service\n * Audience, and Quorum representations of clients and users.\n *\n * @sealed\n * @alpha\n */\nexport interface ISessionClient<\n\tSpecificSessionClientId extends ClientSessionId = ClientSessionId,\n> {\n\t/**\n\t * The session ID of the client that is stable over all connections.\n\t */\n\treadonly sessionId: SpecificSessionClientId;\n\n\t/**\n\t * Get current client connection ID.\n\t *\n\t * @returns Current client connection ID.\n\t *\n\t * @remarks\n\t * Connection ID will change on reconnect.\n\t *\n\t * If {@link ISessionClient.getConnectionStatus} is {@link (SessionClientStatus:variable).Disconnected}, this will represent the last known connection ID.\n\t */\n\tgetConnectionId(): ClientConnectionId;\n\n\t/**\n\t * Get connection status of session client.\n\t *\n\t * @returns Connection status of session client.\n\t *\n\t */\n\tgetConnectionStatus(): SessionClientStatus;\n}\n\n/**\n * Utility type limiting to a specific session client. (A session client with\n * a specific session ID - not just any session ID.)\n *\n * @internal\n */\nexport type SpecificSessionClient<SpecificSessionClientId extends ClientSessionId> =\n\tstring extends SpecificSessionClientId ? never : ISessionClient<SpecificSessionClientId>;\n\n/**\n * @sealed\n * @alpha\n */\nexport interface PresenceEvents {\n\t/**\n\t * Raised when new client joins session.\n\t *\n\t * @eventProperty\n\t */\n\tattendeeJoined: (attendee: ISessionClient) => void;\n\n\t/**\n\t * Raised when client appears disconnected from session.\n\t *\n\t * @eventProperty\n\t */\n\tattendeeDisconnected: (attendee: ISessionClient) => void;\n\n\t/**\n\t * Raised when a workspace is activated within the session.\n\t *\n\t * \"Activated\" means that a workspace is being used by a client and this\n\t * client is seeing information for the first time.\n\t *\n\t * @remarks\n\t * Local workspaces may be passively acquired/registered when this event\n\t * is raised. For a notifications workspace, that lazy registration must\n\t * be done before the event handler returns to ensure no notifications\n\t * are missed.\n\t */\n\tworkspaceActivated: (\n\t\tworkspaceAddress: PresenceWorkspaceAddress,\n\t\ttype: \"States\" | \"Notifications\" | \"Unknown\",\n\t) => void;\n}\n\n/**\n * Presence represents known clients within a session and their custom states and notifications.\n *\n * @sealed\n * @alpha\n */\nexport interface IPresence {\n\t/**\n\t * Events for Notifications manager.\n\t */\n\treadonly events: ISubscribable<PresenceEvents>;\n\n\t/**\n\t * Get all attendees in the session.\n\t *\n\t * @remarks\n\t * Attendee states are dynamic and will change as clients join and leave\n\t * the session.\n\t */\n\tgetAttendees(): ReadonlySet<ISessionClient>;\n\n\t/**\n\t * Lookup a specific attendee in the session.\n\t *\n\t * @param clientId - Client connection or session ID\n\t */\n\tgetAttendee(clientId: ClientConnectionId | ClientSessionId): ISessionClient;\n\n\t/**\n\t * Get this client's session client.\n\t *\n\t * @returns This client's session client.\n\t */\n\tgetMyself(): ISessionClient;\n\n\t/**\n\t * Acquires a PresenceStates workspace from store or adds new one.\n\t *\n\t * @param workspaceAddress - Address of the requested PresenceStates Workspace\n\t * @param requestedContent - Requested states for the workspace\n\t * @returns A PresenceStates workspace\n\t */\n\tgetStates<StatesSchema extends PresenceStatesSchema>(\n\t\tworkspaceAddress: PresenceWorkspaceAddress,\n\t\trequestedContent: StatesSchema,\n\t): PresenceStates<StatesSchema>;\n\n\t/**\n\t * Acquires a Notifications workspace from store or adds new one.\n\t *\n\t * @param workspaceAddress - Address of the requested Notifications Workspace\n\t * @param requestedContent - Requested notifications for the workspace\n\t * @returns A Notifications workspace\n\t */\n\tgetNotifications<NotificationsSchema extends PresenceNotificationsSchema>(\n\t\tnotificationsId: PresenceWorkspaceAddress,\n\t\trequestedContent: NotificationsSchema,\n\t): PresenceNotifications<NotificationsSchema>;\n}\n"]}

package/lib/presenceDatastoreManager.d.ts

@@ -0,0 +1,91 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { IInboundSignalMessage } from "@fluidframework/runtime-definitions/internal";
+import type { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
+import type { ClientConnectionId } from "./baseTypes.js";
+import type { IEphemeralRuntime } from "./internalTypes.js";
+import type { ClientSessionId, ISessionClient } from "./presence.js";
+import type { ClientUpdateEntry, PresenceStatesInternal } from "./presenceStates.js";
+import type { SystemWorkspaceDatastore } from "./systemWorkspace.js";
+import type { PresenceStates, PresenceStatesSchema, PresenceWorkspaceAddress } from "./types.js";
+import type { IExtensionMessage } from "@fluidframework/presence/internal/container-definitions/internal";
+interface PresenceStatesEntry<TSchema extends PresenceStatesSchema> {
+    public: PresenceStates<TSchema>;
+    internal: PresenceStatesInternal;
+}
+interface SystemDatastore {
+    "system:presence": SystemWorkspaceDatastore;
+}
+type InternalWorkspaceAddress = `${"s" | "n"}:${PresenceWorkspaceAddress}`;
+interface GeneralDatastoreMessageContent {
+    [WorkspaceAddress: string]: {
+        [StateValueManagerKey: string]: {
+            [ClientSessionId: ClientSessionId]: ClientUpdateEntry;
+        };
+    };
+}
+type DatastoreMessageContent = SystemDatastore & GeneralDatastoreMessageContent;
+declare const datastoreUpdateMessageType = "Pres:DatastoreUpdate";
+interface DatastoreUpdateMessage extends IInboundSignalMessage {
+    type: typeof datastoreUpdateMessageType;
+    content: {
+        sendTimestamp: number;
+        avgLatency: number;
+        isComplete?: true;
+        data: DatastoreMessageContent;
+    };
+}
+declare const joinMessageType = "Pres:ClientJoin";
+interface ClientJoinMessage extends IInboundSignalMessage {
+    type: typeof joinMessageType;
+    content: {
+        updateProviders: ClientConnectionId[];
+        sendTimestamp: number;
+        avgLatency: number;
+        data: DatastoreMessageContent;
+    };
+}
+/**
+ * @internal
+ */
+export interface PresenceDatastoreManager {
+    joinSession(clientId: ClientConnectionId): void;
+    getWorkspace<TSchema extends PresenceStatesSchema>(internalWorkspaceAddress: InternalWorkspaceAddress, requestedContent: TSchema): PresenceStates<TSchema>;
+    processSignal(message: IExtensionMessage, local: boolean): void;
+}
+/**
+ * Manages singleton datastore for all Presence.
+ */
+export declare class PresenceDatastoreManagerImpl implements PresenceDatastoreManager {
+    private readonly clientSessionId;
+    private readonly runtime;
+    private readonly lookupClient;
+    private readonly logger;
+    private readonly datastore;
+    private averageLatency;
+    private returnedMessages;
+    private refreshBroadcastRequested;
+    private readonly workspaces;
+    constructor(clientSessionId: ClientSessionId, runtime: IEphemeralRuntime, lookupClient: (clientId: ClientSessionId) => ISessionClient, logger: ITelemetryLoggerExt | undefined, systemWorkspaceDatastore: SystemWorkspaceDatastore, systemWorkspace: PresenceStatesEntry<PresenceStatesSchema>);
+    joinSession(clientId: ClientConnectionId): void;
+    getWorkspace<TSchema extends PresenceStatesSchema>(internalWorkspaceAddress: InternalWorkspaceAddress, requestedContent: TSchema): PresenceStates<TSchema>;
+    private localUpdate;
+    private broadcastAllKnownState;
+    processSignal(message: IInboundSignalMessage | DatastoreUpdateMessage | ClientJoinMessage, local: boolean): void;
+    /**
+     * Handles responding to another client joining the session.
+     *
+     * @param updateProviders - list of client connection id's that requestor selected
+     * to provide response
+     * @param requestor - `requestor` is only used in telemetry. While it is the requestor's
+     * client connection id, that is not most important. It is important that this is a
+     * unique shared id across all clients that might respond as we want to monitor the
+     * response patterns. The convenience of being client connection id will allow
+     * correlation with other telemetry where it is often called just `clientId`.
+     */
+    private prepareJoinResponse;
+}
+export {};
+//# sourceMappingURL=presenceDatastoreManager.d.ts.map

package/lib/presenceDatastoreManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"presenceDatastoreManager.d.ts","sourceRoot":"","sources":["../src/presenceDatastoreManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8CAA8C,CAAC;AAC1F,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AAEpF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AACrE,OAAO,KAAK,EACX,iBAAiB,EACjB,sBAAsB,EAEtB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AACrE,OAAO,KAAK,EACX,cAAc,EACd,oBAAoB,EACpB,wBAAwB,EACxB,MAAM,YAAY,CAAC;AAEpB,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kEAAkE,CAAC;AAE1G,UAAU,mBAAmB,CAAC,OAAO,SAAS,oBAAoB;IACjE,MAAM,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;IAChC,QAAQ,EAAE,sBAAsB,CAAC;CACjC;AAED,UAAU,eAAe;IACxB,iBAAiB,EAAE,wBAAwB,CAAC;CAC5C;AAED,KAAK,wBAAwB,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,wBAAwB,EAAE,CAAC;AAM3E,UAAU,8BAA8B;IACvC,CAAC,gBAAgB,EAAE,MAAM,GAAG;QAC3B,CAAC,oBAAoB,EAAE,MAAM,GAAG;YAC/B,CAAC,eAAe,EAAE,eAAe,GAAG,iBAAiB,CAAC;SACtD,CAAC;KACF,CAAC;CACF;AAED,KAAK,uBAAuB,GAAG,eAAe,GAAG,8BAA8B,CAAC;AAEhF,QAAA,MAAM,0BAA0B,yBAAyB,CAAC;AAC1D,UAAU,sBAAuB,SAAQ,qBAAqB;IAC7D,IAAI,EAAE,OAAO,0BAA0B,CAAC;IACxC,OAAO,EAAE;QACR,aAAa,EAAE,MAAM,CAAC;QACtB,UAAU,EAAE,MAAM,CAAC;QACnB,UAAU,CAAC,EAAE,IAAI,CAAC;QAClB,IAAI,EAAE,uBAAuB,CAAC;KAC9B,CAAC;CACF;AAED,QAAA,MAAM,eAAe,oBAAoB,CAAC;AAC1C,UAAU,iBAAkB,SAAQ,qBAAqB;IACxD,IAAI,EAAE,OAAO,eAAe,CAAC;IAC7B,OAAO,EAAE;QACR,eAAe,EAAE,kBAAkB,EAAE,CAAC;QACtC,aAAa,EAAE,MAAM,CAAC;QACtB,UAAU,EAAE,MAAM,CAAC;QACnB,IAAI,EAAE,uBAAuB,CAAC;KAC9B,CAAC;CACF;AAQD;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACxC,WAAW,CAAC,QAAQ,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAChD,YAAY,CAAC,OAAO,SAAS,oBAAoB,EAChD,wBAAwB,EAAE,wBAAwB,EAClD,gBAAgB,EAAE,OAAO,GACvB,cAAc,CAAC,OAAO,CAAC,CAAC;IAC3B,aAAa,CAAC,OAAO,EAAE,iBAAiB,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;CAChE;AAED;;GAEG;AACH,qBAAa,4BAA6B,YAAW,wBAAwB;IAS3E,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,MAAM;IAXxB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;IAC9C,OAAO,CAAC,cAAc,CAAK;IAC3B,OAAO,CAAC,gBAAgB,CAAK;IAC7B,OAAO,CAAC,yBAAyB,CAAS;IAE1C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgE;gBAGzE,eAAe,EAAE,eAAe,EAChC,OAAO,EAAE,iBAAiB,EAC1B,YAAY,EAAE,CAAC,QAAQ,EAAE,eAAe,KAAK,cAAc,EAC3D,MAAM,EAAE,mBAAmB,GAAG,SAAS,EACxD,wBAAwB,EAAE,wBAAwB,EAClD,eAAe,EAAE,mBAAmB,CAAC,oBAAoB,CAAC;IAOpD,WAAW,CAAC,QAAQ,EAAE,kBAAkB,GAAG,IAAI;IAkB/C,YAAY,CAAC,OAAO,SAAS,oBAAoB,EACvD,wBAAwB,EAAE,wBAAwB,EAClD,gBAAgB,EAAE,OAAO,GACvB,cAAc,CAAC,OAAO,CAAC;IA4D1B,OAAO,CAAC,WAAW;IAUnB,OAAO,CAAC,sBAAsB;IAUvB,aAAa,CAOnB,OAAO,EAAE,qBAAqB,GAAG,sBAAsB,GAAG,iBAAiB,EAC3E,KAAK,EAAE,OAAO,GACZ,IAAI;IAkEP;;;;;;;;;;OAUG;IACH,OAAO,CAAC,mBAAmB;CAgE3B"}