namefully 1.0.9 → 1.2.0

package/dist/lib/src/types.d.ts

@@ -0,0 +1,127 @@
+/**
+ * Make a type nullable.
+ */
+export declare type Nullable<T> = T | null | undefined;
+/**
+ * The abbreviation type to indicate whether or not to add period to a prefix
+ * using the American or British way.
+ */
+export declare enum Title {
+    US = "US",
+    UK = "UK"
+}
+/**
+ * An option indicating how to format a surname.
+ *
+ * This enum can be set via `Config` or when creating a `LastName`. As this can
+ * become ambiguous at the time of handling it, the value set in `Config` is
+ * prioritized and viewed as the source of truth for future considerations.
+ */
+export declare enum Surname {
+    FATHER = "father",
+    MOTHER = "mother",
+    HYPHENATED = "hyphenated",
+    ALL = "all"
+}
+/**
+ * The order of appearance of a `FullName`.
+ */
+export declare enum NameOrder {
+    FIRST_NAME = "firstName",
+    LAST_NAME = "lastName"
+}
+/**
+ * The types of name handled in this according the name standards.
+ */
+export declare enum NameType {
+    FIRST_NAME = "firstName",
+    MIDDLE_NAME = "middleName",
+    LAST_NAME = "lastName",
+    BIRTH_NAME = "birthName"
+}
+/**
+ * The possible variants to indicate how to flatten a `FullName`.
+ */
+export declare enum Flat {
+    FIRST_NAME = "firstName",
+    MIDDLE_NAME = "middleName",
+    LAST_NAME = "lastName",
+    FIRST_MID = "firstMid",
+    MID_LAST = "midLast",
+    ALL = "all"
+}
+/**
+ * The range to use when capitalizing a string content.
+ */
+export declare enum CapsRange {
+    NONE = 0,
+    INITIAL = 1,
+    ALL = 2
+}
+/**
+ * The types of name handled in this utility according the name standards.
+ */
+export declare class Namon {
+    readonly index: number;
+    readonly key: string;
+    static readonly PREFIX: Namon;
+    static readonly FIRST_NAME: Namon;
+    static readonly MIDDLE_NAME: Namon;
+    static readonly LAST_NAME: Namon;
+    static readonly SUFFIX: Namon;
+    /**
+     * The list of supported name types.
+     */
+    static readonly values: Namon[];
+    /**
+     * All the predefined name types.
+     */
+    static readonly all: Map<string, Namon>;
+    private constructor();
+    /**
+     * Whether this string key is part of the predefined keys.
+     */
+    static has(key: string): boolean;
+    /**
+     * Makes a string key a namon type.
+     */
+    static cast(key: string): Nullable<Namon>;
+    /**
+     * String representation of this object.
+     */
+    toString(): string;
+    /**
+     * Whether this and the other value are equal.
+     */
+    equal(other: Namon | unknown): boolean;
+}
+/**
+ * The token used to indicate how to split string values.
+ */
+export declare class Separator {
+    readonly name: string;
+    readonly token: string;
+    static readonly COMMA: Separator;
+    static readonly COLON: Separator;
+    static readonly DOUBLE_QUOTE: Separator;
+    static readonly EMPTY: Separator;
+    static readonly HYPHEN: Separator;
+    static readonly PERIOD: Separator;
+    static readonly SEMI_COLON: Separator;
+    static readonly SINGLE_QUOTE: Separator;
+    static readonly SPACE: Separator;
+    static readonly UNDERSCORE: Separator;
+    /**
+     * All the available separators.
+     */
+    static readonly all: Map<string, Separator>;
+    /**
+     * All the available tokens.
+     */
+    static readonly tokens: string[];
+    private constructor();
+    /**
+     * String representation of this object.
+     */
+    toString(): string;
+}

package/dist/lib/src/utils.d.ts

