namefully 1.1.0 → 1.2.1

package/dist/lib/core/parsers/string.parser.d.ts

@@ -1,60 +0,0 @@
-/**
- * A string parser
- *
- * Created on March 15, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-import { Separator, Fullname, NameOrder } from '../../models/index';
-import { Parser } from './index';
-/**
- * Represents a string parser
- * @class
- * @implements {Parser}
- * @classdesc
- * This parser parses a string name using a separator, if set, or simply using
- * the space character <' '> as a basis for the split.
- *
- * **NOTE**:
- * A string name is basically a string type containing the name parts differentiated
- * with the help of a separator. The default separator is the character <space>
- * or <' '>. However, it can be very, very helpful to use a distinct separator
- * (e.g., a colon <:>) to handle multiple names for a `Namon`. That is to say,
- * a piece of name shaped as `De La Cruz` is a last name that needs to be handled
- * as a whole, and therefore requires that a different type of separator to split
- * up the name parts. Alternatively, the `ArrayStringParser` can be used by indicating
- * specifically which part of the name is what. Do note that this parser is actually
- * a wrapper of the `ArrayStringParser`.
- *
- * @example
- * Given the name `Maria De La Cruz`, using this parser without indicating a
- * separator different than <space> will definitely throw an error. So, if the proper
- * proper of doing when `De La Cruz` is the last name:
- * ```
- *  > const name = new Namefully('Maria:De La Cruz', { separator: Separator.COLON })
- *  > console.log(name.getLastname())
- *  De La Cruz
- * ```
- * Or
- * ```
- *  > const name = new Namefully(['Maria', 'De La Cruz'])
- *  > console.log(name.getLastname())
- *  De La Cruz
- * ```
- */
-export default class StringParser implements Parser<string> {
-    raw: string;
-    /**
-     * Create a parser ready to parse the raw data
-     * @param {string} raw data as a string representation
-     */
-    constructor(raw: string);
-    /**
-     * Parses the raw data into a full name
-     * @param options how to parse
-     */
-    parse(options: {
-        orderedBy: NameOrder;
-        separator: Separator;
-        bypass: boolean;
-    }): Fullname;
-}

package/dist/lib/core/parsers/string.parser.js

@@ -1,62 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const index_1 = require("./index");
-/**
- * Represents a string parser
- * @class
- * @implements {Parser}
- * @classdesc
- * This parser parses a string name using a separator, if set, or simply using
- * the space character <' '> as a basis for the split.
- *
- * **NOTE**:
- * A string name is basically a string type containing the name parts differentiated
- * with the help of a separator. The default separator is the character <space>
- * or <' '>. However, it can be very, very helpful to use a distinct separator
- * (e.g., a colon <:>) to handle multiple names for a `Namon`. That is to say,
- * a piece of name shaped as `De La Cruz` is a last name that needs to be handled
- * as a whole, and therefore requires that a different type of separator to split
- * up the name parts. Alternatively, the `ArrayStringParser` can be used by indicating
- * specifically which part of the name is what. Do note that this parser is actually
- * a wrapper of the `ArrayStringParser`.
- *
- * @example
- * Given the name `Maria De La Cruz`, using this parser without indicating a
- * separator different than <space> will definitely throw an error. So, if the proper
- * proper of doing when `De La Cruz` is the last name:
- * ```
- *  > const name = new Namefully('Maria:De La Cruz', { separator: Separator.COLON })
- *  > console.log(name.getLastname())
- *  De La Cruz
- * ```
- * Or
- * ```
- *  > const name = new Namefully(['Maria', 'De La Cruz'])
- *  > console.log(name.getLastname())
- *  De La Cruz
- * ```
- */
-class StringParser {
-    /**
-     * Create a parser ready to parse the raw data
-     * @param {string} raw data as a string representation
-     */
-    constructor(raw) {
-        this.raw = raw;
-    }
-    /**
-     * Parses the raw data into a full name
-     * @param options how to parse
-     */
-    parse(options) {
-        // given this setting
-        const { orderedBy, separator, bypass } = options;
-        // then distribute all the elements accordingly
-        const nama = this.raw.split(separator);
-        const fullname = new index_1.ArrayStringParser(nama).parse({ orderedBy, bypass });
-        // finally return high quality of data
-        return fullname;
-    }
-}
-exports.default = StringParser;
-//# sourceMappingURL=string.parser.js.map

