@fluid-internal/presence-runtime 2.93.0

package/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,72 @@
+# @fluid-internal/presence-runtime
+
+This is an internal package containing implementations of `presence` APIs.
+`presence` APIs should be accessed via `@fluidframework/presence` package.
+
+## Source organization
+
+```
+        @fluidframework/presence
+                  |
+        +---------^---------+-------+
+        |                   |       |
+    ./states           ./runtime    |
+        |                   |       |
+        ^---------v---------+       |
+        |         |         |       |
+        |   ./workspace     |       |
+        |         |         |       |
+        ^-------v-+---------^       |
+        |       |           |       |
+        |   ./utils         |       |
+        |       |           |       |
+        ^-------^---v-------^-------^
+                    |
+    @fluid-internal/presence-definitions
+```
+
+### utils
+
+**Purpose:** Utility functions and shared implementations.
+
+**Files:**
+- `internalUtils.ts` → `objectEntries`, `objectKeys`, `getOrCreateRecord`, JSON helpers
+- `timerManager.ts` → `TimerManager` class
+- `broadcastControls.ts` → `OptionalBroadcastControl`, `RequiredBroadcastControl` classes
+- `valueManager.ts` → `brandIVM`, `unbrandIVM`
+
+### workspace
+
+**Purpose:** Workspace abstractions and state datastore contracts.
+
+**Files:**
+- `stateDatastore.ts` → `StateDatastore` interface, `handleFromDatastore`, `datastoreFromHandle`
+- `presenceStates.ts` → `PresenceStatesImpl`, `createPresenceStates`, workspace implementation
+
+### runtime
+
+**Purpose:** Core runtime - presence manager, datastore manager, system workspace.
+
+**Exposes:** extension elements `ContainerPresenceFactory` and `extensionId`
+
+**Files:**
+- `extension/containerPresence.ts` → `ContainerPresenceFactory`, `extensionId`
+- `presenceDatastoreManager.ts` → `PresenceDatastoreManagerImpl`
+- `presenceManager.ts` → `PresenceManager` class, `createPresenceManager`
+- `protocol.ts` → Message type definitions, `joinMessageType`, `datastoreUpdateMessageType`, `acknowledgementMessageType`
+- `runtimeTypes.ts` → `IEphemeralRuntime`, `ExtensionHost`
+- `systemWorkspace.ts` → `SystemWorkspace`, `createSystemWorkspace`
+
+### states
+
+**Purpose:** State manager implementations.
+
+**Exposes:** `StateFactory` and `Notifications` (factory)
+
+**Files:**
+- `latestMapValueManager.ts` → `latestMap` factory
+- `latestValueManager.ts` → `latest` factory
+- `notificationsManager.ts` → `NotificationsManager`, `Notifications` factory
+- `presence.ts` → `SpecificAttendee`
+- `stateFactory.ts` → `StateFactory` object
+- `validatedGetter.ts` → `createValidatedGetter`

package/dist/package.json

@@ -0,0 +1,4 @@
+{
+	"type": "commonjs",
+	"sideEffects": false
+}

package/dist/packageVersion.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ *
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
+ */
+export declare const pkgName = "@fluid-internal/presence-runtime";
+export declare const pkgVersion = "2.93.0";
+//# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,qCAAqC,CAAC;AAC1D,eAAO,MAAM,UAAU,WAAW,CAAC"}

package/dist/packageVersion.js

@@ -0,0 +1,12 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ *
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pkgVersion = exports.pkgName = void 0;
+exports.pkgName = "@fluid-internal/presence-runtime";
+exports.pkgVersion = "2.93.0";
+//# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,kCAAkC,CAAC;AAC7C,QAAA,UAAU,GAAG,QAAQ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluid-internal/presence-runtime\";\nexport const pkgVersion = \"2.93.0\";\n"]}

package/dist/runtime/extension/containerPresence.d.ts