@@ -0,0 +1,63 @@
+import { NameOrder, CapsRange } from './types';
+/**
+ * A fixed set of values to handle specific positions for list of names.
+ *
+ * As for list of names, this helps to follow a specific order based on the
+ * count of elements. It is expected that the list has to be between two and
+ * five elements. Also, the order of appearance set in the configuration
+ * influences how the parsing is carried out.
+ *
+ * Ordered by first name, the parser works as follows:
+ * - 2 elements: firstName lastName
+ * - 3 elements: firstName middleName lastName
+ * - 4 elements: prefix firstName middleName lastName
+ * - 5 elements: prefix firstName middleName lastName suffix
+ *
+ * Ordered by last name, the parser works as follows:
+ * - 2 elements: lastName firstName
+ * - 3 elements: lastName firstName middleName
+ * - 4 elements: prefix lastName firstName middleName
+ * - 5 elements: prefix lastName firstName middleName suffix
+ *
+ * For example, `Jane Smith` (ordered by first name) is expected to be indexed:
+ * `['Jane', 'Smith']`.
+ */
+export declare class NameIndex {
+    readonly prefix: number;
+    readonly firstName: number;
+    readonly middleName: number;
+    readonly lastName: number;
+    readonly suffix: number;
+    /**
+     * The minimum number of parts in a list of names.
+     */
+    static get min(): number;
+    /**
+     * The maximum number of parts in a list of names.
+     */
+    static get max(): number;
+    private constructor();
+    /**
+     * The default or base indexing: firstName lastName.
+     */
+    static base(): NameIndex;
+    /**
+     * Gets the name index for a list of names based on the `count` of elements
+     * and their `order` of appearance.
+     */
+    static when(order: NameOrder, count?: number): NameIndex;
+}
+/**
+ * Capitalizes a string via a `CapsRange` option.
+ */
+export declare function capitalize(str: string, range?: CapsRange): string;
+/**
+ * Decapitalizes a string via a `CapsRange` option.
+ */
+export declare function decapitalize(str: string, range?: CapsRange): string;
+/**
+ * Toggles a string representation.
+ */
+export declare function toggleCase(str: string): string;
+export declare function isStringArray(value?: unknown): boolean;
+export declare function isNameArray(value?: unknown): boolean;

package/dist/lib/src/validator.d.ts

@@ -0,0 +1,66 @@
+import { FirstName, LastName, Name } from './name';
+import { Namon } from './types';
+import { NameIndex } from './utils';
+export interface Validator<T> {
+    validate(value: T): void;
+}
+declare class ArrayValidator<T extends string | Name> implements Validator<T[]> {
+    validate(values: T[]): void;
+}
+declare class NamonValidator implements Validator<string | Name> {
+    private static validator;
+    private constructor();
+    static create(): NamonValidator;
+    validate(value: string | Name, type?: Namon): void;
+}
+declare class FirstNameValidator implements Validator<string | FirstName> {
+    private static validator;
+    private constructor();
+    static create(): FirstNameValidator;
+    validate(value: string | FirstName): void;
+}
+declare class MiddleNameValidator implements Validator<string | string[] | Name[]> {
+    private static validator;
+    private constructor();
+    static create(): MiddleNameValidator;
+    validate(value: string | string[] | Name[]): void;
+}
+declare class LastNameValidator implements Validator<string | LastName> {
+    private static validator;
+    private constructor();
+    static create(): LastNameValidator;
+    validate(value: string | LastName): void;
+}
+export declare class NamaValidator implements Validator<Map<Namon, string>> {
+    private static validator;
+    private constructor();
+    static create(): NamaValidator;
+    validate(value: Map<Namon, string>): void;
+    validateKeys(nama: Map<Namon, string>): void;
+}
+export declare class ArrayStringValidator extends ArrayValidator<string> {
+    readonly index: NameIndex;
+    constructor(index?: NameIndex);
+    validate(values: string[]): void;
+    validateIndex(values: string[]): void;
+}
+export declare class ArrayNameValidator implements Validator<Name[]> {
+    private static validator;
+    private constructor();
+    static create(): ArrayNameValidator;
+    validate(value: Name[]): void;
+    private hasBasicNames;
+}
+/**
+ * A list of validators for a specific namon.
+ */
+export declare abstract class Validators {
+    static namon: NamonValidator;
+    static nama: NamaValidator;
+    static prefix: NamonValidator;
+    static firstName: FirstNameValidator;
+    static middleName: MiddleNameValidator;
+    static lastName: LastNameValidator;
+    static suffix: NamonValidator;
+}
+export {};

