@fluidframework/shared-summary-block 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/dist/packageVersion.d.ts +1 -1
- package/dist/packageVersion.js +1 -1
- package/dist/packageVersion.js.map +1 -1
- package/lib/packageVersion.d.ts +1 -1
- package/lib/packageVersion.js +1 -1
- package/lib/packageVersion.js.map +1 -1
- package/package.json +10 -10
- package/src/packageVersion.ts +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -3,8 +3,7 @@
|
|
|
3
3
|
SharedSummaryBlock is a DDS that does not generate ops but is part of the summary. The name block comes from the fact that the data in this object is shared across clients only via summary blocks.
|
|
4
4
|
The data on this object must only be set in response to a remote op. Basically, if we replay same ops, the set of calls on this object to set data should be the same. This is critical because it does not generate ops of its own, but relies on the above principle to maintain eventual consistency and to summarize.
|
|
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,11 +37,9 @@ Import the `legacy` APIs from `@fluidframework/shared-summary-block/legacy`.
|
|
|
38
37
|
Read the **@fluidframework/shared-summary-block** API documentation at <https://fluidframework.com/docs/apis/shared-summary-block>.
|
|
39
38
|
|
|
40
39
|
<!-- prettier-ignore-end -->
|
|
40
|
+
<!-- markdown-magic:end -->
|
|
41
41
|
|
|
42
|
-
<!--
|
|
43
|
-
|
|
44
|
-
<!-- AUTO-GENERATED-CONTENT:START (README_FOOTER) -->
|
|
45
|
-
|
|
42
|
+
<!-- markdown-magic:begin {"transform":"readme-footer","headingLevel":2} -->
|
|
46
43
|
<!-- prettier-ignore-start -->
|
|
47
44
|
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
|
|
48
45
|
|
|
@@ -59,29 +56,29 @@ To request support for a configuration that is not listed, file an issue.
|
|
|
59
56
|
The product team will evaluate your request.
|
|
60
57
|
In the issue, specify the current status of the configuration:
|
|
61
58
|
|
|
62
|
-
-
|
|
63
|
-
-
|
|
59
|
+
- The configuration works but needs official support.
|
|
60
|
+
- The configuration does not work and requires changes.
|
|
64
61
|
|
|
65
62
|
### Supported Runtimes
|
|
66
63
|
|
|
67
|
-
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
-
|
|
64
|
+
- Fluid Framework supports Node.js versions 22 and 24 while they receive [upstream support](https://nodejs.org/en/about/previous-releases).
|
|
65
|
+
- Fluid Framework will stop support for version 22 [when upstream support ends on 2027-04-30](https://github.com/nodejs/release#release-schedule).
|
|
66
|
+
- Fluid Framework does not support Node.js with the `--no-experimental-fetch` flag.
|
|
67
|
+
- Fluid Framework supports modern browsers that support the ES2022 standard library.
|
|
71
68
|
|
|
72
69
|
### Supported Tools
|
|
73
70
|
|
|
74
|
-
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
-
|
|
83
|
-
|
|
84
|
-
|
|
71
|
+
- [TypeScript 6.0](https://typescriptdocs.com/release-notes/TypeScript%206.0):
|
|
72
|
+
- Fluid Framework supports all [`strict`](https://www.typescriptlang.org/tsconfig) options.
|
|
73
|
+
- Set the build targets (`lib`, `target`) to `ES2022` or later.
|
|
74
|
+
- Enable [`strictNullChecks`](https://www.typescriptlang.org/tsconfig).
|
|
75
|
+
- 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).
|
|
76
|
+
- Fluid Framework does not fully support `exactOptionalPropertyTypes`.
|
|
77
|
+
If you enable this option, do not use `in`, `Reflect.has`, `Object.hasOwn`, or `Object.prototype.hasOwnProperty` to narrow members of Fluid Framework types.
|
|
78
|
+
These methods can incorrectly exclude `undefined` from the possible values.
|
|
79
|
+
- [webpack](https://webpack.js.org/) 5
|
|
80
|
+
- We do not require a specific bundler.
|
|
81
|
+
Other bundlers that handle ES Modules can work, but we actively test only webpack.
|
|
85
82
|
|
|
86
83
|
### Module Resolution
|
|
87
84
|
|
|
@@ -92,25 +89,25 @@ Do not use `Node10` module resolution.
|
|
|
92
89
|
|
|
93
90
|
### Module Formats
|
|
94
91
|
|
|
95
|
-
-
|
|
96
|
-
|
|
97
|
-
-
|
|
98
|
-
|
|
92
|
+
- ES Modules:
|
|
93
|
+
Use ES Modules to consume Fluid Framework client packages, including in Node.js.
|
|
94
|
+
- CommonJS:
|
|
95
|
+
Fluid Framework does not officially support CommonJS in version 3.0 or later.
|
|
99
96
|
|
|
100
97
|
## Contribution Guidelines
|
|
101
98
|
|
|
102
99
|
You can [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid Framework in these ways:
|
|
103
100
|
|
|
104
|
-
-
|
|
105
|
-
-
|
|
106
|
-
-
|
|
107
|
-
-
|
|
101
|
+
- Answer questions in [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
|
|
102
|
+
- [Submit bug reports](https://github.com/microsoft/FluidFramework/issues) and help verify fixes.
|
|
103
|
+
- Review [source code changes](https://github.com/microsoft/FluidFramework/pulls).
|
|
104
|
+
- [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
|
|
108
105
|
|
|
109
106
|
For detailed instructions, read the [repo documentation](https://github.com/microsoft/FluidFramework/blob/main/docs/content/Home.md).
|
|
110
107
|
|
|
111
108
|
This project follows the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
|
112
109
|
For more information, read the [Code of Conduct frequently asked questions](https://opensource.microsoft.com/codeofconduct/faq/).
|
|
113
|
-
For questions or comments, contact
|
|
110
|
+
For questions or comments, contact <opencode@microsoft.com>.
|
|
114
111
|
|
|
115
112
|
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
|
|
116
113
|
Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
|
|
@@ -131,5 +128,4 @@ Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guid
|
|
|
131
128
|
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
|
|
132
129
|
|
|
133
130
|
<!-- prettier-ignore-end -->
|
|
134
|
-
|
|
135
|
-
<!-- AUTO-GENERATED-CONTENT:END -->
|
|
131
|
+
<!-- markdown-magic:end -->
|
package/dist/packageVersion.d.ts
CHANGED
|
@@ -5,5 +5,5 @@
|
|
|
5
5
|
* THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
|
|
6
6
|
*/
|
|
7
7
|
export declare const pkgName = "@fluidframework/shared-summary-block";
|
|
8
|
-
export declare const pkgVersion = "3.0
|
|
8
|
+
export declare const pkgVersion = "3.1.0";
|
|
9
9
|
//# sourceMappingURL=packageVersion.d.ts.map
|
package/dist/packageVersion.js
CHANGED
|
@@ -8,5 +8,5 @@
|
|
|
8
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
9
|
exports.pkgVersion = exports.pkgName = void 0;
|
|
10
10
|
exports.pkgName = "@fluidframework/shared-summary-block";
|
|
11
|
-
exports.pkgVersion = "3.0
|
|
11
|
+
exports.pkgVersion = "3.1.0";
|
|
12
12
|
//# sourceMappingURL=packageVersion.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,sCAAsC,CAAC;AACjD,QAAA,UAAU,GAAG,OAAO,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/shared-summary-block\";\nexport const pkgVersion = \"3.0
|
|
1
|
+
{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,sCAAsC,CAAC;AACjD,QAAA,UAAU,GAAG,OAAO,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/shared-summary-block\";\nexport const pkgVersion = \"3.1.0\";\n"]}
|
package/lib/packageVersion.d.ts
CHANGED
|
@@ -5,5 +5,5 @@
|
|
|
5
5
|
* THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
|
|
6
6
|
*/
|
|
7
7
|
export declare const pkgName = "@fluidframework/shared-summary-block";
|
|
8
|
-
export declare const pkgVersion = "3.0
|
|
8
|
+
export declare const pkgVersion = "3.1.0";
|
|
9
9
|
//# sourceMappingURL=packageVersion.d.ts.map
|
package/lib/packageVersion.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,sCAAsC,CAAC;AAC9D,MAAM,CAAC,MAAM,UAAU,GAAG,OAAO,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/shared-summary-block\";\nexport const pkgVersion = \"3.0
|
|
1
|
+
{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,sCAAsC,CAAC;AAC9D,MAAM,CAAC,MAAM,UAAU,GAAG,OAAO,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/shared-summary-block\";\nexport const pkgVersion = \"3.1.0\";\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/shared-summary-block",
|
|
3
|
-
"version": "3.0
|
|
3
|
+
"version": "3.1.0",
|
|
4
4
|
"description": "A DDS that does not generate ops but is part of summary",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -55,24 +55,24 @@
|
|
|
55
55
|
"temp-directory": "nyc/.nyc_output"
|
|
56
56
|
},
|
|
57
57
|
"dependencies": {
|
|
58
|
-
"@fluidframework/core-interfaces": "~3.0
|
|
59
|
-
"@fluidframework/datastore-definitions": "~3.0
|
|
60
|
-
"@fluidframework/driver-definitions": "~3.0
|
|
61
|
-
"@fluidframework/driver-utils": "~3.0
|
|
62
|
-
"@fluidframework/runtime-definitions": "~3.0
|
|
63
|
-
"@fluidframework/shared-object-base": "~3.0
|
|
58
|
+
"@fluidframework/core-interfaces": "~3.1.0",
|
|
59
|
+
"@fluidframework/datastore-definitions": "~3.1.0",
|
|
60
|
+
"@fluidframework/driver-definitions": "~3.1.0",
|
|
61
|
+
"@fluidframework/driver-utils": "~3.1.0",
|
|
62
|
+
"@fluidframework/runtime-definitions": "~3.1.0",
|
|
63
|
+
"@fluidframework/shared-object-base": "~3.1.0"
|
|
64
64
|
},
|
|
65
65
|
"devDependencies": {
|
|
66
66
|
"@arethetypeswrong/cli": "^0.18.5",
|
|
67
67
|
"@biomejs/biome": "~2.4.5",
|
|
68
|
-
"@fluid-internal/mocha-test-setup": "~3.0
|
|
68
|
+
"@fluid-internal/mocha-test-setup": "~3.1.0",
|
|
69
69
|
"@fluid-tools/build-cli": "^0.67.0",
|
|
70
70
|
"@fluidframework/build-common": "^2.0.3",
|
|
71
71
|
"@fluidframework/build-tools": "^0.67.0",
|
|
72
|
-
"@fluidframework/container-definitions": "~3.0
|
|
72
|
+
"@fluidframework/container-definitions": "~3.1.0",
|
|
73
73
|
"@fluidframework/eslint-config-fluid": "^14.0.0",
|
|
74
74
|
"@fluidframework/shared-summary-block-previous": "npm:@fluidframework/shared-summary-block@2.116.0",
|
|
75
|
-
"@fluidframework/test-runtime-utils": "~3.0
|
|
75
|
+
"@fluidframework/test-runtime-utils": "~3.1.0",
|
|
76
76
|
"@microsoft/api-extractor": "7.58.1",
|
|
77
77
|
"@types/mocha": "^10.0.10",
|
|
78
78
|
"@types/node": "~22.19.17",
|
package/src/packageVersion.ts
CHANGED