package/dist/lib/core/parsers/string.parser.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"string.parser.js","sourceRoot":"","sources":["../../../../src/core/parsers/string.parser.ts"],"names":[],"mappings":";;AAOA,mCAAoD;AAGpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAqB,YAAY;IAE7B;;;OAGG;IACH,YAAmB,GAAW;QAAX,QAAG,GAAH,GAAG,CAAQ;IAAG,CAAC;IAElC;;;OAGG;IACH,KAAK,CAAC,OAIL;QAEG,qBAAqB;QACrB,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;QAEjD,+CAA+C;QAC/C,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACvC,MAAM,QAAQ,GAAG,IAAI,yBAAiB,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC;QAE1E,sCAAsC;QACtC,OAAO,QAAQ,CAAC;IACpB,CAAC;CACJ;AA5BD,+BA4BC"}

package/dist/lib/core/utils.d.ts

@@ -1,52 +0,0 @@
-/**
- * Utils for the core functionalities of `Namefully`
- *
- * Created on March 16, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-import { NameIndex, NameOrder, NameType } from '../models';
-/**
- * Capitalizes a string
- * @param str string value
- * @param {'initial' | 'all'} [option] how to capitalize it
- */
-export declare function capitalize(str: string, option?: 'initial' | 'all'): string;
-/**
- * De-capitalizes a string
- * @param str string value
- * @param {'initial' | 'all'} [option] how to decapitalize it
- */
-export declare function decapitalize(str: string, option?: 'initial' | 'all'): string;
-/**
- * Toggles a string representation
- * @param str string value to toggle
- */
-export declare function toggleCase(str: string): string;
-/**
- * Reorganizes the existing global indexes for array of name parts
- * @param orderedBy by first or last name
- * @param argLength length of the provided array
- * @param nameIndex global preset of indexing
- */
-export declare function organizeNameIndex(orderedBy: NameOrder, argLength: number, nameIndex?: NameIndex): NameIndex;
-/**
- * Makes it easy to manipulate shortcuts for this `NameType`
- * @param type name type
- */
-export declare function allowShortNameType(type: NameType): NameType;
-/**
- * Makes it easy to manipulate shortcuts for this `NameOrder`
- * @param type name type
- */
-export declare function allowShortNameOrder(type: NameOrder): NameOrder;
-/**
- * Converts to ascii characters (using UTF-16)
- * @param str string content
- * @param restrictions unneeded content to skip
- */
-export declare function convertToAscii(str: string, restrictions?: string[]): number[];
-/**
- * Generates a password
- * @param str string content
- */
-export declare function generatePassword(str: string): string;

package/dist/lib/core/utils.js