package/dist/lib/types.d.ts

@@ -0,0 +1,127 @@
+/**
+ * Make a type nullable.
+ */
+export declare type Nullable<T> = T | null | undefined;
+/**
+ * The abbreviation type to indicate whether or not to add period to a prefix
+ * using the American or British way.
+ */
+export declare enum Title {
+    US = "US",
+    UK = "UK"
+}
+/**
+ * An option indicating how to format a surname.
+ *
+ * This enum can be set via `Config` or when creating a `LastName`. As this can
+ * become ambiguous at the time of handling it, the value set in `Config` is
+ * prioritized and viewed as the source of truth for future considerations.
+ */
+export declare enum Surname {
+    FATHER = "father",
+    MOTHER = "mother",
+    HYPHENATED = "hyphenated",
+    ALL = "all"
+}
+/**
+ * The order of appearance of a `FullName`.
+ */
+export declare enum NameOrder {
+    FIRST_NAME = "firstName",
+    LAST_NAME = "lastName"
+}
+/**
+ * The types of name handled in this according the name standards.
+ */
+export declare enum NameType {
+    FIRST_NAME = "firstName",
+    MIDDLE_NAME = "middleName",
+    LAST_NAME = "lastName",
+    BIRTH_NAME = "birthName"
+}
+/**
+ * The possible variants to indicate how to flatten a `FullName`.
+ */
+export declare enum Flat {
+    FIRST_NAME = "firstName",
+    MIDDLE_NAME = "middleName",
+    LAST_NAME = "lastName",
+    FIRST_MID = "firstMid",
+    MID_LAST = "midLast",
+    ALL = "all"
+}
+/**
+ * The range to use when capitalizing a string content.
+ */
+export declare enum CapsRange {
+    NONE = 0,
+    INITIAL = 1,
+    ALL = 2
+}
+/**
+ * The types of name handled in this utility according the name standards.
+ */
+export declare class Namon {
+    readonly index: number;
+    readonly key: string;
+    static readonly PREFIX: Namon;
+    static readonly FIRST_NAME: Namon;
+    static readonly MIDDLE_NAME: Namon;
+    static readonly LAST_NAME: Namon;
+    static readonly SUFFIX: Namon;
+    /**
+     * The list of supported name types.
+     */
+    static readonly values: Namon[];
+    /**
+     * All the predefined name types.
+     */
+    static readonly all: Map<string, Namon>;
+    private constructor();
+    /**
+     * Whether this string key is part of the predefined keys.
+     */
+    static has(key: string): boolean;
+    /**
+     * Makes a string key a namon type.
+     */
+    static cast(key: string): Nullable<Namon>;
+    /**
+     * String representation of this object.
+     */
+    toString(): string;
+    /**
+     * Whether this and the other value are equal.
+     */
+    equal(other: Namon | unknown): boolean;
+}
+/**
+ * The token used to indicate how to split string values.
+ */
+export declare class Separator {
+    readonly name: string;
+    readonly token: string;
+    static readonly COMMA: Separator;
+    static readonly COLON: Separator;
+    static readonly DOUBLE_QUOTE: Separator;
+    static readonly EMPTY: Separator;
+    static readonly HYPHEN: Separator;
+    static readonly PERIOD: Separator;
+    static readonly SEMI_COLON: Separator;
+    static readonly SINGLE_QUOTE: Separator;
+    static readonly SPACE: Separator;
+    static readonly UNDERSCORE: Separator;
+    /**
+     * All the available separators.
+     */
+    static readonly all: Map<string, Separator>;
+    /**
+     * All the available tokens.
+     */
+    static readonly tokens: string[];
+    private constructor();
+    /**
+     * String representation of this object.
+     */
+    toString(): string;
+}

