@fluidframework/core-interfaces - npm Package Compare versions

Comparing version 2.0.0-internal.1.1.1 to 2.0.0-internal.1.2.0.93071

dist/fluidPackage.d.ts

@@ -6,5 +6,6 @@ /*!
 /**
- * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidPackageEnvironment}
+ * Specifies an environment on Fluid property of an {@link IFluidPackage}.
+ *
+ * @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackageEnvironment}
  * to have code loading modules in same package.
- * Specifies an environment on Fluid property of a IFluidPackage
  */
@@ -32,4 +33,2 @@ export interface IFluidPackageEnvironment {
 /**
- * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidPackage}
- * to have code loading modules in same package.
  * Fluid-specific properties expected on a package to be loaded by the code loader.
@@ -39,2 +38,5 @@ * While compatible with the npm package format it is not necessary that that package is an
  * {@link https://stackoverflow.com/questions/10065564/add-custom-metadata-or-config-to-package-json-is-it-valid}
+ *
+ * @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackage}
+ * to have code loading modules in same package.
  */
@@ -64,12 +66,15 @@ export interface IFluidPackage {
 /**
+ * Check if the package.json defines a Fluid package.
+ *
  * @deprecated in favor of {@link @fluidframework/container-definitions#isFluidPackage}
  * to have code loading modules in same package.
- * Check if the package.json defines a Fluid package
- * @param pkg - the package json data to check if it is a Fluid package.
+ *
+ * @param pkg - The package json data to check if it is a Fluid package.
  */
 export declare const isFluidPackage: (pkg: any) => pkg is Readonly<IFluidPackage>;
 /**
+ * Package manager configuration. Provides a key value mapping of config values.
+ *
  * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsConfig}
  * to have code loading modules in same package.
- * Package manager configuration. Provides a key value mapping of config values
  */
@@ -80,5 +85,6 @@ export interface IFluidCodeDetailsConfig {
 /**
+ * Data structure used to describe the code to load on the Fluid document.
+ *
  * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetails}
  * to have code loading modules in same package.
- * Data structure used to describe the code to load on the Fluid document
  */
@@ -98,3 +104,3 @@ export interface IFluidCodeDetails {
  * @deprecated in favor of {@link @fluidframework/container-definitions#isFluidCodeDetails}
- * to have code loading modules in same package
+ * to have code loading modules in same package.
 */
@@ -115,5 +121,6 @@ export declare const isFluidCodeDetails: (details: unknown) => details is Readonly<IFluidCodeDetails>;
 /**
+ * Provides capability to compare Fluid code details.
+ *
  * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsComparer}
  * to have code loading modules in same package.
- * Provides capability to compare Fluid code details.
  */
@@ -136,3 +143,3 @@ export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsComparer {
      * Similar semantics to:
-     * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#Description | Array.sort}
+     * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#description | Array.sort}
      */
@@ -139,0 +146,0 @@ compare(a: IFluidCodeDetails, b: IFluidCodeDetails): Promise<number | undefined>;

dist/fluidPackage.js

@@ -9,6 +9,8 @@ "use strict";
 /**
+ * Check if the package.json defines a Fluid package.
+ *
  * @deprecated in favor of {@link @fluidframework/container-definitions#isFluidPackage}
  * to have code loading modules in same package.
- * Check if the package.json defines a Fluid package
- * @param pkg - the package json data to check if it is a Fluid package.
+ *
+ * @param pkg - The package json data to check if it is a Fluid package.
  */
@@ -21,3 +23,3 @@ const isFluidPackage = (pkg) => typeof pkg === "object"
  * @deprecated in favor of {@link @fluidframework/container-definitions#isFluidCodeDetails}
- * to have code loading modules in same package
+ * to have code loading modules in same package.
 */
@@ -24,0 +26,0 @@ const isFluidCodeDetails = (details) => {

dist/handles.d.ts

@@ -44,3 +44,3 @@ /*!
     /**
-     * @deprecated - Do not use handle's path for routing. Use `get` to get the underlying object.
+     * @deprecated Do not use handle's path for routing. Use `get` to get the underlying object.
      *
@@ -47,0 +47,0 @@ * The absolute path to the handle context from the root.

lib/fluidPackage.d.ts

@@ -6,5 +6,6 @@ /*!
 /**
- * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidPackageEnvironment}
+ * Specifies an environment on Fluid property of an {@link IFluidPackage}.
+ *
+ * @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackageEnvironment}
  * to have code loading modules in same package.
- * Specifies an environment on Fluid property of a IFluidPackage
  */
@@ -32,4 +33,2 @@ export interface IFluidPackageEnvironment {
 /**
- * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidPackage}
- * to have code loading modules in same package.
  * Fluid-specific properties expected on a package to be loaded by the code loader.
@@ -39,2 +38,5 @@ * While compatible with the npm package format it is not necessary that that package is an
  * {@link https://stackoverflow.com/questions/10065564/add-custom-metadata-or-config-to-package-json-is-it-valid}
+ *
+ * @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackage}
+ * to have code loading modules in same package.
  */
@@ -64,12 +66,15 @@ export interface IFluidPackage {
 /**
+ * Check if the package.json defines a Fluid package.
+ *
  * @deprecated in favor of {@link @fluidframework/container-definitions#isFluidPackage}
  * to have code loading modules in same package.
- * Check if the package.json defines a Fluid package
- * @param pkg - the package json data to check if it is a Fluid package.
+ *
+ * @param pkg - The package json data to check if it is a Fluid package.
  */
 export declare const isFluidPackage: (pkg: any) => pkg is Readonly<IFluidPackage>;
 /**
+ * Package manager configuration. Provides a key value mapping of config values.
+ *
  * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsConfig}
  * to have code loading modules in same package.
- * Package manager configuration. Provides a key value mapping of config values
  */
@@ -80,5 +85,6 @@ export interface IFluidCodeDetailsConfig {
 /**
+ * Data structure used to describe the code to load on the Fluid document.
+ *
  * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetails}
  * to have code loading modules in same package.
- * Data structure used to describe the code to load on the Fluid document
  */
@@ -98,3 +104,3 @@ export interface IFluidCodeDetails {
  * @deprecated in favor of {@link @fluidframework/container-definitions#isFluidCodeDetails}
- * to have code loading modules in same package
+ * to have code loading modules in same package.
 */
@@ -115,5 +121,6 @@ export declare const isFluidCodeDetails: (details: unknown) => details is Readonly<IFluidCodeDetails>;
 /**
+ * Provides capability to compare Fluid code details.
+ *
  * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsComparer}
  * to have code loading modules in same package.
- * Provides capability to compare Fluid code details.
  */
@@ -136,3 +143,3 @@ export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsComparer {
      * Similar semantics to:
-     * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#Description | Array.sort}
+     * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#description | Array.sort}
      */
@@ -139,0 +146,0 @@ compare(a: IFluidCodeDetails, b: IFluidCodeDetails): Promise<number | undefined>;

lib/fluidPackage.js

@@ -6,6 +6,8 @@ /*!
 /**
+ * Check if the package.json defines a Fluid package.
+ *
  * @deprecated in favor of {@link @fluidframework/container-definitions#isFluidPackage}
  * to have code loading modules in same package.
- * Check if the package.json defines a Fluid package
- * @param pkg - the package json data to check if it is a Fluid package.
+ *
+ * @param pkg - The package json data to check if it is a Fluid package.
  */
@@ -17,3 +19,3 @@ export const isFluidPackage = (pkg) => typeof pkg === "object"
  * @deprecated in favor of {@link @fluidframework/container-definitions#isFluidCodeDetails}
- * to have code loading modules in same package
+ * to have code loading modules in same package.
 */
@@ -20,0 +22,0 @@ export const isFluidCodeDetails = (details) => {

lib/handles.d.ts

@@ -44,3 +44,3 @@ /*!
     /**
-     * @deprecated - Do not use handle's path for routing. Use `get` to get the underlying object.
+     * @deprecated Do not use handle's path for routing. Use `get` to get the underlying object.
      *
@@ -47,0 +47,0 @@ * The absolute path to the handle context from the root.

package.json

 {
   "name": "@fluidframework/core-interfaces",
-  "version": "2.0.0-internal.1.1.1",
+  "version": "2.0.0-internal.1.2.0.93071",
   "description": "Fluid object interfaces",
@@ -33,3 +33,2 @@ "homepage": "https://fluidframework.com",
     "lint:fix": "npm run eslint:fix",
-    "test": "npm run test:types",
     "tsc": "tsc",
@@ -42,4 +41,4 @@ "tsc:watch": "tsc --watch",
   "devDependencies": {
-    "@fluidframework/build-common": "^0.24.0",
-    "@fluidframework/build-tools": "^0.3.1000",
+    "@fluidframework/build-common": "^1.0.0",
+    "@fluidframework/build-tools": "^0.4.4000",
     "@fluidframework/core-interfaces-previous": "npm:@fluidframework/core-interfaces@^1.1.0",
@@ -46,0 +45,0 @@ "@fluidframework/eslint-config-fluid": "^0.28.2000",

src/fluidPackage.ts

@@ -7,5 +7,6 @@ /*!
  /**
-  * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidPackageEnvironment}
+  * Specifies an environment on Fluid property of an {@link IFluidPackage}.
+  *
+  * @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackageEnvironment}
   * to have code loading modules in same package.
-  * Specifies an environment on Fluid property of a IFluidPackage
   */
@@ -35,4 +36,2 @@ export interface IFluidPackageEnvironment {
 /**
- * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidPackage}
- * to have code loading modules in same package.
  * Fluid-specific properties expected on a package to be loaded by the code loader.
@@ -42,2 +41,5 @@ * While compatible with the npm package format it is not necessary that that package is an
  * {@link https://stackoverflow.com/questions/10065564/add-custom-metadata-or-config-to-package-json-is-it-valid}
+ *
+ * @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackage}
+ * to have code loading modules in same package.
  */
@@ -68,6 +70,8 @@ export interface IFluidPackage {
 /**
+ * Check if the package.json defines a Fluid package.
+ *
  * @deprecated in favor of {@link @fluidframework/container-definitions#isFluidPackage}
  * to have code loading modules in same package.
- * Check if the package.json defines a Fluid package
- * @param pkg - the package json data to check if it is a Fluid package.
+ *
+ * @param pkg - The package json data to check if it is a Fluid package.
  */
@@ -80,5 +84,6 @@ export const isFluidPackage = (pkg: any): pkg is Readonly<IFluidPackage> =>
 /**
+ * Package manager configuration. Provides a key value mapping of config values.
+ *
  * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsConfig}
  * to have code loading modules in same package.
- * Package manager configuration. Provides a key value mapping of config values
  */
@@ -90,5 +95,6 @@ export interface IFluidCodeDetailsConfig {
 /**
+ * Data structure used to describe the code to load on the Fluid document.
+ *
  * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetails}
  * to have code loading modules in same package.
- * Data structure used to describe the code to load on the Fluid document
  */
@@ -110,3 +116,3 @@ export interface IFluidCodeDetails {
  * @deprecated in favor of {@link @fluidframework/container-definitions#isFluidCodeDetails}
- * to have code loading modules in same package
+ * to have code loading modules in same package.
 */
@@ -135,5 +141,6 @@ export const isFluidCodeDetails = (details: unknown): details is Readonly<IFluidCodeDetails> => {
 /**
+ * Provides capability to compare Fluid code details.
+ *
  * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsComparer}
  * to have code loading modules in same package.
- * Provides capability to compare Fluid code details.
  */
@@ -159,3 +166,3 @@ export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsComparer {
      * Similar semantics to:
-     * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#Description | Array.sort}
+     * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#description | Array.sort}
      */
@@ -162,0 +169,0 @@ compare(a: IFluidCodeDetails, b: IFluidCodeDetails): Promise<number | undefined>;

src/handles.ts

@@ -59,3 +59,3 @@ /*!
     /**
-     * @deprecated - Do not use handle's path for routing. Use `get` to get the underlying object.
+     * @deprecated Do not use handle's path for routing. Use `get` to get the underlying object.
      *
@@ -62,0 +62,0 @@ * The absolute path to the handle context from the root.

No alert changes

Improved metrics

Total package byte prevSize

151796

increased by0.12%

Lines of code

1445

increased by1.76%

No dependency changes