@fluid-internal/presence-definitions 2.93.0

package/dist/types.d.ts

@@ -0,0 +1,134 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { BroadcastControls } from "./broadcastControlsTypes.js";
+import type { InternalTypes } from "./exposedInternalTypes.js";
+import type { InternalUtilityTypes } from "./exposedUtilityTypes.js";
+import type { NotificationsManager } from "./notificationsManagerTypes.js";
+import type { Presence, PresenceWithNotifications } from "./presence.js";
+/**
+ * Unique address within a session.
+ *
+ * @remarks
+ * A string known to all clients working with a certain Workspace and unique
+ * among Workspaces. Recommend using specifying concatenation of: type of
+ * unique identifier, `:` (required), and unique identifier.
+ *
+ * @example Examples
+ * ```typescript
+ *   "guid:g0fl001d-1415-5000-c00l-g0fa54g0b1g1"
+ *   "address:object0/sub-object2:pointers"
+ * ```
+ *
+ * @public
+ */
+export type WorkspaceAddress = `${string}:${string}`;
+/**
+ * Single entry in {@link StatesWorkspaceSchema} or  {@link NotificationsWorkspaceSchema}.
+ *
+ * @public
+ */
+export type StatesWorkspaceEntry<TKey extends string, TValue extends InternalTypes.ValueDirectoryOrState<unknown>, TManager = unknown> = InternalTypes.ManagerFactory<TKey, TValue, TManager>;
+/**
+ * Schema for a {@link StatesWorkspace} workspace.
+ *
+ * Keys of schema are the keys of the {@link StatesWorkspace} providing access to State objects.
+ *
+ * @public
+ */
+export type StatesWorkspaceSchema<Keys extends string = string> = {
+    [Key in Keys]: StatesWorkspaceEntry<Key, InternalTypes.ValueDirectoryOrState<unknown>>;
+};
+/**
+ * Map of State objects registered with {@link StatesWorkspace}.
+ *
+ * @sealed
+ * @public
+ */
+export type StatesWorkspaceEntries<TSchema extends Partial<StatesWorkspaceSchema<TSchemaKeys>>, TSchemaKeys extends string & keyof TSchema = string & keyof TSchema> = {
+    /**
+     * Registered State objects.
+     */
+    readonly [Key in keyof TSchema]: ReturnType<Exclude<TSchema[Key], undefined>>["manager"] extends InternalTypes.StateValue<infer TManager> ? TManager : never;
+};
+/**
+ * `StatesWorkspace` maintains a registry of State objects that all share and provide access to
+ * presence state values across client members in a session.
+ *
+ * State objects offer variations on how to manage states, but all share same principle that
+ * each client's state is independent and may only be updated by originating client.
+ *
+ * @sealed
+ * @public
+ */
+export interface StatesWorkspace<TSchema extends Partial<StatesWorkspaceSchema<TSchemaKeys>>, TManagerConstraints = unknown, TSchemaKeys extends string & keyof TSchema = string & keyof TSchema> {
+    /**
+     * Registers a new State object with the {@link StatesWorkspace}.
+     * @param key - new unique key for the State object within the workspace
+     * @param configuration - factory/settings for creating a State object. Use
+     * {@link @fluidframework/presence#StateFactory} to create.
+     */
+    add<TKey extends string, TValue extends InternalTypes.ValueDirectoryOrState<unknown>, TManager extends TManagerConstraints>(key: TKey, configuration: InternalTypes.ManagerFactory<TKey, TValue, TManager>): asserts this is StatesWorkspace<TSchema & Record<TKey, InternalTypes.ManagerFactory<TKey, TValue, TManager>>, TManagerConstraints>;
+    /**
+     * Registry of State objects.
+     */
+    readonly states: StatesWorkspaceEntries<TSchema, TSchemaKeys>;
+    /**
+     * Default controls for management of broadcast updates.
+     */
+    readonly controls: BroadcastControls;
+    /**
+     * Containing {@link Presence}
+     */
+    readonly presence: Presence;
+}
+/**
+ * Schema for a {@link NotificationsWorkspace} workspace.
+ *
+ * Keys of schema are the keys of the {@link NotificationsWorkspace} providing access to {@link NotificationsManager}s.
+ *
+ * @alpha
+ */
+export type NotificationsWorkspaceSchema<Keys extends string = string> = {
+    [Key in Keys]: InternalTypes.ManagerFactory<Key, InternalTypes.ValueRequiredState<InternalTypes.NotificationType>, NotificationsManager<InternalUtilityTypes.NotificationListeners<unknown>>>;
+};
+/**
+ * `NotificationsWorkspace` maintains a registry of {@link NotificationsManager}s
+ * that facilitate messages across client members in a session.
+ *
+ * @privateRemarks
+ * This should be kept mostly in sync with {@link StatesWorkspace}. Notably the
+ * return type of `add` is limited here and the `controls` property is omitted.
+ * The `PresenceStatesImpl` class implements `AnyWorkspace` and therefore
+ * `NotificationsWorkspace`, so long as this is proper subset.
+ *
+ * @sealed
+ * @alpha
+ */
+export interface NotificationsWorkspace<TSchema extends Partial<NotificationsWorkspaceSchema<TSchemaKeys>>, TSchemaKeys extends string & keyof TSchema = string & keyof TSchema> {
+    /**
+     * Registers a new `NotificationsManager` with the {@link NotificationsWorkspace}.
+     * @param key - new unique key for the `NotificationsManager` within the workspace
+     * @param manager - factory for creating a `NotificationsManager`
+     */
+    add<TKey extends string, TValue extends InternalTypes.ValueDirectoryOrState<unknown>, TManager extends NotificationsManager<InternalUtilityTypes.NotificationListeners<unknown>>>(key: TKey, manager: InternalTypes.ManagerFactory<TKey, TValue, TManager>): asserts this is NotificationsWorkspace<TSchema & Record<TKey, InternalTypes.ManagerFactory<TKey, TValue, TManager>>>;
+    /**
+     * Registry of `NotificationsManager`s.
+     */
+    readonly notifications: StatesWorkspaceEntries<TSchema, TSchemaKeys>;
+    /**
+     * Containing {@link PresenceWithNotifications}
+     */
+    readonly presence: PresenceWithNotifications;
+}
+/**
+ * `AnyWorkspace` is a superset of {@link StatesWorkspace} and {@link NotificationsWorkspace}.
+ *
+ * @internal
+ */
+export interface AnyWorkspace<TSchema extends StatesWorkspaceSchema, TManagerConstraints = unknown> extends StatesWorkspace<TSchema, TManagerConstraints> {
+    readonly notifications: StatesWorkspaceEntries<TSchema>;
+    readonly presence: PresenceWithNotifications;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AACrE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,KAAK,EAAE,QAAQ,EAAE,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAEzE;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,gBAAgB,GAAG,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;AAErD;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,CAC/B,IAAI,SAAS,MAAM,EACnB,MAAM,SAAS,aAAa,CAAC,qBAAqB,CAAC,OAAO,CAAC,EAC3D,QAAQ,GAAG,OAAO,IACf,aAAa,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;AAIzD;;;;;;GAMG;AACH,MAAM,MAAM,qBAAqB,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,IAAI;KAIhE,GAAG,IAAI,IAAI,GAAG,oBAAoB,CAAC,GAAG,EAAE,aAAa,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;CACtF,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,CACjC,OAAO,SAAS,OAAO,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC,EAC3D,WAAW,SAAS,MAAM,GAAG,MAAM,OAAO,GAAG,MAAM,GAAG,MAAM,OAAO,IAChE;IACH;;OAEG;IACH,QAAQ,EAAE,GAAG,IAAI,MAAM,OAAO,GAAG,UAAU,CAC1C,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC,CAChC,CAAC,SAAS,CAAC,SAAS,aAAa,CAAC,UAAU,CAAC,MAAM,QAAQ,CAAC,GAC1D,QAAQ,GACR,KAAK;CACR,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,WAAW,eAAe,CAC/B,OAAO,SAAS,OAAO,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC,EAC3D,mBAAmB,GAAG,OAAO,EAC7B,WAAW,SAAS,MAAM,GAAG,MAAM,OAAO,GAAG,MAAM,GAAG,MAAM,OAAO;IAEnE;;;;;OAKG;IACH,GAAG,CACF,IAAI,SAAS,MAAM,EACnB,MAAM,SAAS,aAAa,CAAC,qBAAqB,CAAC,OAAO,CAAC,EAC3D,QAAQ,SAAS,mBAAmB,EAEpC,GAAG,EAAE,IAAI,EACT,aAAa,EAAE,aAAa,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,GACjE,OAAO,CAAC,IAAI,IAAI,eAAe,CACjC,OAAO,GAAG,MAAM,CAAC,IAAI,EAAE,aAAa,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,EAC5E,mBAAmB,CACnB,CAAC;IAEF;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,sBAAsB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAE9D;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,iBAAiB,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;CAC5B;AAMD;;;;;;GAMG;AACH,MAAM,MAAM,4BAA4B,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,IAAI;KACvE,GAAG,IAAI,IAAI,GAAG,aAAa,CAAC,cAAc,CAC1C,GAAG,EACH,aAAa,CAAC,kBAAkB,CAAC,aAAa,CAAC,gBAAgB,CAAC,EAChE,oBAAoB,CAAC,oBAAoB,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,CACzE;CACD,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,sBAAsB,CACtC,OAAO,SAAS,OAAO,CAAC,4BAA4B,CAAC,WAAW,CAAC,CAAC,EAClE,WAAW,SAAS,MAAM,GAAG,MAAM,OAAO,GAAG,MAAM,GAAG,MAAM,OAAO;IAEnE;;;;OAIG;IACH,GAAG,CACF,IAAI,SAAS,MAAM,EACnB,MAAM,SAAS,aAAa,CAAC,qBAAqB,CAAC,OAAO,CAAC,EAC3D,QAAQ,SAAS,oBAAoB,CAAC,oBAAoB,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,EAE1F,GAAG,EAAE,IAAI,EACT,OAAO,EAAE,aAAa,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,GAC3D,OAAO,CAAC,IAAI,IAAI,sBAAsB,CACxC,OAAO,GAAG,MAAM,CAAC,IAAI,EAAE,aAAa,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAC5E,CAAC;IAEF;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,sBAAsB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAErE;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,yBAAyB,CAAC;CAC7C;AAID;;;;GAIG;AACH,MAAM,WAAW,YAAY,CAC5B,OAAO,SAAS,qBAAqB,EACrC,mBAAmB,GAAG,OAAO,CAC5B,SAAQ,eAAe,CAAC,OAAO,EAAE,mBAAmB,CAAC;IACtD,QAAQ,CAAC,aAAa,EAAE,sBAAsB,CAAC,OAAO,CAAC,CAAC;IAExD,QAAQ,CAAC,QAAQ,EAAE,yBAAyB,CAAC;CAC7C"}

package/dist/types.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=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.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 { BroadcastControls } from \"./broadcastControlsTypes.js\";\nimport type { InternalTypes } from \"./exposedInternalTypes.js\";\nimport type { InternalUtilityTypes } from \"./exposedUtilityTypes.js\";\nimport type { NotificationsManager } from \"./notificationsManagerTypes.js\";\nimport type { Presence, PresenceWithNotifications } from \"./presence.js\";\n\n/**\n * Unique address within a session.\n *\n * @remarks\n * A string known to all clients working with a certain Workspace and unique\n * among Workspaces. Recommend using specifying concatenation of: type of\n * unique identifier, `:` (required), and unique identifier.\n *\n * @example Examples\n * ```typescript\n *   \"guid:g0fl001d-1415-5000-c00l-g0fa54g0b1g1\"\n *   \"address:object0/sub-object2:pointers\"\n * ```\n *\n * @public\n */\nexport type WorkspaceAddress = `${string}:${string}`;\n\n/**\n * Single entry in {@link StatesWorkspaceSchema} or  {@link NotificationsWorkspaceSchema}.\n *\n * @public\n */\nexport type StatesWorkspaceEntry<\n\tTKey extends string,\n\tTValue extends InternalTypes.ValueDirectoryOrState<unknown>,\n\tTManager = unknown,\n> = InternalTypes.ManagerFactory<TKey, TValue, TManager>;\n\n// #region StatesWorkspace\n\n/**\n * Schema for a {@link StatesWorkspace} workspace.\n *\n * Keys of schema are the keys of the {@link StatesWorkspace} providing access to State objects.\n *\n * @public\n */\nexport type StatesWorkspaceSchema<Keys extends string = string> = {\n\t/**\n\t * Key-value pairs of State objects registered with the {@link StatesWorkspace}.\n\t */\n\t[Key in Keys]: StatesWorkspaceEntry<Key, InternalTypes.ValueDirectoryOrState<unknown>>;\n};\n\n/**\n * Map of State objects registered with {@link StatesWorkspace}.\n *\n * @sealed\n * @public\n */\nexport type StatesWorkspaceEntries<\n\tTSchema extends Partial<StatesWorkspaceSchema<TSchemaKeys>>,\n\tTSchemaKeys extends string & keyof TSchema = string & keyof TSchema,\n> = {\n\t/**\n\t * Registered State objects.\n\t */\n\treadonly [Key in keyof TSchema]: ReturnType<\n\t\tExclude<TSchema[Key], undefined>\n\t>[\"manager\"] extends InternalTypes.StateValue<infer TManager>\n\t\t? TManager\n\t\t: never;\n};\n\n/**\n * `StatesWorkspace` maintains a registry of State objects that all share and provide access to\n * presence state values across client members in a session.\n *\n * State objects offer variations on how to manage states, but all share same principle that\n * each client's state is independent and may only be updated by originating client.\n *\n * @sealed\n * @public\n */\nexport interface StatesWorkspace<\n\tTSchema extends Partial<StatesWorkspaceSchema<TSchemaKeys>>,\n\tTManagerConstraints = unknown,\n\tTSchemaKeys extends string & keyof TSchema = string & keyof TSchema,\n> {\n\t/**\n\t * Registers a new State object with the {@link StatesWorkspace}.\n\t * @param key - new unique key for the State object within the workspace\n\t * @param configuration - factory/settings for creating a State object. Use\n\t * {@link @fluidframework/presence#StateFactory} to create.\n\t */\n\tadd<\n\t\tTKey extends string,\n\t\tTValue extends InternalTypes.ValueDirectoryOrState<unknown>,\n\t\tTManager extends TManagerConstraints,\n\t>(\n\t\tkey: TKey,\n\t\tconfiguration: InternalTypes.ManagerFactory<TKey, TValue, TManager>,\n\t): asserts this is StatesWorkspace<\n\t\tTSchema & Record<TKey, InternalTypes.ManagerFactory<TKey, TValue, TManager>>,\n\t\tTManagerConstraints\n\t>;\n\n\t/**\n\t * Registry of State objects.\n\t */\n\treadonly states: StatesWorkspaceEntries<TSchema, TSchemaKeys>;\n\n\t/**\n\t * Default controls for management of broadcast updates.\n\t */\n\treadonly controls: BroadcastControls;\n\n\t/**\n\t * Containing {@link Presence}\n\t */\n\treadonly presence: Presence;\n}\n\n// #endregion StatesWorkspace\n\n// #region NotificationsWorkspace\n\n/**\n * Schema for a {@link NotificationsWorkspace} workspace.\n *\n * Keys of schema are the keys of the {@link NotificationsWorkspace} providing access to {@link NotificationsManager}s.\n *\n * @alpha\n */\nexport type NotificationsWorkspaceSchema<Keys extends string = string> = {\n\t[Key in Keys]: InternalTypes.ManagerFactory<\n\t\tKey,\n\t\tInternalTypes.ValueRequiredState<InternalTypes.NotificationType>,\n\t\tNotificationsManager<InternalUtilityTypes.NotificationListeners<unknown>>\n\t>;\n};\n\n/**\n * `NotificationsWorkspace` maintains a registry of {@link NotificationsManager}s\n * that facilitate messages across client members in a session.\n *\n * @privateRemarks\n * This should be kept mostly in sync with {@link StatesWorkspace}. Notably the\n * return type of `add` is limited here and the `controls` property is omitted.\n * The `PresenceStatesImpl` class implements `AnyWorkspace` and therefore\n * `NotificationsWorkspace`, so long as this is proper subset.\n *\n * @sealed\n * @alpha\n */\nexport interface NotificationsWorkspace<\n\tTSchema extends Partial<NotificationsWorkspaceSchema<TSchemaKeys>>,\n\tTSchemaKeys extends string & keyof TSchema = string & keyof TSchema,\n> {\n\t/**\n\t * Registers a new `NotificationsManager` with the {@link NotificationsWorkspace}.\n\t * @param key - new unique key for the `NotificationsManager` within the workspace\n\t * @param manager - factory for creating a `NotificationsManager`\n\t */\n\tadd<\n\t\tTKey extends string,\n\t\tTValue extends InternalTypes.ValueDirectoryOrState<unknown>,\n\t\tTManager extends NotificationsManager<InternalUtilityTypes.NotificationListeners<unknown>>,\n\t>(\n\t\tkey: TKey,\n\t\tmanager: InternalTypes.ManagerFactory<TKey, TValue, TManager>,\n\t): asserts this is NotificationsWorkspace<\n\t\tTSchema & Record<TKey, InternalTypes.ManagerFactory<TKey, TValue, TManager>>\n\t>;\n\n\t/**\n\t * Registry of `NotificationsManager`s.\n\t */\n\treadonly notifications: StatesWorkspaceEntries<TSchema, TSchemaKeys>;\n\n\t/**\n\t * Containing {@link PresenceWithNotifications}\n\t */\n\treadonly presence: PresenceWithNotifications;\n}\n\n// #endregion NotificationsWorkspace\n\n/**\n * `AnyWorkspace` is a superset of {@link StatesWorkspace} and {@link NotificationsWorkspace}.\n *\n * @internal\n */\nexport interface AnyWorkspace<\n\tTSchema extends StatesWorkspaceSchema,\n\tTManagerConstraints = unknown,\n> extends StatesWorkspace<TSchema, TManagerConstraints> {\n\treadonly notifications: StatesWorkspaceEntries<TSchema>;\n\t// To be removed if/when notifications are fully supported\n\treadonly presence: PresenceWithNotifications;\n}\n"]}

