@fluidframework/core-interfaces 2.0.0-internal.3.0.5 → 2.0.0-internal.3.1.1

package/package.json

@@ -1,65 +1,66 @@
 {
-  "name": "@fluidframework/core-interfaces",
-  "version": "2.0.0-internal.3.0.5",
-  "description": "Fluid object interfaces",
-  "homepage": "https://fluidframework.com",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/microsoft/FluidFramework.git",
-    "directory": "common/lib/core-interfaces"
-  },
-  "license": "MIT",
-  "author": "Microsoft and contributors",
-  "sideEffects": false,
-  "main": "dist/index.js",
-  "module": "lib/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "build": "concurrently npm:build:compile npm:lint && npm run build:docs",
-    "build:commonjs": "npm run tsc && npm run typetests:gen && npm run build:test",
-    "build:compile": "concurrently npm:build:commonjs npm:build:esnext",
-    "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
-    "build:esnext": "tsc --project ./tsconfig.esnext.json",
-    "build:full": "npm run build",
-    "build:full:compile": "npm run build:compile",
-    "build:test": "tsc --project ./src/test/tsconfig.json",
-    "ci:build": "npm run build:compile",
-    "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
-    "ci:test": "echo No test for this package",
-    "ci:test:coverage": "echo No test for this package",
-    "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
-    "eslint": "eslint --format stylish src",
-    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
-    "format": "npm run prettier:fix",
-    "lint": "npm run eslint",
-    "lint:fix": "npm run eslint:fix",
-    "prettier": "prettier --check . --ignore-path ../../../.prettierignore",
-    "prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
-    "tsc": "tsc",
-    "tsc:watch": "tsc --watch",
-    "typetests:gen": "flub generate typetests --generate --dir .",
-    "typetests:prepare": "flub generate typetests --prepare --dir . --pin"
-  },
-  "devDependencies": {
-    "@fluid-tools/build-cli": "^0.8.0",
-    "@fluidframework/build-common": "^1.1.0",
-    "@fluidframework/build-tools": "^0.8.0",
-    "@fluidframework/core-interfaces-previous": "npm:@fluidframework/core-interfaces@2.0.0-internal.3.0.0",
-    "@fluidframework/eslint-config-fluid": "^2.0.0",
-    "@microsoft/api-extractor": "^7.22.2",
-    "@rushstack/eslint-config": "^2.5.1",
-    "@types/node": "^14.18.36",
-    "concurrently": "^6.2.0",
-    "copyfiles": "^2.4.1",
-    "eslint": "~8.6.0",
-    "prettier": "~2.6.2",
-    "rimraf": "^2.6.2",
-    "typescript": "~4.5.5"
-  },
-  "typeValidation": {
-    "version": "2.0.0-internal.3.0.1",
-    "previousVersionStyle": "previousPatch",
-    "baselineRange": "2.0.0-internal.3.0.0",
-    "broken": {}
-  }
+	"name": "@fluidframework/core-interfaces",
+	"version": "2.0.0-internal.3.1.1",
+	"description": "Fluid object interfaces",
+	"homepage": "https://fluidframework.com",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/microsoft/FluidFramework.git",
+		"directory": "common/lib/core-interfaces"
+	},
+	"license": "MIT",
+	"author": "Microsoft and contributors",
+	"sideEffects": false,
+	"main": "dist/index.js",
+	"module": "lib/index.js",
+	"types": "dist/index.d.ts",
+	"scripts": {
+		"build": "concurrently npm:build:compile npm:lint && npm run build:docs",
+		"build:commonjs": "npm run tsc && npm run typetests:gen && npm run build:test",
+		"build:compile": "concurrently npm:build:commonjs npm:build:esnext",
+		"build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
+		"build:esnext": "tsc --project ./tsconfig.esnext.json",
+		"build:full": "npm run build",
+		"build:full:compile": "npm run build:compile",
+		"build:test": "tsc --project ./src/test/tsconfig.json",
+		"ci:build": "npm run build:compile",
+		"ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
+		"ci:test": "echo No test for this package",
+		"ci:test:coverage": "echo No test for this package",
+		"clean": "rimraf dist lib *.tsbuildinfo *.build.log",
+		"eslint": "eslint --format stylish src",
+		"eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
+		"format": "npm run prettier:fix",
+		"lint": "npm run prettier && npm run eslint",
+		"lint:fix": "npm run prettier:fix && npm run eslint:fix",
+		"prettier": "prettier --check . --ignore-path ../../../.prettierignore",
+		"prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
+		"tsc": "tsc",
+		"tsc:watch": "tsc --watch",
+		"typetests:gen": "flub generate typetests --generate --dir .",
+		"typetests:prepare": "flub generate typetests --prepare --dir . --pin"
+	},
+	"devDependencies": {
+		"@fluid-tools/build-cli": "^0.9.0",
+		"@fluidframework/build-common": "^1.1.0",
+		"@fluidframework/build-tools": "^0.9.0",
+		"@fluidframework/core-interfaces-previous": "npm:@fluidframework/core-interfaces@2.0.0-internal.3.0.1",
+		"@fluidframework/eslint-config-fluid": "^2.0.0",
+		"@microsoft/api-extractor": "^7.22.2",
+		"@rushstack/eslint-config": "^2.5.1",
+		"@types/node": "^14.18.36",
+		"concurrently": "^6.2.0",
+		"copyfiles": "^2.4.1",
+		"eslint": "~8.6.0",
+		"prettier": "~2.6.2",
+		"rimraf": "^2.6.2",
+		"typescript": "~4.5.5"
+	},
+	"typeValidation": {
+		"version": "2.0.0-internal.3.1.1",
+		"previousVersionStyle": "~previousMinor",
+		"baselineRange": ">=2.0.0-internal.3.0.0 <2.0.0-internal.3.1.0",
+		"baselineVersion": "2.0.0-internal.3.0.1",
+		"broken": {}
+	}
 }

