@fluidframework/presence 2.73.0 → 2.74.0-368706

package/dist/datastoreSupport.js

@@ -1,84 +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.LoadableFluidObject = exports.BasicDataStoreFactory = void 0;
-const internal_1 = require("@fluidframework/core-utils/internal");
-const internal_2 = require("@fluidframework/datastore/internal");
-const internal_3 = require("@fluidframework/runtime-utils/internal");
-/**
- * `BasicFluidDataStoreRuntime` extends the FluidDataStoreRuntime to provide a request
- * method that routes requests to the entrypoint Fluid object that is expected to be a
- * {@link LoadableFluidObject}.
- */
-class BasicFluidDataStoreRuntime extends internal_2.FluidDataStoreRuntime {
-    async request(request) {
-        const response = await super.request(request);
-        if (response.status !== 404) {
-            return response;
-        }
-        // Return entrypoint object if someone requests it directly.
-        // Direct requests exist from two scenarios:
-        //   1. the request url is a "/"
-        //   2. the request url is empty
-        if (request.url === "" || request.url === "/" || request.url.startsWith("/?")) {
-            // The provideEntryPoint callback below always returns an instance of
-            // LoadableFluidObject. Make sure that is the case.
-            const dataObject = await this.entryPoint.get();
-            (0, internal_1.assert)(dataObject instanceof LoadableFluidObject, 0xa36 /* Data store runtime entryPoint is not expected type */);
-            return { mimeType: "fluid/object", status: 200, value: dataObject };
-        }
-        return (0, internal_3.create404Response)(request);
-    }
-}
-/**
- * `BasicDataStoreFactory` is the factory for creating a {@link BasicFluidDataStoreRuntime}.
- */
-class BasicDataStoreFactory {
-    get IFluidDataStoreFactory() {
-        return this;
-    }
-    constructor(type, instanceCtor) {
-        this.type = type;
-        this.instanceCtor = instanceCtor;
-    }
-    async instantiateDataStore(context, existing) {
-        // Create a new runtime for our data store.
-        // The runtime is what Fluid uses to route to our data store.
-        const runtime = new BasicFluidDataStoreRuntime(context, 
-        /* ISharedObjectRegistry */ new Map(), existing, 
-        /* provideEntryPoint */ async () => {
-            (0, internal_1.assert)(instance !== undefined, 0xa37 /* Intended entryPoint is undefined */);
-            return instance;
-        });
-        const instance = new this.instanceCtor(runtime);
-        return runtime;
-    }
-}
-exports.BasicDataStoreFactory = BasicDataStoreFactory;
-/**
- * `LoadableFluidObject` is helper to build a DataObject handling the {@link FluidObject}
- * and {@link IFluidLoadable} requirements.
- */
-class LoadableFluidObject {
-    constructor(runtime) {
-        this.runtime = runtime;
-    }
-    get IFluidLoadable() {
-        return this;
-    }
-    /**
-     * Handle to the this Fluid object.
-     */
-    get handle() {
-        // BasicDataStoreFactory provides an entryPoint initialization function
-        // to the data store runtime; so, this object should always have access to a
-        // non-null entryPoint.
-        (0, internal_1.assert)(this.runtime.entryPoint !== undefined, 0xa38 /* EntryPoint was undefined */);
-        return this.runtime.entryPoint;
-    }
-}
-exports.LoadableFluidObject = LoadableFluidObject;
-//# sourceMappingURL=datastoreSupport.js.map

