namefully 1.2.1 → 1.3.1

package/dist/lib/builder.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NameBuilder = void 0;
+const namefully_1 = require("./namefully");
+const validator_1 = require("./validator");
+class Builder {
+    constructor(prebuild, postbuild, preclear, postclear) {
+        this.prebuild = prebuild;
+        this.postbuild = postbuild;
+        this.preclear = preclear;
+        this.postclear = postclear;
+        this.queue = [];
+        this.instance = null;
+    }
+    get size() {
+        return this.queue.length;
+    }
+    removeFirst() {
+        return this.queue.length > 0 ? this.queue.shift() : undefined;
+    }
+    removeLast() {
+        return this.queue.length > 0 ? this.queue.pop() : undefined;
+    }
+    addFirst(value) {
+        this.queue.unshift(value);
+    }
+    addLast(value) {
+        this.queue.push(value);
+    }
+    add(...values) {
+        this.queue.push(...values);
+    }
+    remove(value) {
+        const index = this.queue.indexOf(value);
+        if (index !== -1) {
+            this.queue.splice(index, 1);
+            return true;
+        }
+        return false;
+    }
+    removeWhere(callback) {
+        this.queue = this.queue.filter((item) => !callback(item));
+    }
+    retainWhere(callback) {
+        this.queue = this.queue.filter(callback);
+    }
+    clear() {
+        var _a, _b;
+        if (this.instance !== null)
+            (_a = this.preclear) === null || _a === void 0 ? void 0 : _a.call(this, this.instance);
+        this.queue = [];
+        (_b = this.postclear) === null || _b === void 0 ? void 0 : _b.call(this);
+        this.instance = null;
+    }
+}
+class NameBuilder extends Builder {
+    constructor(names, prebuild, postbuild, preclear, postclear) {
+        super(prebuild, postbuild, preclear, postclear);
+        this.add(...names);
+    }
+    static create(name) {
+        return new NameBuilder(name ? [name] : []);
+    }
+    static of(...initialNames) {
+        return new NameBuilder(initialNames);
+    }
+    static use({ names, prebuild, postbuild, preclear, postclear, }) {
+        return new NameBuilder(names !== null && names !== void 0 ? names : [], prebuild, postbuild, preclear, postclear);
+    }
+    build(config) {
+        var _a, _b;
+        (_a = this.prebuild) === null || _a === void 0 ? void 0 : _a.call(this);
+        const names = [...this.queue];
+        validator_1.ArrayNameValidator.create().validate(names);
+        this.instance = new namefully_1.Namefully(names, config);
+        (_b = this.postbuild) === null || _b === void 0 ? void 0 : _b.call(this, this.instance);
+        return this.instance;
+    }
+}
+exports.NameBuilder = NameBuilder;

package/dist/lib/config.js

@@ -99,10 +99,16 @@ class Config {
         __classPrivateFieldSet(this, _Config_surname, types_1.Surname.FATHER, "f");
         _a.cache.set(this.name, this);
     }
-    updateOrder(order) {
-        if (order && order !== __classPrivateFieldGet(this, _Config_orderedBy, "f")) {
-            __classPrivateFieldSet(_a.cache.get(this.name), _Config_orderedBy, order, "f");
-        }
+    update({ orderedBy, title, ending }) {
+        const config = _a.cache.get(this.name);
+        if (!config)
+            return;
+        if (orderedBy !== __classPrivateFieldGet(this, _Config_orderedBy, "f"))
+            __classPrivateFieldSet(config, _Config_orderedBy, orderedBy, "f");
+        if (title !== __classPrivateFieldGet(this, _Config_title, "f"))
+            __classPrivateFieldSet(config, _Config_title, title, "f");
+        if (ending !== __classPrivateFieldGet(this, _Config_ending, "f"))
+            __classPrivateFieldSet(config, _Config_ending, ending, "f");
     }
 }
 exports.Config = Config;

package/dist/lib/constants.js

@@ -1,30 +1,7 @@
 "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 = '1.2.1';