package/dist/lib/types.js

@@ -0,0 +1,181 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Separator = exports.Namon = exports.CapsRange = exports.Flat = exports.NameType = exports.NameOrder = exports.Surname = exports.Title = void 0;
+/**
+ * The abbreviation type to indicate whether or not to add period to a prefix
+ * using the American or British way.
+ */
+var Title;
+(function (Title) {
+    // A period after the prefix.
+    Title["US"] = "US";
+    // No period after the prefix.
+    Title["UK"] = "UK";
+})(Title = exports.Title || (exports.Title = {}));
+/**
+ * An option indicating how to format a surname.
+ *
+ * This enum can be set via `Config` or when creating a `LastName`. As this can
+ * become ambiguous at the time of handling it, the value set in `Config` is
+ * prioritized and viewed as the source of truth for future considerations.
+ */
+var Surname;
+(function (Surname) {
+    // The fatherly surname only.
+    Surname["FATHER"] = "father";
+    // The motherly surname only.
+    Surname["MOTHER"] = "mother";
+    // The junction of both the fatherly and motherly surnames with a hyphen.
+    Surname["HYPHENATED"] = "hyphenated";
+    // The junction of both the fatherly and motherly surnames with a space.
+    Surname["ALL"] = "all";
+})(Surname = exports.Surname || (exports.Surname = {}));
+/**
+ * The order of appearance of a `FullName`.
+ */
+var NameOrder;
+(function (NameOrder) {
+    // The first part of a full name, usually the first piece of a person name.
+    NameOrder["FIRST_NAME"] = "firstName";
+    // The last part of a full name, usually the last piece of a person name.
+    NameOrder["LAST_NAME"] = "lastName";
+})(NameOrder = exports.NameOrder || (exports.NameOrder = {}));
+/**
+ * The types of name handled in this according the name standards.
+ */
+var NameType;
+(function (NameType) {
+    NameType["FIRST_NAME"] = "firstName";
+    NameType["MIDDLE_NAME"] = "middleName";
+    NameType["LAST_NAME"] = "lastName";
+    NameType["BIRTH_NAME"] = "birthName";
+})(NameType = exports.NameType || (exports.NameType = {}));
+/**
+ * The possible variants to indicate how to flatten a `FullName`.
+ */
+var Flat;
+(function (Flat) {
+    // Use the first name's initial combined with the remaining parts.
+    Flat["FIRST_NAME"] = "firstName";
+    // Use the middle name's initial combined with the remaining parts.
+    Flat["MIDDLE_NAME"] = "middleName";
+    // Use the last name's initial combined with the remaining parts.
+    Flat["LAST_NAME"] = "lastName";
+    // Use both the first and middle names' initials combined with the remaining parts.
+    Flat["FIRST_MID"] = "firstMid";
+    // Use both the last and middle names' initials combined with the remaining parts.
+    Flat["MID_LAST"] = "midLast";
+    // Use the first, middle and last names' initials combined with the remaining parts.
+    Flat["ALL"] = "all";
+})(Flat = exports.Flat || (exports.Flat = {}));
+/**
+ * The range to use when capitalizing a string content.
+ */
+var CapsRange;
+(function (CapsRange) {
+    // No capitalization.
+    CapsRange[CapsRange["NONE"] = 0] = "NONE";
+    // Apply capitalization to the first letter.
+    CapsRange[CapsRange["INITIAL"] = 1] = "INITIAL";
+    // Apply capitalization to all the letters.
+    CapsRange[CapsRange["ALL"] = 2] = "ALL";
+})(CapsRange = exports.CapsRange || (exports.CapsRange = {}));
+/**
+ * The types of name handled in this utility according the name standards.
+ */
+class Namon {
+    constructor(index, key) {
+        this.index = index;
+        this.key = key;
+    }
+    /**
+     * Whether this string key is part of the predefined keys.
+     */
+    static has(key) {
+        return Namon.all.has(key);
+    }
+    /**
+     * Makes a string key a namon type.
+     */
+    static cast(key) {
+        return Namon.has(key) ? Namon.all.get(key) : undefined;
+    }
+    /**
+     * String representation of this object.
+     */
+    toString() {
+        return `Namon.${this.key}`;
+    }
+    /**
+     * Whether this and the other value are equal.
+     */
+    equal(other) {
+        return other instanceof Namon && other.index === this.index && other.key === this.key;
+    }
+}
+exports.Namon = Namon;
+Namon.PREFIX = new Namon(0, 'prefix');
+Namon.FIRST_NAME = new Namon(1, 'firstName');
+Namon.MIDDLE_NAME = new Namon(2, 'middleName');
+Namon.LAST_NAME = new Namon(3, 'lastName');
+Namon.SUFFIX = new Namon(4, 'suffix');
+/**
+ * The list of supported name types.
+ */
+Namon.values = [Namon.PREFIX, Namon.FIRST_NAME, Namon.MIDDLE_NAME, Namon.LAST_NAME, Namon.SUFFIX];
+/**
+ * All the predefined name types.
+ */
+Namon.all = new Map([
+    [Namon.PREFIX.key, Namon.PREFIX],
+    [Namon.FIRST_NAME.key, Namon.FIRST_NAME],
+    [Namon.MIDDLE_NAME.key, Namon.MIDDLE_NAME],
+    [Namon.LAST_NAME.key, Namon.LAST_NAME],
+    [Namon.SUFFIX.key, Namon.SUFFIX],
+]);
+/**
+ * The token used to indicate how to split string values.
+ */
+class Separator {
+    constructor(name, token) {
+        this.name = name;
+        this.token = token;
+    }
+    /**
+     * String representation of this object.
+     */
+    toString() {
+        return `Separator.${this.name}`;
+    }
+}
+exports.Separator = Separator;
+Separator.COMMA = new Separator('comma', ',');
+Separator.COLON = new Separator('colon', ':');
+Separator.DOUBLE_QUOTE = new Separator('doubleQuote', '"');
+Separator.EMPTY = new Separator('empty', '');
+Separator.HYPHEN = new Separator('hyphen', '-');
+Separator.PERIOD = new Separator('period', '.');
+Separator.SEMI_COLON = new Separator('semiColon', ';');
+Separator.SINGLE_QUOTE = new Separator('singleQuote', `'`);
+Separator.SPACE = new Separator('space', ' ');
+Separator.UNDERSCORE = new Separator('underscore', '_');
+/**
+ * All the available separators.
+ */
+Separator.all = new Map([
+    [Separator.COMMA.name, Separator.COMMA],
+    [Separator.COLON.name, Separator.COLON],
+    [Separator.DOUBLE_QUOTE.name, Separator.DOUBLE_QUOTE],
+    [Separator.EMPTY.name, Separator.EMPTY],
+    [Separator.HYPHEN.name, Separator.HYPHEN],
+    [Separator.PERIOD.name, Separator.PERIOD],
+    [Separator.SEMI_COLON.name, Separator.SEMI_COLON],
+    [Separator.SINGLE_QUOTE.name, Separator.SINGLE_QUOTE],
+    [Separator.SPACE.name, Separator.SPACE],
+    [Separator.UNDERSCORE.name, Separator.UNDERSCORE],
+]);
+/**
+ * All the available tokens.
+ */
+Separator.tokens = [...Separator.all.values()].map((s) => s.token);
+//# sourceMappingURL=types.js.map

