namefully 1.0.9 → 1.2.0

package/dist/lib/src/models/enums.d.ts

@@ -1,91 +0,0 @@
-/**
- * All the enums are listed here
- *
- * Created on March 06, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-/**
- * Enum `Namon` contains the finite set of a representative piece of a name
- * @readonly
- * @enum {string}
- * The word `Namon` is the singular form used to refer to a chunk|part|piece of
- * a name. And the plural form is `Nama`. (Same idea as in criterion/criteria)
- */
-export declare enum Namon {
-    PREFIX = "prefix",
-    LAST_NAME = "lastname",
-    MIDDLE_NAME = "middlename",
-    FIRST_NAME = "firstname",
-    SUFFIX = "suffix"
-}
-/**
- * Enum for the prefix values
- * @readonly
- * @enum {string}
- * American and Canadian English follow slightly different rules for abbreviated
- * titles than British and Australian English. In North American English, titles
- * before a name require a period: `Mr., Mrs., Ms., Dr.` In British and Australian
- * English, no full stops are used in these abbreviations.
- */
-export declare enum Prefix {
-    FIRT_LIEUTENANT = "1st Lt",
-    ADMIRAL = "Adm",
-    ATTORNEY = "Atty",
-    BROTHER = "Brother",
-    CAPTAIN = "Capt",
-    CHIEF = "Chief",
-    COMMANDER = "Cmdr",
-    COLONEL = "Col",
-    UNI_DEAN = "Dean",
-    DOCTOR = "Dr",
-    ELDER = "Elder",
-    FATHER = "Father",
-    GENERAL = "Gen",
-    HONORABLE = "Hon",
-    LIEUTENANT_COLONEL = "Lt Col",
-    MAJOR = "Maj",
-    MASTER_SERGEANT = "MSgt",
-    MISTER = "Mr",
-    MARRIED_WOMAN = "Mrs",
-    SINGLE_WOMAN = "Ms",
-    PRINCE = "Prince",
-    PROFESSOR = "Prof",
-    RABBI = "Rabbi",
-    REVEREND = "Rev",
-    SISTER = "Sister"
-}
-/**
- * Enum for the suffix values
- * @readonly
- * @enum {string}
- */
-export declare enum Suffix {
-    THE_SECOND = "II",
-    THE_THIRD = "III",
-    THE_FOURTH = "IV",
-    CERT_PUB_ACCOUNTANT = "CPA",
-    DOCTOR_DENTAL_MED = "DDS",
-    ESQUIRE = "Esq",
-    JURIST_DOCTOR = "JD",
-    JUNIOR = "Jr",
-    DOCTOR_OF_LAWS = "LLD",
-    DOCTORATE = "PhD",
-    RETIRED_ARMED_FORCES = "Ret",
-    REGISTERED_NURSE = "RN",
-    SENIOR = "Sr",
-    DOCTOR_OF_OSTEO = "DO"
-}
-/**
- * Enum for the separator values representing some of the ASCII characters
- * @readonly
- * @enum {string}
- */
-export declare enum Separator {
-    COLON = ":",
-    COMMA = ",",
-    EMPTY = "",
-    HYPHEN = "-",
-    PERIOD = ".",
-    SPACE = " ",
-    UNDERSCORE = "_"
-}

package/dist/lib/src/models/firstname.d.ts

@@ -1,41 +0,0 @@
-/**
- * First name class definition
- *
- * Created on March 06, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-import { Name, Summary } from './index';
-/**
- * Represents a first name with some extra functionalities
- * @class
- * @extends Name
- */
-export declare class Firstname extends Name {
-    namon: string;
-    more?: string[];
-    /**
-     * Constructs a `Firstname`
-     * @param {string} namon a piece of string that will be defined as a namon
-     * @param {string[]} [more] additional pieces considered as a given name
-     */
-    constructor(namon: string, more?: string[]);
-    /**
-     * Gives some descriptive statistics that summarize the central tendency,
-     * dispersion and shape of the characters' distribution.
-     * @param {boolean} includeAll whether to include other pieces of the first
-     * name in the summary
-     * @see {@link describe} in `Namefully` class for further information
-     */
-    describe(includeAll?: boolean): Summary;
-    /**
-     * Returns a string representation of the first name
-     * @param {boolean} includeAll whether to include other pieces of the first
-     * name
-     */
-    tostring(includeAll?: boolean): string;
-    /**
-     * Gets the initials of the first name
-     * @returns {Array<string>} the initials
-     */
-    getInitials(includeAll?: boolean): string[];
-}

