namefully 1.0.9 → 1.2.0

package/dist/lib/models/lastname.js

@@ -1,86 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Last name class definition
- *
- * Created on March 06, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-const index_1 = require("./index");
-/**
- * Represents a last name with some extra functionalities
- * @class
- * @extends Name
- */
-class Lastname extends index_1.Name {
-    /**
-     * 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, mother, format = 'father') {
-        super(father, index_1.Namon.LAST_NAME);
-        this.father = father;
-        this.mother = mother;
-        this.format = format;
-    }
-    /**
-     * 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) {
-        format = format || this.format;
-        return new index_1.Summary(this.tostring(format));
-    }
-    /**
-     * 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) {
-        format = format || this.format;
-        switch (format) {
-            case 'father':
-                return this.father;
-            case 'mother':
-                return this.mother || index_1.Separator.EMPTY;
-            case 'hyphenated':
-                return this.mother ? this.father.concat(index_1.Separator.HYPHEN, this.mother) : this.father;
-            case 'all':
-                return this.mother ? this.father.concat(index_1.Separator.SPACE, this.mother) : this.father;
-            // default:
-            //     return this.father;
-        }
-    }
-    /**
-     * Gets the initials of the last name
-     * @returns {Array<string>} the initials
-     */
-    getInitials(format) {
-        format = format || this.format;
-        const initials = [];
-        switch (format) {
-            case 'father':
-                initials.push(this.father[0]);
-                break;
-            case 'mother':
-                if (!!this.mother && this.mother.length)
-                    initials.push(this.mother[0]);
-                break;
-            case 'hyphenated':
-            case 'all':
-                initials.push(this.father[0]);
-                if (!!this.mother && this.mother.length)
-                    initials.push(this.mother[0]);
-                break;
-        }
-        return initials;
-    }
-}
-exports.Lastname = Lastname;
-//# sourceMappingURL=lastname.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"lastname.js","sourceRoot":"","sources":["../../../src/models/lastname.ts"],"names":[],"mappings":";;AAAA;;;;;GAKG;AACH,mCAA0E;AAE1E;;;;GAIG;AACH,MAAa,QAAS,SAAQ,YAAI;IAE9B;;;;;;OAMG;IACH,YAAmB,MAAc,EAAS,MAAe,EAAU,SAAyB,QAAQ;QAChG,KAAK,CAAC,MAAM,EAAE,aAAK,CAAC,SAAS,CAAC,CAAC;QADhB,WAAM,GAAN,MAAM,CAAQ;QAAS,WAAM,GAAN,MAAM,CAAS;QAAU,WAAM,GAAN,MAAM,CAA2B;IAEpG,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,MAAuB;QAC5B,MAAM,GAAG,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC;QAC/B,OAAO,IAAI,eAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,MAAuB;QAC5B,MAAM,GAAG,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC;QAC/B,QAAO,MAAM,EAAE;YACX,KAAK,QAAQ;gBACT,OAAO,IAAI,CAAC,MAAM,CAAC;YACvB,KAAK,QAAQ;gBACT,OAAO,IAAI,CAAC,MAAM,IAAI,iBAAS,CAAC,KAAK,CAAC;YAC1C,KAAK,YAAY;gBACb,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,iBAAS,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;YACzF,KAAK,KAAK;gBACN,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,iBAAS,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;YACxF,WAAW;YACX,0BAA0B;SAC7B;IACL,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,MAAuB;QAC/B,MAAM,GAAG,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC;QAC/B,MAAM,QAAQ,GAAa,EAAE,CAAC;QAE9B,QAAO,MAAM,EAAE;YACX,KAAK,QAAQ;gBACT,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC9B,MAAM;YACV,KAAK,QAAQ;gBACT,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM;oBACnC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;gBAClC,MAAM;YACV,KAAK,YAAY,CAAC;YAAC,KAAK,KAAK;gBACzB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC9B,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM;oBACnC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;gBAClC,MAAM;SACb;QACD,OAAO,QAAQ,CAAC;IACpB,CAAC;CACJ;AAtED,4BAsEC"}

package/dist/lib/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/models/misc.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=misc.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"misc.js","sourceRoot":"","sources":["../../../src/models/misc.ts"],"names":[],"mappings":""}

