@fluidframework/presence 2.10.0-307399

package/dist/exposedUtilityTypes.d.ts

@@ -0,0 +1,63 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { InternalUtilityTypes as CoreInternalUtilityTypes, JsonDeserialized, JsonSerializable } from "@fluidframework/presence/internal/core-interfaces";
+/**
+ * Collection of utility types that are not intended to be used/imported
+ * directly outside of this package.
+ *
+ * @alpha
+ * @system
+ */
+export declare namespace InternalUtilityTypes {
+    /**
+     * Recursively/deeply makes all properties of a type readonly.
+     *
+     * @system
+     */
+    type FullyReadonly<T> = {
+        readonly [K in keyof T]: FullyReadonly<T[K]>;
+    };
+    /**
+     * `true` iff the given type is an acceptable shape for a notification.
+     *
+     * @system
+     */
+    type IsNotificationEvent<Event> = Event extends (...args: infer P) => void ? CoreInternalUtilityTypes.IfSameType<P, JsonSerializable<P> & JsonDeserialized<P>, true, false> : false;
+    /**
+     * Used to specify the kinds of notifications emitted by a {@link NotificationSubscribable}.
+     *
+     * @remarks
+     *
+     * Any object type is a valid NotificationEvents, but only the notification-like
+     * properties of that type will be included.
+     *
+     * @example
+     *
+     * ```typescript
+     * interface MyNotifications {
+     *   load: (user: string, data: IUserData) => void;
+     *   requestPause: (period: number) => void;
+     * }
+     * ```
+     *
+     * @system
+     */
+    type NotificationEvents<E> = {
+        [P in string & keyof E as IsNotificationEvent<E[P]> extends true ? P : never]: E[P];
+    };
+    /**
+     * {@link @fluidframework/core-interfaces#JsonDeserialized} version of the parameters of a function.
+     *
+     * @system
+     */
+    type JsonDeserializedParameters<T extends (...args: any) => any> = T extends (...args: infer P) => any ? JsonDeserialized<P> : never;
+    /**
+     * {@link @fluidframework/core-interfaces#JsonSerializable} version of the parameters of a function.
+     *
+     * @system
+     */
+    type JsonSerializableParameters<T extends (...args: any) => any> = T extends (...args: infer P) => any ? JsonSerializable<P> : never;
+}
+//# sourceMappingURL=exposedUtilityTypes.d.ts.map

package/dist/exposedUtilityTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exposedUtilityTypes.d.ts","sourceRoot":"","sources":["../src/exposedUtilityTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,oBAAoB,IAAI,wBAAwB,EAChD,gBAAgB,EAChB,gBAAgB,EAChB,MAAM,mDAAmD,CAAC;AAE3D;;;;;;GAMG;AAEH,yBAAiB,oBAAoB,CAAC;IACrC;;;;OAIG;IACH,KAAY,aAAa,CAAC,CAAC,IAAI;QAC9B,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAC5C,CAAC;IAEF;;;;OAIG;IACH,KAAY,mBAAmB,CAAC,KAAK,IAAI,KAAK,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,KAAK,IAAI,GAC9E,wBAAwB,CAAC,UAAU,CACnC,CAAC,EACD,gBAAgB,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,EACzC,IAAI,EACJ,KAAK,CACL,GACA,KAAK,CAAC;IAET;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAY,kBAAkB,CAAC,CAAC,IAAI;SAClC,CAAC,IAAI,MAAM,GAAG,MAAM,CAAC,IAAI,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;KACnF,CAAC;IAEF;;;;OAIG;IACH,KAAY,0BAA0B,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,IAAI,CAAC,SAAS,CACnF,GAAG,IAAI,EAAE,MAAM,CAAC,KACZ,GAAG,GACL,gBAAgB,CAAC,CAAC,CAAC,GACnB,KAAK,CAAC;IAET;;;;OAIG;IACH,KAAY,0BAA0B,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,IAAI,CAAC,SAAS,CACnF,GAAG,IAAI,EAAE,MAAM,CAAC,KACZ,GAAG,GACL,gBAAgB,CAAC,CAAC,CAAC,GACnB,KAAK,CAAC;CACT"}

package/dist/exposedUtilityTypes.js

@@ -0,0 +1,7 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=exposedUtilityTypes.js.map