package/dist/lib/src/models/index.d.ts

@@ -1,12 +0,0 @@
-/**
- * Make all the locals available
- *
- * Created on March 06, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-export * from './name';
-export * from './firstname';
-export * from './lastname';
-export * from './enums';
-export * from './summary';
-export * from './misc';

package/dist/lib/src/models/lastname.d.ts

@@ -1,44 +0,0 @@
-/**
- * Last name class definition
- *
- * Created on March 06, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-import { Name, Summary, LastnameFormat } from './index';
-/**
- * Represents a last name with some extra functionalities
- * @class
- * @extends Name
- */
-export declare class Lastname extends Name {
-    father: string;
-    mother?: string;
-    private format;
-    /**
-     * Constructs a `Lastname`
-     * @param {string} father a piece of string that will be defined as a namon
-     * @param {string} [mother] additional pieces considered as a last name
-     * @param {LastnameFormat} [format] how to output a surname considering its
-     * subparts
-     */
-    constructor(father: string, mother?: string, format?: LastnameFormat);
-    /**
-     * Gives some descriptive statistics that summarize the central tendency,
-     * dispersion and shape of the characters' distribution.
-     * @param {LastnameFormat} [format] overrides the how-to format of a surname
-     * output, considering its subparts.
-     * @see {@link describe} in `Namefully` class for further information
-     */
-    describe(format?: LastnameFormat): Summary;
-    /**
-     * Returns a string representation of the last name
-     * @param {LastnameFormat} [format] overrides the how-to format of a surname
-     * output, considering its subparts.
-     */
-    tostring(format?: LastnameFormat): string;
-    /**
-     * Gets the initials of the last name
-     * @returns {Array<string>} the initials
-     */
-    getInitials(format?: LastnameFormat): string[];
-}

package/dist/lib/src/models/misc.d.ts

@@ -1,80 +0,0 @@
-/**
- * Miscellaneous contents
- *
- * Created on March 07, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-import { Parser } from '../core/index';
-import { Name, Firstname, Lastname, Prefix, Suffix, Separator } from './index';
-/**
- * Interface for JSON signature that represents the full name
- * @interface
- */
-export interface Fullname {
-    firstname: Firstname;
-    lastname: Lastname;
-    middlename?: Name[];
-    prefix?: Prefix;
-    suffix?: Suffix;
-}
-/**
- * Defines the two ways that a full name can be ordered: first or last name
- * @typedef NameOrder
- */
-export declare type NameOrder = 'firstname' | 'lastname';
-/**
- * Defines the distinct formats to output a surname
- * @typedef LastnameFormat
- */
-export declare type LastnameFormat = 'father' | 'mother' | 'hyphenated' | 'all';
-/**
- * Defines the ways the international community defines a title
- *
- * American and Canadian English follow slightly different rules for abbreviated
- * titles than British and Australian English. In North American English, titles
- * before a name require a period: `Mr., Mrs., Ms., Dr.` In British and Australian
- * English, no full stops are used in these abbreviations.
- * @typedef AbbrTitle
- */
-export declare type AbbrTitle = 'us' | 'uk';
-/**
- * Interface for JSON signature that represents the configuration of the utility
- * @interface
- */
-export interface Config {
-    orderedBy: NameOrder;
-    separator: Separator;
-    titling: AbbrTitle;
-    ending: Separator;
-    bypass: boolean;
-    parser?: Parser<any>;
-    lastnameFormat?: LastnameFormat;
-}
-/**
- * @interface Nama represents the JSON signature for the `NamaParser`
- */
-export interface Nama {
-    prefix?: string;
-    firstname: string;
-    middlename?: string;
-    lastname: string;
-    suffix?: string;
-}
-/**
- * @interface Indexing represents the JSON signature for indexing name parts
- */
-interface Indexing<T> {
-    prefix: T;
-    firstname: T;
-    middlename: T;
-    lastname: T;
-    suffix: T;
-}
-/**
- * @interface NameIndex represents the JSON signature for indexing name parts
- * using numbered index
- * @extends Index<number>
- */
-export interface NameIndex extends Indexing<number> {
-}
-export {};