package/dist/datastoreSupport.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"datastoreSupport.js","sourceRoot":"","sources":["../src/datastoreSupport.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAcH,kEAA6D;AAC7D,iEAA2E;AAK3E,qEAA2E;AAE3E;;;;GAIG;AACH,MAAM,0BAA2B,SAAQ,gCAAqB;IAC7C,KAAK,CAAC,OAAO,CAAC,OAAiB;QAC9C,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC9C,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC7B,OAAO,QAAQ,CAAC;QACjB,CAAC;QACD,4DAA4D;QAC5D,4CAA4C;QAC5C,gCAAgC;QAChC,gCAAgC;QAChC,IAAI,OAAO,CAAC,GAAG,KAAK,EAAE,IAAI,OAAO,CAAC,GAAG,KAAK,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YAC/E,qEAAqE;YACrE,mDAAmD;YACnD,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;YAC/C,IAAA,iBAAM,EACL,UAAU,YAAY,mBAAmB,EACzC,KAAK,CAAC,wDAAwD,CAC9D,CAAC;YACF,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;QACrE,CAAC;QACD,OAAO,IAAA,4BAAiB,EAAC,OAAO,CAAC,CAAC;IACnC,CAAC;CACD;AAED;;GAEG;AACH,MAAa,qBAAqB;IACjC,IAAW,sBAAsB;QAChC,OAAO,IAAI,CAAC;IACb,CAAC;IAED,YACiB,IAAU,EACT,YAAyE;QAD1E,SAAI,GAAJ,IAAI,CAAM;QACT,iBAAY,GAAZ,YAAY,CAA6D;IACxF,CAAC;IAEG,KAAK,CAAC,oBAAoB,CAChC,OAA+B,EAC/B,QAAiB;QAEjB,2CAA2C;QAC3C,6DAA6D;QAC7D,MAAM,OAAO,GAA0B,IAAI,0BAA0B,CACpE,OAAO;QACP,2BAA2B,CAAC,IAAI,GAAG,EAAE,EACrC,QAAQ;QACR,uBAAuB,CAAC,KAAK,IAAI,EAAE;YAClC,IAAA,iBAAM,EAAC,QAAQ,KAAK,SAAS,EAAE,KAAK,CAAC,sCAAsC,CAAC,CAAC;YAC7E,OAAO,QAAQ,CAAC;QACjB,CAAC,CACD,CAAC;QAEF,MAAM,QAAQ,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAEhD,OAAO,OAAO,CAAC;IAChB,CAAC;CACD;AA9BD,sDA8BC;AAED;;;GAGG;AACH,MAAsB,mBAAmB;IACxC,YAAsC,OAA8B;QAA9B,YAAO,GAAP,OAAO,CAAuB;IAAG,CAAC;IAExE,IAAW,cAAc;QACxB,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACH,IAAW,MAAM;QAChB,uEAAuE;QACvE,4EAA4E;QAC5E,uBAAuB;QACvB,IAAA,iBAAM,EAAC,IAAI,CAAC,OAAO,CAAC,UAAU,KAAK,SAAS,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;QACpF,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;IAChC,CAAC;CACD;AAjBD,kDAiBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * This module provided collection of minimal (slim) helpers to support\n * DataObject creation for temporary {@link ExperimentalPresenceManager}.\n */\n\nimport type {\n\tFluidObject,\n\tIFluidLoadable,\n\tIRequest,\n\tIResponse,\n} from \"@fluidframework/core-interfaces\";\nimport type { IFluidHandleInternal } from \"@fluidframework/core-interfaces/internal\";\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport { FluidDataStoreRuntime } from \"@fluidframework/datastore/internal\";\nimport type {\n\tIFluidDataStoreContext,\n\tIFluidDataStoreFactory,\n} from \"@fluidframework/runtime-definitions/internal\";\nimport { create404Response } from \"@fluidframework/runtime-utils/internal\";\n\n/**\n * `BasicFluidDataStoreRuntime` extends the FluidDataStoreRuntime to provide a request\n * method that routes requests to the entrypoint Fluid object that is expected to be a\n * {@link LoadableFluidObject}.\n */\nclass BasicFluidDataStoreRuntime extends FluidDataStoreRuntime {\n\tpublic override async request(request: IRequest): Promise<IResponse> {\n\t\tconst response = await super.request(request);\n\t\tif (response.status !== 404) {\n\t\t\treturn response;\n\t\t}\n\t\t// Return entrypoint object if someone requests it directly.\n\t\t// Direct requests exist from two scenarios:\n\t\t//   1. the request url is a \"/\"\n\t\t//   2. the request url is empty\n\t\tif (request.url === \"\" || request.url === \"/\" || request.url.startsWith(\"/?\")) {\n\t\t\t// The provideEntryPoint callback below always returns an instance of\n\t\t\t// LoadableFluidObject. Make sure that is the case.\n\t\t\tconst dataObject = await this.entryPoint.get();\n\t\t\tassert(\n\t\t\t\tdataObject instanceof LoadableFluidObject,\n\t\t\t\t0xa36 /* Data store runtime entryPoint is not expected type */,\n\t\t\t);\n\t\t\treturn { mimeType: \"fluid/object\", status: 200, value: dataObject };\n\t\t}\n\t\treturn create404Response(request);\n\t}\n}\n\n/**\n * `BasicDataStoreFactory` is the factory for creating a {@link BasicFluidDataStoreRuntime}.\n */\nexport class BasicDataStoreFactory<Type extends string> implements IFluidDataStoreFactory {\n\tpublic get IFluidDataStoreFactory(): IFluidDataStoreFactory {\n\t\treturn this;\n\t}\n\n\tpublic constructor(\n\t\tpublic readonly type: Type,\n\t\tprivate readonly instanceCtor: new (runtime: FluidDataStoreRuntime) => LoadableFluidObject,\n\t) {}\n\n\tpublic async instantiateDataStore(\n\t\tcontext: IFluidDataStoreContext,\n\t\texisting: boolean,\n\t): Promise<FluidDataStoreRuntime> {\n\t\t// Create a new runtime for our data store.\n\t\t// The runtime is what Fluid uses to route to our data store.\n\t\tconst runtime: FluidDataStoreRuntime = new BasicFluidDataStoreRuntime(\n\t\t\tcontext,\n\t\t\t/* ISharedObjectRegistry */ new Map(),\n\t\t\texisting,\n\t\t\t/* provideEntryPoint */ async () => {\n\t\t\t\tassert(instance !== undefined, 0xa37 /* Intended entryPoint is undefined */);\n\t\t\t\treturn instance;\n\t\t\t},\n\t\t);\n\n\t\tconst instance = new this.instanceCtor(runtime);\n\n\t\treturn runtime;\n\t}\n}\n\n/**\n * `LoadableFluidObject` is helper to build a DataObject handling the {@link FluidObject}\n * and {@link IFluidLoadable} requirements.\n */\nexport abstract class LoadableFluidObject implements FluidObject, IFluidLoadable {\n\tpublic constructor(protected readonly runtime: FluidDataStoreRuntime) {}\n\n\tpublic get IFluidLoadable(): this {\n\t\treturn this;\n\t}\n\n\t/**\n\t * Handle to the this Fluid object.\n\t */\n\tpublic get handle(): IFluidHandleInternal<FluidObject> {\n\t\t// BasicDataStoreFactory provides an entryPoint initialization function\n\t\t// to the data store runtime; so, this object should always have access to a\n\t\t// non-null entryPoint.\n\t\tassert(this.runtime.entryPoint !== undefined, 0xa38 /* EntryPoint was undefined */);\n\t\treturn this.runtime.entryPoint;\n\t}\n}\n"]}

