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

package/api-report/core-interfaces.api.md

@@ -4,7 +4,10 @@
 
 ```ts
 
-// @internal
+// @alpha
+export type ConfigTypes = string | number | boolean | number[] | string[] | boolean[] | undefined;
+
+// @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>;
 
 // @internal
@@ -19,24 +22,29 @@ export const FluidErrorTypes: {
 // @internal (undocumented)
 export type FluidErrorTypes = (typeof FluidErrorTypes)[keyof typeof FluidErrorTypes];
 
-// @internal
+// @alpha
 export type FluidObject<T = unknown> = {
     [P in FluidObjectProviderKeys<T>]?: T[P];
 };
 
-// @internal
+// @alpha
 export type FluidObjectKeys<T> = keyof FluidObject<T>;
 
-// @internal
+// @alpha
 export 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;
 
-// @internal
+// @alpha
+export interface IConfigProviderBase {
+    getRawConfig(name: string): ConfigTypes;
+}
+
+// @alpha
 export interface IDisposable {
     dispose(error?: Error): void;
     readonly disposed: boolean;
 }
 
-// @internal
+// @alpha
 export interface IErrorBase extends Partial<Error> {
     readonly errorType: string;
     getTelemetryProperties?(): ITelemetryBaseProperties;
@@ -45,31 +53,31 @@ export interface IErrorBase extends Partial<Error> {
     readonly stack?: string;
 }
 
-// @internal
+// @alpha
 export interface IErrorEvent extends IEvent {
     // @eventProperty
     (event: "error", listener: (message: any) => void): any;
 }
 
-// @internal
+// @alpha
 export interface IEvent {
     // @eventProperty
     (event: string, listener: (...args: any[]) => void): any;
 }
 
-// @internal
+// @alpha
 export interface IEventProvider<TEvent extends IEvent> {
     readonly off: IEventTransformer<this, TEvent>;
     readonly on: IEventTransformer<this, TEvent>;
     readonly once: IEventTransformer<this, TEvent>;
 }
 
-// @internal
+// @alpha
 export type IEventThisPlaceHolder = {
     thisPlaceHolder: "thisPlaceHolder";
 };
 
-// @internal
+// @alpha
 export type IEventTransformer<TThis, TEvent extends IEvent> = TEvent extends {
     (event: infer E0, listener: (...args: infer A0) => void): any;
     (event: infer E1, listener: (...args: infer A1) => void): any;
@@ -243,10 +251,10 @@ export interface IFluidCodeDetailsConfig {
     readonly [key: string]: string;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export const IFluidHandle: keyof IProvideFluidHandle;
 
-// @internal
+// @alpha
 export interface IFluidHandle<T = FluidObject & IFluidLoadable> extends IProvideFluidHandle {
     // @deprecated (undocumented)
     readonly absolutePath: string;
@@ -258,10 +266,10 @@ export interface IFluidHandle<T = FluidObject & IFluidLoadable> extends IProvide
     readonly isAttached: boolean;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export const IFluidHandleContext: keyof IProvideFluidHandleContext;
 
-// @internal
+// @alpha
 export interface IFluidHandleContext extends IProvideFluidHandleContext {
     readonly absolutePath: string;
     attachGraph(): void;
@@ -271,10 +279,10 @@ export interface IFluidHandleContext extends IProvideFluidHandleContext {
     readonly routeContext?: IFluidHandleContext;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export const IFluidLoadable: keyof IProvideFluidLoadable;
 
-// @internal
+// @alpha
 export interface IFluidLoadable extends IProvideFluidLoadable {
     // (undocumented)
     handle: IFluidHandle;
@@ -297,10 +305,10 @@ export interface IFluidPackageEnvironment {
     };
 }
 
-// @internal @deprecated (undocumented)
+// @alpha @deprecated (undocumented)
 export const IFluidRouter: keyof IProvideFluidRouter;
 
-// @internal @deprecated (undocumented)
+// @alpha @deprecated (undocumented)
 export interface IFluidRouter extends IProvideFluidRouter {
     // (undocumented)
     request(request: IRequest): Promise<IResponse>;
@@ -335,25 +343,25 @@ export interface IProvideFluidCodeDetailsComparer {
     readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IProvideFluidHandle {
     // (undocumented)
     readonly IFluidHandle: IFluidHandle;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IProvideFluidHandleContext {
     // (undocumented)
     readonly IFluidHandleContext: IFluidHandleContext;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IProvideFluidLoadable {
     // (undocumented)
     readonly IFluidLoadable: IFluidLoadable;
 }
 
-// @internal @deprecated
+// @alpha @deprecated
 export interface IProvideFluidRouter {
     // (undocumented)
     readonly IFluidRouter: IFluidRouter;
@@ -365,7 +373,7 @@ export interface IProvideFluidRunnable {
     readonly IFluidRunnable: IFluidRunnable;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IRequest {
     // (undocumented)
     headers?: IRequestHeader;
@@ -373,13 +381,13 @@ export interface IRequest {
     url: string;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IRequestHeader {
     // (undocumented)
     [index: string]: any;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IResponse {
     // (undocumented)
     headers?: {
@@ -409,7 +417,7 @@ export interface ITaggedTelemetryPropertyType {
     value: TelemetryEventPropertyType;
 }
 
-// @internal
+// @alpha
 export interface ITelemetryBaseEvent extends ITelemetryBaseProperties {
     // (undocumented)
     category: string;
@@ -417,7 +425,7 @@ export interface ITelemetryBaseEvent extends ITelemetryBaseProperties {
     eventName: string;
 }
 
-// @internal
+// @alpha
 export interface ITelemetryBaseLogger {
     // (undocumented)
     minLogLevel?: LogLevel;
@@ -425,16 +433,16 @@ export interface ITelemetryBaseLogger {
     send(event: ITelemetryBaseEvent, logLevel?: LogLevel): void;
 }
 
-// @internal
+// @alpha
 export type ITelemetryBaseProperties = ITelemetryProperties;
 
-// @internal @deprecated
+// @alpha @deprecated
 export interface ITelemetryErrorEvent extends ITelemetryProperties {
     // (undocumented)
     eventName: string;
 }
 
-// @internal @deprecated
+// @alpha @deprecated
 export interface ITelemetryGenericEvent extends ITelemetryProperties {
     // (undocumented)
     category?: TelemetryEventCategory;
@@ -442,7 +450,7 @@ export interface ITelemetryGenericEvent extends ITelemetryProperties {
     eventName: string;
 }
 
-// @internal @deprecated
+// @alpha @deprecated
 export interface ITelemetryLogger extends ITelemetryBaseLogger {
     send(event: ITelemetryBaseEvent, logLevel?: LogLevel): void;
     sendErrorEvent(event: ITelemetryErrorEvent, error?: any): void;
@@ -450,13 +458,13 @@ export interface ITelemetryLogger extends ITelemetryBaseLogger {
     sendTelemetryEvent(event: ITelemetryGenericEvent, error?: any, logLevel?: typeof LogLevel.verbose | typeof LogLevel.default): void;
 }
 
-// @internal @deprecated
+// @alpha @deprecated
 export interface ITelemetryPerformanceEvent extends ITelemetryGenericEvent {
     // (undocumented)
     duration?: number;
 }
 
-// @internal @deprecated
+// @alpha @deprecated
 export interface ITelemetryProperties {
     // (undocumented)
     [index: string]: TelemetryEventPropertyType | Tagged<TelemetryEventPropertyType>;
@@ -474,22 +482,22 @@ export interface IUsageError extends IErrorBase {
     readonly errorType: typeof FluidErrorTypes.usageError;
 }
 
-// @internal
+// @alpha
 export const LogLevel: {
     readonly verbose: 10;
     readonly default: 20;
     readonly error: 30;
 };
 
-// @internal
+// @alpha
 export type LogLevel = (typeof LogLevel)[keyof typeof LogLevel];
 
-// @internal
+// @alpha
 export type ReplaceIEventThisPlaceHolder<L extends any[], TThis> = L extends any[] ? {
     [K in keyof L]: L[K] extends IEventThisPlaceHolder ? TThis : L[K];
 } : L;
 
-// @internal
+// @alpha
 export interface Tagged<V, T extends string = string> {
     // (undocumented)
     tag: T;
@@ -500,13 +508,13 @@ export interface Tagged<V, T extends string = string> {
 // @internal
 export type TelemetryBaseEventPropertyType = TelemetryEventPropertyType;
 
-// @internal @deprecated
+// @alpha @deprecated
 export type TelemetryEventCategory = "generic" | "error" | "performance";
 
-// @internal @deprecated
+// @alpha @deprecated
 export type TelemetryEventPropertyType = string | number | boolean | undefined;
 
-// @internal
+// @alpha
 export type TransformedEvent<TThis, E, A extends any[]> = (event: E, listener: (...args: ReplaceIEventThisPlaceHolder<A, TThis>) => void) => TThis;
 
 // (No @packageDocumentation comment for this package)

package/dist/config.d.ts

@@ -0,0 +1,35 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Types supported by {@link IConfigProviderBase}.
+ * @alpha
+ */
+export type ConfigTypes = string | number | boolean | number[] | string[] | boolean[] | undefined;
+/**
+ * Base interface for providing configurations to enable/disable/control features.
+ * @alpha
+ */
+export 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;
+}
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,OAAO,EAAE,GAAG,SAAS,CAAC;AAElG;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC;CACxC"}

package/dist/config.js

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

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.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 * Types supported by {@link IConfigProviderBase}.\n * @alpha\n */\nexport type ConfigTypes = string | number | boolean | number[] | string[] | boolean[] | undefined;\n\n/**\n * Base interface for providing configurations to enable/disable/control features.\n * @alpha\n */\nexport interface IConfigProviderBase {\n\t/**\n\t * For the specified config name this function gets the value.\n\t *\n\t * This type is meant be easy to implement by Fluid Framework consumers\n\t * so the returned valued needs minimal type coercion, and allows consumers to\n\t * return values in a natural way from whatever source they retrieve them.\n\t *\n\t * For instance a value of 1 maybe be returned as a string or a number.\n\t * For array types a json string or an object are allowable.\n\t *\n\t * It should return undefined if there is no value available for the config name.\n\t *\n\t * @param name - The name of the config to get the value for.\n\t *\n\t * @privateRemarks Generally, this type should only be taken as input, and be wrapped by an\n\t * internal monitoring context from the fluidframework/telemetry-utils package. That will provide\n\t * a wrapper with provides strongly typed access to values via consistent type coercion.\n\t */\n\tgetRawConfig(name: string): ConfigTypes;\n}\n"]}