@fluidframework/odsp-urlresolver 2.0.0-dev-rc.1.0.0.232845 → 2.0.0-dev-rc.2.0.0.246488

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.
Files changed (36) hide show
  1. package/{.mocharc.js → .mocharc.cjs} +1 -1
  2. package/CHANGELOG.md +12 -0
  3. package/{api-extractor-esm.json → api-extractor-cjs.json} +5 -1
  4. package/api-extractor.json +1 -1
  5. package/dist/index.d.ts +1 -1
  6. package/dist/index.d.ts.map +1 -1
  7. package/dist/index.js +4 -4
  8. package/dist/index.js.map +1 -1
  9. package/dist/package.json +3 -0
  10. package/dist/tsdoc-metadata.json +1 -1
  11. package/lib/{index.mjs → index.d.ts} +2 -2
  12. package/lib/index.d.ts.map +1 -0
  13. package/lib/{index.d.mts → index.js} +2 -2
  14. package/lib/index.js.map +1 -0
  15. package/lib/test/fluidAppUrlResolver.spec.js +19 -0
  16. package/lib/test/fluidAppUrlResolver.spec.js.map +1 -0
  17. package/lib/test/spoUrlResolver.spec.js +29 -0
  18. package/lib/test/spoUrlResolver.spec.js.map +1 -0
  19. package/lib/test/types/validateOdspUrlresolverPrevious.generated.js +6 -0
  20. package/lib/test/types/validateOdspUrlresolverPrevious.generated.js.map +1 -0
  21. package/lib/{urlResolver.d.mts → urlResolver.d.ts} +1 -1
  22. package/lib/urlResolver.d.ts.map +1 -0
  23. package/lib/{urlResolver.mjs → urlResolver.js} +1 -1
  24. package/lib/urlResolver.js.map +1 -0
  25. package/package.json +32 -49
  26. package/src/index.ts +1 -1
  27. package/tsconfig.cjs.json +7 -0
  28. package/tsconfig.json +2 -5
  29. package/lib/index.d.mts.map +0 -1
  30. package/lib/index.mjs.map +0 -1
  31. package/lib/urlResolver.d.mts.map +0 -1
  32. package/lib/urlResolver.mjs.map +0 -1
  33. /package/lib/{odsp-urlresolver-alpha.d.mts → odsp-urlresolver-alpha.d.ts} +0 -0
  34. /package/lib/{odsp-urlresolver-beta.d.mts → odsp-urlresolver-beta.d.ts} +0 -0
  35. /package/lib/{odsp-urlresolver-public.d.mts → odsp-urlresolver-public.d.ts} +0 -0
  36. /package/lib/{odsp-urlresolver-untrimmed.d.mts → odsp-urlresolver-untrimmed.d.ts} +0 -0
@@ -5,7 +5,7 @@
5
5
 
6
6
  "use strict";
7
7
 
8
- const getFluidTestMochaConfig = require("@fluidframework/mocha-test-setup/mocharc-common");
8
+ const getFluidTestMochaConfig = require("@fluid-internal/mocha-test-setup/mocharc-common");
9
9
 
10
10
  const packageDir = __dirname;
11
11
  const config = getFluidTestMochaConfig(packageDir);
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @fluidframework/odsp-urlresolver
2
2
 
