@sudoplatform/sudo-common 8.0.0 → 8.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sudoplatform/sudo-common",
-  "version": "8.0.0",
+  "version": "8.0.1",
   "author": "Anonyome Labs, Inc.",
   "repository": {
     "type": "git",
@@ -10,7 +10,7 @@
   "scripts": {
     "audit-with-suppressions": "bin/yarn-audit-with-suppression.sh",
     "outdated-with-suppressions": "bin/outdated-with-suppression.sh",
-    "clean": "rimraf ./docs ./cjs ./lib",
+    "clean": "rimraf ./docs ./cjs ./lib ./types",
     "lint": "yarn lint:eslint && yarn lint:prettier",
     "lint:eslint": "eslint \"{bin,integration-tests,src,test}/**/*.{ts,tsx}\"",
     "lint:prettier": "prettier -l \"**/*.{js,json,ts,yml}\"",
@@ -19,14 +19,22 @@
     "test": "jest",
     "build": "yarn clean && yarn build:transpile && yarn build:verify && yarn build:doc",
     "build:verify": "yarn audit-with-suppressions && yarn lint && yarn test --coverage",
-    "build:transpile": "concurrently \"yarn build:transpile:cjs\" \"yarn build:transpile:esm\"",
+    "build:transpile": "concurrently \"yarn build:transpile:declarations\" \"yarn build:transpile:cjs\" \"yarn build:transpile:esm\"",
     "build:transpile:cjs": "tsc --project tsconfig.commonjs.json",
     "build:transpile:esm": "tsc",
+    "build:transpile:declarations": "tsc --project tsconfig.declarations.json",
     "build:doc": "typedoc --treatWarningsAsErrors --excludePrivate --out docs src/index.ts"
   },
   "main": "./cjs/index.js",
-  "types": "./cjs/index.d.ts",
-  "module": "./lib/index.js",
+  "types": "./types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "import": "./lib/index.js",
+      "require": "./cjs/index.js",
+      "default": "./lib/index.js"
+    }
+  },
   "sideEffects": false,
   "bin": {
     "audit-with-suppressions": "bin/yarn-audit-with-suppression.sh",
@@ -37,7 +45,8 @@
   "files": [
     "bin",
     "cjs",
-    "lib"
+    "lib",
+    "types"
   ],
   "resolutions": {
     "**/apollo-cache-inmemory": "^1.6.6",
@@ -47,7 +56,7 @@
     "minimist": "^1.2.6"
   },
   "dependencies": {
-    "@aws-sdk/client-s3": "^3.145.0",
+    "@aws-sdk/client-s3": "^3.154.0",
     "apollo-client": "^2.6.10",
     "browser-bunyan": "^1.8.0",
     "fflate": "^0.7.3",
@@ -59,7 +68,7 @@
   },
   "devDependencies": {
     "@types/jest": "^27.5.2",
-    "@types/node": "^16.11.49",
+    "@types/node": "^16.11.51",
     "@typescript-eslint/eslint-plugin": "^5.33.0",
     "@typescript-eslint/parser": "^5.33.0",
     "aws-sdk-mock": "^5.7.0",

package/lib/configurationManager/defaultConfigurationManager.d.ts

@@ -1,123 +0,0 @@
-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/lib/errors/error.d.ts

@@ -1,263 +0,0 @@
-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/lib/index.d.ts

@@ -1,9 +0,0 @@
-export * from './configurationManager/defaultConfigurationManager';
-export * from './sudoKeyArchive';
-export * from './sudoKeyManager';
-export * from './utils/base64';
-export * from './utils/buffer';
-export * from './utils/stream';
-export * from './errors/error';
-export * from './logging/logger';
-export * from './types/types';

package/lib/logging/bunyanLogger.d.ts

@@ -1,8 +0,0 @@
-import { createLogger } from 'browser-bunyan';
-import * as t from 'io-ts';
-declare const Level: t.UnionC<[t.LiteralC<"trace">, t.LiteralC<"debug">, t.LiteralC<"info">, t.LiteralC<"warn">, t.LiteralC<"error">, t.LiteralC<"fatal">]>;
-declare type Level = t.TypeOf<typeof Level>;
-export declare function getLogLevel(level: string | undefined): Level | undefined;
-export declare function createBunyanLogger(identifier?: string, logLevel?: string): BunyanLogger;
-export declare type BunyanLogger = ReturnType<typeof createLogger>;
-export {};

package/lib/logging/logger.d.ts

@@ -1,87 +0,0 @@
-/**
- * Interface encapsulating logger functions.
- */
-export interface Logger {
-    /**
-     * @returns Whether or not trace level logging is enabled
-     */
-    trace(): boolean;
-    /**
-     * Will log the given message with the logger implementation using the TRACE level
-     * @param message the message to be logged
-     * @param fields optional fields that represent an object
-     */
-    trace(message: string, fields?: Record<string, unknown>): void;
-    /**
-     * @returns Whether or not debug level logging is enabled
-     */
-    debug(): boolean;
-    /**
-     * Will log the given message with the logger implementation using the DEBUG level
-     * @param message the message to be logged
-     * @param fields optional fields that represent an object
-     */
-    debug(message: string, fields?: Record<string, unknown>): void;
-    /**
-     * @returns Whether or not info level logging is enabled
-     */
-    info(): boolean;
-    /**
-     * Will log the given message with the logger implementation using the INFO level
-     * @param message the message to be logged
-     * @param fields optional fields that represent an object
-     */
-    info(message: string, fields?: Record<string, unknown>): void;
-    /**
-     * @returns Whether or not warn level logging is enabled
-     */
-    warn(): boolean;
-    /**
-     * Will log the given message with the logger implementation using the WARN level
-     * @param message the message to be logged
-     * @param fields optional fields that represent an object
-     */
-    warn(message: string, fields?: Record<string, unknown>): void;
-    /**
-     * @returns Whether or not error level logging is enabled
-     */
-    error(): boolean;
-    /**
-     * Will log the given message with the logger implementation using the ERROR level
-     * @param message the message to be logged
-     * @param fields optional fields that represent an object
-     */
-    error(message: string, fields?: Record<string, unknown>): void;
-    /**
-     * @returns Whether or not fatal level logging is enabled
-     */
-    fatal(): boolean;
-    /**
-     * Will log the given message with the logger implementation using the FATAL level
-     * @param message the message to be logged
-     * @param fields optional fields that represent an object
-     */
-    fatal(message: string, fields?: Record<string, unknown>): void;
-}
-export declare class DefaultLogger implements Logger {
-    private logger;
-    /**
-     * The default logger implementation which wraps browser-bunyan
-     *
-     * @param identifier the name of the module
-     * @param logLevel the log level for the module
-     */
-    constructor(identifier?: string, logLevel?: string);
-    trace(): boolean;
-    trace(message: string, fields?: Record<string, unknown>): void;
-    debug(): boolean;
-    debug(message: string, fields?: Record<string, unknown>): void;
-    info(): boolean;
-    info(message: string, fields?: Record<string, unknown>): void;
-    warn(): boolean;
-    warn(message: string, fields?: Record<string, unknown>): void;
-    error(): boolean;
-    error(message: string, fields?: Record<string, unknown>): void;
-    fatal(): boolean;
-    fatal(message: string, fields?: Record<string, unknown>): void;
-}

package/lib/sudoKeyArchive/index.d.ts

@@ -1,4 +0,0 @@
-export * from './keyArchive';
-export * from './keyInfo';
-export * from './keyType';
-export * from './sudoKeyArchive';