@fluidframework/odsp-driver 1.1.0 → 1.2.0

package/dist/odspFluidFileLink.js

@@ -9,13 +9,14 @@ const common_utils_1 = require("@fluidframework/common-utils");
 const constants_1 = require("./constants");
 const fluidSignature = "1";
 const fluidSignatureParamName = "fluid";
-const fluidSitePathParamName = "s";
-const fluidDriveIdParamName = "d";
-const fluidItemIdParamName = "f";
-const fluidDataStorePathParamName = "c";
-const fluidAppNameParamName = "a";
-const fluidContainerPackageNameParamName = "p";
-const fluidFileVersionParamName = "v";
+const sitePathParamName = "s";
+const driveIdParamName = "d";
+const itemIdParamName = "f";
+const dataStorePathParamName = "c";
+const appNameParamName = "a";
+const containerPackageNameParamName = "p";
+const fileVersionParamName = "v";
+const additionalContextParamName = "x";
 /**
  * Transforms given Fluid data store locator into string that can be embedded into url
  * @param locator - describes Fluid data store locator info to be encoded
@@ -27,15 +28,18 @@ function encodeOdspFluidDataStoreLocator(locator) {
     const driveId = encodeURIComponent(locator.driveId);
     const itemId = encodeURIComponent(locator.itemId);
     const dataStorePath = encodeURIComponent(locator.dataStorePath);
-    let locatorSerialized = `${fluidSitePathParamName}=${sitePath}&${fluidDriveIdParamName}=${driveId}&${fluidItemIdParamName}=${itemId}&${fluidDataStorePathParamName}=${dataStorePath}&${fluidSignatureParamName}=${fluidSignature}`;
+    let locatorSerialized = `${sitePathParamName}=${sitePath}&${driveIdParamName}=${driveId}&${itemIdParamName}=${itemId}&${dataStorePathParamName}=${dataStorePath}&${fluidSignatureParamName}=${fluidSignature}`;
     if (locator.appName) {
-        locatorSerialized += `&${fluidAppNameParamName}=${encodeURIComponent(locator.appName)}`;
+        locatorSerialized += `&${appNameParamName}=${encodeURIComponent(locator.appName)}`;
     }
     if (locator.containerPackageName) {
-        locatorSerialized += `&${fluidContainerPackageNameParamName}=${encodeURIComponent(locator.containerPackageName)}`;
+        locatorSerialized += `&${containerPackageNameParamName}=${encodeURIComponent(locator.containerPackageName)}`;
     }
     if (locator.fileVersion) {
-        locatorSerialized += `&${fluidFileVersionParamName}=${encodeURIComponent(locator.fileVersion)}`;
+        locatorSerialized += `&${fileVersionParamName}=${encodeURIComponent(locator.fileVersion)}`;
+    }
+    if (locator.context) {
+        locatorSerialized += `&${additionalContextParamName}=${encodeURIComponent(locator.context)}`;
     }
     return (0, common_utils_1.fromUtf8ToBase64)(locatorSerialized);
 }
@@ -48,21 +52,22 @@ exports.encodeOdspFluidDataStoreLocator = encodeOdspFluidDataStoreLocator;
  * @returns object representing Fluid data store location in ODSP terms
  */
 function decodeOdspFluidDataStoreLocator(encodedLocatorValue, siteOriginUrl) {
-    var _a, _b, _c;
+    var _a, _b, _c, _d;
     const locatorInfo = new URLSearchParams((0, common_utils_1.fromBase64ToUtf8)(encodedLocatorValue));
     const signatureValue = locatorInfo.get(fluidSignatureParamName);
     if (signatureValue !== "1") {
         return undefined;
     }
-    const sitePath = locatorInfo.get(fluidSitePathParamName);
-    const driveId = locatorInfo.get(fluidDriveIdParamName);
-    const itemId = locatorInfo.get(fluidItemIdParamName);
-    const dataStorePath = locatorInfo.get(fluidDataStorePathParamName);
-    const appName = (_a = locatorInfo.get(fluidAppNameParamName)) !== null && _a !== void 0 ? _a : undefined;
-    const containerPackageName = (_b = locatorInfo.get(fluidContainerPackageNameParamName)) !== null && _b !== void 0 ? _b : undefined;
-    const fileVersion = (_c = locatorInfo.get(fluidFileVersionParamName)) !== null && _c !== void 0 ? _c : undefined;
+    const sitePath = locatorInfo.get(sitePathParamName);
+    const driveId = locatorInfo.get(driveIdParamName);
+    const itemId = locatorInfo.get(itemIdParamName);
+    const dataStorePath = locatorInfo.get(dataStorePathParamName);
+    const appName = (_a = locatorInfo.get(appNameParamName)) !== null && _a !== void 0 ? _a : undefined;
+    const containerPackageName = (_b = locatorInfo.get(containerPackageNameParamName)) !== null && _b !== void 0 ? _b : undefined;
+    const fileVersion = (_c = locatorInfo.get(fileVersionParamName)) !== null && _c !== void 0 ? _c : undefined;
+    const context = (_d = locatorInfo.get(additionalContextParamName)) !== null && _d !== void 0 ? _d : undefined;
     // "" is a valid value for dataStorePath so simply check for absence of the param;
-    // the rest of params must be present and non-empty
+    // file storage locator params must be present and non-empty
     if (!sitePath || !driveId || !itemId || dataStorePath === null) {
         return undefined;
     }
@@ -70,7 +75,7 @@ function decodeOdspFluidDataStoreLocator(encodedLocatorValue, siteOriginUrl) {
     try {
         siteUrl = new URL(sitePath, siteOriginUrl);
     }
-    catch (_d) {
+    catch (_e) {
         // Ignore failure to parse url as input might be malformed
     }
     if (!siteUrl) {
@@ -84,6 +89,7 @@ function decodeOdspFluidDataStoreLocator(encodedLocatorValue, siteOriginUrl) {
         appName,
         containerPackageName,
         fileVersion,
+        context,
     };
 }
 // This parameter is provided by host in the resolve request and it contains information about the file

package/dist/odspFluidFileLink.js.map

@@ -1 +1 @@
-{"version":3,"file":"odspFluidFileLink.js","sourceRoot":"","sources":["../src/odspFluidFileLink.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAkF;AAElF,2CAAkE;AAElE,MAAM,cAAc,GAAG,GAAG,CAAC;AAC3B,MAAM,uBAAuB,GAAG,OAAO,CAAC;AACxC,MAAM,sBAAsB,GAAG,GAAG,CAAC;AACnC,MAAM,qBAAqB,GAAG,GAAG,CAAC;AAClC,MAAM,oBAAoB,GAAG,GAAG,CAAC;AACjC,MAAM,2BAA2B,GAAG,GAAG,CAAC;AACxC,MAAM,qBAAqB,GAAG,GAAG,CAAC;AAClC,MAAM,kCAAkC,GAAG,GAAG,CAAC;AAC/C,MAAM,yBAAyB,GAAG,GAAG,CAAC;AAEtC;;;;GAIG;AACH,SAAgB,+BAA+B,CAAC,OAAkC;IAC9E,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACzC,MAAM,QAAQ,GAAG,kBAAkB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACtD,MAAM,OAAO,GAAG,kBAAkB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACpD,MAAM,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAClD,MAAM,aAAa,GAAG,kBAAkB,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IAEhE,IAAI,iBAAiB,GAAG,GAAG,sBAAsB,IAAI,QAAQ,IAAI,qBAAqB,IAAI,OAAO,IAC7F,oBAAoB,IAAI,MAAM,IAAI,2BAA2B,IAAI,aAAa,IAC9E,uBAAuB,IAAI,cAAc,EAAE,CAAC;IAChD,IAAI,OAAO,CAAC,OAAO,EAAE;QACjB,iBAAiB,IAAI,IAAI,qBAAqB,IAAI,kBAAkB,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;KAC3F;IACD,IAAI,OAAO,CAAC,oBAAoB,EAAE;QAC9B,iBAAiB,IAAI,IAAI,kCAAkC,IACvD,kBAAkB,CAAC,OAAO,CAAC,oBAAoB,CAAC,EAAE,CAAC;KAC1D;IACD,IAAI,OAAO,CAAC,WAAW,EAAE;QACrB,iBAAiB,IAAI,IAAI,yBAAyB,IAC9C,kBAAkB,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;KACjD;IAED,OAAO,IAAA,+BAAgB,EAAC,iBAAiB,CAAC,CAAC;AAC/C,CAAC;AAvBD,0EAuBC;AAED;;;;;;GAMG;AACH,SAAS,+BAA+B,CACpC,mBAA2B,EAC3B,aAAqB;;IAErB,MAAM,WAAW,GAAG,IAAI,eAAe,CAAC,IAAA,+BAAgB,EAAC,mBAAmB,CAAC,CAAC,CAAC;IAE/E,MAAM,cAAc,GAAG,WAAW,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;IAChE,IAAI,cAAc,KAAK,GAAG,EAAE;QACxB,OAAO,SAAS,CAAC;KACpB;IAED,MAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;IACzD,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;IACvD,MAAM,MAAM,GAAG,WAAW,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;IACrD,MAAM,aAAa,GAAG,WAAW,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;IACnE,MAAM,OAAO,GAAG,MAAA,WAAW,CAAC,GAAG,CAAC,qBAAqB,CAAC,mCAAI,SAAS,CAAC;IACpE,MAAM,oBAAoB,GAAG,MAAA,WAAW,CAAC,GAAG,CAAC,kCAAkC,CAAC,mCAAI,SAAS,CAAC;IAC9F,MAAM,WAAW,GAAG,MAAA,WAAW,CAAC,GAAG,CAAC,yBAAyB,CAAC,mCAAI,SAAS,CAAC;IAC5E,kFAAkF;IAClF,mDAAmD;IACnD,IAAI,CAAC,QAAQ,IAAI,CAAC,OAAO,IAAI,CAAC,MAAM,IAAI,aAAa,KAAK,IAAI,EAAE;QAC5D,OAAO,SAAS,CAAC;KACpB;IAED,IAAI,OAAwB,CAAC;IAC7B,IAAI;QACA,OAAO,GAAG,IAAI,GAAG,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;KAC9C;IAAC,WAAM;QACJ,0DAA0D;KAC7D;IAED,IAAI,CAAC,OAAO,EAAE;QACV,OAAO,SAAS,CAAC;KACpB;IAED,OAAO;QACH,OAAO,EAAE,OAAO,CAAC,IAAI;QACrB,OAAO;QACP,MAAM;QACN,aAAa;QACb,OAAO;QACP,oBAAoB;QACpB,WAAW;KACd,CAAC;AACN,CAAC;AAED,uGAAuG;AACvG,iEAAiE;AACpD,QAAA,qBAAqB,GAAG,KAAK,CAAC;AAE3C;;;;GAIG;AACH,SAAgB,qBAAqB,CAAC,GAAQ,EAAE,OAAkC;IAC9E,MAAM,mBAAmB,GAAG,+BAA+B,CAAC,OAAO,CAAC,CAAC;IACrE,0GAA0G;IAC1G,qCAAqC;IACrC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,6BAAqB,EAAE,mBAAmB,CAAC,CAAC;AACrE,CAAC;AALD,sDAKC;AAED;;;;;GAKG;AACH,SAAgB,qBAAqB,CAAC,GAAQ;IAC1C,mGAAmG;IACnG,MAAM,mBAAmB,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,6BAAqB,CAAC,CAAC;IACxE,IAAI,CAAC,mBAAmB,EAAE;QACtB,OAAO,SAAS,CAAC;KACpB;IAED,qGAAqG;IACrG,oFAAoF;IACpF,MAAM,aAAa,GAAG,GAAG,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,6BAAiB,CAAC,CAAC,CAAC,4BAAgB,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;IAErG,OAAO,+BAA+B,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAC;AAC/E,CAAC;AAZD,sDAYC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { fromBase64ToUtf8, fromUtf8ToBase64 } from \"@fluidframework/common-utils\";\nimport { OdspFluidDataStoreLocator } from \"./contractsPublic\";\nimport { OdcFileSiteOrigin, OdcApiSiteOrigin } from \"./constants\";\n\nconst fluidSignature = \"1\";\nconst fluidSignatureParamName = \"fluid\";\nconst fluidSitePathParamName = \"s\";\nconst fluidDriveIdParamName = \"d\";\nconst fluidItemIdParamName = \"f\";\nconst fluidDataStorePathParamName = \"c\";\nconst fluidAppNameParamName = \"a\";\nconst fluidContainerPackageNameParamName = \"p\";\nconst fluidFileVersionParamName = \"v\";\n\n/**\n * Transforms given Fluid data store locator into string that can be embedded into url\n * @param locator - describes Fluid data store locator info to be encoded\n * @returns string representing encoded Fluid data store locator info\n */\nexport function encodeOdspFluidDataStoreLocator(locator: OdspFluidDataStoreLocator): string {\n    const siteUrl = new URL(locator.siteUrl);\n    const sitePath = encodeURIComponent(siteUrl.pathname);\n    const driveId = encodeURIComponent(locator.driveId);\n    const itemId = encodeURIComponent(locator.itemId);\n    const dataStorePath = encodeURIComponent(locator.dataStorePath);\n\n    let locatorSerialized = `${fluidSitePathParamName}=${sitePath}&${fluidDriveIdParamName}=${driveId}&${\n        fluidItemIdParamName}=${itemId}&${fluidDataStorePathParamName}=${dataStorePath}&${\n        fluidSignatureParamName}=${fluidSignature}`;\n    if (locator.appName) {\n        locatorSerialized += `&${fluidAppNameParamName}=${encodeURIComponent(locator.appName)}`;\n    }\n    if (locator.containerPackageName) {\n        locatorSerialized += `&${fluidContainerPackageNameParamName}=${\n            encodeURIComponent(locator.containerPackageName)}`;\n    }\n    if (locator.fileVersion) {\n        locatorSerialized += `&${fluidFileVersionParamName}=${\n            encodeURIComponent(locator.fileVersion)}`;\n    }\n\n    return fromUtf8ToBase64(locatorSerialized);\n}\n\n/**\n * Decodes given encoded value representing Fluid data store locator extracted from ODSP Fluid file link\n * @param encodedLocatorValue - encoded Fluid data store locator value which was produced by\n *  encodeOdspFluidDataStoreLocator method\n * @param siteOriginUrl - site origin that will be appended to encoded relative path to form absolute file url\n * @returns object representing Fluid data store location in ODSP terms\n */\nfunction decodeOdspFluidDataStoreLocator(\n    encodedLocatorValue: string,\n    siteOriginUrl: string,\n): OdspFluidDataStoreLocator | undefined {\n    const locatorInfo = new URLSearchParams(fromBase64ToUtf8(encodedLocatorValue));\n\n    const signatureValue = locatorInfo.get(fluidSignatureParamName);\n    if (signatureValue !== \"1\") {\n        return undefined;\n    }\n\n    const sitePath = locatorInfo.get(fluidSitePathParamName);\n    const driveId = locatorInfo.get(fluidDriveIdParamName);\n    const itemId = locatorInfo.get(fluidItemIdParamName);\n    const dataStorePath = locatorInfo.get(fluidDataStorePathParamName);\n    const appName = locatorInfo.get(fluidAppNameParamName) ?? undefined;\n    const containerPackageName = locatorInfo.get(fluidContainerPackageNameParamName) ?? undefined;\n    const fileVersion = locatorInfo.get(fluidFileVersionParamName) ?? undefined;\n    // \"\" is a valid value for dataStorePath so simply check for absence of the param;\n    // the rest of params must be present and non-empty\n    if (!sitePath || !driveId || !itemId || dataStorePath === null) {\n        return undefined;\n    }\n\n    let siteUrl: URL | undefined;\n    try {\n        siteUrl = new URL(sitePath, siteOriginUrl);\n    } catch {\n        // Ignore failure to parse url as input might be malformed\n    }\n\n    if (!siteUrl) {\n        return undefined;\n    }\n\n    return {\n        siteUrl: siteUrl.href,\n        driveId,\n        itemId,\n        dataStorePath,\n        appName,\n        containerPackageName,\n        fileVersion,\n    };\n}\n\n// This parameter is provided by host in the resolve request and it contains information about the file\n// like driveId, itemId, siteUrl, datastorePath, packageName etc.\nexport const locatorQueryParamName = \"nav\";\n\n/**\n * Embeds Fluid data store locator data into given ODSP url\n * @param url - file url in ODSP format (can be either canonical or share link)\n * @param locator - object representing Fluid data store location in ODSP terms\n */\nexport function storeLocatorInOdspUrl(url: URL, locator: OdspFluidDataStoreLocator) {\n    const encodedLocatorValue = encodeOdspFluidDataStoreLocator(locator);\n    // IMPORTANT: Do not apply encodeURIComponent to encodedLocatorValue, param value is automatically encoded\n    // when set via URLSearchParams class\n    url.searchParams.set(locatorQueryParamName, encodedLocatorValue);\n}\n\n/**\n * Extract ODSP Fluid data store locator object from given ODSP url. This extracts things like\n * driveId, ItemId, siteUrl etc from a url where these are encoded in nav query param.\n * @param url - ODSP url representing Fluid file link\n * @returns object representing Fluid data store location in ODSP terms\n */\nexport function getLocatorFromOdspUrl(url: URL): OdspFluidDataStoreLocator | undefined {\n    // NOTE: No need to apply decodeURIComponent when accessing query params via URLSearchParams class.\n    const encodedLocatorValue = url.searchParams.get(locatorQueryParamName);\n    if (!encodedLocatorValue) {\n        return undefined;\n    }\n\n    // IMPORTANT: ODC deviates from ODSP in that its file link origin is different from vroom api origin.\n    // The following code passes vroom api origin as site origin instead of file origin.\n    const siteOriginUrl = url.origin.toLowerCase() === OdcFileSiteOrigin ? OdcApiSiteOrigin : url.origin;\n\n    return decodeOdspFluidDataStoreLocator(encodedLocatorValue, siteOriginUrl);\n}\n"]}
+{"version":3,"file":"odspFluidFileLink.js","sourceRoot":"","sources":["../src/odspFluidFileLink.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAkF;AAElF,2CAAkE;AAElE,MAAM,cAAc,GAAG,GAAG,CAAC;AAC3B,MAAM,uBAAuB,GAAG,OAAO,CAAC;AACxC,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAC9B,MAAM,gBAAgB,GAAG,GAAG,CAAC;AAC7B,MAAM,eAAe,GAAG,GAAG,CAAC;AAC5B,MAAM,sBAAsB,GAAG,GAAG,CAAC;AACnC,MAAM,gBAAgB,GAAG,GAAG,CAAC;AAC7B,MAAM,6BAA6B,GAAG,GAAG,CAAC;AAC1C,MAAM,oBAAoB,GAAG,GAAG,CAAC;AACjC,MAAM,0BAA0B,GAAG,GAAG,CAAC;AAEvC;;;;GAIG;AACH,SAAgB,+BAA+B,CAAC,OAAkC;IAC9E,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACzC,MAAM,QAAQ,GAAG,kBAAkB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACtD,MAAM,OAAO,GAAG,kBAAkB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACpD,MAAM,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAClD,MAAM,aAAa,GAAG,kBAAkB,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IAEhE,IAAI,iBAAiB,GAAG,GAAG,iBAAiB,IAAI,QAAQ,IAAI,gBAAgB,IAAI,OAAO,IACnF,eAAe,IAAI,MAAM,IAAI,sBAAsB,IAAI,aAAa,IACpE,uBAAuB,IAAI,cAAc,EAAE,CAAC;IAChD,IAAI,OAAO,CAAC,OAAO,EAAE;QACjB,iBAAiB,IAAI,IAAI,gBAAgB,IAAI,kBAAkB,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;KACtF;IACD,IAAI,OAAO,CAAC,oBAAoB,EAAE;QAC9B,iBAAiB,IAAI,IAAI,6BAA6B,IAAI,kBAAkB,CAAC,OAAO,CAAC,oBAAoB,CAAC,EAAE,CAAC;KAChH;IACD,IAAI,OAAO,CAAC,WAAW,EAAE;QACrB,iBAAiB,IAAI,IAAI,oBAAoB,IAAI,kBAAkB,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;KAC9F;IACD,IAAI,OAAO,CAAC,OAAO,EAAE;QACjB,iBAAiB,IAAI,IAAI,0BAA0B,IAAI,kBAAkB,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;KAChG;IAED,OAAO,IAAA,+BAAgB,EAAC,iBAAiB,CAAC,CAAC;AAC/C,CAAC;AAxBD,0EAwBC;AAED;;;;;;GAMG;AACH,SAAS,+BAA+B,CACpC,mBAA2B,EAC3B,aAAqB;;IAErB,MAAM,WAAW,GAAG,IAAI,eAAe,CAAC,IAAA,+BAAgB,EAAC,mBAAmB,CAAC,CAAC,CAAC;IAE/E,MAAM,cAAc,GAAG,WAAW,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;IAChE,IAAI,cAAc,KAAK,GAAG,EAAE;QACxB,OAAO,SAAS,CAAC;KACpB;IAED,MAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IACpD,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAClD,MAAM,MAAM,GAAG,WAAW,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IAChD,MAAM,aAAa,GAAG,WAAW,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;IAC9D,MAAM,OAAO,GAAG,MAAA,WAAW,CAAC,GAAG,CAAC,gBAAgB,CAAC,mCAAI,SAAS,CAAC;IAC/D,MAAM,oBAAoB,GAAG,MAAA,WAAW,CAAC,GAAG,CAAC,6BAA6B,CAAC,mCAAI,SAAS,CAAC;IACzF,MAAM,WAAW,GAAG,MAAA,WAAW,CAAC,GAAG,CAAC,oBAAoB,CAAC,mCAAI,SAAS,CAAC;IACvE,MAAM,OAAO,GAAG,MAAA,WAAW,CAAC,GAAG,CAAC,0BAA0B,CAAC,mCAAI,SAAS,CAAC;IACzE,kFAAkF;IAClF,4DAA4D;IAC5D,IAAI,CAAC,QAAQ,IAAI,CAAC,OAAO,IAAI,CAAC,MAAM,IAAI,aAAa,KAAK,IAAI,EAAE;QAC5D,OAAO,SAAS,CAAC;KACpB;IAED,IAAI,OAAwB,CAAC;IAC7B,IAAI;QACA,OAAO,GAAG,IAAI,GAAG,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;KAC9C;IAAC,WAAM;QACJ,0DAA0D;KAC7D;IAED,IAAI,CAAC,OAAO,EAAE;QACV,OAAO,SAAS,CAAC;KACpB;IAED,OAAO;QACH,OAAO,EAAE,OAAO,CAAC,IAAI;QACrB,OAAO;QACP,MAAM;QACN,aAAa;QACb,OAAO;QACP,oBAAoB;QACpB,WAAW;QACX,OAAO;KACV,CAAC;AACN,CAAC;AAED,uGAAuG;AACvG,iEAAiE;AACpD,QAAA,qBAAqB,GAAG,KAAK,CAAC;AAE3C;;;;GAIG;AACH,SAAgB,qBAAqB,CAAC,GAAQ,EAAE,OAAkC;IAC9E,MAAM,mBAAmB,GAAG,+BAA+B,CAAC,OAAO,CAAC,CAAC;IACrE,0GAA0G;IAC1G,qCAAqC;IACrC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,6BAAqB,EAAE,mBAAmB,CAAC,CAAC;AACrE,CAAC;AALD,sDAKC;AAED;;;;;GAKG;AACH,SAAgB,qBAAqB,CAAC,GAAQ;IAC1C,mGAAmG;IACnG,MAAM,mBAAmB,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,6BAAqB,CAAC,CAAC;IACxE,IAAI,CAAC,mBAAmB,EAAE;QACtB,OAAO,SAAS,CAAC;KACpB;IAED,qGAAqG;IACrG,oFAAoF;IACpF,MAAM,aAAa,GAAG,GAAG,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,6BAAiB,CAAC,CAAC,CAAC,4BAAgB,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;IAErG,OAAO,+BAA+B,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAC;AAC/E,CAAC;AAZD,sDAYC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { fromBase64ToUtf8, fromUtf8ToBase64 } from \"@fluidframework/common-utils\";\nimport { OdspFluidDataStoreLocator } from \"./contractsPublic\";\nimport { OdcFileSiteOrigin, OdcApiSiteOrigin } from \"./constants\";\n\nconst fluidSignature = \"1\";\nconst fluidSignatureParamName = \"fluid\";\nconst sitePathParamName = \"s\";\nconst driveIdParamName = \"d\";\nconst itemIdParamName = \"f\";\nconst dataStorePathParamName = \"c\";\nconst appNameParamName = \"a\";\nconst containerPackageNameParamName = \"p\";\nconst fileVersionParamName = \"v\";\nconst additionalContextParamName = \"x\";\n\n/**\n * Transforms given Fluid data store locator into string that can be embedded into url\n * @param locator - describes Fluid data store locator info to be encoded\n * @returns string representing encoded Fluid data store locator info\n */\nexport function encodeOdspFluidDataStoreLocator(locator: OdspFluidDataStoreLocator): string {\n    const siteUrl = new URL(locator.siteUrl);\n    const sitePath = encodeURIComponent(siteUrl.pathname);\n    const driveId = encodeURIComponent(locator.driveId);\n    const itemId = encodeURIComponent(locator.itemId);\n    const dataStorePath = encodeURIComponent(locator.dataStorePath);\n\n    let locatorSerialized = `${sitePathParamName}=${sitePath}&${driveIdParamName}=${driveId}&${\n        itemIdParamName}=${itemId}&${dataStorePathParamName}=${dataStorePath}&${\n        fluidSignatureParamName}=${fluidSignature}`;\n    if (locator.appName) {\n        locatorSerialized += `&${appNameParamName}=${encodeURIComponent(locator.appName)}`;\n    }\n    if (locator.containerPackageName) {\n        locatorSerialized += `&${containerPackageNameParamName}=${encodeURIComponent(locator.containerPackageName)}`;\n    }\n    if (locator.fileVersion) {\n        locatorSerialized += `&${fileVersionParamName}=${encodeURIComponent(locator.fileVersion)}`;\n    }\n    if (locator.context) {\n        locatorSerialized += `&${additionalContextParamName}=${encodeURIComponent(locator.context)}`;\n    }\n\n    return fromUtf8ToBase64(locatorSerialized);\n}\n\n/**\n * Decodes given encoded value representing Fluid data store locator extracted from ODSP Fluid file link\n * @param encodedLocatorValue - encoded Fluid data store locator value which was produced by\n *  encodeOdspFluidDataStoreLocator method\n * @param siteOriginUrl - site origin that will be appended to encoded relative path to form absolute file url\n * @returns object representing Fluid data store location in ODSP terms\n */\nfunction decodeOdspFluidDataStoreLocator(\n    encodedLocatorValue: string,\n    siteOriginUrl: string,\n): OdspFluidDataStoreLocator | undefined {\n    const locatorInfo = new URLSearchParams(fromBase64ToUtf8(encodedLocatorValue));\n\n    const signatureValue = locatorInfo.get(fluidSignatureParamName);\n    if (signatureValue !== \"1\") {\n        return undefined;\n    }\n\n    const sitePath = locatorInfo.get(sitePathParamName);\n    const driveId = locatorInfo.get(driveIdParamName);\n    const itemId = locatorInfo.get(itemIdParamName);\n    const dataStorePath = locatorInfo.get(dataStorePathParamName);\n    const appName = locatorInfo.get(appNameParamName) ?? undefined;\n    const containerPackageName = locatorInfo.get(containerPackageNameParamName) ?? undefined;\n    const fileVersion = locatorInfo.get(fileVersionParamName) ?? undefined;\n    const context = locatorInfo.get(additionalContextParamName) ?? undefined;\n    // \"\" is a valid value for dataStorePath so simply check for absence of the param;\n    // file storage locator params must be present and non-empty\n    if (!sitePath || !driveId || !itemId || dataStorePath === null) {\n        return undefined;\n    }\n\n    let siteUrl: URL | undefined;\n    try {\n        siteUrl = new URL(sitePath, siteOriginUrl);\n    } catch {\n        // Ignore failure to parse url as input might be malformed\n    }\n\n    if (!siteUrl) {\n        return undefined;\n    }\n\n    return {\n        siteUrl: siteUrl.href,\n        driveId,\n        itemId,\n        dataStorePath,\n        appName,\n        containerPackageName,\n        fileVersion,\n        context,\n    };\n}\n\n// This parameter is provided by host in the resolve request and it contains information about the file\n// like driveId, itemId, siteUrl, datastorePath, packageName etc.\nexport const locatorQueryParamName = \"nav\";\n\n/**\n * Embeds Fluid data store locator data into given ODSP url\n * @param url - file url in ODSP format (can be either canonical or share link)\n * @param locator - object representing Fluid data store location in ODSP terms\n */\nexport function storeLocatorInOdspUrl(url: URL, locator: OdspFluidDataStoreLocator) {\n    const encodedLocatorValue = encodeOdspFluidDataStoreLocator(locator);\n    // IMPORTANT: Do not apply encodeURIComponent to encodedLocatorValue, param value is automatically encoded\n    // when set via URLSearchParams class\n    url.searchParams.set(locatorQueryParamName, encodedLocatorValue);\n}\n\n/**\n * Extract ODSP Fluid data store locator object from given ODSP url. This extracts things like\n * driveId, ItemId, siteUrl etc from a url where these are encoded in nav query param.\n * @param url - ODSP url representing Fluid file link\n * @returns object representing Fluid data store location in ODSP terms\n */\nexport function getLocatorFromOdspUrl(url: URL): OdspFluidDataStoreLocator | undefined {\n    // NOTE: No need to apply decodeURIComponent when accessing query params via URLSearchParams class.\n    const encodedLocatorValue = url.searchParams.get(locatorQueryParamName);\n    if (!encodedLocatorValue) {\n        return undefined;\n    }\n\n    // IMPORTANT: ODC deviates from ODSP in that its file link origin is different from vroom api origin.\n    // The following code passes vroom api origin as site origin instead of file origin.\n    const siteOriginUrl = url.origin.toLowerCase() === OdcFileSiteOrigin ? OdcApiSiteOrigin : url.origin;\n\n    return decodeOdspFluidDataStoreLocator(encodedLocatorValue, siteOriginUrl);\n}\n"]}

package/dist/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/odsp-driver";
-export declare const pkgVersion = "1.1.0";
+export declare const pkgVersion = "1.2.0";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.js

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/odsp-driver";
-exports.pkgVersion = "1.1.0";
+exports.pkgVersion = "1.2.0";
 //# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,6BAA6B,CAAC;AACxC,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/odsp-driver\";\nexport const pkgVersion = \"1.1.0\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,6BAA6B,CAAC;AACxC,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/odsp-driver\";\nexport const pkgVersion = \"1.2.0\";\n"]}

package/lib/checkUrl.d.ts

@@ -5,7 +5,7 @@
 import { DriverPreCheckInfo } from "@fluidframework/driver-definitions";
 /**
  * A check that returns DriverPreCheckInfo if the URL format is likely supported by this driver.
- * Note that returning information here is NOT a full guarentee that resolve will ultimately be successsful.
+ * Note that returning information here is NOT a full guarantee that resolve will ultimately be successful.
  * Instead, this should be used as a lightweight check that can filter out easily detectable unsupported URLs
  * before the entire Fluid loading process needs to be kicked off.
  */

package/lib/checkUrl.js

@@ -5,7 +5,7 @@
 import { getLocatorFromOdspUrl } from "./odspFluidFileLink";
 /**
  * A check that returns DriverPreCheckInfo if the URL format is likely supported by this driver.
- * Note that returning information here is NOT a full guarentee that resolve will ultimately be successsful.
+ * Note that returning information here is NOT a full guarantee that resolve will ultimately be successful.
  * Instead, this should be used as a lightweight check that can filter out easily detectable unsupported URLs
  * before the entire Fluid loading process needs to be kicked off.
  */

package/lib/checkUrl.js.map

@@ -1 +1 @@
-{"version":3,"file":"checkUrl.js","sourceRoot":"","sources":["../src/checkUrl.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAE5D;;;;;GAKG;AACH,MAAM,UAAU,QAAQ,CAAC,WAAgB;IACvC,MAAM,OAAO,GAAG,qBAAqB,CAAC,WAAW,CAAC,CAAC;IAEnD,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,SAAS,CAAC;KAClB;IAED,IAAI,UAA8B,CAAC;IACnC,IAAI;QACF,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,EAAE;YACpB,UAAU,GAAG,IAAI,GAAG,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,CAAC,CAAC,MAAM,CAAC;SAC/C;KACF;IAAC,WAAM,GAAE;IAEV,OAAO;QACL,eAAe,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,oBAAoB;QAC9C,uEAAuE;QACvE,mBAAmB,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;KAC3D,CAAC;AACJ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { DriverPreCheckInfo } from \"@fluidframework/driver-definitions\";\nimport { getLocatorFromOdspUrl } from \"./odspFluidFileLink\";\n\n/**\n * A check that returns DriverPreCheckInfo if the URL format is likely supported by this driver.\n * Note that returning information here is NOT a full guarentee that resolve will ultimately be successsful.\n * Instead, this should be used as a lightweight check that can filter out easily detectable unsupported URLs\n * before the entire Fluid loading process needs to be kicked off.\n */\nexport function checkUrl(documentUrl: URL): DriverPreCheckInfo | undefined {\n  const locator = getLocatorFromOdspUrl(documentUrl);\n\n  if (!locator) {\n    return undefined;\n  }\n\n  let siteOrigin: string | undefined;\n  try {\n    if (locator?.siteUrl) {\n      siteOrigin = new URL(locator?.siteUrl).origin;\n    }\n  } catch {}\n\n  return {\n    codeDetailsHint: locator?.containerPackageName,\n    // Add the snapshot endpoint, which has the same domain as the site URL\n    criticalBootDomains: siteOrigin ? [siteOrigin] : undefined,\n  };\n}\n"]}
+{"version":3,"file":"checkUrl.js","sourceRoot":"","sources":["../src/checkUrl.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAE5D;;;;;GAKG;AACH,MAAM,UAAU,QAAQ,CAAC,WAAgB;IACvC,MAAM,OAAO,GAAG,qBAAqB,CAAC,WAAW,CAAC,CAAC;IAEnD,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,SAAS,CAAC;KAClB;IAED,IAAI,UAA8B,CAAC;IACnC,IAAI;QACF,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,EAAE;YACpB,UAAU,GAAG,IAAI,GAAG,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,CAAC,CAAC,MAAM,CAAC;SAC/C;KACF;IAAC,WAAM,GAAE;IAEV,OAAO;QACL,eAAe,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,oBAAoB;QAC9C,uEAAuE;QACvE,mBAAmB,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;KAC3D,CAAC;AACJ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { DriverPreCheckInfo } from \"@fluidframework/driver-definitions\";\nimport { getLocatorFromOdspUrl } from \"./odspFluidFileLink\";\n\n/**\n * A check that returns DriverPreCheckInfo if the URL format is likely supported by this driver.\n * Note that returning information here is NOT a full guarantee that resolve will ultimately be successful.\n * Instead, this should be used as a lightweight check that can filter out easily detectable unsupported URLs\n * before the entire Fluid loading process needs to be kicked off.\n */\nexport function checkUrl(documentUrl: URL): DriverPreCheckInfo | undefined {\n  const locator = getLocatorFromOdspUrl(documentUrl);\n\n  if (!locator) {\n    return undefined;\n  }\n\n  let siteOrigin: string | undefined;\n  try {\n    if (locator?.siteUrl) {\n      siteOrigin = new URL(locator?.siteUrl).origin;\n    }\n  } catch {}\n\n  return {\n    codeDetailsHint: locator?.containerPackageName,\n    // Add the snapshot endpoint, which has the same domain as the site URL\n    criticalBootDomains: siteOrigin ? [siteOrigin] : undefined,\n  };\n}\n"]}

package/lib/constants.d.ts

@@ -2,6 +2,6 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export declare const OdcApiSiteOrigin = "https://api.onedrive.com";
+export declare const OdcApiSiteOrigin = "https://my.microsoftpersonalcontent.com";
 export declare const OdcFileSiteOrigin = "https://1drv.ms";
 //# sourceMappingURL=constants.d.ts.map

package/lib/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,eAAO,MAAM,gBAAgB,6BAA6B,CAAC;AAC3D,eAAO,MAAM,iBAAiB,oBAAoB,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,eAAO,MAAM,gBAAgB,4CAA4C,CAAC;AAC1E,eAAO,MAAM,iBAAiB,oBAAoB,CAAC"}

package/lib/constants.js

@@ -2,6 +2,6 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export const OdcApiSiteOrigin = "https://api.onedrive.com";
+export const OdcApiSiteOrigin = "https://my.microsoftpersonalcontent.com";
 export const OdcFileSiteOrigin = "https://1drv.ms";
 //# sourceMappingURL=constants.js.map

package/lib/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,CAAC,MAAM,gBAAgB,GAAG,0BAA0B,CAAC;AAC3D,MAAM,CAAC,MAAM,iBAAiB,GAAG,iBAAiB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport const OdcApiSiteOrigin = \"https://api.onedrive.com\";\nexport const OdcFileSiteOrigin = \"https://1drv.ms\";\n"]}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,CAAC,MAAM,gBAAgB,GAAG,yCAAyC,CAAC;AAC1E,MAAM,CAAC,MAAM,iBAAiB,GAAG,iBAAiB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport const OdcApiSiteOrigin = \"https://my.microsoftpersonalcontent.com\";\nexport const OdcFileSiteOrigin = \"https://1drv.ms\";\n"]}

