@sudoplatform/sudo-common 7.1.3 → 8.0.0

package/cjs/errors/error.d.ts

@@ -0,0 +1,263 @@
+import { GraphQLError } from 'graphql';
+export declare type AppSyncError = GraphQLError & {
+    errorType?: string | null;
+};
+export declare type AppSyncNetworkError = Error & {
+    networkError: Error & {
+        statusCode?: number;
+    };
+};
+export declare function isAppSyncNetworkError(u: Error): u is AppSyncNetworkError;
+/**
+ * Indicates the GraphQL API returned an error that's not recognized by
+ * the client.
+ */
+export declare class UnknownGraphQLError extends Error {
+    constructor(cause: unknown);
+}
+/**
+ * The configuration set was not found by the given key
+ */
+export declare class ConfigurationSetNotFoundError extends Error {
+    constructor(key?: string);
+}
+/**
+ * The configuration has not been set on the ConfigurationManager
+ * before trying operations that need it
+ */
+export declare class ConfigurationNotSetError extends Error {
+    constructor();
+}
+/**
+ * A decode error message
+ */
+export declare class DecodeError extends Error {
+    constructor(message?: string);
+}
+/**
+ * An error occurred during the authentication process. This may be due to invalid credentials
+ * being supplied, or authentication tokens not able to be retrieved from storage.
+ */
+export declare class AuthenticationError extends Error {
+    constructor(message: string);
+}
+/**
+ * An error occurred during the sign out process.
+ */
+export declare class SignOutError extends Error {
+    constructor(message: string);
+}
+/**
+ * An error occurred during the registration process.
+ * This may be due to the client already being registered.
+ */
+export declare class RegisterError extends Error {
+    constructor(message: string);
+}
+/**
+ * An error occurred indicating that the user is not registered.
+ */
+export declare class NotRegisteredError extends Error {
+    constructor(message?: string);
+}
+/**
+ * The user is not authorized to perform the requested operation. This maybe
+ * due to specifying the wrong key deriving key or password.
+ */
+export declare class NotAuthorizedError extends Error {
+    constructor(message?: string);
+}
+/**
+ * Indicates the operation requires the user to be signed in but the user is
+ * currently not signed in.
+ */
+export declare class NotSignedInError extends Error {
+    constructor();
+}
+/**
+ * Indicates that the user was registered but is not confirmed due to not
+ * passing all the required validation.
+ */
+export declare class UserNotConfirmedError extends Error {
+    constructor();
+}
+/**
+ * The version of the vault that's being updated does not match the version
+ * stored in the backed. It is likely that another client updated the vault
+ * first so the caller should reconcile the changes before attempting to
+ * update the vault.
+ */
+export declare class VersionMismatchError extends Error {
+    constructor();
+}
+/**
+ * Indicates that the ownership proof was invalid.
+ */
+export declare class InvalidOwnershipProofError extends Error {
+    constructor();
+}
+/**
+ * Indicates that the user does not have sufficient entitlements to perform
+ * the requested operation.
+ */
+export declare class InsufficientEntitlementsError extends Error {
+    constructor();
+}
+/**
+ * Indicates the requested operation failed because the user account is locked.
+ */
+export declare class AccountLockedError extends Error {
+    constructor();
+}
+/**
+ * Indicates that an internal server error caused the operation to fail. The error
+ * is possibly transient and retrying at a later time may cause the operation to
+ * complete successfully.
+ */
+export declare class ServiceError extends Error {
+    constructor(message: string);
+}
+/**
+ * Error when expected arguments are missing or invalid
+ */
+export declare class IllegalArgumentError extends Error {
+    constructor(message?: string);
+}
+/**
+ * Error when the state of the program is expecting a value to
+ * be set or available and it is not.
+ */
+export declare class IllegalStateError extends Error {
+    constructor(message: string);
+}
+/**
+ * Operation failed due to it exceeding some limits imposed for the API. For example,
+ * this error can occur if the resource size exceeds the database record size limit.
+ */
+export declare class LimitExceededError extends Error {
+    constructor();
+}
+/**
+ * API request failed due to network error or unexpected server error.
+ */
+export declare class RequestFailedError extends Error {
+    /**
+     * Underlying error that cause the request to fail.
+     */
+    cause?: Error;
+    /**
+     * HTTP status code if a valid response was received with unexpected
+     * status code.
+     */
+    statusCode?: number;
+    constructor(cause?: Error, statusCode?: number);
+}
+/**
+ * An unexpected error was encountered. This may result from programmatic error
+ * and is unlikley to be user recoverable.
+ */
+export declare class FatalError extends Error {
+    constructor(message: string);
+}
+/**
+ * No entitlements assigned to user.
+ */
+export declare class NoEntitlementsError extends Error {
+    constructor();
+}
+/**
+ * Token presented was not valid for the purpose.
+ */
+export declare class InvalidTokenError extends Error {
+    constructor();
+}
+/**
+ * Key not found from store when using cryptoProvider
+ */
+export declare class KeyNotFoundError extends Error {
+    constructor(message?: string);
+}
+/**
+ * Underlying secure key store does not support key export
+ */
+export declare class KeyStoreNotExportableError extends Error {
+    constructor(message?: string);
+}
+/**
+ * No key archive provided prior to unarchiving
+ */
+export declare class KeyArchiveMissingError extends Error {
+    constructor(message?: string);
+}
+/**
+ * No password provided to unarchive secure archive
+ */
+export declare class KeyArchivePasswordRequiredError extends Error {
+    constructor(message?: string);
+}
+/**
+ * No password required to unarchive insecure archive
+ */
+export declare class KeyArchiveNoPasswordRequiredError extends Error {
+    constructor(message?: string);
+}
+/**
+ * Key archive data could not be decoded as expected
+ */
+export declare class KeyArchiveDecodingError extends Error {
+    constructor(message?: string);
+}
+/**
+ * Key archive was unable to be decrypted using the provided password
+ */
+export declare class KeyArchiveIncorrectPasswordError extends Error {
+    constructor(message?: string);
+}
+/**
+ * Key archive type is not supported
+ */
+export declare class KeyArchiveTypeError extends Error {
+    constructor(keyArchiveType: string);
+}
+/**
+ * Key archive version is not supported
+ */
+export declare class KeyArchiveVersionError extends Error {
+    constructor(version: number);
+}
+/**
+ * Key archive key type is not recognized
+ */
+export declare class KeyArchiveUnknownKeyTypeError extends Error {
+    constructor(message?: string);
+}
+/**
+ * Operation not implemented
+ */
+export declare class OperationNotImplementedError extends Error {
+    constructor(message?: string);
+}
+/**
+ * Encryption algorithm is not recognized
+ */
+export declare class UnrecognizedAlgorithmError extends Error {
+    constructor(message?: string);
+}
+/**
+ * Helper method for mapping an App Sync error to common errors.
+ *
+ * For consumption by other Sudo Platform SDKs
+ *
+ * @param error The App Sync error to map
+ * @returns The mapped error
+ */
+export declare function mapGraphQLToClientError(error: Pick<AppSyncError, 'errorType' | 'message'>): Error;
+/**
+ * Call this in error handling when testing with isAppSyncNetworkError on
+ * a caught error from an AppSync operation returns true.
+ *
+ * @param error AppSyncNetworkError to map
+ *
+ * @returns Mapped error
+ */
+export declare function mapNetworkErrorToClientError(error: AppSyncNetworkError): Error;

