@e22m4u/ts-rest-router 0.0.7 → 0.1.0

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

@@ -4,13 +4,38 @@ import { ControllerReflector } from './controller-reflector.js';
 /**
  * Controller decorator.
  *
+ * @param pathOrOptions
  * @param options
  */
-export function controller(options) {
+export function controller(pathOrOptions, options) {
     return function (target) {
         const decoratorType = getDecoratorTargetType(target);
         if (decoratorType !== DecoratorTargetType.CONSTRUCTOR)
             throw new Error('@controller decorator is only supported on a class.');
+        // если первый аргумент является строкой,
+        // то значение используется в качестве
+        // базового пути контроллера
+        if (typeof pathOrOptions === 'string') {
+            // если второй аргумент не определен,
+            // то создается новый объект опций,
+            // который включает базовый путь
+            if (!options) {
+                options = { path: pathOrOptions };
+            }
+            // если второй аргумент определен,
+            // то базовый путь из первого аргумента
+            // передается в объект опций декоратора
+            else {
+                options.path = pathOrOptions;
+            }
+        }
+        // если первый аргумент является объектом,
+        // то его значение используется в качестве
+        // объекта опций декоратора, а второй
+        // аргумент игнорируется
+        else if (typeof pathOrOptions === 'object') {
+            options = pathOrOptions;
+        }
         ControllerReflector.setMetadata({ ...options, className: target.name }, target);
     };
 }

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

@@ -44,4 +44,32 @@ describe('controller', function () {
         const res = ControllerReflector.getMetadata(Target);
         expect(res).to.be.eql({ className: 'Target' });
     });
+    it('allows to pass the path option to the first parameter', function () {
+        let Target = class Target {
+        };
+        Target = __decorate([
+            controller('myPath')
+        ], Target);
+        const res = ControllerReflector.getMetadata(Target);
+        expect(res).to.be.eql({ className: 'Target', path: 'myPath' });
+    });
+    it('merges two given arguments in the target metadata', function () {
+        const before = () => undefined;
+        let Target = class Target {
+        };
+        Target = __decorate([
+            controller('myPath', { before })
+        ], Target);
+        const res = ControllerReflector.getMetadata(Target);
+        expect(res).to.be.eql({ className: 'Target', path: 'myPath', before });
+    });
+    it('overrides the path option by the first argument', function () {
+        let Target = class Target {
+        };
+        Target = __decorate([
+            controller('myPath1', { path: 'myPath2' })
+        ], Target);
+        const res = ControllerReflector.getMetadata(Target);
+        expect(res).to.be.eql({ className: 'Target', path: 'myPath1' });
+    });
 });

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

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

package/dist/esm/decorators/index.js

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

package/dist/esm/decorators/request-data/request-data-decorator.d.ts

