nicot 1.2.5 → 1.2.6

package/dist/src/crud-base.d.ts

@@ -1,8 +1,8 @@
 import { CursorPaginationDto } from './dto';
-import { FindOptionsWhere, Repository, SelectQueryBuilder } from 'typeorm';
+import { FindOneOptions, FindOptionsWhere, Repository, SelectQueryBuilder } from 'typeorm';
 import { EntityHooks, PageSettingsDto, PageSettingsFactory, QueryWise } from './bases';
 import { ConsoleLogger } from '@nestjs/common';
-import { BlankReturnMessageDto, ClassType } from 'nesties';
+import { Awaitable, BlankReturnMessageDto, ClassType, GenericReturnMessageDto } from 'nesties';
 import { RelationDef } from './utility/relation-def';
 import { BindingValueMetadata } from './decorators';
 export type EntityId<T extends {
@@ -27,7 +27,7 @@ export declare class CrudBase<T extends ValidCrudEntity<T>> {
     repo: Repository<T>;
     crudOptions: CrudOptions<T>;
     readonly entityName: string;
-    readonly entityReturnMessageDto: new (statusCode: number, message: string, data: T) => import("nesties").GenericReturnMessageDto<T>;
+    readonly entityReturnMessageDto: new (statusCode: number, message: string, data: T) => GenericReturnMessageDto<T>;
     readonly importEntryDto: new () => {
         result: string;
         entry: T;
@@ -35,7 +35,7 @@ export declare class CrudBase<T extends ValidCrudEntity<T>> {
     readonly importReturnMessageDto: new (statusCode: number, message: string, data: {
         result: string;
         entry: T;
-    }[]) => import("nesties").GenericReturnMessageDto<{
+    }[]) => GenericReturnMessageDto<{
         result: string;
         entry: T;
     }[]>;
@@ -68,14 +68,14 @@ export declare class CrudBase<T extends ValidCrudEntity<T>> {
             entry: T;
         }[];
     }>;
-    create(_ent: T, beforeCreate?: (repo: Repository<T>) => Promise<void>): Promise<import("nesties").GenericReturnMessageDto<T>>;
+    create(_ent: T, beforeCreate?: (repo: Repository<T>) => Promise<void>): Promise<GenericReturnMessageDto<T>>;
     get entityAliasName(): string;
     _applyQueryRelation(qb: SelectQueryBuilder<T>, relation: RelationDef): void;
     _applyQueryRelations(qb: SelectQueryBuilder<T>): void;
     _applyQueryFilters(qb: SelectQueryBuilder<T>, ent: T): void;
     queryBuilder(): SelectQueryBuilder<T>;
     _applyQueryFromBinding(bindingEnt: Partial<T>, qb: SelectQueryBuilder<T>): void;
-    findOne(id: EntityId<T>, extraQuery?: (qb: SelectQueryBuilder<T>) => void): Promise<import("nesties").GenericReturnMessageDto<T>>;
+    findOne(id: EntityId<T>, extraQuery?: (qb: SelectQueryBuilder<T>) => void): Promise<GenericReturnMessageDto<T>>;
     _preFindAll(ent?: Partial<T>, extraQuery?: (qb: SelectQueryBuilder<T>) => void): Promise<{
         query: SelectQueryBuilder<T>;
         newEnt: T;
@@ -85,18 +85,22 @@ export declare class CrudBase<T extends ValidCrudEntity<T>> {
     findAllCursorPaginated(ent?: Partial<T & Partial<CursorPaginationDto>>, extraQuery?: (qb: SelectQueryBuilder<T>) => void): Promise<import("./dto").GenericCursorPaginationReturnMessageDto<T>>;
     update(id: EntityId<T>, entPart: Partial<T>, cond?: FindOptionsWhere<T>): Promise<BlankReturnMessageDto>;
     delete(id: EntityId<T>, cond?: FindOptionsWhere<T>): Promise<BlankReturnMessageDto>;
-    importEntities(_ents: T[], extraChecking?: (ent: T) => string | Promise<string>): Promise<import("nesties").GenericReturnMessageDto<{
+    importEntities(_ents: T[], extraChecking?: (ent: T) => string | Promise<string>): Promise<GenericReturnMessageDto<{
         result: string;
         entry: T;
     }[]>>;
-    exists(id: EntityId<T>): Promise<boolean>;
+    exists(id: EntityId<T>, cond?: FindOptionsWhere<T>): Promise<boolean>;
+    operation<R>(id: EntityId<T>, cb: (ent: T, ctx: {
+        repo: Repository<T>;
+        flush: () => Promise<void>;
+    }) => Awaitable<R>, extraOptions?: FindOneOptions<T>): Promise<GenericReturnMessageDto<R>>;
     _loadFullTextIndex(): Promise<void>;
     onModuleInit(): Promise<void>;
 }
 export declare function CrudService<T extends ValidCrudEntity<T>>(entityClass: ClassType<T>, crudOptions?: CrudOptions<T>): {
     new (repo: Repository<T>): {
         readonly entityName: string;
-        readonly entityReturnMessageDto: new (statusCode: number, message: string, data: T) => import("nesties").GenericReturnMessageDto<T>;
+        readonly entityReturnMessageDto: new (statusCode: number, message: string, data: T) => GenericReturnMessageDto<T>;
         readonly importEntryDto: new () => {
             result: string;
             entry: T;
@@ -104,7 +108,7 @@ export declare function CrudService<T extends ValidCrudEntity<T>>(entityClass: C
         readonly importReturnMessageDto: new (statusCode: number, message: string, data: {
             result: string;
             entry: T;
-        }[]) => import("nesties").GenericReturnMessageDto<{
+        }[]) => GenericReturnMessageDto<{
             result: string;
             entry: T;
         }[]>;
@@ -139,14 +143,14 @@ export declare function CrudService<T extends ValidCrudEntity<T>>(entityClass: C
                 entry: T;
             }[];
         }>;
-        create(_ent: T, beforeCreate?: (repo: Repository<T>) => Promise<void>): Promise<import("nesties").GenericReturnMessageDto<T>>;
+        create(_ent: T, beforeCreate?: (repo: Repository<T>) => Promise<void>): Promise<GenericReturnMessageDto<T>>;
         readonly entityAliasName: string;
         _applyQueryRelation(qb: SelectQueryBuilder<T>, relation: RelationDef): void;
         _applyQueryRelations(qb: SelectQueryBuilder<T>): void;
         _applyQueryFilters(qb: SelectQueryBuilder<T>, ent: T): void;
         queryBuilder(): SelectQueryBuilder<T>;
         _applyQueryFromBinding(bindingEnt: Partial<T>, qb: SelectQueryBuilder<T>): void;
-        findOne(id: EntityId<T>, extraQuery?: (qb: SelectQueryBuilder<T>) => void): Promise<import("nesties").GenericReturnMessageDto<T>>;
+        findOne(id: EntityId<T>, extraQuery?: (qb: SelectQueryBuilder<T>) => void): Promise<GenericReturnMessageDto<T>>;
         _preFindAll(ent?: Partial<T>, extraQuery?: (qb: SelectQueryBuilder<T>) => void): Promise<{
             query: SelectQueryBuilder<T>;
             newEnt: T;
@@ -156,11 +160,15 @@ export declare function CrudService<T extends ValidCrudEntity<T>>(entityClass: C
         findAllCursorPaginated(ent?: Partial<T & Partial<CursorPaginationDto>>, extraQuery?: (qb: SelectQueryBuilder<T>) => void): Promise<import("./dto").GenericCursorPaginationReturnMessageDto<T>>;
         update(id: EntityId<T>, entPart: Partial<T>, cond?: FindOptionsWhere<T>): Promise<BlankReturnMessageDto>;
         delete(id: EntityId<T>, cond?: FindOptionsWhere<T>): Promise<BlankReturnMessageDto>;
-        importEntities(_ents: T[], extraChecking?: (ent: T) => string | Promise<string>): Promise<import("nesties").GenericReturnMessageDto<{
+        importEntities(_ents: T[], extraChecking?: (ent: T) => string | Promise<string>): Promise<GenericReturnMessageDto<{
             result: string;
             entry: T;
         }[]>>;
-        exists(id: EntityId<T>): Promise<boolean>;
+        exists(id: EntityId<T>, cond?: FindOptionsWhere<T>): Promise<boolean>;
+        operation<R>(id: EntityId<T>, cb: (ent: T, ctx: {
+            repo: Repository<T>;
+            flush: () => Promise<void>;
+        }) => Awaitable<R>, extraOptions?: FindOneOptions<T>): Promise<GenericReturnMessageDto<R>>;
         _loadFullTextIndex(): Promise<void>;
         onModuleInit(): Promise<void>;
     };

package/dist/src/restful.d.ts

@@ -1,4 +1,4 @@
-import { AnyClass, BlankReturnMessageDto, ClassType } from 'nesties';
+import { AnyClass, ClassType } from 'nesties';
 import { OperationObject } from '@nestjs/swagger/dist/interfaces/open-api-spec.interface';
 import { CrudBase, CrudOptions } from './crud-base';
 import { PageSettingsDto } from './bases';
@@ -77,6 +77,10 @@ export declare class RestfulFactory<T extends {
     updateParam(): ParameterDecorator;
     delete(extras?: Partial<OperationObject>): MethodDecorator;
     import(extras?: Partial<OperationObject>): MethodDecorator;
+    operation(operationName: string, options?: {
+        returnType?: AnyClass;
+        operationExtras?: Partial<OperationObject>;
+    }): MethodDecorator;
     baseController<Options extends Partial<{
         paginateType: RestfulPaginateType;
         globalMethodDecorators: MethodDecorator[];
@@ -158,13 +162,17 @@ export declare class RestfulFactory<T extends {
             }>;
             findAll(ent?: Partial<T>, extraQuery?: (qb: import("typeorm").SelectQueryBuilder<T>) => void): Promise<import("nesties").GenericPaginatedReturnMessageDto<T>>;
             findAllCursorPaginated(ent?: Partial<T & Partial<CursorPaginationDto>>, extraQuery?: (qb: import("typeorm").SelectQueryBuilder<T>) => void): Promise<import("./dto").GenericCursorPaginationReturnMessageDto<T>>;
-            update(id: import("./crud-base").EntityId<T>, entPart: Partial<T>, cond?: import("typeorm").FindOptionsWhere<T>): Promise<BlankReturnMessageDto>;
-            delete(id: import("./crud-base").EntityId<T>, cond?: import("typeorm").FindOptionsWhere<T>): Promise<BlankReturnMessageDto>;
+            update(id: import("./crud-base").EntityId<T>, entPart: Partial<T>, cond?: import("typeorm").FindOptionsWhere<T>): Promise<import("nesties").BlankReturnMessageDto>;
+            delete(id: import("./crud-base").EntityId<T>, cond?: import("typeorm").FindOptionsWhere<T>): Promise<import("nesties").BlankReturnMessageDto>;
             importEntities(_ents: T[], extraChecking?: (ent: T) => string | Promise<string>): Promise<import("nesties").GenericReturnMessageDto<{
                 result: string;
                 entry: T;
             }[]>>;
-            exists(id: import("./crud-base").EntityId<T>): Promise<boolean>;
+            exists(id: import("./crud-base").EntityId<T>, cond?: import("typeorm").FindOptionsWhere<T>): Promise<boolean>;
+            operation<R_1>(id: import("./crud-base").EntityId<T>, cb: (ent: T, ctx: {
+                repo: Repository<T>;
+                flush: () => Promise<void>;
+            }) => import("nesties").Awaitable<R_1>, extraOptions?: import("typeorm").FindOneOptions<T>): Promise<import("nesties").GenericReturnMessageDto<R_1>>;
             _loadFullTextIndex(): Promise<void>;
             onModuleInit(): Promise<void>;
         };

package/dist/src/utility/observe-diff.d.ts

@@ -0,0 +1,6 @@
+export declare const observeDiff: <T>(obj: T, cb: <K extends keyof T>(change: {
+    type: "add" | "update" | "delete";
+    key: K;
+    oldValue: T[K] | undefined;
+    newValue: T[K] | undefined;
+}) => any) => T;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "nicot",
   "description": "Nest.js interacting with class-validator + OpenAPI + TypeORM for Nest.js Restful API development.",
-  "version": "1.2.5",
+  "version": "1.2.6",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",