package/lib/datastorePresenceManagerFactory.d.ts

@@ -1,51 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import type { IFluidLoadable } from "@fluidframework/core-interfaces";
-import type { SharedObjectKind } from "@fluidframework/shared-object-base";
-import type { PresenceWithNotifications as Presence } from "./presence.js";
-/**
- * Brand for Experimental Presence Data Object.
- *
- * @remarks
- * See {@link getPresenceViaDataObject} for example usage.
- *
- * @deprecated Use {@link getPresence} instead.
- * @sealed
- * @alpha
- */
-export declare class ExperimentalPresenceDO {
-    private readonly _self;
-}
-/**
- * DataStore based Presence Manager that is used as fallback for preferred Container
- * Extension based version requires registration. Export SharedObjectKind for registration.
- *
- * @deprecated Use {@link getPresence} instead.
- * @alpha
- */
-export declare const ExperimentalPresenceManager: SharedObjectKind<IFluidLoadable & ExperimentalPresenceDO>;
-/**
- * Acquire Presence from a DataStore based Presence Manager
- *
- * @example
- * ```typescript
- * const containerSchema = {
- * 	initialObjects: {
- * 		experimentalPresence: ExperimentalPresenceDO,
- * 	},
- * } satisfies ContainerSchema;
- * ```
- * then
- * ```typescript
- * const presence = getPresenceViaDataObject(
- * 	container.initialObjects.experimentalPresence,
- * 	);
- * ```
- *
- * @deprecated Use {@link getPresence} instead.
- * @alpha
- */
-export declare function getPresenceViaDataObject(fluidLoadable: ExperimentalPresenceDO): Presence;
-//# sourceMappingURL=datastorePresenceManagerFactory.d.ts.map

package/lib/datastorePresenceManagerFactory.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"datastorePresenceManagerFactory.d.ts","sourceRoot":"","sources":["../src/datastorePresenceManagerFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAWH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AAGtE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAG3E,OAAO,KAAK,EAAE,yBAAyB,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAC;AAqE3E;;;;;;;;;GASG;AACH,MAAM,CAAC,OAAO,OAAO,sBAAsB;IAC1C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAyB;CAC/C;AAED;;;;;;GAMG;AACH,eAAO,MAAM,2BAA2B,2DAGtC,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,wBAAwB,CAAC,aAAa,EAAE,sBAAsB,GAAG,QAAQ,CAMxF"}

package/lib/datastorePresenceManagerFactory.js

