namefully 1.0.9 → 1.2.0

package/dist/lib/error.js

@@ -0,0 +1,210 @@
+"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");
+/**
+ * The error types supported by `Namefully`.
+ */
+var NameErrorType;
+(function (NameErrorType) {
+    /**
+     * Thrown when a name entry/argument is incorrect.
+     *
+     * For example, a name should have a minimum of 2 characters, so an empty
+     * string or a string of one character would cause this kind of error.
+     */
+    NameErrorType[NameErrorType["INPUT"] = 0] = "INPUT";
+    /**
+     * Thrown when the name components do not match the validation rules if the
+     * `Config.bypass` is not flagged up. This bypass option skips the validation
+     * rules.
+     *
+     * See also: `ValidationError`
+     */
+    NameErrorType[NameErrorType["VALIDATION"] = 1] = "VALIDATION";
+    /**
+     * Thrown by not allowed operations such as in NameBuilder or name formatting.
+     *
+     * See also: `NotAllowedError`, `Namefully.format`.
+     */
+    NameErrorType[NameErrorType["NOT_ALLOWED"] = 2] = "NOT_ALLOWED";
+    /**
+     * Thrown by any other unknown sources or unexpected situation.
+     */
+    NameErrorType[NameErrorType["UNKNOWN"] = 3] = "UNKNOWN";
+})(NameErrorType = exports.NameErrorType || (exports.NameErrorType = {}));
+/**
+ * Base class for all name-related errors.
+ *
+ * A custom error is intended to convey information to the user about a failure,
+ * so that it can be addressed programmatically.
+ *
+ * A name handling failure is not considered a native error that should cause a
+ * program failure. Au contraire, it is expected that a programmer using this utility
+ * would consider validating a name using its own business rules. That is not
+ * this utility's job to guess those rules. So, the predefined `ValidationRules`
+ * obey some common validation techniques when it comes to sanitizing a person
+ * name. For this reason, the [Config.bypass] is set to `true` by default,
+ * indicating that those predefined rules should be skipped for the sake of the
+ * program.
+ *
+ * A programmer may leverage `Parser` to indicate business-tailored rules if he
+ * or she wants this utility to perform those safety checks behind the scenes.
+ *
+ * A name error intends to provide useful information about what causes the error
+ * and let the user take initiative on what happens next to the given name:
+ * reconstructing it or skipping it.
+ */
+class NameError extends Error {
+    /**
+     * Creates an error with a message describing the issue for a name source.
+     * @param source name input that caused the error
+     * @param message a message describing the failure.
+     * @param type of `NameErrorType`
+     */
+    constructor(source, message, type = NameErrorType.UNKNOWN) {
+        super(message);
+        this.source = source;
+        this.type = type;
+        this.name = 'NameError';
+    }
+    /**
+     * The actual source input which caused the error.
+     */
+    get sourceAsString() {
+        let input = '';
+        if (!this.source)
+            input = '<undefined>';
+        if (typeof this.source === 'string')
+            input = this.source;
+        if (utils_1.isNameArray(this.source))
+            input = this.source.map((n) => n.toString()).join(' ');
+        if (utils_1.isStringArray(this.source))
+            input = this.source.join(' ');
+        return input;
+    }
+    /**
+     * Whether a message describing the failure exists.
+     */
+    get hasMessage() {
+        return this.message && this.message.trim().length > 0;
+    }
+    /**
+     * Returns a string representation of the error.
+     */
+    toString() {
+        let report = `${this.name} (${this.sourceAsString})`;
+        if (this.hasMessage)
+            report = `${report}: ${this.message}`;
+        return report;
+    }
+}
+exports.NameError = NameError;
+/**
+ * An error thrown when a name source input is incorrect.
+ *
+ * A `Name` is a name for this utility under certain criteria (i.e., 2+ chars),
+ * hence, a wrong input will cause this kind of error. Another common reason
+ * may be a wrong key in a Json name parsing mechanism.
+ *
+ * Keep in mind that this error is different from a `ValidationError`.
+ */
+class InputError extends NameError {
+    /**
+     * Creates a new `InputError` with an optional error `message`.
+     *
+     * The name source is by nature a string content, maybe wrapped up in a different
+     * type. This string value may be extracted to form the following output:
+     *   "InputError (stringName)",
+     *   "InputError (stringName): message".
+     */
+    constructor(error) {
+        super(error.source, error.message, NameErrorType.INPUT);
+        this.name = 'InputError';
+    }
+}
+exports.InputError = InputError;
+/**
+ * An error thrown to indicate that a name fails the validation rules.
+ */
+class ValidationError extends NameError {
+    /**
+     * Creates error containing the invalid `nameType` and a `message` that
+     * briefly describes the problem if provided.
+     *
+     * For example, a validation error can be interpreted as:
+     *     "ValidationError (nameType='stringName')",
+     *     "ValidationError (nameType='stringName'): message"
+     */
+    constructor(error) {
+        super(error.source, error.message, NameErrorType.VALIDATION);
+        this.nameType = error.nameType;
+        this.name = 'ValidationError';
+    }
+    toString() {
+        let report = `${this.name} (${this.nameType}='${this.sourceAsString}')`;
+        if (this.hasMessage)
+            report = `${report}: ${this.message}`;
+        return report;
+    }
+}
+exports.ValidationError = ValidationError;
+/**
+ * Thrown by not allowed operations such as in name formatting.
+ *
+ * For example, this will occur when trying to format a name accordingly using
+ * a non-supported key.
+ */
+class NotAllowedError extends NameError {
+    /**
+     * Creates a new `NotAllowedError` with an optional error `message` and the
+     * `operation` name.
+     *
+     * For example, an error of this kind can be interpreted as:
+     *     "NotAllowedError (stringName)",
+     *     "NotAllowedError (stringName) - operationName",
+     *     "NotAllowedError (stringName) - operationName: message"
+     */
+    constructor(error) {
+        super(error.source, error.message, NameErrorType.NOT_ALLOWED);
+        this.operation = error.operation;
+        this.name = 'NotAllowedError';
+    }
+    toString() {
+        let report = `${this.name} (${this.sourceAsString})`;
+        if (this.operation && this.operation.trim().length > 0)
+            report = `${report} - ${this.operation}`;
+        if (this.hasMessage)
+            report = `${report}: ${this.message}`;
+        return report;
+    }
+}
+exports.NotAllowedError = NotAllowedError;
+/**
+ * A fallback error thrown by any unknown sources or unexpected failure that are
+ * not of `NameError`.
+ *
+ * In this particular case, an `origin` remains useful as it provides details
+ * on the sources and the true nature of the unexpected error.
+ * At this point, deciding whether to exit the program or not depends on the
+ * programmer.
+ */
+class UnknownError extends NameError {
+    /**
+     * Creates a new `UnknownError` with an optional error `message`.
+     * Optionally, the original error revealing the true nature of the failure.
+     */
+    constructor(error) {
+        super(error.source, error.message, NameErrorType.UNKNOWN);
+        this.origin = error.error;
+        this.name = 'UnknownError';
+    }
+    toString() {
+        let report = super.toString();
+        if (this.origin)
+            report += `\n${this.origin.toString()}`;
+        return report;
+    }
+}
+exports.UnknownError = UnknownError;
+//# sourceMappingURL=error.js.map