@@ -0,0 +1,53 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { PresenceWithNotifications } from "@fluid-internal/presence-definitions";
+import type { ContainerExtension, ContainerExtensionFactory, ExtensionInstantiationResult, ExtensionRuntimeProperties as GenericExtensionRuntimeProperties, InboundExtensionMessage } from "@fluidframework/container-runtime-definitions/internal";
+import type { ExtensionCompatibilityDetails } from "@fluidframework/runtime-definitions/internal";
+import type { SignalMessages } from "../protocol.js";
+import type { ExtensionHost, ExtensionRuntimeProperties } from "../runtimeTypes.js";
+/**
+ * Common Presence manager for a container
+ */
+declare class ContainerPresenceManager implements ContainerExtension<ExtensionRuntimeProperties>, ReturnType<ContainerExtensionFactory<PresenceWithNotifications, ExtensionRuntimeProperties>["instantiateExtension"]> {
+    readonly compatibility: {
+        readonly generation: 1;
+        readonly version: "2.93.0";
+        readonly capabilities: Set<never>;
+    };
+    readonly interface: PresenceWithNotifications;
+    readonly extension: this;
+    private readonly manager;
+    constructor(host: ExtensionHost);
+    handleVersionOrCapabilitiesMismatch<_TRequestedInterface>(ourExistingInstantiation: Readonly<ExtensionInstantiationResult<PresenceWithNotifications, ExtensionRuntimeProperties, []>>, newCompatibilityRequest: ExtensionCompatibilityDetails): never;
+    onNewUse(): void;
+    processSignal(addressChain: string[], message: InboundExtensionMessage<SignalMessages>, local: boolean): void;
+}
+/**
+ * {@link ContainerExtensionId} for Presence
+ *
+ * @internal
+ */
+export declare const extensionId = "dis:bb89f4c0-80fd-4f0c-8469-4f2848ee7f4a";
+/**
+ * {@link ContainerExtensionFactory|Factory} for Presence as {@link ContainerExtension}
+ *
+ * @internal
+ */
+export declare const ContainerPresenceFactory: {
+    readonly hostRequirements: {
+        readonly minSupportedGeneration: 1;
+        readonly requiredFeatures: readonly [];
+    };
+    readonly instanceExpectations: {
+        readonly version: "2.71.0";
+        readonly generation: 1;
+        readonly capabilities: Set<never>;
+    };
+    readonly resolvePriorInstantiation: (existingInstantiation: ExtensionInstantiationResult<unknown, GenericExtensionRuntimeProperties, unknown[]>) => never;
+    readonly instantiateExtension: (host: ExtensionHost) => ContainerPresenceManager;
+    readonly [Symbol.hasInstance]: (instance: unknown) => instance is ContainerPresenceManager;
+};
+export {};
+//# sourceMappingURL=containerPresence.d.ts.map

package/dist/runtime/extension/containerPresence.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"containerPresence.d.ts","sourceRoot":"","sources":["../../../src/runtime/extension/containerPresence.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACtF,OAAO,KAAK,EACX,kBAAkB,EAClB,yBAAyB,EACzB,4BAA4B,EAC5B,0BAA0B,IAAI,iCAAiC,EAC/D,uBAAuB,EACvB,MAAM,wDAAwD,CAAC;AAEhE,OAAO,KAAK,EAEX,6BAA6B,EAC7B,MAAM,8CAA8C,CAAC;AAItD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,KAAK,EAAE,aAAa,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAoCpF;;GAEG;AACH,cAAM,wBACL,YACC,kBAAkB,CAAC,0BAA0B,CAAC,EAC9C,UAAU,CACT,yBAAyB,CACxB,yBAAyB,EACzB,0BAA0B,CAC1B,CAAC,sBAAsB,CAAC,CACzB;IAGF,SAAgB,aAAa;;;;MAAyB;IACtD,SAAgB,SAAS,EAAE,yBAAyB,CAAC;IACrD,SAAgB,SAAS,OAAQ;IAEjC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA6B;gBAElC,IAAI,EAAE,aAAa;IAS/B,mCAAmC,CAAC,oBAAoB,EAC9D,wBAAwB,EAAE,QAAQ,CACjC,4BAA4B,CAAC,yBAAyB,EAAE,0BAA0B,EAAE,EAAE,CAAC,CACvF,EACD,uBAAuB,EAAE,6BAA6B,GACpD,KAAK;IAWD,QAAQ,IAAI,IAAI;IAIhB,aAAa,CACnB,YAAY,EAAE,MAAM,EAAE,EACtB,OAAO,EAAE,uBAAuB,CAAC,cAAc,CAAC,EAChD,KAAK,EAAE,OAAO,GACZ,IAAI;CAGP;AAED;;;;GAIG;AACH,eAAO,MAAM,WAAW,6CACkD,CAAC;AAE3E;;;;GAIG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;gEASZ,6BACtB,OAAO,EACP,iCAAiC,EACjC,OAAO,EAAE,CACT,KACC,KAAK;4DAQmC,wBAAwB;8CAIlC,OAAO;CAMxC,CAAC"}

