@fluidframework/odsp-driver 1.1.0 → 1.2.0-77818

package/dist/odspDriverUrlResolver.js.map

@@ -1 +1 @@
-{"version":3,"file":"odspDriverUrlResolver.js","sourceRoot":"","sources":["../src/odspDriverUrlResolver.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,+DAAsD;AAEtD,2EAM4C;AAC5C,qFAA8G;AAC9G,+DAAiE;AACjE,mDAAgD;AAChD,mDAA6C;AAC7C,2CAAiD;AACjD,uDAAwD;AACxD,uDAA0D;AAC1D,qDAA8C;AAE9C,SAAS,UAAU,CAAC,OAAe,EAAE,OAAe,EAAE,MAAc,EAAE,WAAoB;IACtF,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC;IAC3C,MAAM,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,YAAY,WAAW,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9D,OAAO,GAAG,IAAA,0BAAU,EAAC,UAAU,CAAC,WAAW,OAAO,UAAU,MAAM,IAAI,OAAO,EAAE,CAAC;AACpF,CAAC;AAED,SAAS,cAAc,CAAC,OAAe,EAAE,OAAe,EAAE,MAAc,EAAE,WAAoB;IAC1F,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAClE,OAAO,GAAG,OAAO,oBAAoB,CAAC;AAC1C,CAAC;AAED,SAAS,oBAAoB,CAAC,OAAe,EAAE,OAAe,EAAE,MAAc,EAAE,WAAoB;IAChG,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAClE,OAAO,GAAG,OAAO,qBAAqB,CAAC;AAC3C,CAAC;AAED,SAAS,mBAAmB,CAAC,OAAe,EAAE,OAAe,EAAE,MAAc,EAAE,WAAoB;IAC/F,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAClE,OAAO,GAAG,OAAO,sBAAsB,CAAC;AAC5C,CAAC;AAED,SAAS,kBAAkB,CAAC,OAAe,EAAE,OAAe,EAAE,MAAc,EAAE,WAAoB;IAC9F,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAClE,OAAO,GAAG,OAAO,UAAU,CAAC;AAChC,CAAC;AAED;;;GAGG;AACH,SAAS,oBAAoB,CAAC,GAAW;IACrC,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;QACrB,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;KACxB;IAED,OAAO,GAAG,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,MAAa,qBAAqB;IAC9B,gBAAgB,CAAC;IAEV,KAAK,CAAC,OAAO,CAAC,OAAiB;;QAClC,IAAI,MAAA,OAAO,CAAC,OAAO,0CAAG,iCAAY,CAAC,SAAS,CAAC,EAAE;YAC3C,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAEtD,MAAM,YAAY,GAAG,IAAI,eAAe,CAAC,WAAW,CAAC,CAAC;YACtD,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,iCAAY,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC;YAClE,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YAC5C,MAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAC1C,MAAM,WAAW,GAAG,YAAY,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;YAC7D,MAAM,cAAc,GAAG,YAAY,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;YAC1D,IAAI,CAAC,CAAC,QAAQ,IAAI,OAAO,IAAI,OAAO,IAAI,QAAQ,KAAK,IAAI,IAAI,QAAQ,KAAK,SAAS,CAAC,EAAE;gBAClF,MAAM,IAAI,gCAAiB,CACvB,0CAA0C,EAC1C,oCAAe,CAAC,YAAY,EAC5B,EAAE,aAAa,EAAE,2BAAU,EAAE,CAAC,CAAC;aACtC;YACD,IAAI,aAA4C,CAAC;YACjD,IAAI,cAAc,IAAI,cAAc,IAAI,wCAAc,EAAE;gBACpD,aAAa,GAAG;oBACZ,UAAU,EAAE;wBACR,IAAI,EAAE,wCAAc,CAAC,cAAc,CAAC;qBACvC;iBACJ,CAAC;aACL;YACD,OAAO;gBACH,SAAS,EAAE;oBACP,kBAAkB,EAAE,EAAE;oBACtB,uBAAuB,EAAE,EAAE;oBAC3B,wBAAwB,EAAE,EAAE;oBAC5B,eAAe,EAAE,EAAE;iBACtB;gBACD,MAAM,EAAE,EAAE;gBACV,IAAI,EAAE,OAAO;gBACb,eAAe,EAAE,IAAI;gBACrB,EAAE,EAAE,eAAe;gBACnB,GAAG,EAAE,gBAAgB,OAAO,IAAI,WAAW,eAAe;gBAC1D,OAAO,EAAE,OAAO;gBAChB,gBAAgB,EAAE,EAAE;gBACpB,OAAO,EAAE,OAAO;gBAChB,MAAM,EAAE,EAAE;gBACV,QAAQ;gBACR,UAAU,EAAE,KAAK;gBACjB,QAAQ,EAAE;oBACN,oBAAoB,EAAE,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;iBAC9D;gBACD,WAAW,EAAE,SAAS;gBACtB,aAAa;gBACb,iBAAiB,EAAE,MAAA,OAAO,CAAC,OAAO,0CAAG,uCAAqB,CAAC,iBAAiB,CAAC;aAChF,CAAC;SACL;QACD,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,WAAW,EAAE,GAAG,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACzG,MAAM,gBAAgB,GAAG,MAAM,IAAA,qCAAmB,EAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACpE,IAAA,qBAAM,EAAC,CAAC,gBAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAE1F,IAAI,WAAW,GAAG,wCAAwC,gBAAgB,IAAI,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC;QAE3G,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE;YACxB,gEAAgE;YAChE,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACxC,MAAM,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC;YACvC,IAAI,YAAY,EAAE;gBACd,WAAW,IAAI,YAAY,CAAC;aAC/B;SACJ;QAED,MAAM,UAAU,GAAG,CAAC,CAAC,CAAA,MAAA,OAAO,CAAC,OAAO,0CAAG,iCAAY,CAAC,iBAAiB,CAAC,CAAA,CAAC;QAEvE,OAAO;YACH,IAAI,EAAE,OAAO;YACb,eAAe,EAAE,IAAI;YACrB,SAAS,EAAE;gBACP,kBAAkB,EAAE,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC;gBACzE,wBAAwB,EAAE,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC;gBACrF,uBAAuB,EAAE,mBAAmB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC;gBACnF,eAAe,EAAE,kBAAkB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC;aAC7E;YACD,EAAE,EAAE,gBAAgB;YACpB,MAAM,EAAE,EAAE;YACV,GAAG,EAAE,WAAW;YAChB,gBAAgB;YAChB,OAAO;YACP,OAAO;YACP,MAAM;YACN,QAAQ,EAAE,EAAE;YACZ,UAAU;YACV,QAAQ,EAAE;gBACN,oBAAoB;aACvB;YACD,WAAW;YACX,iBAAiB,EAAE,MAAA,OAAO,CAAC,OAAO,0CAAG,uCAAqB,CAAC,iBAAiB,CAAC;SAChF,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,cAAc,CACvB,WAAyB,EACzB,WAAmB,EACnB,iBAAyC;;QAEzC,IAAI,aAAa,GAAG,WAAW,CAAC;QAChC,IAAI,aAAa,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAC/B,aAAa,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;SAC3C;QACD,MAAM,eAAe,GAAG,IAAA,8BAAkB,EAAC,WAAW,CAAC,CAAC;QACxD,4BAA4B;QAC5B,MAAM,cAAc,GAAG,CAAC,GAAQ,EAAE,EAAE,CAChC,OAAO,GAAG,KAAK,QAAQ;eACpB,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,CAAA,KAAK,QAAQ;eAC7B,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,CAAA,KAAK,QAAQ,CAAC;QACtC,IAAI,oBAAoB,CAAC;QACzB,IAAI,iBAAiB,IAAI,MAAM,IAAI,iBAAiB,EAAE;YAClD,oBAAoB,GAAG,iBAAiB,CAAC,IAAI,CAAC;YAC9C,wGAAwG;SAC3G;aAAM,IAAI,cAAc,CAAC,MAAC,iBAAyB,0CAAE,OAAO,CAAC,EAAE;YAC5D,oBAAoB,GAAG,MAAC,iBAAyB,0CAAE,OAAO,CAAC,IAAI,CAAC;SACnE;aAAM;YACH,oBAAoB,GAAG,MAAC,iBAAyB,0CAAE,OAAO,CAAC;SAC9D;QACD,oBAAoB,GAAG,oBAAoB,aAApB,oBAAoB,cAApB,oBAAoB,GAAI,MAAA,eAAe,CAAC,QAAQ,0CAAE,oBAAoB,CAAC;QAE9F,OAAO,IAAA,6BAAa,kCACZ,eAAe,KACnB,oBAAoB;YACpB,aAAa,IACf,CAAC;IACP,CAAC;CACJ;AAhID,sDAgIC;AAED,SAAS,aAAa,CAAC,GAAW;IAQ9B,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAE9C,MAAM,YAAY,GAAG,IAAI,eAAe,CAAC,WAAW,CAAC,CAAC;IAEtD,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAC5C,MAAM,MAAM,GAAG,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC1C,MAAM,IAAI,GAAG,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACtC,MAAM,oBAAoB,GAAG,YAAY,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;IACtE,MAAM,WAAW,GAAG,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAEpD,IAAI,OAAO,KAAK,IAAI,EAAE;QAClB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;KAC1D;IAED,IAAI,MAAM,KAAK,IAAI,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;KAC1D;IAED,IAAI,IAAI,KAAK,IAAI,EAAE;QACf,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;KACtD;IAED,OAAO;QACH,OAAO;QACP,OAAO,EAAE,kBAAkB,CAAC,OAAO,CAAC;QACpC,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC;QAClC,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;QAC9B,oBAAoB,EAAE,oBAAoB,CAAC,CAAC,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,SAAS;QACjG,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS;KACzE,CAAC;AACN,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { assert } from \"@fluidframework/common-utils\";\nimport { IRequest } from \"@fluidframework/core-interfaces\";\nimport {\n    DriverErrorType,\n    DriverHeader,\n    IContainerPackageInfo,\n    IResolvedUrl,\n    IUrlResolver,\n} from \"@fluidframework/driver-definitions\";\nimport { IOdspResolvedUrl, ShareLinkTypes, ShareLinkInfoType } from \"@fluidframework/odsp-driver-definitions\";\nimport { NonRetryableError } from \"@fluidframework/driver-utils\";\nimport { createOdspUrl } from \"./createOdspUrl\";\nimport { getApiRoot } from \"./odspUrlHelper\";\nimport { getOdspResolvedUrl } from \"./odspUtils\";\nimport { getHashedDocumentId } from \"./odspPublicUtils\";\nimport { ClpCompliantAppHeader } from \"./contractsPublic\";\nimport { pkgVersion } from \"./packageVersion\";\n\nfunction getUrlBase(siteUrl: string, driveId: string, itemId: string, fileVersion?: string) {\n    const siteOrigin = new URL(siteUrl).origin;\n    const version = fileVersion ? `versions/${fileVersion}/` : \"\";\n    return `${getApiRoot(siteOrigin)}/drives/${driveId}/items/${itemId}/${version}`;\n}\n\nfunction getSnapshotUrl(siteUrl: string, driveId: string, itemId: string, fileVersion?: string) {\n    const urlBase = getUrlBase(siteUrl, driveId, itemId, fileVersion);\n    return `${urlBase}opStream/snapshots`;\n}\n\nfunction getAttachmentPOSTUrl(siteUrl: string, driveId: string, itemId: string, fileVersion?: string) {\n    const urlBase = getUrlBase(siteUrl, driveId, itemId, fileVersion);\n    return `${urlBase}opStream/attachment`;\n}\n\nfunction getAttachmentGETUrl(siteUrl: string, driveId: string, itemId: string, fileVersion?: string) {\n    const urlBase = getUrlBase(siteUrl, driveId, itemId, fileVersion);\n    return `${urlBase}opStream/attachments`;\n}\n\nfunction getDeltaStorageUrl(siteUrl: string, driveId: string, itemId: string, fileVersion?: string) {\n    const urlBase = getUrlBase(siteUrl, driveId, itemId, fileVersion);\n    return `${urlBase}opStream`;\n}\n\n/**\n * Utility that enables us to handle paths provided with a beginning slash.\n * For example if a value of '/id1/id2' is provided, id1/id2 is returned.\n */\nfunction removeBeginningSlash(str: string): string {\n    if (str.startsWith(\"/\")) {\n        return str.substr(1);\n    }\n\n    return str;\n}\n\n/**\n * Resolver to resolve urls like the ones created by createOdspUrl which is driver inner\n * url format. Ex: `${siteUrl}?driveId=${driveId}&itemId=${itemId}&path=${path}`\n */\nexport class OdspDriverUrlResolver implements IUrlResolver {\n    constructor() { }\n\n    public async resolve(request: IRequest): Promise<IOdspResolvedUrl> {\n        if (request.headers?.[DriverHeader.createNew]) {\n            const [siteURL, queryString] = request.url.split(\"?\");\n\n            const searchParams = new URLSearchParams(queryString);\n            const fileName = request.headers[DriverHeader.createNew].fileName;\n            const driveID = searchParams.get(\"driveId\");\n            const filePath = searchParams.get(\"path\");\n            const packageName = searchParams.get(\"containerPackageName\");\n            const createLinkType = searchParams.get(\"createLinkType\");\n            if (!(fileName && siteURL && driveID && filePath !== null && filePath !== undefined)) {\n                throw new NonRetryableError(\n                    \"Proper new file params should be there!!\",\n                    DriverErrorType.genericError,\n                    { driverVersion: pkgVersion });\n            }\n            let shareLinkInfo: ShareLinkInfoType | undefined;\n            if (createLinkType && createLinkType in ShareLinkTypes) {\n                shareLinkInfo = {\n                    createLink: {\n                        type: ShareLinkTypes[createLinkType],\n                    },\n                };\n            }\n            return {\n                endpoints: {\n                    snapshotStorageUrl: \"\",\n                    attachmentGETStorageUrl: \"\",\n                    attachmentPOSTStorageUrl: \"\",\n                    deltaStorageUrl: \"\",\n                },\n                tokens: {},\n                type: \"fluid\",\n                odspResolvedUrl: true,\n                id: \"odspCreateNew\",\n                url: `fluid-odsp://${siteURL}?${queryString}&version=null`,\n                siteUrl: siteURL,\n                hashedDocumentId: \"\",\n                driveId: driveID,\n                itemId: \"\",\n                fileName,\n                summarizer: false,\n                codeHint: {\n                    containerPackageName: packageName ? packageName : undefined,\n                },\n                fileVersion: undefined,\n                shareLinkInfo,\n                isClpCompliantApp: request.headers?.[ClpCompliantAppHeader.isClpCompliantApp],\n            };\n        }\n        const { siteUrl, driveId, itemId, path, containerPackageName, fileVersion } = decodeOdspUrl(request.url);\n        const hashedDocumentId = await getHashedDocumentId(driveId, itemId);\n        assert(!hashedDocumentId.includes(\"/\"), 0x0a8 /* \"Docid should not contain slashes!!\" */);\n\n        let documentUrl = `fluid-odsp://placeholder/placeholder/${hashedDocumentId}/${removeBeginningSlash(path)}`;\n\n        if (request.url.length > 0) {\n            // In case of any additional parameters add them back to the url\n            const requestURL = new URL(request.url);\n            const searchParams = requestURL.search;\n            if (searchParams) {\n                documentUrl += searchParams;\n            }\n        }\n\n        const summarizer = !!request.headers?.[DriverHeader.summarizingClient];\n\n        return {\n            type: \"fluid\",\n            odspResolvedUrl: true,\n            endpoints: {\n                snapshotStorageUrl: getSnapshotUrl(siteUrl, driveId, itemId, fileVersion),\n                attachmentPOSTStorageUrl: getAttachmentPOSTUrl(siteUrl, driveId, itemId, fileVersion),\n                attachmentGETStorageUrl: getAttachmentGETUrl(siteUrl, driveId, itemId, fileVersion),\n                deltaStorageUrl: getDeltaStorageUrl(siteUrl, driveId, itemId, fileVersion),\n            },\n            id: hashedDocumentId,\n            tokens: {},\n            url: documentUrl,\n            hashedDocumentId,\n            siteUrl,\n            driveId,\n            itemId,\n            fileName: \"\",\n            summarizer,\n            codeHint: {\n                containerPackageName,\n            },\n            fileVersion,\n            isClpCompliantApp: request.headers?.[ClpCompliantAppHeader.isClpCompliantApp],\n        };\n    }\n\n    public async getAbsoluteUrl(\n        resolvedUrl: IResolvedUrl,\n        relativeUrl: string,\n        packageInfoSource?: IContainerPackageInfo,\n    ): Promise<string> {\n        let dataStorePath = relativeUrl;\n        if (dataStorePath.startsWith(\"/\")) {\n            dataStorePath = dataStorePath.substr(1);\n        }\n        const odspResolvedUrl = getOdspResolvedUrl(resolvedUrl);\n        // back-compat: GitHub #9653\n        const isFluidPackage = (pkg: any) =>\n            typeof pkg === \"object\"\n            && typeof pkg?.name === \"string\"\n            && typeof pkg?.fluid === \"object\";\n        let containerPackageName;\n        if (packageInfoSource && \"name\" in packageInfoSource) {\n            containerPackageName = packageInfoSource.name;\n            // packageInfoSource is cast to any as it is typed to IContainerPackageInfo instead of IFluidCodeDetails\n        } else if (isFluidPackage((packageInfoSource as any)?.package)) {\n            containerPackageName = (packageInfoSource as any)?.package.name;\n        } else {\n            containerPackageName = (packageInfoSource as any)?.package;\n        }\n        containerPackageName = containerPackageName ?? odspResolvedUrl.codeHint?.containerPackageName;\n\n        return createOdspUrl({\n            ... odspResolvedUrl,\n            containerPackageName,\n            dataStorePath,\n        });\n    }\n}\n\nfunction decodeOdspUrl(url: string): {\n    siteUrl: string;\n    driveId: string;\n    itemId: string;\n    path: string;\n    containerPackageName?: string;\n    fileVersion?: string;\n} {\n    const [siteUrl, queryString] = url.split(\"?\");\n\n    const searchParams = new URLSearchParams(queryString);\n\n    const driveId = searchParams.get(\"driveId\");\n    const itemId = searchParams.get(\"itemId\");\n    const path = searchParams.get(\"path\");\n    const containerPackageName = searchParams.get(\"containerPackageName\");\n    const fileVersion = searchParams.get(\"fileVersion\");\n\n    if (driveId === null) {\n        throw new Error(\"ODSP URL did not contain a drive id\");\n    }\n\n    if (itemId === null) {\n        throw new Error(\"ODSP Url did not contain an item id\");\n    }\n\n    if (path === null) {\n        throw new Error(\"ODSP Url did not contain a path\");\n    }\n\n    return {\n        siteUrl,\n        driveId: decodeURIComponent(driveId),\n        itemId: decodeURIComponent(itemId),\n        path: decodeURIComponent(path),\n        containerPackageName: containerPackageName ? decodeURIComponent(containerPackageName) : undefined,\n        fileVersion: fileVersion ? decodeURIComponent(fileVersion) : undefined,\n    };\n}\n"]}
+{"version":3,"file":"odspDriverUrlResolver.js","sourceRoot":"","sources":["../src/odspDriverUrlResolver.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,+DAAsD;AAEtD,2EAM4C;AAC5C,qFAA8G;AAC9G,+DAAiE;AACjE,mDAAgD;AAChD,mDAA6C;AAC7C,2CAAiD;AACjD,uDAAwD;AACxD,uDAA0D;AAC1D,qDAA8C;AAE9C,SAAS,UAAU,CAAC,OAAe,EAAE,OAAe,EAAE,MAAc,EAAE,WAAoB;IACtF,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC;IAC3C,MAAM,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,YAAY,WAAW,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9D,OAAO,GAAG,IAAA,0BAAU,EAAC,UAAU,CAAC,WAAW,OAAO,UAAU,MAAM,IAAI,OAAO,EAAE,CAAC;AACpF,CAAC;AAED,SAAS,cAAc,CAAC,OAAe,EAAE,OAAe,EAAE,MAAc,EAAE,WAAoB;IAC1F,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAClE,OAAO,GAAG,OAAO,oBAAoB,CAAC;AAC1C,CAAC;AAED,SAAS,oBAAoB,CAAC,OAAe,EAAE,OAAe,EAAE,MAAc,EAAE,WAAoB;IAChG,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAClE,OAAO,GAAG,OAAO,qBAAqB,CAAC;AAC3C,CAAC;AAED,SAAS,mBAAmB,CAAC,OAAe,EAAE,OAAe,EAAE,MAAc,EAAE,WAAoB;IAC/F,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAClE,OAAO,GAAG,OAAO,sBAAsB,CAAC;AAC5C,CAAC;AAED,SAAS,kBAAkB,CAAC,OAAe,EAAE,OAAe,EAAE,MAAc,EAAE,WAAoB;IAC9F,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAClE,OAAO,GAAG,OAAO,UAAU,CAAC;AAChC,CAAC;AAED;;;GAGG;AACH,SAAS,oBAAoB,CAAC,GAAW;IACrC,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;QACrB,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;KACxB;IAED,OAAO,GAAG,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,MAAa,qBAAqB;IAC9B,gBAAgB,CAAC;IAEV,KAAK,CAAC,OAAO,CAAC,OAAiB;;QAClC,IAAI,MAAA,OAAO,CAAC,OAAO,0CAAG,iCAAY,CAAC,SAAS,CAAC,EAAE;YAC3C,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAEtD,MAAM,YAAY,GAAG,IAAI,eAAe,CAAC,WAAW,CAAC,CAAC;YACtD,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,iCAAY,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC;YAClE,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YAC5C,MAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAC1C,MAAM,WAAW,GAAG,YAAY,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;YAC7D,MAAM,cAAc,GAAG,YAAY,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;YAC1D,IAAI,CAAC,CAAC,QAAQ,IAAI,OAAO,IAAI,OAAO,IAAI,QAAQ,KAAK,IAAI,IAAI,QAAQ,KAAK,SAAS,CAAC,EAAE;gBAClF,MAAM,IAAI,gCAAiB,CACvB,0CAA0C,EAC1C,oCAAe,CAAC,YAAY,EAC5B,EAAE,aAAa,EAAE,2BAAU,EAAE,CAAC,CAAC;aACtC;YACD,IAAI,aAA4C,CAAC;YACjD,IAAI,cAAc,IAAI,cAAc,IAAI,wCAAc,EAAE;gBACpD,aAAa,GAAG;oBACZ,UAAU,EAAE;wBACR,IAAI,EAAE,wCAAc,CAAC,cAAc,CAAC;qBACvC;iBACJ,CAAC;aACL;YACD,OAAO;gBACH,SAAS,EAAE;oBACP,kBAAkB,EAAE,EAAE;oBACtB,uBAAuB,EAAE,EAAE;oBAC3B,wBAAwB,EAAE,EAAE;oBAC5B,eAAe,EAAE,EAAE;iBACtB;gBACD,MAAM,EAAE,EAAE;gBACV,IAAI,EAAE,OAAO;gBACb,eAAe,EAAE,IAAI;gBACrB,EAAE,EAAE,eAAe;gBACnB,GAAG,EAAE,gBAAgB,OAAO,IAAI,WAAW,eAAe;gBAC1D,OAAO,EAAE,OAAO;gBAChB,gBAAgB,EAAE,EAAE;gBACpB,OAAO,EAAE,OAAO;gBAChB,MAAM,EAAE,EAAE;gBACV,QAAQ;gBACR,UAAU,EAAE,KAAK;gBACjB,QAAQ,EAAE;oBACN,oBAAoB,EAAE,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,SAAS;iBACjD;gBACD,WAAW,EAAE,SAAS;gBACtB,aAAa;gBACb,iBAAiB,EAAE,MAAA,OAAO,CAAC,OAAO,0CAAG,uCAAqB,CAAC,iBAAiB,CAAC;aAChF,CAAC;SACL;QACD,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,WAAW,EAAE,GAAG,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACzG,MAAM,gBAAgB,GAAG,MAAM,IAAA,qCAAmB,EAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACpE,IAAA,qBAAM,EAAC,CAAC,gBAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAE1F,IAAI,WAAW,GAAG,wCAAwC,gBAAgB,IAAI,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC;QAE3G,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE;YACxB,gEAAgE;YAChE,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACxC,MAAM,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC;YACvC,IAAI,YAAY,EAAE;gBACd,WAAW,IAAI,YAAY,CAAC;aAC/B;SACJ;QAED,MAAM,UAAU,GAAG,CAAC,CAAC,CAAA,MAAA,OAAO,CAAC,OAAO,0CAAG,iCAAY,CAAC,iBAAiB,CAAC,CAAA,CAAC;QAEvE,OAAO;YACH,IAAI,EAAE,OAAO;YACb,eAAe,EAAE,IAAI;YACrB,SAAS,EAAE;gBACP,kBAAkB,EAAE,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC;gBACzE,wBAAwB,EAAE,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC;gBACrF,uBAAuB,EAAE,mBAAmB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC;gBACnF,eAAe,EAAE,kBAAkB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC;aAC7E;YACD,EAAE,EAAE,gBAAgB;YACpB,MAAM,EAAE,EAAE;YACV,GAAG,EAAE,WAAW;YAChB,gBAAgB;YAChB,OAAO;YACP,OAAO;YACP,MAAM;YACN,QAAQ,EAAE,EAAE;YACZ,UAAU;YACV,QAAQ,EAAE;gBACN,oBAAoB;aACvB;YACD,WAAW;YACX,iBAAiB,EAAE,MAAA,OAAO,CAAC,OAAO,0CAAG,uCAAqB,CAAC,iBAAiB,CAAC;SAChF,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,cAAc,CACvB,WAAyB,EACzB,WAAmB,EACnB,iBAAyC;;QAEzC,IAAI,aAAa,GAAG,WAAW,CAAC;QAChC,IAAI,aAAa,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAC/B,aAAa,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;SAC3C;QACD,MAAM,eAAe,GAAG,IAAA,8BAAkB,EAAC,WAAW,CAAC,CAAC;QACxD,4BAA4B;QAC5B,MAAM,cAAc,GAAG,CAAC,GAAQ,EAAE,EAAE,CAChC,OAAO,GAAG,KAAK,QAAQ;eACpB,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,CAAA,KAAK,QAAQ;eAC7B,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,CAAA,KAAK,QAAQ,CAAC;QACtC,IAAI,oBAAoB,CAAC;QACzB,IAAI,iBAAiB,IAAI,MAAM,IAAI,iBAAiB,EAAE;YAClD,oBAAoB,GAAG,iBAAiB,CAAC,IAAI,CAAC;YAC9C,wGAAwG;SAC3G;aAAM,IAAI,cAAc,CAAC,MAAC,iBAAyB,0CAAE,OAAO,CAAC,EAAE;YAC5D,oBAAoB,GAAG,MAAC,iBAAyB,0CAAE,OAAO,CAAC,IAAI,CAAC;SACnE;aAAM;YACH,oBAAoB,GAAG,MAAC,iBAAyB,0CAAE,OAAO,CAAC;SAC9D;QACD,oBAAoB,GAAG,oBAAoB,aAApB,oBAAoB,cAApB,oBAAoB,GAAI,MAAA,eAAe,CAAC,QAAQ,0CAAE,oBAAoB,CAAC;QAE9F,OAAO,IAAA,6BAAa,kCACZ,eAAe,KACnB,oBAAoB;YACpB,aAAa,IACf,CAAC;IACP,CAAC;CACJ;AAhID,sDAgIC;AAED,SAAS,aAAa,CAAC,GAAW;IAQ9B,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAE9C,MAAM,YAAY,GAAG,IAAI,eAAe,CAAC,WAAW,CAAC,CAAC;IAEtD,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAC5C,MAAM,MAAM,GAAG,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC1C,MAAM,IAAI,GAAG,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACtC,MAAM,oBAAoB,GAAG,YAAY,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;IACtE,MAAM,WAAW,GAAG,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAEpD,IAAI,OAAO,KAAK,IAAI,EAAE;QAClB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;KAC1D;IAED,IAAI,MAAM,KAAK,IAAI,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;KAC1D;IAED,IAAI,IAAI,KAAK,IAAI,EAAE;QACf,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;KACtD;IAED,OAAO;QACH,OAAO;QACP,OAAO,EAAE,kBAAkB,CAAC,OAAO,CAAC;QACpC,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC;QAClC,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;QAC9B,oBAAoB,EAAE,oBAAoB,CAAC,CAAC,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,SAAS;QACjG,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS;KACzE,CAAC;AACN,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { assert } from \"@fluidframework/common-utils\";\nimport { IRequest } from \"@fluidframework/core-interfaces\";\nimport {\n    DriverErrorType,\n    DriverHeader,\n    IContainerPackageInfo,\n    IResolvedUrl,\n    IUrlResolver,\n} from \"@fluidframework/driver-definitions\";\nimport { IOdspResolvedUrl, ShareLinkTypes, ShareLinkInfoType } from \"@fluidframework/odsp-driver-definitions\";\nimport { NonRetryableError } from \"@fluidframework/driver-utils\";\nimport { createOdspUrl } from \"./createOdspUrl\";\nimport { getApiRoot } from \"./odspUrlHelper\";\nimport { getOdspResolvedUrl } from \"./odspUtils\";\nimport { getHashedDocumentId } from \"./odspPublicUtils\";\nimport { ClpCompliantAppHeader } from \"./contractsPublic\";\nimport { pkgVersion } from \"./packageVersion\";\n\nfunction getUrlBase(siteUrl: string, driveId: string, itemId: string, fileVersion?: string) {\n    const siteOrigin = new URL(siteUrl).origin;\n    const version = fileVersion ? `versions/${fileVersion}/` : \"\";\n    return `${getApiRoot(siteOrigin)}/drives/${driveId}/items/${itemId}/${version}`;\n}\n\nfunction getSnapshotUrl(siteUrl: string, driveId: string, itemId: string, fileVersion?: string) {\n    const urlBase = getUrlBase(siteUrl, driveId, itemId, fileVersion);\n    return `${urlBase}opStream/snapshots`;\n}\n\nfunction getAttachmentPOSTUrl(siteUrl: string, driveId: string, itemId: string, fileVersion?: string) {\n    const urlBase = getUrlBase(siteUrl, driveId, itemId, fileVersion);\n    return `${urlBase}opStream/attachment`;\n}\n\nfunction getAttachmentGETUrl(siteUrl: string, driveId: string, itemId: string, fileVersion?: string) {\n    const urlBase = getUrlBase(siteUrl, driveId, itemId, fileVersion);\n    return `${urlBase}opStream/attachments`;\n}\n\nfunction getDeltaStorageUrl(siteUrl: string, driveId: string, itemId: string, fileVersion?: string) {\n    const urlBase = getUrlBase(siteUrl, driveId, itemId, fileVersion);\n    return `${urlBase}opStream`;\n}\n\n/**\n * Utility that enables us to handle paths provided with a beginning slash.\n * For example if a value of '/id1/id2' is provided, id1/id2 is returned.\n */\nfunction removeBeginningSlash(str: string): string {\n    if (str.startsWith(\"/\")) {\n        return str.substr(1);\n    }\n\n    return str;\n}\n\n/**\n * Resolver to resolve urls like the ones created by createOdspUrl which is driver inner\n * url format. Ex: `${siteUrl}?driveId=${driveId}&itemId=${itemId}&path=${path}`\n */\nexport class OdspDriverUrlResolver implements IUrlResolver {\n    constructor() { }\n\n    public async resolve(request: IRequest): Promise<IOdspResolvedUrl> {\n        if (request.headers?.[DriverHeader.createNew]) {\n            const [siteURL, queryString] = request.url.split(\"?\");\n\n            const searchParams = new URLSearchParams(queryString);\n            const fileName = request.headers[DriverHeader.createNew].fileName;\n            const driveID = searchParams.get(\"driveId\");\n            const filePath = searchParams.get(\"path\");\n            const packageName = searchParams.get(\"containerPackageName\");\n            const createLinkType = searchParams.get(\"createLinkType\");\n            if (!(fileName && siteURL && driveID && filePath !== null && filePath !== undefined)) {\n                throw new NonRetryableError(\n                    \"Proper new file params should be there!!\",\n                    DriverErrorType.genericError,\n                    { driverVersion: pkgVersion });\n            }\n            let shareLinkInfo: ShareLinkInfoType | undefined;\n            if (createLinkType && createLinkType in ShareLinkTypes) {\n                shareLinkInfo = {\n                    createLink: {\n                        type: ShareLinkTypes[createLinkType],\n                    },\n                };\n            }\n            return {\n                endpoints: {\n                    snapshotStorageUrl: \"\",\n                    attachmentGETStorageUrl: \"\",\n                    attachmentPOSTStorageUrl: \"\",\n                    deltaStorageUrl: \"\",\n                },\n                tokens: {},\n                type: \"fluid\",\n                odspResolvedUrl: true,\n                id: \"odspCreateNew\",\n                url: `fluid-odsp://${siteURL}?${queryString}&version=null`,\n                siteUrl: siteURL,\n                hashedDocumentId: \"\",\n                driveId: driveID,\n                itemId: \"\",\n                fileName,\n                summarizer: false,\n                codeHint: {\n                    containerPackageName: packageName ?? undefined,\n                },\n                fileVersion: undefined,\n                shareLinkInfo,\n                isClpCompliantApp: request.headers?.[ClpCompliantAppHeader.isClpCompliantApp],\n            };\n        }\n        const { siteUrl, driveId, itemId, path, containerPackageName, fileVersion } = decodeOdspUrl(request.url);\n        const hashedDocumentId = await getHashedDocumentId(driveId, itemId);\n        assert(!hashedDocumentId.includes(\"/\"), 0x0a8 /* \"Docid should not contain slashes!!\" */);\n\n        let documentUrl = `fluid-odsp://placeholder/placeholder/${hashedDocumentId}/${removeBeginningSlash(path)}`;\n\n        if (request.url.length > 0) {\n            // In case of any additional parameters add them back to the url\n            const requestURL = new URL(request.url);\n            const searchParams = requestURL.search;\n            if (searchParams) {\n                documentUrl += searchParams;\n            }\n        }\n\n        const summarizer = !!request.headers?.[DriverHeader.summarizingClient];\n\n        return {\n            type: \"fluid\",\n            odspResolvedUrl: true,\n            endpoints: {\n                snapshotStorageUrl: getSnapshotUrl(siteUrl, driveId, itemId, fileVersion),\n                attachmentPOSTStorageUrl: getAttachmentPOSTUrl(siteUrl, driveId, itemId, fileVersion),\n                attachmentGETStorageUrl: getAttachmentGETUrl(siteUrl, driveId, itemId, fileVersion),\n                deltaStorageUrl: getDeltaStorageUrl(siteUrl, driveId, itemId, fileVersion),\n            },\n            id: hashedDocumentId,\n            tokens: {},\n            url: documentUrl,\n            hashedDocumentId,\n            siteUrl,\n            driveId,\n            itemId,\n            fileName: \"\",\n            summarizer,\n            codeHint: {\n                containerPackageName,\n            },\n            fileVersion,\n            isClpCompliantApp: request.headers?.[ClpCompliantAppHeader.isClpCompliantApp],\n        };\n    }\n\n    public async getAbsoluteUrl(\n        resolvedUrl: IResolvedUrl,\n        relativeUrl: string,\n        packageInfoSource?: IContainerPackageInfo,\n    ): Promise<string> {\n        let dataStorePath = relativeUrl;\n        if (dataStorePath.startsWith(\"/\")) {\n            dataStorePath = dataStorePath.substr(1);\n        }\n        const odspResolvedUrl = getOdspResolvedUrl(resolvedUrl);\n        // back-compat: GitHub #9653\n        const isFluidPackage = (pkg: any) =>\n            typeof pkg === \"object\"\n            && typeof pkg?.name === \"string\"\n            && typeof pkg?.fluid === \"object\";\n        let containerPackageName;\n        if (packageInfoSource && \"name\" in packageInfoSource) {\n            containerPackageName = packageInfoSource.name;\n            // packageInfoSource is cast to any as it is typed to IContainerPackageInfo instead of IFluidCodeDetails\n        } else if (isFluidPackage((packageInfoSource as any)?.package)) {\n            containerPackageName = (packageInfoSource as any)?.package.name;\n        } else {\n            containerPackageName = (packageInfoSource as any)?.package;\n        }\n        containerPackageName = containerPackageName ?? odspResolvedUrl.codeHint?.containerPackageName;\n\n        return createOdspUrl({\n            ... odspResolvedUrl,\n            containerPackageName,\n            dataStorePath,\n        });\n    }\n}\n\nfunction decodeOdspUrl(url: string): {\n    siteUrl: string;\n    driveId: string;\n    itemId: string;\n    path: string;\n    containerPackageName?: string;\n    fileVersion?: string;\n} {\n    const [siteUrl, queryString] = url.split(\"?\");\n\n    const searchParams = new URLSearchParams(queryString);\n\n    const driveId = searchParams.get(\"driveId\");\n    const itemId = searchParams.get(\"itemId\");\n    const path = searchParams.get(\"path\");\n    const containerPackageName = searchParams.get(\"containerPackageName\");\n    const fileVersion = searchParams.get(\"fileVersion\");\n\n    if (driveId === null) {\n        throw new Error(\"ODSP URL did not contain a drive id\");\n    }\n\n    if (itemId === null) {\n        throw new Error(\"ODSP Url did not contain an item id\");\n    }\n\n    if (path === null) {\n        throw new Error(\"ODSP Url did not contain a path\");\n    }\n\n    return {\n        siteUrl,\n        driveId: decodeURIComponent(driveId),\n        itemId: decodeURIComponent(itemId),\n        path: decodeURIComponent(path),\n        containerPackageName: containerPackageName ? decodeURIComponent(containerPackageName) : undefined,\n        fileVersion: fileVersion ? decodeURIComponent(fileVersion) : undefined,\n    };\n}\n"]}