package/dist/validatableTypes.d.ts

@@ -0,0 +1,79 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { InternalCoreInterfacesUtilityTypes, OpaqueJsonDeserialized } from "@fluidframework/core-interfaces/internal";
+import type { InternalTypes } from "./exposedInternalTypes.js";
+/**
+ * Metadata for a value that may have been validated by a {@link StateSchemaValidator} function.
+ */
+interface ValidatableMetadata<TValue> {
+    /**
+     * Contains a validated value or undefined if `value` is invalid.
+     *
+     * This property will not be present if the data has not been validated.
+     * If it is present and `undefined`, the value has been checked and found to be invalid.
+     * Otherwise it will be the validated value.
+     */
+    validatedValue?: OpaqueJsonDeserialized<TValue> | undefined;
+}
+/**
+ * Represents data with optional value that may have been validated by a
+ * {@link @fluidframework/presence#StateSchemaValidator} function.
+ *
+ * @internal
+ */
+export interface ValidatableOptionalState<TValue> extends Omit<InternalTypes.ValueOptionalState<TValue>, keyof ValidatableMetadata<TValue>>, ValidatableMetadata<TValue> {
+}
+/**
+ * Represents data with required value that may have been validated by a
+ * {@link @fluidframework/presence#StateSchemaValidator} function.
+ *
+ * @internal
+ */
+export interface ValidatableRequiredState<TValue> extends Omit<InternalTypes.ValueRequiredState<TValue>, keyof ValidatableMetadata<TValue>>, ValidatableMetadata<TValue> {
+}
+/**
+ * A directory of validatable values, where each value may be an optional
+ * state or another directory.
+ *
+ * @remarks
+ * The is the validatable version of {@link InternalTypes.ValueDirectory}.
+ *
+ * @internal
+ */
+export interface ValidatableValueDirectory<T> {
+    rev: number;
+    items: {
+        [name: string | number]: ValidatableOptionalState<T> | ValidatableValueDirectory<T>;
+    };
+}
+/**
+ * Convenience type for a validatable required state or a directory of values.
+ *
+ * @remarks
+ * This is the validatable version of {@link InternalTypes.ValueDirectoryOrState}.
+ *
+ * @internal
+ */
+export type ValidatableValueDirectoryOrState<T> = ValidatableRequiredState<T> | ValidatableValueDirectory<T>;
+/**
+ * Transforms basic value datastore / protocol type into equivalent type
+ * with validation support.
+ *
+ * @remarks
+ * Use when some more specific or parameterized type equivalent of
+ * `InternalTypes.Value(Directory|RequiredState|OptionalState)` is needed.
+ *
+ * Basically, wherever a `*ValueState` appears it is extended with
+ * {@link ValidatableMetadata} to support validation.
+ *
+ * @internal
+ */
+export type ValidatableValueStructure<T extends InternalTypes.ValueDirectory<unknown> | InternalTypes.ValueRequiredState<unknown> | InternalTypes.ValueOptionalState<unknown>> = T extends InternalTypes.ValueDirectory<infer TValue> ? InternalCoreInterfacesUtilityTypes.IfSameType<T, InternalTypes.ValueDirectory<T>, ValidatableValueDirectory<TValue>, InternalCoreInterfacesUtilityTypes.FlattenIntersection<Omit<T, "items"> & {
+    items: {
+        [KItems in keyof T["items"]]: ValidatableValueStructure<T["items"][KItems]>;
+    };
+}>> : T extends InternalTypes.ValueRequiredState<infer TValue> | InternalTypes.ValueOptionalState<infer TValue> ? InternalCoreInterfacesUtilityTypes.FlattenIntersection<Omit<T, keyof ValidatableMetadata<TValue>> & ValidatableMetadata<TValue>> : never;
+export {};
+//# sourceMappingURL=validatableTypes.d.ts.map

