@fluidframework/container-definitions 2.0.0-dev.2.3.0.115467 → 2.0.0-dev.3.1.0.125672

package/src/error.ts

@@ -9,77 +9,77 @@ import { ITelemetryProperties } from "@fluidframework/common-definitions";
  * Different error types the Container may report out to the Host
  */
 export enum ContainerErrorType {
-    /**
-     * Some error, most likely an exception caught by runtime and propagated to container as critical error
-     */
-    genericError = "genericError",
+	/**
+	 * Some error, most likely an exception caught by runtime and propagated to container as critical error
+	 */
+	genericError = "genericError",
 
-    /**
-     * Throttling error from server. Server is busy and is asking not to reconnect for some time
-     */
-    throttlingError = "throttlingError",
+	/**
+	 * Throttling error from server. Server is busy and is asking not to reconnect for some time
+	 */
+	throttlingError = "throttlingError",
 
-    /**
-     * Data loss error detected by Container / DeltaManager. Likely points to storage issue.
-     */
-    dataCorruptionError = "dataCorruptionError",
+	/**
+	 * Data loss error detected by Container / DeltaManager. Likely points to storage issue.
+	 */
+	dataCorruptionError = "dataCorruptionError",
 
-    /**
-     * Error encountered when processing an operation. May correlate with data corruption.
-     */
-    dataProcessingError = "dataProcessingError",
+	/**
+	 * Error encountered when processing an operation. May correlate with data corruption.
+	 */
+	dataProcessingError = "dataProcessingError",
 
-    /**
-     * Error indicating an API is being used improperly resulting in an invalid operation.
-     */
-    usageError = "usageError",
+	/**
+	 * Error indicating an API is being used improperly resulting in an invalid operation.
+	 */
+	usageError = "usageError",
 
-    /**
-     * Error indicating an client session has expired. Currently this only happens when GC is allowed on a document and
-     * aids in safely deleting unused objects.
-     */
-    clientSessionExpiredError = "clientSessionExpiredError",
+	/**
+	 * Error indicating an client session has expired. Currently this only happens when GC is allowed on a document and
+	 * aids in safely deleting unused objects.
+	 */
+	clientSessionExpiredError = "clientSessionExpiredError",
 }
 
 /**
  * Base interface for all errors and warnings at container level
  */
 export interface IErrorBase extends Partial<Error> {
-    /** errorType is a union of error types from
-     * - container
-     * - runtime
-     * - drivers
-     */
-    readonly errorType: string;
+	/** errorType is a union of error types from
+	 * - container
+	 * - runtime
+	 * - drivers
+	 */
+	readonly errorType: string;
 
-    /**
-     * See Error.message
-     * Privacy Note - This is a freeform string that we may not control in all cases (e.g. a dependency throws an error)
-     * If there are known cases where this contains privacy-sensitive data it will be tagged and included in the result
-     * of getTelemetryProperties. When logging, consider fetching it that way rather than straight from this field.
-     */
-    readonly message: string;
-    /** See Error.name */
-    readonly name?: string;
-    /** See Error.stack */
-    readonly stack?: string;
-    /**
-     * Returns all properties of this error object that are either safe to log
-     * or explicitly tagged as containing privacy-sensitive data.
-     */
-    getTelemetryProperties?(): ITelemetryProperties;
+	/**
+	 * See Error.message
+	 * Privacy Note - This is a freeform string that we may not control in all cases (e.g. a dependency throws an error)
+	 * If there are known cases where this contains privacy-sensitive data it will be tagged and included in the result
+	 * of getTelemetryProperties. When logging, consider fetching it that way rather than straight from this field.
+	 */
+	readonly message: string;
+	/** See Error.name */
+	readonly name?: string;
+	/** See Error.stack */
+	readonly stack?: string;
+	/**
+	 * Returns all properties of this error object that are either safe to log
+	 * or explicitly tagged as containing privacy-sensitive data.
+	 */
+	getTelemetryProperties?(): ITelemetryProperties;
 }
 
 /**
  * Represents warnings raised on container.
  */
 export interface ContainerWarning extends IErrorBase {
-    /**
-     * Whether this error has already been logged. Used to avoid logging errors twice.
-     *
-     * @defaultValue `false`
-     */
-    logged?: boolean;
+	/**
+	 * Whether this error has already been logged. Used to avoid logging errors twice.
+	 *
+	 * @defaultValue `false`
+	 */
+	logged?: boolean;
 }
 
 /**
@@ -91,21 +91,21 @@ export type ICriticalContainerError = IErrorBase;
  * Generic wrapper for an unrecognized/uncategorized error object
  */
 export interface IGenericError extends IErrorBase {
-    readonly errorType: ContainerErrorType.genericError;
-    error?: any;
+	readonly errorType: ContainerErrorType.genericError;
+	error?: any;
 }
 
 /**
  * Error indicating an API is being used improperly resulting in an invalid operation.
  */
 export interface IUsageError extends IErrorBase {
-    readonly errorType: ContainerErrorType.usageError;
+	readonly errorType: ContainerErrorType.usageError;
 }
 
 /**
  * Warning emitted when requests to storage are being throttled
  */
 export interface IThrottlingWarning extends IErrorBase {
-    readonly errorType: ContainerErrorType.throttlingError;
-    readonly retryAfterSeconds: number;
+	readonly errorType: ContainerErrorType.throttlingError;
+	readonly retryAfterSeconds: number;
 }