package/dist/lib/src/models/name.d.ts

@@ -1,48 +0,0 @@
-/**
- * Name class definition
- *
- * Created on March 06, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-import { Summary, Namon } from './index';
-/**
- * Represents a namon with some extra functionalities
- * @class
- * @see {@link Namon} interface to understand the concept of namon/nama.
- */
-export declare class Name {
-    namon: string;
-    type: Namon;
-    private initial;
-    private body;
-    /**
-     * Constructs a `Name`
-     * @param namon a piece of string that will be defined as a namon
-     * @param type which namon that is
-     */
-    constructor(namon: string, type: Namon, capitalized?: 'initial' | 'all');
-    /**
-     * Gives some descriptive statistics that summarize the central tendency,
-     * dispersion and shape of the characters' distribution.
-     * @see {@link describe} in `Namefully` class for further information
-     */
-    describe(): Summary;
-    /**
-     * Gets the initials of the name
-     * @returns {Array<string>} the initials
-     */
-    getInitials(): string[];
-    /**
-     * Capitalizes a name
-     * @param {'initial' | 'all'} option how to capitalize it
-     */
-    protected capitalize(option?: 'initial' | 'all'): void;
-    /**
-     * Converts all the alphabetic characters in a string to lowercase
-     */
-    lower(): string;
-    /**
-     * Converts all the alphabetic characters in a string to uppercase
-     */
-    upper(): string;
-}

package/dist/lib/src/models/summary.d.ts

@@ -1,23 +0,0 @@
-/**
- * Represents the statistical summary of a string representation
- * @class
- */
-export declare class Summary {
-    private namon;
-    count: number;
-    frequency: number;
-    top: string;
-    unique: number;
-    /**
-     * Creates a `Summary` of a given string of alphabetical characters
-     * @param namon piece of name
-     * @param restrictions a set of undesired characters
-     */
-    constructor(namon: string, restrictions?: string[]);
-    /**
-     * Returns a string representation of the summary
-     */
-    tostring(): string;
-    private compute;
-    private groupByChar;
-}

package/dist/lib/src/validators/array-name.validator.d.ts

@@ -1,25 +0,0 @@
-/**
- * Array of `Name` validator
- *
- * Created on March 15, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-import { Name } from '../models/index';
-import { Validator, ValidatorType } from './index';
-/**
- * Represents a validator to help the array `Name` parser
- * @class
- * @classdesc
- * This validator validates a array of `Name` objects following a specific order
- * based on the count of elements. It is expected that the array has to be
- * between two and five elements.
- *
- */
-export default class ArrayNameValidator implements Validator<Name[]> {
-    readonly type: ValidatorType;
-    /**
-     * Validates the content of a set of custom `Name`s
-     * @param {Array<Name>} value data to validate
-     */
-    validate(values: Array<Name>): void;
-}

package/dist/lib/src/validators/array-string.validator.d.ts