package/dist/lib/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../src/error.ts"],"names":[],"mappings":";;;AAEA,mCAAoD;AASpD;;GAEG;AACH,IAAY,aA6BX;AA7BD,WAAY,aAAa;IACrB;;;;;OAKG;IACH,mDAAK,CAAA;IAEL;;;;;;OAMG;IACH,6DAAU,CAAA;IAEV;;;;OAIG;IACH,+DAAW,CAAA;IAEX;;OAEG;IACH,uDAAO,CAAA;AACX,CAAC,EA7BW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QA6BxB;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAa,SAAU,SAAQ,KAAK;IAChC;;;;;OAKG;IACH,YAAqB,MAAkB,EAAE,OAAgB,EAAW,OAAsB,aAAa,CAAC,OAAO;QAC3G,KAAK,CAAC,OAAO,CAAC,CAAA;QADG,WAAM,GAAN,MAAM,CAAY;QAA6B,SAAI,GAAJ,IAAI,CAAuC;QAE3G,IAAI,CAAC,IAAI,GAAG,WAAW,CAAA;IAC3B,CAAC;IAED;;OAEG;IACH,IAAI,cAAc;QACd,IAAI,KAAK,GAAG,EAAE,CAAA;QACd,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,KAAK,GAAG,aAAa,CAAA;QACvC,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ;YAAE,KAAK,GAAG,IAAI,CAAC,MAAM,CAAA;QACxD,IAAI,mBAAW,CAAC,IAAI,CAAC,MAAM,CAAC;YAAE,KAAK,GAAI,IAAI,CAAC,MAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAChG,IAAI,qBAAa,CAAC,IAAI,CAAC,MAAM,CAAC;YAAE,KAAK,GAAI,IAAI,CAAC,MAAmB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAC3E,OAAO,KAAK,CAAA;IAChB,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAA;IACzD,CAAC;IAED;;OAEG;IACH,QAAQ;QACJ,IAAI,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,cAAc,GAAG,CAAA;QACpD,IAAI,IAAI,CAAC,UAAU;YAAE,MAAM,GAAG,GAAG,MAAM,KAAK,IAAI,CAAC,OAAO,EAAE,CAAA;QAC1D,OAAO,MAAM,CAAA;IACjB,CAAC;CACJ;AAvCD,8BAuCC;AAED;;;;;;;;GAQG;AACH,MAAa,UAAW,SAAQ,SAAS;IACrC;;;;;;;OAOG;IACH,YAAY,KAAmB;QAC3B,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,EAAE,aAAa,CAAC,KAAK,CAAC,CAAA;QACvD,IAAI,CAAC,IAAI,GAAG,YAAY,CAAA;IAC5B,CAAC;CACJ;AAbD,gCAaC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,SAAS;IAM1C;;;;;;;OAOG;IACH,YAAY,KAA0C;QAClD,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,CAAA;QAC5D,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAA;QAC9B,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAA;IACjC,CAAC;IAED,QAAQ;QACJ,IAAI,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,cAAc,IAAI,CAAA;QACvE,IAAI,IAAI,CAAC,UAAU;YAAE,MAAM,GAAG,GAAG,MAAM,KAAK,IAAI,CAAC,OAAO,EAAE,CAAA;QAC1D,OAAO,MAAM,CAAA;IACjB,CAAC;CACJ;AAzBD,0CAyBC;AAED;;;;;GAKG;AACH,MAAa,eAAgB,SAAQ,SAAS;IAM1C;;;;;;;;OAQG;IACH,YAAY,KAA2C;QACnD,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,EAAE,aAAa,CAAC,WAAW,CAAC,CAAA;QAC7D,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAA;QAChC,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAA;IACjC,CAAC;IAED,QAAQ;QACJ,IAAI,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,cAAc,GAAG,CAAA;QACpD,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC;YAAE,MAAM,GAAG,GAAG,MAAM,MAAM,IAAI,CAAC,SAAS,EAAE,CAAA;QAChG,IAAI,IAAI,CAAC,UAAU;YAAE,MAAM,GAAG,GAAG,MAAM,KAAK,IAAI,CAAC,OAAO,EAAE,CAAA;QAC1D,OAAO,MAAM,CAAA;IACjB,CAAC;CACJ;AA3BD,0CA2BC;AAED;;;;;;;;GAQG;AACH,MAAa,YAAa,SAAQ,SAAS;IAMvC;;;OAGG;IACH,YAAY,KAAuC;QAC/C,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC,CAAA;QACzD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,KAAK,CAAA;QACzB,IAAI,CAAC,IAAI,GAAG,cAAc,CAAA;IAC9B,CAAC;IAED,QAAQ;QACJ,IAAI,MAAM,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAA;QAC7B,IAAI,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAA;QACxD,OAAO,MAAM,CAAA;IACjB,CAAC;CACJ;AArBD,oCAqBC"}