package/prettier.config.cjs

@@ -4,5 +4,5 @@
  */
 
 module.exports = {
-    ...require("@fluidframework/build-common/prettier.config.cjs"),
+	...require("@fluidframework/build-common/prettier.config.cjs"),
 };

package/src/fluidLoadable.ts

@@ -8,22 +8,22 @@ import { IFluidHandle } from "./handles";
 export const IFluidLoadable: keyof IProvideFluidLoadable = "IFluidLoadable";
 
 export interface IProvideFluidLoadable {
-    readonly IFluidLoadable: IFluidLoadable;
+	readonly IFluidLoadable: IFluidLoadable;
 }
 /**
  * A shared FluidObject has a URL from which it can be referenced
  */
 export interface IFluidLoadable extends IProvideFluidLoadable {
-    // Handle to the loadable FluidObject
-    handle: IFluidHandle;
+	// Handle to the loadable FluidObject
+	handle: IFluidHandle;
 }
 
 export const IFluidRunnable: keyof IProvideFluidRunnable = "IFluidRunnable";
 
 export interface IProvideFluidRunnable {
-    readonly IFluidRunnable: IFluidRunnable;
+	readonly IFluidRunnable: IFluidRunnable;
 }
 export interface IFluidRunnable {
-    run(...args: any[]): Promise<void>;
-    stop(reason?: string): void;
+	run(...args: any[]): Promise<void>;
+	stop(reason?: string): void;
 }

package/src/fluidPackage.ts

@@ -3,32 +3,34 @@
  * Licensed under the MIT License.
  */
 
- /**
-  * Specifies an environment on Fluid property of an {@link IFluidPackage}.
-  *
-  * @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackageEnvironment}
-  * to have code loading modules in same package.
-  */
+/**
+ * Specifies an environment on Fluid property of an {@link IFluidPackage}.
+ *
+ * @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackageEnvironment}
+ * to have code loading modules in same package.
+ */
 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;
+		  };
 }
 
 /**
@@ -41,26 +43,26 @@ export interface IFluidPackageEnvironment {
  * to have code loading modules in same package.
  */
 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;
 }
 
 /**
@@ -72,9 +74,7 @@ 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.
@@ -83,7 +83,7 @@ export const isFluidPackage = (pkg: any): pkg is Readonly<IFluidPackage> =>
  * to have code loading modules in same package.
  */
 export interface IFluidCodeDetailsConfig {
-    readonly [key: string]: string;
+	readonly [key: string]: string;
 }
 
 /**
@@ -93,41 +93,45 @@ export interface IFluidCodeDetailsConfig {
  * to have code loading modules in same package.
  */
 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.
