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

package/dist/factory.d.ts

@@ -94,11 +94,24 @@ export interface HostStoragePolicy {
      */
     isolateSocketCache?: boolean;
     /**
-     * Enable creation of sharing link along with the creation of file by setting this value to true.
+     * @deprecated Switch to using the new feature gated by enableSingleRequestForShareLinkWithCreate
+     * with 'createLinkScope' and 'createLinkRole' is requested to the odsp apis instead of 'createLinkType'.
+     * It enables the creation of sharing link along with the creation of file by setting this value to true.
      * If the host provides a 'createLinkType' parameter in the request URL to the container.attach()
-     * method, we will request for send the request to ODSP with the same (if the flag is enabled) so
-     * that a sharing can be created with the creation of file to save number for round trips made to ODSP.
+     * method, we will send the request to ODSP with the same (if the flag is enabled) so
+     * that a share link can be created with the creation of file to save number for round trips made to ODSP.
+     * (This flag works independently of enableSingleRequestForShareLinkWithCreate which is used for sharing link
+     * requests where 'createLinkScope' is requested.)
      */
     enableShareLinkWithCreate?: boolean;
+    /**
+     * Enable creation of sharing link along with the creation of file by setting this value to true.
+     * If the host provides a 'createLinkScope' parameter in the request URL to the container.attach()
+     * method, we will send the request to ODSP with the same (if the flag is enabled) so
+     * that a share link can be created with the creation of file to save number for round trips made to ODSP.
+     * (This flag works independently of enableShareLinkWithCreate which was used for old sharing link requests
+     * where 'createLinkType' was requested.)
+     */
+    enableSingleRequestForShareLinkWithCreate?: boolean;
 }
 //# sourceMappingURL=factory.d.ts.map

package/dist/factory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../src/factory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,WAAW,gBAAgB;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAMlB,GAAG,CAAC,EAAE,MAAM,CAAC;IAOb,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAC9B;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAqB;IAClC;;;OAGG;IACH,8BAA8B,CAAC,EAAE,MAAM,CAAC;IACxC;;;;;;;;;OASG;IACH,sCAAsC,CAAC,EAAE,OAAO,CAAC;CACpD;AAED,MAAM,WAAW,iBAAiB;IAC9B,eAAe,CAAC,EAAE,gBAAgB,CAAC;IAEnC;;;;;;;;OAQG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAGlC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,qBAAqB,CAAC;IAEvC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;OAGG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;;;OAKG;IACF,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACxC"}
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../src/factory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,WAAW,gBAAgB;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAMlB,GAAG,CAAC,EAAE,MAAM,CAAC;IAOb,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAC9B;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAqB;IAClC;;;OAGG;IACH,8BAA8B,CAAC,EAAE,MAAM,CAAC;IACxC;;;;;;;;;OASG;IACH,sCAAsC,CAAC,EAAE,OAAO,CAAC;CACpD;AAED,MAAM,WAAW,iBAAiB;IAC9B,eAAe,CAAC,EAAE,gBAAgB,CAAC;IAEnC;;;;;;;;OAQG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAGlC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,qBAAqB,CAAC;IAEvC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;OAGG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;;;;;;;OASG;IACF,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAErC;;;;;;;OAOG;IACH,yCAAyC,CAAC,EAAE,OAAO,CAAC;CACvD"}

package/dist/factory.js.map

@@ -1 +1 @@
-{"version":3,"file":"factory.js","sourceRoot":"","sources":["../src/factory.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport interface ISnapshotOptions {\n    blobs?: number;\n    deltas?: number;\n    channels?: number;\n    /*\n     * Maximum Data size (in bytes)\n     * If specified, SPO will fail snapshot request with 413 error (see OdspErrorType.snapshotTooBig)\n     * if snapshot is bigger in size than specified limit.\n     */\n    mds?: number;\n\n    /*\n     * Maximum time limit to fetch snapshot (in seconds)\n     * If specified, client will timeout the fetch request if it exceeds the time limit and\n     * will try to fetch the snapshot without blobs.\n     */\n    timeout?: number;\n}\n\nexport interface IOpsCachingPolicy {\n    /**\n     * Batch size. Controls how many ops are grouped together as single cache entry\n     * The bigger the number, the more efficient it is (less reads & writes)\n     * At the same time, big number means we wait for so many ops to accumulate, which\n     * increases chances and number of trailing ops that would not be flushed to cache\n     * when user closes tab\n     * Use any number below 1 to disable caching\n     * Default: 100\n     */\n    batchSize?: number;\n\n    /**\n     * To reduce the problem of losing trailing ops when using big batch sizes, host\n     * could specify how often driver should flush ops it has not flushed yet.\n     * -1 means do not use timer.\n     * Measured in ms.\n     * Default: 5000\n     */\n    timerGranularity?: number;\n\n    /**\n     * Total number of ops to cache. When we reach that number, ops caching stops\n     * Default: 5000\n     */\n    totalOpsToCache?: number;\n}\n\nexport interface ICollabSessionOptions {\n    /**\n     * Value indicating the display name for session that admits unauthenticated user.\n     * This name will be used in attribution associated with edits made by such user.\n     */\n    unauthenticatedUserDisplayName?: string;\n    /**\n     * @deprecated - Due to security reasons we will be passing the token via Authorization header only.\n     * Value indicating session preference to always pass access token via Authorization header.\n     * Default behavior is to pass access token via query parameter unless overall href string\n     * length exceeds 2048 characters. Using query param is performance optimization which results\n     * in ODSP XHR request being treated as 'simple' request which do not require OPTIONS call to\n     * validate CORS. However, not all ODSP implementations understand this optimization.\n     * For instance, auth layer on Converged stack will fail request with access token passed via\n     * query param.\n     */\n    forceAccessTokenViaAuthorizationHeader?: boolean;\n}\n\nexport interface HostStoragePolicy {\n    snapshotOptions?: ISnapshotOptions;\n\n    /**\n     * If set to true, tells driver to concurrently fetch snapshot from storage (SPO) and cache\n     * Container loads from whatever comes first in such case.\n     * Snapshot fetched from storage is pushed to cache in either case.\n     * If set to false, driver will first consult with cache. Only on cache miss (cache does not\n     * return snapshot), driver will fetch snapshot from storage (and push it to cache), otherwise\n     * it will load from cache and not reach out to storage.\n     * Passing true results in faster loads and keeping cache more current, but it increases bandwidth consumption.\n     */\n    concurrentSnapshotFetch?: boolean;\n\n    // Options overwriting default ops fetching from storage.\n    opsBatchSize?: number;\n    concurrentOpsBatches?: number;\n\n    /**\n     * Policy controlling ops caching (leveraging IPersistedCache passed to driver factory)\n     */\n    opsCaching?: IOpsCachingPolicy;\n\n    /**\n     * Policy controlling how collaboration session is established\n     */\n    sessionOptions?: ICollabSessionOptions;\n\n    /**\n     * @deprecated - This field will be always set to true after removal.\n     * True to have the sharing link redeem fallback in case the Trees Latest/Redeem 1RT call fails with redeem error.\n     * During fallback it will first redeem the sharing link and then make the Trees latest call.\n     */\n    enableRedeemFallback?: boolean;\n\n    /**\n     * Policy controlling if we will cache initial summary when we create a document\n     */\n    cacheCreateNewSummary?: boolean;\n\n    /**\n     * @deprecated - This will be replaced with feature gate snapshotFormatFetchType.\n     * Policy controlling if we want to fetch binary format snapshot.\n     */\n    fetchBinarySnapshotFormat?: boolean;\n\n    /**\n     * If set to true, socket cache are per OdspDocumentService instead of shared across all instances\n     */\n    isolateSocketCache?: boolean;\n\n    /**\n     * Enable creation of sharing link along with the creation of file by setting this value to true.\n     * If the host provides a 'createLinkType' parameter in the request URL to the container.attach()\n     * method, we will request for send the request to ODSP with the same (if the flag is enabled) so\n     * that a sharing can be created with the creation of file to save number for round trips made to ODSP.\n     */\n     enableShareLinkWithCreate?: boolean;\n}\n"]}
+{"version":3,"file":"factory.js","sourceRoot":"","sources":["../src/factory.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport interface ISnapshotOptions {\n    blobs?: number;\n    deltas?: number;\n    channels?: number;\n    /*\n     * Maximum Data size (in bytes)\n     * If specified, SPO will fail snapshot request with 413 error (see OdspErrorType.snapshotTooBig)\n     * if snapshot is bigger in size than specified limit.\n     */\n    mds?: number;\n\n    /*\n     * Maximum time limit to fetch snapshot (in seconds)\n     * If specified, client will timeout the fetch request if it exceeds the time limit and\n     * will try to fetch the snapshot without blobs.\n     */\n    timeout?: number;\n}\n\nexport interface IOpsCachingPolicy {\n    /**\n     * Batch size. Controls how many ops are grouped together as single cache entry\n     * The bigger the number, the more efficient it is (less reads & writes)\n     * At the same time, big number means we wait for so many ops to accumulate, which\n     * increases chances and number of trailing ops that would not be flushed to cache\n     * when user closes tab\n     * Use any number below 1 to disable caching\n     * Default: 100\n     */\n    batchSize?: number;\n\n    /**\n     * To reduce the problem of losing trailing ops when using big batch sizes, host\n     * could specify how often driver should flush ops it has not flushed yet.\n     * -1 means do not use timer.\n     * Measured in ms.\n     * Default: 5000\n     */\n    timerGranularity?: number;\n\n    /**\n     * Total number of ops to cache. When we reach that number, ops caching stops\n     * Default: 5000\n     */\n    totalOpsToCache?: number;\n}\n\nexport interface ICollabSessionOptions {\n    /**\n     * Value indicating the display name for session that admits unauthenticated user.\n     * This name will be used in attribution associated with edits made by such user.\n     */\n    unauthenticatedUserDisplayName?: string;\n    /**\n     * @deprecated - Due to security reasons we will be passing the token via Authorization header only.\n     * Value indicating session preference to always pass access token via Authorization header.\n     * Default behavior is to pass access token via query parameter unless overall href string\n     * length exceeds 2048 characters. Using query param is performance optimization which results\n     * in ODSP XHR request being treated as 'simple' request which do not require OPTIONS call to\n     * validate CORS. However, not all ODSP implementations understand this optimization.\n     * For instance, auth layer on Converged stack will fail request with access token passed via\n     * query param.\n     */\n    forceAccessTokenViaAuthorizationHeader?: boolean;\n}\n\nexport interface HostStoragePolicy {\n    snapshotOptions?: ISnapshotOptions;\n\n    /**\n     * If set to true, tells driver to concurrently fetch snapshot from storage (SPO) and cache\n     * Container loads from whatever comes first in such case.\n     * Snapshot fetched from storage is pushed to cache in either case.\n     * If set to false, driver will first consult with cache. Only on cache miss (cache does not\n     * return snapshot), driver will fetch snapshot from storage (and push it to cache), otherwise\n     * it will load from cache and not reach out to storage.\n     * Passing true results in faster loads and keeping cache more current, but it increases bandwidth consumption.\n     */\n    concurrentSnapshotFetch?: boolean;\n\n    // Options overwriting default ops fetching from storage.\n    opsBatchSize?: number;\n    concurrentOpsBatches?: number;\n\n    /**\n     * Policy controlling ops caching (leveraging IPersistedCache passed to driver factory)\n     */\n    opsCaching?: IOpsCachingPolicy;\n\n    /**\n     * Policy controlling how collaboration session is established\n     */\n    sessionOptions?: ICollabSessionOptions;\n\n    /**\n     * @deprecated - This field will be always set to true after removal.\n     * True to have the sharing link redeem fallback in case the Trees Latest/Redeem 1RT call fails with redeem error.\n     * During fallback it will first redeem the sharing link and then make the Trees latest call.\n     */\n    enableRedeemFallback?: boolean;\n\n    /**\n     * Policy controlling if we will cache initial summary when we create a document\n     */\n    cacheCreateNewSummary?: boolean;\n\n    /**\n     * @deprecated - This will be replaced with feature gate snapshotFormatFetchType.\n     * Policy controlling if we want to fetch binary format snapshot.\n     */\n    fetchBinarySnapshotFormat?: boolean;\n\n    /**\n     * If set to true, socket cache are per OdspDocumentService instead of shared across all instances\n     */\n    isolateSocketCache?: boolean;\n\n    /**\n     * @deprecated Switch to using the new feature gated by enableSingleRequestForShareLinkWithCreate\n     * with 'createLinkScope' and 'createLinkRole' is requested to the odsp apis instead of 'createLinkType'.\n     * It enables the creation of sharing link along with the creation of file by setting this value to true.\n     * If the host provides a 'createLinkType' parameter in the request URL to the container.attach()\n     * method, we will send the request to ODSP with the same (if the flag is enabled) so\n     * that a share link can be created with the creation of file to save number for round trips made to ODSP.\n     * (This flag works independently of enableSingleRequestForShareLinkWithCreate which is used for sharing link\n     * requests where 'createLinkScope' is requested.)\n     */\n     enableShareLinkWithCreate?: boolean;\n\n    /**\n     * Enable creation of sharing link along with the creation of file by setting this value to true.\n     * If the host provides a 'createLinkScope' parameter in the request URL to the container.attach()\n     * method, we will send the request to ODSP with the same (if the flag is enabled) so\n     * that a share link can be created with the creation of file to save number for round trips made to ODSP.\n     * (This flag works independently of enableShareLinkWithCreate which was used for old sharing link requests\n     * where 'createLinkType' was requested.)\n     */\n    enableSingleRequestForShareLinkWithCreate?: boolean;\n}\n"]}