package/dist/validatableTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validatableTypes.d.ts","sourceRoot":"","sources":["../src/validatableTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,kCAAkC,EAClC,sBAAsB,EACtB,MAAM,0CAA0C,CAAC;AAElD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE/D;;GAEG;AACH,UAAU,mBAAmB,CAAC,MAAM;IACnC;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,sBAAsB,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;CAE5D;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB,CAAC,MAAM,CAC/C,SAAQ,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,MAAM,mBAAmB,CAAC,MAAM,CAAC,CAAC,EACxF,mBAAmB,CAAC,MAAM,CAAC;CAAG;AAEhC;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB,CAAC,MAAM,CAC/C,SAAQ,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,MAAM,mBAAmB,CAAC,MAAM,CAAC,CAAC,EACxF,mBAAmB,CAAC,MAAM,CAAC;CAAG;AAEhC;;;;;;;;GAQG;AACH,MAAM,WAAW,yBAAyB,CAAC,CAAC;IAC3C,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE;QAIN,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,wBAAwB,CAAC,CAAC,CAAC,GAAG,yBAAyB,CAAC,CAAC,CAAC,CAAC;KACpF,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,gCAAgC,CAAC,CAAC,IAC3C,wBAAwB,CAAC,CAAC,CAAC,GAC3B,yBAAyB,CAAC,CAAC,CAAC,CAAC;AAEhC;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,yBAAyB,CACpC,CAAC,SACE,aAAa,CAAC,cAAc,CAAC,OAAO,CAAC,GACrC,aAAa,CAAC,kBAAkB,CAAC,OAAO,CAAC,GACzC,aAAa,CAAC,kBAAkB,CAAC,OAAO,CAAC,IAE5C,CAAC,SAAS,aAAa,CAAC,cAAc,CAAC,MAAM,MAAM,CAAC,GACjD,kCAAkC,CAAC,UAAU,CAC7C,CAAC,EACD,aAAa,CAAC,cAAc,CAAC,CAAC,CAAC,EAE/B,yBAAyB,CAAC,MAAM,CAAC,EAEjC,kCAAkC,CAAC,mBAAmB,CACrD,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG;IAClB,KAAK,EAAE;SACL,MAAM,IAAI,MAAM,CAAC,CAAC,OAAO,CAAC,GAAG,yBAAyB,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;KAC3E,CAAC;CACF,CACD,CACD,GACA,CAAC,SACE,aAAa,CAAC,kBAAkB,CAAC,MAAM,MAAM,CAAC,GAC9C,aAAa,CAAC,kBAAkB,CAAC,MAAM,MAAM,CAAC,GAChD,kCAAkC,CAAC,mBAAmB,CACtD,IAAI,CAAC,CAAC,EAAE,MAAM,mBAAmB,CAAC,MAAM,CAAC,CAAC,GAAG,mBAAmB,CAAC,MAAM,CAAC,CACxE,GACA,KAAK,CAAC"}

