namefully 2.0.0 → 2.0.2

package/dist/cjs/config.js

@@ -46,7 +46,7 @@ class Config {
     }
     static create(name = defaultName) {
         if (!_a.cache.has(name))
-            _a.cache.set(name, new this(name));
+            _a.cache.set(name, new _a(name));
         return _a.cache.get(name);
     }
     static merge(other) {
@@ -87,10 +87,19 @@ class Config {
         this.#surname = types_js_1.Surname.FATHER;
         _a.cache.set(this.name, this);
     }
-    updateOrder(order) {
-        if (order && order !== this.#orderedBy) {
-            _a.cache.get(this.name).#orderedBy = order;
-        }
+    updateOrder(orderedBy) {
+        this.update({ orderedBy });
+    }
+    update({ orderedBy, title, ending }) {
+        const config = _a.cache.get(this.name);
+        if (!config)
+            return;
+        if (orderedBy !== this.#orderedBy)
+            config.#orderedBy = orderedBy;
+        if (title !== this.#title)
+            config.#title = title;
+        if (ending !== this.#ending)
+            config.#ending = ending;
     }
     #genNewName(name) {
         return name === this.name || _a.cache.has(name) ? this.#genNewName(name + copyAlias) : name;

package/dist/cjs/constants.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ALLOWED_TOKENS = exports.MAX_NUMBER_OF_NAME_PARTS = exports.MIN_NUMBER_OF_NAME_PARTS = exports.VERSION = void 0;
-exports.VERSION = '2.0.0';
+exports.ALLOWED_FORMAT_TOKENS = exports.MAX_NUMBER_OF_NAME_PARTS = exports.MIN_NUMBER_OF_NAME_PARTS = exports.VERSION = void 0;
+exports.VERSION = '2.0.2';
 exports.MIN_NUMBER_OF_NAME_PARTS = 2;
 exports.MAX_NUMBER_OF_NAME_PARTS = 5;
-exports.ALLOWED_TOKENS = [
+exports.ALLOWED_FORMAT_TOKENS = [
     '.',
     ',',
     ' ',

package/dist/cjs/error.js

@@ -19,14 +19,11 @@ class NameError extends Error {
         this.name = 'NameError';
     }
     get sourceAsString() {
-        let input = '';
-        if (!this.source)
-            input = '<undefined>';
         if (typeof this.source === 'string')
-            input = this.source;
+            return this.source;
         if ((0, utils_js_1.isStringArray)(this.source))
-            input = this.source.join(' ');
-        return input;
+            return this.source.join(' ');
+        return '<undefined>';
     }
     get hasMessage() {
         return this.message.trim().length > 0;
@@ -82,7 +79,7 @@ class UnknownError extends NameError {
     origin;
     constructor(error) {
         super(error.source, error.message, NameErrorType.UNKNOWN);
-        this.origin = error.error;
+        this.origin = error.origin;
         this.name = 'UnknownError';
     }
     toString() {

package/dist/cjs/fullname.js

@@ -2,10 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FullName = void 0;
 const config_js_1 = require("./config.js");
+const validator_js_1 = require("./validator.js");
+const types_js_1 = require("./types.js");
 const error_js_1 = require("./error.js");
 const name_js_1 = require("./name.js");
-const types_js_1 = require("./types.js");
-const validator_js_1 = require("./validator.js");
 class FullName {
     #prefix;
     #firstName;
@@ -36,13 +36,12 @@ class FullName {
     }
     static parse(json, config) {
         try {
-            const fullName = new FullName(config);
-            fullName.setPrefix(json.prefix);
-            fullName.setFirstName(json.firstName);
-            fullName.setMiddleName(json.middleName ?? []);
-            fullName.setLastName(json.lastName);
-            fullName.setSuffix(json.suffix);
-            return fullName;
+            return new FullName(config)
+                .setPrefix(json.prefix)
+                .setFirstName(json.firstName)
+                .setMiddleName(json.middleName ?? [])
+                .setLastName(json.lastName)
+                .setSuffix(json.suffix);
         }
         catch (error) {
             if (error instanceof error_js_1.NameError)
@@ -50,7 +49,7 @@ class FullName {
             throw new error_js_1.UnknownError({
                 source: Object.values(json).join(' '),
                 message: 'could not parse JSON content',
-                error: error instanceof Error ? error : new Error(String(error)),
+                origin: error instanceof Error ? error : new Error(String(error)),
             });
         }
     }
@@ -80,7 +79,7 @@ class FullName {
             return this;
         if (!this.#config.bypass)
             validator_js_1.Validators.middleName.validate(names);
-        this.#middleName = names.map((name) => (name instanceof name_js_1.Name ? name : name_js_1.Name.middle(name)));
+        this.#middleName = names.map((n) => (n instanceof name_js_1.Name ? n : name_js_1.Name.middle(n)));
         return this;
     }
     setSuffix(name) {

package/dist/cjs/name.js

@@ -43,19 +43,19 @@ class Name {
         return this.type === types_js_1.Namon.SUFFIX;
     }
     static prefix(value) {
-        return new this(value, types_js_1.Namon.PREFIX);
+        return new Name(value, types_js_1.Namon.PREFIX);
     }
     static first(value) {
-        return new this(value, types_js_1.Namon.FIRST_NAME);
+        return new Name(value, types_js_1.Namon.FIRST_NAME);
     }
     static middle(value) {
-        return new this(value, types_js_1.Namon.MIDDLE_NAME);
+        return new Name(value, types_js_1.Namon.MIDDLE_NAME);
     }
     static last(value) {
-        return new this(value, types_js_1.Namon.LAST_NAME);
+        return new Name(value, types_js_1.Namon.LAST_NAME);
     }
     static suffix(value) {
-        return new this(value, types_js_1.Namon.SUFFIX);
+        return new Name(value, types_js_1.Namon.SUFFIX);
     }
     initials() {
         return [this.initial];
@@ -75,8 +75,8 @@ class Name {
         return this;
     }
     validate(name) {
-        if (name && name?.trim()?.length < 2) {
-            throw new error_js_1.InputError({ source: name, message: 'must be 2+ characters' });
+        if (typeof name === 'string' && name.trim().length < 1) {
+            throw new error_js_1.InputError({ source: name, message: 'must be 1+ characters' });
         }
     }
 }
@@ -85,7 +85,7 @@ class FirstName extends Name {
     #more;
     constructor(value, ...more) {
         super(value, types_js_1.Namon.FIRST_NAME);
-        more.forEach((n) => this.validate(n));
+        more.forEach(this.validate);
         this.#more = more;
     }
     get hasMore() {
@@ -96,9 +96,8 @@ class FirstName extends Name {
     }
     get asNames() {
         const names = [Name.first(this.value)];
-        if (this.hasMore) {
-            names.push(...this.#more.map((n) => Name.first(n)));
-        }
+        if (this.hasMore)
+            names.push(...this.#more.map(Name.first));
         return names;
     }
     get more() {
@@ -109,9 +108,8 @@ class FirstName extends Name {
     }
     initials(withMore = false) {
         const inits = [this.initial];
-        if (withMore && this.hasMore) {
+        if (withMore && this.hasMore)
             inits.push(...this.#more.map((n) => n[0]));
-        }
         return inits;
     }
     caps(range) {
@@ -174,34 +172,32 @@ class LastName extends Name {
         }
     }
     initials(format) {
-        format = format || this.format;
         const inits = [];
-        switch (format) {
-            case types_js_1.Surname.MOTHER:
-                if (this.#mother)
-                    inits.push(this.#mother[0]);
-                break;
+        switch (format ?? this.format) {
             case types_js_1.Surname.HYPHENATED:
             case types_js_1.Surname.ALL:
                 inits.push(this.initial);
                 if (this.#mother)
                     inits.push(this.#mother[0]);
                 break;
-            case types_js_1.Surname.FATHER:
+            case types_js_1.Surname.MOTHER:
+                if (this.#mother)
+                    inits.push(this.#mother[0]);
+                break;
             default:
                 inits.push(this.initial);
         }
         return inits;
     }
     caps(range) {
-        range = range || this.capsRange;
+        range ??= this.capsRange;
         this.value = (0, utils_js_1.capitalize)(this.value, range);
         if (this.hasMother)
             this.#mother = (0, utils_js_1.capitalize)(this.#mother, range);
         return this;
     }
     decaps(range) {
-        range = range || this.capsRange;
+        range ??= this.capsRange;
         this.value = (0, utils_js_1.decapitalize)(this.value, range);
         if (this.hasMother)
             this.#mother = (0, utils_js_1.decapitalize)(this.#mother, range);

package/dist/cjs/namefully.js

@@ -4,9 +4,9 @@ exports.Namefully = void 0;
 const constants_js_1 = require("./constants.js");
 const error_js_1 = require("./error.js");
 const name_js_1 = require("./name.js");
-const parser_js_1 = require("./parser.js");
 const types_js_1 = require("./types.js");
 const utils_js_1 = require("./utils.js");
+const parser_js_1 = require("./parser.js");
 class Namefully {
     #fullName;
     constructor(names, options) {
@@ -93,16 +93,16 @@ class Namefully {
             suffix: this.suffix,
         };
     }
+    json = this.toJson;
     has(namon) {
         return this.#fullName.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_js_1.NameOrder.FIRST_NAME) {
+        if ((orderedBy ?? this.config.orderedBy) === types_js_1.NameOrder.FIRST_NAME) {
             names.push(this.first, ...this.middleName(), this.last + sep);
         }
         else {
@@ -113,7 +113,7 @@ class Namefully {
         return names.join(' ').trim();
     }
     birthName(orderedBy) {
-        orderedBy = orderedBy || this.config.orderedBy;
+        orderedBy ??= this.config.orderedBy;
         return orderedBy === types_js_1.NameOrder.FIRST_NAME
             ? [this.first, ...this.middleName(), this.last].join(' ')
             : [this.last, this.first, ...this.middleName()].join(' ');
@@ -128,50 +128,42 @@ class Namefully {
         return this.#fullName.lastName.toString(format);
     }
     initials(options) {
+        const { orderedBy = this.config.orderedBy, only = types_js_1.NameType.BIRTH_NAME, asJson } = options ?? {};
         const firstInits = this.#fullName.firstName.initials();
-        const midInits = this.#fullName.middleName.map((n) => n.initials()[0]);
+        const midInits = this.#fullName.middleName.map((n) => n.value[0]);
         const lastInits = this.#fullName.lastName.initials();
-        if (options?.asJson)
+        if (asJson)
             return { firstName: firstInits, middleName: midInits, lastName: lastInits };
-        const initials = [];
-        const { orderedBy = this.config.orderedBy, only = types_js_1.NameType.BIRTH_NAME } = options ?? {};
         if (only !== types_js_1.NameType.BIRTH_NAME) {
-            if (only === types_js_1.NameType.FIRST_NAME) {
-                initials.push(...firstInits);
-            }
-            else if (only === types_js_1.NameType.MIDDLE_NAME) {
-                initials.push(...midInits);
-            }
-            else {
-                initials.push(...lastInits);
-            }
+            return only === types_js_1.NameType.FIRST_NAME ? firstInits : only === types_js_1.NameType.MIDDLE_NAME ? midInits : lastInits;
         }
         else if (orderedBy === types_js_1.NameOrder.FIRST_NAME) {
-            initials.push(...firstInits, ...midInits, ...lastInits);
+            return [...firstInits, ...midInits, ...lastInits];
         }
         else {
-            initials.push(...lastInits, ...firstInits, ...midInits);
+            return [...lastInits, ...firstInits, ...midInits];
         }
-        return initials;
     }
     shorten(orderedBy) {
-        orderedBy = orderedBy || this.config.orderedBy;
+        orderedBy ??= this.config.orderedBy;
+        const { firstName, lastName } = this.#fullName;
         return orderedBy === types_js_1.NameOrder.FIRST_NAME
-            ? [this.#fullName.firstName.value, this.#fullName.lastName.toString()].join(' ')
-            : [this.#fullName.lastName.toString(), this.#fullName.firstName.value].join(' ');
+            ? [firstName.value, lastName.toString()].join(' ')
+            : [lastName.toString(), firstName.value].join(' ');
     }
     flatten(options) {
         const { by = types_js_1.Flat.MIDDLE_NAME, limit = 20, recursive = false, withMore = false, withPeriod = true, surname, } = options;
         if (this.length <= limit)
             return this.full;
+        const { firstName, lastName, middleName } = this.#fullName;
         const sep = withPeriod ? '.' : '';
-        const fn = this.#fullName.firstName.toString();
-        const mn = this.middleName().join(' ');
-        const ln = this.#fullName.lastName.toString();
         const hasMid = this.hasMiddle;
-        const f = this.#fullName.firstName.initials(withMore).join(sep + ' ') + sep;
-        const l = this.#fullName.lastName.initials(surname).join(sep + ' ') + sep;
-        const m = hasMid ? this.#fullName.middleName.map((n) => n.initials()[0]).join(sep + ' ') + sep : '';
+        const fn = firstName.toString();
+        const mn = this.middleName().join(' ');
+        const ln = lastName.toString();
+        const f = firstName.initials(withMore).join(sep + ' ') + sep;
+        const l = lastName.initials(surname).join(sep + ' ') + sep;
+        const m = hasMid ? middleName.map((n) => n.value[0]).join(sep + ' ') + sep : '';
         let name = [];
         if (this.config.orderedBy === types_js_1.NameOrder.FIRST_NAME) {
             switch (by) {
@@ -252,8 +244,8 @@ class Namefully {
             pattern = 'o';
         let group = '';
         const formatted = [];
-        for (const char of pattern.split('')) {
-            if (constants_js_1.ALLOWED_TOKENS.indexOf(char) === -1) {
+        for (const char of pattern) {
+            if (constants_js_1.ALLOWED_FORMAT_TOKENS.indexOf(char) === -1) {
                 throw new error_js_1.NotAllowedError({
                     source: this.full,
                     operation: 'format',
@@ -269,7 +261,8 @@ class Namefully {
         return formatted.join('').trim();
     }
     flip() {
-        this.config.updateOrder(this.config.orderedBy === types_js_1.NameOrder.FIRST_NAME ? types_js_1.NameOrder.LAST_NAME : types_js_1.NameOrder.FIRST_NAME);
+        const order = this.config.orderedBy === types_js_1.NameOrder.FIRST_NAME ? types_js_1.NameOrder.LAST_NAME : types_js_1.NameOrder.FIRST_NAME;
+        this.config.update({ orderedBy: order });
     }
     split(separator = /[' -]/g) {
         return this.birth.replace(separator, ' ').split(' ');
@@ -320,7 +313,7 @@ class Namefully {
             return new parser_js_1.ArrayNameParser(raw);
         if (typeof raw === 'object')
             return new parser_js_1.NamaParser(raw);
-        throw new error_js_1.InputError({ source: raw, message: 'Cannot parse raw data. Review expected data types.' });
+        throw new error_js_1.InputError({ source: raw, message: 'Cannot parse raw data; review expected data types.' });
     }
     #map(char) {
         switch (char) {
@@ -348,16 +341,15 @@ class Namefully {
             case 'o':
             case 'O':
                 return ((character) => {
-                    const sep = this.config.ending ? ',' : '', names = [];
+                    const sep = this.config.ending ? ',' : '';
+                    const names = [];
                     if (this.prefix)
                         names.push(this.prefix);
                     names.push(`${this.last},`.toUpperCase());
-                    if (this.hasMiddle) {
+                    if (this.hasMiddle)
                         names.push(this.first, this.middleName().join(' ') + sep);
-                    }
-                    else {
+                    else
                         names.push(this.first + sep);
-                    }
                     if (this.suffix)
                         names.push(this.suffix);
                     const nama = names.join(' ').trim();
@@ -373,10 +365,10 @@ class Namefully {
                 return this.suffix?.toUpperCase();
             case '$f':
             case '$F':
-                return this.#fullName.firstName.initials()[0];
+                return this.#fullName.firstName.value[0];
             case '$l':
             case '$L':
-                return this.#fullName.lastName.initials()[0];
+                return this.#fullName.lastName.value[0];
             case '$m':
             case '$M':
                 return this.hasMiddle ? this.middle[0] : undefined;

package/dist/cjs/parser.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ArrayNameParser = exports.NamaParser = exports.ArrayStringParser = exports.StringParser = exports.Parser = void 0;
-const fullname_js_1 = require("./fullname.js");
 const config_js_1 = require("./config.js");
 const utils_js_1 = require("./utils.js");
-const validator_js_1 = require("./validator.js");
-const name_js_1 = require("./name.js");
-const types_js_1 = require("./types.js");
 const error_js_1 = require("./error.js");
+const fullname_js_1 = require("./fullname.js");
+const types_js_1 = require("./types.js");
+const name_js_1 = require("./name.js");
+const validator_js_1 = require("./validator.js");
 class Parser {
     raw;
     constructor(raw) {
@@ -17,7 +17,7 @@ class Parser {
         const parts = text.trim().split(types_js_1.Separator.SPACE.token);
         const length = parts.length;
         if (index instanceof utils_js_1.NameIndex) {
-            const names = Object.entries(index.toJson())
+            const names = Object.entries(index.json())
                 .filter(([, position]) => position > -1 && position < length)
                 .map(([key, position]) => new name_js_1.Name(parts[position], types_js_1.Namon.all.get(key)));
             return new ArrayNameParser(names);
@@ -84,16 +84,7 @@ exports.ArrayStringParser = ArrayStringParser;
 class NamaParser extends Parser {
     parse(options) {
         const config = config_js_1.Config.merge(options);
-        if (config.bypass) {
-            validator_js_1.NamaValidator.create().validateKeys(this.#asNama());
-        }
-        else {
-            validator_js_1.NamaValidator.create().validate(this.#asNama());
-        }
-        return fullname_js_1.FullName.parse(this.raw, config);
-    }
-    #asNama() {
-        return new Map(Object.entries(this.raw).map(([key, value]) => {
+        const names = new Map(Object.entries(this.raw).map(([key, value]) => {
             const namon = types_js_1.Namon.cast(key);
             if (!namon) {
                 throw new error_js_1.InputError({
@@ -103,6 +94,13 @@ class NamaParser extends Parser {
             }
             return [namon, value];
         }));
+        if (config.bypass) {
+            validator_js_1.NamaValidator.create().validateKeys(names);
+        }
+        else {
+            validator_js_1.NamaValidator.create().validate(names);
+        }
+        return fullname_js_1.FullName.parse(this.raw, config);
     }
 }
 exports.NamaParser = NamaParser;

package/dist/cjs/utils.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isStringArray = exports.toggleCase = exports.decapitalize = exports.capitalize = exports.NameIndex = void 0;
-const constants_js_1 = require("./constants.js");
 const types_js_1 = require("./types.js");
+const constants_js_1 = require("./constants.js");
 class NameIndex {
     prefix;
     firstName;
@@ -23,19 +23,19 @@ class NameIndex {
         this.suffix = suffix;
     }
     static base() {
-        return new this(-1, 0, -1, 1, -1);
+        return new NameIndex(-1, 0, -1, 1, -1);
     }
     static when(order, count = 2) {
         if (order === types_js_1.NameOrder.FIRST_NAME) {
             switch (count) {
                 case 2:
-                    return new this(-1, 0, -1, 1, -1);
+                    return new NameIndex(-1, 0, -1, 1, -1);
                 case 3:
-                    return new this(-1, 0, 1, 2, -1);
+                    return new NameIndex(-1, 0, 1, 2, -1);
                 case 4:
-                    return new this(0, 1, 2, 3, -1);
+                    return new NameIndex(0, 1, 2, 3, -1);
                 case 5:
-                    return new this(0, 1, 2, 3, 4);
+                    return new NameIndex(0, 1, 2, 3, 4);
                 default:
                     return NameIndex.base();
             }
@@ -43,20 +43,20 @@ class NameIndex {
         else {
             switch (count) {
                 case 2:
-                    return new this(-1, 1, -1, 0, -1);
+                    return new NameIndex(-1, 1, -1, 0, -1);
                 case 3:
-                    return new this(-1, 1, 2, 0, -1);
+                    return new NameIndex(-1, 1, 2, 0, -1);
                 case 4:
-                    return new this(0, 2, 3, 1, -1);
+                    return new NameIndex(0, 2, 3, 1, -1);
                 case 5:
-                    return new this(0, 2, 3, 1, 4);
+                    return new NameIndex(0, 2, 3, 1, 4);
                 default:
                     return NameIndex.base();
             }
         }
     }
     static only({ prefix = -1, firstName, middleName = -1, lastName, suffix = -1 }) {
-        return new this(prefix, firstName, middleName, lastName, suffix);
+        return new NameIndex(prefix, firstName, middleName, lastName, suffix);
     }
     toJson() {
         return {
@@ -67,35 +67,28 @@ class NameIndex {
             suffix: this.suffix,
         };
     }
+    json = this.toJson;
 }
 exports.NameIndex = NameIndex;
 function capitalize(str, range = types_js_1.CapsRange.INITIAL) {
     if (!str || range === types_js_1.CapsRange.NONE)
         return str;
-    const initial = str[0].toUpperCase();
-    const rest = str.slice(1).toLowerCase();
+    const [initial, rest] = [str[0].toUpperCase(), str.slice(1).toLowerCase()];
     return range === types_js_1.CapsRange.INITIAL ? initial.concat(rest) : str.toUpperCase();
 }
 exports.capitalize = capitalize;
 function decapitalize(str, range = types_js_1.CapsRange.INITIAL) {
     if (!str || range === types_js_1.CapsRange.NONE)
         return str;
-    const initial = str[0].toLowerCase();
-    const rest = str.slice(1);
+    const [initial, rest] = [str[0].toLowerCase(), str.slice(1)];
     return range === types_js_1.CapsRange.INITIAL ? initial.concat(rest) : str.toLowerCase();
 }
 exports.decapitalize = decapitalize;
 function toggleCase(str) {
-    const chars = [];
-    for (const c of str) {
-        if (c === c.toUpperCase()) {
-            chars.push(c.toLowerCase());
-        }
-        else {
-            chars.push(c.toUpperCase());
-        }
-    }
-    return chars.join('');
+    return str
+        .split('')
+        .map((c) => (c === c.toUpperCase() ? c.toLowerCase() : c.toUpperCase()))
+        .join('');
 }
 exports.toggleCase = toggleCase;
 function isStringArray(value) {