@scx-js/scx-data 0.2.4 → 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 scx567888
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,20 @@
+<p align="center">
+    <img src="https://js.scx.dev/scx-logo/scx-data-logo.svg" width="300px" alt="scx-data-logo"/>
+</p>
+<p align="center">
+    <a target="_blank" href="https://github.com/scx-js/scx-data/actions/workflows/ci.yml">
+        <img src="https://github.com/scx-js/scx-data/actions/workflows/ci.yml/badge.svg" alt="CI"/>
+    </a>
+    <a target="_blank" href="https://www.npmjs.com/package/@scx-js/scx-data">
+        <img src="https://img.shields.io/npm/v/@scx-js/scx-data.svg?color=ff69b4" alt="npm"/>
+    </a>
+    <a target="_blank" href="https://github.com/scx-js/scx-data">
+        <img src="https://img.shields.io/github/languages/code-size/scx-js/scx-data?color=orange" alt="code-size"/>
+    </a>
+    <a target="_blank" href="https://github.com/scx-js/scx-data/issues">
+        <img src="https://img.shields.io/github/issues/scx-js/scx-data" alt="issues"/>
+    </a>
+    <a target="_blank" href="https://github.com/scx-js/scx-data/blob/master/LICENSE">
+        <img src="https://img.shields.io/github/license/scx-js/scx-data" alt="license"/>
+    </a>
+</p>

package/field_policy/AssignField.js

