@fluidframework/odsp-driver-definitions 1.4.0-115997 → 2.0.0-dev-rc.1.0.0.224419

package/dist/odspCache.d.ts

@@ -2,12 +2,19 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { IFluidResolvedUrl } from "@fluidframework/driver-definitions";
+import { IResolvedUrl } from "@fluidframework/driver-definitions";
 /**
  * Describes what kind of content is stored in cache entry.
+ * @internal
  */
 export declare const snapshotKey = "snapshot";
-export declare type CacheContentType = "snapshot" | "ops";
+/**
+ * @alpha
+ */
+export type CacheContentType = "snapshot" | "ops";
+/**
+ * @alpha
+ */
 export interface IFileEntry {
     /**
      * Unique and stable ID of the document.
@@ -20,10 +27,11 @@ export interface IFileEntry {
      * a file if user requests so.
      * This is IOdspResolvedUrl in case of ODSP driver.
      */
-    resolvedUrl: IFluidResolvedUrl;
+    resolvedUrl: IResolvedUrl;
 }
 /**
  * Cache entry. Identifies file that this entry belongs to, and type of content stored in it.
+ * @alpha
  */
 export interface IEntry {
     /**
@@ -44,6 +52,7 @@ export interface IEntry {
 }
 /**
  * Cache entry. Identifies file that this entry belongs to, and type of content stored in it.
+ * @alpha
  */
 export interface ICacheEntry extends IEntry {
     /**
@@ -57,13 +66,14 @@ export interface ICacheEntry extends IEntry {
  * cache implementation that does not survive across sessions. Snapshot entires stored in the
  * IPersistedCache will be considered stale and removed after 2 days. Read the README for more
  * information.
+ * @alpha
  */
 export interface IPersistedCache {
     /**
      * Get the cache value of the key
      * @param entry - cache entry, identifies file and particular key for this file.
      * @returns Cached value. undefined if nothing is cached.
-    */
+     */
     get(entry: ICacheEntry): Promise<any>;
     /**
      * Put the value into cache.
@@ -78,4 +88,11 @@ export interface IPersistedCache {
      */
     removeEntries(file: IFileEntry): Promise<void>;
 }
+/**
+ * Api to generate a cache key from cache entry.
+ * @param entry - cache entry from which a cache key is generated
+ * @returns The key for cache.
+ * @internal
+ */
+export declare function getKeyForCacheEntry(entry: ICacheEntry): string;
 //# sourceMappingURL=odspCache.d.ts.map

package/dist/odspCache.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"odspCache.d.ts","sourceRoot":"","sources":["../src/odspCache.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AAEvE;;GAEG;AACH,eAAO,MAAM,WAAW,aAAa,CAAC;AACtC,oBAAY,gBAAgB,GAAG,UAAU,GAAG,KAAK,CAAC;AAOlD,MAAM,WAAW,UAAU;IACvB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;;;OAKG;IACH,WAAW,EAAE,iBAAiB,CAAC;CAClC;AAED;;GAEG;AACF,MAAM,WAAW,MAAM;IACpB;;;;OAIG;IACH,IAAI,EAAE,gBAAgB,CAAC;IAEvB;;;;;;;OAOG;IACH,GAAG,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,MAAM;IACvC;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CACpB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC5B;;;;MAIE;IACF,GAAG,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAEtC;;;;;OAKG;IACH,GAAG,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnD;;;OAGG;IACH,aAAa,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAClD"}
+{"version":3,"file":"odspCache.d.ts","sourceRoot":"","sources":["../src/odspCache.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAElE;;;GAGG;AACH,eAAO,MAAM,WAAW,aAAa,CAAC;AACtC;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,KAAK,CAAC;AAOlD;;GAEG;AACH,MAAM,WAAW,UAAU;IAC1B;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;;;OAKG;IACH,WAAW,EAAE,YAAY,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,MAAM;IACtB;;;;OAIG;IACH,IAAI,EAAE,gBAAgB,CAAC;IAEvB;;;;;;;OAOG;IACH,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,MAAM;IAC1C;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CACjB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,eAAe;IAC/B;;;;OAIG;IACH,GAAG,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAEtC;;;;;OAKG;IACH,GAAG,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnD;;;OAGG;IACH,aAAa,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/C;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,CAE9D"}

package/dist/resolvedUrl.cjs

@@ -0,0 +1,37 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+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.
+ * @alpha
+ */
+var ShareLinkTypes;
+(function (ShareLinkTypes) {
+    ShareLinkTypes["csl"] = "csl";
+})(ShareLinkTypes || (exports.ShareLinkTypes = ShareLinkTypes = {}));
+/**
+ * Sharing scope of the share links created for a file.
+ * @alpha
+ */
+var SharingLinkScope;
+(function (SharingLinkScope) {
+    SharingLinkScope["organization"] = "organization";
+    SharingLinkScope["users"] = "users";
+    SharingLinkScope["anonymous"] = "anonymous";
+    SharingLinkScope["default"] = "default";
+})(SharingLinkScope || (exports.SharingLinkScope = SharingLinkScope = {}));
+/**
+ * View/edit permission role for a sharing link.
+ * @alpha
+ */
+var SharingLinkRole;
+(function (SharingLinkRole) {
+    SharingLinkRole["view"] = "view";
+    SharingLinkRole["edit"] = "edit";
+})(SharingLinkRole || (exports.SharingLinkRole = SharingLinkRole = {}));
+//# sourceMappingURL=resolvedUrl.cjs.map

package/dist/resolvedUrl.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolvedUrl.cjs","sourceRoot":"","sources":["../src/resolvedUrl.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAaH;;;;GAIG;AACH,IAAY,cAEX;AAFD,WAAY,cAAc;IACzB,6BAAW,CAAA;AACZ,CAAC,EAFW,cAAc,8BAAd,cAAc,QAEzB;AAED;;;GAGG;AACH,IAAY,gBAKX;AALD,WAAY,gBAAgB;IAC3B,iDAA6B,CAAA;IAC7B,mCAAe,CAAA;IACf,2CAAuB,CAAA;IACvB,uCAAmB,CAAA;AACpB,CAAC,EALW,gBAAgB,gCAAhB,gBAAgB,QAK3B;AAED;;;GAGG;AACH,IAAY,eAGX;AAHD,WAAY,eAAe;IAC1B,gCAAa,CAAA;IACb,gCAAa,CAAA;AACd,CAAC,EAHW,eAAe,+BAAf,eAAe,QAG1B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IResolvedUrl } from \"@fluidframework/driver-definitions\";\n\n/**\n * @alpha\n */\nexport interface IOdspUrlParts {\n\tsiteUrl: string;\n\tdriveId: string;\n\titemId: 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 * @alpha\n */\nexport enum ShareLinkTypes {\n\tcsl = \"csl\",\n}\n\n/**\n * Sharing scope of the share links created for a file.\n * @alpha\n */\nexport enum SharingLinkScope {\n\torganization = \"organization\",\n\tusers = \"users\",\n\tanonymous = \"anonymous\",\n\tdefault = \"default\",\n}\n\n/**\n * View/edit permission role for a sharing link.\n * @alpha\n */\nexport enum SharingLinkRole {\n\tview = \"view\",\n\tedit = \"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 * @alpha\n */\nexport interface ISharingLinkKind {\n\tscope: SharingLinkScope;\n\t/*\n\t * If this parameter is not provided, the API will default to \"edit\" links (provided\n\t * a valid createLinkScope setting is given).\n\t */\n\trole?: SharingLinkRole;\n}\n\n/**\n * Sharing link data received from the /snapshot api response.\n * @alpha\n */\nexport interface ISharingLink extends ISharingLinkKind {\n\twebUrl: 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 * @alpha\n */\nexport interface ShareLinkInfoType {\n\t/**\n\t * We create a new file in ODSP with the /snapshot api call. Applications then need to make a separate apis call to\n\t * create a sharing link for that file. To reduce the number of network calls, ODSP now provides a feature\n\t * where we can create a share link along with creating a file by passing a query parameter called\n\t * createShareLink (deprecated) or createLinkScope and createLinkRole. createLink object below saves the information\n\t * from the /snapshot api response.\n\t */\n\tcreateLink?: {\n\t\t/**\n\t\t * @deprecated\n\t\t * Type of shareLink requested/created when creating the file for the first time. The 'type' property here\n\t\t * represents the type of sharing link requested.\n\t\t * Will be deprecated soon. Type of sharing link will be present in the link:ISharingLink property below.\n\t\t */\n\t\ttype?: ShareLinkTypes | ISharingLinkKind;\n\n\t\t/**\n\t\t * Share link created when the file is created for the first time with /snapshot api call.\n\t\t */\n\t\tlink?: string | ISharingLink;\n\n\t\t/**\n\t\t * Error message if creation of sharing link fails with /snapshot api call\n\t\t */\n\t\terror?: any;\n\n\t\tshareId?: string;\n\t};\n\n\t/**\n\t * This is used to save the network calls while doing trees/latest call as if the client does not have\n\t * permission then this link can be redeemed for the permissions in the same network call.\n\t */\n\tsharingLinkToRedeem?: string;\n}\n/**\n * @alpha\n */\nexport interface IOdspResolvedUrl extends IResolvedUrl, IOdspUrlParts {\n\ttype: \"fluid\";\n\todspResolvedUrl: true;\n\n\t// URL to send to fluid, contains the documentId and the path\n\turl: string;\n\n\t// A hashed identifier that is unique to this document\n\thashedDocumentId: string;\n\n\tendpoints: {\n\t\tsnapshotStorageUrl: string;\n\t\tattachmentPOSTStorageUrl: string;\n\t\tattachmentGETStorageUrl: string;\n\t\tdeltaStorageUrl: string;\n\t};\n\n\t// Tokens are not obtained by the ODSP driver using the resolve flow, the app must provide them.\n\t// eslint-disable-next-line @typescript-eslint/ban-types\n\ttokens: {};\n\n\tfileName: string;\n\n\tsummarizer: boolean;\n\n\tcodeHint?: {\n\t\t// containerPackageName is used for adding the package name to the request headers.\n\t\t// This may be used for preloading the container package when loading Fluid content.\n\t\tcontainerPackageName?: string;\n\t};\n\n\tfileVersion: string | undefined;\n\n\tdataStorePath?: string;\n\n\t/**\n\t * Sharing link data created for the ODSP item.\n\t * Contains information about either sharing link created while creating a new file or\n\t * a redeemable share link created when loading an existing file\n\t */\n\tshareLinkInfo?: ShareLinkInfoType;\n\n\tisClpCompliantApp?: boolean;\n}\n"]}

