namefully 1.0.9 → 1.2.0

package/dist/lib/config.d.ts

@@ -0,0 +1,121 @@
+import { NameOrder, Separator, Title, Surname } from './types';
+/**
+ * The Configuration to use across the other components.
+ *
+ * The multiton pattern is used to handle configurations across the `namefully`
+ * setup. This adds consistency when building other components such as `FirstName`,
+ * `LastName`, or `Name` of distinct types that may be of particular shapes.
+ *
+ * For example, a person's `FullName` may appear by:
+ * - NameOrder.FIRST_NAME: `Jon Snow` or
+ * - NameOrder.LAST_NAME: `Snow Jon`.
+ *
+ * `Config` makes it easy to set up a specific configuration for `Namefully`
+ * and reuse it through other instances or components along the way. If a new
+ * `Config` is needed, a named configuration may be created. It is actually
+ * advised to use named `Config.create(name)` instead as it may help mitigate issues
+ * and avoid confusion and ambiguity in the future. Plus, a named configuration
+ * explains its purpose.
+ *
+ * ```ts
+ * const defaultConfig = Config.create();
+ * const mergedConfig = Config.merge({ name: 'other', title: Title.US });
+ * const copyConfig = mergedConfig.copyWith({ ending: true });
+ * ```
+ *
+ * Additionally, a configuration may be merged with or copied from an existing
+ * configuration, prioritizing the new one's values, as shown in the example
+ * above.
+ */
+export declare class Config {
+    private _name;
+    private _orderedBy;
+    private _separator;
+    private _title;
+    private _ending;
+    private _bypass;
+    private _surname;
+    /**
+     * Cache for multiple instances.
+     */
+    private static cache;
+    /**
+     * The order of appearance of a full name.
+     */
+    get orderedBy(): NameOrder;
+    /**
+     * The token used to indicate how to split string values.
+     */
+    get separator(): Separator;
+    /**
+     * The abbreviation type to indicate whether or not to add period to a prefix
+     * using the American or British way.
+     */
+    get title(): Title;
+    /**
+     * The option indicating if an ending suffix is used in a formal way.
+     */
+    get ending(): boolean;
+    /**
+     * A bypass of the validation rules with this option. This option is ideal
+     * to avoid checking their validity.
+     */
+    get bypass(): boolean;
+    /**
+     * An option indicating how to format a surname.
+     *
+     * The supported formats are:
+     * - `FATHER` name only
+     * - `MOTHER` name only
+     * - `HYPHENATED`, joining both father and mother names with a hyphen
+     * - `ALL`, joining both father and mother names with a space.
+     *
+     * Note that this option can be set when creating a `LastName`. As this can
+     * become ambiguous at the time of handling it, the value set in this is
+     * prioritized and viewed as the source of truth for future considerations.
+     */
+    get surname(): Surname;
+    /**
+     * The name of the cached configuration.
+     */
+    get name(): string;
+    private constructor();
+    /**
+     * Returns a named configuration with default values.
+     * @param name describing its purpose.
+     */
+    static create(name?: string): Config;
+    /**
+     * Returns a combined version of the existing values of the default configuration
+     * and the provided optional values of another configuration.
+     * @param other partial config to be combined with.
+     */
+    static merge(other?: Partial<Config>): Config;
+    /**
+     * Returns a copy of this configuration merged with the provided values.
+     *
+     * The word `_copy` is added to the existing config's name to create the new
+     * config's name if the name already exists for previous configurations. This
+     * is useful to maintain the uniqueness of each configuration. For example,
+     * if the new copy is made from the default configuration, this new copy will
+     * be named `default_copy`.
+     */
+    copyWith(options?: Partial<Config>): Config;
+    /**
+     * Makes an exact copy of the current configuration.
+     */
+    clone(): Config;
+    /**
+     * Resets the configuration by setting it back to its default values.
+     */
+    reset(): void;
+    /**
+     * Alters the name order between the first and last name, and rearrange the
+     * order of appearance of a name set.
+     */
+    updateOrder(order: NameOrder): void;
+    /**
+     * Generates a unique new name.
+     */
+    private genNewName;
+}

