nicot 1.1.33 → 1.1.35

package/README.md

@@ -192,7 +192,7 @@ RestfulFactory 处理 Entity 类的时候，会以这些装饰器为依据，裁
 nickname: string;
 
 @BoolColumn()
-@QueryEqual()
+@QueryMatchBoolean()
 isActive: boolean;
 ```
 
@@ -209,6 +209,7 @@ NICOT 提供了一套查询装饰器，用于在 Entity 字段上声明支持的
 | `@QueryEqual()`               | 精确匹配：`WHERE field = :value`              |
 | `@QueryLike()`                | 前缀模糊匹配：`WHERE field LIKE :value%`        |
 | `@QuerySearch()`              | 宽泛模糊搜索：`WHERE field LIKE %:value%`       |
+| `@QueryMatchBoolean()`        | `true/false/1/0` 转换为布尔类型查询               |
 | `@QueryEqualZeroNullable()`   | `0 → IS NULL`，否则 `= :value`（适合 nullable） |
 | `@QueryGreater(field)`        | 大于查询：`WHERE field > :value`              |
 | `@QueryLess(field)`           | 小于查询：`WHERE field < :value`              |
@@ -286,7 +287,7 @@ views: number;
 title: string;
 
 @BoolColumn()
-@QueryEqual()
+@QueryMatchBoolean()
 isPublished: boolean;
 
 @NotWritable()
@@ -473,7 +474,7 @@ NICOT 提供了 `RestfulFactory(Entity)` 工厂函数，自动为实体生成标
 name: string;
 
 @BoolColumn()
-@QueryEqual()
+@QueryMatchBoolean()
 isActive: boolean;
 ```
 

package/dist/index.cjs

