npm - @fluidframework/odsp-driver-definitions - Versions diffs - 2.0.0-internal.6.3.2 → 2.0.0-internal.6.4.0 - Mend

@fluidframework/odsp-driver-definitions 2.0.0-internal.6.3.2 → 2.0.0-internal.6.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (27) hide show

package/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,9 @@
 # @fluidframework/odsp-driver-definitions
+## 2.0.0-internal.6.4.0
+Dependency updates only.
 ## 2.0.0-internal.6.3.0
 Dependency updates only.

package/dist/errors.d.ts CHANGED Viewed

@@ -7,6 +7,71 @@ import { DriverError, IDriverErrorBase } from "@fluidframework/driver-definition
  * ODSP Error types.
  * Different error types that may be thrown by the ODSP driver.
  */
+export declare const OdspErrorTypes: {
+    /**
+     * Storage is out of space
+     */
+    readonly outOfStorageError: "outOfStorageError";
+    /**
+     * 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";
+    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"; /**
+     * SPO admin toggle: fluid service is not enabled.
+     */
+    readonly fluidInvalidSchema: "fluidInvalidSchema";
+    readonly fileIsLocked: "fileIsLocked";
+    readonly genericError: "genericError";
+    readonly throttlingError: "throttlingError";
+    readonly usageError: "usageError";
+};
+export declare 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.
+ */
 export declare enum OdspErrorType {
     /**
      * Storage is out of space
@@ -32,6 +97,9 @@ export declare enum OdspErrorType {
      * 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.

package/dist/errors.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,~~EAAE~~,WAAW,~~EAAE~~,gBAAgB,~~EAAE~~,MAAM,oCAAoC,CAAC;~~AAEnF~~;;;GAGG;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,eAAe,oBAAoB;IAEnC;;;;;;OAMG;IACH,aAAa,kBAAkB;IAE/B;;;OAGG;IACH,eAAe,oBAAoB;CACnC;AAED,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;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC,EAAE,uBAAuB;IAC/F,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC;CAClC;AAED,oBAAY,SAAS,GAAG,UAAU,GAAG,CAAC,WAAW,GAAG,uBAAuB,CAAC,CAAC"}
1	+ {"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EACN,WAAW,EACX,gBAAgB,EAEhB,MAAM,oCAAoC,CAAC;AAE5C;;;GAGG;AACH,eAAO,MAAM,cAAc;IAI1B;;OAEG;;IAGH;;OAEG;;IAGH;;;;OAIG;;IAGH;;;;OAIG;;IAGH;;OAEG;;IAGH;;;;;;OAMG;;IAGH;;;OAGG;;;;;;;;;;;;;yDAoCH;;OAEG;;;;;;CApCM,CAAC;AACX,oBAAY,cAAc,GAAG,OAAO,cAAc,CAAC,MAAM,OAAO,cAAc,CAAC,CAAC;AAEhF;;;;;GAKG;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;CACnC;AAED,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;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC,EAAE,uBAAuB;IAC/F,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC;CAClC;AAED,oBAAY,SAAS,GAAG,UAAU,GAAG,CAAC,WAAW,GAAG,uBAAuB,CAAC,CAAC"}

package/dist/errors.js CHANGED Viewed

@@ -1,10 +1,62 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OdspErrorType = void 0;
+exports.OdspErrorType = exports.OdspErrorTypes = void 0;
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+const driver_definitions_1 = require("@fluidframework/driver-definitions");
 /**
  * ODSP Error types.
  * Different error types that may be thrown by the ODSP driver.
  */
+exports.OdspErrorTypes = {
+    // Inherit base driver error types
+    ...driver_definitions_1.DriverErrorTypes,
+    /**
+     * 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",
+    /**
+     * 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",
+};
+/**
+ * ODSP Error types.
+ * Different error types that may be thrown by the ODSP driver.
+ *
+ * @deprecated Use {@link (OdspErrorTypes:variable)} instead.
+ */
 var OdspErrorType;
 (function (OdspErrorType) {
     /**
@@ -31,6 +83,9 @@ var OdspErrorType;
      * SPO admin toggle: fluid service is not enabled.
      */
     OdspErrorType["fluidNotEnabled"] = "fluidNotEnabled";
+    /**
+     * {@inheritDoc @fluidframework/driver-definitions#FluidErrorType.fetchTokenError}
+     */
     OdspErrorType["fetchTokenError"] = "fetchTokenError";
     /**
      * This error will be raised when client is too behind with no way to catch up.

package/dist/errors.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;~~AAMA~~;;;GAGG;AACH,IAAY,~~aA8CX~~;~~AA9CD~~,WAAY,aAAa;IACxB;;OAEG;IACH,wDAAuC,CAAA;IAEvC;;OAEG;IACH,8DAA6C,CAAA;IAE7C;;;;OAIG;IACH,kDAAiC,CAAA;IAEjC;;;;OAIG;IACH,8CAA6B,CAAA;IAE7B;;OAEG;IACH,oDAAmC,CAAA;IAEnC,oDAAmC,CAAA;IAEnC;;;;;;OAMG;IACH,gDAA+B,CAAA;IAE/B;;;OAGG;IACH,oDAAmC,CAAA;AACpC,CAAC,~~EA9CW~~,aAAa,GAAb,qBAAa,KAAb,qBAAa,~~QA8CxB~~","sourcesContent":["/!\n Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n /\nimport { ~~DriverError, IDriverErrorBase~~ } from \"@fluidframework/driver-definitions\";\n\n/\n ODSP Error types.\n * Different error types that may be thrown by the ODSP driver.\n /\nexport enum OdspErrorType {\n\t/\n\t Storage is out of space\n\t /\n\toutOfStorageError = \"outOfStorageError\",\n\n\t/\n\t Invalid file name (at creation of the file)\n\t /\n\tinvalidFileNameError = \"invalidFileNameError\",\n\n\t/\n\t Snapshot is too big. Host application specified limit for snapshot size, and snapshot was bigger\n\t * that that limit, thus request failed. Hosting application is expected to have fall-back behavior for\n\t * such case.\n\t /\n\tsnapshotTooBig = \"snapshotTooBig\",\n\n\t/\n\t Maximum time limit to fetch reached. Host application specified limit for fetching of snapshot, when\n\t * that limit is reached, request fails. Hosting application is expected to have fall-back behavior for\n\t * such case.\n\t /\n\tfetchTimeout = \"fetchTimeout\",\n\n\t/\n\t SPO admin toggle: fluid service is not enabled.\n\t /\n\tfluidNotEnabled = \"fluidNotEnabled\",\n\n\tfetchTokenError = \"fetchTokenError\",\n\n\t/\n\t This error will be raised when client is too behind with no way to catch up.\n\t * This condition will happen when user was offline for too long, resulting in old ops / blobs being deleted\n\t * by storage, and thus removing an ability for client to catch up.\n\t * This condition will result in any local changes being lost (i.e. only way to save state is by user\n\t * copying it over manually)\n\t /\n\tcannotCatchUp = \"cannotCatchUp\",\n\n\t/\n\t SPO can occasionally return 403 for r/w operations on document when there is a fail over to another data center.\n\t * So to preserve integrity of the data, the data becomes readonly.\n\t /\n\tserviceReadOnly = \"serviceReadOnly\",\n}\n\nexport interface IOdspErrorAugmentations {\n\t/\n\t Server epoch indicates when the file was last modified.\n\t * Used to detect modifications outside Fluid's services\n\t /\n\tserverEpoch?: string;\n\n\t/\n\t It is the redirection url at which the network call should have been made. It is due to change\n\t * in site domain of the file on server.\n\t /\n\tredirectLocation?: string;\n\n\t/\n\t It is array of error codes included in error response from server.\n\t /\n\tfacetCodes?: string[];\n}\n\n/\n Base interface for all errors and warnings\n * Superset of IDriverErrorBase, but with Odsp-specific errorType and properties\n */\nexport interface IOdspError extends Omit<IDriverErrorBase, \"errorType\">, IOdspErrorAugmentations {\n\treadonly errorType: OdspErrorType;\n}\n\nexport type OdspError = IOdspError \| (DriverError & IOdspErrorAugmentations);\n"]}
1	+ {"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,2EAI4C;AAE5C;;;GAGG;AACU,QAAA,cAAc,GAAG;IAC7B,kCAAkC;IAClC,GAAG,qCAAgB;IAEnB;;OAEG;IACH,iBAAiB,EAAE,mBAAmB;IAEtC;;OAEG;IACH,oBAAoB,EAAE,sBAAsB;IAE5C;;;;OAIG;IACH,cAAc,EAAE,gBAAgB;IAEhC;;;;OAIG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,eAAe,EAAE,iBAAiB;IAElC;;;;;;OAMG;IACH,aAAa,EAAE,eAAe;IAE9B;;;OAGG;IACH,eAAe,EAAE,iBAAiB;CACzB,CAAC;AAGX;;;;;GAKG;AACH,IAAY,aAiDX;AAjDD,WAAY,aAAa;IACxB;;OAEG;IACH,wDAAuC,CAAA;IAEvC;;OAEG;IACH,8DAA6C,CAAA;IAE7C;;;;OAIG;IACH,kDAAiC,CAAA;IAEjC;;;;OAIG;IACH,8CAA6B,CAAA;IAE7B;;OAEG;IACH,oDAAmC,CAAA;IAEnC;;OAEG;IACH,oDAAmC,CAAA;IAEnC;;;;;;OAMG;IACH,gDAA+B,CAAA;IAE/B;;;OAGG;IACH,oDAAmC,CAAA;AACpC,CAAC,EAjDW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAiDxB","sourcesContent":["/!\n Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n /\nimport {\n\tDriverError,\n\tIDriverErrorBase,\n\tDriverErrorTypes,\n} from \"@fluidframework/driver-definitions\";\n\n/\n ODSP Error types.\n * Different error types that may be thrown by the ODSP driver.\n /\nexport const OdspErrorTypes = {\n\t// Inherit base driver error types\n\t...DriverErrorTypes,\n\n\t/\n\t Storage is out of space\n\t /\n\toutOfStorageError: \"outOfStorageError\",\n\n\t/\n\t Invalid file name (at creation of the file)\n\t /\n\tinvalidFileNameError: \"invalidFileNameError\",\n\n\t/\n\t Snapshot is too big. Host application specified limit for snapshot size, and snapshot was bigger\n\t * that that limit, thus request failed. Hosting application is expected to have fall-back behavior for\n\t * such case.\n\t /\n\tsnapshotTooBig: \"snapshotTooBig\",\n\n\t/\n\t Maximum time limit to fetch reached. Host application specified limit for fetching of snapshot, when\n\t * that limit is reached, request fails. Hosting application is expected to have fall-back behavior for\n\t * such case.\n\t /\n\tfetchTimeout: \"fetchTimeout\",\n\n\t/\n\t SPO admin toggle: fluid service is not enabled.\n\t /\n\tfluidNotEnabled: \"fluidNotEnabled\",\n\n\t/\n\t This error will be raised when client is too behind with no way to catch up.\n\t * This condition will happen when user was offline for too long, resulting in old ops / blobs being deleted\n\t * by storage, and thus removing an ability for client to catch up.\n\t * This condition will result in any local changes being lost (i.e. only way to save state is by user\n\t * copying it over manually)\n\t /\n\tcannotCatchUp: \"cannotCatchUp\",\n\n\t/\n\t SPO can occasionally return 403 for r/w operations on document when there is a fail over to another data center.\n\t * So to preserve integrity of the data, the data becomes readonly.\n\t /\n\tserviceReadOnly: \"serviceReadOnly\",\n} as const;\nexport type OdspErrorTypes = typeof OdspErrorTypes[keyof typeof OdspErrorTypes];\n\n/\n ODSP Error types.\n * Different error types that may be thrown by the ODSP driver.\n \n @deprecated Use {@link (OdspErrorTypes:variable)} instead.\n /\nexport enum OdspErrorType {\n\t/\n\t Storage is out of space\n\t /\n\toutOfStorageError = \"outOfStorageError\",\n\n\t/\n\t Invalid file name (at creation of the file)\n\t /\n\tinvalidFileNameError = \"invalidFileNameError\",\n\n\t/\n\t Snapshot is too big. Host application specified limit for snapshot size, and snapshot was bigger\n\t * that that limit, thus request failed. Hosting application is expected to have fall-back behavior for\n\t * such case.\n\t /\n\tsnapshotTooBig = \"snapshotTooBig\",\n\n\t/\n\t Maximum time limit to fetch reached. Host application specified limit for fetching of snapshot, when\n\t * that limit is reached, request fails. Hosting application is expected to have fall-back behavior for\n\t * such case.\n\t /\n\tfetchTimeout = \"fetchTimeout\",\n\n\t/\n\t SPO admin toggle: fluid service is not enabled.\n\t /\n\tfluidNotEnabled = \"fluidNotEnabled\",\n\n\t/\n\t {@inheritDoc @fluidframework/driver-definitions#FluidErrorType.fetchTokenError}\n\t /\n\tfetchTokenError = \"fetchTokenError\",\n\n\t/\n\t This error will be raised when client is too behind with no way to catch up.\n\t * This condition will happen when user was offline for too long, resulting in old ops / blobs being deleted\n\t * by storage, and thus removing an ability for client to catch up.\n\t * This condition will result in any local changes being lost (i.e. only way to save state is by user\n\t * copying it over manually)\n\t /\n\tcannotCatchUp = \"cannotCatchUp\",\n\n\t/\n\t SPO can occasionally return 403 for r/w operations on document when there is a fail over to another data center.\n\t * So to preserve integrity of the data, the data becomes readonly.\n\t /\n\tserviceReadOnly = \"serviceReadOnly\",\n}\n\nexport interface IOdspErrorAugmentations {\n\t/\n\t Server epoch indicates when the file was last modified.\n\t * Used to detect modifications outside Fluid's services\n\t /\n\tserverEpoch?: string;\n\n\t/\n\t It is the redirection url at which the network call should have been made. It is due to change\n\t * in site domain of the file on server.\n\t /\n\tredirectLocation?: string;\n\n\t/\n\t It is array of error codes included in error response from server.\n\t /\n\tfacetCodes?: string[];\n}\n\n/\n Base interface for all errors and warnings\n * Superset of IDriverErrorBase, but with Odsp-specific errorType and properties\n */\nexport interface IOdspError extends Omit<IDriverErrorBase, \"errorType\">, IOdspErrorAugmentations {\n\treadonly errorType: OdspErrorType;\n}\n\nexport type OdspError = IOdspError \| (DriverError & IOdspErrorAugmentations);\n"]}

package/dist/index.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export { IOdspError, IOdspErrorAugmentations, OdspError, OdspErrorType } from "./errors";
+export { IOdspError, IOdspErrorAugmentations, OdspError, OdspErrorType, OdspErrorTypes, } from "./errors";
 export { HostStoragePolicy, ICollabSessionOptions, IOpsCachingPolicy, ISnapshotOptions, } from "./factory";
 export { CacheContentType, getKeyForCacheEntry, ICacheEntry, IEntry, IFileEntry, IPersistedCache, snapshotKey, } from "./odspCache";
 export { IOdspResolvedUrl, IOdspUrlParts, ISharingLink, ISharingLinkKind, ShareLinkInfoType, ShareLinkTypes, SharingLinkRole, SharingLinkScope, } from "./resolvedUrl";

package/dist/index.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,~~EAAE~~,UAAU,~~EAAE~~,uBAAuB,~~EAAE~~,SAAS,~~EAAE~~,aAAa,~~EAAE~~,MAAM,UAAU,CAAC;~~AACzF~~,OAAO,EACN,iBAAiB,EACjB,qBAAqB,EACrB,iBAAiB,EACjB,gBAAgB,GAChB,MAAM,WAAW,CAAC;AACnB,OAAO,EACN,gBAAgB,EAChB,mBAAmB,EACnB,WAAW,EACX,MAAM,EACN,UAAU,EACV,eAAe,EACf,WAAW,GACX,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,gBAAgB,EAChB,aAAa,EACb,YAAY,EACZ,gBAAgB,EAChB,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,gBAAgB,GAChB,MAAM,eAAe,CAAC;AACvB,OAAO,EACN,YAAY,EACZ,+BAA+B,EAC/B,gBAAgB,EAChB,6BAA6B,EAC7B,YAAY,EACZ,iBAAiB,EACjB,iBAAiB,EACjB,aAAa,GACb,MAAM,cAAc,CAAC;AACtB,OAAO,EACN,iCAAiC,EACjC,+BAA+B,EAC/B,uBAAuB,GACvB,MAAM,mBAAmB,CAAC"}
1	+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,UAAU,EACV,uBAAuB,EACvB,SAAS,EACT,aAAa,EACb,cAAc,GACd,MAAM,UAAU,CAAC;AAClB,OAAO,EACN,iBAAiB,EACjB,qBAAqB,EACrB,iBAAiB,EACjB,gBAAgB,GAChB,MAAM,WAAW,CAAC;AACnB,OAAO,EACN,gBAAgB,EAChB,mBAAmB,EACnB,WAAW,EACX,MAAM,EACN,UAAU,EACV,eAAe,EACf,WAAW,GACX,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,gBAAgB,EAChB,aAAa,EACb,YAAY,EACZ,gBAAgB,EAChB,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,gBAAgB,GAChB,MAAM,eAAe,CAAC;AACvB,OAAO,EACN,YAAY,EACZ,+BAA+B,EAC/B,gBAAgB,EAChB,6BAA6B,EAC7B,YAAY,EACZ,iBAAiB,EACjB,iBAAiB,EACjB,aAAa,GACb,MAAM,cAAc,CAAC;AACtB,OAAO,EACN,iCAAiC,EACjC,+BAA+B,EAC/B,uBAAuB,GACvB,MAAM,mBAAmB,CAAC"}

package/dist/index.js CHANGED Viewed

@@ -4,9 +4,10 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.tokenFromResponse = exports.isTokenFromCache = exports.SharingLinkScope = exports.SharingLinkRole = exports.ShareLinkTypes = exports.snapshotKey = exports.getKeyForCacheEntry = exports.OdspErrorType = void 0;
+exports.tokenFromResponse = exports.isTokenFromCache = exports.SharingLinkScope = exports.SharingLinkRole = exports.ShareLinkTypes = exports.snapshotKey = exports.getKeyForCacheEntry = exports.OdspErrorTypes = exports.OdspErrorType = void 0;
 var errors_1 = require("./errors");
 Object.defineProperty(exports, "OdspErrorType", { enumerable: true, get: function () { return errors_1.OdspErrorType; } });
+Object.defineProperty(exports, "OdspErrorTypes", { enumerable: true, get: function () { return errors_1.OdspErrorTypes; } });
 var odspCache_1 = require("./odspCache");
 Object.defineProperty(exports, "getKeyForCacheEntry", { enumerable: true, get: function () { return odspCache_1.getKeyForCacheEntry; } });
 Object.defineProperty(exports, "snapshotKey", { enumerable: true, get: function () { return odspCache_1.snapshotKey; } });

package/dist/index.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,~~mCAAyF~~;~~AAAhC~~,uGAAA,aAAa,OAAA;~~AAOtE~~,yCAQqB;AANpB,gHAAA,mBAAmB,OAAA;AAKnB,wGAAA,WAAW,OAAA;AAEZ,6CASuB;AAHtB,6GAAA,cAAc,OAAA;AACd,8GAAA,eAAe,OAAA;AACf,+GAAA,gBAAgB,OAAA;AAEjB,2CASsB;AANrB,8GAAA,gBAAgB,OAAA;AAIhB,+GAAA,iBAAiB,OAAA","sourcesContent":["/!\n Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { ~~IOdspError, IOdspErrorAugmentations, OdspError, OdspErrorType~~ } from \"./errors\";\nexport {\n\tHostStoragePolicy,\n\tICollabSessionOptions,\n\tIOpsCachingPolicy,\n\tISnapshotOptions,\n} from \"./factory\";\nexport {\n\tCacheContentType,\n\tgetKeyForCacheEntry,\n\tICacheEntry,\n\tIEntry,\n\tIFileEntry,\n\tIPersistedCache,\n\tsnapshotKey,\n} from \"./odspCache\";\nexport {\n\tIOdspResolvedUrl,\n\tIOdspUrlParts,\n\tISharingLink,\n\tISharingLinkKind,\n\tShareLinkInfoType,\n\tShareLinkTypes,\n\tSharingLinkRole,\n\tSharingLinkScope,\n} from \"./resolvedUrl\";\nexport {\n\tIdentityType,\n\tInstrumentedStorageTokenFetcher,\n\tisTokenFromCache,\n\tOdspResourceTokenFetchOptions,\n\tTokenFetcher,\n\tTokenFetchOptions,\n\ttokenFromResponse,\n\tTokenResponse,\n} from \"./tokenFetch\";\nexport {\n\tIProvideSessionAwareDriverFactory,\n\tIRelaySessionAwareDriverFactory,\n\tISocketStorageDiscovery,\n} from \"./sessionProvider\";\n"]}
1	+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,mCAMkB;AAFjB,uGAAA,aAAa,OAAA;AACb,wGAAA,cAAc,OAAA;AAQf,yCAQqB;AANpB,gHAAA,mBAAmB,OAAA;AAKnB,wGAAA,WAAW,OAAA;AAEZ,6CASuB;AAHtB,6GAAA,cAAc,OAAA;AACd,8GAAA,eAAe,OAAA;AACf,+GAAA,gBAAgB,OAAA;AAEjB,2CASsB;AANrB,8GAAA,gBAAgB,OAAA;AAIhB,+GAAA,iBAAiB,OAAA","sourcesContent":["/!\n Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tIOdspError,\n\tIOdspErrorAugmentations,\n\tOdspError,\n\tOdspErrorType,\n\tOdspErrorTypes,\n} from \"./errors\";\nexport {\n\tHostStoragePolicy,\n\tICollabSessionOptions,\n\tIOpsCachingPolicy,\n\tISnapshotOptions,\n} from \"./factory\";\nexport {\n\tCacheContentType,\n\tgetKeyForCacheEntry,\n\tICacheEntry,\n\tIEntry,\n\tIFileEntry,\n\tIPersistedCache,\n\tsnapshotKey,\n} from \"./odspCache\";\nexport {\n\tIOdspResolvedUrl,\n\tIOdspUrlParts,\n\tISharingLink,\n\tISharingLinkKind,\n\tShareLinkInfoType,\n\tShareLinkTypes,\n\tSharingLinkRole,\n\tSharingLinkScope,\n} from \"./resolvedUrl\";\nexport {\n\tIdentityType,\n\tInstrumentedStorageTokenFetcher,\n\tisTokenFromCache,\n\tOdspResourceTokenFetchOptions,\n\tTokenFetcher,\n\tTokenFetchOptions,\n\ttokenFromResponse,\n\tTokenResponse,\n} from \"./tokenFetch\";\nexport {\n\tIProvideSessionAwareDriverFactory,\n\tIRelaySessionAwareDriverFactory,\n\tISocketStorageDiscovery,\n} from \"./sessionProvider\";\n"]}

