@fluid-internal/client-utils 2.1.0-276985 → 2.1.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # @fluid-internal/client-utils
 
+## 2.1.0
+
+Dependency updates only.
+
 ## 2.0.0-rc.5.0.0
 
 Dependency updates only.

package/README.md

@@ -3,11 +3,32 @@
 This package is intended for sharing and promoting utility functions across packages in the Fluid Framework repo,
 primarily within the client release group.
 
-<!-- AUTO-GENERATED-CONTENT:START (README_PACKAGE_SCOPE_NOTICE) -->
+<!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README_HEADER) -->
+
+<!-- prettier-ignore-start -->
+<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
 
 **IMPORTANT: This package is intended strictly as an implementation detail of the Fluid Framework and is not intended for public consumption.**
 **We make no stability guarantees regarding its APIs.**
 
+## Using Fluid Framework libraries
+
+When taking a dependency on a Fluid Framework library's public APIs, we recommend using a `^` (caret) version range, such as `^1.3.4`.
+While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
+library consumers should always prefer `^`.
+
+If using any of Fluid Framework's unstable APIs (for example, its `beta` APIs), we recommend using a more constrained version range, such as `~`.
+
+## Installation
+
+To get started, install the package by running the following command:
+
+```bash
+npm i @fluid-internal/client-utils
+```
+
+<!-- prettier-ignore-end -->
+
 <!-- AUTO-GENERATED-CONTENT:END -->
 
 ## Adding code to this package
@@ -72,27 +93,36 @@ be the same as browser. (Both report sets use the same target files.)
 Package scripts `check:exports:esm:indexBrowser:legacy` and `check:exports:esm:indexNode:legacy` are not
 verifying actual exports, but the consistency of tags within the legacy API set.
 
-<!-- AUTO-GENERATED-CONTENT:START (README_DEPENDENCY_GUIDELINES_SECTION:includeHeading=TRUE) -->
+<!-- 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. -->
 
-## Using Fluid Framework libraries
+## Contribution Guidelines
 
