@fluidframework/core-interfaces - npm Package Compare versions

Comparing version 0.43.1000 to 1.0.0

api-extractor.json

 {
   "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  "extends": "@fluidframework/build-common/api-extractor-common-report.json",
-  "apiReport": {
-    "enabled": true,
-    "reportFolder": "<projectFolder>/api-report/"
-  },
-  "docModel": {
-    "enabled": true,
-    "apiJsonFilePath": "<projectFolder>/_api-extractor-temp/doc-models/<unscopedPackageName>.api.json"
-  }
+  "extends": "@fluidframework/build-common/api-extractor-common-report.json"
 }

dist/fluidObject.d.ts

@@ -5,6 +5,2 @@ /*!
  */
-import { IFluidLoadable, IFluidRunnable } from "./fluidLoadable";
-import { IFluidRouter } from "./fluidRouter";
-import { IFluidHandle, IFluidHandleContext } from "./handles";
-import { IFluidSerializer } from "./serializer";
 /**
@@ -14,27 +10,3 @@ * @deprecated Use `FluidObject` or the interface directly instead
 export interface IFluidObject {
-    /**
-     * @deprecated - use `FluidObject<IFluidLoadable>` instead
-     */
-    readonly IFluidLoadable?: IFluidLoadable;
-    /**
-     * @deprecated - use `FluidObject<IFluidRunnable>` instead
-     */
-    readonly IFluidRunnable?: IFluidRunnable;
-    /**
-     * @deprecated - use `FluidObject<IFluidRouter>` instead
-     */
-    readonly IFluidRouter?: IFluidRouter;
-    /**
-     * @deprecated - use `FluidObject<IFluidHandleContext>` instead
-     */
-    readonly IFluidHandleContext?: IFluidHandleContext;
-    /**
-     * @deprecated - use `FluidObject<IFluidHandle>` instead
-     */
-    readonly IFluidHandle?: IFluidHandle;
-    /**
-     * @deprecated - use `FluidObject<IFluidSerializer>` instead
-     */
-    readonly IFluidSerializer?: IFluidSerializer;
 }
 //# sourceMappingURL=fluidObject.d.ts.map

dist/fluidPackage.js

@@ -25,3 +25,3 @@ "use strict";
     return typeof maybeCodeDetails === "object"
-        && (typeof (maybeCodeDetails === null || maybeCodeDetails === void 0 ? void 0 : maybeCodeDetails.package) === "string" || exports.isFluidPackage(maybeCodeDetails === null || maybeCodeDetails === void 0 ? void 0 : maybeCodeDetails.package))
+        && (typeof (maybeCodeDetails === null || maybeCodeDetails === void 0 ? void 0 : maybeCodeDetails.package) === "string" || (0, exports.isFluidPackage)(maybeCodeDetails === null || maybeCodeDetails === void 0 ? void 0 : maybeCodeDetails.package))
         && ((maybeCodeDetails === null || maybeCodeDetails === void 0 ? void 0 : maybeCodeDetails.config) === undefined || typeof (maybeCodeDetails === null || maybeCodeDetails === void 0 ? void 0 : maybeCodeDetails.config) === "object");
@@ -28,0 +28,0 @@ };

dist/index.d.ts

@@ -9,5 +9,4 @@ /*!
 export * from "./handles";
-export * from "./serializer";
 export * from "./fluidPackage";
 export * from "./provider";
 //# sourceMappingURL=index.d.ts.map

dist/index.js

@@ -25,5 +25,4 @@ "use strict";
 __exportStar(require("./handles"), exports);
-__exportStar(require("./serializer"), exports);
 __exportStar(require("./fluidPackage"), exports);
 __exportStar(require("./provider"), exports);
 //# sourceMappingURL=index.js.map

lib/fluidObject.d.ts

@@ -5,6 +5,2 @@ /*!
  */