-     */
-    readonly config?: IFluidCodeDetailsConfig;
+	/**
+	 * Configuration details. This includes links to the package manager and base CDNs.
+	 */
+	readonly config?: IFluidCodeDetailsConfig;
 }
 
 /**
  * @deprecated in favor of {@link @fluidframework/container-definitions#isFluidCodeDetails}
  * to have code loading modules in same package.
-*/
+ */
 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")
+	);
 };
 
 /**
  * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsComparer}
  * to have code loading modules in same package.
-*/
-export const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer = "IFluidCodeDetailsComparer";
+ */
+export const IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer =
+	"IFluidCodeDetailsComparer";
 
 /**
  * @deprecated in favor of {@link @fluidframework/container-definitions#IProvideFluidCodeDetailsComparer}
  * to have code loading modules in same package.
-*/
+ */
 export interface IProvideFluidCodeDetailsComparer {
-    readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer ;
+	readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer;
 }
 
 /**
@@ -137,28 +141,27 @@ export interface IProvideFluidCodeDetailsComparer {
  * to have code loading modules in same package.
  */
 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>;
-
-    /**
-     * Returns 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>;
+	/**
+	 * Returns 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/fluidRouter.ts

@@ -4,20 +4,20 @@
  */
 
 export interface IRequestHeader {
-    [index: string]: any;
+	[index: string]: any;
 }
 
 export interface IRequest {
-    url: string;
-    headers?: IRequestHeader;
+	url: string;
+	headers?: IRequestHeader;
 }
 
 export interface IResponse {
-    mimeType: string;
-    status: number;
-    value: any;
-    headers?: { [key: string]: any; };
-    stack?: string;
+	mimeType: string;
+	status: number;
+	value: any;
+	headers?: { [key: string]: any };
+	stack?: string;
 }
 
 export const IFluidRouter: keyof IProvideFluidRouter = "IFluidRouter";
@@ -26,8 +26,8 @@ export const IFluidRouter: keyof IProvideFluidRouter = "IFluidRouter";
  * Request routing
  */
 export interface IProvideFluidRouter {
-    readonly IFluidRouter: IFluidRouter;
+	readonly IFluidRouter: IFluidRouter;
 }
 export interface IFluidRouter extends IProvideFluidRouter {
-    request(request: IRequest): Promise<IResponse>;
+	request(request: IRequest): Promise<IResponse>;
 }

package/src/handles.ts

@@ -10,76 +10,75 @@ import { FluidObject } from "./provider";
 export const IFluidHandleContext: keyof IProvideFluidHandleContext = "IFluidHandleContext";
 
 export interface IProvideFluidHandleContext {
-    readonly IFluidHandleContext: IFluidHandleContext;
+	readonly IFluidHandleContext: IFluidHandleContext;
 }
 
 /**
  * Describes a routing context from which other `IFluidHandleContext`s are defined.
  */
 export interface IFluidHandleContext extends IProvideFluidHandleContext {
-    /**
-     * The absolute path to the handle context from the root.
-     */
-    readonly absolutePath: string;
-
-    /**
-     * The parent IFluidHandleContext that has provided a route path to this IFluidHandleContext or undefined
-     * at the root.
-     */
-    readonly routeContext?: IFluidHandleContext;
-
-    /**
-     * Flag indicating whether or not the entity has services attached.
-     */
-    readonly isAttached: boolean;
-
-    /**
-     * Runs through the graph and attach the bounded handles.
-     */
-    attachGraph(): void;
-
-    resolveHandle(request: IRequest): Promise<IResponse>;
+	/**
+	 * The absolute path to the handle context from the root.
+	 */
+	readonly absolutePath: string;
+
+	/**
+	 * The parent IFluidHandleContext that has provided a route path to this IFluidHandleContext or undefined
+	 * at the root.
+	 */
+	readonly routeContext?: IFluidHandleContext;
+
+	/**
+	 * Flag indicating whether or not the entity has services attached.
+	 */
+	readonly isAttached: boolean;
+
+	/**
+	 * Runs through the graph and attach the bounded handles.
+	 */
+	attachGraph(): void;
+
+	resolveHandle(request: IRequest): Promise<IResponse>;
 }
 
 export const IFluidHandle: keyof IProvideFluidHandle = "IFluidHandle";
 
 export interface IProvideFluidHandle {
-    readonly IFluidHandle: IFluidHandle;
+	readonly IFluidHandle: IFluidHandle;
 }
 
 /**
  * Handle to a shared {@link FluidObject}.
  */
 export interface IFluidHandle<
