namefully 1.1.0 → 1.2.1

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

@@ -1,108 +0,0 @@
-/**
- * Miscellaneous types
- *
- * Created on March 07, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-import { Parser } from '../core/parsers';
-import { Separator } from './enums';
-/**
- * Defines the two ways that a full name can be ordered: first or last name
- * @typedef NameOrder
- */
-export declare type NameOrder = 'firstname' | 'fn' | 'lastname' | 'ln';
-/**
- * Defines the three parts that a birth name
- * @typedef NameType
- */
-export declare type NameType = 'firstname' | 'fn' | 'lastname' | 'ln' | 'middlename' | 'mn';
-/**
- * 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 {
-    /**
-     * The order of appearance of a full name: by first name or last name
-     */
-    orderedBy: NameOrder;
-    /**
-     * For literal string input, this is the parameter used to indicate the token
-     * to utilize to split the string names.
-     */
-    separator: Separator;
-    /**
-     * Whether or not to add period to a prefix using the American or British way.
-     */
-    titling: AbbrTitle;
-    /**
-     * Indicates if the ending suffix should be separated with a comma or space.
-     */
-    ending: boolean;
-    /**
-     * Bypass the validation rules with this option. Since we only provide a
-     * handful of suffixes or prefixes in English, this paramter is ideal to
-     * avoid checking the validity of them.
-     */
-    bypass: boolean;
-    /**
-     * Custom parser, a user-defined parser indicating how to the name set is
-     * organized. Namefully cannot guess it.
-     */
-    parser?: Parser<any>;
-    /**
-     * how to format a surname:
-     * - 'father' (father name only)
-     * - 'mother' (mother name only)
-     * - 'hyphenated' (joining both father and mother names with a hyphen)
-     * - 'all' (joining both father and mother names with a space).
-     *
-     * This parameter can be set either by an instance of a last name or during
-     * the creation of a namefully instance. To avoid ambiguity, we prioritize as
-     * source of truth the value set as optional parameter when instantiating
-     * namefully.
-     */
-    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,76 +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 readonly initial;
-    private readonly body;
-    /**
-     * Constructs a `Name`
-     * @param namon a piece of string that will be defined as a namon
-     * @param type which namon that is
-     * @param cap which kind of capitalizations
-     */
-    constructor(namon: string, type: Namon, cap?: '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;
-    /**
-     * Returns a string representation of the namon
-     */
-    tostring(): string;
-    /**
-     * Gets the initials of the name
-     */
-    getInitials(): string[];
-    /**
-     * Capitalizes a name
-     * @param {'initial' | 'all'} option how to capitalize it
-     */
-    capitalize(option?: 'initial' | 'all'): Name;
-    /**
-     * De-capitalizes a name
-     * @param {'initial' | 'all'} option how to decapitalize it
-     */
-    decapitalize(option?: 'initial' | 'all'): Name;
-    /**
-     * Normalizes the name as it should be
-     */
-    normalize(): Name;
-    /**
-     * Resets to the initial namon
-     */
-    reset(): Name;
-    /**
-     * Returns an ascii representation of each characters of a name
-     * @param restrictions chars to skip
-     */
-    ascii(restrictions?: string[]): number[];
-    /**
-     * Returns a password-like representation of a name
-     */
-    passwd(): string;
-}
-/**
- * Aliases for `Name`
- */
-export interface Name {
-    cap: typeof Name.prototype.capitalize;
-    decap: typeof Name.prototype.decapitalize;
-    norm: typeof Name.prototype.normalize;
-    stats: typeof Name.prototype.describe;
-    inits: typeof Name.prototype.getInitials;
-}

package/dist/lib/models/name.js

