@fluidframework/odsp-driver 2.0.0-internal.2.3.0 → 2.0.0-internal.2.4.0

package/dist/createFile.js.map

@@ -1 +1 @@
-{"version":3,"file":"createFile.js","sourceRoot":"","sources":["../src/createFile.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAsD;AACtD,+DAAiE;AAGjE,qEAAmE;AACnE,qFAQiD;AACjD,2EAAqE;AAIrE,yEAAsE;AACtE,2CAMqB;AAErB,mDAAgD;AAChD,mDAA6C;AAE7C,mEAAgE;AAChE,qDAA+I;AAC/I,6CAA4C;AAC5C,qDAA+D;AAC/D,uDAA0D;AAE1D,MAAM,iBAAiB,GAAG,CAAC,QAAgB,EAAW,EAAE;IACpD,MAAM,iBAAiB,GAAG,gBAAgB,CAAC;IAC3C,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;AAC/C,CAAC,CAAC;AAEF;;;GAGG;AACI,KAAK,UAAU,kBAAkB,CACpC,eAAgD,EAChD,WAAyB,EACzB,MAAwB,EACxB,gBAA0C,EAC1C,YAA0B,EAC1B,SAAqB,EACrB,gBAAyB,EACzB,sCAA+C,EAC/C,iBAA2B,EAC3B,yCAAmD,EACnD,yBAAmC;IAEnC,+EAA+E;IAC/E,IAAI,iBAAiB,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE;QACzC,MAAM,IAAI,gCAAiB;QACvB,2CAA2C;QAC3C,gCAAgC,EAAE,uCAAa,CAAC,oBAAoB,EAAE,EAAE,aAAa,EAAb,2BAAa,EAAE,CAAC,CAAC;KAChG;IAED,IAAI,MAAc,CAAC;IACnB,IAAI,aAAa,GAAW,EAAE,CAAC;IAC/B,IAAI,aAA4C,CAAC;IACjD,IAAI,gBAAgB,KAAK,SAAS,EAAE;QAChC,MAAM,GAAG,MAAM,uBAAuB,CAClC,eAAe,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,sCAAsC,CAAC,CAAC;KACnG;SAAM;QACH,MAAM,OAAO,GAAG,MAAM,6BAA6B,CAC/C,eAAe,EACf,WAAW,EACX,MAAM,EACN,gBAAgB,EAChB,YAAY,EACZ,sCAAsC,CACzC,CAAC;QACF,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QACxB,aAAa,GAAG,OAAO,CAAC,EAAE,CAAC;QAE3B,aAAa,GAAG,oBAAoB,CAChC,WAAW,CAAC,cAAc,EAC1B,OAAO,EACP,yCAAyC,EACzC,yBAAyB,CAAC,CAAC;KAClC;IAED,MAAM,OAAO,GAAG,IAAA,6BAAa,kCAAM,WAAW,KAAE,MAAM,EAAE,aAAa,EAAE,GAAG,IAAG,CAAC;IAC9E,MAAM,QAAQ,GAAG,IAAI,6CAAqB,EAAE,CAAC;IAC7C,MAAM,eAAe,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC;QAC3C,GAAG,EAAE,OAAO;QACZ,OAAO,EAAE,EAAE,CAAC,uCAAqB,CAAC,iBAAiB,CAAC,EAAE,iBAAiB,EAAE;KAC5E,CAAC,CAAC;IACH,SAAS,CAAC,KAAK,GAAG,eAAe,CAAC,gBAAgB,CAAC;IACnD,SAAS,CAAC,WAAW,GAAG,eAAe,CAAC;IAExC,eAAe,CAAC,aAAa,GAAG,aAAa,CAAC;IAE9C,IAAI,gBAAgB,KAAK,SAAS,IAAI,gBAAgB,EAAE;QACpD,IAAA,qBAAM,EAAC,aAAa,KAAK,SAAS,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;QAC/E,iDAAiD;QACjD,MAAM,QAAQ,GAAsB,IAAA,0DAAyC,EAAC,gBAAgB,EAAE,aAAa,CAAC,CAAC;QAC/G,gCAAgC;QAChC,MAAM,YAAY,CAAC,GAAG,CAAC,IAAA,kCAAsB,EAAC,eAAe,CAAC,EAAE,QAAQ,CAAC,CAAC;KAC7E;IACD,OAAO,eAAe,CAAC;AAC3B,CAAC;AAhED,gDAgEC;AAED;;;;;;;;;GASG;AACH,SAAS,oBAAoB,CACzB,wBAAuE,EACvE,QAA6B,EAC7B,yCAAmD,EACnD,yBAAmC;IAEnC,IAAI,CAAC,wBAAwB,EAAE;QAC3B,OAAO;KACV;IACD,IAAI,aAA4C,CAAC;IACjD,IAAI,yCAAyC,EAAE;QAC3C,MAAM,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAC;QAC7B,IAAI,CAAC,OAAO,EAAE;YACV,OAAO;SACV;QACD,aAAa,GAAG;YACZ,UAAU,EAAE;gBACR,IAAI,EAAE,wBAAwB;gBAC9B,IAAI,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC,iBACvB,KAAK,EAAE,OAAO,CAAC,WAAW,CAAC,KAAK,EAChC,IAAI,EAAE,OAAO,CAAC,WAAW,CAAC,IAAI,EAC9B,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,MAAM,IAC/B,OAAO,CAAC,WAAW,EACxB,CAAC,CAAC,SAAS;gBACb,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,OAAO,EAAE,OAAO,CAAC,OAAO;aAC3B;SACJ,CAAC;KACL;SAAM,IAAI,yBAAyB,EAAE;QAClC,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,sBAAsB,EAAE,GAAG,QAAQ,CAAC;QAClE,IAAI,CAAC,WAAW,IAAI,CAAC,sBAAsB,EAAE;YACzC,OAAO;SACV;QACD,aAAa,GAAG;YACZ,UAAU,EAAE;gBACR,IAAI,EAAE,wBAAwB;gBAC9B,IAAI,EAAE,WAAW;gBACjB,KAAK,EAAE,sBAAsB;gBAC7B,OAAO,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO;aAC5B;SACJ,CAAC;KACL;IACD,OAAO,aAAa,CAAC;AACzB,CAAC;AAEM,KAAK,UAAU,uBAAuB,CACzC,eAAgD,EAChD,WAAyB,EACzB,MAAwB,EACxB,YAA0B,EAC1B,sCAA+C;IAE/C,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5F,gEAAgE;IAChE,MAAM,eAAe,GAAG,kBAAkB,CAAC,GAAG,WAAW,CAAC,QAAQ,MAAM,CAAC,CAAC;IAC1E,MAAM,UAAU,GACZ,GAAG,IAAA,0BAAU,EAAC,IAAA,qBAAS,EAAC,WAAW,CAAC,OAAO,CAAC,CAAC,WAAW,WAAW,CAAC,OAAO,gBAAgB,QAC3F,IAAI,eAAe,wEAAwE,CAAC;IAEhG,OAAO,IAAA,uCAA2B,EAAC,KAAK,EAAE,OAAO,EAAE,EAAE;QACjD,MAAM,YAAY,GAAG,MAAM,eAAe,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;QAErE,OAAO,kCAAgB,CAAC,cAAc,CAClC,MAAM,EACN,EAAE,SAAS,EAAE,oBAAoB,EAAE,EACnC,KAAK,EAAE,KAAK,EAAE,EAAE;YACZ,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,IAAA,mDAAwB,EAC7C,UAAU,EAAE,YAAY,EAAE,sCAAsC,CAAC,CAAC;YACtE,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;YAE7C,MAAM,aAAa,GAAG,MAAM,IAAA,yBAAY,EACpC,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,mBAAmB,CACxC,GAAG,EACH;gBACI,IAAI,EAAE,SAAS;gBACf,OAAO;gBACP,MAAM,EAAE,KAAK;aAChB,EACD,YAAY,CACf,EACD,YAAY,EACZ,MAAM,CACT,CAAC;YAEF,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC;YACtC,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE;gBACzB,MAAM,IAAI,gCAAiB;gBACvB,mEAAmE;gBACnE,2DAA2D,EAC3D,oCAAe,CAAC,uBAAuB,EACvC,EAAE,aAAa,EAAb,2BAAa,EAAE,CAAC,CAAC;aAC1B;YACD,KAAK,CAAC,GAAG,iBACL,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,IAC1D,aAAa,CAAC,UAAU,EAC7B,CAAC;YACH,OAAO,OAAO,CAAC,EAAE,CAAC;QACtB,CAAC,EACD,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;AACP,CAAC;AAvDD,0DAuDC;AAEM,KAAK,UAAU,6BAA6B,CAC/C,eAAgD,EAChD,WAAyB,EACzB,MAAwB,EACxB,gBAA8B,EAC9B,YAA0B,EAC1B,sCAA+C;IAE/C,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5F,MAAM,eAAe,GAAG,kBAAkB,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IACjE,MAAM,OAAO,GACT,GAAG,IAAA,0BAAU,EAAC,IAAA,qBAAS,EAAC,WAAW,CAAC,OAAO,CAAC,CAAC,WAAW,WAAW,CAAC,OAAO,cAAc;QACzF,GAAG,QAAQ,IAAI,eAAe,EAAE,CAAC;IAErC,MAAM,iBAAiB,GAAG,IAAA,oDAAmC,EAAC,gBAAgB,CAAC,CAAC;IAEhF,8EAA8E;IAC9E,iGAAiG;IACjG,MAAM,oBAAoB,GAAG,IAAA,uCAA2B,EAAC,WAAW,CAAC,cAAc,CAAC,CAAC;IACrF,MAAM,UAAU,GACZ,GAAG,OAAO,gCAAgC,oBAAoB,CAAC,CAAC,CAAC,IAAI,oBAAoB,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAEvG,OAAO,IAAA,4CAA2B,EAAsB;QACpD,iBAAiB;QACjB,eAAe;QACf,MAAM;QACN,UAAU;QACV,sCAAsC;QACtC,YAAY;QACZ,aAAa,EAAE,eAAe;QAC9B,SAAS,EAAE,YAAY;QACvB,wBAAwB,EAAE,OAAO,CAAC,EAAE;YAChC,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;gBAC7B,MAAM,IAAI,gCAAiB,CACvB,0CAA0C,EAC1C,oCAAe,CAAC,uBAAuB,EACvC,EAAE,aAAa,EAAb,2BAAa,EAAE,CAAC,CAAC;aAC1B;QACL,CAAC;KACR,CAAC,CAAC;AACH,CAAC;AAxCD,sEAwCC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/common-utils\";\nimport { NonRetryableError } from \"@fluidframework/driver-utils\";\nimport { ISummaryTree } from \"@fluidframework/protocol-definitions\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport {\n    InstrumentedStorageTokenFetcher,\n    IOdspResolvedUrl,\n    OdspErrorType,\n    ShareLinkInfoType,\n    ISharingLinkKind,\n    ShareLinkTypes,\n    IFileEntry,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { DriverErrorType } from \"@fluidframework/driver-definitions\";\nimport {\n    ICreateFileResponse,\n} from \"./contracts\";\nimport { getUrlAndHeadersWithAuth } from \"./getUrlAndHeadersWithAuth\";\nimport {\n    buildOdspShareLinkReqParams,\n    createCacheSnapshotKey,\n    getWithRetryForTokenRefresh,\n    INewFileInfo,\n    getOrigin\n} from \"./odspUtils\";\nimport { ISnapshotContents } from \"./odspPublicUtils\";\nimport { createOdspUrl } from \"./createOdspUrl\";\nimport { getApiRoot } from \"./odspUrlHelper\";\nimport { EpochTracker } from \"./epochTracker\";\nimport { OdspDriverUrlResolver } from \"./odspDriverUrlResolver\";\nimport { convertCreateNewSummaryTreeToTreeAndBlobs, convertSummaryIntoContainerSnapshot, createNewFluidContainerCore } from \"./createNewUtils\";\nimport { runWithRetry } from \"./retryUtils\";\nimport { pkgVersion as driverVersion } from \"./packageVersion\";\nimport { ClpCompliantAppHeader } from \"./contractsPublic\";\n\nconst isInvalidFileName = (fileName: string): boolean => {\n    const invalidCharsRegex = /[\"*/:<>?\\\\|]+/g;\n    return !!fileName.match(invalidCharsRegex);\n};\n\n/**\n * Creates a new Fluid file.\n * Returns resolved url\n */\nexport async function createNewFluidFile(\n    getStorageToken: InstrumentedStorageTokenFetcher,\n    newFileInfo: INewFileInfo,\n    logger: ITelemetryLogger,\n    createNewSummary: ISummaryTree | undefined,\n    epochTracker: EpochTracker,\n    fileEntry: IFileEntry,\n    createNewCaching: boolean,\n    forceAccessTokenViaAuthorizationHeader: boolean,\n    isClpCompliantApp?: boolean,\n    enableSingleRequestForShareLinkWithCreate?: boolean,\n    enableShareLinkWithCreate?: boolean\n): Promise<IOdspResolvedUrl> {\n    // Check for valid filename before the request to create file is actually made.\n    if (isInvalidFileName(newFileInfo.filename)) {\n        throw new NonRetryableError(\n            // pre-0.58 error message: Invalid filename\n            \"Invalid filename for createNew\", OdspErrorType.invalidFileNameError, { driverVersion });\n    }\n\n    let itemId: string;\n    let summaryHandle: string = \"\";\n    let shareLinkInfo: ShareLinkInfoType | undefined;\n    if (createNewSummary === undefined) {\n        itemId = await createNewEmptyFluidFile(\n            getStorageToken, newFileInfo, logger, epochTracker, forceAccessTokenViaAuthorizationHeader);\n    } else {\n        const content = await createNewFluidFileFromSummary(\n            getStorageToken,\n            newFileInfo,\n            logger,\n            createNewSummary,\n            epochTracker,\n            forceAccessTokenViaAuthorizationHeader,\n        );\n        itemId = content.itemId;\n        summaryHandle = content.id;\n\n        shareLinkInfo = extractShareLinkData(\n            newFileInfo.createLinkType,\n            content,\n            enableSingleRequestForShareLinkWithCreate,\n            enableShareLinkWithCreate);\n    }\n\n    const odspUrl = createOdspUrl({ ...newFileInfo, itemId, dataStorePath: \"/\" });\n    const resolver = new OdspDriverUrlResolver();\n    const odspResolvedUrl = await resolver.resolve({\n        url: odspUrl,\n        headers: { [ClpCompliantAppHeader.isClpCompliantApp]: isClpCompliantApp },\n    });\n    fileEntry.docId = odspResolvedUrl.hashedDocumentId;\n    fileEntry.resolvedUrl = odspResolvedUrl;\n\n    odspResolvedUrl.shareLinkInfo = shareLinkInfo;\n\n    if (createNewSummary !== undefined && createNewCaching) {\n        assert(summaryHandle !== undefined, 0x203 /* \"Summary handle is undefined\" */);\n        // converting summary and getting sequence number\n        const snapshot: ISnapshotContents = convertCreateNewSummaryTreeToTreeAndBlobs(createNewSummary, summaryHandle);\n        // caching the converted summary\n        await epochTracker.put(createCacheSnapshotKey(odspResolvedUrl), snapshot);\n    }\n    return odspResolvedUrl;\n}\n\n/**\n * If user requested creation of a sharing link along with the creation of the file by providing either\n * createLinkType (now deprecated) or createLinkScope in the request parameters, extract and save\n * sharing link information from the response if it is available.\n * In case there was an error in creation of the sharing link, error is provided back in the response,\n * and does not impact the creation of file in ODSP.\n * @param requestedSharingLinkKind - Kind of sharing link requested to be created along with the creation of file.\n * @param response - Response object received from the /snapshot api call\n * @returns Sharing link information received in the response from a successful creation of a file.\n */\nfunction extractShareLinkData(\n    requestedSharingLinkKind: ShareLinkTypes | ISharingLinkKind | undefined,\n    response: ICreateFileResponse,\n    enableSingleRequestForShareLinkWithCreate?: boolean,\n    enableShareLinkWithCreate?: boolean,\n): ShareLinkInfoType | undefined {\n    if (!requestedSharingLinkKind) {\n        return;\n    }\n    let shareLinkInfo: ShareLinkInfoType | undefined;\n    if (enableSingleRequestForShareLinkWithCreate) {\n        const { sharing } = response;\n        if (!sharing) {\n            return;\n        }\n        shareLinkInfo = {\n            createLink: {\n                type: requestedSharingLinkKind,\n                link: sharing.sharingLink ? {\n                    scope: sharing.sharingLink.scope,\n                    role: sharing.sharingLink.type,\n                    webUrl: sharing.sharingLink.webUrl,\n                    ...sharing.sharingLink,\n                } : undefined,\n                error: sharing.error,\n                shareId: sharing.shareId,\n            },\n        };\n    } else if (enableShareLinkWithCreate) {\n        const { sharing, sharingLink, sharingLinkErrorReason } = response;\n        if (!sharingLink && !sharingLinkErrorReason) {\n            return;\n        }\n        shareLinkInfo = {\n            createLink: {\n                type: requestedSharingLinkKind,\n                link: sharingLink,\n                error: sharingLinkErrorReason,\n                shareId: sharing?.shareId,\n            },\n        };\n    }\n    return shareLinkInfo;\n}\n\nexport async function createNewEmptyFluidFile(\n    getStorageToken: InstrumentedStorageTokenFetcher,\n    newFileInfo: INewFileInfo,\n    logger: ITelemetryLogger,\n    epochTracker: EpochTracker,\n    forceAccessTokenViaAuthorizationHeader: boolean,\n): Promise<string> {\n    const filePath = newFileInfo.filePath ? encodeURIComponent(`/${newFileInfo.filePath}`) : \"\";\n    // add .tmp extension to empty file (host is expected to rename)\n    const encodedFilename = encodeURIComponent(`${newFileInfo.filename}.tmp`);\n    const initialUrl =\n        `${getApiRoot(getOrigin(newFileInfo.siteUrl))}/drives/${newFileInfo.driveId}/items/root:/${filePath\n        }/${encodedFilename}:/content?@name.conflictBehavior=rename&select=id,name,parentReference`;\n\n    return getWithRetryForTokenRefresh(async (options) => {\n        const storageToken = await getStorageToken(options, \"CreateNewFile\");\n\n        return PerformanceEvent.timedExecAsync(\n            logger,\n            { eventName: \"createNewEmptyFile\" },\n            async (event) => {\n                const { url, headers } = getUrlAndHeadersWithAuth(\n                    initialUrl, storageToken, forceAccessTokenViaAuthorizationHeader);\n                headers[\"Content-Type\"] = \"application/json\";\n\n                const fetchResponse = await runWithRetry(\n                    async () => epochTracker.fetchAndParseAsJSON<ICreateFileResponse>(\n                        url,\n                        {\n                            body: undefined,\n                            headers,\n                            method: \"PUT\",\n                        },\n                        \"createFile\",\n                    ),\n                    \"createFile\",\n                    logger,\n                );\n\n                const content = fetchResponse.content;\n                if (!content || !content.id) {\n                    throw new NonRetryableError(\n                        // pre-0.58 error message: ODSP CreateFile call returned no item ID\n                        \"ODSP CreateFile call returned no item ID (for empty file)\",\n                        DriverErrorType.incorrectServerResponse,\n                        { driverVersion });\n                }\n                event.end({\n                    headers: Object.keys(headers).length !== 0 ? true : undefined,\n                    ...fetchResponse.propsToLog,\n                });\n                return content.id;\n            },\n            { end: true, cancel: \"error\" });\n    });\n}\n\nexport async function createNewFluidFileFromSummary(\n    getStorageToken: InstrumentedStorageTokenFetcher,\n    newFileInfo: INewFileInfo,\n    logger: ITelemetryLogger,\n    createNewSummary: ISummaryTree,\n    epochTracker: EpochTracker,\n    forceAccessTokenViaAuthorizationHeader: boolean,\n): Promise<ICreateFileResponse> {\n    const filePath = newFileInfo.filePath ? encodeURIComponent(`/${newFileInfo.filePath}`) : \"\";\n    const encodedFilename = encodeURIComponent(newFileInfo.filename);\n    const baseUrl =\n        `${getApiRoot(getOrigin(newFileInfo.siteUrl))}/drives/${newFileInfo.driveId}/items/root:` +\n        `${filePath}/${encodedFilename}`;\n\n    const containerSnapshot = convertSummaryIntoContainerSnapshot(createNewSummary);\n\n    // Build share link parameter based on the createLinkType provided so that the\n    // snapshot api can create and return the share link along with creation of file in the response.\n    const createShareLinkParam = buildOdspShareLinkReqParams(newFileInfo.createLinkType);\n    const initialUrl =\n        `${baseUrl}:/opStream/snapshots/snapshot${createShareLinkParam ? `?${createShareLinkParam}` : \"\"}`;\n\n    return createNewFluidContainerCore<ICreateFileResponse>({\n        containerSnapshot,\n        getStorageToken,\n        logger,\n        initialUrl,\n        forceAccessTokenViaAuthorizationHeader,\n        epochTracker,\n        telemetryName: \"CreateNewFile\",\n        fetchType: \"createFile\",\n        validateResponseCallback: content => {\n            if (!content || !content.itemId) {\n                throw new NonRetryableError(\n                    \"ODSP CreateFile call returned no item ID\",\n                    DriverErrorType.incorrectServerResponse,\n                    { driverVersion });\n            }\n        }\n});\n}\n"]}
+{"version":3,"file":"createFile.js","sourceRoot":"","sources":["../src/createFile.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAsD;AACtD,+DAAiE;AAGjE,qEAAmE;AACnE,qFAQiD;AACjD,2EAAqE;AAIrE,yEAAsE;AACtE,2CAMqB;AAErB,mDAAgD;AAChD,mDAA6C;AAE7C,mEAAgE;AAChE,qDAA+I;AAC/I,6CAA4C;AAC5C,qDAA+D;AAC/D,uDAA0D;AAE1D,MAAM,iBAAiB,GAAG,CAAC,QAAgB,EAAW,EAAE;IACpD,MAAM,iBAAiB,GAAG,gBAAgB,CAAC;IAC3C,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;AAC/C,CAAC,CAAC;AAEF;;;GAGG;AACI,KAAK,UAAU,kBAAkB,CACpC,eAAgD,EAChD,WAAyB,EACzB,MAAwB,EACxB,gBAA0C,EAC1C,YAA0B,EAC1B,SAAqB,EACrB,gBAAyB,EACzB,sCAA+C,EAC/C,iBAA2B,EAC3B,yCAAmD,EACnD,yBAAmC;IAEnC,+EAA+E;IAC/E,IAAI,iBAAiB,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE;QACzC,MAAM,IAAI,gCAAiB;QACvB,2CAA2C;QAC3C,gCAAgC,EAAE,uCAAa,CAAC,oBAAoB,EAAE,EAAE,aAAa,EAAb,2BAAa,EAAE,CAAC,CAAC;KAChG;IAED,IAAI,MAAc,CAAC;IACnB,IAAI,aAAa,GAAW,EAAE,CAAC;IAC/B,IAAI,aAA4C,CAAC;IACjD,IAAI,gBAAgB,KAAK,SAAS,EAAE;QAChC,MAAM,GAAG,MAAM,uBAAuB,CAClC,eAAe,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,sCAAsC,CAAC,CAAC;KACnG;SAAM;QACH,MAAM,OAAO,GAAG,MAAM,6BAA6B,CAC/C,eAAe,EACf,WAAW,EACX,MAAM,EACN,gBAAgB,EAChB,YAAY,EACZ,sCAAsC,CACzC,CAAC;QACF,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QACxB,aAAa,GAAG,OAAO,CAAC,EAAE,CAAC;QAE3B,aAAa,GAAG,oBAAoB,CAChC,WAAW,CAAC,cAAc,EAC1B,OAAO,EACP,yCAAyC,EACzC,yBAAyB,CAAC,CAAC;KAClC;IAED,MAAM,OAAO,GAAG,IAAA,6BAAa,kCAAM,WAAW,KAAE,MAAM,EAAE,aAAa,EAAE,GAAG,IAAG,CAAC;IAC9E,MAAM,QAAQ,GAAG,IAAI,6CAAqB,EAAE,CAAC;IAC7C,MAAM,eAAe,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC;QAC3C,GAAG,EAAE,OAAO;QACZ,OAAO,EAAE,EAAE,CAAC,uCAAqB,CAAC,iBAAiB,CAAC,EAAE,iBAAiB,EAAE;KAC5E,CAAC,CAAC;IACH,SAAS,CAAC,KAAK,GAAG,eAAe,CAAC,gBAAgB,CAAC;IACnD,SAAS,CAAC,WAAW,GAAG,eAAe,CAAC;IAExC,eAAe,CAAC,aAAa,GAAG,aAAa,CAAC;IAE9C,IAAI,gBAAgB,KAAK,SAAS,IAAI,gBAAgB,EAAE;QACpD,IAAA,qBAAM,EAAC,aAAa,KAAK,SAAS,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;QAC/E,iDAAiD;QACjD,MAAM,QAAQ,GAAsB,IAAA,0DAAyC,EAAC,gBAAgB,EAAE,aAAa,CAAC,CAAC;QAC/G,gCAAgC;QAChC,MAAM,YAAY,CAAC,GAAG,CAAC,IAAA,kCAAsB,EAAC,eAAe,CAAC,EAAE,QAAQ,CAAC,CAAC;KAC7E;IACD,OAAO,eAAe,CAAC;AAC3B,CAAC;AAhED,gDAgEC;AAED;;;;;;;;;GASG;AACH,SAAS,oBAAoB,CACzB,wBAAuE,EACvE,QAA6B,EAC7B,yCAAmD,EACnD,yBAAmC;IAEnC,IAAI,CAAC,wBAAwB,EAAE;QAC3B,OAAO;KACV;IACD,IAAI,aAA4C,CAAC;IACjD,IAAI,yCAAyC,EAAE;QAC3C,MAAM,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAC;QAC7B,IAAI,CAAC,OAAO,EAAE;YACV,OAAO;SACV;QACD,aAAa,GAAG;YACZ,UAAU,EAAE;gBACR,IAAI,EAAE,wBAAwB;gBAC9B,IAAI,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC,iBACvB,KAAK,EAAE,OAAO,CAAC,WAAW,CAAC,KAAK,EAChC,IAAI,EAAE,OAAO,CAAC,WAAW,CAAC,IAAI,EAC9B,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,MAAM,IAC/B,OAAO,CAAC,WAAW,EACxB,CAAC,CAAC,SAAS;gBACb,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,OAAO,EAAE,OAAO,CAAC,OAAO;aAC3B;SACJ,CAAC;KACL;SAAM,IAAI,yBAAyB,EAAE;QAClC,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,sBAAsB,EAAE,GAAG,QAAQ,CAAC;QAClE,IAAI,CAAC,WAAW,IAAI,CAAC,sBAAsB,EAAE;YACzC,OAAO;SACV;QACD,aAAa,GAAG;YACZ,UAAU,EAAE;gBACR,IAAI,EAAE,wBAAwB;gBAC9B,IAAI,EAAE,WAAW;gBACjB,KAAK,EAAE,sBAAsB;gBAC7B,OAAO,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO;aAC5B;SACJ,CAAC;KACL;IACD,OAAO,aAAa,CAAC;AACzB,CAAC;AAEM,KAAK,UAAU,uBAAuB,CACzC,eAAgD,EAChD,WAAyB,EACzB,MAAwB,EACxB,YAA0B,EAC1B,sCAA+C;IAE/C,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5F,gEAAgE;IAChE,MAAM,eAAe,GAAG,kBAAkB,CAAC,GAAG,WAAW,CAAC,QAAQ,MAAM,CAAC,CAAC;IAC1E,MAAM,UAAU,GACZ,GAAG,IAAA,0BAAU,EAAC,IAAA,qBAAS,EAAC,WAAW,CAAC,OAAO,CAAC,CAAC,WAAW,WAAW,CAAC,OAAO,gBAAgB,QAC3F,IAAI,eAAe,wEAAwE,CAAC;IAEhG,OAAO,IAAA,uCAA2B,EAAC,KAAK,EAAE,OAAO,EAAE,EAAE;QACjD,MAAM,YAAY,GAAG,MAAM,eAAe,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;QAErE,OAAO,kCAAgB,CAAC,cAAc,CAClC,MAAM,EACN,EAAE,SAAS,EAAE,oBAAoB,EAAE,EACnC,KAAK,EAAE,KAAK,EAAE,EAAE;YACZ,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,IAAA,mDAAwB,EAC7C,UAAU,EAAE,YAAY,EAAE,sCAAsC,CAAC,CAAC;YACtE,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;YAE7C,MAAM,aAAa,GAAG,MAAM,IAAA,yBAAY,EACpC,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,mBAAmB,CACxC,GAAG,EACH;gBACI,IAAI,EAAE,SAAS;gBACf,OAAO;gBACP,MAAM,EAAE,KAAK;aAChB,EACD,YAAY,CACf,EACD,YAAY,EACZ,MAAM,CACT,CAAC;YAEF,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC;YACtC,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE;gBACzB,MAAM,IAAI,gCAAiB;gBACvB,mEAAmE;gBACnE,2DAA2D,EAC3D,oCAAe,CAAC,uBAAuB,EACvC,EAAE,aAAa,EAAb,2BAAa,EAAE,CAAC,CAAC;aAC1B;YACD,KAAK,CAAC,GAAG,iBACL,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,IAC1D,aAAa,CAAC,UAAU,EAC7B,CAAC;YACH,OAAO,OAAO,CAAC,EAAE,CAAC;QACtB,CAAC,EACD,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;AACP,CAAC;AAvDD,0DAuDC;AAEM,KAAK,UAAU,6BAA6B,CAC/C,eAAgD,EAChD,WAAyB,EACzB,MAAwB,EACxB,gBAA8B,EAC9B,YAA0B,EAC1B,sCAA+C;IAE/C,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5F,MAAM,eAAe,GAAG,kBAAkB,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IACjE,MAAM,OAAO,GACT,GAAG,IAAA,0BAAU,EAAC,IAAA,qBAAS,EAAC,WAAW,CAAC,OAAO,CAAC,CAAC,WAAW,WAAW,CAAC,OAAO,cAAc;QACzF,GAAG,QAAQ,IAAI,eAAe,EAAE,CAAC;IAErC,MAAM,iBAAiB,GAAG,IAAA,oDAAmC,EAAC,gBAAgB,CAAC,CAAC;IAEhF,8EAA8E;IAC9E,iGAAiG;IACjG,MAAM,oBAAoB,GAAG,IAAA,uCAA2B,EAAC,WAAW,CAAC,cAAc,CAAC,CAAC;IACrF,MAAM,UAAU,GACZ,GAAG,OAAO,gCAAgC,oBAAoB,CAAC,CAAC,CAAC,IAAI,oBAAoB,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAEvG,OAAO,IAAA,4CAA2B,EAAsB;QACpD,iBAAiB;QACjB,eAAe;QACf,MAAM;QACN,UAAU;QACV,sCAAsC;QACtC,YAAY;QACZ,aAAa,EAAE,eAAe;QAC9B,SAAS,EAAE,YAAY;QACvB,wBAAwB,EAAE,OAAO,CAAC,EAAE;YAChC,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;gBAC7B,MAAM,IAAI,gCAAiB,CACvB,0CAA0C,EAC1C,oCAAe,CAAC,uBAAuB,EACvC,EAAE,aAAa,EAAb,2BAAa,EAAE,CAAC,CAAC;aAC1B;QACL,CAAC;KACJ,CAAC,CAAC;AACP,CAAC;AAxCD,sEAwCC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/common-utils\";\nimport { NonRetryableError } from \"@fluidframework/driver-utils\";\nimport { ISummaryTree } from \"@fluidframework/protocol-definitions\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport {\n    InstrumentedStorageTokenFetcher,\n    IOdspResolvedUrl,\n    OdspErrorType,\n    ShareLinkInfoType,\n    ISharingLinkKind,\n    ShareLinkTypes,\n    IFileEntry,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { DriverErrorType } from \"@fluidframework/driver-definitions\";\nimport {\n    ICreateFileResponse,\n} from \"./contracts\";\nimport { getUrlAndHeadersWithAuth } from \"./getUrlAndHeadersWithAuth\";\nimport {\n    buildOdspShareLinkReqParams,\n    createCacheSnapshotKey,\n    getWithRetryForTokenRefresh,\n    INewFileInfo,\n    getOrigin\n} from \"./odspUtils\";\nimport { ISnapshotContents } from \"./odspPublicUtils\";\nimport { createOdspUrl } from \"./createOdspUrl\";\nimport { getApiRoot } from \"./odspUrlHelper\";\nimport { EpochTracker } from \"./epochTracker\";\nimport { OdspDriverUrlResolver } from \"./odspDriverUrlResolver\";\nimport { convertCreateNewSummaryTreeToTreeAndBlobs, convertSummaryIntoContainerSnapshot, createNewFluidContainerCore } from \"./createNewUtils\";\nimport { runWithRetry } from \"./retryUtils\";\nimport { pkgVersion as driverVersion } from \"./packageVersion\";\nimport { ClpCompliantAppHeader } from \"./contractsPublic\";\n\nconst isInvalidFileName = (fileName: string): boolean => {\n    const invalidCharsRegex = /[\"*/:<>?\\\\|]+/g;\n    return !!fileName.match(invalidCharsRegex);\n};\n\n/**\n * Creates a new Fluid file.\n * Returns resolved url\n */\nexport async function createNewFluidFile(\n    getStorageToken: InstrumentedStorageTokenFetcher,\n    newFileInfo: INewFileInfo,\n    logger: ITelemetryLogger,\n    createNewSummary: ISummaryTree | undefined,\n    epochTracker: EpochTracker,\n    fileEntry: IFileEntry,\n    createNewCaching: boolean,\n    forceAccessTokenViaAuthorizationHeader: boolean,\n    isClpCompliantApp?: boolean,\n    enableSingleRequestForShareLinkWithCreate?: boolean,\n    enableShareLinkWithCreate?: boolean\n): Promise<IOdspResolvedUrl> {\n    // Check for valid filename before the request to create file is actually made.\n    if (isInvalidFileName(newFileInfo.filename)) {\n        throw new NonRetryableError(\n            // pre-0.58 error message: Invalid filename\n            \"Invalid filename for createNew\", OdspErrorType.invalidFileNameError, { driverVersion });\n    }\n\n    let itemId: string;\n    let summaryHandle: string = \"\";\n    let shareLinkInfo: ShareLinkInfoType | undefined;\n    if (createNewSummary === undefined) {\n        itemId = await createNewEmptyFluidFile(\n            getStorageToken, newFileInfo, logger, epochTracker, forceAccessTokenViaAuthorizationHeader);\n    } else {\n        const content = await createNewFluidFileFromSummary(\n            getStorageToken,\n            newFileInfo,\n            logger,\n            createNewSummary,\n            epochTracker,\n            forceAccessTokenViaAuthorizationHeader,\n        );\n        itemId = content.itemId;\n        summaryHandle = content.id;\n\n        shareLinkInfo = extractShareLinkData(\n            newFileInfo.createLinkType,\n            content,\n            enableSingleRequestForShareLinkWithCreate,\n            enableShareLinkWithCreate);\n    }\n\n    const odspUrl = createOdspUrl({ ...newFileInfo, itemId, dataStorePath: \"/\" });\n    const resolver = new OdspDriverUrlResolver();\n    const odspResolvedUrl = await resolver.resolve({\n        url: odspUrl,\n        headers: { [ClpCompliantAppHeader.isClpCompliantApp]: isClpCompliantApp },\n    });\n    fileEntry.docId = odspResolvedUrl.hashedDocumentId;\n    fileEntry.resolvedUrl = odspResolvedUrl;\n\n    odspResolvedUrl.shareLinkInfo = shareLinkInfo;\n\n    if (createNewSummary !== undefined && createNewCaching) {\n        assert(summaryHandle !== undefined, 0x203 /* \"Summary handle is undefined\" */);\n        // converting summary and getting sequence number\n        const snapshot: ISnapshotContents = convertCreateNewSummaryTreeToTreeAndBlobs(createNewSummary, summaryHandle);\n        // caching the converted summary\n        await epochTracker.put(createCacheSnapshotKey(odspResolvedUrl), snapshot);\n    }\n    return odspResolvedUrl;\n}\n\n/**\n * If user requested creation of a sharing link along with the creation of the file by providing either\n * createLinkType (now deprecated) or createLinkScope in the request parameters, extract and save\n * sharing link information from the response if it is available.\n * In case there was an error in creation of the sharing link, error is provided back in the response,\n * and does not impact the creation of file in ODSP.\n * @param requestedSharingLinkKind - Kind of sharing link requested to be created along with the creation of file.\n * @param response - Response object received from the /snapshot api call\n * @returns Sharing link information received in the response from a successful creation of a file.\n */\nfunction extractShareLinkData(\n    requestedSharingLinkKind: ShareLinkTypes | ISharingLinkKind | undefined,\n    response: ICreateFileResponse,\n    enableSingleRequestForShareLinkWithCreate?: boolean,\n    enableShareLinkWithCreate?: boolean,\n): ShareLinkInfoType | undefined {\n    if (!requestedSharingLinkKind) {\n        return;\n    }\n    let shareLinkInfo: ShareLinkInfoType | undefined;\n    if (enableSingleRequestForShareLinkWithCreate) {\n        const { sharing } = response;\n        if (!sharing) {\n            return;\n        }\n        shareLinkInfo = {\n            createLink: {\n                type: requestedSharingLinkKind,\n                link: sharing.sharingLink ? {\n                    scope: sharing.sharingLink.scope,\n                    role: sharing.sharingLink.type,\n                    webUrl: sharing.sharingLink.webUrl,\n                    ...sharing.sharingLink,\n                } : undefined,\n                error: sharing.error,\n                shareId: sharing.shareId,\n            },\n        };\n    } else if (enableShareLinkWithCreate) {\n        const { sharing, sharingLink, sharingLinkErrorReason } = response;\n        if (!sharingLink && !sharingLinkErrorReason) {\n            return;\n        }\n        shareLinkInfo = {\n            createLink: {\n                type: requestedSharingLinkKind,\n                link: sharingLink,\n                error: sharingLinkErrorReason,\n                shareId: sharing?.shareId,\n            },\n        };\n    }\n    return shareLinkInfo;\n}\n\nexport async function createNewEmptyFluidFile(\n    getStorageToken: InstrumentedStorageTokenFetcher,\n    newFileInfo: INewFileInfo,\n    logger: ITelemetryLogger,\n    epochTracker: EpochTracker,\n    forceAccessTokenViaAuthorizationHeader: boolean,\n): Promise<string> {\n    const filePath = newFileInfo.filePath ? encodeURIComponent(`/${newFileInfo.filePath}`) : \"\";\n    // add .tmp extension to empty file (host is expected to rename)\n    const encodedFilename = encodeURIComponent(`${newFileInfo.filename}.tmp`);\n    const initialUrl =\n        `${getApiRoot(getOrigin(newFileInfo.siteUrl))}/drives/${newFileInfo.driveId}/items/root:/${filePath\n        }/${encodedFilename}:/content?@name.conflictBehavior=rename&select=id,name,parentReference`;\n\n    return getWithRetryForTokenRefresh(async (options) => {\n        const storageToken = await getStorageToken(options, \"CreateNewFile\");\n\n        return PerformanceEvent.timedExecAsync(\n            logger,\n            { eventName: \"createNewEmptyFile\" },\n            async (event) => {\n                const { url, headers } = getUrlAndHeadersWithAuth(\n                    initialUrl, storageToken, forceAccessTokenViaAuthorizationHeader);\n                headers[\"Content-Type\"] = \"application/json\";\n\n                const fetchResponse = await runWithRetry(\n                    async () => epochTracker.fetchAndParseAsJSON<ICreateFileResponse>(\n                        url,\n                        {\n                            body: undefined,\n                            headers,\n                            method: \"PUT\",\n                        },\n                        \"createFile\",\n                    ),\n                    \"createFile\",\n                    logger,\n                );\n\n                const content = fetchResponse.content;\n                if (!content || !content.id) {\n                    throw new NonRetryableError(\n                        // pre-0.58 error message: ODSP CreateFile call returned no item ID\n                        \"ODSP CreateFile call returned no item ID (for empty file)\",\n                        DriverErrorType.incorrectServerResponse,\n                        { driverVersion });\n                }\n                event.end({\n                    headers: Object.keys(headers).length !== 0 ? true : undefined,\n                    ...fetchResponse.propsToLog,\n                });\n                return content.id;\n            },\n            { end: true, cancel: \"error\" });\n    });\n}\n\nexport async function createNewFluidFileFromSummary(\n    getStorageToken: InstrumentedStorageTokenFetcher,\n    newFileInfo: INewFileInfo,\n    logger: ITelemetryLogger,\n    createNewSummary: ISummaryTree,\n    epochTracker: EpochTracker,\n    forceAccessTokenViaAuthorizationHeader: boolean,\n): Promise<ICreateFileResponse> {\n    const filePath = newFileInfo.filePath ? encodeURIComponent(`/${newFileInfo.filePath}`) : \"\";\n    const encodedFilename = encodeURIComponent(newFileInfo.filename);\n    const baseUrl =\n        `${getApiRoot(getOrigin(newFileInfo.siteUrl))}/drives/${newFileInfo.driveId}/items/root:` +\n        `${filePath}/${encodedFilename}`;\n\n    const containerSnapshot = convertSummaryIntoContainerSnapshot(createNewSummary);\n\n    // Build share link parameter based on the createLinkType provided so that the\n    // snapshot api can create and return the share link along with creation of file in the response.\n    const createShareLinkParam = buildOdspShareLinkReqParams(newFileInfo.createLinkType);\n    const initialUrl =\n        `${baseUrl}:/opStream/snapshots/snapshot${createShareLinkParam ? `?${createShareLinkParam}` : \"\"}`;\n\n    return createNewFluidContainerCore<ICreateFileResponse>({\n        containerSnapshot,\n        getStorageToken,\n        logger,\n        initialUrl,\n        forceAccessTokenViaAuthorizationHeader,\n        epochTracker,\n        telemetryName: \"CreateNewFile\",\n        fetchType: \"createFile\",\n        validateResponseCallback: content => {\n            if (!content || !content.itemId) {\n                throw new NonRetryableError(\n                    \"ODSP CreateFile call returned no item ID\",\n                    DriverErrorType.incorrectServerResponse,\n                    { driverVersion });\n            }\n        }\n    });\n}\n"]}

