@fluidframework/driver-definitions 2.0.0-dev-rc.1.0.0.228517 → 2.0.0-dev-rc.1.0.0.232845

package/lib/driver-definitions-untrimmed.d.mts

@@ -5,6 +5,7 @@ import { ICreateBlobResponse } from '@fluidframework/protocol-definitions';
 import { IDisposable } from '@fluidframework/core-interfaces';
 import { IDocumentMessage } from '@fluidframework/protocol-definitions';
 import { IErrorEvent } from '@fluidframework/core-interfaces';
+import { IEvent } from '@fluidframework/core-interfaces';
 import { IEventProvider } from '@fluidframework/core-interfaces';
 import { INack } from '@fluidframework/protocol-definitions';
 import { IRequest } from '@fluidframework/core-interfaces';
@@ -23,97 +24,6 @@ import { IVersion } from '@fluidframework/protocol-definitions';
  */
 export declare type DriverError = IThrottlingWarning | IGenericNetworkError | IAuthorizationError | ILocationRedirectionError | IDriverBasicError;
 
-/**
- * Driver Error types
- * Lists types that are likely to be used by all drivers
- *
- * @deprecated Use {@link (DriverErrorTypes:type)} instead.
- * @public
- */
-export declare enum DriverErrorType {
-    /**
-     * A fatal error with no specific interpretation covered by other DriverErrorType values
-     */
-    genericError = "genericError",
-    /**
-     * 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",
-    /**
-     * Throttling error from server. Server is busy and is asking not to reconnect for some time
-     */
-    throttlingError = "throttlingError",
-    /**
-     * We can not reach server due to computer being offline.
-     */
-    offlineError = "offlineError",
-    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",
-    /**
-     * Error indicating an API is being used improperly resulting in an invalid operation.
-     * ! Should match the value of ContainerErrorType.usageError
-     */
-    usageError = "usageError",
-    /**
-     * File is locked for read/write by storage, e.g. whole collection is locked and access denied.
-     */
-    fileIsLocked = "fileIsLocked",
-    /**
-     * Storage is out of space
-     */
-    outOfStorageError = "outOfStorageError"
-}
-
 /**
  * Different error types the Driver may report out to the Host.
  * @public
@@ -238,11 +148,13 @@ export declare type FiveDaysMs = 432000000;
 
 /**
  * Interface describing errors and warnings raised by any driver code.
+ *
+ * @remarks
  * Not expected to be implemented by a class or an object literal, but rather used in place of
  * any or unknown in various function signatures that pass errors around.
  *
  * "Any" in the interface name is a nod to the fact that errorType has lost its type constraint.
- * It will be either DriverErrorType or the specific driver's specialized error type enum,
+ * It will be either {@link @fluidframework/driver-definitions#(DriverErrorTypes:variable)} or the specific driver's specialized error type enum,
  * but we can't reference a specific driver's error type enum in this code.
  * @public
  */
@@ -254,7 +166,7 @@ export declare interface IAnyDriverError extends Omit<IDriverErrorBase, "errorTy
  * @alpha
  */
 export declare interface IAuthorizationError extends IDriverErrorBase {
-    readonly errorType: DriverErrorType.authorizationError;
+    readonly errorType: typeof DriverErrorTypes.authorizationError;
     readonly claims?: string;
     readonly tenantId?: string;
 }