package/dist/validatableTypes.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=validatableTypes.js.map

package/dist/validatableTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validatableTypes.js","sourceRoot":"","sources":["../src/validatableTypes.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\tInternalCoreInterfacesUtilityTypes,\n\tOpaqueJsonDeserialized,\n} from \"@fluidframework/core-interfaces/internal\";\n\nimport type { InternalTypes } from \"./exposedInternalTypes.js\";\n\n/**\n * Metadata for a value that may have been validated by a {@link StateSchemaValidator} function.\n */\ninterface ValidatableMetadata<TValue> {\n\t/**\n\t * Contains a validated value or undefined if `value` is invalid.\n\t *\n\t * This property will not be present if the data has not been validated.\n\t * If it is present and `undefined`, the value has been checked and found to be invalid.\n\t * Otherwise it will be the validated value.\n\t */\n\tvalidatedValue?: OpaqueJsonDeserialized<TValue> | undefined;\n\t// typeCheck: \"do you have me?\";\n}\n\n/**\n * Represents data with optional value that may have been validated by a\n * {@link @fluidframework/presence#StateSchemaValidator} function.\n *\n * @internal\n */\nexport interface ValidatableOptionalState<TValue>\n\textends Omit<InternalTypes.ValueOptionalState<TValue>, keyof ValidatableMetadata<TValue>>,\n\t\tValidatableMetadata<TValue> {}\n\n/**\n * Represents data with required value that may have been validated by a\n * {@link @fluidframework/presence#StateSchemaValidator} function.\n *\n * @internal\n */\nexport interface ValidatableRequiredState<TValue>\n\textends Omit<InternalTypes.ValueRequiredState<TValue>, keyof ValidatableMetadata<TValue>>,\n\t\tValidatableMetadata<TValue> {}\n\n/**\n * A directory of validatable values, where each value may be an optional\n * state or another directory.\n *\n * @remarks\n * The is the validatable version of {@link InternalTypes.ValueDirectory}.\n *\n * @internal\n */\nexport interface ValidatableValueDirectory<T> {\n\trev: number;\n\titems: {\n\t\t// Caution: any particular item may or may not exist\n\t\t// Typescript does not support absent keys without forcing type to also be undefined.\n\t\t// See https://github.com/microsoft/TypeScript/issues/42810.\n\t\t[name: string | number]: ValidatableOptionalState<T> | ValidatableValueDirectory<T>;\n\t};\n}\n\n/**\n * Convenience type for a validatable required state or a directory of values.\n *\n * @remarks\n * This is the validatable version of {@link InternalTypes.ValueDirectoryOrState}.\n *\n * @internal\n */\nexport type ValidatableValueDirectoryOrState<T> =\n\t| ValidatableRequiredState<T>\n\t| ValidatableValueDirectory<T>;\n\n/**\n * Transforms basic value datastore / protocol type into equivalent type\n * with validation support.\n *\n * @remarks\n * Use when some more specific or parameterized type equivalent of\n * `InternalTypes.Value(Directory|RequiredState|OptionalState)` is needed.\n *\n * Basically, wherever a `*ValueState` appears it is extended with\n * {@link ValidatableMetadata} to support validation.\n *\n * @internal\n */\nexport type ValidatableValueStructure<\n\tT extends\n\t\t| InternalTypes.ValueDirectory<unknown>\n\t\t| InternalTypes.ValueRequiredState<unknown>\n\t\t| InternalTypes.ValueOptionalState<unknown>,\n> =\n\tT extends InternalTypes.ValueDirectory<infer TValue>\n\t\t? InternalCoreInterfacesUtilityTypes.IfSameType<\n\t\t\t\tT,\n\t\t\t\tInternalTypes.ValueDirectory<T>,\n\t\t\t\t// Use canonical type for exact match\n\t\t\t\tValidatableValueDirectory<TValue>,\n\t\t\t\t// Inexact match => recurse\n\t\t\t\tInternalCoreInterfacesUtilityTypes.FlattenIntersection<\n\t\t\t\t\tOmit<T, \"items\"> & {\n\t\t\t\t\t\titems: {\n\t\t\t\t\t\t\t[KItems in keyof T[\"items\"]]: ValidatableValueStructure<T[\"items\"][KItems]>;\n\t\t\t\t\t\t};\n\t\t\t\t\t}\n\t\t\t\t>\n\t\t\t>\n\t\t: T extends\n\t\t\t\t\t| InternalTypes.ValueRequiredState<infer TValue>\n\t\t\t\t\t| InternalTypes.ValueOptionalState<infer TValue>\n\t\t\t? InternalCoreInterfacesUtilityTypes.FlattenIntersection<\n\t\t\t\t\tOmit<T, keyof ValidatableMetadata<TValue>> & ValidatableMetadata<TValue>\n\t\t\t\t>\n\t\t\t: never;\n"]}