package/dist/lib/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/models/name.js

@@ -1,72 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Name class definition
- *
- * Created on March 06, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-const index_1 = require("./index");
-/**
- * Represents a namon with some extra functionalities
- * @class
- * @see {@link Namon} interface to understand the concept of namon/nama.
- */
-class Name {
-    /**
-     * Constructs a `Name`
-     * @param namon a piece of string that will be defined as a namon
-     * @param type which namon that is
-     */
-    constructor(namon, type, capitalized) {
-        this.namon = namon;
-        this.type = type;
-        this.initial = namon[0];
-        this.body = namon.slice(1, namon.length);
-        if (!!capitalized)
-            this.capitalize(capitalized);
-    }
-    /**
-     * 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() {
-        return new index_1.Summary(this.namon);
-    }
-    /**
-     * Gets the initials of the name
-     * @returns {Array<string>} the initials
-     */
-    getInitials() {
-        return [this.initial];
-    }
-    /**
-     * Capitalizes a name
-     * @param {'initial' | 'all'} option how to capitalize it
-     */
-    capitalize(option = 'initial') {
-        if (option === 'initial') {
-            this.initial = this.initial.toUpperCase();
-            this.namon = this.initial.concat(this.body);
-        }
-        else {
-            this.initial = this.initial.toUpperCase();
-            this.namon = this.namon.toUpperCase();
-        }
-    }
-    /**
-     * Converts all the alphabetic characters in a string to lowercase
-     */
-    lower() {
-        return this.namon.toLowerCase();
-    }
-    /**
-     * Converts all the alphabetic characters in a string to uppercase
-     */
-    upper() {
-        return this.namon.toUpperCase();
-    }
-}
-exports.Name = Name;
-//# sourceMappingURL=name.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"name.js","sourceRoot":"","sources":["../../../src/models/name.ts"],"names":[],"mappings":";;AAAA;;;;;GAKG;AACH,mCAAyC;AAEzC;;;;GAIG;AACH,MAAa,IAAI;IAKb;;;;OAIG;IACH,YAAmB,KAAa,EAAS,IAAW,EAAE,WAA+B;QAAlE,UAAK,GAAL,KAAK,CAAQ;QAAS,SAAI,GAAJ,IAAI,CAAO;QAChD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QACzC,IAAI,CAAC,CAAC,WAAW;YAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACH,QAAQ;QACJ,OAAO,IAAI,eAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,WAAW;QACP,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACO,UAAU,CAAC,SAA4B,SAAS;QACtD,IAAI,MAAM,KAAK,SAAS,EAAE;YACtB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;YAC1C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAC/C;aAAM;YACH,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;YAC1C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;SACzC;IACL,CAAC;IAED;;OAEG;IACH,KAAK;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,KAAK;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;IACpC,CAAC;CACJ;AA5DD,oBA4DC"}

package/dist/lib/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/models/summary.js