@@ -10,10 +10,10 @@ class AssignField extends FieldPolicyLike {
     constructor(fieldName, expression) {
         super();
         if (fieldName == null) {
-            throw new Error("fieldName is null");
+            throw new Error("fieldName cannot be null");
         }
         if (expression == null) {
-            throw new Error("expression is null");
+            throw new Error("expression cannot be null");
         }
         this.#fieldName = fieldName;
         this.#expression = expression;
@@ -28,7 +28,7 @@ class AssignField extends FieldPolicyLike {
     }
 
     toFieldPolicy() {
-        //排除 0个 就是包含所有
+        // 默认包含所有 (includeAll)
         return new FieldPolicyImpl(EXCLUDED).assignFields(this);
     }
 

package/field_policy/FieldPolicy.js

@@ -9,9 +9,11 @@ class FieldPolicy {
     }
 
     getFilterMode() {
+
     }
 
     getFieldNames() {
+
     }
 
     clearFieldNames() {
@@ -23,6 +25,7 @@ class FieldPolicy {
     }
 
     getVirtualFields() {
+
     }
 
     clearVirtualFields() {
@@ -46,12 +49,15 @@ class FieldPolicy {
     }
 
     getIgnoreNull() {
+
     }
 
     getIgnoreNulls() {
+
     }
 
     getAssignFields() {
+
     }
 
     clearIgnoreNulls() {

package/field_policy/FieldPolicyBuilder.js

@@ -19,21 +19,32 @@ function exclude(...fieldNames) {
     return includeAll().exclude(...fieldNames);
 }
 
-/// 默认包含所有
+/// 默认包含所有 (includeAll)
 function ignoreNull(ignoreNull) {
     return includeAll().ignoreNull(ignoreNull);
 }
 
-/// 默认包含所有
+/// 默认包含所有 (includeAll)
 function ignoreNull_(fieldName, ignoreNull) {
     return includeAll().ignoreNull_(fieldName, ignoreNull);
 }
 
-/// 默认包含所有
+/// 默认包含所有 (includeAll)
+function assignFields(...assignFields) {
+    return includeAll().assignFields(...assignFields);
+}
+
+/// 默认包含所有 (includeAll)
+function virtualFields(...virtualFields) {
+    return includeAll().virtualFields(...virtualFields);
+}
+
+/// 默认包含所有 (includeAll)
 function assignField(fieldName, expression) {
     return new AssignField(fieldName, expression);
 }
 
+/// 默认包含所有 (includeAll)
 function virtualField(virtualFieldName, expression) {
     return new VirtualField(virtualFieldName, expression);
 }
@@ -45,6 +56,8 @@ export {
     exclude,
     ignoreNull,
     ignoreNull_,
+    assignFields,
+    virtualFields,
     assignField,
     virtualField,
 };

package/field_policy/FieldPolicyImpl.js

@@ -14,11 +14,14 @@ class FieldPolicyImpl extends FieldPolicy {
 
     constructor(filterMode) {
         super();
+        if (filterMode == null) {
+            throw new Error("filterMode cannot be null");
+        }
         this.#filterMode = filterMode;
-        this.#fieldNames = new Set();
+        this.#fieldNames = new Set(); // 需要保证顺序
         this.#virtualFields = [];
         this.#assignFields = [];
-        this.#ignoreNulls = new Map();
+        this.#ignoreNulls = new Map(); // 需要保证顺序
         this.#ignoreNull = true;
     }
 
@@ -51,22 +54,17 @@ class FieldPolicyImpl extends FieldPolicy {
         return this;
     }
 
-    addFieldNames(...fieldNames) {
-        for (const name of fieldNames) {
-            this.#fieldNames.add(name);
+    virtualFields(...virtualFields) {
+        if (virtualFields == null) {
+            throw new Error("virtualFields cannot be null");
         }
-        return this;
-    }
-
-    removeFieldNames(...fieldNames) {
-        for (const name of fieldNames) {
-            this.#fieldNames.delete(name);
+        let newVirtualFields = [];
+        for (let virtualField of virtualFields) {
+            if (virtualField != null) {
+                newVirtualFields.push(virtualField);
+            }
         }
-        return this;
-    }
-
-    virtualFields(...virtualFields) {
-        this.#virtualFields = [...virtualFields];
+        this.#virtualFields = newVirtualFields;
         return this;
     }
 
@@ -90,12 +88,24 @@ class FieldPolicyImpl extends FieldPolicy {
     }
 
     ignoreNull_(fieldName, ignoreNull) {
+        if (fieldName == null) {
+            throw new Error("fieldName cannot be null");
+        }
         this.#ignoreNulls.set(fieldName, ignoreNull);
         return this;
     }
 
     assignFields(...assignFields) {
-        this.#assignFields = [...assignFields];
+        if (assignFields == null) {
+            throw new Error("assignFields cannot be null");
+        }
+        let newAssignFields = [];
+        for (let assignField of assignFields) {
+            if (assignField != null) {
+                newAssignFields.push(assignField);
+            }
+        }
+        this.#assignFields = newAssignFields;
         return this;
     }
 
@@ -122,6 +132,9 @@ class FieldPolicyImpl extends FieldPolicy {
     }
 
     removeIgnoreNull(fieldName) {
+        if (fieldName == null) {
+            throw new Error("fieldName cannot be null");
+        }
         this.#ignoreNulls.delete(fieldName);
         return this;
     }
@@ -131,6 +144,30 @@ class FieldPolicyImpl extends FieldPolicy {
         return this;
     }
 
+    addFieldNames(...fieldNames) {
+        if (fieldNames == null) {
+            throw new Error("fieldNames cannot be null");
+        }
+        for (const fieldName of fieldNames) {
+            if (fieldName != null) {
+                this.#fieldNames.add(fieldName);
+            }
+        }
+        return this;
+    }
+
+    removeFieldNames(...fieldNames) {
+        if (fieldNames == null) {
+            throw new Error("fieldNames cannot be null");
+        }
+        for (const fieldName of fieldNames) {
+            if (fieldName != null) {
+                this.#fieldNames.delete(fieldName);
+            }
+        }
+        return this;
+    }
+
 }
 
 export {FieldPolicyImpl};

package/field_policy/FilterMode.js

@@ -1,5 +1,22 @@
-const INCLUDED = "INCLUDED";
+class FilterMode {
 
-const EXCLUDED = "EXCLUDED";
+    #value;
 
-export {INCLUDED, EXCLUDED};
+    constructor(value) {
+        this.#value = value;
+    }
+
+    value() {
+        return this.#value;
+    }
+
+}
+
+const INCLUDED = new FilterMode("INCLUDED");
+const EXCLUDED = new FilterMode("EXCLUDED");
+
+export {
+    FilterMode,
+    INCLUDED,
+    EXCLUDED,
+};

package/field_policy/VirtualField.js

@@ -10,10 +10,10 @@ class VirtualField extends FieldPolicyLike {
     constructor(virtualFieldName, expression) {
         super();
         if (virtualFieldName == null) {
-            throw new Error("virtualFieldName is null");
+            throw new Error("virtualFieldName cannot be null");
         }
         if (expression == null) {
-            throw new Error("expression is null");
+            throw new Error("expression cannot be null");
         }
         this.#virtualFieldName = virtualFieldName;
         this.#expression = expression;
@@ -28,7 +28,7 @@ class VirtualField extends FieldPolicyLike {
     }
 
     toFieldPolicy() {
-        //排除 0个 就是包含所有
+        // 默认包含所有 (includeAll)
         return new FieldPolicyImpl(EXCLUDED).virtualFields(this);
     }
 

package/index.js

@@ -5,19 +5,20 @@ export * from "./field_policy/FieldPolicyImpl.js";
 export * from "./field_policy/FieldPolicyLike.js";
 export * from "./field_policy/FilterMode.js";
 export * from "./field_policy/VirtualField.js";
-export * from "./query/Junction.js";
 export * from "./query/And.js";
-export * from "./query/Or.js";
+export * from "./query/BuildControl.js";
+export * from "./query/Condition.js";
+export * from "./query/ConditionType.js";
+export * from "./query/Junction.js";
 export * from "./query/Not.js";
+export * from "./query/Or.js";
 export * from "./query/OrderBy.js";
 export * from "./query/OrderByType.js";
 export * from "./query/Query.js";
 export * from "./query/QueryBuilder.js";
 export * from "./query/QueryImpl.js";
 export * from "./query/QueryLike.js";
-export * from "./query/BuildControl.js";
-export * from "./query/Condition.js";
+export * from "./query/SkipIfInfo.js";
 export * from "./query/WhereClause.js";
-export * from "./query/ConditionType.js";
-export * from "./serialization/QuerySerializer.js";
-export * from "./serialization/FieldPolicySerializer.js";
+export * from "./x/FieldPolicyNodeConverter.js";
+export * from "./x/QueryNodeConverter.js";

package/package.json

@@ -1,16 +1,13 @@
 {
   "name": "@scx-js/scx-data",
-  "version": "0.2.4",
+  "version": "0.3.0",
   "description": "SCX Data",
   "license": "MIT",
   "author": "scx567888",
-  "main": "index.js",
+  "exports": "./index.js",
   "type": "module",
   "repository": {
     "type": "git",
-    "url": "https://github.com/scx567888/scx-js.git"
-  },
-  "dependencies": {
-    "@scx-js/scx-common": "0.2.4"
+    "url": "git+https://github.com/scx-js/scx-data.git"
   }
 }

package/query/And.js

@@ -4,11 +4,11 @@ import {Or} from "./Or.js";
 class And extends Junction {
 
     and(...clauses) {
-        return this.add(new And().add(clauses));
+        return this.add(new And().add(...clauses));
     }
 
     or(...clauses) {
-        return this.add(new Or().add(clauses));
+        return this.add(new Or().add(...clauses));
     }
 
 }

package/query/BuildControl.js

@@ -1,3 +1,5 @@
+import {SkipIfInfo} from "./SkipIfInfo.js";
+
 class BuildControl {
 
     #value;
@@ -15,8 +17,28 @@ const SKIP_IF_BLANK_STRING = new BuildControl("SKIP_IF_BLANK_STRING");
 const USE_EXPRESSION = new BuildControl("USE_EXPRESSION");
 const USE_EXPRESSION_VALUE = new BuildControl("USE_EXPRESSION_VALUE");
 
+function toSkipIfInfo(...controls) {
+
+    let skipIfNull = false;
+    let skipIfEmptyList = false;
+    let skipIfEmptyString = false;
+    let skipIfBlankString = false;
+    for (let control of controls) {
+        if (control === SKIP_IF_NULL) {
+            skipIfNull = true;
+        } else if (control === SKIP_IF_EMPTY_LIST) {
+            skipIfEmptyList = true;
+        } else if (control === SKIP_IF_EMPTY_STRING) {
+            skipIfEmptyString = true;
+        } else if (control === SKIP_IF_BLANK_STRING) {
+            skipIfBlankString = true;
+        }
+    }
+
+    return new SkipIfInfo(skipIfNull, skipIfEmptyList, skipIfEmptyString, skipIfBlankString);
+}
 
-function checkUseExpression(...controls) {
+function toUseExpression(...controls) {
     for (let control of controls) {
         if (control === USE_EXPRESSION) {
             return true;
@@ -25,7 +47,7 @@ function checkUseExpression(...controls) {
     return false;
 }
 
-function checkUseExpressionValue(...controls) {
+function toUseExpressionValue(...controls) {
     for (let control of controls) {
         if (control === USE_EXPRESSION_VALUE) {
             return true;
@@ -42,6 +64,7 @@ export {
     SKIP_IF_EMPTY_STRING,
     USE_EXPRESSION,
     USE_EXPRESSION_VALUE,
-    checkUseExpression,
-    checkUseExpressionValue,
+    toSkipIfInfo,
+    toUseExpression,
+    toUseExpressionValue,
 };

package/query/Condition.js

@@ -1,5 +1,4 @@
 import {QueryLike} from "./QueryLike.js";
-import {isBlank} from "@scx-js/scx-common";
 import {QueryImpl} from "./QueryImpl.js";
 
 class Condition extends QueryLike {
@@ -14,13 +13,14 @@ class Condition extends QueryLike {
 
     constructor(selector, conditionType, value1, value2, useExpression, useExpressionValue, skipIfInfo) {
         super();
-        //名称不能为空
-        if (isBlank(selector)) {
-            throw new Error("Where 参数错误 : 名称 不能为空 !!!");
+        if (selector == null) {
+            throw new Error("selector cannot be null");
         }
-        //类型也不能为空
         if (conditionType == null) {
-            throw new Error("Where 参数错误 : whereType 不能为空 !!!");
+            throw new Error("conditionType cannot be null");
+        }
+        if (skipIfInfo == null) {
+            throw new Error("skipIfInfo cannot be null");
         }
         this.#selector = selector;
         this.#conditionType = conditionType;
@@ -59,10 +59,6 @@ class Condition extends QueryLike {
         return this.#skipIfInfo;
     }
 
-    isEmpty() {
-
-    }
-
     toQuery() {
         return new QueryImpl().where(this);
     }

package/query/ConditionType.js

@@ -1,75 +1,34 @@
-/**
- * 等于
- */
-const EQ = "EQ";
-
-/**
- * 不等于
- */
-const NE = "NE";
-
-/**
- * 小于
- */
-const LT = "LT";
-
-/**
- * 小于等于
- */
-const LTE = "LTE";
-
-/**
- * 大于
- */
-const GT = "GT";
-
-/**
- * 大于等于
- */
-const GTE = "GTE";
-
-/**
- * Like
- */
-const LIKE = "LIKE";
-
-/**
- * Not Like
- */
-const NOT_LIKE = "NOT_LIKE";
-
-/**
- * Like 正则表达式
- */
-const LIKE_REGEX = "LIKE_REGEX";
-
-/**
- * Like 正则表达式
- */
-const NOT_LIKE_REGEX = "NOT_LIKE_REGEX";
-
-/**
- * IN
- */
-const IN = "IN";
-
-/**
- * NOT IN
- */
-const NOT_IN = "NOT_IN";
-
-/**
- * 在之间
- */
-const BETWEEN = "BETWEEN";
-
-/**
- * 不在之间
- */
-const NOT_BETWEEN = "NOT_BETWEEN";
-
+class ConditionType {
+
+    #value;
+
+    constructor(value) {
+        this.#value = value;
+    }
+
+    value() {
+        return this.#value;
+    }
+
+}
+
+const EQ = new ConditionType("EQ");
+const NE = new ConditionType("NE");
+const LT = new ConditionType("LT");
+const LTE = new ConditionType("LTE");
+const GT = new ConditionType("GT");
+const GTE = new ConditionType("GTE");
+const LIKE = new ConditionType("LIKE");
+const NOT_LIKE = new ConditionType("NOT_LIKE");
+const LIKE_REGEX = new ConditionType("LIKE_REGEX");
+const NOT_LIKE_REGEX = new ConditionType("NOT_LIKE_REGEX");
+const IN = new ConditionType("IN");
+const NOT_IN = new ConditionType("NOT_IN");
+const BETWEEN = new ConditionType("BETWEEN");
+const NOT_BETWEEN = new ConditionType("NOT_BETWEEN");
 
 export {
+    ConditionType,
     EQ,
     NE,
     LT,

package/query/Junction.js

@@ -15,12 +15,11 @@ import {
     NOT_LIKE,
     NOT_LIKE_REGEX,
 } from "./ConditionType.js";
-import {Condition} from "./Condition.js";
 import {QueryImpl} from "./QueryImpl.js";
 import {Not} from "./Not.js";
 import {WhereClause} from "./WhereClause.js";
-import {checkUseExpression, checkUseExpressionValue} from "./BuildControl.js";
-import {ofSkipIfInfo} from "./SkipIfInfo.js";
+import {toSkipIfInfo, toUseExpression, toUseExpressionValue} from "./BuildControl.js";
+import {Condition} from "./Condition.js";
 
 class Junction extends QueryLike {
 
@@ -35,8 +34,16 @@ class Junction extends QueryLike {
         return this.#clauses;
     }
 
-    add(...logicCauses) {
-        this.#clauses.push(...logicCauses);
+    /// null 项会被忽略.
+    add(...clauses) {
+        if (clauses == null) {
+            throw new Error("clauses cannot be null");
+        }
+        for (let clause of clauses) {
+            if (clause != null) {
+                this.#clauses.push(clause);
+            }
+        }
         return this;
     }
 
@@ -45,6 +52,22 @@ class Junction extends QueryLike {
         return this;
     }
 
+    and(...clauses) {
+        // 因为 js 不允许 循环依赖 所以 这个方法迁移到子类实现
+    }
+
+    or(...clauses) {
+        // 因为 js 不允许 循环依赖 所以 这个方法迁移到子类实现
+    }
+
+    not(clause) {
+        return this.add(new Not(clause));
+    }
+
+    whereClause(expression, ...params) {
+        return this.add(new WhereClause(expression, ...params));
+    }
+
     eq(fieldName, value, ...options) {
         return this.add(condition(fieldName, EQ, value, ...options));
     }
@@ -101,40 +124,25 @@ class Junction extends QueryLike {
         return this.add(condition2(fieldName, NOT_BETWEEN, value1, value2, ...options));
     }
 
-    and(...clauses) {
-        // 因为 js 不允许 循环依赖 所以 这个方法迁移到子类实现
-    }
-
-    or(...clauses) {
-        // 因为 js 不允许 循环依赖 所以 这个方法迁移到子类实现
-    }
-
-    not(clause) {
-        return this.add(new Not(clause));
-    }
-
-    whereClause(expression, ...params) {
-        return this.add(new WhereClause(expression, params));
-    }
-
     toQuery() {
         return new QueryImpl().where(this);
     }
 
 }
 
+// 防止循环依赖 QueryBuilder 这里拷贝一份
 
 function condition(fieldName, conditionType, value, ...controls) {
-    let useExpression = checkUseExpression(...controls);
-    let useExpressionValue = checkUseExpressionValue(...controls);
-    let skipIfInfo = ofSkipIfInfo(...controls);
+    let useExpression = toUseExpression(...controls);
+    let useExpressionValue = toUseExpressionValue(...controls);
+    let skipIfInfo = toSkipIfInfo(...controls);
     return new Condition(fieldName, conditionType, value, null, useExpression, useExpressionValue, skipIfInfo);
 }
 
 function condition2(fieldName, conditionType, value1, value2, ...controls) {
-    let useExpression = checkUseExpression(...controls);
-    let useExpressionValue = checkUseExpressionValue(...controls);
-    let skipIfInfo = ofSkipIfInfo(...controls);
+    let useExpression = toUseExpression(...controls);
+    let useExpressionValue = toUseExpressionValue(...controls);
+    let skipIfInfo = toSkipIfInfo(...controls);
     return new Condition(fieldName, conditionType, value1, value2, useExpression, useExpressionValue, skipIfInfo);
 }