@fluidframework/core-interfaces - npm Package Compare versions

Comparing version 2.0.0-internal.6.3.3 to 2.0.0-internal.6.4.0

.eslintrc.js

@@ -7,3 +7,3 @@ /*!
 module.exports = {
-	extends: [require.resolve("@fluidframework/eslint-config-fluid/minimal"), "prettier"],
+	extends: [require.resolve("@fluidframework/eslint-config-fluid"), "prettier"],
 	parserOptions: {
@@ -10,0 +10,0 @@ project: ["./tsconfig.json", "./src/test/tsconfig.json"],

CHANGELOG.md

 # @fluidframework/core-interfaces
 
+## 2.0.0-internal.6.4.0
+
+Dependency updates only.
+
 ## 2.0.0-internal.6.3.0
@@ -4,0 +8,0 @@

dist/events.d.ts

@@ -53,2 +53,3 @@ /*!
  * @example
+ *
  * ``` typescript
@@ -69,2 +70,3 @@ * interface AEvents extends IEvent{
  * ```
+ *
  * interface B will now extend interface A and its events
@@ -71,0 +73,0 @@ *

dist/fluidPackage.d.ts

@@ -70,3 +70,3 @@ /*!
  */
-export declare const isFluidPackage: (pkg: any) => pkg is Readonly<IFluidPackage>;
+export declare const isFluidPackage: (pkg: unknown) => pkg is Readonly<IFluidPackage>;
 /**
@@ -73,0 +73,0 @@ * Package manager configuration. Provides a key value mapping of config values.

dist/fluidPackage.js

@@ -16,4 +16,7 @@ "use strict";
  */
-const isFluidPackage = (pkg) => typeof pkg === "object" && typeof pkg?.name === "string" && typeof pkg?.fluid === "object";
+const isFluidPackage = (pkg) => typeof pkg === "object" &&
+    typeof pkg?.name === "string" &&
+    typeof pkg?.fluid === "object";
 exports.isFluidPackage = isFluidPackage;
+// eslint-disable-next-line jsdoc/require-description
 /**
@@ -20,0 +23,0 @@ * @deprecated in favor of {@link @fluidframework/container-definitions#isFluidCodeDetails}

dist/index.js

@@ -17,3 +17,3 @@ "use strict";
 Object.defineProperty(exports, "IFluidCodeDetailsComparer", { enumerable: true, get: function () { return fluidPackage_1.IFluidCodeDetailsComparer; } });
-// Typescript forgets the index signature when customers augment IRequestHeader if we export *.
+// TypeScript forgets the index signature when customers augment IRequestHeader if we export *.
 // So we export the explicit members as a workaround:
@@ -20,0 +20,0 @@ // https://github.com/microsoft/TypeScript/issues/18877#issuecomment-476921038

dist/provider.d.ts

@@ -6,4 +6,6 @@ /*!
 /**
- * This utility type is meant for internal use by {@link FluidObject}
  * Produces a valid FluidObject key given a type and a property.
+ *
+ * @remarks
+ *
  * A valid FluidObject key is a property that exists on the incoming type
@@ -13,3 +15,6 @@ * as well as on the type of the property itself. For example: `IProvideFoo.IFoo.IFoo`
  *
+ * This utility type is meant for internal use by {@link FluidObject}
+ *
  * @example
+ *
  * ```typescript
@@ -23,5 +28,5 @@ * interface IProvideFoo{
  * ```
+ *
  * This pattern enables discovery, and delegation in a standard way which is central
- * to FluidObject pattern
- *
+ * to FluidObject pattern.
  */
@@ -38,3 +43,5 @@ export declare type FluidObjectProviderKeys<T, TProp extends keyof T = keyof T> = string extends TProp ? never : number extends TProp ? never : TProp extends keyof Required<T>[TProp] ? Required<T>[TProp] extends Required<Required<T>[TProp]>[TProp] ? TProp : never : never;
  * @example
- * For example, if we have an interface like below
+ *
+ * For example, if we have an interface like the following:
+ *
  * ```typescript
@@ -41,0 +48,0 @@ * interface IProvideFoo{

lib/events.d.ts

@@ -53,2 +53,3 @@ /*!
  * @example
+ *
  * ``` typescript
