@leyyo/common 1.0.4 → 1.0.6

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

@@ -1,66 +1,12 @@
-import { Arr, AssertionCallback, AssertionOpt, InitLike, ShiftMain, ShiftSecure, ToTypeOpt } from "../shared";
+import { InitLike, ShiftMain, ShiftSecure } from "../shared";
+import { DevOpt } from "../developer";
 /**
  * Basic assertions to easy use
  * */
-export interface CommonAssertion extends ShiftSecure<CommonAssertionSecure> {
-    /**
-     * Raises an error with given parameters
-     *
-     * @param {string} message - error message
-     * @param {any?} value
-     * @param {string?} indicator - developer indicator
-     * @param {string?} def - default error message
-     * */
-    raise(message: string, value?: any, indicator?: string, def?: string): void;
-    /**
-     * Raises an error with given parameters
-     *
-     * @param {AssertionCallback} fn - callback which should return {@link AssertionOpt}
-     * @param {any?} value
-     * @param {string?} indicator - developer indicator
-     * @param {string?} def - default error message
-     * */
-    raise(fn: AssertionCallback, value?: any, indicator?: string, def?: string): void;
-    /**
-     * Raises an error with given parameters
-     *
-     * @param {AssertionOpt} opt - options
-     * @param {any?} value
-     * @param {string?} indicator - developer indicator
-     * @param {string?} def - default error message
-     * */
-    raise(opt: AssertionOpt, value?: any, indicator?: string, def?: string): void;
-    /**
-     * Empty function, it can be more useful sometimes
-     *
-     * @param {Arr} params - insignificant parameters
-     * */
-    emptyFn(...params: Arr): void;
-    /**
-     * Converts ant value secure json value
-     *
-     * Controls:
-     * - circular dependency
-     * - depth control
-     * - handling function and symbol values
-     *
-     * @param {any} value
-     * @returns {any} - it based on generic
-     * */
-    secureJson<E = unknown>(value: any): E;
-    /**
-     * Validates value is real number
-     *
-     * Real number means: !NaN and isFinite
-     *
-     * @param {any} value
-     * @param {ToTypeOpt} opt
-     * @returns {number}
-     * */
-    realNumber(value: number, opt?: ToTypeOpt): number;
+export interface CommonAssertionLike extends ShiftSecure<CommonAssertionSecure> {
     /**
      * Asserts value is not empty
-     * @see CommonIs#empty
+     * @see CommonIsLike#empty
      *
      * @param {any} value
      * @param {string?} message
@@ -68,23 +14,23 @@ export interface CommonAssertion extends ShiftSecure<CommonAssertionSecure> {
     notEmpty(value: any, message?: string): void;
     /**
      * Asserts value is not empty
-     * @see CommonIs#empty
+     * @see CommonIsLike#empty
      *
      * @param {any} value
-     * @param {AssertionCallback?} fn - it should return {@link AssertionOpt}
+     * @param {AssertionCallback?} fn - it should return {@link DevOpt}
      * */
     notEmpty(value: any, fn?: AssertionCallback): void;
     /**
      * Asserts value is not empty
-     * @see CommonIs#empty
+     * @see CommonIsLike#empty
      *
      * @param {any} value
-     * @param {AssertionOpt?} opt
+     * @param {DevOpt?} opt
      * */
-    notEmpty(value: any, opt?: AssertionOpt): void;
+    notEmpty(value: any, opt?: DevOpt): void;
     /**
      * Asserts value is a primitive
-     * @see CommonIs#primitive
+     * @see CommonIsLike#primitive
      *
      * @param {any} value
      * @param {string?} message
@@ -92,23 +38,23 @@ export interface CommonAssertion extends ShiftSecure<CommonAssertionSecure> {
     primitive(value: any, message?: string): void;
     /**
      * Asserts value is a primitive
-     * @see CommonIs#primitive
+     * @see CommonIsLike#primitive
      *
      * @param {any} value
-     * @param {AssertionCallback?} fn - it should return {@link AssertionOpt}
+     * @param {AssertionCallback?} fn - it should return {@link DevOpt}
      * */
     primitive(value: any, fn?: AssertionCallback): void;
     /**
      * Asserts value is a primitive
-     * @see CommonIs#primitive
+     * @see CommonIsLike#primitive
      *
      * @param {any} value
-     * @param {AssertionOpt?} opt
+     * @param {DevOpt?} opt
      * */
-    primitive(value: any, opt?: AssertionOpt): void;
+    primitive(value: any, opt?: DevOpt): void;
     /**
      * Asserts value is a real value
-     * @see CommonIs#realValue
+     * @see CommonIsLike#realValue
      *
      * @param {any} value
      * @param {string?} message
@@ -116,23 +62,23 @@ export interface CommonAssertion extends ShiftSecure<CommonAssertionSecure> {
     realValue(value: any, message?: string): void;
     /**
      * Asserts value is a real value
-     * @see CommonIs#realValue
+     * @see CommonIsLike#realValue
      *
      * @param {any} value
-     * @param {AssertionCallback?} fn - it should return {@link AssertionOpt}
+     * @param {AssertionCallback?} fn - it should return {@link DevOpt}
      * */
     realValue(value: any, fn?: AssertionCallback): void;
     /**
      * Asserts value is a real value
-     * @see CommonIs#realValue
+     * @see CommonIsLike#realValue
      *
      * @param {any} value
-     * @param {AssertionOpt?} opt
+     * @param {DevOpt?} opt
      * */
-    realValue(value: any, opt?: AssertionOpt): void;
+    realValue(value: any, opt?: DevOpt): void;
     /**
      * Asserts value is a key
-     * @see CommonIs#key
+     * @see CommonIsLike#key
      *
      * @param {any} value
      * @param {string?} message
@@ -140,23 +86,23 @@ export interface CommonAssertion extends ShiftSecure<CommonAssertionSecure> {
     key(value: any, message?: string): void;
     /**
      * Asserts value is a key
-     * @see CommonIs#key
+     * @see CommonIsLike#key
      *
      * @param {any} value
-     * @param {AssertionCallback?} fn - it should return {@link AssertionOpt}
+     * @param {AssertionCallback?} fn - it should return {@link DevOpt}
      * */
     key(value: any, fn?: AssertionCallback): void;
     /**
      * Asserts value is a key
-     * @see CommonIs#key
+     * @see CommonIsLike#key
      *
      * @param {any} value
-     * @param {AssertionOpt?} opt
+     * @param {DevOpt?} opt
      * */
-    key(value: any, opt?: AssertionOpt): void;
+    key(value: any, opt?: DevOpt): void;
     /**
      * Asserts value is an object
-     * @see CommonIs#object
+     * @see CommonIsLike#object
      *
      * @param {any} value
      * @param {string?} message
@@ -164,23 +110,47 @@ export interface CommonAssertion extends ShiftSecure<CommonAssertionSecure> {
     object(value: any, message?: string): void;
     /**
      * Asserts value is an object
-     * @see CommonIs#object
+     * @see CommonIsLike#object
      *
      * @param {any} value
-     * @param {AssertionCallback?} fn - it should return {@link AssertionOpt}
+     * @param {AssertionCallback?} fn - it should return {@link DevOpt}
      * */
     object(value: any, fn?: AssertionCallback): void;
     /**
      * Asserts value is an object
-     * @see CommonIs#object
+     * @see CommonIsLike#object
      *
      * @param {any} value
-     * @param {AssertionOpt?} opt
+     * @param {DevOpt?} opt
      * */
-    object(value: any, opt?: AssertionOpt): void;
+    object(value: any, opt?: DevOpt): void;
+    /**
+     * Asserts value is an object
+     * @see CommonIsLike#object
+     *
+     * @param {any} value
+     * @param {string?} message
+     * */
+    bareObject(value: any, message?: string): void;
+    /**
+     * Asserts value is an object
+     * @see CommonIsLike#object
+     *
+     * @param {any} value
+     * @param {AssertionCallback?} fn - it should return {@link DevOpt}
+     * */
+    bareObject(value: any, fn?: AssertionCallback): void;
+    /**
+     * Asserts value is an object
+     * @see CommonIsLike#object
+     *
+     * @param {any} value
+     * @param {DevOpt?} opt
+     * */
+    bareObject(value: any, opt?: DevOpt): void;
     /**
      * Asserts value is an array
-     * @see CommonIs#empty
+     * @see CommonIsLike#empty
      *
      * @param {any} value
      * @param {string?} message
@@ -188,23 +158,23 @@ export interface CommonAssertion extends ShiftSecure<CommonAssertionSecure> {
     array(value: any, message?: string): void;
     /**
      * Asserts value is an array
-     * @see CommonIs#array
+     * @see CommonIsLike#array
      *
      * @param {any} value
-     * @param {AssertionCallback?} fn - it should return {@link AssertionOpt}
+     * @param {AssertionCallback?} fn - it should return {@link DevOpt}
      * */
     array(value: any, fn?: AssertionCallback): void;
     /**
      * Asserts value is an array
-     * @see CommonIs#array
+     * @see CommonIsLike#array
      *
      * @param {any} value
-     * @param {AssertionOpt?} opt
+     * @param {DevOpt?} opt
      * */
-    array(value: any, opt?: AssertionOpt): void;
+    array(value: any, opt?: DevOpt): void;
     /**
      * Asserts value is a function
-     * @see CommonIs#func
+     * @see CommonIsLike#func
      *
      * @param {any} value
      * @param {string?} message
@@ -212,23 +182,47 @@ export interface CommonAssertion extends ShiftSecure<CommonAssertionSecure> {
     func(value: any, message?: string): void;
     /**
      * Asserts value is a function
-     * @see CommonIs#func
+     * @see CommonIsLike#func
      *
      * @param {any} value
-     * @param {AssertionCallback?} fn - it should return {@link AssertionOpt}
+     * @param {AssertionCallback?} fn - it should return {@link DevOpt}
      * */
     func(value: any, fn?: AssertionCallback): void;
     /**
      * Asserts value is a function
-     * @see CommonIs#func
+     * @see CommonIsLike#func
+     *
+     * @param {any} value
+     * @param {DevOpt?} opt
+     * */
+    func(value: any, opt?: DevOpt): void;
+    /**
+     * Asserts value is a symbol
+     * @see CommonIsLike#func
+     *
+     * @param {any} value
+     * @param {string?} message
+     * */
+    sym(value: any, message?: string): void;
+    /**
+     * Asserts value is a symbol
+     * @see CommonIsLike#func
+     *
+     * @param {any} value
+     * @param {AssertionCallback?} fn - it should return {@link DevOpt}
+     * */
+    sym(value: any, fn?: AssertionCallback): void;
+    /**
+     * Asserts value is a symbol
+     * @see CommonIsLike#sym
      *
      * @param {any} value
-     * @param {AssertionOpt?} opt
+     * @param {DevOpt?} opt
      * */
-    func(value: any, opt?: AssertionOpt): void;
+    sym(value: any, opt?: DevOpt): void;
     /**
      * Asserts value is a number
-     * @see CommonIs#number
+     * @see CommonIsLike#number
      *
      * @param {any} value
      * @param {string?} message
@@ -236,23 +230,23 @@ export interface CommonAssertion extends ShiftSecure<CommonAssertionSecure> {
     number(value: any, message?: string): void;
     /**
      * Asserts value is a number
-     * @see CommonIs#number
+     * @see CommonIsLike#number
      *
      * @param {any} value
-     * @param {AssertionCallback?} fn - it should return {@link AssertionOpt}
+     * @param {AssertionCallback?} fn - it should return {@link DevOpt}
      * */
     number(value: any, fn?: AssertionCallback): void;
     /**
      * Asserts value is a number
-     * @see CommonIs#number
+     * @see CommonIsLike#number
      *
      * @param {any} value
-     * @param {AssertionOpt?} opt
+     * @param {DevOpt?} opt
      * */
-    number(value: any, opt?: AssertionOpt): void;
+    number(value: any, opt?: DevOpt): void;
     /**
      * Asserts value is a positive number
-     * @see CommonIs#number
+     * @see CommonIsLike#number
      *
      * @param {any} value
      * @param {string?} message
@@ -260,23 +254,23 @@ export interface CommonAssertion extends ShiftSecure<CommonAssertionSecure> {
     positiveNumber(value: any, message?: string): void;
     /**
      * Asserts value is a positive number
-     * @see CommonIs#number
+     * @see CommonIsLike#number
      *
      * @param {any} value
-     * @param {AssertionCallback?} fn - it should return {@link AssertionOpt}
+     * @param {AssertionCallback?} fn - it should return {@link DevOpt}
      * */
     positiveNumber(value: any, fn?: AssertionCallback): void;
     /**
      * Asserts value is a positive number
-     * @see CommonIs#number
+     * @see CommonIsLike#number
      *
      * @param {any} value
-     * @param {AssertionOpt?} opt
+     * @param {DevOpt?} opt
      * */
-    positiveNumber(value: any, opt?: AssertionOpt): void;
+    positiveNumber(value: any, opt?: DevOpt): void;
     /**
      * Asserts value is an integer
-     * @see CommonIs#integer
+     * @see CommonIsLike#integer
      *
      * @param {any} value
      * @param {string?} message
@@ -284,23 +278,23 @@ export interface CommonAssertion extends ShiftSecure<CommonAssertionSecure> {
     integer(value: any, message?: string): void;
     /**
      * Asserts value is an integer
-     * @see CommonIs#integer
+     * @see CommonIsLike#integer
      *
      * @param {any} value
-     * @param {AssertionCallback?} fn - it should return {@link AssertionOpt}
+     * @param {AssertionCallback?} fn - it should return {@link DevOpt}
      * */
     integer(value: any, fn?: AssertionCallback): void;
     /**
      * Asserts value is an integer
-     * @see CommonIs#integer
+     * @see CommonIsLike#integer
      *
      * @param {any} value
-     * @param {AssertionOpt?} opt
+     * @param {DevOpt?} opt
      * */
-    integer(value: any, opt?: AssertionOpt): void;
+    integer(value: any, opt?: DevOpt): void;
     /**
      * Asserts value is a safe integer
-     * @see CommonIs#safeInteger
+     * @see CommonIsLike#safeInteger
      *
      * @param {any} value
      * @param {string?} message
@@ -308,23 +302,23 @@ export interface CommonAssertion extends ShiftSecure<CommonAssertionSecure> {
     safeInteger(value: any, message?: string): void;
     /**
      * Asserts value is a safe integer
-     * @see CommonIs#safeInteger
+     * @see CommonIsLike#safeInteger
      *
      * @param {any} value
-     * @param {AssertionCallback?} fn - it should return {@link AssertionOpt}
+     * @param {AssertionCallback?} fn - it should return {@link DevOpt}
      * */
     safeInteger(value: any, fn?: AssertionCallback): void;
     /**
      * Asserts value is a safe integer
-     * @see CommonIs#safeInteger
+     * @see CommonIsLike#safeInteger
      *
      * @param {any} value
-     * @param {AssertionOpt?} opt
+     * @param {DevOpt?} opt
      * */
-    safeInteger(value: any, opt?: AssertionOpt): void;
+    safeInteger(value: any, opt?: DevOpt): void;
     /**
      * Asserts value is a positive integer
-     * @see CommonIs#integer
+     * @see CommonIsLike#integer
      *
      * @param {any} value
      * @param {string?} message
@@ -332,23 +326,23 @@ export interface CommonAssertion extends ShiftSecure<CommonAssertionSecure> {
     positiveInteger(value: any, message?: string): void;
     /**
      * Asserts value is a positive integer
-     * @see CommonIs#integer
+     * @see CommonIsLike#integer
      *
      * @param {any} value
-     * @param {AssertionCallback?} fn - it should return {@link AssertionOpt}
+     * @param {AssertionCallback?} fn - it should return {@link DevOpt}
      * */
     positiveInteger(value: any, fn?: AssertionCallback): void;
     /**
      * Asserts value is a positive integer
-     * @see CommonIs#integer
+     * @see CommonIsLike#integer
      *
      * @param {any} value
-     * @param {AssertionOpt?} opt
+     * @param {DevOpt?} opt
      * */
-    positiveInteger(value: any, opt?: AssertionOpt): void;
+    positiveInteger(value: any, opt?: DevOpt): void;
     /**
      * Asserts value is a string
-     * @see CommonIs#string
+     * @see CommonIsLike#string
      *
      * @param {any} value
      * @param {string?} message
@@ -356,47 +350,47 @@ export interface CommonAssertion extends ShiftSecure<CommonAssertionSecure> {
     string(value: any, message?: string): void;
     /**
      * Asserts value is a string
-     * @see CommonIs#string
+     * @see CommonIsLike#string
      *
      * @param {any} value
-     * @param {AssertionCallback?} fn - it should return {@link AssertionOpt}
+     * @param {AssertionCallback?} fn - it should return {@link DevOpt}
      * */
     string(value: any, fn?: AssertionCallback): void;
     /**
      * Asserts value is a string
-     * @see CommonIs#string
+     * @see CommonIsLike#string
      *
      * @param {any} value
-     * @param {AssertionOpt?} opt
+     * @param {DevOpt?} opt
      * */
-    string(value: any, opt?: AssertionOpt): void;
+    string(value: any, opt?: DevOpt): void;
     /**
      * Asserts value is a text
-     * @see CommonIs#text
+     * @see CommonIsLike#text
      *
      * @param {any} value
      * @param {string?} message
      * */
-    text(value: any, message?: string): string;
+    text(value: any, message?: string): void;
     /**
      * Asserts value is a text
-     * @see CommonIs#text
+     * @see CommonIsLike#text
      *
      * @param {any} value
-     * @param {AssertionCallback?} fn - it should return {@link AssertionOpt}
+     * @param {AssertionCallback?} fn - it should return {@link DevOpt}
      * */
-    text(value: any, fn?: AssertionCallback): string;
+    text(value: any, fn?: AssertionCallback): void;
     /**
      * Asserts value is a text
-     * @see CommonIs#text
+     * @see CommonIsLike#text
      *
      * @param {any} value
-     * @param {AssertionOpt?} opt
+     * @param {DevOpt?} opt
      * */
-    text(value: any, opt?: AssertionOpt): string;
+    text(value: any, opt?: DevOpt): void;
     /**
      * Asserts value is a possible class
-     * @see CommonIs#clazz
+     * @see CommonIsLike#clazz
      *
      * @param {any} value
      * @param {string?} message
@@ -404,20 +398,20 @@ export interface CommonAssertion extends ShiftSecure<CommonAssertionSecure> {
     clazz(value: any, message?: string): void;
     /**
      * Asserts value is a possible class
-     * @see CommonIs#clazz
+     * @see CommonIsLike#clazz
      *
      * @param {any} value
-     * @param {AssertionCallback?} fn - it should return {@link AssertionOpt}
+     * @param {AssertionCallback?} fn - it should return {@link DevOpt}
      * */
     clazz(value: any, fn?: AssertionCallback): void;
     /**
      * Asserts value is a possible class
-     * @see CommonIs#clazz
+     * @see CommonIsLike#clazz
      *
      * @param {any} value
-     * @param {AssertionOpt?} opt
+     * @param {DevOpt?} opt
      * */
-    clazz(value: any, opt?: AssertionOpt): void;
+    clazz(value: any, opt?: DevOpt): void;
     /**
      * Asserts value is a date
      *
@@ -429,19 +423,19 @@ export interface CommonAssertion extends ShiftSecure<CommonAssertionSecure> {
      * Asserts value is a date
      *
      * @param {any} value
-     * @param {AssertionCallback?} fn - it should return {@link AssertionOpt}
+     * @param {AssertionCallback?} fn - it should return {@link DevOpt}
      * */
     date(value: any, fn?: AssertionCallback): void;
     /**
      * Asserts value is a date
      *
      * @param {any} value
-     * @param {AssertionOpt?} opt
+     * @param {DevOpt?} opt
      * */
-    date(value: any, opt?: AssertionOpt): void;
+    date(value: any, opt?: DevOpt): void;
     /**
      * Asserts value is a boolean
-     * @see CommonIs#boolean
+     * @see CommonIsLike#boolean
      *
      * @param {any} value
      * @param {string?} message
@@ -449,22 +443,23 @@ export interface CommonAssertion extends ShiftSecure<CommonAssertionSecure> {
     boolean(value: any, message?: string): void;
     /**
      * Asserts value is a boolean
-     * @see CommonIs#boolean
+     * @see CommonIsLike#boolean
      *
      * @param {any} value
-     * @param {AssertionCallback?} fn - it should return {@link AssertionOpt}
+     * @param {AssertionCallback?} fn - it should return {@link DevOpt}
      * */
     boolean(value: any, fn?: AssertionCallback): void;
     /**
      * Asserts value is a boolean
-     * @see CommonIs#boolean
+     * @see CommonIsLike#boolean
      *
      * @param {any} value
-     * @param {AssertionOpt?} opt
+     * @param {DevOpt?} opt
      * */
-    boolean(value: any, opt?: AssertionOpt): void;
+    boolean(value: any, opt?: DevOpt): void;
 }
 /**
  * Secure assertion methods
  * */
-export type CommonAssertionSecure = ShiftMain<CommonAssertion> & InitLike;
+export type CommonAssertionSecure = ShiftMain<CommonAssertionLike> & InitLike;
+export type AssertionCallback = () => string | DevOpt;

package/dist/assertion/index-types.js

@@ -1,2 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+//# 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/assertion/index.d.ts

@@ -1,2 +1 @@
 export * from './index-types';
-export * from './common-assertion-impl';

package/dist/assertion/index.js

@@ -15,4 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./index-types"), exports);
-__exportStar(require("./common-assertion-impl"), exports);
+//# sourceMappingURL=index.js.map

package/dist/assertion/index.js.map

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

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

@@ -0,0 +1,19 @@
+import { ClassLike, Func, Obj } from "../shared";
+import { LeyyoLike } from "../leyyo";
+import { CommonDescriptorLike, CommonDescriptorSecure, PropDescriptor } from "./index-types";
+export declare class CommonDescriptor implements CommonDescriptorLike, CommonDescriptorSecure {
+    private assertion;
+    private dev;
+    private sys;
+    sign(fn: Func | ClassLike): void;
+    isSigned(fn: Func | ClassLike): boolean;
+    get<T = any>(target: Func | Obj, key: string | symbol): PropDescriptor<T>;
+    getValue<T = any>(target: Func | Obj, key: string | symbol): T;
+    has(target: Func | Obj, key: string | symbol): boolean;
+    $isNot<T = any>(target: Func | Obj, key: string | symbol): boolean;
+    remove(target: Func | Obj, key: string | symbol): boolean;
+    save<T = any>(target: Func | Obj, key: string | symbol, value: T): boolean;
+    get $back(): CommonDescriptorLike;
+    $init(leyyo: LeyyoLike): void;
+    get $secure(): CommonDescriptorSecure;
+}