@@ -75,18 +75,23 @@ __export(index_exports, {
   QueryLessEqual: () => QueryLessEqual,
   QueryLike: () => QueryLike,
   QueryMatchBoolean: () => QueryMatchBoolean,
+  QueryMatchBooleanMySQL: () => QueryMatchBooleanMySQL,
   QueryNotEqual: () => QueryNotEqual,
   QueryOperator: () => QueryOperator,
   QuerySearch: () => QuerySearch,
   Relation: () => Relation,
   RelationComputed: () => RelationComputed,
   RestfulFactory: () => RestfulFactory,
+  SimpleJsonColumn: () => SimpleJsonColumn,
   StringColumn: () => StringColumn,
   StringIdBase: () => StringIdBase,
+  StringJsonColumn: () => StringJsonColumn,
+  TextColumn: () => TextColumn,
   TimeBase: () => TimeBase,
   UpdatePipe: () => UpdatePipe,
   UuidColumn: () => UuidColumn,
   applyQueryMatchBoolean: () => applyQueryMatchBoolean,
+  applyQueryMatchBooleanMySQL: () => applyQueryMatchBooleanMySQL,
   applyQueryProperty: () => applyQueryProperty,
   applyQueryPropertyLike: () => applyQueryPropertyLike,
   applyQueryPropertySearch: () => applyQueryPropertySearch,
@@ -273,10 +278,52 @@ var TypeTransformer = class {
     return entValue;
   }
 };
+var TypeTransformerString = class extends TypeTransformer {
+  from(dbValue) {
+    if (dbValue == null) {
+      return dbValue;
+    }
+    return super.from(JSON.parse(dbValue));
+  }
+  to(entValue) {
+    if (entValue == null) {
+      return entValue;
+    }
+    return JSON.stringify(super.to(entValue));
+  }
+};
+
+// src/utility/parse-bool.ts
+var parseBool = (value) => {
+  const trueValues = ["true", "1", "yes", "on", true, 1];
+  const falseValues = ["false", "0", "no", "off", false, 0];
+  if (trueValues.indexOf(value) !== -1) return true;
+  if (falseValues.indexOf(value) !== -1) return false;
+  if (!!value) {
+    return true;
+  }
+  return void 0;
+};
+var parseBoolObject = (obj, boolFields) => {
+  const newObj = { ...obj };
+  for (const field of boolFields) {
+    newObj[field] = parseBool(newObj[field]);
+  }
+  return newObj;
+};
+var ParseBoolObjectPipe = class {
+  constructor(boolFields) {
+    this.boolFields = boolFields;
+  }
+  transform(obj) {
+    return parseBoolObject(obj, this.boolFields);
+  }
+};
 
 // src/decorators/property.ts
 function swaggerDecorator(options, injected = {}) {
-  return (0, import_swagger2.ApiProperty)({
+  const notRequiredButHasDefault = options.required == null && options.default != null;
+  const apiPropertyDec = (0, import_swagger2.ApiProperty)({
     default: options.default,
     required: !!(options.required && options.default == null),
     example: options.default,
@@ -284,6 +331,18 @@ function swaggerDecorator(options, injected = {}) {
     ...injected,
     ...options.propertyExtras || {}
   });
+  if (notRequiredButHasDefault) {
+    return (0, import_nesties3.MergePropertyDecorators)([
+      apiPropertyDec,
+      Metadata.set(
+        "notRequiredButHasDefault",
+        true,
+        "notRequiredButHasDefaultFields"
+      )
+    ]);
+  } else {
+    return apiPropertyDec;
+  }
 }
 function validatorDecorator(options) {
   const decs = [];
@@ -302,13 +361,24 @@ function columnDecoratorOptions(options) {
 }
 var StringColumn = (length, options = {}) => {
   return (0, import_nesties3.MergePropertyDecorators)([
-    (0, import_typeorm.Column)("varchar", { length, ...columnDecoratorOptions(options) }),
+    (0, import_typeorm.Column)(options.columnType || "varchar", {
+      length,
+      ...columnDecoratorOptions(options)
+    }),
     (0, import_class_validator3.IsString)(),
     (0, import_class_validator3.MaxLength)(length),
     validatorDecorator(options),
     swaggerDecorator(options, { type: String, maxLength: length })
   ]);
 };
+var TextColumn = (options = {}) => {
+  return (0, import_nesties3.MergePropertyDecorators)([
+    (0, import_typeorm.Column)(options.columnType || "text", columnDecoratorOptions(options)),
+    (0, import_class_validator3.IsString)(),
+    validatorDecorator(options),
+    swaggerDecorator(options, { type: String })
+  ]);
+};
 var UuidColumn = (options = {}) => {
   return (0, import_nesties3.MergePropertyDecorators)([
     (0, import_typeorm.Column)("uuid", {
@@ -327,8 +397,28 @@ var UuidColumn = (options = {}) => {
     })
   ]);
 };
+var intMaxList = {
+  tinyint: 127,
+  smallint: 32767,
+  mediumint: 8388607,
+  int: 2147483647,
+  bigint: Number.MAX_SAFE_INTEGER
+};
 var IntColumn = (type, options = {}) => {
-  const decs = [
+  let max = intMaxList[type] || Number.MAX_SAFE_INTEGER;
+  if (max !== Number.MAX_SAFE_INTEGER && options.unsigned) {
+    max = max * 2 + 1;
+  }
+  let min = options.unsigned ? 0 : -max - 1;
+  if (options.range) {
+    if (typeof options.range.min === "number" && options.range.min > min) {
+      min = options.range.min;
+    }
+    if (typeof options.range.max === "number" && options.range.max < max) {
+      max = options.range.max;
+    }
+  }
+  return (0, import_nesties3.MergePropertyDecorators)([
     (0, import_typeorm.Column)(type, {
       default: options.default,
       unsigned: options.unsigned,
@@ -336,39 +426,53 @@ var IntColumn = (type, options = {}) => {
       ...columnDecoratorOptions(options)
     }),
     (0, import_class_validator3.IsInt)(),
+    ...min > Number.MIN_SAFE_INTEGER ? [(0, import_class_validator3.Min)(min)] : [],
+    ...max < Number.MAX_SAFE_INTEGER ? [(0, import_class_validator3.Max)(max)] : [],
     validatorDecorator(options),
     swaggerDecorator(options, {
       type: Number,
-      minimum: options.unsigned ? 0 : void 0
+      minimum: min > Number.MIN_SAFE_INTEGER ? min : void 0,
+      maximum: max < Number.MAX_SAFE_INTEGER ? max : void 0
     })
-  ];
-  if (options.unsigned) {
-    decs.push((0, import_class_validator3.Min)(0));
-  }
-  return (0, import_nesties3.MergePropertyDecorators)(decs);
+  ]);
 };
 var FloatColumn = (type, options = {}) => {
-  const decs = [
+  let min = options.unsigned ? 0 : Number.MIN_SAFE_INTEGER;
+  let max = Number.MAX_SAFE_INTEGER;
+  if (options.columnExtras?.precision != null && options.columnExtras?.scale != null) {
+    const precision = options.columnExtras.precision;
+    const scale = options.columnExtras.scale;
+    const intDigits = precision - scale;
+    if (intDigits > 0) {
+      const maxIntPart = Math.pow(10, intDigits) - 1;
+      const maxDecimalPart = scale > 0 ? (Math.pow(10, scale) - 1) / Math.pow(10, scale) : 0;
+      max = maxIntPart + maxDecimalPart;
+      min = options.unsigned ? 0 : -max;
+    }
+  }
+  return (0, import_nesties3.MergePropertyDecorators)([
     (0, import_typeorm.Column)(type, {
       default: options.default,
       unsigned: options.unsigned,
       ...columnDecoratorOptions(options)
     }),
     (0, import_class_validator3.IsNumber)(),
+    ...min > Number.MIN_SAFE_INTEGER ? [(0, import_class_validator3.Min)(min)] : [],
+    ...max < Number.MAX_SAFE_INTEGER ? [(0, import_class_validator3.Max)(max)] : [],
     validatorDecorator(options),
     swaggerDecorator(options, {
       type: Number,
-      minimum: options.unsigned ? 0 : void 0
+      minimum: min > Number.MIN_SAFE_INTEGER ? min : void 0,
+      maximum: max < Number.MAX_SAFE_INTEGER ? max : void 0
     })
-  ];
-  if (options.unsigned) {
-    decs.push((0, import_class_validator3.Min)(0));
-  }
-  return (0, import_nesties3.MergePropertyDecorators)(decs);
+  ]);
 };
 var DateColumn = (options = {}) => {
   return (0, import_nesties3.MergePropertyDecorators)([
-    (0, import_typeorm.Column)("timestamp", columnDecoratorOptions(options)),
+    (0, import_typeorm.Column)(
+      options.columnType || "timestamp",
+      columnDecoratorOptions(options)
+    ),
     (0, import_class_validator3.IsDate)(),
     (0, import_class_transformer3.Transform)(
       (v) => {
@@ -408,31 +512,33 @@ var EnumColumn = (targetEnum, options = {}) => {
 var BoolColumn = (options = {}) => (0, import_nesties3.MergePropertyDecorators)([
   (0, import_typeorm.Index)(),
   (0, import_class_transformer3.Transform)((v) => {
-    const trueValues = ["true", "1", "yes", "on", true, 1];
-    const falseValues = ["false", "0", "no", "off", false, 0];
-    if (trueValues.indexOf(v.value) !== -1) return true;
-    if (falseValues.indexOf(v.value) !== -1) return false;
-    return void 0;
+    return parseBool(v.value);
   }),
   (0, import_typeorm.Column)("boolean", columnDecoratorOptions(options)),
   validatorDecorator(options),
   swaggerDecorator(options, { type: Boolean }),
   Metadata.set("boolColumn", true, "boolColumnFields")
 ]);
-var JsonColumn = (definition, options = {}) => {
+var createJsonColumnDef = (columnType = "jsonb", typeTransformerClass = TypeTransformer) => (definition, options = {}) => {
   const cl = (0, import_nesties4.getClassFromClassOrArray)(definition);
   return (0, import_nesties3.MergePropertyDecorators)([
     NotQueryable(),
     (0, import_class_transformer3.Type)(() => cl),
     (0, import_class_validator3.ValidateNested)(),
-    (0, import_typeorm.Column)("jsonb", {
+    (0, import_typeorm.Column)(options.columnType || columnType, {
       ...columnDecoratorOptions(options),
-      transformer: new TypeTransformer(definition)
+      transformer: new typeTransformerClass(definition)
     }),
     validatorDecorator(options),
     swaggerDecorator(options, { type: definition })
   ]);
 };
+var JsonColumn = createJsonColumnDef();
+var SimpleJsonColumn = createJsonColumnDef("json");
+var StringJsonColumn = createJsonColumnDef(
+  "text",
+  TypeTransformerString
+);
 var NotColumn = (options = {}, specials = {}) => (0, import_nesties3.MergePropertyDecorators)([
   (0, import_class_transformer3.Exclude)(),
   swaggerDecorator({
@@ -527,15 +633,26 @@ var applyQueryPropertyZeroNullable = createQueryCondition(
 );
 var applyQueryMatchBoolean = createQueryCondition(
   (obj, qb, entityName, field) => {
-    const value = obj[field];
-    if (value === true || value === "true" || value === 1 || value === "1") {
+    const value = parseBool(obj[field]);
+    if (value === true) {
       qb.andWhere(`${entityName}.${field} = TRUE`);
     }
-    if (value === false || value === "false" || value === 0 || value === "0") {
+    if (value === false) {
       qb.andWhere(`${entityName}.${field} = FALSE`);
     }
   }
 );
+var applyQueryMatchBooleanMySQL = createQueryCondition(
+  (obj, qb, entityName, field) => {
+    const value = parseBool(obj[field]);
+    if (value === true) {
+      qb.andWhere(`${entityName}.${field} = 1`);
+    }
+    if (value === false) {
+      qb.andWhere(`${entityName}.${field} = 0`);
+    }
+  }
+);
 
 // src/decorators/query.ts
 var import_nesties5 = require("nesties");
@@ -580,6 +697,7 @@ var QueryLike = () => QueryCondition(applyQueryPropertyLike);
 var QuerySearch = () => QueryCondition(applyQueryPropertySearch);
 var QueryEqualZeroNullable = () => QueryCondition(applyQueryPropertyZeroNullable);
 var QueryMatchBoolean = () => QueryCondition(applyQueryMatchBoolean);
+var QueryMatchBooleanMySQL = () => QueryCondition(applyQueryMatchBooleanMySQL);
 var QueryOperator = (operator, field) => QueryCondition((obj, qb, entityName, key) => {
   if (obj[key] == null) return;
   const fieldName = field || key;
@@ -1811,8 +1929,8 @@ var PatchColumnsInGet = (cl, originalCl = cl, fieldsToOmit = []) => {
       ...originalApiProp,
       type: String,
       required: false,
-      enum: ["", "1"],
-      default: originalApiProp?.default === true ? "1" : originalApiProp?.default === false ? "" : void 0
+      enum: ["0", "1"],
+      default: originalApiProp?.default === true ? "1" : originalApiProp?.default === false ? "0" : void 0
     })(cl.prototype, field);
   }
   return cl;
@@ -1977,6 +2095,17 @@ var RestfulFactory = class _RestfulFactory {
         }
       }
     }
+    const notRequiredButHasDefaultFields = getSpecificFields(
+      this.entityClass,
+      "notRequiredButHasDefault"
+    ).filter((f) => !outputFieldsToOmit.has(f));
+    for (const field of notRequiredButHasDefaultFields) {
+      const oldApiProperty = (0, import_nesties10.getApiProperty)(resultDto, field);
+      (0, import_swagger7.ApiProperty)({
+        ...oldApiProperty,
+        required: true
+      })(resultDto.prototype, field);
+    }
     const res = (0, import_nesties11.RenameClass)(
       resultDto,
       `${this.getEntityClassName()}ResultDto`
@@ -2063,8 +2192,17 @@ var RestfulFactory = class _RestfulFactory {
       (0, import_swagger7.ApiOkResponse)({ type: this.entityCursorPaginationReturnMessageDto })
     ]);
   }
+  getBoolColumns() {
+    const boolColumns = getSpecificFields(this.entityClass, "boolColumn");
+    return import_lodash4.default.difference(boolColumns, this.fieldsInGetToOmit);
+  }
   findAllParam() {
-    return (0, import_common3.Query)(GetPipe());
+    const boolColumns = this.getBoolColumns();
+    if (boolColumns.length) {
+      return (0, import_common3.Query)(new ParseBoolObjectPipe(boolColumns), GetPipe());
+    } else {
+      return (0, import_common3.Query)(GetPipe());
+    }
   }
   update(extras = {}) {
     return (0, import_nesties10.MergeMethodDecorators)([
@@ -2289,18 +2427,23 @@ var RestfulFactory = class _RestfulFactory {
   QueryLessEqual,
   QueryLike,
   QueryMatchBoolean,
+  QueryMatchBooleanMySQL,
   QueryNotEqual,
   QueryOperator,
   QuerySearch,
   Relation,
   RelationComputed,
   RestfulFactory,
+  SimpleJsonColumn,
   StringColumn,
   StringIdBase,
+  StringJsonColumn,
+  TextColumn,
   TimeBase,
   UpdatePipe,
   UuidColumn,
   applyQueryMatchBoolean,
+  applyQueryMatchBooleanMySQL,
   applyQueryProperty,
   applyQueryPropertyLike,
   applyQueryPropertySearch,