@fluidframework/devtools 2.1.0-276985 → 2.1.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # @fluidframework/devtools
 
+## 2.1.0
+
+Dependency updates only.
+
 ## 2.0.0-rc.5.0.0
 
 ### Minor Changes

package/README.md

@@ -6,11 +6,19 @@ It is used to power our associated [browser extension][browser-extension].
 -   Chrome: <https://aka.ms/fluid/devtool/chrome>
 -   Edge: <https://aka.ms/fluid/devtool/edge>
 
-<!-- AUTO-GENERATED-CONTENT:START (README_INSTALLATION_SECTION:includeHeading=TRUE&devDependency=TRUE) -->
+<!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README_HEADER:devDependency=TRUE) -->
 
 <!-- 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
+
+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:
@@ -19,6 +27,21 @@ To get started, install the package by running the following command:
 npm i @fluidframework/devtools -D
 ```
 
+## Importing from this package
+
+This package leverages [package.json exports](https://nodejs.org/api/packages.html#exports) to separate its APIs by support level.
+For more information on the related support guarantees, see [API Support Levels](https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels).
+
+To access the `public` ([SemVer](https://semver.org/)) APIs, import via `@fluidframework/devtools` like normal.
+
+To access the `beta` APIs, import via `@fluidframework/devtools/beta`.
+
+To access the `alpha` APIs, import via `@fluidframework/devtools/alpha`.
+
+## API Documentation
+
+API documentation for **@fluidframework/devtools** is available at <https://fluidframework.com/docs/apis/devtools>.
+
 <!-- prettier-ignore-end -->
 
 <!-- AUTO-GENERATED-CONTENT:END -->
@@ -121,14 +144,55 @@ Next, to build the code, run `npm run build` from the root of the mono-repo, or
 To run the tests, first ensure you have followed the [build](#build) steps above.
 Next, run `npm run test` from a terminal within this directory.
 
-<!-- AUTO-GENERATED-CONTENT:START (README_API_DOCS_SECTION:includeHeading=TRUE) -->
-<!-- AUTO-GENERATED-CONTENT:END -->
-
-<!-- AUTO-GENERATED-CONTENT:START (README_CONTRIBUTION_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. -->
 
+## 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
 
 There are many ways to [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid.
@@ -147,15 +211,6 @@ This project may contain Microsoft trademarks or logos for Microsoft projects, p
 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-end -->
-
-<!-- AUTO-GENERATED-CONTENT:END -->
-
-<!-- AUTO-GENERATED-CONTENT:START (README_HELP_SECTION:includeHeading=TRUE) -->
-
-<!-- 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/).
@@ -164,15 +219,6 @@ Still not finding what you're looking for? Please [file an issue](https://github
 
 Thank you!
 
-<!-- prettier-ignore-end -->
-
-<!-- AUTO-GENERATED-CONTENT:END -->
-
-<!-- AUTO-GENERATED-CONTENT:START (README_TRADEMARK_SECTION:includeHeading=TRUE) -->
-
-<!-- prettier-ignore-start -->
-<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
-
 ## Trademark
 
 This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.

package/alpha.d.ts

@@ -5,7 +5,7 @@
 
 /*
  * 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/alpha.js";

package/beta.d.ts

@@ -5,7 +5,7 @@
 
 /*
  * 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/beta.js";

package/dist/alpha.d.ts

@@ -5,7 +5,22 @@
 
 /*
  * 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.
+ */
+
+/**
+ * Primary entry-point to the Fluid Devtools.
+ *
+ * To initialize the Devtools alongside your application's {@link @fluidframework/fluid-static#IFluidContainer}, call
+ * {@link initializeDevtools}.
+ *
+ * The Devtools will automatically dispose of themselves upon Window unload, but if you would like to close them
+ * earlier, call {@link IDevtools.dispose}.
+ *
+ * To enable visualization of Telemetry data, you may create a {@link @fluidframework/devtools-core#DevtoolsLogger} and
+ * provide it during Devtools initialization.
+ *
+ * @packageDocumentation
  */
 
 export {

package/dist/beta.d.ts

@@ -5,7 +5,22 @@
 
 /*
  * 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.
+ */
+
+/**
+ * Primary entry-point to the Fluid Devtools.
+ *
+ * To initialize the Devtools alongside your application's {@link @fluidframework/fluid-static#IFluidContainer}, call
+ * {@link initializeDevtools}.
+ *
+ * The Devtools will automatically dispose of themselves upon Window unload, but if you would like to close them
+ * earlier, call {@link IDevtools.dispose}.
+ *
+ * To enable visualization of Telemetry data, you may create a {@link @fluidframework/devtools-core#DevtoolsLogger} and
+ * provide it during Devtools initialization.
+ *
+ * @packageDocumentation
  */
 
 export {

package/dist/public.d.ts

@@ -5,8 +5,21 @@
 
 /*
  * 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 {}
+/**
+ * Primary entry-point to the Fluid Devtools.
+ *
+ * To initialize the Devtools alongside your application's {@link @fluidframework/fluid-static#IFluidContainer}, call
+ * {@link initializeDevtools}.
+ *
+ * The Devtools will automatically dispose of themselves upon Window unload, but if you would like to close them
+ * earlier, call {@link IDevtools.dispose}.
+ *
+ * To enable visualization of Telemetry data, you may create a {@link @fluidframework/devtools-core#DevtoolsLogger} and
+ * provide it during Devtools initialization.
+ *
+ * @packageDocumentation
+ */export {}
 

package/internal.d.ts

@@ -5,7 +5,7 @@
 
 /*
  * 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";

package/lib/alpha.d.ts

@@ -5,7 +5,22 @@
 
 /*
  * 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.
+ */
+
+/**
+ * Primary entry-point to the Fluid Devtools.
+ *
+ * To initialize the Devtools alongside your application's {@link @fluidframework/fluid-static#IFluidContainer}, call
+ * {@link initializeDevtools}.
+ *
+ * The Devtools will automatically dispose of themselves upon Window unload, but if you would like to close them
+ * earlier, call {@link IDevtools.dispose}.
+ *
+ * To enable visualization of Telemetry data, you may create a {@link @fluidframework/devtools-core#DevtoolsLogger} and
+ * provide it during Devtools initialization.
+ *
+ * @packageDocumentation
  */
 
 export {

package/lib/beta.d.ts

@@ -5,7 +5,22 @@
 
 /*
  * 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.
+ */
+
+/**
+ * Primary entry-point to the Fluid Devtools.
+ *
+ * To initialize the Devtools alongside your application's {@link @fluidframework/fluid-static#IFluidContainer}, call
+ * {@link initializeDevtools}.
+ *
+ * The Devtools will automatically dispose of themselves upon Window unload, but if you would like to close them
+ * earlier, call {@link IDevtools.dispose}.
+ *
+ * To enable visualization of Telemetry data, you may create a {@link @fluidframework/devtools-core#DevtoolsLogger} and
+ * provide it during Devtools initialization.
+ *
+ * @packageDocumentation
  */
 
 export {

package/lib/public.d.ts

@@ -5,8 +5,21 @@
 
 /*
  * 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 {}
+/**
+ * Primary entry-point to the Fluid Devtools.
+ *
+ * To initialize the Devtools alongside your application's {@link @fluidframework/fluid-static#IFluidContainer}, call
+ * {@link initializeDevtools}.
+ *
+ * The Devtools will automatically dispose of themselves upon Window unload, but if you would like to close them
+ * earlier, call {@link IDevtools.dispose}.
+ *
+ * To enable visualization of Telemetry data, you may create a {@link @fluidframework/devtools-core#DevtoolsLogger} and
+ * provide it during Devtools initialization.
+ *
+ * @packageDocumentation
+ */export {}
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/devtools",
-  "version": "2.1.0-276985",
+  "version": "2.1.0",
   "description": "Fluid Framework developer tools",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -77,19 +77,19 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluidframework/container-definitions": "2.1.0-276985",
-    "@fluidframework/core-interfaces": "2.1.0-276985",
-    "@fluidframework/devtools-core": "2.1.0-276985",
-    "@fluidframework/fluid-static": "2.1.0-276985"
+    "@fluidframework/container-definitions": "~2.1.0",
+    "@fluidframework/core-interfaces": "~2.1.0",
+    "@fluidframework/devtools-core": "~2.1.0",
+    "@fluidframework/fluid-static": "~2.1.0"
   },
   "devDependencies": {
     "@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",
+    "@fluid-tools/build-cli": "^0.41.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.39.0",
-    "@fluidframework/devtools-previous": "npm:@fluidframework/devtools@2.0.0-rc.5.0.0",
+    "@fluidframework/build-tools": "^0.41.0",
+    "@fluidframework/devtools-previous": "npm:@fluidframework/devtools@2.0.0",
     "@fluidframework/eslint-config-fluid": "^5.3.0",
     "@microsoft/api-extractor": "^7.45.1",
     "@types/chai": "^4.0.0",
@@ -130,7 +130,7 @@
     "build:docs": "api-extractor run --local",
     "build:esnext": "tsc --project ./tsconfig.json",
     "check:are-the-types-wrong": "attw --pack .",
-    "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:alpha": "api-extractor run --config api-extractor/api-extractor-lint-alpha.cjs.json",
@@ -148,7 +148,7 @@
     "format": "npm run format:biome",
     "format-and-build": "npm run format && npm run build",
     "format-and-compile": "npm run format && npm run build:compile",
-    "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",