package/cjs/errors/error.js

@@ -0,0 +1,442 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapNetworkErrorToClientError = exports.mapGraphQLToClientError = exports.UnrecognizedAlgorithmError = exports.OperationNotImplementedError = exports.KeyArchiveUnknownKeyTypeError = exports.KeyArchiveVersionError = exports.KeyArchiveTypeError = exports.KeyArchiveIncorrectPasswordError = exports.KeyArchiveDecodingError = exports.KeyArchiveNoPasswordRequiredError = exports.KeyArchivePasswordRequiredError = exports.KeyArchiveMissingError = exports.KeyStoreNotExportableError = exports.KeyNotFoundError = exports.InvalidTokenError = exports.NoEntitlementsError = exports.FatalError = exports.RequestFailedError = exports.LimitExceededError = exports.IllegalStateError = exports.IllegalArgumentError = exports.ServiceError = exports.AccountLockedError = exports.InsufficientEntitlementsError = exports.InvalidOwnershipProofError = exports.VersionMismatchError = exports.UserNotConfirmedError = exports.NotSignedInError = exports.NotAuthorizedError = exports.NotRegisteredError = exports.RegisterError = exports.SignOutError = exports.AuthenticationError = exports.DecodeError = exports.ConfigurationNotSetError = exports.ConfigurationSetNotFoundError = exports.UnknownGraphQLError = exports.isAppSyncNetworkError = void 0;
+function isAppSyncNetworkError(u) {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    return !!u.networkError;
+}
+exports.isAppSyncNetworkError = isAppSyncNetworkError;
+/**
+ * Indicates the GraphQL API returned an error that's not recognized by
+ * the client.
+ */
+class UnknownGraphQLError extends Error {
+    constructor(cause) {
+        const maybeAppSyncError = cause;
+        let message;
+        if (maybeAppSyncError?.errorType) {
+            message = `type: ${maybeAppSyncError.errorType}, message: ${maybeAppSyncError.message}`;
+        }
+        else if (maybeAppSyncError?.message) {
+            message = maybeAppSyncError?.message;
+        }
+        else if (maybeAppSyncError?.name) {
+            message = maybeAppSyncError.name;
+        }
+        else {
+            message = 'unknown cause';
+        }
+        super(message);
+        this.name = 'UnknownGraphQLError';
+    }
+}
+exports.UnknownGraphQLError = UnknownGraphQLError;
+/**
+ * The configuration set was not found by the given key
+ */
+class ConfigurationSetNotFoundError extends Error {
+    constructor(key) {
+        super('Configuration set not found.');
+        if (key) {
+            this.message += ` Key: ${key}`;
+        }
+        this.name = 'ConfigurationSetNotFoundError';
+    }
+}
+exports.ConfigurationSetNotFoundError = ConfigurationSetNotFoundError;
+/**
+ * The configuration has not been set on the ConfigurationManager
+ * before trying operations that need it
+ */
+class ConfigurationNotSetError extends Error {
+    constructor() {
+        super('Configuration has not been set.');
+        this.name = 'ConfigurationNotSetError';
+    }
+}
+exports.ConfigurationNotSetError = ConfigurationNotSetError;
+/**
+ * A decode error message
+ */
+class DecodeError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'DecodeError';
+    }
+}
+exports.DecodeError = DecodeError;
+/**
+ * An error occurred during the authentication process. This may be due to invalid credentials
+ * being supplied, or authentication tokens not able to be retrieved from storage.
+ */
+class AuthenticationError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'AuthenticationError';
+    }
+}
+exports.AuthenticationError = AuthenticationError;
+/**
+ * An error occurred during the sign out process.
+ */
+class SignOutError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'SignOutError';
+    }
+}
+exports.SignOutError = SignOutError;
+/**
+ * An error occurred during the registration process.
+ * This may be due to the client already being registered.
+ */
+class RegisterError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'RegisterError';
+    }
+}
+exports.RegisterError = RegisterError;
+/**
+ * An error occurred indicating that the user is not registered.
+ */
+class NotRegisteredError extends Error {
+    constructor(message) {
+        super(message ?? 'User is not registered.');
+        this.name = 'NotRegisteredError';
+    }
+}
+exports.NotRegisteredError = NotRegisteredError;
+/**
+ * The user is not authorized to perform the requested operation. This maybe
+ * due to specifying the wrong key deriving key or password.
+ */
+class NotAuthorizedError extends Error {
+    constructor(message) {
+        super(message ?? 'User is not authorized perform the requested operation.');
+        this.name = 'NotAuthorizedError';
+    }
+}
+exports.NotAuthorizedError = NotAuthorizedError;
+/**
+ * Indicates the operation requires the user to be signed in but the user is
+ * currently not signed in.
+ */
+class NotSignedInError extends Error {
+    constructor() {
+        super('Not signed in.');
+        this.name = 'NotSignedInError';
+    }
+}
+exports.NotSignedInError = NotSignedInError;
+/**
+ * Indicates that the user was registered but is not confirmed due to not
+ * passing all the required validation.
+ */
+class UserNotConfirmedError extends Error {
+    constructor() {
+        super('User not confirmed.');
+        this.name = 'UserNotConfirmedError';
+    }
+}
+exports.UserNotConfirmedError = UserNotConfirmedError;
+/**
+ * The version of the vault that's being updated does not match the version
+ * stored in the backed. It is likely that another client updated the vault
+ * first so the caller should reconcile the changes before attempting to
+ * update the vault.
+ */
+class VersionMismatchError extends Error {
+    constructor() {
+        super('Expected object version does not match the actual object version.');
+        this.name = 'VersionMismatchError';
+    }
+}
+exports.VersionMismatchError = VersionMismatchError;
+/**
+ * Indicates that the ownership proof was invalid.
+ */
+class InvalidOwnershipProofError extends Error {
+    constructor() {
+        super('Ownership proof was invalid.');
+        this.name = 'InvalidOwnershipProofError';
+    }
+}
+exports.InvalidOwnershipProofError = InvalidOwnershipProofError;
+/**
+ * Indicates that the user does not have sufficient entitlements to perform
+ * the requested operation.
+ */
+class InsufficientEntitlementsError extends Error {
+    constructor() {
+        super('The user does not have sufficient entitlements to perform the requested operation.');
+        this.name = 'InsufficientEntitlementsError';
+    }
+}
+exports.InsufficientEntitlementsError = InsufficientEntitlementsError;
+/**
+ * Indicates the requested operation failed because the user account is locked.
+ */
+class AccountLockedError extends Error {
+    constructor() {
+        super('The requested operation failed because the user account is locked.');
+        this.name = 'AccountLockedError';
+    }
+}
+exports.AccountLockedError = AccountLockedError;
+/**
+ * Indicates that an internal server error caused the operation to fail. The error
+ * is possibly transient and retrying at a later time may cause the operation to
+ * complete successfully.
+ */
+class ServiceError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'ServiceError';
+    }
+}
+exports.ServiceError = ServiceError;
+/**
+ * Error when expected arguments are missing or invalid
+ */
+class IllegalArgumentError extends Error {
+    constructor(message) {
+        super(message ?? 'Invalid arguments were specified');
+        this.name = 'IllegalArgumentError';
+    }
+}
+exports.IllegalArgumentError = IllegalArgumentError;
+/**
+ * Error when the state of the program is expecting a value to
+ * be set or available and it is not.
+ */
+class IllegalStateError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'IllegalStateError';
+    }
+}
+exports.IllegalStateError = IllegalStateError;
+/**
+ * Operation failed due to it exceeding some limits imposed for the API. For example,
+ * this error can occur if the resource size exceeds the database record size limit.
+ */
+class LimitExceededError extends Error {
+    constructor() {
+        super('API limit exceeded.');
+        this.name = 'LimitExceededError';
+    }
+}
+exports.LimitExceededError = LimitExceededError;
+/**
+ * API request failed due to network error or unexpected server error.
+ */
+class RequestFailedError extends Error {
+    constructor(cause, statusCode) {
+        super(`API request failed. cause: ${cause?.message ?? '<none>'}, statusCode: ${statusCode ?? '<none>'}`);
+        this.name = 'RequestFailedError';
+        this.cause = cause;
+        this.statusCode = statusCode;
+    }
+}
+exports.RequestFailedError = RequestFailedError;
+/**
+ * An unexpected error was encountered. This may result from programmatic error
+ * and is unlikley to be user recoverable.
+ */
+class FatalError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'FatalError';
+    }
+}
+exports.FatalError = FatalError;
+/**
+ * No entitlements assigned to user.
+ */
+class NoEntitlementsError extends Error {
+    constructor() {
+        super('No entitlements assigned to user.');
+        this.name = 'NoEntitlementsError';
+    }
+}
+exports.NoEntitlementsError = NoEntitlementsError;
+/**
+ * Token presented was not valid for the purpose.
+ */
+class InvalidTokenError extends Error {
+    constructor() {
+        super('Invalid token.');
+        this.name = 'InvalidTokenError';
+    }
+}
+exports.InvalidTokenError = InvalidTokenError;
+/**
+ * Key not found from store when using cryptoProvider
+ */
+class KeyNotFoundError extends Error {
+    constructor(message) {
+        super(message ?? 'Key not found.');
+        this.name = 'KeyNotFoundError';
+    }
+}
+exports.KeyNotFoundError = KeyNotFoundError;
+/**
+ * Underlying secure key store does not support key export
+ */
+class KeyStoreNotExportableError extends Error {
+    constructor(message) {
+        super(message ?? 'Key store not exportable.');
+        this.name = 'KeyStoreNotExportableError';
+    }
+}
+exports.KeyStoreNotExportableError = KeyStoreNotExportableError;
+/**
+ * No key archive provided prior to unarchiving
+ */
+class KeyArchiveMissingError extends Error {
+    constructor(message) {
+        super(message ?? 'No key archive provided prior to unarchiving');
+        this.name = 'KeyArchiveMissingError';
+    }
+}
+exports.KeyArchiveMissingError = KeyArchiveMissingError;
+/**
+ * No password provided to unarchive secure archive
+ */
+class KeyArchivePasswordRequiredError extends Error {
+    constructor(message) {
+        super(message ?? 'No password provided to unarchive secure archive');
+        this.name = 'KeyArchivePasswordRequiredError';
+    }
+}
+exports.KeyArchivePasswordRequiredError = KeyArchivePasswordRequiredError;
+/**
+ * No password required to unarchive insecure archive
+ */
+class KeyArchiveNoPasswordRequiredError extends Error {
+    constructor(message) {
+        super(message ?? 'No password required to unarchive insecure archive');
+        this.name = 'KeyArchiveNoPasswordRequiredError';
+    }
+}
+exports.KeyArchiveNoPasswordRequiredError = KeyArchiveNoPasswordRequiredError;
+/**
+ * Key archive data could not be decoded as expected
+ */
+class KeyArchiveDecodingError extends Error {
+    constructor(message) {
+        super(message ?? 'Key archive data could not be decoded as expected');
+        this.name = 'KeyArchiveDecodingError';
+    }
+}
+exports.KeyArchiveDecodingError = KeyArchiveDecodingError;
+/**
+ * Key archive was unable to be decrypted using the provided password
+ */
+class KeyArchiveIncorrectPasswordError extends Error {
+    constructor(message) {
+        super(message ??
+            'Key archive was unable to be decrypted using the provided password');
+        this.name = 'KeyArchiveIncorrectPasswordError';
+    }
+}
+exports.KeyArchiveIncorrectPasswordError = KeyArchiveIncorrectPasswordError;
+/**
+ * Key archive type is not supported
+ */
+class KeyArchiveTypeError extends Error {
+    constructor(keyArchiveType) {
+        super(`Key archive type ${keyArchiveType} is not supported`);
+        this.name = 'KeyArchiveTypeError';
+    }
+}
+exports.KeyArchiveTypeError = KeyArchiveTypeError;
+/**
+ * Key archive version is not supported
+ */
+class KeyArchiveVersionError extends Error {
+    constructor(version) {
+        super(`Key archive version ${version} is not supported`);
+        this.name = 'KeyArchiveVersionError';
+    }
+}
+exports.KeyArchiveVersionError = KeyArchiveVersionError;
+/**
+ * Key archive key type is not recognized
+ */
+class KeyArchiveUnknownKeyTypeError extends Error {
+    constructor(message) {
+        super(message ?? 'Key type is not recognized');
+        this.name = 'KeyArchiveUnknownKeyTypeError';
+    }
+}
+exports.KeyArchiveUnknownKeyTypeError = KeyArchiveUnknownKeyTypeError;
+/**
+ * Operation not implemented
+ */
+class OperationNotImplementedError extends Error {
+    constructor(message) {
+        super(message ?? 'Operation is not implemented');
+        this.name = 'OperationNotImplementedError';
+    }
+}
+exports.OperationNotImplementedError = OperationNotImplementedError;
+/**
+ * Encryption algorithm is not recognized
+ */
+class UnrecognizedAlgorithmError extends Error {
+    constructor(message) {
+        super(message ?? 'Unrecognized encryption algorithm name.');
+        this.name = 'UnrecognizedAlgorithmError';
+    }
+}
+exports.UnrecognizedAlgorithmError = UnrecognizedAlgorithmError;
+/**
+ * Helper method for mapping an App Sync error to common errors.
+ *
+ * For consumption by other Sudo Platform SDKs
+ *
+ * @param error The App Sync error to map
+ * @returns The mapped error
+ */
+function mapGraphQLToClientError(error) {
+    switch (error.errorType) {
+        case 'sudoplatform.AccountLockedError':
+            return new AccountLockedError();
+        case 'sudoplatform.InsufficientEntitlementsError':
+            return new InsufficientEntitlementsError();
+        case 'sudoplatform.InvalidTokenError':
+            return new InvalidTokenError();
+        case 'sudoplatform.InvalidArgumentError':
+            return new IllegalArgumentError();
+        case 'sudoplatform.LimitExceededError':
+            return new LimitExceededError();
+        case 'sudoplatform.NoEntitlementsError':
+            return new NoEntitlementsError();
+        case 'sudoplatform.ServiceError':
+            return new ServiceError(error.message);
+        default:
+            return new UnknownGraphQLError(error);
+    }
+}
+exports.mapGraphQLToClientError = mapGraphQLToClientError;
+/**
+ * Call this in error handling when testing with isAppSyncNetworkError on
+ * a caught error from an AppSync operation returns true.
+ *
+ * @param error AppSyncNetworkError to map
+ *
+ * @returns Mapped error
+ */
+function mapNetworkErrorToClientError(error) {
+    const networkError = error.networkError;
+    switch (networkError.statusCode) {
+        case 401:
+            return new NotAuthorizedError();
+        default:
+            return new RequestFailedError(networkError, networkError.statusCode);
+    }
+}
+exports.mapNetworkErrorToClientError = mapNetworkErrorToClientError;
+//# sourceMappingURL=error.js.map