@e22m4u/ts-rest-router 0.1.0 → 0.1.1

package/README-ru.md

@@ -37,7 +37,7 @@ npm install @e22m4u/ts-rest-router
 ```ts
 import {get} from '@e22m4u/ts-rest-router';
 import {post} from '@e22m4u/ts-rest-router';
-import {bodyProp} from '@e22m4u/ts-rest-router';
+import {field} from '@e22m4u/ts-rest-router';
 import {DataType} from '@e22m4u/ts-rest-router';
 import {controller} from '@e22m4u/ts-rest-router';
 
@@ -45,12 +45,12 @@ import {controller} from '@e22m4u/ts-rest-router';
 class UserController {        // класс контроллера
   @post('/login')             // метод POST /users/login
   async login(
-    @bodyProp('username', {   // свойство тела запроса "username"
+    @field('username', {      // поле "username" в теле запроса
       type: DataType.STRING,  // тип параметра допускает только строки
       required: true,         // параметр является обязательным
     })
     username: string,
-    @bodyProp('password', {   // свойство тела запроса "password"
+    @field('password', {      // поле "password" в теле запроса
       type: DataType.STRING,  // тип параметра допускает только строки
       required: true,         // параметр является обязательным
     })
@@ -110,7 +110,7 @@ server.listen('8080', '0.0.0.0', () => {
 - `@query` - один query параметр
 - `@queries` - все query параметры как объект
 - `@body` - тело запроса
-- `@bodyProp` - свойство из тела запроса
+- `@field` - поле в теле запроса
 - `@header` - один заголовок
 - `@headers` - все заголовки как объект
 - `@cookie` - одна cookie

package/README.md

@@ -37,7 +37,7 @@ Creating a controller and methods.
 ```ts
 import {get} from '@e22m4u/ts-rest-router';
 import {post} from '@e22m4u/ts-rest-router';
-import {bodyProp} from '@e22m4u/ts-rest-router';
+import {field} from '@e22m4u/ts-rest-router';
 import {DataType} from '@e22m4u/ts-rest-router';
 import {controller} from '@e22m4u/ts-rest-router';
 