package/lib/contractsPublic.d.ts

@@ -8,6 +8,7 @@ export interface OdspFluidDataStoreLocator extends IOdspUrlParts {
     appName?: string;
     containerPackageName?: string;
     fileVersion?: string;
+    context?: string;
 }
 export declare enum SharingLinkHeader {
     isSharingLinkToRedeem = "isSharingLinkToRedeem"

package/lib/contractsPublic.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"contractsPublic.d.ts","sourceRoot":"","sources":["../src/contractsPublic.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAC;AAExE,MAAM,WAAW,yBAA0B,SAAQ,aAAa;IAC5D,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,oBAAY,iBAAiB;IAGzB,qBAAqB,0BAA0B;CAClD;AAED,MAAM,WAAW,kBAAkB;IAC/B,CAAC,iBAAiB,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACtD;AAED,oBAAY,qBAAqB;IAG7B,iBAAiB,wBAAwB;CAC5C;AAED,MAAM,WAAW,sBAAsB;IACnC,CAAC,qBAAqB,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAC;CACtD;AAED,OAAO,QAAQ,iCAAiC,CAAC;IAE7C,UAAiB,cAAe,SAAQ,OAAO,CAAC,kBAAkB,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC;KAAI;CAC3G"}
+{"version":3,"file":"contractsPublic.d.ts","sourceRoot":"","sources":["../src/contractsPublic.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAC;AAExE,MAAM,WAAW,yBAA0B,SAAQ,aAAa;IAC5D,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,oBAAY,iBAAiB;IAGzB,qBAAqB,0BAA0B;CAClD;AAED,MAAM,WAAW,kBAAkB;IAC/B,CAAC,iBAAiB,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACtD;AAED,oBAAY,qBAAqB;IAG7B,iBAAiB,wBAAwB;CAC5C;AAED,MAAM,WAAW,sBAAsB;IACnC,CAAC,qBAAqB,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAC;CACtD;AAED,OAAO,QAAQ,iCAAiC,CAAC;IAE7C,UAAiB,cAAe,SAAQ,OAAO,CAAC,kBAAkB,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC;KAAI;CAC3G"}

package/lib/contractsPublic.js.map

@@ -1 +1 @@
-{"version":3,"file":"contractsPublic.js","sourceRoot":"","sources":["../src/contractsPublic.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAWH,MAAM,CAAN,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IACzB,yGAAyG;IACzG,sDAAsD;IACtD,oEAA+C,CAAA;AACnD,CAAC,EAJW,iBAAiB,KAAjB,iBAAiB,QAI5B;AAMD,MAAM,CAAN,IAAY,qBAIX;AAJD,WAAY,qBAAqB;IAC7B,oGAAoG;IACpG,wGAAwG;IACxG,kEAAyC,CAAA;AAC7C,CAAC,EAJW,qBAAqB,KAArB,qBAAqB,QAIhC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IOdspUrlParts } from \"@fluidframework/odsp-driver-definitions\";\n\nexport interface OdspFluidDataStoreLocator extends IOdspUrlParts {\n    dataStorePath: string;\n    appName?: string;\n    containerPackageName?: string;\n    fileVersion?: string;\n}\n\nexport enum SharingLinkHeader {\n    // Can be used in request made to resolver, to tell the resolver that the passed in URL is a sharing link\n    // which can be redeemed at server to get permissions.\n    isSharingLinkToRedeem = \"isSharingLinkToRedeem\",\n}\n\nexport interface ISharingLinkHeader {\n    [SharingLinkHeader.isSharingLinkToRedeem]: boolean;\n}\n\nexport enum ClpCompliantAppHeader {\n    // Can be used in request made to resolver, to tell the resolver that the host app is CLP compliant.\n    // Odsp will not return Classified, labeled, or protected documents if the host app cannot support them.\n    isClpCompliantApp = \"X-CLP-Compliant-App\",\n}\n\nexport interface IClpCompliantAppHeader {\n    [ClpCompliantAppHeader.isClpCompliantApp]: boolean;\n}\n\ndeclare module \"@fluidframework/core-interfaces\" {\n    // eslint-disable-next-line @typescript-eslint/no-empty-interface\n    export interface IRequestHeader extends Partial<ISharingLinkHeader>, Partial<IClpCompliantAppHeader> { }\n}\n"]}
+{"version":3,"file":"contractsPublic.js","sourceRoot":"","sources":["../src/contractsPublic.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAYH,MAAM,CAAN,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IACzB,yGAAyG;IACzG,sDAAsD;IACtD,oEAA+C,CAAA;AACnD,CAAC,EAJW,iBAAiB,KAAjB,iBAAiB,QAI5B;AAMD,MAAM,CAAN,IAAY,qBAIX;AAJD,WAAY,qBAAqB;IAC7B,oGAAoG;IACpG,wGAAwG;IACxG,kEAAyC,CAAA;AAC7C,CAAC,EAJW,qBAAqB,KAArB,qBAAqB,QAIhC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IOdspUrlParts } from \"@fluidframework/odsp-driver-definitions\";\n\nexport interface OdspFluidDataStoreLocator extends IOdspUrlParts {\n    dataStorePath: string;\n    appName?: string;\n    containerPackageName?: string;\n    fileVersion?: string;\n    context?: string;\n}\n\nexport enum SharingLinkHeader {\n    // Can be used in request made to resolver, to tell the resolver that the passed in URL is a sharing link\n    // which can be redeemed at server to get permissions.\n    isSharingLinkToRedeem = \"isSharingLinkToRedeem\",\n}\n\nexport interface ISharingLinkHeader {\n    [SharingLinkHeader.isSharingLinkToRedeem]: boolean;\n}\n\nexport enum ClpCompliantAppHeader {\n    // Can be used in request made to resolver, to tell the resolver that the host app is CLP compliant.\n    // Odsp will not return Classified, labeled, or protected documents if the host app cannot support them.\n    isClpCompliantApp = \"X-CLP-Compliant-App\",\n}\n\nexport interface IClpCompliantAppHeader {\n    [ClpCompliantAppHeader.isClpCompliantApp]: boolean;\n}\n\ndeclare module \"@fluidframework/core-interfaces\" {\n    // eslint-disable-next-line @typescript-eslint/no-empty-interface\n    export interface IRequestHeader extends Partial<ISharingLinkHeader>, Partial<IClpCompliantAppHeader> { }\n}\n"]}

package/lib/getFileLink.js

@@ -64,10 +64,6 @@ export async function getFileLink(getToken, odspUrlParts, identityType, logger)
 }
 async function getFileLinkCore(getToken, odspUrlParts, identityType, logger) {
     const fileItem = await getFileItemLite(getToken, odspUrlParts, logger, identityType === "Consumer");
-    // ODC canonical link does not require any additional processing
-    if (identityType === "Consumer") {
-        return fileItem.webUrl;
-    }
     // ODSP link requires extra call to return link that is resistant to file being renamed or moved to different folder
     return PerformanceEvent.timedExecAsync(logger, { eventName: "odspFileLink", requestName: "getSharingLink" }, async (event) => {
         let attempts = 0;

package/lib/getFileLink.js.map

@@ -1 +1 @@
-{"version":3,"file":"getFileLink.js","sourceRoot":"","sources":["../src/getFileLink.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAC1G,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AAOrE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,WAAW,EAAE,2BAA2B,EAAE,8BAA8B,EAAE,MAAM,aAAa,CAAC;AACvG,OAAO,EAAE,UAAU,IAAI,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAE/D,2GAA2G;AAC3G,MAAM,aAAa,GAAG,IAAI,GAAG,EAA2B,CAAC;AAEzD;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC7B,QAAqD,EACrD,YAA2B,EAC3B,YAA0B,EAC1B,MAAwB;IAExB,MAAM,QAAQ,GAAG,GAAG,YAAY,CAAC,OAAO,IAAI,YAAY,CAAC,OAAO,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;IAC1F,MAAM,uBAAuB,GAAG,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC5D,IAAI,uBAAuB,KAAK,SAAS,EAAE;QACvC,OAAO,uBAAuB,CAAC;KAClC;IAED,MAAM,cAAc,GAAG,KAAK;;QACxB,IAAI,MAA0B,CAAC;QAC/B,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,IAAI,YAAY,GAAG,IAAI,CAAC;QACxB,GAAG;YACC,IAAI;gBACA,MAAM,GAAG,MAAM,eAAe,CAAC,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;gBAC7E,OAAO,GAAG,IAAI,CAAC;aAClB;YAAC,OAAO,GAAG,EAAE;gBACV,0CAA0C;gBAC1C,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE;oBACvB,kDAAkD;oBAClD,aAAa,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;oBAC/B,MAAM,GAAG,CAAC;iBACb;gBACD,sFAAsF;gBACtF,0FAA0F;gBAC1F,YAAY,GAAG,MAAA,sBAAsB,CAAC,GAAG,CAAC,mCAAI,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;gBAC/E,MAAM,KAAK,CAAC,YAAY,CAAC,CAAC;aAC7B;SACJ,QAAQ,CAAC,OAAO,EAAE;QAEnB,6GAA6G;QAC7G,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAC7F,OAAO,MAAM,CAAC;IAClB,CAAC,CAAC;IACF,MAAM,QAAQ,GAAG,cAAc,EAAE,CAAC;IAClC,aAAa,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACtC,OAAO,QAAQ,CAAC;AACpB,CAAC;AAED,KAAK,UAAU,eAAe,CAC1B,QAAqD,EACrD,YAA2B,EAC3B,YAA0B,EAC1B,MAAwB;IAExB,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,KAAK,UAAU,CAAC,CAAC;IAEpG,gEAAgE;IAChE,IAAI,YAAY,KAAK,UAAU,EAAE;QAC7B,OAAO,QAAQ,CAAC,MAAM,CAAC;KAC1B;IAED,oHAAoH;IACpH,OAAO,gBAAgB,CAAC,cAAc,CAClC,MAAM,EACN,EAAE,SAAS,EAAE,cAAc,EAAE,WAAW,EAAE,gBAAgB,EAAE,EAC5D,KAAK,EAAE,KAAK,EAAE,EAAE;QACZ,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,IAAI,eAAe,CAAC;QACpB,MAAM,QAAQ,GAAG,MAAM,2BAA2B,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;;YACjE,QAAQ,EAAE,CAAC;YACX,MAAM,mBAAmB,GAAG,8BAA8B,CACtD,MAAM,EACN,YAAY,EACZ,QAAQ,EACR,IAAI,CAAC,sBAAsB,CAC9B,CAAC;YACF,MAAM,YAAY,GAAG,MAAM,mBAAmB,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;YAC3E,MAAM,CAAC,YAAY,KAAK,IAAI,EACxB,KAAK,CAAC,wFAAwF,CAAC,CAAC;YAEpG,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,wBAAwB,CAC7C,GAAG,YAAY,CAAC,OAAO,4DACnB,kBAAkB,CAAC,IAAI,IAAI,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,QAAQ,GAAG,CAClE,EAAE,EACF,YAAY,EACZ,KAAK,CACR,CAAC;YACF,MAAM,WAAW,GAAG;gBAChB,MAAM,EAAE,MAAM;gBACd,OAAO,kBACH,cAAc,EAAE,gCAAgC,EAChD,QAAQ,EAAE,gCAAgC,IACvC,OAAO,CACb;aACJ,CAAC;YACF,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;YACrD,eAAe,GAAG,QAAQ,CAAC,UAAU,CAAC;YAEtC,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YAClD,MAAM,UAAU,GAAG,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,CAAC,0CAAE,UAAU,CAAC;YAC9C,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;gBAChC,sDAAsD;gBACtD,MAAM,IAAI,iBAAiB,CACvB,mCAAmC,EACnC,eAAe,CAAC,uBAAuB,EACvC,EAAE,aAAa,EAAE,CAAC,CAAC;aAC1B;YACD,OAAO,UAAU,CAAC;QACtB,CAAC,CAAC,CAAC;QACH,KAAK,CAAC,GAAG,iCAAM,eAAe,KAAE,QAAQ,IAAG,CAAC;QAC5C,OAAO,QAAQ,CAAC;IACpB,CAAC,CACJ,CAAC;AACN,CAAC;AAUD,MAAM,cAAc,GAAG,CAAC,iBAAsB,EAAqC,EAAE;IACjF,IAAI,OAAO,iBAAiB,CAAC,MAAM,KAAK,QAAQ,IAAI,OAAO,iBAAiB,CAAC,SAAS,KAAK,QAAQ,EAAE;QACjG,OAAO,KAAK,CAAC;KAChB;IACD,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAEF,KAAK,UAAU,eAAe,CAC1B,QAAqD,EACrD,YAA2B,EAC3B,MAAwB,EACxB,sCAA+C;IAE/C,OAAO,gBAAgB,CAAC,cAAc,CAClC,MAAM,EACN,EAAE,SAAS,EAAE,cAAc,EAAE,WAAW,EAAE,iBAAiB,EAAE,EAC7D,KAAK,EAAE,KAAK,EAAE,EAAE;QACZ,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,IAAI,eAAe,CAAC;QACpB,MAAM,QAAQ,GAAG,MAAM,2BAA2B,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YACjE,QAAQ,EAAE,CAAC;YACX,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,YAAY,CAAC;YAClD,MAAM,mBAAmB,GAAG,8BAA8B,CACtD,MAAM,EACN,YAAY,EACZ,QAAQ,EACR,IAAI,CAAC,sBAAsB,CAC9B,CAAC;YACF,MAAM,YAAY,GAAG,MAAM,mBAAmB,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;YAC3E,MAAM,CAAC,YAAY,KAAK,IAAI,EACxB,KAAK,CAAC,uFAAuF,CAAC,CAAC;YAEnG,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,wBAAwB,CAC7C,GAAG,OAAO,qBAAqB,OAAO,UAAU,MAAM,0BAA0B,EAChF,YAAY,EACZ,sCAAsC,CACzC,CAAC;YACF,MAAM,WAAW,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;YAC/C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;YACrD,eAAe,GAAG,QAAQ,CAAC,UAAU,CAAC;YAEtC,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YACnD,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,EAAE;gBAC/B,sDAAsD;gBACtD,MAAM,IAAI,iBAAiB,CACvB,oCAAoC,EACpC,eAAe,CAAC,uBAAuB,EACvC,EAAE,aAAa,EAAE,CAAC,CAAC;aAC1B;YACD,OAAO,YAAY,CAAC;QACxB,CAAC,CAAC,CAAC;QACH,KAAK,CAAC,GAAG,iCAAM,eAAe,KAAE,QAAQ,IAAG,CAAC;QAC5C,OAAO,QAAQ,CAAC;IACpB,CAAC,CACJ,CAAC;AACN,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, delay } from \"@fluidframework/common-utils\";\nimport { canRetryOnError, getRetryDelayFromError, NonRetryableError } from \"@fluidframework/driver-utils\";\nimport { PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport { DriverErrorType } from \"@fluidframework/driver-definitions\";\nimport {\n    IOdspUrlParts,\n    OdspResourceTokenFetchOptions,\n    IdentityType,\n    TokenFetcher,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { getUrlAndHeadersWithAuth } from \"./getUrlAndHeadersWithAuth\";\nimport { fetchHelper, getWithRetryForTokenRefresh, toInstrumentedOdspTokenFetcher } from \"./odspUtils\";\nimport { pkgVersion as driverVersion } from \"./packageVersion\";\n\n// Store cached responses for the lifetime of web session as file link remains the same for given file item\nconst fileLinkCache = new Map<string, Promise<string>>();\n\n/**\n * Returns file link for a file with given drive and item ids.\n * Scope needed: files.readwrite.all.\n * This function keeps retrying if it gets a retriable error or wait for some delay if it gets a\n * throttling error. In future, we are thinking of app allowing to pass some cancel token, with which\n * we would be able to stop retrying.\n * @param getToken - used to fetch access tokens needed to execute operation\n * @param siteUrl - url of the site that contains the file\n * @param driveId - drive where file is stored\n * @param itemId - file id\n * @param identityType - type of client account\n * @param logger - used to log results of operation, including any error\n * @returns Promise which resolves to file link url when successful; otherwise, undefined.\n */\nexport async function getFileLink(\n    getToken: TokenFetcher<OdspResourceTokenFetchOptions>,\n    odspUrlParts: IOdspUrlParts,\n    identityType: IdentityType,\n    logger: ITelemetryLogger,\n): Promise<string> {\n    const cacheKey = `${odspUrlParts.siteUrl}_${odspUrlParts.driveId}_${odspUrlParts.itemId}`;\n    const maybeFileLinkCacheEntry = fileLinkCache.get(cacheKey);\n    if (maybeFileLinkCacheEntry !== undefined) {\n        return maybeFileLinkCacheEntry;\n    }\n\n    const valueGenerator = async function() {\n        let result: string | undefined;\n        let success = false;\n        let retryAfterMs = 1000;\n        do {\n            try {\n                result = await getFileLinkCore(getToken, odspUrlParts, identityType, logger);\n                success = true;\n            } catch (err) {\n                // If it is not retriable, then just throw\n                if (!canRetryOnError(err)) {\n                    // Delete from the cache to permit retrying later.\n                    fileLinkCache.delete(cacheKey);\n                    throw err;\n                }\n                // If the error is throttling error, then wait for the specified time before retrying.\n                // If the waitTime is not specified, then we start with retrying immediately to max of 8s.\n                retryAfterMs = getRetryDelayFromError(err) ?? Math.min(retryAfterMs * 2, 8000);\n                await delay(retryAfterMs);\n            }\n        } while (!success);\n\n        // We are guaranteed to run the getFileLinkCore at least once with successful result (which must be a string)\n        assert(result !== undefined, 0x292 /* \"Unexpected undefined result from getFileLinkCore\" */);\n        return result;\n    };\n    const fileLink = valueGenerator();\n    fileLinkCache.set(cacheKey, fileLink);\n    return fileLink;\n}\n\nasync function getFileLinkCore(\n    getToken: TokenFetcher<OdspResourceTokenFetchOptions>,\n    odspUrlParts: IOdspUrlParts,\n    identityType: IdentityType,\n    logger: ITelemetryLogger,\n): Promise<string> {\n    const fileItem = await getFileItemLite(getToken, odspUrlParts, logger, identityType === \"Consumer\");\n\n    // ODC canonical link does not require any additional processing\n    if (identityType === \"Consumer\") {\n        return fileItem.webUrl;\n    }\n\n    // ODSP link requires extra call to return link that is resistant to file being renamed or moved to different folder\n    return PerformanceEvent.timedExecAsync(\n        logger,\n        { eventName: \"odspFileLink\", requestName: \"getSharingLink\" },\n        async (event) => {\n            let attempts = 0;\n            let additionalProps;\n            const fileLink = await getWithRetryForTokenRefresh(async (options) => {\n                attempts++;\n                const storageTokenFetcher = toInstrumentedOdspTokenFetcher(\n                    logger,\n                    odspUrlParts,\n                    getToken,\n                    true /* throwOnNullToken */,\n                );\n                const storageToken = await storageTokenFetcher(options, \"GetFileLinkCore\");\n                assert(storageToken !== null,\n                    0x2bb /* \"Instrumented token fetcher with throwOnNullToken = true should never return null\" */);\n\n                const { url, headers } = getUrlAndHeadersWithAuth(\n                    `${odspUrlParts.siteUrl}/_api/web/GetFileByServerRelativeUrl(@a1)/Linkingurl?@a1=${\n                        encodeURIComponent(`'${new URL(fileItem.webDavUrl).pathname}'`)\n                    }`,\n                    storageToken,\n                    false,\n                );\n                const requestInit = {\n                    method: \"POST\",\n                    headers: {\n                        \"Content-Type\": \"application/json;odata=verbose\",\n                        \"Accept\": \"application/json;odata=verbose\",\n                        ...headers,\n                    },\n                };\n                const response = await fetchHelper(url, requestInit);\n                additionalProps = response.propsToLog;\n\n                const sharingInfo = await response.content.json();\n                const linkingUrl = sharingInfo?.d?.LinkingUrl;\n                if (typeof linkingUrl !== \"string\") {\n                    // This will retry once in getWithRetryForTokenRefresh\n                    throw new NonRetryableError(\n                        \"Malformed GetSharingLink response\",\n                        DriverErrorType.incorrectServerResponse,\n                        { driverVersion });\n                }\n                return linkingUrl;\n            });\n            event.end({ ...additionalProps, attempts });\n            return fileLink;\n        },\n    );\n}\n\n/**\n * This represents a lite version of file item containing only the webUrl and webDavUrl properties\n */\ninterface FileItemLite {\n    webUrl: string;\n    webDavUrl: string;\n}\n\nconst isFileItemLite = (maybeFileItemLite: any): maybeFileItemLite is FileItemLite => {\n    if (typeof maybeFileItemLite.webUrl !== \"string\" || typeof maybeFileItemLite.webDavUrl !== \"string\") {\n        return false;\n    }\n    return true;\n};\n\nasync function getFileItemLite(\n    getToken: TokenFetcher<OdspResourceTokenFetchOptions>,\n    odspUrlParts: IOdspUrlParts,\n    logger: ITelemetryLogger,\n    forceAccessTokenViaAuthorizationHeader: boolean,\n): Promise<FileItemLite> {\n    return PerformanceEvent.timedExecAsync(\n        logger,\n        { eventName: \"odspFileLink\", requestName: \"getFileItemLite\" },\n        async (event) => {\n            let attempts = 0;\n            let additionalProps;\n            const fileItem = await getWithRetryForTokenRefresh(async (options) => {\n                attempts++;\n                const { siteUrl, driveId, itemId } = odspUrlParts;\n                const storageTokenFetcher = toInstrumentedOdspTokenFetcher(\n                    logger,\n                    odspUrlParts,\n                    getToken,\n                    true /* throwOnNullToken */,\n                );\n                const storageToken = await storageTokenFetcher(options, \"GetFileItemLite\");\n                assert(storageToken !== null,\n                    0x2bc /* \"Instrumented token fetcher with throwOnNullToken =true should never return null\" */);\n\n                const { url, headers } = getUrlAndHeadersWithAuth(\n                    `${siteUrl}/_api/v2.0/drives/${driveId}/items/${itemId}?select=webUrl,webDavUrl`,\n                    storageToken,\n                    forceAccessTokenViaAuthorizationHeader,\n                );\n                const requestInit = { method: \"GET\", headers };\n                const response = await fetchHelper(url, requestInit);\n                additionalProps = response.propsToLog;\n\n                const responseJson = await response.content.json();\n                if (!isFileItemLite(responseJson)) {\n                    // This will retry once in getWithRetryForTokenRefresh\n                    throw new NonRetryableError(\n                        \"Malformed getFileItemLite response\",\n                        DriverErrorType.incorrectServerResponse,\n                        { driverVersion });\n                }\n                return responseJson;\n            });\n            event.end({ ...additionalProps, attempts });\n            return fileItem;\n        },\n    );\n}\n"]}
+{"version":3,"file":"getFileLink.js","sourceRoot":"","sources":["../src/getFileLink.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAC1G,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AAOrE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,WAAW,EAAE,2BAA2B,EAAE,8BAA8B,EAAE,MAAM,aAAa,CAAC;AACvG,OAAO,EAAE,UAAU,IAAI,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAE/D,2GAA2G;AAC3G,MAAM,aAAa,GAAG,IAAI,GAAG,EAA2B,CAAC;AAEzD;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC7B,QAAqD,EACrD,YAA2B,EAC3B,YAA0B,EAC1B,MAAwB;IAExB,MAAM,QAAQ,GAAG,GAAG,YAAY,CAAC,OAAO,IAAI,YAAY,CAAC,OAAO,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;IAC1F,MAAM,uBAAuB,GAAG,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC5D,IAAI,uBAAuB,KAAK,SAAS,EAAE;QACvC,OAAO,uBAAuB,CAAC;KAClC;IAED,MAAM,cAAc,GAAG,KAAK;;QACxB,IAAI,MAA0B,CAAC;QAC/B,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,IAAI,YAAY,GAAG,IAAI,CAAC;QACxB,GAAG;YACC,IAAI;gBACA,MAAM,GAAG,MAAM,eAAe,CAAC,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;gBAC7E,OAAO,GAAG,IAAI,CAAC;aAClB;YAAC,OAAO,GAAG,EAAE;gBACV,0CAA0C;gBAC1C,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE;oBACvB,kDAAkD;oBAClD,aAAa,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;oBAC/B,MAAM,GAAG,CAAC;iBACb;gBACD,sFAAsF;gBACtF,0FAA0F;gBAC1F,YAAY,GAAG,MAAA,sBAAsB,CAAC,GAAG,CAAC,mCAAI,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;gBAC/E,MAAM,KAAK,CAAC,YAAY,CAAC,CAAC;aAC7B;SACJ,QAAQ,CAAC,OAAO,EAAE;QAEnB,6GAA6G;QAC7G,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAC7F,OAAO,MAAM,CAAC;IAClB,CAAC,CAAC;IACF,MAAM,QAAQ,GAAG,cAAc,EAAE,CAAC;IAClC,aAAa,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACtC,OAAO,QAAQ,CAAC;AACpB,CAAC;AAED,KAAK,UAAU,eAAe,CAC1B,QAAqD,EACrD,YAA2B,EAC3B,YAA0B,EAC1B,MAAwB;IAExB,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,KAAK,UAAU,CAAC,CAAC;IAEpG,oHAAoH;IACpH,OAAO,gBAAgB,CAAC,cAAc,CAClC,MAAM,EACN,EAAE,SAAS,EAAE,cAAc,EAAE,WAAW,EAAE,gBAAgB,EAAE,EAC5D,KAAK,EAAE,KAAK,EAAE,EAAE;QACZ,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,IAAI,eAAe,CAAC;QACpB,MAAM,QAAQ,GAAG,MAAM,2BAA2B,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;;YACjE,QAAQ,EAAE,CAAC;YACX,MAAM,mBAAmB,GAAG,8BAA8B,CACtD,MAAM,EACN,YAAY,EACZ,QAAQ,EACR,IAAI,CAAC,sBAAsB,CAC9B,CAAC;YACF,MAAM,YAAY,GAAG,MAAM,mBAAmB,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;YAC3E,MAAM,CAAC,YAAY,KAAK,IAAI,EACxB,KAAK,CAAC,wFAAwF,CAAC,CAAC;YAEpG,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,wBAAwB,CAC7C,GAAG,YAAY,CAAC,OAAO,4DACnB,kBAAkB,CAAC,IAAI,IAAI,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,QAAQ,GAAG,CAClE,EAAE,EACF,YAAY,EACZ,KAAK,CACR,CAAC;YACF,MAAM,WAAW,GAAG;gBAChB,MAAM,EAAE,MAAM;gBACd,OAAO,kBACH,cAAc,EAAE,gCAAgC,EAChD,QAAQ,EAAE,gCAAgC,IACvC,OAAO,CACb;aACJ,CAAC;YACF,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;YACrD,eAAe,GAAG,QAAQ,CAAC,UAAU,CAAC;YAEtC,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YAClD,MAAM,UAAU,GAAG,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,CAAC,0CAAE,UAAU,CAAC;YAC9C,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;gBAChC,sDAAsD;gBACtD,MAAM,IAAI,iBAAiB,CACvB,mCAAmC,EACnC,eAAe,CAAC,uBAAuB,EACvC,EAAE,aAAa,EAAE,CAAC,CAAC;aAC1B;YACD,OAAO,UAAU,CAAC;QACtB,CAAC,CAAC,CAAC;QACH,KAAK,CAAC,GAAG,iCAAM,eAAe,KAAE,QAAQ,IAAG,CAAC;QAC5C,OAAO,QAAQ,CAAC;IACpB,CAAC,CACJ,CAAC;AACN,CAAC;AAUD,MAAM,cAAc,GAAG,CAAC,iBAAsB,EAAqC,EAAE;IACjF,IAAI,OAAO,iBAAiB,CAAC,MAAM,KAAK,QAAQ,IAAI,OAAO,iBAAiB,CAAC,SAAS,KAAK,QAAQ,EAAE;QACjG,OAAO,KAAK,CAAC;KAChB;IACD,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAEF,KAAK,UAAU,eAAe,CAC1B,QAAqD,EACrD,YAA2B,EAC3B,MAAwB,EACxB,sCAA+C;IAE/C,OAAO,gBAAgB,CAAC,cAAc,CAClC,MAAM,EACN,EAAE,SAAS,EAAE,cAAc,EAAE,WAAW,EAAE,iBAAiB,EAAE,EAC7D,KAAK,EAAE,KAAK,EAAE,EAAE;QACZ,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,IAAI,eAAe,CAAC;QACpB,MAAM,QAAQ,GAAG,MAAM,2BAA2B,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YACjE,QAAQ,EAAE,CAAC;YACX,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,YAAY,CAAC;YAClD,MAAM,mBAAmB,GAAG,8BAA8B,CACtD,MAAM,EACN,YAAY,EACZ,QAAQ,EACR,IAAI,CAAC,sBAAsB,CAC9B,CAAC;YACF,MAAM,YAAY,GAAG,MAAM,mBAAmB,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;YAC3E,MAAM,CAAC,YAAY,KAAK,IAAI,EACxB,KAAK,CAAC,uFAAuF,CAAC,CAAC;YAEnG,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,wBAAwB,CAC7C,GAAG,OAAO,qBAAqB,OAAO,UAAU,MAAM,0BAA0B,EAChF,YAAY,EACZ,sCAAsC,CACzC,CAAC;YACF,MAAM,WAAW,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;YAC/C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;YACrD,eAAe,GAAG,QAAQ,CAAC,UAAU,CAAC;YAEtC,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YACnD,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,EAAE;gBAC/B,sDAAsD;gBACtD,MAAM,IAAI,iBAAiB,CACvB,oCAAoC,EACpC,eAAe,CAAC,uBAAuB,EACvC,EAAE,aAAa,EAAE,CAAC,CAAC;aAC1B;YACD,OAAO,YAAY,CAAC;QACxB,CAAC,CAAC,CAAC;QACH,KAAK,CAAC,GAAG,iCAAM,eAAe,KAAE,QAAQ,IAAG,CAAC;QAC5C,OAAO,QAAQ,CAAC;IACpB,CAAC,CACJ,CAAC;AACN,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, delay } from \"@fluidframework/common-utils\";\nimport { canRetryOnError, getRetryDelayFromError, NonRetryableError } from \"@fluidframework/driver-utils\";\nimport { PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport { DriverErrorType } from \"@fluidframework/driver-definitions\";\nimport {\n    IOdspUrlParts,\n    OdspResourceTokenFetchOptions,\n    IdentityType,\n    TokenFetcher,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { getUrlAndHeadersWithAuth } from \"./getUrlAndHeadersWithAuth\";\nimport { fetchHelper, getWithRetryForTokenRefresh, toInstrumentedOdspTokenFetcher } from \"./odspUtils\";\nimport { pkgVersion as driverVersion } from \"./packageVersion\";\n\n// Store cached responses for the lifetime of web session as file link remains the same for given file item\nconst fileLinkCache = new Map<string, Promise<string>>();\n\n/**\n * Returns file link for a file with given drive and item ids.\n * Scope needed: files.readwrite.all.\n * This function keeps retrying if it gets a retriable error or wait for some delay if it gets a\n * throttling error. In future, we are thinking of app allowing to pass some cancel token, with which\n * we would be able to stop retrying.\n * @param getToken - used to fetch access tokens needed to execute operation\n * @param siteUrl - url of the site that contains the file\n * @param driveId - drive where file is stored\n * @param itemId - file id\n * @param identityType - type of client account\n * @param logger - used to log results of operation, including any error\n * @returns Promise which resolves to file link url when successful; otherwise, undefined.\n */\nexport async function getFileLink(\n    getToken: TokenFetcher<OdspResourceTokenFetchOptions>,\n    odspUrlParts: IOdspUrlParts,\n    identityType: IdentityType,\n    logger: ITelemetryLogger,\n): Promise<string> {\n    const cacheKey = `${odspUrlParts.siteUrl}_${odspUrlParts.driveId}_${odspUrlParts.itemId}`;\n    const maybeFileLinkCacheEntry = fileLinkCache.get(cacheKey);\n    if (maybeFileLinkCacheEntry !== undefined) {\n        return maybeFileLinkCacheEntry;\n    }\n\n    const valueGenerator = async function() {\n        let result: string | undefined;\n        let success = false;\n        let retryAfterMs = 1000;\n        do {\n            try {\n                result = await getFileLinkCore(getToken, odspUrlParts, identityType, logger);\n                success = true;\n            } catch (err) {\n                // If it is not retriable, then just throw\n                if (!canRetryOnError(err)) {\n                    // Delete from the cache to permit retrying later.\n                    fileLinkCache.delete(cacheKey);\n                    throw err;\n                }\n                // If the error is throttling error, then wait for the specified time before retrying.\n                // If the waitTime is not specified, then we start with retrying immediately to max of 8s.\n                retryAfterMs = getRetryDelayFromError(err) ?? Math.min(retryAfterMs * 2, 8000);\n                await delay(retryAfterMs);\n            }\n        } while (!success);\n\n        // We are guaranteed to run the getFileLinkCore at least once with successful result (which must be a string)\n        assert(result !== undefined, 0x292 /* \"Unexpected undefined result from getFileLinkCore\" */);\n        return result;\n    };\n    const fileLink = valueGenerator();\n    fileLinkCache.set(cacheKey, fileLink);\n    return fileLink;\n}\n\nasync function getFileLinkCore(\n    getToken: TokenFetcher<OdspResourceTokenFetchOptions>,\n    odspUrlParts: IOdspUrlParts,\n    identityType: IdentityType,\n    logger: ITelemetryLogger,\n): Promise<string> {\n    const fileItem = await getFileItemLite(getToken, odspUrlParts, logger, identityType === \"Consumer\");\n\n    // ODSP link requires extra call to return link that is resistant to file being renamed or moved to different folder\n    return PerformanceEvent.timedExecAsync(\n        logger,\n        { eventName: \"odspFileLink\", requestName: \"getSharingLink\" },\n        async (event) => {\n            let attempts = 0;\n            let additionalProps;\n            const fileLink = await getWithRetryForTokenRefresh(async (options) => {\n                attempts++;\n                const storageTokenFetcher = toInstrumentedOdspTokenFetcher(\n                    logger,\n                    odspUrlParts,\n                    getToken,\n                    true /* throwOnNullToken */,\n                );\n                const storageToken = await storageTokenFetcher(options, \"GetFileLinkCore\");\n                assert(storageToken !== null,\n                    0x2bb /* \"Instrumented token fetcher with throwOnNullToken = true should never return null\" */);\n\n                const { url, headers } = getUrlAndHeadersWithAuth(\n                    `${odspUrlParts.siteUrl}/_api/web/GetFileByServerRelativeUrl(@a1)/Linkingurl?@a1=${\n                        encodeURIComponent(`'${new URL(fileItem.webDavUrl).pathname}'`)\n                    }`,\n                    storageToken,\n                    false,\n                );\n                const requestInit = {\n                    method: \"POST\",\n                    headers: {\n                        \"Content-Type\": \"application/json;odata=verbose\",\n                        \"Accept\": \"application/json;odata=verbose\",\n                        ...headers,\n                    },\n                };\n                const response = await fetchHelper(url, requestInit);\n                additionalProps = response.propsToLog;\n\n                const sharingInfo = await response.content.json();\n                const linkingUrl = sharingInfo?.d?.LinkingUrl;\n                if (typeof linkingUrl !== \"string\") {\n                    // This will retry once in getWithRetryForTokenRefresh\n                    throw new NonRetryableError(\n                        \"Malformed GetSharingLink response\",\n                        DriverErrorType.incorrectServerResponse,\n                        { driverVersion });\n                }\n                return linkingUrl;\n            });\n            event.end({ ...additionalProps, attempts });\n            return fileLink;\n        },\n    );\n}\n\n/**\n * This represents a lite version of file item containing only the webUrl and webDavUrl properties\n */\ninterface FileItemLite {\n    webUrl: string;\n    webDavUrl: string;\n}\n\nconst isFileItemLite = (maybeFileItemLite: any): maybeFileItemLite is FileItemLite => {\n    if (typeof maybeFileItemLite.webUrl !== \"string\" || typeof maybeFileItemLite.webDavUrl !== \"string\") {\n        return false;\n    }\n    return true;\n};\n\nasync function getFileItemLite(\n    getToken: TokenFetcher<OdspResourceTokenFetchOptions>,\n    odspUrlParts: IOdspUrlParts,\n    logger: ITelemetryLogger,\n    forceAccessTokenViaAuthorizationHeader: boolean,\n): Promise<FileItemLite> {\n    return PerformanceEvent.timedExecAsync(\n        logger,\n        { eventName: \"odspFileLink\", requestName: \"getFileItemLite\" },\n        async (event) => {\n            let attempts = 0;\n            let additionalProps;\n            const fileItem = await getWithRetryForTokenRefresh(async (options) => {\n                attempts++;\n                const { siteUrl, driveId, itemId } = odspUrlParts;\n                const storageTokenFetcher = toInstrumentedOdspTokenFetcher(\n                    logger,\n                    odspUrlParts,\n                    getToken,\n                    true /* throwOnNullToken */,\n                );\n                const storageToken = await storageTokenFetcher(options, \"GetFileItemLite\");\n                assert(storageToken !== null,\n                    0x2bc /* \"Instrumented token fetcher with throwOnNullToken =true should never return null\" */);\n\n                const { url, headers } = getUrlAndHeadersWithAuth(\n                    `${siteUrl}/_api/v2.0/drives/${driveId}/items/${itemId}?select=webUrl,webDavUrl`,\n                    storageToken,\n                    forceAccessTokenViaAuthorizationHeader,\n                );\n                const requestInit = { method: \"GET\", headers };\n                const response = await fetchHelper(url, requestInit);\n                additionalProps = response.propsToLog;\n\n                const responseJson = await response.content.json();\n                if (!isFileItemLite(responseJson)) {\n                    // This will retry once in getWithRetryForTokenRefresh\n                    throw new NonRetryableError(\n                        \"Malformed getFileItemLite response\",\n                        DriverErrorType.incorrectServerResponse,\n                        { driverVersion });\n                }\n                return responseJson;\n            });\n            event.end({ ...additionalProps, attempts });\n            return fileItem;\n        },\n    );\n}\n"]}

package/lib/localOdspDriver/localOdspDocumentService.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ITelemetryLogger } from "@fluidframework/common-definitions";
+import { IDocumentDeltaStorageService, IDocumentService, IDocumentStorageService, IResolvedUrl } from "@fluidframework/driver-definitions";
+import { IOdspResolvedUrl } from "@fluidframework/odsp-driver-definitions";
+import { IClient } from "@fluidframework/protocol-definitions";
+/**
+ * IDocumentService implementation that provides explicit snapshot to the document storage service.
+ */
+export declare class LocalOdspDocumentService implements IDocumentService {
+    private readonly odspResolvedUrl;
+    private readonly logger;
+    private readonly localSnapshot;
+    policies: {
+        storageOnly: boolean;
+    };
+    constructor(odspResolvedUrl: IOdspResolvedUrl, logger: ITelemetryLogger, localSnapshot: Uint8Array | string);
+    get resolvedUrl(): IResolvedUrl;
+    connectToStorage(): Promise<IDocumentStorageService>;
+    connectToDeltaStorage(): Promise<IDocumentDeltaStorageService>;
+    connectToDeltaStream(_client: IClient): never;
+    dispose(_error?: any): void;
+}
+//# sourceMappingURL=localOdspDocumentService.d.ts.map

package/lib/localOdspDriver/localOdspDocumentService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"localOdspDocumentService.d.ts","sourceRoot":"","sources":["../../src/localOdspDriver/localOdspDocumentService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EACH,4BAA4B,EAC5B,gBAAgB,EAChB,uBAAuB,EACvB,YAAY,EACf,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,yCAAyC,CAAC;AAC3E,OAAO,EAAE,OAAO,EAAE,MAAM,sCAAsC,CAAC;AAG/D;;GAEG;AACH,qBAAa,wBAAyB,YAAW,gBAAgB;IAIzD,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,aAAa;IAL3B,QAAQ;;MAAyB;gBAGnB,eAAe,EAAE,gBAAgB,EACjC,MAAM,EAAE,gBAAgB,EACxB,aAAa,EAAE,UAAU,GAAG,MAAM;IAGvD,IAAW,WAAW,IAAI,YAAY,CAErC;IAEY,gBAAgB,IAAI,OAAO,CAAC,uBAAuB,CAAC;IAOpD,qBAAqB,IAAI,OAAO,CAAC,4BAA4B,CAAC;IAIpE,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,KAAK;IAM7C,OAAO,CAAC,MAAM,CAAC,EAAE,GAAG,GAAG,IAAI;CAGrC"}

package/lib/localOdspDriver/localOdspDocumentService.js

@@ -0,0 +1,35 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { UsageError, EmptyDocumentDeltaStorageService } from "@fluidframework/driver-utils";
+import { LocalOdspDocumentStorageService } from "./localOdspDocumentStorageManager";
+/**
+ * IDocumentService implementation that provides explicit snapshot to the document storage service.
+ */
+export class LocalOdspDocumentService {
+    constructor(odspResolvedUrl, logger, localSnapshot) {
+        this.odspResolvedUrl = odspResolvedUrl;
+        this.logger = logger;
+        this.localSnapshot = localSnapshot;
+        this.policies = { storageOnly: true };
+    }
+    get resolvedUrl() {
+        return this.odspResolvedUrl;
+    }
+    async connectToStorage() {
+        return new LocalOdspDocumentStorageService(this.logger, this.localSnapshot);
+    }
+    async connectToDeltaStorage() {
+        return new EmptyDocumentDeltaStorageService();
+    }
+    connectToDeltaStream(_client) {
+        const toThrow = new UsageError("\"connectToDeltaStream\" is not supported by LocalOdspDocumentService");
+        this.logger.sendErrorEvent({ eventName: "UnsupportedUsage" }, toThrow);
+        throw toThrow;
+    }
+    dispose(_error) {
+        // Do nothing
+    }
+}
+//# sourceMappingURL=localOdspDocumentService.js.map

package/lib/localOdspDriver/localOdspDocumentService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"localOdspDocumentService.js","sourceRoot":"","sources":["../../src/localOdspDriver/localOdspDocumentService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AASH,OAAO,EAAE,UAAU,EAAE,gCAAgC,EAAE,MAAM,8BAA8B,CAAC;AAG5F,OAAO,EAAE,+BAA+B,EAAE,MAAM,mCAAmC,CAAC;AAEpF;;GAEG;AACH,MAAM,OAAO,wBAAwB;IAGjC,YACqB,eAAiC,EACjC,MAAwB,EACxB,aAAkC;QAFlC,oBAAe,GAAf,eAAe,CAAkB;QACjC,WAAM,GAAN,MAAM,CAAkB;QACxB,kBAAa,GAAb,aAAa,CAAqB;QALhD,aAAQ,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;IAMpC,CAAC;IAEL,IAAW,WAAW;QAClB,OAAO,IAAI,CAAC,eAAe,CAAC;IAChC,CAAC;IAEM,KAAK,CAAC,gBAAgB;QACzB,OAAO,IAAI,+BAA+B,CACtC,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,aAAa,CACrB,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,qBAAqB;QAC9B,OAAO,IAAI,gCAAgC,EAAE,CAAC;IAClD,CAAC;IAEM,oBAAoB,CAAC,OAAgB;QACxC,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,uEAAuE,CAAC,CAAC;QACxG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,kBAAkB,EAAE,EAAE,OAAO,CAAC,CAAC;QACvE,MAAM,OAAO,CAAC;IAClB,CAAC;IAEM,OAAO,CAAC,MAAY;QACvB,aAAa;IACjB,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport {\n    IDocumentDeltaStorageService,\n    IDocumentService,\n    IDocumentStorageService,\n    IResolvedUrl,\n} from \"@fluidframework/driver-definitions\";\nimport { UsageError, EmptyDocumentDeltaStorageService } from \"@fluidframework/driver-utils\";\nimport { IOdspResolvedUrl } from \"@fluidframework/odsp-driver-definitions\";\nimport { IClient } from \"@fluidframework/protocol-definitions\";\nimport { LocalOdspDocumentStorageService } from \"./localOdspDocumentStorageManager\";\n\n/**\n * IDocumentService implementation that provides explicit snapshot to the document storage service.\n */\nexport class LocalOdspDocumentService implements IDocumentService {\n    public policies = { storageOnly: true };\n\n    constructor(\n        private readonly odspResolvedUrl: IOdspResolvedUrl,\n        private readonly logger: ITelemetryLogger,\n        private readonly localSnapshot: Uint8Array | string,\n    ) { }\n\n    public get resolvedUrl(): IResolvedUrl {\n        return this.odspResolvedUrl;\n    }\n\n    public async connectToStorage(): Promise<IDocumentStorageService> {\n        return new LocalOdspDocumentStorageService(\n            this.logger,\n            this.localSnapshot,\n        );\n    }\n\n    public async connectToDeltaStorage(): Promise<IDocumentDeltaStorageService> {\n        return new EmptyDocumentDeltaStorageService();\n    }\n\n    public connectToDeltaStream(_client: IClient): never {\n        const toThrow = new UsageError(\"\\\"connectToDeltaStream\\\" is not supported by LocalOdspDocumentService\");\n        this.logger.sendErrorEvent({ eventName: \"UnsupportedUsage\" }, toThrow);\n        throw toThrow;\n    }\n\n    public dispose(_error?: any): void {\n        // Do nothing\n    }\n}\n"]}

package/lib/localOdspDriver/localOdspDocumentServiceFactory.d.ts

@@ -0,0 +1,24 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IDocumentService, IResolvedUrl } from "@fluidframework/driver-definitions";
+import { TelemetryLogger } from "@fluidframework/telemetry-utils";
+import { ISummaryTree } from "@fluidframework/protocol-definitions";
+import { ITelemetryBaseLogger } from "@fluidframework/common-definitions";
+import { ICacheAndTracker } from "../epochTracker";
+import { OdspDocumentServiceFactoryCore } from "../odspDocumentServiceFactoryCore";
+/**
+ * Factory for creating sharepoint document service with a provided snapshot.
+ * Use if you don't want to connect to any kind of external/internal storages and want to provide
+ * content directly.
+ */
+export declare class LocalOdspDocumentServiceFactory extends OdspDocumentServiceFactoryCore {
+    private readonly localSnapshot;
+    private logger;
+    constructor(localSnapshot: Uint8Array | string);
+    private throwUnsupportedUsageError;
+    createContainer(_createNewSummary: ISummaryTree | undefined, _createNewResolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, _clientIsSummarizer?: boolean): never;
+    protected createDocumentServiceCore(resolvedUrl: IResolvedUrl, odspLogger: TelemetryLogger, _cacheAndTrackerArg?: ICacheAndTracker, _clientIsSummarizer?: boolean): Promise<IDocumentService>;
+}
+//# sourceMappingURL=localOdspDocumentServiceFactory.d.ts.map

package/lib/localOdspDriver/localOdspDocumentServiceFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"localOdspDocumentServiceFactory.d.ts","sourceRoot":"","sources":["../../src/localOdspDriver/localOdspDocumentServiceFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAEpF,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAE1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,8BAA8B,EAAE,MAAM,mCAAmC,CAAC;AAGnF;;;;GAIG;AACH,qBAAa,+BAAgC,SAAQ,8BAA8B;IAI3E,OAAO,CAAC,QAAQ,CAAC,aAAa;IAHlC,OAAO,CAAC,MAAM,CAA8B;gBAGvB,aAAa,EAAE,UAAU,GAAG,MAAM;IASvD,OAAO,CAAC,0BAA0B;IAO3B,eAAe,CAClB,iBAAiB,EAAE,YAAY,GAAG,SAAS,EAC3C,qBAAqB,EAAE,YAAY,EACnC,MAAM,CAAC,EAAE,oBAAoB,EAC7B,mBAAmB,CAAC,EAAE,OAAO,GAC9B,KAAK;cAMQ,yBAAyB,CACrC,WAAW,EAAE,YAAY,EACzB,UAAU,EAAE,eAAe,EAC3B,mBAAmB,CAAC,EAAE,gBAAgB,EACtC,mBAAmB,CAAC,EAAE,OAAO,GAC9B,OAAO,CAAC,gBAAgB,CAAC;CAU/B"}

package/lib/localOdspDriver/localOdspDocumentServiceFactory.js

@@ -0,0 +1,41 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { UsageError } from "@fluidframework/driver-utils";
+import { createOdspLogger, getOdspResolvedUrl } from "../odspUtils";
+import { OdspDocumentServiceFactoryCore } from "../odspDocumentServiceFactoryCore";
+import { LocalOdspDocumentService } from "./localOdspDocumentService";
+/**
+ * Factory for creating sharepoint document service with a provided snapshot.
+ * Use if you don't want to connect to any kind of external/internal storages and want to provide
+ * content directly.
+ */
+export class LocalOdspDocumentServiceFactory extends OdspDocumentServiceFactoryCore {
+    constructor(localSnapshot) {
+        super((_options) => this.throwUnsupportedUsageError("Getting storage token"), (_options) => this.throwUnsupportedUsageError("Getting websocket token"), () => this.throwUnsupportedUsageError("Getting SocketIO Client"));
+        this.localSnapshot = localSnapshot;
+    }
+    throwUnsupportedUsageError(unsupportedFuncName) {
+        var _a;
+        const toThrow = new UsageError(`${unsupportedFuncName} is not supported by LocalOdspDocumentServiceFactory`);
+        (_a = this.logger) === null || _a === void 0 ? void 0 : _a.sendErrorEvent({ eventName: "UnsupportedUsage" }, toThrow);
+        throw toThrow;
+    }
+    createContainer(_createNewSummary, _createNewResolvedUrl, logger, _clientIsSummarizer) {
+        const toThrow = new UsageError("\"createContainer\" is not supported by LocalOdspDocumentServiceFactory");
+        createOdspLogger(logger).sendErrorEvent({ eventName: "UnsupportedUsage" }, toThrow);
+        throw toThrow;
+    }
+    async createDocumentServiceCore(resolvedUrl, odspLogger, _cacheAndTrackerArg, _clientIsSummarizer) {
+        if (_cacheAndTrackerArg !== undefined) {
+            throw new UsageError("Invalid usage. \"_cacheAndTrackerArg\" should not be provided");
+        }
+        if (_clientIsSummarizer) {
+            throw new UsageError("Invalid usage. \"_clientIsSummarizer\" should not be provided");
+        }
+        this.logger = odspLogger;
+        return new LocalOdspDocumentService(getOdspResolvedUrl(resolvedUrl), odspLogger, this.localSnapshot);
+    }
+}
+//# sourceMappingURL=localOdspDocumentServiceFactory.js.map

package/lib/localOdspDriver/localOdspDocumentServiceFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"localOdspDocumentServiceFactory.js","sourceRoot":"","sources":["../../src/localOdspDriver/localOdspDocumentServiceFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAI1D,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAEpE,OAAO,EAAE,8BAA8B,EAAE,MAAM,mCAAmC,CAAC;AACnF,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAEtE;;;;GAIG;AACH,MAAM,OAAO,+BAAgC,SAAQ,8BAA8B;IAG/E,YACqB,aAAkC;QAEnD,KAAK,CACD,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,0BAA0B,CAAC,uBAAuB,CAAC,EACtE,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,0BAA0B,CAAC,yBAAyB,CAAC,EACxE,GAAG,EAAE,CAAC,IAAI,CAAC,0BAA0B,CAAC,yBAAyB,CAAC,CACnE,CAAC;QANe,kBAAa,GAAb,aAAa,CAAqB;IAOvD,CAAC;IAEO,0BAA0B,CAAC,mBAA2B;;QAC1D,MAAM,OAAO,GAAG,IAAI,UAAU,CAC1B,GAAG,mBAAmB,sDAAsD,CAAC,CAAC;QAClF,MAAA,IAAI,CAAC,MAAM,0CAAE,cAAc,CAAC,EAAE,SAAS,EAAE,kBAAkB,EAAE,EAAE,OAAO,CAAC,CAAC;QACxE,MAAM,OAAO,CAAC;IAClB,CAAC;IAEM,eAAe,CAClB,iBAA2C,EAC3C,qBAAmC,EACnC,MAA6B,EAC7B,mBAA6B;QAE7B,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,yEAAyE,CAAC,CAAC;QAC1G,gBAAgB,CAAC,MAAM,CAAC,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,kBAAkB,EAAE,EAAE,OAAO,CAAC,CAAC;QACpF,MAAM,OAAO,CAAC;IAClB,CAAC;IAES,KAAK,CAAC,yBAAyB,CACrC,WAAyB,EACzB,UAA2B,EAC3B,mBAAsC,EACtC,mBAA6B;QAE7B,IAAI,mBAAmB,KAAK,SAAS,EAAE;YACnC,MAAM,IAAI,UAAU,CAAC,+DAA+D,CAAC,CAAC;SACzF;QACD,IAAI,mBAAmB,EAAE;YACrB,MAAM,IAAI,UAAU,CAAC,+DAA+D,CAAC,CAAC;SACzF;QACD,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC;QACzB,OAAO,IAAI,wBAAwB,CAAC,kBAAkB,CAAC,WAAW,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;IACzG,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDocumentService, IResolvedUrl } from \"@fluidframework/driver-definitions\";\nimport { UsageError } from \"@fluidframework/driver-utils\";\nimport { TelemetryLogger } from \"@fluidframework/telemetry-utils\";\nimport { ISummaryTree } from \"@fluidframework/protocol-definitions\";\nimport { ITelemetryBaseLogger } from \"@fluidframework/common-definitions\";\nimport { createOdspLogger, getOdspResolvedUrl } from \"../odspUtils\";\nimport { ICacheAndTracker } from \"../epochTracker\";\nimport { OdspDocumentServiceFactoryCore } from \"../odspDocumentServiceFactoryCore\";\nimport { LocalOdspDocumentService } from \"./localOdspDocumentService\";\n\n/**\n * Factory for creating sharepoint document service with a provided snapshot.\n * Use if you don't want to connect to any kind of external/internal storages and want to provide\n * content directly.\n */\nexport class LocalOdspDocumentServiceFactory extends OdspDocumentServiceFactoryCore {\n    private logger: TelemetryLogger | undefined;\n\n    constructor(\n        private readonly localSnapshot: Uint8Array | string,\n    ) {\n        super(\n            (_options) => this.throwUnsupportedUsageError(\"Getting storage token\"),\n            (_options) => this.throwUnsupportedUsageError(\"Getting websocket token\"),\n            () => this.throwUnsupportedUsageError(\"Getting SocketIO Client\"),\n        );\n    }\n\n    private throwUnsupportedUsageError(unsupportedFuncName: string): never {\n        const toThrow = new UsageError(\n            `${unsupportedFuncName} is not supported by LocalOdspDocumentServiceFactory`);\n        this.logger?.sendErrorEvent({ eventName: \"UnsupportedUsage\" }, toThrow);\n        throw toThrow;\n    }\n\n    public createContainer(\n        _createNewSummary: ISummaryTree | undefined,\n        _createNewResolvedUrl: IResolvedUrl,\n        logger?: ITelemetryBaseLogger,\n        _clientIsSummarizer?: boolean,\n    ): never {\n        const toThrow = new UsageError(\"\\\"createContainer\\\" is not supported by LocalOdspDocumentServiceFactory\");\n        createOdspLogger(logger).sendErrorEvent({ eventName: \"UnsupportedUsage\" }, toThrow);\n        throw toThrow;\n    }\n\n    protected async createDocumentServiceCore(\n        resolvedUrl: IResolvedUrl,\n        odspLogger: TelemetryLogger,\n        _cacheAndTrackerArg?: ICacheAndTracker,\n        _clientIsSummarizer?: boolean,\n    ): Promise<IDocumentService> {\n        if (_cacheAndTrackerArg !== undefined) {\n            throw new UsageError(\"Invalid usage. \\\"_cacheAndTrackerArg\\\" should not be provided\");\n        }\n        if (_clientIsSummarizer) {\n            throw new UsageError(\"Invalid usage. \\\"_clientIsSummarizer\\\" should not be provided\");\n        }\n        this.logger = odspLogger;\n        return new LocalOdspDocumentService(getOdspResolvedUrl(resolvedUrl), odspLogger, this.localSnapshot);\n    }\n}\n"]}