package/dist/lib/full-name.d.ts

@@ -0,0 +1,71 @@
+import { Config } from './config';
+import { FirstName, LastName, Name, JsonName } from './name';
+import { Nullable, Namon } from './types';
+/**
+ * The core component of this utility.
+ *
+ * This component is comprised of five entities that make it easy to handle a
+ * full name set: prefix, first name, middle name, last name, and suffix.
+ * This class is intended for internal processes. However, it is understandable
+ * that it might be needed at some point for additional purposes. For this reason,
+ * it's made available.
+ *
+ * It is recommended to avoid using this class unless it is highly necessary or
+ * a custom parser is used for uncommon use cases. This utility tries to cover
+ * as many use cases as possible.
+ *
+ * Additionally, an optional configuration can be used to indicate some specific
+ * behaviors related to that name handling.
+ */
+export declare class FullName {
+    private _prefix;
+    private _firstName;
+    private _middleName;
+    private _lastName;
+    private _suffix;
+    private _config;
+    /**
+     * Creates a full name as it goes
+     * @param options optional configuration for additional features.
+     */
+    constructor(options?: Partial<Config>);
+    /**
+     * A snapshot of the configuration used to set up this full name.
+     */
+    get config(): Config;
+    /**
+     * The prefix part of the full name.
+     */
+    get prefix(): Nullable<Name>;
+    /**
+     * The first name part of the full name.
+     */
+    get firstName(): FirstName;
+    /**
+     * The last name part of the full name.
+     */
+    get lastName(): LastName;
+    /**
+     * The middle name part of the full name.
+     */
+    get middleName(): Name[];
+    /**
+     * The suffix part of the full name.
+     */
+    get suffix(): Nullable<Name>;
+    /**
+     * Parses a json name into a full name.
+     * @param json parsable name element
+     * @param config optional configuration for additional features.
+     */
+    static parse(json: JsonName, config?: Config): FullName;
+    setPrefix(name: Nullable<string | Name>): FullName;
+    setFirstName(name: string | FirstName): FullName;
+    setLastName(name: string | LastName): FullName;
+    setMiddleName(names: string[] | Name[]): FullName;
+    setSuffix(name: Nullable<string | Name>): FullName;
+    /**
+     * Returns true if a namon has been set.
+     */
+    has(namon: Namon): boolean;
+}

