@fluidframework/presence 2.92.0 → 2.100.0

package/dist/presence.d.ts

@@ -1,229 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import type { Listenable } from "@fluidframework/core-interfaces";
-import type { SessionId } from "@fluidframework/id-compressor";
-import type { ClientConnectionId } from "./baseTypes.js";
-import type { BroadcastControlSettings } from "./broadcastControlsTypes.js";
-import type { NotificationsWorkspace, NotificationsWorkspaceSchema, StatesWorkspace, StatesWorkspaceSchema, WorkspaceAddress } from "./types.js";
-/**
- * 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 Attendee} as a way to
- * identify clients in a session. {@link Attendee.attendeeId} will provide
- * the session ID.
- *
- * @beta
- */
-export type AttendeeId = SessionId & {
-    readonly AttendeeId: "AttendeeId";
-};
-/**
- * The connection status of the {@link Attendee}.
- *
- * @beta
- */
-export declare const AttendeeStatus: {
-    /**
-     * The {@link Attendee} is connected to the Fluid service.
-     */
-    readonly Connected: "Connected";
-    /**
-     * The {@link Attendee} is not connected to the Fluid service.
-     */
-    readonly Disconnected: "Disconnected";
-};
-/**
- * Represents the connection status of an {@link Attendee}.
- *
- * This type can be either `'Connected'` or `'Disconnected'`, indicating whether
- * the attendee 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).
- *
- * @beta
- */
-export type AttendeeStatus = (typeof AttendeeStatus)[keyof typeof AttendeeStatus];
-/**
- * A client within a Fluid session (period of container connectivity to service).
- *
- * @remarks
- * Note: This is very preliminary attendee representation.
- *
- * {@link Attendee} 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 Attendee.getConnectionStatus}
- * may change over time, `Attendee` 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
- * @beta
- */
-export interface Attendee<SpecificAttendeeId extends AttendeeId = AttendeeId> {
-    /**
-     * The session ID of the client that is stable over all connections.
-     */
-    readonly attendeeId: SpecificAttendeeId;
-    /**
-     * Get current client connection ID.
-     *
-     * @returns Current client connection ID.
-     *
-     * @remarks
-     * Connection ID will change on reconnect.
-     *
-     * If {@link Attendee.getConnectionStatus} is {@link (AttendeeStatus:variable).Disconnected}, this will represent the last known connection ID.
-     */
-    getConnectionId(): ClientConnectionId;
-    /**
-     * Get connection status of attendee.
-     *
-     * @returns Connection status of attendee.
-     *
-     */
-    getConnectionStatus(): AttendeeStatus;
-}
-/**
- * Utility type limiting to a specific attendee. (A attendee with
- * a specific session ID - not just any session ID.)
- */
-export type SpecificAttendee<SpecificAttendeeId extends AttendeeId> = string extends SpecificAttendeeId ? never : Attendee<SpecificAttendeeId>;
-/**
- * Events from {@link Presence.attendees}.
- *
- * @sealed
- * @beta
- */
-export interface AttendeesEvents {
-    /**
-     * Raised when new client joins session.
-     *
-     * @eventProperty
-     */
-    attendeeConnected: (attendee: Attendee) => void;
-    /**
-     * Raised when client appears disconnected from session.
-     *
-     * @eventProperty
-     */
-    attendeeDisconnected: (attendee: Attendee) => void;
-}
-/**
- * Events from {@link Presence}.
- *
- * @sealed
- * @beta
- */
-export interface PresenceEvents {
-    /**
-     * 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: WorkspaceAddress, type: "States" | "Notifications" | "Unknown") => void;
-}
-/**
- * Provides top-level access to Presence feature set including known
- * {@link Attendee}s within a session and their custom states kept
- * under {@link StatesWorkspace}s.
- *
- * @sealed
- * @beta
- */
-export interface Presence {
-    /**
-     * Events for Presence.
-     */
-    readonly events: Listenable<PresenceEvents>;
-    /**
-     * Container-wide {@link Attendee} information and event provider.
-     *
-     * @remarks
-     * This provides access to all {@link Attendee}s in the session, including
-     * the current client. As {@link StatesWorkspace} aren't required to be
-     * uniform across an application, some {@link Attendee}s may be enumerated
-     * here while not being present in any particular {@link StatesWorkspace}.
-     */
-    readonly attendees: {
-        /**
-         * Events for {@link Attendee}s.
-         */
-        readonly events: Listenable<AttendeesEvents>;
-        /**
-         * Get all {@link Attendee}s in the session.
-         *
-         * @remarks
-         * Attendee states are dynamic and will change as clients join and leave
-         * the session.
-         */
-        getAttendees(): ReadonlySet<Attendee>;
-        /**
-         * Lookup a specific {@link Attendee} in the session.
-         *
-         * @param clientId - Client connection or session ID
-         */
-        getAttendee(clientId: ClientConnectionId | AttendeeId): Attendee;
-        /**
-         * Get this client's {@link Attendee}.
-         *
-         * @returns This client's attendee.
-         */
-        getMyself(): Attendee;
-    };
-    /**
-     * Provides access to {@link StatesWorkspace}s that allow clients to
-     * manage custom states.
-     */
-    readonly states: {
-        /**
-         * Acquires a {@link StatesWorkspace} from store or adds new one.
-         *
-         * @param workspaceAddress - Address of the requested {@link StatesWorkspace}
-         * @param requestedStates - Requested states for the workspace
-         * @param controls - Optional settings for default broadcast controls
-         * @returns A {@link StatesWorkspace}
-         */
-        getWorkspace<StatesSchema extends Partial<StatesWorkspaceSchema<SchemaKeys>>, SchemaKeys extends string & keyof StatesSchema = string & keyof StatesSchema>(workspaceAddress: WorkspaceAddress, requestedStates: StatesSchema, controls?: BroadcastControlSettings): StatesWorkspace<StatesSchema, unknown, SchemaKeys>;
-    };
-}
-/**
- * Provides top-level access to Presence feature set including known
- * {@link Attendee}s within a session and their custom states and
- * notifications kept under {@link StatesWorkspace}s and
- * {@link NotificationsWorkspace}s.
- *
- * @remarks
- * To access this alpha API, cast any `{@link Presence}` to `PresenceWithNotifications`.
- *
- * @sealed
- * @alpha
- */
-export interface PresenceWithNotifications extends Presence {
-    readonly notifications: {
-        /**
-         * Acquires a Notifications workspace from store or adds new one.
-         *
-         * @param workspaceAddress - Address of the requested Notifications Workspace
-         * @param requestedNotifications - Requested notifications for the workspace
-         * @returns A Notifications workspace
-         */
-        getWorkspace<NotificationsSchema extends Partial<NotificationsWorkspaceSchema<SchemaKeys>>, SchemaKeys extends string & keyof NotificationsSchema = string & keyof NotificationsSchema>(notificationsId: WorkspaceAddress, requestedNotifications: NotificationsSchema): NotificationsWorkspace<NotificationsSchema, SchemaKeys>;
-    };
-}
-//# sourceMappingURL=presence.d.ts.map

package/dist/presence.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"presence.d.ts","sourceRoot":"","sources":["../src/presence.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAC;AAE/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AAC5E,OAAO,KAAK,EACX,sBAAsB,EACtB,4BAA4B,EAC5B,eAAe,EACf,qBAAqB,EACrB,gBAAgB,EAChB,MAAM,YAAY,CAAC;AAEpB;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,UAAU,GAAG,SAAS,GAAG;IAAE,QAAQ,CAAC,UAAU,EAAE,YAAY,CAAA;CAAE,CAAC;AAE3E;;;;GAIG;AACH,eAAO,MAAM,cAAc;IAC1B;;OAEG;;IAGH;;OAEG;;CAEM,CAAC;AAEX;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,OAAO,cAAc,CAAC,CAAC;AAElF;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,QAAQ,CAAC,kBAAkB,SAAS,UAAU,GAAG,UAAU;IAC3E;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC;IAExC;;;;;;;;;OASG;IACH,eAAe,IAAI,kBAAkB,CAAC;IAEtC;;;;;OAKG;IACH,mBAAmB,IAAI,cAAc,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAAC,kBAAkB,SAAS,UAAU,IACjE,MAAM,SAAS,kBAAkB,GAAG,KAAK,GAAG,QAAQ,CAAC,kBAAkB,CAAC,CAAC;AAE1E;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC/B;;;;OAIG;IACH,iBAAiB,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;IAEhD;;;;OAIG;IACH,oBAAoB,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;CACnD;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC9B;;;;;;;;;;;OAWG;IACH,kBAAkB,EAAE,CACnB,gBAAgB,EAAE,gBAAgB,EAClC,IAAI,EAAE,QAAQ,GAAG,eAAe,GAAG,SAAS,KACxC,IAAI,CAAC;CACV;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,QAAQ;IACxB;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,cAAc,CAAC,CAAC;IAE5C;;;;;;;;OAQG;IACH,QAAQ,CAAC,SAAS,EAAE;QACnB;;WAEG;QACH,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,eAAe,CAAC,CAAC;QAE7C;;;;;;WAMG;QACH,YAAY,IAAI,WAAW,CAAC,QAAQ,CAAC,CAAC;QAEtC;;;;WAIG;QACH,WAAW,CAAC,QAAQ,EAAE,kBAAkB,GAAG,UAAU,GAAG,QAAQ,CAAC;QAEjE;;;;WAIG;QACH,SAAS,IAAI,QAAQ,CAAC;KACtB,CAAC;IAEF;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE;QAChB;;;;;;;WAOG;QACH,YAAY,CACX,YAAY,SAAS,OAAO,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC,EAC/D,UAAU,SAAS,MAAM,GAAG,MAAM,YAAY,GAAG,MAAM,GAAG,MAAM,YAAY,EAE5E,gBAAgB,EAAE,gBAAgB,EAClC,eAAe,EAAE,YAAY,EAC7B,QAAQ,CAAC,EAAE,wBAAwB,GACjC,eAAe,CAAC,YAAY,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;KACtD,CAAC;CACF;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,yBAA0B,SAAQ,QAAQ;IAC1D,QAAQ,CAAC,aAAa,EAAE;QACvB;;;;;;WAMG;QACH,YAAY,CACX,mBAAmB,SAAS,OAAO,CAAC,4BAA4B,CAAC,UAAU,CAAC,CAAC,EAC7E,UAAU,SAAS,MAAM,GAAG,MAAM,mBAAmB,GAAG,MAAM,GAC7D,MAAM,mBAAmB,EAE1B,eAAe,EAAE,gBAAgB,EACjC,sBAAsB,EAAE,mBAAmB,GACzC,sBAAsB,CAAC,mBAAmB,EAAE,UAAU,CAAC,CAAC;KAC3D,CAAC;CACF"}

package/dist/presence.js

@@ -1,23 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AttendeeStatus = void 0;
-/**
- * The connection status of the {@link Attendee}.
- *
- * @beta
- */
-exports.AttendeeStatus = {
-    /**
-     * The {@link Attendee} is connected to the Fluid service.
-     */
-    Connected: "Connected",
-    /**
-     * The {@link Attendee} is not connected to the Fluid service.
-     */
-    Disconnected: "Disconnected",
-};
-//# sourceMappingURL=presence.js.map

package/dist/presence.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"presence.js","sourceRoot":"","sources":["../src/presence.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA6BH;;;;GAIG;AACU,QAAA,cAAc,GAAG;IAC7B;;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 { Listenable } from \"@fluidframework/core-interfaces\";\nimport type { SessionId } from \"@fluidframework/id-compressor\";\n\nimport type { ClientConnectionId } from \"./baseTypes.js\";\nimport type { BroadcastControlSettings } from \"./broadcastControlsTypes.js\";\nimport type {\n\tNotificationsWorkspace,\n\tNotificationsWorkspaceSchema,\n\tStatesWorkspace,\n\tStatesWorkspaceSchema,\n\tWorkspaceAddress,\n} from \"./types.js\";\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 Attendee} as a way to\n * identify clients in a session. {@link Attendee.attendeeId} will provide\n * the session ID.\n *\n * @beta\n */\nexport type AttendeeId = SessionId & { readonly AttendeeId: \"AttendeeId\" };\n\n/**\n * The connection status of the {@link Attendee}.\n *\n * @beta\n */\nexport const AttendeeStatus = {\n\t/**\n\t * The {@link Attendee} is connected to the Fluid service.\n\t */\n\tConnected: \"Connected\",\n\n\t/**\n\t * The {@link Attendee} 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 Attendee}.\n *\n * This type can be either `'Connected'` or `'Disconnected'`, indicating whether\n * the attendee 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 * @beta\n */\nexport type AttendeeStatus = (typeof AttendeeStatus)[keyof typeof AttendeeStatus];\n\n/**\n * A client within a Fluid session (period of container connectivity to service).\n *\n * @remarks\n * Note: This is very preliminary attendee representation.\n *\n * {@link Attendee} 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 Attendee.getConnectionStatus}\n * may change over time, `Attendee` 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 * @beta\n */\nexport interface Attendee<SpecificAttendeeId extends AttendeeId = AttendeeId> {\n\t/**\n\t * The session ID of the client that is stable over all connections.\n\t */\n\treadonly attendeeId: SpecificAttendeeId;\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 Attendee.getConnectionStatus} is {@link (AttendeeStatus:variable).Disconnected}, this will represent the last known connection ID.\n\t */\n\tgetConnectionId(): ClientConnectionId;\n\n\t/**\n\t * Get connection status of attendee.\n\t *\n\t * @returns Connection status of attendee.\n\t *\n\t */\n\tgetConnectionStatus(): AttendeeStatus;\n}\n\n/**\n * Utility type limiting to a specific attendee. (A attendee with\n * a specific session ID - not just any session ID.)\n */\nexport type SpecificAttendee<SpecificAttendeeId extends AttendeeId> =\n\tstring extends SpecificAttendeeId ? never : Attendee<SpecificAttendeeId>;\n\n/**\n * Events from {@link Presence.attendees}.\n *\n * @sealed\n * @beta\n */\nexport interface AttendeesEvents {\n\t/**\n\t * Raised when new client joins session.\n\t *\n\t * @eventProperty\n\t */\n\tattendeeConnected: (attendee: Attendee) => void;\n\n\t/**\n\t * Raised when client appears disconnected from session.\n\t *\n\t * @eventProperty\n\t */\n\tattendeeDisconnected: (attendee: Attendee) => void;\n}\n\n/**\n * Events from {@link Presence}.\n *\n * @sealed\n * @beta\n */\nexport interface PresenceEvents {\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: WorkspaceAddress,\n\t\ttype: \"States\" | \"Notifications\" | \"Unknown\",\n\t) => void;\n}\n\n/**\n * Provides top-level access to Presence feature set including known\n * {@link Attendee}s within a session and their custom states kept\n * under {@link StatesWorkspace}s.\n *\n * @sealed\n * @beta\n */\nexport interface Presence {\n\t/**\n\t * Events for Presence.\n\t */\n\treadonly events: Listenable<PresenceEvents>;\n\n\t/**\n\t * Container-wide {@link Attendee} information and event provider.\n\t *\n\t * @remarks\n\t * This provides access to all {@link Attendee}s in the session, including\n\t * the current client. As {@link StatesWorkspace} aren't required to be\n\t * uniform across an application, some {@link Attendee}s may be enumerated\n\t * here while not being present in any particular {@link StatesWorkspace}.\n\t */\n\treadonly attendees: {\n\t\t/**\n\t\t * Events for {@link Attendee}s.\n\t\t */\n\t\treadonly events: Listenable<AttendeesEvents>;\n\n\t\t/**\n\t\t * Get all {@link Attendee}s in the session.\n\t\t *\n\t\t * @remarks\n\t\t * Attendee states are dynamic and will change as clients join and leave\n\t\t * the session.\n\t\t */\n\t\tgetAttendees(): ReadonlySet<Attendee>;\n\n\t\t/**\n\t\t * Lookup a specific {@link Attendee} in the session.\n\t\t *\n\t\t * @param clientId - Client connection or session ID\n\t\t */\n\t\tgetAttendee(clientId: ClientConnectionId | AttendeeId): Attendee;\n\n\t\t/**\n\t\t * Get this client's {@link Attendee}.\n\t\t *\n\t\t * @returns This client's attendee.\n\t\t */\n\t\tgetMyself(): Attendee;\n\t};\n\n\t/**\n\t * Provides access to {@link StatesWorkspace}s that allow clients to\n\t * manage custom states.\n\t */\n\treadonly states: {\n\t\t/**\n\t\t * Acquires a {@link StatesWorkspace} from store or adds new one.\n\t\t *\n\t\t * @param workspaceAddress - Address of the requested {@link StatesWorkspace}\n\t\t * @param requestedStates - Requested states for the workspace\n\t\t * @param controls - Optional settings for default broadcast controls\n\t\t * @returns A {@link StatesWorkspace}\n\t\t */\n\t\tgetWorkspace<\n\t\t\tStatesSchema extends Partial<StatesWorkspaceSchema<SchemaKeys>>,\n\t\t\tSchemaKeys extends string & keyof StatesSchema = string & keyof StatesSchema,\n\t\t>(\n\t\t\tworkspaceAddress: WorkspaceAddress,\n\t\t\trequestedStates: StatesSchema,\n\t\t\tcontrols?: BroadcastControlSettings,\n\t\t): StatesWorkspace<StatesSchema, unknown, SchemaKeys>;\n\t};\n}\n\n/**\n * Provides top-level access to Presence feature set including known\n * {@link Attendee}s within a session and their custom states and\n * notifications kept under {@link StatesWorkspace}s and\n * {@link NotificationsWorkspace}s.\n *\n * @remarks\n * To access this alpha API, cast any `{@link Presence}` to `PresenceWithNotifications`.\n *\n * @sealed\n * @alpha\n */\nexport interface PresenceWithNotifications extends Presence {\n\treadonly notifications: {\n\t\t/**\n\t\t * Acquires a Notifications workspace from store or adds new one.\n\t\t *\n\t\t * @param workspaceAddress - Address of the requested Notifications Workspace\n\t\t * @param requestedNotifications - Requested notifications for the workspace\n\t\t * @returns A Notifications workspace\n\t\t */\n\t\tgetWorkspace<\n\t\t\tNotificationsSchema extends Partial<NotificationsWorkspaceSchema<SchemaKeys>>,\n\t\t\tSchemaKeys extends string & keyof NotificationsSchema = string &\n\t\t\t\tkeyof NotificationsSchema,\n\t\t>(\n\t\t\tnotificationsId: WorkspaceAddress,\n\t\t\trequestedNotifications: NotificationsSchema,\n\t\t): NotificationsWorkspace<NotificationsSchema, SchemaKeys>;\n\t};\n}\n"]}

