@fluidframework/odsp-driver 1.1.0 → 1.2.0

package/lib/odspFluidFileLink.js

@@ -6,13 +6,14 @@ import { fromBase64ToUtf8, fromUtf8ToBase64 } from "@fluidframework/common-utils
 import { OdcFileSiteOrigin, OdcApiSiteOrigin } from "./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
@@ -24,15 +25,18 @@ export 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 fromUtf8ToBase64(locatorSerialized);
 }
@@ -44,21 +48,22 @@ export function encodeOdspFluidDataStoreLocator(locator) {
  * @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(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;
     }
@@ -66,7 +71,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) {
@@ -80,6 +85,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/lib/odspFluidFileLink.js.map

@@ -1 +1 @@
-{"version":3,"file":"odspFluidFileLink.js","sourceRoot":"","sources":["../src/odspFluidFileLink.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAElF,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;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,MAAM,UAAU,+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,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;AAC/C,CAAC;AAED;;;;;;GAMG;AACH,SAAS,+BAA+B,CACpC,mBAA2B,EAC3B,aAAqB;;IAErB,MAAM,WAAW,GAAG,IAAI,eAAe,CAAC,gBAAgB,CAAC,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;AACjE,MAAM,CAAC,MAAM,qBAAqB,GAAG,KAAK,CAAC;AAE3C;;;;GAIG;AACH,MAAM,UAAU,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,qBAAqB,EAAE,mBAAmB,CAAC,CAAC;AACrE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CAAC,GAAQ;IAC1C,mGAAmG;IACnG,MAAM,mBAAmB,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,qBAAqB,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,iBAAiB,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;IAErG,OAAO,+BAA+B,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAC;AAC/E,CAAC","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,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAElF,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;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,MAAM,UAAU,+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,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;AAC/C,CAAC;AAED;;;;;;GAMG;AACH,SAAS,+BAA+B,CACpC,mBAA2B,EAC3B,aAAqB;;IAErB,MAAM,WAAW,GAAG,IAAI,eAAe,CAAC,gBAAgB,CAAC,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;AACjE,MAAM,CAAC,MAAM,qBAAqB,GAAG,KAAK,CAAC;AAE3C;;;;GAIG;AACH,MAAM,UAAU,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,qBAAqB,EAAE,mBAAmB,CAAC,CAAC;AACrE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CAAC,GAAQ;IAC1C,mGAAmG;IACnG,MAAM,mBAAmB,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,qBAAqB,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,iBAAiB,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;IAErG,OAAO,+BAA+B,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAC;AAC/E,CAAC","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/lib/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/lib/packageVersion.js

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

package/lib/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,6BAA6B,CAAC;AACrD,MAAM,CAAC,MAAM,UAAU,GAAG,OAAO,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/odsp-driver\";\nexport const pkgVersion = \"1.1.0\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,6BAA6B,CAAC;AACrD,MAAM,CAAC,MAAM,UAAU,GAAG,OAAO,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/odsp-driver\";\nexport const pkgVersion = \"1.2.0\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/odsp-driver",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Socket storage implementation for SPO and ODC",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -62,16 +62,16 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/core-interfaces": "^1.1.0",
-    "@fluidframework/driver-base": "^1.1.0",
-    "@fluidframework/driver-definitions": "^1.1.0",
-    "@fluidframework/driver-utils": "^1.1.0",
+    "@fluidframework/core-interfaces": "^1.2.0",
+    "@fluidframework/driver-base": "^1.2.0",
+    "@fluidframework/driver-definitions": "^1.2.0",
+    "@fluidframework/driver-utils": "^1.2.0",
     "@fluidframework/gitresources": "^0.1036.5000",
-    "@fluidframework/odsp-doclib-utils": "^1.1.0",
-    "@fluidframework/odsp-driver-definitions": "^1.1.0",
+    "@fluidframework/odsp-doclib-utils": "^1.2.0",
+    "@fluidframework/odsp-driver-definitions": "^1.2.0",
     "@fluidframework/protocol-base": "^0.1036.5000",
     "@fluidframework/protocol-definitions": "^0.1028.2000",
-    "@fluidframework/telemetry-utils": "^1.1.0",
+    "@fluidframework/telemetry-utils": "^1.2.0",
     "abort-controller": "^3.0.0",
     "node-fetch": "^2.6.1",
     "socket.io-client": "^4.4.1",
@@ -81,8 +81,8 @@
     "@fluidframework/build-common": "^0.24.0",
     "@fluidframework/build-tools": "^0.2.74327",
     "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/mocha-test-setup": "^1.1.0",
-    "@fluidframework/odsp-driver-previous": "npm:@fluidframework/odsp-driver@^1.0.0",
+    "@fluidframework/mocha-test-setup": "^1.2.0",
+    "@fluidframework/odsp-driver-previous": "npm:@fluidframework/odsp-driver@1.1.0",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^9.1.1",
@@ -100,7 +100,12 @@
     "typescript-formatter": "7.1.0"
   },
   "typeValidation": {
-    "version": "1.1.0",
-    "broken": {}
+    "version": "1.2.0",
+    "broken": {
+      "VariableDeclaration_OdcApiSiteOrigin": {
+        "forwardCompat": false,
+        "backCompat": false
+      }
+    }
   }
 }

package/src/checkUrl.ts

@@ -8,7 +8,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/src/constants.ts

@@ -3,5 +3,5 @@
  * 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";

package/src/contractsPublic.ts

@@ -10,6 +10,7 @@ export interface OdspFluidDataStoreLocator extends IOdspUrlParts {
     appName?: string;
     containerPackageName?: string;
     fileVersion?: string;
+    context?: string;
 }
 
 export enum SharingLinkHeader {

package/src/getFileLink.ts

@@ -86,11 +86,6 @@ async function getFileLinkCore(
 ): Promise<string> {
     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,

package/src/localOdspDriver/localOdspDocumentService.ts

@@ -0,0 +1,54 @@
+/*!
+ * 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 { UsageError, EmptyDocumentDeltaStorageService } from "@fluidframework/driver-utils";
+import { IOdspResolvedUrl } from "@fluidframework/odsp-driver-definitions";
+import { IClient } from "@fluidframework/protocol-definitions";
+import { LocalOdspDocumentStorageService } from "./localOdspDocumentStorageManager";
+
+/**
+ * IDocumentService implementation that provides explicit snapshot to the document storage service.
+ */
+export class LocalOdspDocumentService implements IDocumentService {
+    public policies = { storageOnly: true };
+
+    constructor(
+        private readonly odspResolvedUrl: IOdspResolvedUrl,
+        private readonly logger: ITelemetryLogger,
+        private readonly localSnapshot: Uint8Array | string,
+    ) { }
+
+    public get resolvedUrl(): IResolvedUrl {
+        return this.odspResolvedUrl;
+    }
+
+    public async connectToStorage(): Promise<IDocumentStorageService> {
+        return new LocalOdspDocumentStorageService(
+            this.logger,
+            this.localSnapshot,
+        );
+    }
+
+    public async connectToDeltaStorage(): Promise<IDocumentDeltaStorageService> {
+        return new EmptyDocumentDeltaStorageService();
+    }
+
+    public connectToDeltaStream(_client: IClient): never {
+        const toThrow = new UsageError("\"connectToDeltaStream\" is not supported by LocalOdspDocumentService");
+        this.logger.sendErrorEvent({ eventName: "UnsupportedUsage" }, toThrow);
+        throw toThrow;
+    }
+
+    public dispose(_error?: any): void {
+        // Do nothing
+    }
+}

package/src/localOdspDriver/localOdspDocumentServiceFactory.ts

@@ -0,0 +1,67 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { IDocumentService, IResolvedUrl } from "@fluidframework/driver-definitions";
+import { UsageError } from "@fluidframework/driver-utils";
+import { TelemetryLogger } from "@fluidframework/telemetry-utils";
+import { ISummaryTree } from "@fluidframework/protocol-definitions";
+import { ITelemetryBaseLogger } from "@fluidframework/common-definitions";
+import { createOdspLogger, getOdspResolvedUrl } from "../odspUtils";
+import { ICacheAndTracker } from "../epochTracker";
+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 {
+    private logger: TelemetryLogger | undefined;
+
+    constructor(
+        private readonly localSnapshot: Uint8Array | string,
+    ) {
+        super(
+            (_options) => this.throwUnsupportedUsageError("Getting storage token"),
+            (_options) => this.throwUnsupportedUsageError("Getting websocket token"),
+            () => this.throwUnsupportedUsageError("Getting SocketIO Client"),
+        );
+    }
+
+    private throwUnsupportedUsageError(unsupportedFuncName: string): never {
+        const toThrow = new UsageError(
+            `${unsupportedFuncName} is not supported by LocalOdspDocumentServiceFactory`);
+        this.logger?.sendErrorEvent({ eventName: "UnsupportedUsage" }, toThrow);
+        throw toThrow;
+    }
+
+    public createContainer(
+        _createNewSummary: ISummaryTree | undefined,
+        _createNewResolvedUrl: IResolvedUrl,
+        logger?: ITelemetryBaseLogger,
+        _clientIsSummarizer?: boolean,
+    ): never {
+        const toThrow = new UsageError("\"createContainer\" is not supported by LocalOdspDocumentServiceFactory");
+        createOdspLogger(logger).sendErrorEvent({ eventName: "UnsupportedUsage" }, toThrow);
+        throw toThrow;
+    }
+
+    protected async createDocumentServiceCore(
+        resolvedUrl: IResolvedUrl,
+        odspLogger: TelemetryLogger,
+        _cacheAndTrackerArg?: ICacheAndTracker,
+        _clientIsSummarizer?: boolean,
+    ): Promise<IDocumentService> {
+        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);
+    }
+}

package/src/localOdspDriver/localOdspDocumentStorageManager.ts

@@ -0,0 +1,83 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { assert } from "@fluidframework/common-utils";
+import { ITelemetryLogger } from "@fluidframework/common-definitions";
+import { ISummaryContext } from "@fluidframework/driver-definitions";
+import { UsageError } from "@fluidframework/driver-utils";
+import * as api from "@fluidframework/protocol-definitions";
+import { OdspDocumentStorageServiceBase } from "../odspDocumentStorageServiceBase";
+import { ISnapshotContents } from "../odspPublicUtils";
+import { IOdspSnapshot } from "../contracts";
+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 {
+    private snapshotTreeId: string | undefined;
+
+    constructor(
+        private readonly logger: ITelemetryLogger,
+        private readonly localSnapshot: Uint8Array | string,
+    ) {
+        super();
+    }
+
+    private calledGetVersions = false;
+
+    public async getVersions(blobid: string | null, count: number, _scenarioName?: string): Promise<api.IVersion[]> {
+        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: ISnapshotContents;
+
+        if (typeof this.localSnapshot === "string") {
+            const content: IOdspSnapshot = JSON.parse(this.localSnapshot);
+            snapshotContents = convertOdspSnapshotToSnapshotTreeAndBlobs(content);
+        } else {
+            snapshotContents = parseCompactSnapshotResponse(
+                new ReadBuffer(this.localSnapshot));
+        }
+
+        this.snapshotTreeId = this.initializeFromSnapshot(snapshotContents);
+        return this.getSnapshotVersion();
+    }
+
+    private getSnapshotVersion(): api.IVersion[] {
+        return this.snapshotTreeId ? [{ id: this.snapshotTreeId, treeId: undefined! }] : [];
+    }
+
+    protected fetchTreeFromSnapshot(_id: string, _scenarioName?: string): never {
+        this.throwUsageError("fetchTreeFromSnapshot");
+    }
+
+    protected fetchBlobFromStorage(_blobId: string, _evicted: boolean): never {
+        this.throwUsageError("fetchBlobFromStorage");
+    }
+
+    public uploadSummaryWithContext(_summary: api.ISummaryTree, _context: ISummaryContext): never {
+        this.throwUsageError("uploadSummaryWithContext");
+    }
+
+    public createBlob(_file: ArrayBufferLike): never {
+        this.throwUsageError("createBlob");
+    }
+
+    private throwUsageError(methodName: string): never {
+        const toThrow = new UsageError(`"${methodName}" is not supported by LocalOdspDocumentStorageService`);
+        this.logger.sendErrorEvent({ eventName: "UnsupportedUsage" }, toThrow);
+        throw toThrow;
+    }
+}

package/src/odspDeltaStorageService.ts

@@ -236,5 +236,5 @@ export class OdspDeltaStorageWithCache implements IDocumentDeltaStorageService {
                 });
             }
         });
