namefully 1.3.0 → 2.0.0

package/dist/lib/namefully.js

@@ -1,417 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var _Namefully_instances, _Namefully_fullName, _Namefully_toParser, _Namefully_map;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Namefully = void 0;
-const constants_1 = require("./constants");
-const error_1 = require("./error");
-const parser_1 = require("./parser");
-const types_1 = require("./types");
-const utils_1 = require("./utils");
-class Namefully {
-    constructor(names, options) {
-        _Namefully_instances.add(this);
-        _Namefully_fullName.set(this, void 0);
-        __classPrivateFieldSet(this, _Namefully_fullName, __classPrivateFieldGet(this, _Namefully_instances, "m", _Namefully_toParser).call(this, names).parse(options), "f");
-    }
-    static tryParse(text, index) {
-        try {
-            return new Namefully(parser_1.Parser.build(text, index));
-        }
-        catch (_a) {
-            return undefined;
-        }
-    }
-    static parse(text, index) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return parser_1.Parser.buildAsync(text, index).then((parser) => new Namefully(parser));
-        });
-    }
-    get config() {
-        return __classPrivateFieldGet(this, _Namefully_fullName, "f").config;
-    }
-    get length() {
-        return this.birth.length;
-    }
-    get prefix() {
-        var _a;
-        return (_a = __classPrivateFieldGet(this, _Namefully_fullName, "f").prefix) === null || _a === void 0 ? void 0 : _a.toString();
-    }
-    get first() {
-        return this.firstName();
-    }
-    get middle() {
-        return this.hasMiddle ? this.middleName()[0] : undefined;
-    }
-    get hasMiddle() {
-        return __classPrivateFieldGet(this, _Namefully_fullName, "f").has(types_1.Namon.MIDDLE_NAME);
-    }
-    get last() {
-        return this.lastName();
-    }
-    get suffix() {
-        var _a;
-        return (_a = __classPrivateFieldGet(this, _Namefully_fullName, "f").suffix) === null || _a === void 0 ? void 0 : _a.toString();
-    }
-    get birth() {
-        return this.birthName();
-    }
-    get short() {
-        return this.shorten();
-    }
-    get long() {
-        return this.birth;
-    }
-    get full() {
-        return this.fullName();
-    }
-    get public() {
-        return this.format('f $l');
-    }
-    get salutation() {
-        return this.format('p l');
-    }
-    toString() {
-        return this.full;
-    }
-    get(namon) {
-        if (namon.equal(types_1.Namon.PREFIX))
-            return __classPrivateFieldGet(this, _Namefully_fullName, "f").prefix;
-        if (namon.equal(types_1.Namon.FIRST_NAME))
-            return __classPrivateFieldGet(this, _Namefully_fullName, "f").firstName;
-        if (namon.equal(types_1.Namon.MIDDLE_NAME))
-            return __classPrivateFieldGet(this, _Namefully_fullName, "f").middleName;
-        if (namon.equal(types_1.Namon.LAST_NAME))
-            return __classPrivateFieldGet(this, _Namefully_fullName, "f").lastName;
-        if (namon.equal(types_1.Namon.SUFFIX))
-            return __classPrivateFieldGet(this, _Namefully_fullName, "f").suffix;
-        return undefined;
-    }
-    equal(other) {
-        return this.toString() === other.toString();
-    }
-    toJson() {
-        return {
-            prefix: this.prefix,
-            firstName: this.first,
-            middleName: this.middleName(),
-            lastName: this.last,
-            suffix: this.suffix,
-        };
-    }
-    has(namon) {
-        return __classPrivateFieldGet(this, _Namefully_fullName, "f").has(namon);
-    }
-    fullName(orderedBy) {
-        const sep = this.config.ending ? ',' : '';
-        const names = [];
-        orderedBy = orderedBy || this.config.orderedBy;
-        if (this.prefix)
-            names.push(this.prefix);
-        if (orderedBy === types_1.NameOrder.FIRST_NAME) {
-            names.push(this.first, ...this.middleName(), this.last + sep);
-        }
-        else {
-            names.push(this.last, this.first, this.middleName().join(' ') + sep);
-        }
-        if (this.suffix)
-            names.push(this.suffix);
-        return names.join(' ').trim();
-    }
-    birthName(orderedBy) {
-        orderedBy = orderedBy || this.config.orderedBy;
-        return orderedBy === types_1.NameOrder.FIRST_NAME
-            ? [this.first, ...this.middleName(), this.last].join(' ')
-            : [this.last, this.first, ...this.middleName()].join(' ');
-    }
-    firstName(withMore = true) {
-        return __classPrivateFieldGet(this, _Namefully_fullName, "f").firstName.toString(withMore);
-    }
-    middleName() {
-        return __classPrivateFieldGet(this, _Namefully_fullName, "f").middleName.map((n) => n.value);
-    }
-    lastName(format) {
-        return __classPrivateFieldGet(this, _Namefully_fullName, "f").lastName.toString(format);
-    }
-    initials(options) {
-        const firstInits = __classPrivateFieldGet(this, _Namefully_fullName, "f").firstName.initials();
-        const midInits = __classPrivateFieldGet(this, _Namefully_fullName, "f").middleName.map((n) => n.initials()[0]);
-        const lastInits = __classPrivateFieldGet(this, _Namefully_fullName, "f").lastName.initials();
-        if (options === null || options === void 0 ? void 0 : options.asJson)
-            return { firstName: firstInits, middleName: midInits, lastName: lastInits };
-        const initials = [];
-        const { orderedBy = this.config.orderedBy, only = types_1.NameType.BIRTH_NAME } = options !== null && options !== void 0 ? options : {};
-        if (only !== types_1.NameType.BIRTH_NAME) {
-            if (only === types_1.NameType.FIRST_NAME) {
-                initials.push(...firstInits);
-            }
-            else if (only === types_1.NameType.MIDDLE_NAME) {
-                initials.push(...midInits);
-            }
-            else {
-                initials.push(...lastInits);
-            }
-        }
-        else if (orderedBy === types_1.NameOrder.FIRST_NAME) {
-            initials.push(...firstInits, ...midInits, ...lastInits);
-        }
-        else {
-            initials.push(...lastInits, ...firstInits, ...midInits);
-        }
-        return initials;
-    }
-    shorten(orderedBy) {
-        orderedBy = orderedBy || this.config.orderedBy;
-        return orderedBy === types_1.NameOrder.FIRST_NAME
-            ? [__classPrivateFieldGet(this, _Namefully_fullName, "f").firstName.value, __classPrivateFieldGet(this, _Namefully_fullName, "f").lastName.toString()].join(' ')
-            : [__classPrivateFieldGet(this, _Namefully_fullName, "f").lastName.toString(), __classPrivateFieldGet(this, _Namefully_fullName, "f").firstName.value].join(' ');
-    }
-    flatten(options) {
-        if (this.length <= options.limit)
-            return this.full;
-        const { by = types_1.Flat.MIDDLE_NAME, limit = 20, recursive = false, withMore = false, withPeriod = true, surname, } = options;
-        const sep = withPeriod ? '.' : '';
-        const fn = __classPrivateFieldGet(this, _Namefully_fullName, "f").firstName.toString();
-        const mn = this.middleName().join(' ');
-        const ln = __classPrivateFieldGet(this, _Namefully_fullName, "f").lastName.toString();
-        const hasMid = this.hasMiddle;
-        const f = __classPrivateFieldGet(this, _Namefully_fullName, "f").firstName.initials(withMore).join(sep + ' ') + sep;
-        const l = __classPrivateFieldGet(this, _Namefully_fullName, "f").lastName.initials(surname).join(sep + ' ') + sep;
-        const m = hasMid ? __classPrivateFieldGet(this, _Namefully_fullName, "f").middleName.map((n) => n.initials()[0]).join(sep + ' ') + sep : '';
-        let name = [];
-        if (this.config.orderedBy === types_1.NameOrder.FIRST_NAME) {
-            switch (by) {
-                case types_1.Flat.FIRST_NAME:
-                    name = hasMid ? [f, mn, ln] : [f, ln];
-                    break;
-                case types_1.Flat.LAST_NAME:
-                    name = hasMid ? [fn, mn, l] : [fn, l];
-                    break;
-                case types_1.Flat.MIDDLE_NAME:
-                    name = hasMid ? [fn, m, ln] : [fn, ln];
-                    break;
-                case types_1.Flat.FIRST_MID:
-                    name = hasMid ? [f, m, ln] : [f, ln];
-                    break;
-                case types_1.Flat.MID_LAST:
-                    name = hasMid ? [fn, m, l] : [fn, l];
-                    break;
-                case types_1.Flat.ALL:
-                    name = hasMid ? [f, m, l] : [f, l];
-                    break;
-            }
-        }
-        else {
-            switch (by) {
-                case types_1.Flat.FIRST_NAME:
-                    name = hasMid ? [ln, f, mn] : [ln, f];
-                    break;
-                case types_1.Flat.LAST_NAME:
-                    name = hasMid ? [l, fn, mn] : [l, fn];
-                    break;
-                case types_1.Flat.MIDDLE_NAME:
-                    name = hasMid ? [ln, fn, m] : [ln, fn];
-                    break;
-                case types_1.Flat.FIRST_MID:
-                    name = hasMid ? [ln, f, m] : [ln, f];
-                    break;
-                case types_1.Flat.MID_LAST:
-                    name = hasMid ? [l, fn, m] : [l, fn];
-                    break;
-                case types_1.Flat.ALL:
-                    name = hasMid ? [l, f, m] : [l, f];
-                    break;
-            }
-        }
-        const flat = name.join(' ');
-        if (recursive && flat.length > limit) {
-            const next = by === types_1.Flat.FIRST_NAME
-                ? types_1.Flat.MIDDLE_NAME
-                : by === types_1.Flat.MIDDLE_NAME
-                    ? types_1.Flat.LAST_NAME
-                    : by === types_1.Flat.LAST_NAME
-                        ? types_1.Flat.FIRST_MID
-                        : by === types_1.Flat.FIRST_MID
-                            ? types_1.Flat.MID_LAST
-                            : by === types_1.Flat.MID_LAST
-                                ? types_1.Flat.ALL
-                                : by === types_1.Flat.ALL
-                                    ? types_1.Flat.ALL
-                                    : by;
-            if (next === by)
-                return flat;
-            return this.flatten(Object.assign(Object.assign({}, options), { by: next }));
-        }
-        return flat;
-    }
-    zip(by = types_1.Flat.MID_LAST, withPeriod = true) {
-        return this.flatten({ limit: 0, by, withPeriod });
-    }
-    format(pattern) {
-        var _a;
-        if (pattern === 'short')
-            return this.short;
-        if (pattern === 'long')
-            return this.long;
-        if (pattern === 'public')
-            return this.public;
-        if (pattern === 'official')
-            pattern = 'o';
-        let group = '';
-        const formatted = [];
-        for (const char of pattern.split('')) {
-            if (constants_1.ALLOWED_TOKENS.indexOf(char) === -1) {
-                throw new error_1.NotAllowedError({
-                    source: this.full,
-                    operation: 'format',
-                    message: `unsupported character <${char}> from ${pattern}.`,
-                });
-            }
-            group += char;
-            if (char === '$')
-                continue;
-            formatted.push((_a = __classPrivateFieldGet(this, _Namefully_instances, "m", _Namefully_map).call(this, group)) !== null && _a !== void 0 ? _a : '');
-            group = '';
-        }
-        return formatted.join('').trim();
-    }
-    flip() {
-        this.config.updateOrder(this.config.orderedBy === types_1.NameOrder.FIRST_NAME ? types_1.NameOrder.LAST_NAME : types_1.NameOrder.FIRST_NAME);
-    }
-    split(separator = /[' -]/g) {
-        return this.birth.replace(separator, ' ').split(' ');
-    }
-    join(separator = '') {
-        return this.split().join(separator);
-    }
-    toUpperCase() {
-        return this.birth.toUpperCase();
-    }
-    toLowerCase() {
-        return this.birth.toLowerCase();
-    }
-    toCamelCase() {
-        return (0, utils_1.decapitalize)(this.toPascalCase());
-    }
-    toPascalCase() {
-        return this.split()
-            .map((n) => (0, utils_1.capitalize)(n))
-            .join('');
-    }
-    toSnakeCase() {
-        return this.split()
-            .map((n) => n.toLowerCase())
-            .join('_');
-    }
-    toHyphenCase() {
-        return this.split()
-            .map((n) => n.toLowerCase())
-            .join('-');
-    }
-    toDotCase() {
-        return this.split()
-            .map((n) => n.toLowerCase())
-            .join('.');
-    }
-    toToggleCase() {
-        return (0, utils_1.toggleCase)(this.birth);
-    }
-}
-exports.Namefully = Namefully;
-_Namefully_fullName = new WeakMap(), _Namefully_instances = new WeakSet(), _Namefully_toParser = function _Namefully_toParser(raw) {
-    if (raw instanceof parser_1.Parser)
-        return raw;
-    if (typeof raw === 'string')
-        return new parser_1.StringParser(raw);
-    if ((0, utils_1.isStringArray)(raw))
-        return new parser_1.ArrayStringParser(raw);
-    if ((0, utils_1.isNameArray)(raw))
-        return new parser_1.ArrayNameParser(raw);
-    if (typeof raw === 'object')
-        return new parser_1.NamaParser(raw);
-    throw new error_1.InputError({ source: raw, message: 'Cannot parse raw data. Review expected data types.' });
-}, _Namefully_map = function _Namefully_map(char) {
-    var _a, _b;
-    switch (char) {
-        case '.':
-        case ',':
-        case ' ':
-        case '-':
-        case '_':
-            return char;
-        case 'b':
-            return this.birth;
-        case 'B':
-            return this.birth.toUpperCase();
-        case 'f':
-            return this.first;
-        case 'F':
-            return this.first.toUpperCase();
-        case 'l':
-            return this.last;
-        case 'L':
-            return this.last.toUpperCase();
-        case 'm':
-        case 'M':
-            return char === 'm' ? this.middleName().join(' ') : this.middleName().join(' ').toUpperCase();
-        case 'o':
-        case 'O':
-            return ((character) => {
-                const sep = this.config.ending ? ',' : '', names = [];
-                if (this.prefix)
-                    names.push(this.prefix);
-                names.push(`${this.last},`.toUpperCase());
-                if (this.hasMiddle) {
-                    names.push(this.first, this.middleName().join(' ') + sep);
-                }
-                else {
-                    names.push(this.first + sep);
-                }
-                if (this.suffix)
-                    names.push(this.suffix);
-                const nama = names.join(' ').trim();
-                return character === 'o' ? nama : nama.toUpperCase();
-            })(char);
-        case 'p':
-            return this.prefix;
-        case 'P':
-            return (_a = this.prefix) === null || _a === void 0 ? void 0 : _a.toUpperCase();
-        case 's':
-            return this.suffix;
-        case 'S':
-            return (_b = this.suffix) === null || _b === void 0 ? void 0 : _b.toUpperCase();
-        case '$f':
-        case '$F':
-            return __classPrivateFieldGet(this, _Namefully_fullName, "f").firstName.initials()[0];
-        case '$l':
-        case '$L':
-            return __classPrivateFieldGet(this, _Namefully_fullName, "f").lastName.initials()[0];
-        case '$m':
-        case '$M':
-            return this.hasMiddle ? this.middle[0] : undefined;
-        default:
-            return undefined;
-    }
-};
-exports.default = (names, options) => {
-    return new Namefully(names, options);
-};