package/dist/presenceDatastoreManager.d.ts

@@ -1,149 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import type { InboundExtensionMessage } from "@fluidframework/container-runtime-definitions/internal";
-import type { IEmitter } from "@fluidframework/core-interfaces/internal";
-import type { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
-import type { ClientConnectionId } from "./baseTypes.js";
-import type { BroadcastControlSettings } from "./broadcastControlsTypes.js";
-import type { AttendeeId, PresenceWithNotifications as Presence, PresenceEvents } from "./presence.js";
-import type { PresenceStatesInternal } from "./presenceStates.js";
-import type { InternalWorkspaceAddress, SignalMessages } from "./protocol.js";
-import type { IEphemeralRuntime } from "./runtimeTypes.js";
-import type { SystemWorkspaceDatastore } from "./systemWorkspace.js";
-import type { AnyWorkspace, NotificationsWorkspace, NotificationsWorkspaceSchema, StatesWorkspace, StatesWorkspaceSchema, WorkspaceAddress } from "./types.js";
-interface AnyWorkspaceEntry<TSchema extends StatesWorkspaceSchema> {
-    public: AnyWorkspace<TSchema>;
-    internal: PresenceStatesInternal;
-}
-/**
- * High-level contract for manager of singleton Presence datastore
- */
-export interface PresenceDatastoreManager {
-    joinSession(clientId: ClientConnectionId, alternateProvider: ClientConnectionId | undefined): void;
-    onDisconnected(): void;
-    getWorkspace<TSchema extends Partial<StatesWorkspaceSchema<TSchemaKeys>>, TSchemaKeys extends string & keyof TSchema>(internalWorkspaceAddress: `s:${WorkspaceAddress}`, requestedContent: TSchema, controls?: BroadcastControlSettings): StatesWorkspace<TSchema, unknown, TSchemaKeys>;
-    getWorkspace<TSchema extends Partial<NotificationsWorkspaceSchema<TSchemaKeys>>, TSchemaKeys extends string & keyof TSchema>(internalWorkspaceAddress: `n:${WorkspaceAddress}`, requestedContent: TSchema): NotificationsWorkspace<TSchema, TSchemaKeys>;
-    processSignal(message: InboundExtensionMessage<SignalMessages> & {
-        clientId: ClientConnectionId;
-    }, local: boolean, optional: boolean): void;
-}
-/**
- * Delays used for broadcasting join responses to clients.
- *
- * @remarks
- * Exported for test coordination.
- * These could be made customizable in the future to accommodate different
- * session configurations.
- */
-export declare const broadcastJoinResponseDelaysMs: {
-    /**
-     * The delay in milliseconds before a join response is sent to any client.
-     * This is used to accumulate other join response requests and reduce
-     * network traffic.
-     */
-    readonly namedResponder: 200;
-    /**
-     * The additional delay in milliseconds a backup responder waits before sending
-     * a join response to allow others to respond first.
-     */
-    readonly backupResponderIncrement: 40;
-};
-/**
- * Manages singleton datastore for all Presence.
- */
-export declare class PresenceDatastoreManagerImpl implements PresenceDatastoreManager {
-    private readonly attendeeId;
-    private readonly runtime;
-    private readonly logger;
-    private readonly events;
-    private readonly presence;
-    private readonly datastore;
-    private averageLatency;
-    private returnedMessages;
-    private readonly sendMessageTimer;
-    private readonly workspaces;
-    private readonly targetedSignalSupport;
-    /**
-     * Tracks whether this client has complete snapshot level knowledge and
-     * how that determination was reached.
-     * - "alone": no other audience members detected at join
-     * - "join response": another client has responded to our join request
-     * - "full requests": all others have requested response from us
-     *
-     * @remarks
-     * Only applies when not using targeted join responses.
-     *
-     * Without a complete snapshot, we cannot fully onboard any other clients.
-     * One exception to this is if this client is the only participant in the
-     * session. In such a case, there is no one to respond to the join request.
-     * Another exception is multiple clients attempting to join at the same
-     * time and thus expecting that someone has full knowledge, yet none have
-     * received a complete update to think they are qualified to respond.
-     * Generically if the number of outstanding requestors meets or exceeds the
-     * count of other audience members, then we can consider the snapshot
-     * complete (as all will have provided their own complete information in
-     * their join responses).
-     */
-    private reasonForCompleteSnapshot?;
-    /**
-     * Map of outstanding broadcast (join response) requests.
-     */
-    private readonly broadcastRequests;
-    /**
-     * Timer for managing broadcast (join response) request timing.
-     */
-    private readonly broadcastRequestsTimer;
-    constructor(attendeeId: AttendeeId, runtime: IEphemeralRuntime, logger: ITelemetryLoggerExt, events: IEmitter<PresenceEvents>, presence: Presence, systemWorkspaceDatastore: SystemWorkspaceDatastore, systemWorkspace: AnyWorkspaceEntry<StatesWorkspaceSchema>);
-    private getAudienceInformation;
-    joinSession(selfClientId: ClientConnectionId, alternateProvider?: ClientConnectionId | undefined): void;
-    onDisconnected(): void;
-    getWorkspace<TSchema extends StatesWorkspaceSchema>(internalWorkspaceAddress: InternalWorkspaceAddress, requestedContent: TSchema, controls?: BroadcastControlSettings): AnyWorkspace<TSchema>;
-    /**
-     * The combined contents of all queued updates. Will be `"sendAll"` when a
-     * full broadcast is pending or `undefined` when no messages are queued.
-     */
-    private queuedData;
-    /**
-     * Enqueues a new message to be sent. The message may be queued or may be sent immediately depending on the state of
-     * the send timer, other messages in the queue, the configured allowed latency, etc.
-     */
-    private enqueueMessage;
-    /**
-     * Send any queued signal immediately. Does nothing if no message is queued.
-     */
-    private sendQueuedMessage;
-    /**
-     * Recursively strips validation metadata (validatedValue) from datastore before broadcasting.
-     * This ensures that validation metadata doesn't leak into signals sent to other clients.
-     */
-    private stripValidationMetadata;
-    /**
-     * Strips validation metadata from individual value data entries.
-     */
-    private stripValidationFromValueData;
-    private broadcastAllKnownState;
-    processSignal(message: InboundExtensionMessage<SignalMessages> & {
-        clientId: ClientConnectionId;
-    }, local: boolean, optional: boolean): void;
-    /**
-     * Broadcasts a join response (complete datastore update message)
-     * if there is an outstanding join response request.
-     */
-    private readonly sendJoinResponseIfStillNeeded;
-    /**
-     * 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/dist/presenceDatastoreManager.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"presenceDatastoreManager.d.ts","sourceRoot":"","sources":["../src/presenceDatastoreManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,wDAAwD,CAAC;AACtG,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0CAA0C,CAAC;AAEzE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AAEpF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AAG5E,OAAO,KAAK,EACX,UAAU,EACV,yBAAyB,IAAI,QAAQ,EACrC,cAAc,EACd,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EAGX,sBAAsB,EAEtB,MAAM,qBAAqB,CAAC;AAM7B,OAAO,KAAK,EAKX,wBAAwB,EAExB,cAAc,EAEd,MAAM,eAAe,CAAC;AAMvB,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAE3D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AAErE,OAAO,KAAK,EACX,YAAY,EACZ,sBAAsB,EACtB,4BAA4B,EAC5B,eAAe,EACf,qBAAqB,EACrB,gBAAgB,EAChB,MAAM,YAAY,CAAC;AAOpB,UAAU,iBAAiB,CAAC,OAAO,SAAS,qBAAqB;IAChE,MAAM,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;IAC9B,QAAQ,EAAE,sBAAsB,CAAC;CACjC;AAuCD;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACxC,WAAW,CACV,QAAQ,EAAE,kBAAkB,EAC5B,iBAAiB,EAAE,kBAAkB,GAAG,SAAS,GAC/C,IAAI,CAAC;IACR,cAAc,IAAI,IAAI,CAAC;IACvB,YAAY,CACX,OAAO,SAAS,OAAO,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC,EAC3D,WAAW,SAAS,MAAM,GAAG,MAAM,OAAO,EAE1C,wBAAwB,EAAE,KAAK,gBAAgB,EAAE,EACjD,gBAAgB,EAAE,OAAO,EACzB,QAAQ,CAAC,EAAE,wBAAwB,GACjC,eAAe,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAClD,YAAY,CACX,OAAO,SAAS,OAAO,CAAC,4BAA4B,CAAC,WAAW,CAAC,CAAC,EAClE,WAAW,SAAS,MAAM,GAAG,MAAM,OAAO,EAE1C,wBAAwB,EAAE,KAAK,gBAAgB,EAAE,EACjD,gBAAgB,EAAE,OAAO,GACvB,sBAAsB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAChD,aAAa,CACZ,OAAO,EAAE,uBAAuB,CAAC,cAAc,CAAC,GAAG;QAAE,QAAQ,EAAE,kBAAkB,CAAA;KAAE,EACnF,KAAK,EAAE,OAAO,EACd,QAAQ,EAAE,OAAO,GACf,IAAI,CAAC;CACR;AAqCD;;;;;;;GAOG;AACH,eAAO,MAAM,6BAA6B;IACzC;;;;OAIG;;IAEH;;;OAGG;;CAEM,CAAC;AAEX;;GAEG;AACH,qBAAa,4BAA6B,YAAW,wBAAwB;IA4C3E,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IA/C1B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;IAC9C,OAAO,CAAC,cAAc,CAAK;IAC3B,OAAO,CAAC,gBAAgB,CAAK;IAC7B,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAsB;IACvD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA+D;IAC1F,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAU;IAEhD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,OAAO,CAAC,yBAAyB,CAAC,CAA8C;IAEhF;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAG9B;IACJ;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAsB;gBAG3C,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,iBAAiB,EAC1B,MAAM,EAAE,mBAAmB,EAC3B,MAAM,EAAE,QAAQ,CAAC,cAAc,CAAC,EAChC,QAAQ,EAAE,QAAQ,EACnC,wBAAwB,EAAE,wBAAwB,EAClD,eAAe,EAAE,iBAAiB,CAAC,qBAAqB,CAAC;IAY1D,OAAO,CAAC,sBAAsB;IAkCvB,WAAW,CACjB,YAAY,EAAE,kBAAkB,EAChC,iBAAiB,GAAE,kBAAkB,GAAG,SAAqB,GAC3D,IAAI;IAuEA,cAAc,IAAI,IAAI;IAItB,YAAY,CAAC,OAAO,SAAS,qBAAqB,EACxD,wBAAwB,EAAE,wBAAwB,EAClD,gBAAgB,EAAE,OAAO,EACzB,QAAQ,CAAC,EAAE,wBAAwB,GACjC,YAAY,CAAC,OAAO,CAAC;IA6CxB;;;OAGG;IACH,OAAO,CAAC,UAAU,CAAyD;IAE3E;;;OAGG;IACH,OAAO,CAAC,cAAc;IA4CtB;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAmDzB;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IA6B/B;;OAEG;IACH,OAAO,CAAC,4BAA4B;IAkCpC,OAAO,CAAC,sBAAsB;IAkDvB,aAAa,CACnB,OAAO,EAAE,uBAAuB,CAAC,cAAc,CAAC,GAAG;QAAE,QAAQ,EAAE,kBAAkB,CAAA;KAAE,EACnF,KAAK,EAAE,OAAO,EACd,QAAQ,EAAE,OAAO,GACf,IAAI;IAyJP;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,6BAA6B,CAsB5C;IAEF;;;;;;;;;;OAUG;IACH,OAAO,CAAC,mBAAmB;CAqG3B"}