nicot 1.2.3 → 1.2.5

package/dist/index.cjs

@@ -38,6 +38,8 @@ var __decorateClass = (decorators, target, key, kind) => {
 // index.ts
 var index_exports = {};
 __export(index_exports, {
+  BindingColumn: () => BindingColumn,
+  BindingValue: () => BindingValue,
   BlankCursorPaginationReturnMessageDto: () => BlankCursorPaginationReturnMessageDto,
   BoolColumn: () => BoolColumn,
   CrudBase: () => CrudBase,
@@ -45,6 +47,7 @@ __export(index_exports, {
   CursorPaginationDto: () => CursorPaginationDto,
   CursorPaginationReturnMessageDto: () => CursorPaginationReturnMessageDto,
   DateColumn: () => DateColumn,
+  DefaultBindingKey: () => DefaultBindingKey,
   EnumColumn: () => EnumColumn,
   FloatColumn: () => FloatColumn,
   GenericCursorPaginationReturnMessageDto: () => GenericCursorPaginationReturnMessageDto,
@@ -870,6 +873,18 @@ var QueryOr = (...decs) => {
   });
 };
 
+// src/decorators/binding.ts
+var DefaultBindingKey = "default";
+var BindingColumn = (bindingKey = DefaultBindingKey) => Metadata.set("bindingColumn", bindingKey, "bindingColumnFields");
+var BindingValue = (bindingKey = DefaultBindingKey) => (obj, key, des) => {
+  const isMethod = !!des && typeof des.value === "function";
+  Metadata.set(
+    "bindingValue",
+    { bindingKey, isMethod },
+    "bindingValueFields"
+  )(obj, key);
+};
+
 // src/dto/cursor-pagination.ts
 var CursorPaginationDto = class {
 };
@@ -883,7 +898,8 @@ __decorateClass([
     required: false,
     type: String
   }),
-  NotInResult()
+  NotInResult(),
+  QueryManual()
 ], CursorPaginationDto.prototype, "paginationCursor", 2);
 __decorateClass([
   NotWritable(),
@@ -895,7 +911,8 @@ __decorateClass([
     type: Number,
     minimum: 1
   }),
-  NotInResult()
+  NotInResult(),
+  QueryManual()
 ], CursorPaginationDto.prototype, "recordsPerPage", 2);
 var BlankCursorPaginationReturnMessageDto = class extends import_nesties6.BlankReturnMessageDto {
   constructor(statusCode, message, cursorResponse) {
@@ -981,7 +998,8 @@ __decorateClass([
     minimum: 1
   }),
   NotInResult(),
-  Reflect.metadata("design:type", Number)
+  Reflect.metadata("design:type", Number),
+  QueryManual()
 ], PageSettingsDto.prototype, "pageCount", 2);
 __decorateClass([
   NotWritable(),
@@ -993,6 +1011,7 @@ __decorateClass([
     minimum: 1
   }),
   NotInResult(),
+  QueryManual(),
   Reflect.metadata("design:type", Number)
 ], PageSettingsDto.prototype, "recordsPerPage", 2);
 
@@ -1487,7 +1506,11 @@ var CrudBase = class {
     });
     this.log = new import_common2.ConsoleLogger(`${this.entityClass.name}Service`);
     this._typeormRelations = getTypeormRelations(this.entityClass);
+    // binding things
+    this._tmpBindingMap = /* @__PURE__ */ new Map();
+    this._bindingCache = /* @__PURE__ */ new Map();
   }