3
+ ## 2.0.0-rc.2.0.0
4
+
5
+ ### Minor Changes
6
+
7
+ - Resolved URLs no longer use non-standard protocols ([#19840](https://github.com/microsoft/FluidFramework/issues/19840)) [9d3d185183](https://github.com/microsoft/FluidFramework/commits/9d3d1851830d953792a6dfad60dde6f1c59480de)
8
+
9
+ Previously, `IResolvedUrl.url` could use a non-standard protocol like `fluid://`, `fluid-odsp://`, or `fluid-test://`. These have been replaced with `https://` to permit standards-compliant URL parsing.
10
+
11
+ - Remove deprecated package @fluid-tools/fluidapp-odsp-urlresolver ([#19262](https://github.com/microsoft/FluidFramework/issues/19262)) [8990be8bbc](https://github.com/microsoft/FluidFramework/commits/8990be8bbc229c6545eb32023f9caa1dcca8568d)
12
+
13
+ The FluidAppOdspUrlResolver class is now incorporated into the @fluidframework/odsp-urlresolver package.
14
+
3
15
  ## 2.0.0-rc.1.0.0
4
16
 
5
17
  Dependency updates only.
@@ -1,4 +1,8 @@
1
1
  {
2
2
  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
- "extends": "../../../common/build/build-common/api-extractor-base-esm.json"
3
+ "extends": "../../../common/build/build-common/api-extractor-base.cjs.primary.json",
4
+ // CJS is actually secondary; so, no report.
5
+ "apiReport": {
6
+ "enabled": false
7
+ }
4
8
  }
@@ -1,4 +1,4 @@
1
1
  {
2
2
  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
- "extends": "../../../common/build/build-common/api-extractor-base.json"
3
+ "extends": "../../../common/build/build-common/api-extractor-base.esm.primary.json"
4
4
  }
package/dist/index.d.ts CHANGED
@@ -2,5 +2,5 @@
2
2
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
3
  * Licensed under the MIT License.
4
4
  */
5
- export { isOdspUrl, FluidAppOdspUrlResolver, OdspUrlResolver } from "./urlResolver";
5
+ export { isOdspUrl, FluidAppOdspUrlResolver, OdspUrlResolver } from "./urlResolver.js";
6
6
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,SAAS,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,SAAS,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC"}
package/dist/index.js CHANGED
@@ -5,8 +5,8 @@
5
5
  */
6
6
  Object.defineProperty(exports, "__esModule", { value: true });
7
7
  exports.OdspUrlResolver = exports.FluidAppOdspUrlResolver = exports.isOdspUrl = void 0;
8
- var urlResolver_1 = require("./urlResolver");
9
- Object.defineProperty(exports, "isOdspUrl", { enumerable: true, get: function () { return urlResolver_1.isOdspUrl; } });
10
- Object.defineProperty(exports, "FluidAppOdspUrlResolver", { enumerable: true, get: function () { return urlResolver_1.FluidAppOdspUrlResolver; } });
11
- Object.defineProperty(exports, "OdspUrlResolver", { enumerable: true, get: function () { return urlResolver_1.OdspUrlResolver; } });
8
+ var urlResolver_js_1 = require("./urlResolver.js");
9
+ Object.defineProperty(exports, "isOdspUrl", { enumerable: true, get: function () { return urlResolver_js_1.isOdspUrl; } });
10
+ Object.defineProperty(exports, "FluidAppOdspUrlResolver", { enumerable: true, get: function () { return urlResolver_js_1.FluidAppOdspUrlResolver; } });
11
+ Object.defineProperty(exports, "OdspUrlResolver", { enumerable: true, get: function () { return urlResolver_js_1.OdspUrlResolver; } });
12
12
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,6CAAoF;AAA3E,wGAAA,SAAS,OAAA;AAAE,sHAAA,uBAAuB,OAAA;AAAE,8GAAA,eAAe,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { isOdspUrl, FluidAppOdspUrlResolver, OdspUrlResolver } from \"./urlResolver\";\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,mDAAuF;AAA9E,2GAAA,SAAS,OAAA;AAAE,yHAAA,uBAAuB,OAAA;AAAE,iHAAA,eAAe,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { isOdspUrl, FluidAppOdspUrlResolver, OdspUrlResolver } from \"./urlResolver.js\";\n"]}
@@ -0,0 +1,3 @@
1
+ {
2
+ "type": "commonjs"
3
+ }
@@ -5,7 +5,7 @@
5
5
  "toolPackages": [
6
6
  {
7
7
  "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.39.1"
8
+ "packageVersion": "7.42.3"
9
9
  }
10
10
  ]
11
11
  }
@@ -2,5 +2,5 @@
2
2
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
3
  * Licensed under the MIT License.
4
4
  */
5
- export { isOdspUrl, FluidAppOdspUrlResolver, OdspUrlResolver } from "./urlResolver.mjs";
6
- //# sourceMappingURL=index.mjs.map
5
+ export { isOdspUrl, FluidAppOdspUrlResolver, OdspUrlResolver } from "./urlResolver.js";
6
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,SAAS,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC"}
@@ -2,5 +2,5 @@
2
2
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
3
  * Licensed under the MIT License.
4
4
  */
5
- export { isOdspUrl, FluidAppOdspUrlResolver, OdspUrlResolver } from "./urlResolver.mjs";
6
- //# sourceMappingURL=index.d.mts.map
5
+ export { isOdspUrl, FluidAppOdspUrlResolver, OdspUrlResolver } from "./urlResolver.js";
6
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,SAAS,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { isOdspUrl, FluidAppOdspUrlResolver, OdspUrlResolver } from \"./urlResolver.js\";\n"]}
@@ -0,0 +1,19 @@
1
+ /*!
2
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
+ * Licensed under the MIT License.
4
+ */
5
+ import { strict as assert } from "node:assert";
6
+ import { FluidAppOdspUrlResolver } from "../urlResolver.js";
7
+ describe("Fluid App Url Resolver", () => {
8
+ it("Should resolve the Fluid app urls correctly", async () => {
9
+ const urlResolver = new FluidAppOdspUrlResolver();
10
+ const resolved = (await urlResolver.resolve({
11
+ url: "https://dev.fluidpreview.office.net/p/c3BvOmh0dHBzOi8vbWljcm9zb2Z0LnNoYXJlcG9pbnQtZGYuY29tL3RlYW1zL09mZmljZU9ubGluZVByYWd1ZQ%3D%3D/randomDrive/randomItem/OXO-Dogfood-remaining-items?nav=&e=_Ha3TtNhQEaX-jy2yOQM3A&at=15&scriptVersion=3016031",
12
+ }));
13
+ assert.equal(resolved.driveId, "randomDrive", "Drive id does not match");
14
+ assert.equal(resolved.itemId, "randomItem", "Item id does not match");
15
+ assert.equal(resolved.siteUrl, "https://microsoft.sharepoint-df.com/teams/OfficeOnlinePrague", "Site id does not match");
16
+ assert.equal(resolved.endpoints.snapshotStorageUrl, "https://microsoft.sharepoint-df.com/_api/v2.1/drives/randomDrive/items/randomItem/opStream/snapshots", "SnashotStorageUrl does not match");
17
+ });
18
+ });
19
+ //# sourceMappingURL=fluidAppUrlResolver.spec.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fluidAppUrlResolver.spec.js","sourceRoot":"","sources":["../../src/test/fluidAppUrlResolver.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC;AAE/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAE5D,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;IACvC,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;QAC5D,MAAM,WAAW,GAAG,IAAI,uBAAuB,EAAE,CAAC;QAClD,MAAM,QAAQ,GAAG,CAAC,MAAM,WAAW,CAAC,OAAO,CAAC;YAC3C,GAAG,EAAE,iPAAiP;SACtP,CAAC,CAAqB,CAAC;QACxB,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,aAAa,EAAE,yBAAyB,CAAC,CAAC;QACzE,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,YAAY,EAAE,wBAAwB,CAAC,CAAC;QACtE,MAAM,CAAC,KAAK,CACX,QAAQ,CAAC,OAAO,EAChB,8DAA8D,EAC9D,wBAAwB,CACxB,CAAC;QACF,MAAM,CAAC,KAAK,CACX,QAAQ,CAAC,SAAS,CAAC,kBAAkB,EACrC,sGAAsG,EACtG,kCAAkC,CAClC,CAAC;IACH,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { strict as assert } from \"node:assert\";\nimport { IOdspResolvedUrl } from \"@fluidframework/odsp-driver-definitions\";\nimport { FluidAppOdspUrlResolver } from \"../urlResolver.js\";\n\ndescribe(\"Fluid App Url Resolver\", () => {\n\tit(\"Should resolve the Fluid app urls correctly\", async () => {\n\t\tconst urlResolver = new FluidAppOdspUrlResolver();\n\t\tconst resolved = (await urlResolver.resolve({\n\t\t\turl: \"https://dev.fluidpreview.office.net/p/c3BvOmh0dHBzOi8vbWljcm9zb2Z0LnNoYXJlcG9pbnQtZGYuY29tL3RlYW1zL09mZmljZU9ubGluZVByYWd1ZQ%3D%3D/randomDrive/randomItem/OXO-Dogfood-remaining-items?nav=&e=_Ha3TtNhQEaX-jy2yOQM3A&at=15&scriptVersion=3016031\",\n\t\t})) as IOdspResolvedUrl;\n\t\tassert.equal(resolved.driveId, \"randomDrive\", \"Drive id does not match\");\n\t\tassert.equal(resolved.itemId, \"randomItem\", \"Item id does not match\");\n\t\tassert.equal(\n\t\t\tresolved.siteUrl,\n\t\t\t\"https://microsoft.sharepoint-df.com/teams/OfficeOnlinePrague\",\n\t\t\t\"Site id does not match\",\n\t\t);\n\t\tassert.equal(\n\t\t\tresolved.endpoints.snapshotStorageUrl,\n\t\t\t\"https://microsoft.sharepoint-df.com/_api/v2.1/drives/randomDrive/items/randomItem/opStream/snapshots\",\n\t\t\t\"SnashotStorageUrl does not match\",\n\t\t);\n\t});\n});\n"]}
@@ -0,0 +1,29 @@
1
+ /*!
2
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
+ * Licensed under the MIT License.
4
+ */
5
+ import { strict as assert } from "node:assert";
6
+ import { OdspUrlResolver } from "../urlResolver.js";
7
+ describe("Spo Url Resolver", () => {
8
+ it("Should resolve the spo urls correctly", async () => {
9
+ const urlResolver = new OdspUrlResolver();
10
+ const url = "https://microsoft-my.sharepoint-df.com/_api/v2.1/drives/randomDrive/items/randomItem";
11
+ const resolved = (await urlResolver.resolve({ url }));
12
+ assert.equal(resolved.driveId, "randomDrive", "Drive id does not match");
13
+ assert.equal(resolved.itemId, "randomItem", "Item id does not match");
14
+ assert.equal(resolved.siteUrl, url, "Site id does not match");
15
+ assert.equal(resolved.endpoints.snapshotStorageUrl, `${url}/opStream/snapshots`, "SnashotStorageUrl does not match");
16
+ assert.equal(resolved.url, `https://placeholder/placeholder/${resolved.hashedDocumentId}/`, "fluid url does not match");
17
+ });
18
+ it("Should resolve the other tenant spo url correctly", async () => {
19
+ const urlResolver = new OdspUrlResolver();
20
+ const url = "https://random.sharepoint.com/_api/v2.1/drives/randomDrive/items/randomItem";
21
+ const resolved = (await urlResolver.resolve({ url }));
22
+ assert.equal(resolved.driveId, "randomDrive", "Drive id does not match");
23
+ assert.equal(resolved.itemId, "randomItem", "Item id does not match");
24
+ assert.equal(resolved.siteUrl, url, "Site id does not match");
25
+ assert.equal(resolved.endpoints.snapshotStorageUrl, `${url}/opStream/snapshots`, "SnashotStorageUrl does not match");
26
+ assert.equal(resolved.url, `https://placeholder/placeholder/${resolved.hashedDocumentId}/`, "fluid url does not match");
27
+ });
28
+ });
29
+ //# sourceMappingURL=spoUrlResolver.spec.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"spoUrlResolver.spec.js","sourceRoot":"","sources":["../../src/test/spoUrlResolver.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC;AAE/C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IACjC,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;QACtD,MAAM,WAAW,GAAG,IAAI,eAAe,EAAE,CAAC;QAC1C,MAAM,GAAG,GACR,sFAAsF,CAAC;QACxF,MAAM,QAAQ,GAAG,CAAC,MAAM,WAAW,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,CAAqB,CAAC;QAC1E,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,aAAa,EAAE,yBAAyB,CAAC,CAAC;QACzE,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,YAAY,EAAE,wBAAwB,CAAC,CAAC;QACtE,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,wBAAwB,CAAC,CAAC;QAC9D,MAAM,CAAC,KAAK,CACX,QAAQ,CAAC,SAAS,CAAC,kBAAkB,EACrC,GAAG,GAAG,qBAAqB,EAC3B,kCAAkC,CAClC,CAAC;QACF,MAAM,CAAC,KAAK,CACX,QAAQ,CAAC,GAAG,EACZ,mCAAmC,QAAQ,CAAC,gBAAgB,GAAG,EAC/D,0BAA0B,CAC1B,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QAClE,MAAM,WAAW,GAAG,IAAI,eAAe,EAAE,CAAC;QAC1C,MAAM,GAAG,GACR,6EAA6E,CAAC;QAC/E,MAAM,QAAQ,GAAG,CAAC,MAAM,WAAW,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,CAAqB,CAAC;QAC1E,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,aAAa,EAAE,yBAAyB,CAAC,CAAC;QACzE,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,YAAY,EAAE,wBAAwB,CAAC,CAAC;QACtE,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,wBAAwB,CAAC,CAAC;QAC9D,MAAM,CAAC,KAAK,CACX,QAAQ,CAAC,SAAS,CAAC,kBAAkB,EACrC,GAAG,GAAG,qBAAqB,EAC3B,kCAAkC,CAClC,CAAC;QACF,MAAM,CAAC,KAAK,CACX,QAAQ,CAAC,GAAG,EACZ,mCAAmC,QAAQ,CAAC,gBAAgB,GAAG,EAC/D,0BAA0B,CAC1B,CAAC;IACH,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { strict as assert } from \"node:assert\";\nimport { IOdspResolvedUrl } from \"@fluidframework/odsp-driver-definitions\";\nimport { OdspUrlResolver } from \"../urlResolver.js\";\n\ndescribe(\"Spo Url Resolver\", () => {\n\tit(\"Should resolve the spo urls correctly\", async () => {\n\t\tconst urlResolver = new OdspUrlResolver();\n\t\tconst url: string =\n\t\t\t\"https://microsoft-my.sharepoint-df.com/_api/v2.1/drives/randomDrive/items/randomItem\";\n\t\tconst resolved = (await urlResolver.resolve({ url })) as IOdspResolvedUrl;\n\t\tassert.equal(resolved.driveId, \"randomDrive\", \"Drive id does not match\");\n\t\tassert.equal(resolved.itemId, \"randomItem\", \"Item id does not match\");\n\t\tassert.equal(resolved.siteUrl, url, \"Site id does not match\");\n\t\tassert.equal(\n\t\t\tresolved.endpoints.snapshotStorageUrl,\n\t\t\t`${url}/opStream/snapshots`,\n\t\t\t\"SnashotStorageUrl does not match\",\n\t\t);\n\t\tassert.equal(\n\t\t\tresolved.url,\n\t\t\t`https://placeholder/placeholder/${resolved.hashedDocumentId}/`,\n\t\t\t\"fluid url does not match\",\n\t\t);\n\t});\n\n\tit(\"Should resolve the other tenant spo url correctly\", async () => {\n\t\tconst urlResolver = new OdspUrlResolver();\n\t\tconst url: string =\n\t\t\t\"https://random.sharepoint.com/_api/v2.1/drives/randomDrive/items/randomItem\";\n\t\tconst resolved = (await urlResolver.resolve({ url })) as IOdspResolvedUrl;\n\t\tassert.equal(resolved.driveId, \"randomDrive\", \"Drive id does not match\");\n\t\tassert.equal(resolved.itemId, \"randomItem\", \"Item id does not match\");\n\t\tassert.equal(resolved.siteUrl, url, \"Site id does not match\");\n\t\tassert.equal(\n\t\t\tresolved.endpoints.snapshotStorageUrl,\n\t\t\t`${url}/opStream/snapshots`,\n\t\t\t\"SnashotStorageUrl does not match\",\n\t\t);\n\t\tassert.equal(\n\t\t\tresolved.url,\n\t\t\t`https://placeholder/placeholder/${resolved.hashedDocumentId}/`,\n\t\t\t\"fluid url does not match\",\n\t\t);\n\t});\n});\n"]}
@@ -0,0 +1,6 @@
1
+ use_current_ClassDeclaration_OdspUrlResolver(get_old_ClassDeclaration_OdspUrlResolver());
2
+ use_old_ClassDeclaration_OdspUrlResolver(get_current_ClassDeclaration_OdspUrlResolver());
3
+ use_current_VariableDeclaration_isOdspUrl(get_old_VariableDeclaration_isOdspUrl());
4
+ use_old_VariableDeclaration_isOdspUrl(get_current_VariableDeclaration_isOdspUrl());
5
+ export {};
6
+ //# sourceMappingURL=validateOdspUrlresolverPrevious.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"validateOdspUrlresolverPrevious.generated.js","sourceRoot":"","sources":["../../../src/test/types/validateOdspUrlresolverPrevious.generated.ts"],"names":[],"mappings":"AAgCA,4CAA4C,CACxC,wCAAwC,EAAE,CAAC,CAAC;AAWhD,wCAAwC,CACpC,4CAA4C,EAAE,CAAC,CAAC;AAWpD,yCAAyC,CACrC,qCAAqC,EAAE,CAAC,CAAC;AAW7C,qCAAqC,CACjC,yCAAyC,EAAE,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n/*\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.\n * Generated by fluid-type-test-generator in @fluidframework/build-tools.\n */\nimport type * as old from \"@fluidframework/odsp-urlresolver-previous\";\nimport type * as current from \"../../index.js\";\n\n\n// See 'build-tools/src/type-test-generator/compatibility.ts' for more information.\ntype TypeOnly<T> = T extends number\n\t? number\n\t: T extends string\n\t? string\n\t: T extends boolean | bigint | symbol\n\t? T\n\t: {\n\t\t\t[P in keyof T]: TypeOnly<T[P]>;\n\t };\n\n/*\n* Validate forward compat by using old type in place of current type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"ClassDeclaration_OdspUrlResolver\": {\"forwardCompat\": false}\n*/\ndeclare function get_old_ClassDeclaration_OdspUrlResolver():\n TypeOnly<old.OdspUrlResolver>;\ndeclare function use_current_ClassDeclaration_OdspUrlResolver(\n use: TypeOnly<current.OdspUrlResolver>): void;\nuse_current_ClassDeclaration_OdspUrlResolver(\n get_old_ClassDeclaration_OdspUrlResolver());\n\n/*\n* Validate back compat by using current type in place of old type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"ClassDeclaration_OdspUrlResolver\": {\"backCompat\": false}\n*/\ndeclare function get_current_ClassDeclaration_OdspUrlResolver():\n TypeOnly<current.OdspUrlResolver>;\ndeclare function use_old_ClassDeclaration_OdspUrlResolver(\n use: TypeOnly<old.OdspUrlResolver>): void;\nuse_old_ClassDeclaration_OdspUrlResolver(\n get_current_ClassDeclaration_OdspUrlResolver());\n\n/*\n* Validate forward compat by using old type in place of current type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"VariableDeclaration_isOdspUrl\": {\"forwardCompat\": false}\n*/\ndeclare function get_old_VariableDeclaration_isOdspUrl():\n TypeOnly<typeof old.isOdspUrl>;\ndeclare function use_current_VariableDeclaration_isOdspUrl(\n use: TypeOnly<typeof current.isOdspUrl>): void;\nuse_current_VariableDeclaration_isOdspUrl(\n get_old_VariableDeclaration_isOdspUrl());\n\n/*\n* Validate back compat by using current type in place of old type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"VariableDeclaration_isOdspUrl\": {\"backCompat\": false}\n*/\ndeclare function get_current_VariableDeclaration_isOdspUrl():\n TypeOnly<typeof current.isOdspUrl>;\ndeclare function use_old_VariableDeclaration_isOdspUrl(\n use: TypeOnly<typeof old.isOdspUrl>): void;\nuse_old_VariableDeclaration_isOdspUrl(\n get_current_VariableDeclaration_isOdspUrl());\n"]}
@@ -25,4 +25,4 @@ export declare class FluidAppOdspUrlResolver implements IUrlResolver {
25
25
  resolve(request: IRequest): Promise<IResolvedUrl | undefined>;
26
26
  getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string, packageInfoSource?: IContainerPackageInfo): Promise<string>;