@@ -1,115 +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");
-const core_1 = require("../core");
-/**
- * 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
-     * @param cap which kind of capitalizations
-     */
-    constructor(namon, type, cap) {
-        this.namon = namon;
-        this.type = type;
-        this.initial = namon[0];
-        this.body = namon.slice(1);
-        if (!!cap)
-            this.capitalize(cap);
-    }
-    /**
-     * 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);
-    }
-    /**
-     * Returns a string representation of the namon
-     */
-    tostring() {
-        return this.namon;
-    }
-    /**
-     * Gets the initials of the name
-     */
-    getInitials() {
-        return [this.namon[0]];
-    }
-    /**
-     * Capitalizes a name
-     * @param {'initial' | 'all'} option how to capitalize it
-     */
-    capitalize(option = 'initial') {
-        const initial = this.initial.toUpperCase();
-        if (option === 'initial') {
-            this.namon = initial.concat(this.body);
-        }
-        else {
-            this.namon = this.namon.toUpperCase();
-        }
-        return this;
-    }
-    /**
-     * De-capitalizes a name
-     * @param {'initial' | 'all'} option how to decapitalize it
-     */
-    decapitalize(option = 'initial') {
-        const initial = this.initial.toLowerCase();
-        if (option === 'initial') {
-            this.namon = initial.concat(this.body);
-        }
-        else {
-            this.namon = initial.concat(this.body.toLowerCase());
-        }
-        return this;
-    }
-    /**
-     * Normalizes the name as it should be
-     */
-    normalize() {
-        this.namon = this.namon[0]
-            .toUpperCase()
-            .concat(this.namon.slice(1).toLowerCase());
-        return this;
-    }
-    /**
-     * Resets to the initial namon
-     */
-    reset() {
-        this.namon = this.initial.concat(this.body);
-        return this;
-    }
-    /**
-     * Returns an ascii representation of each characters of a name
-     * @param restrictions chars to skip
-     */
-    ascii(restrictions) {
-        return core_1.convertToAscii(this.namon, restrictions);
-    }
-    /**
-     * Returns a password-like representation of a name
-     */
-    passwd() {
-        return core_1.generatePassword(this.namon);
-    }
-}
-exports.Name = Name;
-Name.prototype.cap = Name.prototype.capitalize;
-Name.prototype.decap = Name.prototype.decapitalize;
-Name.prototype.norm = Name.prototype.normalize;
-Name.prototype.stats = Name.prototype.describe;
-Name.prototype.inits = Name.prototype.getInitials;
-//# 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;AACzC,kCAA2D;AAE3D;;;;GAIG;AACH,MAAa,IAAI;IAKb;;;;;OAKG;IACH,YAAmB,KAAa,EAAS,IAAW,EAAE,GAAuB;QAA1D,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,CAAC,CAAC;QAC3B,IAAI,CAAC,CAAC,GAAG;YAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACH,QAAQ;QACJ,OAAO,IAAI,eAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IAED;;OAEG;IACH,QAAQ;QACJ,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,WAAW;QACP,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,SAA4B,SAAS;QAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;QAC3C,IAAI,MAAM,KAAK,SAAS,EAAE;YACtB,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAC1C;aAAM;YACH,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;SACzC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,YAAY,CAAC,SAA4B,SAAS;QAC9C,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;QAC3C,IAAI,MAAM,KAAK,SAAS,EAAE;YACtB,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAC1C;aAAM;YACH,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;SACxD;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,SAAS;QACL,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;aACrB,WAAW,EAAE;aACb,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK;QACD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAuB;QACzB,OAAO,qBAAc,CAAC,IAAI,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;IACpD,CAAC;IAED;;OAEG;IACH,MAAM;QACF,OAAO,uBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC;CACJ;AApGD,oBAoGC;AAaD,IAAI,CAAC,SAAS,CAAC,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC;AAC/C,IAAI,CAAC,SAAS,CAAC,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC;AACnD,IAAI,CAAC,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC;AAC/C,IAAI,CAAC,SAAS,CAAC,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;AAC/C,IAAI,CAAC,SAAS,CAAC,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC"}

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

@@ -1,26 +0,0 @@
-/**
- * Represents the statistical summary of a string representation
- * @class
- */
-export declare class Summary {
-    private namon;
-    distribution: {
-        [key: string]: number;
-    };
-    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,61 +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`, `distrib  : ${Object.entries(this.distribution).map(e => `${e[1]}${e[0]}`).join(',')} \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.distribution = freqs;
-        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;IAOhB;;;;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,EAC9B,cAAc,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAC5F,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,YAAY,GAAG,KAAK,CAAC;QAC1B,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;AA9DD,0BA8DC"}