@fluidframework/odsp-driver 2.0.0-internal.1.0.0.84253 → 2.0.0-internal.1.1.0

package/.mocharc.js

@@ -0,0 +1,12 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+'use strict';
+
+const getFluidTestMochaConfig = require('@fluidframework/mocha-test-setup/mocharc-common');
+
+const packageDir = __dirname;
+const config = getFluidTestMochaConfig(packageDir);
+module.exports = config;

package/README.md

@@ -6,3 +6,22 @@ the client and the ODSP server to retrieve Fluid content and connect to the Flui
 The ODSP Fluid service is not a publicly available service, and currently it is not possible to use this driver
 to connect to it. This driver is present as an illustration of a different Fluid driver implementation.
 Developers should not depend on this driver for their own solutions.
+
+
+## ODSP APIs
+
+Documenting some basics about opds-driver specific apis that are relevant for creation or loading of a Fluid file from ODSP.
+
+### /snapshot API
+
+- Creates a new Fluid file with the contents as the summary provided in the request body.
+- The creation of file along with the summary is done in a single api call to reduce the number of round trips during new file creation.
+- Also supports creation of sharing link for the file if appropriate request headers are provided in the api call. This feature was introduced to save the number of round trips that a host app makes while creating a file and then creating a sharing link. 
+	1. Earlier only `&createLinkType=csl` parameter was supported which could create organizational scoped sharing links. Feature is gated by `enableShareLinkWithCreate` provided via `HostStoragePolicy`. (createLinkType is now deprecated, so prefer using option 2 below)
+	1. Now, providing appropriate values for `&createLinkScope` and `&createLinkRole` request parameters will let you create sharing links with various permission scopes. See `resolvedUrl` definition for more details. Feature is gated by `enableSingleRequestForShareLinkWithCreate ` provided via `HostStoragePolicy`.
+
+### /trees/latest API
+
+- Fetches the snapshot of an existing Fluid file.
+- Earlier, application needed to redeem the sharing link of the file before a /trees/latest fetch could be made. To reduce the number of round trips made to ODSP, redemption of the share link now happens along with fetching latest snapshot in the same api request by passing share link in `&sl` request parameter.
+- This api is also preflight-less, which means it is not preceded by an OPTIONS call in the browsers to reduce the network trips to the server.

package/dist/contracts.d.ts

@@ -176,6 +176,7 @@ export interface ICreateFileResponse {
     itemId: string;
     itemUrl: string;
     sequenceNumber: number;
+    sharing?: any;
     sharingLink?: string;
     sharingLinkErrorReason?: string;
 }