package/lib/localOdspDriver/localOdspDocumentStorageManager.d.ts

@@ -0,0 +1,27 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ITelemetryLogger } from "@fluidframework/common-definitions";
+import { ISummaryContext } from "@fluidframework/driver-definitions";
+import * as api from "@fluidframework/protocol-definitions";
+import { OdspDocumentStorageServiceBase } from "../odspDocumentStorageServiceBase";
+/**
+ * ODSP document storage service that works on a provided snapshot for all its processing.
+ * Attempting to use unsupported actions/methods will result in errors being thrown.
+ */
+export declare class LocalOdspDocumentStorageService extends OdspDocumentStorageServiceBase {
+    private readonly logger;
+    private readonly localSnapshot;
+    private snapshotTreeId;
+    constructor(logger: ITelemetryLogger, localSnapshot: Uint8Array | string);
+    private calledGetVersions;
+    getVersions(blobid: string | null, count: number, _scenarioName?: string): Promise<api.IVersion[]>;
+    private getSnapshotVersion;
+    protected fetchTreeFromSnapshot(_id: string, _scenarioName?: string): never;
+    protected fetchBlobFromStorage(_blobId: string, _evicted: boolean): never;
+    uploadSummaryWithContext(_summary: api.ISummaryTree, _context: ISummaryContext): never;
+    createBlob(_file: ArrayBufferLike): never;
+    private throwUsageError;
+}
+//# sourceMappingURL=localOdspDocumentStorageManager.d.ts.map

