@fluidframework/core-interfaces 2.0.0-internal.7.3.0 → 2.0.0-internal.7.4.1

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

@@ -1,3 +1,9 @@
+/**
+ * Types supported by {@link IConfigProviderBase}.
+ * @alpha
+ */
+export declare type ConfigTypes = string | number | boolean | number[] | string[] | boolean[] | undefined;
+
 /**
  * Allows an interface to extend interfaces that already extend an {@link IEventProvider}.
  *
@@ -20,12 +26,13 @@
  * ```
  *
  * interface B will now extend interface A and its events
- *
+ * @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>;
 
 /**
  * Error types the Fluid Framework may report.
+ * @internal
  */
 export declare const FluidErrorTypes: {
     /**
@@ -50,6 +57,9 @@ export declare const FluidErrorTypes: {
     readonly usageError: "usageError";
 };
 
+/**
+ * @internal
+ */
 export declare type FluidErrorTypes = (typeof FluidErrorTypes)[keyof typeof FluidErrorTypes];
 
 /**
@@ -83,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>`
- *
+ * @alpha
  */
 export declare type FluidObject<T = unknown> = {
     [P in FluidObjectProviderKeys<T>]?: T[P];
@@ -96,7 +106,7 @@ export declare type FluidObject<T = unknown> = {
  * See {@link FluidObject}
  *
  * For example `FluidObjectKeys<IFoo & IBar>` would result in `"IFoo" | "IBar"`
- *
+ * @alpha
  */
 export declare type FluidObjectKeys<T> = keyof FluidObject<T>;
 
@@ -124,11 +134,39 @@ export declare type FluidObjectKeys<T> = keyof FluidObject<T>;
  *
  * This pattern enables discovery, and delegation in a standard way which is central
  * to FluidObject pattern.
+ * @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 providing configurations to enable/disable/control features.
+ * @alpha
+ */
+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 {
     /**
@@ -153,6 +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.
+ *
+ * @alpha
  */
 export declare interface IErrorBase extends Partial<Error> {
     /**
@@ -191,6 +231,7 @@ export declare interface IErrorBase extends Partial<Error> {
 
 /**
  * Base interface for error event emitters.
+ * @alpha
  */
 export declare interface IErrorEvent extends IEvent {
     /**
@@ -203,6 +244,7 @@ export declare interface IErrorEvent extends IEvent {
 
 /**
  * Base interface for event emitters.
+ * @alpha
  */
 export declare interface IEvent {
     /**
@@ -220,6 +262,7 @@ export declare interface IEvent {
 
 /**
  * Base interface for event providers.
+ * @alpha
  */
 export declare interface IEventProvider<TEvent extends IEvent> {
     /**
@@ -238,6 +281,7 @@ export declare interface IEventProvider<TEvent extends IEvent> {
 
 /**
  * The placeholder type that should be used instead of `this` in events.
+ * @alpha
  */
 export declare type IEventThisPlaceHolder = {
     thisPlaceHolder: "thisPlaceHolder";
@@ -251,6 +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}`
+ * @alpha
  */
 export declare type IEventTransformer<TThis, TEvent extends IEvent> = TEvent extends {
     (event: infer E0, listener: (...args: infer A0) => void): any;
@@ -409,6 +454,7 @@ export declare type IEventTransformer<TThis, TEvent extends IEvent> = TEvent ext
  *
  * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetails}
  * to have code loading modules in same package.
+ * @internal
  */
 export declare interface IFluidCodeDetails {
     /**
@@ -425,6 +471,7 @@ export declare interface IFluidCodeDetails {
 /**
  * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsComparer}
  * to have code loading modules in same package.
+ * @internal
  */
 export declare const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer;
 
@@ -433,6 +480,7 @@ export declare const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsCo
  *
  * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsComparer}
  * to have code loading modules in same package.
+ * @internal
  */
 export declare interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsComparer {
     /**
@@ -464,15 +512,20 @@ export declare interface IFluidCodeDetailsComparer extends IProvideFluidCodeDeta
  *
  * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsConfig}
  * to have code loading modules in same package.
+ * @internal
  */
 export declare interface IFluidCodeDetailsConfig {
     readonly [key: string]: string;
 }
 
+/**
+ * @alpha
+ */
 export declare const IFluidHandle: keyof IProvideFluidHandle;
 
 /**
  * Handle to a shared {@link FluidObject}.
+ * @alpha
  */
 export declare interface IFluidHandle<T = FluidObject & IFluidLoadable> extends IProvideFluidHandle {
     /**
@@ -504,10 +557,14 @@ export declare interface IFluidHandle<T = FluidObject & IFluidLoadable> extends
     bind(handle: IFluidHandle): void;
 }
 
+/**
+ * @alpha
+ */
 export declare const IFluidHandleContext: keyof IProvideFluidHandleContext;
 
 /**
  * Describes a routing context from which other `IFluidHandleContext`s are defined.
+ * @alpha
  */
 export declare interface IFluidHandleContext extends IProvideFluidHandleContext {
     /**
@@ -530,10 +587,14 @@ export declare interface IFluidHandleContext extends IProvideFluidHandleContext
     resolveHandle(request: IRequest): Promise<IResponse>;
 }
 
+/**
+ * @alpha
+ */
 export declare const IFluidLoadable: keyof IProvideFluidLoadable;
 
 /**
  * A shared FluidObject has a URL from which it can be referenced
+ * @alpha
  */
 export declare interface IFluidLoadable extends IProvideFluidLoadable {
     handle: IFluidHandle;
@@ -547,6 +608,7 @@ export declare interface IFluidLoadable extends IProvideFluidLoadable {
  *
  * @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackage}
  * to have code loading modules in same package.
+ * @internal
  */
 export declare interface IFluidPackage {
     /**
@@ -576,6 +638,7 @@ export declare interface IFluidPackage {
  *
  * @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackageEnvironment}
  * to have code loading modules in same package.
+ * @internal
  */
 export declare interface IFluidPackageEnvironment {
     /**
@@ -600,18 +663,26 @@ 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
+ * @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
+ * @alpha
  */
 export declare interface IFluidRouter extends IProvideFluidRouter {
     request(request: IRequest): Promise<IResponse>;
 }
 
+/**
+ * @internal
+ */
 export declare const IFluidRunnable: keyof IProvideFluidRunnable;
 
+/**
+ * @internal
+ */
 export declare interface IFluidRunnable {
     run(...args: any[]): Promise<void>;
     stop(reason?: string): void;
@@ -619,6 +690,7 @@ export declare interface IFluidRunnable {
 
 /**
  * Generic wrapper for an unrecognized/uncategorized error object
+ * @internal
  */
 export declare interface IGenericError extends IErrorBase {
     /**
@@ -630,6 +702,7 @@ export declare interface IGenericError extends IErrorBase {
 
 /**
  * An error object that supports exporting its properties to be logged to telemetry
+ * @internal
  */
 export declare interface ILoggingError extends Error {
     /**
@@ -641,19 +714,29 @@ export declare interface ILoggingError extends Error {
 /**
  * @deprecated in favor of {@link @fluidframework/container-definitions#IProvideFluidCodeDetailsComparer}
  * to have code loading modules in same package.
+ * @internal
  */
 export declare interface IProvideFluidCodeDetailsComparer {
     readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer;
 }
 
+/**
+ * @alpha
+ */
 export declare interface IProvideFluidHandle {
     readonly IFluidHandle: IFluidHandle;
 }
 
+/**
+ * @alpha
+ */
 export declare interface IProvideFluidHandleContext {
     readonly IFluidHandleContext: IFluidHandleContext;
 }
 
+/**
+ * @alpha
+ */
 export declare interface IProvideFluidLoadable {
     readonly IFluidLoadable: IFluidLoadable;
 }
@@ -661,24 +744,37 @@ 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
+ * @alpha
  */
 export declare interface IProvideFluidRouter {
     readonly IFluidRouter: IFluidRouter;
 }
 
+/**
+ * @internal
+ */
 export declare interface IProvideFluidRunnable {
     readonly IFluidRunnable: IFluidRunnable;
 }
 
+/**
+ * @alpha
+ */
 export declare interface IRequest {
     url: string;
     headers?: IRequestHeader;
 }
 
+/**
+ * @alpha
+ */
 export declare interface IRequestHeader {
     [index: string]: any;
 }
 
+/**
+ * @alpha
+ */
 export declare interface IResponse {
     mimeType: string;
     status: number;
@@ -692,6 +788,7 @@ export declare interface IResponse {
 /**
  * @deprecated in favor of {@link @fluidframework/container-definitions#isFluidCodeDetails}
  * to have code loading modules in same package.
+ * @internal
  */
 export declare const isFluidCodeDetails: (details: unknown) => details is Readonly<IFluidCodeDetails>;
 
@@ -702,6 +799,7 @@ export declare const isFluidCodeDetails: (details: unknown) => details is Readon
  * to have code loading modules in same package.
  *
  * @param pkg - The package json data to check if it is a Fluid package.
+ * @internal
  */
 export declare const isFluidPackage: (pkg: unknown) => pkg is Readonly<IFluidPackage>;
 
@@ -709,6 +807,7 @@ export declare const isFluidPackage: (pkg: unknown) => pkg is Readonly<IFluidPac
  * @see {@link Tagged} for info on tagging
  *
  * @deprecated Use Tagged\<TelemetryBaseEventPropertyType\>
+ * @internal
  */
 export declare interface ITaggedTelemetryPropertyType {
     value: TelemetryEventPropertyType;
@@ -720,6 +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.
+ * @alpha
  */
 export declare interface ITelemetryBaseEvent extends ITelemetryBaseProperties {
     category: string;
@@ -729,6 +829,7 @@ export declare interface ITelemetryBaseEvent extends ITelemetryBaseProperties {
 /**
  * Interface to output telemetry events.
  * Implemented by hosting app / loader
+ * @alpha
  */
 export declare interface ITelemetryBaseLogger {
     send(event: ITelemetryBaseEvent, logLevel?: LogLevel): void;
@@ -737,6 +838,7 @@ export declare interface ITelemetryBaseLogger {
 
 /**
  * JSON-serializable properties, which will be logged with telemetry.
+ * @alpha
  */
 export declare type ITelemetryBaseProperties = ITelemetryProperties;
 
@@ -746,6 +848,7 @@ export declare type ITelemetryBaseProperties = ITelemetryProperties;
  *
  * @deprecated For internal use within FluidFramework, use ITelemetryErrorEventExt in \@fluidframework/telemetry-utils.
  * No replacement intended for FluidFramework consumers.
+ * @alpha
  */
 export declare interface ITelemetryErrorEvent extends ITelemetryProperties {
     eventName: string;
@@ -757,6 +860,7 @@ export declare interface ITelemetryErrorEvent extends ITelemetryProperties {
  *
  * @deprecated For internal use within FluidFramework, use ITelemetryGenericEventExt in \@fluidframework/telemetry-utils.
  * No replacement intended for FluidFramework consumers.
+ * @alpha
  */
 export declare interface ITelemetryGenericEvent extends ITelemetryProperties {
     eventName: string;
@@ -770,6 +874,7 @@ export declare interface ITelemetryGenericEvent extends ITelemetryProperties {
  *
  * @deprecated For internal use within FluidFramework, use ITelemetryLoggerExt in \@fluidframework/telemetry-utils.
  * No replacement intended for FluidFramework consumers.
+ * @alpha
  */
 export declare interface ITelemetryLogger extends ITelemetryBaseLogger {
     /**
@@ -807,6 +912,7 @@ export declare interface ITelemetryLogger extends ITelemetryBaseLogger {
  *
  * @deprecated For internal use within FluidFramework, use ITelemetryPerformanceEventExt in \@fluidframework/telemetry-utils.
  * No replacement intended for FluidFramework consumers.
+ * @alpha
  */
 export declare interface ITelemetryPerformanceEvent extends ITelemetryGenericEvent {
     duration?: number;
@@ -816,6 +922,7 @@ export declare interface ITelemetryPerformanceEvent extends ITelemetryGenericEve
  * {@inheritDoc ITelemetryBaseProperties}
  *
  * @deprecated Renamed to {@link ITelemetryBaseProperties}
+ * @alpha
  */
 export declare interface ITelemetryProperties {
     [index: string]: TelemetryEventPropertyType | Tagged<TelemetryEventPropertyType>;
@@ -823,6 +930,7 @@ export declare interface ITelemetryProperties {
 
 /**
  * Warning emitted when requests to storage are being throttled
+ * @internal
  */
 export declare interface IThrottlingWarning extends IErrorBase {
     /**
@@ -834,6 +942,7 @@ export declare interface IThrottlingWarning extends IErrorBase {
 
 /**
  * Error indicating an API is being used improperly resulting in an invalid operation.
+ * @internal
  */
 export declare interface IUsageError extends IErrorBase {
     /**
@@ -844,6 +953,7 @@ export declare interface IUsageError extends IErrorBase {
 
 /**
  * Specify levels of the logs.
+ * @alpha
  */
 export declare const LogLevel: {
     readonly verbose: 10;
@@ -853,11 +963,13 @@ export declare const LogLevel: {
 
 /**
  * Specify a level to the log to filter out logs based on the level.
+ * @alpha
  */
 export declare type LogLevel = (typeof LogLevel)[keyof typeof LogLevel];
 
 /**
  * Does the type replacement by changing types of {@link IEventThisPlaceHolder} to `TThis`
+ * @alpha
  */
 export declare type ReplaceIEventThisPlaceHolder<L extends any[], TThis> = L extends any[] ? {
     [K in keyof L]: L[K] extends IEventThisPlaceHolder ? TThis : L[K];
@@ -869,6 +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.
+ * @alpha
  */
 export declare interface Tagged<V, T extends string = string> {
     value: V;
@@ -881,6 +994,7 @@ export declare interface Tagged<V, T extends string = string> {
  * @remarks Logging entire objects is considered extremely dangerous from a telemetry point of view because people can
  * easily add fields to objects that shouldn't be logged and not realize it's going to be logged.
  * General best practice is to explicitly log the fields you care about from objects.
+ * @internal
  */
 export declare type TelemetryBaseEventPropertyType = TelemetryEventPropertyType;
 
@@ -888,6 +1002,7 @@ export declare type TelemetryBaseEventPropertyType = TelemetryEventPropertyType;
  * Examples of known categories, however category can be any string for extensibility.
  *
  * @deprecated Moved to \@fluidframework/telemetry-utils package
+ * @alpha
  */
 export declare type TelemetryEventCategory = "generic" | "error" | "performance";
 
@@ -895,12 +1010,14 @@ export declare type TelemetryEventCategory = "generic" | "error" | "performance"
  * {@inheritDoc TelemetryBaseEventPropertyType}
  *
  * @deprecated Renamed to {@link TelemetryBaseEventPropertyType}
+ * @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
+ * @alpha
  */
 export declare type TransformedEvent<TThis, E, A extends any[]> = (event: E, listener: (...args: ReplaceIEventThisPlaceHolder<A, TThis>) => void) => TThis;
 

package/lib/disposable.d.ts

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

package/lib/disposable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"disposable.d.ts","sourceRoot":"","sources":["../src/disposable.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,WAAW,WAAW;IAC3B;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAE3B;;;;OAIG;IACH,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;CAC7B"}
+{"version":3,"file":"disposable.d.ts","sourceRoot":"","sources":["../src/disposable.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAE3B;;;;OAIG;IACH,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;CAC7B"}

package/lib/disposable.js

@@ -1,6 +1,7 @@
+"use strict";
 /*!
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export {};
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=disposable.js.map

package/lib/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 */\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/lib/error.d.ts

@@ -5,6 +5,7 @@
 import { ITelemetryBaseProperties } from "./index";
 /**
  * Error types the Fluid Framework may report.
+ * @internal
  */
 export declare const FluidErrorTypes: {
     /**
@@ -28,6 +29,9 @@ export declare const FluidErrorTypes: {
      */
     readonly usageError: "usageError";
 };
+/**
+ * @internal
+ */
 export type FluidErrorTypes = (typeof FluidErrorTypes)[keyof typeof FluidErrorTypes];
 /**
  * Base interface for all errors and warnings emitted the container.
@@ -38,6 +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.
+ *
+ * @alpha
  */
 export interface IErrorBase extends Partial<Error> {
     /**
@@ -75,6 +81,7 @@ export interface IErrorBase extends Partial<Error> {
 }
 /**
  * Generic wrapper for an unrecognized/uncategorized error object
+ * @internal
  */
 export interface IGenericError extends IErrorBase {
     /**
@@ -85,6 +92,7 @@ export interface IGenericError extends IErrorBase {
 }
 /**
  * Error indicating an API is being used improperly resulting in an invalid operation.
+ * @internal
  */
 export interface IUsageError extends IErrorBase {
     /**
@@ -94,6 +102,7 @@ export interface IUsageError extends IErrorBase {
 }
 /**
  * Warning emitted when requests to storage are being throttled
+ * @internal
  */
 export interface IThrottlingWarning extends IErrorBase {
     /**

package/lib/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;;GAEG;AACH,eAAO,MAAM,eAAe;IAC3B;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;CAEM,CAAC;AACX,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,OAAO,eAAe,CAAC,CAAC;AAErF;;;;;;;;;GASG;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;;GAEG;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;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC9C;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,OAAO,eAAe,CAAC,UAAU,CAAC;CACtD;AAED;;GAEG;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/lib/error.js

@@ -1,11 +1,15 @@
+"use strict";
 /*!
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FluidErrorTypes = void 0;
 /**
  * Error types the Fluid Framework may report.
+ * @internal
  */
-export const FluidErrorTypes = {
+exports.FluidErrorTypes = {
     /**
      * Some error, most likely an exception caught by runtime and propagated to container as critical error
      */

package/lib/error.js.map

@@ -1 +1 @@
-{"version":3,"file":"error.js","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,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 */\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;\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 */\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 */\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 */\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 */\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/lib/events.d.ts

@@ -4,6 +4,7 @@
  */
 /**
  * Base interface for event emitters.
+ * @alpha
  */
 export interface IEvent {
     /**
@@ -20,6 +21,7 @@ export interface IEvent {
 }
 /**
  * Base interface for error event emitters.
+ * @alpha
  */
 export interface IErrorEvent extends IEvent {
     /**
@@ -31,6 +33,7 @@ export interface IErrorEvent extends IEvent {
 }
 /**
  * Base interface for event providers.
+ * @alpha
  */
 export interface IEventProvider<TEvent extends IEvent> {
     /**
@@ -68,17 +71,19 @@ export interface IEventProvider<TEvent extends IEvent> {
  * ```
  *
  * interface B will now extend interface A and its events
- *
+ * @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.
+ * @alpha
  */
 export type IEventThisPlaceHolder = {
     thisPlaceHolder: "thisPlaceHolder";
 };
 /**
  * Does the type replacement by changing types of {@link IEventThisPlaceHolder} to `TThis`
+ * @alpha
  */
 export type ReplaceIEventThisPlaceHolder<L extends any[], TThis> = L extends any[] ? {
     [K in keyof L]: L[K] extends IEventThisPlaceHolder ? TThis : L[K];
@@ -86,6 +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
+ * @alpha
  */
 export type TransformedEvent<TThis, E, A extends any[]> = (event: E, listener: (...args: ReplaceIEventThisPlaceHolder<A, TThis>) => void) => TThis;
 /**
@@ -96,6 +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}`
+ * @alpha
  */
 export type IEventTransformer<TThis, TEvent extends IEvent> = TEvent extends {
     (event: infer E0, listener: (...args: infer A0) => void): any;