package/dist/lib/config.js

@@ -0,0 +1,189 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Config = void 0;
+const types_1 = require("./types");
+const defaultName = 'default';
+const copyAlias = '_copy';
+/**
+ * The Configuration to use across the other components.
+ *
+ * The multiton pattern is used to handle configurations across the `namefully`
+ * setup. This adds consistency when building other components such as `FirstName`,
+ * `LastName`, or `Name` of distinct types that may be of particular shapes.
+ *
+ * For example, a person's `FullName` may appear by:
+ * - NameOrder.FIRST_NAME: `Jon Snow` or
+ * - NameOrder.LAST_NAME: `Snow Jon`.
+ *
+ * `Config` makes it easy to set up a specific configuration for `Namefully`
+ * and reuse it through other instances or components along the way. If a new
+ * `Config` is needed, a named configuration may be created. It is actually
+ * advised to use named `Config.create(name)` instead as it may help mitigate issues
+ * and avoid confusion and ambiguity in the future. Plus, a named configuration
+ * explains its purpose.
+ *
+ * ```ts
+ * const defaultConfig = Config.create();
+ * const mergedConfig = Config.merge({ name: 'other', title: Title.US });
+ * const copyConfig = mergedConfig.copyWith({ ending: true });
+ * ```
+ *
+ * Additionally, a configuration may be merged with or copied from an existing
+ * configuration, prioritizing the new one's values, as shown in the example
+ * above.
+ */
+class Config {
+    constructor(name, orderedBy = types_1.NameOrder.FIRST_NAME, separator = types_1.Separator.SPACE, title = types_1.Title.UK, ending = false, bypass = true, surname = types_1.Surname.FATHER) {
+        this._name = name;
+        this._orderedBy = orderedBy;
+        this._separator = separator;
+        this._title = title;
+        this._ending = ending;
+        this._bypass = bypass;
+        this._surname = surname;
+    }
+    /**
+     * The order of appearance of a full name.
+     */
+    get orderedBy() {
+        return this._orderedBy;
+    }
+    /**
+     * The token used to indicate how to split string values.
+     */
+    get separator() {
+        return this._separator;
+    }
+    /**
+     * The abbreviation type to indicate whether or not to add period to a prefix
+     * using the American or British way.
+     */
+    get title() {
+        return this._title;
+    }
+    /**
+     * The option indicating if an ending suffix is used in a formal way.
+     */
+    get ending() {
+        return this._ending;
+    }
+    /**
+     * A bypass of the validation rules with this option. This option is ideal
+     * to avoid checking their validity.
+     */
+    get bypass() {
+        return this._bypass;
+    }
+    /**
+     * An option indicating how to format a surname.
+     *
+     * The supported formats are:
+     * - `FATHER` name only
+     * - `MOTHER` name only
+     * - `HYPHENATED`, joining both father and mother names with a hyphen
+     * - `ALL`, joining both father and mother names with a space.
+     *
+     * Note that this option can be set when creating a `LastName`. As this can
+     * become ambiguous at the time of handling it, the value set in this is
+     * prioritized and viewed as the source of truth for future considerations.
+     */
+    get surname() {
+        return this._surname;
+    }
+    /**
+     * The name of the cached configuration.
+     */
+    get name() {
+        return this._name;
+    }
+    /**
+     * Returns a named configuration with default values.
+     * @param name describing its purpose.
+     */
+    static create(name = defaultName) {
+        if (!Config.cache.has(name)) {
+            Config.cache.set(name, new this(name));
+        }
+        return Config.cache.get(name);
+    }
+    /**
+     * Returns a combined version of the existing values of the default configuration
+     * and the provided optional values of another configuration.
+     * @param other partial config to be combined with.
+     */
+    static merge(other) {
+        var _a, _b, _c, _d, _e, _f;
+        if (!other) {
+            return Config.create();
+        }
+        else {
+            const config = Config.create(other.name);
+            config._orderedBy = (_a = other.orderedBy) !== null && _a !== void 0 ? _a : config.orderedBy;
+            config._separator = (_b = other.separator) !== null && _b !== void 0 ? _b : config.separator;
+            config._title = (_c = other.title) !== null && _c !== void 0 ? _c : config.title;
+            config._ending = (_d = other.ending) !== null && _d !== void 0 ? _d : config.ending;
+            config._bypass = (_e = other.bypass) !== null && _e !== void 0 ? _e : config.bypass;
+            config._surname = (_f = other.surname) !== null && _f !== void 0 ? _f : config.surname;
+            return config;
+        }
+    }
+    /**
+     * Returns a copy of this configuration merged with the provided values.
+     *
+     * The word `_copy` is added to the existing config's name to create the new
+     * config's name if the name already exists for previous configurations. This
+     * is useful to maintain the uniqueness of each configuration. For example,
+     * if the new copy is made from the default configuration, this new copy will
+     * be named `default_copy`.
+     */
+    copyWith(options = {}) {
+        const { name, orderedBy, separator, title, ending, bypass, surname } = options;
+        const config = Config.create(this.genNewName(name !== null && name !== void 0 ? name : this.name + copyAlias));
+        config._orderedBy = orderedBy !== null && orderedBy !== void 0 ? orderedBy : this.orderedBy;
+        config._separator = separator !== null && separator !== void 0 ? separator : this.separator;
+        config._title = title !== null && title !== void 0 ? title : this.title;
+        config._ending = ending !== null && ending !== void 0 ? ending : this.ending;
+        config._bypass = bypass !== null && bypass !== void 0 ? bypass : this.bypass;
+        config._surname = surname !== null && surname !== void 0 ? surname : this.surname;
+        return config;
+    }
+    /**
+     * Makes an exact copy of the current configuration.
+     */
+    clone() {
+        return this.copyWith();
+    }
+    /**
+     * Resets the configuration by setting it back to its default values.
+     */
+    reset() {
+        this._orderedBy = types_1.NameOrder.FIRST_NAME;
+        this._separator = types_1.Separator.SPACE;
+        this._title = types_1.Title.UK;
+        this._ending = false;
+        this._bypass = true;
+        this._surname = types_1.Surname.FATHER;
+        Config.cache.set(this.name, this);
+    }
+    /**
+     * Alters the name order between the first and last name, and rearrange the
+     * order of appearance of a name set.
+     */
+    updateOrder(order) {
+        if (order && order !== this._orderedBy) {
+            Config.cache.get(this.name)._orderedBy = order;
+        }
+    }
+    /**
+     * Generates a unique new name.
+     */
+    genNewName(name) {
+        return name === this.name || Config.cache.has(name) ? this.genNewName(name + copyAlias) : name;
+    }
+}
+exports.Config = Config;
+/**
+ * Cache for multiple instances.
+ */
+Config.cache = new Map();
+//# sourceMappingURL=config.js.map

