@fluidframework/core-interfaces - npm Package Compare versions

Comparing version 0.39.8 to 0.40.0-39960

api-extractor.json

 {
   "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  "extends": "@fluidframework/build-common/api-extractor-common.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"
+  }
 }

dist/fluidPackage.d.ts

@@ -32,3 +32,3 @@ /*!
  * npm package:
- * https://stackoverflow.com/questions/10065564/add-custom-metadata-or-config-to-package-json-is-it-valid
+ * {@link https://stackoverflow.com/questions/10065564/add-custom-metadata-or-config-to-package-json-is-it-valid}
  */
@@ -95,3 +95,3 @@ export interface IFluidPackage {
      * Similar semantics to:
-     *      https://github.com/npm/node-semver#usage
+     * {@link https://github.com/npm/node-semver#usage}
      */
@@ -107,3 +107,3 @@ satisfies(candidate: IFluidCodeDetails, constraint: IFluidCodeDetails): Promise<boolean>;
      * Similar semantics to:
-     *      https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#Description
+     * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#Description | Array.sort}
      */
@@ -110,0 +110,0 @@ compare(a: IFluidCodeDetails, b: IFluidCodeDetails): Promise<number | undefined>;

dist/handles.d.ts

@@ -19,3 +19,3 @@ /*!
      */
-    absolutePath: string;
+    readonly absolutePath: string;
     /**
@@ -25,7 +25,7 @@ * The parent IFluidHandleContext that has provided a route path to this IFluidHandleContext or undefined
      */
-    routeContext?: IFluidHandleContext;
+    readonly routeContext?: IFluidHandleContext;
     /**
      * Flag indicating whether or not the entity has services attached.
      */
-    isAttached: boolean;
+    readonly isAttached: boolean;
     /**
@@ -50,7 +50,7 @@ * Runs through the graph and attach the bounded handles.
      */
-    absolutePath: string;
+    readonly absolutePath: string;
     /**
      * Flag indicating whether or not the entity has services attached.
      */
-    isAttached: boolean;
+    readonly isAttached: boolean;
     /**
@@ -57,0 +57,0 @@ * Runs through the graph and attach the bounded handles.

dist/serializer.d.ts

@@ -27,2 +27,12 @@ /*!
     /**
+     * Given a fully-jsonable object tree that may have encoded handle objects embedded within, will return an
+     * equivalent object tree where any encoded IFluidHandles have been replaced with thier decoded form.
+     *
+     * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from
+     * the root to any replaced handles.  (If no handles are found, returns the original object.)
+     *
+     * The decoded handles are implicitly bound to the handle context of this serializer.
+     */
+    decode(input: any): any;
+    /**
      * Stringifies a given value. Converts any IFluidHandle to its stringified equivalent.
@@ -29,0 +39,0 @@ */

lib/fluidPackage.d.ts

@@ -32,3 +32,3 @@ /*!
  * npm package:
- * https://stackoverflow.com/questions/10065564/add-custom-metadata-or-config-to-package-json-is-it-valid
+ * {@link https://stackoverflow.com/questions/10065564/add-custom-metadata-or-config-to-package-json-is-it-valid}
  */
@@ -95,3 +95,3 @@ export interface IFluidPackage {
      * Similar semantics to:
-     *      https://github.com/npm/node-semver#usage
+     * {@link https://github.com/npm/node-semver#usage}
      */
@@ -107,3 +107,3 @@ satisfies(candidate: IFluidCodeDetails, constraint: IFluidCodeDetails): Promise<boolean>;
      * Similar semantics to:
-     *      https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#Description
+     * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#Description | Array.sort}
      */
@@ -110,0 +110,0 @@ compare(a: IFluidCodeDetails, b: IFluidCodeDetails): Promise<number | undefined>;

lib/handles.d.ts

@@ -19,3 +19,3 @@ /*!
      */
-    absolutePath: string;
+    readonly absolutePath: string;
     /**
@@ -25,7 +25,7 @@ * The parent IFluidHandleContext that has provided a route path to this IFluidHandleContext or undefined
      */
-    routeContext?: IFluidHandleContext;
+    readonly routeContext?: IFluidHandleContext;
     /**
      * Flag indicating whether or not the entity has services attached.
      */
-    isAttached: boolean;
+    readonly isAttached: boolean;
     /**
@@ -50,7 +50,7 @@ * Runs through the graph and attach the bounded handles.
      */
-    absolutePath: string;
+    readonly absolutePath: string;
     /**
      * Flag indicating whether or not the entity has services attached.
      */
-    isAttached: boolean;
+    readonly isAttached: boolean;
     /**
@@ -57,0 +57,0 @@ * Runs through the graph and attach the bounded handles.

lib/serializer.d.ts

@@ -27,2 +27,12 @@ /*!
     /**
+     * Given a fully-jsonable object tree that may have encoded handle objects embedded within, will return an
+     * equivalent object tree where any encoded IFluidHandles have been replaced with thier decoded form.
+     *
+     * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from
+     * the root to any replaced handles.  (If no handles are found, returns the original object.)
+     *
+     * The decoded handles are implicitly bound to the handle context of this serializer.
+     */
+    decode(input: any): any;
+    /**
      * Stringifies a given value. Converts any IFluidHandle to its stringified equivalent.
@@ -29,0 +39,0 @@ */

package.json

 {
   "name": "@fluidframework/core-interfaces",
-  "version": "0.39.8",
+  "version": "0.40.0-39960",
   "description": "Fluid object interfaces",
@@ -14,8 +14,12 @@ "homepage": "https://fluidframework.com",
   "scripts": {
-    "build": "concurrently npm:build:compile npm:lint",
+    "build": "concurrently npm:build:compile npm:lint && npm run build:docs",
     "build:compile": "concurrently npm:tsc npm:build:esnext",
-    "build:docs": "api-extractor run --local && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
+    "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",
+    "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",
+    "ci:test:coverage": "echo No test for this package",
     "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
@@ -32,5 +36,6 @@ "eslint": "eslint --format stylish src",
   "devDependencies": {
-    "@fluidframework/build-common": "^0.22.0",
+    "@fluidframework/build-common": "^0.23.0",
+    "@fluidframework/core-interfaces-0.39.8": "npm:@fluidframework/core-interfaces@0.39.8",
     "@fluidframework/eslint-config-fluid": "^0.23.0",
-    "@microsoft/api-extractor": "^7.13.1",
+    "@microsoft/api-extractor": "^7.16.1",
     "@types/node": "^12.19.0",
@@ -51,3 +56,29 @@ "@typescript-eslint/eslint-plugin": "~4.14.0",
     "typescript-formatter": "7.1.0"
+  },
+  "typeValidation": {
+    "version": "0.40.0",
+    "broken": {
+      "InterfaceDeclaration_IFluidHandle": {
+        "forwardCompat": false
+      },
+      "InterfaceDeclaration_IFluidLoadable": {
+        "forwardCompat": false
+      },
+      "InterfaceDeclaration_IFluidObject": {
+        "forwardCompat": false
+      },
+      "InterfaceDeclaration_IFluidSerializer": {
+        "forwardCompat": false
+      },
+      "InterfaceDeclaration_IProvideFluidHandle": {
+        "forwardCompat": false
+      },
+      "InterfaceDeclaration_IProvideFluidLoadable": {
+        "forwardCompat": false
+      },
+      "InterfaceDeclaration_IProvideFluidSerializer": {
+        "forwardCompat": false
+      }
+    }
   }
 }

src/fluidPackage.ts

@@ -36,3 +36,3 @@ /*!
  * npm package:
- * https://stackoverflow.com/questions/10065564/add-custom-metadata-or-config-to-package-json-is-it-valid
+ * {@link https://stackoverflow.com/questions/10065564/add-custom-metadata-or-config-to-package-json-is-it-valid}
  */
@@ -116,6 +116,7 @@ export interface IFluidPackage {
      * Similar semantics to:
-     *      https://github.com/npm/node-semver#usage
+     * {@link https://github.com/npm/node-semver#usage}
      */
     satisfies(candidate: IFluidCodeDetails, constraint: IFluidCodeDetails): Promise<boolean>;
 
+/* eslint-disable max-len */
     /**
@@ -129,5 +130,6 @@ * Return a number representing the ascending sort order of the `a` and `b` code details;
      * Similar semantics to:
-     *      https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#Description
+     * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#Description | Array.sort}
      */
     compare(a: IFluidCodeDetails, b: IFluidCodeDetails): Promise<number | undefined>;
+/* eslint-enable max-len */
 }

src/handles.ts

@@ -23,3 +23,3 @@ /*!
      */
-    absolutePath: string;
+    readonly absolutePath: string;
 
@@ -30,3 +30,3 @@ /**
      */
-    routeContext?: IFluidHandleContext;
+    readonly routeContext?: IFluidHandleContext;
 
@@ -36,3 +36,3 @@ /**
      */
-    isAttached: boolean;
+    readonly isAttached: boolean;
 
@@ -66,3 +66,3 @@ /**
      */
-    absolutePath: string;
+    readonly absolutePath: string;
 
@@ -72,3 +72,3 @@ /**
      */
-    isAttached: boolean;
+    readonly isAttached: boolean;
 
@@ -75,0 +75,0 @@ /**

src/serializer.ts

@@ -35,2 +35,13 @@ /*!
     /**
+     * Given a fully-jsonable object tree that may have encoded handle objects embedded within, will return an
+     * equivalent object tree where any encoded IFluidHandles have been replaced with thier decoded form.
+     *
+     * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from
+     * the root to any replaced handles.  (If no handles are found, returns the original object.)
+     *
+     * The decoded handles are implicitly bound to the handle context of this serializer.
+     */
+    decode(input: any): any;
+
+    /**
      * Stringifies a given value. Converts any IFluidHandle to its stringified equivalent.
@@ -37,0 +48,0 @@ */

No alert changes

Improved metrics

Total package byte prevSize

142681

increased by68.65%

Number of package files

75

increased by7.14%

Lines of code

1183

increased by9.74%

Worsened metrics

Dev dependency count

19

increased by5.56%

No dependency changes