@@ -45,12 +45,12 @@ import {controller} from '@e22m4u/ts-rest-router';
 class UserController {       // controller class
   @post('/login')            // POST /users/login method
   async login(
-    @bodyProp('username', {  // "username" is request body property
+    @field('username', {     // "username" is request body field
       type: DataType.STRING, // parameter type allows only strings
       required: true,        // parameter is required
     })
     username: string,
-    @bodyProp('password', {  // "password" is request body property
+    @field('password', {     // "password" is request body field
       type: DataType.STRING, // parameter type allows only strings
       required: true,        // parameter is required
     })
@@ -110,7 +110,7 @@ Request parameters:
 - `@query` - single query parameter
 - `@queries` - all query parameters as an object
 - `@body` - request body
-- `@bodyProp` - property from request body
+- `@field` - field in request body
 - `@header` - single header
 - `@headers` - all headers as an object
 - `@cookie` - single cookie

package/dist/cjs/index.cjs

@@ -51,7 +51,6 @@ __export(index_exports, {
   after: () => after,
   before: () => before,
   body: () => body,
-  bodyProp: () => bodyProp,
   capitalize: () => capitalize,
   controller: () => controller,
   cookie: () => cookie,
@@ -59,6 +58,7 @@ __export(index_exports, {
   createDebugger: () => createDebugger,
   createError: () => createError,
   del: () => del,
+  field: () => field,
   get: () => get,
   header: () => header,
   headers: () => headers,
@@ -470,7 +470,7 @@ var headers = createRequestDataDecoratorWithSource(RequestDataSource.HEADERS);
 var header = createRequestDataPropertyDecoratorWithSource(RequestDataSource.HEADERS);
 var cookies = createRequestDataDecoratorWithSource(RequestDataSource.COOKIE);
 var cookie = createRequestDataPropertyDecoratorWithSource(RequestDataSource.COOKIE);
-var bodyProp = createRequestDataPropertyDecoratorWithSource(RequestDataSource.BODY);
+var field = createRequestDataPropertyDecoratorWithSource(RequestDataSource.BODY);
 function body(schemaOrType) {
   let schema;
   if (typeof schemaOrType === "object") {
@@ -959,7 +959,6 @@ var RestRouter = _RestRouter;
   after,
   before,
   body,
-  bodyProp,
   capitalize,
   controller,
   cookie,
@@ -967,6 +966,7 @@ var RestRouter = _RestRouter;
   createDebugger,
   createError,
   del,
+  field,
   get,
   header,
   headers,

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 bodyProp: (propertyKey: string, schemaOrType?: DataSchema | DataType) => (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
+export declare const field: (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 bodyProp = createRequestDataPropertyDecoratorWithSource(RequestDataSource.BODY);
+export const field = createRequestDataPropertyDecoratorWithSource(RequestDataSource.BODY);
 /**
  * Request body decorator.
  *

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

@@ -16,13 +16,13 @@ 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 { 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('bodyProp', function () {
+        describe('field', function () {
             it('sets a given "propertyKey" to the target metadata', function () {
                 class Target {
                     myMethod(prop) { }
                 }
                 __decorate([
-                    __param(0, bodyProp('myPropertyKey')),
+                    __param(0, field('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, bodyProp(propertyKey, propertyType)),
+                    __param(0, field(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, bodyProp(propertyKey, schema)),
+                    __param(0, field(propertyKey, schema)),
                     __metadata("design:type", Function),
                     __metadata("design:paramtypes", [Object]),
                     __metadata("design:returntype", void 0)

package/package.json

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

package/src/controller-registry.spec.ts

@@ -6,6 +6,7 @@ import {body} from './decorators/index.js';
 import {after} from './decorators/index.js';
 import {query} from './decorators/index.js';
 import {param} from './decorators/index.js';
+import {field} from './decorators/index.js';
 import {cookie} from './decorators/index.js';
 import {params} from './decorators/index.js';
 import {before} from './decorators/index.js';
@@ -13,7 +14,6 @@ import {header} from './decorators/index.js';
 import {cookies} from './decorators/index.js';
 import {queries} from './decorators/index.js';
 import {headers} from './decorators/index.js';
-import {bodyProp} from './decorators/index.js';
 import {HookName} from '@e22m4u/js-trie-router';
 import {controller} from './decorators/index.js';
 import {TrieRouter} from '@e22m4u/js-trie-router';
@@ -31,13 +31,9 @@ import {ControllerRegistry} from './controller-registry.js';
 
 const PRE_HANDLER_1 = () => undefined;
 const PRE_HANDLER_2 = () => undefined;
-// const PRE_HANDLER_3 = () => undefined;
-// const PRE_HANDLER_4 = () => undefined;
 
 const POST_HANDLER_1 = () => undefined;
 const POST_HANDLER_2 = () => undefined;
-// const POST_HANDLER_3 = () => undefined;
-// const POST_HANDLER_4 = () => undefined;
 
 describe('ControllerRegistry', function () {
   it('has a public property with set of controllers', function () {
@@ -872,7 +868,7 @@ describe('ControllerRegistry', function () {
       class MyController {
         @post('/myAction')
         myAction(
-          @bodyProp('foo')
+          @field('foo')
           foo: object,
         ) {
           expect(foo).to.be.eq('bar');

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

@@ -4,13 +4,13 @@ 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 {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';
@@ -409,11 +409,11 @@ describe('requestData', function () {
       });
     });
 
-    describe('bodyProp', function () {
+    describe('field', function () {
       it('sets a given "propertyKey" to the target metadata', function () {
         class Target {
           myMethod(
-            @bodyProp('myPropertyKey')
+            @field('myPropertyKey')
             prop: unknown,
           ) {}
         }
@@ -430,7 +430,7 @@ describe('requestData', function () {
         const propertyType = DataType.STRING;
         class Target {
           myMethod(
-            @bodyProp(propertyKey, propertyType)
+            @field(propertyKey, propertyType)
             prop: unknown,
           ) {}
         }
@@ -457,7 +457,7 @@ describe('requestData', function () {
         const propertyKey = 'myPropertyKey';
         class Target {
           myMethod(
-            @bodyProp(propertyKey, schema)
+            @field(propertyKey, schema)
             prop: unknown,
           ) {}
         }

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

@@ -109,7 +109,7 @@ export const cookies = createRequestDataDecoratorWithSource(
 export const cookie = createRequestDataPropertyDecoratorWithSource(
   RequestDataSource.COOKIE,
 );
-export const bodyProp = createRequestDataPropertyDecoratorWithSource(
+export const field = createRequestDataPropertyDecoratorWithSource(
   RequestDataSource.BODY,
 );