-    // REVIEW: Constrain `T` to something? How do we support dds and datastores safely?
-    T = FluidObject & IFluidLoadable,
-    > extends IProvideFluidHandle {
-
-    /**
-     * @deprecated Do not use handle's path for routing. Use `get` to get the underlying object.
-     *
-     * The absolute path to the handle context from the root.
-     */
-    readonly absolutePath: string;
-
-    /**
-     * Flag indicating whether or not the entity has services attached.
-     */
-    readonly isAttached: boolean;
-
-    /**
-     * Runs through the graph and attach the bounded handles.
-     */
-    attachGraph(): void;
-
-    /**
-     * Returns a promise to the Fluid Object referenced by the handle.
-     */
-    get(): Promise<T>;
-
-    /**
-     * Binds the given handle to this one or attach the given handle if this handle is attached.
-     * A bound handle will also be attached once this handle is attached.
-     */
-    bind(handle: IFluidHandle): void;
+	// REVIEW: Constrain `T` to something? How do we support dds and datastores safely?
+	T = FluidObject & IFluidLoadable,
+> extends IProvideFluidHandle {
+	/**
+	 * @deprecated Do not use handle's path for routing. Use `get` to get the underlying object.
+	 *
+	 * The absolute path to the handle context from the root.
+	 */
+	readonly absolutePath: string;
+
+	/**
+	 * Flag indicating whether or not the entity has services attached.
+	 */
+	readonly isAttached: boolean;
+
+	/**
+	 * Runs through the graph and attach the bounded handles.
+	 */
+	attachGraph(): void;
+
+	/**
+	 * Returns a promise to the Fluid Object referenced by the handle.
+	 */
+	get(): Promise<T>;
+
+	/**
+	 * Binds the given handle to this one or attach the given handle if this handle is attached.
+	 * A bound handle will also be attached once this handle is attached.
+	 */
+	bind(handle: IFluidHandle): void;
 }

package/src/index.ts

@@ -4,43 +4,39 @@
  */
 
 export {
-    IFluidLoadable,
-    IProvideFluidLoadable,
-    IFluidRunnable,
-    IProvideFluidRunnable,
+	IFluidLoadable,
+	IProvideFluidLoadable,
+	IFluidRunnable,
+	IProvideFluidRunnable,
 } from "./fluidLoadable";
 
 // 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,
+	IRequest,
+	IRequestHeader,
+	IResponse,
+	IProvideFluidRouter,
+	IFluidRouter,
 } from "./fluidRouter";
 
 export {
-    IFluidHandleContext,
-    IProvideFluidHandleContext,
-    IFluidHandle,
-    IProvideFluidHandle,
+	IFluidHandleContext,
+	IProvideFluidHandleContext,
+	IFluidHandle,
+	IProvideFluidHandle,
 } from "./handles";
 
 export {
-    IFluidPackageEnvironment,
-    IFluidPackage,
-    isFluidPackage,
-    IFluidCodeDetailsConfig,
-    IFluidCodeDetails,
-    isFluidCodeDetails,
-    IFluidCodeDetailsComparer,
-    IProvideFluidCodeDetailsComparer,
+	IFluidPackageEnvironment,
+	IFluidPackage,
+	isFluidPackage,
+	IFluidCodeDetailsConfig,
+	IFluidCodeDetails,
+	isFluidCodeDetails,
+	IFluidCodeDetailsComparer,
+	IProvideFluidCodeDetailsComparer,
 } from "./fluidPackage";
 
-export {
-    FluidObjectProviderKeys,
-    FluidObject,
-    FluidObjectKeys,
-} from "./provider";
+export { FluidObjectProviderKeys, FluidObject, FluidObjectKeys } from "./provider";