package/lib/localOdspDriver/localOdspDocumentStorageManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"localOdspDocumentStorageManager.d.ts","sourceRoot":"","sources":["../../src/localOdspDriver/localOdspDocumentStorageManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AAErE,OAAO,KAAK,GAAG,MAAM,sCAAsC,CAAC;AAC5D,OAAO,EAAE,8BAA8B,EAAE,MAAM,mCAAmC,CAAC;AAOnF;;;GAGG;AACH,qBAAa,+BAAgC,SAAQ,8BAA8B;IAI3E,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,aAAa;IAJlC,OAAO,CAAC,cAAc,CAAqB;gBAGtB,MAAM,EAAE,gBAAgB,EACxB,aAAa,EAAE,UAAU,GAAG,MAAM;IAKvD,OAAO,CAAC,iBAAiB,CAAS;IAErB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;IAwB/G,OAAO,CAAC,kBAAkB;IAI1B,SAAS,CAAC,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,KAAK;IAI3E,SAAS,CAAC,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,GAAG,KAAK;IAIlE,wBAAwB,CAAC,QAAQ,EAAE,GAAG,CAAC,YAAY,EAAE,QAAQ,EAAE,eAAe,GAAG,KAAK;IAItF,UAAU,CAAC,KAAK,EAAE,eAAe,GAAG,KAAK;IAIhD,OAAO,CAAC,eAAe;CAK1B"}