package/dist/workspace/workspaceTypes.d.ts

@@ -0,0 +1,18 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { AttendeeId } from "@fluid-internal/presence-definitions";
+import type { ValidatableValueDirectoryOrState } from "@fluid-internal/presence-definitions/internal";
+/**
+ * Basic structure of set of {@link Attendee} records within Presence datastore
+ *
+ * @remarks
+ * This exists per named state in State Managers.
+ *
+ * @internal
+ */
+export interface ClientRecord<TValue extends ValidatableValueDirectoryOrState<unknown>> {
+    [AttendeeId: AttendeeId]: TValue;
+}
+//# sourceMappingURL=workspaceTypes.d.ts.map

package/dist/workspace/workspaceTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workspaceTypes.d.ts","sourceRoot":"","sources":["../../src/workspace/workspaceTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AACvE,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,+CAA+C,CAAC;AAEtG;;;;;;;GAOG;AACH,MAAM,WAAW,YAAY,CAAC,MAAM,SAAS,gCAAgC,CAAC,OAAO,CAAC;IAIrF,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,CAAC;CACjC"}

package/dist/workspace/workspaceTypes.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=workspaceTypes.js.map

package/dist/workspace/workspaceTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workspaceTypes.js","sourceRoot":"","sources":["../../src/workspace/workspaceTypes.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 { AttendeeId } from \"@fluid-internal/presence-definitions\";\nimport type { ValidatableValueDirectoryOrState } from \"@fluid-internal/presence-definitions/internal\";\n\n/**\n * Basic structure of set of {@link Attendee} records within Presence datastore\n *\n * @remarks\n * This exists per named state in State Managers.\n *\n * @internal\n */\nexport interface ClientRecord<TValue extends ValidatableValueDirectoryOrState<unknown>> {\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[AttendeeId: AttendeeId]: TValue;\n}\n"]}

package/dist/workspace-runtime/presenceStatesTypes.d.ts

