@sudoplatform/sudo-common 5.9.0 → 6.0.1

package/lib/errors/error.d.ts

@@ -9,10 +9,11 @@ export declare type AppSyncNetworkError = Error & {
 };
 export declare function isAppSyncNetworkError(u: Error): u is AppSyncNetworkError;
 /**
- * Indicates the GraphQL API returned an error that's not recognized by the client.
+ * Indicates the GraphQL API returned an error that's not recognized by
+ * the client.
  */
 export declare class UnknownGraphQLError extends Error {
-    constructor(cause: AppSyncError);
+    constructor(cause: unknown);
 }
 /**
  * The configuration set was not found by the given key

package/lib/errors/error.js

@@ -15,16 +15,28 @@ function isAppSyncNetworkError(u) {
   return !!u.networkError;
 }
 /**
- * Indicates the GraphQL API returned an error that's not recognized by the client.
+ * Indicates the GraphQL API returned an error that's not recognized by
+ * the client.
  */
 
 
 class UnknownGraphQLError extends Error {
   constructor(cause) {
-    var _cause$errorType;
+    const maybeAppSyncError = cause;
+    let message;
+
+    if (maybeAppSyncError !== null && maybeAppSyncError !== void 0 && maybeAppSyncError.errorType) {
+      message = `type: ${maybeAppSyncError.errorType}, message: ${maybeAppSyncError.message}`;
+    } else if (maybeAppSyncError !== null && maybeAppSyncError !== void 0 && maybeAppSyncError.message) {
+      message = maybeAppSyncError === null || maybeAppSyncError === void 0 ? void 0 : maybeAppSyncError.message;
+    } else if (maybeAppSyncError !== null && maybeAppSyncError !== void 0 && maybeAppSyncError.name) {
+      message = maybeAppSyncError.name;
+    } else {
+      message = 'unknown cause';
+    }
 
-    super(`type: ${(_cause$errorType = cause.errorType) !== null && _cause$errorType !== void 0 ? _cause$errorType : '<cause type not specified>'}, message: ${cause.message}`);
-    this.name = 'GraphQLError';
+    super(message);
+    this.name = 'UnknownGraphQLError';
   }
 
 }