package/dist/odspDriverUrlResolverForShareLink.d.ts

@@ -23,6 +23,7 @@ export interface ShareLinkFetcherProps {
  */
 export declare class OdspDriverUrlResolverForShareLink implements IUrlResolver {
     private readonly appName?;
+    private readonly getContext?;
     private readonly logger;
     private readonly sharingLinkCache;
     private readonly shareLinkFetcherProps;
@@ -35,8 +36,10 @@ export declare class OdspDriverUrlResolverForShareLink implements IUrlResolver {
      * @param appName - application name hint that is encoded with url produced by getAbsoluteUrl() method.
      * This hint is used by link handling logic which determines which app to redirect to when user
      * navigates directly to the link.
+     * @param getContext - callback function which is used to get context for given resolved url. If context
+     * is returned then it will be embedded into url returned by getAbsoluteUrl() method.
      */
-    constructor(shareLinkFetcherProps?: ShareLinkFetcherProps | undefined, logger?: ITelemetryBaseLogger, appName?: string | undefined);
+    constructor(shareLinkFetcherProps?: ShareLinkFetcherProps | undefined, logger?: ITelemetryBaseLogger, appName?: string | undefined, getContext?: ((resolvedUrl: IOdspResolvedUrl, dataStorePath: string) => Promise<string | undefined>) | undefined);
     /**
      * Takes an already generated data store url (from requestUrl) and appends a path to the
      * existing data store information.
@@ -53,7 +56,9 @@ export declare class OdspDriverUrlResolverForShareLink implements IUrlResolver {
      * Requests a driver + data store storage URL. Note that this method requires share link to be fetched
      * and it will throw in case share link fetcher props were not specified when instance was created.
      * @param resolvedUrl - The driver resolved URL
-     * @param request - The relative data store path URL. For requesting a driver URL, this value should always be '/'
+     * @param dataStorePath - The relative data store path URL.
+     * For requesting a driver URL, this value should always be '/'
+     * @param packageInfoSource - optional, represents container package information to be included in url.
      */
     getAbsoluteUrl(resolvedUrl: IResolvedUrl, dataStorePath: string, packageInfoSource?: IContainerPackageInfo): Promise<string>;
     /**
@@ -62,6 +67,7 @@ export declare class OdspDriverUrlResolverForShareLink implements IUrlResolver {
     static createDocumentUrl(baseUrl: string, driverInfo: OdspFluidDataStoreLocator): string;
     /**
      * Crafts a supported data store nav param
+     * @deprecated encodeOdspFluidDataStoreLocator should be used instead
      */
     static createNavParam(locator: OdspFluidDataStoreLocator): string;
 }

package/dist/odspDriverUrlResolverForShareLink.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"odspDriverUrlResolverForShareLink.d.ts","sourceRoot":"","sources":["../src/odspDriverUrlResolverForShareLink.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EACH,qBAAqB,EACrB,YAAY,EACZ,YAAY,EACf,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAoB,MAAM,oCAAoC,CAAC;AAC5F,OAAO,EACH,gBAAgB,EAChB,YAAY,EACZ,6BAA6B,EAC7B,YAAY,EACf,MAAM,yCAAyC,CAAC;AAOjD,OAAO,EAAE,yBAAyB,EAAqB,MAAM,mBAAmB,CAAC;AAMjF;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC,6BAA6B,CAAC,CAAC;IAC1D;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC;CAC9B;AAED;;;;GAIG;AACH,qBAAa,iCAAkC,YAAW,YAAY;IAkB9D,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IAjB7B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmB;IAC1C,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAsC;IACvE,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAoC;IAE1E;;;;;;;;;OASG;gBAEC,qBAAqB,CAAC,EAAE,qBAAqB,GAAG,SAAS,EACzD,MAAM,CAAC,EAAE,oBAAoB,EACZ,OAAO,CAAC,oBAAQ;IAWrC;;;OAGG;IACI,mBAAmB,CAAC,UAAU,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAyBrF,OAAO,CAAC,MAAM;IAId;;OAEG;IACU,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA+BlE,OAAO,CAAC,cAAc;YAQR,mBAAmB;IA8BjC;;;;;OAKG;IACU,cAAc,CACvB,WAAW,EAAE,YAAY,EACzB,aAAa,EAAE,MAAM,EACrB,iBAAiB,CAAC,EAAE,qBAAqB,GAC1C,OAAO,CAAC,MAAM,CAAC;IAiClB;;OAEG;WACW,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,yBAAyB;IAQtF;;OAEG;WACW,cAAc,CAAC,OAAO,EAAE,yBAAyB;CAGlE"}
+{"version":3,"file":"odspDriverUrlResolverForShareLink.d.ts","sourceRoot":"","sources":["../src/odspDriverUrlResolverForShareLink.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EACH,qBAAqB,EACrB,YAAY,EACZ,YAAY,EACf,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAoB,MAAM,oCAAoC,CAAC;AAC5F,OAAO,EACH,gBAAgB,EAChB,YAAY,EACZ,6BAA6B,EAC7B,YAAY,EACf,MAAM,yCAAyC,CAAC;AAOjD,OAAO,EAAE,yBAAyB,EAAqB,MAAM,mBAAmB,CAAC;AAMjF;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC,6BAA6B,CAAC,CAAC;IAC1D;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC;CAC9B;AAED;;;;GAIG;AACH,qBAAa,iCAAkC,YAAW,YAAY;IAoB9D,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IACzB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC;IApBhC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmB;IAC1C,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAsC;IACvE,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAoC;IAE1E;;;;;;;;;;;OAWG;gBAEC,qBAAqB,CAAC,EAAE,qBAAqB,GAAG,SAAS,EACzD,MAAM,CAAC,EAAE,oBAAoB,EACZ,OAAO,CAAC,oBAAQ,EAChB,UAAU,CAAC,iBACV,gBAAgB,iBAAiB,MAAM,KAAK,QAAQ,MAAM,GAAG,SAAS,CAAC,aAAA;IAW7F;;;OAGG;IACI,mBAAmB,CAAC,UAAU,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAyBrF,OAAO,CAAC,MAAM;IAId;;OAEG;IACU,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA+BlE,OAAO,CAAC,cAAc;YAQR,mBAAmB;IA8BjC;;;;;;;OAOG;IACU,cAAc,CACvB,WAAW,EAAE,YAAY,EACzB,aAAa,EAAE,MAAM,EACrB,iBAAiB,CAAC,EAAE,qBAAqB,GAC1C,OAAO,CAAC,MAAM,CAAC;IAsClB;;OAEG;WACW,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,yBAAyB;IAQtF;;;OAGG;WACW,cAAc,CAAC,OAAO,EAAE,yBAAyB;CAGlE"}

package/dist/odspDriverUrlResolverForShareLink.js

@@ -27,9 +27,12 @@ class OdspDriverUrlResolverForShareLink {
      * @param appName - application name hint that is encoded with url produced by getAbsoluteUrl() method.
      * This hint is used by link handling logic which determines which app to redirect to when user
      * navigates directly to the link.
+     * @param getContext - callback function which is used to get context for given resolved url. If context
+     * is returned then it will be embedded into url returned by getAbsoluteUrl() method.
      */
-    constructor(shareLinkFetcherProps, logger, appName) {
+    constructor(shareLinkFetcherProps, logger, appName, getContext) {
         this.appName = appName;
+        this.getContext = getContext;
         this.sharingLinkCache = new common_utils_1.PromiseCache();
         this.logger = (0, odspUtils_1.createOdspLogger)(logger);
         if (shareLinkFetcherProps) {
@@ -127,10 +130,12 @@ class OdspDriverUrlResolverForShareLink {
      * Requests a driver + data store storage URL. Note that this method requires share link to be fetched
      * and it will throw in case share link fetcher props were not specified when instance was created.
      * @param resolvedUrl - The driver resolved URL
-     * @param request - The relative data store path URL. For requesting a driver URL, this value should always be '/'
+     * @param dataStorePath - The relative data store path URL.
+     * For requesting a driver URL, this value should always be '/'
+     * @param packageInfoSource - optional, represents container package information to be included in url.
      */
     async getAbsoluteUrl(resolvedUrl, dataStorePath, packageInfoSource) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e;
         const odspResolvedUrl = (0, odspUtils_1.getOdspResolvedUrl)(resolvedUrl);
         const shareLink = await this.getShareLinkPromise(odspResolvedUrl);
         const shareLinkUrl = new URL(shareLink);
@@ -150,6 +155,7 @@ class OdspDriverUrlResolverForShareLink {
             containerPackageName = (_c = packageInfoSource) === null || _c === void 0 ? void 0 : _c.package;
         }
         containerPackageName = containerPackageName !== null && containerPackageName !== void 0 ? containerPackageName : (_d = odspResolvedUrl.codeHint) === null || _d === void 0 ? void 0 : _d.containerPackageName;
+        const context = await ((_e = this.getContext) === null || _e === void 0 ? void 0 : _e.call(this, odspResolvedUrl, dataStorePath));
         (0, odspFluidFileLink_1.storeLocatorInOdspUrl)(shareLinkUrl, {
             siteUrl: odspResolvedUrl.siteUrl,
             driveId: odspResolvedUrl.driveId,
@@ -158,6 +164,7 @@ class OdspDriverUrlResolverForShareLink {
             appName: this.appName,
             containerPackageName,
             fileVersion: odspResolvedUrl.fileVersion,
+            context,
         });
         return shareLinkUrl.href;
     }
@@ -171,6 +178,7 @@ class OdspDriverUrlResolverForShareLink {
     }
     /**
      * Crafts a supported data store nav param
+     * @deprecated encodeOdspFluidDataStoreLocator should be used instead
      */
     static createNavParam(locator) {
         return (0, odspFluidFileLink_1.encodeOdspFluidDataStoreLocator)(locator);

package/dist/odspDriverUrlResolverForShareLink.js.map

@@ -1 +1 @@
-{"version":3,"file":"odspDriverUrlResolverForShareLink.js","sourceRoot":"","sources":["../src/odspDriverUrlResolverForShareLink.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,+DAA4D;AAc5D,2DAK6B;AAC7B,uDAAiF;AACjF,mDAAgD;AAChD,mEAAgE;AAChE,2CAAmE;AACnE,+CAA4C;AAgB5C;;;;GAIG;AACH,MAAa,iCAAiC;IAK1C;;;;;;;;;OASG;IACH,YACI,qBAAyD,EACzD,MAA6B,EACZ,OAAgB;QAAhB,YAAO,GAAP,OAAO,CAAS;QAhBpB,qBAAgB,GAAG,IAAI,2BAAY,EAAkB,CAAC;QAkBnE,IAAI,CAAC,MAAM,GAAG,IAAA,4BAAgB,EAAC,MAAM,CAAC,CAAC;QACvC,IAAI,qBAAqB,EAAE;YACvB,IAAI,CAAC,qBAAqB,mCACnB,qBAAqB,KACxB,YAAY,EAAE,qBAAqB,CAAC,YAAY,GACnD,CAAC;SACL;IACL,CAAC;IAED;;;OAGG;IACI,mBAAmB,CAAC,UAAe,EAAE,YAAoB;QAC5D,MAAM,SAAS,GAAG,IAAA,yCAAqB,EAAC,UAAU,CAAC,CAAC;QAEpD,IAAI,CAAC,SAAS,EAAE;YACZ,OAAO,SAAS,CAAC;SACpB;QAED,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,aAAa,EAAE,GAAG,UAAU,CAAC,QAAQ,KAAK,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;QACtG,mGAAmG;QACnG,IAAI,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAC/D,MAAM,WAAW,GAAG,IAAI,eAAe,CAAC,YAAY,CAAC,CAAC;YACtD,WAAW,CAAC,OAAO,CAAC,CAAC,KAAa,EAAE,GAAW,EAAE,EAAE;gBAC/C,UAAU,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAC/C,CAAC,CAAC,CAAC;YACH,SAAS,CAAC,aAAa,GAAG,GAAG,UAAU,CAAC,QAAQ,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;SAC1E;aAAM;YACH,SAAS,CAAC,aAAa,GAAG,GAAG,UAAU,CAAC,QAAQ,GAC5C,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAC7E,GAAG,YAAY,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;SAC1C;QACD,IAAA,yCAAqB,EAAC,UAAU,EAAE,SAAS,CAAC,CAAC;QAE7C,OAAO,UAAU,CAAC,IAAI,CAAC;IAC3B,CAAC;IAEO,MAAM,CAAC,WAA6B;QACxC,OAAO,GAAG,WAAW,CAAC,OAAO,IAAI,WAAW,CAAC,OAAO,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC;IACjF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO,CAAC,OAAiB;;QAClC,MAAM,mBAAmB,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;QAC3E,MAAM,qBAAqB,GAAG,MAAA,mBAAmB,CAAC,OAAO,0CAAG,mCAAiB,CAAC,qBAAqB,CAAC,CAAC;QACrG,IAAI;YACA,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAEjC,MAAM,aAAa,GAAG,IAAA,yCAAqB,EAAC,GAAG,CAAC,CAAC;YACjD,IAAI,aAAa,EAAE;gBACf,mBAAmB,CAAC,GAAG,GAAG,IAAA,6BAAa,EAAC,aAAa,CAAC,CAAC;aAC1D;SACJ;QAAC,WAAM;YACJ,8EAA8E;SACjF;QAED,MAAM,eAAe,GAAG,MAAM,IAAI,6CAAqB,EAAE,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;QAEvF,IAAI,qBAAqB,EAAE;YACvB,yGAAyG;YACzG,sGAAsG;YACtG,uBAAuB;YACvB,eAAe,CAAC,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,aAAa,IAAI,EAAE,EAC7E,EAAE,mBAAmB,EAAE,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SAClE;QACD,IAAI,eAAe,CAAC,MAAM,EAAE;YACxB,iGAAiG;YACjG,mGAAmG;YACnG,IAAI,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;SAC7D;QACD,OAAO,eAAe,CAAC;IAC3B,CAAC;IAEO,cAAc,CAAC,IAAY;QAC/B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;QAC1B,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC/C,MAAM,CAAC,MAAM,CAAC,yCAAqB,CAAC,CAAC;QACrC,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;QAC/B,OAAO,GAAG,CAAC,IAAI,CAAC;IACpB,CAAC;IAEO,KAAK,CAAC,mBAAmB,CAAC,WAA6B;QAC3D,IAAI,IAAI,CAAC,qBAAqB,KAAK,SAAS,EAAE;YAC1C,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;SAC5F;QAED,IAAI,CAAC,CAAC,WAAW,CAAC,OAAO,IAAI,WAAW,CAAC,OAAO,IAAI,WAAW,CAAC,MAAM,CAAC,EAAE;YACrE,MAAM,IAAI,KAAK,CAAC,oEAAoE;gBAChF,mCAAmC,CAAC,CAAC;SAC5C;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACrC,MAAM,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACzD,IAAI,iBAAiB,EAAE;YACnB,OAAO,iBAAiB,CAAC;SAC5B;QACD,MAAM,cAAc,GAAG,IAAA,yBAAW,EAC9B,IAAI,CAAC,qBAAqB,CAAC,YAAY,EACvC,WAAW,EACX,IAAI,CAAC,qBAAqB,CAAC,YAAY,EACvC,IAAI,CAAC,MAAM,CACd,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACd,yDAAyD;YACzD,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,mBAAmB,EAAE,EAAE,KAAK,CAAC,CAAC;YACtE,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAClC,MAAM,KAAK,CAAC;QAChB,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,cAAc,CAAC,CAAC;QAC3D,OAAO,cAAc,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,cAAc,CACvB,WAAyB,EACzB,aAAqB,EACrB,iBAAyC;;QAEzC,MAAM,eAAe,GAAG,IAAA,8BAAkB,EAAC,WAAW,CAAC,CAAC;QACxD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;QAClE,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;QACxC,4BAA4B;QAC5B,MAAM,cAAc,GAAG,CAAC,GAAQ,EAAE,EAAE,CAChC,OAAO,GAAG,KAAK,QAAQ;eACpB,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,CAAA,KAAK,QAAQ;eAC7B,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,CAAA,KAAK,QAAQ,CAAC;QACtC,IAAI,oBAAoB,CAAC;QACzB,IAAI,iBAAiB,IAAI,MAAM,IAAI,iBAAiB,EAAE;YAClD,oBAAoB,GAAG,iBAAiB,CAAC,IAAI,CAAC;YAC9C,wGAAwG;SAC3G;aAAM,IAAI,cAAc,CAAC,MAAC,iBAAyB,0CAAE,OAAO,CAAC,EAAE;YAC5D,oBAAoB,GAAG,MAAC,iBAAyB,0CAAE,OAAO,CAAC,IAAI,CAAC;SACnE;aAAM;YACH,oBAAoB,GAAG,MAAC,iBAAyB,0CAAE,OAAO,CAAC;SAC9D;QACD,oBAAoB,GAAG,oBAAoB,aAApB,oBAAoB,cAApB,oBAAoB,GAAI,MAAA,eAAe,CAAC,QAAQ,0CAAE,oBAAoB,CAAC;QAE9F,IAAA,yCAAqB,EAAC,YAAY,EAAE;YAChC,OAAO,EAAE,eAAe,CAAC,OAAO;YAChC,OAAO,EAAE,eAAe,CAAC,OAAO;YAChC,MAAM,EAAE,eAAe,CAAC,MAAM;YAC9B,aAAa;YACb,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,oBAAoB;YACpB,WAAW,EAAE,eAAe,CAAC,WAAW;SAC3C,CAAC,CAAC;QAEH,OAAO,YAAY,CAAC,IAAI,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,iBAAiB,CAAC,OAAe,EAAE,UAAqC;QAClF,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;QAE7B,IAAA,yCAAqB,EAAC,GAAG,EAAE,UAAU,CAAC,CAAC;QAEvC,OAAO,GAAG,CAAC,IAAI,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,cAAc,CAAC,OAAkC;QAC3D,OAAO,IAAA,mDAA+B,EAAC,OAAO,CAAC,CAAC;IACpD,CAAC;CACJ;AAlMD,8EAkMC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { PromiseCache } from \"@fluidframework/common-utils\";\nimport { IRequest } from \"@fluidframework/core-interfaces\";\nimport {\n    IContainerPackageInfo,\n    IResolvedUrl,\n    IUrlResolver,\n} from \"@fluidframework/driver-definitions\";\nimport { ITelemetryBaseLogger, ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport {\n    IOdspResolvedUrl,\n    IdentityType,\n    OdspResourceTokenFetchOptions,\n    TokenFetcher,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport {\n    getLocatorFromOdspUrl,\n    storeLocatorInOdspUrl,\n    encodeOdspFluidDataStoreLocator,\n    locatorQueryParamName,\n} from \"./odspFluidFileLink\";\nimport { OdspFluidDataStoreLocator, SharingLinkHeader } from \"./contractsPublic\";\nimport { createOdspUrl } from \"./createOdspUrl\";\nimport { OdspDriverUrlResolver } from \"./odspDriverUrlResolver\";\nimport { getOdspResolvedUrl, createOdspLogger } from \"./odspUtils\";\nimport { getFileLink } from \"./getFileLink\";\n\n/**\n * Properties passed to the code responsible for fetching share link for a file.\n */\nexport interface ShareLinkFetcherProps {\n    /**\n     * Callback method that is used to fetch access token necessary to call API that produces share link\n     */\n    tokenFetcher: TokenFetcher<OdspResourceTokenFetchOptions>;\n    /**\n     * Identity type determining the shape of share link as it differs for Enterprise and Consumer users.\n     */\n    identityType: IdentityType;\n}\n\n/**\n * Resolver to resolve urls like the ones created by createOdspUrl which is driver inner\n * url format and the ones which have things like driveId, siteId, itemId etc encoded in nav param.\n * This resolver also handles share links and try to generate one for the use by the app.\n */\nexport class OdspDriverUrlResolverForShareLink implements IUrlResolver {\n    private readonly logger: ITelemetryLogger;\n    private readonly sharingLinkCache = new PromiseCache<string, string>();\n    private readonly shareLinkFetcherProps: ShareLinkFetcherProps | undefined;\n\n    /**\n     * Creates url resolver instance\n     * @param shareLinkFetcherProps - properties used when fetching share link.\n     * Can be set as 'undefined' for cases where share link is not needed. Currently, only\n     * getAbsoluteUrl() method requires share link.\n     * @param logger - logger object that is used as telemetry sink\n     * @param appName - application name hint that is encoded with url produced by getAbsoluteUrl() method.\n     * This hint is used by link handling logic which determines which app to redirect to when user\n     * navigates directly to the link.\n     */\n    public constructor(\n        shareLinkFetcherProps?: ShareLinkFetcherProps | undefined,\n        logger?: ITelemetryBaseLogger,\n        private readonly appName?: string,\n    ) {\n        this.logger = createOdspLogger(logger);\n        if (shareLinkFetcherProps) {\n            this.shareLinkFetcherProps = {\n                ...shareLinkFetcherProps,\n                tokenFetcher: shareLinkFetcherProps.tokenFetcher,\n            };\n        }\n    }\n\n    /**\n     * Takes an already generated data store url (from requestUrl) and appends a path to the\n     * existing data store information.\n     */\n    public appendDataStorePath(requestUrl: URL, pathToAppend: string): string | undefined {\n        const fluidInfo = getLocatorFromOdspUrl(requestUrl);\n\n        if (!fluidInfo) {\n            return undefined;\n        }\n\n        const parsingUrl = new URL(fluidInfo.dataStorePath, `${requestUrl.protocol}//${requestUrl.hostname}`);\n        // Determine if the caller is passing a query parameter or path since processing will be different.\n        if (pathToAppend.startsWith(\"/?\") || pathToAppend.startsWith(\"?\")) {\n            const queryParams = new URLSearchParams(pathToAppend);\n            queryParams.forEach((value: string, key: string) => {\n                parsingUrl.searchParams.append(key, value);\n            });\n            fluidInfo.dataStorePath = `${parsingUrl.pathname}${parsingUrl.search}`;\n        } else {\n            fluidInfo.dataStorePath = `${parsingUrl.pathname}${\n                parsingUrl.pathname.endsWith(\"/\") || pathToAppend.startsWith(\"/\") ? \"\" : \"/\"\n            }${pathToAppend}/${parsingUrl.search}`;\n        }\n        storeLocatorInOdspUrl(requestUrl, fluidInfo);\n\n        return requestUrl.href;\n    }\n\n    private getKey(resolvedUrl: IOdspResolvedUrl): string {\n        return `${resolvedUrl.siteUrl},${resolvedUrl.driveId},${resolvedUrl.itemId}`;\n    }\n\n    /**\n     * Resolves request URL into driver details\n     */\n    public async resolve(request: IRequest): Promise<IOdspResolvedUrl> {\n        const requestToBeResolved = { headers: request.headers, url: request.url };\n        const isSharingLinkToRedeem = requestToBeResolved.headers?.[SharingLinkHeader.isSharingLinkToRedeem];\n        try {\n            const url = new URL(request.url);\n\n            const odspFluidInfo = getLocatorFromOdspUrl(url);\n            if (odspFluidInfo) {\n                requestToBeResolved.url = createOdspUrl(odspFluidInfo);\n            }\n        } catch {\n            // If the locator throws some error, then try to resolve the request as it is.\n        }\n\n        const odspResolvedUrl = await new OdspDriverUrlResolver().resolve(requestToBeResolved);\n\n        if (isSharingLinkToRedeem) {\n            // We need to remove the nav param if set by host when setting the sharelink as otherwise the shareLinkId\n            // when redeeming the share link during the redeem fallback for trees latest call becomes greater than\n            // the eligible length.\n            odspResolvedUrl.shareLinkInfo = Object.assign(odspResolvedUrl.shareLinkInfo || {},\n                { sharingLinkToRedeem: this.removeNavParam(request.url) });\n        }\n        if (odspResolvedUrl.itemId) {\n            // Kick start the sharing link request if we don't have it already as a performance optimization.\n            // For detached create new, we don't have an item id yet and therefore cannot generate a share link\n            this.getShareLinkPromise(odspResolvedUrl).catch(() => {});\n        }\n        return odspResolvedUrl;\n    }\n\n    private removeNavParam(link: string): string {\n        const url = new URL(link);\n        const params = new URLSearchParams(url.search);\n        params.delete(locatorQueryParamName);\n        url.search = params.toString();\n        return url.href;\n    }\n\n    private async getShareLinkPromise(resolvedUrl: IOdspResolvedUrl): Promise<string> {\n        if (this.shareLinkFetcherProps === undefined) {\n            throw new Error(\"Failed to get share link because share link fetcher props are missing\");\n        }\n\n        if (!(resolvedUrl.siteUrl && resolvedUrl.driveId && resolvedUrl.itemId)) {\n            throw new Error(\"Failed to get share link because necessary information is missing \" +\n                \"(e.g. siteUrl, driveId or itemId)\");\n        }\n\n        const key = this.getKey(resolvedUrl);\n        const cachedLinkPromise = this.sharingLinkCache.get(key);\n        if (cachedLinkPromise) {\n            return cachedLinkPromise;\n        }\n        const newLinkPromise = getFileLink(\n            this.shareLinkFetcherProps.tokenFetcher,\n            resolvedUrl,\n            this.shareLinkFetcherProps.identityType,\n            this.logger,\n        ).catch((error) => {\n            // This should imply that error is a non-retriable error.\n            this.logger.sendErrorEvent({ eventName: \"FluidFileUrlError\" }, error);\n            this.sharingLinkCache.remove(key);\n            throw error;\n        });\n        this.sharingLinkCache.add(key, async () => newLinkPromise);\n        return newLinkPromise;\n    }\n\n    /**\n     * Requests a driver + data store storage URL. Note that this method requires share link to be fetched\n     * and it will throw in case share link fetcher props were not specified when instance was created.\n     * @param resolvedUrl - The driver resolved URL\n     * @param request - The relative data store path URL. For requesting a driver URL, this value should always be '/'\n     */\n    public async getAbsoluteUrl(\n        resolvedUrl: IResolvedUrl,\n        dataStorePath: string,\n        packageInfoSource?: IContainerPackageInfo,\n    ): Promise<string> {\n        const odspResolvedUrl = getOdspResolvedUrl(resolvedUrl);\n        const shareLink = await this.getShareLinkPromise(odspResolvedUrl);\n        const shareLinkUrl = new URL(shareLink);\n        // back-compat: GitHub #9653\n        const isFluidPackage = (pkg: any) =>\n            typeof pkg === \"object\"\n            && typeof pkg?.name === \"string\"\n            && typeof pkg?.fluid === \"object\";\n        let containerPackageName;\n        if (packageInfoSource && \"name\" in packageInfoSource) {\n            containerPackageName = packageInfoSource.name;\n            // packageInfoSource is cast to any as it is typed to IContainerPackageInfo instead of IFluidCodeDetails\n        } else if (isFluidPackage((packageInfoSource as any)?.package)) {\n            containerPackageName = (packageInfoSource as any)?.package.name;\n        } else {\n            containerPackageName = (packageInfoSource as any)?.package;\n        }\n        containerPackageName = containerPackageName ?? odspResolvedUrl.codeHint?.containerPackageName;\n\n        storeLocatorInOdspUrl(shareLinkUrl, {\n            siteUrl: odspResolvedUrl.siteUrl,\n            driveId: odspResolvedUrl.driveId,\n            itemId: odspResolvedUrl.itemId,\n            dataStorePath,\n            appName: this.appName,\n            containerPackageName,\n            fileVersion: odspResolvedUrl.fileVersion,\n        });\n\n        return shareLinkUrl.href;\n    }\n\n    /**\n     * Crafts a supported document/driver URL\n     */\n    public static createDocumentUrl(baseUrl: string, driverInfo: OdspFluidDataStoreLocator) {\n        const url = new URL(baseUrl);\n\n        storeLocatorInOdspUrl(url, driverInfo);\n\n        return url.href;\n    }\n\n    /**\n     * Crafts a supported data store nav param\n     */\n    public static createNavParam(locator: OdspFluidDataStoreLocator) {\n        return encodeOdspFluidDataStoreLocator(locator);\n    }\n}\n"]}
+{"version":3,"file":"odspDriverUrlResolverForShareLink.js","sourceRoot":"","sources":["../src/odspDriverUrlResolverForShareLink.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,+DAA4D;AAc5D,2DAK6B;AAC7B,uDAAiF;AACjF,mDAAgD;AAChD,mEAAgE;AAChE,2CAAmE;AACnE,+CAA4C;AAgB5C;;;;GAIG;AACH,MAAa,iCAAiC;IAK1C;;;;;;;;;;;OAWG;IACH,YACI,qBAAyD,EACzD,MAA6B,EACZ,OAAgB,EAChB,UACwE;QAFxE,YAAO,GAAP,OAAO,CAAS;QAChB,eAAU,GAAV,UAAU,CAC8D;QApB5E,qBAAgB,GAAG,IAAI,2BAAY,EAAkB,CAAC;QAsBnE,IAAI,CAAC,MAAM,GAAG,IAAA,4BAAgB,EAAC,MAAM,CAAC,CAAC;QACvC,IAAI,qBAAqB,EAAE;YACvB,IAAI,CAAC,qBAAqB,mCACnB,qBAAqB,KACxB,YAAY,EAAE,qBAAqB,CAAC,YAAY,GACnD,CAAC;SACL;IACL,CAAC;IAED;;;OAGG;IACI,mBAAmB,CAAC,UAAe,EAAE,YAAoB;QAC5D,MAAM,SAAS,GAAG,IAAA,yCAAqB,EAAC,UAAU,CAAC,CAAC;QAEpD,IAAI,CAAC,SAAS,EAAE;YACZ,OAAO,SAAS,CAAC;SACpB;QAED,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,aAAa,EAAE,GAAG,UAAU,CAAC,QAAQ,KAAK,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;QACtG,mGAAmG;QACnG,IAAI,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAC/D,MAAM,WAAW,GAAG,IAAI,eAAe,CAAC,YAAY,CAAC,CAAC;YACtD,WAAW,CAAC,OAAO,CAAC,CAAC,KAAa,EAAE,GAAW,EAAE,EAAE;gBAC/C,UAAU,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAC/C,CAAC,CAAC,CAAC;YACH,SAAS,CAAC,aAAa,GAAG,GAAG,UAAU,CAAC,QAAQ,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;SAC1E;aAAM;YACH,SAAS,CAAC,aAAa,GAAG,GAAG,UAAU,CAAC,QAAQ,GAC5C,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAC7E,GAAG,YAAY,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;SAC1C;QACD,IAAA,yCAAqB,EAAC,UAAU,EAAE,SAAS,CAAC,CAAC;QAE7C,OAAO,UAAU,CAAC,IAAI,CAAC;IAC3B,CAAC;IAEO,MAAM,CAAC,WAA6B;QACxC,OAAO,GAAG,WAAW,CAAC,OAAO,IAAI,WAAW,CAAC,OAAO,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC;IACjF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO,CAAC,OAAiB;;QAClC,MAAM,mBAAmB,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;QAC3E,MAAM,qBAAqB,GAAG,MAAA,mBAAmB,CAAC,OAAO,0CAAG,mCAAiB,CAAC,qBAAqB,CAAC,CAAC;QACrG,IAAI;YACA,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAEjC,MAAM,aAAa,GAAG,IAAA,yCAAqB,EAAC,GAAG,CAAC,CAAC;YACjD,IAAI,aAAa,EAAE;gBACf,mBAAmB,CAAC,GAAG,GAAG,IAAA,6BAAa,EAAC,aAAa,CAAC,CAAC;aAC1D;SACJ;QAAC,WAAM;YACJ,8EAA8E;SACjF;QAED,MAAM,eAAe,GAAG,MAAM,IAAI,6CAAqB,EAAE,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;QAEvF,IAAI,qBAAqB,EAAE;YACvB,yGAAyG;YACzG,sGAAsG;YACtG,uBAAuB;YACvB,eAAe,CAAC,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,aAAa,IAAI,EAAE,EAC7E,EAAE,mBAAmB,EAAE,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SAClE;QACD,IAAI,eAAe,CAAC,MAAM,EAAE;YACxB,iGAAiG;YACjG,mGAAmG;YACnG,IAAI,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;SAC7D;QACD,OAAO,eAAe,CAAC;IAC3B,CAAC;IAEO,cAAc,CAAC,IAAY;QAC/B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;QAC1B,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC/C,MAAM,CAAC,MAAM,CAAC,yCAAqB,CAAC,CAAC;QACrC,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;QAC/B,OAAO,GAAG,CAAC,IAAI,CAAC;IACpB,CAAC;IAEO,KAAK,CAAC,mBAAmB,CAAC,WAA6B;QAC3D,IAAI,IAAI,CAAC,qBAAqB,KAAK,SAAS,EAAE;YAC1C,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;SAC5F;QAED,IAAI,CAAC,CAAC,WAAW,CAAC,OAAO,IAAI,WAAW,CAAC,OAAO,IAAI,WAAW,CAAC,MAAM,CAAC,EAAE;YACrE,MAAM,IAAI,KAAK,CAAC,oEAAoE;gBAChF,mCAAmC,CAAC,CAAC;SAC5C;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACrC,MAAM,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACzD,IAAI,iBAAiB,EAAE;YACnB,OAAO,iBAAiB,CAAC;SAC5B;QACD,MAAM,cAAc,GAAG,IAAA,yBAAW,EAC9B,IAAI,CAAC,qBAAqB,CAAC,YAAY,EACvC,WAAW,EACX,IAAI,CAAC,qBAAqB,CAAC,YAAY,EACvC,IAAI,CAAC,MAAM,CACd,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACd,yDAAyD;YACzD,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,mBAAmB,EAAE,EAAE,KAAK,CAAC,CAAC;YACtE,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAClC,MAAM,KAAK,CAAC;QAChB,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,cAAc,CAAC,CAAC;QAC3D,OAAO,cAAc,CAAC;IAC1B,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,cAAc,CACvB,WAAyB,EACzB,aAAqB,EACrB,iBAAyC;;QAEzC,MAAM,eAAe,GAAG,IAAA,8BAAkB,EAAC,WAAW,CAAC,CAAC;QAExD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;QAClE,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;QAExC,4BAA4B;QAC5B,MAAM,cAAc,GAAG,CAAC,GAAQ,EAAE,EAAE,CAChC,OAAO,GAAG,KAAK,QAAQ;eACpB,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,CAAA,KAAK,QAAQ;eAC7B,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,CAAA,KAAK,QAAQ,CAAC;QACtC,IAAI,oBAAoB,CAAC;QACzB,IAAI,iBAAiB,IAAI,MAAM,IAAI,iBAAiB,EAAE;YAClD,oBAAoB,GAAG,iBAAiB,CAAC,IAAI,CAAC;YAC9C,wGAAwG;SAC3G;aAAM,IAAI,cAAc,CAAC,MAAC,iBAAyB,0CAAE,OAAO,CAAC,EAAE;YAC5D,oBAAoB,GAAG,MAAC,iBAAyB,0CAAE,OAAO,CAAC,IAAI,CAAC;SACnE;aAAM;YACH,oBAAoB,GAAG,MAAC,iBAAyB,0CAAE,OAAO,CAAC;SAC9D;QACD,oBAAoB,GAAG,oBAAoB,aAApB,oBAAoB,cAApB,oBAAoB,GAAI,MAAA,eAAe,CAAC,QAAQ,0CAAE,oBAAoB,CAAC;QAE9F,MAAM,OAAO,GAAG,MAAM,CAAA,MAAA,IAAI,CAAC,UAAU,+CAAf,IAAI,EAAc,eAAe,EAAE,aAAa,CAAC,CAAA,CAAC;QAExE,IAAA,yCAAqB,EAAC,YAAY,EAAE;YAChC,OAAO,EAAE,eAAe,CAAC,OAAO;YAChC,OAAO,EAAE,eAAe,CAAC,OAAO;YAChC,MAAM,EAAE,eAAe,CAAC,MAAM;YAC9B,aAAa;YACb,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,oBAAoB;YACpB,WAAW,EAAE,eAAe,CAAC,WAAW;YACxC,OAAO;SACV,CAAC,CAAC;QAEH,OAAO,YAAY,CAAC,IAAI,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,iBAAiB,CAAC,OAAe,EAAE,UAAqC;QAClF,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;QAE7B,IAAA,yCAAqB,EAAC,GAAG,EAAE,UAAU,CAAC,CAAC;QAEvC,OAAO,GAAG,CAAC,IAAI,CAAC;IACpB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,cAAc,CAAC,OAAkC;QAC3D,OAAO,IAAA,mDAA+B,EAAC,OAAO,CAAC,CAAC;IACpD,CAAC;CACJ;AA9MD,8EA8MC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { PromiseCache } from \"@fluidframework/common-utils\";\nimport { IRequest } from \"@fluidframework/core-interfaces\";\nimport {\n    IContainerPackageInfo,\n    IResolvedUrl,\n    IUrlResolver,\n} from \"@fluidframework/driver-definitions\";\nimport { ITelemetryBaseLogger, ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport {\n    IOdspResolvedUrl,\n    IdentityType,\n    OdspResourceTokenFetchOptions,\n    TokenFetcher,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport {\n    getLocatorFromOdspUrl,\n    storeLocatorInOdspUrl,\n    encodeOdspFluidDataStoreLocator,\n    locatorQueryParamName,\n} from \"./odspFluidFileLink\";\nimport { OdspFluidDataStoreLocator, SharingLinkHeader } from \"./contractsPublic\";\nimport { createOdspUrl } from \"./createOdspUrl\";\nimport { OdspDriverUrlResolver } from \"./odspDriverUrlResolver\";\nimport { getOdspResolvedUrl, createOdspLogger } from \"./odspUtils\";\nimport { getFileLink } from \"./getFileLink\";\n\n/**\n * Properties passed to the code responsible for fetching share link for a file.\n */\nexport interface ShareLinkFetcherProps {\n    /**\n     * Callback method that is used to fetch access token necessary to call API that produces share link\n     */\n    tokenFetcher: TokenFetcher<OdspResourceTokenFetchOptions>;\n    /**\n     * Identity type determining the shape of share link as it differs for Enterprise and Consumer users.\n     */\n    identityType: IdentityType;\n}\n\n/**\n * Resolver to resolve urls like the ones created by createOdspUrl which is driver inner\n * url format and the ones which have things like driveId, siteId, itemId etc encoded in nav param.\n * This resolver also handles share links and try to generate one for the use by the app.\n */\nexport class OdspDriverUrlResolverForShareLink implements IUrlResolver {\n    private readonly logger: ITelemetryLogger;\n    private readonly sharingLinkCache = new PromiseCache<string, string>();\n    private readonly shareLinkFetcherProps: ShareLinkFetcherProps | undefined;\n\n    /**\n     * Creates url resolver instance\n     * @param shareLinkFetcherProps - properties used when fetching share link.\n     * Can be set as 'undefined' for cases where share link is not needed. Currently, only\n     * getAbsoluteUrl() method requires share link.\n     * @param logger - logger object that is used as telemetry sink\n     * @param appName - application name hint that is encoded with url produced by getAbsoluteUrl() method.\n     * This hint is used by link handling logic which determines which app to redirect to when user\n     * navigates directly to the link.\n     * @param getContext - callback function which is used to get context for given resolved url. If context\n     * is returned then it will be embedded into url returned by getAbsoluteUrl() method.\n     */\n    public constructor(\n        shareLinkFetcherProps?: ShareLinkFetcherProps | undefined,\n        logger?: ITelemetryBaseLogger,\n        private readonly appName?: string,\n        private readonly getContext?:\n            (resolvedUrl: IOdspResolvedUrl, dataStorePath: string) => Promise<string | undefined>,\n    ) {\n        this.logger = createOdspLogger(logger);\n        if (shareLinkFetcherProps) {\n            this.shareLinkFetcherProps = {\n                ...shareLinkFetcherProps,\n                tokenFetcher: shareLinkFetcherProps.tokenFetcher,\n            };\n        }\n    }\n\n    /**\n     * Takes an already generated data store url (from requestUrl) and appends a path to the\n     * existing data store information.\n     */\n    public appendDataStorePath(requestUrl: URL, pathToAppend: string): string | undefined {\n        const fluidInfo = getLocatorFromOdspUrl(requestUrl);\n\n        if (!fluidInfo) {\n            return undefined;\n        }\n\n        const parsingUrl = new URL(fluidInfo.dataStorePath, `${requestUrl.protocol}//${requestUrl.hostname}`);\n        // Determine if the caller is passing a query parameter or path since processing will be different.\n        if (pathToAppend.startsWith(\"/?\") || pathToAppend.startsWith(\"?\")) {\n            const queryParams = new URLSearchParams(pathToAppend);\n            queryParams.forEach((value: string, key: string) => {\n                parsingUrl.searchParams.append(key, value);\n            });\n            fluidInfo.dataStorePath = `${parsingUrl.pathname}${parsingUrl.search}`;\n        } else {\n            fluidInfo.dataStorePath = `${parsingUrl.pathname}${\n                parsingUrl.pathname.endsWith(\"/\") || pathToAppend.startsWith(\"/\") ? \"\" : \"/\"\n            }${pathToAppend}/${parsingUrl.search}`;\n        }\n        storeLocatorInOdspUrl(requestUrl, fluidInfo);\n\n        return requestUrl.href;\n    }\n\n    private getKey(resolvedUrl: IOdspResolvedUrl): string {\n        return `${resolvedUrl.siteUrl},${resolvedUrl.driveId},${resolvedUrl.itemId}`;\n    }\n\n    /**\n     * Resolves request URL into driver details\n     */\n    public async resolve(request: IRequest): Promise<IOdspResolvedUrl> {\n        const requestToBeResolved = { headers: request.headers, url: request.url };\n        const isSharingLinkToRedeem = requestToBeResolved.headers?.[SharingLinkHeader.isSharingLinkToRedeem];\n        try {\n            const url = new URL(request.url);\n\n            const odspFluidInfo = getLocatorFromOdspUrl(url);\n            if (odspFluidInfo) {\n                requestToBeResolved.url = createOdspUrl(odspFluidInfo);\n            }\n        } catch {\n            // If the locator throws some error, then try to resolve the request as it is.\n        }\n\n        const odspResolvedUrl = await new OdspDriverUrlResolver().resolve(requestToBeResolved);\n\n        if (isSharingLinkToRedeem) {\n            // We need to remove the nav param if set by host when setting the sharelink as otherwise the shareLinkId\n            // when redeeming the share link during the redeem fallback for trees latest call becomes greater than\n            // the eligible length.\n            odspResolvedUrl.shareLinkInfo = Object.assign(odspResolvedUrl.shareLinkInfo || {},\n                { sharingLinkToRedeem: this.removeNavParam(request.url) });\n        }\n        if (odspResolvedUrl.itemId) {\n            // Kick start the sharing link request if we don't have it already as a performance optimization.\n            // For detached create new, we don't have an item id yet and therefore cannot generate a share link\n            this.getShareLinkPromise(odspResolvedUrl).catch(() => {});\n        }\n        return odspResolvedUrl;\n    }\n\n    private removeNavParam(link: string): string {\n        const url = new URL(link);\n        const params = new URLSearchParams(url.search);\n        params.delete(locatorQueryParamName);\n        url.search = params.toString();\n        return url.href;\n    }\n\n    private async getShareLinkPromise(resolvedUrl: IOdspResolvedUrl): Promise<string> {\n        if (this.shareLinkFetcherProps === undefined) {\n            throw new Error(\"Failed to get share link because share link fetcher props are missing\");\n        }\n\n        if (!(resolvedUrl.siteUrl && resolvedUrl.driveId && resolvedUrl.itemId)) {\n            throw new Error(\"Failed to get share link because necessary information is missing \" +\n                \"(e.g. siteUrl, driveId or itemId)\");\n        }\n\n        const key = this.getKey(resolvedUrl);\n        const cachedLinkPromise = this.sharingLinkCache.get(key);\n        if (cachedLinkPromise) {\n            return cachedLinkPromise;\n        }\n        const newLinkPromise = getFileLink(\n            this.shareLinkFetcherProps.tokenFetcher,\n            resolvedUrl,\n            this.shareLinkFetcherProps.identityType,\n            this.logger,\n        ).catch((error) => {\n            // This should imply that error is a non-retriable error.\n            this.logger.sendErrorEvent({ eventName: \"FluidFileUrlError\" }, error);\n            this.sharingLinkCache.remove(key);\n            throw error;\n        });\n        this.sharingLinkCache.add(key, async () => newLinkPromise);\n        return newLinkPromise;\n    }\n\n    /**\n     * Requests a driver + data store storage URL. Note that this method requires share link to be fetched\n     * and it will throw in case share link fetcher props were not specified when instance was created.\n     * @param resolvedUrl - The driver resolved URL\n     * @param dataStorePath - The relative data store path URL.\n     * For requesting a driver URL, this value should always be '/'\n     * @param packageInfoSource - optional, represents container package information to be included in url.\n     */\n    public async getAbsoluteUrl(\n        resolvedUrl: IResolvedUrl,\n        dataStorePath: string,\n        packageInfoSource?: IContainerPackageInfo,\n    ): Promise<string> {\n        const odspResolvedUrl = getOdspResolvedUrl(resolvedUrl);\n\n        const shareLink = await this.getShareLinkPromise(odspResolvedUrl);\n        const shareLinkUrl = new URL(shareLink);\n\n        // back-compat: GitHub #9653\n        const isFluidPackage = (pkg: any) =>\n            typeof pkg === \"object\"\n            && typeof pkg?.name === \"string\"\n            && typeof pkg?.fluid === \"object\";\n        let containerPackageName;\n        if (packageInfoSource && \"name\" in packageInfoSource) {\n            containerPackageName = packageInfoSource.name;\n            // packageInfoSource is cast to any as it is typed to IContainerPackageInfo instead of IFluidCodeDetails\n        } else if (isFluidPackage((packageInfoSource as any)?.package)) {\n            containerPackageName = (packageInfoSource as any)?.package.name;\n        } else {\n            containerPackageName = (packageInfoSource as any)?.package;\n        }\n        containerPackageName = containerPackageName ?? odspResolvedUrl.codeHint?.containerPackageName;\n\n        const context = await this.getContext?.(odspResolvedUrl, dataStorePath);\n\n        storeLocatorInOdspUrl(shareLinkUrl, {\n            siteUrl: odspResolvedUrl.siteUrl,\n            driveId: odspResolvedUrl.driveId,\n            itemId: odspResolvedUrl.itemId,\n            dataStorePath,\n            appName: this.appName,\n            containerPackageName,\n            fileVersion: odspResolvedUrl.fileVersion,\n            context,\n        });\n\n        return shareLinkUrl.href;\n    }\n\n    /**\n     * Crafts a supported document/driver URL\n     */\n    public static createDocumentUrl(baseUrl: string, driverInfo: OdspFluidDataStoreLocator) {\n        const url = new URL(baseUrl);\n\n        storeLocatorInOdspUrl(url, driverInfo);\n\n        return url.href;\n    }\n\n    /**\n     * Crafts a supported data store nav param\n     * @deprecated encodeOdspFluidDataStoreLocator should be used instead\n     */\n    public static createNavParam(locator: OdspFluidDataStoreLocator) {\n        return encodeOdspFluidDataStoreLocator(locator);\n    }\n}\n"]}

package/dist/odspFluidFileLink.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"odspFluidFileLink.d.ts","sourceRoot":"","sources":["../src/odspFluidFileLink.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,yBAAyB,EAAE,MAAM,mBAAmB,CAAC;AAa9D;;;;GAIG;AACH,wBAAgB,+BAA+B,CAAC,OAAO,EAAE,yBAAyB,GAAG,MAAM,CAuB1F;AAyDD,eAAO,MAAM,qBAAqB,QAAQ,CAAC;AAE3C;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,yBAAyB,QAKjF;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,GAAG,GAAG,yBAAyB,GAAG,SAAS,CAYrF"}
+{"version":3,"file":"odspFluidFileLink.d.ts","sourceRoot":"","sources":["../src/odspFluidFileLink.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,yBAAyB,EAAE,MAAM,mBAAmB,CAAC;AAc9D;;;;GAIG;AACH,wBAAgB,+BAA+B,CAAC,OAAO,EAAE,yBAAyB,GAAG,MAAM,CAwB1F;AA2DD,eAAO,MAAM,qBAAqB,QAAQ,CAAC;AAE3C;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,yBAAyB,QAKjF;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,GAAG,GAAG,yBAAyB,GAAG,SAAS,CAYrF"}

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-77818";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,gCAAgC,CAAC;AACrD,eAAO,MAAM,UAAU,UAAU,CAAC"}
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,gCAAgC,CAAC;AACrD,eAAO,MAAM,UAAU,gBAAgB,CAAC"}

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-77818";
 //# 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,aAAa,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-77818\";\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/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"}