@fluidframework/telemetry-utils - npm Package Compare versions

Comparing version 2.1.0-276985 to 2.1.0-281041

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.esm.current.json"
+	"extends": "../../../common/build/build-common/api-extractor-model.esm.json"
 }

api-extractor/api-extractor.legacy.json

 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-base.esm.legacy.json"
+	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-report.esm.legacy.json"
 }

dist/legacy.d.ts

@@ -8,3 +8,3 @@ /*!
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
- * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ * Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
  */
@@ -11,0 +11,0 @@

dist/public.d.ts

@@ -8,3 +8,3 @@ /*!
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
- * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ * Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
  */
@@ -11,0 +11,0 @@

internal.d.ts

@@ -8,5 +8,5 @@ /*!
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
- * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ * Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
  */
 
 export * from "./lib/index.js";

legacy.d.ts

@@ -8,5 +8,5 @@ /*!
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
- * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ * Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
  */
 
 export * from "./lib/legacy.js";

lib/legacy.d.ts

@@ -8,3 +8,3 @@ /*!
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
- * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ * Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
  */
@@ -11,0 +11,0 @@

lib/public.d.ts

@@ -8,3 +8,3 @@ /*!
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
- * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ * Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
  */
@@ -11,0 +11,0 @@

package.json

 {
   "name": "@fluidframework/telemetry-utils",
-  "version": "2.1.0-276985",
+  "version": "2.1.0-281041",
   "description": "Collection of telemetry relates utilities for Fluid",
@@ -70,6 +70,6 @@ "homepage": "https://fluidframework.com",
   "dependencies": {
-    "@fluid-internal/client-utils": "2.1.0-276985",
-    "@fluidframework/core-interfaces": "2.1.0-276985",
-    "@fluidframework/core-utils": "2.1.0-276985",
-    "@fluidframework/driver-definitions": "2.1.0-276985",
+    "@fluid-internal/client-utils": "2.1.0-281041",
+    "@fluidframework/core-interfaces": "2.1.0-281041",
+    "@fluidframework/core-utils": "2.1.0-281041",
+    "@fluidframework/driver-definitions": "2.1.0-281041",
     "debug": "^4.3.4",
@@ -80,9 +80,9 @@ "uuid": "^9.0.0"
     "@arethetypeswrong/cli": "^0.15.2",
-    "@biomejs/biome": "^1.7.3",
-    "@fluid-internal/mocha-test-setup": "2.1.0-276985",
-    "@fluid-tools/build-cli": "^0.39.0",
+    "@biomejs/biome": "~1.8.3",
+    "@fluid-internal/mocha-test-setup": "2.1.0-281041",
+    "@fluid-tools/build-cli": "^0.40.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.39.0",
+    "@fluidframework/build-tools": "^0.40.0",
     "@fluidframework/eslint-config-fluid": "^5.3.0",
-    "@fluidframework/telemetry-utils-previous": "npm:@fluidframework/telemetry-utils@2.0.0-rc.5.0.0",
+    "@fluidframework/telemetry-utils-previous": "npm:@fluidframework/telemetry-utils@2.0.0",
     "@microsoft/api-extractor": "^7.45.1",
@@ -116,7 +116,8 @@ "@types/debug": "^4.1.5",
     "build": "fluid-build . --task build",
+    "build:api-reports": "concurrently \"npm:build:api-reports:*\"",
+    "build:api-reports:current": "api-extractor run --local --config api-extractor/api-extractor.current.json",
+    "build:api-reports:legacy": "api-extractor run --local --config api-extractor/api-extractor.legacy.json",
     "build:commonjs": "fluid-build . --task commonjs",
     "build:compile": "fluid-build . --task compile",
-    "build:docs": "concurrently \"npm:build:docs:*\"",
-    "build:docs:current": "api-extractor run --local",
-    "build:docs:legacy": "api-extractor run --local --config api-extractor/api-extractor.legacy.json",
+    "build:docs": "api-extractor run --local",
     "build:esnext": "tsc --project ./tsconfig.json",
@@ -128,3 +129,3 @@ "build:test": "npm run build:test:esm && npm run build:test:cjs",
     "check:are-the-types-wrong": "attw --pack .",
-    "check:biome": "biome check . --formatter-enabled=true",
+    "check:biome": "biome check .",
     "check:exports": "concurrently \"npm:check:exports:*\"",
@@ -138,5 +139,6 @@ "check:exports:bundle-release-tags": "api-extractor run --config api-extractor/api-extractor-lint-bundle.json",
     "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
-    "ci:build:docs": "concurrently \"npm:ci:build:docs:*\"",
-    "ci:build:docs:current": "api-extractor run",
-    "ci:build:docs:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
+    "ci:build:api-reports": "concurrently \"npm:ci:build:api-reports:*\"",
+    "ci:build:api-reports:current": "api-extractor run --config api-extractor/api-extractor.current.json",
+    "ci:build:api-reports:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
+    "ci:build:docs": "api-extractor run",
     "clean": "rimraf --glob dist lib \"*.d.ts\" \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
@@ -146,3 +148,3 @@ "eslint": "eslint --format stylish src",
     "format": "npm run format:biome",
-    "format:biome": "biome check . --formatter-enabled=true --apply",
+    "format:biome": "biome check . --write",
     "format:prettier": "prettier --write . --cache --ignore-path ../../../.prettierignore",
@@ -149,0 +151,0 @@ "lint": "fluid-build . --task lint",

README.md

@@ -5,3 +5,3 @@ # @fluidframework/telemetry-utils
 
-<!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README:scripts=FALSE) -->
+<!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README_HEADER) -->
 