-}
+    }
 }

package/src/odspDocumentService.ts

@@ -21,7 +21,11 @@ import {
     IDocumentServicePolicies,
     DriverErrorType,
 } from "@fluidframework/driver-definitions";
-import { canRetryOnError, DeltaStreamConnectionForbiddenError, NonRetryableError } from "@fluidframework/driver-utils";
+import {
+    canRetryOnError,
+    DeltaStreamConnectionForbiddenError,
+    NonRetryableError,
+} from "@fluidframework/driver-utils";
 import { IFacetCodes } from "@fluidframework/odsp-doclib-utils";
 import {
     IClient,

package/src/odspDocumentServiceFactory.ts

@@ -12,14 +12,14 @@ import {
 } from "@fluidframework/odsp-driver-definitions";
 import { OdspDocumentServiceFactoryCore } from "./odspDocumentServiceFactoryCore";
 import { getSocketIo } from "./getSocketIo";
+// eslint-disable-next-line import/no-internal-modules
+import { LocalOdspDocumentServiceFactory } from "./localOdspDriver/localOdspDocumentServiceFactory";
 
 /**
  * Factory for creating the sharepoint document service. Use this if you want to
  * use the sharepoint implementation.
  */
-export class OdspDocumentServiceFactory
-    extends OdspDocumentServiceFactoryCore
-    implements IDocumentServiceFactory {
+export class OdspDocumentServiceFactory extends OdspDocumentServiceFactoryCore {
     constructor(
         getStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>,
         getWebsocketToken: TokenFetcher<OdspResourceTokenFetchOptions> | undefined,
@@ -35,3 +35,7 @@ export class OdspDocumentServiceFactory
         );
     }
 }
+
+export function createLocalOdspDocumentServiceFactory(localSnapshot: Uint8Array | string): IDocumentServiceFactory {
+    return new LocalOdspDocumentServiceFactory(localSnapshot);
+}

package/src/odspDocumentServiceFactoryCore.ts

@@ -174,7 +174,7 @@ export class OdspDocumentServiceFactoryCore implements IDocumentServiceFactory {
         return this.createDocumentServiceCore(resolvedUrl, createOdspLogger(logger), undefined, clientIsSummarizer);
     }
 
-    private async createDocumentServiceCore(
+    protected async createDocumentServiceCore(
         resolvedUrl: IResolvedUrl,
         odspLogger: TelemetryLogger,
         cacheAndTrackerArg?: ICacheAndTracker,