+exports.ALLOWED_FORMAT_TOKENS = exports.MAX_NUMBER_OF_NAME_PARTS = exports.MIN_NUMBER_OF_NAME_PARTS = exports.VERSION = void 0;
+exports.VERSION = '1.3.1';
 exports.MIN_NUMBER_OF_NAME_PARTS = 2;
 exports.MAX_NUMBER_OF_NAME_PARTS = 5;
-exports.ALLOWED_TOKENS = [
-    '.',
-    ',',
-    ' ',
-    '-',
-    '_',
-    'b',
-    'B',
-    'f',
-    'F',
-    'l',
-    'L',
-    'm',
-    'M',
-    'n',
-    'N',
-    'o',
-    'O',
-    'p',
-    'P',
-    's',
-    'S',
-    '$',
-];
+exports.ALLOWED_FORMAT_TOKENS = ` .,_-()[]<>'"bBfFlLmMnNoOpPsS$`;

package/dist/lib/error.js

@@ -17,19 +17,14 @@ class NameError extends Error {
         this.name = 'NameError';
     }
     get sourceAsString() {
-        let input = '';
-        if (!this.source)
-            input = '<undefined>';
         if (typeof this.source === 'string')
-            input = this.source;
-        if ((0, utils_1.isNameArray)(this.source))
-            input = this.source.map((n) => n.toString()).join(' ');
+            return this.source;
         if ((0, utils_1.isStringArray)(this.source))
-            input = this.source.join(' ');
-        return input;
+            return this.source.join(' ');
+        return '<undefined>';
     }
     get hasMessage() {
-        return this.message && this.message.trim().length > 0;
+        return this.message.trim().length > 0;
     }
     toString() {
         let report = `${this.name} (${this.sourceAsString})`;
@@ -79,7 +74,7 @@ exports.NotAllowedError = NotAllowedError;
 class UnknownError extends NameError {
     constructor(error) {
         super(error.source, error.message, NameErrorType.UNKNOWN);
-        this.origin = error.error;
+        this.origin = error.origin;
         this.name = 'UnknownError';
     }
     toString() {

package/dist/lib/full-name.js

@@ -14,10 +14,10 @@ var _FullName_prefix, _FullName_firstName, _FullName_middleName, _FullName_lastN
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FullName = void 0;
 const config_1 = require("./config");
+const validator_1 = require("./validator");
+const types_1 = require("./types");
 const error_1 = require("./error");
 const name_1 = require("./name");
-const types_1 = require("./types");
-const validator_1 = require("./validator");
 class FullName {
     constructor(options) {
         _FullName_prefix.set(this, void 0);
@@ -47,14 +47,15 @@ class FullName {
         return __classPrivateFieldGet(this, _FullName_suffix, "f");
     }
     static parse(json, config) {
+        var _a;
         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;
+            const { prefix, firstName: fn, middleName: mn, lastName: ln, suffix } = json;
+            return new FullName(config)
+                .setPrefix(prefix)
+                .setFirstName(typeof fn === 'string' ? fn : new name_1.FirstName(fn.value, ...((_a = fn.more) !== null && _a !== void 0 ? _a : [])))
+                .setMiddleName(typeof mn === 'string' ? [mn] : (mn !== null && mn !== void 0 ? mn : []))
+                .setLastName(typeof ln === 'string' ? ln : new name_1.LastName(ln.father, ln.mother))
+                .setSuffix(suffix);
         }
         catch (error) {
             if (error instanceof error_1.NameError)
@@ -62,7 +63,7 @@ class FullName {
             throw new error_1.UnknownError({
                 source: Object.values(json).join(' '),
                 message: 'could not parse JSON content',
-                error,
+                origin: error instanceof Error ? error : new Error(String(error)),
             });
         }
     }
@@ -72,7 +73,7 @@ class FullName {
         if (!__classPrivateFieldGet(this, _FullName_config, "f").bypass)
             validator_1.Validators.prefix.validate(name);
         const prefix = name instanceof name_1.Name ? name.value : name;
-        __classPrivateFieldSet(this, _FullName_prefix, name_1.Name.prefix(__classPrivateFieldGet(this, _FullName_config, "f").title === types_1.Title.US ? `${prefix}.` : prefix), "f");
+        __classPrivateFieldSet(this, _FullName_prefix, name_1.Name.prefix(__classPrivateFieldGet(this, _FullName_config, "f").title === types_1.Title.US && !prefix.endsWith('.') ? `${prefix}.` : prefix), "f");
         return this;
     }
     setFirstName(name) {
@@ -92,7 +93,7 @@ class FullName {
             return this;
         if (!__classPrivateFieldGet(this, _FullName_config, "f").bypass)
             validator_1.Validators.middleName.validate(names);
-        __classPrivateFieldSet(this, _FullName_middleName, names.map((name) => (name instanceof name_1.Name ? name : name_1.Name.middle(name))), "f");
+        __classPrivateFieldSet(this, _FullName_middleName, names.map((n) => (n instanceof name_1.Name ? n : name_1.Name.middle(n))), "f");
         return this;
     }
     setSuffix(name) {
@@ -103,13 +104,37 @@ class FullName {
         __classPrivateFieldSet(this, _FullName_suffix, name_1.Name.suffix(name instanceof name_1.Name ? name.value : name), "f");
         return this;
     }
-    has(namon) {
+    has(key) {
+        const namon = typeof key === 'string' ? types_1.Namon.cast(key) : key;
+        if (!namon)
+            return false;
         if (namon.equal(types_1.Namon.PREFIX))
             return !!__classPrivateFieldGet(this, _FullName_prefix, "f");
         if (namon.equal(types_1.Namon.SUFFIX))
             return !!__classPrivateFieldGet(this, _FullName_suffix, "f");
         return namon.equal(types_1.Namon.MIDDLE_NAME) ? __classPrivateFieldGet(this, _FullName_middleName, "f").length > 0 : true;
     }
+    toString() {
+        return Array.from(this.toIterable(true)).join(' ');
+    }
+    *toIterable(flat = false) {
+        if (__classPrivateFieldGet(this, _FullName_prefix, "f"))
+            yield __classPrivateFieldGet(this, _FullName_prefix, "f");
+        if (flat) {
+            yield* __classPrivateFieldGet(this, _FullName_firstName, "f").asNames;
+            yield* __classPrivateFieldGet(this, _FullName_middleName, "f");
+            yield* __classPrivateFieldGet(this, _FullName_lastName, "f").asNames;
+        }
+        else {
+            yield __classPrivateFieldGet(this, _FullName_firstName, "f");
+            yield* __classPrivateFieldGet(this, _FullName_middleName, "f");
+            yield __classPrivateFieldGet(this, _FullName_lastName, "f");
+        }
+        if (__classPrivateFieldGet(this, _FullName_suffix, "f"))
+            yield __classPrivateFieldGet(this, _FullName_suffix, "f");
+    }
+    *[(_FullName_prefix = new WeakMap(), _FullName_firstName = new WeakMap(), _FullName_middleName = new WeakMap(), _FullName_lastName = new WeakMap(), _FullName_suffix = new WeakMap(), _FullName_config = new WeakMap(), Symbol.iterator)]() {
+        yield* this.toIterable(true);
+    }
 }
 exports.FullName = FullName;
-_FullName_prefix = new WeakMap(), _FullName_firstName = new WeakMap(), _FullName_middleName = new WeakMap(), _FullName_lastName = new WeakMap(), _FullName_suffix = new WeakMap(), _FullName_config = new WeakMap();

package/dist/lib/index.js

@@ -15,6 +15,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NameIndex = exports.Parser = exports.version = void 0;
+const namefully_1 = require("./namefully");
+__exportStar(require("./builder"), exports);
 __exportStar(require("./config"), exports);
 var constants_1 = require("./constants");
 Object.defineProperty(exports, "version", { enumerable: true, get: function () { return constants_1.VERSION; } });
@@ -27,3 +29,4 @@ Object.defineProperty(exports, "Parser", { enumerable: true, get: function () {
 __exportStar(require("./types"), exports);
 var utils_1 = require("./utils");
 Object.defineProperty(exports, "NameIndex", { enumerable: true, get: function () { return utils_1.NameIndex; } });
+exports.default = namefully_1.default;

package/dist/lib/name.js

@@ -12,7 +12,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 };
 var _Name_namon, _FirstName_more, _LastName_mother;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LastName = exports.FirstName = exports.Name = void 0;
+exports.isNameArray = exports.LastName = exports.FirstName = exports.Name = void 0;
 const error_1 = require("./error");
 const types_1 = require("./types");
 const utils_1 = require("./utils");
@@ -52,19 +52,19 @@ class Name {
         return this.type === types_1.Namon.SUFFIX;
     }
     static prefix(value) {
-        return new this(value, types_1.Namon.PREFIX);
+        return new Name(value, types_1.Namon.PREFIX);
     }
     static first(value) {
-        return new this(value, types_1.Namon.FIRST_NAME);
+        return new Name(value, types_1.Namon.FIRST_NAME);
     }
     static middle(value) {
-        return new this(value, types_1.Namon.MIDDLE_NAME);
+        return new Name(value, types_1.Namon.MIDDLE_NAME);
     }
     static last(value) {
-        return new this(value, types_1.Namon.LAST_NAME);
+        return new Name(value, types_1.Namon.LAST_NAME);
     }
     static suffix(value) {
-        return new this(value, types_1.Namon.SUFFIX);
+        return new Name(value, types_1.Namon.SUFFIX);
     }
     initials() {
         return [this.initial];
@@ -84,8 +84,8 @@ class Name {
         return this;
     }
     validate(name) {
-        if ((name === null || name === void 0 ? void 0 : name.trim().length) < 2) {
-            throw new error_1.InputError({ source: name, message: 'must be 2+ characters' });
+        if (typeof name === 'string' && name.trim().length < 1) {
+            throw new error_1.InputError({ source: name, message: 'must be 1+ characters' });
         }
     }
 }
@@ -95,7 +95,7 @@ class FirstName extends Name {
     constructor(value, ...more) {
         super(value, types_1.Namon.FIRST_NAME);
         _FirstName_more.set(this, void 0);
-        more.forEach((n) => this.validate(n));
+        more.forEach(this.validate);
         __classPrivateFieldSet(this, _FirstName_more, more, "f");
     }
     get hasMore() {
@@ -106,9 +106,8 @@ class FirstName extends Name {
     }
     get asNames() {
         const names = [Name.first(this.value)];
-        if (this.hasMore) {
-            names.push(...__classPrivateFieldGet(this, _FirstName_more, "f").map((n) => Name.first(n)));
-        }
+        if (this.hasMore)
+            names.push(...__classPrivateFieldGet(this, _FirstName_more, "f").map(Name.first));
         return names;
     }
     get more() {
@@ -119,9 +118,8 @@ class FirstName extends Name {
     }
     initials(withMore = false) {
         const inits = [this.initial];
-        if (withMore && this.hasMore) {
+        if (withMore && this.hasMore)
             inits.push(...__classPrivateFieldGet(this, _FirstName_more, "f").map((n) => n[0]));
-        }
         return inits;
     }
     caps(range) {
@@ -140,7 +138,7 @@ class FirstName extends Name {
     }
     copyWith(values) {
         var _a, _b;
-        return new FirstName((_a = values.first) !== null && _a !== void 0 ? _a : this.value, ...((_b = values.more) !== null && _b !== void 0 ? _b : __classPrivateFieldGet(this, _FirstName_more, "f")));
+        return new FirstName((_a = values === null || values === void 0 ? void 0 : values.first) !== null && _a !== void 0 ? _a : this.value, ...((_b = values === null || values === void 0 ? void 0 : values.more) !== null && _b !== void 0 ? _b : __classPrivateFieldGet(this, _FirstName_more, "f")));
     }
 }
 exports.FirstName = FirstName;
@@ -168,9 +166,8 @@ class LastName extends Name {
     }
     get asNames() {
         const names = [Name.last(this.value)];
-        if (this.hasMother) {
+        if (__classPrivateFieldGet(this, _LastName_mother, "f"))
             names.push(Name.last(__classPrivateFieldGet(this, _LastName_mother, "f")));
-        }
         return names;
     }
     toString(format) {
@@ -183,39 +180,37 @@ class LastName extends Name {
                 return (_a = this.mother) !== null && _a !== void 0 ? _a : '';
             case types_1.Surname.HYPHENATED:
                 return this.hasMother ? `${this.value}-${__classPrivateFieldGet(this, _LastName_mother, "f")}` : this.value;
-            case types_1.Surname.ALL:
+            default:
                 return this.hasMother ? `${this.value} ${__classPrivateFieldGet(this, _LastName_mother, "f")}` : this.value;
         }
     }
     initials(format) {
-        format = format || this.format;
         const inits = [];
-        switch (format) {
-            case types_1.Surname.MOTHER:
-                if (this.hasMother)
-                    inits.push(__classPrivateFieldGet(this, _LastName_mother, "f")[0]);
-                break;
+        switch (format !== null && format !== void 0 ? format : this.format) {
             case types_1.Surname.HYPHENATED:
             case types_1.Surname.ALL:
                 inits.push(this.initial);
-                if (this.hasMother)
+                if (__classPrivateFieldGet(this, _LastName_mother, "f"))
+                    inits.push(__classPrivateFieldGet(this, _LastName_mother, "f")[0]);
+                break;
+            case types_1.Surname.MOTHER:
+                if (__classPrivateFieldGet(this, _LastName_mother, "f"))
                     inits.push(__classPrivateFieldGet(this, _LastName_mother, "f")[0]);
                 break;
-            case types_1.Surname.FATHER:
             default:
                 inits.push(this.initial);
         }
         return inits;
     }
     caps(range) {
-        range = range || this.capsRange;
+        range !== null && range !== void 0 ? range : (range = this.capsRange);
         this.value = (0, utils_1.capitalize)(this.value, range);
         if (this.hasMother)
             __classPrivateFieldSet(this, _LastName_mother, (0, utils_1.capitalize)(__classPrivateFieldGet(this, _LastName_mother, "f"), range), "f");
         return this;
     }
     decaps(range) {
-        range = range || this.capsRange;
+        range !== null && range !== void 0 ? range : (range = this.capsRange);
         this.value = (0, utils_1.decapitalize)(this.value, range);
         if (this.hasMother)
             __classPrivateFieldSet(this, _LastName_mother, (0, utils_1.decapitalize)(__classPrivateFieldGet(this, _LastName_mother, "f"), range), "f");
@@ -223,8 +218,12 @@ class LastName extends Name {
     }
     copyWith(values) {
         var _a, _b, _c;
-        return new LastName((_a = values.father) !== null && _a !== void 0 ? _a : this.value, (_b = values.mother) !== null && _b !== void 0 ? _b : this.mother, (_c = values.format) !== null && _c !== void 0 ? _c : this.format);
+        return new LastName((_a = values === null || values === void 0 ? void 0 : values.father) !== null && _a !== void 0 ? _a : this.value, (_b = values === null || values === void 0 ? void 0 : values.mother) !== null && _b !== void 0 ? _b : this.mother, (_c = values === null || values === void 0 ? void 0 : values.format) !== null && _c !== void 0 ? _c : this.format);
     }
 }
 exports.LastName = LastName;
 _LastName_mother = new WeakMap();
+function isNameArray(value) {
+    return Array.isArray(value) && value.length > 0 && value.every((e) => e instanceof Name);
+}
+exports.isNameArray = isNameArray;