@fluidframework/presence 2.10.0-307399

package/dist/datastoreSupport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"datastoreSupport.js","sourceRoot":"","sources":["../src/datastoreSupport.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AASH,kEAA6D;AAC7D,iEAA2E;AAK3E,qEAA2E;AAE3E;;;GAGG;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;;GAEG;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\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 * Extends the FluidDataStoreRuntime to provide a request method that routes requests to\n * the entrypoint Fluid object that is expected to be a {@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 * @internal\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 * @internal\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/dist/events/events.d.ts

@@ -0,0 +1,198 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * This file is a clone of the `events.ts` file from the `@fluidframework/tree` package.
+ * `@public` APIs have been changed to `@alpha` and some lint defects from more strict rules
+ * have been fixed or suppressed.
+ */
+import type { IEvent } from "@fluidframework/core-interfaces";
+/**
+ * Convert a union of types to an intersection of those types. Useful for `TransformEvents`.
+ */
+export type UnionToIntersection<T> = (T extends any ? (k: T) => unknown : never) extends (k: infer U) => unknown ? U : never;
+/**
+ * `true` iff the given type is an acceptable shape for an event
+ * @alpha
+ */
+export type IsEvent<Event> = Event extends (...args: any[]) => any ? true : false;
+/**
+ * Used to specify the kinds of events emitted by an {@link ISubscribable}.
+ *
+ * @remarks
+ *
+ * Any object type is a valid {@link Events}, but only the event-like properties of that
+ * type will be included.
+ *
+ * @example
+ *
+ * ```typescript
+ * interface MyEvents {
+ *   load: (user: string, data: IUserData) => void;
+ *   error: (errorCode: number) => void;
+ * }
+ * ```
+ *
+ * @alpha
+ */
+export type Events<E> = {
+    [P in (string | symbol) & keyof E as IsEvent<E[P]> extends true ? P : never]: E[P];
+};
+/**
+ * Converts an `Events` type (i.e. the event registry for an {@link ISubscribable}) into a type consumable
+ * by an IEventProvider from `@fluidframework/core-interfaces`.
+ * @param E - the `Events` type to transform
+ * @param Target - an optional `IEvent` type that will be merged into the result along with the transformed `E`
+ *
+ * @example
+ *
+ * ```typescript
+ * interface MyEvents {
+ *   load: (user: string, data: IUserData) => void;
+ *   error: (errorCode: number) => void;
+ * }
+ *
+ * class MySharedObject extends SharedObject<TransformEvents<MyEvents, ISharedObjectEvents>> {
+ *    // ...
+ * }
+ * ```
+ */
+export type TransformEvents<E extends Events<E>, Target extends IEvent = IEvent> = {
+    [P in keyof Events<E>]: (event: P, listener: E[P]) => void;
+} extends Record<any, infer Z> ? UnionToIntersection<Z> & Target : never;
+/**
+ * An object which allows the registration of listeners so that subscribers can be notified when an event happens.
+ *
+ * `EventEmitter` can be used as a base class to implement this via extension.
+ * @param E - All the events that this emitter supports
+ * @example
+ * ```ts
+ * type MyEventEmitter = IEventEmitter<{
+ *   load: (user: string, data: IUserData) => void;
+ *   error: (errorCode: number) => void;
+ * }>
+ * ```
+ * @privateRemarks
+ * {@link createEmitter} can help implement this interface via delegation.
+ *
+ * @alpha
+ */
+export interface ISubscribable<E extends Events<E>> {
+    /**
+     * Register an event listener.
+     * @param eventName - the name of the event
+     * @param listener - the handler to run when the event is fired by the emitter
+     * @returns a function which will deregister the listener when run. This function has undefined behavior
+     * if called more than once.
+     */
+    on<K extends keyof Events<E>>(eventName: K, listener: E[K]): () => void;
+}
+/**
+ * Interface for an event emitter that can emit typed events to subscribed listeners.
+ * @internal
+ */
+export interface IEmitter<E extends Events<E>> {
+    /**
+     * Emits an event with the specified name and arguments, notifying all subscribers by calling their registered listener functions.
+     * @param eventName - the name of the event to fire
+     * @param args - the arguments passed to the event listener functions
+     */
+    emit<K extends keyof Events<E>>(eventName: K, ...args: Parameters<E[K]>): void;
+    /**
+     * Emits an event with the specified name and arguments, notifying all subscribers by calling their registered listener functions.
+     * It also collects the return values of all listeners into an array.
+     *
+     * Warning: This method should be used with caution. It deviates from the standard event-based integration pattern as creates substantial coupling between the emitter and its listeners.
+     * For the majority of use-cases it is recommended to use the standard {@link IEmitter.emit} functionality.
+     * @param eventName - the name of the event to fire
+     * @param args - the arguments passed to the event listener functions
+     * @returns An array of the return values of each listener, preserving the order listeners were called.
+     */
+    emitAndCollect<K extends keyof Events<E>>(eventName: K, ...args: Parameters<E[K]>): ReturnType<E[K]>[];
+}
+/**
+ * Create an {@link ISubscribable} that can be instructed to emit events via the {@link IEmitter} interface.
+ *
+ * A class can delegate handling {@link ISubscribable} to the returned value while using it to emit the events.
+ * See also `EventEmitter` which be used as a base class to implement {@link ISubscribable} via extension.
+ * @internal
+ */
+export declare function createEmitter<E extends Events<E>>(noListeners?: NoListenersCallback<E>): ISubscribable<E> & IEmitter<E> & HasListeners<E>;
+/**
+ * Called when the last listener for `eventName` is removed.
+ * Useful for determining when to clean up resources related to detecting when the event might occurs.
+ * @internal
+ */
+export type NoListenersCallback<E extends Events<E>> = (eventName: keyof Events<E>) => void;
+/**
+ * @internal
+ */
+export interface HasListeners<E extends Events<E>> {
+    /**
+     * When no `eventName` is provided, returns true iff there are any listeners.
+     *
+     * When `eventName` is provided, returns true iff there are listeners for that event.
+     *
+     * @remarks
+     * This can be used to know when its safe to cleanup data-structures which only exist to fire events for their listeners.
+     */
+    hasListeners(eventName?: keyof Events<E>): boolean;
+}
+/**
+ * Provides an API for subscribing to and listening to events.
+ *
+ * @remarks Classes wishing to emit events may either extend this class or compose over it.
+ *
+ * @example Extending this class
+ *
+ * ```typescript
+ * interface MyEvents {
+ *   "loaded": () => void;
+ * }
+ *
+ * class MyClass extends EventEmitter<MyEvents> {
+ *   private load() {
+ *     this.emit("loaded");
+ *   }
+ * }
+ * ```
+ *
+ * @example Composing over this class
+ *
+ * ```typescript
+ * class MyClass implements ISubscribable<MyEvents> {
+ *   private readonly events = EventEmitter.create<MyEvents>();
+ *
+ *   private load() {
+ *     this.events.emit("loaded");
+ *   }
+ *
+ *   public on<K extends keyof MyEvents>(eventName: K, listener: MyEvents[K]): () => void {
+ *     return this.events.on(eventName, listener);
+ *   }
+ * }
+ * ```
+ */
+export declare class EventEmitter<E extends Events<E>> implements ISubscribable<E>, HasListeners<E> {
+    private readonly noListeners?;
+    private readonly listeners;
+    protected constructor(noListeners?: NoListenersCallback<E> | undefined);
+    protected emit<K extends keyof Events<E>>(eventName: K, ...args: Parameters<E[K]>): void;
+    protected emitAndCollect<K extends keyof Events<E>>(eventName: K, ...args: Parameters<E[K]>): ReturnType<E[K]>[];
+    /**
+     * Register an event listener.
+     * @param eventName - the name of the event
+     * @param listener - the handler to run when the event is fired by the emitter
+     * @returns a function which will deregister the listener when run.
+     * This function will error if called more than once.
+     * @privateRemarks
+     * TODO:
+     * invoking the returned callback can error even if its only called once if the same listener was provided to two calls to "on".
+     * This behavior is not documented and its unclear if its a bug or not: see note on listeners.
+     */
+    on<K extends keyof Events<E>>(eventName: K, listener: E[K]): () => void;
+    private off;
+    hasListeners(eventName?: keyof Events<E>): boolean;
+}
+//# sourceMappingURL=events.d.ts.map

package/dist/events/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/events/events.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;GAIG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAC;AAuB9D;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,OAAO,GAAG,KAAK,CAAC,SAAS,CACxF,CAAC,EAAE,MAAM,CAAC,KACN,OAAO,GACT,CAAC,GACD,KAAK,CAAC;AAET;;;GAGG;AACH,MAAM,MAAM,OAAO,CAAC,KAAK,IAAI,KAAK,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,GAAG,IAAI,GAAG,KAAK,CAAC;AAElF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,IAAI;KACtB,CAAC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;CAClF,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,SAAS,MAAM,GAAG,MAAM,IAAI;KACjF,CAAC,IAAI,MAAM,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI;CAC1D,SAAS,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,GAC3B,mBAAmB,CAAC,CAAC,CAAC,GAAG,MAAM,GAC/B,KAAK,CAAC;AAET;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC;IACjD;;;;;;OAMG;IACH,EAAE,CAAC,CAAC,SAAS,MAAM,MAAM,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,CAAC;CACxE;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ,CAAC,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC;IAC5C;;;;OAIG;IACH,IAAI,CAAC,CAAC,SAAS,MAAM,MAAM,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAE/E;;;;;;;;;OASG;IACH,cAAc,CAAC,CAAC,SAAS,MAAM,MAAM,CAAC,CAAC,CAAC,EACvC,SAAS,EAAE,CAAC,EACZ,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACvB,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;CACtB;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC,EAChD,WAAW,CAAC,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAClC,aAAa,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAElD;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AAE5F;;GAEG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC;IAChD;;;;;;;OAOG;IACH,YAAY,CAAC,SAAS,CAAC,EAAE,MAAM,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;CACnD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,qBAAa,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC,CAAE,YAAW,aAAa,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC;IASpE,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC;IAJnD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAwD;IAIlF,SAAS,aAA8B,WAAW,CAAC,oCAAwB;IAE3E,SAAS,CAAC,IAAI,CAAC,CAAC,SAAS,MAAM,MAAM,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI;IAcxF,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,MAAM,MAAM,CAAC,CAAC,CAAC,EACjD,SAAS,EAAE,CAAC,EACZ,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACvB,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE;IAgBrB;;;;;;;;;;OAUG;IACI,EAAE,CAAC,CAAC,SAAS,MAAM,MAAM,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI;IAK9E,OAAO,CAAC,GAAG;IAeJ,YAAY,CAAC,SAAS,CAAC,EAAE,MAAM,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO;CAMzD"}

package/dist/events/events.js

@@ -0,0 +1,157 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventEmitter = exports.createEmitter = void 0;
+const internal_1 = require("@fluidframework/core-utils/internal");
+function fail(message) {
+    throw new Error(message);
+}
+/**
+ * Retrieve a value from a map with the given key, or create a new entry if the key is not in the map.
+ * @param map - The map to query/update
+ * @param key - The key to lookup in the map
+ * @param defaultValue - a function which returns a default value. This is called and used to set an initial value for the given key in the map if none exists
+ * @returns either the existing value for the given key, or the newly-created value (the result of `defaultValue`)
+ */
+function getOrCreate(map, key, defaultValue) {
+    let value = map.get(key);
+    if (value === undefined) {
+        value = defaultValue(key);
+        map.set(key, value);
+    }
+    return value;
+}
+/**
+ * Create an {@link ISubscribable} that can be instructed to emit events via the {@link IEmitter} interface.
+ *
+ * A class can delegate handling {@link ISubscribable} to the returned value while using it to emit the events.
+ * See also `EventEmitter` which be used as a base class to implement {@link ISubscribable} via extension.
+ * @internal
+ */
+function createEmitter(noListeners) {
+    return new ComposableEventEmitter(noListeners);
+}
+exports.createEmitter = createEmitter;
+/**
+ * Provides an API for subscribing to and listening to events.
+ *
+ * @remarks Classes wishing to emit events may either extend this class or compose over it.
+ *
+ * @example Extending this class
+ *
+ * ```typescript
+ * interface MyEvents {
+ *   "loaded": () => void;
+ * }
+ *
+ * class MyClass extends EventEmitter<MyEvents> {
+ *   private load() {
+ *     this.emit("loaded");
+ *   }
+ * }
+ * ```
+ *
+ * @example Composing over this class
+ *
+ * ```typescript
+ * class MyClass implements ISubscribable<MyEvents> {
+ *   private readonly events = EventEmitter.create<MyEvents>();
+ *
+ *   private load() {
+ *     this.events.emit("loaded");
+ *   }
+ *
+ *   public on<K extends keyof MyEvents>(eventName: K, listener: MyEvents[K]): () => void {
+ *     return this.events.on(eventName, listener);
+ *   }
+ * }
+ * ```
+ */
+class EventEmitter {
+    // Because this is protected and not public, calling this externally (not from a subclass) makes sending events to the constructed instance impossible.
+    // Instead, use the static `create` function to get an instance which allows emitting events.
+    constructor(noListeners) {
+        this.noListeners = noListeners;
+        // TODO: because the inner data-structure here is a set, adding the same callback twice does not error,
+        // but only calls it once, and unsubscribing will stop calling it all together.
+        // This is surprising since it makes subscribing and unsubscribing not inverses (but instead both idempotent).
+        // This might be desired, but if so the documentation should indicate it.
+        this.listeners = new Map();
+    }
+    emit(eventName, ...args) {
+        const listeners = this.listeners.get(eventName);
+        if (listeners !== undefined) {
+            const argArray = args; // TODO: Current TS (4.5.5) cannot spread `args` into `listener()`, but future versions (e.g. 4.8.4) can.
+            // This explicitly copies listeners so that new listeners added during this call to emit will not receive this event.
+            for (const listener of listeners) {
+                // If listener has been unsubscribed while invoking other listeners, skip it.
+                if (listeners.has(listener)) {
+                    listener(...argArray);
+                }
+            }
+        }
+    }
+    emitAndCollect(eventName, ...args) {
+        const listeners = this.listeners.get(eventName);
+        if (listeners !== undefined) {
+            const argArray = args;
+            const resultArray = [];
+            for (const listener of listeners.values()) {
+                // listner return type is any to enable this.listeners to be a Map
+                // of Sets rather than a Record with tracked (known) return types.
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+                resultArray.push(listener(...argArray));
+            }
+            return resultArray;
+        }
+        return [];
+    }
+    /**
+     * Register an event listener.
+     * @param eventName - the name of the event
+     * @param listener - the handler to run when the event is fired by the emitter
+     * @returns a function which will deregister the listener when run.
+     * This function will error if called more than once.
+     * @privateRemarks
+     * TODO:
+     * invoking the returned callback can error even if its only called once if the same listener was provided to two calls to "on".
+     * This behavior is not documented and its unclear if its a bug or not: see note on listeners.
+     */
+    on(eventName, listener) {
+        getOrCreate(this.listeners, eventName, () => new Set()).add(listener);
+        return () => this.off(eventName, listener);
+    }
+    off(eventName, listener) {
+        const listeners = this.listeners.get(eventName) ??
+            // TODO: consider making this (and assert below) a usage error since it can be triggered by users of the public API: maybe separate those use cases somehow?
+            fail("Event has no listeners. Event deregistration functions may only be invoked once.");
+        (0, internal_1.assert)(listeners.delete(listener), 0xa30 /* Listener does not exist. Event deregistration functions may only be invoked once. */);
+        if (listeners.size === 0) {
+            this.listeners.delete(eventName);
+            this.noListeners?.(eventName);
+        }
+    }
+    hasListeners(eventName) {
+        if (eventName === undefined) {
+            return this.listeners.size > 0;
+        }
+        return this.listeners.has(eventName);
+    }
+}
+exports.EventEmitter = EventEmitter;
+// This class exposes the constructor and the `emit` method of `EventEmitter`, elevating them from protected to public
+class ComposableEventEmitter extends EventEmitter {
+    constructor(noListeners) {
+        super(noListeners);
+    }
+    emit(eventName, ...args) {
+        return super.emit(eventName, ...args);
+    }
+    emitAndCollect(eventName, ...args) {
+        return super.emitAndCollect(eventName, ...args);
+    }
+}
+//# sourceMappingURL=events.js.map

package/dist/events/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/events/events.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AASH,kEAA6D;AAE7D,SAAS,IAAI,CAAC,OAAe;IAC5B,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;AAC1B,CAAC;AAED;;;;;;GAMG;AACH,SAAS,WAAW,CAAO,GAAc,EAAE,GAAM,EAAE,YAA2B;IAC7E,IAAI,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACzB,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACzB,KAAK,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;QAC1B,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACrB,CAAC;IACD,OAAO,KAAK,CAAC;AACd,CAAC;AAyHD;;;;;;GAMG;AACH,SAAgB,aAAa,CAC5B,WAAoC;IAEpC,OAAO,IAAI,sBAAsB,CAAI,WAAW,CAAC,CAAC;AACnD,CAAC;AAJD,sCAIC;AAwBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAa,YAAY;IAOxB,uJAAuJ;IACvJ,6FAA6F;IAC7F,YAAuC,WAAoC;QAApC,gBAAW,GAAX,WAAW,CAAyB;QAR3E,uGAAuG;QACvG,+EAA+E;QAC/E,8GAA8G;QAC9G,yEAAyE;QACxD,cAAS,GAAG,IAAI,GAAG,EAA6C,CAAC;IAIJ,CAAC;IAErE,IAAI,CAA4B,SAAY,EAAE,GAAG,IAAsB;QAChF,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAChD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,QAAQ,GAAc,IAAI,CAAC,CAAC,yGAAyG;YAC3I,qHAAqH;YACrH,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;gBAClC,6EAA6E;gBAC7E,IAAI,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAC7B,QAAQ,CAAC,GAAG,QAAQ,CAAC,CAAC;gBACvB,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC;IAES,cAAc,CACvB,SAAY,EACZ,GAAG,IAAsB;QAEzB,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAChD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,QAAQ,GAAc,IAAI,CAAC;YACjC,MAAM,WAAW,GAAuB,EAAE,CAAC;YAC3C,KAAK,MAAM,QAAQ,IAAI,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC;gBAC3C,kEAAkE;gBAClE,kEAAkE;gBAClE,iEAAiE;gBACjE,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC;YACzC,CAAC;YACD,OAAO,WAAW,CAAC;QACpB,CAAC;QACD,OAAO,EAAE,CAAC;IACX,CAAC;IAED;;;;;;;;;;OAUG;IACI,EAAE,CAA4B,SAAY,EAAE,QAAc;QAChE,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACtE,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC5C,CAAC;IAEO,GAAG,CAA4B,SAAY,EAAE,QAAc;QAClE,MAAM,SAAS,GACd,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC;YAC7B,4JAA4J;YAC5J,IAAI,CAAC,kFAAkF,CAAC,CAAC;QAC1F,IAAA,iBAAM,EACL,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,EAC1B,KAAK,CAAC,uFAAuF,CAC7F,CAAC;QACF,IAAI,SAAS,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YAC1B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YACjC,IAAI,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,CAAC;QAC/B,CAAC;IACF,CAAC;IAEM,YAAY,CAAC,SAA2B;QAC9C,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,GAAG,CAAC,CAAC;QAChC,CAAC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC;CACD;AAjFD,oCAiFC;AAED,sHAAsH;AACtH,MAAM,sBACL,SAAQ,YAAe;IAGvB,YAAmB,WAAoC;QACtD,KAAK,CAAC,WAAW,CAAC,CAAC;IACpB,CAAC;IAEe,IAAI,CACnB,SAAY,EACZ,GAAG,IAAsB;QAEzB,OAAO,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,IAAI,CAAC,CAAC;IACvC,CAAC;IAEe,cAAc,CAC7B,SAAY,EACZ,GAAG,IAAsB;QAEzB,OAAO,KAAK,CAAC,cAAc,CAAC,SAAS,EAAE,GAAG,IAAI,CAAC,CAAC;IACjD,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * This file is a clone of the `events.ts` file from the `@fluidframework/tree` package.\n * `@public` APIs have been changed to `@alpha` and some lint defects from more strict rules\n * have been fixed or suppressed.\n */\n\nimport type { IEvent } from \"@fluidframework/core-interfaces\";\nimport { assert } from \"@fluidframework/core-utils/internal\";\n\nfunction fail(message: string): never {\n\tthrow new Error(message);\n}\n\n/**\n * Retrieve a value from a map with the given key, or create a new entry if the key is not in the map.\n * @param map - The map to query/update\n * @param key - The key to lookup in the map\n * @param defaultValue - a function which returns a default value. This is called and used to set an initial value for the given key in the map if none exists\n * @returns either the existing value for the given key, or the newly-created value (the result of `defaultValue`)\n */\nfunction getOrCreate<K, V>(map: Map<K, V>, key: K, defaultValue: (key: K) => V): V {\n\tlet value = map.get(key);\n\tif (value === undefined) {\n\t\tvalue = defaultValue(key);\n\t\tmap.set(key, value);\n\t}\n\treturn value;\n}\n\n/**\n * Convert a union of types to an intersection of those types. Useful for `TransformEvents`.\n */\nexport type UnionToIntersection<T> = (T extends any ? (k: T) => unknown : never) extends (\n\tk: infer U,\n) => unknown\n\t? U\n\t: never;\n\n/**\n * `true` iff the given type is an acceptable shape for an event\n * @alpha\n */\nexport type IsEvent<Event> = Event extends (...args: any[]) => any ? true : false;\n\n/**\n * Used to specify the kinds of events emitted by an {@link ISubscribable}.\n *\n * @remarks\n *\n * Any object type is a valid {@link Events}, but only the event-like properties of that\n * type will be included.\n *\n * @example\n *\n * ```typescript\n * interface MyEvents {\n *   load: (user: string, data: IUserData) => void;\n *   error: (errorCode: number) => void;\n * }\n * ```\n *\n * @alpha\n */\nexport type Events<E> = {\n\t[P in (string | symbol) & keyof E as IsEvent<E[P]> extends true ? P : never]: E[P];\n};\n\n/**\n * Converts an `Events` type (i.e. the event registry for an {@link ISubscribable}) into a type consumable\n * by an IEventProvider from `@fluidframework/core-interfaces`.\n * @param E - the `Events` type to transform\n * @param Target - an optional `IEvent` type that will be merged into the result along with the transformed `E`\n *\n * @example\n *\n * ```typescript\n * interface MyEvents {\n *   load: (user: string, data: IUserData) => void;\n *   error: (errorCode: number) => void;\n * }\n *\n * class MySharedObject extends SharedObject<TransformEvents<MyEvents, ISharedObjectEvents>> {\n *    // ...\n * }\n * ```\n */\nexport type TransformEvents<E extends Events<E>, Target extends IEvent = IEvent> = {\n\t[P in keyof Events<E>]: (event: P, listener: E[P]) => void;\n} extends Record<any, infer Z>\n\t? UnionToIntersection<Z> & Target\n\t: never;\n\n/**\n * An object which allows the registration of listeners so that subscribers can be notified when an event happens.\n *\n * `EventEmitter` can be used as a base class to implement this via extension.\n * @param E - All the events that this emitter supports\n * @example\n * ```ts\n * type MyEventEmitter = IEventEmitter<{\n *   load: (user: string, data: IUserData) => void;\n *   error: (errorCode: number) => void;\n * }>\n * ```\n * @privateRemarks\n * {@link createEmitter} can help implement this interface via delegation.\n *\n * @alpha\n */\nexport interface ISubscribable<E extends Events<E>> {\n\t/**\n\t * Register an event listener.\n\t * @param eventName - the name of the event\n\t * @param listener - the handler to run when the event is fired by the emitter\n\t * @returns a function which will deregister the listener when run. This function has undefined behavior\n\t * if called more than once.\n\t */\n\ton<K extends keyof Events<E>>(eventName: K, listener: E[K]): () => void;\n}\n\n/**\n * Interface for an event emitter that can emit typed events to subscribed listeners.\n * @internal\n */\nexport interface IEmitter<E extends Events<E>> {\n\t/**\n\t * Emits an event with the specified name and arguments, notifying all subscribers by calling their registered listener functions.\n\t * @param eventName - the name of the event to fire\n\t * @param args - the arguments passed to the event listener functions\n\t */\n\temit<K extends keyof Events<E>>(eventName: K, ...args: Parameters<E[K]>): void;\n\n\t/**\n\t * Emits an event with the specified name and arguments, notifying all subscribers by calling their registered listener functions.\n\t * It also collects the return values of all listeners into an array.\n\t *\n\t * Warning: This method should be used with caution. It deviates from the standard event-based integration pattern as creates substantial coupling between the emitter and its listeners.\n\t * For the majority of use-cases it is recommended to use the standard {@link IEmitter.emit} functionality.\n\t * @param eventName - the name of the event to fire\n\t * @param args - the arguments passed to the event listener functions\n\t * @returns An array of the return values of each listener, preserving the order listeners were called.\n\t */\n\temitAndCollect<K extends keyof Events<E>>(\n\t\teventName: K,\n\t\t...args: Parameters<E[K]>\n\t): ReturnType<E[K]>[];\n}\n\n/**\n * Create an {@link ISubscribable} that can be instructed to emit events via the {@link IEmitter} interface.\n *\n * A class can delegate handling {@link ISubscribable} to the returned value while using it to emit the events.\n * See also `EventEmitter` which be used as a base class to implement {@link ISubscribable} via extension.\n * @internal\n */\nexport function createEmitter<E extends Events<E>>(\n\tnoListeners?: NoListenersCallback<E>,\n): ISubscribable<E> & IEmitter<E> & HasListeners<E> {\n\treturn new ComposableEventEmitter<E>(noListeners);\n}\n\n/**\n * Called when the last listener for `eventName` is removed.\n * Useful for determining when to clean up resources related to detecting when the event might occurs.\n * @internal\n */\nexport type NoListenersCallback<E extends Events<E>> = (eventName: keyof Events<E>) => void;\n\n/**\n * @internal\n */\nexport interface HasListeners<E extends Events<E>> {\n\t/**\n\t * When no `eventName` is provided, returns true iff there are any listeners.\n\t *\n\t * When `eventName` is provided, returns true iff there are listeners for that event.\n\t *\n\t * @remarks\n\t * This can be used to know when its safe to cleanup data-structures which only exist to fire events for their listeners.\n\t */\n\thasListeners(eventName?: keyof Events<E>): boolean;\n}\n\n/**\n * Provides an API for subscribing to and listening to events.\n *\n * @remarks Classes wishing to emit events may either extend this class or compose over it.\n *\n * @example Extending this class\n *\n * ```typescript\n * interface MyEvents {\n *   \"loaded\": () => void;\n * }\n *\n * class MyClass extends EventEmitter<MyEvents> {\n *   private load() {\n *     this.emit(\"loaded\");\n *   }\n * }\n * ```\n *\n * @example Composing over this class\n *\n * ```typescript\n * class MyClass implements ISubscribable<MyEvents> {\n *   private readonly events = EventEmitter.create<MyEvents>();\n *\n *   private load() {\n *     this.events.emit(\"loaded\");\n *   }\n *\n *   public on<K extends keyof MyEvents>(eventName: K, listener: MyEvents[K]): () => void {\n *     return this.events.on(eventName, listener);\n *   }\n * }\n * ```\n */\nexport class EventEmitter<E extends Events<E>> implements ISubscribable<E>, HasListeners<E> {\n\t// TODO: because the inner data-structure here is a set, adding the same callback twice does not error,\n\t// but only calls it once, and unsubscribing will stop calling it all together.\n\t// This is surprising since it makes subscribing and unsubscribing not inverses (but instead both idempotent).\n\t// This might be desired, but if so the documentation should indicate it.\n\tprivate readonly listeners = new Map<keyof E, Set<(...args: unknown[]) => any>>();\n\n\t// Because this is protected and not public, calling this externally (not from a subclass) makes sending events to the constructed instance impossible.\n\t// Instead, use the static `create` function to get an instance which allows emitting events.\n\tprotected constructor(private readonly noListeners?: NoListenersCallback<E>) {}\n\n\tprotected emit<K extends keyof Events<E>>(eventName: K, ...args: Parameters<E[K]>): void {\n\t\tconst listeners = this.listeners.get(eventName);\n\t\tif (listeners !== undefined) {\n\t\t\tconst argArray: unknown[] = args; // TODO: Current TS (4.5.5) cannot spread `args` into `listener()`, but future versions (e.g. 4.8.4) can.\n\t\t\t// This explicitly copies listeners so that new listeners added during this call to emit will not receive this event.\n\t\t\tfor (const listener of listeners) {\n\t\t\t\t// If listener has been unsubscribed while invoking other listeners, skip it.\n\t\t\t\tif (listeners.has(listener)) {\n\t\t\t\t\tlistener(...argArray);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\tprotected emitAndCollect<K extends keyof Events<E>>(\n\t\teventName: K,\n\t\t...args: Parameters<E[K]>\n\t): ReturnType<E[K]>[] {\n\t\tconst listeners = this.listeners.get(eventName);\n\t\tif (listeners !== undefined) {\n\t\t\tconst argArray: unknown[] = args;\n\t\t\tconst resultArray: ReturnType<E[K]>[] = [];\n\t\t\tfor (const listener of listeners.values()) {\n\t\t\t\t// listner return type is any to enable this.listeners to be a Map\n\t\t\t\t// of Sets rather than a Record with tracked (known) return types.\n\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-argument\n\t\t\t\tresultArray.push(listener(...argArray));\n\t\t\t}\n\t\t\treturn resultArray;\n\t\t}\n\t\treturn [];\n\t}\n\n\t/**\n\t * Register an event listener.\n\t * @param eventName - the name of the event\n\t * @param listener - the handler to run when the event is fired by the emitter\n\t * @returns a function which will deregister the listener when run.\n\t * This function will error if called more than once.\n\t * @privateRemarks\n\t * TODO:\n\t * invoking the returned callback can error even if its only called once if the same listener was provided to two calls to \"on\".\n\t * This behavior is not documented and its unclear if its a bug or not: see note on listeners.\n\t */\n\tpublic on<K extends keyof Events<E>>(eventName: K, listener: E[K]): () => void {\n\t\tgetOrCreate(this.listeners, eventName, () => new Set()).add(listener);\n\t\treturn () => this.off(eventName, listener);\n\t}\n\n\tprivate off<K extends keyof Events<E>>(eventName: K, listener: E[K]): void {\n\t\tconst listeners =\n\t\t\tthis.listeners.get(eventName) ??\n\t\t\t// TODO: consider making this (and assert below) a usage error since it can be triggered by users of the public API: maybe separate those use cases somehow?\n\t\t\tfail(\"Event has no listeners. Event deregistration functions may only be invoked once.\");\n\t\tassert(\n\t\t\tlisteners.delete(listener),\n\t\t\t0xa30 /* Listener does not exist. Event deregistration functions may only be invoked once. */,\n\t\t);\n\t\tif (listeners.size === 0) {\n\t\t\tthis.listeners.delete(eventName);\n\t\t\tthis.noListeners?.(eventName);\n\t\t}\n\t}\n\n\tpublic hasListeners(eventName?: keyof Events<E>): boolean {\n\t\tif (eventName === undefined) {\n\t\t\treturn this.listeners.size > 0;\n\t\t}\n\t\treturn this.listeners.has(eventName);\n\t}\n}\n\n// This class exposes the constructor and the `emit` method of `EventEmitter`, elevating them from protected to public\nclass ComposableEventEmitter<E extends Events<E>>\n\textends EventEmitter<E>\n\timplements IEmitter<E>\n{\n\tpublic constructor(noListeners?: NoListenersCallback<E>) {\n\t\tsuper(noListeners);\n\t}\n\n\tpublic override emit<K extends keyof Events<E>>(\n\t\teventName: K,\n\t\t...args: Parameters<E[K]>\n\t): void {\n\t\treturn super.emit(eventName, ...args);\n\t}\n\n\tpublic override emitAndCollect<K extends keyof Events<E>>(\n\t\teventName: K,\n\t\t...args: Parameters<E[K]>\n\t): ReturnType<E[K]>[] {\n\t\treturn super.emitAndCollect(eventName, ...args);\n\t}\n}\n"]}