@@ -36,2 +36,11 @@ <!-- prettier-ignore-start -->
 
+<!-- prettier-ignore-end -->
+
+<!-- AUTO-GENERATED-CONTENT:END -->
+
+<!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README_FOOTER) -->
+
+<!-- prettier-ignore-start -->
+<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
+
 ## API Documentation
@@ -41,2 +50,46 @@
 
+## Minimum Client Requirements
+
+These are the platform requirements for the current version of Fluid Framework Client Packages.
+These requirements err on the side of being too strict since within a major version they can be relaxed over time, but not made stricter.
+For Long Term Support (LTS) versions this can require supporting these platforms for several years.
+
+It is likely that other configurations will work, but they are not supported: if they stop working, we do not consider that a bug.
+If you would benefit from support for something not listed here, file an issue and the product team will evaluate your request.
+When making such a request please include if the configuration already works (and thus the request is just that it becomes officially supported), or if changes are required to get it working.
+
+### Supported Runtimes
+
+-   NodeJs ^20.10.0 except that we will drop support for it [when NodeJs 20 loses its upstream support on 2026-04-30](https://github.com/nodejs/release#release-schedule), and will support a newer LTS version of NodeJS (22) at least 1 year before 20 is end-of-life. This same policy applies to NodeJS 22 when it is end of life (2027-04-30).
+-   Modern browsers supporting the es2022 standard library: in response to asks we can add explicit support for using babel to polyfill to target specific standards or runtimes (meaning we can avoid/remove use of things that don't polyfill robustly, but otherwise target modern standards).
+
+### Supported Tools
+
+-   TypeScript 5.4:
+    -   All [`strict`](https://www.typescriptlang.org/tsconfig) options are supported.
+    -   [`strictNullChecks`](https://www.typescriptlang.org/tsconfig) is required.
+    -   [Configuration options deprecated in 5.0](https://github.com/microsoft/TypeScript/issues/51909) are not supported.
+    -   `exactOptionalPropertyTypes` is currently not fully supported.
+        If used, narrowing members of Fluid Framework types types using `in`, `Reflect.has`, `Object.hasOwn` or `Object.prototype.hasOwnProperty` should be avoided as they may incorrectly exclude `undefined` from the possible values in some cases.
+-   [webpack](https://webpack.js.org/) 5
+    -   We are not intending to be prescriptive about what bundler to use.
+        Other bundlers which can handle ES Modules should work, but webpack is the only one we actively test.
+
+### Module Resolution
+
+[`Node16`, `NodeNext`, or `Bundler`](https://www.typescriptlang.org/tsconfig#moduleResolution) resolution should be used with TypeScript compilerOptions to follow the [Node.js v12+ ESM Resolution and Loading algorithm](https://nodejs.github.io/nodejs.dev/en/api/v20/esm/#resolution-and-loading-algorithm).
+Node10 resolution is not supported as it does not support Fluid Framework's API structuring pattern that is used to distinguish stable APIs from those that are in development.
+
+### Module Formats
+
+-   ES Modules:
+    ES Modules are the preferred way to consume our client packages (including in NodeJs) and consuming our client packages from ES Modules is fully supported.
+-   CommonJs:
+    Consuming our client packages as CommonJs is supported only in NodeJS and only for the cases listed below.
+    This is done to accommodate some workflows without good ES Module support.
+    If you have a workflow you would like included in this list, file an issue.
+    Once this list of workflows motivating CommonJS support is empty, we may drop support for CommonJS one year after notice of the change is posted here.
+
+    -   Testing with Jest (which lacks [stable ESM support](https://jestjs.io/docs/ecmascript-modules) due to [unstable APIs in NodeJs](https://github.com/nodejs/node/issues/37648))
+
 ## Contribution Guidelines
@@ -43,0 +96,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

907660

increased by0.51%

Number of package files

167

increased by1.21%

Lines of code

11347

increased by0.04%

Number of lines in readme file

129

increased by69.74%

Dependency changes

• + Added@fluid-internal/client-utils@2.1.0-281041(transitive)

• + Added@fluidframework/core-interfaces@2.1.0-281041(transitive)

• + Added@fluidframework/core-utils@2.1.0-281041(transitive)

• + Added@fluidframework/driver-definitions@2.1.0-281041(transitive)

• - Removed@fluid-internal/client-utils@2.1.0-276985(transitive)

• - Removed@fluidframework/core-interfaces@2.1.0-276985(transitive)

• - Removed@fluidframework/core-utils@2.1.0-276985(transitive)

• - Removed@fluidframework/driver-definitions@2.1.0-276985(transitive)

• Updated@fluid-internal/client-utils@2.1.0-281041

• Updated@fluidframework/core-interfaces@2.1.0-281041

• Updated@fluidframework/core-utils@2.1.0-281041

• Updated@fluidframework/driver-definitions@2.1.0-281041