@@ -1,178 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Utils for the core functionalities of `Namefully`
- *
- * Created on March 16, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-const models_1 = require("../models");
-const core_1 = require("../core");
-/**
- * Capitalizes a string
- * @param str string value
- * @param {'initial' | 'all'} [option] how to capitalize it
- */
-function capitalize(str, option = 'initial') {
-    if (!str)
-        return '';
-    const initial = str[0].toUpperCase();
-    const rest = str.slice(1).toLowerCase();
-    return option === 'initial' ? initial.concat(rest) : str.toUpperCase();
-}
-exports.capitalize = capitalize;
-/**
- * De-capitalizes a string
- * @param str string value
- * @param {'initial' | 'all'} [option] how to decapitalize it
- */
-function decapitalize(str, option = 'initial') {
-    if (!str)
-        return '';
-    const initial = str[0].toLowerCase();
-    const rest = str.slice(1);
-    return option === 'initial' ? initial.concat(rest) : str.toLowerCase();
-}
-exports.decapitalize = decapitalize;
-/**
- * Toggles a string representation
- * @param str string value to toggle
- */
-function toggleCase(str) {
-    const chars = [];
-    for (const c of str) {
-        if (c === c.toUpperCase()) {
-            chars.push(c.toLowerCase());
-        }
-        else {
-            chars.push(c.toUpperCase());
-        }
-    }
-    return chars.join(models_1.Separator.EMPTY);
-}
-exports.toggleCase = toggleCase;
-/**
- * Reorganizes the existing global indexes for array of name parts
- * @param orderedBy by first or last name
- * @param argLength length of the provided array
- * @param nameIndex global preset of indexing
- */
-function organizeNameIndex(orderedBy, argLength, nameIndex = core_1.NAME_INDEX) {
-    const out = Object.assign({}, nameIndex);
-    if (orderedBy === 'firstname') {
-        switch (argLength) {
-            case core_1.FIRST_LAST_NAME_INDEX: // first name + last name
-                out.firstname = 0;
-                out.lastname = 1;
-                break;
-            case core_1.FIRST_MIDDLE_LAST_NAME_INDEX: // first name + middle name + last name
-                out.firstname = 0;
-                out.middlename = 1;
-                out.lastname = 2;
-                break;
-            case core_1.PREFIX_FIRST_MIDDLE_LAST_NAME_INDEX: // prefix + first name + middle name + last name
-                out.prefix = 0;
-                out.firstname = 1;
-                out.middlename = 2;
-                out.lastname = 3;
-                break;
-            case core_1.PREFIX_FIRST_MIDDLE_LAST_SUFFIX_NAME_INDEX: // prefix + first name + middle name + last name + suffix
-                out.prefix = 0;
-                out.firstname = 1;
-                out.middlename = 2;
-                out.lastname = 3;
-                out.suffix = 4;
-                break;
-        }
-    }
-    else {
-        switch (argLength) {
-            case core_1.LAST_FIRST_NAME_INDEX: // last name + first name
-                out.lastname = 0;
-                out.firstname = 1;
-                break;
-            case core_1.LAST_FIRST_MIDDLE_NAME_INDEX: // last name + first name + middle name
-                out.lastname = 0;
-                out.firstname = 1;
-                out.middlename = 2;
-                break;
-            case core_1.PREFIX_LAST_FIRST_MIDDLE_NAME_INDEX: // prefix + last name + first name + middle name
-                out.prefix = 0;
-                out.lastname = 1;
-                out.firstname = 2;
-                out.middlename = 3;
-                break;
-            case core_1.PREFIX_LAST_FIRST_MIDDLE_SUFFIX_NAME_INDEX: // prefix + last name + first name + middle name + suffix
-                out.prefix = 0;
-                out.lastname = 1;
-                out.firstname = 2;
-                out.middlename = 3;
-                out.suffix = 4;
-                break;
-        }
-    }
-    return out;
-}
-exports.organizeNameIndex = organizeNameIndex;
-/**
- * Makes it easy to manipulate shortcuts for this `NameType`
- * @param type name type
- */
-function allowShortNameType(type) {
-    switch (type) {
-        case 'firstname':
-        case 'fn': return 'firstname';
-        case 'lastname':
-        case 'ln': return 'lastname';
-        case 'middlename':
-        case 'mn': return 'middlename';
-        default:
-            return type;
-    }
-}
-exports.allowShortNameType = allowShortNameType;
-/**
- * Makes it easy to manipulate shortcuts for this `NameOrder`
- * @param type name type
- */
-function allowShortNameOrder(type) {
-    switch (type) {
-        case 'firstname':
-        case 'fn': return 'firstname';
-        case 'lastname':
-        case 'ln': return 'lastname';
-        default:
-            return type;
-    }
-}
-exports.allowShortNameOrder = allowShortNameOrder;
-/**
- * Converts to ascii characters (using UTF-16)
- * @param str string content
- * @param restrictions unneeded content to skip
- */
-function convertToAscii(str, restrictions = [...core_1.RESTRICTED_CHARS]) {
-    return str
-        .split(models_1.Separator.EMPTY)
-        .filter(c => restrictions.indexOf(c) === -1)
-        .map(c => c.charCodeAt(0));
-}
-exports.convertToAscii = convertToAscii;
-/**
- * Generates a password
- * @param str string content
- */
-function generatePassword(str) {
-    const mapper = core_1.PASSWORD_MAPPER;
-    const password = str
-        .split(models_1.Separator.EMPTY)
-        .map(char => {
-        if (mapper.has(char.toLowerCase()))
-            return mapper.get(char.toLowerCase()).random();
-        return mapper.get('$').random();
-    })
-        .join(models_1.Separator.EMPTY);
-    return password;
-}
-exports.generatePassword = generatePassword;
-//# sourceMappingURL=utils.js.map