package/dist/runtime/extension/containerPresence.js

@@ -0,0 +1,90 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContainerPresenceFactory = exports.extensionId = void 0;
+const internal_1 = require("@fluidframework/core-utils/internal");
+const packageVersion_js_1 = require("../../packageVersion.js");
+const presenceManager_js_1 = require("../presenceManager.js");
+const presenceCompatibility = {
+    generation: 1,
+    version: packageVersion_js_1.pkgVersion,
+    capabilities: new Set([]),
+};
+/**
+ * Minimal compatible package version.
+ * If an existing presence extension is registered with this version or higher,
+ * it can be used instead of instantiating new instance from this version of
+ * the package (assuming also capabilities are compatible).
+ */
+const minimalCompatiblePackageVersion = "2.71.0";
+function assertCompatibilityInvariants(compatibility) {
+    (0, internal_1.assert)(compatibility.generation === presenceCompatibility.generation, 0xc97 /* Presence compatibility generation mismatch. */);
+    (0, internal_1.assert)(compatibility.version.startsWith("2."), 0xc98 /* Registered version is not major version 2. */);
+    (0, internal_1.assert)(Number.parseFloat(compatibility.version.slice(2)) <
+        Number.parseFloat(presenceCompatibility.version.slice(2)), 0xc99 /* Registered version is not less than the current version. */);
+    (0, internal_1.assert)(presenceCompatibility.capabilities.size === 0, 0xc9a /* Presence capabilities should be empty. */);
+}
+/**
+ * Common Presence manager for a container
+ */
+class ContainerPresenceManager {
+    constructor(host) {
+        // ContainerExtensionFactory return elements
+        this.compatibility = presenceCompatibility;
+        this.extension = this;
+        this.interface = this.manager = (0, presenceManager_js_1.createPresenceManager)({
+            ...host,
+            submitSignal: (message) => {
+                host.submitAddressedSignal([], message);
+            },
+        });
+    }
+    handleVersionOrCapabilitiesMismatch(ourExistingInstantiation, newCompatibilityRequest) {
+        (0, internal_1.assert)(ourExistingInstantiation.compatibility === presenceCompatibility, 0xc9b /* Presence extension called without own compatibility details */);
+        assertCompatibilityInvariants(newCompatibilityRequest);
+        // There have not yet been any changes that would require action to upgrade.
+        // But also mixed runtime versions are not yet expected.
+        (0, internal_1.fail)(0xcb1 /* Presence is only expected to be accessed with a single version. */);
+    }
+    onNewUse() {
+        // No-op
+    }
+    processSignal(addressChain, message, local) {
+        this.manager.processSignal(addressChain, message, local);
+    }
+}
+/**
+ * {@link ContainerExtensionId} for Presence
+ *
+ * @internal
+ */
+exports.extensionId = "dis:bb89f4c0-80fd-4f0c-8469-4f2848ee7f4a";
+/**
+ * {@link ContainerExtensionFactory|Factory} for Presence as {@link ContainerExtension}
+ *
+ * @internal
+ */
+exports.ContainerPresenceFactory = {
+    hostRequirements: {
+        minSupportedGeneration: 1,
+        requiredFeatures: [],
+    },
+    instanceExpectations: { ...presenceCompatibility, version: minimalCompatiblePackageVersion },
+    resolvePriorInstantiation(existingInstantiation) {
+        // Validate assumptions about existing instance
+        assertCompatibilityInvariants(existingInstantiation.compatibility);
+        // There have not yet been any changes that would require action to upgrade.
+        // But also mixed runtime versions are not yet expected.
+        (0, internal_1.fail)(0xcb2 /* Presence is only expected to be accessed with a single version. */);
+    },
+    instantiateExtension(host) {
+        return new ContainerPresenceManager(host);
+    },
+    [Symbol.hasInstance]: (instance) => {
+        return instance instanceof ContainerPresenceManager;
+    },
+};
+//# sourceMappingURL=containerPresence.js.map

