@samet-it/be-base-common 1.0.1

package/dist/generator/index.types.d.ts

@@ -0,0 +1,616 @@
+export type DateType = 'year' | 'y' | 'month' | 'm' | 'day' | 'd';
+export type TimeType = 'hour' | 'h' | 'minute' | 'i' | 'second' | 's';
+export type DateTimeType = DateType | TimeType;
+export type PastFuture = 'past' | 'future' | 'both';
+export type GeneratorItemLambda<T> = () => T;
+export interface GeneratorLike {
+    /**
+     * Enrich instance, it should be called in the constructor
+     *
+     * @param {object} instance - `this` instance
+     * @param {object} given - incoming data
+     * */
+    buildConstructor<T extends {} = {}>(instance: T, given: Partial<T>): void;
+    /**
+     * Loops n times
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {function} callback
+     * */
+    forLength<T>(size: number | true, callback: GeneratorItemLambda<T>): Array<T>;
+    /**
+     * Generates a word
+     * */
+    word(): string;
+    /**
+     * Generates a word with a specific length
+     *
+     * @param {number} length - text length
+     * */
+    word(length: number): string;
+    /**
+     * Generates a word with a specific length
+     *
+     * @param {number} length - text length
+     * @param {string} alphabet - text pattern to generate
+     * */
+    word(length: number, alphabet: string): string;
+    /**
+     * Generates a word
+     *
+     * @param {string} alphabet - text pattern to generate
+     * */
+    word(alphabet: string): string;
+    /**
+     * Generates a word array
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * */
+    wordArray(size: number | true): Array<string>;
+    /**
+     * Generates a word array with a specific length
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {number} length - text length
+     * */
+    wordArray(size: number | true, length: number): Array<string>;
+    /**
+     * Generates a word array with a specific length
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {number} length - text length
+     * @param {string} alphabet - text pattern to generate
+     * */
+    wordArray(size: number | true, length: number, alphabet: string): Array<string>;
+    /**
+     * Generates a word array
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {string} alphabet - text pattern to generate
+     * */
+    wordArray(size: number | true, alphabet: string): Array<string>;
+    /**
+     * Generates a numeric string
+     * */
+    numeric(): string;
+    /**
+     * Generates a numeric string with a specific length
+     *
+     * @param {number} length - text length
+     * */
+    numeric(length: number): string;
+    /**
+     * Generates a numeric string array
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * */
+    numericArray(size: number | true): Array<string>;
+    /**
+     * Generates a numeric string array with a specific length
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {number} length - text length
+     * */
+    numericArray(size: number | true, length: number): Array<string>;
+    /**
+     * Generates a first upper case string
+     * */
+    firstUpper(): string;
+    /**
+     * Generates a first upper case with a specific length
+     *
+     * @param {number} length - text length
+     * */
+    firstUpper(length: number): string;
+    /**
+     * Generates a first upper case array
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * */
+    firstUpperArray(size: number | true): Array<string>;
+    /**
+     * Generates a first upper case array with a specific length
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {number} length - text length
+     * */
+    firstUpperArray(size: number | true, length: number): Array<string>;
+    /**
+     * Generates an upper case string
+     * */
+    upper(): string;
+    /**
+     * Generates an upper case string with a specific length
+     *
+     * @param {number} length - text length
+     * */
+    upper(length: number): string;
+    /**
+     * Generates an upper case string array
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * */
+    upperArray(size: number | true): Array<string>;
+    /**
+     * Generates an upper case string array with a specific length
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {number} length - text length
+     * */
+    upperArray(size: number | true, length: number): Array<string>;
+    /**
+     * Generates a lower case string
+     * */
+    lower(): string;
+    /**
+     * Generates a lower case string with a specific length
+     *
+     * @param {number} length - text length
+     * */
+    lower(length: number): string;
+    /**
+     * Generates a lower case string array
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * */
+    lowerArray(size: number | true): Array<string>;
+    /**
+     * Generates a lower case string array with a specific length
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {number} length - text length
+     * */
+    lowerArray(size: number | true, length: number): Array<string>;
+    /**
+     * Generates a lorem ipsum
+     * */
+    loremIpsum(): string;
+    /**
+     * Generates a lorem ipsum with a specific word count
+     * @param {number} count - word count
+     * */
+    loremIpsum(count: number): string;
+    /**
+     * Generates a lorem ipsum array
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * */
+    loremIpsumArray(size: number | true): Array<string>;
+    /**
+     * Generates a lorem ipsum array with a specific word count
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {number} count - word count
+     * */
+    loremIpsumArray(size: number | true, count: number): Array<string>;
+    /**
+     * Generates an integer
+     * */
+    integer(): number;
+    /**
+     * Generates an integer with max
+     *
+     * @param {number} max - max limit
+     * */
+    integer(max: number): number;
+    /**
+     * Generates an integer with min and max
+     *
+     * @param {number} min - min limit
+     * @param {number} max - max limit
+     * */
+    integer(min: number, max: number): number;
+    /**
+     * Generates an integer array
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * */
+    integerArray(size: number | true): Array<number>;
+    /**
+     * Generates an integer array with max
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {number} max - max limit
+     * */
+    integerArray(size: number | true, max: number): Array<number>;
+    /**
+     * Generates an integer array with min and max
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {number} min - min limit
+     * @param {number} max - max limit
+     * */
+    integerArray(size: number | true, min: number, max: number): Array<number>;
+    /**
+     * Generates a double
+     * */
+    double(): number;
+    /**
+     * Generates a double with max
+     *
+     * @param {number} max - max limit
+     * */
+    double(max: number): number;
+    /**
+     * Generates a double with min and max
+     *
+     * @param {number} min - min limit
+     * @param {number} max - max limit
+     * */
+    double(min: number, max: number): number;
+    /**
+     * Generates a double array
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * */
+    doubleArray(size: number | true): Array<number>;
+    /**
+     * Generates a double array with max
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {number} max - max limit
+     * */
+    doubleArray(size: number | true, max: number): Array<number>;
+    /**
+     * Generates a double array with min and max
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {number} min - min limit
+     * @param {number} max - max limit
+     * */
+    doubleArray(size: number | true, min: number, max: number): Array<number>;
+    /**
+     * Generates an uuid
+     * */
+    uuid(): string;
+    /**
+     * Generates an uuid array
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * */
+    uuidArray(size: number | true): Array<string>;
+    /**
+     * Generates a boolean
+     * */
+    boolean(): boolean;
+    /**
+     * Generates a boolean array
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * */
+    booleanArray(size: number | true): Array<boolean>;
+    /**
+     * Generates a timestamp
+     * */
+    timestamp(): number;
+    /**
+     * Generates a timestamp with type
+     *
+     * @param {DateTimeType} type - time part for multiplier
+     * */
+    timestamp(type: DateTimeType): number;
+    /**
+     * Generates a timestamp with type and multiplier
+     *
+     * @param {DateTimeType} type - time part for multiplier
+     * @param {number} multiplier - multiplier of part
+     * */
+    timestamp(type: DateTimeType, multiplier: number): number;
+    /**
+     * Generates a timestamp with type and multiplier and past-future option
+     *
+     * @param {DateTimeType} type - time part for multiplier
+     * @param {number} multiplier - multiplier of part
+     * @param {PastFuture} pastFuture - past-future option for multiplier
+     * */
+    timestamp(type: DateTimeType, multiplier: number, pastFuture: PastFuture): number;
+    /**
+     * Generates a timestamp array
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * */
+    timestampArray(size: number | true): Array<number>;
+    /**
+     * Generates a timestamp array with type
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {DateTimeType} type - time part for multiplier
+     * */
+    timestampArray(size: number | true, type: DateTimeType): Array<number>;
+    /**
+     * Generates a timestamp array with type and multiplier
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {DateTimeType} type - time part for multiplier
+     * @param {number} multiplier - multiplier of part
+     * */
+    timestampArray(size: number | true, type: DateTimeType, multiplier: number): Array<number>;
+    /**
+     * Generates a timestamp array with type and multiplier and past-future option
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {DateTimeType} type - time part for multiplier
+     * @param {number} multiplier - multiplier of part
+     * @param {PastFuture} pastFuture - past-future option for multiplier
+     * */
+    timestampArray(size: number | true, type: DateTimeType, multiplier: number, pastFuture: PastFuture): Array<number>;
+    /**
+     * Generates a datetime
+     * */
+    datetime(): Date;
+    /**
+     * Generates a datetime with type
+     *
+     * @param {DateTimeType} type - time part for multiplier
+     * */
+    datetime(type: DateTimeType): Date;
+    /**
+     * Generates a datetime with type and multiplier
+     *
+     * @param {DateTimeType} type - time part for multiplier
+     * @param {number} multiplier - multiplier of part
+     * */
+    datetime(type: DateTimeType, multiplier: number): Date;
+    /**
+     * Generates a datetime with type and multiplier and past-future option
+     *
+     * @param {DateTimeType} type - time part for multiplier
+     * @param {number} multiplier - multiplier of part
+     * @param {PastFuture} pastFuture - past-future option for multiplier
+     * */
+    datetime(type: DateTimeType, multiplier: number, pastFuture: PastFuture): Date;
+    /**
+     * Generates a datetime array
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * */
+    datetimeArray(size: number | true): Array<Date>;
+    /**
+     * Generates a datetime array with type
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {DateTimeType} type - time part for multiplier
+     * */
+    datetimeArray(size: number | true, type: DateTimeType): Array<Date>;
+    /**
+     * Generates a datetime array with type and multiplier
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {DateTimeType} type - time part for multiplier
+     * @param {number} multiplier - multiplier of part
+     * */
+    datetimeArray(size: number | true, type: DateTimeType, multiplier: number): Array<Date>;
+    /**
+     * Generates a datetime array with type and multiplier and past-future option
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {DateTimeType} type - time part for multiplier
+     * @param {number} multiplier - multiplier of part
+     * @param {PastFuture} pastFuture - past-future option for multiplier
+     * */
+    datetimeArray(size: number | true, type: DateTimeType, multiplier: number, pastFuture: PastFuture): Array<Date>;
+    /**
+     * Generates a datetime
+     * */
+    isoDate(): string;
+    /**
+     * Generates a datetime with type
+     *
+     * @param {DateTimeType} type - time part for multiplier
+     * */
+    isoDate(type: DateTimeType): string;
+    /**
+     * Generates a datetime with type and multiplier
+     *
+     * @param {DateTimeType} type - time part for multiplier
+     * @param {number} multiplier - multiplier of part
+     * */
+    isoDate(type: DateTimeType, multiplier: number): string;
+    /**
+     * Generates a datetime with type and multiplier and past-future option
+     *
+     * @param {DateTimeType} type - time part for multiplier
+     * @param {number} multiplier - multiplier of part
+     * @param {PastFuture} pastFuture - past-future option for multiplier
+     * */
+    isoDate(type: DateTimeType, multiplier: number, pastFuture: PastFuture): string;
+    /**
+     * Generates a datetime array
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * */
+    isoDateArray(size: number | true): Array<string>;
+    /**
+     * Generates a datetime array with type
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {DateTimeType} type - time part for multiplier
+     * */
+    isoDateArray(size: number | true, type: DateTimeType): Array<string>;
+    /**
+     * Generates a datetime array with type and multiplier
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {DateTimeType} type - time part for multiplier
+     * @param {number} multiplier - multiplier of part
+     * */
+    isoDateArray(size: number | true, type: DateTimeType, multiplier: number): Array<string>;
+    /**
+     * Generates a datetime array with type and multiplier and past-future option
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {DateTimeType} type - time part for multiplier
+     * @param {number} multiplier - multiplier of part
+     * @param {PastFuture} pastFuture - past-future option for multiplier
+     * */
+    isoDateArray(size: number | true, type: DateTimeType, multiplier: number, pastFuture: PastFuture): Array<string>;
+    /**
+     * Generates a date
+     * */
+    date(): string;
+    /**
+     * Generates a date with type
+     *
+     * @param {DateType} type - date part for multiplier
+     * */
+    date(type: DateType): string;
+    /**
+     * Generates a date with type and multiplier
+     *
+     * @param {DateType} type - date part for multiplier
+     * @param {number} multiplier - multiplier of part
+     * */
+    date(type: DateType, multiplier: number): string;
+    /**
+     * Generates a date with type and multiplier and past-future option
+     *
+     * @param {DateType} type - date part for multiplier
+     * @param {number} multiplier - multiplier of part
+     * @param {PastFuture} pastFuture - past-future option for multiplier
+     * */
+    date(type: DateType, multiplier: number, pastFuture: PastFuture): string;
+    /**
+     * Generates a date array
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * */
+    dateArray(size: number | true): Array<string>;
+    /**
+     * Generates a date array with type
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {DateType} type - date part for multiplier
+     * */
+    dateArray(size: number | true, type: DateType): Array<string>;
+    /**
+     * Generates a date array with type and multiplier
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {DateType} type - date part for multiplier
+     * @param {number} multiplier - multiplier of part
+     * */
+    dateArray(size: number | true, type: DateType, multiplier: number): Array<string>;
+    /**
+     * Generates a date array with type and multiplier and past-future option
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {DateType} type - date part for multiplier
+     * @param {number} multiplier - multiplier of part
+     * @param {PastFuture} pastFuture - past-future option for multiplier
+     * */
+    dateArray(size: number | true, type: DateType, multiplier: number, pastFuture: PastFuture): Array<string>;
+    /**
+     * Generates a time like `23:59:59`
+     * */
+    time(): string;
+    /**
+     * Generates a time like `23:59:59` with type
+     *
+     * @param {DateType} type - date part for multiplier
+     * */
+    time(type: TimeType): string;
+    /**
+     * Generates a time like `23:59:59` with type and multiplier
+     *
+     * @param {DateType} type - date part for multiplier
+     * @param {number} multiplier - multiplier of part
+     * */
+    time(type: TimeType, multiplier: number): string;
+    /**
+     * Generates a time like `23:59:59` with type and multiplier and past-future option
+     *
+     * @param {DateType} type - date part for multiplier
+     * @param {number} multiplier - multiplier of part
+     * @param {PastFuture} pastFuture - past-future option for multiplier
+     * */
+    time(type: TimeType, multiplier: number, pastFuture: PastFuture): string;
+    /**
+     * Generates a time array like [`23:59:59`]
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * */
+    timeArray(size: number | true): Array<string>;
+    /**
+     * Generates a time array like [`23:59:59`] with type
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {DateType} type - date part for multiplier
+     * */
+    timeArray(size: number | true, type: TimeType): Array<string>;
+    /**
+     * Generates a time array like [`23:59:59`] with type and multiplier
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {DateType} type - date part for multiplier
+     * @param {number} multiplier - multiplier of part
+     * */
+    timeArray(size: number | true, type: TimeType, multiplier: number): Array<string>;
+    /**
+     * Generates a time array like [`23:59:59`] with type and multiplier and past-future option
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {DateType} type - date part for multiplier
+     * @param {number} multiplier - multiplier of part
+     * @param {PastFuture} pastFuture - past-future option for multiplier
+     * */
+    timeArray(size: number | true, type: TimeType, multiplier: number, pastFuture: PastFuture): Array<string>;
+    /**
+     * Generates an enum
+     *
+     * @param {Array} keys - enum keys
+     * */
+    enum<T = string>(keys: unknown): T;
+    /**
+     * Generates an enum
+     *
+     * @param {Array} keys - enum keys
+     * */
+    enum<T = string>(keys: Array<string | number>): T;
+    /**
+     * Generates an enum
+     *
+     * @param {object} map - enum map
+     * */
+    enum<T = string>(map: Record<string, string | number>): T;
+    /**
+     * Generates an enum array
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     *
+     * @param {Array} keys - enum keys
+     * */
+    enumArray<T = string>(size: number | true, keys: unknown): Array<T>;
+    /**
+     * Generates an enum array
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     *
+     * @param {Array} keys - enum keys
+     * */
+    enumArray<T = string>(size: number | true, keys: Array<string | number>): Array<T>;
+    /**
+     * Generates an enum array
+     *
+     * @param {(number|true)} size - array size, if true then random(1,5)
+     * @param {object} map - enum map
+     * */
+    enumArray<T = string>(size: number | true, map: Record<string, string | number>): Array<T>;
+    /**
+     * Generates an urn
+     *
+     * @param {number} size - size of parts
+     * @param {string[]} keys - domain parts
+     * */
+    urn(size: number, ...keys: string[]): string;
+    /**
+     * Generates an urn
+     *
+     * @param {string[]} keys - domain parts
+     * */
+    urn(...keys: string[]): string;
+    /**
+     * Generates an urn
+     *
+     * */
+    urn(): string;
+}

package/dist/generator/index.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './config';
+export * from './error';
+export * from './exit';
+export * from './generator';
+export * from './shared';

package/dist/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (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" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./config"), exports);
+__exportStar(require("./error"), exports);
+__exportStar(require("./exit"), exports);
+__exportStar(require("./generator"), exports);
+__exportStar(require("./shared"), exports);

package/dist/shared/index.d.ts

@@ -0,0 +1 @@
+export * from './index.types';

package/dist/shared/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (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" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./index.types"), exports);

package/dist/shared/index.types.d.ts

@@ -0,0 +1,11 @@
+interface _Func {
+    readonly name?: string;
+    readonly length?: number;
+    bind(thisArg: any, ...args: Array<any>): any;
+    apply(thisArg: any, args: Array<any>): any;
+    call(thisArg: any, ...args: Array<any>): any;
+}
+export interface ClassLike<T = {}> extends _Func {
+    new (...args: Array<any>): T;
+}
+export {};

package/dist/shared/index.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });