namefully 1.1.0 → 1.2.0

package/changelog.md

@@ -1,134 +0,0 @@
-# Changelog
-
-This file contains the documentation on the notable changes and bug fixes, and
-is formatted following this [standard](https://keepachangelog.com/en/1.0.0/).
-This project also adheres to [Semantic Versioning](https://semver.org/).
-
-## [1.1.0] - 2020-07-05
-
-**Added**:
-
-- Add a full name builder to construct `Namefully`
-- Augment a `namon` functionality
-  - capitalize
-  - decapitalize
-  - normalize
-  - reset
-- Add ASCII representations
-- Add password-like representations
-- Add support for title cases
-- Add support for birth names (full name without prefix or suffix)
-- Add test coverage for all the API methods
-- Update use cases for new features
-- Use string formats (`short`, `long`, `official`) when formatting a name
-
-**Fixed**:
-
-- Support space in regex
-- Use simplified regex
-- Support for more than one name parts in a first name
-- Revert changes in `compress(...)`: always include a token in the compressed part.
-- Switch to MIT License
-
-## [1.0.9] - 2020-05-18
-
-**Added**:
-
-- Add support for Cyrillic and Greek alphabet
-
-**Fixed**:
-
-- Fix validation rules (regex) for specific fields
-
-## [1.0.8] - 2020-04-18
-
-**Added**:
-
-- Add short API equivalent for `compress` => `zip`
-- Add `lastnameFormat` option to config and surname subparts handling
-- Refactor return values for `describe` (object instead of string)
-- Add support for titling when compressing or zipping
-
-**Fixed**:
-
-- Fix missing bypass for fullname validator
-- Fix logic for name parts handling in `Firstname` class
-
-## [1.0.7] - 2020-03-28
-
-**Added**:
-
-- Add `titling` option to config
-- Add support for prefixes and suffixes when formatting names
-  - including a clear cut for (de)-capitalized official names
-
-**Fixed**:
-
-- Fix wrong ending reference for suffixes
-
-## [1.0.6] - 2020-03-20
-
-**Added**:
-
-- Add support for Latin (European and Spanish) names
-- Add a bypass to skip validation rules (regex)
-
-## [1.0.5] - 2020-03-17
-
-**Added**:
-
-- Add optional parameters for the `getFullname` and `getInitials` API;
-  - Users can forcefully alter order of appearance the full name and initials;
-- Add optional parameters for the `describe` API;
-  - Users can either decide to describe the full name or some specific name parts;
-- Introduce new option in `Namefully` creation;
-  - `ending` accepts a separator for to mark an ending suffix;
-- Add some jsdoc comments to document the API;
-- Add some aliases to the API.
-
-**Fixed**:
-
-- Fix validation error for string array input using wrong/insufficient entries;
-- Fix options in `Namefully` creation;
-  - `orderedBy` accepts now two name parts only (first or last name);
-  - `separator` works as the splitting name factor;
-- Fix the order of appearance for the full name and `compress` API.
-
-## [1.0.3] - 2020-03-11
-
-**Fixed**:
-
-- Fix typescript compilation for ES2015, UMD
-- Fix `namefully` version
-
-## [1.0.2] - 2020-03-11
-
-**Added**:
-
-- Add use cases
-- Add test coverage
-- Add setup CI/CD
-- Add support for UMD
-- Make validation error message more explicit
-
-## [1.0.1] - 2020-03-07
-
-**Fixed**:
-
-- Fix typo in readme
-- Fix build system for npm
-
-## [1.0.0] - 2020-03-07
-
-Initial version
-
-[1.1.0]: https://github.com/ralflorent/namefully/compare/v1.0.9...v1.1.0
-[1.0.9]: https://github.com/ralflorent/namefully/compare/v1.0.8...v1.0.9
-[1.0.8]: https://github.com/ralflorent/namefully/compare/v1.0.7...v1.0.8
-[1.0.7]: https://github.com/ralflorent/namefully/compare/v1.0.6...v1.0.7
-[1.0.6]: https://github.com/ralflorent/namefully/compare/v1.0.5...v1.0.6
-[1.0.5]: https://github.com/ralflorent/namefully/compare/v1.0.3...v1.0.5
-[1.0.3]: https://github.com/ralflorent/namefully/compare/v1.0.2...v1.0.3
-[1.0.2]: https://github.com/ralflorent/namefully/compare/v1.0.1...v1.0.2
-[1.0.1]: https://github.com/ralflorent/namefully/compare/v1.0.0...v1.0.1
-[1.0.0]: https://github.com/ralflorent/namefully/releases/tag/v1.0.0

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

@@ -1,48 +0,0 @@
-/**
- * Constants
- *
- * Created on March 07, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-import { Separator, Config, NameIndex } from '../models/index';
-import { CharSet } from './core';
-/**
- * The current version of `Namefully`.
- * @constant
- */
-export declare const version = "1.1.0";
-/**
- * CONFIG
- * @constant
- * @type {Config}
- * @default
- */
-export declare const CONFIG: Config;
-/**
- * NAME_INDEX
- * @constant
- * @type {NameIndex}
- * @default
- */
-export declare const NAME_INDEX: NameIndex;
-export declare const FIRST_LAST_NAME_INDEX = 2;
-export declare const LAST_FIRST_NAME_INDEX = 2;
-export declare const FIRST_MIDDLE_LAST_NAME_INDEX = 3;
-export declare const LAST_FIRST_MIDDLE_NAME_INDEX = 3;
-export declare const PREFIX_FIRST_MIDDLE_LAST_NAME_INDEX = 4;
-export declare const PREFIX_LAST_FIRST_MIDDLE_NAME_INDEX = 4;
-export declare const PREFIX_FIRST_MIDDLE_LAST_SUFFIX_NAME_INDEX = 5;
-export declare const PREFIX_LAST_FIRST_MIDDLE_SUFFIX_NAME_INDEX = 5;
-export declare const MIN_NUMBER_NAME_PART = 2;
-export declare const MAX_NUMBER_NAME_PART = 5;
-/**
- * RESTRICTED_CHARS
- * @constant
- * @default
- */
-export declare const RESTRICTED_CHARS: readonly [Separator.SPACE, Separator.SINGLE_QUOTE, Separator.HYPHEN, Separator.PERIOD, Separator.COMMA];
-/**
- * PASSWORD_MAPPER
- * @constant
- */
-export declare const PASSWORD_MAPPER: Map<string, CharSet<string>>;

package/dist/lib/core/constants.js

@@ -1,101 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Constants
- *
- * Created on March 07, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-const index_1 = require("../models/index");
-const core_1 = require("./core");
-/**
- * The current version of `Namefully`.
- * @constant
- */
-exports.version = '1.1.0';
-/**
- * CONFIG
- * @constant
- * @type {Config}
- * @default
- */
-exports.CONFIG = {
-    orderedBy: 'firstname',
-    separator: index_1.Separator.SPACE,
-    titling: 'uk',
-    ending: false,
-    bypass: false,
-    lastnameFormat: 'father',
-};
-/**
- * NAME_INDEX
- * @constant
- * @type {NameIndex}
- * @default
- */
-exports.NAME_INDEX = {
-    prefix: 0,
-    firstname: 1,
-    middlename: 2,
-    lastname: 3,
-    suffix: 4,
-};
-exports.FIRST_LAST_NAME_INDEX = 2;
-exports.LAST_FIRST_NAME_INDEX = 2;
-exports.FIRST_MIDDLE_LAST_NAME_INDEX = 3;
-exports.LAST_FIRST_MIDDLE_NAME_INDEX = 3;
-exports.PREFIX_FIRST_MIDDLE_LAST_NAME_INDEX = 4;
-exports.PREFIX_LAST_FIRST_MIDDLE_NAME_INDEX = 4;
-exports.PREFIX_FIRST_MIDDLE_LAST_SUFFIX_NAME_INDEX = 5;
-exports.PREFIX_LAST_FIRST_MIDDLE_SUFFIX_NAME_INDEX = 5;
-exports.MIN_NUMBER_NAME_PART = 2;
-exports.MAX_NUMBER_NAME_PART = 5;
-/**
- * RESTRICTED_CHARS
- * @constant
- * @default
- */
-exports.RESTRICTED_CHARS = [
-    index_1.Separator.SPACE,
-    index_1.Separator.SINGLE_QUOTE,
-    index_1.Separator.HYPHEN,
-    index_1.Separator.PERIOD,
-    index_1.Separator.COMMA,
-];
-/**
- * PASSWORD_MAPPER
- * @constant
- */
-exports.PASSWORD_MAPPER = new Map([
-    ['a', new core_1.CharSet(['a', 'A', '@', '4'])],
-    ['b', new core_1.CharSet(['b', 'B', '6', '|)', '|3', '|>'])],
-    ['c', new core_1.CharSet(['c', 'C', '(', '<'])],
-    ['d', new core_1.CharSet(['d', 'D', '(|', '<|'])],
-    ['e', new core_1.CharSet(['e', 'E', '3', '*'])],
-    ['f', new core_1.CharSet(['f', 'F', '7', '(-'])],
-    ['g', new core_1.CharSet(['g', 'G', '8', '&', '**'])],
-    ['h', new core_1.CharSet(['h', 'H', '#', '|-|'])],
-    ['i', new core_1.CharSet(['i', 'I', '!', '1', '|', '--'])],
-    ['j', new core_1.CharSet(['j', 'J', ')', '1'])],
-    ['k', new core_1.CharSet(['k', 'K', '%', '|<'])],
-    ['l', new core_1.CharSet(['l', 'L', '1', '!', '|_'])],
-    ['m', new core_1.CharSet(['m', 'M', '^^', '>>'])],
-    ['n', new core_1.CharSet(['n', 'N', '!=', '++'])],
-    ['o', new core_1.CharSet(['o', 'O', '0', '.', '*'])],
-    ['p', new core_1.CharSet(['p', 'P', '|3', '|)', '|>'])],
-    ['q', new core_1.CharSet(['q', 'Q', '&', '9', '<|'])],
-    ['r', new core_1.CharSet(['r', 'R', '7', '&'])],
-    ['s', new core_1.CharSet(['s', 'S', '5', '$'])],
-    ['t', new core_1.CharSet(['t', 'T', '7', '['])],
-    ['u', new core_1.CharSet(['u', 'U', '|_|', 'v'])],
-    ['v', new core_1.CharSet(['v', 'V', '>', '<', '^'])],
-    ['w', new core_1.CharSet(['w', 'W', '[|]', 'vv'])],
-    ['x', new core_1.CharSet(['x', 'X', '%', '#'])],
-    ['z', new core_1.CharSet(['z', 'Z', '2', '!='])],
-    ['$', new core_1.CharSet([
-            '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '-', '+', '[',
-            '_', '=', '{', '}', ':', ';', ',', '.', '<', '>', '|', '~', ']',
-            '0', '1', '2', '3', '4', '5', '6', '7', '8', '9'
-        ])],
-]);
-//# sourceMappingURL=constants.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/core/constants.ts"],"names":[],"mappings":";;AAAA;;;;;GAKG;AACH,2CAA+D;AAC/D,iCAAiC;AAEjC;;;GAGG;AACU,QAAA,OAAO,GAAG,OAAO,CAAA;AAE9B;;;;;GAKG;AACU,QAAA,MAAM,GAAW;IAC1B,SAAS,EAAE,WAAW;IACtB,SAAS,EAAE,iBAAS,CAAC,KAAK;IAC1B,OAAO,EAAE,IAAI;IACb,MAAM,EAAE,KAAK;IACb,MAAM,EAAE,KAAK;IACb,cAAc,EAAE,QAAQ;CAClB,CAAA;AAEV;;;;;GAKG;AACU,QAAA,UAAU,GAAc;IACjC,MAAM,EAAE,CAAC;IACT,SAAS,EAAE,CAAC;IACZ,UAAU,EAAE,CAAC;IACb,QAAQ,EAAE,CAAC;IACX,MAAM,EAAE,CAAC;CACH,CAAA;AAEG,QAAA,qBAAqB,GAAG,CAAC,CAAA;AACzB,QAAA,qBAAqB,GAAG,CAAC,CAAA;AACzB,QAAA,4BAA4B,GAAG,CAAC,CAAA;AAChC,QAAA,4BAA4B,GAAG,CAAC,CAAA;AAChC,QAAA,mCAAmC,GAAG,CAAC,CAAA;AACvC,QAAA,mCAAmC,GAAG,CAAC,CAAA;AACvC,QAAA,0CAA0C,GAAG,CAAC,CAAA;AAC9C,QAAA,0CAA0C,GAAG,CAAC,CAAA;AAE9C,QAAA,oBAAoB,GAAG,CAAC,CAAA;AACxB,QAAA,oBAAoB,GAAG,CAAC,CAAA;AAErC;;;;GAIG;AACU,QAAA,gBAAgB,GAAG;IAC5B,iBAAS,CAAC,KAAK;IACf,iBAAS,CAAC,YAAY;IACtB,iBAAS,CAAC,MAAM;IAChB,iBAAS,CAAC,MAAM;IAChB,iBAAS,CAAC,KAAK;CACT,CAAA;AAEV;;;GAGG;AACU,QAAA,eAAe,GAAG,IAAI,GAAG,CAAC;IACnC,CAAE,GAAG,EAAE,IAAI,cAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAE;IAC1C,CAAE,GAAG,EAAE,IAAI,cAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAE;IACvD,CAAE,GAAG,EAAE,IAAI,cAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAE;IAC1C,CAAE,GAAG,EAAE,IAAI,cAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAE;IAC5C,CAAE,GAAG,EAAE,IAAI,cAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAE;IAC1C,CAAE,GAAG,EAAE,IAAI,cAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAE;IAC3C,CAAE,GAAG,EAAE,IAAI,cAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAE;IAChD,CAAE,GAAG,EAAE,IAAI,cAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC,CAAE;IAC5C,CAAE,GAAG,EAAE,IAAI,cAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAE;IACrD,CAAE,GAAG,EAAE,IAAI,cAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAE;IAC1C,CAAE,GAAG,EAAE,IAAI,cAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAE;IAC3C,CAAE,GAAG,EAAE,IAAI,cAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAE;IAChD,CAAE,GAAG,EAAE,IAAI,cAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAE;IAC5C,CAAE,GAAG,EAAE,IAAI,cAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAE;IAC5C,CAAE,GAAG,EAAE,IAAI,cAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAE;IAC/C,CAAE,GAAG,EAAE,IAAI,cAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAE;IAClD,CAAE,GAAG,EAAE,IAAI,cAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAE;IAChD,CAAE,GAAG,EAAE,IAAI,cAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAE;IAC1C,CAAE,GAAG,EAAE,IAAI,cAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAE;IAC1C,CAAE,GAAG,EAAE,IAAI,cAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAE;IAC1C,CAAE,GAAG,EAAE,IAAI,cAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC,CAAE;IAC5C,CAAE,GAAG,EAAE,IAAI,cAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAE;IAC/C,CAAE,GAAG,EAAE,IAAI,cAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAE;IAC7C,CAAE,GAAG,EAAE,IAAI,cAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAE;IAC1C,CAAE,GAAG,EAAE,IAAI,cAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAE;IAC3C,CAAE,GAAG,EAAE,IAAI,cAAO,CAAC;YACf,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG;YAC/D,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG;YAC/D,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG;SACnD,CAAC,CAAC;CACN,CAAC,CAAA"}

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

@@ -1,17 +0,0 @@
-/**
- * Core contents
- *
- * Created on June 30, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-/**
- * Extends `Set` functionalities by shuffling the set values and return one
- */
-export declare class CharSet<T> extends Set<T> {
-    random(): T;
-}
-/**
- * Extends `Array` functionalities
- */
-export declare class CharArray<T> extends Array<T> {
-}

package/dist/lib/core/core.js

@@ -1,24 +0,0 @@
-"use strict";
-/**
- * Core contents
- *
- * Created on June 30, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Extends `Set` functionalities by shuffling the set values and return one
- */
-class CharSet extends Set {
-    random() {
-        return Array.from(this)[Math.floor(Math.random() * this.size)];
-    }
-}
-exports.CharSet = CharSet;
-/**
- * Extends `Array` functionalities
- */
-class CharArray extends Array {
-}
-exports.CharArray = CharArray;
-//# sourceMappingURL=core.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"core.js","sourceRoot":"","sources":["../../../src/core/core.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAEH;;GAEG;AACH,MAAa,OAAW,SAAQ,GAAM;IAClC,MAAM;QACF,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACnE,CAAC;CACJ;AAJD,0BAIC;AAED;;GAEG;AACH,MAAa,SAAa,SAAQ,KAAQ;CAEzC;AAFD,8BAEC"}

package/dist/lib/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';
-export * from './constants';

package/dist/lib/core/index.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-/**
- * Make all the locals available
- *
- * Created on March 06, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-tslib_1.__exportStar(require("./parsers/index"), exports);
-tslib_1.__exportStar(require("./utils"), exports);
-tslib_1.__exportStar(require("./constants"), exports);
-//# sourceMappingURL=index.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/core/index.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,0DAAgC;AAChC,kDAAwB;AACxB,sDAA4B"}

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

@@ -1,41 +0,0 @@
-/**
- * An array `Name` parser
- *
- * Created on March 15, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-import { Name, Fullname, LastnameFormat } from '../../models';
-import { Parser } from './parser';
-/**
- * Represents a `Name[]` parser
- * @class
- * @implements {Parser<Name[]>}
- *
- * 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
-     */
-    parse(options: {
-        bypass: boolean;
-        lastnameFormat: LastnameFormat;
-    }): Fullname;
-    private distribute;
-}

package/dist/lib/core/parsers/array-name.parser.js

@@ -1,86 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * An array `Name` parser
- *
- * Created on March 15, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-const models_1 = require("../../models");
-const index_1 = require("../../validators/index");
-/**
- * Represents a `Name[]` parser
- * @class
- * @implements {Parser<Name[]>}
- *
- * 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.
- */
-class ArrayNameParser {
-    /**
-     * Create a parser ready to parse the raw data
-     * @param {Name[]} raw data
-     */
-    constructor(raw) {
-        this.raw = raw;
-    }
-    /**
-     * Parses the raw data into a full name
-     */
-    parse(options) {
-        const { bypass, lastnameFormat } = options;
-        // validate first
-        if (!bypass)
-            new index_1.ArrayNameValidator().validate(this.raw);
-        // then distribute all the elements accordingly
-        const fullname = this.distribute(lastnameFormat);
-        // finally return high quality of data
-        return fullname;
-    }
-    distribute(lastnameFormat) {
-        const fullname = {
-            firstname: null,
-            lastname: null,
-            middlename: [],
-            prefix: null,
-            suffix: null,
-        };
-        this.raw.forEach(name => {
-            switch (name.type) {
-                case models_1.Namon.PREFIX:
-                    fullname.prefix = name.namon;
-                    break;
-                case models_1.Namon.FIRST_NAME:
-                    if (name instanceof models_1.Firstname)
-                        fullname.firstname = new models_1.Firstname(name.namon, ...name.more);
-                    else
-                        fullname.firstname = new models_1.Firstname(name.namon);
-                    break;
-                case models_1.Namon.LAST_NAME:
-                    if (name instanceof models_1.Lastname)
-                        fullname.lastname = new models_1.Lastname(name.father, name.mother, lastnameFormat);
-                    else
-                        fullname.lastname = new models_1.Lastname(name.namon, null, lastnameFormat);
-                    break;
-                case models_1.Namon.MIDDLE_NAME:
-                    fullname.middlename.push(name);
-                    break;
-                case models_1.Namon.SUFFIX:
-                    fullname.suffix = name.namon;
-                    break;
-            }
-        });
-        return fullname;
-    }
-}
-exports.default = ArrayNameParser;
-//# sourceMappingURL=array-name.parser.js.map

package/dist/lib/core/parsers/array-name.parser.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"array-name.parser.js","sourceRoot":"","sources":["../../../../src/core/parsers/array-name.parser.ts"],"names":[],"mappings":";;AAAA;;;;;GAKG;AACH,yCASsB;AACtB,kDAA4D;AAI5D;;;;;;;;;;;;;;;;GAgBG;AACH,MAAqB,eAAe;IAEhC;;;OAGG;IACH,YAAmB,GAAW;QAAX,QAAG,GAAH,GAAG,CAAQ;IAAG,CAAC;IAElC;;OAEG;IACH,KAAK,CAAC,OAA4D;QAC9D,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;QAC3C,iBAAiB;QACjB,IAAI,CAAC,MAAM;YAAE,IAAI,0BAAkB,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEzD,+CAA+C;QAC/C,MAAM,QAAQ,GAAa,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;QAE3D,sCAAsC;QACtC,OAAO,QAAQ,CAAC;IACpB,CAAC;IAEO,UAAU,CAAC,cAA8B;QAE7C,MAAM,QAAQ,GAAa;YACvB,SAAS,EAAE,IAAI;YACf,QAAQ,EAAE,IAAI;YACd,UAAU,EAAE,EAAE;YACd,MAAM,EAAE,IAAI;YACZ,MAAM,EAAE,IAAI;SACf,CAAC;QAEF,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACpB,QAAQ,IAAI,CAAC,IAAI,EAAE;gBACf,KAAK,cAAK,CAAC,MAAM;oBACb,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC,KAAe,CAAC;oBACvC,MAAM;gBACV,KAAK,cAAK,CAAC,UAAU;oBACjB,IAAI,IAAI,YAAY,kBAAS;wBACzB,QAAQ,CAAC,SAAS,GAAG,IAAI,kBAAS,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;;wBAE7D,QAAQ,CAAC,SAAS,GAAG,IAAI,kBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBACnD,MAAM;gBACV,KAAK,cAAK,CAAC,SAAS;oBAChB,IAAI,IAAI,YAAY,iBAAQ;wBACxB,QAAQ,CAAC,QAAQ,GAAG,IAAI,iBAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;;wBAE1E,QAAQ,CAAC,QAAQ,GAAG,IAAI,iBAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC;oBACvE,MAAM;gBACV,KAAK,cAAK,CAAC,WAAW;oBAClB,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBAC/B,MAAM;gBACV,KAAK,cAAK,CAAC,MAAM;oBACb,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC,KAAe,CAAC;oBACvC,MAAM;aACb;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC;IACpB,CAAC;CACJ;AA7DD,kCA6DC"}

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

@@ -1,47 +0,0 @@
-/**
- * An array of string parser
- *
- * Created on March 15, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-import { Fullname, NameOrder } from '../../models';
-import { Parser } from './parser';
-/**
- * Represents an array string parser
- * @class
- * @implements {Parser<string[]>}
- *
- * 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 {string[]} raw data
-     */
-    constructor(raw: string[]);
-    /**
-     * Parses the raw data into a full name
-     */
-    parse(options: {
-        orderedBy: NameOrder;
-        bypass: boolean;
-    }): Fullname;
-    private distribute;
-}

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