-When taking a dependency on a Fluid Framework library's public APIs, we recommend using a `^` (caret) version range, such as `^1.3.4`.
-While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
-library consumers should always prefer `^`.
+There are many ways to [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid.
 
-If using any of Fluid Framework's unstable APIs (for example, its `beta` APIs), we recommend using a more constrained version range, such as `~`.
+-   Participate in Q&A in our [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
+-   [Submit bugs](https://github.com/microsoft/FluidFramework/issues) and help us verify fixes as they are checked in.
+-   Review the [source code changes](https://github.com/microsoft/FluidFramework/pulls).
+-   [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
 
-<!-- prettier-ignore-end -->
+Detailed instructions for working in the repo can be found in the [Wiki](https://github.com/microsoft/FluidFramework/wiki).
 
-<!-- AUTO-GENERATED-CONTENT:END -->
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
 
-<!-- AUTO-GENERATED-CONTENT:START (README_TRADEMARK_SECTION:includeHeading=TRUE) -->
+This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
+Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
+Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
 
-<!-- prettier-ignore-start -->
-<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
+## Help
+
+Not finding what you're looking for in this README? Check out [fluidframework.com](https://fluidframework.com/docs/).
+
+Still not finding what you're looking for? Please [file an issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
+
+Thank you!
 
 ## Trademark
 

package/api-extractor/{api-extractor-browser.json → api-extractor-model-browser.json}

@@ -1,5 +1,5 @@
 {
 	"$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",
 	"mainEntryPointFilePath": "<projectFolder>/lib/indexBrowser.d.ts"
 }

package/api-extractor/api-extractor-report-browser.json

@@ -0,0 +1,5 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../../common/build/build-common/api-extractor-report.esm.current.json",
+	"mainEntryPointFilePath": "<projectFolder>/lib/indexBrowser.d.ts"
+}

package/api-extractor/{api-extractor-browser.legacy.json → api-extractor-report-browser.legacy.json}

@@ -1,5 +1,5 @@
 {
 	"$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",
 	"mainEntryPointFilePath": "<projectFolder>/lib/<unscopedPackageName>.browser.legacy.d.ts"
 }

package/api-extractor/{api-extractor-node.json → api-extractor-report-node.json}

@@ -1,5 +1,5 @@
 {
 	"$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-report.esm.current.json",
 	"mainEntryPointFilePath": "<projectFolder>/lib/indexNode.d.ts"
 }

package/api-extractor/{api-extractor-node.legacy.json → api-extractor-report-node.legacy.json}

@@ -1,5 +1,5 @@
 {
 	"$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",
 	"mainEntryPointFilePath": "<projectFolder>/lib/<unscopedPackageName>.node.legacy.d.ts"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-internal/client-utils",
-  "version": "2.1.0-276985",
+  "version": "2.1.0",
   "description": "Not intended for use outside the Fluid Framework.",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -67,8 +67,8 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluidframework/core-interfaces": "2.1.0-276985",
-    "@fluidframework/core-utils": "2.1.0-276985",
+    "@fluidframework/core-interfaces": "~2.1.0",
+    "@fluidframework/core-utils": "~2.1.0",
     "@types/events_pkg": "npm:@types/events@^3.0.0",
     "base64-js": "^1.5.1",
     "buffer": "^6.0.3",
@@ -77,17 +77,17 @@
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
-    "@biomejs/biome": "^1.7.3",
-    "@fluid-internal/client-utils-previous": "npm:@fluid-internal/client-utils@2.0.0-rc.5.0.0",
-    "@fluid-internal/mocha-test-setup": "2.1.0-276985",
-    "@fluid-tools/build-cli": "^0.39.0",
+    "@biomejs/biome": "~1.8.3",
+    "@fluid-internal/client-utils-previous": "npm:@fluid-internal/client-utils@2.0.0",
+    "@fluid-internal/mocha-test-setup": "~2.1.0",
+    "@fluid-tools/build-cli": "^0.41.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.39.0",
+    "@fluidframework/build-tools": "^0.41.0",
     "@fluidframework/eslint-config-fluid": "^5.3.0",
     "@microsoft/api-extractor": "^7.45.1",
     "@types/base64-js": "^1.3.0",
     "@types/jest": "29.5.3",
-    "@types/jest-environment-puppeteer": "2.1.0-276985",
+    "@types/jest-environment-puppeteer": "~2.1.0",
     "@types/mocha": "^9.1.1",
     "@types/node": "^18.19.0",
     "@types/rewire": "^2.5.28",
@@ -125,17 +125,17 @@
         "build:test:jest",
         "build:test:types"
       ],
-      "build:docs:browser:current": [
+      "build:api-report:browser:current": [
         "build:exports:browser"
       ],
-      "build:docs:browser:legacy": [
+      "build:api-report:browser:legacy": [
         "build:exports:browser"
       ],
-      "build:docs:node:current": [
-        "build:docs:browser:current"
+      "build:api-report:node:current": [
+        "build:api-report:browser:current"
       ],
-      "build:docs:node:legacy": [
-        "build:docs:browser:legacy"
+      "build:api-report:node:legacy": [
+        "build:api-report:browser:legacy"
       ],
       "check:exports:esm:indexBrowser:legacy": [
         "build:exports:browser"
@@ -155,16 +155,16 @@
       "build:test:types": [
         "build:esnext"
       ],
-      "ci:build:docs:browser:current": [
+      "ci:build:api-report:browser:current": [
         "build:exports:browser"
       ],
-      "ci:build:docs:browser:legacy": [
+      "ci:build:api-report:browser:legacy": [
         "build:exports:browser"
       ],
-      "ci:build:docs:node:current": [
+      "ci:build:api-report:node:current": [
         "build:exports:node"
       ],
-      "ci:build:docs:node:legacy": [
+      "ci:build:api-report:node:legacy": [
         "build:exports:node"
       ]
     }
@@ -174,15 +174,14 @@
   },
   "scripts": {
     "build": "fluid-build . --task build",
+    "build:api-report": "concurrently \"npm:build:api-report:browser:*\" && concurrently \"npm:build:api-report:node:*\"",
+    "build:api-report:browser:current": "api-extractor run --local --config api-extractor/api-extractor-report-browser.json",
+    "build:api-report:browser:legacy": "api-extractor run --local --config api-extractor/api-extractor-report-browser.legacy.json",
+    "build:api-report:node:current": "npm run ci:build:api-report:node:current",
+    "build:api-report:node:legacy": "npm run ci:build:api-report:node:legacy",
     "build:commonjs": "fluid-build . --task commonjs",
     "build:compile": "fluid-build . --task compile",
-    "build:docs": "npm run build:docs:browser && npm run build:docs:node",
-    "build:docs:browser": "npm run build:exports:browser && concurrently \"npm:build:docs:browser:*\"",
-    "build:docs:browser:current": "api-extractor run --local --config api-extractor/api-extractor-browser.json",
-    "build:docs:browser:legacy": "api-extractor run --local --config api-extractor/api-extractor-browser.legacy.json",
-    "build:docs:node": "npm run build:exports:node && concurrently \"npm:build:docs:node:*\"",
-    "build:docs:node:current": "npm run ci:build:docs:node:current",
-    "build:docs:node:legacy": "npm run ci:build:docs:node:legacy",
+    "build:docs": "api-extractor run --local --config api-extractor/api-extractor-model-browser.json",
     "build:esnext": "tsc --project ./tsconfig.json",
     "build:exports:browser": "flub generate entrypoints --outFilePrefix {@unscopedPackageName}.browser. --mainEntrypoint ./src/indexBrowser.ts --outDir ./lib",
     "build:exports:node": "flub generate entrypoints --outFilePrefix {@unscopedPackageName}.node. --mainEntrypoint ./src/indexNode.ts --outDir ./lib",
@@ -193,7 +192,7 @@
     "build:test:mocha:esm": "tsc --project ./src/test/mocha/tsconfig.json",
     "build:test:types": "tsc --project ./src/test/types/tsconfig.json",
     "check:are-the-types-wrong": "attw --pack . --exclude-entrypoints internal-api-report",
-    "check:biome": "biome check . --formatter-enabled=true",
+    "check:biome": "biome check .",
     "check:exports": "concurrently \"npm:check:exports:*\"",
     "check:exports:bundle-release-tags": "api-extractor run --config api-extractor/api-extractor-lint-bundle.json",
     "check:exports:cjs:indexBrowser": "api-extractor run --config api-extractor/api-extractor-lint-indexBrowser.cjs.json",
@@ -204,16 +203,17 @@
     "check:exports:esm:indexNode:legacy": "api-extractor run --config api-extractor/api-extractor-lint-indexNode.legacy.esm.json",
     "check:format": "npm run check:biome",
     "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
-    "ci:build:docs": "concurrently \"npm:ci:build:docs:*\"",
-    "ci:build:docs:browser:current": "api-extractor run --config api-extractor/api-extractor-browser.json",
-    "ci:build:docs:browser:legacy": "api-extractor run --config api-extractor/api-extractor-browser.legacy.json",
-    "ci:build:docs:node:current": "api-extractor run --config api-extractor/api-extractor-node.json",
-    "ci:build:docs:node:legacy": "api-extractor run --config api-extractor/api-extractor-node.legacy.json",
+    "ci:build:api-report": "concurrently \"npm:ci:build:api-report:*\"",
+    "ci:build:api-report:browser:current": "api-extractor run --config api-extractor/api-extractor-report-browser.json",
+    "ci:build:api-report:browser:legacy": "api-extractor run --config api-extractor/api-extractor-report-browser.legacy.json",
+    "ci:build:api-report:node:current": "api-extractor run --config api-extractor/api-extractor-report-node.json",
+    "ci:build:api-report:node:legacy": "api-extractor run --config api-extractor/api-extractor-report-node.legacy.json",
+    "ci:build:docs": "api-extractor run --config api-extractor/api-extractor-model-browser.json",
     "clean": "rimraf --glob _api-extractor-temp dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\" nyc",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "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",
     "lint": "fluid-build . --task lint",
     "lint:fix": "fluid-build . --task eslint:fix --task format",

package/lib/tsdoc-metadata.json

@@ -1,11 +0,0 @@
-// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
-// It should be published with your NPM package.  It should not be tracked by Git.
-{
-  "tsdocVersion": "0.12",
-  "toolPackages": [
-    {
-      "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.45.1"
-    }
-  ]
-}