nicot 1.1.37 → 1.2.0

package/dist/src/bases/base-restful-controller.d.ts

@@ -13,7 +13,7 @@ export declare class BaseRestfulController<T extends {
         relations: (string | RelationDef)[];
         entityClass: ClassType<T>;
     }>;
-    service: CrudBase<T>;
+    _service: CrudBase<T>;
     constructor(serviceOrRepo: CrudBase<T> | Repository<T>, _options?: Partial<{
         paginateType: RestfulPaginateType;
         relations: (string | RelationDef)[];

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

@@ -18,6 +18,7 @@ export interface CrudOptions<T extends ValidCrudEntity<T>> {
     hardDelete?: boolean;
     createOrUpdate?: boolean;
     keepEntityVersioningDates?: boolean;
+    outputFieldsToOmit?: (keyof T)[];
 }
 export declare class CrudBase<T extends ValidCrudEntity<T>> {
     entityClass: ClassType<T>;

package/dist/src/decorators/access.d.ts

@@ -1,4 +1,5 @@
 export declare const NotWritable: () => PropertyDecorator;
+export declare const NotCreatable: () => PropertyDecorator;
 export declare const NotChangeable: () => PropertyDecorator;
 export declare const NotQueryable: () => import("typed-reflector").AllDecorators;
 export declare const NotInResult: (options?: {

package/dist/src/decorators/get-mutator.d.ts

@@ -0,0 +1,17 @@
+import { ApiPropertyOptions } from '@nestjs/swagger';
+export interface GetMutatorOptions {
+    mutator: (s: string) => any;
+    enum?: string[];
+    example?: string;
+    apiPropertyExtras?: ApiPropertyOptions;
+}
+export declare const RequireGetMutator: () => import("typed-reflector").AllDecorators;
+export declare const GetMutator: (mutator: (s: string) => any, options?: Omit<GetMutatorOptions, "mutator">) => import("typed-reflector").AllDecorators;
+export declare const createGetMutator: (mutator: (s: string) => any, defaultOptions?: Omit<GetMutatorOptions, "mutator">) => (options?: Omit<GetMutatorOptions, "mutator">) => import("typed-reflector").AllDecorators;
+export declare const GetMutatorBool: (options?: Omit<GetMutatorOptions, "mutator">) => import("typed-reflector").AllDecorators;
+export declare const GetMutatorInt: (options?: Omit<GetMutatorOptions, "mutator">) => import("typed-reflector").AllDecorators;
+export declare const GetMutatorFloat: (options?: Omit<GetMutatorOptions, "mutator">) => import("typed-reflector").AllDecorators;
+export declare const GetMutatorStringSeparated: (separator?: string, options?: Omit<GetMutatorOptions, "mutator">) => import("typed-reflector").AllDecorators;
+export declare const GetMutatorIntSeparated: (separator?: string, options?: Omit<GetMutatorOptions, "mutator">) => import("typed-reflector").AllDecorators;
+export declare const GetMutatorFloatSeparated: (separator?: string, options?: Omit<GetMutatorOptions, "mutator">) => import("typed-reflector").AllDecorators;
+export declare const GetMutatorJson: (options?: Omit<GetMutatorOptions, "mutator">) => import("typed-reflector").AllDecorators;

package/dist/src/decorators/index.d.ts

@@ -2,3 +2,4 @@ export * from './access';
 export * from './property';
 export * from './pipes';
 export * from './query';
+export * from './get-mutator';

package/dist/src/decorators/pipes.d.ts

@@ -1,4 +1,6 @@
-import { ValidationPipe } from '@nestjs/common';
-export declare const CreatePipe: () => ValidationPipe;
-export declare const GetPipe: () => ValidationPipe;
-export declare const UpdatePipe: () => ValidationPipe;
+import { PipeTransform, ValidationPipe } from '@nestjs/common';
+export declare const OptionalDataPipe: () => ValidationPipe;
+type FieldKey = string | number | symbol;
+export declare const PickPipe: (fields: FieldKey[]) => PipeTransform;
+export declare const OmitPipe: (fields: FieldKey[]) => PipeTransform;
+export {};

package/dist/src/decorators/property.d.ts

@@ -2,10 +2,10 @@ import { ColumnCommonOptions } from 'typeorm/decorator/options/ColumnCommonOptio
 import { ApiPropertyOptions } from '@nestjs/swagger';
 import { ColumnWithLengthOptions } from 'typeorm/decorator/options/ColumnWithLengthOptions';
 import { AnyClass } from 'nesties';
-import { SimpleColumnType, WithLengthColumnType, WithPrecisionColumnType, WithWidthColumnType } from 'typeorm/driver/types/ColumnTypes';
-import { ColumnWithWidthOptions } from 'typeorm/decorator/options/ColumnWithWidthOptions';
+import { SimpleColumnType, UnsignedColumnType, WithLengthColumnType, WithPrecisionColumnType } from 'typeorm/driver/types/ColumnTypes';
 import { ColumnNumericOptions } from 'typeorm/decorator/options/ColumnNumericOptions';
 import { ClassOrArray, ParseType } from 'nesties';
+import { ColumnUnsignedOptions } from 'typeorm/decorator/options/ColumnUnsignedOptions';
 export interface OpenAPIOptions<T> {
     description?: string;
     propertyExtras?: ApiPropertyOptions;
@@ -24,7 +24,7 @@ export declare const TextColumn: (options?: PropertyOptions<string> & {
 export declare const UuidColumn: (options?: PropertyOptions<string> & {
     generated?: boolean;
 }) => PropertyDecorator;
-export declare const IntColumn: (type: WithWidthColumnType, options?: PropertyOptions<number, ColumnWithWidthOptions> & {
+export declare const IntColumn: (type: UnsignedColumnType, options?: PropertyOptions<number, ColumnUnsignedOptions> & {
     unsigned?: boolean;
     range?: {
         min?: number;

package/dist/src/decorators/query.d.ts

@@ -1,17 +1,37 @@
 import { QueryCond } from '../bases';
 import { QueryFullTextColumnOptions } from '../utility/query-full-text-column-options.interface';
 export declare const QueryCondition: (cond: QueryCond) => PropertyDecorator;
-export declare const QueryEqual: () => PropertyDecorator;
-export declare const QueryLike: () => PropertyDecorator;
-export declare const QuerySearch: () => PropertyDecorator;
-export declare const QueryEqualZeroNullable: () => PropertyDecorator;
-export declare const QueryMatchBoolean: () => PropertyDecorator;
-export declare const QueryMatchBooleanMySQL: () => PropertyDecorator;
+export declare const QueryManual: () => PropertyDecorator;
+export declare class QueryWrapInfo<T = unknown> {
+    readonly obj: any;
+    readonly key: string;
+    readonly field: string;
+    private _value;
+    constructor(obj: any, key: string, field: string);
+    get value(): T;
+    mutateValue(next: T): void;
+}
+export type QueryWrapper = (entityExpr: string, varExpr: string, info: QueryWrapInfo<any>) => string | undefined;
+export declare const QueryWrap: (wrapper: QueryWrapper, field?: string) => PropertyDecorator;
+export declare const createQueryWrap: (wrapper: QueryWrapper) => (field?: string) => PropertyDecorator;
+export declare const QueryLike: (field?: string) => PropertyDecorator;
+export declare const QuerySearch: (field?: string) => PropertyDecorator;
+export declare const QueryEqualZeroNullable: (field?: string) => PropertyDecorator;
+export declare const QueryMatchBoolean: (field?: string) => PropertyDecorator;
+export declare const QueryMatchBooleanMySQL: (field?: string) => PropertyDecorator;
 export declare const QueryOperator: (operator: string, field?: string) => PropertyDecorator;
 export declare const createQueryOperator: (operator: string) => (field?: string) => PropertyDecorator;
+export declare const QueryEqual: (field?: string) => PropertyDecorator;
 export declare const QueryGreater: (field?: string) => PropertyDecorator;
 export declare const QueryGreaterEqual: (field?: string) => PropertyDecorator;
 export declare const QueryLess: (field?: string) => PropertyDecorator;
 export declare const QueryLessEqual: (field?: string) => PropertyDecorator;
 export declare const QueryNotEqual: (field?: string) => PropertyDecorator;
+export declare const QueryJsonbHas: (field?: string) => PropertyDecorator;
+export declare const createQueryArrayify: (newWrapper: QueryWrapper, singleFallbackWrapper?: QueryWrapper) => (field?: string) => PropertyDecorator;
+export declare const createQueryOperatorArrayify: (operator: string, singleFallback?: string | QueryWrapper) => (field?: string) => PropertyDecorator;
+export declare const QueryIn: (field?: string) => PropertyDecorator;
+export declare const QueryNotIn: (field?: string) => PropertyDecorator;
 export declare const QueryFullText: (options?: QueryFullTextColumnOptions) => PropertyDecorator;
+export declare const QueryAnd: (...decs: PropertyDecorator[]) => PropertyDecorator;
+export declare const QueryOr: (...decs: PropertyDecorator[]) => PropertyDecorator;

package/dist/src/restful.d.ts

@@ -8,11 +8,16 @@ import { Repository } from 'typeorm';
 import { RelationDef } from './utility/relation-def';
 export interface RestfulFactoryOptions<T> {
     fieldsToOmit?: (keyof T)[];
+    writeFieldsToOmit?: (keyof T)[];
+    createFieldsToOmit?: (keyof T)[];
+    updateFieldsToOmit?: (keyof T)[];
+    findAllFieldsToOmit?: (keyof T)[];
+    outputFieldsToOmit?: (keyof T)[];
     prefix?: string;
     keepEntityVersioningDates?: boolean;
-    outputFieldsToOmit?: (keyof T)[];
     entityClassName?: string;
     relations?: (string | RelationDef)[];
+    skipNonQueryableFields?: boolean;
 }
 export declare class RestfulFactory<T extends {
     id: any;
@@ -21,31 +26,32 @@ export declare class RestfulFactory<T extends {
     private options;
     private __resolveVisited;
     private getEntityClassName;
-    readonly fieldsToOmit: (keyof T)[];
-    private readonly basicInputDto;
-    readonly createDto: ClassType<T>;
-    readonly importDto: new () => {
+    get fieldsToOmit(): (keyof T)[];
+    get fieldsInCreateToOmit(): (keyof T)[];
+    get createDto(): ClassType<T>;
+    get fieldsInUpdateToOmit(): (keyof T)[];
+    get updateDto(): ClassType<T>;
+    get importDto(): new () => {
         data: T[];
     };
-    private readonly fieldsInGetToOmit;
-    readonly findAllDto: ClassType<T>;
-    readonly findAllCursorPaginatedDto: ClassType<T>;
-    readonly updateDto: ClassType<T>;
-    private resolveEntityResultDto;
-    readonly entityResultDto: ClassType<T>;
-    readonly entityCreateResultDto: import("@nestjs/common").Type<Omit<T, keyof T>>;
-    readonly entityReturnMessageDto: new (statusCode: number, message: string, data: T) => import("nesties").GenericReturnMessageDto<T>;
-    readonly entityCreateReturnMessageDto: new (statusCode: number, message: string, data: Omit<T, keyof T>) => import("nesties").GenericReturnMessageDto<Omit<T, keyof T>>;
-    readonly entityArrayReturnMessageDto: new (statusCode: number, message: string, data: T[], total: number, pageSettings: import("nesties").PageSettingsWise) => import("nesties").GenericPaginatedReturnMessageDto<T>;
-    readonly entityCursorPaginationReturnMessageDto: new (statusCode: number, message: string, data: T[], cursorResponse: import("./dto").CursorPaginationResponseWise) => import("./dto").GenericCursorPaginationReturnMessageDto<T>;
-    readonly importReturnMessageDto: new (statusCode: number, message: string, data: {
+    get fieldsInGetToOmit(): (keyof T)[];
+    get queryableFields(): (keyof T)[];
+    get findAllDto(): ClassType<T>;
+    get findAllCursorPaginatedDto(): ClassType<T>;
+    get entityResultDto(): ClassType<T>;
+    get entityCreateResultDto(): import("@nestjs/common").Type<Omit<T, keyof T>>;
+    get entityReturnMessageDto(): new (statusCode: number, message: string, data: T) => import("nesties").GenericReturnMessageDto<T>;
+    get entityCreateReturnMessageDto(): new (statusCode: number, message: string, data: Omit<T, keyof T>) => import("nesties").GenericReturnMessageDto<Omit<T, keyof T>>;
+    get entityArrayReturnMessageDto(): new (statusCode: number, message: string, data: T[], total: number, pageSettings: import("nesties").PageSettingsWise) => import("nesties").GenericPaginatedReturnMessageDto<T>;
+    get entityCursorPaginationReturnMessageDto(): new (statusCode: number, message: string, data: T[], cursorResponse: import("./dto").CursorPaginationResponseWise) => import("./dto").GenericCursorPaginationReturnMessageDto<T>;
+    get importReturnMessageDto(): new (statusCode: number, message: string, data: {
         result: string;
         entry: Omit<T, keyof T>;
     }[]) => import("nesties").GenericReturnMessageDto<{
         result: string;
         entry: Omit<T, keyof T>;
     }[]>;
-    readonly idType: Function;
+    get idType(): StringConstructor | NumberConstructor;
     constructor(entityClass: ClassType<T>, options?: RestfulFactoryOptions<T>, __resolveVisited?: Map<AnyClass, [AnyClass]>);
     private usePrefix;
     create(extras?: Partial<OperationObject>): MethodDecorator;
@@ -54,7 +60,7 @@ export declare class RestfulFactory<T extends {
     idParam(): ParameterDecorator;
     findAll(extras?: Partial<OperationObject>): MethodDecorator;
     findAllCursorPaginated(extras?: Partial<OperationObject>): MethodDecorator;
-    private getBoolColumns;
+    private getMutatorColumns;
     findAllParam(): ParameterDecorator;
     update(extras?: Partial<OperationObject>): MethodDecorator;
     updateParam(): ParameterDecorator;
@@ -74,7 +80,7 @@ export declare class RestfulFactory<T extends {
     } ? M_1 : never; }[keyof NonNullable<Options["routes"]>] & ("update" | "create" | "delete" | "findOne" | "findAll" | "import")> : Pick<BaseRestfulController<T>, { [M in keyof NonNullable<Options["routes"]>]: NonNullable<Options["routes"]>[M] extends {
         enabled: true;
     } ? M : never; }[keyof NonNullable<Options["routes"]>] & ("update" | "create" | "delete" | "findOne" | "findAll" | "import")>) & {
-        service: CrudBase<T>;
+        _service: CrudBase<T>;
     };
     crudService(options?: CrudOptions<T>): {
         new (repo: Repository<T>): {

package/dist/src/utility/memorize.d.ts

@@ -0,0 +1 @@
+export declare const Memorize: () => (_target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;

package/dist/src/utility/metadata.d.ts

@@ -2,11 +2,13 @@ import { MetadataSetter, Reflector } from 'typed-reflector';
 import { QueryCond } from '../bases';
 import { AnyClass } from 'nesties';
 import { QueryFullTextColumnOptions } from './query-full-text-column-options.interface';
+import { GetMutatorOptions } from '../decorators/get-mutator';
 interface SpecificFields {
     notColumn: {
         keepInCreate?: boolean;
     };
     notWritable: boolean;
+    notCreatable: boolean;
     notChangeable: boolean;
     notQueryable: boolean;
     notInResult: {
@@ -17,17 +19,17 @@ interface SpecificFields {
         isArray: boolean;
     };
     queryFullTextColumn: QueryFullTextColumnOptions;
-    boolColumn: boolean;
     notRequiredButHasDefault: boolean;
-}
-interface MetadataMap extends SpecificFields {
     queryCondition: QueryCond;
+    requireGetMutator: boolean;
+    getMutator: GetMutatorOptions;
 }
+type MetadataMap = SpecificFields;
 type FieldsMap = {
     [K in keyof MetadataMap as `${K}Fields`]: string;
 };
-export declare const Metadata: MetadataSetter<MetadataMap, FieldsMap>;
-export declare const reflector: Reflector<MetadataMap, FieldsMap>;
+export declare const Metadata: MetadataSetter<SpecificFields, FieldsMap>;
+export declare const reflector: Reflector<SpecificFields, FieldsMap>;
 export declare function getSpecificFields<K extends keyof SpecificFields>(obj: any, type: K, filter?: (meta: SpecificFields[K], obj: any) => boolean): FieldsMap[`${K}Fields`][];
 export declare function getNotInResultFields(obj: any, keepEntityVersioningDates?: boolean): string[];
 export {};

package/dist/src/utility/mutate-pipe.d.ts

@@ -0,0 +1,8 @@
+import { PipeTransform } from '@nestjs/common';
+import { AnyClass } from 'nesties';
+export declare class MutatorPipe implements PipeTransform {
+    private readonly entityClass;
+    constructor(entityClass: AnyClass);
+    private mutatorFields;
+    transform<T>(obj: T): T;
+}

package/dist/src/utility/omit-type-exclude.d.ts

@@ -1,2 +1,3 @@
 import { ClassType } from 'nesties';
 export declare const OmitTypeExclude: <T, K extends keyof T>(cl: ClassType<T>, keys: readonly K[]) => import("@nestjs/common").Type<Omit<T, K>>;
+export declare const PickTypeExpose: <T, K extends keyof T>(cl: ClassType<T>, keys: readonly K[]) => import("@nestjs/common").Type<Omit<T, K>>;

package/dist/src/utility/parse-bool.d.ts

@@ -1,8 +1 @@
-import { PipeTransform } from '@nestjs/common';
 export declare const parseBool: (value: any) => boolean;
-export declare const parseBoolObject: <T>(obj: T, boolFields: (keyof T)[]) => T;
-export declare class ParseBoolObjectPipe<T> implements PipeTransform {
-    private readonly boolFields;
-    constructor(boolFields: string[]);
-    transform(obj: T): 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.1.37",
+  "version": "1.2.0",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
@@ -91,13 +91,13 @@
     "@nestjs/swagger": "^11.0.0 || ^7.1.8 || ^6.3.0",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.0",
-    "typeorm": "^0.3.16"
+    "typeorm": "^0.3.27"
   },
   "dependencies": {
     "lodash": "^4.17.21",
     "nesties": "^1.1.15",
     "p-queue": "6.6.2",
     "superjson": "1.13.3",
-    "typed-reflector": "^1.0.13"
+    "typed-reflector": "^1.0.14"
   }
 }