@fluidframework/datastore-definitions 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
|
@@ -2,8 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Interface `IFluidDataStoreRuntime` specifies the data store developer API.
|
|
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/datastore-definitions/legacy`.
|
|
|
37
36
|
Read the **@fluidframework/datastore-definitions** API documentation at <https://fluidframework.com/docs/apis/datastore-definitions>.
|
|
38
37
|
|
|
39
38
|
<!-- prettier-ignore-end -->
|
|
40
|
-
|
|
41
|
-
<!-- AUTO-GENERATED-CONTENT:END -->
|
|
39
|
+
<!-- markdown-magic:end -->
|
|
42
40
|
|
|
43
41
|
## Capabilities exposed on `IFluidDataStoreRuntime`
|
|
44
42
|
|
|
@@ -64,8 +62,7 @@ For this reason people usually stick the currentSeq on the signal, so other clie
|
|
|
64
62
|
You can send a signal via the container or data store runtime. The container will emit the signal event on all signals,
|
|
65
63
|
but a data store will emit the signal event only on signals emitted on that data store runtime.
|
|
66
64
|
|
|
67
|
-
<!--
|
|
68
|
-
|
|
65
|
+
<!-- markdown-magic:begin {"transform":"readme-footer","headingLevel":2} -->
|
|
69
66
|
<!-- prettier-ignore-start -->
|
|
70
67
|
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
|
|
71
68
|
|
|
@@ -82,29 +79,29 @@ To request support for a configuration that is not listed, file an issue.
|
|
|
82
79
|
The product team will evaluate your request.
|
|
83
80
|
In the issue, specify the current status of the configuration:
|
|
84
81
|
|
|
85
|
-
-
|
|
86
|
-
-
|
|
82
|
+
- The configuration works but needs official support.
|
|
83
|
+
- The configuration does not work and requires changes.
|
|
87
84
|
|
|
88
85
|
### Supported Runtimes
|
|
89
86
|
|
|
90
|
-
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
-
|
|
87
|
+
- Fluid Framework supports Node.js versions 22 and 24 while they receive [upstream support](https://nodejs.org/en/about/previous-releases).
|
|
88
|
+
- Fluid Framework will stop support for version 22 [when upstream support ends on 2027-04-30](https://github.com/nodejs/release#release-schedule).
|
|
89
|
+
- Fluid Framework does not support Node.js with the `--no-experimental-fetch` flag.
|
|
90
|
+
- Fluid Framework supports modern browsers that support the ES2022 standard library.
|
|
94
91
|
|
|
95
92
|
### Supported Tools
|
|
96
93
|
|
|
97
|
-
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
-
|
|
106
|
-
|
|
107
|
-
|
|
94
|
+
- [TypeScript 6.0](https://typescriptdocs.com/release-notes/TypeScript%206.0):
|
|
95
|
+
- Fluid Framework supports all [`strict`](https://www.typescriptlang.org/tsconfig) options.
|
|
96
|
+
- Set the build targets (`lib`, `target`) to `ES2022` or later.
|
|
97
|
+
- Enable [`strictNullChecks`](https://www.typescriptlang.org/tsconfig).
|
|
98
|
+
- 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).
|
|
99
|
+
- Fluid Framework does not fully support `exactOptionalPropertyTypes`.
|
|
100
|
+
If you enable this option, do not use `in`, `Reflect.has`, `Object.hasOwn`, or `Object.prototype.hasOwnProperty` to narrow members of Fluid Framework types.
|
|
101
|
+
These methods can incorrectly exclude `undefined` from the possible values.
|
|
102
|
+
- [webpack](https://webpack.js.org/) 5
|
|
103
|
+
- We do not require a specific bundler.
|
|
104
|
+
Other bundlers that handle ES Modules can work, but we actively test only webpack.
|
|
108
105
|
|
|
109
106
|
### Module Resolution
|
|
110
107
|
|
|
@@ -115,25 +112,25 @@ Do not use `Node10` module resolution.
|
|
|
115
112
|
|
|
116
113
|
### Module Formats
|
|
117
114
|
|
|
118
|
-
-
|
|
119
|
-
|
|
120
|
-
-
|
|
121
|
-
|
|
115
|
+
- ES Modules:
|
|
116
|
+
Use ES Modules to consume Fluid Framework client packages, including in Node.js.
|
|
117
|
+
- CommonJS:
|
|
118
|
+
Fluid Framework does not officially support CommonJS in version 3.0 or later.
|
|
122
119
|
|
|
123
120
|
## Contribution Guidelines
|
|
124
121
|
|
|
125
122
|
You can [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid Framework in these ways:
|
|
126
123
|
|
|
127
|
-
-
|
|
128
|
-
-
|
|
129
|
-
-
|
|
130
|
-
-
|
|
124
|
+
- Answer questions in [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
|
|
125
|
+
- [Submit bug reports](https://github.com/microsoft/FluidFramework/issues) and help verify fixes.
|
|
126
|
+
- Review [source code changes](https://github.com/microsoft/FluidFramework/pulls).
|
|
127
|
+
- [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
|
|
131
128
|
|
|
132
129
|
For detailed instructions, read the [repo documentation](https://github.com/microsoft/FluidFramework/blob/main/docs/content/Home.md).
|
|
133
130
|
|
|
134
131
|
This project follows the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
|
135
132
|
For more information, read the [Code of Conduct frequently asked questions](https://opensource.microsoft.com/codeofconduct/faq/).
|
|
136
|
-
For questions or comments, contact
|
|
133
|
+
For questions or comments, contact <opencode@microsoft.com>.
|
|
137
134
|
|
|
138
135
|
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
|
|
139
136
|
Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
|
|
@@ -154,5 +151,4 @@ Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guid
|
|
|
154
151
|
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
|
|
155
152
|
|
|
156
153
|
<!-- prettier-ignore-end -->
|
|
157
|
-
|
|
158
|
-
<!-- AUTO-GENERATED-CONTENT:END -->
|
|
154
|
+
<!-- markdown-magic:end -->
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/datastore-definitions",
|
|
3
|
-
"version": "3.0
|
|
3
|
+
"version": "3.1.0",
|
|
4
4
|
"description": "Fluid data store definitions",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -36,11 +36,11 @@
|
|
|
36
36
|
}
|
|
37
37
|
},
|
|
38
38
|
"dependencies": {
|
|
39
|
-
"@fluidframework/container-definitions": "~3.0
|
|
40
|
-
"@fluidframework/core-interfaces": "~3.0
|
|
41
|
-
"@fluidframework/driver-definitions": "~3.0
|
|
42
|
-
"@fluidframework/id-compressor": "~3.0
|
|
43
|
-
"@fluidframework/runtime-definitions": "~3.0
|
|
39
|
+
"@fluidframework/container-definitions": "~3.1.0",
|
|
40
|
+
"@fluidframework/core-interfaces": "~3.1.0",
|
|
41
|
+
"@fluidframework/driver-definitions": "~3.1.0",
|
|
42
|
+
"@fluidframework/id-compressor": "~3.1.0",
|
|
43
|
+
"@fluidframework/runtime-definitions": "~3.1.0"
|
|
44
44
|
},
|
|
45
45
|
"devDependencies": {
|
|
46
46
|
"@arethetypeswrong/cli": "^0.18.5",
|