@opra/common 1.8.0 → 1.9.1

package/esm/filter/filter-rules.js

@@ -41,7 +41,6 @@ export class FilterRules {
                 throw new TypeError(`Invalid filter query. Left side should be a data field.`);
             }
             // Check if filtering accepted for given field
-            // const findManyOp = this.getOperation('findMany');
             const rule = this._rules.get(ast.left.value);
             if (!rule) {
                 throw new OpraException({
@@ -67,6 +66,8 @@ export class FilterRules {
                     },
                 });
             }
+            if (rule.prepare)
+                ast.prepare = rule.prepare;
             this.normalizeFilterAst(ast.right, stack, currentType);
             stack.pop();
             return ast;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/common",
-  "version": "1.8.0",
+  "version": "1.9.1",
   "description": "Opra common package",
   "author": "Panates",
   "license": "MIT",

package/types/document/data-type/enum-type.d.ts

@@ -41,9 +41,9 @@ export interface EnumTypeStatic {
      * @constructor
      */
     new (owner: DocumentElement, args?: EnumType.InitArguments): EnumType;
-    <T extends EnumType.EnumObject, B extends EnumType.EnumObject>(enumSource: T, base: B, options: EnumType.Options<T>): B & T;
-    <T extends EnumType.EnumArray, B extends EnumType.EnumArray>(enumSource: T, base: B, options: EnumType.Options<T>): B & T;
-    <T extends EnumType.EnumObject | EnumType.EnumArray>(target: T, options: EnumType.Options<T>): T;
+    <T extends EnumType.EnumObject, B extends EnumType.EnumObject>(enumSource: T, base?: B, options?: EnumType.Options<T>): B & T;
+    <T extends EnumType.EnumArray, B extends EnumType.EnumArray>(enumSource: T, base?: B, options?: EnumType.Options<T>): B & T;
+    <T extends EnumType.EnumObject | EnumType.EnumArray>(target: T, options?: EnumType.Options<T>): T;
 }
 /**
  * Type definition of EnumType prototype

package/types/document/decorators/http-operation-entity-create.decorator.d.ts

@@ -0,0 +1 @@
+export {};

package/types/document/decorators/http-operation-entity-delete-many.decorator.d.ts

@@ -0,0 +1 @@
+export {};

package/types/document/decorators/http-operation-entity-delete.decorator.d.ts

@@ -0,0 +1 @@
+export {};

package/types/document/decorators/http-operation-entity-find-many.decorator.d.ts

@@ -0,0 +1 @@
+export {};

package/types/document/decorators/http-operation-entity-get.decorator.d.ts

@@ -0,0 +1 @@
+export {};

package/types/document/decorators/http-operation-entity-replace.decorator.d.ts

@@ -0,0 +1 @@
+export {};

package/types/document/decorators/http-operation-entity-update-many.decorator.d.ts

@@ -0,0 +1 @@
+export {};

package/types/document/decorators/http-operation-entity-update.decorator.d.ts

@@ -0,0 +1 @@
+export {};

package/types/document/decorators/http-operation-entity.decorator.d.ts

@@ -1,6 +1,7 @@
 import type { StrictOmit, Type, TypeThunkAsync } from 'ts-gems';
 import { OpraFilter } from '../../filter/index.js';
 import { OpraSchema } from '../../schema/index.js';
+import { HttpOperation } from '../http/http-operation.js';
 import type { HttpParameter } from '../http/http-parameter.js';
 import { HttpRequestBody } from '../http/http-request-body.js';
 import { type HttpOperationDecorator } from './http-operation.decorator.js';
@@ -50,8 +51,14 @@ declare module '../http/http-operation.js' {
                 type: Type | string;
             }
             /** DeleteMany */
