@fluidframework/core-interfaces 2.70.0 → 2.72.0

package/lib/legacy.alpha.d.ts

@@ -0,0 +1,73 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
+ */
+
+export {
+	// #region @public APIs
+	ConfigTypes, 
+	ErasedType, 
+	ExtendEventProvider, 
+	FluidObject, 
+	FluidObjectKeys, 
+	FluidObjectProviderKeys, 
+	IConfigProviderBase, 
+	IDisposable, 
+	IErrorBase, 
+	IErrorEvent, 
+	IEvent, 
+	IEventProvider, 
+	IEventThisPlaceHolder, 
+	IEventTransformer, 
+	IFluidHandle, 
+	IFluidHandleErased, 
+	IFluidLoadable, 
+	IProvideFluidLoadable, 
+	IRequest, 
+	IRequestHeader, 
+	IResponse, 
+	ITelemetryBaseEvent, 
+	ITelemetryBaseLogger, 
+	ITelemetryBaseProperties, 
+	IsListener, 
+	Listenable, 
+	Listeners, 
+	LogLevel, 
+	Off, 
+	ReplaceIEventThisPlaceHolder, 
+	Tagged, 
+	TelemetryBaseEventPropertyType, 
+	TransformedEvent, 
+	fluidHandleSymbol,
+	// #endregion
+ 
+	// #region @beta APIs
+	ErasedBaseType,
+	// #endregion
+ 
+	// #region @legacyBeta APIs
+	FluidErrorTypes, 
+	IFluidHandleContext, 
+	IFluidHandleEvents, 
+	IFluidHandleInternal, 
+	IFluidHandlePayloadPending, 
+	ILocalFluidHandle, 
+	ILocalFluidHandleEvents, 
+	ILoggingError, 
+	IProvideFluidHandle, 
+	IProvideFluidHandleContext, 
+	IThrottlingWarning, 
+	PayloadState, 
+	TypedMessage,
+	// #endregion
+ 
+	// #region @legacyAlpha APIs
+	FluidErrorTypesAlpha, 
+	ILayerIncompatibilityError
+	// #endregion
+} from "./index.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/core-interfaces",
-  "version": "2.70.0",
+  "version": "2.72.0",
   "description": "Fluid object interfaces",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -33,6 +33,16 @@
         "default": "./dist/index.js"
       }
     },
