@fluidframework/core-interfaces - npm Package Compare versions

Comparing version 2.0.0-dev-rc.3.0.0.254866 to 2.0.0-dev-rc.4.0.0.261659

api-report/core-interfaces.api.md

@@ -10,2 +10,8 @@ ## API Report File for "@fluidframework/core-interfaces"
 
+// @public @sealed
+export abstract class ErasedType<out Name = unknown> {
+    static [Symbol.hasInstance](value: never): value is never;
+    protected abstract brand(dummy: never): Name;
+}
+
 // @public
@@ -235,6 +241,6 @@ export type ExtendEventProvider<TBaseEvent extends IEvent, TBase extends IEventProvider<TBaseEvent>, TEvent extends TBaseEvent> = Omit<Omit<Omit<TBase, "on">, "once">, "off"> & IEventProvider<TBaseEvent> & IEventProvider<TEvent>;
 // @public (undocumented)
-export const IFluidHandle: keyof IProvideFluidHandle;
+export const IFluidHandle = "IFluidHandle";
 
 // @public
-export interface IFluidHandle<T = FluidObject & IFluidLoadable> extends IProvideFluidHandle {
+export interface IFluidHandle<out T = FluidObject & IFluidLoadable> extends IProvideFluidHandle {
     // @deprecated (undocumented)
@@ -298,3 +304,3 @@ readonly absolutePath: string;
     // (undocumented)
-    readonly IFluidHandle: IFluidHandle;
+    readonly [IFluidHandle]: IFluidHandle;
 }
@@ -301,0 +307,0 @@

CHANGELOG.md

 # @fluidframework/core-interfaces
 
+## 2.0.0-rc.3.0.0
+
+### Major Changes
+
+-   core-interfaces: Code details and package API surface removed [97d68aa06b](https://github.com/microsoft/FluidFramework/commit/97d68aa06bd5c022ecb026655814aea222a062ae)
+
+    The code details and package API surface was deprecated in @fluidframework/core-interfaces in 0.53 and has now been removed. Please import them from @fluidframework/container-definitions instead. These include:
+
+    -   IFluidCodeDetails
+    -   IFluidCodeDetailsComparer
+    -   IFluidCodeDetailsConfig
+    -   IFluidPackage
+    -   IFluidPackageEnvironment
+    -   IProvideFluidCodeDetailsComparer
+    -   isFluidCodeDetails
+    -   isFluidPackage
+
+-   Packages now use package.json "exports" and require modern module resolution [97d68aa06b](https://github.com/microsoft/FluidFramework/commit/97d68aa06bd5c022ecb026655814aea222a062ae)
+
+    Fluid Framework packages have been updated to use the [package.json "exports"
+    field](https://nodejs.org/docs/latest-v18.x/api/packages.html#exports) to define explicit entry points for both
+    TypeScript types and implementation code.
+
+    This means that using Fluid Framework packages require the following TypeScript settings in tsconfig.json:
+
+    -   `"moduleResolution": "Node16"` with `"module": "Node16"`
+    -   `"moduleResolution": "Bundler"` with `"module": "ESNext"`
+
+    We recommend using Node16/Node16 unless absolutely necessary. That will produce transpiled JavaScript that is suitable
+    for use with modern versions of Node.js _and_ Bundlers.
+    [See the TypeScript documentation](https://www.typescriptlang.org/tsconfig#moduleResolution) for more information
+    regarding the module and moduleResolution options.
+
+    **Node10 moduleResolution is not supported; it does not support Fluid Framework's API structuring pattern that is used
+    to distinguish stable APIs from those that are in development.**
+
 ## 2.0.0-rc.2.0.0
@@ -4,0 +40,0 @@

dist/handles.d.ts

@@ -45,3 +45,3 @@ /*!
  */
-export declare const IFluidHandle: keyof IProvideFluidHandle;
+export declare const IFluidHandle = "IFluidHandle";
 /**
@@ -51,3 +51,3 @@ * @public
 export interface IProvideFluidHandle {
-    readonly IFluidHandle: IFluidHandle;
+    readonly [IFluidHandle]: IFluidHandle;
 }
@@ -58,3 +58,3 @@ /**
  */
-export interface IFluidHandle<T = FluidObject & IFluidLoadable> extends IProvideFluidHandle {
+export interface IFluidHandle<out T = FluidObject & IFluidLoadable> extends IProvideFluidHandle {
     /**
@@ -61,0 +61,0 @@ * @deprecated Do not use handle's path for routing. Use `get` to get the underlying object.

dist/index.d.ts

@@ -19,2 +19,3 @@ /*!
 export type { ISignalEnvelope } from "./messages.js";
+export type { ErasedType } from "./erasedType.js";
 //# sourceMappingURL=index.d.ts.map

dist/public.d.ts

@@ -10,5 +10,7 @@ /*!
  */
+
 export {
-	// public APIs
+	// @public APIs
 	ConfigTypes, 
+	ErasedType, 
 	ExtendEventProvider, 
@@ -15,0 +17,0 @@ FluidObject,

lib/handles.d.ts

@@ -45,3 +45,3 @@ /*!
  */
-export declare const IFluidHandle: keyof IProvideFluidHandle;
+export declare const IFluidHandle = "IFluidHandle";
 /**
@@ -51,3 +51,3 @@ * @public
 export interface IProvideFluidHandle {
-    readonly IFluidHandle: IFluidHandle;
+    readonly [IFluidHandle]: IFluidHandle;
 }
@@ -58,3 +58,3 @@ /**
  */
-export interface IFluidHandle<T = FluidObject & IFluidLoadable> extends IProvideFluidHandle {
+export interface IFluidHandle<out T = FluidObject & IFluidLoadable> extends IProvideFluidHandle {
     /**
@@ -61,0 +61,0 @@ * @deprecated Do not use handle's path for routing. Use `get` to get the underlying object.

lib/index.d.ts

@@ -19,2 +19,3 @@ /*!
 export type { ISignalEnvelope } from "./messages.js";
+export type { ErasedType } from "./erasedType.js";
 //# sourceMappingURL=index.d.ts.map

lib/public.d.ts

@@ -10,5 +10,7 @@ /*!
  */
+
 export {
-	// public APIs
+	// @public APIs
 	ConfigTypes, 
+	ErasedType, 
 	ExtendEventProvider, 
@@ -15,0 +17,0 @@ FluidObject,

package.json

 {
   "name": "@fluidframework/core-interfaces",
-  "version": "2.0.0-dev-rc.3.0.0.254866",
+  "version": "2.0.0-dev-rc.4.0.0.261659",
   "description": "Fluid object interfaces",
@@ -26,9 +26,9 @@ "homepage": "https://fluidframework.com",
     },
-    "./alpha": {
+    "./legacy": {
       "import": {
-        "types": "./lib/alpha.d.ts",
+        "types": "./lib/legacy.d.ts",
         "default": "./lib/index.js"
       },
       "require": {
-        "types": "./dist/alpha.d.ts",
+        "types": "./dist/legacy.d.ts",
         "default": "./dist/index.js"
@@ -48,11 +48,11 @@ }
   },
-  "main": "dist/index.js",
-  "types": "./dist/public.d.ts",
+  "main": "lib/index.js",
+  "types": "lib/public.d.ts",
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
     "@biomejs/biome": "^1.6.2",
-    "@fluid-tools/build-cli": "^0.35.0",
+    "@fluid-tools/build-cli": "0.38.0-259537",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.35.0",
-    "@fluidframework/core-interfaces-previous": "npm:@fluidframework/core-interfaces@2.0.0-internal.8.0.0",
+    "@fluidframework/build-tools": "0.38.0-259537",
+    "@fluidframework/core-interfaces-previous": "npm:@fluidframework/core-interfaces@2.0.0-rc.3.0.0",
     "@fluidframework/eslint-config-fluid": "^5.1.0",
@@ -68,77 +68,8 @@ "@microsoft/api-extractor": "^7.42.3",
   "typeValidation": {
-    "broken": {
-      "RemovedInterfaceDeclaration_ITelemetryLogger": {
-        "forwardCompat": false,
-        "backCompat": false
-      },
-      "RemovedInterfaceDeclaration_ITelemetryPerformanceEvent": {
-        "forwardCompat": false,
-        "backCompat": false
-      },
-      "RemovedInterfaceDeclaration_ITelemetryGenericEvent": {
-        "forwardCompat": false,
-        "backCompat": false
-      },
-      "RemovedInterfaceDeclaration_ITelemetryErrorEvent": {
-        "forwardCompat": false,
-        "backCompat": false
-      },
-      "RemovedInterfaceDeclaration_ITelemetryProperties": {
-        "forwardCompat": false,
-        "backCompat": false
-      },
-      "RemovedTypeAliasDeclaration_TelemetryEventCategory": {
-        "backCompat": false,
-        "forwardCompat": false
-      },
-      "RemovedTypeAliasDeclaration_TelemetryEventPropertyType": {
-        "backCompat": false,
-        "forwardCompat": false
-      },
-      "RemovedInterfaceDeclaration_ITaggedTelemetryPropertyType": {
-        "backCompat": false,
-        "forwardCompat": false
-      },
-      "RemovedInterfaceDeclaration_IFluidCodeDetails": {
-        "backCompat": false,
-        "forwardCompat": false
-      },
-      "RemovedVariableDeclaration_IFluidCodeDetailsComparer": {
-        "backCompat": false,
-        "forwardCompat": false
-      },
-      "RemovedInterfaceDeclaration_IFluidCodeDetailsComparer": {
-        "backCompat": false,
-        "forwardCompat": false
-      },
-      "RemovedInterfaceDeclaration_IFluidCodeDetailsConfig": {
-        "backCompat": false,
-        "forwardCompat": false
-      },
-      "RemovedInterfaceDeclaration_IFluidPackage": {
-        "backCompat": false,
-        "forwardCompat": false
-      },
-      "RemovedInterfaceDeclaration_IFluidPackageEnvironment": {
-        "backCompat": false,
-        "forwardCompat": false
-      },
-      "RemovedInterfaceDeclaration_IProvideFluidCodeDetailsComparer": {
-        "backCompat": false,
-        "forwardCompat": false
-      },
-      "RemovedVariableDeclaration_isFluidCodeDetails": {
-        "backCompat": false,
-        "forwardCompat": false
-      },
-      "RemovedVariableDeclaration_isFluidPackage": {
-        "backCompat": false,
-        "forwardCompat": false
-      }
-    }
+    "broken": {}
   },
   "scripts": {
     "api": "fluid-build . --task api",
-    "api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
-    "api-extractor:esnext": "flub generate entrypoints --outDir ./lib",
+    "api-extractor:commonjs": "flub generate entrypoints --outFileAlpha legacy --outDir ./dist",
+    "api-extractor:esnext": "flub generate entrypoints --outFileAlpha legacy --outDir ./lib --node10TypeCompat",
     "build": "fluid-build . --task build",
@@ -152,3 +83,3 @@ "build:commonjs": "fluid-build . --task commonjs",
     "build:test:esm": "tsc --project ./src/test/tsconfig.json",
-    "check:are-the-types-wrong": "attw --pack . --entrypoints .",
+    "check:are-the-types-wrong": "attw --pack .",
     "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
@@ -160,3 +91,3 @@ "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
     "ci:test:coverage": "echo No test for this package",
-    "clean": "rimraf --glob dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp",
+    "clean": "rimraf --glob dist lib \"*.d.ts\" \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp",
     "eslint": "eslint --format stylish src",
@@ -170,5 +101,5 @@ "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "tsc:watch": "tsc --watch",
-    "typetests:gen": "fluid-type-test-generator",
+    "typetests:gen": "flub generate typetests --dir . -v --publicFallback",
     "typetests:prepare": "flub typetests --dir . --reset --previous --normalize"
   }
 }

src/handles.ts

@@ -54,3 +54,3 @@ /*!
  */
-export const IFluidHandle: keyof IProvideFluidHandle = "IFluidHandle";
+export const IFluidHandle = "IFluidHandle";
 
@@ -61,3 +61,3 @@ /**
 export interface IProvideFluidHandle {
-	readonly IFluidHandle: IFluidHandle;
+	readonly [IFluidHandle]: IFluidHandle;
 }
@@ -71,3 +71,3 @@
 	// REVIEW: Constrain `T` to something? How do we support dds and datastores safely?
-	T = FluidObject & IFluidLoadable,
+	out T = FluidObject & IFluidLoadable,
 > extends IProvideFluidHandle {
@@ -74,0 +74,0 @@ /**

src/index.ts

@@ -45,1 +45,2 @@ /*!
 export type { ISignalEnvelope } from "./messages.js";
+export type { ErasedType } from "./erasedType.js";

No alert changes

Improved metrics

Total package byte prevSize

333491

increased by8.83%

Number of package files

128

increased by7.56%

Lines of code

3457

increased by10.52%

No dependency changes