@sudoplatform/sudo-common 7.0.2 → 8.0.0

package/cjs/configurationManager/defaultConfigurationManager.d.ts

@@ -0,0 +1,123 @@
+import * as t from 'io-ts';
+/**
+ * Service compatibility information.
+ */
+export interface ServiceCompatibilityInfo {
+    /**
+     * The name of the service associated with the compatibility info. This matches one of the
+     * service name present in sudoplatformconfig.json.
+     */
+    name: string;
+    /**
+     * The version of the service config present in sudoplatformconfig.json. It defaults
+     * to 1 if not present.
+     */
+    configVersion: number;
+    /**
+     * The minimum supported service config version currently supported by the backend.
+     */
+    minSupportedVersion?: number;
+    /**
+     * Any service config version less than or equal to this version is considered deprecated
+     * and the backend may remove the support for those versions after a grace period.
+     */
+    deprecatedVersion?: number;
+    /**
+     * After this time any deprecated service config versions will no longer be compatible
+     * with the backend. It is recommended to warn the user prior to the deprecation grace.
+     */
+    deprecationGrace?: Date;
+}
+/**
+ * Result returned by `validateConfig` API if an incompatible client config is found when compared
+ * to the deployed backend services.
+ */
+export interface ValidationResult {
+    /**
+     * The list of incompatible services. The client must be upgraded to the latest
+     * version in order to use these services.
+     */
+    incompatible: ServiceCompatibilityInfo[];
+    /**
+     * The list of services that will be made incompatible with the current version of the
+     * client. The users should be warned that after the specified grace period these services will be
+     * made incompatible.
+     */
+    deprecated: ServiceCompatibilityInfo[];
+}
+/**
+ * Interface that encapsulates the APIs common to all configuration manager implementations.
+ * A configuration manager should be a singleton that holds reference to a parsed config
+ * and returns the configuration set specific to a given namespace.
+ */
+export interface ConfigurationManager {
+    /**
+     * Set config that will be parsed as JSON
+     *
+     * @param config A string representation of configuration
+     *
+     * @returns ConfigurationManager
+     */
+    setConfig(config: string): ConfigurationManager;
+    /**
+     * Get a subset of configuration by namespace
+     *
+     * @param namespace The key for the nested json object
+     *
+     * @returns Configuration set specific to a given namespace
+     *
+     * @throws {@link ConfigurationNotSetError}
+     */
+    getConfigSet(namespace?: string): string | undefined;
+    /**
+     * Decode a configuration set to a given type
+     *
+     * @param configSet Configuration set specific to a given namespace
+     * @param codec The codec to bind the configuration set to
+     *
+     * @returns Configuration as a given type
+     *
+     * @throws {@link DecodeError}
+     */
+    bind<T>(configSet: unknown, codec: t.Mixed): T;
+    /**
+     * Get a configuration by namespace and decode and validate
+     * that configuration set to a given type.  If no namespace
+     * provided, try and use the whole configuration object
+     * to bind to the given type.
+     *
+     * @param namespace The key for the nested json object or undefined
+     * @param codec The codec to bind the configuration set to
+     *
+     * @returns Configuration as a given type
+     *
+     * @throws {@link ConfigurationNotSetError}
+     * @throws {@link ConfigurationSetNotFoundError}
+     * @throws {@link DecodeError}
+     */
+    bindConfigSet<T>(codec: t.Mixed, namespace?: string): T;
+    /**
+     * Validates the client configuration (sudoplatformconfig.json) against the currently deployed set of
+     * backend services. If the client configuration is valid, i.e. the client is compatible will all deployed
+     * backend services, then the call will complete with `success` result. If any part of the client
+     * configuration is incompatible then a detailed information on the incompatible service will be
+     * returned in `failure` result. See `SudoConfigManagerError.compatibilityIssueFound` for more details.
+     *
+     * @return validation result with the details of incompatible or deprecated service configurations.
+     */
+    validateConfig(): Promise<ValidationResult>;
+}
+/**
+ * Singleton to manage configuration
+ */
+export declare class DefaultConfigurationManager implements ConfigurationManager {
+    private static instance;
+    private _config;
+    private constructor();
+    static getInstance(): DefaultConfigurationManager;
+    setConfig(config: string): DefaultConfigurationManager;
+    getConfigSet(namespace?: string): string;
+    bind<T>(configSet: unknown, codec: t.Mixed): T;
+    bindConfigSet<T>(codec: t.Mixed, namespace?: string): T;
+    validateConfig(): Promise<ValidationResult>;
+}

