@fluidframework/azure-local-service 2.1.0-276985 → 2.1.0-281041

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +58 -20
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -6,7 +6,7 @@ Azure local service is a minimal, self-contained, test implementation of the Azu
6
6
 
7
7
  The Azure local service includes most of the basic features needed to **test** data stores and containers. While we use the [Webpack Fluid Loader](../../packages/tools/webpack-fluid-loader)'s in browser service for much of our data store and container development, the Azure local service offers some advantages because it's a standalone process. For instance, testing a Fluid container from 2+ simultaneously connected clients is much easier using the Azure local service.
8
8
 
9
- <!-- AUTO-GENERATED-CONTENT:START (README_DEPENDENCY_GUIDELINES_SECTION:includeHeading=TRUE) -->
9
+ <!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README_HEADER) -->
10
10
 
11
11
  <!-- prettier-ignore-start -->
12
12
  <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
@@ -19,6 +19,14 @@ library consumers should always prefer `^`.
19
19
 
20
20
  If using any of Fluid Framework's unstable APIs (for example, its `beta` APIs), we recommend using a more constrained version range, such as `~`.
21
21
 
22
+ ## Installation
23
+
24
+ To get started, install the package by running the following command:
25
+
26
+ ```bash
27
+ npm i @fluidframework/azure-local-service
28
+ ```
29
+
22
30
  <!-- prettier-ignore-end -->
23
31
 
24
32
  <!-- AUTO-GENERATED-CONTENT:END -->
@@ -45,11 +53,59 @@ $env:PORT=6502
45
53
  npm run start
46
54
  ```
47
55
 
48
- <!-- AUTO-GENERATED-CONTENT:START (README_CONTRIBUTION_GUIDELINES_SECTION:includeHeading=TRUE) -->
56
+ <!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README_FOOTER) -->
49
57
 
50
58
  <!-- prettier-ignore-start -->
51
59
  <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
52
60
 
61
+ ## API Documentation
62
+
63
+ API documentation for **@fluidframework/azure-local-service** is available at <https://fluidframework.com/docs/apis/azure-local-service>.
64
+
65
+ ## Minimum Client Requirements
66
+
67
+ These are the platform requirements for the current version of Fluid Framework Client Packages.
68
+ 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.
69
+ For Long Term Support (LTS) versions this can require supporting these platforms for several years.
70
+
71
+ It is likely that other configurations will work, but they are not supported: if they stop working, we do not consider that a bug.
72
+ If you would benefit from support for something not listed here, file an issue and the product team will evaluate your request.
73
+ 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.
74
+
75
+ ### Supported Runtimes
76
+
77
+ - 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).
78
+ - 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).
79
+
80
+ ### Supported Tools
81
+
82
+ - TypeScript 5.4:
83
+ - All [`strict`](https://www.typescriptlang.org/tsconfig) options are supported.
84
+ - [`strictNullChecks`](https://www.typescriptlang.org/tsconfig) is required.
85
+ - [Configuration options deprecated in 5.0](https://github.com/microsoft/TypeScript/issues/51909) are not supported.
86
+ - `exactOptionalPropertyTypes` is currently not fully supported.
87
+ 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.
88
+ - [webpack](https://webpack.js.org/) 5
89
+ - We are not intending to be prescriptive about what bundler to use.
90
+ Other bundlers which can handle ES Modules should work, but webpack is the only one we actively test.
91
+
92
+ ### Module Resolution
93
+
94
+ [`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).
95
+ 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.
96
+
97
+ ### Module Formats
98
+
99
+ - ES Modules:
100
+ 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.
101
+ - CommonJs:
102
+ Consuming our client packages as CommonJs is supported only in NodeJS and only for the cases listed below.
103
+ This is done to accommodate some workflows without good ES Module support.
104
+ If you have a workflow you would like included in this list, file an issue.
105
+ 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.
106
+
107
+ - 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))
108
+
53
109
  ## Contribution Guidelines
54
110
 
55
111
  There are many ways to [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid.
@@ -68,15 +124,6 @@ This project may contain Microsoft trademarks or logos for Microsoft projects, p
68
124
  Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
69
125
  Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
70
126
 
71
- <!-- prettier-ignore-end -->
72
-
73
- <!-- AUTO-GENERATED-CONTENT:END -->
74
-
75
- <!-- AUTO-GENERATED-CONTENT:START (README_HELP_SECTION:includeHeading=TRUE) -->
76
-
77
- <!-- prettier-ignore-start -->
78
- <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
79
-
80
127
  ## Help
81
128
 
82
129
  Not finding what you're looking for in this README? Check out [fluidframework.com](https://fluidframework.com/docs/).
@@ -85,15 +132,6 @@ Still not finding what you're looking for? Please [file an issue](https://github
85
132
 
86
133
  Thank you!
87
134
 
88
- <!-- prettier-ignore-end -->
89
-
90
- <!-- AUTO-GENERATED-CONTENT:END -->
91
-
92
- <!-- AUTO-GENERATED-CONTENT:START (README_TRADEMARK_SECTION:includeHeading=TRUE) -->
93
-
94
- <!-- prettier-ignore-start -->
95
- <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
96
-
97
135
  ## Trademark
98
136
 
99
137
  This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/azure-local-service",
3
- "version": "2.1.0-276985",
3
+ "version": "2.1.0-281041",
4
4
  "description": "Local implementation of the Azure Fluid Relay service for testing/development use",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -16,9 +16,9 @@
16
16
  "tinylicious": "^5.0.0"
17
17
  },
18
18
  "devDependencies": {
19
- "@biomejs/biome": "^1.7.3",
19
+ "@biomejs/biome": "~1.8.3",
20
20
  "@fluidframework/build-common": "^2.0.3",
21
- "@fluidframework/build-tools": "^0.39.0",
21
+ "@fluidframework/build-tools": "^0.40.0",
22
22
  "@fluidframework/eslint-config-fluid": "^5.3.0",
23
23
  "eslint": "~8.55.0",
24
24
  "eslint-config-prettier": "~9.0.0",
@@ -36,14 +36,14 @@
36
36
  "build": "fluid-build . --task build",
37
37
  "build:compile": "fluid-build . --task compile",
38
38
  "build:esnext": "tsc --project ./tsconfig.json",
39
- "check:biome": "biome check . --formatter-enabled=true",
39
+ "check:biome": "biome check .",
40
40
  "check:format": "npm run check:biome",
41
41
  "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
42
42
  "clean": "rimraf --glob dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp",
43
43
  "eslint": "eslint --format stylish src",
44
44
  "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
45
45
  "format": "npm run format:biome",
46
- "format:biome": "biome check . --formatter-enabled=true --apply",
46
+ "format:biome": "biome check . --write",
47
47
  "format:prettier": "prettier --write . --cache --ignore-path ../../../.prettierignore",
48
48
  "lint": "fluid-build . --task lint",
49
49
  "lint:fix": "fluid-build . --task eslint:fix --task format",