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

package/src/fluidPackage.ts

@@ -8,6 +8,7 @@
  *
  * @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackageEnvironment}
  * to have code loading modules in same package.
+ * @internal
  */
 export interface IFluidPackageEnvironment {
 	/**
@@ -41,6 +42,7 @@ export interface IFluidPackageEnvironment {
  *
  * @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackage}
  * to have code loading modules in same package.
+ * @internal
  */
 export interface IFluidPackage {
 	/**
@@ -72,6 +74,7 @@ export interface IFluidPackage {
  * to have code loading modules in same package.
  *
  * @param pkg - The package json data to check if it is a Fluid package.
+ * @internal
  */
 export const isFluidPackage = (pkg: unknown): pkg is Readonly<IFluidPackage> =>
 	typeof pkg === "object" &&
@@ -83,6 +86,7 @@ export const isFluidPackage = (pkg: unknown): pkg is Readonly<IFluidPackage> =>
  *
  * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsConfig}
  * to have code loading modules in same package.
+ * @internal
  */
 export interface IFluidCodeDetailsConfig {
 	readonly [key: string]: string;
@@ -93,6 +97,7 @@ export interface IFluidCodeDetailsConfig {
  *
  * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetails}
  * to have code loading modules in same package.
+ * @internal
  */
 export interface IFluidCodeDetails {
 	/**
@@ -111,6 +116,7 @@ export interface IFluidCodeDetails {
 /**
  * @deprecated in favor of {@link @fluidframework/container-definitions#isFluidCodeDetails}
  * to have code loading modules in same package.
+ * @internal
  */
 export const isFluidCodeDetails = (details: unknown): details is Readonly<IFluidCodeDetails> => {
 	const maybeCodeDetails = details as Partial<IFluidCodeDetails> | undefined;
@@ -125,6 +131,7 @@ export const isFluidCodeDetails = (details: unknown): details is Readonly<IFluid
 /**
  * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsComparer}
  * to have code loading modules in same package.
+ * @internal
  */
 export const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer =
 	"IFluidCodeDetailsComparer";
@@ -132,6 +139,7 @@ export const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer =
 /**
  * @deprecated in favor of {@link @fluidframework/container-definitions#IProvideFluidCodeDetailsComparer}
  * to have code loading modules in same package.
+ * @internal
  */
 export interface IProvideFluidCodeDetailsComparer {
 	readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer;
@@ -142,6 +150,7 @@ export interface IProvideFluidCodeDetailsComparer {
  *
  * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsComparer}
  * to have code loading modules in same package.
+ * @internal
  */
 export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsComparer {
 	/**

package/src/fluidRouter.ts

@@ -3,17 +3,26 @@
  * Licensed under the MIT License.
  */
 
+/**
+ * @alpha
+ */
 export interface IRequestHeader {
 	// TODO: Use `unknown` instead (API-Breaking)
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	[index: string]: any;
 }
 
+/**
+ * @alpha
+ */
 export interface IRequest {
 	url: string;
 	headers?: IRequestHeader;
 }
 
+/**
+ * @alpha
+ */
 export interface IResponse {
 	mimeType: string;
 	status: number;
@@ -25,23 +34,3 @@ export interface IResponse {
 	headers?: { [key: string]: any };
 	stack?: string;
 }
-
-/**
- * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
- */
-export const IFluidRouter: keyof IProvideFluidRouter = "IFluidRouter";
-
-/**
- * Request routing
- * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
- */
-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
- */
-export interface IFluidRouter extends IProvideFluidRouter {
-	request(request: IRequest): Promise<IResponse>;
-}

package/src/handles.ts

@@ -7,14 +7,21 @@ import { IRequest, IResponse } from "./fluidRouter";
 import { IFluidLoadable } from "./fluidLoadable";
 import { FluidObject } from "./provider";
 
+/**
+ * @alpha
+ */
 export const IFluidHandleContext: keyof IProvideFluidHandleContext = "IFluidHandleContext";
 
+/**
+ * @alpha
+ */
 export interface IProvideFluidHandleContext {
 	readonly IFluidHandleContext: IFluidHandleContext;
 }
 
 /**
  * Describes a routing context from which other `IFluidHandleContext`s are defined.
+ * @alpha
  */
 export interface IFluidHandleContext extends IProvideFluidHandleContext {
 	/**
@@ -41,14 +48,21 @@ export interface IFluidHandleContext extends IProvideFluidHandleContext {
 	resolveHandle(request: IRequest): Promise<IResponse>;
 }
 
+/**
+ * @alpha
+ */
 export const IFluidHandle: keyof IProvideFluidHandle = "IFluidHandle";
 
+/**
+ * @alpha
+ */
 export interface IProvideFluidHandle {
 	readonly IFluidHandle: IFluidHandle;
 }
 
 /**
  * Handle to a shared {@link FluidObject}.
+ * @alpha
  */
 export interface IFluidHandle<
 	// REVIEW: Constrain `T` to something? How do we support dds and datastores safely?

package/src/index.ts

@@ -45,13 +45,7 @@ export {
 // TypeScript forgets the index signature when customers augment IRequestHeader if we export *.
 // So we export the explicit members as a workaround:
 // https://github.com/microsoft/TypeScript/issues/18877#issuecomment-476921038
-export {
-	IRequest,
-	IRequestHeader,
-	IResponse,
-	IProvideFluidRouter,
-	IFluidRouter,
-} from "./fluidRouter";
+export { IRequest, IRequestHeader, IResponse } from "./fluidRouter";
 
 export {
 	IFluidHandleContext,
@@ -78,3 +72,4 @@ export type {
 } from "./logger";
 export { LogLevel } from "./logger";
 export { FluidObjectProviderKeys, FluidObject, FluidObjectKeys } from "./provider";
+export { ConfigTypes, IConfigProviderBase } from "./config";

package/src/logger.ts

@@ -7,6 +7,7 @@
  * Examples of known categories, however category can be any string for extensibility.
  *
  * @deprecated Moved to \@fluidframework/telemetry-utils package
+ * @alpha
  */
 export type TelemetryEventCategory = "generic" | "error" | "performance";
 
@@ -16,6 +17,7 @@ export type TelemetryEventCategory = "generic" | "error" | "performance";
  * @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 type TelemetryBaseEventPropertyType = TelemetryEventPropertyType;
 
@@ -23,6 +25,7 @@ export type TelemetryBaseEventPropertyType = TelemetryEventPropertyType;
  * {@inheritDoc TelemetryBaseEventPropertyType}
  *
  * @deprecated Renamed to {@link TelemetryBaseEventPropertyType}
+ * @alpha
  */
 export type TelemetryEventPropertyType = string | number | boolean | undefined;
 
@@ -32,6 +35,7 @@ export type TelemetryEventPropertyType = string | number | boolean | undefined;
  *
  * 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 interface Tagged<V, T extends string = string> {
 	value: V;
@@ -42,6 +46,7 @@ export interface Tagged<V, T extends string = string> {
  * @see {@link Tagged} for info on tagging
  *
  * @deprecated Use Tagged\<TelemetryBaseEventPropertyType\>
+ * @internal
  */
 export interface ITaggedTelemetryPropertyType {
 	value: TelemetryEventPropertyType;
@@ -50,6 +55,7 @@ export interface ITaggedTelemetryPropertyType {
 
 /**
  * JSON-serializable properties, which will be logged with telemetry.
+ * @alpha
  */
 export type ITelemetryBaseProperties = ITelemetryProperties;
 
@@ -57,6 +63,7 @@ export type ITelemetryBaseProperties = ITelemetryProperties;
  * {@inheritDoc ITelemetryBaseProperties}
  *
  * @deprecated Renamed to {@link ITelemetryBaseProperties}
+ * @alpha
  */
 export interface ITelemetryProperties {
 	[index: string]: TelemetryEventPropertyType | Tagged<TelemetryEventPropertyType>;
@@ -67,6 +74,7 @@ export interface ITelemetryProperties {
  * 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 interface ITelemetryBaseEvent extends ITelemetryBaseProperties {
 	category: string;
@@ -75,6 +83,7 @@ export interface ITelemetryBaseEvent extends ITelemetryBaseProperties {
 
 /**
  * Specify levels of the logs.
+ * @alpha
  */
 export const LogLevel = {
 	verbose: 10, // To log any verbose event for example when you are debugging something.
@@ -84,12 +93,14 @@ export const LogLevel = {
 
 /**
  * Specify a level to the log to filter out logs based on the level.
+ * @alpha
  */
 export type LogLevel = (typeof LogLevel)[keyof typeof LogLevel];
 
 /**
  * Interface to output telemetry events.
  * Implemented by hosting app / loader
+ * @alpha
  */
 export interface ITelemetryBaseLogger {
 	send(event: ITelemetryBaseEvent, logLevel?: LogLevel): void;
@@ -103,6 +114,7 @@ export interface ITelemetryBaseLogger {
  *
  * @deprecated For internal use within FluidFramework, use ITelemetryGenericEventExt in \@fluidframework/telemetry-utils.
  * No replacement intended for FluidFramework consumers.
+ * @alpha
  */
 export interface ITelemetryGenericEvent extends ITelemetryProperties {
 	eventName: string;
@@ -115,6 +127,7 @@ export interface ITelemetryGenericEvent extends ITelemetryProperties {
  *
  * @deprecated For internal use within FluidFramework, use ITelemetryErrorEventExt in \@fluidframework/telemetry-utils.
  * No replacement intended for FluidFramework consumers.
+ * @alpha
  */
 export interface ITelemetryErrorEvent extends ITelemetryProperties {
 	eventName: string;
@@ -126,6 +139,7 @@ export interface ITelemetryErrorEvent extends ITelemetryProperties {
  *
  * @deprecated For internal use within FluidFramework, use ITelemetryPerformanceEventExt in \@fluidframework/telemetry-utils.
  * No replacement intended for FluidFramework consumers.
+ * @alpha
  */
 export interface ITelemetryPerformanceEvent extends ITelemetryGenericEvent {
 	duration?: number; // Duration of event (optional)
@@ -133,6 +147,7 @@ export interface ITelemetryPerformanceEvent extends ITelemetryGenericEvent {
 
 /**
  * An error object that supports exporting its properties to be logged to telemetry
+ * @internal
  */
 export interface ILoggingError extends Error {
 	/**
@@ -148,6 +163,7 @@ export interface ILoggingError extends Error {
  *
  * @deprecated For internal use within FluidFramework, use ITelemetryLoggerExt in \@fluidframework/telemetry-utils.
  * No replacement intended for FluidFramework consumers.
+ * @alpha
  */
 export interface ITelemetryLogger extends ITelemetryBaseLogger {
 	/**

package/src/provider.ts

@@ -27,6 +27,7 @@
  *
  * This pattern enables discovery, and delegation in a standard way which is central
  * to FluidObject pattern.
+ * @alpha
  */
 export type FluidObjectProviderKeys<T, TProp extends keyof T = keyof T> = string extends TProp
 	? never
@@ -69,7 +70,7 @@ export type FluidObjectProviderKeys<T, TProp extends keyof T = keyof T> = string
  *
  * You can inspect multiple types via a intersection. For example:
  * `FluidObject<IFoo & IBar>`
- *
+ * @alpha
  */
 export type FluidObject<T = unknown> = {
 	[P in FluidObjectProviderKeys<T>]?: T[P];
@@ -82,6 +83,6 @@ export type FluidObject<T = unknown> = {
  * See {@link FluidObject}
  *
  * For example `FluidObjectKeys<IFoo & IBar>` would result in `"IFoo" | "IBar"`
- *
+ * @alpha
  */
 export type FluidObjectKeys<T> = keyof FluidObject<T>;