package/dist/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";;;AAKA;;;GAGG;AACH,IAAY,KAMX;AAND,WAAY,KAAK;IACb,6BAA6B;IAC7B,kBAAS,CAAA;IAET,8BAA8B;IAC9B,kBAAS,CAAA;AACb,CAAC,EANW,KAAK,GAAL,aAAK,KAAL,aAAK,QAMhB;AAED;;;;;;GAMG;AACH,IAAY,OAYX;AAZD,WAAY,OAAO;IACf,6BAA6B;IAC7B,4BAAiB,CAAA;IAEjB,6BAA6B;IAC7B,4BAAiB,CAAA;IAEjB,yEAAyE;IACzE,oCAAyB,CAAA;IAEzB,wEAAwE;IACxE,sBAAW,CAAA;AACf,CAAC,EAZW,OAAO,GAAP,eAAO,KAAP,eAAO,QAYlB;AAED;;GAEG;AACH,IAAY,SAMX;AAND,WAAY,SAAS;IACjB,2EAA2E;IAC3E,qCAAwB,CAAA;IAExB,yEAAyE;IACzE,mCAAsB,CAAA;AAC1B,CAAC,EANW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAMpB;AAED;;GAEG;AACH,IAAY,QAKX;AALD,WAAY,QAAQ;IAChB,oCAAwB,CAAA;IACxB,sCAA0B,CAAA;IAC1B,kCAAsB,CAAA;IACtB,oCAAwB,CAAA;AAC5B,CAAC,EALW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAKnB;AAED;;GAEG;AACH,IAAY,IAkBX;AAlBD,WAAY,IAAI;IACZ,kEAAkE;IAClE,gCAAwB,CAAA;IAExB,mEAAmE;IACnE,kCAA0B,CAAA;IAE1B,iEAAiE;IACjE,8BAAsB,CAAA;IAEtB,mFAAmF;IACnF,8BAAsB,CAAA;IAEtB,kFAAkF;IAClF,4BAAoB,CAAA;IAEpB,oFAAoF;IACpF,mBAAW,CAAA;AACf,CAAC,EAlBW,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAkBf;AAED;;GAEG;AACH,IAAY,SASX;AATD,WAAY,SAAS;IACjB,qBAAqB;IACrB,yCAAI,CAAA;IAEJ,4CAA4C;IAC5C,+CAAO,CAAA;IAEP,2CAA2C;IAC3C,uCAAG,CAAA;AACP,CAAC,EATW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QASpB;AAED;;GAEG;AACH,MAAa,KAAK;IAuBd,YAA6B,KAAa,EAAW,GAAW;QAAnC,UAAK,GAAL,KAAK,CAAQ;QAAW,QAAG,GAAH,GAAG,CAAQ;IAAG,CAAC;IAEpE;;OAEG;IACH,MAAM,CAAC,GAAG,CAAC,GAAW;QAClB,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IAC7B,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAAI,CAAC,GAAW;QACnB,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAC1D,CAAC;IAED;;OAEG;IACH,QAAQ;QACJ,OAAO,SAAS,IAAI,CAAC,GAAG,EAAE,CAAA;IAC9B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAsB;QACxB,OAAO,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,KAAK,KAAK,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,GAAG,KAAK,IAAI,CAAC,GAAG,CAAA;IACzF,CAAC;;AAnDL,sBAoDC;AAnDmB,YAAM,GAAG,IAAI,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAA;AAC/B,gBAAU,GAAG,IAAI,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,CAAA;AACtC,iBAAW,GAAG,IAAI,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,CAAA;AACxC,eAAS,GAAG,IAAI,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,CAAA;AACpC,YAAM,GAAG,IAAI,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAA;AAE/C;;GAEG;AACa,YAAM,GAAY,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;AAEpH;;GAEG;AACa,SAAG,GAAG,IAAI,GAAG,CAAgB;IACzC,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC;IAChC,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,UAAU,CAAC;IACxC,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,WAAW,CAAC;IAC1C,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,SAAS,CAAC;IACtC,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC;CACnC,CAAC,CAAA;AAiCN;;GAEG;AACH,MAAa,SAAS;IAiClB,YAA6B,IAAY,EAAW,KAAa;QAApC,SAAI,GAAJ,IAAI,CAAQ;QAAW,UAAK,GAAL,KAAK,CAAQ;IAAG,CAAC;IAErE;;OAEG;IACH,QAAQ;QACJ,OAAO,aAAa,IAAI,CAAC,IAAI,EAAE,CAAA;IACnC,CAAC;;AAxCL,8BAyCC;AAxCmB,eAAK,GAAG,IAAI,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC,CAAA;AACnC,eAAK,GAAG,IAAI,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC,CAAA;AACnC,sBAAY,GAAG,IAAI,SAAS,CAAC,aAAa,EAAE,GAAG,CAAC,CAAA;AAChD,eAAK,GAAG,IAAI,SAAS,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;AAClC,gBAAM,GAAG,IAAI,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAA;AACrC,gBAAM,GAAG,IAAI,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAA;AACrC,oBAAU,GAAG,IAAI,SAAS,CAAC,WAAW,EAAE,GAAG,CAAC,CAAA;AAC5C,sBAAY,GAAG,IAAI,SAAS,CAAC,aAAa,EAAE,GAAG,CAAC,CAAA;AAChD,eAAK,GAAG,IAAI,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC,CAAA;AACnC,oBAAU,GAAG,IAAI,SAAS,CAAC,YAAY,EAAE,GAAG,CAAC,CAAA;AAE7D;;GAEG;AACa,aAAG,GAAG,IAAI,GAAG,CAAoB;IAC7C,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC;IACvC,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC;IACvC,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,YAAY,CAAC;IACrD,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC;IACvC,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC;IACzC,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC;IACzC,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC,UAAU,CAAC;IACjD,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,YAAY,CAAC;IACrD,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC;IACvC,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC,UAAU,CAAC;CACpD,CAAC,CAAA;AAEF;;GAEG;AACa,gBAAM,GAAa,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA"}

