@fluidframework/core-interfaces 2.0.0-dev.7.4.0.216897 → 2.0.0-dev.7.4.0.217212

package/dist/core-interfaces-untrimmed.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Types supported by {@link IConfigProviderBase}.
+ * @internal
+ */
+export declare type ConfigTypes = string | number | boolean | number[] | string[] | boolean[] | undefined;
+
 /**
  * Allows an interface to extend interfaces that already extend an {@link IEventProvider}.
  *
@@ -20,7 +26,7 @@
  * ```
  *
  * interface B will now extend interface A and its events
- * @internal
+ * @alpha
  */
 export declare type ExtendEventProvider<TBaseEvent extends IEvent, TBase extends IEventProvider<TBaseEvent>, TEvent extends TBaseEvent> = Omit<Omit<Omit<TBase, "on">, "once">, "off"> & IEventProvider<TBaseEvent> & IEventProvider<TEvent>;
 
@@ -87,7 +93,7 @@ export declare type FluidErrorTypes = (typeof FluidErrorTypes)[keyof typeof Flui
  *
  * You can inspect multiple types via a intersection. For example:
  * `FluidObject<IFoo & IBar>`
- * @internal
+ * @alpha
  */
 export declare type FluidObject<T = unknown> = {
     [P in FluidObjectProviderKeys<T>]?: T[P];
@@ -128,14 +134,40 @@ export declare type FluidObjectKeys<T> = keyof FluidObject<T>;
  *
  * This pattern enables discovery, and delegation in a standard way which is central
  * to FluidObject pattern.
- * @internal
+ * @alpha
  */
 export declare type FluidObjectProviderKeys<T, TProp extends keyof T = keyof T> = string extends TProp ? never : number extends TProp ? never : TProp extends keyof Required<T>[TProp] ? Required<T>[TProp] extends Required<Required<T>[TProp]>[TProp] ? TProp : never : never;
 
 /**
- * Base interface for objects that require lifetime management via explicit disposal.
+ * Base interface for providing configurations to enable/disable/control features.
  * @internal
  */
+export declare interface IConfigProviderBase {
+    /**
+     * For the specified config name this function gets the value.
+     *
+     * This type is meant be easy to implement by Fluid Framework consumers
+     * so the returned valued needs minimal type coercion, and allows consumers to
+     * return values in a natural way from whatever source they retrieve them.
+     *
+     * For instance a value of 1 maybe be returned as a string or a number.
+     * For array types a json string or an object are allowable.
+     *
+     * It should return undefined if there is no value available for the config name.
+     *
+     * @param name - The name of the config to get the value for.
+     *
+     * @privateRemarks Generally, this type should only be taken as input, and be wrapped by an
+     * internal monitoring context from the fluidframework/telemetry-utils package. That will provide
+     * a wrapper with provides strongly typed access to values via consistent type coercion.
+     */
+    getRawConfig(name: string): ConfigTypes;
+}
+
+/**
+ * Base interface for objects that require lifetime management via explicit disposal.
+ * @alpha
+ */
 export declare interface IDisposable {
     /**
      * Whether or not the object has been disposed.
@@ -159,7 +191,8 @@ export declare interface IDisposable {
  * those from container-definitions. Once fully migrated, this will be a base interface for all errors and
  * warnings emitted by the Fluid Framework. Currently only the container layer is using IErrorBase.
  * Runtime and others will follow soon.
- * @internal
+ *
+ * @alpha
  */
 export declare interface IErrorBase extends Partial<Error> {
     /**
@@ -198,7 +231,7 @@ export declare interface IErrorBase extends Partial<Error> {
 
 /**
  * Base interface for error event emitters.
- * @internal
+ * @alpha
  */
 export declare interface IErrorEvent extends IEvent {
     /**
@@ -211,7 +244,7 @@ export declare interface IErrorEvent extends IEvent {
 
 /**
  * Base interface for event emitters.
- * @internal
+ * @alpha
  */
 export declare interface IEvent {
     /**
@@ -229,7 +262,7 @@ export declare interface IEvent {
 
 /**
  * Base interface for event providers.
- * @internal
+ * @alpha
  */
 export declare interface IEventProvider<TEvent extends IEvent> {
     /**
@@ -248,7 +281,7 @@ export declare interface IEventProvider<TEvent extends IEvent> {
 
 /**
  * The placeholder type that should be used instead of `this` in events.
- * @internal
+ * @alpha
  */
 export declare type IEventThisPlaceHolder = {
     thisPlaceHolder: "thisPlaceHolder";
@@ -262,7 +295,7 @@ export declare type IEventThisPlaceHolder = {
  * It currently supports the max of 15 event overloads which is more than we use anywhere.
  * At more than 15 overloads we start to hit {@link https://github.com/microsoft/TypeScript/issues/37209 | TS2589}.
  * If we need to move beyond 15 we should evaluate using a mapped type pattern like `{"event":(listenerArgs)=>void}`
- * @internal
+ * @alpha
  */
 export declare type IEventTransformer<TThis, TEvent extends IEvent> = TEvent extends {
     (event: infer E0, listener: (...args: infer A0) => void): any;
@@ -630,13 +663,13 @@ export declare interface IFluidPackageEnvironment {
 
 /**
  * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
- * @internal
+ * @alpha
  */
 export declare const IFluidRouter: keyof IProvideFluidRouter;
 
 /**
  * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
- * @internal
+ * @alpha
  */
 export declare interface IFluidRouter extends IProvideFluidRouter {
     request(request: IRequest): Promise<IResponse>;
@@ -711,7 +744,7 @@ export declare interface IProvideFluidLoadable {
 /**
  * Request routing
  * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
- * @internal
+ * @alpha
  */
 export declare interface IProvideFluidRouter {
     readonly IFluidRouter: IFluidRouter;
@@ -725,7 +758,7 @@ export declare interface IProvideFluidRunnable {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IRequest {
     url: string;
@@ -733,14 +766,14 @@ export declare interface IRequest {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IRequestHeader {
     [index: string]: any;
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IResponse {
     mimeType: string;
@@ -786,7 +819,7 @@ export declare interface ITaggedTelemetryPropertyType {
  * Can contain any number of properties that get serialized as json payload.
  * @param category - category of the event, like "error", "performance", "generic", etc.
  * @param eventName - name of the event.
- * @internal
+ * @alpha
  */
 export declare interface ITelemetryBaseEvent extends ITelemetryBaseProperties {
     category: string;
@@ -796,7 +829,7 @@ export declare interface ITelemetryBaseEvent extends ITelemetryBaseProperties {
 /**
  * Interface to output telemetry events.
  * Implemented by hosting app / loader
- * @internal
+ * @alpha
  */
 export declare interface ITelemetryBaseLogger {
     send(event: ITelemetryBaseEvent, logLevel?: LogLevel): void;
@@ -805,7 +838,7 @@ export declare interface ITelemetryBaseLogger {
 
 /**
  * JSON-serializable properties, which will be logged with telemetry.
- * @internal
+ * @alpha
  */
 export declare type ITelemetryBaseProperties = ITelemetryProperties;
 
@@ -889,7 +922,7 @@ export declare interface ITelemetryPerformanceEvent extends ITelemetryGenericEve
  * {@inheritDoc ITelemetryBaseProperties}
  *
  * @deprecated Renamed to {@link ITelemetryBaseProperties}
- * @internal
+ * @alpha
  */
 export declare interface ITelemetryProperties {
     [index: string]: TelemetryEventPropertyType | Tagged<TelemetryEventPropertyType>;
@@ -920,7 +953,7 @@ export declare interface IUsageError extends IErrorBase {
 
 /**
  * Specify levels of the logs.
- * @internal
+ * @alpha
  */
 export declare const LogLevel: {
     readonly verbose: 10;
@@ -930,13 +963,13 @@ export declare const LogLevel: {
 
 /**
  * Specify a level to the log to filter out logs based on the level.
- * @internal
+ * @alpha
  */
 export declare type LogLevel = (typeof LogLevel)[keyof typeof LogLevel];
 
 /**
  * Does the type replacement by changing types of {@link IEventThisPlaceHolder} to `TThis`
- * @internal
+ * @alpha
  */
 export declare type ReplaceIEventThisPlaceHolder<L extends any[], TThis> = L extends any[] ? {
     [K in keyof L]: L[K] extends IEventThisPlaceHolder ? TThis : L[K];
@@ -948,7 +981,7 @@ export declare type ReplaceIEventThisPlaceHolder<L extends any[], TThis> = L ext
  *
  * This indicates that the value should be organized or handled differently by loggers in various first or third
  * party scenarios. For example, tags are used to mark data that should not be stored in logs for privacy reasons.
- * @internal
+ * @alpha
  */
 export declare interface Tagged<V, T extends string = string> {
     value: V;
@@ -977,14 +1010,14 @@ export declare type TelemetryEventCategory = "generic" | "error" | "performance"
  * {@inheritDoc TelemetryBaseEventPropertyType}
  *
  * @deprecated Renamed to {@link TelemetryBaseEventPropertyType}
- * @internal
+ * @alpha
  */
 export declare type TelemetryEventPropertyType = string | number | boolean | undefined;
 
 /**
  * Transforms the event overload by replacing {@link IEventThisPlaceHolder} with `TThis` in the event listener
  * arguments and having the overload return `TTHis` as well
- * @internal
+ * @alpha
  */
 export declare type TransformedEvent<TThis, E, A extends any[]> = (event: E, listener: (...args: ReplaceIEventThisPlaceHolder<A, TThis>) => void) => TThis;
 

package/dist/disposable.d.ts

@@ -4,7 +4,7 @@
  */
 /**
  * Base interface for objects that require lifetime management via explicit disposal.
- * @internal
+ * @alpha
  */
 export interface IDisposable {
     /**

package/dist/disposable.js.map

@@ -1 +1 @@
-{"version":3,"file":"disposable.js","sourceRoot":"","sources":["../src/disposable.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Base interface for objects that require lifetime management via explicit disposal.\n * @internal\n */\nexport interface IDisposable {\n\t/**\n\t * Whether or not the object has been disposed.\n\t * If true, the object should be considered invalid, and its other state should be disregarded.\n\t */\n\treadonly disposed: boolean;\n\n\t/**\n\t * Dispose of the object and its resources.\n\t * @param error - Optional error indicating the reason for the disposal, if the object was\n\t * disposed as the result of an error.\n\t */\n\tdispose(error?: Error): void;\n}\n"]}
+{"version":3,"file":"disposable.js","sourceRoot":"","sources":["../src/disposable.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Base interface for objects that require lifetime management via explicit disposal.\n * @alpha\n */\nexport interface IDisposable {\n\t/**\n\t * Whether or not the object has been disposed.\n\t * If true, the object should be considered invalid, and its other state should be disregarded.\n\t */\n\treadonly disposed: boolean;\n\n\t/**\n\t * Dispose of the object and its resources.\n\t * @param error - Optional error indicating the reason for the disposal, if the object was\n\t * disposed as the result of an error.\n\t */\n\tdispose(error?: Error): void;\n}\n"]}

package/dist/error.d.ts

@@ -42,7 +42,8 @@ export type FluidErrorTypes = (typeof FluidErrorTypes)[keyof typeof FluidErrorTy
  * those from container-definitions. Once fully migrated, this will be a base interface for all errors and
  * warnings emitted by the Fluid Framework. Currently only the container layer is using IErrorBase.
  * Runtime and others will follow soon.
- * @internal
+ *
+ * @alpha
  */
 export interface IErrorBase extends Partial<Error> {
     /**

package/dist/error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAC;AAEnD;;;GAGG;AACH,eAAO,MAAM,eAAe;IAC3B;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;CAEM,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,OAAO,eAAe,CAAC,CAAC;AAErF;;;;;;;;;;GAUG;AACH,MAAM,WAAW,UAAW,SAAQ,OAAO,CAAC,KAAK,CAAC;IACjD;;;;;;;OAOG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,sBAAsB,CAAC,IAAI,wBAAwB,CAAC;CACpD;AAED;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,UAAU;IAChD;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,OAAO,eAAe,CAAC,YAAY,CAAC;IAIxD,KAAK,CAAC,EAAE,GAAG,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC9C;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,OAAO,eAAe,CAAC,UAAU,CAAC;CACtD;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACrD;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,OAAO,eAAe,CAAC,eAAe,CAAC;IAC3D,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;CACnC"}
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAC;AAEnD;;;GAGG;AACH,eAAO,MAAM,eAAe;IAC3B;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;CAEM,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,OAAO,eAAe,CAAC,CAAC;AAErF;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,UAAW,SAAQ,OAAO,CAAC,KAAK,CAAC;IACjD;;;;;;;OAOG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,sBAAsB,CAAC,IAAI,wBAAwB,CAAC;CACpD;AAED;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,UAAU;IAChD;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,OAAO,eAAe,CAAC,YAAY,CAAC;IAIxD,KAAK,CAAC,EAAE,GAAG,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC9C;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,OAAO,eAAe,CAAC,UAAU,CAAC;CACtD;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACrD;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,OAAO,eAAe,CAAC,eAAe,CAAC;IAC3D,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;CACnC"}

package/dist/error.js.map

@@ -1 +1 @@
-{"version":3,"file":"error.js","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;;GAGG;AACU,QAAA,eAAe,GAAG;IAC9B;;OAEG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,eAAe,EAAE,iBAAiB;IAElC;;OAEG;IACH,mBAAmB,EAAE,qBAAqB;IAE1C;;OAEG;IACH,mBAAmB,EAAE,qBAAqB;IAE1C;;OAEG;IACH,UAAU,EAAE,YAAY;CACf,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryBaseProperties } from \"./index\";\n\n/**\n * Error types the Fluid Framework may report.\n * @internal\n */\nexport const FluidErrorTypes = {\n\t/**\n\t * Some error, most likely an exception caught by runtime and propagated to container as critical error\n\t */\n\tgenericError: \"genericError\",\n\n\t/**\n\t * Throttling error from server. Server is busy and is asking not to reconnect for some time\n\t */\n\tthrottlingError: \"throttlingError\",\n\n\t/**\n\t * Data loss error detected by Container / DeltaManager. Likely points to storage issue.\n\t */\n\tdataCorruptionError: \"dataCorruptionError\",\n\n\t/**\n\t * Error encountered when processing an operation. May correlate with data corruption.\n\t */\n\tdataProcessingError: \"dataProcessingError\",\n\n\t/**\n\t * Error indicating an API is being used improperly resulting in an invalid operation.\n\t */\n\tusageError: \"usageError\",\n} as const;\n/**\n * @internal\n */\nexport type FluidErrorTypes = (typeof FluidErrorTypes)[keyof typeof FluidErrorTypes];\n\n/**\n * Base interface for all errors and warnings emitted the container.\n *\n * @remarks\n *\n * We are in the process of unifying error types across layers of the Framework. For now we have only migrated\n * those from container-definitions. Once fully migrated, this will be a base interface for all errors and\n * warnings emitted by the Fluid Framework. Currently only the container layer is using IErrorBase.\n * Runtime and others will follow soon.\n * @internal\n */\nexport interface IErrorBase extends Partial<Error> {\n\t/**\n\t * A type tag differentiating kinds of errors emitted by the container.\n\t *\n\t * @see See {@link FluidErrorTypes#genericError} for some common examples.\n\t * - container\n\t * - runtime\n\t * - drivers\n\t */\n\treadonly errorType: string;\n\n\t/**\n\t * See {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error | Error.message}\n\t *\n\t * @remarks\n\t *\n\t * Privacy Note - This is a freeform string that we may not control in all cases (e.g. a dependency throws an error)\n\t * If there are known cases where this contains privacy-sensitive data it will be tagged and included in the result\n\t * of getTelemetryProperties. When logging, consider fetching it that way rather than straight from this field.\n\t */\n\treadonly message: string;\n\n\t/**\n\t * See {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/name | Error.name}\n\t */\n\treadonly name?: string;\n\n\t/**\n\t * See {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/stack | Error.stack}\n\t */\n\treadonly stack?: string;\n\n\t/**\n\t * Returns all properties of this error object that are fit for logging.\n\t * Some may be tagged to indicate they contain some kind of sensitive data.\n\t */\n\tgetTelemetryProperties?(): ITelemetryBaseProperties;\n}\n\n/**\n * Generic wrapper for an unrecognized/uncategorized error object\n * @internal\n */\nexport interface IGenericError extends IErrorBase {\n\t/**\n\t * {@inheritDoc IErrorBase.errorType}\n\t */\n\treadonly errorType: typeof FluidErrorTypes.genericError;\n\n\t// TODO: Use `unknown` instead (API-Breaking)\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\terror?: any;\n}\n\n/**\n * Error indicating an API is being used improperly resulting in an invalid operation.\n * @internal\n */\nexport interface IUsageError extends IErrorBase {\n\t/**\n\t * {@inheritDoc IErrorBase.errorType}\n\t */\n\treadonly errorType: typeof FluidErrorTypes.usageError;\n}\n\n/**\n * Warning emitted when requests to storage are being throttled\n * @internal\n */\nexport interface IThrottlingWarning extends IErrorBase {\n\t/**\n\t * {@inheritDoc IErrorBase.errorType}\n\t */\n\treadonly errorType: typeof FluidErrorTypes.throttlingError;\n\treadonly retryAfterSeconds: number;\n}\n"]}
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;;GAGG;AACU,QAAA,eAAe,GAAG;IAC9B;;OAEG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,eAAe,EAAE,iBAAiB;IAElC;;OAEG;IACH,mBAAmB,EAAE,qBAAqB;IAE1C;;OAEG;IACH,mBAAmB,EAAE,qBAAqB;IAE1C;;OAEG;IACH,UAAU,EAAE,YAAY;CACf,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryBaseProperties } from \"./index\";\n\n/**\n * Error types the Fluid Framework may report.\n * @internal\n */\nexport const FluidErrorTypes = {\n\t/**\n\t * Some error, most likely an exception caught by runtime and propagated to container as critical error\n\t */\n\tgenericError: \"genericError\",\n\n\t/**\n\t * Throttling error from server. Server is busy and is asking not to reconnect for some time\n\t */\n\tthrottlingError: \"throttlingError\",\n\n\t/**\n\t * Data loss error detected by Container / DeltaManager. Likely points to storage issue.\n\t */\n\tdataCorruptionError: \"dataCorruptionError\",\n\n\t/**\n\t * Error encountered when processing an operation. May correlate with data corruption.\n\t */\n\tdataProcessingError: \"dataProcessingError\",\n\n\t/**\n\t * Error indicating an API is being used improperly resulting in an invalid operation.\n\t */\n\tusageError: \"usageError\",\n} as const;\n/**\n * @internal\n */\nexport type FluidErrorTypes = (typeof FluidErrorTypes)[keyof typeof FluidErrorTypes];\n\n/**\n * Base interface for all errors and warnings emitted the container.\n *\n * @remarks\n *\n * We are in the process of unifying error types across layers of the Framework. For now we have only migrated\n * those from container-definitions. Once fully migrated, this will be a base interface for all errors and\n * warnings emitted by the Fluid Framework. Currently only the container layer is using IErrorBase.\n * Runtime and others will follow soon.\n *\n * @alpha\n */\nexport interface IErrorBase extends Partial<Error> {\n\t/**\n\t * A type tag differentiating kinds of errors emitted by the container.\n\t *\n\t * @see See {@link FluidErrorTypes#genericError} for some common examples.\n\t * - container\n\t * - runtime\n\t * - drivers\n\t */\n\treadonly errorType: string;\n\n\t/**\n\t * See {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error | Error.message}\n\t *\n\t * @remarks\n\t *\n\t * Privacy Note - This is a freeform string that we may not control in all cases (e.g. a dependency throws an error)\n\t * If there are known cases where this contains privacy-sensitive data it will be tagged and included in the result\n\t * of getTelemetryProperties. When logging, consider fetching it that way rather than straight from this field.\n\t */\n\treadonly message: string;\n\n\t/**\n\t * See {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/name | Error.name}\n\t */\n\treadonly name?: string;\n\n\t/**\n\t * See {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/stack | Error.stack}\n\t */\n\treadonly stack?: string;\n\n\t/**\n\t * Returns all properties of this error object that are fit for logging.\n\t * Some may be tagged to indicate they contain some kind of sensitive data.\n\t */\n\tgetTelemetryProperties?(): ITelemetryBaseProperties;\n}\n\n/**\n * Generic wrapper for an unrecognized/uncategorized error object\n * @internal\n */\nexport interface IGenericError extends IErrorBase {\n\t/**\n\t * {@inheritDoc IErrorBase.errorType}\n\t */\n\treadonly errorType: typeof FluidErrorTypes.genericError;\n\n\t// TODO: Use `unknown` instead (API-Breaking)\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\terror?: any;\n}\n\n/**\n * Error indicating an API is being used improperly resulting in an invalid operation.\n * @internal\n */\nexport interface IUsageError extends IErrorBase {\n\t/**\n\t * {@inheritDoc IErrorBase.errorType}\n\t */\n\treadonly errorType: typeof FluidErrorTypes.usageError;\n}\n\n/**\n * Warning emitted when requests to storage are being throttled\n * @internal\n */\nexport interface IThrottlingWarning extends IErrorBase {\n\t/**\n\t * {@inheritDoc IErrorBase.errorType}\n\t */\n\treadonly errorType: typeof FluidErrorTypes.throttlingError;\n\treadonly retryAfterSeconds: number;\n}\n"]}

package/dist/events.d.ts

@@ -4,7 +4,7 @@
  */
 /**
  * Base interface for event emitters.
- * @internal
+ * @alpha
  */
 export interface IEvent {
     /**
@@ -21,7 +21,7 @@ export interface IEvent {
 }
 /**
  * Base interface for error event emitters.
- * @internal
+ * @alpha
  */
 export interface IErrorEvent extends IEvent {
     /**
@@ -33,7 +33,7 @@ export interface IErrorEvent extends IEvent {
 }
 /**
  * Base interface for event providers.
- * @internal
+ * @alpha
  */
 export interface IEventProvider<TEvent extends IEvent> {
     /**
@@ -71,19 +71,19 @@ export interface IEventProvider<TEvent extends IEvent> {
  * ```
  *
  * interface B will now extend interface A and its events
- * @internal
+ * @alpha
  */
 export type ExtendEventProvider<TBaseEvent extends IEvent, TBase extends IEventProvider<TBaseEvent>, TEvent extends TBaseEvent> = Omit<Omit<Omit<TBase, "on">, "once">, "off"> & IEventProvider<TBaseEvent> & IEventProvider<TEvent>;
 /**
  * The placeholder type that should be used instead of `this` in events.
- * @internal
+ * @alpha
  */
 export type IEventThisPlaceHolder = {
     thisPlaceHolder: "thisPlaceHolder";
 };
 /**
  * Does the type replacement by changing types of {@link IEventThisPlaceHolder} to `TThis`
- * @internal
+ * @alpha
  */
 export type ReplaceIEventThisPlaceHolder<L extends any[], TThis> = L extends any[] ? {
     [K in keyof L]: L[K] extends IEventThisPlaceHolder ? TThis : L[K];
@@ -91,7 +91,7 @@ export type ReplaceIEventThisPlaceHolder<L extends any[], TThis> = L extends any
 /**
  * Transforms the event overload by replacing {@link IEventThisPlaceHolder} with `TThis` in the event listener
  * arguments and having the overload return `TTHis` as well
- * @internal
+ * @alpha
  */
 export type TransformedEvent<TThis, E, A extends any[]> = (event: E, listener: (...args: ReplaceIEventThisPlaceHolder<A, TThis>) => void) => TThis;
 /**
@@ -102,7 +102,7 @@ export type TransformedEvent<TThis, E, A extends any[]> = (event: E, listener: (
  * It currently supports the max of 15 event overloads which is more than we use anywhere.
  * At more than 15 overloads we start to hit {@link https://github.com/microsoft/TypeScript/issues/37209 | TS2589}.
  * If we need to move beyond 15 we should evaluate using a mapped type pattern like `{"event":(listenerArgs)=>void}`
- * @internal
+ * @alpha
  */
 export type IEventTransformer<TThis, TEvent extends IEvent> = TEvent extends {
     (event: infer E0, listener: (...args: infer A0) => void): any;

package/dist/events.js.map

@@ -1 +1 @@
-{"version":3,"file":"events.js","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Base interface for event emitters.\n * @internal\n */\nexport interface IEvent {\n\t/**\n\t * Base event emitter signature.\n\t *\n\t * @remarks The event emitter polyfill and the node event emitter have different event types:\n\t * `string | symbol` vs. `string | number`.\n\t *\n\t * So for our typing we'll contrain to string, that way we work with both.\n\t *\n\t * @eventProperty\n\t */\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t(event: string, listener: (...args: any[]) => void);\n}\n\n/**\n * Base interface for error event emitters.\n * @internal\n */\nexport interface IErrorEvent extends IEvent {\n\t/**\n\t * Base error event emitter signature.\n\t *\n\t * @eventProperty\n\t */\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t(event: \"error\", listener: (message: any) => void);\n}\n\n/**\n * Base interface for event providers.\n * @internal\n */\nexport interface IEventProvider<TEvent extends IEvent> {\n\t/**\n\t * Registers a callback to be invoked when the corresponding event is triggered.\n\t */\n\treadonly on: IEventTransformer<this, TEvent>;\n\n\t/**\n\t * Registers a callback to be invoked the first time (after registration) the corresponding event is triggered.\n\t */\n\treadonly once: IEventTransformer<this, TEvent>;\n\n\t/**\n\t * Removes the corresponding event if it has been registered.\n\t */\n\treadonly off: IEventTransformer<this, TEvent>;\n}\n\n/**\n * Allows an interface to extend interfaces that already extend an {@link IEventProvider}.\n *\n * @example\n *\n * ``` typescript\n * interface AEvents extends IEvent{\n *  (event: \"a-event\",listener: (a: number)=>void);\n * }\n * interface A extends IEventProvider<AEvents>{\n *  a: object;\n * }\n *\n * interface BEvents extends IEvent{\n *  (event: \"b-event\",listener: (b: string)=>void);\n * }\n * interface B extends ExtendEventProvider<AEvents, A, BEvents>{\n *  b: boolean;\n * };\n * ```\n *\n * interface B will now extend interface A and its events\n * @internal\n */\nexport type ExtendEventProvider<\n\tTBaseEvent extends IEvent,\n\tTBase extends IEventProvider<TBaseEvent>,\n\tTEvent extends TBaseEvent,\n> = Omit<Omit<Omit<TBase, \"on\">, \"once\">, \"off\"> &\n\tIEventProvider<TBaseEvent> &\n\tIEventProvider<TEvent>;\n\n// These types handle replacing IEventThisPlaceHolder with `this`, so we can\n// support polymorphic `this`. For instance if an event wanted to be:\n// (event: \"some-event\", listener:(target: this)=>void)\n//\n// it should be written as\n// (event: \"some-event\", listener:(target: IEventThisPlaceHolder)=>void)\n//\n// and IEventThisPlaceHolder will be replaced with this.\n// This is all consumers of these types need to know.\n\n/**\n * The placeholder type that should be used instead of `this` in events.\n * @internal\n */\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\nexport type IEventThisPlaceHolder = { thisPlaceHolder: \"thisPlaceHolder\" };\n\n/**\n * Does the type replacement by changing types of {@link IEventThisPlaceHolder} to `TThis`\n * @internal\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type ReplaceIEventThisPlaceHolder<L extends any[], TThis> = L extends any[]\n\t? { [K in keyof L]: L[K] extends IEventThisPlaceHolder ? TThis : L[K] }\n\t: L;\n\n/**\n * Transforms the event overload by replacing {@link IEventThisPlaceHolder} with `TThis` in the event listener\n * arguments and having the overload return `TTHis` as well\n * @internal\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type TransformedEvent<TThis, E, A extends any[]> = (\n\tevent: E,\n\tlistener: (...args: ReplaceIEventThisPlaceHolder<A, TThis>) => void,\n) => TThis;\n\n/**\n * This type is a conditional type for transforming all the overloads provided in `TEvent`.\n *\n * @remarks\n * Due to limitations of the TypeScript typing system, we need to handle each number of overload individually.\n * It currently supports the max of 15 event overloads which is more than we use anywhere.\n * At more than 15 overloads we start to hit {@link https://github.com/microsoft/TypeScript/issues/37209 | TS2589}.\n * If we need to move beyond 15 we should evaluate using a mapped type pattern like `{\"event\":(listenerArgs)=>void}`\n * @internal\n */\nexport type IEventTransformer<TThis, TEvent extends IEvent> = TEvent extends {\n\t(event: infer E0, listener: (...args: infer A0) => void);\n\t(event: infer E1, listener: (...args: infer A1) => void);\n\t(event: infer E2, listener: (...args: infer A2) => void);\n\t(event: infer E3, listener: (...args: infer A3) => void);\n\t(event: infer E4, listener: (...args: infer A4) => void);\n\t(event: infer E5, listener: (...args: infer A5) => void);\n\t(event: infer E6, listener: (...args: infer A6) => void);\n\t(event: infer E7, listener: (...args: infer A7) => void);\n\t(event: infer E8, listener: (...args: infer A8) => void);\n\t(event: infer E9, listener: (...args: infer A9) => void);\n\t(event: infer E10, listener: (...args: infer A10) => void);\n\t(event: infer E11, listener: (...args: infer A11) => void);\n\t(event: infer E12, listener: (...args: infer A12) => void);\n\t(event: infer E13, listener: (...args: infer A13) => void);\n\t(event: infer E14, listener: (...args: infer A14) => void);\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t(event: string, listener: (...args: any[]) => void);\n}\n\t? TransformedEvent<TThis, E0, A0> &\n\t\t\tTransformedEvent<TThis, E1, A1> &\n\t\t\tTransformedEvent<TThis, E2, A2> &\n\t\t\tTransformedEvent<TThis, E3, A3> &\n\t\t\tTransformedEvent<TThis, E4, A4> &\n\t\t\tTransformedEvent<TThis, E5, A5> &\n\t\t\tTransformedEvent<TThis, E6, A6> &\n\t\t\tTransformedEvent<TThis, E7, A7> &\n\t\t\tTransformedEvent<TThis, E8, A8> &\n\t\t\tTransformedEvent<TThis, E9, A9> &\n\t\t\tTransformedEvent<TThis, E10, A10> &\n\t\t\tTransformedEvent<TThis, E11, A11> &\n\t\t\tTransformedEvent<TThis, E12, A12> &\n\t\t\tTransformedEvent<TThis, E13, A13> &\n\t\t\tTransformedEvent<TThis, E14, A14>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t(event: infer E1, listener: (...args: infer A1) => void);\n\t\t\t(event: infer E2, listener: (...args: infer A2) => void);\n\t\t\t(event: infer E3, listener: (...args: infer A3) => void);\n\t\t\t(event: infer E4, listener: (...args: infer A4) => void);\n\t\t\t(event: infer E5, listener: (...args: infer A5) => void);\n\t\t\t(event: infer E6, listener: (...args: infer A6) => void);\n\t\t\t(event: infer E7, listener: (...args: infer A7) => void);\n\t\t\t(event: infer E8, listener: (...args: infer A8) => void);\n\t\t\t(event: infer E9, listener: (...args: infer A9) => void);\n\t\t\t(event: infer E10, listener: (...args: infer A10) => void);\n\t\t\t(event: infer E11, listener: (...args: infer A11) => void);\n\t\t\t(event: infer E12, listener: (...args: infer A12) => void);\n\t\t\t(event: infer E13, listener: (...args: infer A13) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0> &\n\t\t\tTransformedEvent<TThis, E1, A1> &\n\t\t\tTransformedEvent<TThis, E2, A2> &\n\t\t\tTransformedEvent<TThis, E3, A3> &\n\t\t\tTransformedEvent<TThis, E4, A4> &\n\t\t\tTransformedEvent<TThis, E5, A5> &\n\t\t\tTransformedEvent<TThis, E6, A6> &\n\t\t\tTransformedEvent<TThis, E7, A7> &\n\t\t\tTransformedEvent<TThis, E8, A8> &\n\t\t\tTransformedEvent<TThis, E9, A9> &\n\t\t\tTransformedEvent<TThis, E10, A10> &\n\t\t\tTransformedEvent<TThis, E11, A11> &\n\t\t\tTransformedEvent<TThis, E12, A12> &\n\t\t\tTransformedEvent<TThis, E13, A13>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t(event: infer E1, listener: (...args: infer A1) => void);\n\t\t\t(event: infer E2, listener: (...args: infer A2) => void);\n\t\t\t(event: infer E3, listener: (...args: infer A3) => void);\n\t\t\t(event: infer E4, listener: (...args: infer A4) => void);\n\t\t\t(event: infer E5, listener: (...args: infer A5) => void);\n\t\t\t(event: infer E6, listener: (...args: infer A6) => void);\n\t\t\t(event: infer E7, listener: (...args: infer A7) => void);\n\t\t\t(event: infer E8, listener: (...args: infer A8) => void);\n\t\t\t(event: infer E9, listener: (...args: infer A9) => void);\n\t\t\t(event: infer E10, listener: (...args: infer A10) => void);\n\t\t\t(event: infer E11, listener: (...args: infer A11) => void);\n\t\t\t(event: infer E12, listener: (...args: infer A12) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0> &\n\t\t\tTransformedEvent<TThis, E1, A1> &\n\t\t\tTransformedEvent<TThis, E2, A2> &\n\t\t\tTransformedEvent<TThis, E3, A3> &\n\t\t\tTransformedEvent<TThis, E4, A4> &\n\t\t\tTransformedEvent<TThis, E5, A5> &\n\t\t\tTransformedEvent<TThis, E6, A6> &\n\t\t\tTransformedEvent<TThis, E7, A7> &\n\t\t\tTransformedEvent<TThis, E8, A8> &\n\t\t\tTransformedEvent<TThis, E9, A9> &\n\t\t\tTransformedEvent<TThis, E10, A10> &\n\t\t\tTransformedEvent<TThis, E11, A11> &\n\t\t\tTransformedEvent<TThis, E12, A12>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t(event: infer E1, listener: (...args: infer A1) => void);\n\t\t\t(event: infer E2, listener: (...args: infer A2) => void);\n\t\t\t(event: infer E3, listener: (...args: infer A3) => void);\n\t\t\t(event: infer E4, listener: (...args: infer A4) => void);\n\t\t\t(event: infer E5, listener: (...args: infer A5) => void);\n\t\t\t(event: infer E6, listener: (...args: infer A6) => void);\n\t\t\t(event: infer E7, listener: (...args: infer A7) => void);\n\t\t\t(event: infer E8, listener: (...args: infer A8) => void);\n\t\t\t(event: infer E9, listener: (...args: infer A9) => void);\n\t\t\t(event: infer E10, listener: (...args: infer A10) => void);\n\t\t\t(event: infer E11, listener: (...args: infer A11) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0> &\n\t\t\tTransformedEvent<TThis, E1, A1> &\n\t\t\tTransformedEvent<TThis, E2, A2> &\n\t\t\tTransformedEvent<TThis, E3, A3> &\n\t\t\tTransformedEvent<TThis, E4, A4> &\n\t\t\tTransformedEvent<TThis, E5, A5> &\n\t\t\tTransformedEvent<TThis, E6, A6> &\n\t\t\tTransformedEvent<TThis, E7, A7> &\n\t\t\tTransformedEvent<TThis, E8, A8> &\n\t\t\tTransformedEvent<TThis, E9, A9> &\n\t\t\tTransformedEvent<TThis, E10, A10> &\n\t\t\tTransformedEvent<TThis, E11, A11>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t(event: infer E1, listener: (...args: infer A1) => void);\n\t\t\t(event: infer E2, listener: (...args: infer A2) => void);\n\t\t\t(event: infer E3, listener: (...args: infer A3) => void);\n\t\t\t(event: infer E4, listener: (...args: infer A4) => void);\n\t\t\t(event: infer E5, listener: (...args: infer A5) => void);\n\t\t\t(event: infer E6, listener: (...args: infer A6) => void);\n\t\t\t(event: infer E7, listener: (...args: infer A7) => void);\n\t\t\t(event: infer E8, listener: (...args: infer A8) => void);\n\t\t\t(event: infer E9, listener: (...args: infer A9) => void);\n\t\t\t(event: infer E10, listener: (...args: infer A10) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0> &\n\t\t\tTransformedEvent<TThis, E1, A1> &\n\t\t\tTransformedEvent<TThis, E2, A2> &\n\t\t\tTransformedEvent<TThis, E3, A3> &\n\t\t\tTransformedEvent<TThis, E4, A4> &\n\t\t\tTransformedEvent<TThis, E5, A5> &\n\t\t\tTransformedEvent<TThis, E6, A6> &\n\t\t\tTransformedEvent<TThis, E7, A7> &\n\t\t\tTransformedEvent<TThis, E8, A8> &\n\t\t\tTransformedEvent<TThis, E9, A9> &\n\t\t\tTransformedEvent<TThis, E10, A10>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t(event: infer E1, listener: (...args: infer A1) => void);\n\t\t\t(event: infer E2, listener: (...args: infer A2) => void);\n\t\t\t(event: infer E3, listener: (...args: infer A3) => void);\n\t\t\t(event: infer E4, listener: (...args: infer A4) => void);\n\t\t\t(event: infer E5, listener: (...args: infer A5) => void);\n\t\t\t(event: infer E6, listener: (...args: infer A6) => void);\n\t\t\t(event: infer E7, listener: (...args: infer A7) => void);\n\t\t\t(event: infer E8, listener: (...args: infer A8) => void);\n\t\t\t(event: infer E9, listener: (...args: infer A9) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0> &\n\t\t\tTransformedEvent<TThis, E1, A1> &\n\t\t\tTransformedEvent<TThis, E2, A2> &\n\t\t\tTransformedEvent<TThis, E3, A3> &\n\t\t\tTransformedEvent<TThis, E4, A4> &\n\t\t\tTransformedEvent<TThis, E5, A5> &\n\t\t\tTransformedEvent<TThis, E6, A6> &\n\t\t\tTransformedEvent<TThis, E7, A7> &\n\t\t\tTransformedEvent<TThis, E8, A8> &\n\t\t\tTransformedEvent<TThis, E9, A9>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t(event: infer E1, listener: (...args: infer A1) => void);\n\t\t\t(event: infer E2, listener: (...args: infer A2) => void);\n\t\t\t(event: infer E3, listener: (...args: infer A3) => void);\n\t\t\t(event: infer E4, listener: (...args: infer A4) => void);\n\t\t\t(event: infer E5, listener: (...args: infer A5) => void);\n\t\t\t(event: infer E6, listener: (...args: infer A6) => void);\n\t\t\t(event: infer E7, listener: (...args: infer A7) => void);\n\t\t\t(event: infer E8, listener: (...args: infer A8) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0> &\n\t\t\tTransformedEvent<TThis, E1, A1> &\n\t\t\tTransformedEvent<TThis, E2, A2> &\n\t\t\tTransformedEvent<TThis, E3, A3> &\n\t\t\tTransformedEvent<TThis, E4, A4> &\n\t\t\tTransformedEvent<TThis, E5, A5> &\n\t\t\tTransformedEvent<TThis, E6, A6> &\n\t\t\tTransformedEvent<TThis, E7, A7> &\n\t\t\tTransformedEvent<TThis, E8, A8>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t(event: infer E1, listener: (...args: infer A1) => void);\n\t\t\t(event: infer E2, listener: (...args: infer A2) => void);\n\t\t\t(event: infer E3, listener: (...args: infer A3) => void);\n\t\t\t(event: infer E4, listener: (...args: infer A4) => void);\n\t\t\t(event: infer E5, listener: (...args: infer A5) => void);\n\t\t\t(event: infer E6, listener: (...args: infer A6) => void);\n\t\t\t(event: infer E7, listener: (...args: infer A7) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0> &\n\t\t\tTransformedEvent<TThis, E1, A1> &\n\t\t\tTransformedEvent<TThis, E2, A2> &\n\t\t\tTransformedEvent<TThis, E3, A3> &\n\t\t\tTransformedEvent<TThis, E4, A4> &\n\t\t\tTransformedEvent<TThis, E5, A5> &\n\t\t\tTransformedEvent<TThis, E6, A6> &\n\t\t\tTransformedEvent<TThis, E7, A7>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t(event: infer E1, listener: (...args: infer A1) => void);\n\t\t\t(event: infer E2, listener: (...args: infer A2) => void);\n\t\t\t(event: infer E3, listener: (...args: infer A3) => void);\n\t\t\t(event: infer E4, listener: (...args: infer A4) => void);\n\t\t\t(event: infer E5, listener: (...args: infer A5) => void);\n\t\t\t(event: infer E6, listener: (...args: infer A6) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0> &\n\t\t\tTransformedEvent<TThis, E1, A1> &\n\t\t\tTransformedEvent<TThis, E2, A2> &\n\t\t\tTransformedEvent<TThis, E3, A3> &\n\t\t\tTransformedEvent<TThis, E4, A4> &\n\t\t\tTransformedEvent<TThis, E5, A5> &\n\t\t\tTransformedEvent<TThis, E6, A6>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t(event: infer E1, listener: (...args: infer A1) => void);\n\t\t\t(event: infer E2, listener: (...args: infer A2) => void);\n\t\t\t(event: infer E3, listener: (...args: infer A3) => void);\n\t\t\t(event: infer E4, listener: (...args: infer A4) => void);\n\t\t\t(event: infer E5, listener: (...args: infer A5) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0> &\n\t\t\tTransformedEvent<TThis, E1, A1> &\n\t\t\tTransformedEvent<TThis, E2, A2> &\n\t\t\tTransformedEvent<TThis, E3, A3> &\n\t\t\tTransformedEvent<TThis, E4, A4> &\n\t\t\tTransformedEvent<TThis, E5, A5>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t(event: infer E1, listener: (...args: infer A1) => void);\n\t\t\t(event: infer E2, listener: (...args: infer A2) => void);\n\t\t\t(event: infer E3, listener: (...args: infer A3) => void);\n\t\t\t(event: infer E4, listener: (...args: infer A4) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0> &\n\t\t\tTransformedEvent<TThis, E1, A1> &\n\t\t\tTransformedEvent<TThis, E2, A2> &\n\t\t\tTransformedEvent<TThis, E3, A3> &\n\t\t\tTransformedEvent<TThis, E4, A4>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t(event: infer E1, listener: (...args: infer A1) => void);\n\t\t\t(event: infer E2, listener: (...args: infer A2) => void);\n\t\t\t(event: infer E3, listener: (...args: infer A3) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0> &\n\t\t\tTransformedEvent<TThis, E1, A1> &\n\t\t\tTransformedEvent<TThis, E2, A2> &\n\t\t\tTransformedEvent<TThis, E3, A3>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t(event: infer E1, listener: (...args: infer A1) => void);\n\t\t\t(event: infer E2, listener: (...args: infer A2) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0> &\n\t\t\tTransformedEvent<TThis, E1, A1> &\n\t\t\tTransformedEvent<TThis, E2, A2>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t(event: infer E1, listener: (...args: infer A1) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0> & TransformedEvent<TThis, E1, A1>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0>\n\t: // eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t  TransformedEvent<TThis, string, any[]>;\n"]}
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Base interface for event emitters.\n * @alpha\n */\nexport interface IEvent {\n\t/**\n\t * Base event emitter signature.\n\t *\n\t * @remarks The event emitter polyfill and the node event emitter have different event types:\n\t * `string | symbol` vs. `string | number`.\n\t *\n\t * So for our typing we'll contrain to string, that way we work with both.\n\t *\n\t * @eventProperty\n\t */\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t(event: string, listener: (...args: any[]) => void);\n}\n\n/**\n * Base interface for error event emitters.\n * @alpha\n */\nexport interface IErrorEvent extends IEvent {\n\t/**\n\t * Base error event emitter signature.\n\t *\n\t * @eventProperty\n\t */\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t(event: \"error\", listener: (message: any) => void);\n}\n\n/**\n * Base interface for event providers.\n * @alpha\n */\nexport interface IEventProvider<TEvent extends IEvent> {\n\t/**\n\t * Registers a callback to be invoked when the corresponding event is triggered.\n\t */\n\treadonly on: IEventTransformer<this, TEvent>;\n\n\t/**\n\t * Registers a callback to be invoked the first time (after registration) the corresponding event is triggered.\n\t */\n\treadonly once: IEventTransformer<this, TEvent>;\n\n\t/**\n\t * Removes the corresponding event if it has been registered.\n\t */\n\treadonly off: IEventTransformer<this, TEvent>;\n}\n\n/**\n * Allows an interface to extend interfaces that already extend an {@link IEventProvider}.\n *\n * @example\n *\n * ``` typescript\n * interface AEvents extends IEvent{\n *  (event: \"a-event\",listener: (a: number)=>void);\n * }\n * interface A extends IEventProvider<AEvents>{\n *  a: object;\n * }\n *\n * interface BEvents extends IEvent{\n *  (event: \"b-event\",listener: (b: string)=>void);\n * }\n * interface B extends ExtendEventProvider<AEvents, A, BEvents>{\n *  b: boolean;\n * };\n * ```\n *\n * interface B will now extend interface A and its events\n * @alpha\n */\nexport type ExtendEventProvider<\n\tTBaseEvent extends IEvent,\n\tTBase extends IEventProvider<TBaseEvent>,\n\tTEvent extends TBaseEvent,\n> = Omit<Omit<Omit<TBase, \"on\">, \"once\">, \"off\"> &\n\tIEventProvider<TBaseEvent> &\n\tIEventProvider<TEvent>;\n\n// These types handle replacing IEventThisPlaceHolder with `this`, so we can\n// support polymorphic `this`. For instance if an event wanted to be:\n// (event: \"some-event\", listener:(target: this)=>void)\n//\n// it should be written as\n// (event: \"some-event\", listener:(target: IEventThisPlaceHolder)=>void)\n//\n// and IEventThisPlaceHolder will be replaced with this.\n// This is all consumers of these types need to know.\n\n/**\n * The placeholder type that should be used instead of `this` in events.\n * @alpha\n */\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\nexport type IEventThisPlaceHolder = { thisPlaceHolder: \"thisPlaceHolder\" };\n\n/**\n * Does the type replacement by changing types of {@link IEventThisPlaceHolder} to `TThis`\n * @alpha\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type ReplaceIEventThisPlaceHolder<L extends any[], TThis> = L extends any[]\n\t? { [K in keyof L]: L[K] extends IEventThisPlaceHolder ? TThis : L[K] }\n\t: L;\n\n/**\n * Transforms the event overload by replacing {@link IEventThisPlaceHolder} with `TThis` in the event listener\n * arguments and having the overload return `TTHis` as well\n * @alpha\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type TransformedEvent<TThis, E, A extends any[]> = (\n\tevent: E,\n\tlistener: (...args: ReplaceIEventThisPlaceHolder<A, TThis>) => void,\n) => TThis;\n\n/**\n * This type is a conditional type for transforming all the overloads provided in `TEvent`.\n *\n * @remarks\n * Due to limitations of the TypeScript typing system, we need to handle each number of overload individually.\n * It currently supports the max of 15 event overloads which is more than we use anywhere.\n * At more than 15 overloads we start to hit {@link https://github.com/microsoft/TypeScript/issues/37209 | TS2589}.\n * If we need to move beyond 15 we should evaluate using a mapped type pattern like `{\"event\":(listenerArgs)=>void}`\n * @alpha\n */\nexport type IEventTransformer<TThis, TEvent extends IEvent> = TEvent extends {\n\t(event: infer E0, listener: (...args: infer A0) => void);\n\t(event: infer E1, listener: (...args: infer A1) => void);\n\t(event: infer E2, listener: (...args: infer A2) => void);\n\t(event: infer E3, listener: (...args: infer A3) => void);\n\t(event: infer E4, listener: (...args: infer A4) => void);\n\t(event: infer E5, listener: (...args: infer A5) => void);\n\t(event: infer E6, listener: (...args: infer A6) => void);\n\t(event: infer E7, listener: (...args: infer A7) => void);\n\t(event: infer E8, listener: (...args: infer A8) => void);\n\t(event: infer E9, listener: (...args: infer A9) => void);\n\t(event: infer E10, listener: (...args: infer A10) => void);\n\t(event: infer E11, listener: (...args: infer A11) => void);\n\t(event: infer E12, listener: (...args: infer A12) => void);\n\t(event: infer E13, listener: (...args: infer A13) => void);\n\t(event: infer E14, listener: (...args: infer A14) => void);\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t(event: string, listener: (...args: any[]) => void);\n}\n\t? TransformedEvent<TThis, E0, A0> &\n\t\t\tTransformedEvent<TThis, E1, A1> &\n\t\t\tTransformedEvent<TThis, E2, A2> &\n\t\t\tTransformedEvent<TThis, E3, A3> &\n\t\t\tTransformedEvent<TThis, E4, A4> &\n\t\t\tTransformedEvent<TThis, E5, A5> &\n\t\t\tTransformedEvent<TThis, E6, A6> &\n\t\t\tTransformedEvent<TThis, E7, A7> &\n\t\t\tTransformedEvent<TThis, E8, A8> &\n\t\t\tTransformedEvent<TThis, E9, A9> &\n\t\t\tTransformedEvent<TThis, E10, A10> &\n\t\t\tTransformedEvent<TThis, E11, A11> &\n\t\t\tTransformedEvent<TThis, E12, A12> &\n\t\t\tTransformedEvent<TThis, E13, A13> &\n\t\t\tTransformedEvent<TThis, E14, A14>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t(event: infer E1, listener: (...args: infer A1) => void);\n\t\t\t(event: infer E2, listener: (...args: infer A2) => void);\n\t\t\t(event: infer E3, listener: (...args: infer A3) => void);\n\t\t\t(event: infer E4, listener: (...args: infer A4) => void);\n\t\t\t(event: infer E5, listener: (...args: infer A5) => void);\n\t\t\t(event: infer E6, listener: (...args: infer A6) => void);\n\t\t\t(event: infer E7, listener: (...args: infer A7) => void);\n\t\t\t(event: infer E8, listener: (...args: infer A8) => void);\n\t\t\t(event: infer E9, listener: (...args: infer A9) => void);\n\t\t\t(event: infer E10, listener: (...args: infer A10) => void);\n\t\t\t(event: infer E11, listener: (...args: infer A11) => void);\n\t\t\t(event: infer E12, listener: (...args: infer A12) => void);\n\t\t\t(event: infer E13, listener: (...args: infer A13) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0> &\n\t\t\tTransformedEvent<TThis, E1, A1> &\n\t\t\tTransformedEvent<TThis, E2, A2> &\n\t\t\tTransformedEvent<TThis, E3, A3> &\n\t\t\tTransformedEvent<TThis, E4, A4> &\n\t\t\tTransformedEvent<TThis, E5, A5> &\n\t\t\tTransformedEvent<TThis, E6, A6> &\n\t\t\tTransformedEvent<TThis, E7, A7> &\n\t\t\tTransformedEvent<TThis, E8, A8> &\n\t\t\tTransformedEvent<TThis, E9, A9> &\n\t\t\tTransformedEvent<TThis, E10, A10> &\n\t\t\tTransformedEvent<TThis, E11, A11> &\n\t\t\tTransformedEvent<TThis, E12, A12> &\n\t\t\tTransformedEvent<TThis, E13, A13>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t(event: infer E1, listener: (...args: infer A1) => void);\n\t\t\t(event: infer E2, listener: (...args: infer A2) => void);\n\t\t\t(event: infer E3, listener: (...args: infer A3) => void);\n\t\t\t(event: infer E4, listener: (...args: infer A4) => void);\n\t\t\t(event: infer E5, listener: (...args: infer A5) => void);\n\t\t\t(event: infer E6, listener: (...args: infer A6) => void);\n\t\t\t(event: infer E7, listener: (...args: infer A7) => void);\n\t\t\t(event: infer E8, listener: (...args: infer A8) => void);\n\t\t\t(event: infer E9, listener: (...args: infer A9) => void);\n\t\t\t(event: infer E10, listener: (...args: infer A10) => void);\n\t\t\t(event: infer E11, listener: (...args: infer A11) => void);\n\t\t\t(event: infer E12, listener: (...args: infer A12) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0> &\n\t\t\tTransformedEvent<TThis, E1, A1> &\n\t\t\tTransformedEvent<TThis, E2, A2> &\n\t\t\tTransformedEvent<TThis, E3, A3> &\n\t\t\tTransformedEvent<TThis, E4, A4> &\n\t\t\tTransformedEvent<TThis, E5, A5> &\n\t\t\tTransformedEvent<TThis, E6, A6> &\n\t\t\tTransformedEvent<TThis, E7, A7> &\n\t\t\tTransformedEvent<TThis, E8, A8> &\n\t\t\tTransformedEvent<TThis, E9, A9> &\n\t\t\tTransformedEvent<TThis, E10, A10> &\n\t\t\tTransformedEvent<TThis, E11, A11> &\n\t\t\tTransformedEvent<TThis, E12, A12>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t(event: infer E1, listener: (...args: infer A1) => void);\n\t\t\t(event: infer E2, listener: (...args: infer A2) => void);\n\t\t\t(event: infer E3, listener: (...args: infer A3) => void);\n\t\t\t(event: infer E4, listener: (...args: infer A4) => void);\n\t\t\t(event: infer E5, listener: (...args: infer A5) => void);\n\t\t\t(event: infer E6, listener: (...args: infer A6) => void);\n\t\t\t(event: infer E7, listener: (...args: infer A7) => void);\n\t\t\t(event: infer E8, listener: (...args: infer A8) => void);\n\t\t\t(event: infer E9, listener: (...args: infer A9) => void);\n\t\t\t(event: infer E10, listener: (...args: infer A10) => void);\n\t\t\t(event: infer E11, listener: (...args: infer A11) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0> &\n\t\t\tTransformedEvent<TThis, E1, A1> &\n\t\t\tTransformedEvent<TThis, E2, A2> &\n\t\t\tTransformedEvent<TThis, E3, A3> &\n\t\t\tTransformedEvent<TThis, E4, A4> &\n\t\t\tTransformedEvent<TThis, E5, A5> &\n\t\t\tTransformedEvent<TThis, E6, A6> &\n\t\t\tTransformedEvent<TThis, E7, A7> &\n\t\t\tTransformedEvent<TThis, E8, A8> &\n\t\t\tTransformedEvent<TThis, E9, A9> &\n\t\t\tTransformedEvent<TThis, E10, A10> &\n\t\t\tTransformedEvent<TThis, E11, A11>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t(event: infer E1, listener: (...args: infer A1) => void);\n\t\t\t(event: infer E2, listener: (...args: infer A2) => void);\n\t\t\t(event: infer E3, listener: (...args: infer A3) => void);\n\t\t\t(event: infer E4, listener: (...args: infer A4) => void);\n\t\t\t(event: infer E5, listener: (...args: infer A5) => void);\n\t\t\t(event: infer E6, listener: (...args: infer A6) => void);\n\t\t\t(event: infer E7, listener: (...args: infer A7) => void);\n\t\t\t(event: infer E8, listener: (...args: infer A8) => void);\n\t\t\t(event: infer E9, listener: (...args: infer A9) => void);\n\t\t\t(event: infer E10, listener: (...args: infer A10) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0> &\n\t\t\tTransformedEvent<TThis, E1, A1> &\n\t\t\tTransformedEvent<TThis, E2, A2> &\n\t\t\tTransformedEvent<TThis, E3, A3> &\n\t\t\tTransformedEvent<TThis, E4, A4> &\n\t\t\tTransformedEvent<TThis, E5, A5> &\n\t\t\tTransformedEvent<TThis, E6, A6> &\n\t\t\tTransformedEvent<TThis, E7, A7> &\n\t\t\tTransformedEvent<TThis, E8, A8> &\n\t\t\tTransformedEvent<TThis, E9, A9> &\n\t\t\tTransformedEvent<TThis, E10, A10>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t(event: infer E1, listener: (...args: infer A1) => void);\n\t\t\t(event: infer E2, listener: (...args: infer A2) => void);\n\t\t\t(event: infer E3, listener: (...args: infer A3) => void);\n\t\t\t(event: infer E4, listener: (...args: infer A4) => void);\n\t\t\t(event: infer E5, listener: (...args: infer A5) => void);\n\t\t\t(event: infer E6, listener: (...args: infer A6) => void);\n\t\t\t(event: infer E7, listener: (...args: infer A7) => void);\n\t\t\t(event: infer E8, listener: (...args: infer A8) => void);\n\t\t\t(event: infer E9, listener: (...args: infer A9) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0> &\n\t\t\tTransformedEvent<TThis, E1, A1> &\n\t\t\tTransformedEvent<TThis, E2, A2> &\n\t\t\tTransformedEvent<TThis, E3, A3> &\n\t\t\tTransformedEvent<TThis, E4, A4> &\n\t\t\tTransformedEvent<TThis, E5, A5> &\n\t\t\tTransformedEvent<TThis, E6, A6> &\n\t\t\tTransformedEvent<TThis, E7, A7> &\n\t\t\tTransformedEvent<TThis, E8, A8> &\n\t\t\tTransformedEvent<TThis, E9, A9>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t(event: infer E1, listener: (...args: infer A1) => void);\n\t\t\t(event: infer E2, listener: (...args: infer A2) => void);\n\t\t\t(event: infer E3, listener: (...args: infer A3) => void);\n\t\t\t(event: infer E4, listener: (...args: infer A4) => void);\n\t\t\t(event: infer E5, listener: (...args: infer A5) => void);\n\t\t\t(event: infer E6, listener: (...args: infer A6) => void);\n\t\t\t(event: infer E7, listener: (...args: infer A7) => void);\n\t\t\t(event: infer E8, listener: (...args: infer A8) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0> &\n\t\t\tTransformedEvent<TThis, E1, A1> &\n\t\t\tTransformedEvent<TThis, E2, A2> &\n\t\t\tTransformedEvent<TThis, E3, A3> &\n\t\t\tTransformedEvent<TThis, E4, A4> &\n\t\t\tTransformedEvent<TThis, E5, A5> &\n\t\t\tTransformedEvent<TThis, E6, A6> &\n\t\t\tTransformedEvent<TThis, E7, A7> &\n\t\t\tTransformedEvent<TThis, E8, A8>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t(event: infer E1, listener: (...args: infer A1) => void);\n\t\t\t(event: infer E2, listener: (...args: infer A2) => void);\n\t\t\t(event: infer E3, listener: (...args: infer A3) => void);\n\t\t\t(event: infer E4, listener: (...args: infer A4) => void);\n\t\t\t(event: infer E5, listener: (...args: infer A5) => void);\n\t\t\t(event: infer E6, listener: (...args: infer A6) => void);\n\t\t\t(event: infer E7, listener: (...args: infer A7) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0> &\n\t\t\tTransformedEvent<TThis, E1, A1> &\n\t\t\tTransformedEvent<TThis, E2, A2> &\n\t\t\tTransformedEvent<TThis, E3, A3> &\n\t\t\tTransformedEvent<TThis, E4, A4> &\n\t\t\tTransformedEvent<TThis, E5, A5> &\n\t\t\tTransformedEvent<TThis, E6, A6> &\n\t\t\tTransformedEvent<TThis, E7, A7>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t(event: infer E1, listener: (...args: infer A1) => void);\n\t\t\t(event: infer E2, listener: (...args: infer A2) => void);\n\t\t\t(event: infer E3, listener: (...args: infer A3) => void);\n\t\t\t(event: infer E4, listener: (...args: infer A4) => void);\n\t\t\t(event: infer E5, listener: (...args: infer A5) => void);\n\t\t\t(event: infer E6, listener: (...args: infer A6) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0> &\n\t\t\tTransformedEvent<TThis, E1, A1> &\n\t\t\tTransformedEvent<TThis, E2, A2> &\n\t\t\tTransformedEvent<TThis, E3, A3> &\n\t\t\tTransformedEvent<TThis, E4, A4> &\n\t\t\tTransformedEvent<TThis, E5, A5> &\n\t\t\tTransformedEvent<TThis, E6, A6>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t(event: infer E1, listener: (...args: infer A1) => void);\n\t\t\t(event: infer E2, listener: (...args: infer A2) => void);\n\t\t\t(event: infer E3, listener: (...args: infer A3) => void);\n\t\t\t(event: infer E4, listener: (...args: infer A4) => void);\n\t\t\t(event: infer E5, listener: (...args: infer A5) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0> &\n\t\t\tTransformedEvent<TThis, E1, A1> &\n\t\t\tTransformedEvent<TThis, E2, A2> &\n\t\t\tTransformedEvent<TThis, E3, A3> &\n\t\t\tTransformedEvent<TThis, E4, A4> &\n\t\t\tTransformedEvent<TThis, E5, A5>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t(event: infer E1, listener: (...args: infer A1) => void);\n\t\t\t(event: infer E2, listener: (...args: infer A2) => void);\n\t\t\t(event: infer E3, listener: (...args: infer A3) => void);\n\t\t\t(event: infer E4, listener: (...args: infer A4) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0> &\n\t\t\tTransformedEvent<TThis, E1, A1> &\n\t\t\tTransformedEvent<TThis, E2, A2> &\n\t\t\tTransformedEvent<TThis, E3, A3> &\n\t\t\tTransformedEvent<TThis, E4, A4>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t(event: infer E1, listener: (...args: infer A1) => void);\n\t\t\t(event: infer E2, listener: (...args: infer A2) => void);\n\t\t\t(event: infer E3, listener: (...args: infer A3) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0> &\n\t\t\tTransformedEvent<TThis, E1, A1> &\n\t\t\tTransformedEvent<TThis, E2, A2> &\n\t\t\tTransformedEvent<TThis, E3, A3>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t(event: infer E1, listener: (...args: infer A1) => void);\n\t\t\t(event: infer E2, listener: (...args: infer A2) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0> &\n\t\t\tTransformedEvent<TThis, E1, A1> &\n\t\t\tTransformedEvent<TThis, E2, A2>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t(event: infer E1, listener: (...args: infer A1) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0> & TransformedEvent<TThis, E1, A1>\n\t: TEvent extends {\n\t\t\t(event: infer E0, listener: (...args: infer A0) => void);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t(event: string, listener: (...args: any[]) => void);\n\t  }\n\t? TransformedEvent<TThis, E0, A0>\n\t: // eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t  TransformedEvent<TThis, string, any[]>;\n"]}

package/dist/fluidRouter.d.ts

@@ -3,20 +3,20 @@
  * Licensed under the MIT License.
  */
 /**
- * @internal
+ * @alpha
  */
 export interface IRequestHeader {
     [index: string]: any;
 }
 /**
- * @internal
+ * @alpha
  */
 export interface IRequest {
     url: string;
     headers?: IRequestHeader;
 }
 /**
- * @internal
+ * @alpha
  */
 export interface IResponse {
     mimeType: string;
@@ -29,20 +29,20 @@ export interface IResponse {
 }
 /**
  * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
- * @internal
+ * @alpha
  */
 export declare const IFluidRouter: keyof IProvideFluidRouter;
 /**
  * Request routing
  * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
- * @internal
+ * @alpha
  */
 export interface IProvideFluidRouter {
     readonly IFluidRouter: IFluidRouter;
 }
 /**
  * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
- * @internal
+ * @alpha
  */
 export interface IFluidRouter extends IProvideFluidRouter {
     request(request: IRequest): Promise<IResponse>;

package/dist/fluidRouter.js

@@ -7,7 +7,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.IFluidRouter = void 0;
 /**
  * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
- * @internal
+ * @alpha
  */
 exports.IFluidRouter = "IFluidRouter";
 //# sourceMappingURL=fluidRouter.js.map

package/dist/fluidRouter.js.map

@@ -1 +1 @@
-{"version":3,"file":"fluidRouter.js","sourceRoot":"","sources":["../src/fluidRouter.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAkCH;;;GAGG;AACU,QAAA,YAAY,GAA8B,cAAc,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * @internal\n */\nexport interface IRequestHeader {\n\t// TODO: Use `unknown` instead (API-Breaking)\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t[index: string]: any;\n}\n\n/**\n * @internal\n */\nexport interface IRequest {\n\turl: string;\n\theaders?: IRequestHeader;\n}\n\n/**\n * @internal\n */\nexport interface IResponse {\n\tmimeType: string;\n\tstatus: number;\n\t// TODO: Use `unknown` instead (API-Breaking)\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\tvalue: any;\n\t// TODO: Use `unknown` instead (API-Breaking)\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\theaders?: { [key: string]: any };\n\tstack?: string;\n}\n\n/**\n * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the \"entryPoint\" pattern. Refer to Removing-IFluidRouter.md\n * @internal\n */\nexport const IFluidRouter: keyof IProvideFluidRouter = \"IFluidRouter\";\n\n/**\n * Request routing\n * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the \"entryPoint\" pattern. Refer to Removing-IFluidRouter.md\n * @internal\n */\nexport interface IProvideFluidRouter {\n\treadonly IFluidRouter: IFluidRouter;\n}\n\n/**\n * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the \"entryPoint\" pattern. Refer to Removing-IFluidRouter.md\n * @internal\n */\nexport interface IFluidRouter extends IProvideFluidRouter {\n\trequest(request: IRequest): Promise<IResponse>;\n}\n"]}
+{"version":3,"file":"fluidRouter.js","sourceRoot":"","sources":["../src/fluidRouter.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAkCH;;;GAGG;AACU,QAAA,YAAY,GAA8B,cAAc,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * @alpha\n */\nexport interface IRequestHeader {\n\t// TODO: Use `unknown` instead (API-Breaking)\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t[index: string]: any;\n}\n\n/**\n * @alpha\n */\nexport interface IRequest {\n\turl: string;\n\theaders?: IRequestHeader;\n}\n\n/**\n * @alpha\n */\nexport interface IResponse {\n\tmimeType: string;\n\tstatus: number;\n\t// TODO: Use `unknown` instead (API-Breaking)\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\tvalue: any;\n\t// TODO: Use `unknown` instead (API-Breaking)\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\theaders?: { [key: string]: any };\n\tstack?: string;\n}\n\n/**\n * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the \"entryPoint\" pattern. Refer to Removing-IFluidRouter.md\n * @alpha\n */\nexport const IFluidRouter: keyof IProvideFluidRouter = \"IFluidRouter\";\n\n/**\n * Request routing\n * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the \"entryPoint\" pattern. Refer to Removing-IFluidRouter.md\n * @alpha\n */\nexport interface IProvideFluidRouter {\n\treadonly IFluidRouter: IFluidRouter;\n}\n\n/**\n * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the \"entryPoint\" pattern. Refer to Removing-IFluidRouter.md\n * @alpha\n */\nexport interface IFluidRouter extends IProvideFluidRouter {\n\trequest(request: IRequest): Promise<IResponse>;\n}\n"]}

package/dist/index.d.ts

@@ -19,4 +19,5 @@ Tagged, TelemetryEventCategory, // deprecated
 TelemetryBaseEventPropertyType, TelemetryEventPropertyType, } from "./logger";
 export { LogLevel } from "./logger";
 export { FluidObjectProviderKeys, FluidObject, FluidObjectKeys } from "./provider";
+export { ConfigTypes, IConfigProviderBase } from "./config";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,YAAY,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAEhD,OAAO,EACN,eAAe,EACf,UAAU,EACV,aAAa,EACb,WAAW,EACX,kBAAkB,GAClB,MAAM,SAAS,CAAC;AAEjB,YAAY,EACX,mBAAmB,EACnB,WAAW,EACX,MAAM,EACN,cAAc,EACd,qBAAqB,EACrB,iBAAiB,EACjB,4BAA4B,EAC5B,gBAAgB,GAChB,MAAM,UAAU,CAAC;AAElB,OAAO,EACN,cAAc,EACd,qBAAqB,EACrB,cAAc,EACd,qBAAqB,GACrB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACN,wBAAwB,EACxB,aAAa,EACb,cAAc,EACd,uBAAuB,EACvB,iBAAiB,EACjB,kBAAkB,EAClB,yBAAyB,EACzB,gCAAgC,GAChC,MAAM,gBAAgB,CAAC;AAKxB,OAAO,EACN,QAAQ,EACR,cAAc,EACd,SAAS,EACT,mBAAmB,EACnB,YAAY,GACZ,MAAM,eAAe,CAAC;AAEvB,OAAO,EACN,mBAAmB,EACnB,0BAA0B,EAC1B,YAAY,EACZ,mBAAmB,GACnB,MAAM,WAAW,CAAC;AAEnB,YAAY,EACX,aAAa,EACb,4BAA4B,EAAE,aAAa;AAC3C,mBAAmB,EACnB,oBAAoB,EACpB,wBAAwB,EACxB,oBAAoB,EAAE,aAAa;AACnC,sBAAsB,EAAE,aAAa;AACrC,gBAAgB,EAAE,aAAa;AAC/B,0BAA0B,EAAE,aAAa;AACzC,oBAAoB,EAAE,aAAa;AACnC,MAAM,EACN,sBAAsB,EAAE,aAAa;AACrC,8BAA8B,EAC9B,0BAA0B,GAC1B,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACpC,OAAO,EAAE,uBAAuB,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,YAAY,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAEhD,OAAO,EACN,eAAe,EACf,UAAU,EACV,aAAa,EACb,WAAW,EACX,kBAAkB,GAClB,MAAM,SAAS,CAAC;AAEjB,YAAY,EACX,mBAAmB,EACnB,WAAW,EACX,MAAM,EACN,cAAc,EACd,qBAAqB,EACrB,iBAAiB,EACjB,4BAA4B,EAC5B,gBAAgB,GAChB,MAAM,UAAU,CAAC;AAElB,OAAO,EACN,cAAc,EACd,qBAAqB,EACrB,cAAc,EACd,qBAAqB,GACrB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACN,wBAAwB,EACxB,aAAa,EACb,cAAc,EACd,uBAAuB,EACvB,iBAAiB,EACjB,kBAAkB,EAClB,yBAAyB,EACzB,gCAAgC,GAChC,MAAM,gBAAgB,CAAC;AAKxB,OAAO,EACN,QAAQ,EACR,cAAc,EACd,SAAS,EACT,mBAAmB,EACnB,YAAY,GACZ,MAAM,eAAe,CAAC;AAEvB,OAAO,EACN,mBAAmB,EACnB,0BAA0B,EAC1B,YAAY,EACZ,mBAAmB,GACnB,MAAM,WAAW,CAAC;AAEnB,YAAY,EACX,aAAa,EACb,4BAA4B,EAAE,aAAa;AAC3C,mBAAmB,EACnB,oBAAoB,EACpB,wBAAwB,EACxB,oBAAoB,EAAE,aAAa;AACnC,sBAAsB,EAAE,aAAa;AACrC,gBAAgB,EAAE,aAAa;AAC/B,0BAA0B,EAAE,aAAa;AACzC,oBAAoB,EAAE,aAAa;AACnC,MAAM,EACN,sBAAsB,EAAE,aAAa;AACrC,8BAA8B,EAC9B,0BAA0B,GAC1B,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACpC,OAAO,EAAE,uBAAuB,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AACnF,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC"}

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH,iCAMiB;AALhB,wGAAA,eAAe,OAAA;AAkBhB,iDAKyB;AAJxB,+GAAA,cAAc,OAAA;AAEd,+GAAA,cAAc,OAAA;AAIf,+CASwB;AANvB,8GAAA,cAAc,OAAA;AAGd,kHAAA,kBAAkB,OAAA;AAClB,yHAAA,yBAAyB,OAAA;AAI1B,+FAA+F;AAC/F,qDAAqD;AACrD,8EAA8E;AAC9E,6CAMuB;AADtB,2GAAA,YAAY,OAAA;AAGb,qCAKmB;AAJlB,8GAAA,mBAAmB,OAAA;AAEnB,uGAAA,YAAY,OAAA;AAoBb,mCAAoC;AAA3B,kGAAA,QAAQ,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport type { IDisposable } from \"./disposable\";\n\nexport {\n\tFluidErrorTypes,\n\tIErrorBase,\n\tIGenericError,\n\tIUsageError,\n\tIThrottlingWarning,\n} from \"./error\";\n\nexport type {\n\tExtendEventProvider,\n\tIErrorEvent,\n\tIEvent,\n\tIEventProvider,\n\tIEventThisPlaceHolder,\n\tIEventTransformer,\n\tReplaceIEventThisPlaceHolder,\n\tTransformedEvent,\n} from \"./events\";\n\nexport {\n\tIFluidLoadable,\n\tIProvideFluidLoadable,\n\tIFluidRunnable,\n\tIProvideFluidRunnable,\n} from \"./fluidLoadable\";\n\nexport {\n\tIFluidPackageEnvironment,\n\tIFluidPackage,\n\tisFluidPackage,\n\tIFluidCodeDetailsConfig,\n\tIFluidCodeDetails,\n\tisFluidCodeDetails,\n\tIFluidCodeDetailsComparer,\n\tIProvideFluidCodeDetailsComparer,\n} from \"./fluidPackage\";\n\n// TypeScript forgets the index signature when customers augment IRequestHeader if we export *.\n// So we export the explicit members as a workaround:\n// https://github.com/microsoft/TypeScript/issues/18877#issuecomment-476921038\nexport {\n\tIRequest,\n\tIRequestHeader,\n\tIResponse,\n\tIProvideFluidRouter,\n\tIFluidRouter,\n} from \"./fluidRouter\";\n\nexport {\n\tIFluidHandleContext,\n\tIProvideFluidHandleContext,\n\tIFluidHandle,\n\tIProvideFluidHandle,\n} from \"./handles\";\n\nexport type {\n\tILoggingError,\n\tITaggedTelemetryPropertyType, // deprecated\n\tITelemetryBaseEvent,\n\tITelemetryBaseLogger,\n\tITelemetryBaseProperties,\n\tITelemetryErrorEvent, // deprecated\n\tITelemetryGenericEvent, // deprecated\n\tITelemetryLogger, // deprecated\n\tITelemetryPerformanceEvent, // deprecated\n\tITelemetryProperties, // deprecated\n\tTagged,\n\tTelemetryEventCategory, // deprecated\n\tTelemetryBaseEventPropertyType,\n\tTelemetryEventPropertyType, // deprecated\n} from \"./logger\";\nexport { LogLevel } from \"./logger\";\nexport { FluidObjectProviderKeys, FluidObject, FluidObjectKeys } from \"./provider\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH,iCAMiB;AALhB,wGAAA,eAAe,OAAA;AAkBhB,iDAKyB;AAJxB,+GAAA,cAAc,OAAA;AAEd,+GAAA,cAAc,OAAA;AAIf,+CASwB;AANvB,8GAAA,cAAc,OAAA;AAGd,kHAAA,kBAAkB,OAAA;AAClB,yHAAA,yBAAyB,OAAA;AAI1B,+FAA+F;AAC/F,qDAAqD;AACrD,8EAA8E;AAC9E,6CAMuB;AADtB,2GAAA,YAAY,OAAA;AAGb,qCAKmB;AAJlB,8GAAA,mBAAmB,OAAA;AAEnB,uGAAA,YAAY,OAAA;AAoBb,mCAAoC;AAA3B,kGAAA,QAAQ,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport type { IDisposable } from \"./disposable\";\n\nexport {\n\tFluidErrorTypes,\n\tIErrorBase,\n\tIGenericError,\n\tIUsageError,\n\tIThrottlingWarning,\n} from \"./error\";\n\nexport type {\n\tExtendEventProvider,\n\tIErrorEvent,\n\tIEvent,\n\tIEventProvider,\n\tIEventThisPlaceHolder,\n\tIEventTransformer,\n\tReplaceIEventThisPlaceHolder,\n\tTransformedEvent,\n} from \"./events\";\n\nexport {\n\tIFluidLoadable,\n\tIProvideFluidLoadable,\n\tIFluidRunnable,\n\tIProvideFluidRunnable,\n} from \"./fluidLoadable\";\n\nexport {\n\tIFluidPackageEnvironment,\n\tIFluidPackage,\n\tisFluidPackage,\n\tIFluidCodeDetailsConfig,\n\tIFluidCodeDetails,\n\tisFluidCodeDetails,\n\tIFluidCodeDetailsComparer,\n\tIProvideFluidCodeDetailsComparer,\n} from \"./fluidPackage\";\n\n// TypeScript forgets the index signature when customers augment IRequestHeader if we export *.\n// So we export the explicit members as a workaround:\n// https://github.com/microsoft/TypeScript/issues/18877#issuecomment-476921038\nexport {\n\tIRequest,\n\tIRequestHeader,\n\tIResponse,\n\tIProvideFluidRouter,\n\tIFluidRouter,\n} from \"./fluidRouter\";\n\nexport {\n\tIFluidHandleContext,\n\tIProvideFluidHandleContext,\n\tIFluidHandle,\n\tIProvideFluidHandle,\n} from \"./handles\";\n\nexport type {\n\tILoggingError,\n\tITaggedTelemetryPropertyType, // deprecated\n\tITelemetryBaseEvent,\n\tITelemetryBaseLogger,\n\tITelemetryBaseProperties,\n\tITelemetryErrorEvent, // deprecated\n\tITelemetryGenericEvent, // deprecated\n\tITelemetryLogger, // deprecated\n\tITelemetryPerformanceEvent, // deprecated\n\tITelemetryProperties, // deprecated\n\tTagged,\n\tTelemetryEventCategory, // deprecated\n\tTelemetryBaseEventPropertyType,\n\tTelemetryEventPropertyType, // deprecated\n} from \"./logger\";\nexport { LogLevel } from \"./logger\";\nexport { FluidObjectProviderKeys, FluidObject, FluidObjectKeys } from \"./provider\";\nexport { ConfigTypes, IConfigProviderBase } from \"./config\";\n"]}