package/cjs/configurationManager/defaultConfigurationManager.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultConfigurationManager = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable @typescript-eslint/no-unsafe-return */
+/* eslint-disable @typescript-eslint/no-unsafe-call */
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+const Either_1 = require("fp-ts/lib/Either");
+const pipeable_1 = require("fp-ts/lib/pipeable");
+const PathReporter_1 = require("io-ts/lib/PathReporter");
+const error_1 = require("../errors/error");
+const client_s3_1 = require("@aws-sdk/client-s3");
+const stream_1 = require("../utils/stream");
+/**
+ * Singleton to manage configuration
+ */
+class DefaultConfigurationManager {
+    constructor() {
+        // Do Nothing.
+    }
+    static getInstance() {
+        if (!DefaultConfigurationManager.instance) {
+            DefaultConfigurationManager.instance = new DefaultConfigurationManager();
+        }
+        return DefaultConfigurationManager.instance;
+    }
+    setConfig(config) {
+        this._config = config;
+        return DefaultConfigurationManager.instance;
+    }
+    getConfigSet(namespace) {
+        if (!this._config) {
+            throw new error_1.ConfigurationNotSetError();
+        }
+        const parsed = JSON.parse(this._config);
+        const configSet = namespace ? parsed[namespace] : parsed;
+        return configSet;
+    }
+    bind(configSet, codec) {
+        // Decode and validate config
+        return (0, pipeable_1.pipe)(codec.decode(configSet), (0, Either_1.fold)((errors) => {
+            throw new error_1.DecodeError(PathReporter_1.PathReporter.report((0, Either_1.left)(errors)).join('\n'));
+        }, (v) => v));
+    }
+    bindConfigSet(codec, namespace) {
+        const configSet = this.getConfigSet(namespace);
+        if (!configSet) {
+            throw new error_1.ConfigurationSetNotFoundError(namespace);
+        }
+        return this.bind(configSet, codec);
+    }
+    async validateConfig() {
+        if (!this._config) {
+            return { incompatible: [], deprecated: [] };
+        }
+        const config = JSON.parse(this._config);
+        const region = config.identityService?.region;
+        const bucket = config.identityService?.serviceInfoBucket;
+        if (!(region && bucket)) {
+            return { incompatible: [], deprecated: [] };
+        }
+        const s3Client = new client_s3_1.S3Client({
+            region: region,
+            // We want these request to be unauthenticated
+            // so we provide a no-op signer for the requests
+            signer: { sign: (request) => Promise.resolve(request) },
+        });
+        const incompatible = [];
+        const deprecated = [];
+        const listObjectsCommand = new client_s3_1.ListObjectsCommand({
+            Bucket: bucket,
+        });
+        const objects = await s3Client.send(listObjectsCommand);
+        if (!objects.Contents?.length) {
+            return { incompatible: [], deprecated: [] };
+        }
+        const keys = objects.Contents.map((object) => object.Key);
+        // Only fetch the service info docs for the services that are present in client config
+        // to minimize the network calls.
+        const keysToFetch = keys.filter((key) => key.endsWith('.json') && config[key.replace('.json', '')]);
+        for (const key of keysToFetch) {
+            const getObject = new client_s3_1.GetObjectCommand({
+                Key: key,
+                Bucket: bucket,
+            });
+            const object = await s3Client.send(getObject);
+            if (!object.Body) {
+                throw new error_1.FatalError('No S3 object body');
+            }
+            const body = await (0, stream_1.bodyToString)(object.Body);
+            const json = JSON.parse(body);
+            const serviceName = key.replace('.json', '');
+            const serviceInfo = json[serviceName];
+            const serviceConfig = config[serviceName];
+            if (serviceInfo && serviceConfig) {
+                const currentVersion = serviceConfig.version ?? 1;
+                const deprecationGrace = serviceInfo.deprecationGrace ?? -1;
+                const compatibilityInfo = {
+                    name: serviceName,
+                    configVersion: currentVersion,
+                    minSupportedVersion: serviceInfo.minVersion,
+                    deprecatedVersion: serviceInfo.deprecated,
+                    deprecationGrace: deprecationGrace != -1 ? new Date(deprecationGrace) : undefined,
+                };
+                // If the service config in `sudoplatformconfig.json` is less than the
+                // minimum supported version then the client is incompatible.
+                if (currentVersion < (compatibilityInfo.minSupportedVersion ?? 0)) {
+                    incompatible.push(compatibilityInfo);
+                }
+                // If the service config is less than or equal to the deprecated version
+                // then it will be made incompatible after the deprecation grace.
+                if (currentVersion <= (compatibilityInfo.deprecatedVersion ?? 0)) {
+                    deprecated.push(compatibilityInfo);
+                }
+            }
+        }
+        return { incompatible, deprecated };
+    }
+}
+exports.DefaultConfigurationManager = DefaultConfigurationManager;
+//# sourceMappingURL=defaultConfigurationManager.js.map

