npm - @fluidframework/driver-definitions - Versions diffs - 2.0.0-internal.6.2.0 → 2.0.0-internal.6.3.0 - Mend

@fluidframework/driver-definitions 2.0.0-internal.6.2.0 → 2.0.0-internal.6.3.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 (20) hide show

package/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,13 @@
 # @fluidframework/driver-definitions
+## 2.0.0-internal.6.3.0
+### Minor Changes
+-   Add new error type enumeration that extends common errors from core-interfaces ([#17078](https://github.com/microsoft/FluidFramework/issues/17078)) [5c4bf0d9c2](https://github.com/microsoft/FluidFramework/commits/5c4bf0d9c224af86d0c2205c67c6e64405fee51c)
+    Deprecates existing `DriverErrorType` enum in favor of the new `DriverErrorTypes` type.
 ## 2.0.0-internal.6.2.0
 ### Minor Changes

package/dist/driverError.d.ts CHANGED Viewed

@@ -3,9 +3,84 @@
  * Licensed under the MIT License.
  */
 import { IResolvedUrl } from "./urlResolver";
+/**
+ * Different error types the Driver may report out to the Host.
+ */
+export declare const DriverErrorTypes: {
+    /**
+     * Some non-categorized (below) networking error
+     * Include errors like  fatal server error (usually 500).
+     */
+    readonly genericNetworkError: "genericNetworkError";
+    /**
+     * Access denied - user does not have enough privileges to open a file, or continue to operate on a file
+     */
+    readonly authorizationError: "authorizationError";
+    /**
+     * File not found, or file deleted during session
+     */
+    readonly fileNotFoundOrAccessDeniedError: "fileNotFoundOrAccessDeniedError";
+    /**
+     * We can not reach server due to computer being offline.
+     */
+    readonly offlineError: "offlineError";
+    readonly unsupportedClientProtocolVersion: "unsupportedClientProtocolVersion";
+    /**
+     * User does not have write permissions to a file, but is changing content of a file.
+     * That might be indication of some data store error - data stores should not generate ops in readonly mode.
+     */
+    readonly writeError: "writeError";
+    /**
+     * A generic fetch failure that indicates we were not able to get a response from the server.
+     * This may be due to the client being offline (though, if we are able to detect offline state it will be
+     * logged as an offlineError instead).  Other possibilities could be DNS errors, malformed fetch request,
+     * CSP violation, etc.
+     */
+    readonly fetchFailure: "fetchFailure";
+    /**
+     * This error occurs when token provider fails to fetch orderer token
+     */
+    readonly fetchTokenError: "fetchTokenError";
+    /**
+     * Unexpected response from server. Either JSON is malformed, or some required properties are missing
+     */
+    readonly incorrectServerResponse: "incorrectServerResponse";
+    /**
+     * This error occurs when the file is modified externally (not through Fluid protocol) in storage.
+     * It will occur in cases where client has some state or cache that is based on old content (identity) of a file,
+     * and storage / driver / loader detects such mismatch.
+     * When it's hit, client needs to forget all the knowledge about this file and start over.
+     */
+    readonly fileOverwrittenInStorage: "fileOverwrittenInStorage";
+    /**
+     * The document is read-only and delta stream connection is forbidden.
+     */
+    readonly deltaStreamConnectionForbidden: "deltaStreamConnectionForbidden";
+    /**
+     * The location of file/container can change on server. So if the file location moves and we try to access the old
+     * location, then this error is thrown to let the client know about the new location info.
+     */
+    readonly locationRedirection: "locationRedirection";
+    /**
+     * When a file is not a Fluid file, but has Fluid extension such as ".note",
+     * server won't be able to open it and will return this error. The innerMostErrorCode will be
+     * "fluidInvalidSchema"
+     */
+    readonly fluidInvalidSchema: "fluidInvalidSchema";
+    /**
+     * File is locked for read/write by storage, e.g. whole collection is locked and access denied.
+     */
+    readonly fileIsLocked: "fileIsLocked";
+    readonly genericError: "genericError";
+    readonly throttlingError: "throttlingError";
+    readonly usageError: "usageError";
+};
+export declare type DriverErrorTypes = typeof DriverErrorTypes[keyof typeof DriverErrorTypes];
 /**
  * Driver Error types
  * Lists types that are likely to be used by all drivers
+ *
+ * @deprecated Use {@link (DriverErrorTypes:type)} instead.
  */
 export declare enum DriverErrorType {
     /**
@@ -103,7 +178,9 @@ export interface IAnyDriverError extends Omit<IDriverErrorBase, "errorType"> {
  */
 export interface IDriverErrorBase {
     /**
-     * Classification of what type of error this is, used programmatically by consumers to interpret the error
+     * Classification of what type of error this is, used programmatically by consumers to interpret the error.
+     *
+     * @privateRemarks TODO: use {@link DriverErrorTypes} instead (breaking change).
      */
     readonly errorType: DriverErrorType;
     /**

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

	@@ -1 +1 @@
1	- {"version":3,"file":"driverError.d.ts","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":"AAAA;;;GAGG;~~AAEH~~,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;~~AAE7C~~;;;~~GAGG~~;AACH,oBAAY,eAAe;IAC1B;;OAEG;IACH,YAAY,iBAAiB;IAE7B;;;OAGG;IACH,mBAAmB,wBAAwB;IAE3C;;OAEG;IACH,kBAAkB,uBAAuB;IAEzC;;OAEG;IACH,+BAA+B,oCAAoC;IAEnE;;OAEG;IACH,eAAe,oBAAoB;IAEnC;;OAEG;IACH,YAAY,iBAAiB;IAK7B,gCAAgC,qCAAqC;IAErE;;;OAGG;IACH,UAAU,eAAe;IAEzB;;;;;OAKG;IACH,YAAY,iBAAiB;IAE7B;;OAEG;IACH,eAAe,oBAAoB;IAEnC;;OAEG;IACH,uBAAuB,4BAA4B;IAEnD;;;;;OAKG;IACH,wBAAwB,6BAA6B;IAErD;;OAEG;IACH,8BAA8B,mCAAmC;IAEjE;;;OAGG;IACH,mBAAmB,wBAAwB;IAE3C;;;;OAIG;IACH,kBAAkB,uBAAuB;IAEzC;;;OAGG;IACH,UAAU,eAAe;IAEzB;;OAEG;IACH,YAAY,iBAAiB;CAC7B;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC;IAC3E,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC~~;;OAEG~~;IACH,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC3D,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,eAAe,CAAC;IACpD,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC7D,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,mBAAmB,CAAC;IACxD,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC5D,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,kBAAkB,CAAC;IACvD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,yBAA0B,SAAQ,gBAAgB;IAClE,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,mBAAmB,CAAC;IACxD,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IAC1D,QAAQ,CAAC,SAAS,EACf,eAAe,CAAC,YAAY,GAC5B,eAAe,CAAC,+BAA+B,GAC/C,eAAe,CAAC,YAAY,GAC5B,eAAe,CAAC,gCAAgC,GAChD,eAAe,CAAC,UAAU,GAC1B,eAAe,CAAC,YAAY,GAC5B,eAAe,CAAC,eAAe,GAC/B,eAAe,CAAC,uBAAuB,GACvC,eAAe,CAAC,wBAAwB,GACxC,eAAe,CAAC,kBAAkB,GAClC,eAAe,CAAC,UAAU,GAC1B,eAAe,CAAC,YAAY,CAAC;IAChC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,oBAAY,WAAW,GACpB,kBAAkB,GAClB,oBAAoB,GACpB,mBAAmB,GACnB,yBAAyB,GACzB,iBAAiB,CAAC"}
1	+ {"version":3,"file":"driverError.d.ts","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAM7C;;GAEG;AACH,eAAO,MAAM,gBAAgB;IAI5B;;;OAGG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;IAQH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;;;OAIG;;IAGH;;OAEG;;;;;CAEM,CAAC;AACX,oBAAY,gBAAgB,GAAG,OAAO,gBAAgB,CAAC,MAAM,OAAO,gBAAgB,CAAC,CAAC;AAEtF;;;;;GAKG;AACH,oBAAY,eAAe;IAC1B;;OAEG;IACH,YAAY,iBAAiB;IAE7B;;;OAGG;IACH,mBAAmB,wBAAwB;IAE3C;;OAEG;IACH,kBAAkB,uBAAuB;IAEzC;;OAEG;IACH,+BAA+B,oCAAoC;IAEnE;;OAEG;IACH,eAAe,oBAAoB;IAEnC;;OAEG;IACH,YAAY,iBAAiB;IAK7B,gCAAgC,qCAAqC;IAErE;;;OAGG;IACH,UAAU,eAAe;IAEzB;;;;;OAKG;IACH,YAAY,iBAAiB;IAE7B;;OAEG;IACH,eAAe,oBAAoB;IAEnC;;OAEG;IACH,uBAAuB,4BAA4B;IAEnD;;;;;OAKG;IACH,wBAAwB,6BAA6B;IAErD;;OAEG;IACH,8BAA8B,mCAAmC;IAEjE;;;OAGG;IACH,mBAAmB,wBAAwB;IAE3C;;;;OAIG;IACH,kBAAkB,uBAAuB;IAEzC;;;OAGG;IACH,UAAU,eAAe;IAEzB;;OAEG;IACH,YAAY,iBAAiB;CAC7B;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC;IAC3E,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC3D,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,eAAe,CAAC;IACpD,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC7D,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,mBAAmB,CAAC;IACxD,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC5D,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,kBAAkB,CAAC;IACvD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,yBAA0B,SAAQ,gBAAgB;IAClE,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,mBAAmB,CAAC;IACxD,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IAC1D,QAAQ,CAAC,SAAS,EACf,eAAe,CAAC,YAAY,GAC5B,eAAe,CAAC,+BAA+B,GAC/C,eAAe,CAAC,YAAY,GAC5B,eAAe,CAAC,gCAAgC,GAChD,eAAe,CAAC,UAAU,GAC1B,eAAe,CAAC,YAAY,GAC5B,eAAe,CAAC,eAAe,GAC/B,eAAe,CAAC,uBAAuB,GACvC,eAAe,CAAC,wBAAwB,GACxC,eAAe,CAAC,kBAAkB,GAClC,eAAe,CAAC,UAAU,GAC1B,eAAe,CAAC,YAAY,CAAC;IAChC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,oBAAY,WAAW,GACpB,kBAAkB,GAClB,oBAAoB,GACpB,mBAAmB,GACnB,yBAAyB,GACzB,iBAAiB,CAAC"}

package/dist/driverError.js CHANGED Viewed

@@ -4,10 +4,89 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DriverErrorType = void 0;
+exports.DriverErrorType = exports.DriverErrorTypes = void 0;
+const core_interfaces_1 = require("@fluidframework/core-interfaces");
+// Omit `dataCorruptionError` and `dataProcessingError` from the list of values inherited from FluidErrorTypes
+const { dataCorruptionError, dataProcessingError, ...FluidErrorTypesExceptDataTypes } = core_interfaces_1.FluidErrorTypes;
+/**
+ * Different error types the Driver may report out to the Host.
+ */
+exports.DriverErrorTypes = {
+    // Inherit base error types
+    ...FluidErrorTypesExceptDataTypes,
+    /**
+     * Some non-categorized (below) networking error
+     * Include errors like  fatal server error (usually 500).
+     */
+    genericNetworkError: "genericNetworkError",
+    /**
+     * Access denied - user does not have enough privileges to open a file, or continue to operate on a file
+     */
+    authorizationError: "authorizationError",
+    /**
+     * File not found, or file deleted during session
+     */
+    fileNotFoundOrAccessDeniedError: "fileNotFoundOrAccessDeniedError",
+    /**
+     * We can not reach server due to computer being offline.
+     */
+    offlineError: "offlineError",
+    /*
+     * Unsupported client protocol
+     */
+    unsupportedClientProtocolVersion: "unsupportedClientProtocolVersion",
+    /**
+     * User does not have write permissions to a file, but is changing content of a file.
+     * That might be indication of some data store error - data stores should not generate ops in readonly mode.
+     */
+    writeError: "writeError",
+    /**
+     * A generic fetch failure that indicates we were not able to get a response from the server.
+     * This may be due to the client being offline (though, if we are able to detect offline state it will be
+     * logged as an offlineError instead).  Other possibilities could be DNS errors, malformed fetch request,
+     * CSP violation, etc.
+     */
+    fetchFailure: "fetchFailure",
+    /**
+     * This error occurs when token provider fails to fetch orderer token
+     */
+    fetchTokenError: "fetchTokenError",
+    /**
+     * Unexpected response from server. Either JSON is malformed, or some required properties are missing
+     */
+    incorrectServerResponse: "incorrectServerResponse",
+    /**
+     * This error occurs when the file is modified externally (not through Fluid protocol) in storage.
+     * It will occur in cases where client has some state or cache that is based on old content (identity) of a file,
+     * and storage / driver / loader detects such mismatch.
+     * When it's hit, client needs to forget all the knowledge about this file and start over.
+     */
+    fileOverwrittenInStorage: "fileOverwrittenInStorage",
+    /**
+     * The document is read-only and delta stream connection is forbidden.
+     */
+    deltaStreamConnectionForbidden: "deltaStreamConnectionForbidden",
+    /**
+     * The location of file/container can change on server. So if the file location moves and we try to access the old
+     * location, then this error is thrown to let the client know about the new location info.
+     */
+    locationRedirection: "locationRedirection",
+    /**
+     * When a file is not a Fluid file, but has Fluid extension such as ".note",
+     * server won't be able to open it and will return this error. The innerMostErrorCode will be
+     * "fluidInvalidSchema"
+     */
+    fluidInvalidSchema: "fluidInvalidSchema",
+    /**
+     * File is locked for read/write by storage, e.g. whole collection is locked and access denied.
+     */
+    fileIsLocked: "fileIsLocked",
+};
 /**
  * Driver Error types
  * Lists types that are likely to be used by all drivers
+ *
+ * @deprecated Use {@link (DriverErrorTypes:type)} instead.
  */
 var DriverErrorType;
 (function (DriverErrorType) {

package/dist/driverError.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"driverError.js","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;;GAGG;AACH,IAAY,eAiGX;AAjGD,WAAY,eAAe;IAC1B;;OAEG;IACH,gDAA6B,CAAA;IAE7B;;;OAGG;IACH,8DAA2C,CAAA;IAE3C;;OAEG;IACH,4DAAyC,CAAA;IAEzC;;OAEG;IACH,sFAAmE,CAAA;IAEnE;;OAEG;IACH,sDAAmC,CAAA;IAEnC;;OAEG;IACH,gDAA6B,CAAA;IAE7B;;OAEG;IACH,wFAAqE,CAAA;IAErE;;;OAGG;IACH,4CAAyB,CAAA;IAEzB;;;;;OAKG;IACH,gDAA6B,CAAA;IAE7B;;OAEG;IACH,sDAAmC,CAAA;IAEnC;;OAEG;IACH,sEAAmD,CAAA;IAEnD;;;;;OAKG;IACH,wEAAqD,CAAA;IAErD;;OAEG;IACH,oFAAiE,CAAA;IAEjE;;;OAGG;IACH,8DAA2C,CAAA;IAE3C;;;;OAIG;IACH,4DAAyC,CAAA;IAEzC;;;OAGG;IACH,4CAAyB,CAAA;IAEzB;;OAEG;IACH,gDAA6B,CAAA;AAC9B,CAAC,EAjGW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAiG1B","sourcesContent":["/!\n Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n /\n\nimport { IResolvedUrl } from \"./urlResolver\";\n\n/\n Driver Error types\n * Lists types that are likely to be used by all drivers\n /\nexport enum DriverErrorType {\n\t/\n\t A fatal error with no specific interpretation covered by other DriverErrorType values\n\t /\n\tgenericError = \"genericError\",\n\n\t/\n\t Some non-categorized (below) networking error\n\t * Include errors like fatal server error (usually 500).\n\t /\n\tgenericNetworkError = \"genericNetworkError\",\n\n\t/\n\t Access denied - user does not have enough privileges to open a file, or continue to operate on a file\n\t /\n\tauthorizationError = \"authorizationError\",\n\n\t/\n\t File not found, or file deleted during session\n\t /\n\tfileNotFoundOrAccessDeniedError = \"fileNotFoundOrAccessDeniedError\",\n\n\t/\n\t Throttling error from server. Server is busy and is asking not to reconnect for some time\n\t /\n\tthrottlingError = \"throttlingError\",\n\n\t/\n\t We can not reach server due to computer being offline.\n\t /\n\tofflineError = \"offlineError\",\n\n\t/\n\t * Unsupported client protocol\n\t /\n\tunsupportedClientProtocolVersion = \"unsupportedClientProtocolVersion\",\n\n\t/\n\t User does not have write permissions to a file, but is changing content of a file.\n\t * That might be indication of some data store error - data stores should not generate ops in readonly mode.\n\t /\n\twriteError = \"writeError\",\n\n\t/\n\t A generic fetch failure that indicates we were not able to get a response from the server.\n\t * This may be due to the client being offline (though, if we are able to detect offline state it will be\n\t * logged as an offlineError instead). Other possibilities could be DNS errors, malformed fetch request,\n\t * CSP violation, etc.\n\t /\n\tfetchFailure = \"fetchFailure\",\n\n\t/\n\t This error occurs when token provider fails to fetch orderer token\n\t /\n\tfetchTokenError = \"fetchTokenError\",\n\n\t/\n\t Unexpected response from server. Either JSON is malformed, or some required properties are missing\n\t /\n\tincorrectServerResponse = \"incorrectServerResponse\",\n\n\t/\n\t This error occurs when the file is modified externally (not through Fluid protocol) in storage.\n\t * It will occur in cases where client has some state or cache that is based on old content (identity) of a file,\n\t * and storage / driver / loader detects such mismatch.\n\t * When it's hit, client needs to forget all the knowledge about this file and start over.\n\t /\n\tfileOverwrittenInStorage = \"fileOverwrittenInStorage\",\n\n\t/\n\t The document is read-only and delta stream connection is forbidden.\n\t /\n\tdeltaStreamConnectionForbidden = \"deltaStreamConnectionForbidden\",\n\n\t/\n\t The location of file/container can change on server. So if the file location moves and we try to access the old\n\t * location, then this error is thrown to let the client know about the new location info.\n\t /\n\tlocationRedirection = \"locationRedirection\",\n\n\t/\n\t When a file is not a Fluid file, but has Fluid extension such as \".note\",\n\t * server won't be able to open it and will return this error. The innerMostErrorCode will be\n\t * \"fluidInvalidSchema\"\n\t /\n\tfluidInvalidSchema = \"fluidInvalidSchema\",\n\n\t/\n\t Error indicating an API is being used improperly resulting in an invalid operation.\n\t * ! Should match the value of ContainerErrorType.usageError\n\t /\n\tusageError = \"usageError\",\n\n\t/\n\t File is locked for read/write by storage, e.g. whole collection is locked and access denied.\n\t /\n\tfileIsLocked = \"fileIsLocked\",\n}\n\n/\n Interface describing errors and warnings raised by any driver code.\n * Not expected to be implemented by a class or an object literal, but rather used in place of\n * any or unknown in various function signatures that pass errors around.\n \n \"Any\" in the interface name is a nod to the fact that errorType has lost its type constraint.\n * It will be either DriverErrorType or the specific driver's specialized error type enum,\n * but we can't reference a specific driver's error type enum in this code.\n /\nexport interface IAnyDriverError extends Omit<IDriverErrorBase, \"errorType\"> {\n\treadonly errorType: string;\n}\n\n/\n Base interface for all errors and warnings\n /\nexport interface IDriverErrorBase {\n\t/\n\t Classification of what type of error this is, used programmatically by consumers to interpret the error\n\t /\n\treadonly errorType: DriverErrorType;\n\n\t/\n\t Free-form error message\n\t /\n\treadonly message: string;\n\n\t/\n\t True indicates the caller may retry the failed action. False indicates it's a fatal error\n\t /\n\tcanRetry: boolean;\n\n\t/\n\t Best guess as to network conditions (online/offline) when the error arose.\n\t * See OnlineStatus enum in driver-utils package for expected values.\n\t /\n\tonline?: string;\n\n\t/\n\t Whether service was reachable and we got some response from service.\n\t /\n\tendpointReached?: boolean;\n}\n\nexport interface IThrottlingWarning extends IDriverErrorBase {\n\treadonly errorType: DriverErrorType.throttlingError;\n\treadonly retryAfterSeconds: number;\n}\n\nexport interface IGenericNetworkError extends IDriverErrorBase {\n\treadonly errorType: DriverErrorType.genericNetworkError;\n\treadonly statusCode?: number;\n}\n\nexport interface IAuthorizationError extends IDriverErrorBase {\n\treadonly errorType: DriverErrorType.authorizationError;\n\treadonly claims?: string;\n\treadonly tenantId?: string;\n}\n\nexport interface ILocationRedirectionError extends IDriverErrorBase {\n\treadonly errorType: DriverErrorType.locationRedirection;\n\treadonly redirectUrl: IResolvedUrl;\n}\n\n/\n Having this uber interface without types that have their own interfaces\n * allows compiler to differentiate interfaces based on error type\n */\nexport interface IDriverBasicError extends IDriverErrorBase {\n\treadonly errorType:\n\t\t\| DriverErrorType.genericError\n\t\t\| DriverErrorType.fileNotFoundOrAccessDeniedError\n\t\t\| DriverErrorType.offlineError\n\t\t\| DriverErrorType.unsupportedClientProtocolVersion\n\t\t\| DriverErrorType.writeError\n\t\t\| DriverErrorType.fetchFailure\n\t\t\| DriverErrorType.fetchTokenError\n\t\t\| DriverErrorType.incorrectServerResponse\n\t\t\| DriverErrorType.fileOverwrittenInStorage\n\t\t\| DriverErrorType.fluidInvalidSchema\n\t\t\| DriverErrorType.usageError\n\t\t\| DriverErrorType.fileIsLocked;\n\treadonly statusCode?: number;\n}\n\nexport type DriverError =\n\t\| IThrottlingWarning\n\t\| IGenericNetworkError\n\t\| IAuthorizationError\n\t\| ILocationRedirectionError\n\t\| IDriverBasicError;\n"]}
1	+ {"version":3,"file":"driverError.js","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,qEAAkE;AAIlE,8GAA8G;AAC9G,MAAM,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,GAAG,8BAA8B,EAAE,GACpF,iCAAe,CAAC;AAEjB;;GAEG;AACU,QAAA,gBAAgB,GAAG;IAC/B,2BAA2B;IAC3B,GAAG,8BAA8B;IAEjC;;;OAGG;IACH,mBAAmB,EAAE,qBAAqB;IAE1C;;OAEG;IACH,kBAAkB,EAAE,oBAAoB;IAExC;;OAEG;IACH,+BAA+B,EAAE,iCAAiC;IAElE;;OAEG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,gCAAgC,EAAE,kCAAkC;IAEpE;;;OAGG;IACH,UAAU,EAAE,YAAY;IAExB;;;;;OAKG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,eAAe,EAAE,iBAAiB;IAElC;;OAEG;IACH,uBAAuB,EAAE,yBAAyB;IAElD;;;;;OAKG;IACH,wBAAwB,EAAE,0BAA0B;IAEpD;;OAEG;IACH,8BAA8B,EAAE,gCAAgC;IAEhE;;;OAGG;IACH,mBAAmB,EAAE,qBAAqB;IAE1C;;;;OAIG;IACH,kBAAkB,EAAE,oBAAoB;IAExC;;OAEG;IACH,YAAY,EAAE,cAAc;CACnB,CAAC;AAGX;;;;;GAKG;AACH,IAAY,eAiGX;AAjGD,WAAY,eAAe;IAC1B;;OAEG;IACH,gDAA6B,CAAA;IAE7B;;;OAGG;IACH,8DAA2C,CAAA;IAE3C;;OAEG;IACH,4DAAyC,CAAA;IAEzC;;OAEG;IACH,sFAAmE,CAAA;IAEnE;;OAEG;IACH,sDAAmC,CAAA;IAEnC;;OAEG;IACH,gDAA6B,CAAA;IAE7B;;OAEG;IACH,wFAAqE,CAAA;IAErE;;;OAGG;IACH,4CAAyB,CAAA;IAEzB;;;;;OAKG;IACH,gDAA6B,CAAA;IAE7B;;OAEG;IACH,sDAAmC,CAAA;IAEnC;;OAEG;IACH,sEAAmD,CAAA;IAEnD;;;;;OAKG;IACH,wEAAqD,CAAA;IAErD;;OAEG;IACH,oFAAiE,CAAA;IAEjE;;;OAGG;IACH,8DAA2C,CAAA;IAE3C;;;;OAIG;IACH,4DAAyC,CAAA;IAEzC;;;OAGG;IACH,4CAAyB,CAAA;IAEzB;;OAEG;IACH,gDAA6B,CAAA;AAC9B,CAAC,EAjGW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAiG1B","sourcesContent":["/!\n Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n /\n\nimport { FluidErrorTypes } from \"@fluidframework/core-interfaces\";\n\nimport { IResolvedUrl } from \"./urlResolver\";\n\n// Omit `dataCorruptionError` and `dataProcessingError` from the list of values inherited from FluidErrorTypes\nconst { dataCorruptionError, dataProcessingError, ...FluidErrorTypesExceptDataTypes } =\n\tFluidErrorTypes;\n\n/\n Different error types the Driver may report out to the Host.\n /\nexport const DriverErrorTypes = {\n\t// Inherit base error types\n\t...FluidErrorTypesExceptDataTypes,\n\n\t/\n\t Some non-categorized (below) networking error\n\t * Include errors like fatal server error (usually 500).\n\t /\n\tgenericNetworkError: \"genericNetworkError\",\n\n\t/\n\t Access denied - user does not have enough privileges to open a file, or continue to operate on a file\n\t /\n\tauthorizationError: \"authorizationError\",\n\n\t/\n\t File not found, or file deleted during session\n\t /\n\tfileNotFoundOrAccessDeniedError: \"fileNotFoundOrAccessDeniedError\",\n\n\t/\n\t We can not reach server due to computer being offline.\n\t /\n\tofflineError: \"offlineError\",\n\n\t/\n\t * Unsupported client protocol\n\t /\n\tunsupportedClientProtocolVersion: \"unsupportedClientProtocolVersion\",\n\n\t/\n\t User does not have write permissions to a file, but is changing content of a file.\n\t * That might be indication of some data store error - data stores should not generate ops in readonly mode.\n\t /\n\twriteError: \"writeError\",\n\n\t/\n\t A generic fetch failure that indicates we were not able to get a response from the server.\n\t * This may be due to the client being offline (though, if we are able to detect offline state it will be\n\t * logged as an offlineError instead). Other possibilities could be DNS errors, malformed fetch request,\n\t * CSP violation, etc.\n\t /\n\tfetchFailure: \"fetchFailure\",\n\n\t/\n\t This error occurs when token provider fails to fetch orderer token\n\t /\n\tfetchTokenError: \"fetchTokenError\",\n\n\t/\n\t Unexpected response from server. Either JSON is malformed, or some required properties are missing\n\t /\n\tincorrectServerResponse: \"incorrectServerResponse\",\n\n\t/\n\t This error occurs when the file is modified externally (not through Fluid protocol) in storage.\n\t * It will occur in cases where client has some state or cache that is based on old content (identity) of a file,\n\t * and storage / driver / loader detects such mismatch.\n\t * When it's hit, client needs to forget all the knowledge about this file and start over.\n\t /\n\tfileOverwrittenInStorage: \"fileOverwrittenInStorage\",\n\n\t/\n\t The document is read-only and delta stream connection is forbidden.\n\t /\n\tdeltaStreamConnectionForbidden: \"deltaStreamConnectionForbidden\",\n\n\t/\n\t The location of file/container can change on server. So if the file location moves and we try to access the old\n\t * location, then this error is thrown to let the client know about the new location info.\n\t /\n\tlocationRedirection: \"locationRedirection\",\n\n\t/\n\t When a file is not a Fluid file, but has Fluid extension such as \".note\",\n\t * server won't be able to open it and will return this error. The innerMostErrorCode will be\n\t * \"fluidInvalidSchema\"\n\t /\n\tfluidInvalidSchema: \"fluidInvalidSchema\",\n\n\t/\n\t File is locked for read/write by storage, e.g. whole collection is locked and access denied.\n\t /\n\tfileIsLocked: \"fileIsLocked\",\n} as const;\nexport type DriverErrorTypes = typeof DriverErrorTypes[keyof typeof DriverErrorTypes];\n\n/\n Driver Error types\n * Lists types that are likely to be used by all drivers\n \n @deprecated Use {@link (DriverErrorTypes:type)} instead.\n /\nexport enum DriverErrorType {\n\t/\n\t A fatal error with no specific interpretation covered by other DriverErrorType values\n\t /\n\tgenericError = \"genericError\",\n\n\t/\n\t Some non-categorized (below) networking error\n\t * Include errors like fatal server error (usually 500).\n\t /\n\tgenericNetworkError = \"genericNetworkError\",\n\n\t/\n\t Access denied - user does not have enough privileges to open a file, or continue to operate on a file\n\t /\n\tauthorizationError = \"authorizationError\",\n\n\t/\n\t File not found, or file deleted during session\n\t /\n\tfileNotFoundOrAccessDeniedError = \"fileNotFoundOrAccessDeniedError\",\n\n\t/\n\t Throttling error from server. Server is busy and is asking not to reconnect for some time\n\t /\n\tthrottlingError = \"throttlingError\",\n\n\t/\n\t We can not reach server due to computer being offline.\n\t /\n\tofflineError = \"offlineError\",\n\n\t/\n\t * Unsupported client protocol\n\t /\n\tunsupportedClientProtocolVersion = \"unsupportedClientProtocolVersion\",\n\n\t/\n\t User does not have write permissions to a file, but is changing content of a file.\n\t * That might be indication of some data store error - data stores should not generate ops in readonly mode.\n\t /\n\twriteError = \"writeError\",\n\n\t/\n\t A generic fetch failure that indicates we were not able to get a response from the server.\n\t * This may be due to the client being offline (though, if we are able to detect offline state it will be\n\t * logged as an offlineError instead). Other possibilities could be DNS errors, malformed fetch request,\n\t * CSP violation, etc.\n\t /\n\tfetchFailure = \"fetchFailure\",\n\n\t/\n\t This error occurs when token provider fails to fetch orderer token\n\t /\n\tfetchTokenError = \"fetchTokenError\",\n\n\t/\n\t Unexpected response from server. Either JSON is malformed, or some required properties are missing\n\t /\n\tincorrectServerResponse = \"incorrectServerResponse\",\n\n\t/\n\t This error occurs when the file is modified externally (not through Fluid protocol) in storage.\n\t * It will occur in cases where client has some state or cache that is based on old content (identity) of a file,\n\t * and storage / driver / loader detects such mismatch.\n\t * When it's hit, client needs to forget all the knowledge about this file and start over.\n\t /\n\tfileOverwrittenInStorage = \"fileOverwrittenInStorage\",\n\n\t/\n\t The document is read-only and delta stream connection is forbidden.\n\t /\n\tdeltaStreamConnectionForbidden = \"deltaStreamConnectionForbidden\",\n\n\t/\n\t The location of file/container can change on server. So if the file location moves and we try to access the old\n\t * location, then this error is thrown to let the client know about the new location info.\n\t /\n\tlocationRedirection = \"locationRedirection\",\n\n\t/\n\t When a file is not a Fluid file, but has Fluid extension such as \".note\",\n\t * server won't be able to open it and will return this error. The innerMostErrorCode will be\n\t * \"fluidInvalidSchema\"\n\t /\n\tfluidInvalidSchema = \"fluidInvalidSchema\",\n\n\t/\n\t Error indicating an API is being used improperly resulting in an invalid operation.\n\t * ! Should match the value of ContainerErrorType.usageError\n\t /\n\tusageError = \"usageError\",\n\n\t/\n\t File is locked for read/write by storage, e.g. whole collection is locked and access denied.\n\t /\n\tfileIsLocked = \"fileIsLocked\",\n}\n\n/\n Interface describing errors and warnings raised by any driver code.\n * Not expected to be implemented by a class or an object literal, but rather used in place of\n * any or unknown in various function signatures that pass errors around.\n \n \"Any\" in the interface name is a nod to the fact that errorType has lost its type constraint.\n * It will be either DriverErrorType or the specific driver's specialized error type enum,\n * but we can't reference a specific driver's error type enum in this code.\n /\nexport interface IAnyDriverError extends Omit<IDriverErrorBase, \"errorType\"> {\n\treadonly errorType: string;\n}\n\n/\n Base interface for all errors and warnings\n /\nexport interface IDriverErrorBase {\n\t/\n\t Classification of what type of error this is, used programmatically by consumers to interpret the error.\n\t \n\t @privateRemarks TODO: use {@link DriverErrorTypes} instead (breaking change).\n\t /\n\treadonly errorType: DriverErrorType;\n\n\t/\n\t Free-form error message\n\t /\n\treadonly message: string;\n\n\t/\n\t True indicates the caller may retry the failed action. False indicates it's a fatal error\n\t /\n\tcanRetry: boolean;\n\n\t/\n\t Best guess as to network conditions (online/offline) when the error arose.\n\t * See OnlineStatus enum in driver-utils package for expected values.\n\t /\n\tonline?: string;\n\n\t/\n\t Whether service was reachable and we got some response from service.\n\t /\n\tendpointReached?: boolean;\n}\n\nexport interface IThrottlingWarning extends IDriverErrorBase {\n\treadonly errorType: DriverErrorType.throttlingError;\n\treadonly retryAfterSeconds: number;\n}\n\nexport interface IGenericNetworkError extends IDriverErrorBase {\n\treadonly errorType: DriverErrorType.genericNetworkError;\n\treadonly statusCode?: number;\n}\n\nexport interface IAuthorizationError extends IDriverErrorBase {\n\treadonly errorType: DriverErrorType.authorizationError;\n\treadonly claims?: string;\n\treadonly tenantId?: string;\n}\n\nexport interface ILocationRedirectionError extends IDriverErrorBase {\n\treadonly errorType: DriverErrorType.locationRedirection;\n\treadonly redirectUrl: IResolvedUrl;\n}\n\n/\n Having this uber interface without types that have their own interfaces\n * allows compiler to differentiate interfaces based on error type\n */\nexport interface IDriverBasicError extends IDriverErrorBase {\n\treadonly errorType:\n\t\t\| DriverErrorType.genericError\n\t\t\| DriverErrorType.fileNotFoundOrAccessDeniedError\n\t\t\| DriverErrorType.offlineError\n\t\t\| DriverErrorType.unsupportedClientProtocolVersion\n\t\t\| DriverErrorType.writeError\n\t\t\| DriverErrorType.fetchFailure\n\t\t\| DriverErrorType.fetchTokenError\n\t\t\| DriverErrorType.incorrectServerResponse\n\t\t\| DriverErrorType.fileOverwrittenInStorage\n\t\t\| DriverErrorType.fluidInvalidSchema\n\t\t\| DriverErrorType.usageError\n\t\t\| DriverErrorType.fileIsLocked;\n\treadonly statusCode?: number;\n}\n\nexport type DriverError =\n\t\| IThrottlingWarning\n\t\| IGenericNetworkError\n\t\| IAuthorizationError\n\t\| ILocationRedirectionError\n\t\| IDriverBasicError;\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 { DriverError, DriverErrorType, IAnyDriverError, IAuthorizationError, IDriverErrorBase, IDriverBasicError, IGenericNetworkError, ILocationRedirectionError, IThrottlingWarning, } from "./driverError";
+export { DriverError, DriverErrorType, DriverErrorTypes, IAnyDriverError, IAuthorizationError, IDriverErrorBase, IDriverBasicError, IGenericNetworkError, ILocationRedirectionError, IThrottlingWarning, } from "./driverError";
 export { FetchSource, FiveDaysMs, IDeltasFetchResult, IDeltaStorageService, IDocumentDeltaConnection, IDocumentDeltaConnectionEvents, IDocumentDeltaStorageService, IDocumentService, IDocumentServiceFactory, IDocumentServicePolicies, IDocumentStorageService, IDocumentStorageServicePolicies, IStream, IStreamResult, ISummaryContext, LoaderCachingPolicy, } from "./storage";
 export { DriverPreCheckInfo, DriverHeader, IContainerPackageInfo, IDriverHeader, IResolvedUrl, IUrlResolver, } from "./urlResolver";
 //# sourceMappingURL=index.d.ts.map

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,EACN,WAAW,EACX,eAAe,EACf,eAAe,EACf,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,EACpB,yBAAyB,EACzB,kBAAkB,GAClB,MAAM,eAAe,CAAC;AACvB,OAAO,EACN,WAAW,EACX,UAAU,EACV,kBAAkB,EAClB,oBAAoB,EACpB,wBAAwB,EACxB,8BAA8B,EAC9B,4BAA4B,EAC5B,gBAAgB,EAChB,uBAAuB,EACvB,wBAAwB,EACxB,uBAAuB,EACvB,+BAA+B,EAC/B,OAAO,EACP,aAAa,EACb,eAAe,EACf,mBAAmB,GACnB,MAAM,WAAW,CAAC;AACnB,OAAO,EACN,kBAAkB,EAClB,YAAY,EACZ,qBAAqB,EACrB,aAAa,EACb,YAAY,EACZ,YAAY,GACZ,MAAM,eAAe,CAAC"}
1	+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,WAAW,EACX,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,EACpB,yBAAyB,EACzB,kBAAkB,GAClB,MAAM,eAAe,CAAC;AACvB,OAAO,EACN,WAAW,EACX,UAAU,EACV,kBAAkB,EAClB,oBAAoB,EACpB,wBAAwB,EACxB,8BAA8B,EAC9B,4BAA4B,EAC5B,gBAAgB,EAChB,uBAAuB,EACvB,wBAAwB,EACxB,uBAAuB,EACvB,+BAA+B,EAC/B,OAAO,EACP,aAAa,EACb,eAAe,EACf,mBAAmB,GACnB,MAAM,WAAW,CAAC;AACnB,OAAO,EACN,kBAAkB,EAClB,YAAY,EACZ,qBAAqB,EACrB,aAAa,EACb,YAAY,EACZ,YAAY,GACZ,MAAM,eAAe,CAAC"}

package/dist/index.js CHANGED Viewed

@@ -4,9 +4,10 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DriverHeader = exports.LoaderCachingPolicy = exports.FetchSource = exports.DriverErrorType = void 0;
+exports.DriverHeader = exports.LoaderCachingPolicy = exports.FetchSource = exports.DriverErrorTypes = exports.DriverErrorType = void 0;
 var driverError_1 = require("./driverError");
 Object.defineProperty(exports, "DriverErrorType", { enumerable: true, get: function () { return driverError_1.DriverErrorType; } });
+Object.defineProperty(exports, "DriverErrorTypes", { enumerable: true, get: function () { return driverError_1.DriverErrorTypes; } });
 var storage_1 = require("./storage");
 Object.defineProperty(exports, "FetchSource", { enumerable: true, get: function () { return storage_1.FetchSource; } });
 Object.defineProperty(exports, "LoaderCachingPolicy", { enumerable: true, get: function () { return storage_1.LoaderCachingPolicy; } });

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,~~6CAUuB~~;~~AARtB~~,8GAAA,eAAe,OAAA;~~AAShB~~,qCAiBmB;AAhBlB,sGAAA,WAAW,OAAA;AAeX,8GAAA,mBAAmB,OAAA;AAEpB,6CAOuB;AALtB,2GAAA,YAAY,OAAA","sourcesContent":["/!\n Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tDriverError,\n\tDriverErrorType,\n\tIAnyDriverError,\n\tIAuthorizationError,\n\tIDriverErrorBase,\n\tIDriverBasicError,\n\tIGenericNetworkError,\n\tILocationRedirectionError,\n\tIThrottlingWarning,\n} from \"./driverError\";\nexport {\n\tFetchSource,\n\tFiveDaysMs,\n\tIDeltasFetchResult,\n\tIDeltaStorageService,\n\tIDocumentDeltaConnection,\n\tIDocumentDeltaConnectionEvents,\n\tIDocumentDeltaStorageService,\n\tIDocumentService,\n\tIDocumentServiceFactory,\n\tIDocumentServicePolicies,\n\tIDocumentStorageService,\n\tIDocumentStorageServicePolicies,\n\tIStream,\n\tIStreamResult,\n\tISummaryContext,\n\tLoaderCachingPolicy,\n} from \"./storage\";\nexport {\n\tDriverPreCheckInfo,\n\tDriverHeader,\n\tIContainerPackageInfo,\n\tIDriverHeader,\n\tIResolvedUrl,\n\tIUrlResolver,\n} from \"./urlResolver\";\n"]}
1	+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,6CAWuB;AATtB,8GAAA,eAAe,OAAA;AACf,+GAAA,gBAAgB,OAAA;AASjB,qCAiBmB;AAhBlB,sGAAA,WAAW,OAAA;AAeX,8GAAA,mBAAmB,OAAA;AAEpB,6CAOuB;AALtB,2GAAA,YAAY,OAAA","sourcesContent":["/!\n Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tDriverError,\n\tDriverErrorType,\n\tDriverErrorTypes,\n\tIAnyDriverError,\n\tIAuthorizationError,\n\tIDriverErrorBase,\n\tIDriverBasicError,\n\tIGenericNetworkError,\n\tILocationRedirectionError,\n\tIThrottlingWarning,\n} from \"./driverError\";\nexport {\n\tFetchSource,\n\tFiveDaysMs,\n\tIDeltasFetchResult,\n\tIDeltaStorageService,\n\tIDocumentDeltaConnection,\n\tIDocumentDeltaConnectionEvents,\n\tIDocumentDeltaStorageService,\n\tIDocumentService,\n\tIDocumentServiceFactory,\n\tIDocumentServicePolicies,\n\tIDocumentStorageService,\n\tIDocumentStorageServicePolicies,\n\tIStream,\n\tIStreamResult,\n\tISummaryContext,\n\tLoaderCachingPolicy,\n} from \"./storage\";\nexport {\n\tDriverPreCheckInfo,\n\tDriverHeader,\n\tIContainerPackageInfo,\n\tIDriverHeader,\n\tIResolvedUrl,\n\tIUrlResolver,\n} from \"./urlResolver\";\n"]}

package/lib/driverError.d.ts CHANGED Viewed

@@ -3,9 +3,84 @@
  * Licensed under the MIT License.
  */
 import { IResolvedUrl } from "./urlResolver";
+/**
+ * Different error types the Driver may report out to the Host.
+ */
+export declare const DriverErrorTypes: {
+    /**
+     * Some non-categorized (below) networking error
+     * Include errors like  fatal server error (usually 500).
+     */
+    readonly genericNetworkError: "genericNetworkError";
+    /**
+     * Access denied - user does not have enough privileges to open a file, or continue to operate on a file
+     */
+    readonly authorizationError: "authorizationError";
+    /**
+     * File not found, or file deleted during session
+     */
+    readonly fileNotFoundOrAccessDeniedError: "fileNotFoundOrAccessDeniedError";
+    /**
+     * We can not reach server due to computer being offline.
+     */
+    readonly offlineError: "offlineError";
+    readonly unsupportedClientProtocolVersion: "unsupportedClientProtocolVersion";
+    /**
+     * User does not have write permissions to a file, but is changing content of a file.
+     * That might be indication of some data store error - data stores should not generate ops in readonly mode.
+     */
+    readonly writeError: "writeError";
+    /**
+     * A generic fetch failure that indicates we were not able to get a response from the server.
+     * This may be due to the client being offline (though, if we are able to detect offline state it will be
+     * logged as an offlineError instead).  Other possibilities could be DNS errors, malformed fetch request,
+     * CSP violation, etc.
+     */
+    readonly fetchFailure: "fetchFailure";
+    /**
+     * This error occurs when token provider fails to fetch orderer token
+     */
+    readonly fetchTokenError: "fetchTokenError";
+    /**
+     * Unexpected response from server. Either JSON is malformed, or some required properties are missing
+     */
+    readonly incorrectServerResponse: "incorrectServerResponse";
+    /**
+     * This error occurs when the file is modified externally (not through Fluid protocol) in storage.
+     * It will occur in cases where client has some state or cache that is based on old content (identity) of a file,
+     * and storage / driver / loader detects such mismatch.
+     * When it's hit, client needs to forget all the knowledge about this file and start over.
+     */
+    readonly fileOverwrittenInStorage: "fileOverwrittenInStorage";
+    /**
+     * The document is read-only and delta stream connection is forbidden.
+     */
+    readonly deltaStreamConnectionForbidden: "deltaStreamConnectionForbidden";
+    /**
+     * The location of file/container can change on server. So if the file location moves and we try to access the old
+     * location, then this error is thrown to let the client know about the new location info.
+     */
+    readonly locationRedirection: "locationRedirection";
+    /**
+     * When a file is not a Fluid file, but has Fluid extension such as ".note",
+     * server won't be able to open it and will return this error. The innerMostErrorCode will be
+     * "fluidInvalidSchema"
+     */
+    readonly fluidInvalidSchema: "fluidInvalidSchema";
+    /**
+     * File is locked for read/write by storage, e.g. whole collection is locked and access denied.
+     */
+    readonly fileIsLocked: "fileIsLocked";
+    readonly genericError: "genericError";
+    readonly throttlingError: "throttlingError";
+    readonly usageError: "usageError";
+};
+export declare type DriverErrorTypes = typeof DriverErrorTypes[keyof typeof DriverErrorTypes];
 /**
  * Driver Error types
  * Lists types that are likely to be used by all drivers
+ *
+ * @deprecated Use {@link (DriverErrorTypes:type)} instead.
  */
 export declare enum DriverErrorType {
     /**
@@ -103,7 +178,9 @@ export interface IAnyDriverError extends Omit<IDriverErrorBase, "errorType"> {
  */
 export interface IDriverErrorBase {
     /**
-     * Classification of what type of error this is, used programmatically by consumers to interpret the error
+     * Classification of what type of error this is, used programmatically by consumers to interpret the error.
+     *
+     * @privateRemarks TODO: use {@link DriverErrorTypes} instead (breaking change).
      */
     readonly errorType: DriverErrorType;
     /**

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

	@@ -1 +1 @@
1	- {"version":3,"file":"driverError.d.ts","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":"AAAA;;;GAGG;~~AAEH~~,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;~~AAE7C~~;;;~~GAGG~~;AACH,oBAAY,eAAe;IAC1B;;OAEG;IACH,YAAY,iBAAiB;IAE7B;;;OAGG;IACH,mBAAmB,wBAAwB;IAE3C;;OAEG;IACH,kBAAkB,uBAAuB;IAEzC;;OAEG;IACH,+BAA+B,oCAAoC;IAEnE;;OAEG;IACH,eAAe,oBAAoB;IAEnC;;OAEG;IACH,YAAY,iBAAiB;IAK7B,gCAAgC,qCAAqC;IAErE;;;OAGG;IACH,UAAU,eAAe;IAEzB;;;;;OAKG;IACH,YAAY,iBAAiB;IAE7B;;OAEG;IACH,eAAe,oBAAoB;IAEnC;;OAEG;IACH,uBAAuB,4BAA4B;IAEnD;;;;;OAKG;IACH,wBAAwB,6BAA6B;IAErD;;OAEG;IACH,8BAA8B,mCAAmC;IAEjE;;;OAGG;IACH,mBAAmB,wBAAwB;IAE3C;;;;OAIG;IACH,kBAAkB,uBAAuB;IAEzC;;;OAGG;IACH,UAAU,eAAe;IAEzB;;OAEG;IACH,YAAY,iBAAiB;CAC7B;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC;IAC3E,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC~~;;OAEG~~;IACH,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC3D,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,eAAe,CAAC;IACpD,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC7D,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,mBAAmB,CAAC;IACxD,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC5D,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,kBAAkB,CAAC;IACvD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,yBAA0B,SAAQ,gBAAgB;IAClE,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,mBAAmB,CAAC;IACxD,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IAC1D,QAAQ,CAAC,SAAS,EACf,eAAe,CAAC,YAAY,GAC5B,eAAe,CAAC,+BAA+B,GAC/C,eAAe,CAAC,YAAY,GAC5B,eAAe,CAAC,gCAAgC,GAChD,eAAe,CAAC,UAAU,GAC1B,eAAe,CAAC,YAAY,GAC5B,eAAe,CAAC,eAAe,GAC/B,eAAe,CAAC,uBAAuB,GACvC,eAAe,CAAC,wBAAwB,GACxC,eAAe,CAAC,kBAAkB,GAClC,eAAe,CAAC,UAAU,GAC1B,eAAe,CAAC,YAAY,CAAC;IAChC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,oBAAY,WAAW,GACpB,kBAAkB,GAClB,oBAAoB,GACpB,mBAAmB,GACnB,yBAAyB,GACzB,iBAAiB,CAAC"}
1	+ {"version":3,"file":"driverError.d.ts","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAM7C;;GAEG;AACH,eAAO,MAAM,gBAAgB;IAI5B;;;OAGG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;IAQH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;;;OAIG;;IAGH;;OAEG;;;;;CAEM,CAAC;AACX,oBAAY,gBAAgB,GAAG,OAAO,gBAAgB,CAAC,MAAM,OAAO,gBAAgB,CAAC,CAAC;AAEtF;;;;;GAKG;AACH,oBAAY,eAAe;IAC1B;;OAEG;IACH,YAAY,iBAAiB;IAE7B;;;OAGG;IACH,mBAAmB,wBAAwB;IAE3C;;OAEG;IACH,kBAAkB,uBAAuB;IAEzC;;OAEG;IACH,+BAA+B,oCAAoC;IAEnE;;OAEG;IACH,eAAe,oBAAoB;IAEnC;;OAEG;IACH,YAAY,iBAAiB;IAK7B,gCAAgC,qCAAqC;IAErE;;;OAGG;IACH,UAAU,eAAe;IAEzB;;;;;OAKG;IACH,YAAY,iBAAiB;IAE7B;;OAEG;IACH,eAAe,oBAAoB;IAEnC;;OAEG;IACH,uBAAuB,4BAA4B;IAEnD;;;;;OAKG;IACH,wBAAwB,6BAA6B;IAErD;;OAEG;IACH,8BAA8B,mCAAmC;IAEjE;;;OAGG;IACH,mBAAmB,wBAAwB;IAE3C;;;;OAIG;IACH,kBAAkB,uBAAuB;IAEzC;;;OAGG;IACH,UAAU,eAAe;IAEzB;;OAEG;IACH,YAAY,iBAAiB;CAC7B;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC;IAC3E,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC3D,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,eAAe,CAAC;IACpD,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC7D,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,mBAAmB,CAAC;IACxD,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC5D,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,kBAAkB,CAAC;IACvD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,yBAA0B,SAAQ,gBAAgB;IAClE,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,mBAAmB,CAAC;IACxD,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IAC1D,QAAQ,CAAC,SAAS,EACf,eAAe,CAAC,YAAY,GAC5B,eAAe,CAAC,+BAA+B,GAC/C,eAAe,CAAC,YAAY,GAC5B,eAAe,CAAC,gCAAgC,GAChD,eAAe,CAAC,UAAU,GAC1B,eAAe,CAAC,YAAY,GAC5B,eAAe,CAAC,eAAe,GAC/B,eAAe,CAAC,uBAAuB,GACvC,eAAe,CAAC,wBAAwB,GACxC,eAAe,CAAC,kBAAkB,GAClC,eAAe,CAAC,UAAU,GAC1B,eAAe,CAAC,YAAY,CAAC;IAChC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,oBAAY,WAAW,GACpB,kBAAkB,GAClB,oBAAoB,GACpB,mBAAmB,GACnB,yBAAyB,GACzB,iBAAiB,CAAC"}

package/lib/driverError.js CHANGED Viewed

@@ -2,9 +2,88 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+import { FluidErrorTypes } from "@fluidframework/core-interfaces";
+// Omit `dataCorruptionError` and `dataProcessingError` from the list of values inherited from FluidErrorTypes
+const { dataCorruptionError, dataProcessingError, ...FluidErrorTypesExceptDataTypes } = FluidErrorTypes;
+/**
+ * Different error types the Driver may report out to the Host.
+ */
+export const DriverErrorTypes = {
+    // Inherit base error types
+    ...FluidErrorTypesExceptDataTypes,
+    /**
+     * Some non-categorized (below) networking error
+     * Include errors like  fatal server error (usually 500).
+     */
+    genericNetworkError: "genericNetworkError",
+    /**
+     * Access denied - user does not have enough privileges to open a file, or continue to operate on a file
+     */
+    authorizationError: "authorizationError",
+    /**
+     * File not found, or file deleted during session
+     */
+    fileNotFoundOrAccessDeniedError: "fileNotFoundOrAccessDeniedError",
+    /**
+     * We can not reach server due to computer being offline.
+     */
+    offlineError: "offlineError",
+    /*
+     * Unsupported client protocol
+     */
+    unsupportedClientProtocolVersion: "unsupportedClientProtocolVersion",
+    /**
+     * User does not have write permissions to a file, but is changing content of a file.
+     * That might be indication of some data store error - data stores should not generate ops in readonly mode.
+     */
+    writeError: "writeError",
+    /**
+     * A generic fetch failure that indicates we were not able to get a response from the server.
+     * This may be due to the client being offline (though, if we are able to detect offline state it will be
+     * logged as an offlineError instead).  Other possibilities could be DNS errors, malformed fetch request,
+     * CSP violation, etc.
+     */
+    fetchFailure: "fetchFailure",
+    /**
+     * This error occurs when token provider fails to fetch orderer token
+     */
+    fetchTokenError: "fetchTokenError",
+    /**
+     * Unexpected response from server. Either JSON is malformed, or some required properties are missing
+     */
+    incorrectServerResponse: "incorrectServerResponse",
+    /**
+     * This error occurs when the file is modified externally (not through Fluid protocol) in storage.
+     * It will occur in cases where client has some state or cache that is based on old content (identity) of a file,
+     * and storage / driver / loader detects such mismatch.
+     * When it's hit, client needs to forget all the knowledge about this file and start over.
+     */
+    fileOverwrittenInStorage: "fileOverwrittenInStorage",
+    /**
+     * The document is read-only and delta stream connection is forbidden.
+     */
+    deltaStreamConnectionForbidden: "deltaStreamConnectionForbidden",
+    /**
+     * The location of file/container can change on server. So if the file location moves and we try to access the old
+     * location, then this error is thrown to let the client know about the new location info.
+     */
+    locationRedirection: "locationRedirection",
+    /**
+     * When a file is not a Fluid file, but has Fluid extension such as ".note",
+     * server won't be able to open it and will return this error. The innerMostErrorCode will be
+     * "fluidInvalidSchema"
+     */
+    fluidInvalidSchema: "fluidInvalidSchema",
+    /**
+     * File is locked for read/write by storage, e.g. whole collection is locked and access denied.
+     */
+    fileIsLocked: "fileIsLocked",
+};
 /**
  * Driver Error types
  * Lists types that are likely to be used by all drivers
+ *
+ * @deprecated Use {@link (DriverErrorTypes:type)} instead.
  */
 export var DriverErrorType;
 (function (DriverErrorType) {

package/lib/driverError.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"driverError.js","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;;GAGG;AACH,MAAM,CAAN,IAAY,eAiGX;AAjGD,WAAY,eAAe;IAC1B;;OAEG;IACH,gDAA6B,CAAA;IAE7B;;;OAGG;IACH,8DAA2C,CAAA;IAE3C;;OAEG;IACH,4DAAyC,CAAA;IAEzC;;OAEG;IACH,sFAAmE,CAAA;IAEnE;;OAEG;IACH,sDAAmC,CAAA;IAEnC;;OAEG;IACH,gDAA6B,CAAA;IAE7B;;OAEG;IACH,wFAAqE,CAAA;IAErE;;;OAGG;IACH,4CAAyB,CAAA;IAEzB;;;;;OAKG;IACH,gDAA6B,CAAA;IAE7B;;OAEG;IACH,sDAAmC,CAAA;IAEnC;;OAEG;IACH,sEAAmD,CAAA;IAEnD;;;;;OAKG;IACH,wEAAqD,CAAA;IAErD;;OAEG;IACH,oFAAiE,CAAA;IAEjE;;;OAGG;IACH,8DAA2C,CAAA;IAE3C;;;;OAIG;IACH,4DAAyC,CAAA;IAEzC;;;OAGG;IACH,4CAAyB,CAAA;IAEzB;;OAEG;IACH,gDAA6B,CAAA;AAC9B,CAAC,EAjGW,eAAe,KAAf,eAAe,QAiG1B","sourcesContent":["/!\n Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n /\n\nimport { IResolvedUrl } from \"./urlResolver\";\n\n/\n Driver Error types\n * Lists types that are likely to be used by all drivers\n /\nexport enum DriverErrorType {\n\t/\n\t A fatal error with no specific interpretation covered by other DriverErrorType values\n\t /\n\tgenericError = \"genericError\",\n\n\t/\n\t Some non-categorized (below) networking error\n\t * Include errors like fatal server error (usually 500).\n\t /\n\tgenericNetworkError = \"genericNetworkError\",\n\n\t/\n\t Access denied - user does not have enough privileges to open a file, or continue to operate on a file\n\t /\n\tauthorizationError = \"authorizationError\",\n\n\t/\n\t File not found, or file deleted during session\n\t /\n\tfileNotFoundOrAccessDeniedError = \"fileNotFoundOrAccessDeniedError\",\n\n\t/\n\t Throttling error from server. Server is busy and is asking not to reconnect for some time\n\t /\n\tthrottlingError = \"throttlingError\",\n\n\t/\n\t We can not reach server due to computer being offline.\n\t /\n\tofflineError = \"offlineError\",\n\n\t/\n\t * Unsupported client protocol\n\t /\n\tunsupportedClientProtocolVersion = \"unsupportedClientProtocolVersion\",\n\n\t/\n\t User does not have write permissions to a file, but is changing content of a file.\n\t * That might be indication of some data store error - data stores should not generate ops in readonly mode.\n\t /\n\twriteError = \"writeError\",\n\n\t/\n\t A generic fetch failure that indicates we were not able to get a response from the server.\n\t * This may be due to the client being offline (though, if we are able to detect offline state it will be\n\t * logged as an offlineError instead). Other possibilities could be DNS errors, malformed fetch request,\n\t * CSP violation, etc.\n\t /\n\tfetchFailure = \"fetchFailure\",\n\n\t/\n\t This error occurs when token provider fails to fetch orderer token\n\t /\n\tfetchTokenError = \"fetchTokenError\",\n\n\t/\n\t Unexpected response from server. Either JSON is malformed, or some required properties are missing\n\t /\n\tincorrectServerResponse = \"incorrectServerResponse\",\n\n\t/\n\t This error occurs when the file is modified externally (not through Fluid protocol) in storage.\n\t * It will occur in cases where client has some state or cache that is based on old content (identity) of a file,\n\t * and storage / driver / loader detects such mismatch.\n\t * When it's hit, client needs to forget all the knowledge about this file and start over.\n\t /\n\tfileOverwrittenInStorage = \"fileOverwrittenInStorage\",\n\n\t/\n\t The document is read-only and delta stream connection is forbidden.\n\t /\n\tdeltaStreamConnectionForbidden = \"deltaStreamConnectionForbidden\",\n\n\t/\n\t The location of file/container can change on server. So if the file location moves and we try to access the old\n\t * location, then this error is thrown to let the client know about the new location info.\n\t /\n\tlocationRedirection = \"locationRedirection\",\n\n\t/\n\t When a file is not a Fluid file, but has Fluid extension such as \".note\",\n\t * server won't be able to open it and will return this error. The innerMostErrorCode will be\n\t * \"fluidInvalidSchema\"\n\t /\n\tfluidInvalidSchema = \"fluidInvalidSchema\",\n\n\t/\n\t Error indicating an API is being used improperly resulting in an invalid operation.\n\t * ! Should match the value of ContainerErrorType.usageError\n\t /\n\tusageError = \"usageError\",\n\n\t/\n\t File is locked for read/write by storage, e.g. whole collection is locked and access denied.\n\t /\n\tfileIsLocked = \"fileIsLocked\",\n}\n\n/\n Interface describing errors and warnings raised by any driver code.\n * Not expected to be implemented by a class or an object literal, but rather used in place of\n * any or unknown in various function signatures that pass errors around.\n \n \"Any\" in the interface name is a nod to the fact that errorType has lost its type constraint.\n * It will be either DriverErrorType or the specific driver's specialized error type enum,\n * but we can't reference a specific driver's error type enum in this code.\n /\nexport interface IAnyDriverError extends Omit<IDriverErrorBase, \"errorType\"> {\n\treadonly errorType: string;\n}\n\n/\n Base interface for all errors and warnings\n /\nexport interface IDriverErrorBase {\n\t/\n\t Classification of what type of error this is, used programmatically by consumers to interpret the error\n\t /\n\treadonly errorType: DriverErrorType;\n\n\t/\n\t Free-form error message\n\t /\n\treadonly message: string;\n\n\t/\n\t True indicates the caller may retry the failed action. False indicates it's a fatal error\n\t /\n\tcanRetry: boolean;\n\n\t/\n\t Best guess as to network conditions (online/offline) when the error arose.\n\t * See OnlineStatus enum in driver-utils package for expected values.\n\t /\n\tonline?: string;\n\n\t/\n\t Whether service was reachable and we got some response from service.\n\t /\n\tendpointReached?: boolean;\n}\n\nexport interface IThrottlingWarning extends IDriverErrorBase {\n\treadonly errorType: DriverErrorType.throttlingError;\n\treadonly retryAfterSeconds: number;\n}\n\nexport interface IGenericNetworkError extends IDriverErrorBase {\n\treadonly errorType: DriverErrorType.genericNetworkError;\n\treadonly statusCode?: number;\n}\n\nexport interface IAuthorizationError extends IDriverErrorBase {\n\treadonly errorType: DriverErrorType.authorizationError;\n\treadonly claims?: string;\n\treadonly tenantId?: string;\n}\n\nexport interface ILocationRedirectionError extends IDriverErrorBase {\n\treadonly errorType: DriverErrorType.locationRedirection;\n\treadonly redirectUrl: IResolvedUrl;\n}\n\n/\n Having this uber interface without types that have their own interfaces\n * allows compiler to differentiate interfaces based on error type\n */\nexport interface IDriverBasicError extends IDriverErrorBase {\n\treadonly errorType:\n\t\t\| DriverErrorType.genericError\n\t\t\| DriverErrorType.fileNotFoundOrAccessDeniedError\n\t\t\| DriverErrorType.offlineError\n\t\t\| DriverErrorType.unsupportedClientProtocolVersion\n\t\t\| DriverErrorType.writeError\n\t\t\| DriverErrorType.fetchFailure\n\t\t\| DriverErrorType.fetchTokenError\n\t\t\| DriverErrorType.incorrectServerResponse\n\t\t\| DriverErrorType.fileOverwrittenInStorage\n\t\t\| DriverErrorType.fluidInvalidSchema\n\t\t\| DriverErrorType.usageError\n\t\t\| DriverErrorType.fileIsLocked;\n\treadonly statusCode?: number;\n}\n\nexport type DriverError =\n\t\| IThrottlingWarning\n\t\| IGenericNetworkError\n\t\| IAuthorizationError\n\t\| ILocationRedirectionError\n\t\| IDriverBasicError;\n"]}
1	+ {"version":3,"file":"driverError.js","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAIlE,8GAA8G;AAC9G,MAAM,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,GAAG,8BAA8B,EAAE,GACpF,eAAe,CAAC;AAEjB;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC/B,2BAA2B;IAC3B,GAAG,8BAA8B;IAEjC;;;OAGG;IACH,mBAAmB,EAAE,qBAAqB;IAE1C;;OAEG;IACH,kBAAkB,EAAE,oBAAoB;IAExC;;OAEG;IACH,+BAA+B,EAAE,iCAAiC;IAElE;;OAEG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,gCAAgC,EAAE,kCAAkC;IAEpE;;;OAGG;IACH,UAAU,EAAE,YAAY;IAExB;;;;;OAKG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,eAAe,EAAE,iBAAiB;IAElC;;OAEG;IACH,uBAAuB,EAAE,yBAAyB;IAElD;;;;;OAKG;IACH,wBAAwB,EAAE,0BAA0B;IAEpD;;OAEG;IACH,8BAA8B,EAAE,gCAAgC;IAEhE;;;OAGG;IACH,mBAAmB,EAAE,qBAAqB;IAE1C;;;;OAIG;IACH,kBAAkB,EAAE,oBAAoB;IAExC;;OAEG;IACH,YAAY,EAAE,cAAc;CACnB,CAAC;AAGX;;;;;GAKG;AACH,MAAM,CAAN,IAAY,eAiGX;AAjGD,WAAY,eAAe;IAC1B;;OAEG;IACH,gDAA6B,CAAA;IAE7B;;;OAGG;IACH,8DAA2C,CAAA;IAE3C;;OAEG;IACH,4DAAyC,CAAA;IAEzC;;OAEG;IACH,sFAAmE,CAAA;IAEnE;;OAEG;IACH,sDAAmC,CAAA;IAEnC;;OAEG;IACH,gDAA6B,CAAA;IAE7B;;OAEG;IACH,wFAAqE,CAAA;IAErE;;;OAGG;IACH,4CAAyB,CAAA;IAEzB;;;;;OAKG;IACH,gDAA6B,CAAA;IAE7B;;OAEG;IACH,sDAAmC,CAAA;IAEnC;;OAEG;IACH,sEAAmD,CAAA;IAEnD;;;;;OAKG;IACH,wEAAqD,CAAA;IAErD;;OAEG;IACH,oFAAiE,CAAA;IAEjE;;;OAGG;IACH,8DAA2C,CAAA;IAE3C;;;;OAIG;IACH,4DAAyC,CAAA;IAEzC;;;OAGG;IACH,4CAAyB,CAAA;IAEzB;;OAEG;IACH,gDAA6B,CAAA;AAC9B,CAAC,EAjGW,eAAe,KAAf,eAAe,QAiG1B","sourcesContent":["/!\n Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n /\n\nimport { FluidErrorTypes } from \"@fluidframework/core-interfaces\";\n\nimport { IResolvedUrl } from \"./urlResolver\";\n\n// Omit `dataCorruptionError` and `dataProcessingError` from the list of values inherited from FluidErrorTypes\nconst { dataCorruptionError, dataProcessingError, ...FluidErrorTypesExceptDataTypes } =\n\tFluidErrorTypes;\n\n/\n Different error types the Driver may report out to the Host.\n /\nexport const DriverErrorTypes = {\n\t// Inherit base error types\n\t...FluidErrorTypesExceptDataTypes,\n\n\t/\n\t Some non-categorized (below) networking error\n\t * Include errors like fatal server error (usually 500).\n\t /\n\tgenericNetworkError: \"genericNetworkError\",\n\n\t/\n\t Access denied - user does not have enough privileges to open a file, or continue to operate on a file\n\t /\n\tauthorizationError: \"authorizationError\",\n\n\t/\n\t File not found, or file deleted during session\n\t /\n\tfileNotFoundOrAccessDeniedError: \"fileNotFoundOrAccessDeniedError\",\n\n\t/\n\t We can not reach server due to computer being offline.\n\t /\n\tofflineError: \"offlineError\",\n\n\t/\n\t * Unsupported client protocol\n\t /\n\tunsupportedClientProtocolVersion: \"unsupportedClientProtocolVersion\",\n\n\t/\n\t User does not have write permissions to a file, but is changing content of a file.\n\t * That might be indication of some data store error - data stores should not generate ops in readonly mode.\n\t /\n\twriteError: \"writeError\",\n\n\t/\n\t A generic fetch failure that indicates we were not able to get a response from the server.\n\t * This may be due to the client being offline (though, if we are able to detect offline state it will be\n\t * logged as an offlineError instead). Other possibilities could be DNS errors, malformed fetch request,\n\t * CSP violation, etc.\n\t /\n\tfetchFailure: \"fetchFailure\",\n\n\t/\n\t This error occurs when token provider fails to fetch orderer token\n\t /\n\tfetchTokenError: \"fetchTokenError\",\n\n\t/\n\t Unexpected response from server. Either JSON is malformed, or some required properties are missing\n\t /\n\tincorrectServerResponse: \"incorrectServerResponse\",\n\n\t/\n\t This error occurs when the file is modified externally (not through Fluid protocol) in storage.\n\t * It will occur in cases where client has some state or cache that is based on old content (identity) of a file,\n\t * and storage / driver / loader detects such mismatch.\n\t * When it's hit, client needs to forget all the knowledge about this file and start over.\n\t /\n\tfileOverwrittenInStorage: \"fileOverwrittenInStorage\",\n\n\t/\n\t The document is read-only and delta stream connection is forbidden.\n\t /\n\tdeltaStreamConnectionForbidden: \"deltaStreamConnectionForbidden\",\n\n\t/\n\t The location of file/container can change on server. So if the file location moves and we try to access the old\n\t * location, then this error is thrown to let the client know about the new location info.\n\t /\n\tlocationRedirection: \"locationRedirection\",\n\n\t/\n\t When a file is not a Fluid file, but has Fluid extension such as \".note\",\n\t * server won't be able to open it and will return this error. The innerMostErrorCode will be\n\t * \"fluidInvalidSchema\"\n\t /\n\tfluidInvalidSchema: \"fluidInvalidSchema\",\n\n\t/\n\t File is locked for read/write by storage, e.g. whole collection is locked and access denied.\n\t /\n\tfileIsLocked: \"fileIsLocked\",\n} as const;\nexport type DriverErrorTypes = typeof DriverErrorTypes[keyof typeof DriverErrorTypes];\n\n/\n Driver Error types\n * Lists types that are likely to be used by all drivers\n \n @deprecated Use {@link (DriverErrorTypes:type)} instead.\n /\nexport enum DriverErrorType {\n\t/\n\t A fatal error with no specific interpretation covered by other DriverErrorType values\n\t /\n\tgenericError = \"genericError\",\n\n\t/\n\t Some non-categorized (below) networking error\n\t * Include errors like fatal server error (usually 500).\n\t /\n\tgenericNetworkError = \"genericNetworkError\",\n\n\t/\n\t Access denied - user does not have enough privileges to open a file, or continue to operate on a file\n\t /\n\tauthorizationError = \"authorizationError\",\n\n\t/\n\t File not found, or file deleted during session\n\t /\n\tfileNotFoundOrAccessDeniedError = \"fileNotFoundOrAccessDeniedError\",\n\n\t/\n\t Throttling error from server. Server is busy and is asking not to reconnect for some time\n\t /\n\tthrottlingError = \"throttlingError\",\n\n\t/\n\t We can not reach server due to computer being offline.\n\t /\n\tofflineError = \"offlineError\",\n\n\t/\n\t * Unsupported client protocol\n\t /\n\tunsupportedClientProtocolVersion = \"unsupportedClientProtocolVersion\",\n\n\t/\n\t User does not have write permissions to a file, but is changing content of a file.\n\t * That might be indication of some data store error - data stores should not generate ops in readonly mode.\n\t /\n\twriteError = \"writeError\",\n\n\t/\n\t A generic fetch failure that indicates we were not able to get a response from the server.\n\t * This may be due to the client being offline (though, if we are able to detect offline state it will be\n\t * logged as an offlineError instead). Other possibilities could be DNS errors, malformed fetch request,\n\t * CSP violation, etc.\n\t /\n\tfetchFailure = \"fetchFailure\",\n\n\t/\n\t This error occurs when token provider fails to fetch orderer token\n\t /\n\tfetchTokenError = \"fetchTokenError\",\n\n\t/\n\t Unexpected response from server. Either JSON is malformed, or some required properties are missing\n\t /\n\tincorrectServerResponse = \"incorrectServerResponse\",\n\n\t/\n\t This error occurs when the file is modified externally (not through Fluid protocol) in storage.\n\t * It will occur in cases where client has some state or cache that is based on old content (identity) of a file,\n\t * and storage / driver / loader detects such mismatch.\n\t * When it's hit, client needs to forget all the knowledge about this file and start over.\n\t /\n\tfileOverwrittenInStorage = \"fileOverwrittenInStorage\",\n\n\t/\n\t The document is read-only and delta stream connection is forbidden.\n\t /\n\tdeltaStreamConnectionForbidden = \"deltaStreamConnectionForbidden\",\n\n\t/\n\t The location of file/container can change on server. So if the file location moves and we try to access the old\n\t * location, then this error is thrown to let the client know about the new location info.\n\t /\n\tlocationRedirection = \"locationRedirection\",\n\n\t/\n\t When a file is not a Fluid file, but has Fluid extension such as \".note\",\n\t * server won't be able to open it and will return this error. The innerMostErrorCode will be\n\t * \"fluidInvalidSchema\"\n\t /\n\tfluidInvalidSchema = \"fluidInvalidSchema\",\n\n\t/\n\t Error indicating an API is being used improperly resulting in an invalid operation.\n\t * ! Should match the value of ContainerErrorType.usageError\n\t /\n\tusageError = \"usageError\",\n\n\t/\n\t File is locked for read/write by storage, e.g. whole collection is locked and access denied.\n\t /\n\tfileIsLocked = \"fileIsLocked\",\n}\n\n/\n Interface describing errors and warnings raised by any driver code.\n * Not expected to be implemented by a class or an object literal, but rather used in place of\n * any or unknown in various function signatures that pass errors around.\n \n \"Any\" in the interface name is a nod to the fact that errorType has lost its type constraint.\n * It will be either DriverErrorType or the specific driver's specialized error type enum,\n * but we can't reference a specific driver's error type enum in this code.\n /\nexport interface IAnyDriverError extends Omit<IDriverErrorBase, \"errorType\"> {\n\treadonly errorType: string;\n}\n\n/\n Base interface for all errors and warnings\n /\nexport interface IDriverErrorBase {\n\t/\n\t Classification of what type of error this is, used programmatically by consumers to interpret the error.\n\t \n\t @privateRemarks TODO: use {@link DriverErrorTypes} instead (breaking change).\n\t /\n\treadonly errorType: DriverErrorType;\n\n\t/\n\t Free-form error message\n\t /\n\treadonly message: string;\n\n\t/\n\t True indicates the caller may retry the failed action. False indicates it's a fatal error\n\t /\n\tcanRetry: boolean;\n\n\t/\n\t Best guess as to network conditions (online/offline) when the error arose.\n\t * See OnlineStatus enum in driver-utils package for expected values.\n\t /\n\tonline?: string;\n\n\t/\n\t Whether service was reachable and we got some response from service.\n\t /\n\tendpointReached?: boolean;\n}\n\nexport interface IThrottlingWarning extends IDriverErrorBase {\n\treadonly errorType: DriverErrorType.throttlingError;\n\treadonly retryAfterSeconds: number;\n}\n\nexport interface IGenericNetworkError extends IDriverErrorBase {\n\treadonly errorType: DriverErrorType.genericNetworkError;\n\treadonly statusCode?: number;\n}\n\nexport interface IAuthorizationError extends IDriverErrorBase {\n\treadonly errorType: DriverErrorType.authorizationError;\n\treadonly claims?: string;\n\treadonly tenantId?: string;\n}\n\nexport interface ILocationRedirectionError extends IDriverErrorBase {\n\treadonly errorType: DriverErrorType.locationRedirection;\n\treadonly redirectUrl: IResolvedUrl;\n}\n\n/\n Having this uber interface without types that have their own interfaces\n * allows compiler to differentiate interfaces based on error type\n */\nexport interface IDriverBasicError extends IDriverErrorBase {\n\treadonly errorType:\n\t\t\| DriverErrorType.genericError\n\t\t\| DriverErrorType.fileNotFoundOrAccessDeniedError\n\t\t\| DriverErrorType.offlineError\n\t\t\| DriverErrorType.unsupportedClientProtocolVersion\n\t\t\| DriverErrorType.writeError\n\t\t\| DriverErrorType.fetchFailure\n\t\t\| DriverErrorType.fetchTokenError\n\t\t\| DriverErrorType.incorrectServerResponse\n\t\t\| DriverErrorType.fileOverwrittenInStorage\n\t\t\| DriverErrorType.fluidInvalidSchema\n\t\t\| DriverErrorType.usageError\n\t\t\| DriverErrorType.fileIsLocked;\n\treadonly statusCode?: number;\n}\n\nexport type DriverError =\n\t\| IThrottlingWarning\n\t\| IGenericNetworkError\n\t\| IAuthorizationError\n\t\| ILocationRedirectionError\n\t\| IDriverBasicError;\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 { DriverError, DriverErrorType, IAnyDriverError, IAuthorizationError, IDriverErrorBase, IDriverBasicError, IGenericNetworkError, ILocationRedirectionError, IThrottlingWarning, } from "./driverError";
+export { DriverError, DriverErrorType, DriverErrorTypes, IAnyDriverError, IAuthorizationError, IDriverErrorBase, IDriverBasicError, IGenericNetworkError, ILocationRedirectionError, IThrottlingWarning, } from "./driverError";
 export { FetchSource, FiveDaysMs, IDeltasFetchResult, IDeltaStorageService, IDocumentDeltaConnection, IDocumentDeltaConnectionEvents, IDocumentDeltaStorageService, IDocumentService, IDocumentServiceFactory, IDocumentServicePolicies, IDocumentStorageService, IDocumentStorageServicePolicies, IStream, IStreamResult, ISummaryContext, LoaderCachingPolicy, } from "./storage";
 export { DriverPreCheckInfo, DriverHeader, IContainerPackageInfo, IDriverHeader, IResolvedUrl, IUrlResolver, } from "./urlResolver";
 //# sourceMappingURL=index.d.ts.map

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,EACN,WAAW,EACX,eAAe,EACf,eAAe,EACf,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,EACpB,yBAAyB,EACzB,kBAAkB,GAClB,MAAM,eAAe,CAAC;AACvB,OAAO,EACN,WAAW,EACX,UAAU,EACV,kBAAkB,EAClB,oBAAoB,EACpB,wBAAwB,EACxB,8BAA8B,EAC9B,4BAA4B,EAC5B,gBAAgB,EAChB,uBAAuB,EACvB,wBAAwB,EACxB,uBAAuB,EACvB,+BAA+B,EAC/B,OAAO,EACP,aAAa,EACb,eAAe,EACf,mBAAmB,GACnB,MAAM,WAAW,CAAC;AACnB,OAAO,EACN,kBAAkB,EAClB,YAAY,EACZ,qBAAqB,EACrB,aAAa,EACb,YAAY,EACZ,YAAY,GACZ,MAAM,eAAe,CAAC"}
1	+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,WAAW,EACX,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,EACpB,yBAAyB,EACzB,kBAAkB,GAClB,MAAM,eAAe,CAAC;AACvB,OAAO,EACN,WAAW,EACX,UAAU,EACV,kBAAkB,EAClB,oBAAoB,EACpB,wBAAwB,EACxB,8BAA8B,EAC9B,4BAA4B,EAC5B,gBAAgB,EAChB,uBAAuB,EACvB,wBAAwB,EACxB,uBAAuB,EACvB,+BAA+B,EAC/B,OAAO,EACP,aAAa,EACb,eAAe,EACf,mBAAmB,GACnB,MAAM,WAAW,CAAC;AACnB,OAAO,EACN,kBAAkB,EAClB,YAAY,EACZ,qBAAqB,EACrB,aAAa,EACb,YAAY,EACZ,YAAY,GACZ,MAAM,eAAe,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 { DriverErrorType, } from "./driverError";
+export { DriverErrorType, DriverErrorTypes, } from "./driverError";
 export { FetchSource, LoaderCachingPolicy, } from "./storage";
 export { DriverHeader, } from "./urlResolver";
 //# sourceMappingURL=index.js.map

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,EAEN,eAAe,~~GAQf~~,MAAM,eAAe,CAAC;AACvB,OAAO,EACN,WAAW,EAeX,mBAAmB,GACnB,MAAM,WAAW,CAAC;AACnB,OAAO,EAEN,YAAY,GAKZ,MAAM,eAAe,CAAC","sourcesContent":["/!\n Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tDriverError,\n\tDriverErrorType,\n\tIAnyDriverError,\n\tIAuthorizationError,\n\tIDriverErrorBase,\n\tIDriverBasicError,\n\tIGenericNetworkError,\n\tILocationRedirectionError,\n\tIThrottlingWarning,\n} from \"./driverError\";\nexport {\n\tFetchSource,\n\tFiveDaysMs,\n\tIDeltasFetchResult,\n\tIDeltaStorageService,\n\tIDocumentDeltaConnection,\n\tIDocumentDeltaConnectionEvents,\n\tIDocumentDeltaStorageService,\n\tIDocumentService,\n\tIDocumentServiceFactory,\n\tIDocumentServicePolicies,\n\tIDocumentStorageService,\n\tIDocumentStorageServicePolicies,\n\tIStream,\n\tIStreamResult,\n\tISummaryContext,\n\tLoaderCachingPolicy,\n} from \"./storage\";\nexport {\n\tDriverPreCheckInfo,\n\tDriverHeader,\n\tIContainerPackageInfo,\n\tIDriverHeader,\n\tIResolvedUrl,\n\tIUrlResolver,\n} from \"./urlResolver\";\n"]}
1	+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAEN,eAAe,EACf,gBAAgB,GAQhB,MAAM,eAAe,CAAC;AACvB,OAAO,EACN,WAAW,EAeX,mBAAmB,GACnB,MAAM,WAAW,CAAC;AACnB,OAAO,EAEN,YAAY,GAKZ,MAAM,eAAe,CAAC","sourcesContent":["/!\n Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tDriverError,\n\tDriverErrorType,\n\tDriverErrorTypes,\n\tIAnyDriverError,\n\tIAuthorizationError,\n\tIDriverErrorBase,\n\tIDriverBasicError,\n\tIGenericNetworkError,\n\tILocationRedirectionError,\n\tIThrottlingWarning,\n} from \"./driverError\";\nexport {\n\tFetchSource,\n\tFiveDaysMs,\n\tIDeltasFetchResult,\n\tIDeltaStorageService,\n\tIDocumentDeltaConnection,\n\tIDocumentDeltaConnectionEvents,\n\tIDocumentDeltaStorageService,\n\tIDocumentService,\n\tIDocumentServiceFactory,\n\tIDocumentServicePolicies,\n\tIDocumentStorageService,\n\tIDocumentStorageServicePolicies,\n\tIStream,\n\tIStreamResult,\n\tISummaryContext,\n\tLoaderCachingPolicy,\n} from \"./storage\";\nexport {\n\tDriverPreCheckInfo,\n\tDriverHeader,\n\tIContainerPackageInfo,\n\tIDriverHeader,\n\tIResolvedUrl,\n\tIUrlResolver,\n} from \"./urlResolver\";\n"]}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/driver-definitions",
-  "version": "2.0.0-internal.6.2.0",
+  "version": "2.0.0-internal.6.3.0",
   "description": "Fluid driver definitions",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -15,17 +15,16 @@
   "module": "lib/index.js",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "@fluidframework/core-interfaces": ">=2.0.0-internal.6.2.0 <2.0.0-internal.6.3.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-internal.6.3.0 <2.0.0-internal.6.4.0",
     "@fluidframework/protocol-definitions": "^1.1.0"
   },
   "devDependencies": {
-    "@fluid-tools/build-cli": "^0.23.0",
+    "@fluid-tools/build-cli": "^0.22.0",
     "@fluidframework/build-common": "^2.0.0",
-    "@fluidframework/build-tools": "^0.23.0",
+    "@fluidframework/build-tools": "^0.22.0",
     "@fluidframework/driver-definitions-previous": "npm:@fluidframework/driver-definitions@2.0.0-internal.6.1.1",
     "@fluidframework/eslint-config-fluid": "^2.1.0",
     "@microsoft/api-extractor": "^7.34.4",
-    "concurrently": "^7.6.0",
     "copyfiles": "^2.4.1",
     "eslint": "~8.6.0",
     "prettier": "~2.6.2",
@@ -52,7 +51,7 @@
     "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
     "ci:test": "echo No test for this package",
     "ci:test:coverage": "echo No test for this package",
-    "clean": "rimraf --glob \"dist\" \"lib\" \"*.tsbuildinfo\" \"*.build.log\"",
+    "clean": "rimraf --glob 'dist' 'lib' '*.tsbuildinfo' '*.build.log' '_api-extractor-temp'",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "format": "npm run prettier:fix",

package/src/driverError.ts CHANGED Viewed

@@ -3,11 +3,109 @@
  * Licensed under the MIT License.
  */
+import { FluidErrorTypes } from "@fluidframework/core-interfaces";
 import { IResolvedUrl } from "./urlResolver";
+// Omit `dataCorruptionError` and `dataProcessingError` from the list of values inherited from FluidErrorTypes
+const { dataCorruptionError, dataProcessingError, ...FluidErrorTypesExceptDataTypes } =
+	FluidErrorTypes;
+/**
+ * Different error types the Driver may report out to the Host.
+ */
+export const DriverErrorTypes = {
+	// Inherit base error types
+	...FluidErrorTypesExceptDataTypes,
+	/**
+	 * Some non-categorized (below) networking error
+	 * Include errors like  fatal server error (usually 500).
+	 */
+	genericNetworkError: "genericNetworkError",
+	/**
+	 * Access denied - user does not have enough privileges to open a file, or continue to operate on a file
+	 */
+	authorizationError: "authorizationError",
+	/**
+	 * File not found, or file deleted during session
+	 */
+	fileNotFoundOrAccessDeniedError: "fileNotFoundOrAccessDeniedError",
+	/**
+	 * We can not reach server due to computer being offline.
+	 */
+	offlineError: "offlineError",
+	/*
+	 * Unsupported client protocol
+	 */
+	unsupportedClientProtocolVersion: "unsupportedClientProtocolVersion",
+	/**
+	 * User does not have write permissions to a file, but is changing content of a file.
+	 * That might be indication of some data store error - data stores should not generate ops in readonly mode.
+	 */
+	writeError: "writeError",
+	/**
+	 * A generic fetch failure that indicates we were not able to get a response from the server.
+	 * This may be due to the client being offline (though, if we are able to detect offline state it will be
+	 * logged as an offlineError instead).  Other possibilities could be DNS errors, malformed fetch request,
+	 * CSP violation, etc.
+	 */
+	fetchFailure: "fetchFailure",
+	/**
+	 * This error occurs when token provider fails to fetch orderer token
+	 */
+	fetchTokenError: "fetchTokenError",
+	/**
+	 * Unexpected response from server. Either JSON is malformed, or some required properties are missing
+	 */
+	incorrectServerResponse: "incorrectServerResponse",
+	/**
+	 * This error occurs when the file is modified externally (not through Fluid protocol) in storage.
+	 * It will occur in cases where client has some state or cache that is based on old content (identity) of a file,
+	 * and storage / driver / loader detects such mismatch.
+	 * When it's hit, client needs to forget all the knowledge about this file and start over.
+	 */
+	fileOverwrittenInStorage: "fileOverwrittenInStorage",
+	/**
+	 * The document is read-only and delta stream connection is forbidden.
+	 */
+	deltaStreamConnectionForbidden: "deltaStreamConnectionForbidden",
+	/**
+	 * The location of file/container can change on server. So if the file location moves and we try to access the old
+	 * location, then this error is thrown to let the client know about the new location info.
+	 */
+	locationRedirection: "locationRedirection",
+	/**
+	 * When a file is not a Fluid file, but has Fluid extension such as ".note",
+	 * server won't be able to open it and will return this error. The innerMostErrorCode will be
+	 * "fluidInvalidSchema"
+	 */
+	fluidInvalidSchema: "fluidInvalidSchema",
+	/**
+	 * File is locked for read/write by storage, e.g. whole collection is locked and access denied.
+	 */
+	fileIsLocked: "fileIsLocked",
+} as const;
+export type DriverErrorTypes = typeof DriverErrorTypes[keyof typeof DriverErrorTypes];
 /**
  * Driver Error types
  * Lists types that are likely to be used by all drivers
+ *
+ * @deprecated Use {@link (DriverErrorTypes:type)} instead.
  */
 export enum DriverErrorType {
 	/**
@@ -126,7 +224,9 @@ export interface IAnyDriverError extends Omit<IDriverErrorBase, "errorType"> {
  */
 export interface IDriverErrorBase {
 	/**
-	 * Classification of what type of error this is, used programmatically by consumers to interpret the error
+	 * Classification of what type of error this is, used programmatically by consumers to interpret the error.
+	 *
+	 * @privateRemarks TODO: use {@link DriverErrorTypes} instead (breaking change).
 	 */
 	readonly errorType: DriverErrorType;

package/src/index.ts CHANGED Viewed

@@ -6,6 +6,7 @@
 export {
 	DriverError,
 	DriverErrorType,
+	DriverErrorTypes,
 	IAnyDriverError,
 	IAuthorizationError,
 	IDriverErrorBase,