package/dist/experimentalAccess.d.ts

@@ -0,0 +1,15 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { IFluidContainer } from "@fluidframework/fluid-static";
+import type { IPresence } from "./presence.js";
+/**
+ * Acquire an IPresence from a Fluid Container
+ * @param fluidContainer - Fluid Container to acquire the map from
+ * @returns the IPresence
+ *
+ * @alpha
+ */
+export declare function acquirePresence(fluidContainer: IFluidContainer): IPresence;
+//# sourceMappingURL=experimentalAccess.d.ts.map

package/dist/experimentalAccess.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"experimentalAccess.d.ts","sourceRoot":"","sources":["../src/experimentalAccess.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAKpE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AA2C/C;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,cAAc,EAAE,eAAe,GAAG,SAAS,CAiB1E"}

package/dist/experimentalAccess.js

@@ -0,0 +1,46 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.acquirePresence = void 0;
+const internal_1 = require("@fluidframework/core-utils/internal");
+const internal_2 = require("@fluidframework/fluid-static/internal");
+const presenceManager_js_1 = require("./presenceManager.js");
+function isContainerExtensionStore(manager) {
+    return manager.acquireExtension !== undefined;
+}
+/**
+ * Common Presence manager for a container
+ */
+class ContainerPresenceManager {
+    constructor(runtime) {
+        this.extension = this;
+        // TODO create the appropriate ephemeral runtime (map address must be in submitSignal, etc.)
+        this.interface = this.manager = (0, presenceManager_js_1.createPresenceManager)(runtime);
+    }
+    onNewContext() {
+        // No-op
+    }
+    processSignal(address, message, local) {
+        this.manager.processSignal(address, message, local);
+    }
+}
+ContainerPresenceManager.extensionId = "dis:bb89f4c0-80fd-4f0c-8469-4f2848ee7f4a";
+/**
+ * Acquire an IPresence from a Fluid Container
+ * @param fluidContainer - Fluid Container to acquire the map from
+ * @returns the IPresence
+ *
+ * @alpha
+ */
+function acquirePresence(fluidContainer) {
+    (0, internal_1.assert)((0, internal_2.isInternalFluidContainer)(fluidContainer), 0xa2f /* IFluidContainer was not recognized. Only Containers generated by the Fluid Framework are supported. */);
+    const innerContainer = fluidContainer.container;
+    (0, internal_1.assert)(isContainerExtensionStore(innerContainer), 0xa39 /* Container does not support extensions. Use acquirePresenceViaDataObject. */);
+    const presence = innerContainer.acquireExtension(ContainerPresenceManager.extensionId, ContainerPresenceManager);
+    return presence;
+}
+exports.acquirePresence = acquirePresence;
+//# sourceMappingURL=experimentalAccess.js.map

