@fluidframework/odsp-urlresolver 2.117.0 → 3.0.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 +36 -2
- package/README.md +49 -46
- package/{api-extractor.json → api-extractor/api-extractor-model.json} +1 -1
- package/api-extractor/api-extractor-report.json +5 -0
- package/lib/public.d.ts +1 -1
- package/package.json +24 -32
- package/tsconfig.json +1 -1
- package/internal.d.ts +0 -11
package/CHANGELOG.md
CHANGED
|
@@ -1,8 +1,42 @@
|
|
|
1
1
|
# @fluidframework/odsp-urlresolver
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## 3.0.0
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- Removal of direct CommonJS support ([#28124](https://github.com/microsoft/FluidFramework/pull/28124)) [0f84e3b8878](https://github.com/microsoft/FluidFramework/commit/0f84e3b8878a5e75b2253976d98fd963bbd9db88)
|
|
8
|
+
|
|
9
|
+
Direct `require()` import is no longer directly supported.
|
|
10
|
+
Package is transpiled as ECMAScript Module.
|
|
11
|
+
|
|
12
|
+
See [Removal of direct CommonJS support in v3.0](https://github.com/microsoft/FluidFramework/issues/27444) for more information.
|
|
13
|
+
|
|
14
|
+
- Require modern TypeScript module resolution ([#27970](https://github.com/microsoft/FluidFramework/pull/27970)) [325e2016ca9](https://github.com/microsoft/FluidFramework/commit/325e2016ca9978d4a1f7552c97ba34feac9df41f)
|
|
15
|
+
|
|
16
|
+
Fluid Framework Client packages no longer include type declaration compatibility entrypoints for TypeScript's legacy Node10 resolution mode (`"moduleResolution": "node"` or `"node10"`).
|
|
17
|
+
Applications upgrading to Fluid Framework 3.0 must use one of the following supported configurations:
|
|
18
|
+
- `"module": "Node16"` with `"moduleResolution": "Node16"`
|
|
19
|
+
- `"module": "NodeNext"` with `"moduleResolution": "NodeNext"`
|
|
20
|
+
- `"module": "ESNext"` with `"moduleResolution": "Bundler"`
|
|
21
|
+
|
|
22
|
+
Existing public package entrypoints exposed through `package.json` exports, including `/alpha`, `/beta`, and `/legacy`, remain available under supported module resolution modes.
|
|
23
|
+
|
|
24
|
+
See [Removal of Node10 resolutions in v3.0](https://github.com/microsoft/FluidFramework/issues/27457) for more information.
|
|
25
|
+
|
|
26
|
+
- Client packages now target ES2022 ([#27846](https://github.com/microsoft/FluidFramework/pull/27846)) [91c78541bdd](https://github.com/microsoft/FluidFramework/commit/91c78541bddcbca5d6c5f357b023eeaee617d885)
|
|
27
|
+
|
|
28
|
+
The TypeScript compilation `target` and `lib` for the Fluid Framework client packages have been raised from ES2021/ES2020 to **ES2022**.
|
|
29
|
+
The published JavaScript now uses ES2022 language features (with correspondingly less down-leveling), so consuming these packages requires a runtime that supports ES2022.
|
|
30
|
+
All actively supported Node.js versions and evergreen browsers already meet this requirement.
|
|
31
|
+
|
|
32
|
+
Note that Fluid Framework has not officially supported targets older than ES2022 since before 2.0: this is documented in [ClientRequirements.md](https://github.com/microsoft/FluidFramework/blob/main/ClientRequirements.md) as well as the README for every client package.
|
|
33
|
+
|
|
34
|
+
It is possible this change could impact users of less up to date JavaScript runtimes.
|
|
35
|
+
Impacted users can use a tool like [babel](https://babeljs.io/) to transpile out unsupported language features.
|
|
36
|
+
|
|
37
|
+
- Build with TypeScript 6 ([#28052](https://github.com/microsoft/FluidFramework/pull/28052)) [7ab015c49de](https://github.com/microsoft/FluidFramework/commit/7ab015c49deec84833cdfe1fb5e1606b901f6e81)
|
|
38
|
+
|
|
39
|
+
FluidFramework Client SDK is now built using TypeScript 6. Consumers should build with TypeScript v6 or v7 or compatible tooling.
|
|
6
40
|
|
|
7
41
|
## 2.116.0
|
|
8
42
|
|
package/README.md
CHANGED
|
@@ -9,15 +9,15 @@ This is an implementation of a url resolver which resolves onedrive and sharepoi
|
|
|
9
9
|
|
|
10
10
|
## Using Fluid Framework libraries
|
|
11
11
|
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
library consumers should always prefer `^`.
|
|
12
|
+
For a dependency on a Fluid Framework library's public APIs, we recommend a `^` (caret) version range.
|
|
13
|
+
For example, use `^1.3.4`.
|
|
15
14
|
|
|
16
|
-
|
|
15
|
+
For a dependency on an unstable API, such as a `beta` API, we recommend a more restrictive version range.
|
|
16
|
+
For example, use a `~` version range.
|
|
17
17
|
|
|
18
18
|
## Installation
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
Run this command to install the package:
|
|
21
21
|
|
|
22
22
|
```bash
|
|
23
23
|
npm i @fluidframework/odsp-urlresolver
|
|
@@ -25,7 +25,7 @@ npm i @fluidframework/odsp-urlresolver
|
|
|
25
25
|
|
|
26
26
|
## API Documentation
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
Read the **@fluidframework/odsp-urlresolver** API documentation at <https://fluidframework.com/docs/apis/odsp-urlresolver>.
|
|
29
29
|
|
|
30
30
|
<!-- prettier-ignore-end -->
|
|
31
31
|
|
|
@@ -38,62 +38,69 @@ API documentation for **@fluidframework/odsp-urlresolver** is available at <http
|
|
|
38
38
|
|
|
39
39
|
## Minimum Client Requirements
|
|
40
40
|
|
|
41
|
-
|
|
42
|
-
These requirements
|
|
43
|
-
|
|
41
|
+
Fluid Framework client libraries support the platforms in this document.
|
|
42
|
+
These requirements are intentionally restrictive.
|
|
43
|
+
Within a major version series, we can relax these requirements, but we cannot make them stricter.
|
|
44
|
+
For a Long Term Support (LTS) version, we might need to support these platforms for several years.
|
|
44
45
|
|
|
45
|
-
|
|
46
|
-
If
|
|
47
|
-
|
|
46
|
+
Other configurations can work, but Fluid Framework does not support them.
|
|
47
|
+
If an unsupported configuration stops working, we do not classify this as a bug.
|
|
48
|
+
To request support for a configuration that is not listed, file an issue.
|
|
49
|
+
The product team will evaluate your request.
|
|
50
|
+
In the issue, specify the current status of the configuration:
|
|
51
|
+
|
|
52
|
+
- The configuration works but needs official support.
|
|
53
|
+
- The configuration does not work and requires changes.
|
|
48
54
|
|
|
49
55
|
### Supported Runtimes
|
|
50
56
|
|
|
51
|
-
-
|
|
52
|
-
-
|
|
53
|
-
-
|
|
57
|
+
- Fluid Framework supports Node.js versions 22 and 24 while they receive [upstream support](https://nodejs.org/en/about/previous-releases).
|
|
58
|
+
- Fluid Framework will stop support for version 22 [when upstream support ends on 2027-04-30](https://github.com/nodejs/release#release-schedule).
|
|
59
|
+
- Fluid Framework does not support Node.js with the `--no-experimental-fetch` flag.
|
|
60
|
+
- Fluid Framework supports modern browsers that support the ES2022 standard library.
|
|
54
61
|
|
|
55
62
|
### Supported Tools
|
|
56
63
|
|
|
57
|
-
- TypeScript
|
|
58
|
-
-
|
|
59
|
-
-
|
|
60
|
-
- [
|
|
61
|
-
-
|
|
62
|
-
|
|
64
|
+
- [TypeScript 6.0](https://typescriptdocs.com/release-notes/TypeScript%206.0):
|
|
65
|
+
- Fluid Framework supports all [`strict`](https://www.typescriptlang.org/tsconfig) options.
|
|
66
|
+
- Set the build targets (`lib`, `target`) to `ES2022` or later.
|
|
67
|
+
- Enable [`strictNullChecks`](https://www.typescriptlang.org/tsconfig).
|
|
68
|
+
- 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).
|
|
69
|
+
- Fluid Framework does not fully support `exactOptionalPropertyTypes`.
|
|
70
|
+
If you enable this option, do not use `in`, `Reflect.has`, `Object.hasOwn`, or `Object.prototype.hasOwnProperty` to narrow members of Fluid Framework types.
|
|
71
|
+
These methods can incorrectly exclude `undefined` from the possible values.
|
|
63
72
|
- [webpack](https://webpack.js.org/) 5
|
|
64
|
-
- We
|
|
65
|
-
Other bundlers
|
|
73
|
+
- We do not require a specific bundler.
|
|
74
|
+
Other bundlers that handle ES Modules can work, but we actively test only webpack.
|
|
66
75
|
|
|
67
76
|
### Module Resolution
|
|
68
77
|
|
|
69
|
-
[`Node16`, `NodeNext`, or `Bundler`](https://www.typescriptlang.org/tsconfig#moduleResolution)
|
|
70
|
-
|
|
78
|
+
In TypeScript `compilerOptions`, use [`Node16`, `Node20`, `NodeNext`, or `Bundler`](https://www.typescriptlang.org/tsconfig#moduleResolution) module resolution.
|
|
79
|
+
These settings follow the [Node.js v12+ ESM Resolution and Loading algorithm](https://nodejs.github.io/nodejs.dev/en/api/v20/esm/#resolution-and-loading-algorithm).
|
|
80
|
+
|
|
81
|
+
Do not use `Node10` module resolution.
|
|
71
82
|
|
|
72
83
|
### Module Formats
|
|
73
84
|
|
|
74
85
|
- ES Modules:
|
|
75
|
-
ES Modules
|
|
76
|
-
-
|
|
77
|
-
|
|
78
|
-
This is done to accommodate some workflows without good ES Module support.
|
|
79
|
-
If you have a workflow you would like included in this list, file an issue.
|
|
80
|
-
Once this list of workflows motivating CommonJS support is empty, we may drop support for CommonJS one year after notice of the change is posted here.
|
|
81
|
-
|
|
82
|
-
- Testing with Jest (which lacks [stable ESM support](https://jestjs.io/docs/ecmascript-modules) due to [unstable APIs in NodeJs](https://github.com/nodejs/node/issues/37648))
|
|
86
|
+
Use ES Modules to consume Fluid Framework client packages, including in Node.js.
|
|
87
|
+
- CommonJS:
|
|
88
|
+
Fluid Framework does not officially support CommonJS in version 3.0 or later.
|
|
83
89
|
|
|
84
90
|
## Contribution Guidelines
|
|
85
91
|
|
|
86
|
-
|
|
92
|
+
You can [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid Framework in these ways:
|
|
87
93
|
|
|
88
|
-
-
|
|
89
|
-
- [Submit
|
|
90
|
-
- Review
|
|
94
|
+
- Answer questions in [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
|
|
95
|
+
- [Submit bug reports](https://github.com/microsoft/FluidFramework/issues) and help verify fixes.
|
|
96
|
+
- Review [source code changes](https://github.com/microsoft/FluidFramework/pulls).
|
|
91
97
|
- [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
|
|
92
98
|
|
|
93
|
-
|
|
99
|
+
For detailed instructions, read the [repo documentation](https://github.com/microsoft/FluidFramework/blob/main/docs/content/Home.md).
|
|
94
100
|
|
|
95
|
-
This project
|
|
96
|
-
For more information
|
|
101
|
+
This project follows the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
|
102
|
+
For more information, read the [Code of Conduct frequently asked questions](https://opensource.microsoft.com/codeofconduct/faq/).
|
|
103
|
+
For questions or comments, contact [opencode@microsoft.com](mailto:opencode@microsoft.com).
|
|
97
104
|
|
|
98
105
|
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
|
|
99
106
|
Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
|
|
@@ -101,13 +108,9 @@ Use of Microsoft trademarks or logos in modified versions of this project must n
|
|
|
101
108
|
|
|
102
109
|
## Help
|
|
103
110
|
|
|
104
|
-
|
|
105
|
-
Check out [fluidframework.com](https://fluidframework.com/docs/).
|
|
106
|
-
|
|
107
|
-
Still not finding what you're looking for?
|
|
108
|
-
Please [file an issue](https://github.com/microsoft/FluidFramework/blob/main/docs/content/Contributing/Submitting-Bugs-and-Feature-Requests.md).
|
|
111
|
+
Read the [Fluid Framework documentation](https://fluidframework.com/docs/) for information about Fluid Framework concepts and APIs.
|
|
109
112
|
|
|
110
|
-
|
|
113
|
+
To request information that the documentation does not contain, [create an issue](https://github.com/microsoft/FluidFramework/blob/main/docs/content/Contributing/Submitting-Bugs-and-Feature-Requests.md).
|
|
111
114
|
|
|
112
115
|
## Trademark
|
|
113
116
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
|
3
|
-
"extends": "
|
|
3
|
+
"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-model.esm.json"
|
|
4
4
|
}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
|
3
|
+
"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-report-base.esm.json",
|
|
4
|
+
"mainEntryPointFilePath": "<projectFolder>/lib/public.d.ts"
|
|
5
|
+
}
|
package/lib/public.d.ts
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
/*
|
|
7
7
|
* THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
|
|
8
|
-
* Generated by "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib
|
|
8
|
+
* Generated by "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib" in @fluid-tools/build-cli.
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
export {}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/odsp-urlresolver",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "3.0.0",
|
|
4
4
|
"description": "Url Resolver for odsp urls.",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -14,40 +14,29 @@
|
|
|
14
14
|
"type": "module",
|
|
15
15
|
"exports": {
|
|
16
16
|
".": {
|
|
17
|
-
"
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
"require": {
|
|
22
|
-
"types": "./dist/public.d.ts",
|
|
23
|
-
"default": "./dist/index.js"
|
|
17
|
+
"types": "./lib/public.d.ts",
|
|
18
|
+
"default": "./lib/index.js",
|
|
19
|
+
"internal-entrypoint-generation": {
|
|
20
|
+
"types": "./dist/public.d.ts"
|
|
24
21
|
}
|
|
25
22
|
},
|
|
26
23
|
"./internal": {
|
|
27
|
-
"
|
|
28
|
-
|
|
29
|
-
"default": "./lib/index.js"
|
|
30
|
-
},
|
|
31
|
-
"require": {
|
|
32
|
-
"types": "./dist/index.d.ts",
|
|
33
|
-
"default": "./dist/index.js"
|
|
34
|
-
}
|
|
24
|
+
"types": "./lib/index.d.ts",
|
|
25
|
+
"default": "./lib/index.js"
|
|
35
26
|
}
|
|
36
27
|
},
|
|
37
|
-
"main": "lib/index.js",
|
|
38
|
-
"types": "lib/public.d.ts",
|
|
39
28
|
"dependencies": {
|
|
40
|
-
"@fluid-internal/client-utils": "~
|
|
41
|
-
"@fluidframework/core-interfaces": "~
|
|
42
|
-
"@fluidframework/core-utils": "~
|
|
43
|
-
"@fluidframework/driver-definitions": "~
|
|
44
|
-
"@fluidframework/odsp-driver": "~
|
|
45
|
-
"@fluidframework/odsp-driver-definitions": "~
|
|
29
|
+
"@fluid-internal/client-utils": "~3.0.0",
|
|
30
|
+
"@fluidframework/core-interfaces": "~3.0.0",
|
|
31
|
+
"@fluidframework/core-utils": "~3.0.0",
|
|
32
|
+
"@fluidframework/driver-definitions": "~3.0.0",
|
|
33
|
+
"@fluidframework/odsp-driver": "~3.0.0",
|
|
34
|
+
"@fluidframework/odsp-driver-definitions": "~3.0.0"
|
|
46
35
|
},
|
|
47
36
|
"devDependencies": {
|
|
48
37
|
"@arethetypeswrong/cli": "^0.18.5",
|
|
49
38
|
"@biomejs/biome": "~2.4.5",
|
|
50
|
-
"@fluid-internal/mocha-test-setup": "~
|
|
39
|
+
"@fluid-internal/mocha-test-setup": "~3.0.0",
|
|
51
40
|
"@fluid-tools/build-cli": "^0.67.0",
|
|
52
41
|
"@fluidframework/build-common": "^2.0.3",
|
|
53
42
|
"@fluidframework/build-tools": "^0.67.0",
|
|
@@ -64,7 +53,7 @@
|
|
|
64
53
|
"mocha": "^11.7.5",
|
|
65
54
|
"mocha-multi-reporters": "^1.5.1",
|
|
66
55
|
"rimraf": "^6.1.3",
|
|
67
|
-
"typescript": "~
|
|
56
|
+
"typescript": "~6.0.3"
|
|
68
57
|
},
|
|
69
58
|
"typeValidation": {
|
|
70
59
|
"broken": {},
|
|
@@ -72,24 +61,28 @@
|
|
|
72
61
|
},
|
|
73
62
|
"scripts": {
|
|
74
63
|
"build": "fluid-build . --task build",
|
|
64
|
+
"build:api-reports": "api-extractor run --local --config api-extractor/api-extractor-report.json",
|
|
65
|
+
"build:cjs": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
|
|
75
66
|
"build:commonjs": "fluid-build . --task commonjs",
|
|
76
67
|
"build:compile": "fluid-build . --task compile",
|
|
77
|
-
"build:docs": "api-extractor run --local",
|
|
68
|
+
"build:docs": "api-extractor run --local --config api-extractor/api-extractor-model.json",
|
|
78
69
|
"build:entrypoints": "fluid-build . --task build:entrypoints",
|
|
79
70
|
"build:entrypoints:cjs": "flub generate entrypoints --resolutionConditions require --outFileLegacyBeta legacy --outDir ./dist",
|
|
80
|
-
"build:entrypoints:esm": "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib
|
|
81
|
-
"build:
|
|
71
|
+
"build:entrypoints:esm": "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib",
|
|
72
|
+
"build:esm": "tsc --project ./tsconfig.json",
|
|
82
73
|
"build:test": "concurrently npm:build:test:esm npm:build:test:cjs",
|
|
83
74
|
"build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
|
|
84
75
|
"build:test:esm": "tsc --project ./src/test/tsconfig.json",
|
|
85
|
-
"check:are-the-types-wrong": "attw --pack .",
|
|
76
|
+
"check:are-the-types-wrong": "attw --pack . --profile esm-only",
|
|
86
77
|
"check:biome": "biome check .",
|
|
87
78
|
"check:exports": "concurrently \"npm:check:exports:*\"",
|
|
88
79
|
"check:exports:bundle-release-tags": "api-extractor run --config api-extractor/api-extractor-lint-bundle.json",
|
|
89
80
|
"check:exports:cjs:public": "api-extractor run --config api-extractor/api-extractor-lint-public.cjs.json",
|
|
90
81
|
"check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
|
|
91
82
|
"check:format": "npm run check:biome",
|
|
92
|
-
"
|
|
83
|
+
"check:types:inexactOptionalPropertyTypes": "tsc --project ./tsconfig.json --noEmit --exactOptionalPropertyTypes false --skipLibCheck --emitDeclarationOnly false --tsBuildInfoFile ./tsconfig.inexactOptionalPropertyTypes.tsbuildinfo",
|
|
84
|
+
"ci:build:api-reports": "api-extractor run --config api-extractor/api-extractor-report.json",
|
|
85
|
+
"ci:build:docs": "api-extractor run --config api-extractor/api-extractor-model.json",
|
|
93
86
|
"clean": "rimraf --glob dist lib {alpha,beta,internal,legacy}.d.ts \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
|
|
94
87
|
"eslint": "eslint --quiet --format stylish src",
|
|
95
88
|
"eslint:fix": "eslint --quiet --format stylish src --fix --fix-type problem,suggestion,layout",
|
|
@@ -102,7 +95,6 @@
|
|
|
102
95
|
"test:mocha:cjs": "cross-env FLUID_TEST_MODULE_SYSTEM=CJS mocha",
|
|
103
96
|
"test:mocha:esm": "mocha",
|
|
104
97
|
"test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
|
|
105
|
-
"tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
|
|
106
98
|
"typetests:gen": "flub generate typetests --dir . -v"
|
|
107
99
|
}
|
|
108
100
|
}
|
package/tsconfig.json
CHANGED
package/internal.d.ts
DELETED
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
/*!
|
|
2
|
-
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
|
-
* Licensed under the MIT License.
|
|
4
|
-
*/
|
|
5
|
-
|
|
6
|
-
/*
|
|
7
|
-
* THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
|
|
8
|
-
* Generated by "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib --node10TypeCompat" in @fluid-tools/build-cli.
|
|
9
|
-
*/
|
|
10
|
-
|
|
11
|
-
export * from "./lib/index.js";
|