@fluidframework/runtime-utils 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/compatibilityBase.d.ts +1 -1
- package/dist/packageVersion.d.ts +1 -1
- package/dist/packageVersion.js +1 -1
- package/dist/packageVersion.js.map +1 -1
- package/lib/compatibilityBase.d.ts +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 +12 -12
- package/src/packageVersion.ts +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -2,8 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
This package contains code for common utilities used by Fluid Framework runtimes.
|
|
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,11 +36,9 @@ Import the `legacy` APIs from `@fluidframework/runtime-utils/legacy`.
|
|
|
37
36
|
Read the **@fluidframework/runtime-utils** API documentation at <https://fluidframework.com/docs/apis/runtime-utils>.
|
|
38
37
|
|
|
39
38
|
<!-- prettier-ignore-end -->
|
|
39
|
+
<!-- markdown-magic:end -->
|
|
40
40
|
|
|
41
|
-
<!--
|
|
42
|
-
|
|
43
|
-
<!-- AUTO-GENERATED-CONTENT:START (README_FOOTER) -->
|
|
44
|
-
|
|
41
|
+
<!-- markdown-magic:begin {"transform":"readme-footer","headingLevel":2} -->
|
|
45
42
|
<!-- prettier-ignore-start -->
|
|
46
43
|
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
|
|
47
44
|
|
|
@@ -58,29 +55,29 @@ To request support for a configuration that is not listed, file an issue.
|
|
|
58
55
|
The product team will evaluate your request.
|
|
59
56
|
In the issue, specify the current status of the configuration:
|
|
60
57
|
|
|
61
|
-
-
|
|
62
|
-
-
|
|
58
|
+
- The configuration works but needs official support.
|
|
59
|
+
- The configuration does not work and requires changes.
|
|
63
60
|
|
|
64
61
|
### Supported Runtimes
|
|
65
62
|
|
|
66
|
-
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
-
|
|
63
|
+
- Fluid Framework supports Node.js versions 22 and 24 while they receive [upstream support](https://nodejs.org/en/about/previous-releases).
|
|
64
|
+
- Fluid Framework will stop support for version 22 [when upstream support ends on 2027-04-30](https://github.com/nodejs/release#release-schedule).
|
|
65
|
+
- Fluid Framework does not support Node.js with the `--no-experimental-fetch` flag.
|
|
66
|
+
- Fluid Framework supports modern browsers that support the ES2022 standard library.
|
|
70
67
|
|
|
71
68
|
### Supported Tools
|
|
72
69
|
|
|
73
|
-
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
-
|
|
82
|
-
|
|
83
|
-
|
|
70
|
+
- [TypeScript 6.0](https://typescriptdocs.com/release-notes/TypeScript%206.0):
|
|
71
|
+
- Fluid Framework supports all [`strict`](https://www.typescriptlang.org/tsconfig) options.
|
|
72
|
+
- Set the build targets (`lib`, `target`) to `ES2022` or later.
|
|
73
|
+
- Enable [`strictNullChecks`](https://www.typescriptlang.org/tsconfig).
|
|
74
|
+
- 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).
|
|
75
|
+
- Fluid Framework does not fully support `exactOptionalPropertyTypes`.
|
|
76
|
+
If you enable this option, do not use `in`, `Reflect.has`, `Object.hasOwn`, or `Object.prototype.hasOwnProperty` to narrow members of Fluid Framework types.
|
|
77
|
+
These methods can incorrectly exclude `undefined` from the possible values.
|
|
78
|
+
- [webpack](https://webpack.js.org/) 5
|
|
79
|
+
- We do not require a specific bundler.
|
|
80
|
+
Other bundlers that handle ES Modules can work, but we actively test only webpack.
|
|
84
81
|
|
|
85
82
|
### Module Resolution
|
|
86
83
|
|
|
@@ -91,25 +88,25 @@ Do not use `Node10` module resolution.
|
|
|
91
88
|
|
|
92
89
|
### Module Formats
|
|
93
90
|
|
|
94
|
-
-
|
|
95
|
-
|
|
96
|
-
-
|
|
97
|
-
|
|
91
|
+
- ES Modules:
|
|
92
|
+
Use ES Modules to consume Fluid Framework client packages, including in Node.js.
|
|
93
|
+
- CommonJS:
|
|
94
|
+
Fluid Framework does not officially support CommonJS in version 3.0 or later.
|
|
98
95
|
|
|
99
96
|
## Contribution Guidelines
|
|
100
97
|
|
|
101
98
|
You can [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid Framework in these ways:
|
|
102
99
|
|
|
103
|
-
-
|
|
104
|
-
-
|
|
105
|
-
-
|
|
106
|
-
-
|
|
100
|
+
- Answer questions in [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
|
|
101
|
+
- [Submit bug reports](https://github.com/microsoft/FluidFramework/issues) and help verify fixes.
|
|
102
|
+
- Review [source code changes](https://github.com/microsoft/FluidFramework/pulls).
|
|
103
|
+
- [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
|
|
107
104
|
|
|
108
105
|
For detailed instructions, read the [repo documentation](https://github.com/microsoft/FluidFramework/blob/main/docs/content/Home.md).
|
|
109
106
|
|
|
110
107
|
This project follows the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
|
111
108
|
For more information, read the [Code of Conduct frequently asked questions](https://opensource.microsoft.com/codeofconduct/faq/).
|
|
112
|
-
For questions or comments, contact
|
|
109
|
+
For questions or comments, contact <opencode@microsoft.com>.
|
|
113
110
|
|
|
114
111
|
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
|
|
115
112
|
Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
|
|
@@ -130,5 +127,4 @@ Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guid
|
|
|
130
127
|
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
|
|
131
128
|
|
|
132
129
|
<!-- prettier-ignore-end -->
|
|
133
|
-
|
|
134
|
-
<!-- AUTO-GENERATED-CONTENT:END -->
|
|
130
|
+
<!-- markdown-magic:end -->
|
|
@@ -143,7 +143,7 @@ export declare function isValidMinVersionForCollab(minVersionForCollab: Semantic
|
|
|
143
143
|
*
|
|
144
144
|
* @internal
|
|
145
145
|
*/
|
|
146
|
-
export declare const cleanedPackageVersion: "3.
|
|
146
|
+
export declare const cleanedPackageVersion: "3.1.0";
|
|
147
147
|
/**
|
|
148
148
|
* Narrows the type of the provided {@link SemanticVersion} to a {@link @fluidframework/runtime-definitions#OldestSupportedClientVersion}, throwing a UsageError if it is not valid.
|
|
149
149
|
* @remarks
|
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/runtime-utils";
|
|
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/runtime-utils";
|
|
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,+BAA+B,CAAC;AAC1C,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/runtime-utils\";\nexport const pkgVersion = \"3.0
|
|
1
|
+
{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,+BAA+B,CAAC;AAC1C,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/runtime-utils\";\nexport const pkgVersion = \"3.1.0\";\n"]}
|
|
@@ -143,7 +143,7 @@ export declare function isValidMinVersionForCollab(minVersionForCollab: Semantic
|
|
|
143
143
|
*
|
|
144
144
|
* @internal
|
|
145
145
|
*/
|
|
146
|
-
export declare const cleanedPackageVersion: "3.
|
|
146
|
+
export declare const cleanedPackageVersion: "3.1.0";
|
|
147
147
|
/**
|
|
148
148
|
* Narrows the type of the provided {@link SemanticVersion} to a {@link @fluidframework/runtime-definitions#OldestSupportedClientVersion}, throwing a UsageError if it is not valid.
|
|
149
149
|
* @remarks
|
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/runtime-utils";
|
|
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,+BAA+B,CAAC;AACvD,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/runtime-utils\";\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,+BAA+B,CAAC;AACvD,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/runtime-utils\";\nexport const pkgVersion = \"3.1.0\";\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/runtime-utils",
|
|
3
|
-
"version": "3.0
|
|
3
|
+
"version": "3.1.0",
|
|
4
4
|
"description": "Collection of utility functions for Fluid Runtime",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -62,22 +62,22 @@
|
|
|
62
62
|
"temp-directory": "nyc/.nyc_output"
|
|
63
63
|
},
|
|
64
64
|
"dependencies": {
|
|
65
|
-
"@fluid-internal/client-utils": "~3.0
|
|
66
|
-
"@fluidframework/container-definitions": "~3.0
|
|
67
|
-
"@fluidframework/container-runtime-definitions": "~3.0
|
|
68
|
-
"@fluidframework/core-interfaces": "~3.0
|
|
69
|
-
"@fluidframework/core-utils": "~3.0
|
|
70
|
-
"@fluidframework/datastore-definitions": "~3.0
|
|
71
|
-
"@fluidframework/driver-definitions": "~3.0
|
|
72
|
-
"@fluidframework/driver-utils": "~3.0
|
|
73
|
-
"@fluidframework/runtime-definitions": "~3.0
|
|
74
|
-
"@fluidframework/telemetry-utils": "~3.0
|
|
65
|
+
"@fluid-internal/client-utils": "~3.1.0",
|
|
66
|
+
"@fluidframework/container-definitions": "~3.1.0",
|
|
67
|
+
"@fluidframework/container-runtime-definitions": "~3.1.0",
|
|
68
|
+
"@fluidframework/core-interfaces": "~3.1.0",
|
|
69
|
+
"@fluidframework/core-utils": "~3.1.0",
|
|
70
|
+
"@fluidframework/datastore-definitions": "~3.1.0",
|
|
71
|
+
"@fluidframework/driver-definitions": "~3.1.0",
|
|
72
|
+
"@fluidframework/driver-utils": "~3.1.0",
|
|
73
|
+
"@fluidframework/runtime-definitions": "~3.1.0",
|
|
74
|
+
"@fluidframework/telemetry-utils": "~3.1.0",
|
|
75
75
|
"semver-ts": "^1.0.3"
|
|
76
76
|
},
|
|
77
77
|
"devDependencies": {
|
|
78
78
|
"@arethetypeswrong/cli": "^0.18.5",
|
|
79
79
|
"@biomejs/biome": "~2.4.5",
|
|
80
|
-
"@fluid-internal/mocha-test-setup": "~3.0
|
|
80
|
+
"@fluid-internal/mocha-test-setup": "~3.1.0",
|
|
81
81
|
"@fluid-tools/build-cli": "^0.67.0",
|
|
82
82
|
"@fluidframework/build-common": "^2.0.3",
|
|
83
83
|
"@fluidframework/build-tools": "^0.67.0",
|
package/src/packageVersion.ts
CHANGED