namefully 1.0.9 → 1.2.0

package/dist/lib/src/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/src/name.d.ts

@@ -0,0 +1,177 @@
+import { CapsRange, Namon, Surname } from './types';
+/**
+ * Representation of a string type name with some extra capabilities.
+ */
+export declare class Name {
+    readonly type: Namon;
+    private namon;
+    protected initial: string;
+    protected capsRange: CapsRange;
+    /**
+     * Creates augmented names by adding extra functionality to a string name.
+     * @param type must be indicated to categorize the name so it can be
+     * treated accordingly.
+     * @param capsRange determines how the name should be capitalized initially.
+     */
+    constructor(value: string, type: Namon, capsRange?: CapsRange);
+    set value(newValue: string);
+    /**
+     * The piece of string treated as a name.
+     */
+    get value(): string;
+    /**
+     * The length of the name.
+     */
+    get length(): number;
+    /**
+     * Whether the name is a prefix.
+     */
+    get isPrefix(): boolean;
+    /**
+     * Whether the name is a first name.
+     */
+    get isFirstName(): boolean;
+    /**
+     * Whether the name is a middle name.
+     */
+    get isMiddleName(): boolean;
+    /**
+     * Whether the name is a last name.
+     */
+    get isLastName(): boolean;
+    /**
+     * Whether the name is a suffix.
+     */
+    get isSuffix(): boolean;
+    /**
+     * Creates a prefix.
+     */
+    static prefix(value: string): Name;
+    /**
+     * Creates a first name.
+     */
+    static first(value: string): Name;
+    /**
+     * Creates a middle name.
+     */
+    static middle(value: string): Name;
+    /**
+     * Creates a last name.
+     */
+    static last(value: string): Name;
+    /**
+     * Creates a suffix.
+     */
+    static suffix(value: string): Name;
+    /**
+     * Gets the initials (first character) of this name.
+     */
+    initials(): string[];
+    /**
+     * String representation of this object.
+     */
+    toString(): string;
+    /**
+     * Returns true if the other is equal to this name.
+     */
+    equal(other: Name | unknown): boolean;
+    /**
+     * Capitalizes the name.
+     */
+    caps(range?: CapsRange): Name;
+    /**
+     * De-capitalizes the name.
+     */
+    decaps(range?: CapsRange): Name;
+}
+/**
+ * Representation of a first name with some extra functionality.
+ */
+export declare class FirstName extends Name {
+    private _more;
+    /**
+     * Creates an extended version of `Name` and flags it as a first name `type`.
+     *
+     * Some may consider `more` additional name parts of a given name as their
+     * first names, but not as their middle names. Though, it may mean the same,
+     * `more` provides the freedom to do it as it pleases.
+     */
+    constructor(value: string, ...more: string[]);
+    /**
+     * Determines whether a first name has `more` name parts.
+     */
+    get hasMore(): boolean;
+    get length(): number;
+    /**
+     * Returns a combined version of the `value` and `more` if any.
+     */
+    get asNames(): Name[];
+    /**
+     * The additional name parts of the first name.
+     */
+    get more(): string[];
+    toString(withMore?: boolean): string;
+    initials(withMore?: boolean): string[];
+    caps(range?: CapsRange): FirstName;
+    decaps(range?: CapsRange): FirstName;
+    /**
+     * Makes a copy of the current name.
+     */
+    copyWith(values?: {
+        first?: string;
+        more?: string[];
+    }): FirstName;
+}
+/**
+ * Representation of a last name with some extra functionality.
+ */
+export declare class LastName extends Name {
+    readonly format: Surname;
+    private _mother?;
+    /**
+     * Creates an extended version of `Name` and flags it as a last name `type`.
+     *
+     * Some people may keep their `mother`'s surname and want to keep a clear cut
+     * from their `father`'s surname. However, there are no clear rules about it.
+     */
+    constructor(father: string, mother?: string, format?: Surname);
+    /**
+     * The surname inherited from a father side.
+     */
+    get father(): string;
+    /**
+     * The surname inherited from a mother side.
+     */
+    get mother(): string | undefined;
+    /**
+     * Returns `true` if the mother's surname is defined.
+     */
+    get hasMother(): boolean;
+    get length(): number;
+    /**
+     * Returns a combined version of the `father` and `mother` if any.
+     */
+    get asNames(): Name[];
+    toString(format?: Surname): string;
+    initials(format?: Surname): string[];
+    caps(range?: CapsRange): LastName;
+    decaps(range?: CapsRange): LastName;
+    /**
+     * Makes a copy of the current name.
+     */
+    copyWith(values?: {
+        father?: string;
+        mother?: string;
+        format?: Surname;
+    }): LastName;
+}
+/**
+ * JSON signature for `FullName` data.
+ */
+export interface JsonName {
+    prefix?: string;
+    firstName: string;
+    middleName?: string[];
+    lastName: string;
+    suffix?: string;
+}