27
27
  }
28
- //# sourceMappingURL=urlResolver.d.mts.map
28
+ //# sourceMappingURL=urlResolver.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"urlResolver.d.ts","sourceRoot":"","sources":["../src/urlResolver.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EACN,qBAAqB,EACrB,YAAY,EACZ,YAAY,EACZ,MAAM,oCAAoC,CAAC;AAkB5C;;GAEG;AACH,qBAAa,eAAgB,YAAW,YAAY;IACtC,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC;IAiB7D,cAAc,CAAC,WAAW,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAG5F;AAED;;;;GAIG;AACH,eAAO,MAAM,SAAS,QAAS,MAAM,KAAG,OAEvC,CAAC;AAEF;;;GAGG;AACH,qBAAa,uBAAwB,YAAW,YAAY;IAC9C,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC;IA6B7D,cAAc,CAC1B,WAAW,EAAE,YAAY,EACzB,WAAW,EAAE,MAAM,EACnB,iBAAiB,CAAC,EAAE,qBAAqB,GACvC,OAAO,CAAC,MAAM,CAAC;CAGlB"}
@@ -102,4 +102,4 @@ async function initializeFluidOfficeOrOneNote(urlSource) {
102
102
  const itemId = decodeURIComponent(siteDriveItemMatch[4]);
103
103
  return { siteUrl, driveId, itemId };
104
104
  }