package/dist/lib/core/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/core/utils.ts"],"names":[],"mappings":";;AAAA;;;;;GAKG;AACH,sCAAsE;AACtE,kCAYiB;AAEjB;;;;GAIG;AACH,SAAgB,UAAU,CAAC,GAAW,EAAE,SAA4B,SAAS;IACzE,IAAI,CAAC,GAAG;QAAE,OAAO,EAAE,CAAC;IACpB,MAAM,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;IACrC,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;IACxC,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;AAC3E,CAAC;AALD,gCAKC;AAED;;;;GAIG;AACH,SAAgB,YAAY,CAAC,GAAW,EAAE,SAA4B,SAAS;IAC3E,IAAI,CAAC,GAAG;QAAE,OAAO,EAAE,CAAC;IACpB,MAAM,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;IACrC,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC1B,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;AAC3E,CAAC;AALD,oCAKC;AAED;;;GAGG;AACH,SAAgB,UAAU,CAAC,GAAW;IAClC,MAAM,KAAK,GAAG,EAAE,CAAC;IACjB,KAAK,MAAM,CAAC,IAAI,GAAG,EAAE;QACjB,IAAI,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,EAAE;YACvB,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAA;SAC9B;aAAM;YACH,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAA;SAC9B;KACJ;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,kBAAS,CAAC,KAAK,CAAC,CAAC;AACvC,CAAC;AAVD,gCAUC;AAED;;;;;GAKG;AACH,SAAgB,iBAAiB,CAC7B,SAAoB,EACpB,SAAiB,EACjB,YAAuB,iBAAU;IAEjC,MAAM,GAAG,qBAAmB,SAAS,CAAE,CAAC;IAExC,IAAI,SAAS,KAAK,WAAW,EAAE;QAC3B,QAAO,SAAS,EAAE;YACd,KAAK,4BAAqB,EAAE,yBAAyB;gBACjD,GAAG,CAAC,SAAS,GAAG,CAAC,CAAC;gBAClB,GAAG,CAAC,QAAQ,GAAG,CAAC,CAAC;gBACjB,MAAM;YACV,KAAK,mCAA4B,EAAE,uCAAuC;gBACtE,GAAG,CAAC,SAAS,GAAG,CAAC,CAAC;gBAClB,GAAG,CAAC,UAAU,GAAG,CAAC,CAAC;gBACnB,GAAG,CAAC,QAAQ,GAAG,CAAC,CAAC;gBACjB,MAAM;YACV,KAAK,0CAAmC,EAAE,gDAAgD;gBACtF,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;gBACf,GAAG,CAAC,SAAS,GAAG,CAAC,CAAC;gBAClB,GAAG,CAAC,UAAU,GAAG,CAAC,CAAC;gBACnB,GAAG,CAAC,QAAQ,GAAG,CAAC,CAAC;gBACjB,MAAM;YACV,KAAK,iDAA0C,EAAE,yDAAyD;gBACtG,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;gBACf,GAAG,CAAC,SAAS,GAAG,CAAC,CAAC;gBAClB,GAAG,CAAC,UAAU,GAAG,CAAC,CAAC;gBACnB,GAAG,CAAC,QAAQ,GAAG,CAAC,CAAC;gBACjB,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;gBACf,MAAM;SACb;KACJ;SACI;QACD,QAAO,SAAS,EAAE;YACd,KAAK,4BAAqB,EAAE,yBAAyB;gBACjD,GAAG,CAAC,QAAQ,GAAG,CAAC,CAAC;gBACjB,GAAG,CAAC,SAAS,GAAG,CAAC,CAAC;gBAClB,MAAM;YACV,KAAK,mCAA4B,EAAE,uCAAuC;gBACtE,GAAG,CAAC,QAAQ,GAAG,CAAC,CAAC;gBACjB,GAAG,CAAC,SAAS,GAAG,CAAC,CAAC;gBAClB,GAAG,CAAC,UAAU,GAAG,CAAC,CAAC;gBACnB,MAAM;YACV,KAAK,0CAAmC,EAAE,gDAAgD;gBACtF,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;gBACf,GAAG,CAAC,QAAQ,GAAG,CAAC,CAAC;gBACjB,GAAG,CAAC,SAAS,GAAG,CAAC,CAAC;gBAClB,GAAG,CAAC,UAAU,GAAG,CAAC,CAAC;gBACnB,MAAM;YACV,KAAK,iDAA0C,EAAE,yDAAyD;gBACtG,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;gBACf,GAAG,CAAC,QAAQ,GAAG,CAAC,CAAC;gBACjB,GAAG,CAAC,SAAS,GAAG,CAAC,CAAC;gBAClB,GAAG,CAAC,UAAU,GAAG,CAAC,CAAC;gBACnB,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;gBACf,MAAM;SACb;KACJ;IACD,OAAO,GAAG,CAAC;AACf,CAAC;AA5DD,8CA4DC;AAED;;;GAGG;AACH,SAAgB,kBAAkB,CAAC,IAAc;IAC7C,QAAO,IAAI,EAAE;QACT,KAAK,WAAW,CAAC;QAAC,KAAK,IAAI,CAAC,CAAC,OAAO,WAAW,CAAC;QAChD,KAAK,UAAU,CAAC;QAAC,KAAK,IAAI,CAAC,CAAC,OAAO,UAAU,CAAC;QAC9C,KAAK,YAAY,CAAC;QAAC,KAAK,IAAI,CAAC,CAAC,OAAO,YAAY,CAAC;QAClD;YACI,OAAO,IAAI,CAAC;KACnB;AACL,CAAC;AARD,gDAQC;AAED;;;GAGG;AACH,SAAgB,mBAAmB,CAAC,IAAe;IAC/C,QAAO,IAAI,EAAE;QACT,KAAK,WAAW,CAAC;QAAC,KAAK,IAAI,CAAC,CAAC,OAAO,WAAW,CAAC;QAChD,KAAK,UAAU,CAAC;QAAC,KAAK,IAAI,CAAC,CAAC,OAAO,UAAU,CAAC;QAC9C;YACI,OAAO,IAAI,CAAC;KACnB;AACL,CAAC;AAPD,kDAOC;AAED;;;;GAIG;AACH,SAAgB,cAAc,CAC1B,GAAW,EACX,eAAyB,CAAC,GAAG,uBAAgB,CAAC;IAE9C,OAAO,GAAG;SACL,KAAK,CAAC,kBAAS,CAAC,KAAK,CAAC;SACtB,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;SAC3C,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AACnC,CAAC;AARD,wCAQC;AAED;;;GAGG;AACH,SAAgB,gBAAgB,CAAC,GAAW;IACxC,MAAM,MAAM,GAAG,sBAAe,CAAC;IAE/B,MAAM,QAAQ,GAAG,GAAG;SACf,KAAK,CAAC,kBAAS,CAAC,KAAK,CAAC;SACtB,GAAG,CAAC,IAAI,CAAC,EAAE;QACR,IAAI,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YAC9B,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;QACnD,OAAO,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;IACpC,CAAC,CAAC;SACD,IAAI,CAAC,kBAAS,CAAC,KAAK,CAAC,CAAC;IAC3B,OAAO,QAAQ,CAAC;AACpB,CAAC;AAZD,4CAYC"}

