@fluidframework/core-interfaces 2.90.0-378676 → 2.90.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/core-interfaces",
-  "version": "2.90.0-378676",
+  "version": "2.90.0",
   "description": "Fluid object interfaces",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -86,8 +86,8 @@
     "@fluid-tools/build-cli": "^0.63.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.63.0",
-    "@fluidframework/core-interfaces-previous": "npm:@fluidframework/core-interfaces@2.82.0",
-    "@fluidframework/eslint-config-fluid": "2.90.0-378676",
+    "@fluidframework/core-interfaces-previous": "npm:@fluidframework/core-interfaces@2.83.0",
+    "@fluidframework/eslint-config-fluid": "~2.90.0",
     "@microsoft/api-extractor": "7.52.11",
     "@types/mocha": "^10.0.10",
     "@types/node": "~20.19.30",
@@ -97,9 +97,9 @@
     "cross-env": "^10.1.0",
     "eslint": "~9.39.1",
     "jiti": "^2.6.1",
-    "mocha": "^10.8.2",
+    "mocha": "^11.7.5",
     "mocha-multi-reporters": "^1.5.1",
-    "rimraf": "^6.1.2",
+    "rimraf": "^6.1.3",
     "typescript": "~5.4.5"
   },
   "fluidBuild": {
@@ -136,11 +136,11 @@
     "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:internal/exposedUtilityTypes": "api-extractor run --config api-extractor/api-extractor-lint-internal-exposedUtilityTypes.esm.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",
     "ci:build:api-reports": "concurrently \"npm:ci:build:api-reports:*\"",
     "ci:build:api-reports:current": "api-extractor run --config api-extractor/api-extractor.current.json",
     "ci:build:api-reports:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",

package/src/api-extractor/exposedUtilityTypes.ts

@@ -0,0 +1,18 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+// This is a workaround for api-extractor to see that "./index.js" exports are
+// covered for the "internal/exposedUtilityTypes" entry point. This file
+// re-exports everything from index.js and the exposedUtilityTypes.js files,
+// which allows api-extractor to verify that all exports from both files are
+// exported somewhere by the package.
+
+/* eslint-disable no-restricted-syntax */
+
+// The "internal" exports are a superset of the standard ones. So, we want to export everything from the standard barrel file.
+// eslint-disable-next-line @typescript-eslint/no-restricted-imports
+export type * from "../index.js";
+
+export type * from "../exposedUtilityTypes.js";

package/src/brandedType.ts

@@ -69,7 +69,7 @@
  * }
  * ```
  *
- * @internal
+ * @beta
  */
 export declare class BrandedType<out Brand> {
 	/**

package/src/deepReadonly.ts

@@ -16,6 +16,7 @@ import type {
  * @privateRemarks
  * WeakRef should be added when lib is updated to ES2021 or later.
  *
+ * @beta
  * @system
  */
 export type DeepReadonlySupportedGenericsDefault =

package/src/exposedInternalUtilityTypes.ts

@@ -551,7 +551,7 @@ export namespace InternalUtilityTypes {
 	 * @typeParam IfNoMatch - Type to return if no match is found.
 	 *
 	 * @remarks
-	 * In a recursive context, use {@link InternalUtilityTypes.IfExactTypeInTuple} to manage ancestry.
+	 * In a recursive context, use {@link InternalCoreInterfacesUtilityTypes.IfExactTypeInTuple} to manage ancestry.
 	 *
 	 * @privateRemarks
 	 * Perhaps it is a Typescript defect but a simple check that `T` is `never`
@@ -989,7 +989,7 @@ export namespace InternalUtilityTypes {
 	/* eslint-enable @typescript-eslint/no-explicit-any */
 
 	/**
-	 * Helper for {@link JsonSerializableFilter} to determine if a property may
+	 * Helper for {@link InternalCoreInterfacesUtilityTypes.JsonSerializableFilter} to determine if a property may
 	 * be `undefined` and selects from options for result.
 	 * Since `unknown` is a superset of `undefined`, it is given a special case.
 	 * Additionally since index signatures are inherently optional, `unknown` typed
@@ -1248,7 +1248,7 @@ export namespace InternalUtilityTypes {
 		: never /* unreachable else for infer */;
 
 	/**
-	 * Recurses `T` applying {@link InternalUtilityTypes.JsonDeserializedFilter} up until
+	 * Recurses `T` applying {@link InternalCoreInterfacesUtilityTypes.JsonDeserializedFilter} up until
 	 * `T` is found to be a match of an ancestor type. At that point `T` is wrapped in
 	 * {@link OpaqueJsonDeserialized} to avoid further immediate processing, if
 	 * modification is needed. Caller will need to unwrap the type to continue processing.
@@ -1760,7 +1760,7 @@ export namespace InternalUtilityTypes {
 		: /* unreachable else for infer */ never;
 
 	/**
-	 * Recurses `T` applying {@link InternalUtilityTypes.DeepReadonlyWorker} up to `RecurseLimit` times.
+	 * Recurses `T` applying {@link InternalCoreInterfacesUtilityTypes.DeepReadonlyWorker} up to `RecurseLimit` times.
 	 *
 	 * @system
 	 */
@@ -1783,7 +1783,7 @@ export namespace InternalUtilityTypes {
 		: DeepReadonlyWorker<T, DeepenedGenerics, RecurseLimit, TAncestorTypes | T>;
 
 	/**
-	 * Core implementation of {@link InternalUtilityTypes.DeepReadonlyLimitingRecursion}.
+	 * Core implementation of {@link InternalCoreInterfacesUtilityTypes.DeepReadonlyLimitingRecursion}.
 	 *
 	 * @system
 	 */

package/src/exposedUtilityTypes.ts

@@ -7,9 +7,13 @@
 // system level but externally exposed version of utilities are needed.
 // Import via /internal when use is not exposed externally.
 // Should a customer need access to these types, export should be relocated to
-// index.ts and retagged export from internal.ts may be removed.
+// index.ts and the re-tagged export from internal.ts may be removed.
 
-export type { DeepReadonly } from "./deepReadonly.js";
+export type {
+	DeepReadonly,
+	DeepReadonlyOptions,
+	DeepReadonlySupportedGenericsDefault,
+} from "./deepReadonly.js";
 export type { JsonDeserialized, JsonDeserializedOptions } from "./jsonDeserialized.js";
 export type { JsonSerializable, JsonSerializableOptions } from "./jsonSerializable.js";
 export type {
@@ -22,9 +26,15 @@ export type {
 	ReadonlyJsonTypeWith,
 } from "./jsonType.js";
 export type { OpaqueJsonDeserialized, OpaqueJsonSerializable } from "./opaqueJson.js";
-export type { ShallowReadonly } from "./shallowReadonly.js";
+export type {
+	ShallowReadonly,
+	ShallowReadonlyOptions,
+	ShallowReadonlySupportedGenericsDefault,
+} from "./shallowReadonly.js";
 
 export type {
-	InternalUtilityTypes,
+	DeepReadonlyRecursionLimit,
+	// External name is qualified to avoid confusion with similarly named types in other packages.
+	InternalUtilityTypes as InternalCoreInterfacesUtilityTypes,
 	ReadonlySupportedGenerics,
 } from "./exposedInternalUtilityTypes.js";

package/src/handles.ts

@@ -223,5 +223,5 @@ export interface IFluidHandle<out T = unknown> {
  * Created from {@link IFluidHandleInternal} using {@link toFluidHandleErased}.
  * @sealed @public
  */
-// eslint-disable-next-line @typescript-eslint/no-empty-object-type, @typescript-eslint/no-empty-interface
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface IFluidHandleErased<T> extends ErasedType<readonly ["IFluidHandle", T]> {}

package/src/internal.ts

@@ -99,7 +99,7 @@ export type OpaqueJsonSerializable<
  * @internal
  */
 // eslint-disable-next-line @typescript-eslint/no-namespace
-export namespace InternalUtilityTypes {
+export namespace InternalCoreInterfacesUtilityTypes {
 	/* eslint-disable jsdoc/require-jsdoc */
 	export type FlattenIntersection<T extends ExposedInternalUtilityTypes.AnyRecord> =
 		ExposedInternalUtilityTypes.FlattenIntersection<T>;

package/src/jsonString.ts

@@ -3,7 +3,6 @@
  * Licensed under the MIT License.
  */
 
-// eslint-disable-next-line @typescript-eslint/consistent-type-imports -- incorrect rule: misunderstands `declare`d types.
 import type { BrandedType } from "./brandedType.js";
 import type { InternalUtilityTypes } from "./exposedInternalUtilityTypes.js";
 import type { JsonDeserialized } from "./jsonDeserialized.js";

package/src/shallowReadonly.ts

@@ -16,6 +16,7 @@ import type { IFluidHandle } from "./handles.js";
  * @privateRemarks
  * WeakRef should be added when lib is updated to ES2021 or later.
  *
+ * @beta
  * @system
  */
 export type ShallowReadonlySupportedGenericsDefault = Promise<unknown> | IFluidHandle;