@fluid-internal/client-utils 2.23.0 → 2.31.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 +29 -21
- package/lib/tsdoc-metadata.json +1 -1
- package/package.json +8 -11
- package/prettier.config.cjs +0 -8
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# @fluid-internal/client-utils
|
|
2
2
|
|
|
3
|
+
## 2.31.0
|
|
4
|
+
|
|
5
|
+
Dependency updates only.
|
|
6
|
+
|
|
7
|
+
## 2.30.0
|
|
8
|
+
|
|
9
|
+
Dependency updates only.
|
|
10
|
+
|
|
3
11
|
## 2.23.0
|
|
4
12
|
|
|
5
13
|
Dependency updates only.
|
|
@@ -28,12 +36,12 @@ Dependency updates only.
|
|
|
28
36
|
|
|
29
37
|
### Minor Changes
|
|
30
38
|
|
|
31
|
-
-
|
|
39
|
+
- The events library has been moved from the tree package ([#23141](https://github.com/microsoft/FluidFramework/pull/23141)) [cae07b5c8c](https://github.com/microsoft/FluidFramework/commit/cae07b5c8c7904184b5fbf8c677f302da19cc697)
|
|
32
40
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
41
|
+
In previous releases, the `@fluidframework/tree` package contained an internal events library. The events-related types and interfaces have been moved to
|
|
42
|
+
`@fluidframework/core-interfaces`, while the implementation has been relocated to `@fluid-internal/client-utils`. There are
|
|
43
|
+
no changes to how the events library is used; the relocation simply organizes the library into more appropriate
|
|
44
|
+
packages. This change should have no impact on developers using the Fluid Framework.
|
|
37
45
|
|
|
38
46
|
## 2.10.0
|
|
39
47
|
|
|
@@ -71,24 +79,24 @@ Dependency updates only.
|
|
|
71
79
|
|
|
72
80
|
### Major Changes
|
|
73
81
|
|
|
74
|
-
-
|
|
82
|
+
- Packages now use package.json "exports" and require modern module resolution [97d68aa06b](https://github.com/microsoft/FluidFramework/commit/97d68aa06bd5c022ecb026655814aea222a062ae)
|
|
75
83
|
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
84
|
+
Fluid Framework packages have been updated to use the [package.json "exports"
|
|
85
|
+
field](https://nodejs.org/docs/latest-v18.x/api/packages.html#exports) to define explicit entry points for both
|
|
86
|
+
TypeScript types and implementation code.
|
|
79
87
|
|
|
80
|
-
|
|
88
|
+
This means that using Fluid Framework packages require the following TypeScript settings in tsconfig.json:
|
|
81
89
|
|
|
82
|
-
|
|
83
|
-
|
|
90
|
+
- `"moduleResolution": "Node16"` with `"module": "Node16"`
|
|
91
|
+
- `"moduleResolution": "Bundler"` with `"module": "ESNext"`
|
|
84
92
|
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
93
|
+
We recommend using Node16/Node16 unless absolutely necessary. That will produce transpiled JavaScript that is suitable
|
|
94
|
+
for use with modern versions of Node.js _and_ Bundlers.
|
|
95
|
+
[See the TypeScript documentation](https://www.typescriptlang.org/tsconfig#moduleResolution) for more information
|
|
96
|
+
regarding the module and moduleResolution options.
|
|
89
97
|
|
|
90
|
-
|
|
91
|
-
|
|
98
|
+
**Node10 moduleResolution is not supported; it does not support Fluid Framework's API structuring pattern that is used
|
|
99
|
+
to distinguish stable APIs from those that are in development.**
|
|
92
100
|
|
|
93
101
|
## 2.0.0-rc.2.0.0
|
|
94
102
|
|
|
@@ -122,11 +130,11 @@ Dependency updates only.
|
|
|
122
130
|
|
|
123
131
|
### Minor Changes
|
|
124
132
|
|
|
125
|
-
-
|
|
133
|
+
- client-utils: Internal buffer encoding helpers now require 'utf8', 'utf-8', or 'base64' [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
126
134
|
|
|
127
|
-
|
|
135
|
+
Previously, the buffer encoding helpers 'Uint8ArrayToString', 'bufferToString', and 'IsoBuffer.toString' would accept a string argument, which was overly permissive.
|
|
128
136
|
|
|
129
|
-
|
|
137
|
+
The type of the 'encoding' argument has been narrow to just the supported values 'utf8', 'utf-8', or 'base64'.
|
|
130
138
|
|
|
131
139
|
## 2.0.0-internal.6.4.0
|
|
132
140
|
|
package/lib/tsdoc-metadata.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluid-internal/client-utils",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.31.0",
|
|
4
4
|
"description": "Not intended for use outside the Fluid Framework.",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -69,8 +69,8 @@
|
|
|
69
69
|
"temp-directory": "nyc/.nyc_output"
|
|
70
70
|
},
|
|
71
71
|
"dependencies": {
|
|
72
|
-
"@fluidframework/core-interfaces": "~2.
|
|
73
|
-
"@fluidframework/core-utils": "~2.
|
|
72
|
+
"@fluidframework/core-interfaces": "~2.31.0",
|
|
73
|
+
"@fluidframework/core-utils": "~2.31.0",
|
|
74
74
|
"@types/events_pkg": "npm:@types/events@^3.0.0",
|
|
75
75
|
"base64-js": "^1.5.1",
|
|
76
76
|
"buffer": "^6.0.3",
|
|
@@ -80,16 +80,16 @@
|
|
|
80
80
|
"devDependencies": {
|
|
81
81
|
"@arethetypeswrong/cli": "^0.17.1",
|
|
82
82
|
"@biomejs/biome": "~1.9.3",
|
|
83
|
-
"@fluid-internal/client-utils-previous": "npm:@fluid-internal/client-utils@2.
|
|
84
|
-
"@fluid-internal/mocha-test-setup": "~2.
|
|
83
|
+
"@fluid-internal/client-utils-previous": "npm:@fluid-internal/client-utils@2.30.0",
|
|
84
|
+
"@fluid-internal/mocha-test-setup": "~2.31.0",
|
|
85
85
|
"@fluid-tools/build-cli": "^0.54.0",
|
|
86
86
|
"@fluidframework/build-common": "^2.0.3",
|
|
87
87
|
"@fluidframework/build-tools": "^0.54.0",
|
|
88
88
|
"@fluidframework/eslint-config-fluid": "^5.7.3",
|
|
89
|
-
"@microsoft/api-extractor": "7.
|
|
89
|
+
"@microsoft/api-extractor": "7.50.1",
|
|
90
90
|
"@types/base64-js": "^1.3.0",
|
|
91
91
|
"@types/jest": "29.5.3",
|
|
92
|
-
"@types/jest-environment-puppeteer": "~2.
|
|
92
|
+
"@types/jest-environment-puppeteer": "~2.31.0",
|
|
93
93
|
"@types/mocha": "^10.0.10",
|
|
94
94
|
"@types/node": "^18.19.0",
|
|
95
95
|
"@types/rewire": "^2.5.28",
|
|
@@ -105,10 +105,9 @@
|
|
|
105
105
|
"jest-environment-puppeteer": "^10.1.3",
|
|
106
106
|
"jest-junit": "^16.0.0",
|
|
107
107
|
"jest-puppeteer": "^10.1.3",
|
|
108
|
-
"mocha": "^10.2
|
|
108
|
+
"mocha": "^10.8.2",
|
|
109
109
|
"mocha-multi-reporters": "^1.5.1",
|
|
110
110
|
"moment": "^2.21.0",
|
|
111
|
-
"prettier": "~3.0.3",
|
|
112
111
|
"puppeteer": "^23.6.0",
|
|
113
112
|
"rewire": "^5.0.0",
|
|
114
113
|
"rimraf": "^4.4.0",
|
|
@@ -222,7 +221,6 @@
|
|
|
222
221
|
"check:exports:esm:indexNode": "api-extractor run --config api-extractor/api-extractor-lint-indexNode.esm.json",
|
|
223
222
|
"check:exports:esm:indexNode:legacy": "api-extractor run --config api-extractor/api-extractor-lint-indexNode.legacy.esm.json",
|
|
224
223
|
"check:format": "npm run check:biome",
|
|
225
|
-
"check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
|
|
226
224
|
"ci:build:api-reports": "concurrently \"npm:ci:build:api-reports:*\"",
|
|
227
225
|
"ci:build:api-reports:browser:current": "api-extractor run --config api-extractor/api-extractor-report-browser.json",
|
|
228
226
|
"ci:build:api-reports:browser:legacy": "api-extractor run --config api-extractor/api-extractor-report-browser.legacy.json",
|
|
@@ -234,7 +232,6 @@
|
|
|
234
232
|
"eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
|
|
235
233
|
"format": "npm run format:biome",
|
|
236
234
|
"format:biome": "biome check . --write",
|
|
237
|
-
"format:prettier": "prettier --write . --cache --ignore-path ../../../.prettierignore",
|
|
238
235
|
"lint": "fluid-build . --task lint",
|
|
239
236
|
"lint:fix": "fluid-build . --task eslint:fix --task format",
|
|
240
237
|
"test": "npm run test:mocha && npm run test:jest",
|