package/src/fluidModule.ts

@@ -8,5 +8,5 @@ import { IProvideFluidCodeDetailsComparer } from "./fluidPackage";
 import { IRuntimeFactory } from "./runtime";
 
 export interface IFluidModule {
-    fluidExport: FluidObject<IRuntimeFactory & IProvideFluidCodeDetailsComparer>;
+	fluidExport: FluidObject<IRuntimeFactory & IProvideFluidCodeDetailsComparer>;
 }

package/src/fluidPackage.ts

@@ -7,26 +7,27 @@
  * Specifies an environment on Fluid property of a IFluidPackage.
  */
 export interface IFluidPackageEnvironment {
+	/**
+	 * The name of the target. For a browser environment, this could be umd for scripts
+	 * or css for styles.
+	 */
+	[target: string]:
+		| undefined
+		| {
+				/**
+				 * List of files for the target. These can be relative or absolute.
+				 * The code loader should resolve relative paths, and validate all
+				 * full urls.
+				 */
+				files: string[];
 
-    /**
-     * The name of the target. For a browser environment, this could be umd for scripts
-     * or css for styles.
-     */
-    [target: string]: undefined | {
-        /**
-         * List of files for the target. These can be relative or absolute.
-         * The code loader should resolve relative paths, and validate all
-         * full urls.
-         */
-        files: string[];
-
-        /**
-         * General access for extended fields as specific usages will
-         * likely have additional infornamation like a definition
-         * of Library, the entrypoint for umd packages.
-         */
-        [key: string]: unknown;
-    };
+				/**
+				 * General access for extended fields as specific usages will
+				 * likely have additional infornamation like a definition
+				 * of Library, the entrypoint for umd packages.
+				 */
+				[key: string]: unknown;
+		  };
 }
 
 /**
@@ -36,26 +37,26 @@ export interface IFluidPackageEnvironment {
  * {@link https://stackoverflow.com/questions/10065564/add-custom-metadata-or-config-to-package-json-is-it-valid}
  */
 export interface IFluidPackage {
-    /**
-     * The name of the package that this code represnets
-     */
-    name: string;
-    /**
-     * This object represents the Fluid specific properties of the package
-     */
-    fluid: {
-        /**
-         * The name of the of the environment. This should be something like browser, or node
-         * and contain the necessary targets for loading this code in that environment.
-         */
-        [environment: string]: undefined | IFluidPackageEnvironment;
-    };
-    /**
-     * General access for extended fields as specific usages will
-     * likely have additional infornamation like a definition of
-     * compatible versions, or deployment information like rings or rollouts.
-     */
-    [key: string]: unknown;
+	/**
+	 * The name of the package that this code represnets
+	 */
+	name: string;
+	/**
+	 * This object represents the Fluid specific properties of the package
+	 */
+	fluid: {
+		/**
+		 * The name of the of the environment. This should be something like browser, or node
+		 * and contain the necessary targets for loading this code in that environment.
+		 */
+		[environment: string]: undefined | IFluidPackageEnvironment;
+	};
+	/**
+	 * General access for extended fields as specific usages will
+	 * likely have additional infornamation like a definition of
+	 * compatible versions, or deployment information like rings or rollouts.
+	 */
+	[key: string]: unknown;
 }
 
 /**
@@ -63,77 +64,76 @@ export interface IFluidPackage {
  * @param pkg - the package json data to check if it is a Fluid package.
  */
 export const isFluidPackage = (pkg: any): pkg is Readonly<IFluidPackage> =>
