@nextage/nx-frame-be 1.0.1

package/build/common/utils.d.ts

@@ -0,0 +1,552 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { ClassElement } from 'typescript';
+import moment, { Moment } from 'moment';
+import JSZip from 'jszip';
+import schedule from 'node-schedule';
+import jwt from 'jsonwebtoken';
+import UAParser from 'ua-parser-js';
+import { DatePeriod } from './enums';
+import { NxObject, BaseUser, NxContext } from './interfaces';
+export declare function devMode(): boolean;
+export declare function prodMode(): boolean;
+/**
+ *
+ * @param {*} jti
+ */
+export declare function generateJwt(sub: string, jti: string, iss: string, signOpts?: jwt.SignOptions, secret?: jwt.Secret): string;
+/**
+ *
+ * @param {*} token
+ */
+export declare function validateJwt(token: string, options?: jwt.VerifyOptions, secret?: jwt.Secret): string | jwt.Jwt | jwt.JwtPayload;
+/**
+ *
+ * @param {*} size
+ */
+export declare function randomString(size?: number): string;
+/**
+ *
+ * @param {*} a
+ * @param {*} b
+ * @param {*} key
+ */
+export declare function baseComparator(a: string, b: string, key: string): number;
+/**
+ *
+ * @param {*} a
+ * @param {*} b
+ * @param {*} key
+ */
+export declare function baseComparatorReverse(a: string, b: string, key: string): number;
+/**
+ * Returns if a value is an object
+ *
+ * @param {*} value
+ */
+export declare function isObject(value: any): boolean;
+/**
+ * Returns if a value is a function
+ *
+ * @param {*} value
+ */
+export declare function isFunction(value: any): boolean;
+/**
+ * Returns if a value is a date
+ *
+ * @param {*} value
+ */
+export declare function isDate(value: any): boolean;
+/**
+ * Returns if a value is a boolean
+ *
+ * @param {*} value
+ */
+export declare function isBoolean(value: any): boolean;
+/**
+ * Returns if a value is a string
+ *
+ * @param {*} value
+ */
+export declare function isString(value: any): boolean;
+/**
+ * Returns if a value is a number
+ *
+ * @param value
+ */
+export declare function isNumber(value: any): boolean;
+/**
+ * Returns if a value is not null and not undefined
+ *
+ * @param {*} value
+ */
+export declare function isNotNull(value: any): boolean;
+/**
+ *
+ * @param value
+ * @returns
+ */
+export declare function isNil(value: any): boolean;
+/**
+ * Returns if a value is null or undefined
+ *
+ * @param {*} value
+ */
+export declare function isUndefined(value: any): boolean;
+/**
+ * Returns if a value is defined
+ *
+ * @param {*} value
+ */
+export declare function isDefined(value: any): boolean;
+/**
+ *
+ * @param {*} v
+ * @param {*} opts
+ * @returns
+ */
+export declare function isBase64(value: any, opts?: {
+    allowEmpty?: boolean;
+    allowMime?: boolean;
+    mimeRequired?: boolean;
+    paddingRequired?: boolean;
+}): boolean;
+/**
+ * Returns if value is a valid email
+ *
+ * @param {*} value
+ * @returns
+ */
+export declare function isEmail(value: any): boolean;
+/**
+ * Returns true if array contains value
+ *
+ * @param {*} value
+ */
+export declare function contains(arr: any[], value: any): boolean;
+/**
+ * Returns true if array contains value
+ *
+ * @param {*} value
+ */
+export declare function containsArrayValue(arr: any[], value: any): boolean;
+/**
+ * Returns true if empty object or array
+ *
+ * @param {*} item
+ */
+export declare function isEmpty(item: any): boolean;
+/**
+ * Returns true if obj is not empty
+ *
+ * @param {*} value
+ */
+export declare function hasKeys(obj: NxObject): boolean;
+/**
+ *
+ * @param {*} key
+ * @param {*} arrays
+ */
+export declare function mergeArraysByKey(key: string, arrays: any[][]): any[];
+/**
+ *
+ * @param data
+ * @param obj
+ */
+export declare function findDeep(data: any[], attr: string, obj: NxObject): any;
+/**
+ * Percentage Difference between two numbers
+ *
+ * @param  {int}     base  First and original number
+ * @param  {int}     peak  Second new number to differentiate
+ * @param  {boolean} round Round return value to nearest whole numer?
+ * @return {int}     Percentage difference between lowest and highest number
+ */
+export declare function percentDiff(base: number, peak: number, round?: boolean): number;
+/**
+ *
+ * @param {*} obj
+ */
+export declare function dottedKeys(obj: NxObject): string[];
+/**
+ *
+ * @param {*} obj
+ */
+export declare function dotObj(obj: NxObject): NxObject;
+/**
+ * json string parsed to object with regex values management
+ *
+ * @param {*} objStr
+ */
+export declare function strToJson(str: string): NxObject;
+/**
+ * json object parsed to string with regex values management
+ *
+ * @param {*} obj
+ */
+export declare function jsonToStr(obj: NxObject): string;
+/**
+ * Capitalize first char of string
+ * @param text
+ */
+export declare function capitalize(text: string): string;
+/**
+ * Parse string value type coded
+ */
+export declare function parseTypedString(value: string): any;
+/**
+ *
+ * @param {*} period
+ * @param {*} year
+ */
+export declare function toFilterDatePeriod(period: DatePeriod, year: number): {
+    $gte: Date | moment.Moment;
+    $lt: Date | moment.Moment;
+} | {
+    $gte?: undefined;
+    $lt?: undefined;
+};
+/**
+ * Returns if string is valid date
+ *
+ * @param {*} value
+ */
+export declare function isValidDateStr(value: string, format?: string): boolean;
+/**
+ *
+ * @param {*} value
+ */
+export declare function toDate(value: string | Date, format?: string): Date | Date[];
+/**
+ *
+ * @param {*} value
+ * @param {*} format
+ */
+export declare function toMoment(value: string | Date | Moment, format?: string, utc?: boolean): Moment;
+/**
+ *
+ * @param {*} value
+ * @param {*} format
+ */
+export declare function dateFormat(value: Date, format: string): string;
+/**
+ *
+ * @param {*} d1
+ * @param {*} d2
+ * @param {*} period
+ */
+export declare function getDateDiff(d1: Date, d2: Date, period?: moment.unitOfTime.Diff): number;
+/**
+ *
+ * @param {*} date
+ * @param {*} utc
+ */
+export declare function getDateValues(date: Date | Moment, utc?: boolean): {
+    day?: number;
+    month?: number;
+    year?: number;
+};
+/**
+ *
+ * @param {*} date
+ * @param {*} utc
+ */
+export declare function getTimeValues(date: Date | Moment, utc?: boolean): {
+    hour?: number;
+    minute?: number;
+    seconds?: number;
+};
+/**
+ *
+ * @param {*} period
+ * @param {*} year
+ * @param {*} momentValue
+ */
+export declare function getDatePeriod(period: DatePeriod, year: number, momentValue?: boolean): Moment[] | Date[];
+/**
+ *
+ * @param {*} value value to be checked
+ */
+export declare function uuid(value?: string): string;
+/**
+ *
+ * @param {*} obj
+ */
+export declare function logClassCtx(obj: any, method?: string): {
+    context?: string;
+    method?: string;
+};
+/**
+ *
+ * @param obj
+ * @param logger
+ */
+export declare function logMemory(obj: ClassElement, logger?: any): void;
+/**
+ *
+ * @param logger
+ */
+export declare function forceGC(logger?: any): void;
+/**
+ *
+ * @param {*} ctx
+ */
+export declare function getCtxUser(ctx: NxContext): BaseUser | null;
+/**
+ *
+ */
+export declare function flattenArray(arr: any[], parseMethod: Function): any[];
+/**
+ *
+ * @param {*} obj
+ * @param {*} path
+ * @param {*} cloneKey
+ */
+export declare function deleteKey(obj: any, path: string, cloneKey: boolean): any;
+/**
+ *
+ * @param array
+ * @param properties
+ */
+export declare function sortBy(array: any[], properties: string | string[]): any[];
+/**
+ *
+ * @param {*} path
+ * @returns
+ */
+export declare function readFileSync(path: string): string;
+/**
+ *
+ * @param {*} arr1
+ * @param {*} arr2
+ * @returns
+ */
+export declare function union(arr1: any[], arr2: any[]): any[];
+/**
+ *
+ * @param {*} arr
+ * @param {*} iteratee
+ * @returns
+ */
+export declare function uniqBy(arr: any[], iteratee: Function): any[];
+/**
+ *
+ * @param {*} obj1
+ * @param {*} obj2
+ * @returns
+ */
+export declare function merge(obj1: any, obj2: any): any;
+/**
+ *
+ * @param data
+ */
+export declare function clone(data: any): any;
+/**
+ *
+ * @param object
+ * @param path
+ */
+export declare function getAttr(object: any, path: string): any;
+/**
+ *
+ * @param object
+ * @param path
+ * @param value
+ */
+export declare function setAttr(object: any, path: string, value: any): any;
+/**
+ *
+ * @param object
+ * @param path
+ */
+export declare function hasAttr(object: any, path: string): boolean;
+/**
+ *
+ * @param value1
+ * @param value2
+ */
+export declare function isEqual(value1: any, value2: any): boolean;
+/**
+ *
+ * @param {*} value
+ * @param {*} from
+ * @param {*} to
+ */
+export declare function encodeString(value: string, from?: BufferEncoding, to?: BufferEncoding): string;
+/**
+ * Split a string into chunks by specified size
+ * @param {String} stringToChunk The string to split
+ * @param {number} size the size of character to use to split the string
+ */
+export declare function chunkString(stringToChunk: string, size: number): string[];
+/**
+ * Initialize an object by a given dot notation structure
+ * eg.
+ *  'service.url' -> { service: { url: value } }
+ * @param {String} path the dot notation string representation of property
+ * @param {*} value the value to be used
+ */
+export declare function initObjectFromDotNotation(path: string, value: any): any;
+/**
+ * Initialize an object with a dot notation property name
+ * eg.
+ *  'service.url' -> { "service.url": value }
+ * @param {String} path
+ * @param {*} value
+ */
+export declare function initObjectWithProperty(path: string, value: any): any;
+/**
+ * Resize phrase Buffer by given size
+ * @param   { Buffer } phrase
+ * @param   { number } size
+ * @returns { Buffer } Given size buffer based on given phrase buffer
+ */
+export declare function resizeBuffer(buffer: Buffer, size: number): Buffer;
+/**
+ * Generate a random Hex string (using sha256 HASH Algorithm)
+ * @returns { Buffer } Buffer representation of hash
+ */
+export declare function generateRandomHex(): Buffer;
+/**
+ * Generate random buffer of specified size
+ * @param { number } bitSize bit size of the buffer
+ * @returns { Buffer } Given size random Buffer
+ */
+export declare function generateRandomBuffer(bitSize: number): Buffer;
+/**
+ * Use object to filter another object
+ * @param {*} obj
+ * @param {*} filterObj
+ */
+export declare function filterObject(obj: any, filterObj: any): any;
+/**
+ *
+ * @param {*} request
+ */
+export declare function parseUserAgent(req: Request): UAParser.IResult;
+/**
+ *
+ * @param {*} rule
+ * @param {*} options
+ * @param {*} method
+ */
+export declare function scheduleJob(rule: any, { recurrence, startTime, endTime }: {
+    recurrence?: boolean;
+    startTime?: string;
+    endTime?: string;
+}, method?: () => void): schedule.Job | null;
+/**
+ * Schedule multiple jobs.
+ * Input rules have following format:
+ * { rule (string/obj), recurrence (bool), method (function) }
+ *
+ * Example:
+ *   let jobs = scheduleJobs([
+ *     { rule: { minute: 56 }, options: { recurrence: true }, method: () => { console.log('JOB AT MIN 56!') } },
+ *     { rule: '* * * * *',    options: { recurrence: true }, method: () => { console.log('JOB EVERY MINUTE!') } },
+ *     { rule: '* * * * *',    options: { recurrence: true, startTime: '10:55' }, method: () => { console.log('JOB EVERY MINUTE after 10:53!') } }
+ *   ]);
+ *
+ * @param {*} rules array of rules objects
+ */
+export declare function scheduleJobs(rules?: any[]): schedule.Job[];
+/**
+ * Test password security / complexity criteria
+ *
+ * @param {*} pwd
+ * @returns
+ */
+export declare function checkPasswordComplexity(pwd: string): boolean;
+/**
+ * Test password security / complexity criteria
+ *
+ * @param {*} pwd
+ * @returns
+ */
+export declare function checkCommonPassword(commonPwds: string[], pwd: string): boolean;
+/**
+ * Zip and save a folder
+ *
+ * @param {*} path
+ * @param {*} name
+ * @param {*} callback
+ */
+export declare function zipFolder(path: string, name: string): Promise<unknown>;
+/**
+ *
+ * @param {*} path
+ * @param {*} name
+ * @param {*} stream
+ * @param {*} callback
+ */
+export declare function zipFolderStream(path: string, name: string): NodeJS.ReadableStream;
+/**
+ * Add files to zip object
+ *
+ * @param {*} dir
+ * @param {*} zip
+ * @param {*} callback
+ */
+export declare function addDirectoryToZip(path: string, dir: string, zip: JSZip): JSZip;
+/**
+ * Push in array and return value
+ *
+ * @param {*} arr
+ * @param {*} value
+ * @returns
+ */
+export declare function arrayPushRef(arr: any[] | undefined, value: any): any;
+/**
+ *
+ * @param {*} arr
+ * @param {*} item
+ * @param {*} attr
+ * @returns
+ */
+export declare function arrayPushUniq(arr: any[] | undefined, item: any, attr: string): void;
+/**
+ *
+ * @param {*} arr
+ * @param {*} item
+ * @param {*} attr
+ * @returns
+ */
+export declare function arrayToggle(arr: any[] | undefined, item: any, attr: string): void;
+/**
+ *
+ * @param {*} arrays
+ * @returns
+ */
+export declare function intersectArrays(arrays?: never[]): unknown[];
+/**
+ *
+ * @param {*} arrays
+ * @returns
+ */
+export declare function intersectArraysBy(arr: any[] | undefined, iteratee: any): unknown[];
+/**
+ * Get last child in a tree like structure array
+ * { _id: '', children: [{ _id: '', parent: '', children: [...] }]}
+ *
+ * @param {*} item
+ * @param {*} attr
+ * @param {*} arr
+ * @returns
+ */
+export declare function getLastChild(item: any, attr?: string, arr?: any[]): any;
+/**
+ *  * Get an array with last childern in a tree like structure array
+ * { _id: '', children: [{ _id: '', parent: '', children: [...] }]}
+ *
+ * @param {*} item
+ * @param {*} attr
+ * @param {*} arr
+ * @returns
+ */
+export declare function getLastChildren(items: any[], attr?: string, arr?: any[]): any;
+/**
+ *
+ * @param {*} str
+ * @returns
+ */
+export declare function validDataUrl(str: string): boolean;