package/dist/createNewContainerOnExistingFile.d.ts

@@ -0,0 +1,18 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ISummaryTree } from "@fluidframework/protocol-definitions";
+import { ITelemetryLogger } from "@fluidframework/common-definitions";
+import { IFileEntry, InstrumentedStorageTokenFetcher, IOdspResolvedUrl } from "@fluidframework/odsp-driver-definitions";
+import { IExistingFileInfo } from "./odspUtils";
+import { EpochTracker } from "./epochTracker";
+/**
+ * Creates a new Fluid container on an existing file.
+ * This requires service's capability to manage Fluid container inside an existing file.
+ * @example - This enables a scenario where Fluid data is not stored as a standalone file but in a way that is managed
+ *  by an existing file. For example, SharePoint Pages is able to store Fluid container in an
+ *  "alternative file partition" where the main File stub is an ASPX page.
+ */
+export declare function createNewContainerOnExistingFile(getStorageToken: InstrumentedStorageTokenFetcher, fileInfo: IExistingFileInfo, logger: ITelemetryLogger, createNewSummary: ISummaryTree | undefined, epochTracker: EpochTracker, fileEntry: IFileEntry, createNewCaching: boolean, forceAccessTokenViaAuthorizationHeader: boolean, isClpCompliantApp?: boolean): Promise<IOdspResolvedUrl>;
+//# sourceMappingURL=createNewContainerOnExistingFile.d.ts.map