105
- //# sourceMappingURL=urlResolver.mjs.map
105
+ //# sourceMappingURL=urlResolver.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"urlResolver.js","sourceRoot":"","sources":["../src/urlResolver.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAQH,OAAO,EACN,aAAa,EACb,qBAAqB,EACrB,QAAQ,EACR,QAAQ,EACR,eAAe,GACf,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAGpD,MAAM,4BAA4B,GAAG,IAAI,GAAG,CAAC;IAC5C,6BAA6B;IAC7B,yBAAyB;IACzB,iBAAiB;CACjB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,OAAO,eAAe;IACpB,KAAK,CAAC,OAAO,CAAC,OAAiB;QACrC,IAAI,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YAC3B,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACpC,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,MAAM,CAAC,CAAC;YAC/C,IAAI,CAAC,QAAQ,EAAE;gBACd,OAAO,SAAS,CAAC;aACjB;YACD,MAAM,eAAe,GAAG,aAAa,CAAC,EAAE,GAAG,QAAQ,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC,CAAC;YAC1E,MAAM,qBAAqB,GAAiB,IAAI,qBAAqB,EAAE,CAAC;YACxE,OAAO,qBAAqB,CAAC,OAAO,CAAC;gBACpC,GAAG,EAAE,eAAe;gBACpB,OAAO,EAAE,OAAO,CAAC,OAAO;aACxB,CAAC,CAAC;SACH;QACD,OAAO,SAAS,CAAC;IAClB,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,WAAyB,EAAE,WAAmB;QACzE,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACpC,CAAC;CACD;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,GAAW,EAAW,EAAE;IACjD,OAAO,QAAQ,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,GAAG,CAAC,CAAC;AACvC,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,OAAO,uBAAuB;IAC5B,KAAK,CAAC,OAAO,CAAC,OAAiB;QACrC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;QAC7C,IAAI,QAAmC,CAAC;QACxC,IAAI,4BAA4B,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YAC7C,QAAQ,GAAG,MAAM,8BAA8B,CAAC,MAAM,CAAC,CAAC;SACxD;aAAM,IAAI,MAAM,KAAK,gBAAgB,EAAE;YACvC,MAAM,gBAAgB,GAAG,CAAC,IAAY,EAAU,EAAE;gBACjD,MAAM,KAAK,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBAC5C,MAAM,CAAC,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,iDAAiD,CAAC,CAAC;gBACzE,OAAO,KAAK,CAAC;YACd,CAAC,CAAC;YACF,QAAQ,GAAG;gBACV,OAAO,EAAE,gBAAgB,CAAC,OAAO,CAAC;gBAClC,MAAM,EAAE,gBAAgB,CAAC,MAAM,CAAC;gBAChC,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC;aACpC,CAAC;SACF;aAAM;YACN,OAAO,SAAS,CAAC;SACjB;QACD,IAAI,CAAC,QAAQ,EAAE;YACd,OAAO,SAAS,CAAC;SACjB;QACD,MAAM,eAAe,GAAG,aAAa,CAAC,EAAE,GAAG,QAAQ,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC,CAAC;QAC1E,MAAM,qBAAqB,GAAiB,IAAI,qBAAqB,EAAE,CAAC;QACxE,OAAO,qBAAqB,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,eAAe,EAAE,CAAC,CAAC;IAChE,CAAC;IAED,8EAA8E;IACvE,KAAK,CAAC,cAAc,CAC1B,WAAyB,EACzB,WAAmB,EACnB,iBAAyC;QAEzC,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACpC,CAAC;CACD;AAED,KAAK,UAAU,8BAA8B,CAAC,SAAc;IAC3D,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC;IACpC,MAAM,kBAAkB,GAAG,QAAQ,CAAC,KAAK,CACxC,6DAA6D,CAC7D,CAAC;IACF,IAAI,kBAAkB,KAAK,IAAI,EAAE;QAChC,OAAO,SAAS,CAAC;KACjB;IAED,MAAM,IAAI,GAAG,kBAAkB,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;IAEvD,uDAAuD;IACvD,MAAM,WAAW,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAE3C,mCAAmC;IACnC,MAAM,WAAW,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9C,MAAM,mBAAmB,GAAG,KAAK,CAAC,CAAC,2BAA2B;IAC9D,IAAI,WAAW,KAAK,mBAAmB,EAAE;QACxC,MAAM,IAAI,KAAK,CAAC,2BAA2B,WAAW,eAAe,mBAAmB,EAAE,CAAC,CAAC;KAC5F;IAED,uEAAuE;IACvE,MAAM,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IACvE,MAAM,OAAO,GAAG,kBAAkB,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1D,MAAM,MAAM,GAAG,kBAAkB,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;IACzD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;AACrC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IRequest } from \"@fluidframework/core-interfaces\";\nimport {\n\tIContainerPackageInfo,\n\tIResolvedUrl,\n\tIUrlResolver,\n} from \"@fluidframework/driver-definitions\";\nimport {\n\tcreateOdspUrl,\n\tOdspDriverUrlResolver,\n\tisSpoUrl,\n\tisOdcUrl,\n\tgetOdspUrlParts,\n} from \"@fluidframework/odsp-driver\";\nimport { fromBase64ToUtf8 } from \"@fluid-internal/client-utils\";\nimport { assert } from \"@fluidframework/core-utils\";\nimport { IOdspUrlParts } from \"@fluidframework/odsp-driver-definitions\";\n\nconst fluidOfficeAndOneNoteServers = new Set([\n\t\"dev.fluidpreview.office.net\",\n\t\"fluidpreview.office.net\",\n\t\"www.onenote.com\",\n]);\n\n/**\n * @internal\n */\nexport class OdspUrlResolver implements IUrlResolver {\n\tpublic async resolve(request: IRequest): Promise<IResolvedUrl | undefined> {\n\t\tif (isOdspUrl(request.url)) {\n\t\t\tconst reqUrl = new URL(request.url);\n\t\t\tconst contents = await getOdspUrlParts(reqUrl);\n\t\t\tif (!contents) {\n\t\t\t\treturn undefined;\n\t\t\t}\n\t\t\tconst urlToBeResolved = createOdspUrl({ ...contents, dataStorePath: \"\" });\n\t\t\tconst odspDriverUrlResolver: IUrlResolver = new OdspDriverUrlResolver();\n\t\t\treturn odspDriverUrlResolver.resolve({\n\t\t\t\turl: urlToBeResolved,\n\t\t\t\theaders: request.headers,\n\t\t\t});\n\t\t}\n\t\treturn undefined;\n\t}\n\n\tpublic async getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string): Promise<string> {\n\t\tthrow new Error(\"Not implemented\");\n\t}\n}\n\n/**\n * Returns true if the given string is a valid SPO/ODB or ODC URL.\n *\n * @internal\n */\nexport const isOdspUrl = (url: string): boolean => {\n\treturn isSpoUrl(url) || isOdcUrl(url);\n};\n\n/**\n * This class helps to resolve Fluid URLs from Office and OneNote. Construct the resolver class and invoke its resolve function to retrieve the content parameters.\n * @internal\n */\nexport class FluidAppOdspUrlResolver implements IUrlResolver {\n\tpublic async resolve(request: IRequest): Promise<IResolvedUrl | undefined> {\n\t\tconst reqUrl = new URL(request.url);\n\t\tconst server = reqUrl.hostname.toLowerCase();\n\t\tlet contents: IOdspUrlParts | undefined;\n\t\tif (fluidOfficeAndOneNoteServers.has(server)) {\n\t\t\tcontents = await initializeFluidOfficeOrOneNote(reqUrl);\n\t\t} else if (server === \"www.office.com\") {\n\t\t\tconst getRequiredParam = (name: string): string => {\n\t\t\t\tconst value = reqUrl.searchParams.get(name);\n\t\t\t\tassert(!!value, 0x097 /* Missing param from office.com URL parameter */);\n\t\t\t\treturn value;\n\t\t\t};\n\t\t\tcontents = {\n\t\t\t\tdriveId: getRequiredParam(\"drive\"),\n\t\t\t\titemId: getRequiredParam(\"item\"),\n\t\t\t\tsiteUrl: getRequiredParam(\"siteUrl\"),\n\t\t\t};\n\t\t} else {\n\t\t\treturn undefined;\n\t\t}\n\t\tif (!contents) {\n\t\t\treturn undefined;\n\t\t}\n\t\tconst urlToBeResolved = createOdspUrl({ ...contents, dataStorePath: \"\" });\n\t\tconst odspDriverUrlResolver: IUrlResolver = new OdspDriverUrlResolver();\n\t\treturn odspDriverUrlResolver.resolve({ url: urlToBeResolved });\n\t}\n\n\t// TODO: Issue-2109 Implement detach container api or put appropriate comment.\n\tpublic async getAbsoluteUrl(\n\t\tresolvedUrl: IResolvedUrl,\n\t\trelativeUrl: string,\n\t\tpackageInfoSource?: IContainerPackageInfo,\n\t): Promise<string> {\n\t\tthrow new Error(\"Not implemented\");\n\t}\n}\n\nasync function initializeFluidOfficeOrOneNote(urlSource: URL): Promise<IOdspUrlParts | undefined> {\n\tconst pathname = urlSource.pathname;\n\tconst siteDriveItemMatch = pathname.match(\n\t\t/\\/(p|preview|meetingnotes|notes)\\/([^/]*)\\/([^/]*)\\/([^/]*)/,\n\t);\n\tif (siteDriveItemMatch === null) {\n\t\treturn undefined;\n\t}\n\n\tconst site = decodeURIComponent(siteDriveItemMatch[2]);\n\n\t// Path value is base64 encoded so need to decode first\n\tconst decodedSite = fromBase64ToUtf8(site);\n\n\t// Site value includes storage type\n\tconst storageType = decodedSite.split(\":\")[0];\n\tconst expectedStorageType = \"spo\"; // Only support spo for now\n\tif (storageType !== expectedStorageType) {\n\t\tthrow new Error(`Unexpected storage type ${storageType}, expected: ${expectedStorageType}`);\n\t}\n\n\t// Since we have the drive and item, only take the host ignore the rest\n\tconst siteUrl = decodedSite.slice(Math.max(0, storageType.length + 1));\n\tconst driveId = decodeURIComponent(siteDriveItemMatch[3]);\n\tconst itemId = decodeURIComponent(siteDriveItemMatch[4]);\n\treturn { siteUrl, driveId, itemId };\n}\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/odsp-urlresolver",
3
- "version": "2.0.0-dev-rc.1.0.0.232845",
3
+ "version": "2.0.0-dev-rc.2.0.0.246488",
4
4
  "description": "Url Resolver for odsp urls.",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -11,90 +11,69 @@