@@ -1,60 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Summary of descriptive stats of the name
- *
- * Created on March 06, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-const index_1 = require("./index");
-/**
- * Represents the statistical summary of a string representation
- * @class
- */
-class Summary {
-    /**
-     * Creates a `Summary` of a given string of alphabetical characters
-     * @param namon piece of name
-     * @param restrictions a set of undesired characters
-     */
-    constructor(namon, restrictions = [index_1.Separator.SPACE]) {
-        this.namon = namon;
-        this.compute(restrictions);
-    }
-    /**
-     * Returns a string representation of the summary
-     */
-    tostring() {
-        return index_1.Separator.EMPTY.concat(`Descriptive statistics for "${this.namon}" \n`, `count    : ${this.count} \n`, `frequency: ${this.frequency} \n`, `top      : ${this.top} \n`, `unique   : ${this.unique} \n`);
-    }
-    compute(restrictions = []) {
-        // compute stats for the string
-        let count = 0, maxfreq = 0, uniq = 0, top = '';
-        const freqs = this.groupByChar();
-        for (const char in freqs) {
-            if (restrictions.indexOf(char) === -1) {
-                count += freqs[char];
-                if (freqs[char] >= maxfreq) {
-                    maxfreq = freqs[char];
-                    top = char;
-                }
-                uniq++;
-            }
-        }
-        this.count = count;
-        this.frequency = maxfreq;
-        this.top = top;
-        this.unique = uniq;
-    }
-    groupByChar() {
-        const frequencies = {};
-        for (const char of this.namon.toUpperCase())
-            if (Object.keys(frequencies).includes(char))
-                frequencies[char] += 1;
-            else
-                frequencies[char] = 1;
-        return frequencies;
-    }
-}
-exports.Summary = Summary;
-//# sourceMappingURL=summary.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"summary.js","sourceRoot":"","sources":["../../../src/models/summary.ts"],"names":[],"mappings":";;AAAA;;;;;GAKG;AACH,mCAAoC;AAEpC;;;GAGG;AACH,MAAa,OAAO;IAMhB;;;;OAIG;IACH,YAAoB,KAAa,EAAE,eAAyB,CAAC,iBAAS,CAAC,KAAK,CAAC;QAAzD,UAAK,GAAL,KAAK,CAAQ;QAC7B,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,QAAQ;QACJ,OAAO,iBAAS,CAAC,KAAK,CAAC,MAAM,CACzB,+BAA+B,IAAI,CAAC,KAAK,MAAM,EAC/C,cAAc,IAAI,CAAC,KAAK,KAAK,EAC7B,cAAc,IAAI,CAAC,SAAS,KAAK,EACjC,cAAc,IAAI,CAAC,GAAG,KAAK,EAC3B,cAAc,IAAI,CAAC,MAAM,KAAK,CACjC,CAAC;IACN,CAAC;IAEO,OAAO,CAAC,eAAyB,EAAE;QACvC,+BAA+B;QAC/B,IAAI,KAAK,GAAG,CAAC,EAAE,OAAO,GAAG,CAAC,EAAE,IAAI,GAAG,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC;QAC/C,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAEjC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACtB,IAAI,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE;gBACnC,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC;gBACrB,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,OAAO,EAAE;oBACxB,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;oBACtB,GAAG,GAAG,IAAI,CAAC;iBACd;gBACD,IAAI,EAAE,CAAC;aACV;SACJ;QAED,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC;QACzB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;IACvB,CAAC;IAEO,WAAW;QACf,MAAM,WAAW,GAA8B,EAAE,CAAC;QAClD,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE;YACvC,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;gBACvC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;;gBAEvB,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC9B,OAAO,WAAW,CAAC;IACvB,CAAC;CACJ;AA3DD,0BA2DC"}

package/dist/lib/src/core/constants.d.ts

@@ -1,26 +0,0 @@
-/**
- * Constants
- *
- * Created on March 07, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-import { Config, NameIndex } from '../models/index';
-/**
- * The current version of `Namefully`.
- * @constant
- */
-export declare const version = "1.0.9";
-/**
- * CONFIG constant
- * @constant
- * @type {Config}
- * @default
- */
-export declare const CONFIG: Config;
-/**
- * NAME_INDEX constant
- * @constant
- * @type {NameIndex}
- * @default
- */
-export declare const NAME_INDEX: NameIndex;

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

@@ -1,9 +0,0 @@
-/**
- * Make all the locals available
- *
- * Created on March 06, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-export * from './parsers/index';
-export * from './utils/utils';
-export * from './constants';

package/dist/lib/src/core/parsers/array-name.parser.d.ts

@@ -1,42 +0,0 @@
-/**
- * An array `Name` parser
- *
- * Created on March 15, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-import { Name, Fullname, LastnameFormat } from '../../models/index';
-import { Parser } from './parser';
-/**
- * Represents a `Name[]` parser
- * @class
- * @implements {Parser<Name[]>}
- * @classdesc
- * This parser parses an array of the class `Name` while checking that every part
- * plays the role they are supposed to play. The class `Name` is a ready-made
- * recipe that saves the how-to parsing for a raw data input.
- *
- * **NOTE**:
- * In this specific case, the user is expected to carefully set each name part
- * and submit a high-quality data. Why is this parser if the data is already
- * shaped as wanted? Well, it is better to be safe than sorry, so we implement a
- * double-check of these values and reconfirm a cleaner data. Remember, namefully
- * works like a trapdoor, once the data is set and confirmed safe, no editing is
- * possible.
- */
-export default class ArrayNameParser implements Parser<Name[]> {
-    raw: Name[];
-    /**
-     * Create a parser ready to parse the raw data
-     * @param {Name[]} raw data
-     */
-    constructor(raw: Name[]);
-    /**
-     * Parses the raw data into a full name
-     * @returns {Fullname}
-     */
-    parse(options: {
-        bypass: boolean;
-        lastnameFormat: LastnameFormat;
-    }): Fullname;
-    private distribute;
-}