@@ -1,96 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-/*
- * Hacky support for internal datastore based usages.
- */
-import { createEmitter } from "@fluid-internal/client-utils";
-import { assert } from "@fluidframework/core-utils/internal";
-import { BasicDataStoreFactory, LoadableFluidObject } from "./datastoreSupport.js";
-import { createPresenceManager } from "./presenceManager.js";
-/**
- * This provides faux validation of the signal message.
- */
-function assertSignalMessageIsValid(message) {
-    assert(message.clientId !== null, 0xa58 /* Signal must have a client ID */);
-    // The other difference between messages is that `content` for
-    // RawInboundExtensionMessage is JsonDeserialized and we are fine assuming that.
-}
-/**
- * Simple FluidObject holding Presence Manager.
- */
-class PresenceManagerDataObject extends LoadableFluidObject {
-    presenceManager() {
-        if (!this._presenceManager) {
-            // TODO: investigate if ContainerExtensionStore (path-based address routing for
-            // Signals) is readily detectable here and use that presence manager directly.
-            const runtime = this.runtime;
-            const events = createEmitter();
-            runtime.on("connected", (clientId) => events.emit("joined", { clientId, canWrite: true }));
-            runtime.on("disconnected", () => events.emit("disconnected"));
-            const manager = createPresenceManager({
-                getJoinedStatus: () => (runtime.connected ? "joinedForWriting" : "disconnected"),
-                getClientId: () => runtime.clientId,
-                events,
-                getQuorum: runtime.getQuorum.bind(runtime),
-                getAudience: runtime.getAudience.bind(runtime),
-                submitSignal: (message) => runtime.submitSignal(message.type, message.content, message.targetClientId),
-                supportedFeatures: new Set() /* We do not implement feature detection here since this is a deprecated path */,
-            });
-            this.runtime.on("signal", (message, local) => {
-                assertSignalMessageIsValid(message);
-                manager.processSignal([], message, local);
-            });
-            this._presenceManager = manager;
-        }
-        return this._presenceManager;
-    }
-}
-/**
- * Factory class to create {@link Presence} in own data store.
- */
-class PresenceManagerFactory {
-    constructor() {
-        this.factory = new BasicDataStoreFactory("@fluidframework/presence", PresenceManagerDataObject);
-    }
-    is(value) {
-        return value instanceof PresenceManagerDataObject;
-    }
-}
-/**
- * DataStore based Presence Manager that is used as fallback for preferred Container
- * Extension based version requires registration. Export SharedObjectKind for registration.
- *
- * @deprecated Use {@link getPresence} instead.
- * @alpha
- */
-export const ExperimentalPresenceManager = new PresenceManagerFactory();
-/**
- * Acquire Presence from a DataStore based Presence Manager
- *
- * @example
- * ```typescript
- * const containerSchema = {
- * 	initialObjects: {
- * 		experimentalPresence: ExperimentalPresenceDO,
- * 	},
- * } satisfies ContainerSchema;
- * ```
- * then
- * ```typescript
- * const presence = getPresenceViaDataObject(
- * 	container.initialObjects.experimentalPresence,
- * 	);
- * ```
- *
- * @deprecated Use {@link getPresence} instead.
- * @alpha
- */
-export function getPresenceViaDataObject(fluidLoadable) {
-    if (fluidLoadable instanceof PresenceManagerDataObject) {
-        return fluidLoadable.presenceManager();
-    }
-    throw new Error("Incompatible loadable; make sure to use ExperimentalPresenceManager");
-}
-//# sourceMappingURL=datastorePresenceManagerFactory.js.map