package/dist/experimentalAccess.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"experimentalAccess.js","sourceRoot":"","sources":["../src/experimentalAccess.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,kEAA6D;AAE7D,oEAAiF;AAMjF,6DAA6D;AAS7D,SAAS,yBAAyB,CACjC,OAAiF;IAEjF,OAAQ,OAAmC,CAAC,gBAAgB,KAAK,SAAS,CAAC;AAC5E,CAAC;AAED;;GAEG;AACH,MAAM,wBAAwB;IAK7B,YAAmB,OAA0B;QAH7B,cAAS,GAAG,IAAI,CAAC;QAIhC,4FAA4F;QAC5F,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,OAAO,GAAG,IAAA,0CAAqB,EACpD,OAAuC,CACvC,CAAC;IACH,CAAC;IAEM,YAAY;QAClB,QAAQ;IACT,CAAC;IAIM,aAAa,CAAC,OAAe,EAAE,OAA0B,EAAE,KAAc;QAC/E,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IACrD,CAAC;;AAJsB,oCAAW,GAAG,0CAA0C,AAA7C,CAA8C;AAOjF;;;;;;GAMG;AACH,SAAgB,eAAe,CAAC,cAA+B;IAC9D,IAAA,iBAAM,EACL,IAAA,mCAAwB,EAAC,cAAc,CAAC,EACxC,KAAK,CAAC,yGAAyG,CAC/G,CAAC;IACF,MAAM,cAAc,GAAG,cAAc,CAAC,SAAS,CAAC;IAEhD,IAAA,iBAAM,EACL,yBAAyB,CAAC,cAAc,CAAC,EACzC,KAAK,CAAC,8EAA8E,CACpF,CAAC;IAEF,MAAM,QAAQ,GAAG,cAAc,CAAC,gBAAgB,CAC/C,wBAAwB,CAAC,WAAW,EACpC,wBAAwB,CACxB,CAAC;IACF,OAAO,QAAQ,CAAC;AACjB,CAAC;AAjBD,0CAiBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IContainerExperimental } from \"@fluidframework/container-loader/internal\";\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport type { IFluidContainer } from \"@fluidframework/fluid-static\";\nimport { isInternalFluidContainer } from \"@fluidframework/fluid-static/internal\";\nimport type { IContainerRuntimeBase } from \"@fluidframework/runtime-definitions/internal\";\n\nimport type { IEphemeralRuntime } from \"./internalTypes.js\";\nimport type { IPresence } from \"./presence.js\";\nimport type { PresenceExtensionInterface } from \"./presenceManager.js\";\nimport { createPresenceManager } from \"./presenceManager.js\";\n\nimport type {\n\tContainerExtensionStore,\n\tIContainerExtension,\n\tIExtensionMessage,\n\tIExtensionRuntime,\n} from \"@fluidframework/presence/internal/container-definitions/internal\";\n\nfunction isContainerExtensionStore(\n\tmanager: ContainerExtensionStore | IContainerRuntimeBase | IContainerExperimental,\n): manager is ContainerExtensionStore {\n\treturn (manager as ContainerExtensionStore).acquireExtension !== undefined;\n}\n\n/**\n * Common Presence manager for a container\n */\nclass ContainerPresenceManager implements IContainerExtension<never> {\n\tpublic readonly interface: IPresence;\n\tpublic readonly extension = this;\n\tprivate readonly manager: PresenceExtensionInterface;\n\n\tpublic constructor(runtime: IExtensionRuntime) {\n\t\t// TODO create the appropriate ephemeral runtime (map address must be in submitSignal, etc.)\n\t\tthis.interface = this.manager = createPresenceManager(\n\t\t\truntime as unknown as IEphemeralRuntime,\n\t\t);\n\t}\n\n\tpublic onNewContext(): void {\n\t\t// No-op\n\t}\n\n\tpublic static readonly extensionId = \"dis:bb89f4c0-80fd-4f0c-8469-4f2848ee7f4a\";\n\n\tpublic processSignal(address: string, message: IExtensionMessage, local: boolean): void {\n\t\tthis.manager.processSignal(address, message, local);\n\t}\n}\n\n/**\n * Acquire an IPresence from a Fluid Container\n * @param fluidContainer - Fluid Container to acquire the map from\n * @returns the IPresence\n *\n * @alpha\n */\nexport function acquirePresence(fluidContainer: IFluidContainer): IPresence {\n\tassert(\n\t\tisInternalFluidContainer(fluidContainer),\n\t\t0xa2f /* IFluidContainer was not recognized. Only Containers generated by the Fluid Framework are supported. */,\n\t);\n\tconst innerContainer = fluidContainer.container;\n\n\tassert(\n\t\tisContainerExtensionStore(innerContainer),\n\t\t0xa39 /* Container does not support extensions. Use acquirePresenceViaDataObject. */,\n\t);\n\n\tconst presence = innerContainer.acquireExtension(\n\t\tContainerPresenceManager.extensionId,\n\t\tContainerPresenceManager,\n\t);\n\treturn presence;\n}\n"]}

