namefully 1.3.0 → 2.0.0

package/dist/{lib → cjs}/builder.js

@@ -1,16 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NameBuilder = void 0;
-const namefully_1 = require("./namefully");
-const validator_1 = require("./validator");
+const namefully_js_1 = require("./namefully.js");
+const validator_js_1 = require("./validator.js");
 class Builder {
+    prebuild;
+    postbuild;
+    preclear;
+    postclear;
+    queue = [];
+    instance = null;
     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;
@@ -45,11 +49,10 @@ class Builder {
         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.preclear?.(this.instance);
         this.queue = [];
-        (_b = this.postclear) === null || _b === void 0 ? void 0 : _b.call(this);
+        this.postclear?.();
         this.instance = null;
     }
 }
@@ -65,15 +68,14 @@ class NameBuilder extends Builder {
         return new NameBuilder(initialNames);
     }
     static use({ names, prebuild, postbuild, preclear, postclear, }) {
-        return new NameBuilder(names !== null && names !== void 0 ? names : [], prebuild, postbuild, preclear, postclear);
+        return new NameBuilder(names ?? [], prebuild, postbuild, preclear, postclear);
     }
     build(config) {
-        var _a, _b;
-        (_a = this.prebuild) === null || _a === void 0 ? void 0 : _a.call(this);
+        this.prebuild?.();
         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);
+        validator_js_1.ArrayNameValidator.create().validate(names);
+        this.instance = new namefully_js_1.Namefully(names, config);
+        this.postbuild?.(this.instance);
         return this.instance;
     }
 }

package/dist/cjs/config.js

@@ -0,0 +1,100 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Config = void 0;
+const types_js_1 = require("./types.js");
+const defaultName = 'default';
+const copyAlias = '_copy';
+class Config {
+    #name;
+    #orderedBy;
+    #separator;
+    #title;
+    #ending;
+    #bypass;
+    #surname;
+    static cache = new Map();
+    get orderedBy() {
+        return this.#orderedBy;
+    }
+    get separator() {
+        return this.#separator;
+    }
+    get title() {
+        return this.#title;
+    }
+    get ending() {
+        return this.#ending;
+    }
+    get bypass() {
+        return this.#bypass;
+    }
+    get surname() {
+        return this.#surname;
+    }
+    get name() {
+        return this.#name;
+    }
+    constructor(name, orderedBy = types_js_1.NameOrder.FIRST_NAME, separator = types_js_1.Separator.SPACE, title = types_js_1.Title.UK, ending = false, bypass = true, surname = types_js_1.Surname.FATHER) {
+        this.#name = name;
+        this.#orderedBy = orderedBy;
+        this.#separator = separator;
+        this.#title = title;
+        this.#ending = ending;
+        this.#bypass = bypass;
+        this.#surname = surname;
+    }
+    static create(name = defaultName) {
+        if (!_a.cache.has(name))
+            _a.cache.set(name, new this(name));
+        return _a.cache.get(name);
+    }
+    static merge(other) {
+        if (!other) {
+            return _a.create();
+        }
+        else {
+            const config = _a.create(other.name);
+            config.#orderedBy = other.orderedBy ?? config.orderedBy;
+            config.#separator = other.separator ?? config.separator;
+            config.#title = other.title ?? config.title;
+            config.#ending = other.ending ?? config.ending;
+            config.#bypass = other.bypass ?? config.bypass;
+            config.#surname = other.surname ?? config.surname;
+            return config;
+        }
+    }
+    copyWith(options = {}) {
+        const { name, orderedBy, separator, title, ending, bypass, surname } = options;
+        const config = _a.create(this.#genNewName(name ?? this.name + copyAlias));
+        config.#orderedBy = orderedBy ?? this.orderedBy;
+        config.#separator = separator ?? this.separator;
+        config.#title = title ?? this.title;
+        config.#ending = ending ?? this.ending;
+        config.#bypass = bypass ?? this.bypass;
+        config.#surname = surname ?? this.surname;
+        return config;
+    }
+    clone() {
+        return this.copyWith();
+    }
+    reset() {
+        this.#orderedBy = types_js_1.NameOrder.FIRST_NAME;
+        this.#separator = types_js_1.Separator.SPACE;
+        this.#title = types_js_1.Title.UK;
+        this.#ending = false;
+        this.#bypass = true;
+        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;
+        }
+    }
+    #genNewName(name) {
+        return name === this.name || _a.cache.has(name) ? this.#genNewName(name + copyAlias) : name;
+    }
+}
+exports.Config = Config;
+_a = Config;