@@ -1,43 +0,0 @@
-/**
- * Array of string validator
- *
- * Created on March 15, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-import { Validator, ValidatorType } from './index';
-import { NameIndex } from '../models/index';
-/**
- * Represents a validator to help the array string parser
- * @class
- * @classdesc
- * This validator validates an array of string name following a specific order
- * based on the count of elements. It is expected that the array has to be between
- * two and five elements. Also, the order of appearance set in the configuration
- * influences how this validation is carried out.
- *
- * Ordered by first name, the validator validates the following:
- * - 2 elements: firstname lastname
- * - 3 elements: firstname middlename lastname
- * - 4 elements: prefix firstname middlename lastname
- * - 5 elements: prefix firstname middlename lastname suffix
- *
- * Ordered by last name, the validator validates the following:
- * - 2 elements: lastname firstname
- * - 3 elements: lastname firstname middlename
- * - 4 elements: prefix lastname firstname middlename
- * - 5 elements: prefix lastname firstname middlename suffix
- */
-export default class ArrayStringValidator implements Validator<string[]> {
-    indexing: NameIndex;
-    readonly type: ValidatorType;
-    /**
-     * Creates an instance of the validator
-     * @param indexing how to index the name parts
-     */
-    constructor(indexing: NameIndex);
-    /**
-     * Validates the content of a name
-     * @param {string} value data to validate
-     */
-    validate(values: string[]): void;
-}

package/dist/lib/src/validators/common/validation-error.d.ts

@@ -1,19 +0,0 @@
-/**
- * Validation error
- *
- * Created on March 06, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-/**
- * Represents a validation error
- * @class
- * @extends Error
- */
-export declare class ValidationError extends Error {
-    /**
-     * Create a validation `Error`
-     * @param message of error to display
-     * @param type categorizes the error
-     */
-    constructor(message?: string, type?: string);
-}

package/dist/lib/src/validators/common/validation-rule.d.ts

@@ -1,69 +0,0 @@
-/**
- * Validation rules
- *
- * Created on March 06, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-/**
- * Represents a set of validation rules (regex)
- * @class
- * @static
- *
- * 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)
- *  [\u04FFΆ-ωΑ-ώ]: Greek alphabet from Ά (index 902) to ω (index 969)
- */
-export declare class ValidationRule {
-    /**
-     * Matches one name part (namon) that is of nature:
-     * - Latin (English, Spanish, French, etc.)
-     * - European (Greek, Cyrillic, Icelandic, German)
-     * - hyphenated
-     * - with apostrophe
-     */
-    static namon: RegExp;
-    /**
-     * Matches 1+ name parts (namon) that are of nature:
-     * - Latin (English, Spanish, French, etc.)
-     * - European (Greek, Cyrillic, Icelandic, German)
-     * - hyphenated
-     * - with apostrophe
-     * - with comma
-     * - with period
-     * - with space
-     */
-    static fullname: RegExp;
-    /**
-     * Matches one name part (namon) that is of nature:
-     * - Latin (English, Spanish, French, etc.)
-     * - European (Greek, Cyrillic, Icelandic, German)
-     * - hyphenated
-     * - with apostrophe
-     */
-    static firstname: RegExp;
-    /**
-     * Matches 1+ names part (namon) that are of nature:
-     * - Latin (English, Spanish, French, etc.)
-     * - European (Greek, Cyrillic, Icelandic, German)
-     * - hyphenated
-     * - with apostrophe
-     * - with space
-     */
-    static middlename: RegExp;
-    /**
-     * Matches one name part (namon) that is of nature:
-     * - Latin (English, Spanish, French, etc.)
-     * - European (Greek, Cyrillic, Icelandic, German)
-     * - hyphenated
-     * - with apostrophe
-     */
-    static lastname: RegExp;
-}

package/dist/lib/src/validators/common/validation-type.d.ts

@@ -1,24 +0,0 @@
-/**
- * Validation types
- *
- * Created on March 06, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-/**
- * Enum for the validation types
- * @enum
- */
-export declare enum ValidatorType {
-    NONE = 0,
-    NAMON = 1,
-    NAMA = 2,
-    ARR_NAMES = 3,
-    ARR_STRING = 4,
-    FULL_NAME = 5,
-    PREFIX = 6,
-    FIRST_NAME = 7,
-    MIDDLE_NAME = 8,
-    LAST_NAME = 9,
-    SUFFIX = 10,
-    CUSTOM = 11
-}

package/dist/lib/src/validators/firstname.validator.d.ts