package/dist/createNewContainerOnExistingFile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createNewContainerOnExistingFile.d.ts","sourceRoot":"","sources":["../src/createNewContainerOnExistingFile.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AACpE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAEtE,OAAO,EACH,UAAU,EACV,+BAA+B,EAC/B,gBAAgB,EACnB,MAAM,yCAAyC,CAAC;AAEjD,OAAO,EAGH,iBAAiB,EACpB,MAAM,aAAa,CAAC;AAIrB,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAK9C;;;;;;GAMG;AACH,wBAAsB,gCAAgC,CAClD,eAAe,EAAE,+BAA+B,EAChD,QAAQ,EAAE,iBAAiB,EAC3B,MAAM,EAAE,gBAAgB,EACxB,gBAAgB,EAAE,YAAY,GAAG,SAAS,EAC1C,YAAY,EAAE,YAAY,EAC1B,SAAS,EAAE,UAAU,EACrB,gBAAgB,EAAE,OAAO,EACzB,sCAAsC,EAAE,OAAO,EAC/C,iBAAiB,CAAC,EAAE,OAAO,GAC5B,OAAO,CAAC,gBAAgB,CAAC,CAuC3B"}

package/dist/createNewContainerOnExistingFile.js

@@ -0,0 +1,56 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createNewContainerOnExistingFile = void 0;
+const driver_utils_1 = require("@fluidframework/driver-utils");
+const odspUtils_1 = require("./odspUtils");
+const createOdspUrl_1 = require("./createOdspUrl");
+const odspUrlHelper_1 = require("./odspUrlHelper");
+const odspDriverUrlResolver_1 = require("./odspDriverUrlResolver");
+const createNewUtils_1 = require("./createNewUtils");
+const contractsPublic_1 = require("./contractsPublic");
+/**
+ * Creates a new Fluid container on an existing file.
+ * This requires service's capability to manage Fluid container inside an existing file.
+ * @example - This enables a scenario where Fluid data is not stored as a standalone file but in a way that is managed
+ *  by an existing file. For example, SharePoint Pages is able to store Fluid container in an
+ *  "alternative file partition" where the main File stub is an ASPX page.
+ */
+async function createNewContainerOnExistingFile(getStorageToken, fileInfo, logger, createNewSummary, epochTracker, fileEntry, createNewCaching, forceAccessTokenViaAuthorizationHeader, isClpCompliantApp) {
+    if (createNewSummary === undefined) {
+        throw new driver_utils_1.UsageError("createNewSummary must exist to create a new container");
+    }
+    const baseUrl = `${(0, odspUrlHelper_1.getApiRoot)((0, odspUtils_1.getOrigin)(fileInfo.siteUrl))}/drives/${fileInfo.driveId}/items/${fileInfo.itemId}`;
+    const containerSnapshot = (0, createNewUtils_1.convertSummaryIntoContainerSnapshot)(createNewSummary);
+    const initialUrl = `${baseUrl}/opStream/snapshots/snapshot`;
+    const { id: summaryHandle } = await (0, createNewUtils_1.createNewFluidContainerCore)({
+        containerSnapshot,
+        getStorageToken,
+        logger,
+        initialUrl,
+        forceAccessTokenViaAuthorizationHeader,
+        epochTracker,
+        telemetryName: "CreateNewContainerOnExistingFile",
+        fetchType: "uploadSummary"
+    });
+    const odspUrl = (0, createOdspUrl_1.createOdspUrl)(Object.assign(Object.assign({}, fileInfo), { dataStorePath: "/" }));
+    const resolver = new odspDriverUrlResolver_1.OdspDriverUrlResolver();
+    const odspResolvedUrl = await resolver.resolve({
+        url: odspUrl,
+        headers: { [contractsPublic_1.ClpCompliantAppHeader.isClpCompliantApp]: isClpCompliantApp },
+    });
+    fileEntry.docId = odspResolvedUrl.hashedDocumentId;
+    fileEntry.resolvedUrl = odspResolvedUrl;
+    if (createNewCaching) {
+        // converting summary and getting sequence number
+        const snapshot = (0, createNewUtils_1.convertCreateNewSummaryTreeToTreeAndBlobs)(createNewSummary, summaryHandle);
+        // caching the converted summary
+        await epochTracker.put((0, odspUtils_1.createCacheSnapshotKey)(odspResolvedUrl), snapshot);
+    }
+    return odspResolvedUrl;
+}
+exports.createNewContainerOnExistingFile = createNewContainerOnExistingFile;
+//# sourceMappingURL=createNewContainerOnExistingFile.js.map