package/dist/lib/full-name.js

@@ -0,0 +1,147 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FullName = void 0;
+const config_1 = require("./config");
+const error_1 = require("./error");
+const name_1 = require("./name");
+const types_1 = require("./types");
+const validator_1 = require("./validator");
+/**
+ * The core component of this utility.
+ *
+ * This component is comprised of five entities that make it easy to handle a
+ * full name set: prefix, first name, middle name, last name, and suffix.
+ * This class is intended for internal processes. However, it is understandable
+ * that it might be needed at some point for additional purposes. For this reason,
+ * it's made available.
+ *
+ * It is recommended to avoid using this class unless it is highly necessary or
+ * a custom parser is used for uncommon use cases. This utility tries to cover
+ * as many use cases as possible.
+ *
+ * Additionally, an optional configuration can be used to indicate some specific
+ * behaviors related to that name handling.
+ */
+class FullName {
+    /**
+     * Creates a full name as it goes
+     * @param options optional configuration for additional features.
+     */
+    constructor(options) {
+        this._middleName = [];
+        this._config = config_1.Config.merge(options);
+    }
+    /**
+     * A snapshot of the configuration used to set up this full name.
+     */
+    get config() {
+        return this._config;
+    }
+    /**
+     * The prefix part of the full name.
+     */
+    get prefix() {
+        return this._prefix;
+    }
+    /**
+     * The first name part of the full name.
+     */
+    get firstName() {
+        return this._firstName;
+    }
+    /**
+     * The last name part of the full name.
+     */
+    get lastName() {
+        return this._lastName;
+    }
+    /**
+     * The middle name part of the full name.
+     */
+    get middleName() {
+        return this._middleName;
+    }
+    /**
+     * The suffix part of the full name.
+     */
+    get suffix() {
+        return this._suffix;
+    }
+    /**
+     * Parses a json name into a full name.
+     * @param json parsable name element
+     * @param config optional configuration for additional features.
+     */
+    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_1.NameError) {
+                throw error;
+            }
+            else {
+                throw new error_1.UnknownError({
+                    source: Object.values(json).join(' '),
+                    message: 'could not parse JSON content',
+                    error,
+                });
+            }
+        }
+    }
+    setPrefix(name) {
+        if (!name)
+            return this;
+        if (!this._config.bypass)
+            validator_1.Validators.prefix.validate(name);
+        const prefix = name instanceof name_1.Name ? name.value : name;
+        this._prefix = name_1.Name.prefix(this._config.title === types_1.Title.US ? `${prefix}.` : prefix);
+        return this;
+    }
+    setFirstName(name) {
+        if (!this._config.bypass)
+            validator_1.Validators.firstName.validate(name);
+        this._firstName = name instanceof name_1.FirstName ? name : new name_1.FirstName(name);
+        return this;
+    }
+    setLastName(name) {
+        if (!this._config.bypass)
+            validator_1.Validators.lastName.validate(name);
+        this._lastName = name instanceof name_1.LastName ? name : new name_1.LastName(name);
+        return this;
+    }
+    setMiddleName(names) {
+        if (!Array.isArray(names))
+            return;
+        if (!this._config.bypass)
+            validator_1.Validators.middleName.validate(names);
+        this._middleName = names.map((name) => name instanceof name_1.Name ? name : name_1.Name.middle(name));
+        return this;
+    }
+    setSuffix(name) {
+        if (!name)
+            return this;
+        if (!this._config.bypass)
+            validator_1.Validators.suffix.validate(name);
+        this._suffix = name_1.Name.suffix(name instanceof name_1.Name ? name.value : name);
+        return this;
+    }
+    /**
+     * Returns true if a namon has been set.
+     */
+    has(namon) {
+        if (namon.equal(types_1.Namon.PREFIX))
+            return !!this._prefix;
+        if (namon.equal(types_1.Namon.SUFFIX))
+            return !!this._suffix;
+        return namon.equal(types_1.Namon.MIDDLE_NAME) ? this._middleName.length > 0 : true;
+    }
+}
+exports.FullName = FullName;
+//# sourceMappingURL=full-name.js.map