+    "./legacy/alpha": {
+      "import": {
+        "types": "./lib/legacy.alpha.d.ts",
+        "default": "./lib/index.js"
+      },
+      "require": {
+        "types": "./dist/legacy.alpha.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
     "./internal": {
       "import": {
         "types": "./lib/internal.d.ts",
@@ -73,11 +83,11 @@
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-tools/build-cli": "^0.58.3",
+    "@fluid-tools/build-cli": "^0.60.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.58.3",
-    "@fluidframework/core-interfaces-previous": "npm:@fluidframework/core-interfaces@2.63.0",
-    "@fluidframework/eslint-config-fluid": "^6.1.0",
+    "@fluidframework/build-tools": "^0.60.0",
+    "@fluidframework/core-interfaces-previous": "npm:@fluidframework/core-interfaces@2.71.0",
+    "@fluidframework/eslint-config-fluid": "~2.72.0",
     "@microsoft/api-extractor": "7.52.11",
     "@types/mocha": "^10.0.10",
     "@types/node": "^18.19.0",
@@ -104,8 +114,8 @@
   },
   "scripts": {
     "api": "fluid-build . --task api",
-    "api-extractor:commonjs": "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./dist",
-    "api-extractor:esnext": "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib --node10TypeCompat",
+    "api-extractor:commonjs": "flub generate entrypoints --outFileLegacyBeta legacy --outFileLegacyAlpha legacy.alpha --outDir ./dist",
+    "api-extractor:esnext": "flub generate entrypoints --outFileLegacyBeta legacy --outFileLegacyAlpha legacy.alpha --outDir ./lib --node10TypeCompat",
     "build": "fluid-build . --task build",
     "build:api-reports": "concurrently \"npm:build:api-reports:*\"",
     "build:api-reports:current": "api-extractor run --local --config api-extractor/api-extractor.current.json",
@@ -123,8 +133,10 @@
     "check:exports": "concurrently \"npm:check:exports:*\"",
     "check:exports:bundle-release-tags": "api-extractor run --config api-extractor/api-extractor-lint-bundle.json",
     "check:exports:cjs:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.cjs.json",
+    "check:exports:cjs:legacy.alpha": "api-extractor run --config api-extractor/api-extractor-lint-legacy.alpha.cjs.json",
     "check:exports:cjs:public": "api-extractor run --config api-extractor/api-extractor-lint-public.cjs.json",
     "check:exports:esm:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.esm.json",
+    "check:exports:esm:legacy.alpha": "api-extractor run --config api-extractor/api-extractor-lint-legacy.alpha.esm.json",
     "check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
     "check:format": "npm run check:biome",
     "ci:build": "npm run build:compile",
@@ -133,8 +145,8 @@
     "ci:build:api-reports:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
     "ci:build:docs": "api-extractor run",
     "clean": "rimraf --glob dist lib {alpha,beta,legacy}.d.ts \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
-    "eslint": "eslint --format stylish src",
-    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
+    "eslint": "eslint --quiet --format stylish src",
+    "eslint:fix": "eslint --quiet --format stylish src --fix --fix-type problem,suggestion,layout",
     "format": "npm run format:biome",
     "format:biome": "biome check . --write",
     "lint": "fluid-build . --task lint",

package/src/cjs/package.json

@@ -10,6 +10,10 @@
 			"types": "./legacy.d.ts",
 			"default": "./index.js"
 		},
+		"./legacy/alpha": {
+			"types": "./legacy.alpha.d.ts",
+			"default": "./index.js"
+		},
 		"./internal": {
 			"types": "./internal.d.ts",
 			"default": "./internal.js"

package/src/error.ts

@@ -41,6 +41,29 @@ export const FluidErrorTypes = {
  */
 export type FluidErrorTypes = (typeof FluidErrorTypes)[keyof typeof FluidErrorTypes];
 
+/**
+ * New error types that are still in alpha stage. Once stabilized, they will be moved to FluidErrorTypes.
+ * @legacy @alpha
+ */
+export const FluidErrorTypesAlpha = {
+	...FluidErrorTypes,
+	/**
+	 * Error indicating that two Fluid layers are incompatible. For instance, if the Loader layer is
+	 * not compatible with the Runtime layer, the container create / load will fail with an error of this type.
+	 * In most cases, the layer compatibility validation happens during container load / create causing it to
+	 * fail with this error type.
+	 * In some cases such as for the Runtime and DataStore layer compatibility, the incompatibility may be detected
+	 * during data store loads. In such cases, the data store load will fail with this error type.
+	 */
+	layerIncompatibilityError: "layerIncompatibilityError",
+} as const;
+
+/**
+ * @legacy @alpha
+ */
+export type FluidErrorTypesAlpha =
+	(typeof FluidErrorTypesAlpha)[keyof typeof FluidErrorTypesAlpha];
+
 /**
  * Base interface for all errors and warnings emitted the container.
  *
@@ -130,15 +153,7 @@ export interface IThrottlingWarning extends IErrorBase {
 }
 
 /**
- * Symbol used to identify an error of type {@link ILayerIncompatibilityError}.
- * @legacy @alpha
- */
-export const layerIncompatibilityErrorSymbol: unique symbol = Symbol(
-	"LayerIncompatibilityError",
-);
-
-/**
- * Usage error indicating that two Fluid layers are incompatible. For instance, if the Loader layer is
+ * Layer incompatibility error indicating that two Fluid layers are incompatible. For instance, if the Loader layer is
  * not compatible with the Runtime layer, the container will be disposed with this error.
  * @legacy @alpha
  */
@@ -146,12 +161,7 @@ export interface ILayerIncompatibilityError extends IErrorBase {
 	/**
 	 * {@inheritDoc IErrorBase.errorType}
 	 */
-	readonly errorType: typeof FluidErrorTypes.usageError;
-
-	/**
-	 * Symbol used to identify this error as a layer incompatibility error.
-	 */
-	readonly [layerIncompatibilityErrorSymbol]: true;
+	readonly errorType: typeof FluidErrorTypesAlpha.layerIncompatibilityError;
 	/**
 	 * The layer that is reporting the incompatibility.
 	 */

package/src/events/listeners.ts

@@ -30,6 +30,7 @@ export type Listeners<T extends object> = {
 	[P in (string | symbol) & keyof T as IsListener<T[P]> extends true ? P : never]: T[P];
 };
 
+/* eslint-disable @fluid-internal/fluid/no-hyphen-after-jsdoc-tag -- false positive AB#50920 */
 /**
  * An object which allows the registration of listeners so that subscribers can be notified when an event happens.
  * @param TListeners - All the {@link Listeners | events} that this subscribable supports
@@ -47,6 +48,7 @@ export type Listeners<T extends object> = {
  * @sealed @public
  */
 export interface Listenable<TListeners extends object> {
+	/* eslint-enable @fluid-internal/fluid/no-hyphen-after-jsdoc-tag -- false positive
 	/**
 	 * Register an event listener.
 	 * @param eventName - The name of the event.

package/src/index.ts

@@ -14,8 +14,10 @@ export type {
 	IThrottlingWarning,
 	ILayerIncompatibilityError,
 } from "./error.js";
-export { layerIncompatibilityErrorSymbol } from "./error.js";
-export { FluidErrorTypes } from "./error.js";
+export {
+	FluidErrorTypes,
+	FluidErrorTypesAlpha,
+} from "./error.js";
 
 export type {
 	ExtendEventProvider,