@@ -23,7 +23,7 @@ export declare const headers: () => (target: Prototype<object>, propertyKey: str
 export declare const header: (propertyKey: string, schemaOrType?: DataSchema | DataType) => (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
 export declare const cookies: () => (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
 export declare const cookie: (propertyKey: string, schemaOrType?: DataSchema | DataType) => (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
-export declare const bodyParam: (propertyKey: string, schemaOrType?: DataSchema | DataType) => (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
+export declare const bodyProp: (propertyKey: string, schemaOrType?: DataSchema | DataType) => (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
 /**
  * Request body decorator.
  *

package/dist/esm/decorators/request-data/request-data-decorator.js

@@ -63,7 +63,7 @@ export const headers = createRequestDataDecoratorWithSource(RequestDataSource.HE
 export const header = createRequestDataPropertyDecoratorWithSource(RequestDataSource.HEADERS);
 export const cookies = createRequestDataDecoratorWithSource(RequestDataSource.COOKIE);
 export const cookie = createRequestDataPropertyDecoratorWithSource(RequestDataSource.COOKIE);
-export const bodyParam = createRequestDataPropertyDecoratorWithSource(RequestDataSource.BODY);
+export const bodyProp = createRequestDataPropertyDecoratorWithSource(RequestDataSource.BODY);
 /**
  * Request body decorator.
  *

package/dist/esm/decorators/request-data/request-data-decorator.spec.js

@@ -22,7 +22,7 @@ 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 { bodyParam } from './request-data-decorator.js';
+import { bodyProp } from './request-data-decorator.js';
 import { requestData } from './request-data-decorator.js';
 import { RequestDataSource } from './request-data-metadata.js';
 import { RequestDataReflector } from './request-data-reflector.js';
@@ -460,13 +460,13 @@ describe('requestData', function () {
                 });
             });
         });
-        describe('bodyParam', function () {
+        describe('bodyProp', function () {
             it('sets a given "propertyKey" to the target metadata', function () {
                 class Target {
                     myMethod(prop) { }
                 }
                 __decorate([
-                    __param(0, bodyParam('myPropertyKey')),
+                    __param(0, bodyProp('myPropertyKey')),
                     __metadata("design:type", Function),
                     __metadata("design:paramtypes", [Object]),
                     __metadata("design:returntype", void 0)
@@ -485,7 +485,7 @@ describe('requestData', function () {
                     myMethod(prop) { }
                 }
                 __decorate([
-                    __param(0, bodyParam(propertyKey, propertyType)),
+                    __param(0, bodyProp(propertyKey, propertyType)),
                     __metadata("design:type", Function),
                     __metadata("design:paramtypes", [Object]),
                     __metadata("design:returntype", void 0)
@@ -514,7 +514,7 @@ describe('requestData', function () {
                     myMethod(prop) { }
                 }
                 __decorate([
-                    __param(0, bodyParam(propertyKey, schema)),
+                    __param(0, bodyProp(propertyKey, schema)),
                     __metadata("design:type", Function),
                     __metadata("design:paramtypes", [Object]),
                     __metadata("design:returntype", void 0)

package/dist/esm/utils/create-debugger.d.ts

@@ -1,11 +1,44 @@
-import { format } from '@e22m4u/js-format';
 /**
  * Debugger.
  */
-export type Debugger = (...args: Parameters<typeof format>) => void;
+export type Debugger = (messageOrData: string | unknown, ...args: any[]) => void;
 /**
  * Create debugger.
  *
+ * Base usage:
+ * ```ts
+ * const debug = createDebugger('myService');
+ * debug('Service created.');
+ * // ujut:myService Service created.
+ * ```
+ *
+ * Nested namespaces:
+ * ```ts
+ * const debug1 = debug.bind('namespace1');
+ * const debug2 = debug.bind('namespace2');
+ * debug1('Application started');    // ujut:myService [namespace1] Application started
+ * debug2('Connection established'); // ujut:myService [namespace2] Connection established
+ * ```
+ *
+ * Value inspection:
+ * ```ts
+ * debug({foo: 'lorem', bar: 'ipsum'})
+ * // ujut:myService {
+ * // ujut:myService   "foo": "lorem",
+ * // ujut:myService   "bar": "ipsum"
+ * // ujut:myService }
+ * ```
+ *
+ * Titled inspection output:
+ * ```ts
+ * debug({foo: 'lorem', bar: 'ipsum'}, 'My awesome output:')
+ * // ujut:myService My awesome output:
+ * // ujut:myService {
+ * // ujut:myService   "foo": "lorem",
+ * // ujut:myService   "bar": "ipsum"
+ * // ujut:myService }
+ * ```
+ *
  * @param name
  */
 export declare function createDebugger(name: string): Debugger;

package/dist/esm/utils/create-debugger.js

@@ -1,15 +1,81 @@
-import DebugFactory from 'debug';
+import { inspect } from 'util';
+import DebugModule from 'debug';
 import { format } from '@e22m4u/js-format';
+/**
+ * Colorize string.
+ *
+ * @param input
+ */
+function colorizeString(input) {
+    const c = Number(DebugModule['selectColor'](input));
+    const colorCode = '\u001B[3' + (c < 8 ? c : '8;5;' + c);
+    return `${colorCode};1m${input}\u001B[0m`;
+}
 /**
  * Create debugger.
  *
+ * Base usage:
+ * ```ts
+ * const debug = createDebugger('myService');
+ * debug('Service created.');
+ * // ujut:myService Service created.
+ * ```
+ *
+ * Nested namespaces:
+ * ```ts
+ * const debug1 = debug.bind('namespace1');
+ * const debug2 = debug.bind('namespace2');
+ * debug1('Application started');    // ujut:myService [namespace1] Application started
+ * debug2('Connection established'); // ujut:myService [namespace2] Connection established
+ * ```
+ *
+ * Value inspection:
+ * ```ts
+ * debug({foo: 'lorem', bar: 'ipsum'})
+ * // ujut:myService {
+ * // ujut:myService   "foo": "lorem",
+ * // ujut:myService   "bar": "ipsum"
+ * // ujut:myService }
+ * ```
+ *
+ * Titled inspection output:
+ * ```ts
+ * debug({foo: 'lorem', bar: 'ipsum'}, 'My awesome output:')
+ * // ujut:myService My awesome output:
+ * // ujut:myService {
+ * // ujut:myService   "foo": "lorem",
+ * // ujut:myService   "bar": "ipsum"
+ * // ujut:myService }
+ * ```
+ *
  * @param name
  */
 export function createDebugger(name) {
-    const debug = DebugFactory(`tsRestRouter:${name}`);
+    const debuggerName = `tsRestRouter:${name}`;
+    // включить вывод логов можно принудительно
+    // if (!process.env.DEBUG) DebugModule.enable('ujut*');
+    const debug = DebugModule(debuggerName);
+    return function (messageOrData, 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    return function (message, ...args) {
-        const interpolatedMessage = format(message, ...args);
-        return debug(interpolatedMessage);
+    ...args) {
+        let prefix = '';
+        if (typeof this === 'string') {
+            const isDebugUsesColors = debug.useColors;
+            prefix = isDebugUsesColors ? colorizeString(`[${this}] `) : `[${this}] `;
+        }
+        if (typeof messageOrData === 'string') {
+            const interpolatedMessage = format(messageOrData, ...args);
+            return debug(prefix + interpolatedMessage);
+        }
+        const inspectOptions = {
+            showHidden: false,
+            depth: null,
+            colors: true,
+            compact: false,
+        };
+        const multiString = inspect(messageOrData, inspectOptions);
+        const rows = multiString.split('\n');
+        const colorizedDebuggerName = colorizeString(debuggerName);
+        [...args, ...rows].forEach(v => console.log(`  ${colorizedDebuggerName} ${prefix}${v}`));
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e22m4u/ts-rest-router",
-  "version": "0.0.7",
+  "version": "0.1.0",
   "description": "Controllers-based REST router implementation for TypeScript",
   "author": "e22m4u <e22m4u@yandex.ru>",
   "keywords": [