package/cjs/configurationManager/defaultConfigurationManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultConfigurationManager.js","sourceRoot":"","sources":["../../src/configurationManager/defaultConfigurationManager.ts"],"names":[],"mappings":";;;AAAA,uDAAuD;AACvD,wDAAwD;AACxD,sDAAsD;AACtD,+DAA+D;AAC/D,4DAA4D;AAC5D,6CAA6C;AAC7C,iDAAyC;AAEzC,yDAAqD;AACrD,2CAKwB;AACxB,kDAI2B;AAC3B,4CAA8C;AAqH9C;;GAEG;AACH,MAAa,2BAA2B;IAKtC;QACE,cAAc;IAChB,CAAC;IAEM,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,2BAA2B,CAAC,QAAQ,EAAE;YACzC,2BAA2B,CAAC,QAAQ,GAAG,IAAI,2BAA2B,EAAE,CAAA;SACzE;QAED,OAAO,2BAA2B,CAAC,QAAQ,CAAA;IAC7C,CAAC;IAEM,SAAS,CAAC,MAAc;QAC7B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QAErB,OAAO,2BAA2B,CAAC,QAAQ,CAAA;IAC7C,CAAC;IAEM,YAAY,CAAC,SAAkB;QACpC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,MAAM,IAAI,gCAAwB,EAAE,CAAA;SACrC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACvC,MAAM,SAAS,GAAG,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;QAExD,OAAO,SAAS,CAAA;IAClB,CAAC;IAEM,IAAI,CAAI,SAAkB,EAAE,KAAc;QAC/C,6BAA6B;QAC7B,OAAO,IAAA,eAAI,EACT,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,EACvB,IAAA,aAAI,EACF,CAAC,MAAgB,EAAK,EAAE;YACtB,MAAM,IAAI,mBAAW,CAAC,2BAAY,CAAC,MAAM,CAAC,IAAA,aAAI,EAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;QACrE,CAAC,EACD,CAAC,CAAI,EAAK,EAAE,CAAC,CAAC,CACf,CACF,CAAA;IACH,CAAC;IAEM,aAAa,CAAI,KAAc,EAAE,SAAkB;QACxD,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAA;QAE9C,IAAI,CAAC,SAAS,EAAE;YACd,MAAM,IAAI,qCAA6B,CAAC,SAAS,CAAC,CAAA;SACnD;QAED,OAAO,IAAI,CAAC,IAAI,CAAI,SAAS,EAAE,KAAK,CAAC,CAAA;IACvC,CAAC;IAEM,KAAK,CAAC,cAAc;QACzB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,OAAO,EAAE,YAAY,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,CAAA;SAC5C;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAEvC,MAAM,MAAM,GAAG,MAAM,CAAC,eAAe,EAAE,MAAM,CAAA;QAC7C,MAAM,MAAM,GAAG,MAAM,CAAC,eAAe,EAAE,iBAAiB,CAAA;QAExD,IAAI,CAAC,CAAC,MAAM,IAAI,MAAM,CAAC,EAAE;YACvB,OAAO,EAAE,YAAY,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,CAAA;SAC5C;QAED,MAAM,QAAQ,GAAG,IAAI,oBAAQ,CAAC;YAC5B,MAAM,EAAE,MAAM;YACd,8CAA8C;YAC9C,gDAAgD;YAChD,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,OAAY,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;SAC7D,CAAC,CAAA;QAEF,MAAM,YAAY,GAA+B,EAAE,CAAA;QACnD,MAAM,UAAU,GAA+B,EAAE,CAAA;QAEjD,MAAM,kBAAkB,GAAG,IAAI,8BAAkB,CAAC;YAChD,MAAM,EAAE,MAAM;SACf,CAAC,CAAA;QAEF,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAA;QACvD,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE;YAC7B,OAAO,EAAE,YAAY,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,CAAA;SAC5C;QAED,MAAM,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAW,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAE9D,sFAAsF;QACtF,iCAAiC;QACjC,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAC7B,CAAC,GAAW,EAAE,EAAE,CACd,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAC5D,CAAA;QAED,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE;YAC7B,MAAM,SAAS,GAAG,IAAI,4BAAgB,CAAC;gBACrC,GAAG,EAAE,GAAG;gBACR,MAAM,EAAE,MAAM;aACf,CAAC,CAAA;YACF,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YAC7C,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;gBAChB,MAAM,IAAI,kBAAU,CAAC,mBAAmB,CAAC,CAAA;aAC1C;YACD,MAAM,IAAI,GAAG,MAAM,IAAA,qBAAY,EAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YAC5C,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YAC7B,MAAM,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;YAC5C,MAAM,WAAW,GAAQ,IAAI,CAAC,WAAW,CAAC,CAAA;YAC1C,MAAM,aAAa,GAAQ,MAAM,CAAC,WAAW,CAAC,CAAA;YAC9C,IAAI,WAAW,IAAI,aAAa,EAAE;gBAChC,MAAM,cAAc,GAAW,aAAa,CAAC,OAAO,IAAI,CAAC,CAAA;gBACzD,MAAM,gBAAgB,GAAW,WAAW,CAAC,gBAAgB,IAAI,CAAC,CAAC,CAAA;gBACnE,MAAM,iBAAiB,GAA6B;oBAClD,IAAI,EAAE,WAAW;oBACjB,aAAa,EAAE,cAAc;oBAC7B,mBAAmB,EAAE,WAAW,CAAC,UAAU;oBAC3C,iBAAiB,EAAE,WAAW,CAAC,UAAU;oBACzC,gBAAgB,EACd,gBAAgB,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,SAAS;iBAClE,CAAA;gBAED,sEAAsE;gBACtE,6DAA6D;gBAC7D,IAAI,cAAc,GAAG,CAAC,iBAAiB,CAAC,mBAAmB,IAAI,CAAC,CAAC,EAAE;oBACjE,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAA;iBACrC;gBAED,wEAAwE;gBACxE,iEAAiE;gBACjE,IAAI,cAAc,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,IAAI,CAAC,CAAC,EAAE;oBAChE,UAAU,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAA;iBACnC;aACF;SACF;QAED,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,CAAA;IACrC,CAAC;CACF;AA7ID,kEA6IC"}

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;