@leyyo/common 1.0.8 → 1.0.9

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

@@ -0,0 +1,661 @@
+import { ClassLike, EnumLiteral, EnumMap, InitLike, KeyValue, ShiftMain, ShiftSecure } from "../shared";
+import { DevOpt } from "../developer";
+export type AssertionTupleItems = 'notEmpty' | keyof CommonAssertionSingular | keyof KeyOpt1<CommonAssertionSingular> | keyof KeyOpt2<CommonAssertionSingular> | keyof KeyArray1<CommonAssertionSingular> | keyof KeyArray2<CommonAssertionSingular>;
+export type AssertionTupleDuals = 'notEmpty' | keyof CommonAssertionDual | keyof KeyOpt1<CommonAssertionDual> | keyof KeyOpt2<CommonAssertionDual> | keyof KeyArray1<CommonAssertionDual> | keyof KeyArray2<CommonAssertionDual>;
+export type AssertionTupleValue = AssertionTupleItems | [AssertionTupleDuals, any];
+export type AssertionTuple = Array<AssertionTupleValue | ['or', Array<AssertionTupleValue>]>;
+export type AssertionTupleItemLambda = (value: any, opt: string | AssertionCallback | DevOpt) => any;
+export type AssertionTupleDualLambda = (value: any, setting: any, opt: string | AssertionCallback | DevOpt) => any;
+/**
+ * Basic assertions to easy use
+ * */
+export interface CommonAssertionLike extends CommonAssertionSingular, CommonAssertionDual, ShiftSecure<CommonAssertionSecure> {
+    /**
+     * Optional usage of above
+     * @see #instanceOf
+     * */
+    instanceOfOptional<T>(value: any, clazz: ClassLike<T>, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Array usage of above
+     * @see #literal
+     * */
+    instanceOfArray<T>(value: any, clazz: ClassLike<T>, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Optional usage of above
+     * @see #realValue
+     * */
+    tupleOptional(value: any, setting: AssertionTuple, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Array usage of above
+     * @see #literal
+     * */
+    tupleArray(value: any, setting: AssertionTuple, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Optional usage of above
+     * @see #enum
+     * */
+    enumOptional<E extends KeyValue = KeyValue>(value: any, map: EnumMap<E>, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Array usage of above
+     * @see #enum
+     * */
+    enumArray<E extends KeyValue = KeyValue>(value: any, map: EnumMap<E>, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Optional usage of above
+     * @see #orCase
+     * */
+    orCaseOptional(value: any, types: Array<AssertionTupleValue>, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Array usage of above
+     * @see #orCase
+     * */
+    orCaseArray(value: any, types: Array<AssertionTupleValue>, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Optional usage of above
+     * @see #literal
+     * */
+    literalOptional<E extends KeyValue = KeyValue>(value: any, items: EnumLiteral<E>, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Array usage of above
+     * @see #literal
+     * */
+    literalArray<E extends KeyValue = KeyValue>(value: any, items: EnumLiteral<E>, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Asserts value is not empty
+     * @see CommonIsLike#empty
+     *
+     * @param {any} value
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     *
+     * Option cases
+     * - string: issue
+     * - function: it should return {@link DevOpt}
+     * - object: object:
+     * */
+    notEmpty(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Optional usage of above
+     * @see #realValue
+     * */
+    realValueOptional(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Array usage of above
+     * @see #literal
+     * */
+    realValueArray(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Optional usage of above
+     * @see #object
+     * */
+    objectOptional(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Array usage of above
+     * @see #literal
+     * */
+    objectArray(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Optional usage of above
+     * @see #bareObject
+     * */
+    bareObjectOptional(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Array usage of above
+     * @see #literal
+     * */
+    bareObjectArray(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Optional usage of above
+     * @see #bareObject
+     * */
+    anotherObjectOptional(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Array usage of above
+     * @see #literal
+     * */
+    anotherObjectArray(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Optional usage of above
+     * @see #realValue
+     * */
+    arrayLikeOptional(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Array usage of above
+     * @see #literal
+     * */
+    arrayLikeArray(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Optional usage of above
+     * @see #array
+     * */
+    arrayOptional(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Array usage of above
+     * @see #array
+     * */
+    arrayArray(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Optional usage of above
+     * @see #primitive
+     * */
+    primitiveOptional(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Array usage of above
+     * @see #primitive
+     * */
+    primitiveArray(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Optional usage of above
+     * @see #key
+     * */
+    keyOptional(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Array usage of above
+     * @see #key
+     * */
+    keyArray(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Optional usage of above
+     * @see #func
+     * */
+    funcOptional(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Array usage of above
+     * @see #func
+     * */
+    funcArray(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Optional usage of above
+     * @see #sym
+     * */
+    symOptional(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Array usage of above
+     * @see #sym
+     * */
+    symArray(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Optional usage of above
+     * @see #number
+     * */
+    numberOptional(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Array usage of above
+     * @see #number
+     * */
+    numberArray(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Optional usage of above
+     * @see #positiveNumber
+     * */
+    positiveNumberOptional(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Array usage of above
+     * @see #positiveNumber
+     * */
+    positiveNumberArray(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Optional usage of above
+     * @see #nonNegativeNumber
+     * */
+    nonNegativeNumberOptional(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Array usage of above
+     * @see #nonNegativeNumber
+     * */
+    nonNegativeNumberArray(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Optional usage of above
+     * @see #integer
+     * */
+    integerOptional(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Array usage of above
+     * @see #integer
+     * */
+    integerArray(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Optional usage of above
+     * @see #safeInteger
+     * */
+    safeIntegerOptional(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Array usage of above
+     * @see #safeInteger
+     * */
+    safeIntegerArray(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Optional usage of above
+     * @see #positiveInteger
+     * */
+    positiveIntegerOptional(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Array usage of above
+     * @see #positiveInteger
+     * */
+    positiveIntegerArray(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Optional usage of above
+     * @see #positiveInteger
+     * */
+    nonNegativeIntegerOptional(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Array usage of above
+     * @see #positiveInteger
+     * */
+    nonNegativeIntegerArray(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Optional usage of above
+     * @see #string
+     * */
+    stringOptional(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Array usage of above
+     * @see #string
+     * */
+    stringArray(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Optional usage of above
+     * @see #text
+     * */
+    textOptional(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Array usage of above
+     * @see #text
+     * */
+    textArray(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Optional usage of above
+     * @see #clazz
+     * */
+    clazzOptional(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Array usage of above
+     * @see #clazz
+     * */
+    clazzArray(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Optional usage of above
+     * @see #clazz
+     * */
+    possibleFuncOptional(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Array usage of above
+     * @see #clazz
+     * */
+    possibleFuncArray(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Optional usage of above
+     * @see #boolean
+     * */
+    booleanOptional(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Array usage of above
+     * @see #boolean
+     * */
+    booleanArray(value: any, opt?: string | AssertionCallback | DevOpt): void;
+}
+export interface CommonAssertionDual {
+    /**
+     * Asserts value is instance of class
+     *
+     * @param {any} value
+     * @param {ClassLike} clazz
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     *
+     * Option cases
+     * - string: issue
+     * - function: it should return {@link DevOpt}
+     * - object: object:
+     * */
+    instanceOf<T>(value: any, clazz: ClassLike<T>, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Asserts value is a tuple
+     *
+     * @param {any} value
+     * @param {AssertionTuple} setting
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     *
+     * Option cases
+     * - string: issue
+     * - function: it should return {@link DevOpt}
+     * - object: object:
+     * */
+    tuple(value: any, setting: AssertionTuple, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Asserts value is a boolean
+     * @see CommonIsLike#boolean
+     *
+     * @param {any} value
+     * @param {EnumMap} map
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     *
+     * Option cases
+     * - string: issue
+     * - function: it should return {@link DevOpt}
+     * - object: object:
+     * */
+    enum<E extends KeyValue = KeyValue>(value: any, map: EnumMap<E>, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Asserts value is a boolean
+     * @see CommonIsLike#boolean
+     *
+     * @param {any} value
+     * @param {EnumLiteral} items
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     *
+     * Option cases
+     * - string: issue
+     * - function: it should return {@link DevOpt}
+     * - object: object:
+     * */
+    literal<E extends KeyValue = KeyValue>(value: any, items: EnumLiteral<E>, opt?: string | AssertionCallback | DevOpt): void;
+}
+export interface CommonAssertionSingular {
+    /**
+     * Asserts value is a real value
+     * @see CommonIsLike#realValue
+     *
+     * @param {any} value
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     *
+     * Option cases
+     * - string: issue
+     * - function: it should return {@link DevOpt}
+     * - object: object:
+     * */
+    realValue(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Asserts value is an object
+     * @see CommonIsLike#object
+     *
+     * @param {any} value
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     *
+     * Option cases
+     * - string: issue
+     * - function: it should return {@link DevOpt}
+     * - object: object:
+     * */
+    object(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Asserts value is an object
+     * @see CommonIsLike#object
+     *
+     * @param {any} value
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     *
+     * Option cases
+     * - string: issue
+     * - function: it should return {@link DevOpt}
+     * - object: object:
+     * */
+    bareObject(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Asserts value is another object [constructor !== Object] or not?
+     *
+     * @param {any} value
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     * */
+    anotherObject(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Asserts value is array like (array, Set or List) or not?
+     * @see CommonIsLike#arrayLike
+     *
+     * @param {any} value
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     * */
+    arrayLike(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Asserts value is an array
+     * @see CommonIsLike#empty
+     *
+     * @param {any} value
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     *
+     * Option cases
+     * - string: issue
+     * - function: it should return {@link DevOpt}
+     * - object: object:
+     * */
+    array(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Asserts value is a primitive
+     * @see CommonIsLike#primitive
+     *
+     * @param {any} value
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     *
+     * Option cases
+     * - string: issue
+     * - function: it should return {@link DevOpt}
+     * - object: object:
+     * */
+    primitive(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Asserts value is a key
+     * @see CommonIsLike#key
+     *
+     * @param {any} value
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     *
+     * Option cases
+     * - string: issue
+     * - function: it should return {@link DevOpt}
+     * - object: object:
+     * */
+    key(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Asserts value is a function
+     * @see CommonIsLike#func
+     *
+     * @param {any} value
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     *
+     * Option cases
+     * - string: issue
+     * - function: it should return {@link DevOpt}
+     * - object: object:
+     * */
+    func(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Asserts value is a symbol
+     * @see CommonIsLike#func
+     *
+     * @param {any} value
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     *
+     * Option cases
+     * - string: issue
+     * - function: it should return {@link DevOpt}
+     * - object: object:
+     * */
+    sym(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Asserts value is a number
+     * @see CommonIsLike#number
+     *
+     * @param {any} value
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     *
+     * Option cases
+     * - string: issue
+     * - function: it should return {@link DevOpt}
+     * - object: object:
+     * */
+    number(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Asserts value is a positive number
+     * @see CommonIsLike#number
+     *
+     * @param {any} value
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     *
+     * Option cases
+     * - string: issue
+     * - function: it should return {@link DevOpt}
+     * - object: object:
+     * */
+    positiveNumber(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Asserts value is a non-negative number
+     * @see CommonIsLike#number
+     *
+     * @param {any} value
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     *
+     * Option cases
+     * - string: issue
+     * - function: it should return {@link DevOpt}
+     * - object: object:
+     * */
+    nonNegativeNumber(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Asserts value is an integer
+     * @see CommonIsLike#integer
+     *
+     * @param {any} value
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     *
+     * Option cases
+     * - string: issue
+     * - function: it should return {@link DevOpt}
+     * - object: object:
+     * */
+    integer(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Asserts value is a safe integer
+     * @see CommonIsLike#safeInteger
+     *
+     * @param {any} value
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     *
+     * Option cases
+     * - string: issue
+     * - function: it should return {@link DevOpt}
+     * - object: object:
+     * */
+    safeInteger(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Asserts value is a positive integer
+     * @see CommonIsLike#integer
+     *
+     * @param {any} value
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     *
+     * Option cases
+     * - string: issue
+     * - function: it should return {@link DevOpt}
+     * - object: object:
+     * */
+    positiveInteger(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Asserts value is a positive integer
+     * @see CommonIsLike#integer
+     *
+     * @param {any} value
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     *
+     * Option cases
+     * - string: issue
+     * - function: it should return {@link DevOpt}
+     * - object: object:
+     * */
+    nonNegativeInteger(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Asserts value is a string
+     * @see CommonIsLike#string
+     *
+     * @param {any} value
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     *
+     * Option cases
+     * - string: issue
+     * - function: it should return {@link DevOpt}
+     * - object: object:
+     * */
+    string(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Asserts value is a text
+     * @see CommonIsLike#text
+     *
+     * @param {any} value
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     *
+     * Option cases
+     * - string: issue
+     * - function: it should return {@link DevOpt}
+     * - object: object:
+     * */
+    text(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Asserts value is a class
+     * @see CommonIsLike#clazz
+     *
+     * @param {any} value
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     *
+     * Option cases
+     * - string: issue
+     * - function: it should return {@link DevOpt}
+     * - object: object:
+     * */
+    clazz(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Checks value is possible func?
+     * Possible class means: object as instance, string as function name, or function
+     * @see CommonIsLike#possibleFunc
+     *
+     * @param {any} value
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     *
+     * Option cases
+     * - string: issue
+     * - function: it should return {@link DevOpt}
+     * - object: object:
+     * */
+    possibleFunc(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Asserts value is a boolean
+     * @see CommonIsLike#boolean
+     *
+     * @param {any} value
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     *
+     * Option cases
+     * - string: issue
+     * - function: it should return {@link DevOpt}
+     * - object: object:
+     * */
+    boolean(value: any, opt?: string | AssertionCallback | DevOpt): void;
+    /**
+     * Asserts value is any of them
+     *
+     * @param {any} value
+     * @param {Array<AssertionTupleValue>} types
+     * @param {(string | AssertionCallback | DevOpt)?} opt
+     *
+     * Option cases
+     * - string: issue
+     * - function: it should return {@link DevOpt}
+     * - object: object:
+     * */
+    orCase(value: any, types: Array<AssertionTupleValue>, opt?: string | AssertionCallback | DevOpt): void;
+}
+type KeyOpt1<T> = {
+    [K in keyof T as `${string & K}?`]: string;
+};
+type KeyOpt2<T> = {
+    [K in keyof T as `${string & K}Optional`]: string;
+};
+type KeyArray1<T> = {
+    [K in keyof T as `${string & K}[]`]: string;
+};
+type KeyArray2<T> = {
+    [K in keyof T as `${string & K}Array`]: string;
+};
+/**
+ * Secure assertion methods
+ * */
+export type CommonAssertionSecure = ShiftMain<CommonAssertionLike> & InitLike;
+export type AssertionCallback = () => string | DevOpt | [string, string | number, DevOpt?];
+export {};

package/dist/{descriptor/index-types.js → assertion/index.types.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=index-types.js.map
+//# sourceMappingURL=index.types.js.map

package/dist/assertion/index.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.types.js","sourceRoot":"","sources":["../../src/assertion/index.types.ts"],"names":[],"mappings":""}

package/dist/config/common-config.d.ts

@@ -0,0 +1,16 @@
+import { CommonConfigLike, CommonConfigSecure } from "./index.types";
+import { LeyyoLike } from "../leyyo";
+import { Dict } from "../shared";
+export declare class CommonConfig implements CommonConfigLike, CommonConfigSecure {
+    private lyy;
+    private value;
+    constructor(lyy: LeyyoLike);
+    get<R = Dict>(pck?: string): R;
+    private _read;
+    read(): void;
+    toJSON(): unknown;
+    get $secure(): CommonConfigSecure;
+    get $back(): CommonConfigLike;
+    $init(): void;
+    $update(value: Dict): void;
+}