@@ -0,0 +1,72 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { AttendeeId, BroadcastControlSettings, ClientConnectionId, StatesWorkspaceSchema } from "@fluid-internal/presence-definitions";
+import type { AnyWorkspace, InternalTypes, PostUpdateAction, ValidatableValueDirectoryOrState } from "@fluid-internal/presence-definitions/internal";
+import type { ClientRecord } from "@fluid-internal/presence-definitions/internal/workspace";
+/**
+ * Miscellaneous options for local state updates
+ *
+ * @internal
+ */
+export interface RuntimeLocalUpdateOptions {
+    /**
+     * The maximum time in milliseconds that this update is allowed to be
+     * delayed before it must be sent to the service.
+     */
+    allowableUpdateLatencyMs: number;
+    /**
+     * Special option allowed for unicast notifications.
+     */
+    targetClientId?: ClientConnectionId;
+}
+/**
+ * ValueElementMap is a map of key to a map of attendeeId to ValueState.
+ *
+ * @remarks
+ * It is not restricted to the schema of the map as it may receive updates from other clients
+ * with managers that have not been registered locally. Each map node is responsible for keeping
+ * all session's state to be able to pick an arbitrary client to rebroadcast to others.
+ *
+ * This generic aspect makes some typing difficult. The loose typing is not broadcast to the
+ * consumers. They are expected to maintain their schema over multiple versions of clients.
+ *
+ * @internal
+ */
+export interface ValueElementMap<_TSchema extends StatesWorkspaceSchema> {
+    [key: string]: ClientRecord<ValidatableValueDirectoryOrState<unknown>>;
+}
+/**
+ * Data content of a datastore entry in update messages
+ *
+ * @internal
+ */
+export type ClientUpdateEntry = InternalTypes.ValueDirectoryOrState<unknown> & {
+    ignoreUnmonitored?: true;
+};
+/**
+ * Record of client update entries keyed by attendee ID
+ */
+interface ClientUpdateRecord {
+    [AttendeeId: AttendeeId]: ClientUpdateEntry;
+}
+/**
+ * Record of value updates keyed by value key
+ *
+ * @internal
+ */
+export interface ValueUpdateRecord {
+    [valueKey: string]: ClientUpdateRecord;
+}
+/**
+ * Contract for Workspaces as required by `PresenceDatastoreManager`
+ *
+ * @internal
+ */
+export interface PresenceStatesInternal {
+    ensureContent<TSchemaAdditional extends StatesWorkspaceSchema>(content: TSchemaAdditional, controls: BroadcastControlSettings | undefined): AnyWorkspace<TSchemaAdditional>;
+    processUpdate(received: number, timeModifier: number, remoteDatastore: ValueUpdateRecord, senderConnectionId: ClientConnectionId): PostUpdateAction[];
+}
+export {};
+//# sourceMappingURL=presenceStatesTypes.d.ts.map

package/dist/workspace-runtime/presenceStatesTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"presenceStatesTypes.d.ts","sourceRoot":"","sources":["../../src/workspace-runtime/presenceStatesTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,UAAU,EACV,wBAAwB,EACxB,kBAAkB,EAClB,qBAAqB,EACrB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,EACX,YAAY,EACZ,aAAa,EACb,gBAAgB,EAChB,gCAAgC,EAChC,MAAM,+CAA+C,CAAC;AACvD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yDAAyD,CAAC;AAE5F;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACzC;;;OAGG;IACH,wBAAwB,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,cAAc,CAAC,EAAE,kBAAkB,CAAC;CACpC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,eAAe,CAAC,QAAQ,SAAS,qBAAqB;IACtE,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAC,gCAAgC,CAAC,OAAO,CAAC,CAAC,CAAC;CACvE;AAuBD;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,aAAa,CAAC,qBAAqB,CAAC,OAAO,CAAC,GAAG;IAC9E,iBAAiB,CAAC,EAAE,IAAI,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,UAAU,kBAAkB;IAC3B,CAAC,UAAU,EAAE,UAAU,GAAG,iBAAiB,CAAC;CAC5C;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IACjC,CAAC,QAAQ,EAAE,MAAM,GAAG,kBAAkB,CAAC;CACvC;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACtC,aAAa,CAAC,iBAAiB,SAAS,qBAAqB,EAC5D,OAAO,EAAE,iBAAiB,EAC1B,QAAQ,EAAE,wBAAwB,GAAG,SAAS,GAC5C,YAAY,CAAC,iBAAiB,CAAC,CAAC;IACnC,aAAa,CACZ,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,iBAAiB,EAClC,kBAAkB,EAAE,kBAAkB,GACpC,gBAAgB,EAAE,CAAC;CACtB"}

package/dist/workspace-runtime/presenceStatesTypes.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=presenceStatesTypes.js.map

package/dist/workspace-runtime/presenceStatesTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"presenceStatesTypes.js","sourceRoot":"","sources":["../../src/workspace-runtime/presenceStatesTypes.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\tAttendeeId,\n\tBroadcastControlSettings,\n\tClientConnectionId,\n\tStatesWorkspaceSchema,\n} from \"@fluid-internal/presence-definitions\";\nimport type {\n\tAnyWorkspace,\n\tInternalTypes,\n\tPostUpdateAction,\n\tValidatableValueDirectoryOrState,\n} from \"@fluid-internal/presence-definitions/internal\";\nimport type { ClientRecord } from \"@fluid-internal/presence-definitions/internal/workspace\";\n\n/**\n * Miscellaneous options for local state updates\n *\n * @internal\n */\nexport interface RuntimeLocalUpdateOptions {\n\t/**\n\t * The maximum time in milliseconds that this update is allowed to be\n\t * delayed before it must be sent to the service.\n\t */\n\tallowableUpdateLatencyMs: number;\n\n\t/**\n\t * Special option allowed for unicast notifications.\n\t */\n\ttargetClientId?: ClientConnectionId;\n}\n\n/**\n * ValueElementMap is a map of key to a map of attendeeId to ValueState.\n *\n * @remarks\n * It is not restricted to the schema of the map as it may receive updates from other clients\n * with managers that have not been registered locally. Each map node is responsible for keeping\n * all session's state to be able to pick an arbitrary client to rebroadcast to others.\n *\n * This generic aspect makes some typing difficult. The loose typing is not broadcast to the\n * consumers. They are expected to maintain their schema over multiple versions of clients.\n *\n * @internal\n */\nexport interface ValueElementMap<_TSchema extends StatesWorkspaceSchema> {\n\t[key: string]: ClientRecord<ValidatableValueDirectoryOrState<unknown>>;\n}\n\n// An attempt to make the type more precise, but it is not working.\n// If the casting in support code is too much we could keep two references to the same\n// complete datastore, but with the respective types desired.\n// type ValueElementMap<TSchema extends PresenceStatesNodeSchema> =\n// \t| {\n// \t\t\t[Key in keyof TSchema & string]?: {\n// \t\t\t\t[AttendeeId: AttendeeId]: InternalTypes.ValueDirectoryOrState<MapSchemaElement<TSchema,\"value\",Key>>;\n// \t\t\t};\n// \t  }\n// \t| {\n// \t\t\t[key: string]: ClientRecord<InternalTypes.ValueDirectoryOrState<unknown>>;\n// \t  };\n// interface ValueElementMap<TValue> {\n// \t[Id: string]: ClientRecord<InternalTypes.ValueDirectoryOrState<TValue>>;\n// \t// Version with local packed in is convenient for map, but not for join broadcast to serialize simply.\n// \t// [Id: string]: {\n// \t// \tlocal: InternalTypes.ValueDirectoryOrState<TValue>;\n// \t// \tall: ClientRecord<InternalTypes.ValueDirectoryOrState<TValue>>;\n// \t// };\n// }\n\n/**\n * Data content of a datastore entry in update messages\n *\n * @internal\n */\nexport type ClientUpdateEntry = InternalTypes.ValueDirectoryOrState<unknown> & {\n\tignoreUnmonitored?: true;\n};\n\n/**\n * Record of client update entries keyed by attendee ID\n */\ninterface ClientUpdateRecord {\n\t[AttendeeId: AttendeeId]: ClientUpdateEntry;\n}\n\n/**\n * Record of value updates keyed by value key\n *\n * @internal\n */\nexport interface ValueUpdateRecord {\n\t[valueKey: string]: ClientUpdateRecord;\n}\n\n/**\n * Contract for Workspaces as required by `PresenceDatastoreManager`\n *\n * @internal\n */\nexport interface PresenceStatesInternal {\n\tensureContent<TSchemaAdditional extends StatesWorkspaceSchema>(\n\t\tcontent: TSchemaAdditional,\n\t\tcontrols: BroadcastControlSettings | undefined,\n\t): AnyWorkspace<TSchemaAdditional>;\n\tprocessUpdate(\n\t\treceived: number,\n\t\ttimeModifier: number,\n\t\tremoteDatastore: ValueUpdateRecord,\n\t\tsenderConnectionId: ClientConnectionId,\n\t): PostUpdateAction[];\n}\n"]}