package/dist/exposedInternalTypes.d.ts

@@ -0,0 +1,100 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { JsonDeserialized, JsonSerializable } from "@fluidframework/presence/internal/core-interfaces";
+/**
+ * Collection of value types that are not intended to be used/imported
+ * directly outside of this package.
+ *
+ * @alpha
+ * @system
+ */
+export declare namespace InternalTypes {
+    /**
+     * @system
+     */
+    interface ValueStateMetadata {
+        rev: number;
+        timestamp: number;
+    }
+    /**
+     * @system
+     */
+    interface ValueOptionalState<TValue> extends ValueStateMetadata {
+        value?: JsonDeserialized<TValue>;
+    }
+    /**
+     * @system
+     */
+    interface ValueRequiredState<TValue> extends ValueStateMetadata {
+        value: JsonDeserialized<TValue>;
+    }
+    /**
+     * @system
+     */
+    interface ValueDirectory<T> {
+        rev: number;
+        items: {
+            [name: string | number]: ValueOptionalState<T> | ValueDirectory<T>;
+        };
+    }
+    /**
+     * @system
+     */
+    type ValueDirectoryOrState<T> = ValueRequiredState<T> | ValueDirectory<T>;
+    /**
+     * @system
+     */
+    interface MapValueState<T> {
+        rev: number;
+        items: {
+            [name: string | number]: ValueOptionalState<T>;
+        };
+    }
+    /**
+     * @system
+     */
+    class StateDatastoreHandle<TKey, TValue extends ValueDirectoryOrState<any>> {
+        private readonly StateDatastoreHandle;
+    }
+    /**
+     * Brand to ensure state values internal type safety without revealing
+     * internals that are subject to change.
+     *
+     * @system
+     */
+    class StateValueBrand<T> {
+        private readonly StateValue;
+    }
+    /**
+     * This type provides no additional functionality over the type it wraps.
+     * It is used to ensure type safety within package.
+     * Users may find it convenient to just use the type it wraps directly.
+     *
+     * @privateRemarks
+     * Checkout filtering omitting unknown from T (`Omit<T,unknown> &`).
+     *
+     * @system
+     */
+    type StateValue<T> = T & StateValueBrand<T>;
+    /**
+     * Package internal function declaration for value manager instantiation.
+     *
+     * @system
+     */
+    type ManagerFactory<TKey extends string, TValue extends ValueDirectoryOrState<any>, TManager> = {
+        instanceBase: new (...args: any[]) => any;
+    } & ((key: TKey, datastoreHandle: StateDatastoreHandle<TKey, TValue>) => {
+        value?: TValue;
+        manager: StateValue<TManager>;
+    });
+    /**
+     * @system
+     */
+    interface NotificationType {
+        name: string;
+        args: (JsonSerializable<unknown> & JsonDeserialized<unknown>)[];
+    }
+}
+//# sourceMappingURL=exposedInternalTypes.d.ts.map