-import { IFluidLoadable, IFluidRunnable } from "./fluidLoadable";
-import { IFluidRouter } from "./fluidRouter";
-import { IFluidHandle, IFluidHandleContext } from "./handles";
-import { IFluidSerializer } from "./serializer";
 /**
@@ -14,27 +10,3 @@ * @deprecated Use `FluidObject` or the interface directly instead
 export interface IFluidObject {
-    /**
-     * @deprecated - use `FluidObject<IFluidLoadable>` instead
-     */
-    readonly IFluidLoadable?: IFluidLoadable;
-    /**
-     * @deprecated - use `FluidObject<IFluidRunnable>` instead
-     */
-    readonly IFluidRunnable?: IFluidRunnable;
-    /**
-     * @deprecated - use `FluidObject<IFluidRouter>` instead
-     */
-    readonly IFluidRouter?: IFluidRouter;
-    /**
-     * @deprecated - use `FluidObject<IFluidHandleContext>` instead
-     */
-    readonly IFluidHandleContext?: IFluidHandleContext;
-    /**
-     * @deprecated - use `FluidObject<IFluidHandle>` instead
-     */
-    readonly IFluidHandle?: IFluidHandle;
-    /**
-     * @deprecated - use `FluidObject<IFluidSerializer>` instead
-     */
-    readonly IFluidSerializer?: IFluidSerializer;
 }
 //# sourceMappingURL=fluidObject.d.ts.map

lib/index.d.ts