package/dist/packageVersion.d.ts

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

package/dist/packageVersion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,4CAA4C,CAAC;AACjE,eAAO,MAAM,UAAU,+BAA+B,CAAC"}
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,4CAA4C,CAAC;AACjE,eAAO,MAAM,UAAU,yBAAyB,CAAC"}

package/dist/packageVersion.js

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

package/dist/packageVersion.js.map

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

package/dist/resolvedUrl.d.ts

@@ -9,14 +9,42 @@ export interface IOdspUrlParts {
     itemId: string;
 }
 /**
+ * @deprecated Use ISharingLinkKind type instead.
  * Type of shareLink requested/created when creating the file for the first time.
- * At the time of adding this comment (Sept/2021) ODSP only supports creation of CSL links
- * when provided as a request parameter with the /snapshot api call.
- * In future, we can add more types here.
 */
 export declare enum ShareLinkTypes {
     csl = "csl"
 }
+/**
+ * Sharing scope of the share links created for a file.
+*/
+export declare enum SharingLinkScope {
+    organization = "organization",
+    users = "users",
+    anonymous = "anonymous",
+    default = "default"
+}
+/**
+ * View/edit permission role for a sharing link.
+ */
+export declare enum SharingLinkRole {
+    view = "view",
+    edit = "edit"
+}
+/**
+ * Defines the permissions scope for a share link requested to be created during the creation the file in ODSP.
+ * Providing these properties to the /snapshot api will also create and return the requested kind of sharing link.
+*/
+export interface ISharingLinkKind {
+    scope: SharingLinkScope;
+    role?: SharingLinkRole;
+}
+/**
+ * Sharing link data received from the /snapshot api response.
+ */
+export interface ISharingLink extends ISharingLinkKind {
+    webUrl: string;
+}
 /**
  * Sharing link data created for the ODSP item.
  * Contains information about either sharing link created while creating a new file or
@@ -24,27 +52,29 @@ export declare enum ShareLinkTypes {
  */
 export interface ShareLinkInfoType {
     /**
-     * We create a new file in ODSP with the /snapshot api call. Applications then call separate apis to
-     * create a sharing link for that file. To reduce the number of api calls, ODSP now provides a feature
+     * We create a new file in ODSP with the /snapshot api call. Applications then need to make a separate apis call to
+     * create a sharing link for that file. To reduce the number of network calls, ODSP now provides a feature
      * where we can create a share link along with creating a file by passing a query parameter called
-     * createShareLink. createLink object below saves the data corresponding to this feature.
+     * createShareLink (deprecated) or createLinkScope and createLinkRole. createLink object below saves the information
+     * from the /snapshot api response.
      */
     createLink?: {
         /**
-         * Type of shareLink requested/created when creating the file for the first time.
-         * At the time of adding this comment (Sept/2021) ODSP only supports creation of CSL links
-         * when provided as a request parameter with the /snapshot api call.
+         * @deprecated
+         * Type of shareLink requested/created when creating the file for the first time. The 'type' property here
+         * represents the type of sharing link requested.
+         * Will be deprecated soon. Type of sharing link will be present in the link:ISharingLink property below.
         */
-        type?: ShareLinkTypes;
+        type?: ShareLinkTypes | ISharingLinkKind;
         /**
          * Share link created when the file is created for the first time with /snapshot api call.
-         * This link does not require redemption.
          */
-        link?: string;
+        link?: string | ISharingLink;
         /**
          * Error message if creation of sharing link fails with /snapshot api call
          */
         error?: any;
+        shareId?: string;
     };
     /**
      * This is used to save the network calls while doing trees/latest call as if the client does not have

package/dist/resolvedUrl.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resolvedUrl.d.ts","sourceRoot":"","sources":["../src/resolvedUrl.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AAEvE,MAAM,WAAW,aAAa;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAClB;AAED;;;;;EAKE;AACF,oBAAY,cAAc;IACtB,GAAG,QAAQ;CACd;AACD;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAE9B;;;;;OAKG;IACH,UAAU,CAAC,EAAE;QACT;;;;UAIE;QACF,IAAI,CAAC,EAAE,cAAc,CAAC;QAEtB;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,CAAC,EAAE,GAAG,CAAC;KACf,CAAC;IAEF;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAChC;AACD,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB,EAAE,aAAa;IACtE,IAAI,EAAE,OAAO,CAAC;IACd,eAAe,EAAE,IAAI,CAAC;IAGtB,GAAG,EAAE,MAAM,CAAC;IAGZ,gBAAgB,EAAE,MAAM,CAAC;IAEzB,SAAS,EAAE;QACP,kBAAkB,EAAE,MAAM,CAAC;QAC3B,wBAAwB,EAAE,MAAM,CAAC;QACjC,uBAAuB,EAAE,MAAM,CAAC;QAChC,eAAe,EAAE,MAAM,CAAC;KAC3B,CAAC;IAIF,MAAM,EAAE,EAAE,CAAC;IAEX,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,OAAO,CAAC;IAEpB,QAAQ,CAAC,EAAE;QAGP,oBAAoB,CAAC,EAAE,MAAM,CAAC;KACjC,CAAC;IAEF,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;OAIG;IACH,aAAa,CAAC,EAAE,iBAAiB,CAAC;IAElC,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC/B"}
+{"version":3,"file":"resolvedUrl.d.ts","sourceRoot":"","sources":["../src/resolvedUrl.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AAEvE,MAAM,WAAW,aAAa;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAClB;AAED;;;EAGE;AACF,oBAAY,cAAc;IACtB,GAAG,QAAQ;CACd;AAED;;EAEE;AACF,oBAAY,gBAAgB;IACxB,YAAY,iBAAiB;IAC7B,KAAK,UAAU;IACf,SAAS,cAAc;IACvB,OAAO,YAAY;CACtB;AAED;;GAEG;AACH,oBAAY,eAAe;IACvB,IAAI,SAAS;IACb,IAAI,SAAS;CAChB;AAED;;;EAGE;AACF,MAAM,WAAW,gBAAgB;IAC7B,KAAK,EAAE,gBAAgB,CAAC;IAKxB,IAAI,CAAC,EAAE,eAAe,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,gBAAgB;IAClD,MAAM,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAE9B;;;;;;OAMG;IACH,UAAU,CAAC,EAAE;QACT;;;;;UAKE;QACF,IAAI,CAAC,EAAE,cAAc,GAAG,gBAAgB,CAAC;QAEzC;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,YAAY,CAAC;QAE7B;;WAEG;QACH,KAAK,CAAC,EAAE,GAAG,CAAC;QAEZ,OAAO,CAAC,EAAE,MAAM,CAAC;KAEpB,CAAC;IAEF;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAChC;AACD,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB,EAAE,aAAa;IACtE,IAAI,EAAE,OAAO,CAAC;IACd,eAAe,EAAE,IAAI,CAAC;IAGtB,GAAG,EAAE,MAAM,CAAC;IAGZ,gBAAgB,EAAE,MAAM,CAAC;IAEzB,SAAS,EAAE;QACP,kBAAkB,EAAE,MAAM,CAAC;QAC3B,wBAAwB,EAAE,MAAM,CAAC;QACjC,uBAAuB,EAAE,MAAM,CAAC;QAChC,eAAe,EAAE,MAAM,CAAC;KAC3B,CAAC;IAIF,MAAM,EAAE,EAAE,CAAC;IAEX,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,OAAO,CAAC;IAEpB,QAAQ,CAAC,EAAE;QAGP,oBAAoB,CAAC,EAAE,MAAM,CAAC;KACjC,CAAC;IAEF,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;OAIG;IACH,aAAa,CAAC,EAAE,iBAAiB,CAAC;IAElC,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC/B"}

package/dist/resolvedUrl.js

@@ -4,15 +4,31 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ShareLinkTypes = void 0;
+exports.SharingLinkRole = exports.SharingLinkScope = exports.ShareLinkTypes = void 0;
 /**
+ * @deprecated Use ISharingLinkKind type instead.
  * Type of shareLink requested/created when creating the file for the first time.
- * At the time of adding this comment (Sept/2021) ODSP only supports creation of CSL links
- * when provided as a request parameter with the /snapshot api call.
- * In future, we can add more types here.
 */
 var ShareLinkTypes;
 (function (ShareLinkTypes) {
     ShareLinkTypes["csl"] = "csl";
 })(ShareLinkTypes = exports.ShareLinkTypes || (exports.ShareLinkTypes = {}));
+/**
+ * Sharing scope of the share links created for a file.
+*/
+var SharingLinkScope;
+(function (SharingLinkScope) {
+    SharingLinkScope["organization"] = "organization";
+    SharingLinkScope["users"] = "users";
+    SharingLinkScope["anonymous"] = "anonymous";
+    SharingLinkScope["default"] = "default";
+})(SharingLinkScope = exports.SharingLinkScope || (exports.SharingLinkScope = {}));
+/**
+ * View/edit permission role for a sharing link.
+ */
+var SharingLinkRole;
+(function (SharingLinkRole) {
+    SharingLinkRole["view"] = "view";
+    SharingLinkRole["edit"] = "edit";
+})(SharingLinkRole = exports.SharingLinkRole || (exports.SharingLinkRole = {}));
 //# sourceMappingURL=resolvedUrl.js.map

package/dist/resolvedUrl.js.map

@@ -1 +1 @@
-{"version":3,"file":"resolvedUrl.js","sourceRoot":"","sources":["../src/resolvedUrl.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAUH;;;;;EAKE;AACF,IAAY,cAEX;AAFD,WAAY,cAAc;IACtB,6BAAW,CAAA;AACf,CAAC,EAFW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAEzB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidResolvedUrl } from \"@fluidframework/driver-definitions\";\n\nexport interface IOdspUrlParts {\n    siteUrl: string;\n    driveId: string;\n    itemId: string;\n}\n\n/**\n * Type of shareLink requested/created when creating the file for the first time.\n * At the time of adding this comment (Sept/2021) ODSP only supports creation of CSL links\n * when provided as a request parameter with the /snapshot api call.\n * In future, we can add more types here.\n*/\nexport enum ShareLinkTypes {\n    csl = \"csl\",\n}\n/**\n * Sharing link data created for the ODSP item.\n * Contains information about either sharing link created while creating a new file or\n * a redeemable share link created when loading an existing file\n */\nexport interface ShareLinkInfoType {\n\n    /**\n     * We create a new file in ODSP with the /snapshot api call. Applications then call separate apis to\n     * create a sharing link for that file. To reduce the number of api calls, ODSP now provides a feature\n     * where we can create a share link along with creating a file by passing a query parameter called\n     * createShareLink. createLink object below saves the data corresponding to this feature.\n     */\n    createLink?: {\n        /**\n         * Type of shareLink requested/created when creating the file for the first time.\n         * At the time of adding this comment (Sept/2021) ODSP only supports creation of CSL links\n         * when provided as a request parameter with the /snapshot api call.\n        */\n        type?: ShareLinkTypes;\n\n        /**\n         * Share link created when the file is created for the first time with /snapshot api call.\n         * This link does not require redemption.\n         */\n        link?: string;\n\n        /**\n         * Error message if creation of sharing link fails with /snapshot api call\n         */\n        error?: any;\n    };\n\n    /**\n     * This is used to save the network calls while doing trees/latest call as if the client does not have\n     * permission then this link can be redeemed for the permissions in the same network call.\n     */\n    sharingLinkToRedeem?: string;\n}\nexport interface IOdspResolvedUrl extends IFluidResolvedUrl, IOdspUrlParts {\n    type: \"fluid\";\n    odspResolvedUrl: true;\n\n    // URL to send to fluid, contains the documentId and the path\n    url: string;\n\n    // A hashed identifier that is unique to this document\n    hashedDocumentId: string;\n\n    endpoints: {\n        snapshotStorageUrl: string;\n        attachmentPOSTStorageUrl: string;\n        attachmentGETStorageUrl: string;\n        deltaStorageUrl: string;\n    };\n\n    // Tokens are not obtained by the ODSP driver using the resolve flow, the app must provide them.\n    // eslint-disable-next-line @typescript-eslint/ban-types\n    tokens: {};\n\n    fileName: string;\n\n    summarizer: boolean;\n\n    codeHint?: {\n        // containerPackageName is used for adding the package name to the request headers.\n        // This may be used for preloading the container package when loading Fluid content.\n        containerPackageName?: string;\n    };\n\n    fileVersion: string | undefined;\n\n    /**\n     * Sharing link data created for the ODSP item.\n     * Contains information about either sharing link created while creating a new file or\n     * a redeemable share link created when loading an existing file\n     */\n    shareLinkInfo?: ShareLinkInfoType;\n\n    isClpCompliantApp?: boolean;\n}\n"]}
+{"version":3,"file":"resolvedUrl.js","sourceRoot":"","sources":["../src/resolvedUrl.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAUH;;;EAGE;AACF,IAAY,cAEX;AAFD,WAAY,cAAc;IACtB,6BAAW,CAAA;AACf,CAAC,EAFW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAEzB;AAED;;EAEE;AACF,IAAY,gBAKX;AALD,WAAY,gBAAgB;IACxB,iDAA6B,CAAA;IAC7B,mCAAe,CAAA;IACf,2CAAuB,CAAA;IACvB,uCAAmB,CAAA;AACvB,CAAC,EALW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAK3B;AAED;;GAEG;AACH,IAAY,eAGX;AAHD,WAAY,eAAe;IACvB,gCAAa,CAAA;IACb,gCAAa,CAAA;AACjB,CAAC,EAHW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAG1B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidResolvedUrl } from \"@fluidframework/driver-definitions\";\n\nexport interface IOdspUrlParts {\n    siteUrl: string;\n    driveId: string;\n    itemId: string;\n}\n\n/**\n * @deprecated Use ISharingLinkKind type instead.\n * Type of shareLink requested/created when creating the file for the first time.\n*/\nexport enum ShareLinkTypes {\n    csl = \"csl\",\n}\n\n/**\n * Sharing scope of the share links created for a file.\n*/\nexport enum SharingLinkScope {\n    organization = \"organization\",\n    users = \"users\",\n    anonymous = \"anonymous\",\n    default = \"default\",\n}\n\n/**\n * View/edit permission role for a sharing link.\n */\nexport enum SharingLinkRole {\n    view = \"view\",\n    edit = \"edit\",\n}\n\n/**\n * Defines the permissions scope for a share link requested to be created during the creation the file in ODSP.\n * Providing these properties to the /snapshot api will also create and return the requested kind of sharing link.\n*/\nexport interface ISharingLinkKind {\n    scope: SharingLinkScope;\n    /*\n     * If this parameter is not provided, the API will default to \"edit\" links (provided\n     * a valid createLinkScope setting is given).\n    */\n    role?: SharingLinkRole;\n}\n\n/**\n * Sharing link data received from the /snapshot api response.\n */\nexport interface ISharingLink extends ISharingLinkKind {\n    webUrl: string;\n}\n\n/**\n * Sharing link data created for the ODSP item.\n * Contains information about either sharing link created while creating a new file or\n * a redeemable share link created when loading an existing file\n */\nexport interface ShareLinkInfoType {\n\n    /**\n     * We create a new file in ODSP with the /snapshot api call. Applications then need to make a separate apis call to\n     * create a sharing link for that file. To reduce the number of network calls, ODSP now provides a feature\n     * where we can create a share link along with creating a file by passing a query parameter called\n     * createShareLink (deprecated) or createLinkScope and createLinkRole. createLink object below saves the information\n     * from the /snapshot api response.\n     */\n    createLink?: {\n        /**\n         * @deprecated\n         * Type of shareLink requested/created when creating the file for the first time. The 'type' property here\n         * represents the type of sharing link requested.\n         * Will be deprecated soon. Type of sharing link will be present in the link:ISharingLink property below.\n        */\n        type?: ShareLinkTypes | ISharingLinkKind;\n\n        /**\n         * Share link created when the file is created for the first time with /snapshot api call.\n         */\n        link?: string | ISharingLink;\n\n        /**\n         * Error message if creation of sharing link fails with /snapshot api call\n         */\n        error?: any;\n\n        shareId?: string;\n\n    };\n\n    /**\n     * This is used to save the network calls while doing trees/latest call as if the client does not have\n     * permission then this link can be redeemed for the permissions in the same network call.\n     */\n    sharingLinkToRedeem?: string;\n}\nexport interface IOdspResolvedUrl extends IFluidResolvedUrl, IOdspUrlParts {\n    type: \"fluid\";\n    odspResolvedUrl: true;\n\n    // URL to send to fluid, contains the documentId and the path\n    url: string;\n\n    // A hashed identifier that is unique to this document\n    hashedDocumentId: string;\n\n    endpoints: {\n        snapshotStorageUrl: string;\n        attachmentPOSTStorageUrl: string;\n        attachmentGETStorageUrl: string;\n        deltaStorageUrl: string;\n    };\n\n    // Tokens are not obtained by the ODSP driver using the resolve flow, the app must provide them.\n    // eslint-disable-next-line @typescript-eslint/ban-types\n    tokens: {};\n\n    fileName: string;\n\n    summarizer: boolean;\n\n    codeHint?: {\n        // containerPackageName is used for adding the package name to the request headers.\n        // This may be used for preloading the container package when loading Fluid content.\n        containerPackageName?: string;\n    };\n\n    fileVersion: string | undefined;\n\n    /**\n     * Sharing link data created for the ODSP item.\n     * Contains information about either sharing link created while creating a new file or\n     * a redeemable share link created when loading an existing file\n     */\n    shareLinkInfo?: ShareLinkInfoType;\n\n    isClpCompliantApp?: boolean;\n}\n"]}

package/lib/factory.d.ts

@@ -94,11 +94,24 @@ export interface HostStoragePolicy {
      */
     isolateSocketCache?: boolean;
     /**
-     * Enable creation of sharing link along with the creation of file by setting this value to true.
+     * @deprecated Switch to using the new feature gated by enableSingleRequestForShareLinkWithCreate
+     * with 'createLinkScope' and 'createLinkRole' is requested to the odsp apis instead of 'createLinkType'.
+     * It enables the creation of sharing link along with the creation of file by setting this value to true.
      * If the host provides a 'createLinkType' parameter in the request URL to the container.attach()
-     * method, we will request for send the request to ODSP with the same (if the flag is enabled) so
-     * that a sharing can be created with the creation of file to save number for round trips made to ODSP.
+     * method, we will send the request to ODSP with the same (if the flag is enabled) so
+     * that a share link can be created with the creation of file to save number for round trips made to ODSP.
+     * (This flag works independently of enableSingleRequestForShareLinkWithCreate which is used for sharing link
+     * requests where 'createLinkScope' is requested.)
      */
     enableShareLinkWithCreate?: boolean;
+    /**
+     * Enable creation of sharing link along with the creation of file by setting this value to true.
+     * If the host provides a 'createLinkScope' parameter in the request URL to the container.attach()
+     * method, we will send the request to ODSP with the same (if the flag is enabled) so
+     * that a share link can be created with the creation of file to save number for round trips made to ODSP.
+     * (This flag works independently of enableShareLinkWithCreate which was used for old sharing link requests
+     * where 'createLinkType' was requested.)
+     */
+    enableSingleRequestForShareLinkWithCreate?: boolean;
 }
 //# sourceMappingURL=factory.d.ts.map

package/lib/factory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../src/factory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,WAAW,gBAAgB;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAMlB,GAAG,CAAC,EAAE,MAAM,CAAC;IAOb,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAC9B;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAqB;IAClC;;;OAGG;IACH,8BAA8B,CAAC,EAAE,MAAM,CAAC;IACxC;;;;;;;;;OASG;IACH,sCAAsC,CAAC,EAAE,OAAO,CAAC;CACpD;AAED,MAAM,WAAW,iBAAiB;IAC9B,eAAe,CAAC,EAAE,gBAAgB,CAAC;IAEnC;;;;;;;;OAQG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAGlC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,qBAAqB,CAAC;IAEvC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;OAGG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;;;OAKG;IACF,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACxC"}
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../src/factory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,WAAW,gBAAgB;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAMlB,GAAG,CAAC,EAAE,MAAM,CAAC;IAOb,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAC9B;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAqB;IAClC;;;OAGG;IACH,8BAA8B,CAAC,EAAE,MAAM,CAAC;IACxC;;;;;;;;;OASG;IACH,sCAAsC,CAAC,EAAE,OAAO,CAAC;CACpD;AAED,MAAM,WAAW,iBAAiB;IAC9B,eAAe,CAAC,EAAE,gBAAgB,CAAC;IAEnC;;;;;;;;OAQG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAGlC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,qBAAqB,CAAC;IAEvC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;OAGG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;;;;;;;OASG;IACF,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAErC;;;;;;;OAOG;IACH,yCAAyC,CAAC,EAAE,OAAO,CAAC;CACvD"}

package/lib/factory.js.map

@@ -1 +1 @@
-{"version":3,"file":"factory.js","sourceRoot":"","sources":["../src/factory.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport interface ISnapshotOptions {\n    blobs?: number;\n    deltas?: number;\n    channels?: number;\n    /*\n     * Maximum Data size (in bytes)\n     * If specified, SPO will fail snapshot request with 413 error (see OdspErrorType.snapshotTooBig)\n     * if snapshot is bigger in size than specified limit.\n     */\n    mds?: number;\n\n    /*\n     * Maximum time limit to fetch snapshot (in seconds)\n     * If specified, client will timeout the fetch request if it exceeds the time limit and\n     * will try to fetch the snapshot without blobs.\n     */\n    timeout?: number;\n}\n\nexport interface IOpsCachingPolicy {\n    /**\n     * Batch size. Controls how many ops are grouped together as single cache entry\n     * The bigger the number, the more efficient it is (less reads & writes)\n     * At the same time, big number means we wait for so many ops to accumulate, which\n     * increases chances and number of trailing ops that would not be flushed to cache\n     * when user closes tab\n     * Use any number below 1 to disable caching\n     * Default: 100\n     */\n    batchSize?: number;\n\n    /**\n     * To reduce the problem of losing trailing ops when using big batch sizes, host\n     * could specify how often driver should flush ops it has not flushed yet.\n     * -1 means do not use timer.\n     * Measured in ms.\n     * Default: 5000\n     */\n    timerGranularity?: number;\n\n    /**\n     * Total number of ops to cache. When we reach that number, ops caching stops\n     * Default: 5000\n     */\n    totalOpsToCache?: number;\n}\n\nexport interface ICollabSessionOptions {\n    /**\n     * Value indicating the display name for session that admits unauthenticated user.\n     * This name will be used in attribution associated with edits made by such user.\n     */\n    unauthenticatedUserDisplayName?: string;\n    /**\n     * @deprecated - Due to security reasons we will be passing the token via Authorization header only.\n     * Value indicating session preference to always pass access token via Authorization header.\n     * Default behavior is to pass access token via query parameter unless overall href string\n     * length exceeds 2048 characters. Using query param is performance optimization which results\n     * in ODSP XHR request being treated as 'simple' request which do not require OPTIONS call to\n     * validate CORS. However, not all ODSP implementations understand this optimization.\n     * For instance, auth layer on Converged stack will fail request with access token passed via\n     * query param.\n     */\n    forceAccessTokenViaAuthorizationHeader?: boolean;\n}\n\nexport interface HostStoragePolicy {\n    snapshotOptions?: ISnapshotOptions;\n\n    /**\n     * If set to true, tells driver to concurrently fetch snapshot from storage (SPO) and cache\n     * Container loads from whatever comes first in such case.\n     * Snapshot fetched from storage is pushed to cache in either case.\n     * If set to false, driver will first consult with cache. Only on cache miss (cache does not\n     * return snapshot), driver will fetch snapshot from storage (and push it to cache), otherwise\n     * it will load from cache and not reach out to storage.\n     * Passing true results in faster loads and keeping cache more current, but it increases bandwidth consumption.\n     */\n    concurrentSnapshotFetch?: boolean;\n\n    // Options overwriting default ops fetching from storage.\n    opsBatchSize?: number;\n    concurrentOpsBatches?: number;\n\n    /**\n     * Policy controlling ops caching (leveraging IPersistedCache passed to driver factory)\n     */\n    opsCaching?: IOpsCachingPolicy;\n\n    /**\n     * Policy controlling how collaboration session is established\n     */\n    sessionOptions?: ICollabSessionOptions;\n\n    /**\n     * @deprecated - This field will be always set to true after removal.\n     * True to have the sharing link redeem fallback in case the Trees Latest/Redeem 1RT call fails with redeem error.\n     * During fallback it will first redeem the sharing link and then make the Trees latest call.\n     */\n    enableRedeemFallback?: boolean;\n\n    /**\n     * Policy controlling if we will cache initial summary when we create a document\n     */\n    cacheCreateNewSummary?: boolean;\n\n    /**\n     * @deprecated - This will be replaced with feature gate snapshotFormatFetchType.\n     * Policy controlling if we want to fetch binary format snapshot.\n     */\n    fetchBinarySnapshotFormat?: boolean;\n\n    /**\n     * If set to true, socket cache are per OdspDocumentService instead of shared across all instances\n     */\n    isolateSocketCache?: boolean;\n\n    /**\n     * Enable creation of sharing link along with the creation of file by setting this value to true.\n     * If the host provides a 'createLinkType' parameter in the request URL to the container.attach()\n     * method, we will request for send the request to ODSP with the same (if the flag is enabled) so\n     * that a sharing can be created with the creation of file to save number for round trips made to ODSP.\n     */\n     enableShareLinkWithCreate?: boolean;\n}\n"]}
+{"version":3,"file":"factory.js","sourceRoot":"","sources":["../src/factory.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport interface ISnapshotOptions {\n    blobs?: number;\n    deltas?: number;\n    channels?: number;\n    /*\n     * Maximum Data size (in bytes)\n     * If specified, SPO will fail snapshot request with 413 error (see OdspErrorType.snapshotTooBig)\n     * if snapshot is bigger in size than specified limit.\n     */\n    mds?: number;\n\n    /*\n     * Maximum time limit to fetch snapshot (in seconds)\n     * If specified, client will timeout the fetch request if it exceeds the time limit and\n     * will try to fetch the snapshot without blobs.\n     */\n    timeout?: number;\n}\n\nexport interface IOpsCachingPolicy {\n    /**\n     * Batch size. Controls how many ops are grouped together as single cache entry\n     * The bigger the number, the more efficient it is (less reads & writes)\n     * At the same time, big number means we wait for so many ops to accumulate, which\n     * increases chances and number of trailing ops that would not be flushed to cache\n     * when user closes tab\n     * Use any number below 1 to disable caching\n     * Default: 100\n     */\n    batchSize?: number;\n\n    /**\n     * To reduce the problem of losing trailing ops when using big batch sizes, host\n     * could specify how often driver should flush ops it has not flushed yet.\n     * -1 means do not use timer.\n     * Measured in ms.\n     * Default: 5000\n     */\n    timerGranularity?: number;\n\n    /**\n     * Total number of ops to cache. When we reach that number, ops caching stops\n     * Default: 5000\n     */\n    totalOpsToCache?: number;\n}\n\nexport interface ICollabSessionOptions {\n    /**\n     * Value indicating the display name for session that admits unauthenticated user.\n     * This name will be used in attribution associated with edits made by such user.\n     */\n    unauthenticatedUserDisplayName?: string;\n    /**\n     * @deprecated - Due to security reasons we will be passing the token via Authorization header only.\n     * Value indicating session preference to always pass access token via Authorization header.\n     * Default behavior is to pass access token via query parameter unless overall href string\n     * length exceeds 2048 characters. Using query param is performance optimization which results\n     * in ODSP XHR request being treated as 'simple' request which do not require OPTIONS call to\n     * validate CORS. However, not all ODSP implementations understand this optimization.\n     * For instance, auth layer on Converged stack will fail request with access token passed via\n     * query param.\n     */\n    forceAccessTokenViaAuthorizationHeader?: boolean;\n}\n\nexport interface HostStoragePolicy {\n    snapshotOptions?: ISnapshotOptions;\n\n    /**\n     * If set to true, tells driver to concurrently fetch snapshot from storage (SPO) and cache\n     * Container loads from whatever comes first in such case.\n     * Snapshot fetched from storage is pushed to cache in either case.\n     * If set to false, driver will first consult with cache. Only on cache miss (cache does not\n     * return snapshot), driver will fetch snapshot from storage (and push it to cache), otherwise\n     * it will load from cache and not reach out to storage.\n     * Passing true results in faster loads and keeping cache more current, but it increases bandwidth consumption.\n     */\n    concurrentSnapshotFetch?: boolean;\n\n    // Options overwriting default ops fetching from storage.\n    opsBatchSize?: number;\n    concurrentOpsBatches?: number;\n\n    /**\n     * Policy controlling ops caching (leveraging IPersistedCache passed to driver factory)\n     */\n    opsCaching?: IOpsCachingPolicy;\n\n    /**\n     * Policy controlling how collaboration session is established\n     */\n    sessionOptions?: ICollabSessionOptions;\n\n    /**\n     * @deprecated - This field will be always set to true after removal.\n     * True to have the sharing link redeem fallback in case the Trees Latest/Redeem 1RT call fails with redeem error.\n     * During fallback it will first redeem the sharing link and then make the Trees latest call.\n     */\n    enableRedeemFallback?: boolean;\n\n    /**\n     * Policy controlling if we will cache initial summary when we create a document\n     */\n    cacheCreateNewSummary?: boolean;\n\n    /**\n     * @deprecated - This will be replaced with feature gate snapshotFormatFetchType.\n     * Policy controlling if we want to fetch binary format snapshot.\n     */\n    fetchBinarySnapshotFormat?: boolean;\n\n    /**\n     * If set to true, socket cache are per OdspDocumentService instead of shared across all instances\n     */\n    isolateSocketCache?: boolean;\n\n    /**\n     * @deprecated Switch to using the new feature gated by enableSingleRequestForShareLinkWithCreate\n     * with 'createLinkScope' and 'createLinkRole' is requested to the odsp apis instead of 'createLinkType'.\n     * It enables the creation of sharing link along with the creation of file by setting this value to true.\n     * If the host provides a 'createLinkType' parameter in the request URL to the container.attach()\n     * method, we will send the request to ODSP with the same (if the flag is enabled) so\n     * that a share link can be created with the creation of file to save number for round trips made to ODSP.\n     * (This flag works independently of enableSingleRequestForShareLinkWithCreate which is used for sharing link\n     * requests where 'createLinkScope' is requested.)\n     */\n     enableShareLinkWithCreate?: boolean;\n\n    /**\n     * Enable creation of sharing link along with the creation of file by setting this value to true.\n     * If the host provides a 'createLinkScope' parameter in the request URL to the container.attach()\n     * method, we will send the request to ODSP with the same (if the flag is enabled) so\n     * that a share link can be created with the creation of file to save number for round trips made to ODSP.\n     * (This flag works independently of enableShareLinkWithCreate which was used for old sharing link requests\n     * where 'createLinkType' was requested.)\n     */\n    enableSingleRequestForShareLinkWithCreate?: boolean;\n}\n"]}

package/lib/packageVersion.d.ts

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

package/lib/packageVersion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,4CAA4C,CAAC;AACjE,eAAO,MAAM,UAAU,+BAA+B,CAAC"}
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,4CAA4C,CAAC;AACjE,eAAO,MAAM,UAAU,yBAAyB,CAAC"}

package/lib/packageVersion.js

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

package/lib/packageVersion.js.map

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

package/lib/resolvedUrl.d.ts

@@ -9,14 +9,42 @@ export interface IOdspUrlParts {
     itemId: string;
 }
 /**
+ * @deprecated Use ISharingLinkKind type instead.
  * Type of shareLink requested/created when creating the file for the first time.
- * At the time of adding this comment (Sept/2021) ODSP only supports creation of CSL links
- * when provided as a request parameter with the /snapshot api call.
- * In future, we can add more types here.
 */
 export declare enum ShareLinkTypes {
     csl = "csl"
 }
+/**
+ * Sharing scope of the share links created for a file.
+*/
+export declare enum SharingLinkScope {
+    organization = "organization",
+    users = "users",
+    anonymous = "anonymous",
+    default = "default"
+}
+/**
+ * View/edit permission role for a sharing link.
+ */
+export declare enum SharingLinkRole {
+    view = "view",
+    edit = "edit"
+}
+/**
+ * Defines the permissions scope for a share link requested to be created during the creation the file in ODSP.
+ * Providing these properties to the /snapshot api will also create and return the requested kind of sharing link.
+*/
+export interface ISharingLinkKind {
+    scope: SharingLinkScope;
+    role?: SharingLinkRole;
+}
+/**
+ * Sharing link data received from the /snapshot api response.
+ */
+export interface ISharingLink extends ISharingLinkKind {
+    webUrl: string;
+}
 /**
  * Sharing link data created for the ODSP item.
  * Contains information about either sharing link created while creating a new file or
@@ -24,27 +52,29 @@ export declare enum ShareLinkTypes {
  */
 export interface ShareLinkInfoType {
     /**
-     * We create a new file in ODSP with the /snapshot api call. Applications then call separate apis to
-     * create a sharing link for that file. To reduce the number of api calls, ODSP now provides a feature
+     * We create a new file in ODSP with the /snapshot api call. Applications then need to make a separate apis call to
+     * create a sharing link for that file. To reduce the number of network calls, ODSP now provides a feature
      * where we can create a share link along with creating a file by passing a query parameter called
-     * createShareLink. createLink object below saves the data corresponding to this feature.
+     * createShareLink (deprecated) or createLinkScope and createLinkRole. createLink object below saves the information
+     * from the /snapshot api response.
      */
     createLink?: {
         /**
-         * Type of shareLink requested/created when creating the file for the first time.
-         * At the time of adding this comment (Sept/2021) ODSP only supports creation of CSL links
-         * when provided as a request parameter with the /snapshot api call.
+         * @deprecated
+         * Type of shareLink requested/created when creating the file for the first time. The 'type' property here
+         * represents the type of sharing link requested.
+         * Will be deprecated soon. Type of sharing link will be present in the link:ISharingLink property below.
         */
-        type?: ShareLinkTypes;
+        type?: ShareLinkTypes | ISharingLinkKind;
         /**
          * Share link created when the file is created for the first time with /snapshot api call.
-         * This link does not require redemption.
          */
-        link?: string;
+        link?: string | ISharingLink;
         /**
          * Error message if creation of sharing link fails with /snapshot api call
          */
         error?: any;
+        shareId?: string;
     };
     /**
      * This is used to save the network calls while doing trees/latest call as if the client does not have

package/lib/resolvedUrl.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resolvedUrl.d.ts","sourceRoot":"","sources":["../src/resolvedUrl.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AAEvE,MAAM,WAAW,aAAa;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAClB;AAED;;;;;EAKE;AACF,oBAAY,cAAc;IACtB,GAAG,QAAQ;CACd;AACD;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAE9B;;;;;OAKG;IACH,UAAU,CAAC,EAAE;QACT;;;;UAIE;QACF,IAAI,CAAC,EAAE,cAAc,CAAC;QAEtB;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,CAAC,EAAE,GAAG,CAAC;KACf,CAAC;IAEF;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAChC;AACD,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB,EAAE,aAAa;IACtE,IAAI,EAAE,OAAO,CAAC;IACd,eAAe,EAAE,IAAI,CAAC;IAGtB,GAAG,EAAE,MAAM,CAAC;IAGZ,gBAAgB,EAAE,MAAM,CAAC;IAEzB,SAAS,EAAE;QACP,kBAAkB,EAAE,MAAM,CAAC;QAC3B,wBAAwB,EAAE,MAAM,CAAC;QACjC,uBAAuB,EAAE,MAAM,CAAC;QAChC,eAAe,EAAE,MAAM,CAAC;KAC3B,CAAC;IAIF,MAAM,EAAE,EAAE,CAAC;IAEX,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,OAAO,CAAC;IAEpB,QAAQ,CAAC,EAAE;QAGP,oBAAoB,CAAC,EAAE,MAAM,CAAC;KACjC,CAAC;IAEF,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;OAIG;IACH,aAAa,CAAC,EAAE,iBAAiB,CAAC;IAElC,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC/B"}
+{"version":3,"file":"resolvedUrl.d.ts","sourceRoot":"","sources":["../src/resolvedUrl.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AAEvE,MAAM,WAAW,aAAa;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAClB;AAED;;;EAGE;AACF,oBAAY,cAAc;IACtB,GAAG,QAAQ;CACd;AAED;;EAEE;AACF,oBAAY,gBAAgB;IACxB,YAAY,iBAAiB;IAC7B,KAAK,UAAU;IACf,SAAS,cAAc;IACvB,OAAO,YAAY;CACtB;AAED;;GAEG;AACH,oBAAY,eAAe;IACvB,IAAI,SAAS;IACb,IAAI,SAAS;CAChB;AAED;;;EAGE;AACF,MAAM,WAAW,gBAAgB;IAC7B,KAAK,EAAE,gBAAgB,CAAC;IAKxB,IAAI,CAAC,EAAE,eAAe,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,gBAAgB;IAClD,MAAM,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAE9B;;;;;;OAMG;IACH,UAAU,CAAC,EAAE;QACT;;;;;UAKE;QACF,IAAI,CAAC,EAAE,cAAc,GAAG,gBAAgB,CAAC;QAEzC;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,YAAY,CAAC;QAE7B;;WAEG;QACH,KAAK,CAAC,EAAE,GAAG,CAAC;QAEZ,OAAO,CAAC,EAAE,MAAM,CAAC;KAEpB,CAAC;IAEF;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAChC;AACD,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB,EAAE,aAAa;IACtE,IAAI,EAAE,OAAO,CAAC;IACd,eAAe,EAAE,IAAI,CAAC;IAGtB,GAAG,EAAE,MAAM,CAAC;IAGZ,gBAAgB,EAAE,MAAM,CAAC;IAEzB,SAAS,EAAE;QACP,kBAAkB,EAAE,MAAM,CAAC;QAC3B,wBAAwB,EAAE,MAAM,CAAC;QACjC,uBAAuB,EAAE,MAAM,CAAC;QAChC,eAAe,EAAE,MAAM,CAAC;KAC3B,CAAC;IAIF,MAAM,EAAE,EAAE,CAAC;IAEX,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,OAAO,CAAC;IAEpB,QAAQ,CAAC,EAAE;QAGP,oBAAoB,CAAC,EAAE,MAAM,CAAC;KACjC,CAAC;IAEF,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;OAIG;IACH,aAAa,CAAC,EAAE,iBAAiB,CAAC;IAElC,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC/B"}

package/lib/resolvedUrl.js

@@ -3,13 +3,29 @@
  * Licensed under the MIT License.
  */
 /**
+ * @deprecated Use ISharingLinkKind type instead.
  * Type of shareLink requested/created when creating the file for the first time.
- * At the time of adding this comment (Sept/2021) ODSP only supports creation of CSL links
- * when provided as a request parameter with the /snapshot api call.
- * In future, we can add more types here.
 */
 export var ShareLinkTypes;
 (function (ShareLinkTypes) {
     ShareLinkTypes["csl"] = "csl";
 })(ShareLinkTypes || (ShareLinkTypes = {}));
+/**
+ * Sharing scope of the share links created for a file.
+*/
+export var SharingLinkScope;
+(function (SharingLinkScope) {
+    SharingLinkScope["organization"] = "organization";
+    SharingLinkScope["users"] = "users";
+    SharingLinkScope["anonymous"] = "anonymous";
+    SharingLinkScope["default"] = "default";
+})(SharingLinkScope || (SharingLinkScope = {}));
+/**
+ * View/edit permission role for a sharing link.
+ */
+export var SharingLinkRole;
+(function (SharingLinkRole) {
+    SharingLinkRole["view"] = "view";
+    SharingLinkRole["edit"] = "edit";
+})(SharingLinkRole || (SharingLinkRole = {}));
 //# sourceMappingURL=resolvedUrl.js.map

package/lib/resolvedUrl.js.map

@@ -1 +1 @@
-{"version":3,"file":"resolvedUrl.js","sourceRoot":"","sources":["../src/resolvedUrl.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAUH;;;;;EAKE;AACF,MAAM,CAAN,IAAY,cAEX;AAFD,WAAY,cAAc;IACtB,6BAAW,CAAA;AACf,CAAC,EAFW,cAAc,KAAd,cAAc,QAEzB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidResolvedUrl } from \"@fluidframework/driver-definitions\";\n\nexport interface IOdspUrlParts {\n    siteUrl: string;\n    driveId: string;\n    itemId: string;\n}\n\n/**\n * Type of shareLink requested/created when creating the file for the first time.\n * At the time of adding this comment (Sept/2021) ODSP only supports creation of CSL links\n * when provided as a request parameter with the /snapshot api call.\n * In future, we can add more types here.\n*/\nexport enum ShareLinkTypes {\n    csl = \"csl\",\n}\n/**\n * Sharing link data created for the ODSP item.\n * Contains information about either sharing link created while creating a new file or\n * a redeemable share link created when loading an existing file\n */\nexport interface ShareLinkInfoType {\n\n    /**\n     * We create a new file in ODSP with the /snapshot api call. Applications then call separate apis to\n     * create a sharing link for that file. To reduce the number of api calls, ODSP now provides a feature\n     * where we can create a share link along with creating a file by passing a query parameter called\n     * createShareLink. createLink object below saves the data corresponding to this feature.\n     */\n    createLink?: {\n        /**\n         * Type of shareLink requested/created when creating the file for the first time.\n         * At the time of adding this comment (Sept/2021) ODSP only supports creation of CSL links\n         * when provided as a request parameter with the /snapshot api call.\n        */\n        type?: ShareLinkTypes;\n\n        /**\n         * Share link created when the file is created for the first time with /snapshot api call.\n         * This link does not require redemption.\n         */\n        link?: string;\n\n        /**\n         * Error message if creation of sharing link fails with /snapshot api call\n         */\n        error?: any;\n    };\n\n    /**\n     * This is used to save the network calls while doing trees/latest call as if the client does not have\n     * permission then this link can be redeemed for the permissions in the same network call.\n     */\n    sharingLinkToRedeem?: string;\n}\nexport interface IOdspResolvedUrl extends IFluidResolvedUrl, IOdspUrlParts {\n    type: \"fluid\";\n    odspResolvedUrl: true;\n\n    // URL to send to fluid, contains the documentId and the path\n    url: string;\n\n    // A hashed identifier that is unique to this document\n    hashedDocumentId: string;\n\n    endpoints: {\n        snapshotStorageUrl: string;\n        attachmentPOSTStorageUrl: string;\n        attachmentGETStorageUrl: string;\n        deltaStorageUrl: string;\n    };\n\n    // Tokens are not obtained by the ODSP driver using the resolve flow, the app must provide them.\n    // eslint-disable-next-line @typescript-eslint/ban-types\n    tokens: {};\n\n    fileName: string;\n\n    summarizer: boolean;\n\n    codeHint?: {\n        // containerPackageName is used for adding the package name to the request headers.\n        // This may be used for preloading the container package when loading Fluid content.\n        containerPackageName?: string;\n    };\n\n    fileVersion: string | undefined;\n\n    /**\n     * Sharing link data created for the ODSP item.\n     * Contains information about either sharing link created while creating a new file or\n     * a redeemable share link created when loading an existing file\n     */\n    shareLinkInfo?: ShareLinkInfoType;\n\n    isClpCompliantApp?: boolean;\n}\n"]}
+{"version":3,"file":"resolvedUrl.js","sourceRoot":"","sources":["../src/resolvedUrl.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAUH;;;EAGE;AACF,MAAM,CAAN,IAAY,cAEX;AAFD,WAAY,cAAc;IACtB,6BAAW,CAAA;AACf,CAAC,EAFW,cAAc,KAAd,cAAc,QAEzB;AAED;;EAEE;AACF,MAAM,CAAN,IAAY,gBAKX;AALD,WAAY,gBAAgB;IACxB,iDAA6B,CAAA;IAC7B,mCAAe,CAAA;IACf,2CAAuB,CAAA;IACvB,uCAAmB,CAAA;AACvB,CAAC,EALW,gBAAgB,KAAhB,gBAAgB,QAK3B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,eAGX;AAHD,WAAY,eAAe;IACvB,gCAAa,CAAA;IACb,gCAAa,CAAA;AACjB,CAAC,EAHW,eAAe,KAAf,eAAe,QAG1B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidResolvedUrl } from \"@fluidframework/driver-definitions\";\n\nexport interface IOdspUrlParts {\n    siteUrl: string;\n    driveId: string;\n    itemId: string;\n}\n\n/**\n * @deprecated Use ISharingLinkKind type instead.\n * Type of shareLink requested/created when creating the file for the first time.\n*/\nexport enum ShareLinkTypes {\n    csl = \"csl\",\n}\n\n/**\n * Sharing scope of the share links created for a file.\n*/\nexport enum SharingLinkScope {\n    organization = \"organization\",\n    users = \"users\",\n    anonymous = \"anonymous\",\n    default = \"default\",\n}\n\n/**\n * View/edit permission role for a sharing link.\n */\nexport enum SharingLinkRole {\n    view = \"view\",\n    edit = \"edit\",\n}\n\n/**\n * Defines the permissions scope for a share link requested to be created during the creation the file in ODSP.\n * Providing these properties to the /snapshot api will also create and return the requested kind of sharing link.\n*/\nexport interface ISharingLinkKind {\n    scope: SharingLinkScope;\n    /*\n     * If this parameter is not provided, the API will default to \"edit\" links (provided\n     * a valid createLinkScope setting is given).\n    */\n    role?: SharingLinkRole;\n}\n\n/**\n * Sharing link data received from the /snapshot api response.\n */\nexport interface ISharingLink extends ISharingLinkKind {\n    webUrl: string;\n}\n\n/**\n * Sharing link data created for the ODSP item.\n * Contains information about either sharing link created while creating a new file or\n * a redeemable share link created when loading an existing file\n */\nexport interface ShareLinkInfoType {\n\n    /**\n     * We create a new file in ODSP with the /snapshot api call. Applications then need to make a separate apis call to\n     * create a sharing link for that file. To reduce the number of network calls, ODSP now provides a feature\n     * where we can create a share link along with creating a file by passing a query parameter called\n     * createShareLink (deprecated) or createLinkScope and createLinkRole. createLink object below saves the information\n     * from the /snapshot api response.\n     */\n    createLink?: {\n        /**\n         * @deprecated\n         * Type of shareLink requested/created when creating the file for the first time. The 'type' property here\n         * represents the type of sharing link requested.\n         * Will be deprecated soon. Type of sharing link will be present in the link:ISharingLink property below.\n        */\n        type?: ShareLinkTypes | ISharingLinkKind;\n\n        /**\n         * Share link created when the file is created for the first time with /snapshot api call.\n         */\n        link?: string | ISharingLink;\n\n        /**\n         * Error message if creation of sharing link fails with /snapshot api call\n         */\n        error?: any;\n\n        shareId?: string;\n\n    };\n\n    /**\n     * This is used to save the network calls while doing trees/latest call as if the client does not have\n     * permission then this link can be redeemed for the permissions in the same network call.\n     */\n    sharingLinkToRedeem?: string;\n}\nexport interface IOdspResolvedUrl extends IFluidResolvedUrl, IOdspUrlParts {\n    type: \"fluid\";\n    odspResolvedUrl: true;\n\n    // URL to send to fluid, contains the documentId and the path\n    url: string;\n\n    // A hashed identifier that is unique to this document\n    hashedDocumentId: string;\n\n    endpoints: {\n        snapshotStorageUrl: string;\n        attachmentPOSTStorageUrl: string;\n        attachmentGETStorageUrl: string;\n        deltaStorageUrl: string;\n    };\n\n    // Tokens are not obtained by the ODSP driver using the resolve flow, the app must provide them.\n    // eslint-disable-next-line @typescript-eslint/ban-types\n    tokens: {};\n\n    fileName: string;\n\n    summarizer: boolean;\n\n    codeHint?: {\n        // containerPackageName is used for adding the package name to the request headers.\n        // This may be used for preloading the container package when loading Fluid content.\n        containerPackageName?: string;\n    };\n\n    fileVersion: string | undefined;\n\n    /**\n     * Sharing link data created for the ODSP item.\n     * Contains information about either sharing link created while creating a new file or\n     * a redeemable share link created when loading an existing file\n     */\n    shareLinkInfo?: ShareLinkInfoType;\n\n    isClpCompliantApp?: boolean;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/odsp-driver-definitions",
-  "version": "2.0.0-internal.1.0.0.84253",
+  "version": "2.0.0-internal.1.1.0",
   "description": "Socket storage implementation for SPO and ODC",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -36,7 +36,7 @@
     "typetests:gen": "fluid-type-validator -g -d ."
   },
   "dependencies": {
-    "@fluidframework/driver-definitions": "2.0.0-internal.1.0.0.84253"
+    "@fluidframework/driver-definitions": "^2.0.0-internal.1.1.0"
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.24.0",
@@ -47,7 +47,7 @@
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "concurrently": "^6.2.0",
-    "copyfiles": "^2.1.0",
+    "copyfiles": "^2.4.1",
     "cross-env": "^7.0.2",
     "eslint": "~8.6.0",
     "rimraf": "^2.6.2",

package/src/factory.ts

@@ -121,10 +121,24 @@ export interface HostStoragePolicy {
     isolateSocketCache?: boolean;
 
     /**
-     * Enable creation of sharing link along with the creation of file by setting this value to true.
+     * @deprecated Switch to using the new feature gated by enableSingleRequestForShareLinkWithCreate
+     * with 'createLinkScope' and 'createLinkRole' is requested to the odsp apis instead of 'createLinkType'.
+     * It enables the creation of sharing link along with the creation of file by setting this value to true.
      * If the host provides a 'createLinkType' parameter in the request URL to the container.attach()
-     * method, we will request for send the request to ODSP with the same (if the flag is enabled) so
-     * that a sharing can be created with the creation of file to save number for round trips made to ODSP.
+     * method, we will send the request to ODSP with the same (if the flag is enabled) so
+     * that a share link can be created with the creation of file to save number for round trips made to ODSP.
+     * (This flag works independently of enableSingleRequestForShareLinkWithCreate which is used for sharing link
+     * requests where 'createLinkScope' is requested.)
      */
      enableShareLinkWithCreate?: boolean;
+
+    /**
+     * Enable creation of sharing link along with the creation of file by setting this value to true.
+     * If the host provides a 'createLinkScope' parameter in the request URL to the container.attach()
+     * method, we will send the request to ODSP with the same (if the flag is enabled) so
+     * that a share link can be created with the creation of file to save number for round trips made to ODSP.
+     * (This flag works independently of enableShareLinkWithCreate which was used for old sharing link requests
+     * where 'createLinkType' was requested.)
+     */
+    enableSingleRequestForShareLinkWithCreate?: boolean;
 }

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/odsp-driver-definitions";
-export const pkgVersion = "2.0.0-internal.1.0.0.84253";
+export const pkgVersion = "2.0.0-internal.1.1.0";

package/src/resolvedUrl.ts

@@ -12,14 +12,51 @@ export interface IOdspUrlParts {
 }
 
 /**
+ * @deprecated Use ISharingLinkKind type instead.
  * Type of shareLink requested/created when creating the file for the first time.
- * At the time of adding this comment (Sept/2021) ODSP only supports creation of CSL links
- * when provided as a request parameter with the /snapshot api call.
- * In future, we can add more types here.
 */
 export enum ShareLinkTypes {
     csl = "csl",
 }
+
+/**
+ * Sharing scope of the share links created for a file.
+*/
+export enum SharingLinkScope {
+    organization = "organization",
+    users = "users",
+    anonymous = "anonymous",
+    default = "default",
+}
+
+/**
+ * View/edit permission role for a sharing link.
+ */
+export enum SharingLinkRole {
+    view = "view",
+    edit = "edit",
+}
+
+/**
+ * Defines the permissions scope for a share link requested to be created during the creation the file in ODSP.
+ * Providing these properties to the /snapshot api will also create and return the requested kind of sharing link.
+*/
+export interface ISharingLinkKind {
+    scope: SharingLinkScope;
+    /*
+     * If this parameter is not provided, the API will default to "edit" links (provided
+     * a valid createLinkScope setting is given).
+    */
+    role?: SharingLinkRole;
+}
+
+/**
+ * Sharing link data received from the /snapshot api response.
+ */
+export interface ISharingLink extends ISharingLinkKind {
+    webUrl: string;
+}
+
 /**
  * Sharing link data created for the ODSP item.
  * Contains information about either sharing link created while creating a new file or
@@ -28,29 +65,33 @@ export enum ShareLinkTypes {
 export interface ShareLinkInfoType {
 
     /**
-     * We create a new file in ODSP with the /snapshot api call. Applications then call separate apis to
-     * create a sharing link for that file. To reduce the number of api calls, ODSP now provides a feature
+     * We create a new file in ODSP with the /snapshot api call. Applications then need to make a separate apis call to
+     * create a sharing link for that file. To reduce the number of network calls, ODSP now provides a feature
      * where we can create a share link along with creating a file by passing a query parameter called
-     * createShareLink. createLink object below saves the data corresponding to this feature.
+     * createShareLink (deprecated) or createLinkScope and createLinkRole. createLink object below saves the information
+     * from the /snapshot api response.
      */
     createLink?: {
         /**
-         * Type of shareLink requested/created when creating the file for the first time.
-         * At the time of adding this comment (Sept/2021) ODSP only supports creation of CSL links
-         * when provided as a request parameter with the /snapshot api call.
+         * @deprecated
+         * Type of shareLink requested/created when creating the file for the first time. The 'type' property here
+         * represents the type of sharing link requested.
+         * Will be deprecated soon. Type of sharing link will be present in the link:ISharingLink property below.
         */
-        type?: ShareLinkTypes;
+        type?: ShareLinkTypes | ISharingLinkKind;
 
         /**
          * Share link created when the file is created for the first time with /snapshot api call.
-         * This link does not require redemption.
          */
-        link?: string;
+        link?: string | ISharingLink;
 
         /**
          * Error message if creation of sharing link fails with /snapshot api call
          */
         error?: any;
+
+        shareId?: string;
+
     };
 
     /**