package/dist/workspace-states/stateDatastoreTypes.d.ts

@@ -0,0 +1,42 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { AttendeeId, ClientConnectionId, PresenceWithNotifications as Presence } from "@fluid-internal/presence-definitions";
+import type { InternalTypes, ValidatableValueDirectoryOrState, ValidatableValueStructure } from "@fluid-internal/presence-definitions/internal";
+import type { ClientRecord } from "@fluid-internal/presence-definitions/internal/workspace";
+/**
+ * Miscellaneous options for local state updates
+ *
+ * @internal
+ */
+export interface LocalStateUpdateOptions {
+    /**
+     * When defined, this is the maximum time in milliseconds that this
+     * update is allowed to be delayed before it must be sent to service.
+     * When `undefined`, the callee may determine maximum delay.
+     */
+    allowableUpdateLatencyMs: number | undefined;
+    /**
+     * Special option allowed for unicast notifications.
+     */
+    targetClientId?: ClientConnectionId;
+}
+/**
+ * Contract for States Workspace to support State Manager access to
+ * datastore and general internal presence knowledge.
+ *
+ * @internal
+ */
+export interface StateDatastore<TKey extends string, TLocalUpdateValue extends InternalTypes.ValueDirectoryOrState<unknown>, TStoredValue extends ValidatableValueDirectoryOrState<unknown> = ValidatableValueStructure<TLocalUpdateValue>> {
+    readonly presence: Presence;
+    localUpdate(key: TKey, value: TLocalUpdateValue & {
+        ignoreUnmonitored?: true;
+    }, options: LocalStateUpdateOptions): void;
+    update(key: TKey, attendeeId: AttendeeId, value: TStoredValue): void;
+    knownValues(key: TKey): {
+        self: AttendeeId | undefined;
+        states: ClientRecord<TStoredValue>;
+    };
+}
+//# sourceMappingURL=stateDatastoreTypes.d.ts.map

package/dist/workspace-states/stateDatastoreTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stateDatastoreTypes.d.ts","sourceRoot":"","sources":["../../src/workspace-states/stateDatastoreTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,UAAU,EACV,kBAAkB,EAClB,yBAAyB,IAAI,QAAQ,EACrC,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,EACX,aAAa,EACb,gCAAgC,EAChC,yBAAyB,EACzB,MAAM,+CAA+C,CAAC;AACvD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yDAAyD,CAAC;AAE5F;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACvC;;;;OAIG;IACH,wBAAwB,EAAE,MAAM,GAAG,SAAS,CAAC;IAE7C;;OAEG;IACH,cAAc,CAAC,EAAE,kBAAkB,CAAC;CACpC;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc,CAC9B,IAAI,SAAS,MAAM,EACnB,iBAAiB,SAAS,aAAa,CAAC,qBAAqB,CAAC,OAAO,CAAC,EACtE,YAAY,SACX,gCAAgC,CAAC,OAAO,CAAC,GAAG,yBAAyB,CAAC,iBAAiB,CAAC;IAEzF,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,WAAW,CACV,GAAG,EAAE,IAAI,EACT,KAAK,EAAE,iBAAiB,GAAG;QAC1B,iBAAiB,CAAC,EAAE,IAAI,CAAC;KACzB,EACD,OAAO,EAAE,uBAAuB,GAC9B,IAAI,CAAC;IACR,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,UAAU,EAAE,KAAK,EAAE,YAAY,GAAG,IAAI,CAAC;IACrE,WAAW,CAAC,GAAG,EAAE,IAAI,GAAG;QACvB,IAAI,EAAE,UAAU,GAAG,SAAS,CAAC;QAC7B,MAAM,EAAE,YAAY,CAAC,YAAY,CAAC,CAAC;KACnC,CAAC;CACF"}

package/dist/workspace-states/stateDatastoreTypes.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=stateDatastoreTypes.js.map