package/dist/lib/full-name.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"full-name.js","sourceRoot":"","sources":["../../src/full-name.ts"],"names":[],"mappings":";;;AAAA,qCAAiC;AACjC,mCAAiD;AACjD,iCAA4D;AAC5D,mCAAgD;AAChD,2CAAwC;AAExC;;;;;;;;;;;;;;;GAeG;AACH,MAAa,QAAQ;IAQjB;;;OAGG;IACH,YAAY,OAAyB;QAT7B,gBAAW,GAAW,EAAE,CAAA;QAU5B,IAAI,CAAC,OAAO,GAAG,eAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;IACxC,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,OAAO,CAAA;IACvB,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,OAAO,CAAA;IACvB,CAAC;IAED;;OAEG;IACH,IAAI,SAAS;QACT,OAAO,IAAI,CAAC,UAAU,CAAA;IAC1B,CAAC;IAED;;OAEG;IACH,IAAI,QAAQ;QACR,OAAO,IAAI,CAAC,SAAS,CAAA;IACzB,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,WAAW,CAAA;IAC3B,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,OAAO,CAAA;IACvB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,IAAc,EAAE,MAAe;QACxC,IAAI;YACA,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAA;YACrC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;YAC/B,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YACrC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;YACvC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YACnC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;YAC/B,OAAO,QAAQ,CAAA;SAClB;QAAC,OAAO,KAAK,EAAE;YACZ,IAAI,KAAK,YAAY,iBAAS,EAAE;gBAC5B,MAAM,KAAK,CAAA;aACd;iBAAM;gBACH,MAAM,IAAI,oBAAY,CAAC;oBACnB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;oBACrC,OAAO,EAAE,8BAA8B;oBACvC,KAAK;iBACR,CAAC,CAAA;aACL;SACJ;IACL,CAAC;IAED,SAAS,CAAC,IAA6B;QACnC,IAAI,CAAC,IAAI;YAAE,OAAO,IAAI,CAAA;QACtB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM;YAAE,sBAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QAC1D,MAAM,MAAM,GAAG,IAAI,YAAY,WAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAA;QACvD,IAAI,CAAC,OAAO,GAAG,WAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,KAAK,aAAK,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;QACnF,OAAO,IAAI,CAAA;IACf,CAAC;IAED,YAAY,CAAC,IAAwB;QACjC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM;YAAE,sBAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QAC7D,IAAI,CAAC,UAAU,GAAG,IAAI,YAAY,gBAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,gBAAS,CAAC,IAAI,CAAC,CAAA;QACxE,OAAO,IAAI,CAAA;IACf,CAAC;IAED,WAAW,CAAC,IAAuB;QAC/B,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM;YAAE,sBAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QAC5D,IAAI,CAAC,SAAS,GAAG,IAAI,YAAY,eAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,eAAQ,CAAC,IAAI,CAAC,CAAA;QACrE,OAAO,IAAI,CAAA;IACf,CAAC;IAED,aAAa,CAAC,KAAwB;QAClC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;YAAE,OAAM;QACjC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM;YAAE,sBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;QAC/D,IAAI,CAAC,WAAW,GAAI,KAA8B,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAC5D,IAAI,YAAY,WAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,WAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAClD,CAAA;QACD,OAAO,IAAI,CAAA;IACf,CAAC;IAED,SAAS,CAAC,IAA6B;QACnC,IAAI,CAAC,IAAI;YAAE,OAAO,IAAI,CAAA;QACtB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM;YAAE,sBAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QAC1D,IAAI,CAAC,OAAO,GAAG,WAAI,CAAC,MAAM,CAAC,IAAI,YAAY,WAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;QACpE,OAAO,IAAI,CAAA;IACf,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,KAAY;QACZ,IAAI,KAAK,CAAC,KAAK,CAAC,aAAK,CAAC,MAAM,CAAC;YAAE,OAAO,CAAC,CAAC,IAAI,CAAC,OAAO,CAAA;QACpD,IAAI,KAAK,CAAC,KAAK,CAAC,aAAK,CAAC,MAAM,CAAC;YAAE,OAAO,CAAC,CAAC,IAAI,CAAC,OAAO,CAAA;QACpD,OAAO,KAAK,CAAC,KAAK,CAAC,aAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;IAC9E,CAAC;CACJ;AAjID,4BAiIC"}