package/dist/exposedUtilityTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exposedUtilityTypes.js","sourceRoot":"","sources":["../src/exposedUtilityTypes.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 {\n\tInternalUtilityTypes as CoreInternalUtilityTypes,\n\tJsonDeserialized,\n\tJsonSerializable,\n} from \"@fluidframework/presence/internal/core-interfaces\";\n\n/**\n * Collection of utility types that are not intended to be used/imported\n * directly outside of this package.\n *\n * @alpha\n * @system\n */\n// eslint-disable-next-line @typescript-eslint/no-namespace\nexport namespace InternalUtilityTypes {\n\t/**\n\t * Recursively/deeply makes all properties of a type readonly.\n\t *\n\t * @system\n\t */\n\texport type FullyReadonly<T> = {\n\t\treadonly [K in keyof T]: FullyReadonly<T[K]>;\n\t};\n\n\t/**\n\t * `true` iff the given type is an acceptable shape for a notification.\n\t *\n\t * @system\n\t */\n\texport type IsNotificationEvent<Event> = Event extends (...args: infer P) => void\n\t\t? CoreInternalUtilityTypes.IfSameType<\n\t\t\t\tP,\n\t\t\t\tJsonSerializable<P> & JsonDeserialized<P>,\n\t\t\t\ttrue,\n\t\t\t\tfalse\n\t\t\t>\n\t\t: false;\n\n\t/**\n\t * Used to specify the kinds of notifications emitted by a {@link NotificationSubscribable}.\n\t *\n\t * @remarks\n\t *\n\t * Any object type is a valid NotificationEvents, but only the notification-like\n\t * properties of that type will be included.\n\t *\n\t * @example\n\t *\n\t * ```typescript\n\t * interface MyNotifications {\n\t *   load: (user: string, data: IUserData) => void;\n\t *   requestPause: (period: number) => void;\n\t * }\n\t * ```\n\t *\n\t * @system\n\t */\n\texport type NotificationEvents<E> = {\n\t\t[P in string & keyof E as IsNotificationEvent<E[P]> extends true ? P : never]: E[P];\n\t};\n\n\t/**\n\t * {@link @fluidframework/core-interfaces#JsonDeserialized} version of the parameters of a function.\n\t *\n\t * @system\n\t */\n\texport type JsonDeserializedParameters<T extends (...args: any) => any> = T extends (\n\t\t...args: infer P\n\t) => any\n\t\t? JsonDeserialized<P>\n\t\t: never;\n\n\t/**\n\t * {@link @fluidframework/core-interfaces#JsonSerializable} version of the parameters of a function.\n\t *\n\t * @system\n\t */\n\texport type JsonSerializableParameters<T extends (...args: any) => any> = T extends (\n\t\t...args: infer P\n\t) => any\n\t\t? JsonSerializable<P>\n\t\t: never;\n}\n"]}

package/dist/index.d.ts

@@ -0,0 +1,22 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Experimental package for client presence within a connected session.
+ *
+ * See {@link https://github.com/microsoft/FluidFramework/tree/main/packages/framework/presence#readme | README.md } for an overview of the package.
+ *
+ * @packageDocumentation
+ */
+export type { ClientConnectionId } from "./baseTypes.js";
+export type { PresenceNotifications, PresenceNotificationsSchema, PresenceStates, PresenceStatesEntries, PresenceStatesEntry, PresenceStatesSchema, PresenceWorkspaceAddress, } from "./types.js";
+export { type ClientSessionId, type IPresence, type ISessionClient, type PresenceEvents, SessionClientStatus, } from "./presence.js";
+export { acquirePresence } from "./experimentalAccess.js";
+export { acquirePresenceViaDataObject, type ExperimentalPresenceDO, ExperimentalPresenceManager, } from "./datastorePresenceManagerFactory.js";
+export type { LatestValueControls } from "./latestValueControls.js";
+export { LatestMap, type LatestMapItemRemovedClientData, type LatestMapItemValueClientData, type LatestMapValueClientData, type LatestMapValueManager, type LatestMapValueManagerEvents, type ValueMap, } from "./latestMapValueManager.js";
+export { Latest, type LatestValueManager, type LatestValueManagerEvents, } from "./latestValueManager.js";
+export type { LatestValueClientData, LatestValueData, LatestValueMetadata, } from "./latestValueTypes.js";
+export { type NotificationEmitter, type NotificationSubscribable, type NotificationSubscriptions, Notifications, type NotificationsManager, type NotificationsManagerEvents, } from "./notificationsManager.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;GAMG;AAgBH,YAAY,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAEzD,YAAY,EACX,qBAAqB,EACrB,2BAA2B,EAC3B,cAAc,EACd,qBAAqB,EACrB,mBAAmB,EACnB,oBAAoB,EACpB,wBAAwB,GACxB,MAAM,YAAY,CAAC;AAEpB,OAAO,EACN,KAAK,eAAe,EACpB,KAAK,SAAS,EACd,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,mBAAmB,GACnB,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE1D,OAAO,EACN,4BAA4B,EAC5B,KAAK,sBAAsB,EAC3B,2BAA2B,GAC3B,MAAM,sCAAsC,CAAC;AAE9C,YAAY,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,EACN,SAAS,EACT,KAAK,8BAA8B,EACnC,KAAK,4BAA4B,EACjC,KAAK,wBAAwB,EAC7B,KAAK,qBAAqB,EAC1B,KAAK,2BAA2B,EAChC,KAAK,QAAQ,GACb,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACN,MAAM,EACN,KAAK,kBAAkB,EACvB,KAAK,wBAAwB,GAC7B,MAAM,yBAAyB,CAAC;AACjC,YAAY,EACX,qBAAqB,EACrB,eAAe,EACf,mBAAmB,GACnB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EACN,KAAK,mBAAmB,EACxB,KAAK,wBAAwB,EAC7B,KAAK,yBAAyB,EAC9B,aAAa,EACb,KAAK,oBAAoB,EACzB,KAAK,0BAA0B,GAC/B,MAAM,2BAA2B,CAAC"}