package/lib/localOdspDriver/localOdspDocumentStorageManager.js

@@ -0,0 +1,62 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { assert } from "@fluidframework/common-utils";
+import { UsageError } from "@fluidframework/driver-utils";
+import { OdspDocumentStorageServiceBase } from "../odspDocumentStorageServiceBase";
+import { convertOdspSnapshotToSnapshotTreeAndBlobs } from "../odspSnapshotParser";
+import { parseCompactSnapshotResponse } from "../compactSnapshotParser";
+import { ReadBuffer } from "../ReadBufferUtils";
+/**
+ * ODSP document storage service that works on a provided snapshot for all its processing.
+ * Attempting to use unsupported actions/methods will result in errors being thrown.
+ */
+export class LocalOdspDocumentStorageService extends OdspDocumentStorageServiceBase {
+    constructor(logger, localSnapshot) {
+        super();
+        this.logger = logger;
+        this.localSnapshot = localSnapshot;
+        this.calledGetVersions = false;
+    }
+    async getVersions(blobid, count, _scenarioName) {
+        assert(blobid === null, 0x342 /* Invalid usage. "blobid" should always be null */);
+        assert(count === 1, 0x343 /* Invalid usage. "count" should always be 1 */);
+        // No reason to re-parse the data since it will never change
+        if (this.calledGetVersions) {
+            return this.getSnapshotVersion();
+        }
+        this.calledGetVersions = true;
+        let snapshotContents;
+        if (typeof this.localSnapshot === "string") {
+            const content = JSON.parse(this.localSnapshot);
+            snapshotContents = convertOdspSnapshotToSnapshotTreeAndBlobs(content);
+        }
+        else {
+            snapshotContents = parseCompactSnapshotResponse(new ReadBuffer(this.localSnapshot));
+        }
+        this.snapshotTreeId = this.initializeFromSnapshot(snapshotContents);
+        return this.getSnapshotVersion();
+    }
+    getSnapshotVersion() {
+        return this.snapshotTreeId ? [{ id: this.snapshotTreeId, treeId: undefined }] : [];
+    }
+    fetchTreeFromSnapshot(_id, _scenarioName) {
+        this.throwUsageError("fetchTreeFromSnapshot");
+    }
+    fetchBlobFromStorage(_blobId, _evicted) {
+        this.throwUsageError("fetchBlobFromStorage");
+    }
+    uploadSummaryWithContext(_summary, _context) {
+        this.throwUsageError("uploadSummaryWithContext");
+    }
+    createBlob(_file) {
+        this.throwUsageError("createBlob");
+    }
+    throwUsageError(methodName) {
+        const toThrow = new UsageError(`"${methodName}" is not supported by LocalOdspDocumentStorageService`);
+        this.logger.sendErrorEvent({ eventName: "UnsupportedUsage" }, toThrow);
+        throw toThrow;
+    }
+}
+//# sourceMappingURL=localOdspDocumentStorageManager.js.map