package/dist/lib/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":";;;AAAA,mCAA8D;AAE9D,MAAM,WAAW,GAAG,SAAS,CAAA;AAC7B,MAAM,SAAS,GAAG,OAAO,CAAA;AAEzB;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAa,MAAM;IA2Ef,YACI,IAAY,EACZ,SAAS,GAAG,iBAAS,CAAC,UAAU,EAChC,SAAS,GAAG,iBAAS,CAAC,KAAK,EAC3B,KAAK,GAAG,aAAK,CAAC,EAAE,EAChB,MAAM,GAAG,KAAK,EACd,MAAM,GAAG,IAAI,EACb,OAAO,GAAG,eAAO,CAAC,MAAM;QAExB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACjB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAA;QAC3B,IAAI,CAAC,UAAU,GAAG,SAAS,CAAA;QAC3B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;QACnB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QACrB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QACrB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAA;IAC3B,CAAC;IA7ED;;OAEG;IACH,IAAI,SAAS;QACT,OAAO,IAAI,CAAC,UAAU,CAAA;IAC1B,CAAC;IAED;;OAEG;IACH,IAAI,SAAS;QACT,OAAO,IAAI,CAAC,UAAU,CAAA;IAC1B,CAAC;IAED;;;OAGG;IACH,IAAI,KAAK;QACL,OAAO,IAAI,CAAC,MAAM,CAAA;IACtB,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,OAAO,CAAA;IACvB,CAAC;IAED;;;OAGG;IACH,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,OAAO,CAAA;IACvB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,OAAO;QACP,OAAO,IAAI,CAAC,QAAQ,CAAA;IACxB,CAAC;IAED;;OAEG;IACH,IAAI,IAAI;QACJ,OAAO,IAAI,CAAC,KAAK,CAAA;IACrB,CAAC;IAoBD;;;OAGG;IACH,MAAM,CAAC,MAAM,CAAC,IAAI,GAAG,WAAW;QAC5B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YACzB,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;SACzC;QACD,OAAO,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IACjC,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,KAAuB;;QAChC,IAAI,CAAC,KAAK,EAAE;YACR,OAAO,MAAM,CAAC,MAAM,EAAE,CAAA;SACzB;aAAM;YACH,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YACxC,MAAM,CAAC,UAAU,SAAG,KAAK,CAAC,SAAS,mCAAI,MAAM,CAAC,SAAS,CAAA;YACvD,MAAM,CAAC,UAAU,SAAG,KAAK,CAAC,SAAS,mCAAI,MAAM,CAAC,SAAS,CAAA;YACvD,MAAM,CAAC,MAAM,SAAG,KAAK,CAAC,KAAK,mCAAI,MAAM,CAAC,KAAK,CAAA;YAC3C,MAAM,CAAC,OAAO,SAAG,KAAK,CAAC,MAAM,mCAAI,MAAM,CAAC,MAAM,CAAA;YAC9C,MAAM,CAAC,OAAO,SAAG,KAAK,CAAC,MAAM,mCAAI,MAAM,CAAC,MAAM,CAAA;YAC9C,MAAM,CAAC,QAAQ,SAAG,KAAK,CAAC,OAAO,mCAAI,MAAM,CAAC,OAAO,CAAA;YACjD,OAAO,MAAM,CAAA;SAChB;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,UAA2B,EAAE;QAClC,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAA;QAC9E,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC,CAAC,CAAA;QAC5E,MAAM,CAAC,UAAU,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,IAAI,CAAC,SAAS,CAAA;QAC/C,MAAM,CAAC,UAAU,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,IAAI,CAAC,SAAS,CAAA;QAC/C,MAAM,CAAC,MAAM,GAAG,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,IAAI,CAAC,KAAK,CAAA;QACnC,MAAM,CAAC,OAAO,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,IAAI,CAAC,MAAM,CAAA;QACtC,MAAM,CAAC,OAAO,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,IAAI,CAAC,MAAM,CAAA;QACtC,MAAM,CAAC,QAAQ,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAI,CAAC,OAAO,CAAA;QACzC,OAAO,MAAM,CAAA;IACjB,CAAC;IAED;;OAEG;IACH,KAAK;QACD,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAA;IAC1B,CAAC;IAED;;OAEG;IACH,KAAK;QACD,IAAI,CAAC,UAAU,GAAG,iBAAS,CAAC,UAAU,CAAA;QACtC,IAAI,CAAC,UAAU,GAAG,iBAAS,CAAC,KAAK,CAAA;QACjC,IAAI,CAAC,MAAM,GAAG,aAAK,CAAC,EAAE,CAAA;QACtB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;QACpB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACnB,IAAI,CAAC,QAAQ,GAAG,eAAO,CAAC,MAAM,CAAA;QAC9B,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IACrC,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,KAAgB;QACxB,IAAI,KAAK,IAAI,KAAK,KAAK,IAAI,CAAC,UAAU,EAAE;YACpC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,UAAU,GAAG,KAAK,CAAA;SACjD;IACL,CAAC;IAED;;OAEG;IACK,UAAU,CAAC,IAAY;QAC3B,OAAO,IAAI,KAAK,IAAI,CAAC,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;IAClG,CAAC;;AApLL,wBAqLC;AA5KG;;GAEG;AACY,YAAK,GAAG,IAAI,GAAG,EAAkB,CAAA"}