package/dist/index.js

@@ -0,0 +1,21 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Notifications = exports.Latest = exports.LatestMap = exports.ExperimentalPresenceManager = exports.acquirePresenceViaDataObject = exports.acquirePresence = exports.SessionClientStatus = void 0;
+var presence_js_1 = require("./presence.js");
+Object.defineProperty(exports, "SessionClientStatus", { enumerable: true, get: function () { return presence_js_1.SessionClientStatus; } });
+var experimentalAccess_js_1 = require("./experimentalAccess.js");
+Object.defineProperty(exports, "acquirePresence", { enumerable: true, get: function () { return experimentalAccess_js_1.acquirePresence; } });
+var datastorePresenceManagerFactory_js_1 = require("./datastorePresenceManagerFactory.js");
+Object.defineProperty(exports, "acquirePresenceViaDataObject", { enumerable: true, get: function () { return datastorePresenceManagerFactory_js_1.acquirePresenceViaDataObject; } });
+Object.defineProperty(exports, "ExperimentalPresenceManager", { enumerable: true, get: function () { return datastorePresenceManagerFactory_js_1.ExperimentalPresenceManager; } });
+var latestMapValueManager_js_1 = require("./latestMapValueManager.js");
+Object.defineProperty(exports, "LatestMap", { enumerable: true, get: function () { return latestMapValueManager_js_1.LatestMap; } });
+var latestValueManager_js_1 = require("./latestValueManager.js");
+Object.defineProperty(exports, "Latest", { enumerable: true, get: function () { return latestValueManager_js_1.Latest; } });
+var notificationsManager_js_1 = require("./notificationsManager.js");
+Object.defineProperty(exports, "Notifications", { enumerable: true, get: function () { return notificationsManager_js_1.Notifications; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAoCH,6CAMuB;AADtB,kHAAA,mBAAmB,OAAA;AAGpB,iEAA0D;AAAjD,wHAAA,eAAe,OAAA;AAExB,2FAI8C;AAH7C,kJAAA,4BAA4B,OAAA;AAE5B,iJAAA,2BAA2B,OAAA;AAI5B,uEAQoC;AAPnC,qHAAA,SAAS,OAAA;AAQV,iEAIiC;AAHhC,+GAAA,MAAM,OAAA;AAUP,qEAOmC;AAHlC,wHAAA,aAAa,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Experimental package for client presence within a connected session.\n *\n * See {@link https://github.com/microsoft/FluidFramework/tree/main/packages/framework/presence#readme | README.md } for an overview of the package.\n *\n * @packageDocumentation\n */\n\n// If desired these are the \"required\" types from core-interfaces.\n// export type {\n// \tInternalUtilityTypes,\n// \tJsonDeserialized,\n// \tJsonSerializable,\n// } from \"@fluidframework/presence/internal/core-interfaces\";\n\n// If desired these are the \"required\" types from events.\n// export type {\n// \tEvents,\n// \tIsEvent,\n// \tISubscribable,\n// } from \"@fluidframework/presence/internal/events\";\n\nexport type { ClientConnectionId } from \"./baseTypes.js\";\n\nexport type {\n\tPresenceNotifications,\n\tPresenceNotificationsSchema,\n\tPresenceStates,\n\tPresenceStatesEntries,\n\tPresenceStatesEntry,\n\tPresenceStatesSchema,\n\tPresenceWorkspaceAddress,\n} from \"./types.js\";\n\nexport {\n\ttype ClientSessionId,\n\ttype IPresence,\n\ttype ISessionClient,\n\ttype PresenceEvents,\n\tSessionClientStatus,\n} from \"./presence.js\";\n\nexport { acquirePresence } from \"./experimentalAccess.js\";\n\nexport {\n\tacquirePresenceViaDataObject,\n\ttype ExperimentalPresenceDO,\n\tExperimentalPresenceManager,\n} from \"./datastorePresenceManagerFactory.js\";\n\nexport type { LatestValueControls } from \"./latestValueControls.js\";\nexport {\n\tLatestMap,\n\ttype LatestMapItemRemovedClientData,\n\ttype LatestMapItemValueClientData,\n\ttype LatestMapValueClientData,\n\ttype LatestMapValueManager,\n\ttype LatestMapValueManagerEvents,\n\ttype ValueMap,\n} from \"./latestMapValueManager.js\";\nexport {\n\tLatest,\n\ttype LatestValueManager,\n\ttype LatestValueManagerEvents,\n} from \"./latestValueManager.js\";\nexport type {\n\tLatestValueClientData,\n\tLatestValueData,\n\tLatestValueMetadata,\n} from \"./latestValueTypes.js\";\n\nexport {\n\ttype NotificationEmitter,\n\ttype NotificationSubscribable,\n\ttype NotificationSubscriptions,\n\tNotifications,\n\ttype NotificationsManager,\n\ttype NotificationsManagerEvents,\n} from \"./notificationsManager.js\";\n"]}

package/dist/internalTypes.d.ts

@@ -0,0 +1,39 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { IContainerRuntime } from "@fluidframework/container-runtime-definitions/internal";
+import type { IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions/internal";
+import type { InternalTypes } from "./exposedInternalTypes.js";
+import type { ClientSessionId, ISessionClient } from "./presence.js";
+import type { IRuntimeInternal } from "@fluidframework/presence/internal/container-definitions/internal";
+/**
+ * @internal
+ */
+export interface ClientRecord<TValue extends InternalTypes.ValueDirectoryOrState<unknown> | undefined> {
+    [ClientSessionId: ClientSessionId]: Exclude<TValue, undefined>;
+}
+/**
+ * Object.entries retyped to support branded string-based keys.
+ *
+ * @internal
+ */
+export declare const brandedObjectEntries: <K extends string, T>(o: Record<K, T>) => [K, T][];
+/**
+ * This interface is a subset of (IContainerRuntime & IRuntimeInternal) and
+ * (IFluidDataStoreRuntime) that is needed by the Presence States.
+ *
+ * @privateRemarks
+ * Replace with non-DataStore based interface.
+ *
+ * @internal
+ */
+export type IEphemeralRuntime = Pick<(IContainerRuntime & IRuntimeInternal) | IFluidDataStoreRuntime, "clientId" | "connected" | "getAudience" | "getQuorum" | "off" | "on" | "submitSignal"> & Partial<Pick<IFluidDataStoreRuntime, "logger">>;
+/**
+ * @internal
+ */
+export interface ValueManager<TValue, TValueState extends InternalTypes.ValueDirectoryOrState<TValue> = InternalTypes.ValueDirectoryOrState<TValue>> {
+    readonly value?: TValueState;
+    update(client: ISessionClient, received: number, value: TValueState): void;
+}
+//# sourceMappingURL=internalTypes.d.ts.map

package/dist/internalTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"internalTypes.d.ts","sourceRoot":"","sources":["../src/internalTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wDAAwD,CAAC;AAChG,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,gDAAgD,CAAC;AAE7F,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAErE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kEAAkE,CAAC;AAEzG;;GAEG;AACH,MAAM,WAAW,YAAY,CAC5B,MAAM,SAAS,aAAa,CAAC,qBAAqB,CAAC,OAAO,CAAC,GAAG,SAAS;IAKvE,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;CAC/D;AAED;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,2BAC7B,OAAO,CAAC,EAAE,CAAC,CAAC,KACX,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;AAEd;;;;;;;;GAQG;AACH,MAAM,MAAM,iBAAiB,GAAG,IAAI,CACnC,CAAC,iBAAiB,GAAG,gBAAgB,CAAC,GAAG,sBAAsB,EAC/D,UAAU,GAAG,WAAW,GAAG,aAAa,GAAG,WAAW,GAAG,KAAK,GAAG,IAAI,GAAG,cAAc,CACtF,GACA,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,QAAQ,CAAC,CAAC,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,YAAY,CAC5B,MAAM,EACN,WAAW,SACV,aAAa,CAAC,qBAAqB,CAAC,MAAM,CAAC,GAAG,aAAa,CAAC,qBAAqB,CAAC,MAAM,CAAC;IAG1F,QAAQ,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC;IAC7B,MAAM,CAAC,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,GAAG,IAAI,CAAC;CAC3E"}

package/dist/internalTypes.js

@@ -0,0 +1,14 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.brandedObjectEntries = void 0;
+/**
+ * Object.entries retyped to support branded string-based keys.
+ *
+ * @internal
+ */
+exports.brandedObjectEntries = Object.entries;
+//# sourceMappingURL=internalTypes.js.map

package/dist/internalTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"internalTypes.js","sourceRoot":"","sources":["../src/internalTypes.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAsBH;;;;GAIG;AACU,QAAA,oBAAoB,GAAG,MAAM,CAAC,OAE9B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IContainerRuntime } from \"@fluidframework/container-runtime-definitions/internal\";\nimport type { IFluidDataStoreRuntime } from \"@fluidframework/datastore-definitions/internal\";\n\nimport type { InternalTypes } from \"./exposedInternalTypes.js\";\nimport type { ClientSessionId, ISessionClient } from \"./presence.js\";\n\nimport type { IRuntimeInternal } from \"@fluidframework/presence/internal/container-definitions/internal\";\n\n/**\n * @internal\n */\nexport interface ClientRecord<\n\tTValue extends InternalTypes.ValueDirectoryOrState<unknown> | undefined,\n> {\n\t// Caution: any particular item may or may not exist\n\t// Typescript does not support absent keys without forcing type to also be undefined.\n\t// See https://github.com/microsoft/TypeScript/issues/42810.\n\t[ClientSessionId: ClientSessionId]: Exclude<TValue, undefined>;\n}\n\n/**\n * Object.entries retyped to support branded string-based keys.\n *\n * @internal\n */\nexport const brandedObjectEntries = Object.entries as <K extends string, T>(\n\to: Record<K, T>,\n) => [K, T][];\n\n/**\n * This interface is a subset of (IContainerRuntime & IRuntimeInternal) and\n * (IFluidDataStoreRuntime) that is needed by the Presence States.\n *\n * @privateRemarks\n * Replace with non-DataStore based interface.\n *\n * @internal\n */\nexport type IEphemeralRuntime = Pick<\n\t(IContainerRuntime & IRuntimeInternal) | IFluidDataStoreRuntime,\n\t\"clientId\" | \"connected\" | \"getAudience\" | \"getQuorum\" | \"off\" | \"on\" | \"submitSignal\"\n> &\n\tPartial<Pick<IFluidDataStoreRuntime, \"logger\">>;\n\n/**\n * @internal\n */\nexport interface ValueManager<\n\tTValue,\n\tTValueState extends\n\t\tInternalTypes.ValueDirectoryOrState<TValue> = InternalTypes.ValueDirectoryOrState<TValue>,\n> {\n\t// Most value managers should provide value - implement Required<ValueManager<...>>\n\treadonly value?: TValueState;\n\tupdate(client: ISessionClient, received: number, value: TValueState): void;\n}\n"]}

package/dist/latestMapValueManager.d.ts

@@ -0,0 +1,182 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { LatestValueControls } from "./latestValueControls.js";
+import type { LatestValueClientData, LatestValueData, LatestValueMetadata } from "./latestValueTypes.js";
+import type { ClientSessionId, ISessionClient } from "./presence.js";
+import type { JsonDeserialized, JsonSerializable } from "@fluidframework/presence/internal/core-interfaces";
+import type { ISubscribable } from "@fluidframework/presence/internal/events";
+import type { InternalTypes } from "@fluidframework/presence/internal/exposedInternalTypes";
+import type { InternalUtilityTypes } from "@fluidframework/presence/internal/exposedUtilityTypes";
+/**
+ * Collection of latest known values for a specific client.
+ *
+ * @sealed
+ * @alpha
+ */
+export interface LatestMapValueClientData<T, Keys extends string | number, SpecificSessionClientId extends ClientSessionId = ClientSessionId> {
+    /**
+     * Associated client.
+     */
+    client: ISessionClient<SpecificSessionClientId>;
+    /**
+     * @privateRemarks This could be regular map currently as no Map is
+     * stored internally and a new instance is created for every request.
+     */
+    items: ReadonlyMap<Keys, LatestValueData<T>>;
+}
+/**
+ * State of a single item value, its key, and its metadata.
+ *
+ * @sealed
+ * @alpha
+ */
+export interface LatestMapItemValueClientData<T, K extends string | number> extends LatestValueClientData<T> {
+    key: K;
+}
+/**
+ * Identifier and metadata for a removed item.
+ *
+ * @sealed
+ * @alpha
+ */
+export interface LatestMapItemRemovedClientData<K extends string | number> {
+    client: ISessionClient;
+    key: K;
+    metadata: LatestValueMetadata;
+}
+/**
+ * @sealed
+ * @alpha
+ */
+export interface LatestMapValueManagerEvents<T, K extends string | number> {
+    /**
+     * Raised when any item's value for remote client is updated.
+     * @param updates - Map of one or more values updated.
+     *
+     * @remarks The event does not include item removals.
+     *
+     * @eventProperty
+     */
+    updated: (updates: LatestMapValueClientData<T, K>) => void;
+    /**
+     * Raised when specific item's value is updated.
+     * @param updatedItem - Updated item value.
+     *
+     * @eventProperty
+     */
+    itemUpdated: (updatedItem: LatestMapItemValueClientData<T, K>) => void;
+    /**
+     * Raised when specific item is removed.
+     * @param removedItem - Removed item.
+     *
+     * @eventProperty
+     */
+    itemRemoved: (removedItem: LatestMapItemRemovedClientData<K>) => void;
+}
+/**
+ * Map of local client's values. Modifications are transmitted to all other connected clients.
+ *
+ * @sealed
+ * @alpha
+ */
+export interface ValueMap<K extends string | number, V> {
+    /**
+     * ${@link ValueMap.delete}s all elements in the ValueMap.
+     * @remarks This is not yet implemented.
+     */
+    clear(): void;
+    /**
+     * @returns true if an element in the ValueMap existed and has been removed, or false if
+     * the element does not exist.
+     * @remarks No entry is fully removed. Instead an undefined placeholder is locally and
+     * transmitted to all other clients. For better performance limit the number of deleted
+     * entries and reuse keys when possible.
+     * @privateRemarks In the future we may add a mechanism to remove the placeholder, at least
+     * from transmissions after sufficient time has passed.
+     */
+    delete(key: K): boolean;
+    /**
+     * Executes a provided function once per each key/value pair in the ValueMap, in arbitrary order.
+     */
+    forEach(callbackfn: (value: InternalUtilityTypes.FullyReadonly<JsonDeserialized<V>>, key: K, map: ValueMap<K, V>) => void, thisArg?: unknown): void;
+    /**
+     * Returns a specified element from the ValueMap object.
+     * @returns Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
+     */
+    get(key: K): InternalUtilityTypes.FullyReadonly<JsonDeserialized<V>> | undefined;
+    /**
+     * @returns boolean indicating whether an element with the specified key exists or not.
+     */
+    has(key: K): boolean;
+    /**
+     * Adds a new element with a specified key and value to the ValueMap. If an element with the same key already exists, the element will be updated.
+     * The value will be transmitted to all other connected clients.
+     *
+     * @remarks Manager assumes ownership of the value and its references.
+     * Make a deep clone before setting, if needed. No comparison is done to detect changes; all
+     * sets are transmitted.
+     */
+    set(key: K, value: JsonSerializable<V> & JsonDeserialized<V>): this;
+    /**
+     * @returns the number of elements in the ValueMap.
+     */
+    readonly size: number;
+    /**
+     * Returns an iterable of entries in the map.
+     */
+    /**
+     * Returns an iterable of key, value pairs for every entry in the map.
+     */
+    /**
+     * Returns an iterable of keys in the map.
+     */
+    keys(): IterableIterator<K>;
+}
+/**
+ * Value manager that provides a `Map` of latest known values from this client to
+ * others and read access to their values.
+ * Entries in the map may vary over time and by client, but all values are expected to
+ * be of the same type, which may be a union type.
+ *
+ * @remarks Create using {@link LatestMap} registered to {@link PresenceStates}.
+ *
+ * @sealed
+ * @alpha
+ */
+export interface LatestMapValueManager<T, Keys extends string | number = string | number> {
+    /**
+     * Events for LatestMap value manager.
+     */
+    readonly events: ISubscribable<LatestMapValueManagerEvents<T, Keys>>;
+    /**
+     * Controls for management of sending updates.
+     */
+    readonly controls: LatestValueControls;
+    /**
+     * Current value map for this client.
+     */
+    readonly local: ValueMap<Keys, T>;
+    /**
+     * Iterable access to remote clients' map of values.
+     */
+    clientValues(): IterableIterator<LatestMapValueClientData<T, Keys>>;
+    /**
+     * Array of known clients.
+     */
+    clients(): ISessionClient[];
+    /**
+     * Access to a specific client's map of values.
+     */
+    clientValue(client: ISessionClient): ReadonlyMap<Keys, LatestValueData<T>>;
+}
+/**
+ * Factory for creating a {@link LatestMapValueManager}.
+ *
+ * @alpha
+ */
+export declare function LatestMap<T extends object, Keys extends string | number = string | number, RegistrationKey extends string = string>(initialValues?: {
+    [K in Keys]: JsonSerializable<T> & JsonDeserialized<T>;
+}, controls?: LatestValueControls): InternalTypes.ManagerFactory<RegistrationKey, InternalTypes.MapValueState<T>, LatestMapValueManager<T, Keys>>;
+//# sourceMappingURL=latestMapValueManager.d.ts.map

package/dist/latestMapValueManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"latestMapValueManager.d.ts","sourceRoot":"","sources":["../src/latestMapValueManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAEpE,OAAO,KAAK,EACX,qBAAqB,EACrB,eAAe,EACf,mBAAmB,EACnB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAyB,MAAM,eAAe,CAAC;AAI5F,OAAO,KAAK,EACX,gBAAgB,EAChB,gBAAgB,EAChB,MAAM,mDAAmD,CAAC;AAC3D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0CAA0C,CAAC;AAE9E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wDAAwD,CAAC;AAC5F,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,uDAAuD,CAAC;AAElG;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB,CACxC,CAAC,EACD,IAAI,SAAS,MAAM,GAAG,MAAM,EAC5B,uBAAuB,SAAS,eAAe,GAAG,eAAe;IAEjE;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC,uBAAuB,CAAC,CAAC;IAEhD;;;OAGG;IACH,KAAK,EAAE,WAAW,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;CAC7C;AAED;;;;;GAKG;AACH,MAAM,WAAW,4BAA4B,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,GAAG,MAAM,CACzE,SAAQ,qBAAqB,CAAC,CAAC,CAAC;IAChC,GAAG,EAAE,CAAC,CAAC;CACP;AAED;;;;;GAKG;AACH,MAAM,WAAW,8BAA8B,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;IACxE,MAAM,EAAE,cAAc,CAAC;IACvB,GAAG,EAAE,CAAC,CAAC;IACP,QAAQ,EAAE,mBAAmB,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA2B,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,GAAG,MAAM;IACxE;;;;;;;OAOG;IACH,OAAO,EAAE,CAAC,OAAO,EAAE,wBAAwB,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC;IAE3D;;;;;OAKG;IACH,WAAW,EAAE,CAAC,WAAW,EAAE,4BAA4B,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC;IAEvE;;;;;OAKG;IACH,WAAW,EAAE,CAAC,WAAW,EAAE,8BAA8B,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;CACtE;AAED;;;;;GAKG;AACH,MAAM,WAAW,QAAQ,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,CAAC;IACrD;;;OAGG;IACH,KAAK,IAAI,IAAI,CAAC;IAEd;;;;;;;;OAQG;IACH,MAAM,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC;IAExB;;OAEG;IACH,OAAO,CACN,UAAU,EAAE,CACX,KAAK,EAAE,oBAAoB,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,EAC9D,GAAG,EAAE,CAAC,EACN,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,KACf,IAAI,EACT,OAAO,CAAC,EAAE,OAAO,GACf,IAAI,CAAC;IAER;;;OAGG;IACH,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,oBAAoB,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IAEjF;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC;IAErB;;;;;;;OAOG;IACH,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAEpE;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IAGH;;OAEG;IAGH;;OAEG;IACH,IAAI,IAAI,gBAAgB,CAAC,CAAC,CAAC,CAAC;CAM5B;AAqFD;;;;;;;;;;GAUG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC,EAAE,IAAI,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM;IACvF;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,2BAA2B,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;IAErE;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,mBAAmB,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAClC;;OAEG;IACH,YAAY,IAAI,gBAAgB,CAAC,wBAAwB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;IACpE;;OAEG;IACH,OAAO,IAAI,cAAc,EAAE,CAAC;IAC5B;;OAEG;IACH,WAAW,CAAC,MAAM,EAAE,cAAc,GAAG,WAAW,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;CAC3E;AAkID;;;;GAIG;AACH,wBAAgB,SAAS,CACxB,CAAC,SAAS,MAAM,EAChB,IAAI,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,EAC9C,eAAe,SAAS,MAAM,GAAG,MAAM,EAEvC,aAAa,CAAC,EAAE;KACd,CAAC,IAAI,IAAI,GAAG,gBAAgB,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC;CACtD,EACD,QAAQ,CAAC,EAAE,mBAAmB,GAC5B,aAAa,CAAC,cAAc,CAC9B,eAAe,EACf,aAAa,CAAC,aAAa,CAAC,CAAC,CAAC,EAC9B,qBAAqB,CAAC,CAAC,EAAE,IAAI,CAAC,CAC9B,CAwCA"}

package/dist/latestMapValueManager.js

@@ -0,0 +1,206 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LatestMap = void 0;
+const latestValueControls_js_1 = require("./latestValueControls.js");
+const stateDatastore_js_1 = require("./stateDatastore.js");
+const valueManager_js_1 = require("./valueManager.js");
+const events_1 = require("@fluidframework/presence/internal/events");
+class ValueMapImpl {
+    constructor(value, localUpdate) {
+        this.value = value;
+        this.localUpdate = localUpdate;
+        // All initial items are expected to be defined.
+        // TODO assert all defined and/or update type.
+        this.countDefined = Object.keys(value.items).length;
+    }
+    updateItem(key, value) {
+        this.value.rev += 1;
+        const item = this.value.items[key];
+        item.rev += 1;
+        item.timestamp = Date.now();
+        if (value === undefined) {
+            delete item.value;
+        }
+        else {
+            item.value = value;
+        }
+        const update = { rev: this.value.rev, items: { [key]: item } };
+        this.localUpdate(update, /* forceUpdate */ false);
+    }
+    clear() {
+        throw new Error("Method not implemented.");
+    }
+    delete(key) {
+        const { items } = this.value;
+        const hasKey = items[key]?.value !== undefined;
+        if (hasKey) {
+            this.countDefined -= 1;
+            this.updateItem(key, undefined);
+        }
+        return hasKey;
+    }
+    forEach(callbackfn, thisArg) {
+        for (const [key, item] of Object.entries(this.value.items)) {
+            if (item.value !== undefined) {
+                // TODO: see about typing InternalTypes.MapValueState with K
+                callbackfn(item.value, key, this);
+            }
+        }
+    }
+    get(key) {
+        return this.value.items[key]?.value;
+    }
+    has(key) {
+        return this.value.items[key]?.value !== undefined;
+    }
+    set(key, value) {
+        if (!(key in this.value.items)) {
+            this.countDefined += 1;
+            this.value.items[key] = { rev: 0, timestamp: 0, value };
+        }
+        this.updateItem(key, value);
+        return this;
+    }
+    get size() {
+        return this.countDefined;
+    }
+    keys() {
+        const keys = [];
+        for (const [key, item] of Object.entries(this.value.items)) {
+            if (item.value !== undefined) {
+                keys.push(key);
+            }
+        }
+        return keys[Symbol.iterator]();
+    }
+}
+class LatestMapValueManagerImpl {
+    constructor(key, datastore, value, controlSettings) {
+        this.key = key;
+        this.datastore = datastore;
+        this.value = value;
+        this.events = (0, events_1.createEmitter)();
+        this.controls = new latestValueControls_js_1.LatestValueControl(controlSettings);
+        this.local = new ValueMapImpl(value, (updates, forceUpdate) => {
+            datastore.localUpdate(key, updates, forceUpdate);
+        });
+    }
+    *clientValues() {
+        const allKnownStates = this.datastore.knownValues(this.key);
+        for (const clientSessionId of Object.keys(allKnownStates.states)) {
+            if (clientSessionId !== allKnownStates.self) {
+                const client = this.datastore.lookupClient(clientSessionId);
+                const items = this.clientValue(client);
+                yield { client, items };
+            }
+        }
+    }
+    clients() {
+        const allKnownStates = this.datastore.knownValues(this.key);
+        return Object.keys(allKnownStates.states)
+            .filter((clientSessionId) => clientSessionId !== allKnownStates.self)
+            .map((clientSessionId) => this.datastore.lookupClient(clientSessionId));
+    }
+    clientValue(client) {
+        const allKnownStates = this.datastore.knownValues(this.key);
+        const clientSessionId = client.sessionId;
+        if (!(clientSessionId in allKnownStates.states)) {
+            throw new Error("No entry for client");
+        }
+        const clientStateMap = allKnownStates.states[clientSessionId];
+        const items = new Map();
+        for (const [key, item] of Object.entries(clientStateMap.items)) {
+            const value = item.value;
+            if (value !== undefined) {
+                items.set(key, {
+                    value,
+                    metadata: { revision: item.rev, timestamp: item.timestamp },
+                });
+            }
+        }
+        return items;
+    }
+    update(client, _received, value) {
+        const allKnownStates = this.datastore.knownValues(this.key);
+        const clientSessionId = client.sessionId;
+        if (!(clientSessionId in allKnownStates.states)) {
+            // New client - prepare new client state directory
+            allKnownStates.states[clientSessionId] = { rev: value.rev, items: {} };
+        }
+        const currentState = allKnownStates.states[clientSessionId];
+        // Accumulate individual update keys
+        const updatedItemKeys = [];
+        for (const [key, item] of Object.entries(value.items)) {
+            if (!(key in currentState.items) || currentState.items[key].rev < item.rev) {
+                updatedItemKeys.push(key);
+            }
+        }
+        if (updatedItemKeys.length === 0) {
+            return;
+        }
+        // Store updates
+        if (value.rev > currentState.rev) {
+            currentState.rev = value.rev;
+        }
+        const allUpdates = {
+            client,
+            items: new Map(),
+        };
+        for (const key of updatedItemKeys) {
+            const item = value.items[key];
+            const hadPriorValue = currentState.items[key]?.value;
+            currentState.items[key] = item;
+            const metadata = { revision: item.rev, timestamp: item.timestamp };
+            if (item.value !== undefined) {
+                this.events.emit("itemUpdated", {
+                    client,
+                    key,
+                    value: item.value,
+                    metadata,
+                });
+                allUpdates.items.set(key, { value: item.value, metadata });
+            }
+            else if (hadPriorValue !== undefined) {
+                this.events.emit("itemRemoved", {
+                    client,
+                    key,
+                    metadata,
+                });
+            }
+        }
+        this.datastore.update(this.key, clientSessionId, currentState);
+        this.events.emit("updated", allUpdates);
+    }
+}
+/**
+ * Factory for creating a {@link LatestMapValueManager}.
+ *
+ * @alpha
+ */
+function LatestMap(initialValues, controls) {
+    const timestamp = Date.now();
+    const value = { rev: 0, items: {} };
+    // LatestMapValueManager takes ownership of values within initialValues.
+    if (initialValues !== undefined) {
+        for (const key of Object.keys(initialValues)) {
+            value.items[key] = { rev: 0, timestamp, value: initialValues[key] };
+        }
+    }
+    const controlSettings = controls
+        ? { ...controls }
+        : {
+            allowableUpdateLatency: 60,
+            forcedRefreshInterval: 0,
+        };
+    const factory = (key, datastoreHandle) => ({
+        value,
+        manager: (0, valueManager_js_1.brandIVM)(new LatestMapValueManagerImpl(key, (0, stateDatastore_js_1.datastoreFromHandle)(datastoreHandle), value, controlSettings)),
+    });
+    return Object.assign(factory, { instanceBase: LatestMapValueManagerImpl });
+}
+exports.LatestMap = LatestMap;
+//# sourceMappingURL=latestMapValueManager.js.map