package/dist/exposedInternalTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exposedInternalTypes.d.ts","sourceRoot":"","sources":["../src/exposedInternalTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,gBAAgB,EAChB,gBAAgB,EAChB,MAAM,mDAAmD,CAAC;AAE3D;;;;;;GAMG;AAEH,yBAAiB,aAAa,CAAC;IAC9B;;OAEG;IACH,UAAiB,kBAAkB;QAClC,GAAG,EAAE,MAAM,CAAC;QACZ,SAAS,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,kBAAkB,CAAC,MAAM,CAAE,SAAQ,kBAAkB;QACrE,KAAK,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAC;KACjC;IAED;;OAEG;IACH,UAAiB,kBAAkB,CAAC,MAAM,CAAE,SAAQ,kBAAkB;QACrE,KAAK,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAC;KAChC;IAED;;OAEG;IACH,UAAiB,cAAc,CAAC,CAAC;QAChC,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE;YAIN,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,kBAAkB,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;SACnE,CAAC;KACF;IAED;;OAEG;IACH,KAAY,qBAAqB,CAAC,CAAC,IAAI,kBAAkB,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;IAEjF;;OAEG;IACH,UAAiB,aAAa,CAAC,CAAC;QAC/B,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE;YAIN,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC;SAC/C,CAAC;KACF;IAED;;OAEG;IACH,MAAqB,oBAAoB,CAAC,IAAI,EAAE,MAAM,SAAS,qBAAqB,CAAC,GAAG,CAAC;QACxF,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAqC;KAC1E;IAED;;;;;OAKG;IACH,MAAqB,eAAe,CAAC,CAAC;QACrC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgB;KAC3C;IAED;;;;;;;;;OASG;IACH,KAAY,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC;IAEnD;;;;OAIG;IACH,KAAY,cAAc,CACzB,IAAI,SAAS,MAAM,EACnB,MAAM,SAAS,qBAAqB,CAAC,GAAG,CAAC,EACzC,QAAQ,IACL;QAAE,YAAY,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;KAAE,GAAG,CAAC,CACpD,GAAG,EAAE,IAAI,EACT,eAAe,EAAE,oBAAoB,CAAC,IAAI,EAAE,MAAM,CAAC,KAC/C;QACJ,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;KAC9B,CAAC,CAAC;IAEH;;OAEG;IACH,UAAiB,gBAAgB;QAChC,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,CAAC,gBAAgB,CAAC,OAAO,CAAC,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;KAChE;CACD"}