+            interface FilterOptions {
+                operators?: OpraFilter.ComparisonOperator[];
+                notes?: string;
+                prepare?: (args: OpraFilter.ComparisonExpression.PrepareArgs) => any;
+            }
             interface DeleteManyDecorator extends HttpOperationDecorator {
-                Filter(field: OpraSchema.Field.QualifiedName, operators?: OpraFilter.ComparisonOperator[] | string, notes?: string): this;
+                Filter(field: string, operators?: OpraFilter.ComparisonOperator[] | string): this;
+                Filter(field: string, options?: FilterOptions): this;
             }
             interface DeleteManyArgs extends StrictOmit<HttpOperation.Options, 'method' | 'requestBody'> {
                 type: Type | string;
@@ -59,8 +66,10 @@ declare module '../http/http-operation.js' {
             /** FindMany */
             interface FindManyDecorator extends HttpOperationDecorator {
                 SortFields(...fields: OpraSchema.Field.QualifiedName[]): FindManyDecorator;
+                SortFields(fieldsMap: Record<OpraSchema.Field.QualifiedName, OpraSchema.Field.QualifiedName>): FindManyDecorator;
                 DefaultSort(...fields: OpraSchema.Field.QualifiedName[]): FindManyDecorator;
-                Filter(field: OpraSchema.Field.QualifiedName, operators?: OpraFilter.ComparisonOperator[] | string, notes?: string): this;
+                Filter(field: OpraSchema.Field.QualifiedName, operators?: OpraFilter.ComparisonOperator[] | string): this;
+                Filter(field: string, options?: FilterOptions): this;
             }
             interface FindManyArgs extends StrictOmit<HttpOperation.Options, 'method' | 'requestBody'> {
                 type: Type | string;
@@ -85,7 +94,8 @@ declare module '../http/http-operation.js' {
             /** Update */
             interface UpdateDecorator extends HttpOperationDecorator {
                 KeyParam(name: string, optionsOrType?: StrictOmit<HttpParameter.Options, 'location'> | string | TypeThunkAsync): this;
-                Filter(field: OpraSchema.Field.QualifiedName, operators?: OpraFilter.ComparisonOperator[] | string, notes?: string): this;
+                Filter(field: OpraSchema.Field.QualifiedName, operators?: OpraFilter.ComparisonOperator[] | string): this;
+                Filter(field: string, options?: FilterOptions): this;
             }
             interface UpdateArgs extends StrictOmit<HttpOperation.Options, 'method' | 'requestBody'> {
                 type: Type | string;
@@ -97,7 +107,8 @@ declare module '../http/http-operation.js' {
             }
             /** UpdateMany */
             interface UpdateManyDecorator extends HttpOperationDecorator {
-                Filter(field: OpraSchema.Field.QualifiedName, operators?: OpraFilter.ComparisonOperator[] | string, notes?: string): this;
+                Filter(field: OpraSchema.Field.QualifiedName, operators?: OpraFilter.ComparisonOperator[] | string): this;
+                Filter(field: string, options?: FilterOptions): this;
             }
             interface UpdateManyArgs extends StrictOmit<HttpOperation.Options, 'method' | 'requestBody'> {
                 type: Type | string;
@@ -110,3 +121,20 @@ declare module '../http/http-operation.js' {
         }
     }
 }
+/**
+ *
+ * @param typ
+ */
+export declare function getDataTypeName(typ: Type | string): string;
+/**
+ *
+ */
+export declare function createKeyParamDecorator<T extends HttpOperationDecorator>(decorator: T, decoratorChain: Function[]): (name: string, prmOptions?: StrictOmit<HttpParameter.Options, "location"> | string | Type) => T;
+/**
+ *
+ */
+export declare function createSortFieldsDecorator<T extends HttpOperationDecorator>(decorator: T, decoratorChain: Function[]): (...varargs: any[]) => T;
+/**
+ *
+ */
+export declare function createFilterDecorator<T extends HttpOperationDecorator>(decorator: T, decoratorChain: Function[], dataType: string | Type): (field: string, arg0?: OpraFilter.ComparisonOperator[] | string | HttpOperation.Entity.FilterOptions) => T;

package/types/document/http/http-parameter.d.ts

@@ -16,10 +16,12 @@ export declare namespace HttpParameter {
     }
     interface Options extends Partial<StrictOmit<Metadata, 'type'>> {
         type?: string | TypeThunkAsync | object;
+        parser?: (v: any) => any;
     }
     interface InitArguments extends Combine<{
         type?: DataType;
     }, Metadata> {
+        parser?: (v: any) => any;
     }
 }
 /**
@@ -47,6 +49,7 @@ declare class HttpParameterClass extends Value {
     deprecated?: boolean | string;
     required?: boolean;
     arraySeparator?: string;
+    parser?: (v: any) => any;
     toJSON(options?: ApiDocument.ExportOptions): OpraSchema.HttpParameter;
 }
 export {};

package/types/document/index.d.ts

@@ -1,4 +1,13 @@
 import 'reflect-metadata';
+import './decorators/http-operation-entity.decorator.js';
+import './decorators/http-operation-entity-create.decorator.js';
+import './decorators/http-operation-entity-delete.decorator.js';
+import './decorators/http-operation-entity-delete-many.decorator.js';
+import './decorators/http-operation-entity-find-many.decorator.js';
+import './decorators/http-operation-entity-get.decorator.js';
+import './decorators/http-operation-entity-replace.decorator.js';
+import './decorators/http-operation-entity-update.decorator.js';
+import './decorators/http-operation-entity-update-many.decorator.js';
 import * as RpcControllerDecorator_ from './decorators/rpc-controller.decorator.js';
 import * as RpcOperationDecorator_ from './decorators/rpc-operation.decorator.js';
 import * as DataTypeFactory_ from './factory/data-type.factory.js';
@@ -24,7 +33,6 @@ export * from './data-type/pick-type.js';
 export * from './data-type/primitive-types/index.js';
 export * from './data-type/required-type.js';
 export * from './data-type/simple-type.js';
-export * from './decorators/http-operation-entity.decorator.js';
 export type { RpcControllerDecorator } from './decorators/rpc-controller.decorator.js';
 export type { RpcOperationDecorator } from './decorators/rpc-operation.decorator.js';
 export * from './factory/api-document.factory.js';

package/types/filter/ast/expressions/comparison-expression.d.ts

@@ -5,6 +5,15 @@ export declare class ComparisonExpression extends Expression {
     op: ComparisonOperator;
     left: Expression;
     right: Expression;
+    prepare?: (args: ComparisonExpression.PrepareArgs) => any;
     constructor(o: StrictOmit<ComparisonExpression, 'kind'>);
     toString(): string;
 }
+export declare namespace ComparisonExpression {
+    interface PrepareArgs {
+        left: string;
+        right: any;
+        op: ComparisonOperator;
+        adapter: string;
+    }
+}

package/types/filter/filter-rules.d.ts

@@ -4,7 +4,7 @@ import { Validator } from 'valgen';
 import type { ComplexType } from '../document/index.js';
 import { ResponsiveMap } from '../helpers/index.js';
 import { OpraSchema } from '../schema/index.js';
-import { type ComparisonOperator, Expression } from './ast/index.js';
+import { ComparisonExpression, type ComparisonOperator, Expression } from './ast/index.js';
 export declare namespace FilterRules {
     interface Options {
         caseSensitive?: boolean;
@@ -12,6 +12,7 @@ export declare namespace FilterRules {
     interface Rule {
         operators?: ComparisonOperator[];
         description?: string;
+        prepare?: (args: ComparisonExpression.PrepareArgs) => any;
     }
 }
 export declare class FilterRules {