package/dist/{lib → cjs}/constants.js

@@ -1,7 +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.3.0';
+exports.VERSION = '2.0.0';
 exports.MIN_NUMBER_OF_NAME_PARTS = 2;
 exports.MAX_NUMBER_OF_NAME_PARTS = 5;
 exports.ALLOWED_TOKENS = [

package/dist/{lib → cjs}/error.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UnknownError = exports.NotAllowedError = exports.ValidationError = exports.InputError = exports.NameError = exports.NameErrorType = void 0;
-const utils_1 = require("./utils");
+const utils_js_1 = require("./utils.js");
 var NameErrorType;
 (function (NameErrorType) {
     NameErrorType[NameErrorType["INPUT"] = 0] = "INPUT";
@@ -10,6 +10,8 @@ var NameErrorType;
     NameErrorType[NameErrorType["UNKNOWN"] = 3] = "UNKNOWN";
 })(NameErrorType || (exports.NameErrorType = NameErrorType = {}));
 class NameError extends Error {
+    source;
+    type;
     constructor(source, message, type = NameErrorType.UNKNOWN) {
         super(message);
         this.source = source;
@@ -22,14 +24,12 @@ class NameError extends Error {
             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(' ');
-        if ((0, utils_1.isStringArray)(this.source))
+        if ((0, utils_js_1.isStringArray)(this.source))
             input = this.source.join(' ');
         return input;
     }
     get hasMessage() {
-        return this.message && this.message.trim().length > 0;
+        return this.message.trim().length > 0;
     }
     toString() {
         let report = `${this.name} (${this.sourceAsString})`;
@@ -47,6 +47,7 @@ class InputError extends NameError {
 }
 exports.InputError = InputError;
 class ValidationError extends NameError {
+    nameType;
     constructor(error) {
         super(error.source, error.message, NameErrorType.VALIDATION);
         this.nameType = error.nameType;
@@ -61,6 +62,7 @@ class ValidationError extends NameError {
 }
 exports.ValidationError = ValidationError;
 class NotAllowedError extends NameError {
+    operation;
     constructor(error) {
         super(error.source, error.message, NameErrorType.NOT_ALLOWED);
         this.operation = error.operation;
@@ -77,6 +79,7 @@ class NotAllowedError extends NameError {
 }
 exports.NotAllowedError = NotAllowedError;
 class UnknownError extends NameError {
+    origin;
     constructor(error) {
         super(error.source, error.message, NameErrorType.UNKNOWN);
         this.origin = error.error;

package/dist/cjs/fullname.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FullName = void 0;
+const config_js_1 = require("./config.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;
+    #middleName = [];
+    #lastName;
+    #suffix;
+    #config;
+    constructor(options) {
+        this.#config = config_js_1.Config.merge(options);
+    }
+    get config() {
+        return this.#config;
+    }
+    get prefix() {
+        return this.#prefix;
+    }
+    get firstName() {
+        return this.#firstName;
+    }
+    get lastName() {
+        return this.#lastName;
+    }
+    get middleName() {
+        return this.#middleName;
+    }
+    get suffix() {
+        return this.#suffix;
+    }
+    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;
+        }
+        catch (error) {
+            if (error instanceof error_js_1.NameError)
+                throw error;
+            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)),
+            });
+        }
+    }
+    setPrefix(name) {
+        if (!name)
+            return this;
+        if (!this.#config.bypass)
+            validator_js_1.Validators.prefix.validate(name);
+        const prefix = name instanceof name_js_1.Name ? name.value : name;
+        this.#prefix = name_js_1.Name.prefix(this.#config.title === types_js_1.Title.US ? `${prefix}.` : prefix);
+        return this;
+    }
+    setFirstName(name) {
+        if (!this.#config.bypass)
+            validator_js_1.Validators.firstName.validate(name);
+        this.#firstName = name instanceof name_js_1.FirstName ? name : new name_js_1.FirstName(name);
+        return this;
+    }
+    setLastName(name) {
+        if (!this.#config.bypass)
+            validator_js_1.Validators.lastName.validate(name);
+        this.#lastName = name instanceof name_js_1.LastName ? name : new name_js_1.LastName(name);
+        return this;
+    }
+    setMiddleName(names) {
+        if (!Array.isArray(names))
+            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)));
+        return this;
+    }
+    setSuffix(name) {
+        if (!name)
+            return this;
+        if (!this.#config.bypass)
+            validator_js_1.Validators.suffix.validate(name);
+        this.#suffix = name_js_1.Name.suffix(name instanceof name_js_1.Name ? name.value : name);
+        return this;
+    }
+    has(namon) {
+        if (namon.equal(types_js_1.Namon.PREFIX))
+            return !!this.#prefix;
+        if (namon.equal(types_js_1.Namon.SUFFIX))
+            return !!this.#suffix;
+        return namon.equal(types_js_1.Namon.MIDDLE_NAME) ? this.#middleName.length > 0 : true;
+    }
+}
+exports.FullName = FullName;

package/dist/{lib → cjs}/index.js

@@ -13,20 +13,23 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 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; } });
-__exportStar(require("./error"), exports);
-__exportStar(require("./full-name"), exports);
-__exportStar(require("./name"), exports);
-__exportStar(require("./namefully"), exports);
-var parser_1 = require("./parser");
-Object.defineProperty(exports, "Parser", { enumerable: true, get: function () { return parser_1.Parser; } });
-__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;
+const namefully_js_1 = __importDefault(require("./namefully.js"));
+__exportStar(require("./builder.js"), exports);
+__exportStar(require("./config.js"), exports);
+var constants_js_1 = require("./constants.js");
+Object.defineProperty(exports, "version", { enumerable: true, get: function () { return constants_js_1.VERSION; } });
+__exportStar(require("./error.js"), exports);
+__exportStar(require("./fullname.js"), exports);
+__exportStar(require("./name.js"), exports);
+__exportStar(require("./namefully.js"), exports);
+var parser_js_1 = require("./parser.js");
+Object.defineProperty(exports, "Parser", { enumerable: true, get: function () { return parser_js_1.Parser; } });
+__exportStar(require("./types.js"), exports);
+var utils_js_1 = require("./utils.js");
+Object.defineProperty(exports, "NameIndex", { enumerable: true, get: function () { return utils_js_1.NameIndex; } });
+exports.default = namefully_js_1.default;

package/dist/cjs/name.js

@@ -0,0 +1,218 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNameArray = exports.LastName = exports.FirstName = exports.Name = void 0;
+const error_js_1 = require("./error.js");
+const types_js_1 = require("./types.js");
+const utils_js_1 = require("./utils.js");
+class Name {
+    type;
+    #namon;
+    initial;
+    capsRange;
+    constructor(value, type, capsRange) {
+        this.type = type;
+        this.capsRange = capsRange ?? types_js_1.CapsRange.INITIAL;
+        this.value = value;
+        if (capsRange)
+            this.caps(capsRange);
+    }
+    set value(newValue) {
+        this.validate(newValue);
+        this.#namon = newValue;
+        this.initial = newValue[0];
+    }
+    get value() {
+        return this.#namon;
+    }
+    get length() {
+        return this.#namon.length;
+    }
+    get isPrefix() {
+        return this.type === types_js_1.Namon.PREFIX;
+    }
+    get isFirstName() {
+        return this.type === types_js_1.Namon.FIRST_NAME;
+    }
+    get isMiddleName() {
+        return this.type === types_js_1.Namon.MIDDLE_NAME;
+    }
+    get isLastName() {
+        return this.type === types_js_1.Namon.LAST_NAME;
+    }
+    get isSuffix() {
+        return this.type === types_js_1.Namon.SUFFIX;
+    }
+    static prefix(value) {
+        return new this(value, types_js_1.Namon.PREFIX);
+    }
+    static first(value) {
+        return new this(value, types_js_1.Namon.FIRST_NAME);
+    }
+    static middle(value) {
+        return new this(value, types_js_1.Namon.MIDDLE_NAME);
+    }
+    static last(value) {
+        return new this(value, types_js_1.Namon.LAST_NAME);
+    }
+    static suffix(value) {
+        return new this(value, types_js_1.Namon.SUFFIX);
+    }
+    initials() {
+        return [this.initial];
+    }
+    toString() {
+        return this.#namon;
+    }
+    equal(other) {
+        return other instanceof Name && other.value === this.value && other.type === this.type;
+    }
+    caps(range) {
+        this.value = (0, utils_js_1.capitalize)(this.#namon, range ?? this.capsRange);
+        return this;
+    }
+    decaps(range) {
+        this.value = (0, utils_js_1.decapitalize)(this.#namon, range ?? this.capsRange);
+        return this;
+    }
+    validate(name) {
+        if (name && name?.trim()?.length < 2) {
+            throw new error_js_1.InputError({ source: name, message: 'must be 2+ characters' });
+        }
+    }
+}
+exports.Name = Name;
+class FirstName extends Name {
+    #more;
+    constructor(value, ...more) {
+        super(value, types_js_1.Namon.FIRST_NAME);
+        more.forEach((n) => this.validate(n));
+        this.#more = more;
+    }
+    get hasMore() {
+        return this.#more.length > 0;
+    }
+    get length() {
+        return super.length + (this.hasMore ? this.#more.reduce((acc, n) => acc + n).length : 0);
+    }
+    get asNames() {
+        const names = [Name.first(this.value)];
+        if (this.hasMore) {
+            names.push(...this.#more.map((n) => Name.first(n)));
+        }
+        return names;
+    }
+    get more() {
+        return this.#more;
+    }
+    toString(withMore = false) {
+        return withMore && this.hasMore ? `${this.value} ${this.#more.join(' ')}`.trim() : this.value;
+    }
+    initials(withMore = false) {
+        const inits = [this.initial];
+        if (withMore && this.hasMore) {
+            inits.push(...this.#more.map((n) => n[0]));
+        }
+        return inits;
+    }
+    caps(range) {
+        range = range || this.capsRange;
+        this.value = (0, utils_js_1.capitalize)(this.value, range);
+        if (this.hasMore)
+            this.#more = this.#more.map((n) => (0, utils_js_1.capitalize)(n, range));
+        return this;
+    }
+    decaps(range) {
+        range = range || this.capsRange;
+        this.value = (0, utils_js_1.decapitalize)(this.value, range);
+        if (this.hasMore)
+            this.#more = this.#more.map((n) => (0, utils_js_1.decapitalize)(n, range));
+        return this;
+    }
+    copyWith(values) {
+        return new FirstName(values?.first ?? this.value, ...(values?.more ?? this.#more));
+    }
+}
+exports.FirstName = FirstName;
+class LastName extends Name {
+    format;
+    #mother;
+    constructor(father, mother, format = types_js_1.Surname.FATHER) {
+        super(father, types_js_1.Namon.LAST_NAME);
+        this.format = format;
+        this.validate(mother);
+        this.#mother = mother;
+    }
+    get father() {
+        return this.value;
+    }
+    get mother() {
+        return this.#mother;
+    }
+    get hasMother() {
+        return !!this.#mother;
+    }
+    get length() {
+        return super.length + (this.#mother?.length ?? 0);
+    }
+    get asNames() {
+        const names = [Name.last(this.value)];
+        if (this.#mother)
+            names.push(Name.last(this.#mother));
+        return names;
+    }
+    toString(format) {
+        format = format ?? this.format;
+        switch (format) {
+            case types_js_1.Surname.FATHER:
+                return this.value;
+            case types_js_1.Surname.MOTHER:
+                return this.mother ?? '';
+            case types_js_1.Surname.HYPHENATED:
+                return this.hasMother ? `${this.value}-${this.#mother}` : this.value;
+            case types_js_1.Surname.ALL:
+                return this.hasMother ? `${this.value} ${this.#mother}` : this.value;
+        }
+    }
+    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;
+            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:
+            default:
+                inits.push(this.initial);
+        }
+        return inits;
+    }
+    caps(range) {
+        range = 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;
+        this.value = (0, utils_js_1.decapitalize)(this.value, range);
+        if (this.hasMother)
+            this.#mother = (0, utils_js_1.decapitalize)(this.#mother, range);
+        return this;
+    }
+    copyWith(values) {
+        return new LastName(values?.father ?? this.value, values?.mother ?? this.mother, values?.format ?? this.format);
+    }
+}
+exports.LastName = LastName;
+function isNameArray(value) {
+    return Array.isArray(value) && value.length > 0 && value.every((e) => e instanceof Name);
+}
+exports.isNameArray = isNameArray;