-    typeof pkg === "object"
-    && typeof pkg?.name === "string"
-    && typeof pkg?.fluid === "object";
+	typeof pkg === "object" && typeof pkg?.name === "string" && typeof pkg?.fluid === "object";
 
 /**
  * Package manager configuration. Provides a key value mapping of config values
  */
 export interface IFluidCodeDetailsConfig {
-    readonly [key: string]: string;
+	readonly [key: string]: string;
 }
 
 /**
  * Data structure used to describe the code to load on the Fluid document
  */
 export interface IFluidCodeDetails {
-    /**
-     * The code package to be used on the Fluid document. This is either the package name which will be loaded
-     * from a package manager. Or the expanded Fluid package.
-     */
-    readonly package: string | Readonly<IFluidPackage>;
+	/**
+	 * The code package to be used on the Fluid document. This is either the package name which will be loaded
+	 * from a package manager. Or the expanded Fluid package.
+	 */
+	readonly package: string | Readonly<IFluidPackage>;
 
-    /**
-     * Configuration details. This includes links to the package manager and base CDNs.
-     *
-     * @remarks This is strictly consumer-defined data.
-     * Its contents and semantics (including whether or not this data is present) are completely up to the consumer.
-     */
-    readonly config?: IFluidCodeDetailsConfig;
+	/**
+	 * Configuration details. This includes links to the package manager and base CDNs.
+	 *
+	 * @remarks This is strictly consumer-defined data.
+	 * Its contents and semantics (including whether or not this data is present) are completely up to the consumer.
+	 */
+	readonly config?: IFluidCodeDetailsConfig;
 }
 
 export const isFluidCodeDetails = (details: unknown): details is Readonly<IFluidCodeDetails> => {
-    const maybeCodeDetails = details as Partial<IFluidCodeDetails> | undefined;
-    return typeof maybeCodeDetails === "object"
-        && (typeof maybeCodeDetails?.package === "string" || isFluidPackage(maybeCodeDetails?.package))
-        && (maybeCodeDetails?.config === undefined || typeof maybeCodeDetails?.config === "object");
+	const maybeCodeDetails = details as Partial<IFluidCodeDetails> | undefined;
+	return (
+		typeof maybeCodeDetails === "object" &&
+		(typeof maybeCodeDetails?.package === "string" ||
+			isFluidPackage(maybeCodeDetails?.package)) &&
+		(maybeCodeDetails?.config === undefined || typeof maybeCodeDetails?.config === "object")
+	);
 };
 
-export const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer = "IFluidCodeDetailsComparer";
+export const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer =
+	"IFluidCodeDetailsComparer";
 
 export interface IProvideFluidCodeDetailsComparer {
-    readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer ;
+	readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer;
 }
 
 /**
  * Provides capability to compare Fluid code details.
  */
 export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsComparer {
+	/**
+	 * Determines if the `candidate` code details satisfy the constraints specified in `constraint` code details.
+	 *
+	 * Similar semantics to:
+	 * {@link https://github.com/npm/node-semver#usage}
+	 */
+	satisfies(candidate: IFluidCodeDetails, constraint: IFluidCodeDetails): Promise<boolean>;
 
-    /**
-     * Determines if the `candidate` code details satisfy the constraints specified in `constraint` code details.
-     *
-     * Similar semantics to:
-     * {@link https://github.com/npm/node-semver#usage}
-     */
-    satisfies(candidate: IFluidCodeDetails, constraint: IFluidCodeDetails): Promise<boolean>;
-
-    /* eslint-disable max-len */
-    /**
-     * Return a number representing the ascending sort order of the `a` and `b` code details:
-     *
-     * - `< 0` if `a < b`.
-     *
-     * - `= 0` if `a === b`.
-     *
-     * - `> 0` if `a > b`.
-     *
-     * - `undefined` if `a` is not comparable to `b`.
-     *
-     * Similar semantics to:
-     * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#description | Array.sort}
-     */
-    compare(a: IFluidCodeDetails, b: IFluidCodeDetails): Promise<number | undefined>;
-    /* eslint-enable max-len */
+	/**
+	 * Return a number representing the ascending sort order of the `a` and `b` code details:
+	 *
+	 * - `< 0` if `a < b`.
+	 *
+	 * - `= 0` if `a === b`.
+	 *
+	 * - `> 0` if `a > b`.
+	 *
+	 * - `undefined` if `a` is not comparable to `b`.
+	 *
+	 * Similar semantics to:
+	 * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#description | Array.sort}
+	 */
+	compare(a: IFluidCodeDetails, b: IFluidCodeDetails): Promise<number | undefined>;
 }