package/dist/lib/src/core/parsers/array-string.parser.d.ts

@@ -1,48 +0,0 @@
-/**
- * An array of string parser
- *
- * Created on March 15, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-import { Fullname, NameOrder } from '../../models/index';
-import { Parser } from './parser';
-/**
- * Represents an array string parser
- * @class
- * @implements {Parser<string[]>}
- * @classdesc
- * This parser parses 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 parsing is carried out.
- *
- * Ordered by first name, the parser works as follows:
- * - 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 parser works as follows:
- * - 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 ArrayStringParser implements Parser<string[]> {
-    raw: string[];
-    /**
-     * Create a parser ready to parse the raw data
-     * @param {Array<string>} raw data
-     */
-    constructor(raw: string[]);
-    /**
-     * Parses the raw data into a full name
-     * @returns {Fullname}
-     */
-    parse(options: {
-        orderedBy: NameOrder;
-        bypass: boolean;
-    }): Fullname;
-    private distribute;
-}

package/dist/lib/src/core/parsers/index.d.ts

@@ -1,11 +0,0 @@
-/**
- * Export the local parsers
- *
- * Created on March 03, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-export * from './parser';
-export { default as ArrayNameParser } from './array-name.parser';
-export { default as ArrayStringParser } from './array-string.parser';
-export { default as NamaParser } from './nama.parser';
-export { default as StringParser } from './string.parser';

package/dist/lib/src/core/parsers/nama.parser.d.ts

@@ -1,34 +0,0 @@
-/**
- * A `Nama` (JSON signature) parser
- *
- * Created on March 15, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-import { Nama, Fullname } from '../../models/index';
-import { Parser } from './parser';
-/**
- * Represents a `Nama` parser
- * @class
- * @implements {Parser<Nama>}
- * @classdesc
- * This parser parses a JSON signature of the name parts provided as string
- * values. This is to facilitate a developer's life that holds users' info in a
- * JSON format. In other words, the developer only needs to provide similar info
- * and the rest will follow.
- */
-export default class NamaParser implements Parser<Nama> {
-    raw: Nama;
-    /**
-     * Create a parser ready to parse the raw data
-     * @param {Nama} raw data as JSON object
-     */
-    constructor(raw: Nama);
-    /**
-     * Parses the raw data into a full name
-     * @returns {Fullname}
-     */
-    parse(options: {
-        bypass: boolean;
-    }): Fullname;
-    private distribute;
-}

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

@@ -1,29 +0,0 @@
-/**
- * A `Parser` contract
- *
- * Created on March 15, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-import { Fullname, Separator, NameOrder, LastnameFormat } from '../../models/index';
-/**
- * Interface for JSON signature that represents a generic parser
- * @interface
- */
-export interface Parser<T> {
-    /**
-     * raw data to be parsed
-     * @type {T}
-     */
-    raw: T;
-    /**
-     * Parses the raw data into a full name
-     * @param {Config} [options]
-     * @returns {Fullname}
-     */
-    parse(options?: Partial<{
-        orderedBy: NameOrder;
-        separator: Separator;
-        bypass: boolean;
-        lastnameFormat: LastnameFormat;
-    }>): Fullname;
-}

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

@@ -1,61 +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
-     * @returns {Fullname}
-     */
-    parse(options: {
-        orderedBy: NameOrder;
-        separator: Separator;
-        bypass: boolean;
-    }): Fullname;
-}

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

@@ -1,14 +0,0 @@
-/**
- * Utils for the core functionalities of `Namefully`
- *
- * Created on March 16, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-import { NameIndex, NameOrder } from '../../models';
-/**
- * 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;