package/dist/runtime/extension/containerPresence.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"containerPresence.js","sourceRoot":"","sources":["../../../src/runtime/extension/containerPresence.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAWH,kEAAmE;AAMnE,+DAAqD;AACrD,8DAA+F;AAI/F,MAAM,qBAAqB,GAAG;IAC7B,UAAU,EAAE,CAAC;IACb,OAAO,EAAE,8BAAU;IACnB,YAAY,EAAE,IAAI,GAAG,CAAC,EAAE,CAAC;CACwB,CAAC;AAEnD;;;;;GAKG;AACH,MAAM,+BAA+B,GAAG,QAAQ,CAAC;AAEjD,SAAS,6BAA6B,CAAC,aAA4C;IAClF,IAAA,iBAAM,EACL,aAAa,CAAC,UAAU,KAAK,qBAAqB,CAAC,UAAU,EAC7D,KAAK,CAAC,iDAAiD,CACvD,CAAC;IACF,IAAA,iBAAM,EACL,aAAa,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,EACtC,KAAK,CAAC,gDAAgD,CACtD,CAAC;IACF,IAAA,iBAAM,EACL,MAAM,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAChD,MAAM,CAAC,UAAU,CAAC,qBAAqB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC1D,KAAK,CAAC,8DAA8D,CACpE,CAAC;IACF,IAAA,iBAAM,EACL,qBAAqB,CAAC,YAAY,CAAC,IAAI,KAAK,CAAC,EAC7C,KAAK,CAAC,4CAA4C,CAClD,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,wBAAwB;IAiB7B,YAAmB,IAAmB;QAPtC,4CAA4C;QAC5B,kBAAa,GAAG,qBAAqB,CAAC;QAEtC,cAAS,GAAG,IAAI,CAAC;QAKhC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,OAAO,GAAG,IAAA,0CAAqB,EAAC;YACrD,GAAG,IAAI;YACP,YAAY,EAAE,CAAC,OAAO,EAAE,EAAE;gBACzB,IAAI,CAAC,qBAAqB,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;YACzC,CAAC;SACD,CAAC,CAAC;IACJ,CAAC;IAEM,mCAAmC,CACzC,wBAEC,EACD,uBAAsD;QAEtD,IAAA,iBAAM,EACL,wBAAwB,CAAC,aAAa,KAAK,qBAAqB,EAChE,KAAK,CAAC,iEAAiE,CACvE,CAAC;QACF,6BAA6B,CAAC,uBAAuB,CAAC,CAAC;QACvD,4EAA4E;QAC5E,wDAAwD;QACxD,IAAA,eAAI,EAAC,KAAK,CAAC,qEAAqE,CAAC,CAAC;IACnF,CAAC;IAEM,QAAQ;QACd,QAAQ;IACT,CAAC;IAEM,aAAa,CACnB,YAAsB,EACtB,OAAgD,EAChD,KAAc;QAEd,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,YAAY,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IAC1D,CAAC;CACD;AAED;;;;GAIG;AACU,QAAA,WAAW,GACvB,0CAAyE,CAAC;AAE3E;;;;GAIG;AACU,QAAA,wBAAwB,GAAG;IACvC,gBAAgB,EAAE;QACjB,sBAAsB,EAAE,CAAC;QACzB,gBAAgB,EAAE,EAAE;KAC+B;IAEpD,oBAAoB,EAAE,EAAE,GAAG,qBAAqB,EAAE,OAAO,EAAE,+BAA+B,EAAE;IAE5F,yBAAyB,CACxB,qBAIC;QAED,+CAA+C;QAC/C,6BAA6B,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC;QACnE,4EAA4E;QAC5E,wDAAwD;QACxD,IAAA,eAAI,EAAC,KAAK,CAAC,qEAAqE,CAAC,CAAC;IACnF,CAAC;IAED,oBAAoB,CAAC,IAAmB;QACvC,OAAO,IAAI,wBAAwB,CAAC,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,QAAiB,EAAwC,EAAE;QACjF,OAAO,QAAQ,YAAY,wBAAwB,CAAC;IACrD,CAAC;CAID,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ILayerCompatSupportRequirements } from \"@fluid-internal/client-utils\";\nimport type { PresenceWithNotifications } from \"@fluid-internal/presence-definitions\";\nimport type {\n\tContainerExtension,\n\tContainerExtensionFactory,\n\tExtensionInstantiationResult,\n\tExtensionRuntimeProperties as GenericExtensionRuntimeProperties,\n\tInboundExtensionMessage,\n} from \"@fluidframework/container-runtime-definitions/internal\";\nimport { assert, fail } from \"@fluidframework/core-utils/internal\";\nimport type {\n\tContainerExtensionId,\n\tExtensionCompatibilityDetails,\n} from \"@fluidframework/runtime-definitions/internal\";\n\nimport { pkgVersion } from \"../../packageVersion.js\";\nimport { createPresenceManager, type PresenceExtensionInterface } from \"../presenceManager.js\";\nimport type { SignalMessages } from \"../protocol.js\";\nimport type { ExtensionHost, ExtensionRuntimeProperties } from \"../runtimeTypes.js\";\n\nconst presenceCompatibility = {\n\tgeneration: 1,\n\tversion: pkgVersion,\n\tcapabilities: new Set([]),\n} as const satisfies ExtensionCompatibilityDetails;\n\n/**\n * Minimal compatible package version.\n * If an existing presence extension is registered with this version or higher,\n * it can be used instead of instantiating new instance from this version of\n * the package (assuming also capabilities are compatible).\n */\nconst minimalCompatiblePackageVersion = \"2.71.0\";\n\nfunction assertCompatibilityInvariants(compatibility: ExtensionCompatibilityDetails): void {\n\tassert(\n\t\tcompatibility.generation === presenceCompatibility.generation,\n\t\t0xc97 /* Presence compatibility generation mismatch. */,\n\t);\n\tassert(\n\t\tcompatibility.version.startsWith(\"2.\"),\n\t\t0xc98 /* Registered version is not major version 2. */,\n\t);\n\tassert(\n\t\tNumber.parseFloat(compatibility.version.slice(2)) <\n\t\t\tNumber.parseFloat(presenceCompatibility.version.slice(2)),\n\t\t0xc99 /* Registered version is not less than the current version. */,\n\t);\n\tassert(\n\t\tpresenceCompatibility.capabilities.size === 0,\n\t\t0xc9a /* Presence capabilities should be empty. */,\n\t);\n}\n\n/**\n * Common Presence manager for a container\n */\nclass ContainerPresenceManager\n\timplements\n\t\tContainerExtension<ExtensionRuntimeProperties>,\n\t\tReturnType<\n\t\t\tContainerExtensionFactory<\n\t\t\t\tPresenceWithNotifications,\n\t\t\t\tExtensionRuntimeProperties\n\t\t\t>[\"instantiateExtension\"]\n\t\t>\n{\n\t// ContainerExtensionFactory return elements\n\tpublic readonly compatibility = presenceCompatibility;\n\tpublic readonly interface: PresenceWithNotifications;\n\tpublic readonly extension = this;\n\n\tprivate readonly manager: PresenceExtensionInterface;\n\n\tpublic constructor(host: ExtensionHost) {\n\t\tthis.interface = this.manager = createPresenceManager({\n\t\t\t...host,\n\t\t\tsubmitSignal: (message) => {\n\t\t\t\thost.submitAddressedSignal([], message);\n\t\t\t},\n\t\t});\n\t}\n\n\tpublic handleVersionOrCapabilitiesMismatch<_TRequestedInterface>(\n\t\tourExistingInstantiation: Readonly<\n\t\t\tExtensionInstantiationResult<PresenceWithNotifications, ExtensionRuntimeProperties, []>\n\t\t>,\n\t\tnewCompatibilityRequest: ExtensionCompatibilityDetails,\n\t): never {\n\t\tassert(\n\t\t\tourExistingInstantiation.compatibility === presenceCompatibility,\n\t\t\t0xc9b /* Presence extension called without own compatibility details */,\n\t\t);\n\t\tassertCompatibilityInvariants(newCompatibilityRequest);\n\t\t// There have not yet been any changes that would require action to upgrade.\n\t\t// But also mixed runtime versions are not yet expected.\n\t\tfail(0xcb1 /* Presence is only expected to be accessed with a single version. */);\n\t}\n\n\tpublic onNewUse(): void {\n\t\t// No-op\n\t}\n\n\tpublic processSignal(\n\t\taddressChain: string[],\n\t\tmessage: InboundExtensionMessage<SignalMessages>,\n\t\tlocal: boolean,\n\t): void {\n\t\tthis.manager.processSignal(addressChain, message, local);\n\t}\n}\n\n/**\n * {@link ContainerExtensionId} for Presence\n *\n * @internal\n */\nexport const extensionId =\n\t\"dis:bb89f4c0-80fd-4f0c-8469-4f2848ee7f4a\" satisfies ContainerExtensionId;\n\n/**\n * {@link ContainerExtensionFactory|Factory} for Presence as {@link ContainerExtension}\n *\n * @internal\n */\nexport const ContainerPresenceFactory = {\n\thostRequirements: {\n\t\tminSupportedGeneration: 1,\n\t\trequiredFeatures: [],\n\t} as const satisfies ILayerCompatSupportRequirements,\n\n\tinstanceExpectations: { ...presenceCompatibility, version: minimalCompatiblePackageVersion },\n\n\tresolvePriorInstantiation(\n\t\texistingInstantiation: ExtensionInstantiationResult<\n\t\t\tunknown,\n\t\t\tGenericExtensionRuntimeProperties,\n\t\t\tunknown[]\n\t\t>,\n\t): never {\n\t\t// Validate assumptions about existing instance\n\t\tassertCompatibilityInvariants(existingInstantiation.compatibility);\n\t\t// There have not yet been any changes that would require action to upgrade.\n\t\t// But also mixed runtime versions are not yet expected.\n\t\tfail(0xcb2 /* Presence is only expected to be accessed with a single version. */);\n\t},\n\n\tinstantiateExtension(host: ExtensionHost): ContainerPresenceManager {\n\t\treturn new ContainerPresenceManager(host);\n\t},\n\n\t[Symbol.hasInstance]: (instance: unknown): instance is ContainerPresenceManager => {\n\t\treturn instance instanceof ContainerPresenceManager;\n\t},\n} as const satisfies ContainerExtensionFactory<\n\tPresenceWithNotifications,\n\tExtensionRuntimeProperties\n>;\n"]}