package/dist/exposedInternalTypes.js

@@ -0,0 +1,19 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InternalTypes = void 0;
+/**
+ * Collection of value types that are not intended to be used/imported
+ * directly outside of this package.
+ *
+ * @alpha
+ * @system
+ */
+// eslint-disable-next-line @typescript-eslint/no-namespace
+var InternalTypes;
+(function (InternalTypes) {
+})(InternalTypes || (exports.InternalTypes = InternalTypes = {}));
+//# sourceMappingURL=exposedInternalTypes.js.map

package/dist/exposedInternalTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exposedInternalTypes.js","sourceRoot":"","sources":["../src/exposedInternalTypes.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAOH;;;;;;GAMG;AACH,2DAA2D;AAC3D,IAAiB,aAAa,CA2G7B;AA3GD,WAAiB,aAAa;AA2G9B,CAAC,EA3GgB,aAAa,6BAAb,aAAa,QA2G7B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type {\n\tJsonDeserialized,\n\tJsonSerializable,\n} from \"@fluidframework/presence/internal/core-interfaces\";\n\n/**\n * Collection of value types that are not intended to be used/imported\n * directly outside of this package.\n *\n * @alpha\n * @system\n */\n// eslint-disable-next-line @typescript-eslint/no-namespace\nexport namespace InternalTypes {\n\t/**\n\t * @system\n\t */\n\texport interface ValueStateMetadata {\n\t\trev: number;\n\t\ttimestamp: number;\n\t}\n\n\t/**\n\t * @system\n\t */\n\texport interface ValueOptionalState<TValue> extends ValueStateMetadata {\n\t\tvalue?: JsonDeserialized<TValue>;\n\t}\n\n\t/**\n\t * @system\n\t */\n\texport interface ValueRequiredState<TValue> extends ValueStateMetadata {\n\t\tvalue: JsonDeserialized<TValue>;\n\t}\n\n\t/**\n\t * @system\n\t */\n\texport interface ValueDirectory<T> {\n\t\trev: number;\n\t\titems: {\n\t\t\t// Caution: any particular item may or may not exist\n\t\t\t// Typescript does not support absent keys without forcing type to also be undefined.\n\t\t\t// See https://github.com/microsoft/TypeScript/issues/42810.\n\t\t\t[name: string | number]: ValueOptionalState<T> | ValueDirectory<T>;\n\t\t};\n\t}\n\n\t/**\n\t * @system\n\t */\n\texport type ValueDirectoryOrState<T> = ValueRequiredState<T> | ValueDirectory<T>;\n\n\t/**\n\t * @system\n\t */\n\texport interface MapValueState<T> {\n\t\trev: number;\n\t\titems: {\n\t\t\t// Caution: any particular item may or may not exist\n\t\t\t// Typescript does not support absent keys without forcing type to also be undefined.\n\t\t\t// See https://github.com/microsoft/TypeScript/issues/42810.\n\t\t\t[name: string | number]: ValueOptionalState<T>;\n\t\t};\n\t}\n\n\t/**\n\t * @system\n\t */\n\texport declare class StateDatastoreHandle<TKey, TValue extends ValueDirectoryOrState<any>> {\n\t\tprivate readonly StateDatastoreHandle: StateDatastoreHandle<TKey, TValue>;\n\t}\n\n\t/**\n\t * Brand to ensure state values internal type safety without revealing\n\t * internals that are subject to change.\n\t *\n\t * @system\n\t */\n\texport declare class StateValueBrand<T> {\n\t\tprivate readonly StateValue: StateValue<T>;\n\t}\n\n\t/**\n\t * This type provides no additional functionality over the type it wraps.\n\t * It is used to ensure type safety within package.\n\t * Users may find it convenient to just use the type it wraps directly.\n\t *\n\t * @privateRemarks\n\t * Checkout filtering omitting unknown from T (`Omit<T,unknown> &`).\n\t *\n\t * @system\n\t */\n\texport type StateValue<T> = T & StateValueBrand<T>;\n\n\t/**\n\t * Package internal function declaration for value manager instantiation.\n\t *\n\t * @system\n\t */\n\texport type ManagerFactory<\n\t\tTKey extends string,\n\t\tTValue extends ValueDirectoryOrState<any>,\n\t\tTManager,\n\t> = { instanceBase: new (...args: any[]) => any } & ((\n\t\tkey: TKey,\n\t\tdatastoreHandle: StateDatastoreHandle<TKey, TValue>,\n\t) => {\n\t\tvalue?: TValue;\n\t\tmanager: StateValue<TManager>;\n\t});\n\n\t/**\n\t * @system\n\t */\n\texport interface NotificationType {\n\t\tname: string;\n\t\targs: (JsonSerializable<unknown> & JsonDeserialized<unknown>)[];\n\t}\n}\n"]}