package/dist/lib/index.d.ts

@@ -1,10 +0,0 @@
-/**
- * Main entry to `Namefully`
- *
- * Created on March 03, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-export * from './namefully';
-export * from './core';
-export * from './models';
-export * from './validators';

package/dist/lib/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,sDAA4B;AAC5B,iDAAuB;AACvB,mDAAyB;AACzB,uDAA6B"}

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

@@ -1,106 +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 `Alphabet` for the list of writing systems
- * @readonly
- * @enum {string}
- */
-export declare enum Alphabet {
-    LATIN = "Latin",
-    CYRILLIC = "Cyrillic",
-    GREEK = "Greek",
-    ARMENIAN = "Armenian",
-    GEORGIAN = "Georgian",
-    HANGUL = "Hangul"
-}
-/**
- * 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 = " ",
-    SINGLE_QUOTE = "'",
-    DOUBLE_QUOTE = "\"",
-    UNDERSCORE = "_"
-}

package/dist/lib/models/enums.js

@@ -1,114 +0,0 @@
-"use strict";
-/**
- * All the enums are listed here
- *
- * Created on March 06, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * 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)
- */
-var Namon;
-(function (Namon) {
-    Namon["PREFIX"] = "prefix";
-    Namon["LAST_NAME"] = "lastname";
-    Namon["MIDDLE_NAME"] = "middlename";
-    Namon["FIRST_NAME"] = "firstname";
-    Namon["SUFFIX"] = "suffix";
-})(Namon = exports.Namon || (exports.Namon = {}));
-/**
- * Enum `Alphabet` for the list of writing systems
- * @readonly
- * @enum {string}
- */
-var Alphabet;
-(function (Alphabet) {
-    Alphabet["LATIN"] = "Latin";
-    Alphabet["CYRILLIC"] = "Cyrillic";
-    Alphabet["GREEK"] = "Greek";
-    Alphabet["ARMENIAN"] = "Armenian";
-    Alphabet["GEORGIAN"] = "Georgian";
-    Alphabet["HANGUL"] = "Hangul";
-})(Alphabet = exports.Alphabet || (exports.Alphabet = {}));
-/**
- * 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.
- */
-var Prefix;
-(function (Prefix) {
-    Prefix["FIRT_LIEUTENANT"] = "1st Lt";
-    Prefix["ADMIRAL"] = "Adm";
-    Prefix["ATTORNEY"] = "Atty";
-    Prefix["BROTHER"] = "Brother";
-    Prefix["CAPTAIN"] = "Capt";
-    Prefix["CHIEF"] = "Chief";
-    Prefix["COMMANDER"] = "Cmdr";
-    Prefix["COLONEL"] = "Col";
-    Prefix["UNI_DEAN"] = "Dean";
-    Prefix["DOCTOR"] = "Dr";
-    Prefix["ELDER"] = "Elder";
-    Prefix["FATHER"] = "Father";
-    Prefix["GENERAL"] = "Gen";
-    Prefix["HONORABLE"] = "Hon";
-    Prefix["LIEUTENANT_COLONEL"] = "Lt Col";
-    Prefix["MAJOR"] = "Maj";
-    Prefix["MASTER_SERGEANT"] = "MSgt";
-    Prefix["MISTER"] = "Mr";
-    Prefix["MARRIED_WOMAN"] = "Mrs";
-    Prefix["SINGLE_WOMAN"] = "Ms";
-    Prefix["PRINCE"] = "Prince";
-    Prefix["PROFESSOR"] = "Prof";
-    Prefix["RABBI"] = "Rabbi";
-    Prefix["REVEREND"] = "Rev";
-    Prefix["SISTER"] = "Sister";
-})(Prefix = exports.Prefix || (exports.Prefix = {}));
-/**
- * Enum for the suffix values
- * @readonly
- * @enum {string}
- */
-var Suffix;
-(function (Suffix) {
-    Suffix["THE_SECOND"] = "II";
-    Suffix["THE_THIRD"] = "III";
-    Suffix["THE_FOURTH"] = "IV";
-    Suffix["CERT_PUB_ACCOUNTANT"] = "CPA";
-    Suffix["DOCTOR_DENTAL_MED"] = "DDS";
-    Suffix["ESQUIRE"] = "Esq";
-    Suffix["JURIST_DOCTOR"] = "JD";
-    Suffix["JUNIOR"] = "Jr";
-    Suffix["DOCTOR_OF_LAWS"] = "LLD";
-    Suffix["DOCTORATE"] = "PhD";
-    Suffix["RETIRED_ARMED_FORCES"] = "Ret";
-    Suffix["REGISTERED_NURSE"] = "RN";
-    Suffix["SENIOR"] = "Sr";
-    Suffix["DOCTOR_OF_OSTEO"] = "DO";
-})(Suffix = exports.Suffix || (exports.Suffix = {}));
-/**
- * Enum for the separator values representing some of the ASCII characters
- * @readonly
- * @enum {string}
- */
-var Separator;
-(function (Separator) {
-    Separator["COLON"] = ":";
-    Separator["COMMA"] = ",";
-    Separator["EMPTY"] = "";
-    Separator["HYPHEN"] = "-";
-    Separator["PERIOD"] = ".";
-    Separator["SPACE"] = " ";
-    Separator["SINGLE_QUOTE"] = "'";
-    Separator["DOUBLE_QUOTE"] = "\"";
-    Separator["UNDERSCORE"] = "_";
-})(Separator = exports.Separator || (exports.Separator = {}));
-//# sourceMappingURL=enums.js.map

