@fluidframework/presence 2.10.0 → 2.12.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/presence",
-  "version": "2.10.0",
+  "version": "2.12.0",
   "description": "A component for lightweight data sharing within a single session",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -31,10 +31,6 @@
       "import": "./lib/core-interfaces/index.js",
       "require": "./dist/core-interfaces/index.js"
     },
-    "./internal/events": {
-      "import": "./lib/events/events.js",
-      "require": "./dist/events/events.js"
-    },
     "./internal/exposedInternalTypes": {
       "import": "./lib/exposedInternalTypes.js",
       "require": "./dist/exposedInternalTypes.js"
@@ -73,31 +69,31 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluidframework/container-definitions": "~2.10.0",
-    "@fluidframework/container-loader": "~2.10.0",
-    "@fluidframework/container-runtime-definitions": "~2.10.0",
-    "@fluidframework/core-interfaces": "~2.10.0",
-    "@fluidframework/core-utils": "~2.10.0",
-    "@fluidframework/datastore": "~2.10.0",
-    "@fluidframework/datastore-definitions": "~2.10.0",
-    "@fluidframework/fluid-static": "~2.10.0",
-    "@fluidframework/id-compressor": "~2.10.0",
-    "@fluidframework/runtime-definitions": "~2.10.0",
-    "@fluidframework/runtime-utils": "~2.10.0",
-    "@fluidframework/shared-object-base": "~2.10.0",
-    "@fluidframework/telemetry-utils": "~2.10.0"
+    "@fluid-internal/client-utils": "~2.12.0",
+    "@fluidframework/container-definitions": "~2.12.0",
+    "@fluidframework/container-loader": "~2.12.0",
+    "@fluidframework/container-runtime-definitions": "~2.12.0",
+    "@fluidframework/core-interfaces": "~2.12.0",
+    "@fluidframework/core-utils": "~2.12.0",
+    "@fluidframework/datastore": "~2.12.0",
+    "@fluidframework/datastore-definitions": "~2.12.0",
+    "@fluidframework/fluid-static": "~2.12.0",
+    "@fluidframework/id-compressor": "~2.12.0",
+    "@fluidframework/runtime-definitions": "~2.12.0",
+    "@fluidframework/runtime-utils": "~2.12.0",
+    "@fluidframework/shared-object-base": "~2.12.0",
+    "@fluidframework/telemetry-utils": "~2.12.0"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.16.4",
+    "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
     "@fluid-tools/build-cli": "^0.51.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.51.0",
-    "@fluidframework/driver-definitions": "~2.10.0",
-    "@fluidframework/eslint-config-fluid": "^5.4.0",
-    "@fluidframework/presence-previous": "npm:@fluid-experimental/presence@2.5.0",
-    "@fluidframework/test-runtime-utils": "~2.10.0",
-    "@fluidframework/test-utils": "~2.10.0",
+    "@fluidframework/driver-definitions": "~2.12.0",
+    "@fluidframework/eslint-config-fluid": "^5.6.0",
+    "@fluidframework/test-runtime-utils": "~2.12.0",
+    "@fluidframework/test-utils": "~2.12.0",
     "@microsoft/api-extractor": "7.47.8",
     "@types/mocha": "^9.1.1",
     "@types/node": "^18.19.0",
@@ -146,7 +142,7 @@
     "build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
     "build:test:esm": "tsc --project ./src/test/tsconfig.json",
     "build:test:esm:core-interfaces-no-exactOptionalPropertyTypes": "tsc --project ./src/test/core-interfaces/tsconfig.no-exactOptionalPropertyTypes.json",
-    "check:are-the-types-wrong": "echo skip per issue #112 - node10 requirement: attw --pack .",
+    "check:are-the-types-wrong": "attw --pack . --profile node16",
     "check:biome": "biome check .",
     "check:exports": "concurrently \"npm:check:exports:*\"",
     "check:exports:bundle-release-tags": "api-extractor run --config api-extractor/api-extractor-lint-bundle.json",

package/dist/events/events.d.ts

@@ -1,198 +0,0 @@
-/*!
- * 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

@@ -1 +0,0 @@
-{"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

@@ -1,157 +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.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

@@ -1 +0,0 @@
-{"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"]}