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