package/dist/workspace-states/stateDatastoreTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stateDatastoreTypes.js","sourceRoot":"","sources":["../../src/workspace-states/stateDatastoreTypes.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\tAttendeeId,\n\tClientConnectionId,\n\tPresenceWithNotifications as Presence,\n} from \"@fluid-internal/presence-definitions\";\nimport type {\n\tInternalTypes,\n\tValidatableValueDirectoryOrState,\n\tValidatableValueStructure,\n} from \"@fluid-internal/presence-definitions/internal\";\nimport type { ClientRecord } from \"@fluid-internal/presence-definitions/internal/workspace\";\n\n/**\n * Miscellaneous options for local state updates\n *\n * @internal\n */\nexport interface LocalStateUpdateOptions {\n\t/**\n\t * When defined, this is the maximum time in milliseconds that this\n\t * update is allowed to be delayed before it must be sent to service.\n\t * When `undefined`, the callee may determine maximum delay.\n\t */\n\tallowableUpdateLatencyMs: number | undefined;\n\n\t/**\n\t * Special option allowed for unicast notifications.\n\t */\n\ttargetClientId?: ClientConnectionId;\n}\n\n/**\n * Contract for States Workspace to support State Manager access to\n * datastore and general internal presence knowledge.\n *\n * @internal\n */\nexport interface StateDatastore<\n\tTKey extends string,\n\tTLocalUpdateValue extends InternalTypes.ValueDirectoryOrState<unknown>,\n\tTStoredValue extends\n\t\tValidatableValueDirectoryOrState<unknown> = ValidatableValueStructure<TLocalUpdateValue>,\n> {\n\treadonly presence: Presence;\n\tlocalUpdate(\n\t\tkey: TKey,\n\t\tvalue: TLocalUpdateValue & {\n\t\t\tignoreUnmonitored?: true;\n\t\t},\n\t\toptions: LocalStateUpdateOptions,\n\t): void;\n\tupdate(key: TKey, attendeeId: AttendeeId, value: TStoredValue): void;\n\tknownValues(key: TKey): {\n\t\tself: AttendeeId | undefined;\n\t\tstates: ClientRecord<TStoredValue>;\n\t};\n}\n"]}

package/lib/baseTypes.d.ts

@@ -0,0 +1,24 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * A Fluid client connection identifier.
+ *
+ * @remarks
+ * Each client connection is given a unique identifier for the duration of the
+ * connection. If a client disconnects and reconnects, it will be given a new
+ * identifier. Prefer use of {@link Attendee} as a way to identify clients
+ * in a session. {@link Attendee.getConnectionId} will provide the current
+ * connection identifier for a logical attendee.
+ *
+ * @privateRemarks
+ * This represents what is commonly `clientId` in Fluid code. Ideally this is
+ * moved somewhere more central and we brand it to avoid confusion with other
+ * strings. Branding broadly is likely a breaking change and may take decent
+ * effort to manage.
+ *
+ * @public
+ */
+export type ClientConnectionId = string;
+//# sourceMappingURL=baseTypes.d.ts.map

package/lib/baseTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"baseTypes.d.ts","sourceRoot":"","sources":["../src/baseTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC"}

package/lib/baseTypes.js

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

package/lib/baseTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"baseTypes.js","sourceRoot":"","sources":["../src/baseTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * A Fluid client connection identifier.\n *\n * @remarks\n * Each client connection is given a unique identifier for the duration of the\n * connection. If a client disconnects and reconnects, it will be given a new\n * identifier. Prefer use of {@link Attendee} as a way to identify clients\n * in a session. {@link Attendee.getConnectionId} will provide the current\n * connection identifier for a logical attendee.\n *\n * @privateRemarks\n * This represents what is commonly `clientId` in Fluid code. Ideally this is\n * moved somewhere more central and we brand it to avoid confusion with other\n * strings. Branding broadly is likely a breaking change and may take decent\n * effort to manage.\n *\n * @public\n */\nexport type ClientConnectionId = string;\n"]}

package/lib/broadcastControlsTypes.d.ts

@@ -0,0 +1,38 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Common controls for States objects.
+ *
+ * @sealed
+ * @public
+ */
+export interface BroadcastControls {
+    /**
+     * Maximum time in milliseconds that a local value update is allowed
+     * to remain pending before it must be broadcast.
+     *
+     * @remarks
+     * There is no guarantee of broadcast within time allowed
+     * as other conditions such as disconnect or service throttling may
+     * cause a delay.
+     *
+     * Setting to `undefined` will restore to a system default.
+     */
+    allowableUpdateLatencyMs: number | undefined;
+}
+/**
+ * Value set to configure {@link BroadcastControls}.
+ *
+ * @public
+ */
+export interface BroadcastControlSettings {
+    /**
+     * {@inheritdoc BroadcastControls.allowableUpdateLatencyMs}
+     *
+     * @defaultValue 60 [milliseconds]
+     */
+    readonly allowableUpdateLatencyMs?: number;
+}
+//# sourceMappingURL=broadcastControlsTypes.d.ts.map

package/lib/broadcastControlsTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"broadcastControlsTypes.d.ts","sourceRoot":"","sources":["../src/broadcastControlsTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IACjC;;;;;;;;;;OAUG;IACH,wBAAwB,EAAE,MAAM,GAAG,SAAS,CAAC;CAc7C;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACxC;;;;OAIG;IACH,QAAQ,CAAC,wBAAwB,CAAC,EAAE,MAAM,CAAC;CAS3C"}

package/lib/broadcastControlsTypes.js

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

package/lib/broadcastControlsTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"broadcastControlsTypes.js","sourceRoot":"","sources":["../src/broadcastControlsTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Common controls for States objects.\n *\n * @sealed\n * @public\n */\nexport interface BroadcastControls {\n\t/**\n\t * Maximum time in milliseconds that a local value update is allowed\n\t * to remain pending before it must be broadcast.\n\t *\n\t * @remarks\n\t * There is no guarantee of broadcast within time allowed\n\t * as other conditions such as disconnect or service throttling may\n\t * cause a delay.\n\t *\n\t * Setting to `undefined` will restore to a system default.\n\t */\n\tallowableUpdateLatencyMs: number | undefined;\n\n\t/**\n\t * Target time in milliseconds between oldest changed local state\n\t * has been broadcast and forced rebroadcast of all local values.\n\t * A value of less than 10 disables forced refresh.\n\t *\n\t * @privateRemarks\n\t * Any time less than 10 milliseconds is likely to generate too\n\t * many signals. Ideally this feature becomes obsolete as\n\t * we understand the system better and account for holes.\n\t */\n\t// forcedRefreshIntervalMs is removed until it is supported.\n\t// forcedRefreshIntervalMs: number | undefined;\n}\n\n/**\n * Value set to configure {@link BroadcastControls}.\n *\n * @public\n */\nexport interface BroadcastControlSettings {\n\t/**\n\t * {@inheritdoc BroadcastControls.allowableUpdateLatencyMs}\n\t *\n\t * @defaultValue 60 [milliseconds]\n\t */\n\treadonly allowableUpdateLatencyMs?: number;\n\n\t/**\n\t * {@inheritdoc BroadcastControls.forcedRefreshIntervalMs}\n\t *\n\t * @defaultValue 0 (disabled)\n\t */\n\t// forcedRefreshIntervalMs is removed until it is supported.\n\t// readonly forcedRefreshIntervalMs?: number;\n}\n"]}