namefully 1.2.0 → 1.2.1

package/dist/lib/validator.js

@@ -1,4 +1,16 @@
 "use strict";
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var _a, _NamonValidator_validator, _b, _FirstNameValidator_validator, _c, _MiddleNameValidator_validator, _d, _LastNameValidator_validator, _e, _NameValidator_validator, _f, _NamaValidator_validator, _ArrayNameValidator_instances, _g, _ArrayNameValidator_validator, _ArrayNameValidator_hasBasicNames;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Validators = exports.ArrayNameValidator = exports.ArrayStringValidator = exports.NamaValidator = void 0;
 const constants_1 = require("./constants");
@@ -6,64 +18,16 @@ const error_1 = require("./error");
 const name_1 = require("./name");
 const types_1 = require("./types");
 const utils_1 = require("./utils");
-/**
- * Represents a set of validation rules (regex)
- *
- * This regex is intented to match specific alphabets only as a person name does
- * not contain special characters. `\w` does not cover non-Latin characters. So,
- * it is extended using unicode chars to cover more cases (e.g., Icelandic).
- * It matches as follows:
- *  [a-z]: Latin alphabet from a (index 97) to z (index 122)
- *  [A-Z]: Latin alphabet from A (index 65) to Z (index 90)
- *  [\u00C0-\u00D6]: Latin/German chars from À (index 192) to Ö (index 214)
- *  [\u00D8-\u00f6]: German/Icelandic chars from Ø (index 216) to ö (index 246)
- *  [\u00f8-\u00ff]: German/Icelandic chars from ø (index 248) to ÿ (index 255)
- *  [\u0400-\u04FF]: Cyrillic alphabet from Ѐ (index 1024) to ӿ (index 1279)
- *  [Ά-ωΑ-ώ]: Greek alphabet from Ά (index 902) to ω (index 969)
- */
 class ValidationRule {
 }
 ValidationRule.base = /[a-zA-Z\u00C0-\u00D6\u00D8-\u00f6\u00f8-\u00ff\u0400-\u04FFΆ-ωΑ-ώ]/;
-/**
- * Matches one name part (namon) that is of nature:
- * - Latin (English, Spanish, French, etc.)
- * - European (Greek, Cyrillic, Icelandic, German)
- * - hyphenated
- * - with apostrophe
- * - with space
- */
 ValidationRule.namon = new RegExp(`^${ValidationRule.base.source}+(([' -]${ValidationRule.base.source})?${ValidationRule.base.source}*)*$`);
-/**
- * Matches one name part (namon) that is of nature:
- * - Latin (English, Spanish, French, etc.)
- * - European (Greek, Cyrillic, Icelandic, German)
- * - hyphenated
- * - with apostrophe
- */
 ValidationRule.firstName = ValidationRule.namon;
-/**
- * Matches 1+ names part (namon) that are of nature:
- * - Latin (English, Spanish, French, etc.)
- * - European (Greek, Cyrillic, Icelandic, German)
- * - hyphenated
- * - with apostrophe
- * - with space
- */
 ValidationRule.middleName = new RegExp(`^${ValidationRule.base.source}+(([' -]${ValidationRule.base.source})?${ValidationRule.base.source}*)*$`);