package/dist/contracts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"contracts.d.ts","sourceRoot":"","sources":["../src/contracts.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,GAAG,MAAM,sCAAsC,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,yCAAyC,CAAC;AAC5E,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAEtD;;;;EAIE;AACF,MAAM,WAAW,eAAe;IAC5B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;KAAE,CAAC;IACnC,OAAO,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;KAAE,CAAC;IACrC,KAAK,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,CAAC;KAAE,CAAC;IAE5C,YAAY,CAAC,EAAE,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IAEpC,EAAE,EAAE,MAAM,CAAC;IAIX,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC;IAEjB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,6BAA6B,CAAC,EAAE,MAAM,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACrC,KAAK,EAAE,GAAG,CAAC,yBAAyB,EAAE,GAAG,wBAAwB,EAAE,CAAC;CACvE;AAED,MAAM,WAAW,wBAAwB;IACrC,EAAE,EAAE,GAAG,CAAC,yBAAyB,CAAC;IAClC,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,mCAAmC;IAChD,KAAK,EAAE,uBAAuB,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,uBAAuB;IACpC,EAAE,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AAEH,MAAM,WAAW,mBAAmB;IAChC,IAAI,EAAE,WAAW,GAAG,SAAS,CAAC;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,oBAAoB,EAAE,CAAC;CACnC;AAED,MAAM,WAAW,qBAAqB;IAClC,EAAE,EAAE,MAAM,CAAC;CACd;AAED,oBAAY,oBAAoB,GAAG,0BAA0B,GAAG,2BAA2B,CAAC;AAE5F,MAAM,WAAW,yBAAyB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC;CACpC;AAED,MAAM,WAAW,0BAA2B,SAAQ,yBAAyB;IACzE,KAAK,EAAE,oBAAoB,CAAC;IAE5B,YAAY,CAAC,EAAE,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,2BAA4B,SAAQ,yBAAyB;IAC1E,EAAE,EAAE,MAAM,CAAC;CACd;AAED,oBAAY,oBAAoB,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;AAEvE,MAAM,WAAW,gBAAgB;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,oBAAoB,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,gBAAgB;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC;CAChC;AAED;;;;GAIG;AAEH,MAAM,WAAW,0BAA0B;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IAEb,YAAY,CAAC,EAAE,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,4BAA4B;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,QAAQ,CAAC;CAClB;AAED,MAAM,WAAW,0BAA0B;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,oBAAY,sBAAsB,GAC5B,0BAA0B,GAC1B,4BAA4B,GAC5B,0BAA0B,CAAC;AAEjC,MAAM,WAAW,mBAAmB;IAChC,OAAO,EAAE,sBAAsB,EAAE,CAAC;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B,OAAO,EAAE,MAAM,CAAC;IAGhB,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,aAAa;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,mBAAmB,EAAE,CAAC;IAC7B,KAAK,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC5B,GAAG,CAAC,EAAE,wBAAwB,EAAE,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB;IAChE,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED,MAAM,WAAW,mBAAmB;IAChC,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,wBAAwB;IACrC,KAAK,EAAE,GAAG,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,EAAE,CAAC,CAAC;CACd;AAED,eAAO,MAAM,0BAA0B,IAAI,CAAC;AAE5C,MAAM,WAAW,eAAe;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,GAAG,CAAC,yBAAyB,EAAE,CAAC;CAC9C;AAED,MAAM,WAAW,iBAAiB;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,sBAAsB;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2BAA2B,CAAC,EAAE,MAAM,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,iBAAiB;IAC3D,cAAc,EAAE,MAAM,CAAC;CAC1B"}
+{"version":3,"file":"contracts.d.ts","sourceRoot":"","sources":["../src/contracts.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,GAAG,MAAM,sCAAsC,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,yCAAyC,CAAC;AAC5E,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAEtD;;;;EAIE;AACF,MAAM,WAAW,eAAe;IAC5B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;KAAE,CAAC;IACnC,OAAO,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;KAAE,CAAC;IACrC,KAAK,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,CAAC;KAAE,CAAC;IAE5C,YAAY,CAAC,EAAE,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IAEpC,EAAE,EAAE,MAAM,CAAC;IAIX,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC;IAEjB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,6BAA6B,CAAC,EAAE,MAAM,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACrC,KAAK,EAAE,GAAG,CAAC,yBAAyB,EAAE,GAAG,wBAAwB,EAAE,CAAC;CACvE;AAED,MAAM,WAAW,wBAAwB;IACrC,EAAE,EAAE,GAAG,CAAC,yBAAyB,CAAC;IAClC,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,mCAAmC;IAChD,KAAK,EAAE,uBAAuB,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,uBAAuB;IACpC,EAAE,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AAEH,MAAM,WAAW,mBAAmB;IAChC,IAAI,EAAE,WAAW,GAAG,SAAS,CAAC;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,oBAAoB,EAAE,CAAC;CACnC;AAED,MAAM,WAAW,qBAAqB;IAClC,EAAE,EAAE,MAAM,CAAC;CACd;AAED,oBAAY,oBAAoB,GAAG,0BAA0B,GAAG,2BAA2B,CAAC;AAE5F,MAAM,WAAW,yBAAyB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC;CACpC;AAED,MAAM,WAAW,0BAA2B,SAAQ,yBAAyB;IACzE,KAAK,EAAE,oBAAoB,CAAC;IAE5B,YAAY,CAAC,EAAE,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,2BAA4B,SAAQ,yBAAyB;IAC1E,EAAE,EAAE,MAAM,CAAC;CACd;AAED,oBAAY,oBAAoB,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;AAEvE,MAAM,WAAW,gBAAgB;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,oBAAoB,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,gBAAgB;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC;CAChC;AAED;;;;GAIG;AAEH,MAAM,WAAW,0BAA0B;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IAEb,YAAY,CAAC,EAAE,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,4BAA4B;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,QAAQ,CAAC;CAClB;AAED,MAAM,WAAW,0BAA0B;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,oBAAY,sBAAsB,GAC5B,0BAA0B,GAC1B,4BAA4B,GAC5B,0BAA0B,CAAC;AAEjC,MAAM,WAAW,mBAAmB;IAChC,OAAO,EAAE,sBAAsB,EAAE,CAAC;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B,OAAO,EAAE,MAAM,CAAC;IAGhB,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,aAAa;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,mBAAmB,EAAE,CAAC;IAC7B,KAAK,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC5B,GAAG,CAAC,EAAE,wBAAwB,EAAE,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB;IAChE,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED,MAAM,WAAW,mBAAmB;IAChC,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IAEvB,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,wBAAwB;IACrC,KAAK,EAAE,GAAG,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,EAAE,CAAC,CAAC;CACd;AAED,eAAO,MAAM,0BAA0B,IAAI,CAAC;AAE5C,MAAM,WAAW,eAAe;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,GAAG,CAAC,yBAAyB,EAAE,CAAC;CAC9C;AAED,MAAM,WAAW,iBAAiB;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,sBAAsB;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2BAA2B,CAAC,EAAE,MAAM,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,iBAAiB;IAC3D,cAAc,EAAE,MAAM,CAAC;CAC1B"}

package/dist/contracts.js.map

@@ -1 +1 @@
-{"version":3,"file":"contracts.js","sourceRoot":"","sources":["../src/contracts.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAkOU,QAAA,0BAA0B,GAAG,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport * as api from \"@fluidframework/protocol-definitions\";\nimport { HostStoragePolicy } from \"@fluidframework/odsp-driver-definitions\";\nimport { ISnapshotContents } from \"./odspPublicUtils\";\n\n/** https://portal.microsofticm.com/imp/v3/incidents/details/308931013/home\n * The commits property was removed from protocol-definitions but in order to support back compat, we will\n * temporarily add back in this local structure in order to upload the snapshot to support rolling back to 0.58.\n * Notice this entire interface will be removed once the backward compatibility is not required anymore.\n*/\nexport interface ISnapshotTreeEx {\n    id?: string;\n    blobs: { [path: string]: string; };\n    commits: { [path: string]: string; };\n    trees: { [path: string]: ISnapshotTreeEx; };\n    // Indicates that this tree is unreferenced. If this is not present, the tree is considered referenced.\n    unreferenced?: true;\n}\n\n/**\n * Socket storage discovery api response\n */\nexport interface ISocketStorageDiscovery {\n    // The id of the web socket\n    id: string;\n\n    // SPO gives us runtimeTenantId, we remap it to tenantId\n    // See getSocketStorageDiscovery\n    runtimeTenantId?: string;\n    tenantId: string;\n\n    snapshotStorageUrl: string;\n    deltaStorageUrl: string;\n\n    /**\n     * PUSH URL\n     */\n    deltaStreamSocketUrl: string;\n\n    /**\n     * The access token for PushChannel. Optionally returned, depending on implementation.\n     * OneDrive for Consumer implementation returns it and OneDrive for Business implementation\n     * does not return it and instead expects token to be returned via `getWebsocketToken` callback\n     * passed as a parameter to `OdspDocumentService.create()` factory.\n     */\n    socketToken?: string;\n\n    /**\n     * This is the time within which client has to refresh the session on (ODSP) relay service.\n     */\n    refreshSessionDurationSeconds?: number;\n}\n\n/**\n * Interface for error responses for the WebSocket connection\n */\nexport interface IOdspSocketError {\n    /**\n     * An error code number for the error that occurred\n     * It will be a valid HTTP status code\n     */\n    code: number;\n\n    /**\n     * A message about the error that occurred for debugging / logging purposes\n     * This should not be displayed to the user directly\n     */\n    message: string;\n\n    /**\n     * Optional Retry-After time in seconds\n     * The client should wait this many seconds before retrying its request\n     */\n    retryAfter?: number;\n}\n\n/**\n * Interface for delta storage response.\n * Contains either SequencedDocumentMessages or SequencedDeltaOpMessage.\n */\nexport interface IDeltaStorageGetResponse {\n    value: api.ISequencedDocumentMessage[] | ISequencedDeltaOpMessage[];\n}\n\nexport interface ISequencedDeltaOpMessage {\n    op: api.ISequencedDocumentMessage;\n    sequenceNumber: number;\n}\n\nexport interface IDocumentStorageGetVersionsResponse {\n    value: IDocumentStorageVersion[];\n}\n\nexport interface IDocumentStorageVersion {\n    id: string;\n}\n\n/**\n *\n * Data structures that form ODSP Summary\n *\n */\n\nexport interface IOdspSummaryPayload {\n    type: \"container\" | \"channel\";\n    message: string;\n    sequenceNumber: number;\n    entries: OdspSummaryTreeEntry[];\n}\n\nexport interface IWriteSummaryResponse {\n    id: string;\n}\n\nexport type OdspSummaryTreeEntry = IOdspSummaryTreeValueEntry | IOdspSummaryTreeHandleEntry;\n\nexport interface IOdspSummaryTreeBaseEntry {\n    path: string;\n    type: \"blob\" | \"tree\" | \"commit\";\n}\n\nexport interface IOdspSummaryTreeValueEntry extends IOdspSummaryTreeBaseEntry {\n    value: OdspSummaryTreeValue;\n    // Indicates that this tree entry is unreferenced. If this is not present, the tree entry is considered referenced.\n    unreferenced?: true;\n}\n\nexport interface IOdspSummaryTreeHandleEntry extends IOdspSummaryTreeBaseEntry {\n    id: string;\n}\n\nexport type OdspSummaryTreeValue = IOdspSummaryTree | IOdspSummaryBlob;\n\nexport interface IOdspSummaryTree {\n    type: \"tree\";\n    entries?: OdspSummaryTreeEntry[];\n}\n\nexport interface IOdspSummaryBlob {\n    type: \"blob\";\n    content: string;\n    encoding: \"base64\" | \"utf-8\";\n}\n\n/**\n *\n * Data structures that form ODSP Snapshot\n *\n */\n\nexport interface IOdspSnapshotTreeEntryTree {\n    path: string;\n    type: \"tree\";\n    // Indicates that this tree entry is unreferenced. If this is not present, the tree entry is considered referenced.\n    unreferenced?: true;\n}\n\nexport interface IOdspSnapshotTreeEntryCommit {\n    id: string;\n    path: string;\n    type: \"commit\";\n}\n\nexport interface IOdspSnapshotTreeEntryBlob {\n    id: string;\n    path: string;\n    type: \"blob\";\n}\n\nexport type IOdspSnapshotTreeEntry =\n    | IOdspSnapshotTreeEntryTree\n    | IOdspSnapshotTreeEntryCommit\n    | IOdspSnapshotTreeEntryBlob;\n\nexport interface IOdspSnapshotCommit {\n    entries: IOdspSnapshotTreeEntry[];\n    id: string;\n    sequenceNumber: number;\n}\n\n/**\n * Blob content, represents blobs in downloaded snapshot.\n */\nexport interface IOdspSnapshotBlob {\n    content: string;\n    // SPO only uses \"base64\" today for download.\n    // We are adding undefined too, as temp way to roundtrip strings unchanged.\n    encoding: \"base64\" | undefined;\n    id: string;\n    size: number;\n}\n\nexport interface IOdspSnapshot {\n    id: string;\n    trees: IOdspSnapshotCommit[];\n    blobs?: IOdspSnapshotBlob[];\n    ops?: ISequencedDeltaOpMessage[];\n}\n\n/**\n * Same as HostStoragePolicy, but adds options that are internal to runtime.\n * All fields should be optional.\n */\nexport interface HostStoragePolicyInternal extends HostStoragePolicy {\n    summarizerClient?: boolean;\n}\n\nexport interface ICreateFileResponse {\n    \"@odata.context\": string;\n    driveId: string;\n    id: string;\n    itemId: string;\n    itemUrl: string;\n    sequenceNumber: number;\n    sharingLink?: string;\n    sharingLinkErrorReason?: string;\n}\n\nexport interface IVersionedValueWithEpoch {\n    value: any;\n    fluidEpoch: string;\n    // This is same as \"persistedCacheValueVersion\" below. This represents the version of data stored in cache.\n    version: 3;\n}\n\nexport const persistedCacheValueVersion = 3;\n\nexport interface IGetOpsResponse {\n    nonce: string;\n    code: number;\n    /** Time in seconds. Currently never set by PUSH */\n    retryAfter?: number;\n    messages?: api.ISequencedDocumentMessage[];\n}\n\nexport interface IFlushOpsResponse {\n    nonce: string;\n    code: number;\n    /** Time in seconds */\n    retryAfter?: number;\n    lastPersistedSequenceNumber?: number;\n}\n\n/**\n * Represents the cached snapshot value.\n */\nexport interface ISnapshotCachedEntry extends ISnapshotContents {\n    cacheEntryTime: number;\n}\n"]}
+{"version":3,"file":"contracts.js","sourceRoot":"","sources":["../src/contracts.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAoOU,QAAA,0BAA0B,GAAG,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport * as api from \"@fluidframework/protocol-definitions\";\nimport { HostStoragePolicy } from \"@fluidframework/odsp-driver-definitions\";\nimport { ISnapshotContents } from \"./odspPublicUtils\";\n\n/** https://portal.microsofticm.com/imp/v3/incidents/details/308931013/home\n * The commits property was removed from protocol-definitions but in order to support back compat, we will\n * temporarily add back in this local structure in order to upload the snapshot to support rolling back to 0.58.\n * Notice this entire interface will be removed once the backward compatibility is not required anymore.\n*/\nexport interface ISnapshotTreeEx {\n    id?: string;\n    blobs: { [path: string]: string; };\n    commits: { [path: string]: string; };\n    trees: { [path: string]: ISnapshotTreeEx; };\n    // Indicates that this tree is unreferenced. If this is not present, the tree is considered referenced.\n    unreferenced?: true;\n}\n\n/**\n * Socket storage discovery api response\n */\nexport interface ISocketStorageDiscovery {\n    // The id of the web socket\n    id: string;\n\n    // SPO gives us runtimeTenantId, we remap it to tenantId\n    // See getSocketStorageDiscovery\n    runtimeTenantId?: string;\n    tenantId: string;\n\n    snapshotStorageUrl: string;\n    deltaStorageUrl: string;\n\n    /**\n     * PUSH URL\n     */\n    deltaStreamSocketUrl: string;\n\n    /**\n     * The access token for PushChannel. Optionally returned, depending on implementation.\n     * OneDrive for Consumer implementation returns it and OneDrive for Business implementation\n     * does not return it and instead expects token to be returned via `getWebsocketToken` callback\n     * passed as a parameter to `OdspDocumentService.create()` factory.\n     */\n    socketToken?: string;\n\n    /**\n     * This is the time within which client has to refresh the session on (ODSP) relay service.\n     */\n    refreshSessionDurationSeconds?: number;\n}\n\n/**\n * Interface for error responses for the WebSocket connection\n */\nexport interface IOdspSocketError {\n    /**\n     * An error code number for the error that occurred\n     * It will be a valid HTTP status code\n     */\n    code: number;\n\n    /**\n     * A message about the error that occurred for debugging / logging purposes\n     * This should not be displayed to the user directly\n     */\n    message: string;\n\n    /**\n     * Optional Retry-After time in seconds\n     * The client should wait this many seconds before retrying its request\n     */\n    retryAfter?: number;\n}\n\n/**\n * Interface for delta storage response.\n * Contains either SequencedDocumentMessages or SequencedDeltaOpMessage.\n */\nexport interface IDeltaStorageGetResponse {\n    value: api.ISequencedDocumentMessage[] | ISequencedDeltaOpMessage[];\n}\n\nexport interface ISequencedDeltaOpMessage {\n    op: api.ISequencedDocumentMessage;\n    sequenceNumber: number;\n}\n\nexport interface IDocumentStorageGetVersionsResponse {\n    value: IDocumentStorageVersion[];\n}\n\nexport interface IDocumentStorageVersion {\n    id: string;\n}\n\n/**\n *\n * Data structures that form ODSP Summary\n *\n */\n\nexport interface IOdspSummaryPayload {\n    type: \"container\" | \"channel\";\n    message: string;\n    sequenceNumber: number;\n    entries: OdspSummaryTreeEntry[];\n}\n\nexport interface IWriteSummaryResponse {\n    id: string;\n}\n\nexport type OdspSummaryTreeEntry = IOdspSummaryTreeValueEntry | IOdspSummaryTreeHandleEntry;\n\nexport interface IOdspSummaryTreeBaseEntry {\n    path: string;\n    type: \"blob\" | \"tree\" | \"commit\";\n}\n\nexport interface IOdspSummaryTreeValueEntry extends IOdspSummaryTreeBaseEntry {\n    value: OdspSummaryTreeValue;\n    // Indicates that this tree entry is unreferenced. If this is not present, the tree entry is considered referenced.\n    unreferenced?: true;\n}\n\nexport interface IOdspSummaryTreeHandleEntry extends IOdspSummaryTreeBaseEntry {\n    id: string;\n}\n\nexport type OdspSummaryTreeValue = IOdspSummaryTree | IOdspSummaryBlob;\n\nexport interface IOdspSummaryTree {\n    type: \"tree\";\n    entries?: OdspSummaryTreeEntry[];\n}\n\nexport interface IOdspSummaryBlob {\n    type: \"blob\";\n    content: string;\n    encoding: \"base64\" | \"utf-8\";\n}\n\n/**\n *\n * Data structures that form ODSP Snapshot\n *\n */\n\nexport interface IOdspSnapshotTreeEntryTree {\n    path: string;\n    type: \"tree\";\n    // Indicates that this tree entry is unreferenced. If this is not present, the tree entry is considered referenced.\n    unreferenced?: true;\n}\n\nexport interface IOdspSnapshotTreeEntryCommit {\n    id: string;\n    path: string;\n    type: \"commit\";\n}\n\nexport interface IOdspSnapshotTreeEntryBlob {\n    id: string;\n    path: string;\n    type: \"blob\";\n}\n\nexport type IOdspSnapshotTreeEntry =\n    | IOdspSnapshotTreeEntryTree\n    | IOdspSnapshotTreeEntryCommit\n    | IOdspSnapshotTreeEntryBlob;\n\nexport interface IOdspSnapshotCommit {\n    entries: IOdspSnapshotTreeEntry[];\n    id: string;\n    sequenceNumber: number;\n}\n\n/**\n * Blob content, represents blobs in downloaded snapshot.\n */\nexport interface IOdspSnapshotBlob {\n    content: string;\n    // SPO only uses \"base64\" today for download.\n    // We are adding undefined too, as temp way to roundtrip strings unchanged.\n    encoding: \"base64\" | undefined;\n    id: string;\n    size: number;\n}\n\nexport interface IOdspSnapshot {\n    id: string;\n    trees: IOdspSnapshotCommit[];\n    blobs?: IOdspSnapshotBlob[];\n    ops?: ISequencedDeltaOpMessage[];\n}\n\n/**\n * Same as HostStoragePolicy, but adds options that are internal to runtime.\n * All fields should be optional.\n */\nexport interface HostStoragePolicyInternal extends HostStoragePolicy {\n    summarizerClient?: boolean;\n}\n\nexport interface ICreateFileResponse {\n    \"@odata.context\": string;\n    driveId: string;\n    id: string;\n    itemId: string;\n    itemUrl: string;\n    sequenceNumber: number;\n    // sharing object contains shareId, sharingLink data or error in the response\n    sharing?: any;\n    sharingLink?: string;\n    sharingLinkErrorReason?: string;\n}\n\nexport interface IVersionedValueWithEpoch {\n    value: any;\n    fluidEpoch: string;\n    // This is same as \"persistedCacheValueVersion\" below. This represents the version of data stored in cache.\n    version: 3;\n}\n\nexport const persistedCacheValueVersion = 3;\n\nexport interface IGetOpsResponse {\n    nonce: string;\n    code: number;\n    /** Time in seconds. Currently never set by PUSH */\n    retryAfter?: number;\n    messages?: api.ISequencedDocumentMessage[];\n}\n\nexport interface IFlushOpsResponse {\n    nonce: string;\n    code: number;\n    /** Time in seconds */\n    retryAfter?: number;\n    lastPersistedSequenceNumber?: number;\n}\n\n/**\n * Represents the cached snapshot value.\n */\nexport interface ISnapshotCachedEntry extends ISnapshotContents {\n    cacheEntryTime: number;\n}\n"]}

package/dist/createFile.d.ts

@@ -12,7 +12,7 @@ import { EpochTracker } from "./epochTracker";
  * Creates a new Fluid file.
  * Returns resolved url
  */
-export declare function createNewFluidFile(getStorageToken: InstrumentedStorageTokenFetcher, newFileInfo: INewFileInfo, logger: ITelemetryLogger, createNewSummary: ISummaryTree | undefined, epochTracker: EpochTracker, fileEntry: IFileEntry, createNewCaching: boolean, forceAccessTokenViaAuthorizationHeader: boolean, isClpCompliantApp?: boolean): Promise<IOdspResolvedUrl>;
+export declare function createNewFluidFile(getStorageToken: InstrumentedStorageTokenFetcher, newFileInfo: INewFileInfo, logger: ITelemetryLogger, createNewSummary: ISummaryTree | undefined, epochTracker: EpochTracker, fileEntry: IFileEntry, createNewCaching: boolean, forceAccessTokenViaAuthorizationHeader: boolean, isClpCompliantApp?: boolean, enableSingleRequestForShareLinkWithCreate?: boolean, enableShareLinkWithCreate?: boolean): Promise<IOdspResolvedUrl>;
 export declare function createNewEmptyFluidFile(getStorageToken: InstrumentedStorageTokenFetcher, newFileInfo: INewFileInfo, logger: ITelemetryLogger, epochTracker: EpochTracker, forceAccessTokenViaAuthorizationHeader: boolean): Promise<string>;
 export declare function createNewFluidFileFromSummary(getStorageToken: InstrumentedStorageTokenFetcher, newFileInfo: INewFileInfo, logger: ITelemetryLogger, createNewSummary: ISummaryTree, epochTracker: EpochTracker, forceAccessTokenViaAuthorizationHeader: boolean): Promise<ICreateFileResponse>;
 /**

package/dist/createFile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createFile.d.ts","sourceRoot":"","sources":["../src/createFile.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,OAAO,EAAe,YAAY,EAAgB,MAAM,sCAAsC,CAAC;AAC/F,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAEtE,OAAO,EACH,UAAU,EACV,+BAA+B,EAC/B,gBAAgB,EAEnB,MAAM,yCAAyC,CAAC;AAEjD,OAAO,EACH,gBAAgB,EAGhB,mBAAmB,EAEtB,MAAM,aAAa,CAAC;AAErB,OAAO,EAGH,YAAY,EAGf,MAAM,aAAa,CAAC;AAIrB,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAY9C;;;GAGG;AACH,wBAAsB,kBAAkB,CACpC,eAAe,EAAE,+BAA+B,EAChD,WAAW,EAAE,YAAY,EACzB,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,CAyD3B;AAED,wBAAsB,uBAAuB,CACzC,eAAe,EAAE,+BAA+B,EAChD,WAAW,EAAE,YAAY,EACzB,MAAM,EAAE,gBAAgB,EACxB,YAAY,EAAE,YAAY,EAC1B,sCAAsC,EAAE,OAAO,GAChD,OAAO,CAAC,MAAM,CAAC,CAiDjB;AAED,wBAAsB,6BAA6B,CAC/C,eAAe,EAAE,+BAA+B,EAChD,WAAW,EAAE,YAAY,EACzB,MAAM,EAAE,gBAAgB,EACxB,gBAAgB,EAAE,YAAY,EAC9B,YAAY,EAAE,YAAY,EAC1B,sCAAsC,EAAE,OAAO,GAChD,OAAO,CAAC,mBAAmB,CAAC,CAiF9B;AA+BD;;GAEG;AACH,wBAAgB,wCAAwC,CAAC,OAAO,EAAE,YAAY,GAAG,gBAAgB,CAoDhG"}
+{"version":3,"file":"createFile.d.ts","sourceRoot":"","sources":["../src/createFile.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,OAAO,EAAe,YAAY,EAAgB,MAAM,sCAAsC,CAAC;AAC/F,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAEtE,OAAO,EACH,UAAU,EACV,+BAA+B,EAC/B,gBAAgB,EAKnB,MAAM,yCAAyC,CAAC;AAEjD,OAAO,EACH,gBAAgB,EAGhB,mBAAmB,EAEtB,MAAM,aAAa,CAAC;AAErB,OAAO,EAIH,YAAY,EAGf,MAAM,aAAa,CAAC;AAIrB,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAY9C;;;GAGG;AACH,wBAAsB,kBAAkB,CACpC,eAAe,EAAE,+BAA+B,EAChD,WAAW,EAAE,YAAY,EACzB,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,EAC3B,yCAAyC,CAAC,EAAE,OAAO,EACnD,yBAAyB,CAAC,EAAE,OAAO,GACpC,OAAO,CAAC,gBAAgB,CAAC,CAoD3B;AAyDD,wBAAsB,uBAAuB,CACzC,eAAe,EAAE,+BAA+B,EAChD,WAAW,EAAE,YAAY,EACzB,MAAM,EAAE,gBAAgB,EACxB,YAAY,EAAE,YAAY,EAC1B,sCAAsC,EAAE,OAAO,GAChD,OAAO,CAAC,MAAM,CAAC,CAiDjB;AAED,wBAAsB,6BAA6B,CAC/C,eAAe,EAAE,+BAA+B,EAChD,WAAW,EAAE,YAAY,EACzB,MAAM,EAAE,gBAAgB,EACxB,gBAAgB,EAAE,YAAY,EAC9B,YAAY,EAAE,YAAY,EAC1B,sCAAsC,EAAE,OAAO,GAChD,OAAO,CAAC,mBAAmB,CAAC,CAqF9B;AA+BD;;GAEG;AACH,wBAAgB,wCAAwC,CAAC,OAAO,EAAE,YAAY,GAAG,gBAAgB,CAoDhG"}

package/dist/createFile.js

@@ -30,7 +30,7 @@ const isInvalidFileName = (fileName) => {
  * Creates a new Fluid file.
  * Returns resolved url
  */
-async function createNewFluidFile(getStorageToken, newFileInfo, logger, createNewSummary, epochTracker, fileEntry, createNewCaching, forceAccessTokenViaAuthorizationHeader, isClpCompliantApp) {
+async function createNewFluidFile(getStorageToken, newFileInfo, logger, createNewSummary, epochTracker, fileEntry, createNewCaching, forceAccessTokenViaAuthorizationHeader, isClpCompliantApp, enableSingleRequestForShareLinkWithCreate, enableShareLinkWithCreate) {
     // Check for valid filename before the request to create file is actually made.
     if (isInvalidFileName(newFileInfo.filename)) {
         throw new driver_utils_1.NonRetryableError(
@@ -39,8 +39,7 @@ async function createNewFluidFile(getStorageToken, newFileInfo, logger, createNe
     }
     let itemId;
     let summaryHandle = "";
-    let sharingLink;
-    let sharingLinkErrorReason;
+    let shareLinkInfo;
     if (createNewSummary === undefined) {
         itemId = await createNewEmptyFluidFile(getStorageToken, newFileInfo, logger, epochTracker, forceAccessTokenViaAuthorizationHeader);
     }
@@ -48,8 +47,7 @@ async function createNewFluidFile(getStorageToken, newFileInfo, logger, createNe
         const content = await createNewFluidFileFromSummary(getStorageToken, newFileInfo, logger, createNewSummary, epochTracker, forceAccessTokenViaAuthorizationHeader);
         itemId = content.itemId;
         summaryHandle = content.id;
-        sharingLink = content.sharingLink;
-        sharingLinkErrorReason = content.sharingLinkErrorReason;
+        shareLinkInfo = extractShareLinkData(newFileInfo.createLinkType, content, enableSingleRequestForShareLinkWithCreate, enableShareLinkWithCreate);
     }
     const odspUrl = (0, createOdspUrl_1.createOdspUrl)(Object.assign(Object.assign({}, newFileInfo), { itemId, dataStorePath: "/" }));
     const resolver = new odspDriverUrlResolver_1.OdspDriverUrlResolver();
@@ -59,15 +57,7 @@ async function createNewFluidFile(getStorageToken, newFileInfo, logger, createNe
     });
     fileEntry.docId = odspResolvedUrl.hashedDocumentId;
     fileEntry.resolvedUrl = odspResolvedUrl;
-    if (sharingLink || sharingLinkErrorReason) {
-        odspResolvedUrl.shareLinkInfo = {
-            createLink: {
-                type: newFileInfo.createLinkType,
-                link: sharingLink,
-                error: sharingLinkErrorReason,
-            },
-        };
-    }
+    odspResolvedUrl.shareLinkInfo = shareLinkInfo;
     if (createNewSummary !== undefined && createNewCaching) {
         (0, common_utils_1.assert)(summaryHandle !== undefined, 0x203 /* "Summary handle is undefined" */);
         // converting summary and getting sequence number
@@ -78,6 +68,51 @@ async function createNewFluidFile(getStorageToken, newFileInfo, logger, createNe
     return odspResolvedUrl;
 }
 exports.createNewFluidFile = createNewFluidFile;
+/**
+ * If user requested creation of a sharing link along with the creation of the file by providing either
+ * createLinkType (now deprecated) or createLinkScope in the request parameters, extract and save
+ * sharing link information from the response if it is available.
+ * In case there was an error in creation of the sharing link, error is provided back in the response,
+ * and does not impact the creation of file in ODSP.
+ * @param requestedSharingLinkKind - Kind of sharing link requested to be created along with the creation of file.
+ * @param response - Response object received from the /snapshot api call
+ * @returns Sharing link information received in the response from a successful creation of a file.
+ */
+function extractShareLinkData(requestedSharingLinkKind, response, enableSingleRequestForShareLinkWithCreate, enableShareLinkWithCreate) {
+    if (!requestedSharingLinkKind) {
+        return;
+    }
+    let shareLinkInfo;
+    if (enableSingleRequestForShareLinkWithCreate) {
+        const { sharing } = response;
+        if (!sharing) {
+            return;
+        }
+        shareLinkInfo = {
+            createLink: {
+                type: requestedSharingLinkKind,
+                link: sharing.sharingLink ? Object.assign({ scope: sharing.sharingLink.scope, role: sharing.sharingLink.type, webUrl: sharing.sharingLink.webUrl }, sharing.sharingLink) : undefined,
+                error: sharing.error,
+                shareId: sharing.shareId,
+            },
+        };
+    }
+    else if (enableShareLinkWithCreate) {
+        const { sharing, sharingLink, sharingLinkErrorReason } = response;
+        if (!sharingLink && !sharingLinkErrorReason) {
+            return;
+        }
+        shareLinkInfo = {
+            createLink: {
+                type: requestedSharingLinkKind,
+                link: sharingLink,
+                error: sharingLinkErrorReason,
+                shareId: sharing === null || sharing === void 0 ? void 0 : sharing.shareId,
+            },
+        };
+    }
+    return shareLinkInfo;
+}
 async function createNewEmptyFluidFile(getStorageToken, newFileInfo, logger, epochTracker, forceAccessTokenViaAuthorizationHeader) {
     const filePath = newFileInfo.filePath ? encodeURIComponent(`/${newFileInfo.filePath}`) : "";
     // add .tmp extension to empty file (host is expected to rename)
@@ -111,8 +146,10 @@ async function createNewFluidFileFromSummary(getStorageToken, newFileInfo, logge
     const baseUrl = `${(0, odspUrlHelper_1.getApiRoot)((0, odspUtils_1.getOrigin)(newFileInfo.siteUrl))}/drives/${newFileInfo.driveId}/items/root:` +
         `${filePath}/${encodedFilename}`;
     const containerSnapshot = convertSummaryIntoContainerSnapshot(createNewSummary);
-    const initialUrl = `${baseUrl}:/opStream/snapshots/snapshot${newFileInfo.createLinkType ?
-        `?createLinkType=${newFileInfo.createLinkType}` : ""}`;
+    // Build share link parameter based on the createLinkType provided so that the
+    // snapshot api can create and return the share link along with creation of file in the response.
+    const createShareLinkParam = (0, odspUtils_1.buildOdspShareLinkReqParams)(newFileInfo.createLinkType);
+    const initialUrl = `${baseUrl}:/opStream/snapshots/snapshot${createShareLinkParam ? `?${createShareLinkParam}` : ""}`;
     return (0, odspUtils_1.getWithRetryForTokenRefresh)(async (options) => {
         const storageToken = await getStorageToken(options, "CreateNewFile");
         return telemetry_utils_1.PerformanceEvent.timedExecAsync(logger, { eventName: "createNewFile" }, async (event) => {

package/dist/createFile.js.map

@@ -1 +1 @@
-{"version":3,"file":"createFile.js","sourceRoot":"","sources":["../src/createFile.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+BAAkC;AAClC,+DAA0E;AAC1E,+DAAsG;AACtG,iEAA2D;AAC3D,+EAA+F;AAE/F,qEAAmE;AACnE,qFAKiD;AACjD,2EAAqE;AAQrE,yEAAsE;AACtE,2CAMqB;AAErB,mDAAgD;AAChD,mDAA6C;AAE7C,mEAAgE;AAChE,qDAA6E;AAC7E,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;IAE3B,+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,WAA+B,CAAC;IACpC,IAAI,sBAA0C,CAAC;IAC/C,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;QAC3B,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QAClC,sBAAsB,GAAG,OAAO,CAAC,sBAAsB,CAAC;KAC3D;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,IAAI,WAAW,IAAI,sBAAsB,EAAE;QACvC,eAAe,CAAC,aAAa,GAAG;YAC5B,UAAU,EAAE;gBACR,IAAI,EAAE,WAAW,CAAC,cAAc;gBAChC,IAAI,EAAE,WAAW;gBACjB,KAAK,EAAE,sBAAsB;aAChC;SACJ,CAAC;KACL;IAED,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;AAnED,gDAmEC;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,mCAAmC,CAAC,gBAAgB,CAAC,CAAC;IAChF,MAAM,UAAU,GAAG,GAAG,OAAO,gCAAgC,WAAW,CAAC,cAAc,CAAC,CAAC;QACrF,mBAAmB,WAAW,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAE3D,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,eAAe,EAAE,EAC9B,KAAK,EAAE,KAAK,EAAE,EAAE;YACZ,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;YACvD,IAAI,GAAW,CAAC;YAChB,IAAI,OAAqC,CAAC;YAC1C,IAAI,SAAS,GAAG,KAAK,CAAC;YACtB,MAAM,YAAY,GAAG,IAAA,SAAI,GAAE,CAAC;YAC5B,IAAI,QAAQ,GAAG,KAAK,YAAY,MAAM,CAAC;YACvC,QAAQ,IAAI,yBAAyB,YAAY,MAAM,CAAC;YACxD,QAAQ,IAAI,kCAAkC,CAAC;YAC/C,QAAQ,IAAI,oCAAoC,CAAC;YACjD,QAAQ,IAAI,cAAc,CAAC;YAC3B,QAAQ,IAAI,OAAO,YAAY,MAAM,CAAC;YACtC,QAAQ,IAAI,SAAS,YAAY,IAAI,CAAC;YAEtC,IAAI,QAAQ,CAAC,MAAM,IAAI,8BAAkB,EAAE;gBACvC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC;gBACnC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;gBACpC,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC;gBAClB,OAAO,GAAG;oBACN,cAAc,EAAE,gCAAgC,YAAY,EAAE;iBACjE,CAAC;gBACF,SAAS,GAAG,IAAI,CAAC;aACpB;iBAAM;gBACH,MAAM,KAAK,GAAG,IAAA,mDAAwB,EAClC,UAAU,EAAE,YAAY,EAAE,sCAAsC,CAAC,CAAC;gBACtE,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;gBAChB,OAAO,mCACA,KAAK,CAAC,OAAO,KAChB,cAAc,EAAE,kBAAkB,GACrC,CAAC;gBACF,QAAQ,GAAG,YAAY,CAAC;aAC3B;YAED,MAAM,aAAa,GAAG,MAAM,IAAA,yBAAY,EACpC,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,mBAAmB,CACxC,GAAG,EACH;gBACI,IAAI,EAAE,QAAQ;gBACd,OAAO;gBACP,MAAM,EAAE,MAAM;aACjB,EACD,YAAY,EACZ,SAAS,CACZ,EACD,YAAY,EACZ,MAAM,CACT,CAAC;YAEF,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC;YACtC,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;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,EAC7D,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAC9B,aAAa,CAAC,UAAU,EAC7B,CAAC;YACH,OAAO,OAAO,CAAC;QACnB,CAAC,CACJ,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC;AAxFD,sEAwFC;AAED,SAAS,mCAAmC,CAAC,gBAA8B;;IACvE,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAiB,CAAC;IACjE,MAAM,eAAe,GAAG,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAiB,CAAC;IAC3E,IAAI,CAAC,CAAC,UAAU,IAAI,eAAe,CAAC,EAAE;QAClC,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;KAC9E;IACD,MAAM,kBAAkB,GAAG,IAAA,kDAAmC,EAAC,eAAe,CAAC,CAAC;IAChF,MAAM,qBAAqB,GAAiB;QACxC,IAAI,EAAE,kCAAW,CAAC,IAAI;QACtB,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC;KAC9C,CAAC;IACF,eAAe,CAAC,IAAI,CAAC,UAAU,GAAG,qBAAqB,CAAC;IACxD,MAAM,yBAAyB,GAAiB;QAC5C,IAAI,EAAE,kCAAW,CAAC,IAAI;QACtB,IAAI,EAAE;YACF,WAAW,EAAE,eAAe;YAC5B,MAAM,EAAE,UAAU;SACrB;KACJ,CAAC;IACF,MAAM,YAAY,GAAG,wCAAwC,CAAC,yBAAyB,CAAC,CAAC;IACzF,MAAM,QAAQ,GAAwB;QAClC,OAAO,EAAE,MAAA,YAAY,CAAC,OAAO,mCAAI,EAAE;QACnC,OAAO,EAAE,KAAK;QACd,cAAc,EAAE,kBAAkB,CAAC,cAAc;QACjD,IAAI,EAAE,WAAW;KACpB,CAAC;IACF,OAAO,QAAQ,CAAC;AACpB,CAAC;AAED;;GAEG;AACH,SAAgB,wCAAwC,CAAC,OAAqB;;IAC1E,MAAM,YAAY,GAAqB;QACnC,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,EAAE;KACd,CAAC;IAEF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACpB,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAExC,IAAI,KAA2B,CAAC;QAChC,yGAAyG;QACzG,4GAA4G;QAC5G,6CAA6C;QAC7C,IAAI,YAA8B,CAAC;QAEnC,QAAQ,aAAa,CAAC,IAAI,EAAE;YACxB,KAAK,kCAAW,CAAC,IAAI,CAAC,CAAC;gBACnB,KAAK,GAAG,wCAAwC,CAAC,aAAa,CAAC,CAAC;gBAChE,YAAY,GAAG,aAAa,CAAC,YAAY,CAAC;gBAC1C,MAAM;aACT;YACD,KAAK,kCAAW,CAAC,IAAI,CAAC,CAAC;gBACnB,MAAM,OAAO,GAAG,OAAO,aAAa,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC;oBACvD,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,IAAA,iCAAkB,EAAC,aAAa,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAChF,MAAM,QAAQ,GAAG,OAAO,aAAa,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC;gBAEhF,KAAK,GAAG;oBACJ,IAAI,EAAE,MAAM;oBACZ,OAAO;oBACP,QAAQ;iBACX,CAAC;gBACF,MAAM;aACT;YACD,KAAK,kCAAW,CAAC,MAAM,CAAC,CAAC;gBACrB,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;aACtE;YACD,OAAO,CAAC,CAAC;gBACL,MAAM,IAAI,KAAK,CAAC,qBAAqB,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC;aAC9D;SACJ;QAED,MAAM,KAAK,GAAyB;YAChC,IAAI,EAAE,kBAAkB,CAAC,GAAG,CAAC;YAC7B,IAAI,EAAE,IAAA,0BAAU,EAAC,aAAa,CAAC;YAC/B,KAAK;YACL,YAAY;SACf,CAAC;QACF,MAAA,YAAY,CAAC,OAAO,0CAAE,IAAI,CAAC,KAAK,CAAC,CAAC;KACrC;IAED,OAAO,YAAY,CAAC;AACxB,CAAC;AApDD,4FAoDC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { v4 as uuid } from \"uuid\";\nimport { assert, Uint8ArrayToString } from \"@fluidframework/common-utils\";\nimport { getDocAttributesFromProtocolSummary, NonRetryableError } from \"@fluidframework/driver-utils\";\nimport { getGitType } from \"@fluidframework/protocol-base\";\nimport { SummaryType, ISummaryTree, ISummaryBlob } from \"@fluidframework/protocol-definitions\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport {\n    IFileEntry,\n    InstrumentedStorageTokenFetcher,\n    IOdspResolvedUrl,\n    OdspErrorType,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { DriverErrorType } from \"@fluidframework/driver-definitions\";\nimport {\n    IOdspSummaryTree,\n    OdspSummaryTreeValue,\n    OdspSummaryTreeEntry,\n    ICreateFileResponse,\n    IOdspSummaryPayload,\n} from \"./contracts\";\nimport { getUrlAndHeadersWithAuth } from \"./getUrlAndHeadersWithAuth\";\nimport {\n    createCacheSnapshotKey,\n    getWithRetryForTokenRefresh,\n    INewFileInfo,\n    getOrigin,\n    maxUmpPostBodySize,\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 } 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): 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 sharingLink: string | undefined;\n    let sharingLinkErrorReason: string | 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        sharingLink = content.sharingLink;\n        sharingLinkErrorReason = content.sharingLinkErrorReason;\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    if (sharingLink || sharingLinkErrorReason) {\n        odspResolvedUrl.shareLinkInfo = {\n            createLink: {\n                type: newFileInfo.createLinkType,\n                link: sharingLink,\n                error: sharingLinkErrorReason,\n            },\n        };\n    }\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\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    const initialUrl = `${baseUrl}:/opStream/snapshots/snapshot${newFileInfo.createLinkType ?\n        `?createLinkType=${newFileInfo.createLinkType}` : \"\"}`;\n\n    return getWithRetryForTokenRefresh(async (options) => {\n        const storageToken = await getStorageToken(options, \"CreateNewFile\");\n\n        return PerformanceEvent.timedExecAsync(\n            logger,\n            { eventName: \"createNewFile\" },\n            async (event) => {\n                const snapshotBody = JSON.stringify(containerSnapshot);\n                let url: string;\n                let headers: { [index: string]: string; };\n                let addInBody = false;\n                const formBoundary = uuid();\n                let postBody = `--${formBoundary}\\r\\n`;\n                postBody += `Authorization: Bearer ${storageToken}\\r\\n`;\n                postBody += `X-HTTP-Method-Override: POST\\r\\n`;\n                postBody += `Content-Type: application/json\\r\\n`;\n                postBody += `_post: 1\\r\\n`;\n                postBody += `\\r\\n${snapshotBody}\\r\\n`;\n                postBody += `\\r\\n--${formBoundary}--`;\n\n                if (postBody.length <= maxUmpPostBodySize) {\n                    const urlObj = new URL(initialUrl);\n                    urlObj.searchParams.set(\"ump\", \"1\");\n                    url = urlObj.href;\n                    headers = {\n                        \"Content-Type\": `multipart/form-data;boundary=${formBoundary}`,\n                    };\n                    addInBody = true;\n                } else {\n                    const parts = getUrlAndHeadersWithAuth(\n                        initialUrl, storageToken, forceAccessTokenViaAuthorizationHeader);\n                    url = parts.url;\n                    headers = {\n                        ...parts.headers,\n                        \"Content-Type\": \"application/json\",\n                    };\n                    postBody = snapshotBody;\n                }\n\n                const fetchResponse = await runWithRetry(\n                    async () => epochTracker.fetchAndParseAsJSON<ICreateFileResponse>(\n                        url,\n                        {\n                            body: postBody,\n                            headers,\n                            method: \"POST\",\n                        },\n                        \"createFile\",\n                        addInBody,\n                    ),\n                    \"createFile\",\n                    logger,\n                );\n\n                const content = fetchResponse.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                event.end({\n                    headers: Object.keys(headers).length !== 0 ? true : undefined,\n                    attempts: options.refresh ? 2 : 1,\n                    ...fetchResponse.propsToLog,\n                });\n                return content;\n            },\n        );\n    });\n}\n\nfunction convertSummaryIntoContainerSnapshot(createNewSummary: ISummaryTree) {\n    const appSummary = createNewSummary.tree[\".app\"] as ISummaryTree;\n    const protocolSummary = createNewSummary.tree[\".protocol\"] as ISummaryTree;\n    if (!(appSummary && protocolSummary)) {\n        throw new Error(\"App and protocol summary required for create new path!!\");\n    }\n    const documentAttributes = getDocAttributesFromProtocolSummary(protocolSummary);\n    const attributesSummaryBlob: ISummaryBlob = {\n        type: SummaryType.Blob,\n        content: JSON.stringify(documentAttributes),\n    };\n    protocolSummary.tree.attributes = attributesSummaryBlob;\n    const convertedCreateNewSummary: ISummaryTree = {\n        type: SummaryType.Tree,\n        tree: {\n            \".protocol\": protocolSummary,\n            \".app\": appSummary,\n        },\n    };\n    const snapshotTree = convertSummaryToSnapshotTreeForCreateNew(convertedCreateNewSummary);\n    const snapshot: IOdspSummaryPayload = {\n        entries: snapshotTree.entries ?? [],\n        message: \"app\",\n        sequenceNumber: documentAttributes.sequenceNumber,\n        type: \"container\",\n    };\n    return snapshot;\n}\n\n/**\n * Converts a summary tree to ODSP tree\n */\nexport function convertSummaryToSnapshotTreeForCreateNew(summary: ISummaryTree): IOdspSummaryTree {\n    const snapshotTree: IOdspSummaryTree = {\n        type: \"tree\",\n        entries: [],\n    };\n\n    const keys = Object.keys(summary.tree);\n    for (const key of keys) {\n        const summaryObject = summary.tree[key];\n\n        let value: OdspSummaryTreeValue;\n        // Tracks if an entry is unreferenced. Currently, only tree entries can be marked as unreferenced. If the\n        // property is not present, the tree entry is considered referenced. If the property is present and is true,\n        // the tree entry is considered unreferenced.\n        let unreferenced: true | undefined;\n\n        switch (summaryObject.type) {\n            case SummaryType.Tree: {\n                value = convertSummaryToSnapshotTreeForCreateNew(summaryObject);\n                unreferenced = summaryObject.unreferenced;\n                break;\n            }\n            case SummaryType.Blob: {\n                const content = typeof summaryObject.content === \"string\" ?\n                    summaryObject.content : Uint8ArrayToString(summaryObject.content, \"base64\");\n                const encoding = typeof summaryObject.content === \"string\" ? \"utf-8\" : \"base64\";\n\n                value = {\n                    type: \"blob\",\n                    content,\n                    encoding,\n                };\n                break;\n            }\n            case SummaryType.Handle: {\n                throw new Error(\"No handle should be present for first summary!!\");\n            }\n            default: {\n                throw new Error(`Unknown tree type ${summaryObject.type}`);\n            }\n        }\n\n        const entry: OdspSummaryTreeEntry = {\n            path: encodeURIComponent(key),\n            type: getGitType(summaryObject),\n            value,\n            unreferenced,\n        };\n        snapshotTree.entries?.push(entry);\n    }\n\n    return snapshotTree;\n}\n"]}
+{"version":3,"file":"createFile.js","sourceRoot":"","sources":["../src/createFile.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+BAAkC;AAClC,+DAA0E;AAC1E,+DAAsG;AACtG,iEAA2D;AAC3D,+EAA+F;AAE/F,qEAAmE;AACnE,qFAQiD;AACjD,2EAAqE;AAQrE,yEAAsE;AACtE,2CAOqB;AAErB,mDAAgD;AAChD,mDAA6C;AAE7C,mEAAgE;AAChE,qDAA6E;AAC7E,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,mCAAmC,CAAC,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,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,eAAe,EAAE,EAC9B,KAAK,EAAE,KAAK,EAAE,EAAE;YACZ,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;YACvD,IAAI,GAAW,CAAC;YAChB,IAAI,OAAqC,CAAC;YAC1C,IAAI,SAAS,GAAG,KAAK,CAAC;YACtB,MAAM,YAAY,GAAG,IAAA,SAAI,GAAE,CAAC;YAC5B,IAAI,QAAQ,GAAG,KAAK,YAAY,MAAM,CAAC;YACvC,QAAQ,IAAI,yBAAyB,YAAY,MAAM,CAAC;YACxD,QAAQ,IAAI,kCAAkC,CAAC;YAC/C,QAAQ,IAAI,oCAAoC,CAAC;YACjD,QAAQ,IAAI,cAAc,CAAC;YAC3B,QAAQ,IAAI,OAAO,YAAY,MAAM,CAAC;YACtC,QAAQ,IAAI,SAAS,YAAY,IAAI,CAAC;YAEtC,IAAI,QAAQ,CAAC,MAAM,IAAI,8BAAkB,EAAE;gBACvC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC;gBACnC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;gBACpC,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC;gBAClB,OAAO,GAAG;oBACN,cAAc,EAAE,gCAAgC,YAAY,EAAE;iBACjE,CAAC;gBACF,SAAS,GAAG,IAAI,CAAC;aACpB;iBAAM;gBACH,MAAM,KAAK,GAAG,IAAA,mDAAwB,EAClC,UAAU,EAAE,YAAY,EAAE,sCAAsC,CAAC,CAAC;gBACtE,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;gBAChB,OAAO,mCACA,KAAK,CAAC,OAAO,KAChB,cAAc,EAAE,kBAAkB,GACrC,CAAC;gBACF,QAAQ,GAAG,YAAY,CAAC;aAC3B;YAED,MAAM,aAAa,GAAG,MAAM,IAAA,yBAAY,EACpC,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,mBAAmB,CACxC,GAAG,EACH;gBACI,IAAI,EAAE,QAAQ;gBACd,OAAO;gBACP,MAAM,EAAE,MAAM;aACjB,EACD,YAAY,EACZ,SAAS,CACZ,EACD,YAAY,EACZ,MAAM,CACT,CAAC;YAEF,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC;YACtC,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;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,EAC7D,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAC9B,aAAa,CAAC,UAAU,EAC7B,CAAC;YACH,OAAO,OAAO,CAAC;QACnB,CAAC,CACJ,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC;AA5FD,sEA4FC;AAED,SAAS,mCAAmC,CAAC,gBAA8B;;IACvE,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAiB,CAAC;IACjE,MAAM,eAAe,GAAG,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAiB,CAAC;IAC3E,IAAI,CAAC,CAAC,UAAU,IAAI,eAAe,CAAC,EAAE;QAClC,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;KAC9E;IACD,MAAM,kBAAkB,GAAG,IAAA,kDAAmC,EAAC,eAAe,CAAC,CAAC;IAChF,MAAM,qBAAqB,GAAiB;QACxC,IAAI,EAAE,kCAAW,CAAC,IAAI;QACtB,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC;KAC9C,CAAC;IACF,eAAe,CAAC,IAAI,CAAC,UAAU,GAAG,qBAAqB,CAAC;IACxD,MAAM,yBAAyB,GAAiB;QAC5C,IAAI,EAAE,kCAAW,CAAC,IAAI;QACtB,IAAI,EAAE;YACF,WAAW,EAAE,eAAe;YAC5B,MAAM,EAAE,UAAU;SACrB;KACJ,CAAC;IACF,MAAM,YAAY,GAAG,wCAAwC,CAAC,yBAAyB,CAAC,CAAC;IACzF,MAAM,QAAQ,GAAwB;QAClC,OAAO,EAAE,MAAA,YAAY,CAAC,OAAO,mCAAI,EAAE;QACnC,OAAO,EAAE,KAAK;QACd,cAAc,EAAE,kBAAkB,CAAC,cAAc;QACjD,IAAI,EAAE,WAAW;KACpB,CAAC;IACF,OAAO,QAAQ,CAAC;AACpB,CAAC;AAED;;GAEG;AACH,SAAgB,wCAAwC,CAAC,OAAqB;;IAC1E,MAAM,YAAY,GAAqB;QACnC,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,EAAE;KACd,CAAC;IAEF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACpB,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAExC,IAAI,KAA2B,CAAC;QAChC,yGAAyG;QACzG,4GAA4G;QAC5G,6CAA6C;QAC7C,IAAI,YAA8B,CAAC;QAEnC,QAAQ,aAAa,CAAC,IAAI,EAAE;YACxB,KAAK,kCAAW,CAAC,IAAI,CAAC,CAAC;gBACnB,KAAK,GAAG,wCAAwC,CAAC,aAAa,CAAC,CAAC;gBAChE,YAAY,GAAG,aAAa,CAAC,YAAY,CAAC;gBAC1C,MAAM;aACT;YACD,KAAK,kCAAW,CAAC,IAAI,CAAC,CAAC;gBACnB,MAAM,OAAO,GAAG,OAAO,aAAa,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC;oBACvD,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,IAAA,iCAAkB,EAAC,aAAa,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAChF,MAAM,QAAQ,GAAG,OAAO,aAAa,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC;gBAEhF,KAAK,GAAG;oBACJ,IAAI,EAAE,MAAM;oBACZ,OAAO;oBACP,QAAQ;iBACX,CAAC;gBACF,MAAM;aACT;YACD,KAAK,kCAAW,CAAC,MAAM,CAAC,CAAC;gBACrB,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;aACtE;YACD,OAAO,CAAC,CAAC;gBACL,MAAM,IAAI,KAAK,CAAC,qBAAqB,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC;aAC9D;SACJ;QAED,MAAM,KAAK,GAAyB;YAChC,IAAI,EAAE,kBAAkB,CAAC,GAAG,CAAC;YAC7B,IAAI,EAAE,IAAA,0BAAU,EAAC,aAAa,CAAC;YAC/B,KAAK;YACL,YAAY;SACf,CAAC;QACF,MAAA,YAAY,CAAC,OAAO,0CAAE,IAAI,CAAC,KAAK,CAAC,CAAC;KACrC;IAED,OAAO,YAAY,CAAC;AACxB,CAAC;AApDD,4FAoDC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { v4 as uuid } from \"uuid\";\nimport { assert, Uint8ArrayToString } from \"@fluidframework/common-utils\";\nimport { getDocAttributesFromProtocolSummary, NonRetryableError } from \"@fluidframework/driver-utils\";\nimport { getGitType } from \"@fluidframework/protocol-base\";\nimport { SummaryType, ISummaryTree, ISummaryBlob } from \"@fluidframework/protocol-definitions\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { PerformanceEvent } from \"@fluidframework/telemetry-utils\";\nimport {\n    IFileEntry,\n    InstrumentedStorageTokenFetcher,\n    IOdspResolvedUrl,\n    OdspErrorType,\n    ShareLinkInfoType,\n    ISharingLinkKind,\n    ShareLinkTypes,\n} from \"@fluidframework/odsp-driver-definitions\";\nimport { DriverErrorType } from \"@fluidframework/driver-definitions\";\nimport {\n    IOdspSummaryTree,\n    OdspSummaryTreeValue,\n    OdspSummaryTreeEntry,\n    ICreateFileResponse,\n    IOdspSummaryPayload,\n} from \"./contracts\";\nimport { getUrlAndHeadersWithAuth } from \"./getUrlAndHeadersWithAuth\";\nimport {\n    buildOdspShareLinkReqParams,\n    createCacheSnapshotKey,\n    getWithRetryForTokenRefresh,\n    INewFileInfo,\n    getOrigin,\n    maxUmpPostBodySize,\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 } 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 getWithRetryForTokenRefresh(async (options) => {\n        const storageToken = await getStorageToken(options, \"CreateNewFile\");\n\n        return PerformanceEvent.timedExecAsync(\n            logger,\n            { eventName: \"createNewFile\" },\n            async (event) => {\n                const snapshotBody = JSON.stringify(containerSnapshot);\n                let url: string;\n                let headers: { [index: string]: string; };\n                let addInBody = false;\n                const formBoundary = uuid();\n                let postBody = `--${formBoundary}\\r\\n`;\n                postBody += `Authorization: Bearer ${storageToken}\\r\\n`;\n                postBody += `X-HTTP-Method-Override: POST\\r\\n`;\n                postBody += `Content-Type: application/json\\r\\n`;\n                postBody += `_post: 1\\r\\n`;\n                postBody += `\\r\\n${snapshotBody}\\r\\n`;\n                postBody += `\\r\\n--${formBoundary}--`;\n\n                if (postBody.length <= maxUmpPostBodySize) {\n                    const urlObj = new URL(initialUrl);\n                    urlObj.searchParams.set(\"ump\", \"1\");\n                    url = urlObj.href;\n                    headers = {\n                        \"Content-Type\": `multipart/form-data;boundary=${formBoundary}`,\n                    };\n                    addInBody = true;\n                } else {\n                    const parts = getUrlAndHeadersWithAuth(\n                        initialUrl, storageToken, forceAccessTokenViaAuthorizationHeader);\n                    url = parts.url;\n                    headers = {\n                        ...parts.headers,\n                        \"Content-Type\": \"application/json\",\n                    };\n                    postBody = snapshotBody;\n                }\n\n                const fetchResponse = await runWithRetry(\n                    async () => epochTracker.fetchAndParseAsJSON<ICreateFileResponse>(\n                        url,\n                        {\n                            body: postBody,\n                            headers,\n                            method: \"POST\",\n                        },\n                        \"createFile\",\n                        addInBody,\n                    ),\n                    \"createFile\",\n                    logger,\n                );\n\n                const content = fetchResponse.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                event.end({\n                    headers: Object.keys(headers).length !== 0 ? true : undefined,\n                    attempts: options.refresh ? 2 : 1,\n                    ...fetchResponse.propsToLog,\n                });\n                return content;\n            },\n        );\n    });\n}\n\nfunction convertSummaryIntoContainerSnapshot(createNewSummary: ISummaryTree) {\n    const appSummary = createNewSummary.tree[\".app\"] as ISummaryTree;\n    const protocolSummary = createNewSummary.tree[\".protocol\"] as ISummaryTree;\n    if (!(appSummary && protocolSummary)) {\n        throw new Error(\"App and protocol summary required for create new path!!\");\n    }\n    const documentAttributes = getDocAttributesFromProtocolSummary(protocolSummary);\n    const attributesSummaryBlob: ISummaryBlob = {\n        type: SummaryType.Blob,\n        content: JSON.stringify(documentAttributes),\n    };\n    protocolSummary.tree.attributes = attributesSummaryBlob;\n    const convertedCreateNewSummary: ISummaryTree = {\n        type: SummaryType.Tree,\n        tree: {\n            \".protocol\": protocolSummary,\n            \".app\": appSummary,\n        },\n    };\n    const snapshotTree = convertSummaryToSnapshotTreeForCreateNew(convertedCreateNewSummary);\n    const snapshot: IOdspSummaryPayload = {\n        entries: snapshotTree.entries ?? [],\n        message: \"app\",\n        sequenceNumber: documentAttributes.sequenceNumber,\n        type: \"container\",\n    };\n    return snapshot;\n}\n\n/**\n * Converts a summary tree to ODSP tree\n */\nexport function convertSummaryToSnapshotTreeForCreateNew(summary: ISummaryTree): IOdspSummaryTree {\n    const snapshotTree: IOdspSummaryTree = {\n        type: \"tree\",\n        entries: [],\n    };\n\n    const keys = Object.keys(summary.tree);\n    for (const key of keys) {\n        const summaryObject = summary.tree[key];\n\n        let value: OdspSummaryTreeValue;\n        // Tracks if an entry is unreferenced. Currently, only tree entries can be marked as unreferenced. If the\n        // property is not present, the tree entry is considered referenced. If the property is present and is true,\n        // the tree entry is considered unreferenced.\n        let unreferenced: true | undefined;\n\n        switch (summaryObject.type) {\n            case SummaryType.Tree: {\n                value = convertSummaryToSnapshotTreeForCreateNew(summaryObject);\n                unreferenced = summaryObject.unreferenced;\n                break;\n            }\n            case SummaryType.Blob: {\n                const content = typeof summaryObject.content === \"string\" ?\n                    summaryObject.content : Uint8ArrayToString(summaryObject.content, \"base64\");\n                const encoding = typeof summaryObject.content === \"string\" ? \"utf-8\" : \"base64\";\n\n                value = {\n                    type: \"blob\",\n                    content,\n                    encoding,\n                };\n                break;\n            }\n            case SummaryType.Handle: {\n                throw new Error(\"No handle should be present for first summary!!\");\n            }\n            default: {\n                throw new Error(`Unknown tree type ${summaryObject.type}`);\n            }\n        }\n\n        const entry: OdspSummaryTreeEntry = {\n            path: encodeURIComponent(key),\n            type: getGitType(summaryObject),\n            value,\n            unreferenced,\n        };\n        snapshotTree.entries?.push(entry);\n    }\n\n    return snapshotTree;\n}\n"]}

package/dist/createOdspCreateContainerRequest.d.ts

@@ -3,14 +3,15 @@
  * Licensed under the MIT License.
  */
 import { IRequest } from "@fluidframework/core-interfaces";
-import { ShareLinkTypes } from "@fluidframework/odsp-driver-definitions";
+import { ShareLinkTypes, ISharingLinkKind } from "@fluidframework/odsp-driver-definitions";
 /**
  * Create the request object with url and headers for creating a new file on OneDrive Sharepoint
  * @param siteUrl - Base url for OneDrive
  * @param driveId - drive identifier
  * @param filePath - path where file needs to be created
  * @param fileName - name of the new file to be created
- * @param createLinkType - type of sharing link you would like to create for this file
+ * @param createShareLinkType - type of sharing link you would like to create for this file. ShareLinkTypes
+ * will be deprecated soon, so for any new implementation please provide createShareLinkType of type ShareLink
  */
-export declare function createOdspCreateContainerRequest(siteUrl: string, driveId: string, filePath: string, fileName: string, createLinkType?: ShareLinkTypes): IRequest;
+export declare function createOdspCreateContainerRequest(siteUrl: string, driveId: string, filePath: string, fileName: string, createShareLinkType?: ShareLinkTypes | ISharingLinkKind): IRequest;
 //# sourceMappingURL=createOdspCreateContainerRequest.d.ts.map

package/dist/createOdspCreateContainerRequest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createOdspCreateContainerRequest.d.ts","sourceRoot":"","sources":["../src/createOdspCreateContainerRequest.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAE3D,OAAO,EAAE,cAAc,EAAE,MAAM,yCAAyC,CAAC;AAEzE;;;;;;;GAOG;AACH,wBAAgB,gCAAgC,CAC5C,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,cAAc,CAAC,EAAE,cAAc,GAChC,QAAQ,CAYV"}
+{"version":3,"file":"createOdspCreateContainerRequest.d.ts","sourceRoot":"","sources":["../src/createOdspCreateContainerRequest.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAE3D,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,yCAAyC,CAAC;AAG3F;;;;;;;;GAQG;AACH,wBAAgB,gCAAgC,CAC5C,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,mBAAmB,CAAC,EAAE,cAAc,GAAG,gBAAgB,GACxD,QAAQ,CAaV"}

package/dist/createOdspCreateContainerRequest.js

@@ -2,17 +2,20 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createOdspCreateContainerRequest = void 0;
 const driver_definitions_1 = require("@fluidframework/driver-definitions");
+const odspUtils_1 = require("./odspUtils");
 /**
  * Create the request object with url and headers for creating a new file on OneDrive Sharepoint
  * @param siteUrl - Base url for OneDrive
  * @param driveId - drive identifier
  * @param filePath - path where file needs to be created
  * @param fileName - name of the new file to be created
- * @param createLinkType - type of sharing link you would like to create for this file
+ * @param createShareLinkType - type of sharing link you would like to create for this file. ShareLinkTypes
+ * will be deprecated soon, so for any new implementation please provide createShareLinkType of type ShareLink
  */
-function createOdspCreateContainerRequest(siteUrl, driveId, filePath, fileName, createLinkType) {
+function createOdspCreateContainerRequest(siteUrl, driveId, filePath, fileName, createShareLinkType) {
+    const shareLinkRequestParams = (0, odspUtils_1.buildOdspShareLinkReqParams)(createShareLinkType);
     const createNewRequest = {
-        url: `${siteUrl}?driveId=${encodeURIComponent(driveId)}&path=${encodeURIComponent(filePath)}${createLinkType ? `&createLinkType=${createLinkType}` : ""}`,
+        url: `${siteUrl}?driveId=${encodeURIComponent(driveId)}&path=${encodeURIComponent(filePath)}${shareLinkRequestParams ? `&${shareLinkRequestParams}` : ""}`,
         headers: {
             [driver_definitions_1.DriverHeader.createNew]: {
                 fileName,

package/dist/createOdspCreateContainerRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"createOdspCreateContainerRequest.js","sourceRoot":"","sources":["../src/createOdspCreateContainerRequest.ts"],"names":[],"mappings":";;;AAKA,2EAAkE;AAGlE;;;;;;;GAOG;AACH,SAAgB,gCAAgC,CAC5C,OAAe,EACf,OAAe,EACf,QAAgB,EAChB,QAAgB,EAChB,cAA+B;IAE/B,MAAM,gBAAgB,GAAa;QAC/B,GAAG,EAAE,GAAG,OAAO,YAAY,kBAAkB,CACzC,OAAO,CACV,SAAS,kBAAkB,CAAC,QAAQ,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,mBAAmB,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE;QACpG,OAAO,EAAE;YACL,CAAC,iCAAY,CAAC,SAAS,CAAC,EAAE;gBACtB,QAAQ;aACX;SACJ;KACJ,CAAC;IACF,OAAO,gBAAgB,CAAC;AAC5B,CAAC;AAlBD,4EAkBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { IRequest } from \"@fluidframework/core-interfaces\";\nimport { DriverHeader } from \"@fluidframework/driver-definitions\";\nimport { ShareLinkTypes } from \"@fluidframework/odsp-driver-definitions\";\n\n/**\n * Create the request object with url and headers for creating a new file on OneDrive Sharepoint\n * @param siteUrl - Base url for OneDrive\n * @param driveId - drive identifier\n * @param filePath - path where file needs to be created\n * @param fileName - name of the new file to be created\n * @param createLinkType - type of sharing link you would like to create for this file\n */\nexport function createOdspCreateContainerRequest(\n    siteUrl: string,\n    driveId: string,\n    filePath: string,\n    fileName: string,\n    createLinkType?: ShareLinkTypes,\n): IRequest {\n    const createNewRequest: IRequest = {\n        url: `${siteUrl}?driveId=${encodeURIComponent(\n            driveId,\n        )}&path=${encodeURIComponent(filePath)}${createLinkType ? `&createLinkType=${createLinkType}` : \"\"}`,\n        headers: {\n            [DriverHeader.createNew]: {\n                fileName,\n            },\n        },\n    };\n    return createNewRequest;\n}\n"]}
+{"version":3,"file":"createOdspCreateContainerRequest.js","sourceRoot":"","sources":["../src/createOdspCreateContainerRequest.ts"],"names":[],"mappings":";;;AAKA,2EAAkE;AAElE,2CAA0D;AAE1D;;;;;;;;GAQG;AACH,SAAgB,gCAAgC,CAC5C,OAAe,EACf,OAAe,EACf,QAAgB,EAChB,QAAgB,EAChB,mBAAuD;IAEvD,MAAM,sBAAsB,GAAG,IAAA,uCAA2B,EAAC,mBAAmB,CAAC,CAAC;IAChF,MAAM,gBAAgB,GAAa;QAC/B,GAAG,EAAE,GAAG,OAAO,YAAY,kBAAkB,CACzC,OAAO,CACV,SAAS,kBAAkB,CAAC,QAAQ,CAAC,GAAG,sBAAsB,CAAC,CAAC,CAAC,IAAI,sBAAsB,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE;QACrG,OAAO,EAAE;YACL,CAAC,iCAAY,CAAC,SAAS,CAAC,EAAE;gBACtB,QAAQ;aACX;SACJ;KACJ,CAAC;IACF,OAAO,gBAAgB,CAAC;AAC5B,CAAC;AAnBD,4EAmBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { IRequest } from \"@fluidframework/core-interfaces\";\nimport { DriverHeader } from \"@fluidframework/driver-definitions\";\nimport { ShareLinkTypes, ISharingLinkKind } from \"@fluidframework/odsp-driver-definitions\";\nimport { buildOdspShareLinkReqParams } from \"./odspUtils\";\n\n/**\n * Create the request object with url and headers for creating a new file on OneDrive Sharepoint\n * @param siteUrl - Base url for OneDrive\n * @param driveId - drive identifier\n * @param filePath - path where file needs to be created\n * @param fileName - name of the new file to be created\n * @param createShareLinkType - type of sharing link you would like to create for this file. ShareLinkTypes\n * will be deprecated soon, so for any new implementation please provide createShareLinkType of type ShareLink\n */\nexport function createOdspCreateContainerRequest(\n    siteUrl: string,\n    driveId: string,\n    filePath: string,\n    fileName: string,\n    createShareLinkType?: ShareLinkTypes | ISharingLinkKind,\n): IRequest {\n    const shareLinkRequestParams = buildOdspShareLinkReqParams(createShareLinkType);\n    const createNewRequest: IRequest = {\n        url: `${siteUrl}?driveId=${encodeURIComponent(\n            driveId,\n        )}&path=${encodeURIComponent(filePath)}${shareLinkRequestParams ? `&${shareLinkRequestParams}` : \"\"}`,\n        headers: {\n            [DriverHeader.createNew]: {\n                fileName,\n            },\n        },\n    };\n    return createNewRequest;\n}\n"]}

package/dist/fetchSnapshot.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetchSnapshot.d.ts","sourceRoot":"","sources":["../src/fetchSnapshot.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAE9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAItE,OAAO,EACH,gBAAgB,EAChB,gBAAgB,EAEhB,+BAA+B,EAClC,MAAM,yCAAyC,CAAC;AAGjD,OAAO,EAAE,aAAa,EAAwB,wBAAwB,EAA8B,MAAM,aAAa,CAAC;AAGxH,OAAO,EAKH,aAAa,EAChB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAItD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAG9C;;GAEG;AACH,oBAAY,yBAAyB;IACjC,IAAI,IAAI;IACR,MAAM,IAAI;IACV,aAAa,IAAI;CACpB;AAED;;;;;;;;;GASG;AACH,wBAAsB,aAAa,CAC/B,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,MAAM,GAAG,IAAI,EACpB,SAAS,EAAE,MAAM,EACjB,iBAAiB,EAAE,OAAO,EAC1B,sCAAsC,EAAE,OAAO,EAC/C,MAAM,EAAE,gBAAgB,EACxB,kBAAkB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE;IAAE,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;CAAE,KAAK,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,GAC9G,OAAO,CAAC,iBAAiB,CAAC,CAwB5B;AAED,wBAAsB,uBAAuB,CACzC,eAAe,EAAE,gBAAgB,EACjC,mBAAmB,EAAE,+BAA+B,EACpD,eAAe,EAAE,gBAAgB,GAAG,SAAS,EAC7C,sCAAsC,EAAE,OAAO,EAC/C,MAAM,EAAE,gBAAgB,EACxB,kBAAkB,EAAE,CAChB,oBAAoB,EAAE,gBAAgB,EACtC,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,gBAAgB,GAAG,SAAS,EAC7C,UAAU,CAAC,EAAE,eAAe,KAC3B,OAAO,CAAC,kCAAkC,CAAC,EAChD,UAAU,EAAE,CAAC,cAAc,EAAE,wBAAwB,KAAK,OAAO,CAAC,IAAI,CAAC,EACvE,aAAa,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,EAClC,oBAAoB,CAAC,EAAE,OAAO,GAC/B,OAAO,CAAC,iBAAiB,CAAC,CAsD5B;AAwRD,MAAM,WAAW,kCAAkC;IAC/C,YAAY,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;IACtC,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,CAAC;CAC7C;AAiDD,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,aAAa,QAK5D;AAWD;;;;;;;;;;GAUG;AACH,wBAAsB,gBAAgB,CAClC,eAAe,EAAE,gBAAgB,EACjC,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,gBAAgB,EACxB,eAAe,EAAE,gBAAgB,GAAG,SAAS,EAC7C,uBAAuB,CAAC,EAAE,yBAAyB,EACnD,UAAU,CAAC,EAAE,eAAe,EAC5B,YAAY,CAAC,EAAE,YAAY,EAC3B,YAAY,CAAC,EAAE,MAAM,GACtB,OAAO,CAAC,kCAAkC,CAAC,CA0C7C"}
+{"version":3,"file":"fetchSnapshot.d.ts","sourceRoot":"","sources":["../src/fetchSnapshot.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAE9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAItE,OAAO,EACH,gBAAgB,EAChB,gBAAgB,EAEhB,+BAA+B,EAClC,MAAM,yCAAyC,CAAC;AAGjD,OAAO,EAAE,aAAa,EAAwB,wBAAwB,EAA8B,MAAM,aAAa,CAAC;AAGxH,OAAO,EAKH,aAAa,EAChB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAItD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAG9C;;GAEG;AACH,oBAAY,yBAAyB;IACjC,IAAI,IAAI;IACR,MAAM,IAAI;IACV,aAAa,IAAI;CACpB;AAED;;;;;;;;;GASG;AACH,wBAAsB,aAAa,CAC/B,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,MAAM,GAAG,IAAI,EACpB,SAAS,EAAE,MAAM,EACjB,iBAAiB,EAAE,OAAO,EAC1B,sCAAsC,EAAE,OAAO,EAC/C,MAAM,EAAE,gBAAgB,EACxB,kBAAkB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE;IAAE,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;CAAE,KAAK,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,GAC9G,OAAO,CAAC,iBAAiB,CAAC,CAwB5B;AAED,wBAAsB,uBAAuB,CACzC,eAAe,EAAE,gBAAgB,EACjC,mBAAmB,EAAE,+BAA+B,EACpD,eAAe,EAAE,gBAAgB,GAAG,SAAS,EAC7C,sCAAsC,EAAE,OAAO,EAC/C,MAAM,EAAE,gBAAgB,EACxB,kBAAkB,EAAE,CAChB,oBAAoB,EAAE,gBAAgB,EACtC,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,gBAAgB,GAAG,SAAS,EAC7C,UAAU,CAAC,EAAE,eAAe,KAC3B,OAAO,CAAC,kCAAkC,CAAC,EAChD,UAAU,EAAE,CAAC,cAAc,EAAE,wBAAwB,KAAK,OAAO,CAAC,IAAI,CAAC,EACvE,aAAa,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,EAClC,oBAAoB,CAAC,EAAE,OAAO,GAC/B,OAAO,CAAC,iBAAiB,CAAC,CAsD5B;AA8RD,MAAM,WAAW,kCAAkC;IAC/C,YAAY,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;IACtC,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,CAAC;CAC7C;AAiDD,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,aAAa,QAK5D;AAWD;;;;;;;;;;GAUG;AACH,wBAAsB,gBAAgB,CAClC,eAAe,EAAE,gBAAgB,EACjC,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,gBAAgB,EACxB,eAAe,EAAE,gBAAgB,GAAG,SAAS,EAC7C,uBAAuB,CAAC,EAAE,yBAAyB,EACnD,UAAU,CAAC,EAAE,eAAe,EAC5B,YAAY,CAAC,EAAE,YAAY,EAC3B,YAAY,CAAC,EAAE,MAAM,GACtB,OAAO,CAAC,kCAAkC,CAAC,CAwC7C"}

package/dist/fetchSnapshot.js

@@ -142,8 +142,15 @@ async function fetchLatestSnapshotCore(odspResolvedUrl, storageTokenFetcher, sna
             // Measure how much time we spend processing payload
             const snapshotParseEvent = telemetry_utils_1.PerformanceEvent.start(logger, Object.assign({ eventName: "SnapshotParse" }, propsToLog));
             let parsedSnapshotContents;
+            let contentTypeToRead;
+            if ((contentType === null || contentType === void 0 ? void 0 : contentType.indexOf("application/ms-fluid")) !== -1) {
+                contentTypeToRead = "application/ms-fluid";
+            }
+            else if ((contentType === null || contentType === void 0 ? void 0 : contentType.indexOf("application/json")) !== -1) {
+                contentTypeToRead = "application/json";
+            }
             try {
-                switch (contentType) {
+                switch (contentTypeToRead) {
                     case "application/json": {
                         const text = await odspResponse.content.text();
                         propsToLog.bodySize = text.length;
@@ -378,14 +385,12 @@ async function downloadSnapshot(odspResolvedUrl, storageToken, logger, snapshotO
     };
     // Decide what snapshot format to fetch as per the feature gate.
     switch (snapshotFormatFetchType) {
-        case SnapshotFormatSupportType.JsonAndBinary:
-            headers.accept = `application/json, application/ms-fluid; v=${compactSnapshotParser_1.currentReadVersion}`;
-            break;
         case SnapshotFormatSupportType.Binary:
             headers.accept = `application/ms-fluid; v=${compactSnapshotParser_1.currentReadVersion}`;
             break;
         default:
-            headers.accept = "application/json";
+            // By default ask both versions and let the server decide the format.
+            headers.accept = `application/json, application/ms-fluid; v=${compactSnapshotParser_1.currentReadVersion}`;
     }
     const odspResponse = await ((_a = epochTracker === null || epochTracker === void 0 ? void 0 : epochTracker.fetch(url, fetchOptions, "treesLatest", true, scenarioName)) !== null && _a !== void 0 ? _a : (0, odspUtils_1.fetchHelper)(url, fetchOptions));
     return {