package/dist/createNewContainerOnExistingFile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createNewContainerOnExistingFile.js","sourceRoot":"","sources":["../src/createNewContainerOnExistingFile.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH,+DAA0D;AAO1D,2CAIqB;AAErB,mDAAgD;AAChD,mDAA6C;AAE7C,mEAAgE;AAChE,qDAA+I;AAC/I,uDAA0D;AAE1D;;;;;;GAMG;AACI,KAAK,UAAU,gCAAgC,CAClD,eAAgD,EAChD,QAA2B,EAC3B,MAAwB,EACxB,gBAA0C,EAC1C,YAA0B,EAC1B,SAAqB,EACrB,gBAAyB,EACzB,sCAA+C,EAC/C,iBAA2B;IAE3B,IAAI,gBAAgB,KAAK,SAAS,EAAE;QAChC,MAAM,IAAI,yBAAU,CAAC,uDAAuD,CAAC,CAAC;KACjF;IAED,MAAM,OAAO,GAAG,GAAG,IAAA,0BAAU,EAAC,IAAA,qBAAS,EAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,WAAW,QAAQ,CAAC,OAAO,UAAU,QAAQ,CAAC,MAAM,EAAE,CAAC;IAEjH,MAAM,iBAAiB,GAAG,IAAA,oDAAmC,EAAC,gBAAgB,CAAC,CAAC;IAEhF,MAAM,UAAU,GAAG,GAAG,OAAO,8BAA8B,CAAC;IAE5D,MAAM,EAAE,EAAE,EAAE,aAAa,EAAE,GAAG,MAAM,IAAA,4CAA2B,EAAwB;QACnF,iBAAiB;QACjB,eAAe;QACf,MAAM;QACN,UAAU;QACV,sCAAsC;QACtC,YAAY;QACZ,aAAa,EAAE,kCAAkC;QACjD,SAAS,EAAE,eAAe;KAC7B,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,IAAA,6BAAa,kCAAM,QAAQ,KAAE,aAAa,EAAE,GAAG,IAAG,CAAC;IACnE,MAAM,QAAQ,GAAG,IAAI,6CAAqB,EAAE,CAAC;IAC7C,MAAM,eAAe,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC;QAC3C,GAAG,EAAE,OAAO;QACZ,OAAO,EAAE,EAAE,CAAC,uCAAqB,CAAC,iBAAiB,CAAC,EAAE,iBAAiB,EAAE;KAC5E,CAAC,CAAC;IACH,SAAS,CAAC,KAAK,GAAG,eAAe,CAAC,gBAAgB,CAAC;IACnD,SAAS,CAAC,WAAW,GAAG,eAAe,CAAC;IAExC,IAAI,gBAAgB,EAAE;QAClB,iDAAiD;QACjD,MAAM,QAAQ,GAAsB,IAAA,0DAAyC,EAAC,gBAAgB,EAAE,aAAa,CAAC,CAAC;QAC/G,gCAAgC;QAChC,MAAM,YAAY,CAAC,GAAG,CAAC,IAAA,kCAAsB,EAAC,eAAe,CAAC,EAAE,QAAQ,CAAC,CAAC;KAC7E;IAED,OAAO,eAAe,CAAC;AAC3B,CAAC;AAjDD,4EAiDC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ISummaryTree } from \"@fluidframework/protocol-definitions\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { UsageError } from \"@fluidframework/driver-utils\";\nimport {\n    IFileEntry,\n    InstrumentedStorageTokenFetcher,\n    IOdspResolvedUrl\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { IWriteSummaryResponse } from \"./contracts\";\nimport {\n    createCacheSnapshotKey,\n    getOrigin,\n    IExistingFileInfo,\n} from \"./odspUtils\";\nimport { ISnapshotContents } from \"./odspPublicUtils\";\nimport { createOdspUrl } from \"./createOdspUrl\";\nimport { getApiRoot } from \"./odspUrlHelper\";\nimport { EpochTracker } from \"./epochTracker\";\nimport { OdspDriverUrlResolver } from \"./odspDriverUrlResolver\";\nimport { convertCreateNewSummaryTreeToTreeAndBlobs, convertSummaryIntoContainerSnapshot, createNewFluidContainerCore } from \"./createNewUtils\";\nimport { ClpCompliantAppHeader } from \"./contractsPublic\";\n\n/**\n * Creates a new Fluid container on an existing file.\n * This requires service's capability to manage Fluid container inside an existing file.\n * @example - This enables a scenario where Fluid data is not stored as a standalone file but in a way that is managed\n *  by an existing file. For example, SharePoint Pages is able to store Fluid container in an\n *  \"alternative file partition\" where the main File stub is an ASPX page.\n */\nexport async function createNewContainerOnExistingFile(\n    getStorageToken: InstrumentedStorageTokenFetcher,\n    fileInfo: IExistingFileInfo,\n    logger: ITelemetryLogger,\n    createNewSummary: ISummaryTree | undefined,\n    epochTracker: EpochTracker,\n    fileEntry: IFileEntry,\n    createNewCaching: boolean,\n    forceAccessTokenViaAuthorizationHeader: boolean,\n    isClpCompliantApp?: boolean\n): Promise<IOdspResolvedUrl> {\n    if (createNewSummary === undefined) {\n        throw new UsageError(\"createNewSummary must exist to create a new container\");\n    }\n\n    const baseUrl = `${getApiRoot(getOrigin(fileInfo.siteUrl))}/drives/${fileInfo.driveId}/items/${fileInfo.itemId}`;\n\n    const containerSnapshot = convertSummaryIntoContainerSnapshot(createNewSummary);\n\n    const initialUrl = `${baseUrl}/opStream/snapshots/snapshot`;\n\n    const { id: summaryHandle } = await createNewFluidContainerCore<IWriteSummaryResponse>({\n        containerSnapshot,\n        getStorageToken,\n        logger,\n        initialUrl,\n        forceAccessTokenViaAuthorizationHeader,\n        epochTracker,\n        telemetryName: \"CreateNewContainerOnExistingFile\",\n        fetchType: \"uploadSummary\"\n    });\n\n    const odspUrl = createOdspUrl({ ...fileInfo, dataStorePath: \"/\" });\n    const resolver = new OdspDriverUrlResolver();\n    const odspResolvedUrl = await resolver.resolve({\n        url: odspUrl,\n        headers: { [ClpCompliantAppHeader.isClpCompliantApp]: isClpCompliantApp },\n    });\n    fileEntry.docId = odspResolvedUrl.hashedDocumentId;\n    fileEntry.resolvedUrl = odspResolvedUrl;\n\n    if (createNewCaching) {\n        // converting summary and getting sequence number\n        const snapshot: ISnapshotContents = convertCreateNewSummaryTreeToTreeAndBlobs(createNewSummary, summaryHandle);\n        // caching the converted summary\n        await epochTracker.put(createCacheSnapshotKey(odspResolvedUrl), snapshot);\n    }\n\n    return odspResolvedUrl;\n}\n"]}