package/lib/datastorePresenceManagerFactory.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"datastorePresenceManagerFactory.js","sourceRoot":"","sources":["../src/datastorePresenceManagerFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAM7D,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAI7D,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEnF,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAG7D;;GAEG;AACH,SAAS,0BAA0B,CAClC,OAA2E;IAE3E,MAAM,CAAC,OAAO,CAAC,QAAQ,KAAK,IAAI,EAAE,KAAK,CAAC,kCAAkC,CAAC,CAAC;IAC5E,8DAA8D;IAC9D,gFAAgF;AACjF,CAAC;AAED;;GAEG;AACH,MAAM,yBAA0B,SAAQ,mBAAmB;IAKnD,eAAe;QACrB,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC5B,+EAA+E;YAC/E,8EAA8E;YAC9E,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;YAC7B,MAAM,MAAM,GAAG,aAAa,EAAuB,CAAC;YACpD,OAAO,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,EAAE,CACpC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CACnD,CAAC;YACF,OAAO,CAAC,EAAE,CAAC,cAAc,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;YAE9D,MAAM,OAAO,GAAG,qBAAqB,CAAC;gBACrC,eAAe,EAAE,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,cAAc,CAAC;gBAChF,WAAW,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,QAAQ;gBACnC,MAAM;gBACN,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC;gBAC1C,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC;gBAC9C,YAAY,EAAE,CAAC,OAAgC,EAAE,EAAE,CAClD,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,cAAc,CAAC;gBAC5E,iBAAiB,EAChB,IAAI,GAAG,EAAE,CAAC,gFAAgF;aAC3F,CAAC,CAAC;YACH,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,OAA8B,EAAE,KAAc,EAAE,EAAE;gBAC5E,0BAA0B,CAAC,OAAO,CAAC,CAAC;gBACpC,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;YAC3C,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC;QACjC,CAAC;QACD,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC9B,CAAC;CACD;AAED;;GAEG;AACH,MAAM,sBAAsB;IAA5B;QAKiB,YAAO,GAAG,IAAI,qBAAqB,CAClD,0BAA0B,EAC1B,yBAAyB,CACzB,CAAC;IACH,CAAC;IARO,EAAE,CAAC,KAA8C;QACvD,OAAO,KAAK,YAAY,yBAAyB,CAAC;IACnD,CAAC;CAMD;AAgBD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,2BAA2B,GACvC,IAAI,sBAAsB,EAEzB,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,wBAAwB,CAAC,aAAqC;IAC7E,IAAI,aAAa,YAAY,yBAAyB,EAAE,CAAC;QACxD,OAAO,aAAa,CAAC,eAAe,EAAE,CAAC;IACxC,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;AACxF,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/*\n * Hacky support for internal datastore based usages.\n */\n\nimport { createEmitter } from \"@fluid-internal/client-utils\";\nimport type {\n\tExtensionHostEvents,\n\tRawInboundExtensionMessage,\n} from \"@fluidframework/container-runtime-definitions/internal\";\nimport type { IFluidLoadable } from \"@fluidframework/core-interfaces\";\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport type { IInboundSignalMessage } from \"@fluidframework/runtime-definitions/internal\";\nimport type { SharedObjectKind } from \"@fluidframework/shared-object-base\";\n\nimport { BasicDataStoreFactory, LoadableFluidObject } from \"./datastoreSupport.js\";\nimport type { PresenceWithNotifications as Presence } from \"./presence.js\";\nimport { createPresenceManager } from \"./presenceManager.js\";\nimport type { OutboundPresenceMessage, SignalMessages } from \"./protocol.js\";\n\n/**\n * This provides faux validation of the signal message.\n */\nfunction assertSignalMessageIsValid(\n\tmessage: IInboundSignalMessage | RawInboundExtensionMessage<SignalMessages>,\n): asserts message is RawInboundExtensionMessage<SignalMessages> {\n\tassert(message.clientId !== null, 0xa58 /* Signal must have a client ID */);\n\t// The other difference between messages is that `content` for\n\t// RawInboundExtensionMessage is JsonDeserialized and we are fine assuming that.\n}\n\n/**\n * Simple FluidObject holding Presence Manager.\n */\nclass PresenceManagerDataObject extends LoadableFluidObject {\n\t// Creation of presence manager is deferred until first acquisition to avoid\n\t// instantiations and stand-up by Summarizer that has no actual use.\n\tprivate _presenceManager: Presence | undefined;\n\n\tpublic presenceManager(): Presence {\n\t\tif (!this._presenceManager) {\n\t\t\t// TODO: investigate if ContainerExtensionStore (path-based address routing for\n\t\t\t// Signals) is readily detectable here and use that presence manager directly.\n\t\t\tconst runtime = this.runtime;\n\t\t\tconst events = createEmitter<ExtensionHostEvents>();\n\t\t\truntime.on(\"connected\", (clientId) =>\n\t\t\t\tevents.emit(\"joined\", { clientId, canWrite: true }),\n\t\t\t);\n\t\t\truntime.on(\"disconnected\", () => events.emit(\"disconnected\"));\n\n\t\t\tconst manager = createPresenceManager({\n\t\t\t\tgetJoinedStatus: () => (runtime.connected ? \"joinedForWriting\" : \"disconnected\"),\n\t\t\t\tgetClientId: () => runtime.clientId,\n\t\t\t\tevents,\n\t\t\t\tgetQuorum: runtime.getQuorum.bind(runtime),\n\t\t\t\tgetAudience: runtime.getAudience.bind(runtime),\n\t\t\t\tsubmitSignal: (message: OutboundPresenceMessage) =>\n\t\t\t\t\truntime.submitSignal(message.type, message.content, message.targetClientId),\n\t\t\t\tsupportedFeatures:\n\t\t\t\t\tnew Set() /* We do not implement feature detection here since this is a deprecated path */,\n\t\t\t});\n\t\t\tthis.runtime.on(\"signal\", (message: IInboundSignalMessage, local: boolean) => {\n\t\t\t\tassertSignalMessageIsValid(message);\n\t\t\t\tmanager.processSignal([], message, local);\n\t\t\t});\n\t\t\tthis._presenceManager = manager;\n\t\t}\n\t\treturn this._presenceManager;\n\t}\n}\n\n/**\n * Factory class to create {@link Presence} in own data store.\n */\nclass PresenceManagerFactory {\n\tpublic is(value: IFluidLoadable | ExperimentalPresenceDO): value is ExperimentalPresenceDO {\n\t\treturn value instanceof PresenceManagerDataObject;\n\t}\n\n\tpublic readonly factory = new BasicDataStoreFactory(\n\t\t\"@fluidframework/presence\",\n\t\tPresenceManagerDataObject,\n\t);\n}\n\n/**\n * Brand for Experimental Presence Data Object.\n *\n * @remarks\n * See {@link getPresenceViaDataObject} for example usage.\n *\n * @deprecated Use {@link getPresence} instead.\n * @sealed\n * @alpha\n */\nexport declare class ExperimentalPresenceDO {\n\tprivate readonly _self: ExperimentalPresenceDO;\n}\n\n/**\n * DataStore based Presence Manager that is used as fallback for preferred Container\n * Extension based version requires registration. Export SharedObjectKind for registration.\n *\n * @deprecated Use {@link getPresence} instead.\n * @alpha\n */\nexport const ExperimentalPresenceManager =\n\tnew PresenceManagerFactory() as unknown as SharedObjectKind<\n\t\tIFluidLoadable & ExperimentalPresenceDO\n\t>;\n\n/**\n * Acquire Presence from a DataStore based Presence Manager\n *\n * @example\n * ```typescript\n * const containerSchema = {\n * \tinitialObjects: {\n * \t\texperimentalPresence: ExperimentalPresenceDO,\n * \t},\n * } satisfies ContainerSchema;\n * ```\n * then\n * ```typescript\n * const presence = getPresenceViaDataObject(\n * \tcontainer.initialObjects.experimentalPresence,\n * \t);\n * ```\n *\n * @deprecated Use {@link getPresence} instead.\n * @alpha\n */\nexport function getPresenceViaDataObject(fluidLoadable: ExperimentalPresenceDO): Presence {\n\tif (fluidLoadable instanceof PresenceManagerDataObject) {\n\t\treturn fluidLoadable.presenceManager();\n\t}\n\n\tthrow new Error(\"Incompatible loadable; make sure to use ExperimentalPresenceManager\");\n}\n"]}