package/dist/lib/models/enums.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../../src/models/enums.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAEH;;;;;;GAMG;AACH,IAAY,KAMX;AAND,WAAY,KAAK;IACb,0BAAiB,CAAA;IACjB,+BAAsB,CAAA;IACtB,mCAA0B,CAAA;IAC1B,iCAAwB,CAAA;IACxB,0BAAiB,CAAA;AACrB,CAAC,EANW,KAAK,GAAL,aAAK,KAAL,aAAK,QAMhB;AAED;;;;GAIG;AACH,IAAY,QAOX;AAPD,WAAY,QAAQ;IAChB,2BAAe,CAAA;IACf,iCAAqB,CAAA;IACrB,2BAAe,CAAA;IAClB,iCAAqB,CAAA;IACrB,iCAAqB,CAAA;IACrB,6BAAiB,CAAA;AAClB,CAAC,EAPW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAOnB;AAED;;;;;;;;GAQG;AACH,IAAY,MA0BX;AA1BD,WAAY,MAAM;IACd,oCAA0B,CAAA;IAC1B,yBAAe,CAAA;IACf,2BAAiB,CAAA;IACjB,6BAAmB,CAAA;IACnB,0BAAgB,CAAA;IAChB,yBAAe,CAAA;IACf,4BAAkB,CAAA;IAClB,yBAAe,CAAA;IACf,2BAAiB,CAAA;IACjB,uBAAa,CAAA;IACb,yBAAe,CAAA;IACf,2BAAiB,CAAA;IACjB,yBAAe,CAAA;IACf,2BAAiB,CAAA;IACjB,uCAA6B,CAAA;IAC7B,uBAAa,CAAA;IACb,kCAAwB,CAAA;IACxB,uBAAa,CAAA;IACb,+BAAqB,CAAA;IACrB,6BAAmB,CAAA;IACnB,2BAAiB,CAAA;IACjB,4BAAkB,CAAA;IAClB,yBAAe,CAAA;IACf,0BAAgB,CAAA;IAChB,2BAAiB,CAAA;AACrB,CAAC,EA1BW,MAAM,GAAN,cAAM,KAAN,cAAM,QA0BjB;AAED;;;;GAIG;AACH,IAAY,MAeX;AAfD,WAAY,MAAM;IACd,2BAAiB,CAAA;IACjB,2BAAiB,CAAA;IACjB,2BAAiB,CAAA;IACjB,qCAA2B,CAAA;IAC3B,mCAAyB,CAAA;IACzB,yBAAe,CAAA;IACf,8BAAoB,CAAA;IACpB,uBAAa,CAAA;IACb,gCAAsB,CAAA;IACtB,2BAAiB,CAAA;IACjB,sCAA4B,CAAA;IAC5B,iCAAuB,CAAA;IACvB,uBAAa,CAAA;IACb,gCAAsB,CAAA;AAC1B,CAAC,EAfW,MAAM,GAAN,cAAM,KAAN,cAAM,QAejB;AAED;;;;GAIG;AACH,IAAY,SAUX;AAVD,WAAY,SAAS;IACjB,wBAAW,CAAA;IACX,wBAAW,CAAA;IACX,uBAAU,CAAA;IACV,yBAAY,CAAA;IACZ,yBAAY,CAAA;IACZ,wBAAW,CAAA;IACX,+BAAkB,CAAA;IAClB,gCAAkB,CAAA;IAClB,6BAAgB,CAAA;AACpB,CAAC,EAVW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAUpB"}

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