11
11
  "license": "MIT",
12
12
  "author": "Microsoft and contributors",
13
13
  "sideEffects": false,
14
+ "type": "module",
14
15
  "exports": {
15
16
  ".": {
16
17
  "import": {
17
- "types": "./lib/index.d.mts",
18
- "default": "./lib/index.mjs"
18
+ "types": "./lib/index.d.ts",
19
+ "default": "./lib/index.js"
19
20
  },
20
21
  "require": {
21
22
  "types": "./dist/index.d.ts",
22
23
  "default": "./dist/index.js"
23
24
  }
24
25
  },
25
- "./alpha": {
26
- "import": {
27
- "types": "./lib/odsp-urlresolver-alpha.d.mts",
28
- "default": "./lib/index.mjs"
29
- },
30
- "require": {
31
- "types": "./dist/odsp-urlresolver-alpha.d.ts",
32
- "default": "./dist/index.js"
33
- }
34
- },
35
- "./beta": {
26
+ "./public": {
36
27
  "import": {
37
- "types": "./lib/odsp-urlresolver-beta.d.mts",
38
- "default": "./lib/index.mjs"
28
+ "types": "./lib/odsp-urlresolver-public.d.ts",
29
+ "default": "./lib/index.js"
39
30
  },
40
31
  "require": {
41
- "types": "./dist/odsp-urlresolver-beta.d.ts",
32
+ "types": "./dist/odsp-urlresolver-public.d.ts",
42
33
  "default": "./dist/index.js"
43
34
  }
44
35
  },
45
36
  "./internal": {
46
37
  "import": {
47
- "types": "./lib/index.d.mts",
48
- "default": "./lib/index.mjs"
38
+ "types": "./lib/index.d.ts",
39
+ "default": "./lib/index.js"
49
40
  },
50
41
  "require": {
51
42
  "types": "./dist/index.d.ts",
52
43
  "default": "./dist/index.js"
53
44
  }
54
- },
55
- "./public": {
56
- "import": {
57
- "types": "./lib/odsp-urlresolver-public.d.mts",
58
- "default": "./lib/index.mjs"
59
- },
60
- "require": {
61
- "types": "./dist/odsp-urlresolver-public.d.ts",
62
- "default": "./dist/index.js"
63
- }
64
45
  }
65
46
  },
66
47
  "main": "dist/index.js",
67
- "module": "lib/index.mjs",
68
48
  "types": "dist/index.d.ts",
69
49
  "dependencies": {
70
- "@fluid-internal/client-utils": "2.0.0-dev-rc.1.0.0.232845",
71
- "@fluidframework/core-interfaces": "2.0.0-dev-rc.1.0.0.232845",
72
- "@fluidframework/core-utils": "2.0.0-dev-rc.1.0.0.232845",
73
- "@fluidframework/driver-definitions": "2.0.0-dev-rc.1.0.0.232845",
74
- "@fluidframework/odsp-driver": "2.0.0-dev-rc.1.0.0.232845",
75
- "@fluidframework/odsp-driver-definitions": "2.0.0-dev-rc.1.0.0.232845"
50
+ "@fluid-internal/client-utils": "2.0.0-dev-rc.2.0.0.246488",
51
+ "@fluidframework/core-interfaces": "2.0.0-dev-rc.2.0.0.246488",
52
+ "@fluidframework/core-utils": "2.0.0-dev-rc.2.0.0.246488",
53
+ "@fluidframework/driver-definitions": "2.0.0-dev-rc.2.0.0.246488",
54
+ "@fluidframework/odsp-driver": "2.0.0-dev-rc.2.0.0.246488",
55
+ "@fluidframework/odsp-driver-definitions": "2.0.0-dev-rc.2.0.0.246488"
76
56
  },
77
57
  "devDependencies": {
78
58
  "@arethetypeswrong/cli": "^0.13.3",
79
- "@fluid-tools/build-cli": "^0.29.0",
59
+ "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.2.0.0.246488",
60
+ "@fluid-tools/build-cli": "^0.34.0",
80
61
  "@fluidframework/build-common": "^2.0.3",
81
- "@fluidframework/build-tools": "^0.29.0",
82
- "@fluidframework/eslint-config-fluid": "^3.3.0",
83
- "@fluidframework/mocha-test-setup": "2.0.0-dev-rc.1.0.0.232845",
62
+ "@fluidframework/build-tools": "^0.34.0",
63
+ "@fluidframework/eslint-config-fluid": "^5.1.0",
84
64
  "@fluidframework/odsp-urlresolver-previous": "npm:@fluidframework/odsp-urlresolver@2.0.0-internal.8.0.0",
85
- "@microsoft/api-extractor": "^7.39.1",
65
+ "@microsoft/api-extractor": "^7.42.3",
86
66
  "@types/mocha": "^9.1.1",
87
67
  "@types/node": "^18.19.0",
88
68
  "copyfiles": "^2.4.1",
89
69
  "cross-env": "^7.0.3",
90
- "eslint": "~8.50.0",
70
+ "eslint": "~8.55.0",
91
71
  "mocha": "^10.2.0",
92
72
  "mocha-json-output-reporter": "^2.0.1",
93
73
  "mocha-multi-reporters": "^1.5.1",
94
74
  "moment": "^2.21.0",
95
75
  "prettier": "~3.0.3",
96
76
  "rimraf": "^4.4.0",
97
- "tsc-multi": "^1.1.0",
98
77
  "typescript": "~5.1.6"
99
78
  },
100
79
  "fluidBuild": {
@@ -114,14 +93,16 @@
114
93
  },
115
94
  "scripts": {
116
95
  "api": "fluid-build . --task api",
117
- "api-extractor:commonjs": "api-extractor run --local",
118
- "api-extractor:esnext": "api-extractor run --config ./api-extractor-esm.json",
96
+ "api-extractor:commonjs": "api-extractor run --config ./api-extractor-cjs.json",
97
+ "api-extractor:esnext": "api-extractor run --local",
119
98
  "build": "fluid-build . --task build",
120
99
  "build:commonjs": "fluid-build . --task commonjs",
121
100
  "build:compile": "fluid-build . --task compile",
122
101
  "build:docs": "fluid-build . --task api",
123
- "build:esnext": "tsc-multi --config ../../../common/build/build-common/tsc-multi.esm.json",
124
- "build:test": "tsc --project ./src/test/tsconfig.json",
102
+ "build:esnext": "tsc --project ./tsconfig.json",
103
+ "build:test": "npm run build:test:esm && npm run build:test:cjs",
104
+ "build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
105
+ "build:test:esm": "tsc --project ./src/test/tsconfig.json",
125
106
  "check:are-the-types-wrong": "attw --pack . --entrypoints .",
126
107
  "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
127
108
  "ci:build:docs": "api-extractor run",
@@ -134,9 +115,11 @@
134
115
  "prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
135
116
  "prettier:fix": "prettier --write . --cache --ignore-path ../../../.prettierignore",
136
117
  "test": "npm run test:mocha",
137
- "test:mocha": "mocha --ignore \"dist/test/types/*\" --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup",
118
+ "test:mocha": "npm run test:mocha:esm && echo skipping cjs to avoid overhead - npm run test:mocha:cjs",
119
+ "test:mocha:cjs": "mocha --recursive \"dist/test/**/*.spec.*js\" --exit -r node_modules/@fluid-internal/mocha-test-setup",
120
+ "test:mocha:esm": "mocha --recursive \"lib/test/**/*.spec.*js\" --exit -r node_modules/@fluid-internal/mocha-test-setup",
138
121
  "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
139
- "tsc": "tsc",
122
+ "tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
140
123
  "typetests:gen": "fluid-type-test-generator",
141
124
  "typetests:prepare": "flub typetests --dir . --reset --previous --normalize"
142
125
  }
package/src/index.ts CHANGED
@@ -3,4 +3,4 @@
3
3
  * Licensed under the MIT License.
4
4
  */
5
5
 
6
- export { isOdspUrl, FluidAppOdspUrlResolver, OdspUrlResolver } from "./urlResolver";
6
+ export { isOdspUrl, FluidAppOdspUrlResolver, OdspUrlResolver } from "./urlResolver.js";
@@ -0,0 +1,7 @@
1
+ {
2
+ // This config must be used in a "type": "commonjs" environment. (Use fluid-tsc commonjs.)
3
+ "extends": "./tsconfig.json",
4
+ "compilerOptions": {
5
+ "outDir": "./dist",
6
+ },
7
+ }
package/tsconfig.json CHANGED
@@ -1,12 +1,9 @@
1
1
  {
2
- "extends": [
3
- "../../../common/build/build-common/tsconfig.base.json",
4
- "../../../common/build/build-common/tsconfig.cjs.json",
5
- ],
2
+ "extends": "../../../common/build/build-common/tsconfig.node16.json",
6
3
  "include": ["src/**/*"],
7
4
  "exclude": ["src/test/**/*"],
8
5
  "compilerOptions": {
9
6
  "rootDir": "./src",
10
- "outDir": "./dist",
7
+ "outDir": "./lib",
11
8
  },
12
9
  }
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAAE,SAAS,EAAE,uBAAuB,EAAE,eAAe,EAAE"}
package/lib/index.mjs.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAAE,SAAS,EAAE,uBAAuB,EAAE,eAAe,EAAE","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { isOdspUrl, FluidAppOdspUrlResolver, OdspUrlResolver } from \"./urlResolver\";\n"]}
@@ -1 +0,0 @@
1
- {"version":3,"file":"urlResolver.d.mts","sourceRoot":"","sources":["../src/urlResolver.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAAE,QAAQ,EAAE,MAAM,iCAAiC;OACnD,EACN,qBAAqB,EACrB,YAAY,EACZ,YAAY,EACZ,MAAM,oCAAoC;AAkB3C;;GAEG;AACH,qBAAa,eAAgB,YAAW,YAAY;IACtC,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC;IAiB7D,cAAc,CAAC,WAAW,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAG5F;AAED;;;;GAIG;AACH,eAAO,MAAM,SAAS,QAAS,MAAM,KAAG,OAEvC,CAAC;AAEF;;;GAGG;AACH,qBAAa,uBAAwB,YAAW,YAAY;IAC9C,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC;IA6B7D,cAAc,CAC1B,WAAW,EAAE,YAAY,EACzB,WAAW,EAAE,MAAM,EACnB,iBAAiB,CAAC,EAAE,qBAAqB,GACvC,OAAO,CAAC,MAAM,CAAC;CAGlB"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"urlResolver.mjs","sourceRoot":"","sources":["../src/urlResolver.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAQI,EACN,aAAa,EACb,qBAAqB,EACrB,QAAQ,EACR,QAAQ,EACR,eAAe,GACf,MAAM,6BAA6B;OAC7B,EAAE,gBAAgB,EAAE,MAAM,8BAA8B;OACxD,EAAE,MAAM,EAAE,MAAM,4BAA4B;AAGnD,MAAM,4BAA4B,GAAG,IAAI,GAAG,CAAC;IAC5C,6BAA6B;IAC7B,yBAAyB;IACzB,iBAAiB;CACjB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,OAAO,eAAe;IACpB,KAAK,CAAC,OAAO,CAAC,OAAiB;QACrC,IAAI,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YAC3B,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACpC,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,MAAM,CAAC,CAAC;YAC/C,IAAI,CAAC,QAAQ,EAAE;gBACd,OAAO,SAAS,CAAC;aACjB;YACD,MAAM,eAAe,GAAG,aAAa,CAAC,EAAE,GAAG,QAAQ,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC,CAAC;YAC1E,MAAM,qBAAqB,GAAiB,IAAI,qBAAqB,EAAE,CAAC;YACxE,OAAO,qBAAqB,CAAC,OAAO,CAAC;gBACpC,GAAG,EAAE,eAAe;gBACpB,OAAO,EAAE,OAAO,CAAC,OAAO;aACxB,CAAC,CAAC;SACH;QACD,OAAO,SAAS,CAAC;IAClB,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,WAAyB,EAAE,WAAmB;QACzE,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACpC,CAAC;CACD;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,GAAW,EAAW,EAAE;IACjD,OAAO,QAAQ,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,GAAG,CAAC,CAAC;AACvC,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,OAAO,uBAAuB;IAC5B,KAAK,CAAC,OAAO,CAAC,OAAiB;QACrC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;QAC7C,IAAI,QAAmC,CAAC;QACxC,IAAI,4BAA4B,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YAC7C,QAAQ,GAAG,MAAM,8BAA8B,CAAC,MAAM,CAAC,CAAC;SACxD;aAAM,IAAI,MAAM,KAAK,gBAAgB,EAAE;YACvC,MAAM,gBAAgB,GAAG,CAAC,IAAY,EAAU,EAAE;gBACjD,MAAM,KAAK,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBAC5C,MAAM,CAAC,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,iDAAiD,CAAC,CAAC;gBACzE,OAAO,KAAK,CAAC;YACd,CAAC,CAAC;YACF,QAAQ,GAAG;gBACV,OAAO,EAAE,gBAAgB,CAAC,OAAO,CAAC;gBAClC,MAAM,EAAE,gBAAgB,CAAC,MAAM,CAAC;gBAChC,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC;aACpC,CAAC;SACF;aAAM;YACN,OAAO,SAAS,CAAC;SACjB;QACD,IAAI,CAAC,QAAQ,EAAE;YACd,OAAO,SAAS,CAAC;SACjB;QACD,MAAM,eAAe,GAAG,aAAa,CAAC,EAAE,GAAG,QAAQ,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC,CAAC;QAC1E,MAAM,qBAAqB,GAAiB,IAAI,qBAAqB,EAAE,CAAC;QACxE,OAAO,qBAAqB,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,eAAe,EAAE,CAAC,CAAC;IAChE,CAAC;IAED,8EAA8E;IACvE,KAAK,CAAC,cAAc,CAC1B,WAAyB,EACzB,WAAmB,EACnB,iBAAyC;QAEzC,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACpC,CAAC;CACD;AAED,KAAK,UAAU,8BAA8B,CAAC,SAAc;IAC3D,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC;IACpC,MAAM,kBAAkB,GAAG,QAAQ,CAAC,KAAK,CACxC,6DAA6D,CAC7D,CAAC;IACF,IAAI,kBAAkB,KAAK,IAAI,EAAE;QAChC,OAAO,SAAS,CAAC;KACjB;IAED,MAAM,IAAI,GAAG,kBAAkB,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;IAEvD,uDAAuD;IACvD,MAAM,WAAW,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAE3C,mCAAmC;IACnC,MAAM,WAAW,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9C,MAAM,mBAAmB,GAAG,KAAK,CAAC,CAAC,2BAA2B;IAC9D,IAAI,WAAW,KAAK,mBAAmB,EAAE;QACxC,MAAM,IAAI,KAAK,CAAC,2BAA2B,WAAW,eAAe,mBAAmB,EAAE,CAAC,CAAC;KAC5F;IAED,uEAAuE;IACvE,MAAM,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IACvE,MAAM,OAAO,GAAG,kBAAkB,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1D,MAAM,MAAM,GAAG,kBAAkB,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;IACzD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;AACrC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IRequest } from \"@fluidframework/core-interfaces\";\nimport {\n\tIContainerPackageInfo,\n\tIResolvedUrl,\n\tIUrlResolver,\n} from \"@fluidframework/driver-definitions\";\nimport {\n\tcreateOdspUrl,\n\tOdspDriverUrlResolver,\n\tisSpoUrl,\n\tisOdcUrl,\n\tgetOdspUrlParts,\n} from \"@fluidframework/odsp-driver\";\nimport { fromBase64ToUtf8 } from \"@fluid-internal/client-utils\";\nimport { assert } from \"@fluidframework/core-utils\";\nimport { IOdspUrlParts } from \"@fluidframework/odsp-driver-definitions\";\n\nconst fluidOfficeAndOneNoteServers = new Set([\n\t\"dev.fluidpreview.office.net\",\n\t\"fluidpreview.office.net\",\n\t\"www.onenote.com\",\n]);\n\n/**\n * @internal\n */\nexport class OdspUrlResolver implements IUrlResolver {\n\tpublic async resolve(request: IRequest): Promise<IResolvedUrl | undefined> {\n\t\tif (isOdspUrl(request.url)) {\n\t\t\tconst reqUrl = new URL(request.url);\n\t\t\tconst contents = await getOdspUrlParts(reqUrl);\n\t\t\tif (!contents) {\n\t\t\t\treturn undefined;\n\t\t\t}\n\t\t\tconst urlToBeResolved = createOdspUrl({ ...contents, dataStorePath: \"\" });\n\t\t\tconst odspDriverUrlResolver: IUrlResolver = new OdspDriverUrlResolver();\n\t\t\treturn odspDriverUrlResolver.resolve({\n\t\t\t\turl: urlToBeResolved,\n\t\t\t\theaders: request.headers,\n\t\t\t});\n\t\t}\n\t\treturn undefined;\n\t}\n\n\tpublic async getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string): Promise<string> {\n\t\tthrow new Error(\"Not implemented\");\n\t}\n}\n\n/**\n * Returns true if the given string is a valid SPO/ODB or ODC URL.\n *\n * @internal\n */\nexport const isOdspUrl = (url: string): boolean => {\n\treturn isSpoUrl(url) || isOdcUrl(url);\n};\n\n/**\n * This class helps to resolve Fluid URLs from Office and OneNote. Construct the resolver class and invoke its resolve function to retrieve the content parameters.\n * @internal\n */\nexport class FluidAppOdspUrlResolver implements IUrlResolver {\n\tpublic async resolve(request: IRequest): Promise<IResolvedUrl | undefined> {\n\t\tconst reqUrl = new URL(request.url);\n\t\tconst server = reqUrl.hostname.toLowerCase();\n\t\tlet contents: IOdspUrlParts | undefined;\n\t\tif (fluidOfficeAndOneNoteServers.has(server)) {\n\t\t\tcontents = await initializeFluidOfficeOrOneNote(reqUrl);\n\t\t} else if (server === \"www.office.com\") {\n\t\t\tconst getRequiredParam = (name: string): string => {\n\t\t\t\tconst value = reqUrl.searchParams.get(name);\n\t\t\t\tassert(!!value, 0x097 /* Missing param from office.com URL parameter */);\n\t\t\t\treturn value;\n\t\t\t};\n\t\t\tcontents = {\n\t\t\t\tdriveId: getRequiredParam(\"drive\"),\n\t\t\t\titemId: getRequiredParam(\"item\"),\n\t\t\t\tsiteUrl: getRequiredParam(\"siteUrl\"),\n\t\t\t};\n\t\t} else {\n\t\t\treturn undefined;\n\t\t}\n\t\tif (!contents) {\n\t\t\treturn undefined;\n\t\t}\n\t\tconst urlToBeResolved = createOdspUrl({ ...contents, dataStorePath: \"\" });\n\t\tconst odspDriverUrlResolver: IUrlResolver = new OdspDriverUrlResolver();\n\t\treturn odspDriverUrlResolver.resolve({ url: urlToBeResolved });\n\t}\n\n\t// TODO: Issue-2109 Implement detach container api or put appropriate comment.\n\tpublic async getAbsoluteUrl(\n\t\tresolvedUrl: IResolvedUrl,\n\t\trelativeUrl: string,\n\t\tpackageInfoSource?: IContainerPackageInfo,\n\t): Promise<string> {\n\t\tthrow new Error(\"Not implemented\");\n\t}\n}\n\nasync function initializeFluidOfficeOrOneNote(urlSource: URL): Promise<IOdspUrlParts | undefined> {\n\tconst pathname = urlSource.pathname;\n\tconst siteDriveItemMatch = pathname.match(\n\t\t/\\/(p|preview|meetingnotes|notes)\\/([^/]*)\\/([^/]*)\\/([^/]*)/,\n\t);\n\tif (siteDriveItemMatch === null) {\n\t\treturn undefined;\n\t}\n\n\tconst site = decodeURIComponent(siteDriveItemMatch[2]);\n\n\t// Path value is base64 encoded so need to decode first\n\tconst decodedSite = fromBase64ToUtf8(site);\n\n\t// Site value includes storage type\n\tconst storageType = decodedSite.split(\":\")[0];\n\tconst expectedStorageType = \"spo\"; // Only support spo for now\n\tif (storageType !== expectedStorageType) {\n\t\tthrow new Error(`Unexpected storage type ${storageType}, expected: ${expectedStorageType}`);\n\t}\n\n\t// Since we have the drive and item, only take the host ignore the rest\n\tconst siteUrl = decodedSite.slice(Math.max(0, storageType.length + 1));\n\tconst driveId = decodeURIComponent(siteDriveItemMatch[3]);\n\tconst itemId = decodeURIComponent(siteDriveItemMatch[4]);\n\treturn { siteUrl, driveId, itemId };\n}\n"]}