package/lib/datastoreSupport.d.ts

@@ -1,36 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-/**
- * This module provided collection of minimal (slim) helpers to support
- * DataObject creation for temporary {@link ExperimentalPresenceManager}.
- */
-import type { FluidObject, IFluidLoadable } from "@fluidframework/core-interfaces";
-import type { IFluidHandleInternal } from "@fluidframework/core-interfaces/internal";
-import { FluidDataStoreRuntime } from "@fluidframework/datastore/internal";
-import type { IFluidDataStoreContext, IFluidDataStoreFactory } from "@fluidframework/runtime-definitions/internal";
-/**
- * `BasicDataStoreFactory` is the factory for creating a {@link BasicFluidDataStoreRuntime}.
- */
-export declare class BasicDataStoreFactory<Type extends string> implements IFluidDataStoreFactory {
-    readonly type: Type;
-    private readonly instanceCtor;
-    get IFluidDataStoreFactory(): IFluidDataStoreFactory;
-    constructor(type: Type, instanceCtor: new (runtime: FluidDataStoreRuntime) => LoadableFluidObject);
-    instantiateDataStore(context: IFluidDataStoreContext, existing: boolean): Promise<FluidDataStoreRuntime>;
-}
-/**
- * `LoadableFluidObject` is helper to build a DataObject handling the {@link FluidObject}
- * and {@link IFluidLoadable} requirements.
- */
-export declare abstract class LoadableFluidObject implements FluidObject, IFluidLoadable {
-    protected readonly runtime: FluidDataStoreRuntime;
-    constructor(runtime: FluidDataStoreRuntime);
-    get IFluidLoadable(): this;
-    /**
-     * Handle to the this Fluid object.
-     */
-    get handle(): IFluidHandleInternal<FluidObject>;
-}
-//# sourceMappingURL=datastoreSupport.d.ts.map

package/lib/datastoreSupport.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"datastoreSupport.d.ts","sourceRoot":"","sources":["../src/datastoreSupport.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;GAGG;AAEH,OAAO,KAAK,EACX,WAAW,EACX,cAAc,EAGd,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0CAA0C,CAAC;AAErF,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,OAAO,KAAK,EACX,sBAAsB,EACtB,sBAAsB,EACtB,MAAM,8CAA8C,CAAC;AAgCtD;;GAEG;AACH,qBAAa,qBAAqB,CAAC,IAAI,SAAS,MAAM,CAAE,YAAW,sBAAsB;aAMvE,IAAI,EAAE,IAAI;IAC1B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAN9B,IAAW,sBAAsB,IAAI,sBAAsB,CAE1D;gBAGgB,IAAI,EAAE,IAAI,EACT,YAAY,EAAE,KAAK,OAAO,EAAE,qBAAqB,KAAK,mBAAmB;IAG9E,oBAAoB,CAChC,OAAO,EAAE,sBAAsB,EAC/B,QAAQ,EAAE,OAAO,GACf,OAAO,CAAC,qBAAqB,CAAC;CAiBjC;AAED;;;GAGG;AACH,8BAAsB,mBAAoB,YAAW,WAAW,EAAE,cAAc;IAC5D,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,qBAAqB;gBAA9B,OAAO,EAAE,qBAAqB;IAEpE,IAAW,cAAc,IAAI,IAAI,CAEhC;IAED;;OAEG;IACH,IAAW,MAAM,IAAI,oBAAoB,CAAC,WAAW,CAAC,CAMrD;CACD"}

package/lib/datastoreSupport.js