package/dist/lib/index.d.ts

@@ -1,10 +1,20 @@
 /**
- * Main entry to `Namefully`
+ * Welcome to namefully!
  *
- * Created on March 03, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
+ * `namefully` is a JavaScript utility for handing person names.
+ *
+ * Sources
+ * - repo: https://github.com/ralflorent/namefully
+ * - docs: https://namefully.netlify.app
+ * - npm: https://npmjs.com/package/namefully
+ *
+ * @license MIT
  */
+export * from './config';
+export * from './error';
+export * from './full-name';
+export * from './name';
 export * from './namefully';
-export * from './core';
-export * from './models';
-export * from './validators';
+export { Parser } from './parser';
+export * from './types';
+export { NameIndex } from './utils';

package/dist/lib/index.js

@@ -1,14 +1,35 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
 /**
- * Main entry to `Namefully`
+ * Welcome to namefully!
  *
- * Created on March 03, 2020
- * @author Ralph Florent <ralflornt@gmail.com>
+ * `namefully` is a JavaScript utility for handing person names.
+ *
+ * Sources
+ * - repo: https://github.com/ralflorent/namefully
+ * - docs: https://namefully.netlify.app
+ * - npm: https://npmjs.com/package/namefully
+ *
+ * @license MIT
  */
-tslib_1.__exportStar(require("./namefully"), exports);
-tslib_1.__exportStar(require("./core"), exports);
-tslib_1.__exportStar(require("./models"), exports);
-tslib_1.__exportStar(require("./validators"), exports);
+__exportStar(require("./config"), exports);
+__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; } });
 //# sourceMappingURL=index.js.map

package/dist/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,sDAA4B;AAC5B,iDAAuB;AACvB,mDAAyB;AACzB,uDAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA;;;;;;;;;;;GAWG;AACH,2CAAwB;AACxB,0CAAuB;AACvB,8CAA2B;AAC3B,yCAAsB;AACtB,8CAA2B;AAC3B,mCAAiC;AAAxB,gGAAA,MAAM,OAAA;AACf,0CAAuB;AACvB,iCAAmC;AAA1B,kGAAA,SAAS,OAAA"}