package/dist/resolvedUrl.d.ts

@@ -2,49 +2,88 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { IFluidResolvedUrl } from "@fluidframework/driver-definitions";
+import { IResolvedUrl } from "@fluidframework/driver-definitions";
+/**
+ * @alpha
+ */
 export interface IOdspUrlParts {
     siteUrl: string;
     driveId: string;
     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.
-*/
+ * @alpha
+ */
 export declare enum ShareLinkTypes {
     csl = "csl"
 }
+/**
+ * Sharing scope of the share links created for a file.
+ * @alpha
+ */
+export declare enum SharingLinkScope {
+    organization = "organization",
+    users = "users",
+    anonymous = "anonymous",
+    default = "default"
+}
+/**
+ * View/edit permission role for a sharing link.
+ * @alpha
+ */
+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.
+ * @alpha
+ */
+export interface ISharingLinkKind {
+    scope: SharingLinkScope;
+    role?: SharingLinkRole;
+}
+/**
+ * Sharing link data received from the /snapshot api response.
+ * @alpha
+ */
+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
  * a redeemable share link created when loading an existing file
+ * @alpha
  */
 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.
-        */
-        type?: ShareLinkTypes;
+         * @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 | 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
@@ -52,7 +91,10 @@ export interface ShareLinkInfoType {
      */
     sharingLinkToRedeem?: string;
 }
-export interface IOdspResolvedUrl extends IFluidResolvedUrl, IOdspUrlParts {
+/**
+ * @alpha
+ */
+export interface IOdspResolvedUrl extends IResolvedUrl, IOdspUrlParts {
     type: "fluid";
     odspResolvedUrl: true;
     url: string;
@@ -70,6 +112,7 @@ export interface IOdspResolvedUrl extends IFluidResolvedUrl, IOdspUrlParts {
         containerPackageName?: string;
     };
     fileVersion: string | undefined;
+    dataStorePath?: string;
     /**
      * Sharing link data created for the ODSP item.
      * Contains information about either sharing link created while creating a new file or

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,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAElE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,oBAAY,cAAc;IACzB,GAAG,QAAQ;CACX;AAED;;;GAGG;AACH,oBAAY,gBAAgB;IAC3B,YAAY,iBAAiB;IAC7B,KAAK,UAAU;IACf,SAAS,cAAc;IACvB,OAAO,YAAY;CACnB;AAED;;;GAGG;AACH,oBAAY,eAAe;IAC1B,IAAI,SAAS;IACb,IAAI,SAAS;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAChC,KAAK,EAAE,gBAAgB,CAAC;IAKxB,IAAI,CAAC,EAAE,eAAe,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,gBAAgB;IACrD,MAAM,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IACjC;;;;;;OAMG;IACH,UAAU,CAAC,EAAE;QACZ;;;;;WAKG;QACH,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;KACjB,CAAC;IAEF;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC7B;AACD;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,YAAY,EAAE,aAAa;IACpE,IAAI,EAAE,OAAO,CAAC;IACd,eAAe,EAAE,IAAI,CAAC;IAGtB,GAAG,EAAE,MAAM,CAAC;IAGZ,gBAAgB,EAAE,MAAM,CAAC;IAEzB,SAAS,EAAE;QACV,kBAAkB,EAAE,MAAM,CAAC;QAC3B,wBAAwB,EAAE,MAAM,CAAC;QACjC,uBAAuB,EAAE,MAAM,CAAC;QAChC,eAAe,EAAE,MAAM,CAAC;KACxB,CAAC;IAIF,MAAM,EAAE,EAAE,CAAC;IAEX,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,OAAO,CAAC;IAEpB,QAAQ,CAAC,EAAE;QAGV,oBAAoB,CAAC,EAAE,MAAM,CAAC;KAC9B,CAAC;IAEF,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,aAAa,CAAC,EAAE,iBAAiB,CAAC;IAElC,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC5B"}

package/dist/{odspCache.js → sessionProvider.cjs}

@@ -4,9 +4,4 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.snapshotKey = void 0;
-/**
- * Describes what kind of content is stored in cache entry.
- */
-exports.snapshotKey = "snapshot";
-//# sourceMappingURL=odspCache.js.map
+//# sourceMappingURL=sessionProvider.cjs.map

package/dist/sessionProvider.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"sessionProvider.cjs","sourceRoot":"","sources":["../src/sessionProvider.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IResolvedUrl } from \"@fluidframework/driver-definitions\";\n\n/**\n * Socket storage discovery api response\n * @alpha\n */\nexport interface ISocketStorageDiscovery {\n\t// The id of the web socket\n\tid: string;\n\n\t// SPO gives us runtimeTenantId, we remap it to tenantId\n\t// See getSocketStorageDiscovery\n\truntimeTenantId?: string;\n\ttenantId: string;\n\n\tsnapshotStorageUrl: string;\n\tdeltaStorageUrl: string;\n\n\t/**\n\t * PUSH URL\n\t */\n\tdeltaStreamSocketUrl: string;\n\n\t/**\n\t * The access token for PushChannel. Optionally returned, depending on implementation.\n\t * OneDrive for Consumer implementation returns it and OneDrive for Business implementation\n\t * does not return it and instead expects token to be returned via `getWebsocketToken` callback\n\t * passed as a parameter to `OdspDocumentService.create()` factory.\n\t */\n\tsocketToken?: string;\n\n\t/**\n\t * This is the time within which client has to refresh the session on (ODSP) relay service.\n\t */\n\trefreshSessionDurationSeconds?: number;\n}\n\n/**\n * An interface that allows a concrete instance of a driver factory to interrogate itself\n * to find out if it is session aware.\n * @alpha\n */\nexport interface IProvideSessionAwareDriverFactory {\n\treadonly IRelaySessionAwareDriverFactory: IRelaySessionAwareDriverFactory;\n}\n\n/**\n * An interface that allows a concrete instance of a driver factory to call the `getRelayServiceSessionInfo`\n * function if it session aware.\n * @alpha\n */\nexport interface IRelaySessionAwareDriverFactory extends IProvideSessionAwareDriverFactory {\n\tgetRelayServiceSessionInfo(\n\t\tresolvedUrl: IResolvedUrl,\n\t): Promise<ISocketStorageDiscovery | undefined>;\n}\n"]}

package/dist/sessionProvider.d.ts

@@ -0,0 +1,48 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IResolvedUrl } from "@fluidframework/driver-definitions";
+/**
+ * Socket storage discovery api response
+ * @alpha
+ */
+export interface ISocketStorageDiscovery {
+    id: string;
+    runtimeTenantId?: string;
+    tenantId: string;
+    snapshotStorageUrl: string;
+    deltaStorageUrl: string;
+    /**
+     * PUSH URL
+     */
+    deltaStreamSocketUrl: string;
+    /**
+     * The access token for PushChannel. Optionally returned, depending on implementation.
+     * OneDrive for Consumer implementation returns it and OneDrive for Business implementation
+     * does not return it and instead expects token to be returned via `getWebsocketToken` callback
+     * passed as a parameter to `OdspDocumentService.create()` factory.
+     */
+    socketToken?: string;
+    /**
+     * This is the time within which client has to refresh the session on (ODSP) relay service.
+     */
+    refreshSessionDurationSeconds?: number;
+}
+/**
+ * An interface that allows a concrete instance of a driver factory to interrogate itself
+ * to find out if it is session aware.
+ * @alpha
+ */
+export interface IProvideSessionAwareDriverFactory {
+    readonly IRelaySessionAwareDriverFactory: IRelaySessionAwareDriverFactory;
+}
+/**
+ * An interface that allows a concrete instance of a driver factory to call the `getRelayServiceSessionInfo`
+ * function if it session aware.
+ * @alpha
+ */
+export interface IRelaySessionAwareDriverFactory extends IProvideSessionAwareDriverFactory {
+    getRelayServiceSessionInfo(resolvedUrl: IResolvedUrl): Promise<ISocketStorageDiscovery | undefined>;
+}
+//# sourceMappingURL=sessionProvider.d.ts.map

package/dist/sessionProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sessionProvider.d.ts","sourceRoot":"","sources":["../src/sessionProvider.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAElE;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IAEvC,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;CACvC;AAED;;;;GAIG;AACH,MAAM,WAAW,iCAAiC;IACjD,QAAQ,CAAC,+BAA+B,EAAE,+BAA+B,CAAC;CAC1E;AAED;;;;GAIG;AACH,MAAM,WAAW,+BAAgC,SAAQ,iCAAiC;IACzF,0BAA0B,CACzB,WAAW,EAAE,YAAY,GACvB,OAAO,CAAC,uBAAuB,GAAG,SAAS,CAAC,CAAC;CAChD"}

package/dist/{tokenFetch.js → tokenFetch.cjs}

@@ -9,19 +9,23 @@ exports.isTokenFromCache = exports.tokenFromResponse = void 0;
  * Helper method which transforms return value for TokenFetcher method to token string
  * @param tokenResponse - return value for TokenFetcher method
  * @returns Token value
+ * @internal
  */
 const tokenFromResponse = (tokenResponse) => tokenResponse === null || typeof tokenResponse === "string"
     ? tokenResponse
-    : tokenResponse === undefined ? null : tokenResponse.token;
+    : tokenResponse === undefined
+        ? null
+        : tokenResponse.token;
 exports.tokenFromResponse = tokenFromResponse;
 /**
  * Helper method which returns flag indicating whether token response comes from local cache
  * @param tokenResponse - return value for TokenFetcher method
  * @returns Value indicating whether response came from cache.
  * Undefined is returned when we could not determine the source of token.
+ * @internal
  */
 const isTokenFromCache = (tokenResponse) => tokenResponse === null || typeof tokenResponse === "string"
     ? undefined
     : tokenResponse.fromCache;
 exports.isTokenFromCache = isTokenFromCache;
-//# sourceMappingURL=tokenFetch.js.map
+//# sourceMappingURL=tokenFetch.cjs.map

package/dist/tokenFetch.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokenFetch.cjs","sourceRoot":"","sources":["../src/tokenFetch.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAgEH;;;;;GAKG;AACI,MAAM,iBAAiB,GAAG,CAChC,aAAwD,EACxC,EAAE,CAClB,aAAa,KAAK,IAAI,IAAI,OAAO,aAAa,KAAK,QAAQ;IAC1D,CAAC,CAAC,aAAa;IACf,CAAC,CAAC,aAAa,KAAK,SAAS;QAC7B,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC;AAPX,QAAA,iBAAiB,qBAON;AAExB;;;;;;GAMG;AACI,MAAM,gBAAgB,GAAG,CAC/B,aAA4C,EACtB,EAAE,CACxB,aAAa,KAAK,IAAI,IAAI,OAAO,aAAa,KAAK,QAAQ;IAC1D,CAAC,CAAC,SAAS;IACX,CAAC,CAAC,aAAa,CAAC,SAAS,CAAC;AALf,QAAA,gBAAgB,oBAKD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Represents token response\n * @beta\n */\nexport interface TokenResponse {\n\t/** Token value */\n\ttoken: string;\n\n\t/** Flag indicating whether token was obtained from local cache */\n\tfromCache?: boolean;\n}\n\n/**\n * Represents access token fetch options\n * @alpha\n */\nexport interface TokenFetchOptions {\n\t/**\n\t * Value indicating whether fresh token has to be returned.\n\t * If false then it is okay to return cached unexpired token if available.\n\t */\n\trefresh: boolean;\n\n\t/**\n\t * Claims that have to be passed with token fetch request.\n\t * These can be used to specify additional information that must be passed to token authority.\n\t */\n\tclaims?: string;\n\n\t/**\n\t * Tenant id of authority that must be handling token fetch.\n\t * If it is not specified then it is up to token fetching logic to determine which tenant authority\n\t * to use to issue access token.\n\t */\n\ttenantId?: string;\n}\n\n/**\n * Represents access token fetch options for ODSP resource\n * @alpha\n */\nexport interface OdspResourceTokenFetchOptions extends TokenFetchOptions {\n\t/** Site url representing ODSP resource location */\n\tsiteUrl: string;\n\n\t/** ODSP drive id where resource resides. Optional, used only when fetching token to access ODSP file */\n\tdriveId?: string;\n\n\t/** ODSP item id representing resource. Optional, used only when fetching token to access ODSP file */\n\titemId?: string;\n}\n\n/**\n * Method signature for callback method used to fetch access token\n * @param options - token fetch options\n * @returns If successful, TokenResponse object representing token value along with flag indicating\n * whether token came from cache. Legacy implementation may return a string for token value;\n * in this case it should be assumes that fromCache signal is undefined. Null is returned in case of failure.\n * @alpha\n */\nexport type TokenFetcher<T> = (options: T) => Promise<string | TokenResponse | null>;\n\n/**\n * Helper method which transforms return value for TokenFetcher method to token string\n * @param tokenResponse - return value for TokenFetcher method\n * @returns Token value\n * @internal\n */\nexport const tokenFromResponse = (\n\ttokenResponse: string | TokenResponse | null | undefined,\n): string | null =>\n\ttokenResponse === null || typeof tokenResponse === \"string\"\n\t\t? tokenResponse\n\t\t: tokenResponse === undefined\n\t\t? null\n\t\t: tokenResponse.token;\n\n/**\n * Helper method which returns flag indicating whether token response comes from local cache\n * @param tokenResponse - return value for TokenFetcher method\n * @returns Value indicating whether response came from cache.\n * Undefined is returned when we could not determine the source of token.\n * @internal\n */\nexport const isTokenFromCache = (\n\ttokenResponse: string | TokenResponse | null,\n): boolean | undefined =>\n\ttokenResponse === null || typeof tokenResponse === \"string\"\n\t\t? undefined\n\t\t: tokenResponse.fromCache;\n\n/**\n * Identity types supported by ODSP driver.\n * `Consumer` represents user authenticated with Microsoft Account (MSA).\n * `Enterprise` represents user authenticated with M365 tenant account.\n * @alpha\n */\nexport type IdentityType = \"Consumer\" | \"Enterprise\";\n\n/**\n * @internal\n */\nexport type InstrumentedStorageTokenFetcher = (\n\toptions: TokenFetchOptions,\n\tname: string,\n\talwaysRecordTokenFetchTelemetry?: boolean,\n) => Promise<string | null>;\n"]}