package/dist/odspDocumentServiceFactoryCore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"odspDocumentServiceFactoryCore.d.ts","sourceRoot":"","sources":["../src/odspDocumentServiceFactoryCore.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EACH,gBAAgB,EAChB,uBAAuB,EACvB,YAAY,EACf,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AACpE,OAAO,EACH,eAAe,EAElB,MAAM,iCAAiC,CAAC;AAKzC,OAAO,EAEH,6BAA6B,EAC7B,YAAY,EACZ,eAAe,EACf,iBAAiB,EAOpB,MAAM,yCAAyC,CAAC;AAMjD,OAAO,EAEH,gBAAgB,EACnB,MAAM,gBAAgB,CAAC;AAKxB;;;;;;GAMG;AACH,qBAAa,8BAA+B,YAAW,uBAAuB;IAyGtE,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,SAAS,CAAC,cAAc,EAAE,eAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,UAAU;IA3G/B,SAAgB,YAAY,iBAAiB;IAE7C,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAA4B;IAC/D,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAS;IAEtC,eAAe,CACxB,gBAAgB,EAAE,YAAY,GAAG,SAAS,EAC1C,oBAAoB,EAAE,YAAY,EAClC,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IAmF5B;;;;;;;;;OASG;gBAEkB,eAAe,EAAE,YAAY,CAAC,6BAA6B,CAAC,EAC5D,iBAAiB,EAAE,YAAY,CAAC,6BAA6B,CAAC,GAAG,SAAS,EACjF,cAAc,GAAE,eAA4C,EACrD,UAAU,GAAE,iBAAsB;IAc1C,qBAAqB,CAC9B,WAAW,EAAE,YAAY,EACzB,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC7B,OAAO,CAAC,gBAAgB,CAAC;cAIZ,yBAAyB,CACrC,WAAW,EAAE,YAAY,EACzB,UAAU,EAAE,eAAe,EAC3B,kBAAkB,CAAC,EAAE,gBAAgB,EACrC,kBAAkB,CAAC,EAAE,OAAO,GAC7B,OAAO,CAAC,gBAAgB,CAAC;CA0C/B"}
+{"version":3,"file":"odspDocumentServiceFactoryCore.d.ts","sourceRoot":"","sources":["../src/odspDocumentServiceFactoryCore.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EACH,gBAAgB,EAChB,uBAAuB,EACvB,YAAY,EACf,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AACpE,OAAO,EACH,eAAe,EAElB,MAAM,iCAAiC,CAAC;AAKzC,OAAO,EAEH,6BAA6B,EAC7B,YAAY,EACZ,eAAe,EACf,iBAAiB,EAOpB,MAAM,yCAAyC,CAAC;AAMjD,OAAO,EAEH,gBAAgB,EACnB,MAAM,gBAAgB,CAAC;AAMxB;;;;;;GAMG;AACH,qBAAa,8BAA+B,YAAW,uBAAuB;IAmItE,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,SAAS,CAAC,cAAc,EAAE,eAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,UAAU;IArI/B,SAAgB,YAAY,iBAAiB;IAE7C,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAA4B;IAC/D,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAS;IAEtC,eAAe,CACxB,gBAAgB,EAAE,YAAY,GAAG,SAAS,EAC1C,oBAAoB,EAAE,YAAY,EAClC,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IA6G5B;;;;;;;;;OASG;gBAEkB,eAAe,EAAE,YAAY,CAAC,6BAA6B,CAAC,EAC5D,iBAAiB,EAAE,YAAY,CAAC,6BAA6B,CAAC,GAAG,SAAS,EACjF,cAAc,GAAE,eAA4C,EACrD,UAAU,GAAE,iBAAsB;IAc1C,qBAAqB,CAC9B,WAAW,EAAE,YAAY,EACzB,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC7B,OAAO,CAAC,gBAAgB,CAAC;cAIZ,yBAAyB,CACrC,WAAW,EAAE,YAAY,EACzB,UAAU,EAAE,eAAe,EAC3B,kBAAkB,CAAC,EAAE,gBAAgB,EACrC,kBAAkB,CAAC,EAAE,OAAO,GAC7B,OAAO,CAAC,gBAAgB,CAAC;CA0C/B"}

package/dist/odspDocumentServiceFactoryCore.js

@@ -14,6 +14,7 @@ const epochTracker_1 = require("./epochTracker");
 const odspDocumentService_1 = require("./odspDocumentService");
 const odspUtils_1 = require("./odspUtils");
 const createFile_1 = require("./createFile");
+const createNewContainerOnExistingFile_1 = require("./createNewContainerOnExistingFile");
 /**
  * Factory for creating the sharepoint document service. Use this if you want to
  * use the sharepoint implementation.
@@ -62,6 +63,30 @@ class OdspDocumentServiceFactoryCore {
         if (filePath === undefined || filePath === null) {
             throw new Error("File path should be provided!!");
         }
+        let fileInfo;
+        let createShareLinkParam;
+        if (odspResolvedUrl.itemId) {
+            fileInfo = {
+                type: 'Existing',
+                driveId: odspResolvedUrl.driveId,
+                siteUrl: odspResolvedUrl.siteUrl,
+                itemId: odspResolvedUrl.itemId
+            };
+        }
+        else if (odspResolvedUrl.fileName) {
+            createShareLinkParam = getSharingLinkParams(this.hostPolicy, searchParams);
+            fileInfo = {
+                type: 'New',
+                driveId: odspResolvedUrl.driveId,
+                siteUrl: odspResolvedUrl.siteUrl,
+                filePath,
+                filename: odspResolvedUrl.fileName,
+                createLinkType: createShareLinkParam,
+            };
+        }
+        else {
+            throw new Error("A new or existing file must be specified to create container!");
+        }
         const protocolSummary = createNewSummary === null || createNewSummary === void 0 ? void 0 : createNewSummary.tree[".protocol"];
         if (protocolSummary) {
             const documentAttributes = (0, driver_utils_1.getDocAttributesFromProtocolSummary)(protocolSummary);
@@ -69,27 +94,21 @@ class OdspDocumentServiceFactoryCore {
                 throw new Error("Seq number in detached ODSP container should be 0");
             }
         }
-        const createShareLinkParam = getSharingLinkParams(this.hostPolicy, searchParams);
-        const newFileInfo = {
-            type: 'New',
-            driveId: odspResolvedUrl.driveId,
-            siteUrl: odspResolvedUrl.siteUrl,
-            filePath,
-            filename: odspResolvedUrl.fileName,
-            createLinkType: createShareLinkParam,
-        };
         const odspLogger = (0, odspUtils_1.createOdspLogger)(logger);
         const fileEntry = { resolvedUrl: odspResolvedUrl, docId: odspResolvedUrl.hashedDocumentId };
         const cacheAndTracker = (0, epochTracker_1.createOdspCacheAndTracker)(this.persistedCache, this.nonPersistentCache, fileEntry, odspLogger, clientIsSummarizer);
         return telemetry_utils_1.PerformanceEvent.timedExecAsync(odspLogger, {
             eventName: "CreateNew",
             isWithSummaryUpload: true,
-            createShareLinkParam: JSON.stringify(createShareLinkParam),
+            createShareLinkParam: createShareLinkParam ? JSON.stringify(createShareLinkParam) : undefined,
             enableShareLinkWithCreate: this.hostPolicy.enableShareLinkWithCreate,
             enableSingleRequestForShareLinkWithCreate: this.hostPolicy.enableSingleRequestForShareLinkWithCreate,
         }, async (event) => {
-            var _a, _b;
-            odspResolvedUrl = await (0, createFile_1.createNewFluidFile)((0, odspUtils_1.toInstrumentedOdspTokenFetcher)(odspLogger, resolvedUrlData, this.getStorageToken, true /* throwOnNullToken */), newFileInfo, odspLogger, createNewSummary, cacheAndTracker.epochTracker, fileEntry, (_a = this.hostPolicy.cacheCreateNewSummary) !== null && _a !== void 0 ? _a : true, !!((_b = this.hostPolicy.sessionOptions) === null || _b === void 0 ? void 0 : _b.forceAccessTokenViaAuthorizationHeader), odspResolvedUrl.isClpCompliantApp, this.hostPolicy.enableSingleRequestForShareLinkWithCreate, this.hostPolicy.enableShareLinkWithCreate);
+            var _a, _b, _c, _d;
+            const getStorageToken = (0, odspUtils_1.toInstrumentedOdspTokenFetcher)(odspLogger, resolvedUrlData, this.getStorageToken, true /* throwOnNullToken */);
+            odspResolvedUrl = (0, odspUtils_1.isNewFileInfo)(fileInfo)
+                ? await (0, createFile_1.createNewFluidFile)(getStorageToken, fileInfo, odspLogger, createNewSummary, cacheAndTracker.epochTracker, fileEntry, (_a = this.hostPolicy.cacheCreateNewSummary) !== null && _a !== void 0 ? _a : true, !!((_b = this.hostPolicy.sessionOptions) === null || _b === void 0 ? void 0 : _b.forceAccessTokenViaAuthorizationHeader), odspResolvedUrl.isClpCompliantApp, this.hostPolicy.enableSingleRequestForShareLinkWithCreate, this.hostPolicy.enableShareLinkWithCreate)
+                : await (0, createNewContainerOnExistingFile_1.createNewContainerOnExistingFile)(getStorageToken, fileInfo, odspLogger, createNewSummary, cacheAndTracker.epochTracker, fileEntry, (_c = this.hostPolicy.cacheCreateNewSummary) !== null && _c !== void 0 ? _c : true, !!((_d = this.hostPolicy.sessionOptions) === null || _d === void 0 ? void 0 : _d.forceAccessTokenViaAuthorizationHeader), odspResolvedUrl.isClpCompliantApp);
             const docService = this.createDocumentServiceCore(odspResolvedUrl, odspLogger, cacheAndTracker, clientIsSummarizer);
             event.end({
                 docId: odspResolvedUrl.hashedDocumentId,

package/dist/odspDocumentServiceFactoryCore.js.map

@@ -1 +1 @@
-{"version":3,"file":"odspDocumentServiceFactoryCore.js","sourceRoot":"","sources":["../src/odspDocumentServiceFactoryCore.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AASH,qEAGyC;AACzC,+DAGsC;AACtC,qFAYiD;AACjD,+BAAkC;AAClC,2CAGqB;AACrB,iDAGwB;AACxB,+DAA4D;AAC5D,2CAAiH;AACjH,6CAAkD;AAElD;;;;;;GAMG;AACH,MAAa,8BAA8B;IA8FvC;;;;;;;;;OASG;IACH,YACqB,eAA4D,EAC5D,iBAA0E,EACjF,iBAAkC,IAAI,gCAAoB,EAAE,EACrD,aAAgC,EAAE;;QAHlC,oBAAe,GAAf,eAAe,CAA6C;QAC5D,sBAAiB,GAAjB,iBAAiB,CAAyD;QACjF,mBAAc,GAAd,cAAc,CAA8C;QACrD,eAAU,GAAV,UAAU,CAAwB;QA3GvC,iBAAY,GAAG,aAAa,CAAC;QAE5B,uBAAkB,GAAG,IAAI,8BAAkB,EAAE,CAAC;QA2G3D,IAAI,IAAI,CAAC,UAAU,CAAC,kBAAkB,KAAK,IAAI,EAAE;YAC7C,oDAAoD;YACpD,IAAI,CAAC,wBAAwB,GAAG,IAAA,SAAI,GAAE,CAAC;SAC1C;QACD,+CAA+C;QAC/C,IAAI,CAAC,UAAU,CAAC,oBAAoB,GAAG,MAAA,IAAI,CAAC,UAAU,CAAC,oBAAoB,mCAAI,IAAI,CAAC;QACpF,IAAI,CAAC,UAAU,CAAC,cAAc,mBAC1B,sCAAsC,EAAE,IAAI,IACzC,IAAI,CAAC,UAAU,CAAC,cAAc,CACpC,CAAC;IACN,CAAC;IAlHM,KAAK,CAAC,eAAe,CACxB,gBAA0C,EAC1C,oBAAkC,EAClC,MAA6B,EAC7B,kBAA4B;QAE5B,IAAA,qCAAsB,EAAC,oBAAoB,CAAC,CAAC;QAE7C,IAAI,eAAe,GAAG,IAAA,8BAAkB,EAAC,oBAAoB,CAAC,CAAC;QAC/D,MAAM,eAAe,GAAkB;YACnC,OAAO,EAAE,eAAe,CAAC,OAAO;YAChC,OAAO,EAAE,eAAe,CAAC,OAAO;YAChC,MAAM,EAAE,eAAe,CAAC,MAAM;SACjC,CAAC;QACF,MAAM,CAAC,EAAE,WAAW,CAAC,GAAG,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEvD,MAAM,YAAY,GAAG,IAAI,eAAe,CAAC,WAAW,CAAC,CAAC;QACtD,MAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,IAAI,EAAE;YAC7C,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;SACrD;QAED,MAAM,eAAe,GAAG,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC5D,IAAI,eAAe,EAAE;YACjB,MAAM,kBAAkB,GAAG,IAAA,kDAAmC,EAAC,eAA+B,CAAC,CAAC;YAChG,IAAI,CAAA,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,CAAE,cAAc,MAAK,CAAC,EAAE;gBAC1C,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;aACxE;SACJ;QAED,MAAM,oBAAoB,GAAG,oBAAoB,CAAC,IAAI,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;QACjF,MAAM,WAAW,GAAiB;YAC9B,IAAI,EAAE,KAAK;YACX,OAAO,EAAE,eAAe,CAAC,OAAO;YAChC,OAAO,EAAE,eAAe,CAAC,OAAO;YAChC,QAAQ;YACR,QAAQ,EAAE,eAAe,CAAC,QAAQ;YAClC,cAAc,EAAE,oBAAoB;SACvC,CAAC;QAEF,MAAM,UAAU,GAAG,IAAA,4BAAgB,EAAC,MAAM,CAAC,CAAC;QAE5C,MAAM,SAAS,GAAe,EAAE,WAAW,EAAE,eAAe,EAAE,KAAK,EAAE,eAAe,CAAC,gBAAgB,EAAE,CAAC;QACxG,MAAM,eAAe,GAAG,IAAA,wCAAyB,EAC7C,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,kBAAkB,EACvB,SAAS,EACT,UAAU,EACV,kBAAkB,CAAC,CAAC;QAExB,OAAO,kCAAgB,CAAC,cAAc,CAClC,UAAU,EACV;YACI,SAAS,EAAE,WAAW;YACtB,mBAAmB,EAAE,IAAI;YACzB,oBAAoB,EAAE,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC;YAC1D,yBAAyB,EAAE,IAAI,CAAC,UAAU,CAAC,yBAAyB;YACpE,yCAAyC,EACrC,IAAI,CAAC,UAAU,CAAC,yCAAyC;SAChE,EACD,KAAK,EAAE,KAAK,EAAE,EAAE;;YACZ,eAAe,GAAG,MAAM,IAAA,+BAAkB,EACtC,IAAA,0CAA8B,EAC1B,UAAU,EACV,eAAe,EACf,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,sBAAsB,CAC9B,EACD,WAAW,EACX,UAAU,EACV,gBAAgB,EAChB,eAAe,CAAC,YAAY,EAC5B,SAAS,EACT,MAAA,IAAI,CAAC,UAAU,CAAC,qBAAqB,mCAAI,IAAI,EAC7C,CAAC,CAAC,CAAA,MAAA,IAAI,CAAC,UAAU,CAAC,cAAc,0CAAE,sCAAsC,CAAA,EACxE,eAAe,CAAC,iBAAiB,EACjC,IAAI,CAAC,UAAU,CAAC,yCAAyC,EACzD,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAC5C,CAAC;YACF,MAAM,UAAU,GAAG,IAAI,CAAC,yBAAyB,CAAC,eAAe,EAAE,UAAU,EACzE,eAAe,EAAE,kBAAkB,CAAC,CAAC;YACzC,KAAK,CAAC,GAAG,CAAC;gBACN,KAAK,EAAE,eAAe,CAAC,gBAAgB;aAC1C,CAAC,CAAC;YACH,OAAO,UAAU,CAAC;QACtB,CAAC,CAAC,CAAC;IACX,CAAC;IA8BM,KAAK,CAAC,qBAAqB,CAC9B,WAAyB,EACzB,MAA6B,EAC7B,kBAA4B;QAE5B,OAAO,IAAI,CAAC,yBAAyB,CAAC,WAAW,EAAE,IAAA,4BAAgB,EAAC,MAAM,CAAC,EAAE,SAAS,EAAE,kBAAkB,CAAC,CAAC;IAChH,CAAC;IAES,KAAK,CAAC,yBAAyB,CACrC,WAAyB,EACzB,UAA2B,EAC3B,kBAAqC,EACrC,kBAA4B;QAE5B,MAAM,eAAe,GAAG,IAAA,8BAAkB,EAAC,WAAW,CAAC,CAAC;QACxD,MAAM,eAAe,GAAkB;YACnC,OAAO,EAAE,eAAe,CAAC,OAAO;YAChC,OAAO,EAAE,eAAe,CAAC,OAAO;YAChC,MAAM,EAAE,eAAe,CAAC,MAAM;SACjC,CAAC;QACF,MAAM,eAAe,GAAG,kBAAkB,aAAlB,kBAAkB,cAAlB,kBAAkB,GAAI,IAAA,wCAAyB,EACnE,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,kBAAkB,EACvB,EAAE,WAAW,EAAE,eAAe,EAAE,KAAK,EAAE,eAAe,CAAC,gBAAgB,EAAE,EACzE,UAAU,EACV,kBAAkB,CAAC,CAAC;QAExB,MAAM,mBAAmB,GAAG,IAAA,0CAA8B,EACtD,UAAU,EACV,eAAe,EACf,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,sBAAsB,CAC9B,CAAC;QAEF,MAAM,qBAAqB,GAAG,IAAI,CAAC,iBAAiB,KAAK,SAAS;YAC9D,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,KAAK,EAAE,OAA0B,EAAE,EAAE,CAAC,IAAA,0CAA8B,EAClE,UAAU,EACV,eAAe,EACf,IAAI,CAAC,iBAAkB,EACvB,KAAK,CAAC,sBAAsB,CAC/B,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC;QAEpC,OAAO,yCAAmB,CAAC,MAAM,CAC7B,WAAW,EACX,mBAAmB,EACnB,qBAAqB,EACrB,UAAU,EACV,eAAe,CAAC,KAAK,EACrB,IAAI,CAAC,UAAU,EACf,eAAe,CAAC,YAAY,EAC5B,IAAI,CAAC,wBAAwB,EAC7B,kBAAkB,CACrB,CAAC;IACN,CAAC;CACJ;AAjLD,wEAiLC;AAED;;GAEG;AACH,SAAS,oBAAoB,CACzB,UAA6B,EAC7B,YAA6B;IAE7B,kGAAkG;IAClG,IAAI,oBAAmE,CAAC;IACxE,IAAI,UAAU,CAAC,yCAAyC,EAAE;QACtD,MAAM,eAAe,GAAG,YAAY,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC5D,MAAM,cAAc,GAAG,YAAY,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QAC1D,IAAI,eAAe,IAAI,0CAAgB,CAAC,eAAe,CAAC,EAAE;YACtD,oBAAoB,mBAChB,KAAK,EAAE,0CAAgB,CAAC,eAAe,CAAC,IACrC,CAAC,cAAc,IAAI,yCAAe,CAAC,cAAc,CAAC,CAAC,CAAC;gBACnD,EAAE,IAAI,EAAE,yCAAe,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CACtD,CAAC;SACL;KACJ;SAAM,IAAI,UAAU,CAAC,yBAAyB,EAAE;QAC7C,MAAM,cAAc,GAAG,YAAY,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QAC1D,IAAI,cAAc,IAAI,wCAAc,CAAC,cAAc,CAAC,EAAE;YAClD,oBAAoB,GAAG,wCAAc,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC;SAC/D;KACJ;IACD,OAAO,oBAAoB,CAAC;AAChC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryBaseLogger } from \"@fluidframework/common-definitions\";\nimport {\n    IDocumentService,\n    IDocumentServiceFactory,\n    IResolvedUrl,\n} from \"@fluidframework/driver-definitions\";\nimport { ISummaryTree } from \"@fluidframework/protocol-definitions\";\nimport {\n    TelemetryLogger,\n    PerformanceEvent,\n} from \"@fluidframework/telemetry-utils\";\nimport {\n    getDocAttributesFromProtocolSummary,\n    ensureFluidResolvedUrl,\n} from \"@fluidframework/driver-utils\";\nimport {\n    TokenFetchOptions,\n    OdspResourceTokenFetchOptions,\n    TokenFetcher,\n    IPersistedCache,\n    HostStoragePolicy,\n    IFileEntry,\n    IOdspUrlParts,\n    SharingLinkScope,\n    SharingLinkRole,\n    ShareLinkTypes,\n    ISharingLinkKind,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { v4 as uuid } from \"uuid\";\nimport {\n    LocalPersistentCache,\n    NonPersistentCache,\n} from \"./odspCache\";\nimport {\n    createOdspCacheAndTracker,\n    ICacheAndTracker,\n} from \"./epochTracker\";\nimport { OdspDocumentService } from \"./odspDocumentService\";\nimport { INewFileInfo, getOdspResolvedUrl, createOdspLogger, toInstrumentedOdspTokenFetcher } from \"./odspUtils\";\nimport { createNewFluidFile } from \"./createFile\";\n\n/**\n * Factory for creating the sharepoint document service. Use this if you want to\n * use the sharepoint implementation.\n *\n * This constructor should be used by environments that support dynamic imports and that wish\n * to leverage code splitting as a means to keep bundles as small as possible.\n */\nexport class OdspDocumentServiceFactoryCore implements IDocumentServiceFactory {\n    public readonly protocolName = \"fluid-odsp:\";\n\n    private readonly nonPersistentCache = new NonPersistentCache();\n    private readonly socketReferenceKeyPrefix?: string;\n\n    public async createContainer(\n        createNewSummary: ISummaryTree | undefined,\n        createNewResolvedUrl: IResolvedUrl,\n        logger?: ITelemetryBaseLogger,\n        clientIsSummarizer?: boolean,\n    ): Promise<IDocumentService> {\n        ensureFluidResolvedUrl(createNewResolvedUrl);\n\n        let odspResolvedUrl = getOdspResolvedUrl(createNewResolvedUrl);\n        const resolvedUrlData: IOdspUrlParts = {\n            siteUrl: odspResolvedUrl.siteUrl,\n            driveId: odspResolvedUrl.driveId,\n            itemId: odspResolvedUrl.itemId,\n        };\n        const [, queryString] = odspResolvedUrl.url.split(\"?\");\n\n        const searchParams = new URLSearchParams(queryString);\n        const filePath = searchParams.get(\"path\");\n        if (filePath === undefined || filePath === null) {\n            throw new Error(\"File path should be provided!!\");\n        }\n\n        const protocolSummary = createNewSummary?.tree[\".protocol\"];\n        if (protocolSummary) {\n            const documentAttributes = getDocAttributesFromProtocolSummary(protocolSummary as ISummaryTree);\n            if (documentAttributes?.sequenceNumber !== 0) {\n                throw new Error(\"Seq number in detached ODSP container should be 0\");\n            }\n        }\n\n        const createShareLinkParam = getSharingLinkParams(this.hostPolicy, searchParams);\n        const newFileInfo: INewFileInfo = {\n            type: 'New',\n            driveId: odspResolvedUrl.driveId,\n            siteUrl: odspResolvedUrl.siteUrl,\n            filePath,\n            filename: odspResolvedUrl.fileName,\n            createLinkType: createShareLinkParam,\n        };\n\n        const odspLogger = createOdspLogger(logger);\n\n        const fileEntry: IFileEntry = { resolvedUrl: odspResolvedUrl, docId: odspResolvedUrl.hashedDocumentId };\n        const cacheAndTracker = createOdspCacheAndTracker(\n            this.persistedCache,\n            this.nonPersistentCache,\n            fileEntry,\n            odspLogger,\n            clientIsSummarizer);\n\n        return PerformanceEvent.timedExecAsync(\n            odspLogger,\n            {\n                eventName: \"CreateNew\",\n                isWithSummaryUpload: true,\n                createShareLinkParam: JSON.stringify(createShareLinkParam),\n                enableShareLinkWithCreate: this.hostPolicy.enableShareLinkWithCreate,\n                enableSingleRequestForShareLinkWithCreate:\n                    this.hostPolicy.enableSingleRequestForShareLinkWithCreate,\n            },\n            async (event) => {\n                odspResolvedUrl = await createNewFluidFile(\n                    toInstrumentedOdspTokenFetcher(\n                        odspLogger,\n                        resolvedUrlData,\n                        this.getStorageToken,\n                        true /* throwOnNullToken */,\n                    ),\n                    newFileInfo,\n                    odspLogger,\n                    createNewSummary,\n                    cacheAndTracker.epochTracker,\n                    fileEntry,\n                    this.hostPolicy.cacheCreateNewSummary ?? true,\n                    !!this.hostPolicy.sessionOptions?.forceAccessTokenViaAuthorizationHeader,\n                    odspResolvedUrl.isClpCompliantApp,\n                    this.hostPolicy.enableSingleRequestForShareLinkWithCreate,\n                    this.hostPolicy.enableShareLinkWithCreate,\n                );\n                const docService = this.createDocumentServiceCore(odspResolvedUrl, odspLogger,\n                    cacheAndTracker, clientIsSummarizer);\n                event.end({\n                    docId: odspResolvedUrl.hashedDocumentId,\n                });\n                return docService;\n            });\n    }\n\n    /**\n     * @param getStorageToken - function that can provide the storage token for a given site. This is\n     * is also referred to as the \"Vroom\" token in SPO.\n     * @param getWebsocketToken - function that can provide a token for accessing the web socket. This is also\n     * to as the \"Push\" token in SPO. If undefined then websocket token is expected to be returned with joinSession\n     * response payload.\n     * @param storageFetchWrapper - if not provided FetchWrapper will be used\n     * @param deltasFetchWrapper - if not provided FetchWrapper will be used\n     * @param persistedCache - PersistedCache provided by host for use in this session.\n     */\n    constructor(\n        private readonly getStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>,\n        private readonly getWebsocketToken: TokenFetcher<OdspResourceTokenFetchOptions> | undefined,\n        protected persistedCache: IPersistedCache = new LocalPersistentCache(),\n        private readonly hostPolicy: HostStoragePolicy = {},\n    ) {\n        if (this.hostPolicy.isolateSocketCache === true) {\n            // create the key to separate the socket reuse cache\n            this.socketReferenceKeyPrefix = uuid();\n        }\n        // Set enableRedeemFallback by default as true.\n        this.hostPolicy.enableRedeemFallback = this.hostPolicy.enableRedeemFallback ?? true;\n        this.hostPolicy.sessionOptions = {\n            forceAccessTokenViaAuthorizationHeader: true,\n            ...this.hostPolicy.sessionOptions,\n        };\n    }\n\n    public async createDocumentService(\n        resolvedUrl: IResolvedUrl,\n        logger?: ITelemetryBaseLogger,\n        clientIsSummarizer?: boolean,\n    ): Promise<IDocumentService> {\n        return this.createDocumentServiceCore(resolvedUrl, createOdspLogger(logger), undefined, clientIsSummarizer);\n    }\n\n    protected async createDocumentServiceCore(\n        resolvedUrl: IResolvedUrl,\n        odspLogger: TelemetryLogger,\n        cacheAndTrackerArg?: ICacheAndTracker,\n        clientIsSummarizer?: boolean,\n    ): Promise<IDocumentService> {\n        const odspResolvedUrl = getOdspResolvedUrl(resolvedUrl);\n        const resolvedUrlData: IOdspUrlParts = {\n            siteUrl: odspResolvedUrl.siteUrl,\n            driveId: odspResolvedUrl.driveId,\n            itemId: odspResolvedUrl.itemId,\n        };\n        const cacheAndTracker = cacheAndTrackerArg ?? createOdspCacheAndTracker(\n            this.persistedCache,\n            this.nonPersistentCache,\n            { resolvedUrl: odspResolvedUrl, docId: odspResolvedUrl.hashedDocumentId },\n            odspLogger,\n            clientIsSummarizer);\n\n        const storageTokenFetcher = toInstrumentedOdspTokenFetcher(\n            odspLogger,\n            resolvedUrlData,\n            this.getStorageToken,\n            true /* throwOnNullToken */,\n        );\n\n        const webSocketTokenFetcher = this.getWebsocketToken === undefined\n            ? undefined\n            : async (options: TokenFetchOptions) => toInstrumentedOdspTokenFetcher(\n                odspLogger,\n                resolvedUrlData,\n                this.getWebsocketToken!,\n                false /* throwOnNullToken */,\n            )(options, \"GetWebsocketToken\");\n\n        return OdspDocumentService.create(\n            resolvedUrl,\n            storageTokenFetcher,\n            webSocketTokenFetcher,\n            odspLogger,\n            cacheAndTracker.cache,\n            this.hostPolicy,\n            cacheAndTracker.epochTracker,\n            this.socketReferenceKeyPrefix,\n            clientIsSummarizer,\n        );\n    }\n}\n\n/**\n * Extract the sharing link kind from the resolved URL's query paramerters\n */\nfunction getSharingLinkParams(\n    hostPolicy: HostStoragePolicy,\n    searchParams: URLSearchParams,\n): ShareLinkTypes | ISharingLinkKind | undefined {\n    // extract request parameters for creation of sharing link (if provided) if the feature is enabled\n    let createShareLinkParam: ShareLinkTypes | ISharingLinkKind | undefined;\n    if (hostPolicy.enableSingleRequestForShareLinkWithCreate) {\n        const createLinkScope = searchParams.get(\"createLinkScope\");\n        const createLinkRole = searchParams.get(\"createLinkRole\");\n        if (createLinkScope && SharingLinkScope[createLinkScope]) {\n            createShareLinkParam = {\n                scope: SharingLinkScope[createLinkScope],\n                ...(createLinkRole && SharingLinkRole[createLinkRole] ?\n                    { role: SharingLinkRole[createLinkRole] } : {}),\n            };\n        }\n    } else if (hostPolicy.enableShareLinkWithCreate) {\n        const createLinkType = searchParams.get(\"createLinkType\");\n        if (createLinkType && ShareLinkTypes[createLinkType]) {\n            createShareLinkParam = ShareLinkTypes[createLinkType || \"\"];\n        }\n    }\n    return createShareLinkParam;\n}\n"]}
+{"version":3,"file":"odspDocumentServiceFactoryCore.js","sourceRoot":"","sources":["../src/odspDocumentServiceFactoryCore.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AASH,qEAGyC;AACzC,+DAGsC;AACtC,qFAYiD;AACjD,+BAAkC;AAClC,2CAGqB;AACrB,iDAGwB;AACxB,+DAA4D;AAC5D,2CAAmJ;AACnJ,6CAAkD;AAClD,yFAAsF;AAEtF;;;;;;GAMG;AACH,MAAa,8BAA8B;IAwHvC;;;;;;;;;OASG;IACH,YACqB,eAA4D,EAC5D,iBAA0E,EACjF,iBAAkC,IAAI,gCAAoB,EAAE,EACrD,aAAgC,EAAE;;QAHlC,oBAAe,GAAf,eAAe,CAA6C;QAC5D,sBAAiB,GAAjB,iBAAiB,CAAyD;QACjF,mBAAc,GAAd,cAAc,CAA8C;QACrD,eAAU,GAAV,UAAU,CAAwB;QArIvC,iBAAY,GAAG,aAAa,CAAC;QAE5B,uBAAkB,GAAG,IAAI,8BAAkB,EAAE,CAAC;QAqI3D,IAAI,IAAI,CAAC,UAAU,CAAC,kBAAkB,KAAK,IAAI,EAAE;YAC7C,oDAAoD;YACpD,IAAI,CAAC,wBAAwB,GAAG,IAAA,SAAI,GAAE,CAAC;SAC1C;QACD,+CAA+C;QAC/C,IAAI,CAAC,UAAU,CAAC,oBAAoB,GAAG,MAAA,IAAI,CAAC,UAAU,CAAC,oBAAoB,mCAAI,IAAI,CAAC;QACpF,IAAI,CAAC,UAAU,CAAC,cAAc,mBAC1B,sCAAsC,EAAE,IAAI,IACzC,IAAI,CAAC,UAAU,CAAC,cAAc,CACpC,CAAC;IACN,CAAC;IA5IM,KAAK,CAAC,eAAe,CACxB,gBAA0C,EAC1C,oBAAkC,EAClC,MAA6B,EAC7B,kBAA4B;QAE5B,IAAA,qCAAsB,EAAC,oBAAoB,CAAC,CAAC;QAE7C,IAAI,eAAe,GAAG,IAAA,8BAAkB,EAAC,oBAAoB,CAAC,CAAC;QAC/D,MAAM,eAAe,GAAkB;YACnC,OAAO,EAAE,eAAe,CAAC,OAAO;YAChC,OAAO,EAAE,eAAe,CAAC,OAAO;YAChC,MAAM,EAAE,eAAe,CAAC,MAAM;SACjC,CAAC;QACF,MAAM,CAAC,EAAE,WAAW,CAAC,GAAG,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEvD,MAAM,YAAY,GAAG,IAAI,eAAe,CAAC,WAAW,CAAC,CAAC;QACtD,MAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,IAAI,EAAE;YAC7C,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;SACrD;QAED,IAAI,QAA0C,CAAC;QAC/C,IAAI,oBAAmE,CAAC;QACxE,IAAI,eAAe,CAAC,MAAM,EAAE;YACxB,QAAQ,GAAG;gBACP,IAAI,EAAE,UAAU;gBAChB,OAAO,EAAE,eAAe,CAAC,OAAO;gBAChC,OAAO,EAAE,eAAe,CAAC,OAAO;gBAChC,MAAM,EAAE,eAAe,CAAC,MAAM;aACjC,CAAC;SACL;aAAM,IAAI,eAAe,CAAC,QAAQ,EAAE;YACjC,oBAAoB,GAAG,oBAAoB,CAAC,IAAI,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;YAC3E,QAAQ,GAAG;gBACP,IAAI,EAAE,KAAK;gBACX,OAAO,EAAE,eAAe,CAAC,OAAO;gBAChC,OAAO,EAAE,eAAe,CAAC,OAAO;gBAChC,QAAQ;gBACR,QAAQ,EAAE,eAAe,CAAC,QAAQ;gBAClC,cAAc,EAAE,oBAAoB;aACvC,CAAC;SACL;aAAM;YACH,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;SACpF;QAED,MAAM,eAAe,GAAG,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC5D,IAAI,eAAe,EAAE;YACjB,MAAM,kBAAkB,GAAG,IAAA,kDAAmC,EAAC,eAA+B,CAAC,CAAC;YAChG,IAAI,CAAA,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,CAAE,cAAc,MAAK,CAAC,EAAE;gBAC1C,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;aACxE;SACJ;QAED,MAAM,UAAU,GAAG,IAAA,4BAAgB,EAAC,MAAM,CAAC,CAAC;QAE5C,MAAM,SAAS,GAAe,EAAE,WAAW,EAAE,eAAe,EAAE,KAAK,EAAE,eAAe,CAAC,gBAAgB,EAAE,CAAC;QACxG,MAAM,eAAe,GAAG,IAAA,wCAAyB,EAC7C,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,kBAAkB,EACvB,SAAS,EACT,UAAU,EACV,kBAAkB,CAAC,CAAC;QAExB,OAAO,kCAAgB,CAAC,cAAc,CAClC,UAAU,EACV;YACI,SAAS,EAAE,WAAW;YACtB,mBAAmB,EAAE,IAAI;YACzB,oBAAoB,EAAE,oBAAoB,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,SAAS;YAC7F,yBAAyB,EAAE,IAAI,CAAC,UAAU,CAAC,yBAAyB;YACpE,yCAAyC,EACrC,IAAI,CAAC,UAAU,CAAC,yCAAyC;SAChE,EACD,KAAK,EAAE,KAAK,EAAE,EAAE;;YACZ,MAAM,eAAe,GAAG,IAAA,0CAA8B,EAClD,UAAU,EACV,eAAe,EACf,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,sBAAsB,CAC9B,CAAC;YACF,eAAe,GAAG,IAAA,yBAAa,EAAC,QAAQ,CAAC;gBACrC,CAAC,CAAC,MAAM,IAAA,+BAAkB,EACtB,eAAe,EACf,QAAQ,EACR,UAAU,EACV,gBAAgB,EAChB,eAAe,CAAC,YAAY,EAC5B,SAAS,EACT,MAAA,IAAI,CAAC,UAAU,CAAC,qBAAqB,mCAAI,IAAI,EAC7C,CAAC,CAAC,CAAA,MAAA,IAAI,CAAC,UAAU,CAAC,cAAc,0CAAE,sCAAsC,CAAA,EACxE,eAAe,CAAC,iBAAiB,EACjC,IAAI,CAAC,UAAU,CAAC,yCAAyC,EACzD,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAC5C;gBACD,CAAC,CAAC,MAAM,IAAA,mEAAgC,EACpC,eAAe,EACf,QAAQ,EACR,UAAU,EACV,gBAAgB,EAChB,eAAe,CAAC,YAAY,EAC5B,SAAS,EACT,MAAA,IAAI,CAAC,UAAU,CAAC,qBAAqB,mCAAI,IAAI,EAC7C,CAAC,CAAC,CAAA,MAAA,IAAI,CAAC,UAAU,CAAC,cAAc,0CAAE,sCAAsC,CAAA,EACxE,eAAe,CAAC,iBAAiB,CACpC,CAAC;YACN,MAAM,UAAU,GAAG,IAAI,CAAC,yBAAyB,CAAC,eAAe,EAAE,UAAU,EACzE,eAAe,EAAE,kBAAkB,CAAC,CAAC;YACzC,KAAK,CAAC,GAAG,CAAC;gBACN,KAAK,EAAE,eAAe,CAAC,gBAAgB;aAC1C,CAAC,CAAC;YACH,OAAO,UAAU,CAAC;QACtB,CAAC,CAAC,CAAC;IACX,CAAC;IA8BM,KAAK,CAAC,qBAAqB,CAC9B,WAAyB,EACzB,MAA6B,EAC7B,kBAA4B;QAE5B,OAAO,IAAI,CAAC,yBAAyB,CAAC,WAAW,EAAE,IAAA,4BAAgB,EAAC,MAAM,CAAC,EAAE,SAAS,EAAE,kBAAkB,CAAC,CAAC;IAChH,CAAC;IAES,KAAK,CAAC,yBAAyB,CACrC,WAAyB,EACzB,UAA2B,EAC3B,kBAAqC,EACrC,kBAA4B;QAE5B,MAAM,eAAe,GAAG,IAAA,8BAAkB,EAAC,WAAW,CAAC,CAAC;QACxD,MAAM,eAAe,GAAkB;YACnC,OAAO,EAAE,eAAe,CAAC,OAAO;YAChC,OAAO,EAAE,eAAe,CAAC,OAAO;YAChC,MAAM,EAAE,eAAe,CAAC,MAAM;SACjC,CAAC;QACF,MAAM,eAAe,GAAG,kBAAkB,aAAlB,kBAAkB,cAAlB,kBAAkB,GAAI,IAAA,wCAAyB,EACnE,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,kBAAkB,EACvB,EAAE,WAAW,EAAE,eAAe,EAAE,KAAK,EAAE,eAAe,CAAC,gBAAgB,EAAE,EACzE,UAAU,EACV,kBAAkB,CAAC,CAAC;QAExB,MAAM,mBAAmB,GAAG,IAAA,0CAA8B,EACtD,UAAU,EACV,eAAe,EACf,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,sBAAsB,CAC9B,CAAC;QAEF,MAAM,qBAAqB,GAAG,IAAI,CAAC,iBAAiB,KAAK,SAAS;YAC9D,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,KAAK,EAAE,OAA0B,EAAE,EAAE,CAAC,IAAA,0CAA8B,EAClE,UAAU,EACV,eAAe,EACf,IAAI,CAAC,iBAAkB,EACvB,KAAK,CAAC,sBAAsB,CAC/B,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC;QAEpC,OAAO,yCAAmB,CAAC,MAAM,CAC7B,WAAW,EACX,mBAAmB,EACnB,qBAAqB,EACrB,UAAU,EACV,eAAe,CAAC,KAAK,EACrB,IAAI,CAAC,UAAU,EACf,eAAe,CAAC,YAAY,EAC5B,IAAI,CAAC,wBAAwB,EAC7B,kBAAkB,CACrB,CAAC;IACN,CAAC;CACJ;AA3MD,wEA2MC;AAED;;GAEG;AACH,SAAS,oBAAoB,CACzB,UAA6B,EAC7B,YAA6B;IAE7B,kGAAkG;IAClG,IAAI,oBAAmE,CAAC;IACxE,IAAI,UAAU,CAAC,yCAAyC,EAAE;QACtD,MAAM,eAAe,GAAG,YAAY,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC5D,MAAM,cAAc,GAAG,YAAY,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QAC1D,IAAI,eAAe,IAAI,0CAAgB,CAAC,eAAe,CAAC,EAAE;YACtD,oBAAoB,mBAChB,KAAK,EAAE,0CAAgB,CAAC,eAAe,CAAC,IACrC,CAAC,cAAc,IAAI,yCAAe,CAAC,cAAc,CAAC,CAAC,CAAC;gBACnD,EAAE,IAAI,EAAE,yCAAe,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CACtD,CAAC;SACL;KACJ;SAAM,IAAI,UAAU,CAAC,yBAAyB,EAAE;QAC7C,MAAM,cAAc,GAAG,YAAY,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QAC1D,IAAI,cAAc,IAAI,wCAAc,CAAC,cAAc,CAAC,EAAE;YAClD,oBAAoB,GAAG,wCAAc,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC;SAC/D;KACJ;IACD,OAAO,oBAAoB,CAAC;AAChC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryBaseLogger } from \"@fluidframework/common-definitions\";\nimport {\n    IDocumentService,\n    IDocumentServiceFactory,\n    IResolvedUrl,\n} from \"@fluidframework/driver-definitions\";\nimport { ISummaryTree } from \"@fluidframework/protocol-definitions\";\nimport {\n    TelemetryLogger,\n    PerformanceEvent,\n} from \"@fluidframework/telemetry-utils\";\nimport {\n    getDocAttributesFromProtocolSummary,\n    ensureFluidResolvedUrl,\n} from \"@fluidframework/driver-utils\";\nimport {\n    TokenFetchOptions,\n    OdspResourceTokenFetchOptions,\n    TokenFetcher,\n    IPersistedCache,\n    HostStoragePolicy,\n    IFileEntry,\n    IOdspUrlParts,\n    SharingLinkScope,\n    SharingLinkRole,\n    ShareLinkTypes,\n    ISharingLinkKind,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { v4 as uuid } from \"uuid\";\nimport {\n    LocalPersistentCache,\n    NonPersistentCache,\n} from \"./odspCache\";\nimport {\n    createOdspCacheAndTracker,\n    ICacheAndTracker,\n} from \"./epochTracker\";\nimport { OdspDocumentService } from \"./odspDocumentService\";\nimport { INewFileInfo, getOdspResolvedUrl, createOdspLogger, toInstrumentedOdspTokenFetcher, IExistingFileInfo, isNewFileInfo } from \"./odspUtils\";\nimport { createNewFluidFile } from \"./createFile\";\nimport { createNewContainerOnExistingFile } from \"./createNewContainerOnExistingFile\";\n\n/**\n * Factory for creating the sharepoint document service. Use this if you want to\n * use the sharepoint implementation.\n *\n * This constructor should be used by environments that support dynamic imports and that wish\n * to leverage code splitting as a means to keep bundles as small as possible.\n */\nexport class OdspDocumentServiceFactoryCore implements IDocumentServiceFactory {\n    public readonly protocolName = \"fluid-odsp:\";\n\n    private readonly nonPersistentCache = new NonPersistentCache();\n    private readonly socketReferenceKeyPrefix?: string;\n\n    public async createContainer(\n        createNewSummary: ISummaryTree | undefined,\n        createNewResolvedUrl: IResolvedUrl,\n        logger?: ITelemetryBaseLogger,\n        clientIsSummarizer?: boolean,\n    ): Promise<IDocumentService> {\n        ensureFluidResolvedUrl(createNewResolvedUrl);\n\n        let odspResolvedUrl = getOdspResolvedUrl(createNewResolvedUrl);\n        const resolvedUrlData: IOdspUrlParts = {\n            siteUrl: odspResolvedUrl.siteUrl,\n            driveId: odspResolvedUrl.driveId,\n            itemId: odspResolvedUrl.itemId,\n        };\n        const [, queryString] = odspResolvedUrl.url.split(\"?\");\n\n        const searchParams = new URLSearchParams(queryString);\n        const filePath = searchParams.get(\"path\");\n        if (filePath === undefined || filePath === null) {\n            throw new Error(\"File path should be provided!!\");\n        }\n\n        let fileInfo: INewFileInfo | IExistingFileInfo;\n        let createShareLinkParam: ShareLinkTypes | ISharingLinkKind | undefined;\n        if (odspResolvedUrl.itemId) {\n            fileInfo = {\n                type: 'Existing',\n                driveId: odspResolvedUrl.driveId,\n                siteUrl: odspResolvedUrl.siteUrl,\n                itemId: odspResolvedUrl.itemId\n            };\n        } else if (odspResolvedUrl.fileName) {\n            createShareLinkParam = getSharingLinkParams(this.hostPolicy, searchParams);\n            fileInfo = {\n                type: 'New',\n                driveId: odspResolvedUrl.driveId,\n                siteUrl: odspResolvedUrl.siteUrl,\n                filePath,\n                filename: odspResolvedUrl.fileName,\n                createLinkType: createShareLinkParam,\n            };\n        } else {\n            throw new Error(\"A new or existing file must be specified to create container!\");\n        }\n\n        const protocolSummary = createNewSummary?.tree[\".protocol\"];\n        if (protocolSummary) {\n            const documentAttributes = getDocAttributesFromProtocolSummary(protocolSummary as ISummaryTree);\n            if (documentAttributes?.sequenceNumber !== 0) {\n                throw new Error(\"Seq number in detached ODSP container should be 0\");\n            }\n        }\n\n        const odspLogger = createOdspLogger(logger);\n\n        const fileEntry: IFileEntry = { resolvedUrl: odspResolvedUrl, docId: odspResolvedUrl.hashedDocumentId };\n        const cacheAndTracker = createOdspCacheAndTracker(\n            this.persistedCache,\n            this.nonPersistentCache,\n            fileEntry,\n            odspLogger,\n            clientIsSummarizer);\n\n        return PerformanceEvent.timedExecAsync(\n            odspLogger,\n            {\n                eventName: \"CreateNew\",\n                isWithSummaryUpload: true,\n                createShareLinkParam: createShareLinkParam ? JSON.stringify(createShareLinkParam) : undefined,\n                enableShareLinkWithCreate: this.hostPolicy.enableShareLinkWithCreate,\n                enableSingleRequestForShareLinkWithCreate:\n                    this.hostPolicy.enableSingleRequestForShareLinkWithCreate,\n            },\n            async (event) => {\n                const getStorageToken = toInstrumentedOdspTokenFetcher(\n                    odspLogger,\n                    resolvedUrlData,\n                    this.getStorageToken,\n                    true /* throwOnNullToken */,\n                );\n                odspResolvedUrl = isNewFileInfo(fileInfo)\n                    ? await createNewFluidFile(\n                        getStorageToken,\n                        fileInfo,\n                        odspLogger,\n                        createNewSummary,\n                        cacheAndTracker.epochTracker,\n                        fileEntry,\n                        this.hostPolicy.cacheCreateNewSummary ?? true,\n                        !!this.hostPolicy.sessionOptions?.forceAccessTokenViaAuthorizationHeader,\n                        odspResolvedUrl.isClpCompliantApp,\n                        this.hostPolicy.enableSingleRequestForShareLinkWithCreate,\n                        this.hostPolicy.enableShareLinkWithCreate\n                    )\n                    : await createNewContainerOnExistingFile(\n                        getStorageToken,\n                        fileInfo,\n                        odspLogger,\n                        createNewSummary,\n                        cacheAndTracker.epochTracker,\n                        fileEntry,\n                        this.hostPolicy.cacheCreateNewSummary ?? true,\n                        !!this.hostPolicy.sessionOptions?.forceAccessTokenViaAuthorizationHeader,\n                        odspResolvedUrl.isClpCompliantApp,\n                    );\n                const docService = this.createDocumentServiceCore(odspResolvedUrl, odspLogger,\n                    cacheAndTracker, clientIsSummarizer);\n                event.end({\n                    docId: odspResolvedUrl.hashedDocumentId,\n                });\n                return docService;\n            });\n    }\n\n    /**\n     * @param getStorageToken - function that can provide the storage token for a given site. This is\n     * is also referred to as the \"Vroom\" token in SPO.\n     * @param getWebsocketToken - function that can provide a token for accessing the web socket. This is also\n     * to as the \"Push\" token in SPO. If undefined then websocket token is expected to be returned with joinSession\n     * response payload.\n     * @param storageFetchWrapper - if not provided FetchWrapper will be used\n     * @param deltasFetchWrapper - if not provided FetchWrapper will be used\n     * @param persistedCache - PersistedCache provided by host for use in this session.\n     */\n    constructor(\n        private readonly getStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>,\n        private readonly getWebsocketToken: TokenFetcher<OdspResourceTokenFetchOptions> | undefined,\n        protected persistedCache: IPersistedCache = new LocalPersistentCache(),\n        private readonly hostPolicy: HostStoragePolicy = {},\n    ) {\n        if (this.hostPolicy.isolateSocketCache === true) {\n            // create the key to separate the socket reuse cache\n            this.socketReferenceKeyPrefix = uuid();\n        }\n        // Set enableRedeemFallback by default as true.\n        this.hostPolicy.enableRedeemFallback = this.hostPolicy.enableRedeemFallback ?? true;\n        this.hostPolicy.sessionOptions = {\n            forceAccessTokenViaAuthorizationHeader: true,\n            ...this.hostPolicy.sessionOptions,\n        };\n    }\n\n    public async createDocumentService(\n        resolvedUrl: IResolvedUrl,\n        logger?: ITelemetryBaseLogger,\n        clientIsSummarizer?: boolean,\n    ): Promise<IDocumentService> {\n        return this.createDocumentServiceCore(resolvedUrl, createOdspLogger(logger), undefined, clientIsSummarizer);\n    }\n\n    protected async createDocumentServiceCore(\n        resolvedUrl: IResolvedUrl,\n        odspLogger: TelemetryLogger,\n        cacheAndTrackerArg?: ICacheAndTracker,\n        clientIsSummarizer?: boolean,\n    ): Promise<IDocumentService> {\n        const odspResolvedUrl = getOdspResolvedUrl(resolvedUrl);\n        const resolvedUrlData: IOdspUrlParts = {\n            siteUrl: odspResolvedUrl.siteUrl,\n            driveId: odspResolvedUrl.driveId,\n            itemId: odspResolvedUrl.itemId,\n        };\n        const cacheAndTracker = cacheAndTrackerArg ?? createOdspCacheAndTracker(\n            this.persistedCache,\n            this.nonPersistentCache,\n            { resolvedUrl: odspResolvedUrl, docId: odspResolvedUrl.hashedDocumentId },\n            odspLogger,\n            clientIsSummarizer);\n\n        const storageTokenFetcher = toInstrumentedOdspTokenFetcher(\n            odspLogger,\n            resolvedUrlData,\n            this.getStorageToken,\n            true /* throwOnNullToken */,\n        );\n\n        const webSocketTokenFetcher = this.getWebsocketToken === undefined\n            ? undefined\n            : async (options: TokenFetchOptions) => toInstrumentedOdspTokenFetcher(\n                odspLogger,\n                resolvedUrlData,\n                this.getWebsocketToken!,\n                false /* throwOnNullToken */,\n            )(options, \"GetWebsocketToken\");\n\n        return OdspDocumentService.create(\n            resolvedUrl,\n            storageTokenFetcher,\n            webSocketTokenFetcher,\n            odspLogger,\n            cacheAndTracker.cache,\n            this.hostPolicy,\n            cacheAndTracker.epochTracker,\n            this.socketReferenceKeyPrefix,\n            clientIsSummarizer,\n        );\n    }\n}\n\n/**\n * Extract the sharing link kind from the resolved URL's query paramerters\n */\nfunction getSharingLinkParams(\n    hostPolicy: HostStoragePolicy,\n    searchParams: URLSearchParams,\n): ShareLinkTypes | ISharingLinkKind | undefined {\n    // extract request parameters for creation of sharing link (if provided) if the feature is enabled\n    let createShareLinkParam: ShareLinkTypes | ISharingLinkKind | undefined;\n    if (hostPolicy.enableSingleRequestForShareLinkWithCreate) {\n        const createLinkScope = searchParams.get(\"createLinkScope\");\n        const createLinkRole = searchParams.get(\"createLinkRole\");\n        if (createLinkScope && SharingLinkScope[createLinkScope]) {\n            createShareLinkParam = {\n                scope: SharingLinkScope[createLinkScope],\n                ...(createLinkRole && SharingLinkRole[createLinkRole] ?\n                    { role: SharingLinkRole[createLinkRole] } : {}),\n            };\n        }\n    } else if (hostPolicy.enableShareLinkWithCreate) {\n        const createLinkType = searchParams.get(\"createLinkType\");\n        if (createLinkType && ShareLinkTypes[createLinkType]) {\n            createShareLinkParam = ShareLinkTypes[createLinkType || \"\"];\n        }\n    }\n    return createShareLinkParam;\n}\n"]}

package/dist/odspDriverUrlResolver.d.ts

@@ -8,6 +8,14 @@ import { IOdspResolvedUrl } from "@fluidframework/odsp-driver-definitions";
 export declare class OdspDriverUrlResolver implements IUrlResolver {
     constructor();
     resolve(request: IRequest): Promise<IOdspResolvedUrl>;
+    /**
+     * Requests a driver + data store storage URL.
+     * @param resolvedUrl - The driver resolved URL.
+     * @param relativeUrl - The relative data store path URL.
+     * For requesting a driver URL, this value should always be '/'. If an empty string is passed, then dataStorePath
+     * will be extracted from the resolved url if present.
+     * @param packageInfoSource - optional, represents container package information to be included in url.
+     */
     getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string, packageInfoSource?: IContainerPackageInfo): Promise<string>;
 }
 //# sourceMappingURL=odspDriverUrlResolver.d.ts.map

package/dist/odspDriverUrlResolver.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"odspDriverUrlResolver.d.ts","sourceRoot":"","sources":["../src/odspDriverUrlResolver.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAGH,qBAAqB,EACrB,YAAY,EACZ,YAAY,EACf,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAqC,MAAM,yCAAyC,CAAC;AA+C9G;;;GAGG;AACH,qBAAa,qBAAsB,YAAW,YAAY;;IAGzC,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA6FrD,cAAc,CACvB,WAAW,EAAE,YAAY,EACzB,WAAW,EAAE,MAAM,EACnB,iBAAiB,CAAC,EAAE,qBAAqB,GAC1C,OAAO,CAAC,MAAM,CAAC;CA4BrB"}
+{"version":3,"file":"odspDriverUrlResolver.d.ts","sourceRoot":"","sources":["../src/odspDriverUrlResolver.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAGH,qBAAqB,EACrB,YAAY,EACZ,YAAY,EACf,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAqC,MAAM,yCAAyC,CAAC;AA+C9G;;;GAGG;AACH,qBAAa,qBAAsB,YAAW,YAAY;;IAGzC,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA8FlE;;;;;;;OAOG;IACU,cAAc,CACvB,WAAW,EAAE,YAAY,EACzB,WAAW,EAAE,MAAM,EACnB,iBAAiB,CAAC,EAAE,qBAAqB,GAC1C,OAAO,CAAC,MAAM,CAAC;CAkCrB"}

package/dist/odspDriverUrlResolver.js

@@ -128,6 +128,7 @@ class OdspDriverUrlResolver {
             siteUrl,
             driveId,
             itemId,
+            dataStorePath: path,
             fileName: "",
             summarizer,
             codeHint: {
@@ -137,13 +138,25 @@ class OdspDriverUrlResolver {
             isClpCompliantApp: (_d = request.headers) === null || _d === void 0 ? void 0 : _d[contractsPublic_1.ClpCompliantAppHeader.isClpCompliantApp],
         };
     }
+    /**
+     * Requests a driver + data store storage URL.
+     * @param resolvedUrl - The driver resolved URL.
+     * @param relativeUrl - The relative data store path URL.
+     * For requesting a driver URL, this value should always be '/'. If an empty string is passed, then dataStorePath
+     * will be extracted from the resolved url if present.
+     * @param packageInfoSource - optional, represents container package information to be included in url.
+     */
     async getAbsoluteUrl(resolvedUrl, relativeUrl, packageInfoSource) {
         var _a, _b, _c, _d;
+        const odspResolvedUrl = (0, odspUtils_1.getOdspResolvedUrl)(resolvedUrl);
         let dataStorePath = relativeUrl;
+        if (relativeUrl === "" && odspResolvedUrl.dataStorePath !== undefined) {
+            // If the user has passed an empty dataStorePath, then extract it from the resolved url.
+            dataStorePath = odspResolvedUrl.dataStorePath;
+        }
         if (dataStorePath.startsWith("/")) {
             dataStorePath = dataStorePath.substr(1);
         }
-        const odspResolvedUrl = (0, odspUtils_1.getOdspResolvedUrl)(resolvedUrl);
         // back-compat: GitHub #9653
         const isFluidPackage = (pkg) => typeof pkg === "object"
             && typeof (pkg === null || pkg === void 0 ? void 0 : pkg.name) === "string"

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,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"]}
+{"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,aAAa,EAAE,IAAI;YACnB,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;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,cAAc,CACvB,WAAyB,EACzB,WAAmB,EACnB,iBAAyC;;QAEzC,MAAM,eAAe,GAAG,IAAA,8BAAkB,EAAC,WAAW,CAAC,CAAC;QAExD,IAAI,aAAa,GAAG,WAAW,CAAC;QAChC,IAAI,WAAW,KAAK,EAAE,IAAI,eAAe,CAAC,aAAa,KAAK,SAAS,EAAE;YACnE,wFAAwF;YACxF,aAAa,GAAG,eAAe,CAAC,aAAa,CAAC;SACjD;QACD,IAAI,aAAa,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAC/B,aAAa,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;SAC3C;QAED,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;AA/ID,sDA+IC;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            dataStorePath: path,\n            fileName: \"\",\n            summarizer,\n            codeHint: {\n                containerPackageName,\n            },\n            fileVersion,\n            isClpCompliantApp: request.headers?.[ClpCompliantAppHeader.isClpCompliantApp],\n        };\n    }\n\n    /**\n     * Requests a driver + data store storage URL.\n     * @param resolvedUrl - The driver resolved URL.\n     * @param relativeUrl - The relative data store path URL.\n     * For requesting a driver URL, this value should always be '/'. If an empty string is passed, then dataStorePath\n     * will be extracted from the resolved url if present.\n     * @param packageInfoSource - optional, represents container package information to be included in url.\n     */\n    public async getAbsoluteUrl(\n        resolvedUrl: IResolvedUrl,\n        relativeUrl: string,\n        packageInfoSource?: IContainerPackageInfo,\n    ): Promise<string> {\n        const odspResolvedUrl = getOdspResolvedUrl(resolvedUrl);\n\n        let dataStorePath = relativeUrl;\n        if (relativeUrl === \"\" && odspResolvedUrl.dataStorePath !== undefined) {\n            // If the user has passed an empty dataStorePath, then extract it from the resolved url.\n            dataStorePath = odspResolvedUrl.dataStorePath;\n        }\n        if (dataStorePath.startsWith(\"/\")) {\n            dataStorePath = dataStorePath.substr(1);\n        } \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        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

@@ -57,7 +57,8 @@ export declare class OdspDriverUrlResolverForShareLink implements IUrlResolver {
      * and it will throw in case share link fetcher props were not specified when instance was created.
      * @param resolvedUrl - The driver resolved URL
      * @param dataStorePath - The relative data store path URL.
-     * For requesting a driver URL, this value should always be '/'
+     * For requesting a driver URL, this value should always be '/'. If an empty string is passed, then dataStorePath
+     * will be extracted from the resolved url if present.
      * @param packageInfoSource - optional, represents container package information to be included in url.
      */
     getAbsoluteUrl(resolvedUrl: IResolvedUrl, dataStorePath: string, packageInfoSource?: IContainerPackageInfo): Promise<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;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;IA2BjC;;;;;;;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"}
+{"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;IA2BjC;;;;;;;;OAQG;IACU,cAAc,CACvB,WAAW,EAAE,YAAY,EACzB,aAAa,EAAE,MAAM,EACrB,iBAAiB,CAAC,EAAE,qBAAqB,GAC1C,OAAO,CAAC,MAAM,CAAC;IA4ClB;;OAEG;WACW,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,yBAAyB;IAQtF;;;OAGG;WACW,cAAc,CAAC,OAAO,EAAE,yBAAyB;CAGlE"}

package/dist/odspDriverUrlResolverForShareLink.js

@@ -131,7 +131,8 @@ class OdspDriverUrlResolverForShareLink {
      * and it will throw in case share link fetcher props were not specified when instance was created.
      * @param resolvedUrl - The driver resolved URL
      * @param dataStorePath - The relative data store path URL.
-     * For requesting a driver URL, this value should always be '/'
+     * For requesting a driver URL, this value should always be '/'. If an empty string is passed, then dataStorePath
+     * will be extracted from the resolved url if present.
      * @param packageInfoSource - optional, represents container package information to be included in url.
      */
     async getAbsoluteUrl(resolvedUrl, dataStorePath, packageInfoSource) {
@@ -139,6 +140,11 @@ class OdspDriverUrlResolverForShareLink {
         const odspResolvedUrl = (0, odspUtils_1.getOdspResolvedUrl)(resolvedUrl);
         const shareLink = await this.getShareLinkPromise(odspResolvedUrl);
         const shareLinkUrl = new URL(shareLink);
+        let actualDataStorePath = dataStorePath;
+        // If the user has passed an empty dataStorePath, then extract it from the resolved url.
+        if (dataStorePath === "" && odspResolvedUrl.dataStorePath !== undefined) {
+            actualDataStorePath = odspResolvedUrl.dataStorePath;
+        }
         // back-compat: GitHub #9653
         const isFluidPackage = (pkg) => typeof pkg === "object"
             && typeof (pkg === null || pkg === void 0 ? void 0 : pkg.name) === "string"
@@ -155,12 +161,12 @@ 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));
+        const context = await ((_e = this.getContext) === null || _e === void 0 ? void 0 : _e.call(this, odspResolvedUrl, actualDataStorePath));
         (0, odspFluidFileLink_1.storeLocatorInOdspUrl)(shareLinkUrl, {
             siteUrl: odspResolvedUrl.siteUrl,
             driveId: odspResolvedUrl.driveId,
             itemId: odspResolvedUrl.itemId,
-            dataStorePath,
+            dataStorePath: actualDataStorePath,
             appName: this.appName,
             containerPackageName,
             fileVersion: odspResolvedUrl.fileVersion,