@@ -9,5 +9,4 @@ /*!
 export * from "./handles";
-export * from "./serializer";
 export * from "./fluidPackage";
 export * from "./provider";
 //# sourceMappingURL=index.d.ts.map

lib/index.js

@@ -11,5 +11,4 @@ /*!
 export * from "./handles";
-export * from "./serializer";
 export * from "./fluidPackage";
 export * from "./provider";
 //# sourceMappingURL=index.js.map

lib/test/types/validateCoreInterfacesPrevious.js

@@ -15,6 +15,2 @@ use_current_TypeAliasDeclaration_FluidObject(get_old_TypeAliasDeclaration_FluidObject());
 use_old_InterfaceDeclaration_IFluidCodeDetailsConfig(get_current_InterfaceDeclaration_IFluidCodeDetailsConfig());
-use_current_RemovedVariableDeclaration_IFluidConfiguration(get_old_VariableDeclaration_IFluidConfiguration());
-use_old_VariableDeclaration_IFluidConfiguration(get_current_RemovedVariableDeclaration_IFluidConfiguration());
-use_current_RemovedInterfaceDeclaration_IFluidConfiguration(get_old_InterfaceDeclaration_IFluidConfiguration());
-use_old_InterfaceDeclaration_IFluidConfiguration(get_current_RemovedInterfaceDeclaration_IFluidConfiguration());
 use_current_VariableDeclaration_IFluidHandle(get_old_VariableDeclaration_IFluidHandle());
@@ -46,10 +42,4 @@ use_old_VariableDeclaration_IFluidHandle(get_current_VariableDeclaration_IFluidHandle());
 use_old_InterfaceDeclaration_IFluidRunnable(get_current_InterfaceDeclaration_IFluidRunnable());
-use_current_VariableDeclaration_IFluidSerializer(get_old_VariableDeclaration_IFluidSerializer());
-use_old_VariableDeclaration_IFluidSerializer(get_current_VariableDeclaration_IFluidSerializer());
-use_current_InterfaceDeclaration_IFluidSerializer(get_old_InterfaceDeclaration_IFluidSerializer());
-use_old_InterfaceDeclaration_IFluidSerializer(get_current_InterfaceDeclaration_IFluidSerializer());
 use_current_InterfaceDeclaration_IProvideFluidCodeDetailsComparer(get_old_InterfaceDeclaration_IProvideFluidCodeDetailsComparer());
 use_old_InterfaceDeclaration_IProvideFluidCodeDetailsComparer(get_current_InterfaceDeclaration_IProvideFluidCodeDetailsComparer());
-use_current_RemovedInterfaceDeclaration_IProvideFluidConfiguration(get_old_InterfaceDeclaration_IProvideFluidConfiguration());
-use_old_InterfaceDeclaration_IProvideFluidConfiguration(get_current_RemovedInterfaceDeclaration_IProvideFluidConfiguration());
 use_current_InterfaceDeclaration_IProvideFluidHandle(get_old_InterfaceDeclaration_IProvideFluidHandle());
@@ -65,4 +55,2 @@ use_old_InterfaceDeclaration_IProvideFluidHandle(get_current_InterfaceDeclaration_IProvideFluidHandle());
 use_old_InterfaceDeclaration_IProvideFluidRunnable(get_current_InterfaceDeclaration_IProvideFluidRunnable());
-use_current_InterfaceDeclaration_IProvideFluidSerializer(get_old_InterfaceDeclaration_IProvideFluidSerializer());
-use_old_InterfaceDeclaration_IProvideFluidSerializer(get_current_InterfaceDeclaration_IProvideFluidSerializer());
 use_current_InterfaceDeclaration_IRequest(get_old_InterfaceDeclaration_IRequest());
@@ -74,4 +62,2 @@ use_old_InterfaceDeclaration_IRequest(get_current_InterfaceDeclaration_IRequest());
 use_old_InterfaceDeclaration_IResponse(get_current_InterfaceDeclaration_IResponse());
-use_current_InterfaceDeclaration_ISerializedHandle(get_old_InterfaceDeclaration_ISerializedHandle());
-use_old_InterfaceDeclaration_ISerializedHandle(get_current_InterfaceDeclaration_ISerializedHandle());
 use_current_VariableDeclaration_isFluidCodeDetails(get_old_VariableDeclaration_isFluidCodeDetails());
@@ -78,0 +64,0 @@ use_old_VariableDeclaration_isFluidCodeDetails(get_current_VariableDeclaration_isFluidCodeDetails());

package.json

 {
   "name": "@fluidframework/core-interfaces",
-  "version": "0.43.1000",
+  "version": "1.0.0",
   "description": "Fluid object interfaces",
@@ -18,11 +18,10 @@ "homepage": "https://fluidframework.com",
   "scripts": {
-    "build": "npm run build:gen && concurrently npm:build:compile npm:lint && npm run build:docs",
-    "build:compile": "concurrently npm:tsc 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": "concurrently npm:build:compile npm:lint && npm run build:docs",
+    "build:compile": "concurrently npm:typetests:gen npm:tsc 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:gen": "npm run typetests:gen",
-    "ci:build": "npm run build:gen && 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: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",
@@ -40,44 +39,37 @@ "ci:test:coverage": "echo No test for this package",
     "tsfmt:fix": "tsfmt --replace",
-    "typetests:gen": "fluid-type-validator -d .",
-    "typetests:prepare": "fluid-type-validator -d . -p"
+    "typetests:gen": "fluid-type-validator -g -d ."
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/build-tools": "^0.2.61288",
-    "@fluidframework/core-interfaces-previous": "npm:@fluidframework/core-interfaces@^0.42.0",
-    "@fluidframework/eslint-config-fluid": "^0.28.1000",
-    "@microsoft/api-extractor": "^7.16.1",
+    "@fluidframework/build-tools": "^0.2.71273",
+    "@fluidframework/core-interfaces-previous": "npm:@fluidframework/core-interfaces@0.43.1000",
+    "@fluidframework/eslint-config-fluid": "^0.28.2000",
+    "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/node": "^14.18.0",
-    "@typescript-eslint/eslint-plugin": "~5.9.0",
-    "@typescript-eslint/parser": "~5.9.0",
     "concurrently": "^6.2.0",
     "copyfiles": "^2.1.0",
     "eslint": "~8.6.0",
-    "eslint-plugin-editorconfig": "~3.2.0",
-    "eslint-plugin-eslint-comments": "~3.2.0",
-    "eslint-plugin-import": "~2.25.4",
-    "eslint-plugin-no-null": "~1.0.2",
-    "eslint-plugin-react": "~7.28.0",
-    "eslint-plugin-unicorn": "~40.0.0",
     "rimraf": "^2.6.2",
-    "typescript": "~4.1.3",
+    "typescript": "~4.5.5",
     "typescript-formatter": "7.1.0"
   },
   "typeValidation": {
-    "version": "0.43.1000",
+    "version": "0.44.1000",
     "broken": {
-      "0.42.0": {
-        "RemovedVariableDeclaration_IFluidConfiguration": {
-          "backCompat": false,
-          "forwardCompat": false
-        },
-        "RemovedInterfaceDeclaration_IFluidConfiguration": {
-          "backCompat": false,
-          "forwardCompat": false
-        },
-        "RemovedInterfaceDeclaration_IProvideFluidConfiguration": {
-          "backCompat": false,
-          "forwardCompat": false
-        }
+      "RemovedVariableDeclaration_IFluidSerializer": {
+        "backCompat": false,
+        "forwardCompat": false
+      },
+      "RemovedInterfaceDeclaration_IFluidSerializer": {
+        "backCompat": false,
+        "forwardCompat": false
+      },
+      "RemovedInterfaceDeclaration_IProvideFluidSerializer": {
+        "backCompat": false,
+        "forwardCompat": false
+      },
+      "RemovedInterfaceDeclaration_ISerializedHandle": {
+        "backCompat": false,
+        "forwardCompat": false
       }
@@ -84,0 +76,0 @@ }

src/fluidObject.ts

@@ -6,39 +6,8 @@ /*!
 
-import {
-    IFluidLoadable,
-    IFluidRunnable,
-} from "./fluidLoadable";
-import { IFluidRouter } from "./fluidRouter";
-import { IFluidHandle, IFluidHandleContext } from "./handles";
-import { IFluidSerializer } from "./serializer";
-
 /**
  * @deprecated Use `FluidObject` or the interface directly instead
  */
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
 export interface IFluidObject {
 
-    /**
-     * @deprecated - use `FluidObject<IFluidLoadable>` instead
-     */
-    readonly IFluidLoadable?: IFluidLoadable;
-    /**
-     * @deprecated - use `FluidObject<IFluidRunnable>` instead
-     */
-    readonly IFluidRunnable?: IFluidRunnable
-    /**
-     * @deprecated - use `FluidObject<IFluidRouter>` instead
-     */
-    readonly IFluidRouter?: IFluidRouter;
-    /**
-     * @deprecated - use `FluidObject<IFluidHandleContext>` instead
-     */
-    readonly IFluidHandleContext?: IFluidHandleContext;
-    /**
-     * @deprecated - use `FluidObject<IFluidHandle>` instead
-     */
-    readonly IFluidHandle?: IFluidHandle;
-    /**
-     * @deprecated - use `FluidObject<IFluidSerializer>` instead
-     */
-    readonly IFluidSerializer?: IFluidSerializer;
 }