package/dist/lib/parser.js

@@ -1,144 +0,0 @@
-"use strict";
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _NamaParser_instances, _NamaParser_asNama;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ArrayNameParser = exports.NamaParser = exports.ArrayStringParser = exports.StringParser = exports.Parser = void 0;
-const full_name_1 = require("./full-name");
-const config_1 = require("./config");
-const utils_1 = require("./utils");
-const validator_1 = require("./validator");
-const name_1 = require("./name");
-const types_1 = require("./types");
-const error_1 = require("./error");
-class Parser {
-    constructor(raw) {
-        this.raw = raw;
-    }
-    static build(text, index) {
-        const parts = text.trim().split(types_1.Separator.SPACE.token);
-        const length = parts.length;
-        if (index instanceof utils_1.NameIndex) {
-            const names = Object.entries(index.toJson())
-                .filter(([, position]) => position > -1 && position < length)
-                .map(([key, position]) => new name_1.Name(parts[position], types_1.Namon.all.get(key)));
-            return new ArrayNameParser(names);
-        }
-        if (length < 2) {
-            throw new error_1.InputError({
-                source: text,
-                message: 'cannot build from invalid input',
-            });
-        }
-        else if (length === 2 || length === 3) {
-            return new StringParser(text);
-        }
-        else {
-            const last = parts.pop();
-            const [first, ...middles] = parts;
-            return new ArrayStringParser([first, middles.join(' '), last]);
-        }
-    }
-    static buildAsync(text, index) {
-        try {
-            return Promise.resolve(Parser.build(text, index));
-        }
-        catch (error) {
-            return Promise.reject(error);
-        }
-    }
-}
-exports.Parser = Parser;
-class StringParser extends Parser {
-    parse(options) {
-        const config = config_1.Config.merge(options);
-        const names = this.raw.split(config.separator.token);
-        return new ArrayStringParser(names).parse(options);
-    }
-}
-exports.StringParser = StringParser;
-class ArrayStringParser extends Parser {
-    parse(options) {
-        const config = config_1.Config.merge(options);
-        const fullName = new full_name_1.FullName(config);
-        const raw = this.raw.map((n) => n.trim());
-        const index = utils_1.NameIndex.when(config.orderedBy, raw.length);
-        const validator = new validator_1.ArrayStringValidator(index);
-        if (config.bypass) {
-            validator.validateIndex(raw);
-        }
-        else {
-            validator.validate(raw);
-        }
-        const { firstName, lastName, middleName, prefix, suffix } = index;
-        fullName.setFirstName(new name_1.FirstName(raw[firstName]));
-        fullName.setLastName(new name_1.LastName(raw[lastName]));
-        if (raw.length >= 3)
-            fullName.setMiddleName(raw[middleName].split(config.separator.token));
-        if (raw.length >= 4)
-            fullName.setPrefix(name_1.Name.prefix(raw[prefix]));
-        if (raw.length === 5)
-            fullName.setSuffix(name_1.Name.suffix(raw[suffix]));
-        return fullName;
-    }
-}
-exports.ArrayStringParser = ArrayStringParser;
-class NamaParser extends Parser {
-    constructor() {
-        super(...arguments);
-        _NamaParser_instances.add(this);
-    }
-    parse(options) {
-        const config = config_1.Config.merge(options);
-        if (config.bypass) {
-            validator_1.NamaValidator.create().validateKeys(__classPrivateFieldGet(this, _NamaParser_instances, "m", _NamaParser_asNama).call(this));
-        }
-        else {
-            validator_1.NamaValidator.create().validate(__classPrivateFieldGet(this, _NamaParser_instances, "m", _NamaParser_asNama).call(this));
-        }
-        return full_name_1.FullName.parse(this.raw, config);
-    }
-}
-exports.NamaParser = NamaParser;
-_NamaParser_instances = new WeakSet(), _NamaParser_asNama = function _NamaParser_asNama() {
-    return new Map(Object.entries(this.raw).map(([key, value]) => {
-        const namon = types_1.Namon.cast(key);
-        if (!namon) {
-            throw new error_1.InputError({
-                source: Object.values(this.raw).join(' '),
-                message: `unsupported key "${key}"`,
-            });
-        }
-        return [namon, value];
-    }));
-};
-class ArrayNameParser extends Parser {
-    parse(options) {
-        const config = config_1.Config.merge(options);
-        const fullName = new full_name_1.FullName(config);
-        validator_1.ArrayNameValidator.create().validate(this.raw);
-        for (const name of this.raw) {
-            if (name.isPrefix) {
-                fullName.setPrefix(name);
-            }
-            else if (name.isSuffix) {
-                fullName.setSuffix(name);
-            }
-            else if (name.isFirstName) {
-                fullName.setFirstName(name instanceof name_1.FirstName ? name : new name_1.FirstName(name.value));
-            }
-            else if (name.isMiddleName) {
-                fullName.middleName.push(name);
-            }
-            else if (name.isLastName) {
-                const lastName = new name_1.LastName(name.value, name instanceof name_1.LastName ? name.mother : undefined, config.surname);
-                fullName.setLastName(lastName);
-            }
-        }
-        return fullName;
-    }
-}
-exports.ArrayNameParser = ArrayNameParser;