xjs-common 7.0.0 → 8.0.1

package/README.md

@@ -4,7 +4,7 @@ Available to `npm i xjs-common`.
 **NOTE**: The versions <= `v6.2.0` was unpublished. If you has been used these versions, please update to the version >= `v7.0.0`.
 
 # Overview
-Library modules for nodejs that bundled general-purpose implementations.  
+Library modules for nodejs + typescript that bundled general-purpose implementations.  
 This module is very simple, therefore it has no dependencies.
 
 # Code example (only part)
@@ -181,28 +181,28 @@ class Cls_B {
     console.log(!!cropped.id && !cropped.p && !!cropped.objA.aryB && !cropped.objA.q) // true;
 
     // validation. below are valid cases.
-    console.log(UType.validate(valid1)); // true
+    console.log(UType.validate(valid1)); // []
 
     const valid2 = { id: 0 };
-    console.log(UType.validate(Object.assign(new Cls_A(), valid2))); // true
+    console.log(UType.validate(Object.assign(new Cls_A(), valid2))); // []
 
     // validation. below are invalid cases.
     const invalid1 = {};
-    console.log(UType.validate(Object.assign(new Cls_A(), invalid1))); // false
+    console.log(UType.validate(Object.assign(new Cls_A(), invalid1))); // [ 'id' ]
 
     const invalid3 = { id: 0, strA: [], objA: valid_b1 };
-    console.log(UType.validate(Object.assign(new Cls_A(), invalid3))); // false
+    console.log(UType.validate(Object.assign(new Cls_A(), invalid3))); // [ 'strA' ]
 
     const invalid4 = { id: "0", strA: "a", objA: valid_b1 };
-    console.log(UType.validate(Object.assign(new Cls_A(), invalid4))); // false
+    console.log(UType.validate(Object.assign(new Cls_A(), invalid4))); // [ 'id' ]
 
     const invalid_b1 = Object.assign(new Cls_B(), { aryB: [1, 2, 3], boolB: 1 });
     const invalid5 = { id: 0, strA: "a", objA: invalid_b1 };
-    console.log(UType.validate(Object.assign(new Cls_A(), invalid5))); // false
+    console.log(UType.validate(Object.assign(new Cls_A(), invalid5))); // [ 'objA.boolB' ]
 
     const invalid_b2 = Object.assign(new Cls_B(), { aryB: ["1"], boolB: true });
     const invalid6 = { id: 0, strA: "a", objA: invalid_b2 };
-    console.log(UType.validate(Object.assign(new Cls_A(), invalid6))); // false
+    console.log(UType.validate(Object.assign(new Cls_A(), invalid6))); // [ 'objA.aryB' ]
 })();
 ```
 ## Error definition

package/dist/const/types.d.ts

@@ -1,5 +1,6 @@
 export type IndexSignature = string | number | symbol;
 export type NormalRecord = Record<IndexSignature, any>;
+export type MaybeArray<T> = T | T[];
 export declare enum Type {
     string = "string",
     number = "number",

package/dist/func/decorator/d-type.js

@@ -47,7 +47,7 @@ var DType;
     }
     DType.keep = keep;
     function setDesc(target, propKey, setter) {
-        const map = target[exports.smbl_tm] ?? {};
+        const map = target[exports.smbl_tm] ? Object.assign({}, target[exports.smbl_tm]) : {};
         map[propKey] ??= { t: null, req: false, rec: false, ary: null };
         const td = map[propKey];
         setter(td);
@@ -66,6 +66,6 @@ var DType;
         }
         if (ex1 && ex2)
             throw new xjs_err_1.XjsErr(s_errCode, `decorator to express ${ex1} and ${ex2} are exclusive.`);
-        Object.defineProperty(target, exports.smbl_tm, { value: map });
+        Object.defineProperty(target, exports.smbl_tm, { value: map, configurable: true });
     }
 })(DType = exports.DType || (exports.DType = {}));

package/dist/func/u-file.d.ts

@@ -1,10 +1,11 @@
 /// <reference types="node" />
+import { MaybeArray } from "../const/types";
 export declare namespace UFile {
-    function mkdir(p: string | string[]): boolean;
-    function write(p: string | string[], c: string): void;
+    function mkdir(p: MaybeArray<string>): boolean;
+    function write(p: MaybeArray<string>, c: string): void;
     function exists(...p: string[]): boolean;
-    function read(p: string | string[]): Buffer;
-    function read(p: string | string[], encoding: BufferEncoding): string;
-    function cp(from: string | string[], to: string | string[]): void;
-    function mv(from: string | string[], to: string | string[]): void;
+    function read(p: MaybeArray<string>): Buffer;
+    function read(p: MaybeArray<string>, encoding: BufferEncoding): string;
+    function cp(from: MaybeArray<string>, to: MaybeArray<string>): void;
+    function mv(from: MaybeArray<string>, to: MaybeArray<string>): void;
 }

package/dist/func/u-type.d.ts

@@ -1,4 +1,4 @@
-import { Type } from "../const/types";
+import { MaybeArray, Type } from "../const/types";
 export declare namespace UType {
     function isDefined(v: any): boolean;
     function isEmpty(v: any): boolean;
@@ -15,7 +15,11 @@ export declare namespace UType {
     function isArray(v: any, t: Type.symbol): v is symbol[];
     function isArray(v: any, t: Type.object): v is object[];
     function isArray(v: any): v is any[];
-    /** validate properties which attached decorators in {@link DType} */
-    function validate(o: any): boolean;
-    function takeAsArray<T>(v: T | T[]): T[];
+    /**
+     * validate properties which attached decorators in {@link DType}.
+     * @param o object to be validated.
+     * @returns invalid property keys. returns an empty array if `o` is valid.
+     */
+    function validate(o: any): string[];
+    function takeAsArray<T>(v: MaybeArray<T>): T[];
 }

package/dist/func/u-type.js

@@ -29,22 +29,27 @@ var UType;
         return Array.isArray(v) && (!t || v.every(e => typeof e === t));
     }
     UType.isArray = isArray;
-    /** validate properties which attached decorators in {@link DType} */
+    /**
+     * validate properties which attached decorators in {@link DType}.
+     * @param o object to be validated.
+     * @returns invalid property keys. returns an empty array if `o` is valid.
+     */
     function validate(o) {
-        return !o[d_type_1.smbl_tm] || Object.entries(o[d_type_1.smbl_tm])
-            .every(e => validateProp(o[e[0]], e[1]));
+        if (!o[d_type_1.smbl_tm])
+            return [];
+        return Object.entries(o[d_type_1.smbl_tm]).flatMap(e => validateProp(e[0], o[e[0]], e[1]));
     }
     UType.validate = validate;
-    function validateProp(prop, td) {
+    function validateProp(k, prop, td) {
         if (isEmpty(prop))
-            return !td.req;
+            return td.req ? [k] : [];
         if (td.t && typeof prop !== td.t)
-            return false;
+            return [k];
         if (td.ary)
-            return Array.isArray(prop) && (!td.ary || prop.every(e => validateProp(e, td.ary)));
+            return Array.isArray(prop) ? prop.flatMap(e => validateProp(k, e, td.ary)) : [k];
         if (td.rec)
-            return validate(prop);
-        return true;
+            return validate(prop).flatMap(k2 => `${k}.${k2}`);
+        return [];
     }
     function takeAsArray(v) {
         return Array.isArray(v) ? v : [v];

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "xjs-common",
-  "version": "7.0.0",
-  "description": "library modules for nodejs that bundled general-purpose implementations.",
+  "version": "8.0.1",
+  "description": "library modules for nodejs + typescript that bundled general-purpose implementations.",
   "repository": {
     "type": "git",
     "url": "https://github.com/begyyal/xjs_commons"
   },
   "keywords": [
     "node",
+    "typescript",
     "utility"
   ],
   "scripts": {