@e22m4u/ts-rest-router 0.1.1 → 0.2.0

package/src/decorators/{before/before-decorator.spec.ts → before-action/before-action-decorator.spec.ts}

@@ -1,39 +1,39 @@
 /* eslint mocha/no-sibling-hooks: 0 */
 import {expect} from 'chai';
-import {before} from './before-decorator.js';
-import {BeforeReflector} from './before-reflector.js';
+import {beforeAction} from './before-action-decorator.js';
+import {BeforeActionReflector} from './before-action-reflector.js';
 
 const MIDDLEWARE_1 = () => undefined;
 const MIDDLEWARE_2 = () => undefined;
 const MIDDLEWARE_3 = () => undefined;
 
-describe('before', function () {
+describe('beforeAction', function () {
   describe('class target', function () {
     it('sets given middleware to the target metadata', function () {
-      @before(MIDDLEWARE_1)
+      @beforeAction(MIDDLEWARE_1)
       class Target {
         method() {}
       }
-      const res = BeforeReflector.getMetadata(Target);
+      const res = BeforeActionReflector.getMetadata(Target);
       expect(res).to.be.eql([{middleware: MIDDLEWARE_1}]);
     });
 
-    it('sets miltiple middlewares to the target metadata', function () {
-      @before([MIDDLEWARE_1, MIDDLEWARE_2])
+    it('sets multiple middlewares to the target metadata', function () {
+      @beforeAction([MIDDLEWARE_1, MIDDLEWARE_2])
       class Target {
         method() {}
       }
-      const res = BeforeReflector.getMetadata(Target);
+      const res = BeforeActionReflector.getMetadata(Target);
       expect(res).to.be.eql([{middleware: [MIDDLEWARE_1, MIDDLEWARE_2]}]);
     });
 
     it('allows to use the decorator multiple times', function () {
-      @before(MIDDLEWARE_1)
-      @before([MIDDLEWARE_2, MIDDLEWARE_3])
+      @beforeAction(MIDDLEWARE_1)
+      @beforeAction([MIDDLEWARE_2, MIDDLEWARE_3])
       class Target {
         method() {}
       }
-      const res = BeforeReflector.getMetadata(Target);
+      const res = BeforeActionReflector.getMetadata(Target);
       expect(res).to.be.eql([
         {middleware: MIDDLEWARE_1},
         {middleware: [MIDDLEWARE_2, MIDDLEWARE_3]},
@@ -44,10 +44,10 @@ describe('before', function () {
   describe('method target', function () {
     it('sets given middleware to the target metadata', function () {
       class Target {
-        @before(MIDDLEWARE_1)
+        @beforeAction(MIDDLEWARE_1)
         method() {}
       }
-      const res = BeforeReflector.getMetadata(Target, 'method');
+      const res = BeforeActionReflector.getMetadata(Target, 'method');
       expect(res).to.be.eql([
         {
           propertyKey: 'method',
@@ -56,12 +56,12 @@ describe('before', function () {
       ]);
     });
 
-    it('sets miltiple middlewares to the target metadata', function () {
+    it('sets multiple middlewares to the target metadata', function () {
       class Target {
-        @before([MIDDLEWARE_1, MIDDLEWARE_2])
+        @beforeAction([MIDDLEWARE_1, MIDDLEWARE_2])
         method() {}
       }
-      const res = BeforeReflector.getMetadata(Target, 'method');
+      const res = BeforeActionReflector.getMetadata(Target, 'method');
       expect(res).to.be.eql([
         {
           propertyKey: 'method',
@@ -72,11 +72,11 @@ describe('before', function () {
 
     it('allows to use the decorator multiple times', function () {
       class Target {
-        @before(MIDDLEWARE_1)
-        @before([MIDDLEWARE_2, MIDDLEWARE_3])
+        @beforeAction(MIDDLEWARE_1)
+        @beforeAction([MIDDLEWARE_2, MIDDLEWARE_3])
         method() {}
       }
-      const res = BeforeReflector.getMetadata(Target, 'method');
+      const res = BeforeActionReflector.getMetadata(Target, 'method');
       expect(res).to.be.eql([
         {
           propertyKey: 'method',

package/src/decorators/{after/after-decorator.ts → before-action/before-action-decorator.ts}

@@ -1,17 +1,17 @@
 import {Prototype} from '../../types.js';
 import {Constructor} from '../../types.js';
-import {AfterMetadata} from './after-metadata.js';
-import {AfterReflector} from './after-reflector.js';
 import {DecoratorTargetType} from '@e22m4u/ts-reflector';
 import {getDecoratorTargetType} from '@e22m4u/ts-reflector';
+import {BeforeActionMetadata} from './before-action-metadata.js';
+import {BeforeActionReflector} from './before-action-reflector.js';
 
 /**
- * After decorator.
+ * Before action decorator.
  *
- * @param options
+ * @param middleware
  */
-export function after<T extends object>(
-  middleware: AfterMetadata['middleware'],
+export function beforeAction<T extends object>(
+  middleware: BeforeActionMetadata['middleware'],
 ) {
   return function (
     target: Constructor<T> | Prototype<T>,
@@ -24,16 +24,16 @@ export function after<T extends object>(
       descriptor,
     );
     if (decoratorType === DecoratorTargetType.CONSTRUCTOR) {
-      AfterReflector.addMetadata({middleware}, target as Constructor<T>);
+      BeforeActionReflector.addMetadata({middleware}, target as Constructor<T>);
     } else if (decoratorType === DecoratorTargetType.INSTANCE_METHOD) {
-      AfterReflector.addMetadata(
+      BeforeActionReflector.addMetadata(
         {propertyKey, middleware},
         target.constructor as Constructor<T>,
         propertyKey,
       );
     } else {
       throw new Error(
-        '@after decorator is only supported on a class or an instance method.',
+        '@beforeAction decorator is only supported on a class or an instance method.',
       );
     }
   };

package/src/decorators/before-action/before-action-metadata.ts

@@ -0,0 +1,17 @@
+import {MetadataKey} from '@e22m4u/ts-reflector';
+import {RoutePreHandler} from '@e22m4u/js-trie-router';
+
+/**
+ * Before action metadata.
+ */
+export type BeforeActionMetadata = {
+  propertyKey?: string;
+  middleware: RoutePreHandler | RoutePreHandler[];
+};
+
+/**
+ * Before action metadata key.
+ */
+export const BEFORE_ACTION_METADATA_KEY = new MetadataKey<
+  BeforeActionMetadata[]
+>('beforeActionMetadataKey');

package/src/decorators/{after/after-reflector.spec.ts → before-action/before-action-reflector.spec.ts}

@@ -1,23 +1,26 @@
 import {expect} from 'chai';
 import {describe} from 'mocha';
 import {Reflector} from '@e22m4u/ts-reflector';
-import {AfterReflector} from './after-reflector.js';
-import {AFTER_METADATA_KEY} from './after-metadata.js';
+import {BeforeActionReflector} from './before-action-reflector.js';
+import {BEFORE_ACTION_METADATA_KEY} from './before-action-metadata.js';
 
 const MIDDLEWARE_1 = () => undefined;
 const MIDDLEWARE_2 = () => undefined;
 const MIDDLEWARE_3 = () => undefined;
 
-describe('AfterReflector', function () {
+describe('BeforeActionReflector', function () {
   describe('class target', function () {
     describe('addMetadata', function () {
       it('adds a given value to the target metadata', function () {
         class Target {}
         const md1 = {middleware: MIDDLEWARE_1};
         const md2 = {middleware: [MIDDLEWARE_2, MIDDLEWARE_3]};
-        AfterReflector.addMetadata(md1, Target);
-        AfterReflector.addMetadata(md2, Target);
-        const res = Reflector.getOwnMetadata(AFTER_METADATA_KEY, Target);
+        BeforeActionReflector.addMetadata(md1, Target);
+        BeforeActionReflector.addMetadata(md2, Target);
+        const res = Reflector.getOwnMetadata(
+          BEFORE_ACTION_METADATA_KEY,
+          Target,
+        );
         expect(res).to.be.eql([md2, md1]);
       });
     });
@@ -25,7 +28,7 @@ describe('AfterReflector', function () {
     describe('getMetadata', function () {
       it('returns an empty array if no metadata', function () {
         class Target {}
-        const res = AfterReflector.getMetadata(Target);
+        const res = BeforeActionReflector.getMetadata(Target);
         expect(res).to.be.eql([]);
       });
 
@@ -34,8 +37,8 @@ describe('AfterReflector', function () {
         const md1 = {middleware: MIDDLEWARE_1};
         const md2 = {middleware: [MIDDLEWARE_2, MIDDLEWARE_3]};
         const mdArray = [md1, md2];
-        Reflector.defineMetadata(AFTER_METADATA_KEY, mdArray, Target);
-        const res = AfterReflector.getMetadata(Target);
+        Reflector.defineMetadata(BEFORE_ACTION_METADATA_KEY, mdArray, Target);
+        const res = BeforeActionReflector.getMetadata(Target);
         expect(res).to.be.eql(mdArray);
       });
     });
@@ -47,10 +50,10 @@ describe('AfterReflector', function () {
         class Target {}
         const md1 = {middleware: MIDDLEWARE_1};
         const md2 = {middleware: [MIDDLEWARE_2, MIDDLEWARE_3]};
-        AfterReflector.addMetadata(md1, Target, 'prop');
-        AfterReflector.addMetadata(md2, Target, 'prop');
+        BeforeActionReflector.addMetadata(md1, Target, 'prop');
+        BeforeActionReflector.addMetadata(md2, Target, 'prop');
         const res = Reflector.getOwnMetadata(
-          AFTER_METADATA_KEY,
+          BEFORE_ACTION_METADATA_KEY,
           Target,
           'prop',
         );
@@ -61,7 +64,7 @@ describe('AfterReflector', function () {
     describe('getMetadata', function () {
       it('returns an empty array if no metadata', function () {
         class Target {}
-        const res = AfterReflector.getMetadata(Target, 'prop');
+        const res = BeforeActionReflector.getMetadata(Target, 'prop');
         expect(res).to.be.eql([]);
       });
 
@@ -70,8 +73,13 @@ describe('AfterReflector', function () {
         const md1 = {middleware: MIDDLEWARE_1};
         const md2 = {middleware: [MIDDLEWARE_2, MIDDLEWARE_3]};
         const mdArray = [md1, md2];
-        Reflector.defineMetadata(AFTER_METADATA_KEY, mdArray, Target, 'prop');
-        const res = AfterReflector.getMetadata(Target, 'prop');
+        Reflector.defineMetadata(
+          BEFORE_ACTION_METADATA_KEY,
+          mdArray,
+          Target,
+          'prop',
+        );
+        const res = BeforeActionReflector.getMetadata(Target, 'prop');
         expect(res).to.be.eql(mdArray);
       });
     });
@@ -82,10 +90,14 @@ describe('AfterReflector', function () {
       class Target {}
       const md1 = {middleware: MIDDLEWARE_1};
       const md2 = {middleware: MIDDLEWARE_2};
-      AfterReflector.addMetadata(md1, Target);
-      AfterReflector.addMetadata(md2, Target, 'prop');
-      const res1 = Reflector.getOwnMetadata(AFTER_METADATA_KEY, Target);
-      const res2 = Reflector.getOwnMetadata(AFTER_METADATA_KEY, Target, 'prop');
+      BeforeActionReflector.addMetadata(md1, Target);
+      BeforeActionReflector.addMetadata(md2, Target, 'prop');
+      const res1 = Reflector.getOwnMetadata(BEFORE_ACTION_METADATA_KEY, Target);
+      const res2 = Reflector.getOwnMetadata(
+        BEFORE_ACTION_METADATA_KEY,
+        Target,
+        'prop',
+      );
       expect(res1).to.be.eql([md1]);
       expect(res2).to.be.eql([md2]);
     });
@@ -96,10 +108,15 @@ describe('AfterReflector', function () {
       class Target {}
       const md1 = {middleware: MIDDLEWARE_1};
       const md2 = {middleware: MIDDLEWARE_2};
-      Reflector.defineMetadata(AFTER_METADATA_KEY, [md1], Target);
-      Reflector.defineMetadata(AFTER_METADATA_KEY, [md2], Target, 'prop');
-      const res1 = AfterReflector.getMetadata(Target);
-      const res2 = AfterReflector.getMetadata(Target, 'prop');
+      Reflector.defineMetadata(BEFORE_ACTION_METADATA_KEY, [md1], Target);
+      Reflector.defineMetadata(
+        BEFORE_ACTION_METADATA_KEY,
+        [md2],
+        Target,
+        'prop',
+      );
+      const res1 = BeforeActionReflector.getMetadata(Target);
+      const res2 = BeforeActionReflector.getMetadata(Target, 'prop');
       expect(res1).to.be.eql([md1]);
       expect(res2).to.be.eql([md2]);
     });

package/src/decorators/{after/after-reflector.ts → before-action/before-action-reflector.ts}

@@ -1,12 +1,12 @@
 import {Constructor} from '../../types.js';
 import {Reflector} from '@e22m4u/ts-reflector';
-import {AfterMetadata} from './after-metadata.js';
-import {AFTER_METADATA_KEY} from './after-metadata.js';
+import {BeforeActionMetadata} from './before-action-metadata.js';
+import {BEFORE_ACTION_METADATA_KEY} from './before-action-metadata.js';
 
 /**
- * After reflector.
+ * Before action reflector.
  */
-export class AfterReflector {
+export class BeforeActionReflector {
   /**
    * Set metadata.
    *
@@ -15,14 +15,23 @@ export class AfterReflector {
    * @param propertyKey
    */
   static addMetadata(
-    metadata: AfterMetadata,
+    metadata: BeforeActionMetadata,
     target: Constructor,
     propertyKey?: string,
   ) {
     const oldArray =
-      Reflector.getOwnMetadata(AFTER_METADATA_KEY, target, propertyKey) ?? [];
+      Reflector.getOwnMetadata(
+        BEFORE_ACTION_METADATA_KEY,
+        target,
+        propertyKey,
+      ) ?? [];
     const newArray = [metadata, ...oldArray];
-    Reflector.defineMetadata(AFTER_METADATA_KEY, newArray, target, propertyKey);
+    Reflector.defineMetadata(
+      BEFORE_ACTION_METADATA_KEY,
+      newArray,
+      target,
+      propertyKey,
+    );
   }
 
   /**
@@ -34,9 +43,9 @@ export class AfterReflector {
   static getMetadata(
     target: Constructor,
     propertyKey?: string,
-  ): AfterMetadata[] {
+  ): BeforeActionMetadata[] {
     const metadata = Reflector.getOwnMetadata(
-      AFTER_METADATA_KEY,
+      BEFORE_ACTION_METADATA_KEY,
       target,
       propertyKey,
     );

package/src/decorators/before-action/index.ts

@@ -0,0 +1,3 @@
+export * from './before-action-metadata.js';
+export * from './before-action-reflector.js';
+export * from './before-action-decorator.js';

package/src/decorators/index.ts

@@ -1,6 +1,6 @@
-export * from './after/index.js';
-export * from './before/index.js';
-export * from './action/index.js';
-export * from './controller/index.js';
+export * from './rest-action/index.js';
 export * from './request-data/index.js';
+export * from './after-action/index.js';
+export * from './before-action/index.js';
+export * from './rest-controller/index.js';
 export * from './request-context/index.js';

package/src/decorators/request-context/request-context-decorator.spec.ts

@@ -1,9 +1,16 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 import {expect} from 'chai';
+import {httpRequest} from './request-context-decorator.js';
+import {httpResponse} from './request-context-decorator.js';
 import {requestContext} from './request-context-decorator.js';
 import {RequestContextReflector} from './request-context-reflector.js';
 
 describe('requestContext', function () {
+  it('has aliases', function () {
+    expect(httpRequest).to.be.instanceOf(Function);
+    expect(httpResponse).to.be.instanceOf(Function);
+  });
+
   it('does not require options', function () {
     class Target {
       method(

package/src/decorators/request-context/request-context-decorator.ts

@@ -38,15 +38,15 @@ export function requestContext<T extends object>(
 }
 
 /**
- * Request decorator.
+ * HttpRequest decorator.
  */
-export function request() {
+export function httpRequest() {
   return requestContext('req');
 }
 
 /**
- * Response decorator.
+ * HttpResponse decorator.
  */
-export function response() {
+export function httpResponse() {
   return requestContext('res');
 }

package/src/decorators/request-data/request-data-decorator.spec.ts

@@ -1,21 +1,34 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 import {expect} from 'chai';
 import {DataType} from '@e22m4u/ts-data-schema';
-import {body} from './request-data-decorator.js';
-import {param} from './request-data-decorator.js';
-import {query} from './request-data-decorator.js';
-import {field} from './request-data-decorator.js';
-import {cookie} from './request-data-decorator.js';
-import {header} from './request-data-decorator.js';
-import {params} from './request-data-decorator.js';
-import {queries} from './request-data-decorator.js';
-import {cookies} from './request-data-decorator.js';
-import {headers} from './request-data-decorator.js';
 import {requestData} from './request-data-decorator.js';
+import {requestBody} from './request-data-decorator.js';
+import {requestField} from './request-data-decorator.js';
+import {requestParam} from './request-data-decorator.js';
+import {requestQuery} from './request-data-decorator.js';
+import {requestCookie} from './request-data-decorator.js';
+import {requestHeader} from './request-data-decorator.js';
+import {requestParams} from './request-data-decorator.js';
+import {requestQueries} from './request-data-decorator.js';
+import {requestHeaders} from './request-data-decorator.js';
+import {requestCookies} from './request-data-decorator.js';
 import {RequestDataSource} from './request-data-metadata.js';
 import {RequestDataReflector} from './request-data-reflector.js';
 
 describe('requestData', function () {
+  it('has aliases', function () {
+    expect(requestParams).to.be.instanceOf(Function);
+    expect(requestParam).to.be.instanceOf(Function);
+    expect(requestQueries).to.be.instanceOf(Function);
+    expect(requestQuery).to.be.instanceOf(Function);
+    expect(requestHeaders).to.be.instanceOf(Function);
+    expect(requestHeader).to.be.instanceOf(Function);
+    expect(requestCookies).to.be.instanceOf(Function);
+    expect(requestCookie).to.be.instanceOf(Function);
+    expect(requestField).to.be.instanceOf(Function);
+    expect(requestBody).to.be.instanceOf(Function);
+  });
+
   it('sets given options to the target metadata', function () {
     const options = {
       source: RequestDataSource.BODY,
@@ -38,7 +51,7 @@ describe('requestData', function () {
       it('sets metadata with specified source and schema', function () {
         class Target {
           myMethod(
-            @params()
+            @requestParams()
             prop: unknown,
           ) {}
         }
@@ -54,7 +67,7 @@ describe('requestData', function () {
       it('sets metadata with specified source and schema', function () {
         class Target {
           myMethod(
-            @queries()
+            @requestQueries()
             prop: unknown,
           ) {}
         }
@@ -70,7 +83,7 @@ describe('requestData', function () {
       it('sets metadata with specified source and schema', function () {
         class Target {
           myMethod(
-            @headers()
+            @requestHeaders()
             prop: unknown,
           ) {}
         }
@@ -86,7 +99,7 @@ describe('requestData', function () {
       it('sets metadata with specified source and schema', function () {
         class Target {
           myMethod(
-            @cookies()
+            @requestCookies()
             prop: unknown,
           ) {}
         }
@@ -102,7 +115,7 @@ describe('requestData', function () {
       it('sets metadata with specified source and schema', function () {
         class Target {
           myMethod(
-            @body()
+            @requestBody()
             prop: unknown,
           ) {}
         }
@@ -116,7 +129,7 @@ describe('requestData', function () {
       it('sets a given DataType to the target metadata', function () {
         class Target {
           myMethod(
-            @body(DataType.STRING)
+            @requestBody(DataType.STRING)
             prop: unknown,
           ) {}
         }
@@ -131,7 +144,7 @@ describe('requestData', function () {
         const schema = {type: DataType.STRING, required: true};
         class Target {
           myMethod(
-            @body(schema)
+            @requestBody(schema)
             prop: unknown,
           ) {}
         }
@@ -149,7 +162,7 @@ describe('requestData', function () {
       it('sets a given "propertyKey" to the target metadata', function () {
         class Target {
           myMethod(
-            @param('myPropertyKey')
+            @requestParam('myPropertyKey')
             prop: unknown,
           ) {}
         }
@@ -166,7 +179,7 @@ describe('requestData', function () {
         const propertyType = DataType.STRING;
         class Target {
           myMethod(
-            @param(propertyKey, propertyType)
+            @requestParam(propertyKey, propertyType)
             prop: unknown,
           ) {}
         }
@@ -193,7 +206,7 @@ describe('requestData', function () {
         const propertyKey = 'myPropertyKey';
         class Target {
           myMethod(
-            @param(propertyKey, schema)
+            @requestParam(propertyKey, schema)
             prop: unknown,
           ) {}
         }
@@ -215,7 +228,7 @@ describe('requestData', function () {
       it('sets a given "propertyKey" to the target metadata', function () {
         class Target {
           myMethod(
-            @query('myPropertyKey')
+            @requestQuery('myPropertyKey')
             prop: unknown,
           ) {}
         }
@@ -232,7 +245,7 @@ describe('requestData', function () {
         const propertyType = DataType.STRING;
         class Target {
           myMethod(
-            @query(propertyKey, propertyType)
+            @requestQuery(propertyKey, propertyType)
             prop: unknown,
           ) {}
         }
@@ -259,7 +272,7 @@ describe('requestData', function () {
         const propertyKey = 'myPropertyKey';
         class Target {
           myMethod(
-            @query(propertyKey, schema)
+            @requestQuery(propertyKey, schema)
             prop: unknown,
           ) {}
         }
@@ -281,7 +294,7 @@ describe('requestData', function () {
       it('sets a given "propertyKey" to the target metadata', function () {
         class Target {
           myMethod(
-            @header('myPropertyKey')
+            @requestHeader('myPropertyKey')
             prop: unknown,
           ) {}
         }
@@ -298,7 +311,7 @@ describe('requestData', function () {
         const propertyType = DataType.STRING;
         class Target {
           myMethod(
-            @header(propertyKey, propertyType)
+            @requestHeader(propertyKey, propertyType)
             prop: unknown,
           ) {}
         }
@@ -325,7 +338,7 @@ describe('requestData', function () {
         const propertyKey = 'myPropertyKey';
         class Target {
           myMethod(
-            @header(propertyKey, schema)
+            @requestHeader(propertyKey, schema)
             prop: unknown,
           ) {}
         }
@@ -347,7 +360,7 @@ describe('requestData', function () {
       it('sets a given "propertyKey" to the target metadata', function () {
         class Target {
           myMethod(
-            @cookie('myPropertyKey')
+            @requestCookie('myPropertyKey')
             prop: unknown,
           ) {}
         }
@@ -364,7 +377,7 @@ describe('requestData', function () {
         const propertyType = DataType.STRING;
         class Target {
           myMethod(
-            @cookie(propertyKey, propertyType)
+            @requestCookie(propertyKey, propertyType)
             prop: unknown,
           ) {}
         }
@@ -391,7 +404,7 @@ describe('requestData', function () {
         const propertyKey = 'myPropertyKey';
         class Target {
           myMethod(
-            @cookie(propertyKey, schema)
+            @requestCookie(propertyKey, schema)
             prop: unknown,
           ) {}
         }
@@ -413,7 +426,7 @@ describe('requestData', function () {
       it('sets a given "propertyKey" to the target metadata', function () {
         class Target {
           myMethod(
-            @field('myPropertyKey')
+            @requestField('myPropertyKey')
             prop: unknown,
           ) {}
         }
@@ -430,7 +443,7 @@ describe('requestData', function () {
         const propertyType = DataType.STRING;
         class Target {
           myMethod(
-            @field(propertyKey, propertyType)
+            @requestField(propertyKey, propertyType)
             prop: unknown,
           ) {}
         }
@@ -457,7 +470,7 @@ describe('requestData', function () {
         const propertyKey = 'myPropertyKey';
         class Target {
           myMethod(
-            @field(propertyKey, schema)
+            @requestField(propertyKey, schema)
             prop: unknown,
           ) {}
         }