@@ -405,7 +317,7 @@ export declare interface IDocumentDeltaStorageService {
 /**
  * @alpha
  */
-export declare interface IDocumentService {
+export declare interface IDocumentService extends IEventProvider<IDocumentServiceEvents> {
     resolvedUrl: IResolvedUrl;
     /**
      * Policies implemented/instructed by driver.
@@ -436,6 +348,18 @@ export declare interface IDocumentService {
     dispose(error?: any): void;
 }
 
+/**
+ * Events emitted by {@link IDocumentService}.
+ * @alpha
+ */
+export declare interface IDocumentServiceEvents extends IEvent {
+    /**
+     * This event is used to communicate any metadata related to the container. We might have received metadata from the service.
+     * Read more info on this event from here `IContainer.containerMetadata`.
+     */
+    (event: "metadataUpdate", listener: (metadata: Record<string, string>) => void): any;
+}
+
 /**
  * @alpha
  */
@@ -478,6 +402,12 @@ export declare interface IDocumentServicePolicies {
      * Summarizer uploads the protocol tree too when summarizing.
      */
     readonly summarizeProtocolTree?: boolean;
+    /**
+     * Whether the driver supports the new getSnapshot api which returns snapshot which
+     * contains all contents along with the snapshot tree. Enable this by default when the
+     * driver can fully support the api.
+     */
+    readonly supportGetSnapshotApi?: boolean;
 }
 
 /**
@@ -497,6 +427,13 @@ export declare interface IDocumentStorageService extends Partial<IDisposable> {
      * in debugging purposes to see why this call was made.
      */
     getSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null>;
+    /**
+     * Returns the snapshot which can contain other artifacts too like blob contents, ops etc. It is different from
+     * `getSnapshotTree` api in that, that API only returns the snapshot tree from the snapshot.
+     * @param snapshotFetchOptions - Options specified by the caller to specify and want certain behavior from the
+     * driver when fetching the snapshot.
+     */
+    getSnapshot?(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot>;
     /**
      * Retrieves all versions of the document starting at the specified versionId - or null if from the head
      * @param versionId - Version id of the requested version.
@@ -558,7 +495,7 @@ export declare interface IDocumentStorageServicePolicies {
  * @alpha
  */
 export declare interface IDriverBasicError extends IDriverErrorBase {
-    readonly errorType: DriverErrorType.genericError | DriverErrorType.fileNotFoundOrAccessDeniedError | DriverErrorType.offlineError | DriverErrorType.unsupportedClientProtocolVersion | DriverErrorType.writeError | DriverErrorType.fetchFailure | DriverErrorType.fetchTokenError | DriverErrorType.incorrectServerResponse | DriverErrorType.fileOverwrittenInStorage | DriverErrorType.fluidInvalidSchema | DriverErrorType.usageError | DriverErrorType.fileIsLocked | DriverErrorType.outOfStorageError;
+    readonly errorType: typeof DriverErrorTypes.genericError | typeof DriverErrorTypes.fileNotFoundOrAccessDeniedError | typeof DriverErrorTypes.offlineError | typeof DriverErrorTypes.unsupportedClientProtocolVersion | typeof DriverErrorTypes.writeError | typeof DriverErrorTypes.fetchFailure | typeof DriverErrorTypes.fetchTokenError | typeof DriverErrorTypes.incorrectServerResponse | typeof DriverErrorTypes.fileOverwrittenInStorage | typeof DriverErrorTypes.fluidInvalidSchema | typeof DriverErrorTypes.usageError | typeof DriverErrorTypes.fileIsLocked | typeof DriverErrorTypes.outOfStorageError;
     readonly statusCode?: number;
 }
 
@@ -572,7 +509,7 @@ export declare interface IDriverErrorBase {
      *
      * @privateRemarks TODO: use {@link DriverErrorTypes} instead (breaking change).
      */
-    readonly errorType: DriverErrorType;
+    readonly errorType: DriverErrorTypes;
     /**
      * Free-form error message
      */
@@ -604,7 +541,7 @@ export declare interface IDriverHeader {
  * @alpha
  */
 export declare interface IGenericNetworkError extends IDriverErrorBase {
-    readonly errorType: DriverErrorType.genericNetworkError;
+    readonly errorType: typeof DriverErrorTypes.genericNetworkError;
     readonly statusCode?: number;
 }
 
@@ -612,7 +549,7 @@ export declare interface IGenericNetworkError extends IDriverErrorBase {
  * @alpha
  */
 export declare interface ILocationRedirectionError extends IDriverErrorBase {
-    readonly errorType: DriverErrorType.locationRedirection;
+    readonly errorType: typeof DriverErrorTypes.locationRedirection;
     readonly redirectUrl: IResolvedUrl;
 }
 
@@ -634,6 +571,47 @@ export declare interface IResolvedUrl {
     };
 }
 
+/**
+ * @alpha
+ */
+export declare interface ISnapshot {
+    snapshotTree: ISnapshotTree;
+    blobContents: Map<string, ArrayBuffer>;
+    ops: ISequencedDocumentMessage[];
+    /**
+     * Sequence number of the snapshot
+     */
+    sequenceNumber: number | undefined;
+    /**
+     * Sequence number for the latest op/snapshot for the file in ODSP
+     */
+    latestSequenceNumber: number | undefined;
+    snapshotFormatV: 1;
+}
+
+/**
+ * Snapshot fetch options which are used to communicate different things to the driver
+ * when fetching the snapshot.
+ * @alpha
+ */
+export declare interface ISnapshotFetchOptions {
+    /**
+     * Indicates scenario in which the snapshot is fetched. It is a free form string  mostly
+     * used for telemetry purposes.
+     */
+    scenarioName?: string;
+    /**
+     * Tell driver to cache the fetched snapshot. Driver is supposed to cache the fetched snapshot if this is
+     * set to true. If undefined, then it is upto the driver, to cache it or not.
+     */
+    cacheSnapshot?: boolean;
+    /**
+     * Version of the snapshot to be fetched. Certain storage services just keep 1 snapshot for the
+     * container, so specifying version is not necessary for storage services.
+     */
+    versionId?: string;
+}
+
 /**
  * Read interface for the Queue
  * @alpha
@@ -673,7 +651,7 @@ export declare interface ISummaryContext {
  * @alpha
  */
 export declare interface IThrottlingWarning extends IDriverErrorBase {
-    readonly errorType: DriverErrorType.throttlingError;
+    readonly errorType: typeof DriverErrorTypes.throttlingError;
     readonly retryAfterSeconds: number;
 }
 

package/lib/driverError.d.mts

@@ -84,103 +84,15 @@ export declare const DriverErrorTypes: {
  * @public
  */
 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.
- * @public
- */
-export declare enum DriverErrorType {
-    /**
-     * A fatal error with no specific interpretation covered by other DriverErrorType values
-     */
-    genericError = "genericError",
-    /**
-     * 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",
-    /**
-     * Throttling error from server. Server is busy and is asking not to reconnect for some time
-     */
-    throttlingError = "throttlingError",
-    /**
-     * We can not reach server due to computer being offline.
-     */
-    offlineError = "offlineError",
-    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",
-    /**
-     * Error indicating an API is being used improperly resulting in an invalid operation.
-     * ! Should match the value of ContainerErrorType.usageError
-     */
-    usageError = "usageError",
-    /**
-     * File is locked for read/write by storage, e.g. whole collection is locked and access denied.
-     */
-    fileIsLocked = "fileIsLocked",
-    /**
-     * Storage is out of space
-     */
-    outOfStorageError = "outOfStorageError"
-}
 /**
  * Interface describing errors and warnings raised by any driver code.
+ *
+ * @remarks
  * Not expected to be implemented by a class or an object literal, but rather used in place of
  * any or unknown in various function signatures that pass errors around.
  *
  * "Any" in the interface name is a nod to the fact that errorType has lost its type constraint.
- * It will be either DriverErrorType or the specific driver's specialized error type enum,
+ * It will be either {@link @fluidframework/driver-definitions#(DriverErrorTypes:variable)} or the specific driver's specialized error type enum,
  * but we can't reference a specific driver's error type enum in this code.
  * @public
  */
@@ -197,7 +109,7 @@ export interface IDriverErrorBase {
      *
      * @privateRemarks TODO: use {@link DriverErrorTypes} instead (breaking change).
      */
-    readonly errorType: DriverErrorType;
+    readonly errorType: DriverErrorTypes;
     /**
      * Free-form error message
      */
@@ -220,21 +132,21 @@ export interface IDriverErrorBase {
  * @alpha
  */
 export interface IThrottlingWarning extends IDriverErrorBase {
-    readonly errorType: DriverErrorType.throttlingError;
+    readonly errorType: typeof DriverErrorTypes.throttlingError;
     readonly retryAfterSeconds: number;
 }
 /**
  * @alpha
  */
 export interface IGenericNetworkError extends IDriverErrorBase {
-    readonly errorType: DriverErrorType.genericNetworkError;
+    readonly errorType: typeof DriverErrorTypes.genericNetworkError;
     readonly statusCode?: number;
 }
 /**
  * @alpha
  */
 export interface IAuthorizationError extends IDriverErrorBase {
-    readonly errorType: DriverErrorType.authorizationError;
+    readonly errorType: typeof DriverErrorTypes.authorizationError;
     readonly claims?: string;
     readonly tenantId?: string;
 }
@@ -242,7 +154,7 @@ export interface IAuthorizationError extends IDriverErrorBase {
  * @alpha
  */
 export interface ILocationRedirectionError extends IDriverErrorBase {
-    readonly errorType: DriverErrorType.locationRedirection;
+    readonly errorType: typeof DriverErrorTypes.locationRedirection;
     readonly redirectUrl: IResolvedUrl;
 }
 /**
@@ -251,7 +163,7 @@ export interface ILocationRedirectionError extends IDriverErrorBase {
  * @alpha
  */
 export interface IDriverBasicError extends IDriverErrorBase {
-    readonly errorType: DriverErrorType.genericError | DriverErrorType.fileNotFoundOrAccessDeniedError | DriverErrorType.offlineError | DriverErrorType.unsupportedClientProtocolVersion | DriverErrorType.writeError | DriverErrorType.fetchFailure | DriverErrorType.fetchTokenError | DriverErrorType.incorrectServerResponse | DriverErrorType.fileOverwrittenInStorage | DriverErrorType.fluidInvalidSchema | DriverErrorType.usageError | DriverErrorType.fileIsLocked | DriverErrorType.outOfStorageError;
+    readonly errorType: typeof DriverErrorTypes.genericError | typeof DriverErrorTypes.fileNotFoundOrAccessDeniedError | typeof DriverErrorTypes.offlineError | typeof DriverErrorTypes.unsupportedClientProtocolVersion | typeof DriverErrorTypes.writeError | typeof DriverErrorTypes.fetchFailure | typeof DriverErrorTypes.fetchTokenError | typeof DriverErrorTypes.incorrectServerResponse | typeof DriverErrorTypes.fileOverwrittenInStorage | typeof DriverErrorTypes.fluidInvalidSchema | typeof DriverErrorTypes.usageError | typeof DriverErrorTypes.fileIsLocked | typeof DriverErrorTypes.outOfStorageError;
     readonly statusCode?: number;
 }
 /**

package/lib/driverError.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"driverError.d.mts","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAII,EAAE,YAAY,EAAE;AAMvB;;;GAGG;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;;IAGH;;OAEG;;;;;CAEM,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,OAAO,gBAAgB,CAAC,CAAC;AAExF;;;;;;GAMG;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;IAE7B;;OAEG;IACH,iBAAiB,sBAAsB;CACvC;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC;IAC3E,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;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;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC3D,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,eAAe,CAAC;IACpD,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC7D,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,mBAAmB,CAAC;IACxD,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,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;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,gBAAgB;IAClE,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,mBAAmB,CAAC;IACxD,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;CACnC;AAED;;;;GAIG;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,GAC5B,eAAe,CAAC,iBAAiB,CAAC;IACrC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GACpB,kBAAkB,GAClB,oBAAoB,GACpB,mBAAmB,GACnB,yBAAyB,GACzB,iBAAiB,CAAC"}
+{"version":3,"file":"driverError.d.mts","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAII,EAAE,YAAY,EAAE;AAMvB;;;GAGG;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;;IAGH;;OAEG;;;;;CAEM,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,OAAO,gBAAgB,CAAC,CAAC;AAExF;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC;IAC3E,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,gBAAgB,CAAC;IAErC;;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;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC3D,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,eAAe,CAAC;IAC5D,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC7D,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,mBAAmB,CAAC;IAChE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC5D,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,kBAAkB,CAAC;IAC/D,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,gBAAgB;IAClE,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,mBAAmB,CAAC;IAChE,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IAC1D,QAAQ,CAAC,SAAS,EACf,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,+BAA+B,GACvD,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,gCAAgC,GACxD,OAAO,gBAAgB,CAAC,UAAU,GAClC,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,eAAe,GACvC,OAAO,gBAAgB,CAAC,uBAAuB,GAC/C,OAAO,gBAAgB,CAAC,wBAAwB,GAChD,OAAO,gBAAgB,CAAC,kBAAkB,GAC1C,OAAO,gBAAgB,CAAC,UAAU,GAClC,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,iBAAiB,CAAC;IAC7C,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GACpB,kBAAkB,GAClB,oBAAoB,GACpB,mBAAmB,GACnB,yBAAyB,GACzB,iBAAiB,CAAC"}

package/lib/driverError.mjs

@@ -84,98 +84,4 @@ export const DriverErrorTypes = {
      */
     outOfStorageError: "outOfStorageError",
 };
-/**
- * Driver Error types
- * Lists types that are likely to be used by all drivers
- *
- * @deprecated Use {@link (DriverErrorTypes:type)} instead.
- * @public
- */
-export var DriverErrorType;
-(function (DriverErrorType) {
-    /**
-     * A fatal error with no specific interpretation covered by other DriverErrorType values
-     */
-    DriverErrorType["genericError"] = "genericError";
-    /**
-     * Some non-categorized (below) networking error
-     * Include errors like  fatal server error (usually 500).
-     */
-    DriverErrorType["genericNetworkError"] = "genericNetworkError";
-    /**
-     * Access denied - user does not have enough privileges to open a file, or continue to operate on a file
-     */
-    DriverErrorType["authorizationError"] = "authorizationError";
-    /**
-     * File not found, or file deleted during session
-     */
-    DriverErrorType["fileNotFoundOrAccessDeniedError"] = "fileNotFoundOrAccessDeniedError";
-    /**
-     * Throttling error from server. Server is busy and is asking not to reconnect for some time
-     */
-    DriverErrorType["throttlingError"] = "throttlingError";
-    /**
-     * We can not reach server due to computer being offline.
-     */
-    DriverErrorType["offlineError"] = "offlineError";
-    /*
-     * Unsupported client protocol
-     */
-    DriverErrorType["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.
-     */
-    DriverErrorType["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.
-     */
-    DriverErrorType["fetchFailure"] = "fetchFailure";
-    /**
-     * This error occurs when token provider fails to fetch orderer token
-     */
-    DriverErrorType["fetchTokenError"] = "fetchTokenError";
-    /**
-     * Unexpected response from server. Either JSON is malformed, or some required properties are missing
-     */
-    DriverErrorType["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.
-     */
-    DriverErrorType["fileOverwrittenInStorage"] = "fileOverwrittenInStorage";
-    /**
-     * The document is read-only and delta stream connection is forbidden.
-     */
-    DriverErrorType["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.
-     */
-    DriverErrorType["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"
-     */
-    DriverErrorType["fluidInvalidSchema"] = "fluidInvalidSchema";
-    /**
-     * Error indicating an API is being used improperly resulting in an invalid operation.
-     * ! Should match the value of ContainerErrorType.usageError
-     */
-    DriverErrorType["usageError"] = "usageError";
-    /**
-     * File is locked for read/write by storage, e.g. whole collection is locked and access denied.
-     */
-    DriverErrorType["fileIsLocked"] = "fileIsLocked";
-    /**
-     * Storage is out of space
-     */
-    DriverErrorType["outOfStorageError"] = "outOfStorageError";
-})(DriverErrorType || (DriverErrorType = {}));
 //# sourceMappingURL=driverError.mjs.map

package/lib/driverError.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"driverError.mjs","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAAE,eAAe,EAAE,MAAM,iCAAiC;AAIjE,8GAA8G;AAC9G,MAAM,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,GAAG,8BAA8B,EAAE,GACpF,eAAe,CAAC;AAEjB;;;GAGG;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;IAE5B;;OAEG;IACH,iBAAiB,EAAE,mBAAmB;CAC7B,CAAC;AAMX;;;;;;GAMG;AACH,MAAM,CAAN,IAAY,eAsGX;AAtGD,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;IAE7B;;OAEG;IACH,0DAAuC,CAAA;AACxC,CAAC,EAtGW,eAAe,KAAf,eAAe,QAsG1B","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 * @public\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\n\t/**\n\t * Storage is out of space\n\t */\n\toutOfStorageError: \"outOfStorageError\",\n} as const;\n/**\n * @public\n */\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 * @public\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\t/**\n\t * Storage is out of space\n\t */\n\toutOfStorageError = \"outOfStorageError\",\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 * @public\n */\nexport interface IAnyDriverError extends Omit<IDriverErrorBase, \"errorType\"> {\n\treadonly errorType: string;\n}\n\n/**\n * Base interface for all errors and warnings\n * @public\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\n/**\n * @alpha\n */\nexport interface IThrottlingWarning extends IDriverErrorBase {\n\treadonly errorType: DriverErrorType.throttlingError;\n\treadonly retryAfterSeconds: number;\n}\n\n/**\n * @alpha\n */\nexport interface IGenericNetworkError extends IDriverErrorBase {\n\treadonly errorType: DriverErrorType.genericNetworkError;\n\treadonly statusCode?: number;\n}\n\n/**\n * @alpha\n */\nexport interface IAuthorizationError extends IDriverErrorBase {\n\treadonly errorType: DriverErrorType.authorizationError;\n\treadonly claims?: string;\n\treadonly tenantId?: string;\n}\n\n/**\n * @alpha\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 * @alpha\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\t\t| DriverErrorType.outOfStorageError;\n\treadonly statusCode?: number;\n}\n\n/**\n * @alpha\n */\nexport type DriverError =\n\t| IThrottlingWarning\n\t| IGenericNetworkError\n\t| IAuthorizationError\n\t| ILocationRedirectionError\n\t| IDriverBasicError;\n"]}
+{"version":3,"file":"driverError.mjs","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAAE,eAAe,EAAE,MAAM,iCAAiC;AAIjE,8GAA8G;AAC9G,MAAM,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,GAAG,8BAA8B,EAAE,GACpF,eAAe,CAAC;AAEjB;;;GAGG;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;IAE5B;;OAEG;IACH,iBAAiB,EAAE,mBAAmB;CAC7B,CAAC","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 * @public\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\n\t/**\n\t * Storage is out of space\n\t */\n\toutOfStorageError: \"outOfStorageError\",\n} as const;\n/**\n * @public\n */\nexport type DriverErrorTypes = (typeof DriverErrorTypes)[keyof typeof DriverErrorTypes];\n\n/**\n * Interface describing errors and warnings raised by any driver code.\n *\n * @remarks\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 {@link @fluidframework/driver-definitions#(DriverErrorTypes:variable)} 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 * @public\n */\nexport interface IAnyDriverError extends Omit<IDriverErrorBase, \"errorType\"> {\n\treadonly errorType: string;\n}\n\n/**\n * Base interface for all errors and warnings\n * @public\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: DriverErrorTypes;\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\n/**\n * @alpha\n */\nexport interface IThrottlingWarning extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.throttlingError;\n\treadonly retryAfterSeconds: number;\n}\n\n/**\n * @alpha\n */\nexport interface IGenericNetworkError extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.genericNetworkError;\n\treadonly statusCode?: number;\n}\n\n/**\n * @alpha\n */\nexport interface IAuthorizationError extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.authorizationError;\n\treadonly claims?: string;\n\treadonly tenantId?: string;\n}\n\n/**\n * @alpha\n */\nexport interface ILocationRedirectionError extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.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 * @alpha\n */\nexport interface IDriverBasicError extends IDriverErrorBase {\n\treadonly errorType:\n\t\t| typeof DriverErrorTypes.genericError\n\t\t| typeof DriverErrorTypes.fileNotFoundOrAccessDeniedError\n\t\t| typeof DriverErrorTypes.offlineError\n\t\t| typeof DriverErrorTypes.unsupportedClientProtocolVersion\n\t\t| typeof DriverErrorTypes.writeError\n\t\t| typeof DriverErrorTypes.fetchFailure\n\t\t| typeof DriverErrorTypes.fetchTokenError\n\t\t| typeof DriverErrorTypes.incorrectServerResponse\n\t\t| typeof DriverErrorTypes.fileOverwrittenInStorage\n\t\t| typeof DriverErrorTypes.fluidInvalidSchema\n\t\t| typeof DriverErrorTypes.usageError\n\t\t| typeof DriverErrorTypes.fileIsLocked\n\t\t| typeof DriverErrorTypes.outOfStorageError;\n\treadonly statusCode?: number;\n}\n\n/**\n * @alpha\n */\nexport type DriverError =\n\t| IThrottlingWarning\n\t| IGenericNetworkError\n\t| IAuthorizationError\n\t| ILocationRedirectionError\n\t| IDriverBasicError;\n"]}

package/lib/index.d.mts

@@ -2,7 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export { DriverError, DriverErrorType, DriverErrorTypes, IAnyDriverError, IAuthorizationError, IDriverErrorBase, IDriverBasicError, IGenericNetworkError, ILocationRedirectionError, IThrottlingWarning, } from "./driverError.mjs";
-export { FetchSource, FiveDaysMs, IDeltasFetchResult, IDeltaStorageService, IDocumentDeltaConnection, IDocumentDeltaConnectionEvents, IDocumentDeltaStorageService, IDocumentService, IDocumentServiceFactory, IDocumentServicePolicies, IDocumentStorageService, IDocumentStorageServicePolicies, IStream, IStreamResult, ISummaryContext, LoaderCachingPolicy, } from "./storage.mjs";
+export { DriverError, DriverErrorTypes, IAnyDriverError, IAuthorizationError, IDriverErrorBase, IDriverBasicError, IGenericNetworkError, ILocationRedirectionError, IThrottlingWarning, } from "./driverError.mjs";
+export { FetchSource, FiveDaysMs, IDeltasFetchResult, IDeltaStorageService, IDocumentDeltaConnection, IDocumentDeltaConnectionEvents, IDocumentDeltaStorageService, IDocumentService, IDocumentServiceEvents, IDocumentServiceFactory, IDocumentServicePolicies, IDocumentStorageService, IDocumentStorageServicePolicies, ISnapshot, ISnapshotFetchOptions, IStream, IStreamResult, ISummaryContext, LoaderCachingPolicy, } from "./storage.mjs";
 export { DriverPreCheckInfo, DriverHeader, IContainerPackageInfo, IDriverHeader, IResolvedUrl, IUrlResolver, } from "./urlResolver.mjs";
 //# sourceMappingURL=index.d.mts.map

package/lib/index.d.mts.map

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

package/lib/index.mjs

@@ -2,7 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export { DriverErrorType, DriverErrorTypes, } from "./driverError.mjs";
+export { DriverErrorTypes, } from "./driverError.mjs";
 export { FetchSource, LoaderCachingPolicy, } from "./storage.mjs";
 export { DriverHeader, } from "./urlResolver.mjs";
 //# sourceMappingURL=index.mjs.map

package/lib/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAEN,eAAe,EACf,gBAAgB,GAQhB;OACM,EACN,WAAW,EAeX,mBAAmB,GACnB;OACM,EAEN,YAAY,GAKZ","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"]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAEN,gBAAgB,GAQhB;OACM,EACN,WAAW,EAkBX,mBAAmB,GACnB;OACM,EAEN,YAAY,GAKZ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tDriverError,\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\tIDocumentServiceEvents,\n\tIDocumentServiceFactory,\n\tIDocumentServicePolicies,\n\tIDocumentStorageService,\n\tIDocumentStorageServicePolicies,\n\tISnapshot,\n\tISnapshotFetchOptions,\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"]}