@fluidframework/core-interfaces 2.71.0 → 2.73.0

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/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,