@@ -1,79 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { assert } from "@fluidframework/core-utils/internal";
-import { FluidDataStoreRuntime } from "@fluidframework/datastore/internal";
-import { create404Response } from "@fluidframework/runtime-utils/internal";
-/**
- * `BasicFluidDataStoreRuntime` extends the FluidDataStoreRuntime to provide a request
- * method that routes requests to the entrypoint Fluid object that is expected to be a
- * {@link LoadableFluidObject}.
- */
-class BasicFluidDataStoreRuntime extends FluidDataStoreRuntime {
-    async request(request) {
-        const response = await super.request(request);
-        if (response.status !== 404) {
-            return response;
-        }
-        // Return entrypoint object if someone requests it directly.
-        // Direct requests exist from two scenarios:
-        //   1. the request url is a "/"
-        //   2. the request url is empty
-        if (request.url === "" || request.url === "/" || request.url.startsWith("/?")) {
-            // The provideEntryPoint callback below always returns an instance of
-            // LoadableFluidObject. Make sure that is the case.
-            const dataObject = await this.entryPoint.get();
-            assert(dataObject instanceof LoadableFluidObject, 0xa36 /* Data store runtime entryPoint is not expected type */);
-            return { mimeType: "fluid/object", status: 200, value: dataObject };
-        }
-        return create404Response(request);
-    }
-}
-/**
- * `BasicDataStoreFactory` is the factory for creating a {@link BasicFluidDataStoreRuntime}.
- */
-export class BasicDataStoreFactory {
-    get IFluidDataStoreFactory() {
-        return this;
-    }
-    constructor(type, instanceCtor) {
-        this.type = type;
-        this.instanceCtor = instanceCtor;
-    }
-    async instantiateDataStore(context, existing) {
-        // Create a new runtime for our data store.
-        // The runtime is what Fluid uses to route to our data store.
-        const runtime = new BasicFluidDataStoreRuntime(context, 
-        /* ISharedObjectRegistry */ new Map(), existing, 
-        /* provideEntryPoint */ async () => {
-            assert(instance !== undefined, 0xa37 /* Intended entryPoint is undefined */);
-            return instance;
-        });
-        const instance = new this.instanceCtor(runtime);
-        return runtime;
-    }
-}
-/**
- * `LoadableFluidObject` is helper to build a DataObject handling the {@link FluidObject}
- * and {@link IFluidLoadable} requirements.
- */
-export class LoadableFluidObject {
-    constructor(runtime) {
-        this.runtime = runtime;
-    }
-    get IFluidLoadable() {
-        return this;
-    }
-    /**
-     * Handle to the this Fluid object.
-     */
-    get handle() {
-        // BasicDataStoreFactory provides an entryPoint initialization function
-        // to the data store runtime; so, this object should always have access to a
-        // non-null entryPoint.
-        assert(this.runtime.entryPoint !== undefined, 0xa38 /* EntryPoint was undefined */);
-        return this.runtime.entryPoint;
-    }
-}
-//# sourceMappingURL=datastoreSupport.js.map