@@ -1,77 +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[]);
-    /**
-     * Determines whether a first name has more name parts
-     */
-    hasMore(): boolean;
-    /**
-     * 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
-     */
-    getInitials(includeAll?: boolean): string[];
-    /**
-     * Capitalizes a first name
-     * @param {'initial' | 'all'} option how to capitalize its subparts
-     */
-    capitalize(option?: 'initial' | 'all'): Firstname;
-    /**
-     * De-capitalizes a first name
-     * @param {'initial' | 'all'} option how to decapitalize its subparts
-     */
-    decapitalize(option?: 'initial' | 'all'): Firstname;
-    /**
-     * Normalizes the first name as it should be
-     */
-    normalize(): Firstname;
-    /**
-     * Returns an ascii representation of each characters of a first name
-     * @param restrictions chars to skip
-     */
-    ascii(restrictions?: string[]): number[];
-    /**
-     * Returns a password-like representation of a first name
-     */
-    passwd(): string;
-}
-/**
- * Aliases for `Firstname`
- */
-export interface Firstname {
-    cap: typeof Firstname.prototype.capitalize;
-    decap: typeof Firstname.prototype.decapitalize;
-    norm: typeof Firstname.prototype.normalize;
-    stats: typeof Firstname.prototype.describe;
-    inits: typeof Firstname.prototype.getInitials;
-}