nicot 1.1.32 → 1.1.33

package/README.md

@@ -192,7 +192,7 @@ RestfulFactory 处理 Entity 类的时候，会以这些装饰器为依据，裁
 nickname: string;
 
 @BoolColumn()
-@QueryMatchBoolean()
+@QueryEqual()
 isActive: boolean;
 ```
 
@@ -209,7 +209,6 @@ 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`              |
@@ -287,7 +286,7 @@ views: number;
 title: string;
 
 @BoolColumn()
-@QueryMatchBoolean()
+@QueryEqual()
 isPublished: boolean;
 
 @NotWritable()
@@ -474,7 +473,7 @@ NICOT 提供了 `RestfulFactory(Entity)` 工厂函数，自动为实体生成标
 name: string;
 
 @BoolColumn()
-@QueryMatchBoolean()
+@QueryEqual()
 isActive: boolean;
 ```
 

package/dist/index.cjs

@@ -80,7 +80,6 @@ __export(index_exports, {
   QuerySearch: () => QuerySearch,
   Relation: () => Relation,
   RelationComputed: () => RelationComputed,
-  RenameClass: () => RenameClass,
   RestfulFactory: () => RestfulFactory,
   StringColumn: () => StringColumn,
   StringIdBase: () => StringIdBase,
@@ -417,7 +416,8 @@ var BoolColumn = (options = {}) => (0, import_nesties3.MergePropertyDecorators)(
   }),
   (0, import_typeorm.Column)("boolean", columnDecoratorOptions(options)),
   validatorDecorator(options),
-  swaggerDecorator(options, { type: Boolean })
+  swaggerDecorator(options, { type: Boolean }),
+  Metadata.set("boolColumn", true, "boolColumnFields")
 ]);
 var JsonColumn = (definition, options = {}) => {
   const cl = (0, import_nesties4.getClassFromClassOrArray)(definition);
@@ -537,12 +537,6 @@ var applyQueryMatchBoolean = createQueryCondition(
   }
 );
 
-// src/utility/rename-class.ts
-function RenameClass(cls, name) {
-  Object.defineProperty(cls, "name", { value: name });
-  return cls;
-}
-
 // src/decorators/query.ts
 var import_nesties5 = require("nesties");
 
@@ -1739,10 +1733,10 @@ function CrudService(entityClass, crudOptions = {}) {
 
 // src/restful.ts
 var import_common3 = require("@nestjs/common");
-var import_nesties9 = require("nesties");
-var import_swagger6 = require("@nestjs/swagger");
+var import_nesties10 = require("nesties");
+var import_swagger7 = require("@nestjs/swagger");
 var import_lodash4 = __toESM(require("lodash"));
-var import_constants = require("@nestjs/swagger/dist/constants");
+var import_nesties11 = require("nesties");
 
 // src/bases/base-restful-controller.ts
 var RestfulMethods = [
@@ -1803,6 +1797,27 @@ var OmitTypeExclude = (cl, keys) => {
   return omitted;
 };
 
+// src/utility/patch-column-in-get.ts
+var import_swagger6 = require("@nestjs/swagger");
+var import_nesties9 = require("nesties");
+var PatchColumnsInGet = (cl, originalCl = cl, fieldsToOmit = []) => {
+  const omit2 = new Set(fieldsToOmit);
+  const boolFields = getSpecificFields(originalCl || cl, "boolColumn").filter(
+    (f) => !omit2.has(f)
+  );
+  for (const field of boolFields) {
+    const originalApiProp = (0, import_nesties9.getApiProperty)(originalCl, field);
+    (0, import_swagger6.ApiProperty)({
+      ...originalApiProp,
+      type: String,
+      required: false,
+      enum: ["", "1"],
+      default: originalApiProp?.default === true ? "1" : originalApiProp?.default === false ? "" : void 0
+    })(cl.prototype, field);
+  }
+  return cl;
+};
+
 // src/restful.ts
 var getCurrentLevelRelations = (relations) => relations.filter((r) => !r.includes("."));
 var getNextLevelRelations = (relations, enteringField) => relations.filter((r) => r.includes(".") && r.startsWith(`${enteringField}.`)).map((r) => r.split(".").slice(1).join("."));
@@ -1822,7 +1837,7 @@ var RestfulFactory = class _RestfulFactory {
       this.entityClass,
       this.fieldsToOmit
     );
-    this.createDto = RenameClass(
+    this.createDto = (0, import_nesties11.RenameClass)(
       OmitTypeExclude(
         this.basicInputDto,
         getSpecificFields(this.entityClass, "notWritable")
@@ -1830,27 +1845,35 @@ var RestfulFactory = class _RestfulFactory {
       `Create${this.entityClass.name}Dto`
     );
     this.importDto = ImportDataDto(this.createDto);
-    this.findAllDto = RenameClass(
-      (0, import_swagger6.PartialType)(
-        OmitTypeExclude(
-          this.entityClass instanceof PageSettingsDto ? this.basicInputDto : (0, import_swagger6.IntersectionType)(
-            this.basicInputDto,
-            PageSettingsDto
+    this.fieldsInGetToOmit = import_lodash4.default.uniq([
+      ...this.fieldsToOmit,
+      ...getSpecificFields(this.entityClass, "notQueryable")
+    ]);
+    this.findAllDto = (0, import_nesties11.RenameClass)(
+      (0, import_swagger7.PartialType)(
+        PatchColumnsInGet(
+          OmitTypeExclude(
+            this.entityClass instanceof PageSettingsDto ? this.entityClass : (0, import_swagger7.IntersectionType)(
+              this.entityClass,
+              PageSettingsDto
+            ),
+            this.fieldsInGetToOmit
           ),
-          getSpecificFields(this.entityClass, "notQueryable")
+          this.entityClass,
+          this.fieldsInGetToOmit
         )
       ),
       `Find${this.entityClass.name}Dto`
     );
-    this.findAllCursorPaginatedDto = RenameClass(
-      (0, import_swagger6.IntersectionType)(
+    this.findAllCursorPaginatedDto = (0, import_nesties11.RenameClass)(
+      (0, import_swagger7.IntersectionType)(
         OmitTypeExclude(this.findAllDto, ["pageCount"]),
         CursorPaginationDto
       ),
       `Find${this.entityClass.name}CursorPaginatedDto`
     );
-    this.updateDto = RenameClass(
-      (0, import_swagger6.PartialType)(
+    this.updateDto = (0, import_nesties11.RenameClass)(
+      (0, import_swagger7.PartialType)(
         OmitTypeExclude(
           this.createDto,
           getSpecificFields(this.entityClass, "notChangeable")
@@ -1859,8 +1882,8 @@ var RestfulFactory = class _RestfulFactory {
       `Update${this.entityClass.name}Dto`
     );
     this.entityResultDto = this.resolveEntityResultDto();
-    this.entityCreateResultDto = RenameClass(
-      (0, import_swagger6.OmitType)(this.entityResultDto, [
+    this.entityCreateResultDto = (0, import_nesties11.RenameClass)(
+      (0, import_swagger7.OmitType)(this.entityResultDto, [
         ...getTypeormRelations(this.entityClass).map(
           (r) => r.propertyName
         ),
@@ -1872,15 +1895,15 @@ var RestfulFactory = class _RestfulFactory {
       ]),
       `${this.getEntityClassName()}CreateResultDto`
     );
-    this.entityReturnMessageDto = (0, import_nesties9.ReturnMessageDto)(this.entityResultDto);
-    this.entityCreateReturnMessageDto = (0, import_nesties9.ReturnMessageDto)(
+    this.entityReturnMessageDto = (0, import_nesties10.ReturnMessageDto)(this.entityResultDto);
+    this.entityCreateReturnMessageDto = (0, import_nesties10.ReturnMessageDto)(
       this.entityCreateResultDto
     );
-    this.entityArrayReturnMessageDto = (0, import_nesties9.PaginatedReturnMessageDto)(
+    this.entityArrayReturnMessageDto = (0, import_nesties10.PaginatedReturnMessageDto)(
       this.entityResultDto
     );
     this.entityCursorPaginationReturnMessageDto = CursorPaginationReturnMessageDto(this.entityResultDto);
-    this.importReturnMessageDto = (0, import_nesties9.ReturnMessageDto)([
+    this.importReturnMessageDto = (0, import_nesties10.ReturnMessageDto)([
       ImportEntryDto(this.entityCreateResultDto)
     ]);
     // eslint-disable-next-line @typescript-eslint/ban-types
@@ -1911,17 +1934,16 @@ var RestfulFactory = class _RestfulFactory {
       ...this.options.outputFieldsToOmit || [],
       ...this.options.relations ? relations.map((r) => r.propertyName).filter((r) => !currentLevelRelations.has(r)) : []
     ]);
-    const resultDto = (0, import_swagger6.OmitType)(this.entityClass, [...outputFieldsToOmit]);
+    const resultDto = (0, import_swagger7.OmitType)(this.entityClass, [...outputFieldsToOmit]);
     for (const relation of relations) {
       if (outputFieldsToOmit.has(relation.propertyName)) continue;
       if (nonTransformableTypes.has(relation.propertyClass)) continue;
       const replace = (useClass) => {
-        const oldApiProperty = Reflect.getMetadata(
-          import_constants.DECORATORS.API_MODEL_PROPERTIES,
-          this.entityClass.prototype,
+        const oldApiProperty = (0, import_nesties10.getApiProperty)(
+          this.entityClass,
           relation.propertyName
-        ) || {};
-        (0, import_swagger6.ApiProperty)({
+        );
+        (0, import_swagger7.ApiProperty)({
           ...oldApiProperty,
           required: false,
           type: () => relation.isArray ? [useClass[0]] : useClass[0]
@@ -1955,7 +1977,7 @@ var RestfulFactory = class _RestfulFactory {
         }
       }
     }
-    const res = RenameClass(
+    const res = (0, import_nesties11.RenameClass)(
       resultDto,
       `${this.getEntityClassName()}ResultDto`
     );
@@ -1981,17 +2003,17 @@ var RestfulFactory = class _RestfulFactory {
     }
   }
   create(extras = {}) {
-    return (0, import_nesties9.MergeMethodDecorators)([
+    return (0, import_nesties10.MergeMethodDecorators)([
       this.usePrefix(import_common3.Post),
       (0, import_common3.HttpCode)(200),
-      (0, import_swagger6.ApiOperation)({
+      (0, import_swagger7.ApiOperation)({
         summary: `Create a new ${this.getEntityClassName()}`,
         ...extras
       }),
-      (0, import_swagger6.ApiBody)({ type: this.createDto }),
-      (0, import_swagger6.ApiOkResponse)({ type: this.entityCreateReturnMessageDto }),
-      (0, import_swagger6.ApiBadRequestResponse)({
-        type: import_nesties9.BlankReturnMessageDto,
+      (0, import_swagger7.ApiBody)({ type: this.createDto }),
+      (0, import_swagger7.ApiOkResponse)({ type: this.entityCreateReturnMessageDto }),
+      (0, import_swagger7.ApiBadRequestResponse)({
+        type: import_nesties10.BlankReturnMessageDto,
         description: `The ${this.getEntityClassName()} is not valid`
       })
     ]);
@@ -2000,16 +2022,16 @@ var RestfulFactory = class _RestfulFactory {
     return (0, import_common3.Body)(CreatePipe());
   }
   findOne(extras = {}) {
-    return (0, import_nesties9.MergeMethodDecorators)([
+    return (0, import_nesties10.MergeMethodDecorators)([
       this.usePrefix(import_common3.Get, ":id"),
-      (0, import_swagger6.ApiOperation)({
+      (0, import_swagger7.ApiOperation)({
         summary: `Find a ${this.getEntityClassName()} by id`,
         ...extras
       }),
-      (0, import_swagger6.ApiParam)({ name: "id", type: this.idType, required: true }),
-      (0, import_swagger6.ApiOkResponse)({ type: this.entityReturnMessageDto }),
-      (0, import_swagger6.ApiNotFoundResponse)({
-        type: import_nesties9.BlankReturnMessageDto,
+      (0, import_swagger7.ApiParam)({ name: "id", type: this.idType, required: true }),
+      (0, import_swagger7.ApiOkResponse)({ type: this.entityReturnMessageDto }),
+      (0, import_swagger7.ApiNotFoundResponse)({
+        type: import_nesties10.BlankReturnMessageDto,
         description: `The ${this.getEntityClassName()} with the given id was not found`
       })
     ]);
@@ -2022,49 +2044,49 @@ var RestfulFactory = class _RestfulFactory {
     }
   }
   findAll(extras = {}) {
-    return (0, import_nesties9.MergeMethodDecorators)([
+    return (0, import_nesties10.MergeMethodDecorators)([
       this.usePrefix(import_common3.Get),
-      (0, import_swagger6.ApiOperation)({
+      (0, import_swagger7.ApiOperation)({
         summary: `Find all ${this.getEntityClassName()}`,
         ...extras
       }),
-      (0, import_swagger6.ApiOkResponse)({ type: this.entityArrayReturnMessageDto })
+      (0, import_swagger7.ApiOkResponse)({ type: this.entityArrayReturnMessageDto })
     ]);
   }
   findAllCursorPaginated(extras = {}) {
-    return (0, import_nesties9.MergeMethodDecorators)([
+    return (0, import_nesties10.MergeMethodDecorators)([
       this.usePrefix(import_common3.Get),
-      (0, import_swagger6.ApiOperation)({
+      (0, import_swagger7.ApiOperation)({
         summary: `Find all ${this.getEntityClassName()}`,
         ...extras
       }),
-      (0, import_swagger6.ApiOkResponse)({ type: this.entityCursorPaginationReturnMessageDto })
+      (0, import_swagger7.ApiOkResponse)({ type: this.entityCursorPaginationReturnMessageDto })
     ]);
   }
   findAllParam() {
     return (0, import_common3.Query)(GetPipe());
   }
   update(extras = {}) {
-    return (0, import_nesties9.MergeMethodDecorators)([
+    return (0, import_nesties10.MergeMethodDecorators)([
       this.usePrefix(import_common3.Patch, ":id"),
       (0, import_common3.HttpCode)(200),
-      (0, import_swagger6.ApiOperation)({
+      (0, import_swagger7.ApiOperation)({
         summary: `Update a ${this.getEntityClassName()} by id`,
         ...extras
       }),
-      (0, import_swagger6.ApiParam)({ name: "id", type: this.idType, required: true }),
-      (0, import_swagger6.ApiBody)({ type: this.updateDto }),
-      (0, import_swagger6.ApiOkResponse)({ type: import_nesties9.BlankReturnMessageDto }),
-      (0, import_swagger6.ApiNotFoundResponse)({
-        type: import_nesties9.BlankReturnMessageDto,
+      (0, import_swagger7.ApiParam)({ name: "id", type: this.idType, required: true }),
+      (0, import_swagger7.ApiBody)({ type: this.updateDto }),
+      (0, import_swagger7.ApiOkResponse)({ type: import_nesties10.BlankReturnMessageDto }),
+      (0, import_swagger7.ApiNotFoundResponse)({
+        type: import_nesties10.BlankReturnMessageDto,
         description: `The ${this.getEntityClassName()} with the given id was not found`
       }),
-      (0, import_swagger6.ApiBadRequestResponse)({
-        type: import_nesties9.BlankReturnMessageDto,
+      (0, import_swagger7.ApiBadRequestResponse)({
+        type: import_nesties10.BlankReturnMessageDto,
         description: `The ${this.getEntityClassName()} is not valid`
       }),
-      (0, import_swagger6.ApiInternalServerErrorResponse)({
-        type: import_nesties9.BlankReturnMessageDto,
+      (0, import_swagger7.ApiInternalServerErrorResponse)({
+        type: import_nesties10.BlankReturnMessageDto,
         description: "Internal error"
       })
     ]);
@@ -2073,37 +2095,37 @@ var RestfulFactory = class _RestfulFactory {
     return (0, import_common3.Body)(UpdatePipe());
   }
   delete(extras = {}) {
-    return (0, import_nesties9.MergeMethodDecorators)([
+    return (0, import_nesties10.MergeMethodDecorators)([
       this.usePrefix(import_common3.Delete, ":id"),
       (0, import_common3.HttpCode)(200),
-      (0, import_swagger6.ApiOperation)({
+      (0, import_swagger7.ApiOperation)({
         summary: `Delete a ${this.getEntityClassName()} by id`,
         ...extras
       }),
-      (0, import_swagger6.ApiParam)({ name: "id", type: this.idType, required: true }),
-      (0, import_swagger6.ApiOkResponse)({ type: import_nesties9.BlankReturnMessageDto }),
-      (0, import_swagger6.ApiNotFoundResponse)({
-        type: import_nesties9.BlankReturnMessageDto,
+      (0, import_swagger7.ApiParam)({ name: "id", type: this.idType, required: true }),
+      (0, import_swagger7.ApiOkResponse)({ type: import_nesties10.BlankReturnMessageDto }),
+      (0, import_swagger7.ApiNotFoundResponse)({
+        type: import_nesties10.BlankReturnMessageDto,
         description: `The ${this.getEntityClassName()} with the given id was not found`
       }),
-      (0, import_swagger6.ApiInternalServerErrorResponse)({
-        type: import_nesties9.BlankReturnMessageDto,
+      (0, import_swagger7.ApiInternalServerErrorResponse)({
+        type: import_nesties10.BlankReturnMessageDto,
         description: "Internal error"
       })
     ]);
   }
   import(extras = {}) {
-    return (0, import_nesties9.MergeMethodDecorators)([
+    return (0, import_nesties10.MergeMethodDecorators)([
       (0, import_common3.Post)("import"),
       (0, import_common3.HttpCode)(200),
-      (0, import_swagger6.ApiOperation)({
+      (0, import_swagger7.ApiOperation)({
         summary: `Import ${this.getEntityClassName()}`,
         ...extras
       }),
-      (0, import_swagger6.ApiBody)({ type: this.importDto }),
-      (0, import_swagger6.ApiOkResponse)({ type: this.importReturnMessageDto }),
-      (0, import_swagger6.ApiInternalServerErrorResponse)({
-        type: import_nesties9.BlankReturnMessageDto,
+      (0, import_swagger7.ApiBody)({ type: this.importDto }),
+      (0, import_swagger7.ApiOkResponse)({ type: this.importReturnMessageDto }),
+      (0, import_swagger7.ApiInternalServerErrorResponse)({
+        type: import_nesties10.BlankReturnMessageDto,
         description: "Internal error"
       })
     ]);
@@ -2136,7 +2158,7 @@ var RestfulFactory = class _RestfulFactory {
       },
       findAll: {
         paramTypes: [
-          routeOptions.paginateType === "cursor" ? this.findAllCursorPaginatedDto : routeOptions.paginateType === "none" ? (0, import_swagger6.OmitType)(this.findAllDto, [
+          routeOptions.paginateType === "cursor" ? this.findAllCursorPaginatedDto : routeOptions.paginateType === "none" ? (0, import_swagger7.OmitType)(this.findAllDto, [
             "pageCount",
             "recordsPerPage"
           ]) : this.findAllDto
@@ -2219,7 +2241,7 @@ var RestfulFactory = class _RestfulFactory {
         Object.defineProperty(cl.prototype, method, descriptor);
       });
     }
-    return RenameClass(cl, `${this.getEntityClassName()}Controller`);
+    return (0, import_nesties11.RenameClass)(cl, `${this.getEntityClassName()}Controller`);
   }
   crudService(options = {}) {
     return CrudService(this.entityClass, {
@@ -2272,7 +2294,6 @@ var RestfulFactory = class _RestfulFactory {
   QuerySearch,
   Relation,
   RelationComputed,
-  RenameClass,
   RestfulFactory,
   StringColumn,
   StringIdBase,