@authereum/resolution/src/errors/configurationError.ts

Domain Resolution for blockchain domains

import { ResolutionMethod } from '../publicTypes';
/** Alias for Resolution error handler function
 * @internal
 */
type ConfigurationErrorHandler = (error: ConfigurationErrorOptions) => string;
/** Explains Resolution Error options */
type ConfigurationErrorOptions = {
  method?: ResolutionMethod;
  dependency?: string;
  version?: string;
};

export enum ConfigurationErrorCode {
  IncorrectProvider = 'IncorrectProvider',
  UnspecifiedNetwork = 'UnspecifiedNetwork',
  UnspecifiedUrl = 'UnspecifiedUrl',
  MissingProviderConfigurations = 'MissingProviderConfigurations',
  DependencyMissing = "DependencyMissing"
}

/**
 * @internal
 * Internal Mapping object from ConfigurationErrorCode to a ConfigurationErrorHandler
 */
const HandlersByCode = {
  [ConfigurationErrorCode.IncorrectProvider]: (params: {}) =>
    'Provider doesn\'t implement sendAsync or send method',
  [ConfigurationErrorCode.UnspecifiedNetwork]: (params: {
    method: ResolutionMethod;
  }) => `Unspecified network in Resolution ${params.method} configuration`,
  [ConfigurationErrorCode.UnspecifiedUrl]: (params: {
    method: ResolutionMethod;
  }) => `Unspecified url in Resolution ${params.method} configuration`,
  [ConfigurationErrorCode.MissingProviderConfigurations]: (params: {}) =>
    `Couldn't find any configurations\n\tUse -C to configurate the library`,
  [ConfigurationErrorCode.DependencyMissing]: (params: {dependecy: string, version: string}) => 
    `Missing dependency for this functionality. Please install ${params.dependecy} @ ${params.version} via npm or yarn`
};

/**
 * Configuration Error class is designed to control every error being thrown by wrong configurations for objects
 * @param code - Error Code
 * - IncorrectProvider - When provider doesn't have implemented send or sendAsync methods
 * - UnspecifiedNetwork - When network is not specified for naming service configurations
 * - UnspecifiedUrl - When url is not specified for custom naming service configurations
 * @param method - optional param to specify which namingService errored out
 */
export class ConfigurationError extends Error {
  readonly code: ConfigurationErrorCode;
  readonly method?: string;

  constructor(
    code: ConfigurationErrorCode,
    options: ConfigurationErrorOptions = {},
  ) {
    const configurationErrorHandler: ConfigurationErrorHandler =
      HandlersByCode[code];
    super(configurationErrorHandler(options));
    this.code = code;
    this.method = options.method;
    this.name = 'ConfigurationError';
    Object.setPrototypeOf(this, ConfigurationError.prototype);
  }
}
export default ConfigurationError;