package/lib/datastoreSupport.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"datastoreSupport.js","sourceRoot":"","sources":["../src/datastoreSupport.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAcH,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAC7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAK3E,OAAO,EAAE,iBAAiB,EAAE,MAAM,wCAAwC,CAAC;AAE3E;;;;GAIG;AACH,MAAM,0BAA2B,SAAQ,qBAAqB;IAC7C,KAAK,CAAC,OAAO,CAAC,OAAiB;QAC9C,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC9C,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC7B,OAAO,QAAQ,CAAC;QACjB,CAAC;QACD,4DAA4D;QAC5D,4CAA4C;QAC5C,gCAAgC;QAChC,gCAAgC;QAChC,IAAI,OAAO,CAAC,GAAG,KAAK,EAAE,IAAI,OAAO,CAAC,GAAG,KAAK,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YAC/E,qEAAqE;YACrE,mDAAmD;YACnD,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;YAC/C,MAAM,CACL,UAAU,YAAY,mBAAmB,EACzC,KAAK,CAAC,wDAAwD,CAC9D,CAAC;YACF,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;QACrE,CAAC;QACD,OAAO,iBAAiB,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;CACD;AAED;;GAEG;AACH,MAAM,OAAO,qBAAqB;IACjC,IAAW,sBAAsB;QAChC,OAAO,IAAI,CAAC;IACb,CAAC;IAED,YACiB,IAAU,EACT,YAAyE;QAD1E,SAAI,GAAJ,IAAI,CAAM;QACT,iBAAY,GAAZ,YAAY,CAA6D;IACxF,CAAC;IAEG,KAAK,CAAC,oBAAoB,CAChC,OAA+B,EAC/B,QAAiB;QAEjB,2CAA2C;QAC3C,6DAA6D;QAC7D,MAAM,OAAO,GAA0B,IAAI,0BAA0B,CACpE,OAAO;QACP,2BAA2B,CAAC,IAAI,GAAG,EAAE,EACrC,QAAQ;QACR,uBAAuB,CAAC,KAAK,IAAI,EAAE;YAClC,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE,KAAK,CAAC,sCAAsC,CAAC,CAAC;YAC7E,OAAO,QAAQ,CAAC;QACjB,CAAC,CACD,CAAC;QAEF,MAAM,QAAQ,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAEhD,OAAO,OAAO,CAAC;IAChB,CAAC;CACD;AAED;;;GAGG;AACH,MAAM,OAAgB,mBAAmB;IACxC,YAAsC,OAA8B;QAA9B,YAAO,GAAP,OAAO,CAAuB;IAAG,CAAC;IAExE,IAAW,cAAc;QACxB,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACH,IAAW,MAAM;QAChB,uEAAuE;QACvE,4EAA4E;QAC5E,uBAAuB;QACvB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,KAAK,SAAS,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;QACpF,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;IAChC,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * This module provided collection of minimal (slim) helpers to support\n * DataObject creation for temporary {@link ExperimentalPresenceManager}.\n */\n\nimport type {\n\tFluidObject,\n\tIFluidLoadable,\n\tIRequest,\n\tIResponse,\n} from \"@fluidframework/core-interfaces\";\nimport type { IFluidHandleInternal } from \"@fluidframework/core-interfaces/internal\";\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport { FluidDataStoreRuntime } from \"@fluidframework/datastore/internal\";\nimport type {\n\tIFluidDataStoreContext,\n\tIFluidDataStoreFactory,\n} from \"@fluidframework/runtime-definitions/internal\";\nimport { create404Response } from \"@fluidframework/runtime-utils/internal\";\n\n/**\n * `BasicFluidDataStoreRuntime` extends the FluidDataStoreRuntime to provide a request\n * method that routes requests to the entrypoint Fluid object that is expected to be a\n * {@link LoadableFluidObject}.\n */\nclass BasicFluidDataStoreRuntime extends FluidDataStoreRuntime {\n\tpublic override async request(request: IRequest): Promise<IResponse> {\n\t\tconst response = await super.request(request);\n\t\tif (response.status !== 404) {\n\t\t\treturn response;\n\t\t}\n\t\t// Return entrypoint object if someone requests it directly.\n\t\t// Direct requests exist from two scenarios:\n\t\t//   1. the request url is a \"/\"\n\t\t//   2. the request url is empty\n\t\tif (request.url === \"\" || request.url === \"/\" || request.url.startsWith(\"/?\")) {\n\t\t\t// The provideEntryPoint callback below always returns an instance of\n\t\t\t// LoadableFluidObject. Make sure that is the case.\n\t\t\tconst dataObject = await this.entryPoint.get();\n\t\t\tassert(\n\t\t\t\tdataObject instanceof LoadableFluidObject,\n\t\t\t\t0xa36 /* Data store runtime entryPoint is not expected type */,\n\t\t\t);\n\t\t\treturn { mimeType: \"fluid/object\", status: 200, value: dataObject };\n\t\t}\n\t\treturn create404Response(request);\n\t}\n}\n\n/**\n * `BasicDataStoreFactory` is the factory for creating a {@link BasicFluidDataStoreRuntime}.\n */\nexport class BasicDataStoreFactory<Type extends string> implements IFluidDataStoreFactory {\n\tpublic get IFluidDataStoreFactory(): IFluidDataStoreFactory {\n\t\treturn this;\n\t}\n\n\tpublic constructor(\n\t\tpublic readonly type: Type,\n\t\tprivate readonly instanceCtor: new (runtime: FluidDataStoreRuntime) => LoadableFluidObject,\n\t) {}\n\n\tpublic async instantiateDataStore(\n\t\tcontext: IFluidDataStoreContext,\n\t\texisting: boolean,\n\t): Promise<FluidDataStoreRuntime> {\n\t\t// Create a new runtime for our data store.\n\t\t// The runtime is what Fluid uses to route to our data store.\n\t\tconst runtime: FluidDataStoreRuntime = new BasicFluidDataStoreRuntime(\n\t\t\tcontext,\n\t\t\t/* ISharedObjectRegistry */ new Map(),\n\t\t\texisting,\n\t\t\t/* provideEntryPoint */ async () => {\n\t\t\t\tassert(instance !== undefined, 0xa37 /* Intended entryPoint is undefined */);\n\t\t\t\treturn instance;\n\t\t\t},\n\t\t);\n\n\t\tconst instance = new this.instanceCtor(runtime);\n\n\t\treturn runtime;\n\t}\n}\n\n/**\n * `LoadableFluidObject` is helper to build a DataObject handling the {@link FluidObject}\n * and {@link IFluidLoadable} requirements.\n */\nexport abstract class LoadableFluidObject implements FluidObject, IFluidLoadable {\n\tpublic constructor(protected readonly runtime: FluidDataStoreRuntime) {}\n\n\tpublic get IFluidLoadable(): this {\n\t\treturn this;\n\t}\n\n\t/**\n\t * Handle to the this Fluid object.\n\t */\n\tpublic get handle(): IFluidHandleInternal<FluidObject> {\n\t\t// BasicDataStoreFactory provides an entryPoint initialization function\n\t\t// to the data store runtime; so, this object should always have access to a\n\t\t// non-null entryPoint.\n\t\tassert(this.runtime.entryPoint !== undefined, 0xa38 /* EntryPoint was undefined */);\n\t\treturn this.runtime.entryPoint;\n\t}\n}\n"]}