package/dist/lib/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const version = "1.2.0";
+export declare const MIN_NUMBER_OF_NAME_PARTS = 2;
+export declare const MAX_NUMBER_OF_NAME_PARTS = 5;
+export declare const ALLOWED_TOKENS: string[];

package/dist/lib/constants.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ALLOWED_TOKENS = exports.MAX_NUMBER_OF_NAME_PARTS = exports.MIN_NUMBER_OF_NAME_PARTS = exports.version = void 0;
+exports.version = '1.2.0';
+exports.MIN_NUMBER_OF_NAME_PARTS = 2;
+exports.MAX_NUMBER_OF_NAME_PARTS = 5;
+exports.ALLOWED_TOKENS = [
+    '.',
+    ',',
+    ' ',
+    '-',
+    '_',
+    'b',
+    'B',
+    'f',
+    'F',
+    'l',
+    'L',
+    'm',
+    'M',
+    'n',
+    'N',
+    'o',
+    'O',
+    'p',
+    'P',
+    's',
+    'S',
+    '$',
+];
+//# sourceMappingURL=constants.js.map

package/dist/lib/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAA;AACjB,QAAA,wBAAwB,GAAG,CAAC,CAAA;AAC5B,QAAA,wBAAwB,GAAG,CAAC,CAAA;AAC5B,QAAA,cAAc,GAAG;IAC1B,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;CACN,CAAA"}