package/dist/odspCache.d.ts CHANGED Viewed

@@ -81,7 +81,7 @@ export interface IPersistedCache {
 /**
  * Api to generate a cache key from cache entry.
  * @param entry - cache entry from which a cache key is generated
- * @returns - key for cache.
+ * @returns The key for cache.
  */
 export declare function getKeyForCacheEntry(entry: ICacheEntry): string;
 //# sourceMappingURL=odspCache.d.ts.map

package/dist/odspCache.js CHANGED Viewed

@@ -12,7 +12,7 @@ exports.snapshotKey = "snapshot";
 /**
  * Api to generate a cache key from cache entry.
  * @param entry - cache entry from which a cache key is generated
- * @returns - key for cache.
+ * @returns The key for cache.
  */
 function getKeyForCacheEntry(entry) {
     return `${entry.file.docId}_${entry.type}_${entry.key}`;

package/dist/odspCache.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"odspCache.js","sourceRoot":"","sources":["../src/odspCache.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;GAEG;AACU,QAAA,WAAW,GAAG,UAAU,CAAC;AAqFtC;;;;GAIG;AACH,SAAgB,mBAAmB,CAAC,KAAkB;IACrD,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC;AACzD,CAAC;AAFD,kDAEC","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 Describes what kind of content is stored in cache entry.\n /\nexport const snapshotKey = \"snapshot\";\nexport type CacheContentType = \"snapshot\" \| \"ops\";\n\n/\n * File / container identifier.\n * There is overlapping information here - host can use all of it or parts\n * to implement storage / identify files.\n /\nexport interface IFileEntry {\n\t/\n\t Unique and stable ID of the document.\n\t * Driver guarantees that docId is stable ID uniquely identifying document.\n\t /\n\tdocId: string;\n\t/\n\t Resolved URI is provided for additional versatility - host can use it to\n\t * identify file in storage, and (as example) delete all cached entries for\n\t * a file if user requests so.\n\t * This is IOdspResolvedUrl in case of ODSP driver.\n\t /\n\tresolvedUrl: IResolvedUrl;\n}\n\n/\n Cache entry. Identifies file that this entry belongs to, and type of content stored in it.\n /\nexport interface IEntry {\n\t/\n\t Identifies type of entry for a given file.\n\t * Each file can have multiple types of entries associated with it.\n\t * For example, it can be snapshot, blob, ops, etc.\n\t /\n\ttype: CacheContentType;\n\n\t/\n\t Identifies individual entry for a given file and type.\n\t * Each file can have multiple cache entries associated with it.\n\t * This property identifies a particular instance of entry.\n\t * For example, for blobs it will be unique ID of the blob in a file.\n\t * For batch of ops, it can be starting op sequence number.\n\t * For types that have only one entry (like snapshots), it will be empty string.\n\t /\n\tkey: string;\n}\n\n/\n Cache entry. Identifies file that this entry belongs to, and type of content stored in it.\n /\nexport interface ICacheEntry extends IEntry {\n\t/\n\t Identifies file in storage this cached entry is for\n\t /\n\tfile: IFileEntry;\n}\n\n/\n Persistent cache. This interface can be implemented by the host to provide durable caching\n * across sessions. If not provided at driver factory construction, factory will use in-memory\n * cache implementation that does not survive across sessions. Snapshot entires stored in the\n * IPersistedCache will be considered stale and removed after 2 days. Read the README for more\n * information.\n /\nexport interface IPersistedCache {\n\t/\n\t Get the cache value of the key\n\t * @param entry - cache entry, identifies file and particular key for this file.\n\t * @returns Cached value. undefined if nothing is cached.\n\t /\n\tget(entry: ICacheEntry): Promise<any>;\n\n\t/\n\t Put the value into cache.\n\t * Important - only serializable content is allowed since this cache may be persisted between sessions\n\t * @param entry - cache entry.\n\t * @param value - JSON-serializable content.\n\t /\n\tput(entry: ICacheEntry, value: any): Promise<void>;\n\n\t/\n\t Removes the entries from the cache for given parametres.\n\t * @param file - file entry to be deleted.\n\t /\n\tremoveEntries(file: IFileEntry): Promise<void>;\n}\n\n/\n Api to generate a cache key from cache entry.\n * @param entry - cache entry from which a cache key is generated\n * @returns - key for cache.\n */\nexport function getKeyForCacheEntry(entry: ICacheEntry): string {\n\treturn `${entry.file.docId}_${entry.type}_${entry.key}`;\n}\n"]}
1	+ {"version":3,"file":"odspCache.js","sourceRoot":"","sources":["../src/odspCache.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;GAEG;AACU,QAAA,WAAW,GAAG,UAAU,CAAC;AAqFtC;;;;GAIG;AACH,SAAgB,mBAAmB,CAAC,KAAkB;IACrD,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC;AACzD,CAAC;AAFD,kDAEC","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 Describes what kind of content is stored in cache entry.\n /\nexport const snapshotKey = \"snapshot\";\nexport type CacheContentType = \"snapshot\" \| \"ops\";\n\n/\n * File / container identifier.\n * There is overlapping information here - host can use all of it or parts\n * to implement storage / identify files.\n /\nexport interface IFileEntry {\n\t/\n\t Unique and stable ID of the document.\n\t * Driver guarantees that docId is stable ID uniquely identifying document.\n\t /\n\tdocId: string;\n\t/\n\t Resolved URI is provided for additional versatility - host can use it to\n\t * identify file in storage, and (as example) delete all cached entries for\n\t * a file if user requests so.\n\t * This is IOdspResolvedUrl in case of ODSP driver.\n\t /\n\tresolvedUrl: IResolvedUrl;\n}\n\n/\n Cache entry. Identifies file that this entry belongs to, and type of content stored in it.\n /\nexport interface IEntry {\n\t/\n\t Identifies type of entry for a given file.\n\t * Each file can have multiple types of entries associated with it.\n\t * For example, it can be snapshot, blob, ops, etc.\n\t /\n\ttype: CacheContentType;\n\n\t/\n\t Identifies individual entry for a given file and type.\n\t * Each file can have multiple cache entries associated with it.\n\t * This property identifies a particular instance of entry.\n\t * For example, for blobs it will be unique ID of the blob in a file.\n\t * For batch of ops, it can be starting op sequence number.\n\t * For types that have only one entry (like snapshots), it will be empty string.\n\t /\n\tkey: string;\n}\n\n/\n Cache entry. Identifies file that this entry belongs to, and type of content stored in it.\n /\nexport interface ICacheEntry extends IEntry {\n\t/\n\t Identifies file in storage this cached entry is for\n\t /\n\tfile: IFileEntry;\n}\n\n/\n Persistent cache. This interface can be implemented by the host to provide durable caching\n * across sessions. If not provided at driver factory construction, factory will use in-memory\n * cache implementation that does not survive across sessions. Snapshot entires stored in the\n * IPersistedCache will be considered stale and removed after 2 days. Read the README for more\n * information.\n /\nexport interface IPersistedCache {\n\t/\n\t Get the cache value of the key\n\t * @param entry - cache entry, identifies file and particular key for this file.\n\t * @returns Cached value. undefined if nothing is cached.\n\t /\n\tget(entry: ICacheEntry): Promise<any>;\n\n\t/\n\t Put the value into cache.\n\t * Important - only serializable content is allowed since this cache may be persisted between sessions\n\t * @param entry - cache entry.\n\t * @param value - JSON-serializable content.\n\t /\n\tput(entry: ICacheEntry, value: any): Promise<void>;\n\n\t/\n\t Removes the entries from the cache for given parametres.\n\t * @param file - file entry to be deleted.\n\t /\n\tremoveEntries(file: IFileEntry): Promise<void>;\n}\n\n/\n Api to generate a cache key from cache entry.\n * @param entry - cache entry from which a cache key is generated\n * @returns The key for cache.\n */\nexport function getKeyForCacheEntry(entry: ICacheEntry): string {\n\treturn `${entry.file.docId}_${entry.type}_${entry.key}`;\n}\n"]}

package/lib/errors.d.ts CHANGED Viewed

@@ -7,6 +7,71 @@ import { DriverError, IDriverErrorBase } from "@fluidframework/driver-definition
  * ODSP Error types.
  * Different error types that may be thrown by the ODSP driver.
  */
+export declare const OdspErrorTypes: {
+    /**
+     * Storage is out of space
+     */
+    readonly outOfStorageError: "outOfStorageError";
+    /**
+     * 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";
+    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"; /**
+     * SPO admin toggle: fluid service is not enabled.
+     */
+    readonly fluidInvalidSchema: "fluidInvalidSchema";
+    readonly fileIsLocked: "fileIsLocked";
+    readonly genericError: "genericError";
+    readonly throttlingError: "throttlingError";
+    readonly usageError: "usageError";
+};
+export declare 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.
+ */
 export declare enum OdspErrorType {
     /**
      * Storage is out of space
@@ -32,6 +97,9 @@ export declare enum OdspErrorType {
      * 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.

package/lib/errors.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,~~EAAE~~,WAAW,~~EAAE~~,gBAAgB,~~EAAE~~,MAAM,oCAAoC,CAAC;~~AAEnF~~;;;GAGG;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,eAAe,oBAAoB;IAEnC;;;;;;OAMG;IACH,aAAa,kBAAkB;IAE/B;;;OAGG;IACH,eAAe,oBAAoB;CACnC;AAED,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;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC,EAAE,uBAAuB;IAC/F,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC;CAClC;AAED,oBAAY,SAAS,GAAG,UAAU,GAAG,CAAC,WAAW,GAAG,uBAAuB,CAAC,CAAC"}
1	+ {"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EACN,WAAW,EACX,gBAAgB,EAEhB,MAAM,oCAAoC,CAAC;AAE5C;;;GAGG;AACH,eAAO,MAAM,cAAc;IAI1B;;OAEG;;IAGH;;OAEG;;IAGH;;;;OAIG;;IAGH;;;;OAIG;;IAGH;;OAEG;;IAGH;;;;;;OAMG;;IAGH;;;OAGG;;;;;;;;;;;;;yDAoCH;;OAEG;;;;;;CApCM,CAAC;AACX,oBAAY,cAAc,GAAG,OAAO,cAAc,CAAC,MAAM,OAAO,cAAc,CAAC,CAAC;AAEhF;;;;;GAKG;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;CACnC;AAED,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;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC,EAAE,uBAAuB;IAC/F,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC;CAClC;AAED,oBAAY,SAAS,GAAG,UAAU,GAAG,CAAC,WAAW,GAAG,uBAAuB,CAAC,CAAC"}

package/lib/errors.js CHANGED Viewed

@@ -1,7 +1,59 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { DriverErrorTypes, } from "@fluidframework/driver-definitions";
 /**
  * ODSP Error types.
  * Different error types that may be thrown by the ODSP driver.
  */
+export const OdspErrorTypes = {
+    // Inherit base driver error types
+    ...DriverErrorTypes,
+    /**
+     * 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",
+    /**
+     * 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",
+};
+/**
+ * ODSP Error types.
+ * Different error types that may be thrown by the ODSP driver.
+ *
+ * @deprecated Use {@link (OdspErrorTypes:variable)} instead.
+ */
 export var OdspErrorType;
 (function (OdspErrorType) {
     /**
@@ -28,6 +80,9 @@ export var OdspErrorType;
      * SPO admin toggle: fluid service is not enabled.
      */
     OdspErrorType["fluidNotEnabled"] = "fluidNotEnabled";
+    /**
+     * {@inheritDoc @fluidframework/driver-definitions#FluidErrorType.fetchTokenError}
+     */
     OdspErrorType["fetchTokenError"] = "fetchTokenError";
     /**
      * This error will be raised when client is too behind with no way to catch up.

package/lib/errors.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"~~AAMA~~;;;GAGG;AACH,MAAM,CAAN,IAAY,~~aA8CX~~;~~AA9CD~~,WAAY,aAAa;IACxB;;OAEG;IACH,wDAAuC,CAAA;IAEvC;;OAEG;IACH,8DAA6C,CAAA;IAE7C;;;;OAIG;IACH,kDAAiC,CAAA;IAEjC;;;;OAIG;IACH,8CAA6B,CAAA;IAE7B;;OAEG;IACH,oDAAmC,CAAA;IAEnC,oDAAmC,CAAA;IAEnC;;;;;;OAMG;IACH,gDAA+B,CAAA;IAE/B;;;OAGG;IACH,oDAAmC,CAAA;AACpC,CAAC,~~EA9CW~~,aAAa,KAAb,aAAa,~~QA8CxB~~","sourcesContent":["/!\n Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n /\nimport { ~~DriverError, IDriverErrorBase~~ } from \"@fluidframework/driver-definitions\";\n\n/\n ODSP Error types.\n * Different error types that may be thrown by the ODSP driver.\n /\nexport enum OdspErrorType {\n\t/\n\t Storage is out of space\n\t /\n\toutOfStorageError = \"outOfStorageError\",\n\n\t/\n\t Invalid file name (at creation of the file)\n\t /\n\tinvalidFileNameError = \"invalidFileNameError\",\n\n\t/\n\t Snapshot is too big. Host application specified limit for snapshot size, and snapshot was bigger\n\t * that that limit, thus request failed. Hosting application is expected to have fall-back behavior for\n\t * such case.\n\t /\n\tsnapshotTooBig = \"snapshotTooBig\",\n\n\t/\n\t Maximum time limit to fetch reached. Host application specified limit for fetching of snapshot, when\n\t * that limit is reached, request fails. Hosting application is expected to have fall-back behavior for\n\t * such case.\n\t /\n\tfetchTimeout = \"fetchTimeout\",\n\n\t/\n\t SPO admin toggle: fluid service is not enabled.\n\t /\n\tfluidNotEnabled = \"fluidNotEnabled\",\n\n\tfetchTokenError = \"fetchTokenError\",\n\n\t/\n\t This error will be raised when client is too behind with no way to catch up.\n\t * This condition will happen when user was offline for too long, resulting in old ops / blobs being deleted\n\t * by storage, and thus removing an ability for client to catch up.\n\t * This condition will result in any local changes being lost (i.e. only way to save state is by user\n\t * copying it over manually)\n\t /\n\tcannotCatchUp = \"cannotCatchUp\",\n\n\t/\n\t SPO can occasionally return 403 for r/w operations on document when there is a fail over to another data center.\n\t * So to preserve integrity of the data, the data becomes readonly.\n\t /\n\tserviceReadOnly = \"serviceReadOnly\",\n}\n\nexport interface IOdspErrorAugmentations {\n\t/\n\t Server epoch indicates when the file was last modified.\n\t * Used to detect modifications outside Fluid's services\n\t /\n\tserverEpoch?: string;\n\n\t/\n\t It is the redirection url at which the network call should have been made. It is due to change\n\t * in site domain of the file on server.\n\t /\n\tredirectLocation?: string;\n\n\t/\n\t It is array of error codes included in error response from server.\n\t /\n\tfacetCodes?: string[];\n}\n\n/\n Base interface for all errors and warnings\n * Superset of IDriverErrorBase, but with Odsp-specific errorType and properties\n */\nexport interface IOdspError extends Omit<IDriverErrorBase, \"errorType\">, IOdspErrorAugmentations {\n\treadonly errorType: OdspErrorType;\n}\n\nexport type OdspError = IOdspError \| (DriverError & IOdspErrorAugmentations);\n"]}
1	+ {"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAGN,gBAAgB,GAChB,MAAM,oCAAoC,CAAC;AAE5C;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC7B,kCAAkC;IAClC,GAAG,gBAAgB;IAEnB;;OAEG;IACH,iBAAiB,EAAE,mBAAmB;IAEtC;;OAEG;IACH,oBAAoB,EAAE,sBAAsB;IAE5C;;;;OAIG;IACH,cAAc,EAAE,gBAAgB;IAEhC;;;;OAIG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,eAAe,EAAE,iBAAiB;IAElC;;;;;;OAMG;IACH,aAAa,EAAE,eAAe;IAE9B;;;OAGG;IACH,eAAe,EAAE,iBAAiB;CACzB,CAAC;AAGX;;;;;GAKG;AACH,MAAM,CAAN,IAAY,aAiDX;AAjDD,WAAY,aAAa;IACxB;;OAEG;IACH,wDAAuC,CAAA;IAEvC;;OAEG;IACH,8DAA6C,CAAA;IAE7C;;;;OAIG;IACH,kDAAiC,CAAA;IAEjC;;;;OAIG;IACH,8CAA6B,CAAA;IAE7B;;OAEG;IACH,oDAAmC,CAAA;IAEnC;;OAEG;IACH,oDAAmC,CAAA;IAEnC;;;;;;OAMG;IACH,gDAA+B,CAAA;IAE/B;;;OAGG;IACH,oDAAmC,CAAA;AACpC,CAAC,EAjDW,aAAa,KAAb,aAAa,QAiDxB","sourcesContent":["/!\n Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n /\nimport {\n\tDriverError,\n\tIDriverErrorBase,\n\tDriverErrorTypes,\n} from \"@fluidframework/driver-definitions\";\n\n/\n ODSP Error types.\n * Different error types that may be thrown by the ODSP driver.\n /\nexport const OdspErrorTypes = {\n\t// Inherit base driver error types\n\t...DriverErrorTypes,\n\n\t/\n\t Storage is out of space\n\t /\n\toutOfStorageError: \"outOfStorageError\",\n\n\t/\n\t Invalid file name (at creation of the file)\n\t /\n\tinvalidFileNameError: \"invalidFileNameError\",\n\n\t/\n\t Snapshot is too big. Host application specified limit for snapshot size, and snapshot was bigger\n\t * that that limit, thus request failed. Hosting application is expected to have fall-back behavior for\n\t * such case.\n\t /\n\tsnapshotTooBig: \"snapshotTooBig\",\n\n\t/\n\t Maximum time limit to fetch reached. Host application specified limit for fetching of snapshot, when\n\t * that limit is reached, request fails. Hosting application is expected to have fall-back behavior for\n\t * such case.\n\t /\n\tfetchTimeout: \"fetchTimeout\",\n\n\t/\n\t SPO admin toggle: fluid service is not enabled.\n\t /\n\tfluidNotEnabled: \"fluidNotEnabled\",\n\n\t/\n\t This error will be raised when client is too behind with no way to catch up.\n\t * This condition will happen when user was offline for too long, resulting in old ops / blobs being deleted\n\t * by storage, and thus removing an ability for client to catch up.\n\t * This condition will result in any local changes being lost (i.e. only way to save state is by user\n\t * copying it over manually)\n\t /\n\tcannotCatchUp: \"cannotCatchUp\",\n\n\t/\n\t SPO can occasionally return 403 for r/w operations on document when there is a fail over to another data center.\n\t * So to preserve integrity of the data, the data becomes readonly.\n\t /\n\tserviceReadOnly: \"serviceReadOnly\",\n} as const;\nexport type OdspErrorTypes = typeof OdspErrorTypes[keyof typeof OdspErrorTypes];\n\n/\n ODSP Error types.\n * Different error types that may be thrown by the ODSP driver.\n \n @deprecated Use {@link (OdspErrorTypes:variable)} instead.\n /\nexport enum OdspErrorType {\n\t/\n\t Storage is out of space\n\t /\n\toutOfStorageError = \"outOfStorageError\",\n\n\t/\n\t Invalid file name (at creation of the file)\n\t /\n\tinvalidFileNameError = \"invalidFileNameError\",\n\n\t/\n\t Snapshot is too big. Host application specified limit for snapshot size, and snapshot was bigger\n\t * that that limit, thus request failed. Hosting application is expected to have fall-back behavior for\n\t * such case.\n\t /\n\tsnapshotTooBig = \"snapshotTooBig\",\n\n\t/\n\t Maximum time limit to fetch reached. Host application specified limit for fetching of snapshot, when\n\t * that limit is reached, request fails. Hosting application is expected to have fall-back behavior for\n\t * such case.\n\t /\n\tfetchTimeout = \"fetchTimeout\",\n\n\t/\n\t SPO admin toggle: fluid service is not enabled.\n\t /\n\tfluidNotEnabled = \"fluidNotEnabled\",\n\n\t/\n\t {@inheritDoc @fluidframework/driver-definitions#FluidErrorType.fetchTokenError}\n\t /\n\tfetchTokenError = \"fetchTokenError\",\n\n\t/\n\t This error will be raised when client is too behind with no way to catch up.\n\t * This condition will happen when user was offline for too long, resulting in old ops / blobs being deleted\n\t * by storage, and thus removing an ability for client to catch up.\n\t * This condition will result in any local changes being lost (i.e. only way to save state is by user\n\t * copying it over manually)\n\t /\n\tcannotCatchUp = \"cannotCatchUp\",\n\n\t/\n\t SPO can occasionally return 403 for r/w operations on document when there is a fail over to another data center.\n\t * So to preserve integrity of the data, the data becomes readonly.\n\t /\n\tserviceReadOnly = \"serviceReadOnly\",\n}\n\nexport interface IOdspErrorAugmentations {\n\t/\n\t Server epoch indicates when the file was last modified.\n\t * Used to detect modifications outside Fluid's services\n\t /\n\tserverEpoch?: string;\n\n\t/\n\t It is the redirection url at which the network call should have been made. It is due to change\n\t * in site domain of the file on server.\n\t /\n\tredirectLocation?: string;\n\n\t/\n\t It is array of error codes included in error response from server.\n\t /\n\tfacetCodes?: string[];\n}\n\n/\n Base interface for all errors and warnings\n * Superset of IDriverErrorBase, but with Odsp-specific errorType and properties\n */\nexport interface IOdspError extends Omit<IDriverErrorBase, \"errorType\">, IOdspErrorAugmentations {\n\treadonly errorType: OdspErrorType;\n}\n\nexport type OdspError = IOdspError \| (DriverError & IOdspErrorAugmentations);\n"]}

package/lib/index.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export { IOdspError, IOdspErrorAugmentations, OdspError, OdspErrorType } from "./errors";
+export { IOdspError, IOdspErrorAugmentations, OdspError, OdspErrorType, OdspErrorTypes, } from "./errors";
 export { HostStoragePolicy, ICollabSessionOptions, IOpsCachingPolicy, ISnapshotOptions, } from "./factory";
 export { CacheContentType, getKeyForCacheEntry, ICacheEntry, IEntry, IFileEntry, IPersistedCache, snapshotKey, } from "./odspCache";
 export { IOdspResolvedUrl, IOdspUrlParts, ISharingLink, ISharingLinkKind, ShareLinkInfoType, ShareLinkTypes, SharingLinkRole, SharingLinkScope, } from "./resolvedUrl";

package/lib/index.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,~~EAAE~~,UAAU,~~EAAE~~,uBAAuB,~~EAAE~~,SAAS,~~EAAE~~,aAAa,~~EAAE~~,MAAM,UAAU,CAAC;~~AACzF~~,OAAO,EACN,iBAAiB,EACjB,qBAAqB,EACrB,iBAAiB,EACjB,gBAAgB,GAChB,MAAM,WAAW,CAAC;AACnB,OAAO,EACN,gBAAgB,EAChB,mBAAmB,EACnB,WAAW,EACX,MAAM,EACN,UAAU,EACV,eAAe,EACf,WAAW,GACX,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,gBAAgB,EAChB,aAAa,EACb,YAAY,EACZ,gBAAgB,EAChB,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,gBAAgB,GAChB,MAAM,eAAe,CAAC;AACvB,OAAO,EACN,YAAY,EACZ,+BAA+B,EAC/B,gBAAgB,EAChB,6BAA6B,EAC7B,YAAY,EACZ,iBAAiB,EACjB,iBAAiB,EACjB,aAAa,GACb,MAAM,cAAc,CAAC;AACtB,OAAO,EACN,iCAAiC,EACjC,+BAA+B,EAC/B,uBAAuB,GACvB,MAAM,mBAAmB,CAAC"}
1	+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,UAAU,EACV,uBAAuB,EACvB,SAAS,EACT,aAAa,EACb,cAAc,GACd,MAAM,UAAU,CAAC;AAClB,OAAO,EACN,iBAAiB,EACjB,qBAAqB,EACrB,iBAAiB,EACjB,gBAAgB,GAChB,MAAM,WAAW,CAAC;AACnB,OAAO,EACN,gBAAgB,EAChB,mBAAmB,EACnB,WAAW,EACX,MAAM,EACN,UAAU,EACV,eAAe,EACf,WAAW,GACX,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,gBAAgB,EAChB,aAAa,EACb,YAAY,EACZ,gBAAgB,EAChB,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,gBAAgB,GAChB,MAAM,eAAe,CAAC;AACvB,OAAO,EACN,YAAY,EACZ,+BAA+B,EAC/B,gBAAgB,EAChB,6BAA6B,EAC7B,YAAY,EACZ,iBAAiB,EACjB,iBAAiB,EACjB,aAAa,GACb,MAAM,cAAc,CAAC;AACtB,OAAO,EACN,iCAAiC,EACjC,+BAA+B,EAC/B,uBAAuB,GACvB,MAAM,mBAAmB,CAAC"}

package/lib/index.js CHANGED Viewed

@@ -2,7 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export { OdspErrorType } from "./errors";
+export { OdspErrorType, OdspErrorTypes, } from "./errors";
 export { getKeyForCacheEntry, snapshotKey, } from "./odspCache";
 export { ShareLinkTypes, SharingLinkRole, SharingLinkScope, } from "./resolvedUrl";
 export { isTokenFromCache, tokenFromResponse, } from "./tokenFetch";

package/lib/index.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,~~EAAkD~~,aAAa,~~EAAE~~,MAAM,UAAU,CAAC;~~AAOzF~~,OAAO,EAEN,mBAAmB,EAKnB,WAAW,GACX,MAAM,aAAa,CAAC;AACrB,OAAO,EAMN,cAAc,EACd,eAAe,EACf,gBAAgB,GAChB,MAAM,eAAe,CAAC;AACvB,OAAO,EAGN,gBAAgB,EAIhB,iBAAiB,GAEjB,MAAM,cAAc,CAAC","sourcesContent":["/!\n Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { ~~IOdspError, IOdspErrorAugmentations, OdspError, OdspErrorType~~ } from \"./errors\";\nexport {\n\tHostStoragePolicy,\n\tICollabSessionOptions,\n\tIOpsCachingPolicy,\n\tISnapshotOptions,\n} from \"./factory\";\nexport {\n\tCacheContentType,\n\tgetKeyForCacheEntry,\n\tICacheEntry,\n\tIEntry,\n\tIFileEntry,\n\tIPersistedCache,\n\tsnapshotKey,\n} from \"./odspCache\";\nexport {\n\tIOdspResolvedUrl,\n\tIOdspUrlParts,\n\tISharingLink,\n\tISharingLinkKind,\n\tShareLinkInfoType,\n\tShareLinkTypes,\n\tSharingLinkRole,\n\tSharingLinkScope,\n} from \"./resolvedUrl\";\nexport {\n\tIdentityType,\n\tInstrumentedStorageTokenFetcher,\n\tisTokenFromCache,\n\tOdspResourceTokenFetchOptions,\n\tTokenFetcher,\n\tTokenFetchOptions,\n\ttokenFromResponse,\n\tTokenResponse,\n} from \"./tokenFetch\";\nexport {\n\tIProvideSessionAwareDriverFactory,\n\tIRelaySessionAwareDriverFactory,\n\tISocketStorageDiscovery,\n} from \"./sessionProvider\";\n"]}
1	+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAIN,aAAa,EACb,cAAc,GACd,MAAM,UAAU,CAAC;AAOlB,OAAO,EAEN,mBAAmB,EAKnB,WAAW,GACX,MAAM,aAAa,CAAC;AACrB,OAAO,EAMN,cAAc,EACd,eAAe,EACf,gBAAgB,GAChB,MAAM,eAAe,CAAC;AACvB,OAAO,EAGN,gBAAgB,EAIhB,iBAAiB,GAEjB,MAAM,cAAc,CAAC","sourcesContent":["/!\n Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tIOdspError,\n\tIOdspErrorAugmentations,\n\tOdspError,\n\tOdspErrorType,\n\tOdspErrorTypes,\n} from \"./errors\";\nexport {\n\tHostStoragePolicy,\n\tICollabSessionOptions,\n\tIOpsCachingPolicy,\n\tISnapshotOptions,\n} from \"./factory\";\nexport {\n\tCacheContentType,\n\tgetKeyForCacheEntry,\n\tICacheEntry,\n\tIEntry,\n\tIFileEntry,\n\tIPersistedCache,\n\tsnapshotKey,\n} from \"./odspCache\";\nexport {\n\tIOdspResolvedUrl,\n\tIOdspUrlParts,\n\tISharingLink,\n\tISharingLinkKind,\n\tShareLinkInfoType,\n\tShareLinkTypes,\n\tSharingLinkRole,\n\tSharingLinkScope,\n} from \"./resolvedUrl\";\nexport {\n\tIdentityType,\n\tInstrumentedStorageTokenFetcher,\n\tisTokenFromCache,\n\tOdspResourceTokenFetchOptions,\n\tTokenFetcher,\n\tTokenFetchOptions,\n\ttokenFromResponse,\n\tTokenResponse,\n} from \"./tokenFetch\";\nexport {\n\tIProvideSessionAwareDriverFactory,\n\tIRelaySessionAwareDriverFactory,\n\tISocketStorageDiscovery,\n} from \"./sessionProvider\";\n"]}

