@fluidframework/azure-client 3.0.1 → 3.1.0
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.
- package/CHANGELOG.md +4 -0
- package/README.md +30 -34
- package/package.json +16 -16
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -2,8 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
The azure-client package provides a simple and powerful way to consume collaborative Fluid data with the Azure Fluid Relay service.
|
|
4
4
|
|
|
5
|
-
<!--
|
|
6
|
-
|
|
5
|
+
<!-- markdown-magic:begin {"transform":"library-readme-header","headingLevel":2} -->
|
|
7
6
|
<!-- prettier-ignore-start -->
|
|
8
7
|
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
|
|
9
8
|
|
|
@@ -37,8 +36,7 @@ Import the `legacy` APIs from `@fluidframework/azure-client/legacy`.
|
|
|
37
36
|
Read the **@fluidframework/azure-client** API documentation at <https://fluidframework.com/docs/apis/azure-client>.
|
|
38
37
|
|
|
39
38
|
<!-- prettier-ignore-end -->
|
|
40
|
-
|
|
41
|
-
<!-- AUTO-GENERATED-CONTENT:END -->
|
|
39
|
+
<!-- markdown-magic:end -->
|
|
42
40
|
|
|
43
41
|
## Using azure-client
|
|
44
42
|
|
|
@@ -207,8 +205,7 @@ const text1 = await map1.get(); // Resolve the handle to get the object
|
|
|
207
205
|
const text1 = await map1.get("text1-unique-id").get();
|
|
208
206
|
```
|
|
209
207
|
|
|
210
|
-
<!--
|
|
211
|
-
|
|
208
|
+
<!-- markdown-magic:begin {"transform":"readme-footer","headingLevel":2} -->
|
|
212
209
|
<!-- prettier-ignore-start -->
|
|
213
210
|
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
|
|
214
211
|
|
|
@@ -225,29 +222,29 @@ To request support for a configuration that is not listed, file an issue.
|
|
|
225
222
|
The product team will evaluate your request.
|
|
226
223
|
In the issue, specify the current status of the configuration:
|
|
227
224
|
|
|
228
|
-
-
|
|
229
|
-
-
|
|
225
|
+
- The configuration works but needs official support.
|
|
226
|
+
- The configuration does not work and requires changes.
|
|
230
227
|
|
|
231
228
|
### Supported Runtimes
|
|
232
229
|
|
|
233
|
-
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
-
|
|
230
|
+
- Fluid Framework supports Node.js versions 22 and 24 while they receive [upstream support](https://nodejs.org/en/about/previous-releases).
|
|
231
|
+
- Fluid Framework will stop support for version 22 [when upstream support ends on 2027-04-30](https://github.com/nodejs/release#release-schedule).
|
|
232
|
+
- Fluid Framework does not support Node.js with the `--no-experimental-fetch` flag.
|
|
233
|
+
- Fluid Framework supports modern browsers that support the ES2022 standard library.
|
|
237
234
|
|
|
238
235
|
### Supported Tools
|
|
239
236
|
|
|
240
|
-
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
-
|
|
249
|
-
|
|
250
|
-
|
|
237
|
+
- [TypeScript 6.0](https://typescriptdocs.com/release-notes/TypeScript%206.0):
|
|
238
|
+
- Fluid Framework supports all [`strict`](https://www.typescriptlang.org/tsconfig) options.
|
|
239
|
+
- Set the build targets (`lib`, `target`) to `ES2022` or later.
|
|
240
|
+
- Enable [`strictNullChecks`](https://www.typescriptlang.org/tsconfig).
|
|
241
|
+
- Fluid Framework does not support [configuration options deprecated in TypeScript 6.0](https://typescriptdocs.com/release-notes/TypeScript%206.0#breaking-changes-and-deprecations-in-typescript-6-0).
|
|
242
|
+
- Fluid Framework does not fully support `exactOptionalPropertyTypes`.
|
|
243
|
+
If you enable this option, do not use `in`, `Reflect.has`, `Object.hasOwn`, or `Object.prototype.hasOwnProperty` to narrow members of Fluid Framework types.
|
|
244
|
+
These methods can incorrectly exclude `undefined` from the possible values.
|
|
245
|
+
- [webpack](https://webpack.js.org/) 5
|
|
246
|
+
- We do not require a specific bundler.
|
|
247
|
+
Other bundlers that handle ES Modules can work, but we actively test only webpack.
|
|
251
248
|
|
|
252
249
|
### Module Resolution
|
|
253
250
|
|
|
@@ -258,25 +255,25 @@ Do not use `Node10` module resolution.
|
|
|
258
255
|
|
|
259
256
|
### Module Formats
|
|
260
257
|
|
|
261
|
-
-
|
|
262
|
-
|
|
263
|
-
-
|
|
264
|
-
|
|
258
|
+
- ES Modules:
|
|
259
|
+
Use ES Modules to consume Fluid Framework client packages, including in Node.js.
|
|
260
|
+
- CommonJS:
|
|
261
|
+
Fluid Framework does not officially support CommonJS in version 3.0 or later.
|
|
265
262
|
|
|
266
263
|
## Contribution Guidelines
|
|
267
264
|
|
|
268
265
|
You can [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid Framework in these ways:
|
|
269
266
|
|
|
270
|
-
-
|
|
271
|
-
-
|
|
272
|
-
-
|
|
273
|
-
-
|
|
267
|
+
- Answer questions in [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
|
|
268
|
+
- [Submit bug reports](https://github.com/microsoft/FluidFramework/issues) and help verify fixes.
|
|
269
|
+
- Review [source code changes](https://github.com/microsoft/FluidFramework/pulls).
|
|
270
|
+
- [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
|
|
274
271
|
|
|
275
272
|
For detailed instructions, read the [repo documentation](https://github.com/microsoft/FluidFramework/blob/main/docs/content/Home.md).
|
|
276
273
|
|
|
277
274
|
This project follows the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
|
278
275
|
For more information, read the [Code of Conduct frequently asked questions](https://opensource.microsoft.com/codeofconduct/faq/).
|
|
279
|
-
For questions or comments, contact
|
|
276
|
+
For questions or comments, contact <opencode@microsoft.com>.
|
|
280
277
|
|
|
281
278
|
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
|
|
282
279
|
Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
|
|
@@ -297,5 +294,4 @@ Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guid
|
|
|
297
294
|
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
|
|
298
295
|
|
|
299
296
|
<!-- prettier-ignore-end -->
|
|
300
|
-
|
|
301
|
-
<!-- AUTO-GENERATED-CONTENT:END -->
|
|
297
|
+
<!-- markdown-magic:end -->
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/azure-client",
|
|
3
|
-
"version": "3.0
|
|
3
|
+
"version": "3.1.0",
|
|
4
4
|
"description": "A tool to enable creation and loading of Fluid containers using the Azure Fluid Relay service",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -33,29 +33,29 @@
|
|
|
33
33
|
}
|
|
34
34
|
},
|
|
35
35
|
"dependencies": {
|
|
36
|
-
"@fluidframework/container-definitions": "~3.0
|
|
37
|
-
"@fluidframework/container-loader": "~3.0
|
|
38
|
-
"@fluidframework/core-interfaces": "~3.0
|
|
39
|
-
"@fluidframework/driver-definitions": "~3.0
|
|
40
|
-
"@fluidframework/driver-utils": "~3.0
|
|
41
|
-
"@fluidframework/fluid-static": "~3.0
|
|
42
|
-
"@fluidframework/routerlicious-driver": "~3.0
|
|
43
|
-
"@fluidframework/runtime-definitions": "~3.0
|
|
44
|
-
"@fluidframework/telemetry-utils": "~3.0
|
|
36
|
+
"@fluidframework/container-definitions": "~3.1.0",
|
|
37
|
+
"@fluidframework/container-loader": "~3.1.0",
|
|
38
|
+
"@fluidframework/core-interfaces": "~3.1.0",
|
|
39
|
+
"@fluidframework/driver-definitions": "~3.1.0",
|
|
40
|
+
"@fluidframework/driver-utils": "~3.1.0",
|
|
41
|
+
"@fluidframework/fluid-static": "~3.1.0",
|
|
42
|
+
"@fluidframework/routerlicious-driver": "~3.1.0",
|
|
43
|
+
"@fluidframework/runtime-definitions": "~3.1.0",
|
|
44
|
+
"@fluidframework/telemetry-utils": "~3.1.0"
|
|
45
45
|
},
|
|
46
46
|
"devDependencies": {
|
|
47
47
|
"@arethetypeswrong/cli": "^0.18.5",
|
|
48
48
|
"@biomejs/biome": "~2.4.5",
|
|
49
|
-
"@fluid-internal/mocha-test-setup": "~3.0
|
|
49
|
+
"@fluid-internal/mocha-test-setup": "~3.1.0",
|
|
50
50
|
"@fluid-tools/build-cli": "^0.67.0",
|
|
51
51
|
"@fluidframework/azure-client-previous": "npm:@fluidframework/azure-client@2.116.0",
|
|
52
|
-
"@fluidframework/azure-local-service": "~3.0
|
|
52
|
+
"@fluidframework/azure-local-service": "~3.1.0",
|
|
53
53
|
"@fluidframework/build-common": "^2.0.3",
|
|
54
54
|
"@fluidframework/build-tools": "^0.67.0",
|
|
55
|
-
"@fluidframework/container-runtime": "~3.0
|
|
55
|
+
"@fluidframework/container-runtime": "~3.1.0",
|
|
56
56
|
"@fluidframework/eslint-config-fluid": "^14.0.0",
|
|
57
|
-
"@fluidframework/test-runtime-utils": "~3.0
|
|
58
|
-
"@fluidframework/test-utils": "~3.0
|
|
57
|
+
"@fluidframework/test-runtime-utils": "~3.1.0",
|
|
58
|
+
"@fluidframework/test-utils": "~3.1.0",
|
|
59
59
|
"@microsoft/api-extractor": "7.58.1",
|
|
60
60
|
"@types/mocha": "^10.0.10",
|
|
61
61
|
"@types/node": "~22.19.17",
|
|
@@ -64,7 +64,7 @@
|
|
|
64
64
|
"cross-env": "^10.1.0",
|
|
65
65
|
"eslint": "~9.39.1",
|
|
66
66
|
"eslint-config-prettier": "~10.1.8",
|
|
67
|
-
"fluid-framework": "~3.0
|
|
67
|
+
"fluid-framework": "~3.1.0",
|
|
68
68
|
"jiti": "^2.6.1",
|
|
69
69
|
"mocha": "^11.7.5",
|
|
70
70
|
"rimraf": "^6.1.3",
|