package/dist/tokenFetch.d.ts

@@ -4,6 +4,7 @@
  */
 /**
  * Represents token response
+ * @beta
  */
 export interface TokenResponse {
     /** Token value */
@@ -13,6 +14,7 @@ export interface TokenResponse {
 }
 /**
  * Represents access token fetch options
+ * @alpha
  */
 export interface TokenFetchOptions {
     /**
@@ -34,6 +36,7 @@ export interface TokenFetchOptions {
 }
 /**
  * Represents access token fetch options for ODSP resource
+ * @alpha
  */
 export interface OdspResourceTokenFetchOptions extends TokenFetchOptions {
     /** Site url representing ODSP resource location */
@@ -49,12 +52,14 @@ export interface OdspResourceTokenFetchOptions extends TokenFetchOptions {
  * @returns If successful, TokenResponse object representing token value along with flag indicating
  * whether token came from cache. Legacy implementation may return a string for token value;
  * in this case it should be assumes that fromCache signal is undefined. Null is returned in case of failure.
+ * @alpha
  */
-export declare type TokenFetcher<T> = (options: T) => Promise<string | TokenResponse | null>;
+export type TokenFetcher<T> = (options: T) => Promise<string | TokenResponse | null>;
 /**
  * Helper method which transforms return value for TokenFetcher method to token string
  * @param tokenResponse - return value for TokenFetcher method
  * @returns Token value
+ * @internal
  */
 export declare const tokenFromResponse: (tokenResponse: string | TokenResponse | null | undefined) => string | null;
 /**
@@ -62,13 +67,18 @@ export declare const tokenFromResponse: (tokenResponse: string | TokenResponse |
  * @param tokenResponse - return value for TokenFetcher method
  * @returns Value indicating whether response came from cache.
  * Undefined is returned when we could not determine the source of token.
+ * @internal
  */
 export declare const isTokenFromCache: (tokenResponse: string | TokenResponse | null) => boolean | undefined;
 /**
  * Identity types supported by ODSP driver.
- *  Consumer represents user authenticated with Microsoft Account (MSA)
- *  Enterprise represents user authenticated with M365 tenant account
+ * `Consumer` represents user authenticated with Microsoft Account (MSA).
+ * `Enterprise` represents user authenticated with M365 tenant account.
+ * @alpha
  */
-export declare type IdentityType = "Consumer" | "Enterprise";
-export declare type InstrumentedStorageTokenFetcher = (options: TokenFetchOptions, name: string, alwaysRecordTokenFetchTelemetry?: boolean) => Promise<string | null>;
+export type IdentityType = "Consumer" | "Enterprise";
+/**
+ * @internal
+ */
+export type InstrumentedStorageTokenFetcher = (options: TokenFetchOptions, name: string, alwaysRecordTokenFetchTelemetry?: boolean) => Promise<string | null>;
 //# sourceMappingURL=tokenFetch.d.ts.map

package/dist/tokenFetch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tokenFetch.d.ts","sourceRoot":"","sources":["../src/tokenFetch.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,kBAAkB;IAClB,KAAK,EAAE,MAAM,CAAC;IAEd,kEAAkE;IAClE,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,iBAAiB;IACpE,mDAAmD;IACnD,OAAO,EAAE,MAAM,CAAC;IAEhB,wGAAwG;IACxG,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,sGAAsG;IACtG,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;GAMG;AACH,oBAAY,YAAY,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,OAAO,CAAC,MAAM,GAAG,aAAa,GAAG,IAAI,CAAC,CAAC;AAErF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,kBAAmB,MAAM,GAAG,aAAa,GAAG,IAAI,GAAG,SAAS,KAAG,MAAM,GAAG,IAGpC,CAAC;AAEnE;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,kBAAmB,MAAM,GAAG,aAAa,GAAG,IAAI,KAAG,OAAO,GAAG,SAGzD,CAAC;AAElC;;;;GAIG;AACH,oBAAY,YAAY,GAAG,UAAU,GAAG,YAAY,CAAC;AAErD,oBAAY,+BAA+B,GAAG,CAC1C,OAAO,EAAE,iBAAiB,EAC1B,IAAI,EAAE,MAAM,EACZ,+BAA+B,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC"}
+{"version":3,"file":"tokenFetch.d.ts","sourceRoot":"","sources":["../src/tokenFetch.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B,kBAAkB;IAClB,KAAK,EAAE,MAAM,CAAC;IAEd,kEAAkE;IAClE,SAAS,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IACjC;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,6BAA8B,SAAQ,iBAAiB;IACvE,mDAAmD;IACnD,OAAO,EAAE,MAAM,CAAC;IAEhB,wGAAwG;IACxG,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,sGAAsG;IACtG,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,OAAO,CAAC,MAAM,GAAG,aAAa,GAAG,IAAI,CAAC,CAAC;AAErF;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,kBACd,MAAM,GAAG,aAAa,GAAG,IAAI,GAAG,SAAS,KACtD,MAAM,GAAG,IAKW,CAAC;AAExB;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,kBACb,MAAM,GAAG,aAAa,GAAG,IAAI,KAC1C,OAAO,GAAG,SAGc,CAAC;AAE5B;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,YAAY,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG,CAC7C,OAAO,EAAE,iBAAiB,EAC1B,IAAI,EAAE,MAAM,EACZ,+BAA+B,CAAC,EAAE,OAAO,KACrC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC"}

package/dist/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.38.3"
+    }
+  ]
+}

package/lib/errors.d.mts

@@ -0,0 +1,153 @@
+import { DriverError, IDriverErrorBase } from "@fluidframework/driver-definitions";
+/**
+ * ODSP Error types.
+ * Different error types that may be thrown by the ODSP driver.
+ * @alpha
+ */
+export declare const OdspErrorTypes: {
+    /**
+     * Invalid file name (at creation of the file)
+     */
+    readonly invalidFileNameError: "invalidFileNameError";
+    /**
+     * Snapshot is too big. Host application specified limit for snapshot size, and snapshot was bigger
+     * that that limit, thus request failed. Hosting application is expected to have fall-back behavior for
+     * such case.
+     */
+    readonly snapshotTooBig: "snapshotTooBig";
+    /**
+     * Maximum time limit to fetch reached. Host application specified limit for fetching of snapshot, when
+     * that limit is reached, request fails. Hosting application is expected to have fall-back behavior for
+     * such case.
+     */
+    readonly fetchTimeout: "fetchTimeout";
+    /**
+     * SPO admin toggle: fluid service is not enabled.
+     */
+    readonly fluidNotEnabled: "fluidNotEnabled";
+    /**
+     * This error will be raised when client is too behind with no way to catch up.
+     * This condition will happen when user was offline for too long, resulting in old ops / blobs being deleted
+     * by storage, and thus removing an ability for client to catch up.
+     * This condition will result in any local changes being lost (i.e. only way to save state is by user
+     * copying it over manually)
+     */
+    readonly cannotCatchUp: "cannotCatchUp";
+    /**
+     * SPO can occasionally return 403 for r/w operations on document when there is a fail over to another data center.
+     * So to preserve integrity of the data, the data becomes readonly.
+     */
+    readonly serviceReadOnly: "serviceReadOnly";
+    /**
+     * Due to organizational policies, you can't access server resources from the current network location.
+     */
+    readonly blockedIPAddress: "blockedIPAddress";
+    readonly genericNetworkError: "genericNetworkError";
+    readonly authorizationError: "authorizationError";
+    readonly fileNotFoundOrAccessDeniedError: "fileNotFoundOrAccessDeniedError";
+    readonly offlineError: "offlineError";
+    readonly unsupportedClientProtocolVersion: "unsupportedClientProtocolVersion";
+    readonly writeError: "writeError";
+    readonly fetchFailure: "fetchFailure";
+    readonly fetchTokenError: "fetchTokenError";
+    readonly incorrectServerResponse: "incorrectServerResponse";
+    readonly fileOverwrittenInStorage: "fileOverwrittenInStorage";
+    readonly deltaStreamConnectionForbidden: "deltaStreamConnectionForbidden";
+    readonly locationRedirection: "locationRedirection";
+    readonly fluidInvalidSchema: "fluidInvalidSchema";
+    readonly fileIsLocked: "fileIsLocked";
+    readonly outOfStorageError: "outOfStorageError";
+    readonly genericError: "genericError";
+    readonly throttlingError: "throttlingError";
+    readonly usageError: "usageError";
+};
+/**
+ * @alpha
+ */
+export type OdspErrorTypes = (typeof OdspErrorTypes)[keyof typeof OdspErrorTypes];
+/**
+ * ODSP Error types.
+ * Different error types that may be thrown by the ODSP driver.
+ *
+ * @deprecated Use {@link (OdspErrorTypes:variable)} instead.
+ * @alpha
+ */
+export declare enum OdspErrorType {
+    /**
+     * Storage is out of space
+     */
+    outOfStorageError = "outOfStorageError",
+    /**
+     * Invalid file name (at creation of the file)
+     */
+    invalidFileNameError = "invalidFileNameError",
+    /**
+     * Snapshot is too big. Host application specified limit for snapshot size, and snapshot was bigger
+     * that that limit, thus request failed. Hosting application is expected to have fall-back behavior for
+     * such case.
+     */
+    snapshotTooBig = "snapshotTooBig",
+    /**
+     * Maximum time limit to fetch reached. Host application specified limit for fetching of snapshot, when
+     * that limit is reached, request fails. Hosting application is expected to have fall-back behavior for
+     * such case.
+     */
+    fetchTimeout = "fetchTimeout",
+    /**
+     * SPO admin toggle: fluid service is not enabled.
+     */
+    fluidNotEnabled = "fluidNotEnabled",
+    /**
+     * {@inheritDoc @fluidframework/driver-definitions#FluidErrorType.fetchTokenError}
+     */
+    fetchTokenError = "fetchTokenError",
+    /**
+     * This error will be raised when client is too behind with no way to catch up.
+     * This condition will happen when user was offline for too long, resulting in old ops / blobs being deleted
+     * by storage, and thus removing an ability for client to catch up.
+     * This condition will result in any local changes being lost (i.e. only way to save state is by user
+     * copying it over manually)
+     */
+    cannotCatchUp = "cannotCatchUp",
+    /**
+     * SPO can occasionally return 403 for r/w operations on document when there is a fail over to another data center.
+     * So to preserve integrity of the data, the data becomes readonly.
+     */
+    serviceReadOnly = "serviceReadOnly",
+    /**
+     * Due to organizational policies, you can't access server resources from the current network location.
+     */
+    blockedIPAddress = "blockedIPAddress"
+}
+/**
+ * @alpha
+ */
+export interface IOdspErrorAugmentations {
+    /**
+     * Server epoch indicates when the file was last modified.
+     * Used to detect modifications outside Fluid's services
+     */
+    serverEpoch?: string;
+    /**
+     * It is the redirection url at which the network call should have been made. It is due to change
+     * in site domain of the file on server.
+     */
+    redirectLocation?: string;
+    /**
+     * It is array of error codes included in error response from server.
+     */
+    facetCodes?: string[];
+}
+/**
+ * Base interface for all errors and warnings
+ * Superset of IDriverErrorBase, but with Odsp-specific errorType and properties
+ * @alpha
+ */
+export interface IOdspError extends Omit<IDriverErrorBase, "errorType">, IOdspErrorAugmentations {
+    readonly errorType: OdspErrorType;
+}
+/**
+ * @alpha
+ */
+export type OdspError = IOdspError | (DriverError & IOdspErrorAugmentations);
+//# sourceMappingURL=errors.d.ts.map

package/lib/errors.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"OAIO,EACN,WAAW,EACX,gBAAgB,EAEhB,MAAM,oCAAoC;AAE3C;;;;GAIG;AACH,eAAO,MAAM,cAAc;IAI1B;;OAEG;;IAGH;;;;OAIG;;IAGH;;;;OAIG;;IAGH;;OAEG;;IAGH;;;;;;OAMG;;IAGH;;;OAGG;;IAGH;;OAEG;;;;;;;;;;;;;;;;;;;;CAEM,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,OAAO,cAAc,CAAC,CAAC;AAElF;;;;;;GAMG;AACH,oBAAY,aAAa;IACxB;;OAEG;IACH,iBAAiB,sBAAsB;IAEvC;;OAEG;IACH,oBAAoB,yBAAyB;IAE7C;;;;OAIG;IACH,cAAc,mBAAmB;IAEjC;;;;OAIG;IACH,YAAY,iBAAiB;IAE7B;;OAEG;IACH,eAAe,oBAAoB;IAEnC;;OAEG;IACH,eAAe,oBAAoB;IAEnC;;;;;;OAMG;IACH,aAAa,kBAAkB;IAE/B;;;OAGG;IACH,eAAe,oBAAoB;IAEnC;;OAEG;IACH,gBAAgB,qBAAqB;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAW,SAAQ,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC,EAAE,uBAAuB;IAC/F,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,UAAU,GAAG,CAAC,WAAW,GAAG,uBAAuB,CAAC,CAAC"}