@@ -129,7 +141,7 @@ exports.RegisterError = RegisterError;
 
 class NotRegisteredError extends Error {
   constructor(message) {
-    super(message !== null && message !== void 0 ? message : 'User is not registered.');
+    super(message ?? 'User is not registered.');
     this.name = 'NotRegisteredError';
   }
 
@@ -144,7 +156,7 @@ exports.NotRegisteredError = NotRegisteredError;
 
 class NotAuthorizedError extends Error {
   constructor(message) {
-    super(message !== null && message !== void 0 ? message : 'User is not authorized perform the requested operation.');
+    super(message ?? 'User is not authorized perform the requested operation.');
     this.name = 'NotAuthorizedError';
   }
 
@@ -264,7 +276,7 @@ exports.ServiceError = ServiceError;
 
 class IllegalArgumentError extends Error {
   constructor(message) {
-    super(message !== null && message !== void 0 ? message : 'Invalid arguments were specified');
+    super(message ?? 'Invalid arguments were specified');
     this.name = 'IllegalArgumentError';
   }
 
@@ -316,9 +328,7 @@ class RequestFailedError extends Error {
    * status code.
    */
   constructor(cause, statusCode) {
-    var _cause$message;
-
-    super(`API request failed. cause: ${(_cause$message = cause === null || cause === void 0 ? void 0 : cause.message) !== null && _cause$message !== void 0 ? _cause$message : '<none>'}, statusCode: ${statusCode !== null && statusCode !== void 0 ? statusCode : '<none>'}`);
+    super(`API request failed. cause: ${(cause === null || cause === void 0 ? void 0 : cause.message) ?? '<none>'}, statusCode: ${statusCode ?? '<none>'}`);
 
     _defineProperty(this, "cause", void 0);
 
@@ -382,7 +392,7 @@ exports.InvalidTokenError = InvalidTokenError;
 
 class KeyNotFoundError extends Error {
   constructor(message) {
-    super(message !== null && message !== void 0 ? message : 'Key not found.');
+    super(message ?? 'Key not found.');
     this.name = 'KeyNotFoundError';
   }
 
@@ -396,7 +406,7 @@ exports.KeyNotFoundError = KeyNotFoundError;
 
 class KeyStoreNotExportableError extends Error {
   constructor(message) {
-    super(message !== null && message !== void 0 ? message : 'Key store not exportable.');
+    super(message ?? 'Key store not exportable.');
     this.name = 'KeyStoreNotExportableError';
   }
 
@@ -410,7 +420,7 @@ exports.KeyStoreNotExportableError = KeyStoreNotExportableError;
 
 class KeyArchiveMissingError extends Error {
   constructor(message) {
-    super(message !== null && message !== void 0 ? message : 'No key archive provided prior to unarchiving');
+    super(message ?? 'No key archive provided prior to unarchiving');
     this.name = 'KeyArchiveMissingError';
   }
 
@@ -424,7 +434,7 @@ exports.KeyArchiveMissingError = KeyArchiveMissingError;
 
 class KeyArchivePasswordRequiredError extends Error {
   constructor(message) {
-    super(message !== null && message !== void 0 ? message : 'No password provided to unarchive secure archive');
+    super(message ?? 'No password provided to unarchive secure archive');
     this.name = 'KeyArchivePasswordRequiredError';
   }
 
@@ -438,7 +448,7 @@ exports.KeyArchivePasswordRequiredError = KeyArchivePasswordRequiredError;
 
 class KeyArchiveNoPasswordRequiredError extends Error {
   constructor(message) {
-    super(message !== null && message !== void 0 ? message : 'No password required to unarchive insecure archive');
+    super(message ?? 'No password required to unarchive insecure archive');
     this.name = 'KeyArchiveNoPasswordRequiredError';
   }
 
@@ -452,7 +462,7 @@ exports.KeyArchiveNoPasswordRequiredError = KeyArchiveNoPasswordRequiredError;
 
 class KeyArchiveDecodingError extends Error {
   constructor(message) {
-    super(message !== null && message !== void 0 ? message : 'Key archive data could not be decoded as expected');
+    super(message ?? 'Key archive data could not be decoded as expected');
     this.name = 'KeyArchiveDecodingError';
   }
 
@@ -466,7 +476,7 @@ exports.KeyArchiveDecodingError = KeyArchiveDecodingError;
 
 class KeyArchiveIncorrectPasswordError extends Error {
   constructor(message) {
-    super(message !== null && message !== void 0 ? message : 'Key archive was unable to be decrypted using the provided password');
+    super(message ?? 'Key archive was unable to be decrypted using the provided password');
     this.name = 'KeyArchiveIncorrectPasswordError';
   }
 
@@ -508,7 +518,7 @@ exports.KeyArchiveVersionError = KeyArchiveVersionError;
 
 class KeyArchiveUnknownKeyTypeError extends Error {
   constructor(message) {
-    super(message !== null && message !== void 0 ? message : 'Key type is not recognized');
+    super(message ?? 'Key type is not recognized');
     this.name = 'KeyArchiveUnknownKeyTypeError';
   }
 
@@ -522,7 +532,7 @@ exports.KeyArchiveUnknownKeyTypeError = KeyArchiveUnknownKeyTypeError;
 
 class OperationNotImplementedError extends Error {
   constructor(message) {
-    super(message !== null && message !== void 0 ? message : 'Operation is not implemented');
+    super(message ?? 'Operation is not implemented');
     this.name = 'OperationNotImplementedError';
   }
 
@@ -536,7 +546,7 @@ exports.OperationNotImplementedError = OperationNotImplementedError;
 
 class UnrecognizedAlgorithmError extends Error {
   constructor(message) {
-    super(message !== null && message !== void 0 ? message : 'Unrecognized encryption algorithm name.');
+    super(message ?? 'Unrecognized encryption algorithm name.');
     this.name = 'UnrecognizedAlgorithmError';
   }
 

package/lib/logging/logger.d.ts

@@ -2,36 +2,60 @@
  * 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
@@ -48,10 +72,16 @@ export declare class DefaultLogger implements Logger {
      * @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/logging/logger.js

@@ -23,6 +23,8 @@ class DefaultLogger {
   }
 
   trace(message, fields) {
+    if (message === undefined) return this.logger.trace();
+
     if (fields) {
       this.logger.trace({
         obj: fields
@@ -33,6 +35,8 @@ class DefaultLogger {
   }
 
   debug(message, fields) {
+    if (message === undefined) return this.logger.debug();
+
     if (fields) {
       this.logger.debug({
         obj: fields
@@ -43,6 +47,8 @@ class DefaultLogger {
   }
 
   info(message, fields) {
+    if (message === undefined) return this.logger.info();
+
     if (fields) {
       this.logger.info({
         obj: fields
@@ -53,6 +59,8 @@ class DefaultLogger {
   }
 
   warn(message, fields) {
+    if (message === undefined) return this.logger.warn();
+
     if (fields) {
       this.logger.warn({
         obj: fields
@@ -63,6 +71,8 @@ class DefaultLogger {
   }
 
   error(message, fields) {
+    if (message === undefined) return this.logger.error();
+
     if (fields) {
       this.logger.error({
         obj: fields
@@ -73,6 +83,8 @@ class DefaultLogger {
   }
 
   fatal(message, fields) {
+    if (message === undefined) return this.logger.fatal();
+
     if (fields) {
       this.logger.fatal({
         obj: fields

package/lib/sudoKeyManager/sudoCryptoProvider.d.ts

@@ -69,6 +69,12 @@ export interface SudoCryptoProvider {
      * @returns The symmetric key or undefined if not found.
      */
     getSymmetricKey(name: string): Promise<ArrayBuffer | undefined>;
+    /**
+     * Checks to see if the specified symmetric key exists.
+     *
+     * @param name The name of the symmetric key.
+     */
+    doesSymmetricKeyExists(name: string): Promise<boolean>;
     /**
      * Deletes a symmetric key from the secure store.
      *
@@ -122,6 +128,12 @@ export interface SudoCryptoProvider {
      * @returns Requested private key or undefined if the key was not found.
      */
     getPrivateKey(name: string): Promise<ArrayBuffer | undefined>;
+    /**
+     * Checks to see if the specified private key exists.
+     *
+     * @param name The name of the private key.
+     */
+    doesPrivateKeyExists(name: string): Promise<boolean>;
     /**
      * Adds a public key to the secure store.
      *

package/lib/sudoKeyManager/sudoKeyManager.d.ts

@@ -51,6 +51,12 @@ export interface SudoKeyManager {
      * @returns The symmetric key or undefined if not found.
      */
     getSymmetricKey(name: string): Promise<ArrayBuffer | undefined>;
+    /**
+     * Checks to see if the specified symmetric key exists.
+     *
+     * @param name The name of the symmetric key.
+     */
+    doesSymmetricKeyExists(name: string): Promise<boolean>;
     /**
      * Deletes a symmetric key from the secure store.
      *
@@ -72,6 +78,12 @@ export interface SudoKeyManager {
      * @returns Requested private key or undefined if the key was not found.
      */
     getPrivateKey(name: string): Promise<ArrayBuffer | undefined>;
+    /**
+     * Checks to see if the specified private key exists.
+     *
+     * @param name The name of the private key.
+     */
+    doesPrivateKeyExists(name: string): Promise<boolean>;
     /**
      * Adds a public key to the secure store.
      *
@@ -278,10 +290,12 @@ export declare class DefaultSudoKeyManager implements SudoKeyManager {
     updatePassword(password: ArrayBuffer, name: string): Promise<void>;
     addSymmetricKey(key: ArrayBuffer, name: string): Promise<void>;
     getSymmetricKey(name: string): Promise<ArrayBuffer | undefined>;
+    doesSymmetricKeyExists(name: string): Promise<boolean>;
     deleteSymmetricKey(name: string): Promise<void>;
     generateKeyPair(name: string): Promise<void>;
     addPrivateKey(key: ArrayBuffer, name: string): Promise<void>;
     getPrivateKey(name: string): Promise<ArrayBuffer | undefined>;
+    doesPrivateKeyExists(name: string): Promise<boolean>;
     addPublicKey(key: ArrayBuffer, name: string): Promise<void>;
     getPublicKey(name: string): Promise<PublicKey | undefined>;
     deleteKeyPair(name: string): Promise<void>;

package/lib/sudoKeyManager/sudoKeyManager.js

@@ -49,6 +49,10 @@ class DefaultSudoKeyManager {
     return this.sudoCryptoProvider.getSymmetricKey(name);
   }
 
+  doesSymmetricKeyExists(name) {
+    return this.sudoCryptoProvider.doesSymmetricKeyExists(name);
+  }
+
   deleteSymmetricKey(name) {
     return this.sudoCryptoProvider.deleteSymmetricKey(name);
   }
@@ -65,6 +69,10 @@ class DefaultSudoKeyManager {
     return this.sudoCryptoProvider.getPrivateKey(name);
   }
 
+  doesPrivateKeyExists(name) {
+    return this.sudoCryptoProvider.doesPrivateKeyExists(name);
+  }
+
   addPublicKey(key, name) {
     return this.sudoCryptoProvider.addPublicKey(key, name);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sudoplatform/sudo-common",
-  "version": "5.9.0",
+  "version": "6.0.1",
   "author": "Anonyome Labs, Inc.",
   "repository": {
     "type": "git",
@@ -9,6 +9,7 @@
   "license": "Apache-2.0",
   "scripts": {
     "audit-with-suppressions": "bin/yarn-audit-with-suppression.sh",
+    "outdated-with-suppressions": "bin/yarn-outdated-with-suppression.sh",
     "clean": "rimraf ./lib ./test-lib",
     "lint": "yarn lint:eslint && yarn lint:prettier",
     "lint:eslint": "eslint \"{bin,integration-tests,src,test}/**/*.{ts,tsx}\"",
@@ -24,7 +25,9 @@
   "types": "./lib/index.d.ts",
   "bin": {
     "audit-with-suppressions": "bin/yarn-audit-with-suppression.sh",
-    "suppress-audit": "bin/suppress-audit.sh"
+    "suppress-audit": "bin/suppress-audit.sh",
+    "outdated-with-suppressions": "bin/yarn-outdated-with-suppression.sh",
+    "suppress-outdated": "bin/suppress-outdated.sh"
   },
   "files": [
     "lib",
@@ -53,23 +56,23 @@
     "@babel/preset-env": "^7.15.8",
     "@babel/preset-typescript": "^7.15.0",
     "@types/jest": "^27.0.2",
-    "@typescript-eslint/eslint-plugin": "^4.33.0",
-    "@typescript-eslint/parser": "^4.33.0",
-    "eslint": "^7.32.0",
+    "@typescript-eslint/eslint-plugin": "^5.1.0",
+    "@typescript-eslint/parser": "^5.1.0",
+    "eslint": "^8.0.1",
     "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-import": "^2.24.2",
+    "eslint-plugin-import": "^2.25.2",
     "eslint-plugin-prettier": "^4.0.0",
-    "fp-ts": "^2.11.4",
+    "fp-ts": "^2.11.5",
     "io-ts": "^2.2.16",
     "io-ts-types": "^0.5.16",
     "isomorphic-webcrypto": "^2.3.8",
-    "jest": "^27.2.4",
+    "jest": "^27.3.1",
     "monocle-ts": "^2.3.11",
     "newtype-ts": "^0.3.2",
     "prettier": "^2.4.1",
     "rimraf": "^3.0.2",
     "ts-mockito": "^2.6.1",
-    "typedoc": "^0.22.5",
-    "typescript": "^4.4.3"
+    "typedoc": "^0.22.6",
+    "typescript": "^4.4.4"
   }
 }

package/src/errors/error.ts

@@ -16,16 +16,25 @@ export function isAppSyncNetworkError(u: Error): u is AppSyncNetworkError {
 }
 
 /**
- * Indicates the GraphQL API returned an error that's not recognized by the client.
+ * Indicates the GraphQL API returned an error that's not recognized by
+ * the client.
  */
 export class UnknownGraphQLError extends Error {
-  constructor(cause: AppSyncError) {
-    super(
-      `type: ${cause.errorType ?? '<cause type not specified>'}, message: ${
-        cause.message
-      }`,
-    )
-    this.name = 'GraphQLError'
+  constructor(cause: unknown) {
+    const maybeAppSyncError = cause as AppSyncError
+    let message: string
+    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'
   }
 }
 

package/src/logging/logger.ts

@@ -4,36 +4,71 @@ import { BunyanLogger, createBunyanLogger } from './bunyanLogger'
  * 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
@@ -55,7 +90,11 @@ export class DefaultLogger implements Logger {
     this.logger = createBunyanLogger(identifier, logLevel)
   }
 
-  trace(message: string, fields?: Record<string, unknown>): void {
+  trace(): boolean
+  trace(message: string, fields?: Record<string, unknown>): void
+  trace(message?: string, fields?: Record<string, unknown>): boolean | void {
+    if (message === undefined) return this.logger.trace()
+
     if (fields) {
       this.logger.trace({ obj: fields }, message)
     } else {
@@ -63,7 +102,11 @@ export class DefaultLogger implements Logger {
     }
   }
 
-  debug(message: string, fields?: Record<string, unknown>): void {
+  debug(): boolean
+  debug(message: string, fields?: Record<string, unknown>): void
+  debug(message?: string, fields?: Record<string, unknown>): boolean | void {
+    if (message === undefined) return this.logger.debug()
+
     if (fields) {
       this.logger.debug({ obj: fields }, message)
     } else {
@@ -71,7 +114,11 @@ export class DefaultLogger implements Logger {
     }
   }
 
-  info(message: string, fields?: Record<string, unknown>): void {
+  info(): boolean
+  info(message: string, fields?: Record<string, unknown>): void
+  info(message?: string, fields?: Record<string, unknown>): boolean | void {
+    if (message === undefined) return this.logger.info()
+
     if (fields) {
       this.logger.info({ obj: fields }, message)
     } else {
@@ -79,7 +126,11 @@ export class DefaultLogger implements Logger {
     }
   }
 
-  warn(message: string, fields?: Record<string, unknown>): void {
+  warn(): boolean
+  warn(message: string, fields?: Record<string, unknown>): void
+  warn(message?: string, fields?: Record<string, unknown>): boolean | void {
+    if (message === undefined) return this.logger.warn()
+
     if (fields) {
       this.logger.warn({ obj: fields }, message)
     } else {
@@ -87,7 +138,11 @@ export class DefaultLogger implements Logger {
     }
   }
 
-  error(message: string, fields?: Record<string, unknown>): void {
+  error(): boolean
+  error(message: string, fields?: Record<string, unknown>): void
+  error(message?: string, fields?: Record<string, unknown>): boolean | void {
+    if (message === undefined) return this.logger.error()
+
     if (fields) {
       this.logger.error({ obj: fields }, message)
     } else {
@@ -95,7 +150,11 @@ export class DefaultLogger implements Logger {
     }
   }
 
-  fatal(message: string, fields?: Record<string, unknown>): void {
+  fatal(): boolean
+  fatal(message: string, fields?: Record<string, unknown>): void
+  fatal(message?: string, fields?: Record<string, unknown>): boolean | void {
+    if (message === undefined) return this.logger.fatal()
+
     if (fields) {
       this.logger.fatal({ obj: fields }, message)
     } else {

package/src/sudoKeyManager/sudoCryptoProvider.ts

@@ -85,6 +85,13 @@ export interface SudoCryptoProvider {
    */
   getSymmetricKey(name: string): Promise<ArrayBuffer | undefined>
 
+  /**
+   * Checks to see if the specified symmetric key exists.
+   *
+   * @param name The name of the symmetric key.
+   */
+  doesSymmetricKeyExists(name: string): Promise<boolean>
+
   /**
    * Deletes a symmetric key from the secure store.
    *
@@ -147,6 +154,13 @@ export interface SudoCryptoProvider {
    */
   getPrivateKey(name: string): Promise<ArrayBuffer | undefined>
 
+  /**
+   * Checks to see if the specified private key exists.
+   *
+   * @param name The name of the private key.
+   */
+  doesPrivateKeyExists(name: string): Promise<boolean>
+
   /**
    * Adds a public key to the secure store.
    *