@e22m4u/ts-rest-router 0.1.2 → 0.2.0

package/src/decorators/{controller/controller-decorator.spec.ts → rest-controller/rest-controller-decorator.spec.ts}

@@ -1,13 +1,13 @@
 import {expect} from 'chai';
-import {controller} from './controller-decorator.js';
-import {ControllerOptions} from './controller-decorator.js';
-import {ControllerReflector} from './controller-reflector.js';
+import {restController} from './rest-controller-decorator.js';
+import {RestControllerOptions} from './rest-controller-decorator.js';
+import {RestControllerReflector} from './rest-controller-reflector.js';
 
-describe('controller', function () {
+describe('restController', function () {
   it('does not require options', function () {
-    @controller()
+    @restController()
     class Target {}
-    const res = ControllerReflector.getMetadata(Target);
+    const res = RestControllerReflector.getMetadata(Target);
     expect(res).to.be.eql({className: 'Target'});
   });
 
@@ -18,9 +18,9 @@ describe('controller', function () {
       after: () => undefined,
       extraOption: 'extraOption',
     };
-    @controller(options)
+    @restController(options)
     class Target {}
-    const res = ControllerReflector.getMetadata(Target);
+    const res = RestControllerReflector.getMetadata(Target);
     expect(res).to.be.eql({
       ...options,
       className: 'Target',
@@ -28,31 +28,31 @@ describe('controller', function () {
   });
 
   it('overrides given "className" option by the target class name', function () {
-    @controller({className: 'myClassName'} as ControllerOptions)
+    @restController({className: 'myClassName'} as RestControllerOptions)
     class Target {}
-    const res = ControllerReflector.getMetadata(Target);
+    const res = RestControllerReflector.getMetadata(Target);
     expect(res).to.be.eql({className: 'Target'});
   });
 
   it('allows to pass the path option to the first parameter', function () {
-    @controller('myPath')
+    @restController('myPath')
     class Target {}
-    const res = ControllerReflector.getMetadata(Target);
+    const res = RestControllerReflector.getMetadata(Target);
     expect(res).to.be.eql({className: 'Target', path: 'myPath'});
   });
 
   it('merges two given arguments in the target metadata', function () {
     const before = () => undefined;
-    @controller('myPath', {before})
+    @restController('myPath', {before})
     class Target {}
-    const res = ControllerReflector.getMetadata(Target);
+    const res = RestControllerReflector.getMetadata(Target);
     expect(res).to.be.eql({className: 'Target', path: 'myPath', before});
   });
 
   it('overrides the path option by the first argument', function () {
-    @controller('myPath1', {path: 'myPath2'})
+    @restController('myPath1', {path: 'myPath2'})
     class Target {}
-    const res = ControllerReflector.getMetadata(Target);
+    const res = RestControllerReflector.getMetadata(Target);
     expect(res).to.be.eql({className: 'Target', path: 'myPath1'});
   });
 });

package/src/decorators/{controller/controller-decorator.ts → rest-controller/rest-controller-decorator.ts}

@@ -1,29 +1,33 @@
 import {Flatten} from '../../types.js';
 import {Constructor} from '../../types.js';
 import {DecoratorTargetType} from '@e22m4u/ts-reflector';
-import {ControllerMetadata} from './controller-metadata.js';
 import {getDecoratorTargetType} from '@e22m4u/ts-reflector';
-import {ControllerReflector} from './controller-reflector.js';
+import {RestControllerMetadata} from './rest-controller-metadata.js';
+import {RestControllerReflector} from './rest-controller-reflector.js';
 
 /**
- * Controller options.
+ * Rest controller options.
  */
-export type ControllerOptions = Flatten<Omit<ControllerMetadata, 'className'>>;
+export type RestControllerOptions = Flatten<
+  Omit<RestControllerMetadata, 'className'>
+>;
 
 /**
- * Controller decorator.
+ * Rest controller decorator.
  *
  * @param pathOrOptions
  * @param options
  */
-export function controller<T extends object>(
-  pathOrOptions?: string | ControllerOptions,
-  options?: ControllerOptions,
+export function restController<T extends object>(
+  pathOrOptions?: string | RestControllerOptions,
+  options?: RestControllerOptions,
 ) {
   return function (target: Constructor<T>) {
     const decoratorType = getDecoratorTargetType(target);
     if (decoratorType !== DecoratorTargetType.CONSTRUCTOR)
-      throw new Error('@controller decorator is only supported on a class.');
+      throw new Error(
+        '@restController decorator is only supported on a class.',
+      );
     // если первый аргумент является строкой,
     // то значение используется в качестве
     // базового пути контроллера
@@ -48,7 +52,7 @@ export function controller<T extends object>(
     else if (typeof pathOrOptions === 'object') {
       options = pathOrOptions;
     }
-    ControllerReflector.setMetadata(
+    RestControllerReflector.setMetadata(
       {...options, className: target.name},
       target,
     );

package/src/decorators/{controller/controller-metadata.ts → rest-controller/rest-controller-metadata.ts}

@@ -1,11 +1,11 @@
+import {MetadataKey} from '@e22m4u/ts-reflector';
 import {RoutePreHandler} from '@e22m4u/js-trie-router';
 import {RoutePostHandler} from '@e22m4u/js-trie-router';
-import {MetadataKey} from '@e22m4u/ts-reflector';
 
 /**
- * Controller metadata.
+ * Rest controller metadata.
  */
-export type ControllerMetadata = {
+export type RestControllerMetadata = {
   className: string;
   path?: string;
   before?: RoutePreHandler | RoutePreHandler[];
@@ -13,8 +13,7 @@ export type ControllerMetadata = {
 };
 
 /**
- * Controller metadata key.
+ * Rest controller metadata key.
  */
-export const CONTROLLER_METADATA_KEY = new MetadataKey<ControllerMetadata>(
-  'controllerMetadataKey',
-);
+export const REST_CONTROLLER_METADATA_KEY =
+  new MetadataKey<RestControllerMetadata>('restControllerMetadataKey');

package/src/decorators/{controller/controller-reflector.spec.ts → rest-controller/rest-controller-reflector.spec.ts}

@@ -1,16 +1,19 @@
 import {expect} from 'chai';
 import {describe} from 'mocha';
 import {Reflector} from '@e22m4u/ts-reflector';
-import {ControllerReflector} from './controller-reflector.js';
-import {CONTROLLER_METADATA_KEY} from './controller-metadata.js';
+import {RestControllerReflector} from './rest-controller-reflector.js';
+import {REST_CONTROLLER_METADATA_KEY} from './rest-controller-metadata.js';
 
-describe('ControllerReflector', function () {
+describe('RestControllerReflector', function () {
   describe('setMetadata', function () {
     it('sets a given value as target metadata', function () {
       class Target {}
       const md = {className: 'Target'};
-      ControllerReflector.setMetadata(md, Target);
-      const res = Reflector.getOwnMetadata(CONTROLLER_METADATA_KEY, Target);
+      RestControllerReflector.setMetadata(md, Target);
+      const res = Reflector.getOwnMetadata(
+        REST_CONTROLLER_METADATA_KEY,
+        Target,
+      );
       expect(res).to.be.eq(md);
     });
 
@@ -18,11 +21,17 @@ describe('ControllerReflector', function () {
       class Target {}
       const md1 = {className: 'Target', path: 'path1'};
       const md2 = {className: 'Target', path: 'path2'};
-      ControllerReflector.setMetadata(md1, Target);
-      const res1 = Reflector.getOwnMetadata(CONTROLLER_METADATA_KEY, Target);
+      RestControllerReflector.setMetadata(md1, Target);
+      const res1 = Reflector.getOwnMetadata(
+        REST_CONTROLLER_METADATA_KEY,
+        Target,
+      );
       expect(res1).to.be.eq(md1);
-      ControllerReflector.setMetadata(md2, Target);
-      const res2 = Reflector.getOwnMetadata(CONTROLLER_METADATA_KEY, Target);
+      RestControllerReflector.setMetadata(md2, Target);
+      const res2 = Reflector.getOwnMetadata(
+        REST_CONTROLLER_METADATA_KEY,
+        Target,
+      );
       expect(res2).to.be.eq(md2);
     });
   });
@@ -31,14 +40,14 @@ describe('ControllerReflector', function () {
     it('returns an existing metadata of the target', function () {
       class Target {}
       const md = {className: 'Target'};
-      Reflector.defineMetadata(CONTROLLER_METADATA_KEY, md, Target);
-      const res = ControllerReflector.getMetadata(Target);
+      Reflector.defineMetadata(REST_CONTROLLER_METADATA_KEY, md, Target);
+      const res = RestControllerReflector.getMetadata(Target);
       expect(res).to.be.eq(md);
     });
 
     it('returns undefined if no metadata', function () {
       class Target {}
-      const res = ControllerReflector.getMetadata(Target);
+      const res = RestControllerReflector.getMetadata(Target);
       expect(res).to.be.undefined;
     });
   });

package/src/decorators/rest-controller/rest-controller-reflector.ts

@@ -0,0 +1,32 @@
+import {Constructor} from '../../types.js';
+import {Reflector} from '@e22m4u/ts-reflector';
+import {RestControllerMetadata} from './rest-controller-metadata.js';
+import {REST_CONTROLLER_METADATA_KEY} from './rest-controller-metadata.js';
+
+/**
+ * Rest controller reflector.
+ */
+export class RestControllerReflector {
+  /**
+   * Set metadata.
+   *
+   * @param metadata
+   * @param target
+   */
+  static setMetadata(metadata: RestControllerMetadata, target: Constructor) {
+    return Reflector.defineMetadata(
+      REST_CONTROLLER_METADATA_KEY,
+      metadata,
+      target,
+    );
+  }
+
+  /**
+   * Get metadata.
+   *
+   * @param target
+   */
+  static getMetadata(target: Constructor): RestControllerMetadata | undefined {
+    return Reflector.getOwnMetadata(REST_CONTROLLER_METADATA_KEY, target);
+  }
+}

package/src/errors/not-a-controller-error.ts

@@ -10,6 +10,9 @@ export class NotAControllerError extends Errorf {
    * @param value
    */
   constructor(value: unknown) {
-    super('%v is not a controller, do use @controller decorator on it.', value);
+    super(
+      '%v is not a controller, do use @restController decorator on it.',
+      value,
+    );
   }
 }

package/src/types.ts

@@ -36,16 +36,6 @@ export type Identity<T> = T;
  */
 export type Flatten<T> = Identity<{[k in keyof T]: T[k]}>;
 
-/**
- * A promise or value.
- */
-export type ValueOrPromise<T> = T | PromiseLike<T>;
-
-/**
- * Plain object.
- */
-export type PlainObject = {[key: string]: unknown};
-
 /**
  * Remove null and undefined from T.
  */

package/src/utils/index.ts

@@ -1,4 +1,3 @@
 export * from './capitalize.js';
 export * from './create-error.js';
 export * from './to-camel-case.js';
-export * from './create-debugger.js';

package/dist/esm/decorators/action/action-decorator.d.ts

@@ -1,52 +0,0 @@
-import { Flatten } from '../../types.js';
-import { Prototype } from '../../types.js';
-import { ActionMetadata } from './action-metadata.js';
-/**
- * Action options.
- */
-export type ActionOptions = Flatten<Omit<ActionMetadata, 'propertyKey'>>;
-/**
- * Action decorator.
- *
- * @param options
- */
-export declare function action<T extends object>(options: ActionOptions): (target: Prototype<T>, propertyKey: string, descriptor: PropertyDescriptor) => void;
-/**
- * Action method options.
- */
-export type ActionMethodOptions = Flatten<Omit<ActionOptions, 'method' | 'path'>>;
-/**
- * Get decorator.
- *
- * @param path
- * @param options
- */
-export declare const get: (path: string, options?: ActionMethodOptions) => (target: Prototype<object>, propertyKey: string, descriptor: PropertyDescriptor) => void;
-/**
- * Post decorator.
- *
- * @param path
- * @param options
- */
-export declare const post: (path: string, options?: ActionMethodOptions) => (target: Prototype<object>, propertyKey: string, descriptor: PropertyDescriptor) => void;
-/**
- * Put decorator.
- *
- * @param path
- * @param options
- */
-export declare const put: (path: string, options?: ActionMethodOptions) => (target: Prototype<object>, propertyKey: string, descriptor: PropertyDescriptor) => void;
-/**
- * Patch decorator.
- *
- * @param path
- * @param options
- */
-export declare const patch: (path: string, options?: ActionMethodOptions) => (target: Prototype<object>, propertyKey: string, descriptor: PropertyDescriptor) => void;
-/**
- * Del decorator.
- *
- * @param path
- * @param options
- */
-export declare const del: (path: string, options?: ActionMethodOptions) => (target: Prototype<object>, propertyKey: string, descriptor: PropertyDescriptor) => void;

package/dist/esm/decorators/action/action-decorator.js

@@ -1,62 +0,0 @@
-import { HttpMethod } from '@e22m4u/js-trie-router';
-import { ActionReflector } from './action-reflector.js';
-import { DecoratorTargetType } from '@e22m4u/ts-reflector';
-import { getDecoratorTargetType } from '@e22m4u/ts-reflector';
-/**
- * Action decorator.
- *
- * @param options
- */
-export function action(options) {
-    return function (target, propertyKey, descriptor) {
-        const decoratorType = getDecoratorTargetType(target, propertyKey, descriptor);
-        if (decoratorType !== DecoratorTargetType.INSTANCE_METHOD)
-            throw new Error('@action decorator is only supported on an instance method.');
-        ActionReflector.setMetadata({ ...options, propertyKey }, target.constructor, propertyKey);
-    };
-}
-/**
- * Get decorator.
- *
- * @param path
- * @param options
- */
-export const get = (path, options) => {
-    return action({ ...options, path, method: HttpMethod.GET });
-};
-/**
- * Post decorator.
- *
- * @param path
- * @param options
- */
-export const post = (path, options) => {
-    return action({ ...options, path, method: HttpMethod.POST });
-};
-/**
- * Put decorator.
- *
- * @param path
- * @param options
- */
-export const put = (path, options) => {
-    return action({ ...options, path, method: HttpMethod.PUT });
-};
-/**
- * Patch decorator.
- *
- * @param path
- * @param options
- */
-export const patch = (path, options) => {
-    return action({ ...options, path, method: HttpMethod.PATCH });
-};
-/**
- * Del decorator.
- *
- * @param path
- * @param options
- */
-export const del = (path, options) => {
-    return action({ ...options, path, method: HttpMethod.DELETE });
-};

package/dist/esm/decorators/action/action-decorator.spec.js

@@ -1,59 +0,0 @@
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-import { expect } from 'chai';
-import { action } from './action-decorator.js';
-import { HttpMethod } from '@e22m4u/js-trie-router';
-import { ActionReflector } from './action-reflector.js';
-describe('action', function () {
-    it('sets given options to the target metadata', function () {
-        const options = {
-            method: HttpMethod.GET,
-            path: 'myPath',
-            before: () => undefined,
-            after: () => undefined,
-            customOption: 'customOption',
-        };
-        class Target {
-            method() { }
-        }
-        __decorate([
-            action(options),
-            __metadata("design:type", Function),
-            __metadata("design:paramtypes", []),
-            __metadata("design:returntype", void 0)
-        ], Target.prototype, "method", null);
-        const res = ActionReflector.getMetadata(Target);
-        expect(res.get('method')).to.be.eql({
-            ...options,
-            propertyKey: 'method',
-        });
-    });
-    it('overrides a given "propertyKey" option by the target method name', function () {
-        const options = {
-            propertyKey: 'myMethod',
-            method: HttpMethod.GET,
-            path: 'myPath',
-        };
-        class Target {
-            method() { }
-        }
-        __decorate([
-            action(options),
-            __metadata("design:type", Function),
-            __metadata("design:paramtypes", []),
-            __metadata("design:returntype", void 0)
-        ], Target.prototype, "method", null);
-        const res = ActionReflector.getMetadata(Target);
-        expect(res.get('method')).to.be.eql({
-            ...options,
-            propertyKey: 'method',
-        });
-    });
-});

package/dist/esm/decorators/action/action-metadata.js

@@ -1,5 +0,0 @@
-import { MetadataKey } from '@e22m4u/ts-reflector';
-/**
- * Actions metadata key.
- */
-export const ACTIONS_METADATA_KEY = new MetadataKey('actionsMetadataKey');

package/dist/esm/decorators/action/action-reflector.d.ts

@@ -1,22 +0,0 @@
-import { Constructor } from '../../types.js';
-import { ActionMetadata } from './action-metadata.js';
-import { ActionMetadataMap } from './action-metadata.js';
-/**
- * Action reflector.
- */
-export declare class ActionReflector {
-    /**
-     * Set metadata.
-     *
-     * @param metadata
-     * @param target
-     * @param propertyKey
-     */
-    static setMetadata(metadata: ActionMetadata, target: Constructor, propertyKey: string): void;
-    /**
-     * Get metadata.
-     *
-     * @param target
-     */
-    static getMetadata(target: Constructor): ActionMetadataMap;
-}

package/dist/esm/decorators/action/index.d.ts

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

package/dist/esm/decorators/action/index.js

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

package/dist/esm/decorators/after/after-decorator.d.ts

@@ -1,9 +0,0 @@
-import { Prototype } from '../../types.js';
-import { Constructor } from '../../types.js';
-import { AfterMetadata } from './after-metadata.js';
-/**
- * After decorator.
- *
- * @param options
- */
-export declare function after<T extends object>(middleware: AfterMetadata['middleware']): (target: Constructor<T> | Prototype<T>, propertyKey?: string, descriptor?: PropertyDescriptor) => void;

package/dist/esm/decorators/after/after-metadata.js

@@ -1,5 +0,0 @@
-import { MetadataKey } from '@e22m4u/ts-reflector';
-/**
- * After metadata key.
- */
-export const AFTER_METADATA_KEY = new MetadataKey('afterMetadataKey');

package/dist/esm/decorators/after/index.d.ts

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

package/dist/esm/decorators/after/index.js

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

package/dist/esm/decorators/before/before-decorator.d.ts

@@ -1,9 +0,0 @@
-import { Prototype } from '../../types.js';
-import { Constructor } from '../../types.js';
-import { BeforeMetadata } from './before-metadata.js';
-/**
- * Before decorator.
- *
- * @param options
- */
-export declare function before<T extends object>(middleware: BeforeMetadata['middleware']): (target: Constructor<T> | Prototype<T>, propertyKey?: string, descriptor?: PropertyDescriptor) => void;

package/dist/esm/decorators/before/before-metadata.js

@@ -1,5 +0,0 @@
-import { MetadataKey } from '@e22m4u/ts-reflector';
-/**
- * Before metadata key.
- */
-export const BEFORE_METADATA_KEY = new MetadataKey('beforeMetadataKey');

package/dist/esm/decorators/before/index.d.ts

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

package/dist/esm/decorators/before/index.js

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

package/dist/esm/decorators/controller/controller-decorator.d.ts

@@ -1,14 +0,0 @@
-import { Flatten } from '../../types.js';
-import { Constructor } from '../../types.js';
-import { ControllerMetadata } from './controller-metadata.js';
-/**
- * Controller options.
- */
-export type ControllerOptions = Flatten<Omit<ControllerMetadata, 'className'>>;
-/**
- * Controller decorator.
- *
- * @param pathOrOptions
- * @param options
- */
-export declare function controller<T extends object>(pathOrOptions?: string | ControllerOptions, options?: ControllerOptions): (target: Constructor<T>) => void;

package/dist/esm/decorators/controller/controller-metadata.js

@@ -1,5 +0,0 @@
-import { MetadataKey } from '@e22m4u/ts-reflector';
-/**
- * Controller metadata key.
- */
-export const CONTROLLER_METADATA_KEY = new MetadataKey('controllerMetadataKey');

package/dist/esm/decorators/controller/controller-reflector.d.ts

@@ -1,20 +0,0 @@
-import { Constructor } from '../../types.js';
-import { ControllerMetadata } from './controller-metadata.js';
-/**
- * Controller reflector.
- */
-export declare class ControllerReflector {
-    /**
-     * Set metadata.
-     *
-     * @param metadata
-     * @param target
-     */
-    static setMetadata(metadata: ControllerMetadata, target: Constructor): void;
-    /**
-     * Get metadata.
-     *
-     * @param target
-     */
-    static getMetadata(target: Constructor): ControllerMetadata | undefined;
-}

package/dist/esm/decorators/controller/controller-reflector.js

@@ -1,24 +0,0 @@
-import { Reflector } from '@e22m4u/ts-reflector';
-import { CONTROLLER_METADATA_KEY } from './controller-metadata.js';
-/**
- * Controller reflector.
- */
-export class ControllerReflector {
-    /**
-     * Set metadata.
-     *
-     * @param metadata
-     * @param target
-     */
-    static setMetadata(metadata, target) {
-        return Reflector.defineMetadata(CONTROLLER_METADATA_KEY, metadata, target);
-    }
-    /**
-     * Get metadata.
-     *
-     * @param target
-     */
-    static getMetadata(target) {
-        return Reflector.getOwnMetadata(CONTROLLER_METADATA_KEY, target);
-    }
-}

package/dist/esm/decorators/controller/index.d.ts

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

package/dist/esm/decorators/controller/index.js

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