@fluid-internal/client-utils - npm Package Compare versions

Comparing version 2.0.0-dev.7.4.0.221926 to 2.0.0-dev-rc.1.0.0.224419

api-extractor-lint.json

 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../../common/build/build-common/api-extractor-lint.json",
-	"messages": {
-		"extractorMessageReporting": {
-			// TODO: remove once base config has this enabled as an error
-			"ae-incompatible-release-tags": {
-				"logLevel": "error",
-				"addToApiReportFile": false
-			}
-		}
-	}
+	"extends": "../../../common/build/build-common/api-extractor-lint.json"
 }

api-extractor.json

 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../../common/build/build-common/api-extractor-base.json",
-	"messages": {
-		"extractorMessageReporting": {
-			// TODO: Add missing documentation and remove this rule override
-			"ae-undocumented": {
-				"logLevel": "none"
-			}
-		}
-	}
+	"extends": "../../../common/build/build-common/api-extractor-base.json"
 }

api-report/client-utils.api.md

@@ -26,6 +26,6 @@ ## API Report File for "@fluid-internal/client-utils"
 
-// @internal
+// @alpha
 export const bufferToString: (blob: ArrayBufferLike, encoding: "utf8" | "utf-8" | "base64") => string;
 
-// @alpha
+// @public
 export type EventEmitterEventType = EventEmitter extends {
@@ -101,3 +101,3 @@ on(event: infer E, listener: any): any;
 
-// @alpha
+// @public
 export class TypedEventEmitter<TEvent> extends EventEmitter implements IEventProvider<TEvent & IEvent> {
@@ -121,3 +121,3 @@ constructor();
 
-// @alpha (undocumented)
+// @public (undocumented)
 export type TypedEventTransform<TThis, TEvent> = TransformedEvent<TThis, "newListener" | "removeListener", Parameters<(event: string, listener: (...args: any[]) => void) => void>> & IEventTransformer<TThis, TEvent & IEvent> & TransformedEvent<TThis, EventEmitterEventType, any[]>;
@@ -124,0 +124,0 @@

CHANGELOG.md

 # @fluid-internal/client-utils
 
+## 2.0.0-internal.8.0.0
+
+Dependency updates only.
+
 ## 2.0.0-internal.7.4.0
@@ -4,0 +8,0 @@

dist/bufferBrowser.d.ts

@@ -33,3 +33,3 @@ /*!
  *
- * @internal
+ * @alpha
  */
@@ -36,0 +36,0 @@ export declare const bufferToString: (blob: ArrayBufferLike, encoding: "utf8" | "utf-8" | "base64") => string;

dist/bufferNode.d.ts

@@ -59,5 +59,5 @@ /*!
  *
- * @internal
+ * @alpha
  */
 export declare const bufferToString: (blob: ArrayBufferLike, encoding: "utf8" | "utf-8" | "base64") => string;
 //# sourceMappingURL=bufferNode.d.ts.map

dist/client-utils-alpha.d.ts

@@ -12,3 +12,12 @@ /// <reference types="node" />
 
-/* Excluded from this release type: bufferToString */
+/**
+ * Convert binary blob to string format
+ *
+ * @param blob - The binary blob
+ * @param encoding - Output string's encoding
+ * @returns The blob in string format
+ *
+ * @alpha
+ */
+export declare const bufferToString: (blob: ArrayBufferLike, encoding: "utf8" | "utf-8" | "base64") => string;
 
@@ -20,4 +29,3 @@ /**
  * This type allow us to correctly handle either type
- *
- * @alpha
+ * @public
  */
@@ -54,4 +62,3 @@ export declare type EventEmitterEventType = EventEmitter extends {
  * Event Emitter helper class the supports emitting typed events
- *
- * @alpha
+ * @public
  */
@@ -70,3 +77,3 @@ export declare class TypedEventEmitter<TEvent> extends EventEmitter implements IEventProvider<TEvent & IEvent> {
 /**
- * @alpha
+ * @public
  */
@@ -73,0 +80,0 @@ export declare type TypedEventTransform<TThis, TEvent> = TransformedEvent<TThis, "newListener" | "removeListener", Parameters<(event: string, listener: (...args: any[]) => void) => void>> & IEventTransformer<TThis, TEvent & IEvent> & TransformedEvent<TThis, EventEmitterEventType, any[]>;

dist/client-utils-beta.d.ts

@@ -14,3 +14,12 @@ /// <reference types="node" />
 
-/* Excluded from this release type: EventEmitterEventType */
+/**
+ * The event emitter polyfill and the node event emitter have different event types:
+ * string | symbol vs. string | number
+ *
+ * This type allow us to correctly handle either type
+ * @public
+ */
+export declare type EventEmitterEventType = EventEmitter extends {
+    on(event: infer E, listener: any): any;
+} ? E : never;
 
@@ -27,10 +36,2 @@ /* Excluded from this release type: EventForwarder */
 
-/* Excluded from this release type: IDisposable */
-
-/* Excluded from this release type: IEvent */
-
-/* Excluded from this release type: IEventProvider */
-
-/* Excluded from this release type: IEventTransformer */
-
 /* Excluded from this release type: IsoBuffer */
@@ -50,8 +51,22 @@
 
-/* Excluded from this release type: TransformedEvent */
+/**
+ * Event Emitter helper class the supports emitting typed events
+ * @public
+ */
+export declare class TypedEventEmitter<TEvent> extends EventEmitter implements IEventProvider<TEvent & IEvent> {
+    constructor();
+    readonly addListener: TypedEventTransform<this, TEvent>;
+    readonly on: TypedEventTransform<this, TEvent>;
+    readonly once: TypedEventTransform<this, TEvent>;
+    readonly prependListener: TypedEventTransform<this, TEvent>;
+    readonly prependOnceListener: TypedEventTransform<this, TEvent>;
+    readonly removeListener: TypedEventTransform<this, TEvent>;
+    readonly off: TypedEventTransform<this, TEvent>;
+}
 
-/* Excluded from this release type: TypedEventEmitter */
+/**
+ * @public
+ */
+export declare type TypedEventTransform<TThis, TEvent> = TransformedEvent<TThis, "newListener" | "removeListener", Parameters<(event: string, listener: (...args: any[]) => void) => void>> & IEventTransformer<TThis, TEvent & IEvent> & TransformedEvent<TThis, EventEmitterEventType, any[]>;
 
-/* Excluded from this release type: TypedEventTransform */
-
 /* Excluded from this release type: Uint8ArrayToArrayBuffer */
@@ -58,0 +73,0 @@

dist/client-utils-public.d.ts

@@ -14,3 +14,12 @@ /// <reference types="node" />
 
-/* Excluded from this release type: EventEmitterEventType */
+/**
+ * The event emitter polyfill and the node event emitter have different event types:
+ * string | symbol vs. string | number
+ *
+ * This type allow us to correctly handle either type
+ * @public
+ */
+export declare type EventEmitterEventType = EventEmitter extends {
+    on(event: infer E, listener: any): any;
+} ? E : never;
 
@@ -27,10 +36,2 @@ /* Excluded from this release type: EventForwarder */
 
-/* Excluded from this release type: IDisposable */
-
-/* Excluded from this release type: IEvent */
-
-/* Excluded from this release type: IEventProvider */
-
-/* Excluded from this release type: IEventTransformer */
-
 /* Excluded from this release type: IsoBuffer */
@@ -50,8 +51,22 @@
 
-/* Excluded from this release type: TransformedEvent */
+/**
+ * Event Emitter helper class the supports emitting typed events
+ * @public
+ */
+export declare class TypedEventEmitter<TEvent> extends EventEmitter implements IEventProvider<TEvent & IEvent> {
+    constructor();
+    readonly addListener: TypedEventTransform<this, TEvent>;
+    readonly on: TypedEventTransform<this, TEvent>;
+    readonly once: TypedEventTransform<this, TEvent>;
+    readonly prependListener: TypedEventTransform<this, TEvent>;
+    readonly prependOnceListener: TypedEventTransform<this, TEvent>;
+    readonly removeListener: TypedEventTransform<this, TEvent>;
+    readonly off: TypedEventTransform<this, TEvent>;
+}
 
-/* Excluded from this release type: TypedEventEmitter */
+/**
+ * @public
+ */
+export declare type TypedEventTransform<TThis, TEvent> = TransformedEvent<TThis, "newListener" | "removeListener", Parameters<(event: string, listener: (...args: any[]) => void) => void>> & IEventTransformer<TThis, TEvent & IEvent> & TransformedEvent<TThis, EventEmitterEventType, any[]>;
 
-/* Excluded from this release type: TypedEventTransform */
-
 /* Excluded from this release type: Uint8ArrayToArrayBuffer */
@@ -58,0 +73,0 @@

dist/client-utils-untrimmed.d.ts

@@ -40,3 +40,3 @@ /// <reference types="node" />
  *
- * @internal
+ * @alpha
  */
@@ -50,4 +50,3 @@ export declare const bufferToString: (blob: ArrayBufferLike, encoding: "utf8" | "utf-8" | "base64") => string;
  * This type allow us to correctly handle either type
- *
- * @alpha
+ * @public
  */
@@ -212,4 +211,3 @@ export declare type EventEmitterEventType = EventEmitter extends {
  * Event Emitter helper class the supports emitting typed events
- *
- * @alpha
+ * @public
  */
@@ -228,3 +226,3 @@ export declare class TypedEventEmitter<TEvent> extends EventEmitter implements IEventProvider<TEvent & IEvent> {
 /**
- * @alpha
+ * @public
  */
@@ -231,0 +229,0 @@ export declare type TypedEventTransform<TThis, TEvent> = TransformedEvent<TThis, "newListener" | "removeListener", Parameters<(event: string, listener: (...args: any[]) => void) => void>> & IEventTransformer<TThis, TEvent & IEvent> & TransformedEvent<TThis, EventEmitterEventType, any[]>;

dist/typedEventEmitter.d.ts

@@ -13,4 +13,3 @@ /*!
  * This type allow us to correctly handle either type
- *
- * @alpha
+ * @public
  */
@@ -21,3 +20,3 @@ export type EventEmitterEventType = EventEmitter extends {
 /**
- * @alpha
+ * @public
  */
@@ -27,4 +26,3 @@ export type TypedEventTransform<TThis, TEvent> = TransformedEvent<TThis, "newListener" | "removeListener", Parameters<(event: string, listener: (...args: any[]) => void) => void>> & IEventTransformer<TThis, TEvent & IEvent> & TransformedEvent<TThis, EventEmitterEventType, any[]>;
  * Event Emitter helper class the supports emitting typed events
- *
- * @alpha
+ * @public
  */
@@ -31,0 +29,0 @@ export declare class TypedEventEmitter<TEvent> extends EventEmitter implements IEventProvider<TEvent & IEvent> {

jest.config.js

@@ -18,4 +18,4 @@ /*!
 	],
-	testMatch: ["**/dist/test/jest/?(*.)+(spec|test).js"],
+	testMatch: ["**/dist/test/jest/?(*.)+(spec|test).?js"],
 	testPathIgnorePatterns: ["/node_modules/"],
 };

package.json

 {
   "name": "@fluid-internal/client-utils",
-  "version": "2.0.0-dev.7.4.0.221926",
+  "version": "2.0.0-dev-rc.1.0.0.224419",
   "description": "Not intended for use outside the Fluid Framework.",
@@ -14,7 +14,7 @@ "homepage": "https://fluidframework.com",
   "sideEffects": false,
-  "main": "dist/index.js",
-  "module": "lib/index.js",
+  "main": "dist/index.cjs",
+  "module": "lib/index.mjs",
   "browser": {
-    "./dist/indexNode.js": "./dist/indexBrowser.js",
-    "./lib/indexNode.js": "./lib/indexBrowser.js"
+    "./dist/indexNode.cjs": "./dist/indexBrowser.cjs",
+    "./lib/indexNode.mjs": "./lib/indexBrowser.mjs"
   },
@@ -26,9 +26,9 @@ "types": "dist/index.d.ts",
     "exclude": [
-      "src/test/**/*.ts",
-      "dist/test/**/*.js"
+      "src/test/**/*.*ts",
+      "dist/test/**/*.*js"
     ],
     "exclude-after-remap": false,
     "include": [
-      "src/**/*.ts",
-      "dist/**/*.js"
+      "src/**/*.*ts",
+      "dist/**/*.*js"
     ],
@@ -44,4 +44,4 @@ "report-dir": "nyc/report",
   "dependencies": {
-    "@fluidframework/core-interfaces": "2.0.0-dev.7.4.0.221926",
-    "@fluidframework/core-utils": "2.0.0-dev.7.4.0.221926",
+    "@fluidframework/core-interfaces": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/core-utils": "2.0.0-dev-rc.1.0.0.224419",
     "@types/events": "^3.0.0",
@@ -56,7 +56,8 @@ "base64-js": "^1.5.1",
     "@arethetypeswrong/cli": "^0.13.3",
-    "@fluid-tools/build-cli": "^0.28.0",
+    "@fluid-internal/client-utils-previous": "npm:@fluid-internal/client-utils@2.0.0-internal.7.3.0",
+    "@fluid-tools/build-cli": "0.29.0-222379",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.28.0",
+    "@fluidframework/build-tools": "0.29.0-222379",
     "@fluidframework/eslint-config-fluid": "^3.1.0",
-    "@fluidframework/mocha-test-setup": "2.0.0-dev.7.4.0.221926",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev-rc.1.0.0.224419",
     "@microsoft/api-extractor": "^7.38.3",
@@ -87,2 +88,3 @@ "@types/base64-js": "^1.3.0",
     "puppeteer": "^17.1.3",
+    "renamer": "^4.0.0",
     "rewire": "^5.0.0",
@@ -93,2 +95,3 @@ "rimraf": "^4.4.0",
     "ts-node": "^10.9.1",
+    "tsc-multi": "^1.1.0",
     "typescript": "~5.1.6"
@@ -98,8 +101,2 @@ },
     "tasks": {
-      "eslint": [
-        "tsc",
-        "build:test:mocha",
-        "build:test:jest",
-        "build:test:types"
-      ],
       "build:docs": {
@@ -112,16 +109,6 @@ "dependsOn": [
         "script": false
-      },
-      "build:test:jest": [
-        "tsc"
-      ],
-      "build:test:mocha": [
-        "tsc"
-      ],
-      "build:test:types": [
-        "tsc"
-      ]
+      }
     }
   },
   "typeValidation": {
-    "disabled": true,
     "broken": {}
@@ -137,7 +124,5 @@ },
     "build:docs": "fluid-build . --task api",
-    "build:esnext": "tsc --project ./tsconfig.esnext.json",
-    "build:test": "concurrently npm:build:test:mocha npm:build:test:jest npm:build:test:types",
-    "build:test:jest": "tsc --project ./src/test/jest/tsconfig.json",
-    "build:test:mocha": "tsc --project ./src/test/mocha/tsconfig.json",
-    "build:test:types": "tsc --project ./src/test/types/tsconfig.json",
+    "build:esnext": "tsc-multi --config ../../../common/build/build-common/tsc-multi.esm.json",
+    "build:rename-types": "renamer \"lib/**\" -f .d.ts -r .d.mts --force",
+    "build:test": "tsc-multi --config ./tsc-multi.test.json",
     "check:are-the-types-wrong": "attw --pack",
@@ -157,4 +142,4 @@ "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
     "test:jest": "jest",
-    "test:mocha": "mocha  --recursive \"dist/test/mocha/**/*.spec.js\" --exit --project test/tsconfig.json",
-    "tsc": "tsc",
+    "test:mocha": "mocha  --recursive \"dist/test/mocha/**/*.spec.?js\" --exit --project test/tsconfig.json",
+    "tsc": "tsc-multi --config ../../../common/build/build-common/tsc-multi.cjs.json",
     "typetests:gen": "fluid-type-test-generator",
@@ -161,0 +146,0 @@ "typetests:prepare": "flub typetests --dir . --reset --previous --normalize"

src/bufferBrowser.ts

@@ -58,3 +58,3 @@ /*!
  *
- * @internal
+ * @alpha
  */
@@ -61,0 +61,0 @@ export const bufferToString = (

src/bufferNode.ts

@@ -83,3 +83,3 @@ /*!
  *
- * @internal
+ * @alpha
  */
@@ -86,0 +86,0 @@ export const bufferToString = (

src/typedEventEmitter.ts

@@ -21,4 +21,3 @@ /*!
  * This type allow us to correctly handle either type
- *
- * @alpha
+ * @public
  */
@@ -31,3 +30,3 @@ // eslint-disable-next-line @typescript-eslint/no-explicit-any
 /**
- * @alpha
+ * @public
  */
@@ -53,4 +52,3 @@ export type TypedEventTransform<TThis, TEvent> =
  * Event Emitter helper class the supports emitting typed events
- *
- * @alpha
+ * @public
  */
@@ -57,0 +55,0 @@ export class TypedEventEmitter<TEvent>

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

265329

decreased by-2.65%

Dev dependency count

40

increased by8.11%

Lines of code

2997

decreased by-22.78%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@fluidframework/core-interfaces@2.0.0-dev-rc.1.0.0.224419(transitive)

• + Added@fluidframework/core-utils@2.0.0-dev-rc.1.0.0.224419(transitive)

• - Removed@fluidframework/core-interfaces@2.0.0-dev.7.4.0.221926(transitive)

• - Removed@fluidframework/core-utils@2.0.0-dev.7.4.0.221926(transitive)

• Updated@fluidframework/core-interfaces@2.0.0-dev-rc.1.0.0.224419

• Updated@fluidframework/core-utils@2.0.0-dev-rc.1.0.0.224419