@@ -1,20 +0,0 @@
-/**
- * First name validator
- *
- * Created on March 15, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-import { Validator, ValidatorType } from './index';
-/**
- * Represents a first name validator
- * @class
- * @implements {Validator}
- */
-export default class FirstnameValidator implements Validator<string> {
-    readonly type: ValidatorType;
-    /**
-     * Validates the content of a first name
-     * @param {string} value data to validate
-     */
-    validate(value: string): void;
-}

package/dist/lib/src/validators/fullname.validator.d.ts

@@ -1,21 +0,0 @@
-/**
- * `Fullname` validator
- *
- * Created on March 15, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-import { Fullname } from '../models/index';
-import { Validator, ValidatorType } from './index';
-/**
- * Represents a `Fullname` (JSON signature) validator for provided custom parser
- * @class
- * @implements {Validator}
- */
-export default class FullnameValidator implements Validator<Fullname> {
-    readonly type: ValidatorType;
-    /**
-     * Validates that the `Fullname` contract is met
-     * @param {Fullname} value data to validate
-     */
-    validate(v: Fullname): void;
-}

package/dist/lib/src/validators/index.d.ts

@@ -1,21 +0,0 @@
-/**
- * Make all the locals available
- *
- * Created on March 06, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-export * from './common/validation-rule';
-export * from './common/validation-type';
-export * from './common/validation-error';
-export * from './validator';
-export { default as NamonValidator } from './namon.validator';
-export { default as PrefixValidator } from './prefix.validator';
-export { default as SuffixValidator } from './suffix.validator';
-export { default as FirstnameValidator } from './firstname.validator';
-export { default as LastnameValidator } from './lastname.validator';
-export { default as MiddlenameValidator } from './middlename.validator';
-export { default as FullnameValidator } from './fullname.validator';
-export { default as NamaValidator } from './nama.validator';
-export { default as ArrayNameValidator } from './array-name.validator';
-export { default as ArrayStringValidator } from './array-string.validator';
-export { default as StringNameValidator } from './string-name.validator';

package/dist/lib/src/validators/lastname.validator.d.ts

@@ -1,20 +0,0 @@
-/**
- * Last name validator
- *
- * Created on March 15, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-import { Validator, ValidatorType } from './index';
-/**
- * Represents a last name validator
- * @class
- * @implements {Validator}
- */
-export default class LastnameValidator implements Validator<string> {
-    readonly type: ValidatorType;
-    /**
-     * Validates the content of a last name
-     * @param {string} value data to validate
-     */
-    validate(value: string): void;
-}

package/dist/lib/src/validators/middlename.validator.d.ts

@@ -1,20 +0,0 @@
-/**
- * Middle name validator
- *
- * Created on March 15, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-import { Validator, ValidatorType } from './index';
-/**
- * Represents a middle name validator
- * @class
- * @implements {Validator}
- */
-export default class MiddlenameValidator implements Validator<string | string[]> {
-    readonly type: ValidatorType;
-    /**
-     * Validates the content of a list of middle names
-     * @param {string | Array<string>} values to validate
-     */
-    validate(values: string | string[]): void;
-}

package/dist/lib/src/validators/nama.validator.d.ts

@@ -1,21 +0,0 @@
-/**
- * Nama validator
- *
- * Created on March 15, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-import { Nama } from '../models/index';
-import { Validator, ValidatorType } from './index';
-/**
- * Represents a `Nama` validator to help the nama parser
- * @class
- * @implements {Validator}
- */
-export default class NamaValidator implements Validator<Nama> {
-    readonly type: ValidatorType;
-    /**
-     * Validates the content of a JSON-formatted names
-     * @param {string} value data to validate
-     */
-    validate(value: Nama): void;
-}

package/dist/lib/src/validators/namon.validator.d.ts

@@ -1,20 +0,0 @@
-/**
- * Namon validator
- *
- * Created on March 15, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-import { Validator, ValidatorType } from './index';
-/**
- * Represents a namon validator to help to parse single pieces of string
- * @class
- * @implements {Validator}
- */
-export default class NamonValidator implements Validator<string> {
-    readonly type: ValidatorType;
-    /**
-     * Validates the content of a name
-     * @param {string} value data to validate
-     */
-    validate(value: string): void;
-}