@fluidframework/synthesize 3.0.2 → 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 +6 -6
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -3,8 +3,7 @@
|
|
|
3
3
|
An Ioc type library for synthesizing a FluidObject based on FluidObject providers.
|
|
4
4
|
|
|
5
5
|
|
|
6
|
-
<!--
|
|
7
|
-
|
|
6
|
+
<!-- markdown-magic:begin {"transform":"library-readme-header","headingLevel":2} -->
|
|
8
7
|
<!-- prettier-ignore-start -->
|
|
9
8
|
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
|
|
10
9
|
|
|
@@ -38,8 +37,7 @@ Import the `legacy` APIs from `@fluidframework/synthesize/legacy`.
|
|
|
38
37
|
Read the **@fluidframework/synthesize** API documentation at <https://fluidframework.com/docs/apis/synthesize>.
|
|
39
38
|
|
|
40
39
|
<!-- prettier-ignore-end -->
|
|
41
|
-
|
|
42
|
-
<!-- AUTO-GENERATED-CONTENT:END -->
|
|
40
|
+
<!-- markdown-magic:end -->
|
|
43
41
|
|
|
44
42
|
It allows for the creation of a `DependencyContainer` that can have FluidObjects registered with it
|
|
45
43
|
based on their interface Symbol. So for example if I wanted to register something as `IFoo` I would
|
|
@@ -264,8 +262,7 @@ console.log(bar.bar);
|
|
|
264
262
|
The `DependencyContainer` takes one optional parameter which is the `parent`. When resolving providers the `DependencyContainer` will first
|
|
265
263
|
check the current container then look in the parent.
|
|
266
264
|
|
|
267
|
-
<!--
|
|
268
|
-
|
|
265
|
+
<!-- markdown-magic:begin {"transform":"readme-footer","headingLevel":2} -->
|
|
269
266
|
<!-- prettier-ignore-start -->
|
|
270
267
|
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
|
|
271
268
|
|
|
@@ -282,29 +279,29 @@ To request support for a configuration that is not listed, file an issue.
|
|
|
282
279
|
The product team will evaluate your request.
|
|
283
280
|
In the issue, specify the current status of the configuration:
|
|
284
281
|
|
|
285
|
-
-
|
|
286
|
-
-
|
|
282
|
+
- The configuration works but needs official support.
|
|
283
|
+
- The configuration does not work and requires changes.
|
|
287
284
|
|
|
288
285
|
### Supported Runtimes
|
|
289
286
|
|
|
290
|
-
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
-
|
|
287
|
+
- Fluid Framework supports Node.js versions 22 and 24 while they receive [upstream support](https://nodejs.org/en/about/previous-releases).
|
|
288
|
+
- Fluid Framework will stop support for version 22 [when upstream support ends on 2027-04-30](https://github.com/nodejs/release#release-schedule).
|
|
289
|
+
- Fluid Framework does not support Node.js with the `--no-experimental-fetch` flag.
|
|
290
|
+
- Fluid Framework supports modern browsers that support the ES2022 standard library.
|
|
294
291
|
|
|
295
292
|
### Supported Tools
|
|
296
293
|
|
|
297
|
-
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
-
|
|
306
|
-
|
|
307
|
-
|
|
294
|
+
- [TypeScript 6.0](https://typescriptdocs.com/release-notes/TypeScript%206.0):
|
|
295
|
+
- Fluid Framework supports all [`strict`](https://www.typescriptlang.org/tsconfig) options.
|
|
296
|
+
- Set the build targets (`lib`, `target`) to `ES2022` or later.
|
|
297
|
+
- Enable [`strictNullChecks`](https://www.typescriptlang.org/tsconfig).
|
|
298
|
+
- 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).
|
|
299
|
+
- Fluid Framework does not fully support `exactOptionalPropertyTypes`.
|
|
300
|
+
If you enable this option, do not use `in`, `Reflect.has`, `Object.hasOwn`, or `Object.prototype.hasOwnProperty` to narrow members of Fluid Framework types.
|
|
301
|
+
These methods can incorrectly exclude `undefined` from the possible values.
|
|
302
|
+
- [webpack](https://webpack.js.org/) 5
|
|
303
|
+
- We do not require a specific bundler.
|
|
304
|
+
Other bundlers that handle ES Modules can work, but we actively test only webpack.
|
|
308
305
|
|
|
309
306
|
### Module Resolution
|
|
310
307
|
|
|
@@ -315,25 +312,25 @@ Do not use `Node10` module resolution.
|
|
|
315
312
|
|
|
316
313
|
### Module Formats
|
|
317
314
|
|
|
318
|
-
-
|
|
319
|
-
|
|
320
|
-
-
|
|
321
|
-
|
|
315
|
+
- ES Modules:
|
|
316
|
+
Use ES Modules to consume Fluid Framework client packages, including in Node.js.
|
|
317
|
+
- CommonJS:
|
|
318
|
+
Fluid Framework does not officially support CommonJS in version 3.0 or later.
|
|
322
319
|
|
|
323
320
|
## Contribution Guidelines
|
|
324
321
|
|
|
325
322
|
You can [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid Framework in these ways:
|
|
326
323
|
|
|
327
|
-
-
|
|
328
|
-
-
|
|
329
|
-
-
|
|
330
|
-
-
|
|
324
|
+
- Answer questions in [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
|
|
325
|
+
- [Submit bug reports](https://github.com/microsoft/FluidFramework/issues) and help verify fixes.
|
|
326
|
+
- Review [source code changes](https://github.com/microsoft/FluidFramework/pulls).
|
|
327
|
+
- [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
|
|
331
328
|
|
|
332
329
|
For detailed instructions, read the [repo documentation](https://github.com/microsoft/FluidFramework/blob/main/docs/content/Home.md).
|
|
333
330
|
|
|
334
331
|
This project follows the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
|
335
332
|
For more information, read the [Code of Conduct frequently asked questions](https://opensource.microsoft.com/codeofconduct/faq/).
|
|
336
|
-
For questions or comments, contact
|
|
333
|
+
For questions or comments, contact <opencode@microsoft.com>.
|
|
337
334
|
|
|
338
335
|
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
|
|
339
336
|
Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
|
|
@@ -354,5 +351,4 @@ Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guid
|
|
|
354
351
|
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
|
|
355
352
|
|
|
356
353
|
<!-- prettier-ignore-end -->
|
|
357
|
-
|
|
358
|
-
<!-- AUTO-GENERATED-CONTENT:END -->
|
|
354
|
+
<!-- markdown-magic:end -->
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/synthesize",
|
|
3
|
-
"version": "3.0
|
|
3
|
+
"version": "3.1.0",
|
|
4
4
|
"description": "A library for synthesizing scope objects.",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -55,19 +55,19 @@
|
|
|
55
55
|
"temp-directory": "nyc/.nyc_output"
|
|
56
56
|
},
|
|
57
57
|
"dependencies": {
|
|
58
|
-
"@fluidframework/core-utils": "~3.0
|
|
58
|
+
"@fluidframework/core-utils": "~3.1.0"
|
|
59
59
|
},
|
|
60
60
|
"devDependencies": {
|
|
61
61
|
"@arethetypeswrong/cli": "^0.18.5",
|
|
62
62
|
"@biomejs/biome": "~2.4.5",
|
|
63
|
-
"@fluid-internal/mocha-test-setup": "~3.0
|
|
63
|
+
"@fluid-internal/mocha-test-setup": "~3.1.0",
|
|
64
64
|
"@fluid-tools/build-cli": "^0.67.0",
|
|
65
65
|
"@fluidframework/build-common": "^2.0.3",
|
|
66
66
|
"@fluidframework/build-tools": "^0.67.0",
|
|
67
|
-
"@fluidframework/core-interfaces": "~3.0
|
|
68
|
-
"@fluidframework/datastore": "~3.0
|
|
67
|
+
"@fluidframework/core-interfaces": "~3.1.0",
|
|
68
|
+
"@fluidframework/datastore": "~3.1.0",
|
|
69
69
|
"@fluidframework/eslint-config-fluid": "^14.0.0",
|
|
70
|
-
"@fluidframework/runtime-utils": "~3.0
|
|
70
|
+
"@fluidframework/runtime-utils": "~3.1.0",
|
|
71
71
|
"@fluidframework/synthesize-previous": "npm:@fluidframework/synthesize@2.116.0",
|
|
72
72
|
"@microsoft/api-extractor": "7.58.1",
|
|
73
73
|
"@types/mocha": "^10.0.10",
|