-/**
- * Matches one name part (namon) that is of nature:
- * - Latin (English, Spanish, French, etc.)
- * - European (Greek, Cyrillic, Icelandic, German)
- * - hyphenated
- * - with apostrophe
- * - with space
- */
 ValidationRule.lastName = ValidationRule.namon;
 class ArrayValidator {
     validate(values) {
-        if (values.length === 0 ||
-            values.length < constants_1.MIN_NUMBER_OF_NAME_PARTS ||
-            values.length > constants_1.MAX_NUMBER_OF_NAME_PARTS) {
+        if (values.length === 0 || values.length < constants_1.MIN_NUMBER_OF_NAME_PARTS || values.length > constants_1.MAX_NUMBER_OF_NAME_PARTS) {
             throw new error_1.InputError({
                 source: values.map((n) => n.toString()),
                 message: `expecting a list of ${constants_1.MIN_NUMBER_OF_NAME_PARTS}-${constants_1.MIN_NUMBER_OF_NAME_PARTS} elements`,
@@ -72,9 +36,8 @@ class ArrayValidator {
     }
 }
 class NamonValidator {
-    constructor() { }
     static create() {
-        return this.validator || (this.validator = new this());
+        return __classPrivateFieldGet(this, _a, "f", _NamonValidator_validator) || (__classPrivateFieldSet(this, _a, new this(), "f", _NamonValidator_validator));
     }
     validate(value, type) {
         if (value instanceof name_1.Name) {
@@ -97,10 +60,11 @@ class NamonValidator {
         }
     }
 }
+_a = NamonValidator;
+_NamonValidator_validator = { value: void 0 };
 class FirstNameValidator {
-    constructor() { }
     static create() {
-        return this.validator || (this.validator = new this());
+        return __classPrivateFieldGet(this, _b, "f", _FirstNameValidator_validator) || (__classPrivateFieldSet(this, _b, new this(), "f", _FirstNameValidator_validator));
     }
     validate(value) {
         if (value instanceof name_1.FirstName) {
@@ -123,10 +87,11 @@ class FirstNameValidator {
         }
     }
 }
+_b = FirstNameValidator;
+_FirstNameValidator_validator = { value: void 0 };
 class MiddleNameValidator {
-    constructor() { }
     static create() {
-        return this.validator || (this.validator = new this());
+        return __classPrivateFieldGet(this, _c, "f", _MiddleNameValidator_validator) || (__classPrivateFieldSet(this, _c, new this(), "f", _MiddleNameValidator_validator));
     }
     validate(value) {
         if (typeof value === 'string') {
@@ -160,10 +125,11 @@ class MiddleNameValidator {
         }
     }
 }
+_c = MiddleNameValidator;
+_MiddleNameValidator_validator = { value: void 0 };
 class LastNameValidator {
-    constructor() { }
     static create() {
-        return this.validator || (this.validator = new this());
+        return __classPrivateFieldGet(this, _d, "f", _LastNameValidator_validator) || (__classPrivateFieldSet(this, _d, new this(), "f", _LastNameValidator_validator));
     }
     validate(value) {
         if (value instanceof name_1.LastName) {
@@ -186,10 +152,11 @@ class LastNameValidator {
         }
     }
 }
+_d = LastNameValidator;
+_LastNameValidator_validator = { value: void 0 };
 class NameValidator {
-    constructor() { }
     static create() {
-        return this.validator || (this.validator = new this());
+        return __classPrivateFieldGet(this, _e, "f", _NameValidator_validator) || (__classPrivateFieldSet(this, _e, new this(), "f", _NameValidator_validator));
     }
     validate(name, type) {
         if (type && name.type !== type) {
@@ -208,10 +175,11 @@ class NameValidator {
         }
     }
 }
+_e = NameValidator;
+_NameValidator_validator = { value: void 0 };
 class NamaValidator {
-    constructor() { }
     static create() {
-        return this.validator || (this.validator = new this());
+        return __classPrivateFieldGet(this, _f, "f", _NamaValidator_validator) || (__classPrivateFieldSet(this, _f, new this(), "f", _NamaValidator_validator));
     }
     validate(value) {
         this.validateKeys(value);
@@ -249,6 +217,8 @@ class NamaValidator {
     }
 }
 exports.NamaValidator = NamaValidator;
+_f = NamaValidator;
+_NamaValidator_validator = { value: void 0 };
 class ArrayStringValidator extends ArrayValidator {
     constructor(index = utils_1.NameIndex.base()) {
         super();
@@ -287,9 +257,11 @@ class ArrayStringValidator extends ArrayValidator {
 }
 exports.ArrayStringValidator = ArrayStringValidator;
 class ArrayNameValidator {
-    constructor() { }
+    constructor() {
+        _ArrayNameValidator_instances.add(this);
+    }
     static create() {
-        return this.validator || (this.validator = new this());
+        return __classPrivateFieldGet(this, _g, "f", _ArrayNameValidator_validator) || (__classPrivateFieldSet(this, _g, new this(), "f", _ArrayNameValidator_validator));
     }
     validate(value) {
         if (value.length < constants_1.MIN_NUMBER_OF_NAME_PARTS) {
@@ -298,27 +270,25 @@ class ArrayNameValidator {
                 message: `expecting at least ${constants_1.MIN_NUMBER_OF_NAME_PARTS} elements`,
             });
         }
-        if (!this.hasBasicNames(value)) {
+        if (!__classPrivateFieldGet(this, _ArrayNameValidator_instances, "m", _ArrayNameValidator_hasBasicNames).call(this, value)) {
             throw new error_1.InputError({
                 source: value,
                 message: 'both first and last names are required',
             });
         }
     }
-    hasBasicNames(names) {
-        const accumulator = {};
-        for (const name of names) {
-            if (name.isFirstName || name.isLastName) {
-                accumulator[name.type.key] = name.toString();
-            }
-        }
-        return Object.keys(accumulator).length === constants_1.MIN_NUMBER_OF_NAME_PARTS;
-    }
 }
 exports.ArrayNameValidator = ArrayNameValidator;
-/**
- * A list of validators for a specific namon.
- */
+_g = ArrayNameValidator, _ArrayNameValidator_instances = new WeakSet(), _ArrayNameValidator_hasBasicNames = function _ArrayNameValidator_hasBasicNames(names) {
+    const accumulator = {};
+    for (const name of names) {
+        if (name.isFirstName || name.isLastName) {
+            accumulator[name.type.key] = name.toString();
+        }
+    }
+    return Object.keys(accumulator).length === constants_1.MIN_NUMBER_OF_NAME_PARTS;
+};
+_ArrayNameValidator_validator = { value: void 0 };
 class Validators {
 }
 exports.Validators = Validators;
@@ -329,4 +299,3 @@ Validators.firstName = FirstNameValidator.create();
 Validators.middleName = MiddleNameValidator.create();
 Validators.lastName = LastNameValidator.create();
 Validators.suffix = NamonValidator.create();
-//# sourceMappingURL=validator.js.map

package/dist/{lib/src → types}/config.d.ts

@@ -28,29 +28,19 @@ import { NameOrder, Separator, Title, Surname } from './types';
  * above.
  */
 export declare class Config {
-    private _name;
-    private _orderedBy;
-    private _separator;
-    private _title;
-    private _ending;
-    private _bypass;
-    private _surname;
-    /**
-     * The order of appearance of a full name.
-     */
+    #private;
+    /** 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.
-     */
+    /** 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.
-     */
+    /** 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
@@ -71,14 +61,8 @@ export declare class Config {
      * prioritized and viewed as the source of truth for future considerations.
      */
     get surname(): Surname;
-    /**
-     * The name of the cached configuration.
-     */
+    /** The name of the cached configuration. */
     get name(): string;
-    /**
-     * Cache for multiple instances.
-     */
-    private static cache;
     private constructor();
     /**
      * Returns a named configuration with default values.
@@ -101,21 +85,13 @@ export declare class Config {
      * be named `default_copy`.
      */
     copyWith(options?: Partial<Config>): Config;
-    /**
-     * Makes an exact copy of the current configuration.
-     */
+    /** Makes an exact copy of the current configuration. */
     clone(): Config;
-    /**
-     * Resets the configuration by setting it back to its default values.
-     */
+    /** 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/src → types}/constants.d.ts

@@ -1,4 +1,4 @@
-export declare const version = "1.2.0";
+export declare const VERSION = "1.2.1";
 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 → types}/error.d.ts

@@ -1,6 +1,6 @@
 import { Name } from './name';
 import { Nullable } from './types';
-declare type NameSource = Nullable<string | string[] | Name[]>;
+type NameSource = Nullable<string | string[] | Name[]>;
 interface ErrorMessage {
     source: NameSource;
     message?: string;
@@ -67,17 +67,11 @@ export declare class NameError extends Error {
      * @param type of `NameErrorType`
      */
     constructor(source: NameSource, message?: string, type?: NameErrorType);
-    /**
-     * The actual source input which caused the error.
-     */
+    /** The actual source input which caused the error. */
     get sourceAsString(): string;
-    /**
-     * Whether a message describing the failure exists.
-     */
+    /** Whether a message describing the failure exists. */
     get hasMessage(): boolean;
-    /**
-     * Returns a string representation of the error.
-     */
+    /** Returns a string representation of the error. */
     toString(): string;
 }
 /**
@@ -100,13 +94,9 @@ export declare class InputError extends NameError {
      */
     constructor(error: ErrorMessage);
 }
-/**
- * An error thrown to indicate that a name fails the validation rules.
- */
+/** 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.
-     */
+    /** Name of the invalid `nameType` if available. */
     readonly nameType: string;
     /**
      * Creates error containing the invalid `nameType` and a `message` that
@@ -128,9 +118,7 @@ export declare class ValidationError extends NameError {
  * a non-supported key.
  */
 export declare class NotAllowedError extends NameError {
-    /**
-     * The revoked operation name.
-     */
+    /** The revoked operation name. */
     readonly operation: string;
     /**
      * Creates a new `NotAllowedError` with an optional error `message` and the
@@ -156,9 +144,7 @@ export declare class NotAllowedError extends NameError {
  * programmer.
  */
 export declare class UnknownError extends NameError {
-    /**
-     * The possible unknown error, with trace revealing its source and reason.
-     */
+    /** The possible unknown error, with trace revealing its source and reason. */
     readonly origin?: Error;
     /**
      * Creates a new `UnknownError` with an optional error `message`.

package/dist/{lib → types}/full-name.d.ts

@@ -18,40 +18,23 @@ import { Nullable, Namon } from './types';
  * behaviors related to that name handling.
  */
 export declare class FullName {
-    private _prefix;
-    private _firstName;
-    private _middleName;
-    private _lastName;
-    private _suffix;
-    private _config;
+    #private;
     /**
      * Creates a full name as it goes
      * @param options optional configuration for additional features.
      */
     constructor(options?: Partial<Config>);
-    /**
-     * A snapshot of the configuration used to set up this full name.
-     */
+    /** A snapshot of the configuration used to set up this full name. */
     get config(): Config;
-    /**
-     * The prefix part of the full name.
-     */
+    /** The prefix part of the full name. */
     get prefix(): Nullable<Name>;
-    /**
-     * The first name part of the full name.
-     */
+    /** The first name part of the full name. */
     get firstName(): FirstName;
-    /**
-     * The last name part of the full name.
-     */
+    /** The last name part of the full name. */
     get lastName(): LastName;
-    /**
-     * The middle name part of the full name.
-     */
+    /** The middle name part of the full name. */
     get middleName(): Name[];
-    /**
-     * The suffix part of the full name.
-     */
+    /** The suffix part of the full name. */
     get suffix(): Nullable<Name>;
     /**
      * Parses a json name into a full name.

package/dist/{lib → types}/index.d.ts

@@ -11,6 +11,7 @@
  * @license MIT
  */
 export * from './config';
+export { VERSION as version } from './constants';
 export * from './error';
 export * from './full-name';
 export * from './name';

package/dist/{lib/src → types}/name.d.ts

@@ -3,8 +3,8 @@ import { CapsRange, Namon, Surname } from './types';
  * Representation of a string type name with some extra capabilities.
  */
 export declare class Name {
+    #private;
     readonly type: Namon;
-    private namon;
     protected initial: string;
     protected capsRange: CapsRange;
     /**
@@ -15,80 +15,47 @@ export declare class Name {
      */
     constructor(value: string, type: Namon, capsRange?: CapsRange);
     set value(newValue: string);
-    /**
-     * The piece of string treated as a name.
-     */
+    /** The piece of string treated as a name. */
     get value(): string;
-    /**
-     * The length of the name.
-     */
+    /** The length of the name. */
     get length(): number;
-    /**
-     * Whether the name is a prefix.
-     */
+    /** Whether the name is a prefix. */
     get isPrefix(): boolean;
-    /**
-     * Whether the name is a first name.
-     */
+    /** Whether the name is a first name. */
     get isFirstName(): boolean;
-    /**
-     * Whether the name is a middle name.
-     */
+    /** Whether the name is a middle name. */
     get isMiddleName(): boolean;
-    /**
-     * Whether the name is a last name.
-     */
+    /** Whether the name is a last name. */
     get isLastName(): boolean;
-    /**
-     * Whether the name is a suffix.
-     */
+    /** Whether the name is a suffix. */
     get isSuffix(): boolean;
-    /**
-     * Creates a prefix.
-     */
+    /** Creates a prefix. */
     static prefix(value: string): Name;
-    /**
-     * Creates a first name.
-     */
+    /** Creates a first name. */
     static first(value: string): Name;
-    /**
-     * Creates a middle name.
-     */
+    /** Creates a middle name. */
     static middle(value: string): Name;
-    /**
-     * Creates a last name.
-     */
+    /** Creates a last name. */
     static last(value: string): Name;
-    /**
-     * Creates a suffix.
-     */
+    /** Creates a suffix. */
     static suffix(value: string): Name;
-    /**
-     * Gets the initials (first character) of this name.
-     */
+    /** Gets the initials (first character) of this name. */
     initials(): string[];
-    /**
-     * String representation of this object.
-     */
+    /** String representation of this object. */
     toString(): string;
-    /**
-     * Returns true if the other is equal to this name.
-     */
+    /** Returns true if the other is equal to this name. */
     equal(other: Name | unknown): boolean;
-    /**
-     * Capitalizes the name.
-     */
+    /** Capitalizes the name. */
     caps(range?: CapsRange): Name;
-    /**
-     * De-capitalizes the name.
-     */
+    /** De-capitalizes the name. */
     decaps(range?: CapsRange): Name;
+    protected validate(name?: string): void;
 }
 /**
  * Representation of a first name with some extra functionality.
  */
 export declare class FirstName extends Name {
-    private _more;
+    #private;
     /**
      * Creates an extended version of `Name` and flags it as a first name `type`.
      *
@@ -97,26 +64,18 @@ export declare class FirstName extends Name {
      * `more` provides the freedom to do it as it pleases.
      */
     constructor(value: string, ...more: string[]);
-    /**
-     * Determines whether a first name has `more` name parts.
-     */
+    /** Determines whether a first name has `more` name parts. */
     get hasMore(): boolean;
     get length(): number;
-    /**
-     * Returns a combined version of the `value` and `more` if any.
-     */
+    /** Returns a combined version of the `value` and `more` if any. */
     get asNames(): Name[];
-    /**
-     * The additional name parts of the first name.
-     */
+    /** The additional name parts of the first name. */
     get more(): string[];
     toString(withMore?: boolean): string;
     initials(withMore?: boolean): string[];
     caps(range?: CapsRange): FirstName;
     decaps(range?: CapsRange): FirstName;
-    /**
-     * Makes a copy of the current name.
-     */
+    /** Makes a copy of the current name. */
     copyWith(values?: {
         first?: string;
         more?: string[];
@@ -126,8 +85,8 @@ export declare class FirstName extends Name {
  * Representation of a last name with some extra functionality.
  */
 export declare class LastName extends Name {
+    #private;
     readonly format: Surname;
-    private _mother?;
     /**
      * Creates an extended version of `Name` and flags it as a last name `type`.
      *
@@ -135,30 +94,20 @@ export declare class LastName extends Name {
      * from their `father`'s surname. However, there are no clear rules about it.
      */
     constructor(father: string, mother?: string, format?: Surname);
-    /**
-     * The surname inherited from a father side.
-     */
+    /** The surname inherited from a father side. */
     get father(): string;
-    /**
-     * The surname inherited from a mother side.
-     */
+    /** The surname inherited from a mother side. */
     get mother(): string | undefined;
-    /**
-     * Returns `true` if the mother's surname is defined.
-     */
+    /** Returns `true` if the mother's surname is defined. */
     get hasMother(): boolean;
     get length(): number;
-    /**
-     * Returns a combined version of the `father` and `mother` if any.
-     */
+    /** Returns a combined version of the `father` and `mother` if any. */
     get asNames(): Name[];
     toString(format?: Surname): string;
     initials(format?: Surname): string[];
     caps(range?: CapsRange): LastName;
     decaps(range?: CapsRange): LastName;
-    /**
-     * Makes a copy of the current name.
-     */
+    /** Makes a copy of the current name. */
     copyWith(values?: {
         father?: string;
         mother?: string;