package/src/index.ts

@@ -10,62 +10,66 @@
  */
 
 export { IAudience, IAudienceOwner } from "./audience";
-export { IFluidBrowserPackage, IFluidBrowserPackageEnvironment, isFluidBrowserPackage } from "./browserPackage";
 export {
-    IConnectionDetails,
-    IDeltaHandlerStrategy,
-    IDeltaManager,
-    IDeltaManagerEvents,
-    IDeltaSender,
-    IDeltaQueue,
-    IDeltaQueueEvents,
-    ReadOnlyInfo,
+	IFluidBrowserPackage,
+	IFluidBrowserPackageEnvironment,
+	isFluidBrowserPackage,
+} from "./browserPackage";
+export {
+	IConnectionDetails,
+	IDeltaHandlerStrategy,
+	IDeltaManager,
+	IDeltaManagerEvents,
+	IDeltaSender,
+	IDeltaQueue,
+	IDeltaQueueEvents,
+	ReadOnlyInfo,
 } from "./deltas";
 export {
-    ContainerErrorType,
-    ContainerWarning,
-    ICriticalContainerError,
-    IErrorBase,
-    IGenericError,
-    IUsageError,
-    IThrottlingWarning,
+	ContainerErrorType,
+	ContainerWarning,
+	ICriticalContainerError,
+	IErrorBase,
+	IGenericError,
+	IUsageError,
+	IThrottlingWarning,
 } from "./error";
 export {
-    ConnectionState,
-    ICodeAllowList,
-    ICodeDetailsLoader,
-    IContainer,
-    IContainerEvents,
-    IContainerLoadMode,
-    IFluidCodeResolver,
-    IFluidModuleWithDetails,
-    IHostLoader,
-    ILoader,
-    ILoaderHeader,
-    ILoaderOptions,
-    IPendingLocalState,
-    IProvideLoader,
-    IResolvedFluidCodeDetails,
-    ISnapshotTreeWithBlobContents,
-    LoaderHeader,
+	ConnectionState,
+	ICodeAllowList,
+	ICodeDetailsLoader,
+	IContainer,
+	IContainerEvents,
+	IContainerLoadMode,
+	IFluidCodeResolver,
+	IFluidModuleWithDetails,
+	IHostLoader,
+	ILoader,
+	ILoaderHeader,
+	ILoaderOptions,
+	IPendingLocalState,
+	IProvideLoader,
+	IResolvedFluidCodeDetails,
+	ISnapshotTreeWithBlobContents,
+	LoaderHeader,
 } from "./loader";
 export { IFluidModule } from "./fluidModule";
 export {
-    IFluidPackage,
-    IFluidPackageEnvironment,
-    IFluidCodeDetails,
-    IFluidCodeDetailsComparer,
-    IFluidCodeDetailsConfig,
-    IProvideFluidCodeDetailsComparer,
-    isFluidPackage,
-    isFluidCodeDetails,
+	IFluidPackage,
+	IFluidPackageEnvironment,
+	IFluidCodeDetails,
+	IFluidCodeDetailsComparer,
+	IFluidCodeDetailsConfig,
+	IProvideFluidCodeDetailsComparer,
+	isFluidPackage,
+	isFluidCodeDetails,
 } from "./fluidPackage";
 export {
-    AttachState,
-    IBatchMessage,
-    IContainerContext,
-    IProvideRuntimeFactory,
-    IRuntime,
-    IRuntimeFactory,
+	AttachState,
+	IBatchMessage,
+	IContainerContext,
+	IProvideRuntimeFactory,
+	IRuntime,
+	IRuntimeFactory,
 } from "./runtime";
 export { IFluidTokenProvider, IProvideFluidTokenProvider } from "./tokenProvider";