package/dist/lib/error.d.ts

@@ -0,0 +1,172 @@
+import { Name } from './name';
+import { Nullable } from './types';
+declare type NameSource = Nullable<string | string[] | Name[]>;
+interface ErrorMessage {
+    source: NameSource;
+    message?: string;
+}
+/**
+ * The error types supported by `Namefully`.
+ */
+export declare enum NameErrorType {
+    /**
+     * Thrown when a name entry/argument is incorrect.
+     *
+     * For example, a name should have a minimum of 2 characters, so an empty
+     * string or a string of one character would cause this kind of error.
+     */
+    INPUT = 0,
+    /**
+     * Thrown when the name components do not match the validation rules if the
+     * `Config.bypass` is not flagged up. This bypass option skips the validation
+     * rules.
+     *
+     * See also: `ValidationError`
+     */
+    VALIDATION = 1,
+    /**
+     * Thrown by not allowed operations such as in NameBuilder or name formatting.
+     *
+     * See also: `NotAllowedError`, `Namefully.format`.
+     */
+    NOT_ALLOWED = 2,
+    /**
+     * Thrown by any other unknown sources or unexpected situation.
+     */
+    UNKNOWN = 3
+}
+/**
+ * Base class for all name-related errors.
+ *
+ * A custom error is intended to convey information to the user about a failure,
+ * so that it can be addressed programmatically.
+ *
+ * A name handling failure is not considered a native error that should cause a
+ * program failure. Au contraire, it is expected that a programmer using this utility
+ * would consider validating a name using its own business rules. That is not
+ * this utility's job to guess those rules. So, the predefined `ValidationRules`
+ * obey some common validation techniques when it comes to sanitizing a person
+ * name. For this reason, the [Config.bypass] is set to `true` by default,
+ * indicating that those predefined rules should be skipped for the sake of the
+ * program.
+ *
+ * A programmer may leverage `Parser` to indicate business-tailored rules if he
+ * or she wants this utility to perform those safety checks behind the scenes.
+ *
+ * A name error intends to provide useful information about what causes the error
+ * and let the user take initiative on what happens next to the given name:
+ * reconstructing it or skipping it.
+ */
+export declare class NameError extends Error {
+    readonly source: NameSource;
+    readonly type: NameErrorType;
+    /**
+     * Creates an error with a message describing the issue for a name source.
+     * @param source name input that caused the error
+     * @param message a message describing the failure.
+     * @param type of `NameErrorType`
+     */
+    constructor(source: NameSource, message?: string, type?: NameErrorType);
+    /**
+     * The actual source input which caused the error.
+     */
+    get sourceAsString(): string;
+    /**
+     * Whether a message describing the failure exists.
+     */
+    get hasMessage(): boolean;
+    /**
+     * Returns a string representation of the error.
+     */
+    toString(): string;
+}
+/**
+ * An error thrown when a name source input is incorrect.
+ *
+ * A `Name` is a name for this utility under certain criteria (i.e., 2+ chars),
+ * hence, a wrong input will cause this kind of error. Another common reason
+ * may be a wrong key in a Json name parsing mechanism.
+ *
+ * Keep in mind that this error is different from a `ValidationError`.
+ */
+export declare class InputError extends NameError {
+    /**
+     * Creates a new `InputError` with an optional error `message`.
+     *
+     * The name source is by nature a string content, maybe wrapped up in a different
+     * type. This string value may be extracted to form the following output:
+     *   "InputError (stringName)",
+     *   "InputError (stringName): message".
+     */
+    constructor(error: ErrorMessage);
+}
+/**
+ * An error thrown to indicate that a name fails the validation rules.
+ */
+export declare class ValidationError extends NameError {
+    /**
+     * Name of the invalid `nameType` if available.
+     */
+    readonly nameType: string;
+    /**
+     * Creates error containing the invalid `nameType` and a `message` that
+     * briefly describes the problem if provided.
+     *
+     * For example, a validation error can be interpreted as:
+     *     "ValidationError (nameType='stringName')",
+     *     "ValidationError (nameType='stringName'): message"
+     */
+    constructor(error: ErrorMessage & {
+        nameType: string;
+    });
+    toString(): string;
+}
+/**
+ * Thrown by not allowed operations such as in name formatting.
+ *
+ * For example, this will occur when trying to format a name accordingly using
+ * a non-supported key.
+ */
+export declare class NotAllowedError extends NameError {
+    /**
+     * The revoked operation name.
+     */
+    readonly operation: string;
+    /**
+     * Creates a new `NotAllowedError` with an optional error `message` and the
+     * `operation` name.
+     *
+     * For example, an error of this kind can be interpreted as:
+     *     "NotAllowedError (stringName)",
+     *     "NotAllowedError (stringName) - operationName",
+     *     "NotAllowedError (stringName) - operationName: message"
+     */
+    constructor(error: ErrorMessage & {
+        operation: string;
+    });
+    toString(): string;
+}
+/**
+ * A fallback error thrown by any unknown sources or unexpected failure that are
+ * not of `NameError`.
+ *
+ * In this particular case, an `origin` remains useful as it provides details
+ * on the sources and the true nature of the unexpected error.
+ * At this point, deciding whether to exit the program or not depends on the
+ * programmer.
+ */
+export declare class UnknownError extends NameError {
+    /**
+     * The possible unknown error, with trace revealing its source and reason.
+     */
+    readonly origin?: Error;
+    /**
+     * Creates a new `UnknownError` with an optional error `message`.
+     * Optionally, the original error revealing the true nature of the failure.
+     */
+    constructor(error: ErrorMessage & {
+        error?: Error;
+    });
+    toString(): string;
+}
+export {};