package/lib/odspCache.d.ts CHANGED Viewed

@@ -81,7 +81,7 @@ export interface IPersistedCache {
 /**
  * Api to generate a cache key from cache entry.
  * @param entry - cache entry from which a cache key is generated
- * @returns - key for cache.
+ * @returns The key for cache.
  */
 export declare function getKeyForCacheEntry(entry: ICacheEntry): string;
 //# sourceMappingURL=odspCache.d.ts.map

package/lib/odspCache.js CHANGED Viewed

@@ -9,7 +9,7 @@ export const snapshotKey = "snapshot";
 /**
  * Api to generate a cache key from cache entry.
  * @param entry - cache entry from which a cache key is generated
- * @returns - key for cache.
+ * @returns The key for cache.
  */
 export function getKeyForCacheEntry(entry) {
     return `${entry.file.docId}_${entry.type}_${entry.key}`;

package/lib/odspCache.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"odspCache.js","sourceRoot":"","sources":["../src/odspCache.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,UAAU,CAAC;AAqFtC;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAAkB;IACrD,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC;AACzD,CAAC","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 Describes what kind of content is stored in cache entry.\n /\nexport const snapshotKey = \"snapshot\";\nexport type CacheContentType = \"snapshot\" \| \"ops\";\n\n/\n * File / container identifier.\n * There is overlapping information here - host can use all of it or parts\n * to implement storage / identify files.\n /\nexport interface IFileEntry {\n\t/\n\t Unique and stable ID of the document.\n\t * Driver guarantees that docId is stable ID uniquely identifying document.\n\t /\n\tdocId: string;\n\t/\n\t Resolved URI is provided for additional versatility - host can use it to\n\t * identify file in storage, and (as example) delete all cached entries for\n\t * a file if user requests so.\n\t * This is IOdspResolvedUrl in case of ODSP driver.\n\t /\n\tresolvedUrl: IResolvedUrl;\n}\n\n/\n Cache entry. Identifies file that this entry belongs to, and type of content stored in it.\n /\nexport interface IEntry {\n\t/\n\t Identifies type of entry for a given file.\n\t * Each file can have multiple types of entries associated with it.\n\t * For example, it can be snapshot, blob, ops, etc.\n\t /\n\ttype: CacheContentType;\n\n\t/\n\t Identifies individual entry for a given file and type.\n\t * Each file can have multiple cache entries associated with it.\n\t * This property identifies a particular instance of entry.\n\t * For example, for blobs it will be unique ID of the blob in a file.\n\t * For batch of ops, it can be starting op sequence number.\n\t * For types that have only one entry (like snapshots), it will be empty string.\n\t /\n\tkey: string;\n}\n\n/\n Cache entry. Identifies file that this entry belongs to, and type of content stored in it.\n /\nexport interface ICacheEntry extends IEntry {\n\t/\n\t Identifies file in storage this cached entry is for\n\t /\n\tfile: IFileEntry;\n}\n\n/\n Persistent cache. This interface can be implemented by the host to provide durable caching\n * across sessions. If not provided at driver factory construction, factory will use in-memory\n * cache implementation that does not survive across sessions. Snapshot entires stored in the\n * IPersistedCache will be considered stale and removed after 2 days. Read the README for more\n * information.\n /\nexport interface IPersistedCache {\n\t/\n\t Get the cache value of the key\n\t * @param entry - cache entry, identifies file and particular key for this file.\n\t * @returns Cached value. undefined if nothing is cached.\n\t /\n\tget(entry: ICacheEntry): Promise<any>;\n\n\t/\n\t Put the value into cache.\n\t * Important - only serializable content is allowed since this cache may be persisted between sessions\n\t * @param entry - cache entry.\n\t * @param value - JSON-serializable content.\n\t /\n\tput(entry: ICacheEntry, value: any): Promise<void>;\n\n\t/\n\t Removes the entries from the cache for given parametres.\n\t * @param file - file entry to be deleted.\n\t /\n\tremoveEntries(file: IFileEntry): Promise<void>;\n}\n\n/\n Api to generate a cache key from cache entry.\n * @param entry - cache entry from which a cache key is generated\n * @returns - key for cache.\n */\nexport function getKeyForCacheEntry(entry: ICacheEntry): string {\n\treturn `${entry.file.docId}_${entry.type}_${entry.key}`;\n}\n"]}
1	+ {"version":3,"file":"odspCache.js","sourceRoot":"","sources":["../src/odspCache.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,UAAU,CAAC;AAqFtC;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAAkB;IACrD,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC;AACzD,CAAC","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 Describes what kind of content is stored in cache entry.\n /\nexport const snapshotKey = \"snapshot\";\nexport type CacheContentType = \"snapshot\" \| \"ops\";\n\n/\n * File / container identifier.\n * There is overlapping information here - host can use all of it or parts\n * to implement storage / identify files.\n /\nexport interface IFileEntry {\n\t/\n\t Unique and stable ID of the document.\n\t * Driver guarantees that docId is stable ID uniquely identifying document.\n\t /\n\tdocId: string;\n\t/\n\t Resolved URI is provided for additional versatility - host can use it to\n\t * identify file in storage, and (as example) delete all cached entries for\n\t * a file if user requests so.\n\t * This is IOdspResolvedUrl in case of ODSP driver.\n\t /\n\tresolvedUrl: IResolvedUrl;\n}\n\n/\n Cache entry. Identifies file that this entry belongs to, and type of content stored in it.\n /\nexport interface IEntry {\n\t/\n\t Identifies type of entry for a given file.\n\t * Each file can have multiple types of entries associated with it.\n\t * For example, it can be snapshot, blob, ops, etc.\n\t /\n\ttype: CacheContentType;\n\n\t/\n\t Identifies individual entry for a given file and type.\n\t * Each file can have multiple cache entries associated with it.\n\t * This property identifies a particular instance of entry.\n\t * For example, for blobs it will be unique ID of the blob in a file.\n\t * For batch of ops, it can be starting op sequence number.\n\t * For types that have only one entry (like snapshots), it will be empty string.\n\t /\n\tkey: string;\n}\n\n/\n Cache entry. Identifies file that this entry belongs to, and type of content stored in it.\n /\nexport interface ICacheEntry extends IEntry {\n\t/\n\t Identifies file in storage this cached entry is for\n\t /\n\tfile: IFileEntry;\n}\n\n/\n Persistent cache. This interface can be implemented by the host to provide durable caching\n * across sessions. If not provided at driver factory construction, factory will use in-memory\n * cache implementation that does not survive across sessions. Snapshot entires stored in the\n * IPersistedCache will be considered stale and removed after 2 days. Read the README for more\n * information.\n /\nexport interface IPersistedCache {\n\t/\n\t Get the cache value of the key\n\t * @param entry - cache entry, identifies file and particular key for this file.\n\t * @returns Cached value. undefined if nothing is cached.\n\t /\n\tget(entry: ICacheEntry): Promise<any>;\n\n\t/\n\t Put the value into cache.\n\t * Important - only serializable content is allowed since this cache may be persisted between sessions\n\t * @param entry - cache entry.\n\t * @param value - JSON-serializable content.\n\t /\n\tput(entry: ICacheEntry, value: any): Promise<void>;\n\n\t/\n\t Removes the entries from the cache for given parametres.\n\t * @param file - file entry to be deleted.\n\t /\n\tremoveEntries(file: IFileEntry): Promise<void>;\n}\n\n/\n Api to generate a cache key from cache entry.\n * @param entry - cache entry from which a cache key is generated\n * @returns The key for cache.\n */\nexport function getKeyForCacheEntry(entry: ICacheEntry): string {\n\treturn `${entry.file.docId}_${entry.type}_${entry.key}`;\n}\n"]}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/odsp-driver-definitions",
-  "version": "2.0.0-internal.6.3.2",
+  "version": "2.0.0-internal.6.4.0",
   "description": "Socket storage implementation for SPO and ODC",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -15,14 +15,14 @@
   "module": "lib/index.js",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "@fluidframework/driver-definitions": ">=2.0.0-internal.6.3.2 <2.0.0-internal.6.4.0"
+    "@fluidframework/driver-definitions": ">=2.0.0-internal.6.4.0 <2.0.0-internal.6.5.0"
   },
   "devDependencies": {
     "@fluid-tools/build-cli": "^0.22.0",
     "@fluidframework/build-common": "^2.0.0",
     "@fluidframework/build-tools": "^0.22.0",
     "@fluidframework/eslint-config-fluid": "^2.1.0",
-    "@fluidframework/odsp-driver-definitions-previous": "npm:@fluidframework/odsp-driver-definitions@2.0.0-internal.6.3.1",
+    "@fluidframework/odsp-driver-definitions-previous": "npm:@fluidframework/odsp-driver-definitions@2.0.0-internal.6.3.0",
     "@fluidframework/protocol-definitions": "^1.1.0",
     "@microsoft/api-extractor": "^7.34.4",
     "copyfiles": "^2.4.1",

package/src/errors.ts CHANGED Viewed

@@ -2,12 +2,72 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { DriverError, IDriverErrorBase } from "@fluidframework/driver-definitions";
+import {
+	DriverError,
+	IDriverErrorBase,
+	DriverErrorTypes,
+} from "@fluidframework/driver-definitions";
 /**
  * ODSP Error types.
  * Different error types that may be thrown by the ODSP driver.
  */
+export const OdspErrorTypes = {
+	// Inherit base driver error types
+	...DriverErrorTypes,
+	/**
+	 * 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",
+	/**
+	 * 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",
+} as const;
+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.
+ */
 export enum OdspErrorType {
 	/**
 	 * Storage is out of space
@@ -38,6 +98,9 @@ export enum OdspErrorType {
 	 */
 	fluidNotEnabled = "fluidNotEnabled",
+	/**
+	 * {@inheritDoc @fluidframework/driver-definitions#FluidErrorType.fetchTokenError}
+	 */
 	fetchTokenError = "fetchTokenError",
 	/**

package/src/index.ts CHANGED Viewed

@@ -3,7 +3,13 @@
  * Licensed under the MIT License.
  */
-export { IOdspError, IOdspErrorAugmentations, OdspError, OdspErrorType } from "./errors";
+export {
+	IOdspError,
+	IOdspErrorAugmentations,
+	OdspError,
+	OdspErrorType,
+	OdspErrorTypes,
+} from "./errors";
 export {
 	HostStoragePolicy,
 	ICollabSessionOptions,

package/src/odspCache.ts CHANGED Viewed

@@ -96,7 +96,7 @@ export interface IPersistedCache {
 /**
  * Api to generate a cache key from cache entry.
  * @param entry - cache entry from which a cache key is generated
- * @returns - key for cache.
+ * @returns The key for cache.
  */
 export function getKeyForCacheEntry(entry: ICacheEntry): string {
 	return `${entry.file.docId}_${entry.type}_${entry.key}`;