package/dist/runtime/extension/index.d.ts

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

package/dist/runtime/extension/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/runtime/extension/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,wBAAwB,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC"}

package/dist/runtime/extension/index.js

@@ -0,0 +1,11 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extensionId = exports.ContainerPresenceFactory = void 0;
+var containerPresence_js_1 = require("./containerPresence.js");
+Object.defineProperty(exports, "ContainerPresenceFactory", { enumerable: true, get: function () { return containerPresence_js_1.ContainerPresenceFactory; } });
+Object.defineProperty(exports, "extensionId", { enumerable: true, get: function () { return containerPresence_js_1.extensionId; } });
+//# sourceMappingURL=index.js.map

package/dist/runtime/extension/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/runtime/extension/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAA+E;AAAtE,gIAAA,wBAAwB,OAAA;AAAE,mHAAA,WAAW,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { ContainerPresenceFactory, extensionId } from \"./containerPresence.js\";\n"]}

package/dist/runtime/presenceDatastoreManager.d.ts

@@ -0,0 +1,146 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { AttendeeId, BroadcastControlSettings, ClientConnectionId, NotificationsWorkspace, NotificationsWorkspaceSchema, PresenceWithNotifications as Presence, PresenceEvents, StatesWorkspace, StatesWorkspaceSchema, WorkspaceAddress } from "@fluid-internal/presence-definitions";
+import type { AnyWorkspace } from "@fluid-internal/presence-definitions/internal";
+import type { PresenceStatesInternal } from "@fluid-internal/presence-definitions/internal/workspace-runtime";
+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 { InternalWorkspaceAddress, SignalMessages, SystemWorkspaceDatastore } from "./protocol.js";
+import type { IEphemeralRuntime } from "./runtimeTypes.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/runtime/presenceDatastoreManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"presenceDatastoreManager.d.ts","sourceRoot":"","sources":["../../src/runtime/presenceDatastoreManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,UAAU,EACV,wBAAwB,EACxB,kBAAkB,EAClB,sBAAsB,EACtB,4BAA4B,EAC5B,yBAAyB,IAAI,QAAQ,EACrC,cAAc,EACd,eAAe,EACf,qBAAqB,EACrB,gBAAgB,EAChB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,EACX,YAAY,EAMZ,MAAM,+CAA+C,CAAC;AACvD,OAAO,KAAK,EAEX,sBAAsB,EAGtB,MAAM,iEAAiE,CAAC;AACzE,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;AASpF,OAAO,KAAK,EAKX,wBAAwB,EAExB,cAAc,EAEd,wBAAwB,EACxB,MAAM,eAAe,CAAC;AAMvB,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAE3D,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"}