@fluidframework/azure-service-utils 2.1.0-276326 → 2.1.0-281041

package/README.md

@@ -9,10 +9,12 @@ A set of helper utilities for building backend APIs for use with Azure Fluid Rel
 
 ## Using Fluid Framework libraries
 
-When taking a dependency on a Fluid Framework library, we recommend using a `^` (caret) version range, such as `^1.3.4`.
+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 `~`.
+
 <!-- prettier-ignore-end -->
 
 <!-- AUTO-GENERATED-CONTENT:END -->
@@ -55,11 +57,9 @@ Use of Microsoft trademarks or logos in modified versions of this project must n
 
 ## Help
 
-Not finding what you're looking for in this README? Check out our [GitHub
-Wiki](https://github.com/microsoft/FluidFramework/wiki) or [fluidframework.com](https://fluidframework.com/docs/).
+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).
+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!
 

package/api-extractor/api-extractor.current.json

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

package/api-extractor/api-extractor.legacy.json

@@ -1,4 +1,4 @@
 {
 	"$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"
 }

package/api-extractor.json

@@ -1,4 +1,4 @@
 {
 	"$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"
 }

package/api-report/azure-service-utils.beta.api.md

@@ -6,6 +6,4 @@
 
 export { IUser }
 
-export { ScopeType }
-
 ```

package/api-report/azure-service-utils.legacy.alpha.api.md

@@ -11,6 +11,4 @@ export { IUser }
 
 export { ScopeType }
 
-// (No @packageDocumentation comment for this package)
-
 ```

package/api-report/azure-service-utils.legacy.public.api.md

@@ -0,0 +1,11 @@
+## Public API Report File for "@fluidframework/azure-service-utils"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+export { IUser }
+
+export { ScopeType }
+
+```

package/api-report/azure-service-utils.public.api.md

@@ -6,6 +6,4 @@
 
 export { IUser }
 
-export { ScopeType }
-
 ```

package/dist/legacy.d.ts

@@ -5,7 +5,19 @@
 
 /*
  * 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.
+ */
+
+/**
+ * A set of helper utilities for building backend APIs for use with
+ * {@link https://docs.microsoft.com/en-us/azure/azure-fluid-relay/overview/overview | Azure Fluid Relay}.
+ *
+ * @remarks
+ * Note that this library's primary entry-point ({@link generateToken}) is only intended
+ * to be run in a browser context.
+ * It is **not** Node.js-compatible.
+ *
+ * @packageDocumentation
  */
 
 export {

package/dist/public.d.ts

@@ -5,7 +5,19 @@
 
 /*
  * 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.
+ */
+
+/**
+ * A set of helper utilities for building backend APIs for use with
+ * {@link https://docs.microsoft.com/en-us/azure/azure-fluid-relay/overview/overview | Azure Fluid Relay}.
+ *
+ * @remarks
+ * Note that this library's primary entry-point ({@link generateToken}) is only intended
+ * to be run in a browser context.
+ * It is **not** Node.js-compatible.
+ *
+ * @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/legacy.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/legacy.js";

package/lib/legacy.d.ts

@@ -5,7 +5,19 @@
 
 /*
  * 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.
+ */
+
+/**
+ * A set of helper utilities for building backend APIs for use with
+ * {@link https://docs.microsoft.com/en-us/azure/azure-fluid-relay/overview/overview | Azure Fluid Relay}.
+ *
+ * @remarks
+ * Note that this library's primary entry-point ({@link generateToken}) is only intended
+ * to be run in a browser context.
+ * It is **not** Node.js-compatible.
+ *
+ * @packageDocumentation
  */
 
 export {

package/lib/public.d.ts

@@ -5,7 +5,19 @@
 
 /*
  * 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.
+ */
+
+/**
+ * A set of helper utilities for building backend APIs for use with
+ * {@link https://docs.microsoft.com/en-us/azure/azure-fluid-relay/overview/overview | Azure Fluid Relay}.
+ *
+ * @remarks
+ * Note that this library's primary entry-point ({@link generateToken}) is only intended
+ * to be run in a browser context.
+ * It is **not** Node.js-compatible.
+ *
+ * @packageDocumentation
  */
 
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/azure-service-utils",
-  "version": "2.1.0-276326",
+  "version": "2.1.0-281041",
   "description": "Helper service-side utilities for connecting to Azure Fluid Relay service",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -47,17 +47,17 @@
   "main": "lib/index.js",
   "types": "lib/public.d.ts",
   "dependencies": {
-    "@fluidframework/driver-definitions": "2.1.0-276326",
+    "@fluidframework/driver-definitions": "2.1.0-281041",
     "jsrsasign": "^11.0.0",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
-    "@biomejs/biome": "^1.7.3",
-    "@fluid-tools/build-cli": "^0.39.0",
-    "@fluidframework/azure-service-utils-previous": "npm:@fluidframework/azure-service-utils@2.0.0-rc.5.0.0",
+    "@biomejs/biome": "~1.8.3",
+    "@fluid-tools/build-cli": "^0.40.0",
+    "@fluidframework/azure-service-utils-previous": "npm:@fluidframework/azure-service-utils@2.0.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",
     "@microsoft/api-extractor": "^7.45.1",
     "@types/jsrsasign": "^10.5.12",
@@ -78,17 +78,18 @@
     "api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
     "api-extractor:esnext": "flub generate entrypoints --outDir ./lib --node10TypeCompat",
     "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",
     "build:test": "npm run build:test:esm && npm run build:test:cjs",
     "build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
     "build:test:esm": "tsc --project ./src/test/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:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.cjs.json",
@@ -97,14 +98,15 @@
     "check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.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: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",
     "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",