src/fluidPackage.ts

@@ -30,3 +30,3 @@ /*!
         [key: string]: unknown;
-    }
+    };
 }
@@ -107,3 +107,3 @@
 */
-export const isFluidCodeDetails = (details: unknown): details is Readonly<IFluidCodeDetails> =>{
+export const isFluidCodeDetails = (details: unknown): details is Readonly<IFluidCodeDetails> => {
     const maybeCodeDetails = details as Partial<IFluidCodeDetails> | undefined;
@@ -110,0 +110,0 @@ return typeof maybeCodeDetails === "object"

src/fluidRouter.ts

@@ -19,3 +19,3 @@ /*!
     value: any;
-    headers?: { [key: string]: any };
+    headers?: { [key: string]: any; };
     stack?: string;
@@ -22,0 +22,0 @@ }

src/handles.ts

@@ -55,3 +55,3 @@ /*!
     // REVIEW: Constrain `T` to something? How do we support dds and datastores safely?
-    T = FluidObject & IFluidLoadable
+    T = FluidObject & IFluidLoadable,
     > extends IProvideFluidHandle {
@@ -58,0 +58,0 @@

src/index.ts

@@ -22,4 +22,3 @@ /*!
 export * from "./handles";
-export * from "./serializer";
 export * from "./fluidPackage";
 export * from "./provider";

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Dev dependency count

13

decreased by-38.1%

Number of low quality alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

154619

decreased by-19.32%

Number of package files

78

decreased by-11.36%

Lines of code

1408

decreased by-17.13%

No dependency changes