package/dist/lib/utils.d.ts

@@ -0,0 +1,63 @@
+import { NameOrder, CapsRange } from './types';
+/**
+ * A fixed set of values to handle specific positions for list of names.
+ *
+ * As for list of names, this helps to follow a specific order based on the
+ * count of elements. It is expected that the list has to be between two and
+ * five elements. Also, the order of appearance set in the configuration
+ * influences how the parsing is carried out.
+ *
+ * Ordered by first name, the parser works as follows:
+ * - 2 elements: firstName lastName
+ * - 3 elements: firstName middleName lastName
+ * - 4 elements: prefix firstName middleName lastName
+ * - 5 elements: prefix firstName middleName lastName suffix
+ *
+ * Ordered by last name, the parser works as follows:
+ * - 2 elements: lastName firstName
+ * - 3 elements: lastName firstName middleName
+ * - 4 elements: prefix lastName firstName middleName
+ * - 5 elements: prefix lastName firstName middleName suffix
+ *
+ * For example, `Jane Smith` (ordered by first name) is expected to be indexed:
+ * `['Jane', 'Smith']`.
+ */
+export declare class NameIndex {
+    readonly prefix: number;
+    readonly firstName: number;
+    readonly middleName: number;
+    readonly lastName: number;
+    readonly suffix: number;
+    /**
+     * The minimum number of parts in a list of names.
+     */
+    static get min(): number;
+    /**
+     * The maximum number of parts in a list of names.
+     */
+    static get max(): number;
+    private constructor();
+    /**
+     * The default or base indexing: firstName lastName.
+     */
+    static base(): NameIndex;
+    /**
+     * Gets the name index for a list of names based on the `count` of elements
+     * and their `order` of appearance.
+     */
+    static when(order: NameOrder, count?: number): NameIndex;
+}
+/**
+ * Capitalizes a string via a `CapsRange` option.
+ */
+export declare function capitalize(str: string, range?: CapsRange): string;
+/**
+ * Decapitalizes a string via a `CapsRange` option.
+ */
+export declare function decapitalize(str: string, range?: CapsRange): string;
+/**
+ * Toggles a string representation.
+ */
+export declare function toggleCase(str: string): string;
+export declare function isStringArray(value?: unknown): boolean;
+export declare function isNameArray(value?: unknown): boolean;