@@ -69,2 +70,3 @@ * interface AEvents extends IEvent{
  * ```
+ *
  * interface B will now extend interface A and its events
@@ -71,0 +73,0 @@ *

lib/fluidPackage.d.ts

@@ -70,3 +70,3 @@ /*!
  */
-export declare const isFluidPackage: (pkg: any) => pkg is Readonly<IFluidPackage>;
+export declare const isFluidPackage: (pkg: unknown) => pkg is Readonly<IFluidPackage>;
 /**
@@ -73,0 +73,0 @@ * Package manager configuration. Provides a key value mapping of config values.

lib/fluidPackage.js

@@ -13,3 +13,6 @@ /*!
  */
-export const isFluidPackage = (pkg) => typeof pkg === "object" && typeof pkg?.name === "string" && typeof pkg?.fluid === "object";
+export const isFluidPackage = (pkg) => typeof pkg === "object" &&
+    typeof pkg?.name === "string" &&
+    typeof pkg?.fluid === "object";
+// eslint-disable-next-line jsdoc/require-description
 /**
@@ -16,0 +19,0 @@ * @deprecated in favor of {@link @fluidframework/container-definitions#isFluidCodeDetails}

lib/index.js

@@ -8,3 +8,3 @@ /*!
 export { isFluidPackage, isFluidCodeDetails, IFluidCodeDetailsComparer, } from "./fluidPackage";
-// Typescript forgets the index signature when customers augment IRequestHeader if we export *.
+// TypeScript forgets the index signature when customers augment IRequestHeader if we export *.
 // So we export the explicit members as a workaround:
@@ -11,0 +11,0 @@ // https://github.com/microsoft/TypeScript/issues/18877#issuecomment-476921038

lib/provider.d.ts

@@ -6,4 +6,6 @@ /*!
 /**
- * This utility type is meant for internal use by {@link FluidObject}
  * Produces a valid FluidObject key given a type and a property.
+ *
+ * @remarks
+ *
  * A valid FluidObject key is a property that exists on the incoming type
@@ -13,3 +15,6 @@ * as well as on the type of the property itself. For example: `IProvideFoo.IFoo.IFoo`
  *
+ * This utility type is meant for internal use by {@link FluidObject}
+ *
  * @example
+ *
  * ```typescript
@@ -23,5 +28,5 @@ * interface IProvideFoo{
  * ```
+ *
  * This pattern enables discovery, and delegation in a standard way which is central
- * to FluidObject pattern
- *
+ * to FluidObject pattern.
  */
@@ -38,3 +43,5 @@ export declare type FluidObjectProviderKeys<T, TProp extends keyof T = keyof T> = string extends TProp ? never : number extends TProp ? never : TProp extends keyof Required<T>[TProp] ? Required<T>[TProp] extends Required<Required<T>[TProp]>[TProp] ? TProp : never : never;
  * @example
- * For example, if we have an interface like below
+ *
+ * For example, if we have an interface like the following:
+ *
  * ```typescript
@@ -41,0 +48,0 @@ * interface IProvideFoo{

package.json

 {
   "name": "@fluidframework/core-interfaces",
-  "version": "2.0.0-internal.6.3.3",
+  "version": "2.0.0-internal.6.4.0",
   "description": "Fluid object interfaces",
@@ -21,3 +21,3 @@ "homepage": "https://fluidframework.com",
     "@fluidframework/build-tools": "^0.22.0",
-    "@fluidframework/core-interfaces-previous": "npm:@fluidframework/core-interfaces@2.0.0-internal.6.3.1",
+    "@fluidframework/core-interfaces-previous": "npm:@fluidframework/core-interfaces@2.0.0-internal.6.3.0",
     "@fluidframework/eslint-config-fluid": "^2.1.0",
@@ -24,0 +24,0 @@ "@microsoft/api-extractor": "^7.34.4",

src/error.ts

@@ -96,2 +96,5 @@ /*!
 	readonly errorType: typeof FluidErrorTypes.genericError;
+
+	// TODO: Use `unknown` instead (API-Breaking)
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	error?: any;
@@ -98,0 +101,0 @@ }

src/events.ts

@@ -61,2 +61,3 @@ /*!
  * @example
+ *
  * ``` typescript
@@ -77,2 +78,3 @@ * interface AEvents extends IEvent{
  * ```
+ *
  * interface B will now extend interface A and its events
@@ -79,0 +81,0 @@ *

src/fluidLoadable.ts

@@ -27,4 +27,6 @@ /*!
 export interface IFluidRunnable {
+	// TODO: Use `unknown` instead (API-Breaking)
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	run(...args: any[]): Promise<void>;
 	stop(reason?: string): void;
 }

src/fluidPackage.ts

@@ -76,4 +76,6 @@ /*!
  */
-export const isFluidPackage = (pkg: any): pkg is Readonly<IFluidPackage> =>
-	typeof pkg === "object" && typeof pkg?.name === "string" && typeof pkg?.fluid === "object";
+export const isFluidPackage = (pkg: unknown): pkg is Readonly<IFluidPackage> =>
+	typeof pkg === "object" &&
+	typeof (pkg as Partial<IFluidPackage>)?.name === "string" &&
+	typeof (pkg as Partial<IFluidPackage>)?.fluid === "object";
 
@@ -109,2 +111,3 @@ /**
 
+// eslint-disable-next-line jsdoc/require-description
 /**
@@ -111,0 +114,0 @@ * @deprecated in favor of {@link @fluidframework/container-definitions#isFluidCodeDetails}

src/fluidRouter.ts

@@ -7,2 +7,4 @@ /*!
 export interface IRequestHeader {
+	// TODO: Use `unknown` instead (API-Breaking)
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	[index: string]: any;
@@ -19,3 +21,7 @@ }
 	status: number;
+	// TODO: Use `unknown` instead (API-Breaking)
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	value: any;
+	// TODO: Use `unknown` instead (API-Breaking)
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	headers?: { [key: string]: any };
@@ -22,0 +28,0 @@ stack?: string;

src/index.ts

@@ -45,3 +45,3 @@ /*!
 
-// Typescript forgets the index signature when customers augment IRequestHeader if we export *.
+// TypeScript forgets the index signature when customers augment IRequestHeader if we export *.
 // So we export the explicit members as a workaround:
@@ -48,0 +48,0 @@ // https://github.com/microsoft/TypeScript/issues/18877#issuecomment-476921038

src/logger.ts

@@ -167,5 +167,6 @@ /*!
 	 */
-	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	sendTelemetryEvent(
 		event: ITelemetryGenericEvent,
+		// TODO: Use `unknown` instead (API-Breaking)
+		// eslint-disable-next-line @typescript-eslint/no-explicit-any
 		error?: any,
@@ -189,5 +190,6 @@ logLevel?: typeof LogLevel.verbose | typeof LogLevel.default,
 	 */
-	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	sendPerformanceEvent(
 		event: ITelemetryPerformanceEvent,
+		// TODO: Use `unknown` instead (API-Breaking)
+		// eslint-disable-next-line @typescript-eslint/no-explicit-any
 		error?: any,
@@ -194,0 +196,0 @@ logLevel?: typeof LogLevel.verbose | typeof LogLevel.default,

src/provider.ts

@@ -7,4 +7,6 @@ /*!
 /**
- * This utility type is meant for internal use by {@link FluidObject}
  * Produces a valid FluidObject key given a type and a property.
+ *
+ * @remarks
+ *
  * A valid FluidObject key is a property that exists on the incoming type
@@ -14,3 +16,6 @@ * as well as on the type of the property itself. For example: `IProvideFoo.IFoo.IFoo`
  *
+ * This utility type is meant for internal use by {@link FluidObject}
+ *
  * @example
+ *
  * ```typescript
@@ -24,5 +29,5 @@ * interface IProvideFoo{
  * ```
+ *
  * This pattern enables discovery, and delegation in a standard way which is central
- * to FluidObject pattern
- *
+ * to FluidObject pattern.
  */
@@ -48,3 +53,5 @@ export type FluidObjectProviderKeys<T, TProp extends keyof T = keyof T> = string extends TProp
  * @example
- * For example, if we have an interface like below
+ *
+ * For example, if we have an interface like the following:
+ *
  * ```typescript
@@ -51,0 +58,0 @@ * interface IProvideFoo{

No alert changes

Improved metrics

Total package byte prevSize

310822

increased by0.93%

Lines of code

3305

increased by1.47%

No dependency changes