@@ -1,95 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * An array of string parser
- *
- * Created on March 15, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
- */
-const models_1 = require("../../models");
-const validators_1 = require("../../validators");
-const core_1 = require("../../core");
-/**
- * Represents an array string parser
- * @class
- * @implements {Parser<string[]>}
- *
- * 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
- *
- */
-class ArrayStringParser {
-    /**
-     * Create a parser ready to parse the raw data
-     * @param {string[]} raw data
-     */
-    constructor(raw) {
-        this.raw = raw;
-    }
-    /**
-     * Parses the raw data into a full name
-     */
-    parse(options) {
-        // given this setting
-        const { orderedBy, bypass } = options;
-        // validate first
-        const raw = this.raw.map(n => n.trim()); // cleanup
-        const index = core_1.organizeNameIndex(orderedBy, raw.length);
-        if (!bypass)
-            new validators_1.ArrayStringValidator(index).validate(raw);
-        // then distribute all the elements accordingly
-        const fullname = this.distribute(raw, index);
-        // finally return high quality of data
-        return fullname;
-    }
-    distribute(raw, index) {
-        const fullname = {
-            firstname: null,
-            lastname: null,
-            middlename: [],
-            prefix: null,
-            suffix: null,
-        };
-        switch (raw.length) {
-            case 2: // first name + last name
-                fullname.firstname = new models_1.Firstname(raw[index.firstname]);
-                fullname.lastname = new models_1.Lastname(raw[index.lastname]);
-                break;
-            case 3: // first name + middle name + last name
-                fullname.firstname = new models_1.Firstname(raw[index.firstname]);
-                fullname.middlename.push(new models_1.Name(raw[index.middlename], models_1.Namon.MIDDLE_NAME));
-                fullname.lastname = new models_1.Lastname(raw[index.lastname]);
-                break;
-            case 4: // prefix + first name + middle name + last name
-                fullname.prefix = raw[index.prefix];
-                fullname.firstname = new models_1.Firstname(raw[index.firstname]);
-                fullname.middlename.push(new models_1.Name(raw[index.middlename], models_1.Namon.MIDDLE_NAME));
-                fullname.lastname = new models_1.Lastname(raw[index.lastname]);
-                break;
-            case 5: // prefix + first name + middle name + last name + suffix
-                fullname.prefix = raw[index.prefix];
-                fullname.firstname = new models_1.Firstname(raw[index.firstname]);
-                fullname.middlename.push(new models_1.Name(raw[index.middlename], models_1.Namon.MIDDLE_NAME));
-                fullname.lastname = new models_1.Lastname(raw[index.lastname]);
-                fullname.suffix = raw[index.suffix];
-                break;
-        }
-        return fullname;
-    }
-}
-exports.default = ArrayStringParser;
-//# sourceMappingURL=array-string.parser.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"array-string.parser.js","sourceRoot":"","sources":["../../../../src/core/parsers/array-string.parser.ts"],"names":[],"mappings":";;AAAA;;;;;GAKG;AACH,yCAUsB;AACtB,iDAAwD;AACxD,qCAA+C;AAI/C;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAqB,iBAAiB;IAElC;;;OAGG;IACH,YAAmB,GAAa;QAAb,QAAG,GAAH,GAAG,CAAU;IAAI,CAAC;IAErC;;OAEG;IACH,KAAK,CAAC,OAAkD;QAEpD,qBAAqB;QACrB,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;QAEtC,iBAAiB;QACjB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,UAAU;QACnD,MAAM,KAAK,GAAG,wBAAiB,CAAC,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;QACvD,IAAI,CAAC,MAAM;YAAE,IAAI,iCAAoB,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAE3D,+CAA+C;QAC/C,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAE7C,sCAAsC;QACtC,OAAO,QAAQ,CAAC;IACpB,CAAC;IAEO,UAAU,CAAC,GAAa,EAAE,KAAgB;QAE9C,MAAM,QAAQ,GAAa;YACvB,SAAS,EAAE,IAAI;YACf,QAAQ,EAAE,IAAI;YACd,UAAU,EAAE,EAAE;YACd,MAAM,EAAE,IAAI;YACZ,MAAM,EAAE,IAAI;SACf,CAAC;QAEF,QAAQ,GAAG,CAAC,MAAM,EAAE;YAChB,KAAK,CAAC,EAAE,yBAAyB;gBAC7B,QAAQ,CAAC,SAAS,GAAG,IAAI,kBAAS,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;gBACzD,QAAQ,CAAC,QAAQ,GAAG,IAAI,iBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;gBACtD,MAAM;YACV,KAAK,CAAC,EAAE,uCAAuC;gBAC3C,QAAQ,CAAC,SAAS,GAAG,IAAI,kBAAS,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;gBACzD,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,aAAI,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,cAAK,CAAC,WAAW,CAAC,CAAC,CAAC;gBAC7E,QAAQ,CAAC,QAAQ,GAAG,IAAI,iBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;gBACtD,MAAM;YACV,KAAK,CAAC,EAAE,gDAAgD;gBACpD,QAAQ,CAAC,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM,CAAW,CAAC;gBAC9C,QAAQ,CAAC,SAAS,GAAG,IAAI,kBAAS,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;gBACzD,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,aAAI,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,cAAK,CAAC,WAAW,CAAC,CAAC,CAAC;gBAC7E,QAAQ,CAAC,QAAQ,GAAG,IAAI,iBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;gBACtD,MAAM;YACV,KAAK,CAAC,EAAE,yDAAyD;gBAC7D,QAAQ,CAAC,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM,CAAW,CAAC;gBAC9C,QAAQ,CAAC,SAAS,GAAG,IAAI,kBAAS,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;gBACzD,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,aAAI,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,cAAK,CAAC,WAAW,CAAC,CAAC,CAAC;gBAC7E,QAAQ,CAAC,QAAQ,GAAG,IAAI,iBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;gBACtD,QAAQ,CAAC,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM,CAAW,CAAC;gBAC9C,MAAM;SACb;QACD,OAAO,QAAQ,CAAC;IACpB,CAAC;CACJ;AAhED,oCAgEC"}

package/dist/lib/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';