@fluidframework/container-definitions 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 +3 -3
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -10,8 +10,7 @@ Some important interfaces in here include:
|
|
|
10
10
|
- **IRuntime / IRuntimeFactory** - Contract necessary for the ContainerContext to "boot" a Container at runtime.
|
|
11
11
|
- **IDeltaManager / IDeltaQueue** - Abstraction over the Container's view of the ops being transmitted to/from storage.
|
|
12
12
|
|
|
13
|
-
<!--
|
|
14
|
-
|
|
13
|
+
<!-- markdown-magic:begin {"transform":"library-readme-header","headingLevel":2} -->
|
|
15
14
|
<!-- prettier-ignore-start -->
|
|
16
15
|
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
|
|
17
16
|
|
|
@@ -45,11 +44,9 @@ Import the `legacy` APIs from `@fluidframework/container-definitions/legacy`.
|
|
|
45
44
|
Read the **@fluidframework/container-definitions** API documentation at <https://fluidframework.com/docs/apis/container-definitions>.
|
|
46
45
|
|
|
47
46
|
<!-- prettier-ignore-end -->
|
|
47
|
+
<!-- markdown-magic:end -->
|
|
48
48
|
|
|
49
|
-
<!--
|
|
50
|
-
|
|
51
|
-
<!-- AUTO-GENERATED-CONTENT:START (README_FOOTER) -->
|
|
52
|
-
|
|
49
|
+
<!-- markdown-magic:begin {"transform":"readme-footer","headingLevel":2} -->
|
|
53
50
|
<!-- prettier-ignore-start -->
|
|
54
51
|
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
|
|
55
52
|
|
|
@@ -66,29 +63,29 @@ To request support for a configuration that is not listed, file an issue.
|
|
|
66
63
|
The product team will evaluate your request.
|
|
67
64
|
In the issue, specify the current status of the configuration:
|
|
68
65
|
|
|
69
|
-
-
|
|
70
|
-
-
|
|
66
|
+
- The configuration works but needs official support.
|
|
67
|
+
- The configuration does not work and requires changes.
|
|
71
68
|
|
|
72
69
|
### Supported Runtimes
|
|
73
70
|
|
|
74
|
-
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
-
|
|
71
|
+
- Fluid Framework supports Node.js versions 22 and 24 while they receive [upstream support](https://nodejs.org/en/about/previous-releases).
|
|
72
|
+
- Fluid Framework will stop support for version 22 [when upstream support ends on 2027-04-30](https://github.com/nodejs/release#release-schedule).
|
|
73
|
+
- Fluid Framework does not support Node.js with the `--no-experimental-fetch` flag.
|
|
74
|
+
- Fluid Framework supports modern browsers that support the ES2022 standard library.
|
|
78
75
|
|
|
79
76
|
### Supported Tools
|
|
80
77
|
|
|
81
|
-
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
-
|
|
90
|
-
|
|
91
|
-
|
|
78
|
+
- [TypeScript 6.0](https://typescriptdocs.com/release-notes/TypeScript%206.0):
|
|
79
|
+
- Fluid Framework supports all [`strict`](https://www.typescriptlang.org/tsconfig) options.
|
|
80
|
+
- Set the build targets (`lib`, `target`) to `ES2022` or later.
|
|
81
|
+
- Enable [`strictNullChecks`](https://www.typescriptlang.org/tsconfig).
|
|
82
|
+
- 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).
|
|
83
|
+
- Fluid Framework does not fully support `exactOptionalPropertyTypes`.
|
|
84
|
+
If you enable this option, do not use `in`, `Reflect.has`, `Object.hasOwn`, or `Object.prototype.hasOwnProperty` to narrow members of Fluid Framework types.
|
|
85
|
+
These methods can incorrectly exclude `undefined` from the possible values.
|
|
86
|
+
- [webpack](https://webpack.js.org/) 5
|
|
87
|
+
- We do not require a specific bundler.
|
|
88
|
+
Other bundlers that handle ES Modules can work, but we actively test only webpack.
|
|
92
89
|
|
|
93
90
|
### Module Resolution
|
|
94
91
|
|
|
@@ -99,25 +96,25 @@ Do not use `Node10` module resolution.
|
|
|
99
96
|
|
|
100
97
|
### Module Formats
|
|
101
98
|
|
|
102
|
-
-
|
|
103
|
-
|
|
104
|
-
-
|
|
105
|
-
|
|
99
|
+
- ES Modules:
|
|
100
|
+
Use ES Modules to consume Fluid Framework client packages, including in Node.js.
|
|
101
|
+
- CommonJS:
|
|
102
|
+
Fluid Framework does not officially support CommonJS in version 3.0 or later.
|
|
106
103
|
|
|
107
104
|
## Contribution Guidelines
|
|
108
105
|
|
|
109
106
|
You can [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid Framework in these ways:
|
|
110
107
|
|
|
111
|
-
-
|
|
112
|
-
-
|
|
113
|
-
-
|
|
114
|
-
-
|
|
108
|
+
- Answer questions in [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
|
|
109
|
+
- [Submit bug reports](https://github.com/microsoft/FluidFramework/issues) and help verify fixes.
|
|
110
|
+
- Review [source code changes](https://github.com/microsoft/FluidFramework/pulls).
|
|
111
|
+
- [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
|
|
115
112
|
|
|
116
113
|
For detailed instructions, read the [repo documentation](https://github.com/microsoft/FluidFramework/blob/main/docs/content/Home.md).
|
|
117
114
|
|
|
118
115
|
This project follows the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
|
119
116
|
For more information, read the [Code of Conduct frequently asked questions](https://opensource.microsoft.com/codeofconduct/faq/).
|
|
120
|
-
For questions or comments, contact
|
|
117
|
+
For questions or comments, contact <opencode@microsoft.com>.
|
|
121
118
|
|
|
122
119
|
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
|
|
123
120
|
Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
|
|
@@ -138,5 +135,4 @@ Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guid
|
|
|
138
135
|
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
|
|
139
136
|
|
|
140
137
|
<!-- prettier-ignore-end -->
|
|
141
|
-
|
|
142
|
-
<!-- AUTO-GENERATED-CONTENT:END -->
|
|
138
|
+
<!-- markdown-magic:end -->
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/container-definitions",
|
|
3
|
-
"version": "3.0
|
|
3
|
+
"version": "3.1.0",
|
|
4
4
|
"description": "Fluid container definitions",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -33,8 +33,8 @@
|
|
|
33
33
|
}
|
|
34
34
|
},
|
|
35
35
|
"dependencies": {
|
|
36
|
-
"@fluidframework/core-interfaces": "~3.0
|
|
37
|
-
"@fluidframework/driver-definitions": "~3.0
|
|
36
|
+
"@fluidframework/core-interfaces": "~3.1.0",
|
|
37
|
+
"@fluidframework/driver-definitions": "~3.1.0"
|
|
38
38
|
},
|
|
39
39
|
"devDependencies": {
|
|
40
40
|
"@arethetypeswrong/cli": "^0.18.5",
|