+  // cleaning entities
   _cleanEntityNotInResultFields(ent) {
     const visited = /* @__PURE__ */ new Set();
     const runSingleObject = (o, cl) => {
@@ -1531,6 +1554,105 @@ var CrudBase = class {
       return this._cleanEntityNotInResultFields(ents);
     }
   }
+  _lookForBindingValueField(bindingKey) {
+    if (this._bindingCache.has(bindingKey)) {
+      return this._bindingCache.get(bindingKey);
+    }
+    const bindingServiceFields = getSpecificFields(this, "bindingValue");
+    const useField = bindingServiceFields.find((f) => {
+      const meta = reflector.get("bindingValue", this, f);
+      return meta?.bindingKey === bindingKey;
+    });
+    if (useField) {
+      const meta = reflector.get("bindingValue", this, useField);
+      const res = {
+        ...meta,
+        field: useField
+      };
+      this._bindingCache.set(bindingKey, res);
+      return res;
+    }
+    return void 0;
+  }
+  _resolveBindingValue(entityField) {
+    const bindingKey = reflector.get(
+      "bindingColumn",
+      this.entityClass,
+      entityField
+    );
+    if (!bindingKey) {
+      return void 0;
+    }
+    if (this._tmpBindingMap.has(bindingKey)) {
+      return this._tmpBindingMap.get(bindingKey);
+    }
+    const bindingValueField = this._lookForBindingValueField(bindingKey);
+    if (!bindingValueField) {
+      return void 0;
+    }
+    if (bindingValueField.isMethod) {
+      return this[bindingValueField.field]();
+    } else {
+      return this[bindingValueField.field];
+    }
+  }
+  // MUST be called 1st on every CRUD operation
+  async getBindingPartialEntity() {
+    const bindingFields = getSpecificFields(this.entityClass, "bindingColumn");
+    if (!bindingFields.length) {
+      return {};
+    }
+    const values = bindingFields.map((field, i) => {
+      return {
+        field,
+        value: this._resolveBindingValue(field),
+        i
+      };
+    });
+    this._tmpBindingMap.clear();
+    const containingPromiseValues = values.filter(
+      (v) => v.value instanceof Promise
+    );
+    if (containingPromiseValues.length) {
+      await Promise.all(
+        containingPromiseValues.map(async (v) => {
+          v.value = await v.value;
+        })
+      );
+    }
+    const res = {};
+    for (const v of values) {
+      if (v.value != null) {
+        res[v.field] = v.value;
+      }
+    }
+    return res;
+  }
+  useBinding(value, bindngKey = DefaultBindingKey) {
+    this._tmpBindingMap.set(bindngKey, value);
+    return this;
+  }
+  _freezeBindings() {
+    const res = {};
+    for (const [key, value] of this._tmpBindingMap.entries()) {
+      res[key] = value;
+    }
+    this._tmpBindingMap.clear();
+    return res;
+  }
+  _restoreBindings(frozen) {
+    this._tmpBindingMap.clear();
+    for (const key of Object.keys(frozen)) {
+      this._tmpBindingMap.set(key, frozen[key]);
+    }
+    return this;
+  }
+  async beforeSuper(fn) {
+    const snap = this._freezeBindings();
+    const res = await fn();
+    this._restoreBindings(snap);
+    return res;
+  }
   async _batchCreate(ents, beforeCreate, skipErrors = false) {
     const entsWithId = ents.filter((ent) => ent.id != null);
     return this.repo.manager.transaction(async (mdb) => {
@@ -1636,6 +1758,7 @@ var CrudBase = class {
     });
   }
   async create(_ent, beforeCreate) {
+    const bindingEnt = await this.getBindingPartialEntity();
     if (!_ent) {
       throw new import_nesties8.BlankReturnMessageDto(400, "Invalid entity").toException();
     }
@@ -1670,6 +1793,7 @@ var CrudBase = class {
           }
         }
       }
+      Object.assign(ent, bindingEnt);
       if (beforeCreate) {
         await beforeCreate(repo);
       }
@@ -1735,10 +1859,20 @@ var CrudBase = class {
   queryBuilder() {
     return this.repo.createQueryBuilder(this.entityAliasName);
   }
+  _applyQueryFromBinding(bindingEnt, qb) {
+    for (const [key, value] of Object.entries(bindingEnt)) {
+      const typeormKey = `_binding_${key}`;
+      qb.andWhere(`${this.entityAliasName}.${key} = :${typeormKey}`, {
+        [typeormKey]: value
+      });
+    }
+  }
   async findOne(id, extraQuery = () => {
   }) {
+    const bindingEnt = await this.getBindingPartialEntity();
     const query = this.queryBuilder().where(`${this.entityAliasName}.id = :id`, { id }).take(1);
     this._applyQueryRelations(query);
+    this._applyQueryFromBinding(bindingEnt, query);
     this.extraGetQuery(query);
     extraQuery(query);
     query.take(1);
@@ -1769,6 +1903,7 @@ var CrudBase = class {
   }
   async _preFindAll(ent, extraQuery = () => {
   }) {
+    const bindingEnt = await this.getBindingPartialEntity();
     const query = this.queryBuilder().where("1 = 1");
     const newEnt = new this.entityClass();
     if (ent) {
@@ -1778,6 +1913,7 @@ var CrudBase = class {
     }
     this._applyQueryRelations(query);
     this._applyQueryFilters(query, newEnt);
+    this._applyQueryFromBinding(bindingEnt, query);
     const pageSettings = newEnt instanceof PageSettingsDto ? newEnt : Object.assign(new PageSettingsDto(), newEnt);
     this.extraGetQuery(query);
     extraQuery(query);
@@ -1836,6 +1972,7 @@ var CrudBase = class {
     }
   }
   async update(id, entPart, cond = {}) {
+    const bindingEnt = await this.getBindingPartialEntity();
     let result;
     const ent = new this.entityClass();
     Object.assign(ent, entPart);
@@ -1848,6 +1985,7 @@ var CrudBase = class {
       result = await this.repo.update(
         {
           id,
+          ...bindingEnt,
           ...cond
         },
         ent
@@ -1869,9 +2007,11 @@ var CrudBase = class {
     return new import_nesties8.BlankReturnMessageDto(200, "success");
   }
   async delete(id, cond = {}) {
+    const bindingEnt = await this.getBindingPartialEntity();
     let result;
     const searchCond = {
       id,
+      ...bindingEnt,
       ...cond
     };
     try {
@@ -1889,6 +2029,7 @@ var CrudBase = class {
     return new import_nesties8.BlankReturnMessageDto(200, "success");
   }
   async importEntities(_ents, extraChecking) {
+    const bindingEnt = await this.getBindingPartialEntity();
     const ents = _ents.map((ent) => {
       const newEnt = new this.entityClass();
       Object.assign(
@@ -1916,6 +2057,9 @@ var CrudBase = class {
     const remainingEnts = ents.filter(
       (ent) => !invalidResults.find((result) => result.entry === ent)
     );
+    for (const ent of remainingEnts) {
+      Object.assign(ent, bindingEnt);
+    }
     await Promise.all(remainingEnts.map((ent) => ent.beforeCreate?.()));
     const data = await this._batchCreate(remainingEnts, void 0, true);
     await Promise.all(data.results.map((e) => e.afterCreate?.()));
@@ -1936,7 +2080,11 @@ var CrudBase = class {
     );
   }
   async exists(id) {
-    const ent = await this.repo.findOne({ where: { id }, select: ["id"] });
+    const bindingEnt = await this.getBindingPartialEntity();
+    const ent = await this.repo.findOne({
+      where: { id, ...bindingEnt },
+      select: ["id"]
+    });
     return !!ent;
   }
   async _loadFullTextIndex() {
@@ -2159,7 +2307,132 @@ var _RestfulFactory = class _RestfulFactory {
       filterRelations(entityClass, options.relations);
     }
   }
-  getEntityClassName() {
+  omitInput(...fields) {
+    return new _RestfulFactory(
+      this.entityClass,
+      {
+        ...this.options,
+        fieldsToOmit: import_lodash5.default.uniq([...this.options.fieldsToOmit || [], ...fields])
+      },
+      this.__resolveVisited
+    );
+  }
+  omitWrite(...fields) {
+    return new _RestfulFactory(
+      this.entityClass,
+      {
+        ...this.options,
+        writeFieldsToOmit: import_lodash5.default.uniq([
+          ...this.options.writeFieldsToOmit || [],
+          ...fields
+        ])
+      },
+      this.__resolveVisited
+    );
+  }
+  omitCreate(...fields) {
+    return new _RestfulFactory(
+      this.entityClass,
+      {
+        ...this.options,
+        createFieldsToOmit: import_lodash5.default.uniq([
+          ...this.options.createFieldsToOmit || [],
+          ...fields
+        ])
+      },
+      this.__resolveVisited
+    );
+  }
+  omitUpdate(...fields) {
+    return new _RestfulFactory(
+      this.entityClass,
+      {
+        ...this.options,
+        updateFieldsToOmit: import_lodash5.default.uniq([
+          ...this.options.updateFieldsToOmit || [],
+          ...fields
+        ])
+      },
+      this.__resolveVisited
+    );
+  }
+  omitFindAll(...fields) {
+    return new _RestfulFactory(
+      this.entityClass,
+      {
+        ...this.options,
+        findAllFieldsToOmit: import_lodash5.default.uniq([
+          ...this.options.findAllFieldsToOmit || [],
+          ...fields
+        ])
+      },
+      this.__resolveVisited
+    );
+  }
+  omitOutput(...fields) {
+    return new _RestfulFactory(
+      this.entityClass,
+      {
+        ...this.options,
+        outputFieldsToOmit: import_lodash5.default.uniq([
+          ...this.options.outputFieldsToOmit || [],
+          ...fields
+        ])
+      },
+      this.__resolveVisited
+    );
+  }
+  pathPrefix(prefix) {
+    return new _RestfulFactory(
+      this.entityClass,
+      {
+        ...this.options,
+        prefix
+      },
+      this.__resolveVisited
+    );
+  }
+  keepEntityVersioningDates(enable = true) {
+    return new _RestfulFactory(
+      this.entityClass,
+      {
+        ...this.options,
+        keepEntityVersioningDates: enable
+      },
+      this.__resolveVisited
+    );
+  }
+  skipNonQueryableFields(enable = true) {
+    return new _RestfulFactory(
+      this.entityClass,
+      {
+        ...this.options,
+        skipNonQueryableFields: enable
+      },
+      this.__resolveVisited
+    );
+  }
+  renameEntityClass(name) {
+    return new _RestfulFactory(
+      this.entityClass,
+      {
+        ...this.options,
+        entityClassName: name
+      },
+      this.__resolveVisited
+    );
+  }
+  useRelations(...relations) {
+    return new _RestfulFactory(
+      this.entityClass,
+      {
+        ...this.options,
+        relations: [...this.options.relations || [], ...relations]
+      },
+      this.__resolveVisited
+    );
+  }
+  get entityClassName() {
     return this.options.entityClassName || this.entityClass.name;
   }
   get fieldsToOmit() {
@@ -2183,7 +2456,7 @@ var _RestfulFactory = class _RestfulFactory {
   get createDto() {
     return (0, import_nesties11.RenameClass)(
       OmitTypeExclude(this.entityClass, this.fieldsInCreateToOmit),
-      `Create${this.entityClass.name}Dto`
+      `Create${this.entityClassName}Dto`
     );
   }
   get fieldsInUpdateToOmit() {
@@ -2198,7 +2471,7 @@ var _RestfulFactory = class _RestfulFactory {
   get updateDto() {
     return (0, import_nesties11.RenameClass)(
       (0, import_swagger6.PartialType)(OmitTypeExclude(this.entityClass, this.fieldsInUpdateToOmit)),
-      `Update${this.entityClass.name}Dto`
+      `Update${this.entityClassName}Dto`
     );
   }
   get importDto() {
@@ -2216,7 +2489,12 @@ var _RestfulFactory = class _RestfulFactory {
   }
   get queryableFields() {
     return import_lodash5.default.difference(
-      getSpecificFields(this.entityClass, "queryCondition"),
+      [
+        ...getSpecificFields(this.entityClass, "queryCondition"),
+        "pageCount",
+        "recordsPerPage",
+        "paginationCursor"
+      ],
       this.fieldsInGetToOmit
     );
   }
@@ -2237,7 +2515,7 @@ var _RestfulFactory = class _RestfulFactory {
     if (this.options.skipNonQueryableFields) {
       cl = PickTypeExpose(cl, this.queryableFields);
     }
-    return (0, import_nesties11.RenameClass)(cl, `Find${this.entityClass.name}Dto`);
+    return (0, import_nesties11.RenameClass)(cl, `Find${this.entityClassName}Dto`);
   }
   get findAllCursorPaginatedDto() {
     return (0, import_nesties11.RenameClass)(
@@ -2245,7 +2523,7 @@ var _RestfulFactory = class _RestfulFactory {
         OmitTypeExclude(this.findAllDto, ["pageCount"]),
         CursorPaginationDto
       ),
-      `Find${this.entityClass.name}CursorPaginatedDto`
+      `Find${this.entityClassName}CursorPaginatedDto`
     );
   }
   get entityResultDto() {
@@ -2288,7 +2566,7 @@ var _RestfulFactory = class _RestfulFactory {
         const relationFactory = new _RestfulFactory(
           relation.propertyClass,
           {
-            entityClassName: `${this.getEntityClassName()}${this.options.relations ? (0, import_lodash5.upperFirst)(relation.propertyName) : relation.propertyClass.name}`,
+            entityClassName: `${this.entityClassName}${this.options.relations ? (0, import_lodash5.upperFirst)(relation.propertyName) : relation.propertyClass.name}`,
             relations: this.options.relations && getNextLevelRelations(
               this.options.relations.map(extractRelationName),
               relation.propertyName
@@ -2319,7 +2597,7 @@ var _RestfulFactory = class _RestfulFactory {
     }
     const res = (0, import_nesties11.RenameClass)(
       resultDto,
-      `${this.getEntityClassName()}ResultDto`
+      `${this.entityClassName}ResultDto`
     );
     const currentContainer = this.__resolveVisited.get(this.entityClass);
     if (currentContainer) {
@@ -2339,7 +2617,7 @@ var _RestfulFactory = class _RestfulFactory {
           (m) => !m.keepInCreate
         )
       ]),
-      `${this.getEntityClassName()}CreateResultDto`
+      `${this.entityClassName}CreateResultDto`
     );
   }
   get entityReturnMessageDto() {
@@ -2381,14 +2659,14 @@ var _RestfulFactory = class _RestfulFactory {
       this.usePrefix(import_common3.Post),
       (0, import_common3.HttpCode)(200),
       (0, import_swagger6.ApiOperation)({
-        summary: `Create a new ${this.getEntityClassName()}`,
+        summary: `Create a new ${this.entityClassName}`,
         ...extras
       }),
       (0, import_swagger6.ApiBody)({ type: this.createDto }),
       (0, import_swagger6.ApiOkResponse)({ type: this.entityCreateReturnMessageDto }),
       (0, import_swagger6.ApiBadRequestResponse)({
         type: import_nesties10.BlankReturnMessageDto,
-        description: `The ${this.getEntityClassName()} is not valid`
+        description: `The ${this.entityClassName} is not valid`
       })
     ]);
   }
@@ -2399,14 +2677,14 @@ var _RestfulFactory = class _RestfulFactory {
     return (0, import_nesties10.MergeMethodDecorators)([
       this.usePrefix(import_common3.Get, ":id"),
       (0, import_swagger6.ApiOperation)({
-        summary: `Find a ${this.getEntityClassName()} by id`,
+        summary: `Find a ${this.entityClassName} 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_nesties10.BlankReturnMessageDto,
-        description: `The ${this.getEntityClassName()} with the given id was not found`
+        description: `The ${this.entityClassName} with the given id was not found`
       })
     ]);
   }
@@ -2421,7 +2699,7 @@ var _RestfulFactory = class _RestfulFactory {
     return (0, import_nesties10.MergeMethodDecorators)([
       this.usePrefix(import_common3.Get),
       (0, import_swagger6.ApiOperation)({
-        summary: `Find all ${this.getEntityClassName()}`,
+        summary: `Find all ${this.entityClassName}`,
         ...extras
       }),
       (0, import_swagger6.ApiOkResponse)({ type: this.entityArrayReturnMessageDto })
@@ -2431,7 +2709,7 @@ var _RestfulFactory = class _RestfulFactory {
     return (0, import_nesties10.MergeMethodDecorators)([
       this.usePrefix(import_common3.Get),
       (0, import_swagger6.ApiOperation)({
-        summary: `Find all ${this.getEntityClassName()}`,
+        summary: `Find all ${this.entityClassName}`,
         ...extras
       }),
       (0, import_swagger6.ApiOkResponse)({ type: this.entityCursorPaginationReturnMessageDto })
@@ -2458,7 +2736,7 @@ var _RestfulFactory = class _RestfulFactory {
       this.usePrefix(import_common3.Patch, ":id"),
       (0, import_common3.HttpCode)(200),
       (0, import_swagger6.ApiOperation)({
-        summary: `Update a ${this.getEntityClassName()} by id`,
+        summary: `Update a ${this.entityClassName} by id`,
         ...extras
       }),
       (0, import_swagger6.ApiParam)({ name: "id", type: this.idType, required: true }),
@@ -2466,11 +2744,11 @@ var _RestfulFactory = class _RestfulFactory {
       (0, import_swagger6.ApiOkResponse)({ type: import_nesties10.BlankReturnMessageDto }),
       (0, import_swagger6.ApiNotFoundResponse)({
         type: import_nesties10.BlankReturnMessageDto,
-        description: `The ${this.getEntityClassName()} with the given id was not found`
+        description: `The ${this.entityClassName} with the given id was not found`
       }),
       (0, import_swagger6.ApiBadRequestResponse)({
         type: import_nesties10.BlankReturnMessageDto,
-        description: `The ${this.getEntityClassName()} is not valid`
+        description: `The ${this.entityClassName} is not valid`
       }),
       (0, import_swagger6.ApiInternalServerErrorResponse)({
         type: import_nesties10.BlankReturnMessageDto,
@@ -2486,14 +2764,14 @@ var _RestfulFactory = class _RestfulFactory {
       this.usePrefix(import_common3.Delete, ":id"),
       (0, import_common3.HttpCode)(200),
       (0, import_swagger6.ApiOperation)({
-        summary: `Delete a ${this.getEntityClassName()} by id`,
+        summary: `Delete a ${this.entityClassName} by id`,
         ...extras
       }),
       (0, import_swagger6.ApiParam)({ name: "id", type: this.idType, required: true }),
       (0, import_swagger6.ApiOkResponse)({ type: import_nesties10.BlankReturnMessageDto }),
       (0, import_swagger6.ApiNotFoundResponse)({
         type: import_nesties10.BlankReturnMessageDto,
-        description: `The ${this.getEntityClassName()} with the given id was not found`
+        description: `The ${this.entityClassName} with the given id was not found`
       }),
       (0, import_swagger6.ApiInternalServerErrorResponse)({
         type: import_nesties10.BlankReturnMessageDto,
@@ -2506,7 +2784,7 @@ var _RestfulFactory = class _RestfulFactory {
       (0, import_common3.Post)("import"),
       (0, import_common3.HttpCode)(200),
       (0, import_swagger6.ApiOperation)({
-        summary: `Import ${this.getEntityClassName()}`,
+        summary: `Import ${this.entityClassName}`,
         ...extras
       }),
       (0, import_swagger6.ApiBody)({ type: this.importDto }),
@@ -2628,7 +2906,7 @@ var _RestfulFactory = class _RestfulFactory {
         Object.defineProperty(cl.prototype, method, descriptor);
       });
     }
-    return (0, import_nesties11.RenameClass)(cl, `${this.getEntityClassName()}Controller`);
+    return (0, import_nesties11.RenameClass)(cl, `${this.entityClassName}Controller`);
   }
   crudService(options = {}) {
     return CrudService(this.entityClass, {
@@ -2760,6 +3038,8 @@ var applyQueryMatchBooleanMySQL = createQueryCondition(
 );
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  BindingColumn,
+  BindingValue,
   BlankCursorPaginationReturnMessageDto,
   BoolColumn,
   CrudBase,
@@ -2767,6 +3047,7 @@ var applyQueryMatchBooleanMySQL = createQueryCondition(
   CursorPaginationDto,
   CursorPaginationReturnMessageDto,
   DateColumn,
+  DefaultBindingKey,
   EnumColumn,
   FloatColumn,
   GenericCursorPaginationReturnMessageDto,