@e22m4u/ts-rest-router 0.0.2

package/dist/esm/decorators/request-context/index.d.ts

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

package/dist/esm/decorators/request-context/index.js

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

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

@@ -0,0 +1,17 @@
+import { Prototype } from '../../types.js';
+import { RequestContext } from '@e22m4u/js-trie-router';
+import { RequestContextMetadata } from './request-context-metadata.js';
+/**
+ * Request context decorator.
+ *
+ * @param propertyOrMetadata
+ */
+export declare function requestContext<T extends object>(propertyOrMetadata?: keyof RequestContext | RequestContextMetadata): (target: Prototype<T>, propertyKey: string, indexOrDescriptor: number) => void;
+/**
+ * Request decorator.
+ */
+export declare function request(): (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
+/**
+ * Response decorator.
+ */
+export declare function response(): (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;

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

@@ -0,0 +1,32 @@
+import { DecoratorTargetType } from '@e22m4u/ts-reflector';
+import { getDecoratorTargetType } from '@e22m4u/ts-reflector';
+import { RequestContextReflector } from './request-context-reflector.js';
+/**
+ * Request context decorator.
+ *
+ * @param propertyOrMetadata
+ */
+export function requestContext(propertyOrMetadata) {
+    return function (target, propertyKey, indexOrDescriptor) {
+        const decoratorType = getDecoratorTargetType(target, propertyKey, indexOrDescriptor);
+        if (decoratorType !== DecoratorTargetType.INSTANCE_METHOD_PARAMETER)
+            throw new Error('@requestContext decorator is only supported ' +
+                'on an instance method parameter.');
+        const metadata = typeof propertyOrMetadata !== 'object'
+            ? { property: propertyOrMetadata }
+            : propertyOrMetadata;
+        RequestContextReflector.setMetadata(metadata, target.constructor, indexOrDescriptor, propertyKey);
+    };
+}
+/**
+ * Request decorator.
+ */
+export function request() {
+    return requestContext('req');
+}
+/**
+ * Response decorator.
+ */
+export function response() {
+    return requestContext('res');
+}

package/dist/esm/decorators/request-context/request-context-decorator.spec.d.ts

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

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

@@ -0,0 +1,59 @@
+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);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import { expect } from 'chai';
+import { requestContext } from './request-context-decorator.js';
+import { RequestContextReflector } from './request-context-reflector.js';
+describe('requestContext', function () {
+    it('does not requires options', function () {
+        class Target {
+            method(prop) { }
+        }
+        __decorate([
+            __param(0, requestContext()),
+            __metadata("design:type", Function),
+            __metadata("design:paramtypes", [Object]),
+            __metadata("design:returntype", void 0)
+        ], Target.prototype, "method", null);
+        const res = RequestContextReflector.getMetadata(Target, 'method');
+        expect(res.get(0)).to.be.eql({ property: undefined });
+    });
+    it('sets a given key of RequestContext as "propertyKey" of the target metadata', function () {
+        class Target {
+            method(prop) { }
+        }
+        __decorate([
+            __param(0, requestContext('res')),
+            __metadata("design:type", Function),
+            __metadata("design:paramtypes", [Object]),
+            __metadata("design:returntype", void 0)
+        ], Target.prototype, "method", null);
+        const res = RequestContextReflector.getMetadata(Target, 'method');
+        expect(res.get(0)).to.be.eql({ property: 'res' });
+    });
+    it('sets a given RequestContextMetadata as the target metadata', function () {
+        const property = 'res';
+        const customOption = 'customOption';
+        class Target {
+            method(prop) { }
+        }
+        __decorate([
+            __param(0, requestContext({ property, customOption })),
+            __metadata("design:type", Function),
+            __metadata("design:paramtypes", [Object]),
+            __metadata("design:returntype", void 0)
+        ], Target.prototype, "method", null);
+        const res = RequestContextReflector.getMetadata(Target, 'method');
+        expect(res.get(0)).to.be.eql({ property, customOption });
+    });
+});

package/dist/esm/decorators/request-context/request-context-metadata.d.ts

@@ -0,0 +1,17 @@
+import { MetadataKey } from '@e22m4u/ts-reflector';
+import { RequestContext } from '@e22m4u/js-trie-router';
+/**
+ * Request context metadata.
+ */
+export type RequestContextMetadata = {
+    property?: keyof RequestContext;
+    [option: string]: unknown | undefined;
+};
+/**
+ * Request context metadata map.
+ */
+export type RequestContextMetadataMap = Map<number, RequestContextMetadata>;
+/**
+ * Request context metadata key.
+ */
+export declare const REQUEST_CONTEXT_METADATA_KEY: MetadataKey<RequestContextMetadataMap>;

package/dist/esm/decorators/request-context/request-context-metadata.js

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

package/dist/esm/decorators/request-context/request-context-reflector.d.ts

@@ -0,0 +1,24 @@
+import { Constructor } from '../../types.js';
+import { RequestContextMetadata } from './request-context-metadata.js';
+import { RequestContextMetadataMap } from './request-context-metadata.js';
+/**
+ * Request context reflector.
+ */
+export declare class RequestContextReflector {
+    /**
+     * Set metadata.
+     *
+     * @param metadata
+     * @param target
+     * @param index
+     * @param propertyKey
+     */
+    static setMetadata(metadata: RequestContextMetadata, target: Constructor, index: number, propertyKey: string): void;
+    /**
+     * Get metadata.
+     *
+     * @param target
+     * @param propertyKey
+     */
+    static getMetadata(target: Constructor, propertyKey: string): RequestContextMetadataMap;
+}

package/dist/esm/decorators/request-context/request-context-reflector.js

@@ -0,0 +1,31 @@
+import { Reflector } from '@e22m4u/ts-reflector';
+import { REQUEST_CONTEXT_METADATA_KEY } from './request-context-metadata.js';
+/**
+ * Request context reflector.
+ */
+export class RequestContextReflector {
+    /**
+     * Set metadata.
+     *
+     * @param metadata
+     * @param target
+     * @param index
+     * @param propertyKey
+     */
+    static setMetadata(metadata, target, index, propertyKey) {
+        const oldMap = Reflector.getOwnMetadata(REQUEST_CONTEXT_METADATA_KEY, target, propertyKey);
+        const newMap = new Map(oldMap);
+        newMap.set(index, metadata);
+        Reflector.defineMetadata(REQUEST_CONTEXT_METADATA_KEY, newMap, target, propertyKey);
+    }
+    /**
+     * Get metadata.
+     *
+     * @param target
+     * @param propertyKey
+     */
+    static getMetadata(target, propertyKey) {
+        const metadata = Reflector.getOwnMetadata(REQUEST_CONTEXT_METADATA_KEY, target, propertyKey);
+        return metadata ?? new Map();
+    }
+}

package/dist/esm/decorators/request-context/request-context-reflector.spec.d.ts

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

package/dist/esm/decorators/request-context/request-context-reflector.spec.js

@@ -0,0 +1,59 @@
+import { expect } from 'chai';
+import { describe } from 'mocha';
+import { Reflector } from '@e22m4u/ts-reflector';
+import { RequestContextReflector } from './request-context-reflector.js';
+import { REQUEST_CONTEXT_METADATA_KEY } from './request-context-metadata.js';
+describe('RequestContextReflector', function () {
+    describe('setMetadata', function () {
+        it('sets a given value as target metadata', function () {
+            class Target {
+            }
+            const md1 = { property: 'req' };
+            const md2 = { property: 'res' };
+            RequestContextReflector.setMetadata(md1, Target, 0, 'propertyKey');
+            RequestContextReflector.setMetadata(md2, Target, 1, 'propertyKey');
+            const res = Reflector.getOwnMetadata(REQUEST_CONTEXT_METADATA_KEY, Target, 'propertyKey');
+            expect(res).to.be.instanceof(Map);
+            expect(res.get(0)).to.be.eq(md1);
+            expect(res.get(1)).to.be.eq(md2);
+        });
+        it('overrides existing metadata', function () {
+            class Target {
+            }
+            const md1 = { property: 'req' };
+            const md2 = { property: 'res' };
+            RequestContextReflector.setMetadata(md1, Target, 0, 'propertyKey');
+            const res1 = Reflector.getOwnMetadata(REQUEST_CONTEXT_METADATA_KEY, Target, 'propertyKey');
+            expect(res1).to.be.instanceof(Map);
+            expect(res1.get(0)).to.be.eq(md1);
+            RequestContextReflector.setMetadata(md2, Target, 0, 'propertyKey');
+            const res2 = Reflector.getOwnMetadata(REQUEST_CONTEXT_METADATA_KEY, Target, 'propertyKey');
+            expect(res2).to.be.instanceof(Map);
+            expect(res2.get(0)).to.be.eq(md2);
+        });
+    });
+    describe('getMetadata', function () {
+        it('returns an existing metadata of the target', function () {
+            class Target {
+            }
+            const md1 = { property: 'req' };
+            const md2 = { property: 'res' };
+            const mdMap = new Map([
+                [0, md1],
+                [1, md2],
+            ]);
+            Reflector.defineMetadata(REQUEST_CONTEXT_METADATA_KEY, mdMap, Target, 'propertyKey');
+            const res = RequestContextReflector.getMetadata(Target, 'propertyKey');
+            expect(res).to.be.instanceof(Map);
+            expect(res.get(0)).to.be.eq(md1);
+            expect(res.get(1)).to.be.eq(md2);
+        });
+        it('returns an empty map if no metadata', function () {
+            class Target {
+            }
+            const res = RequestContextReflector.getMetadata(Target, 'propertyKey');
+            expect(res).to.be.instanceof(Map);
+            expect(res).to.be.empty;
+        });
+    });
+});

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

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

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

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

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

@@ -0,0 +1,28 @@
+import { Prototype } from '../../types.js';
+import { DataType } from '@e22m4u/ts-data-schema';
+import { DataSchema } from '@e22m4u/ts-data-schema';
+import { RequestDataMetadata } from './request-data-metadata.js';
+/**
+ * Request data decorator.
+ *
+ * @param metadata
+ */
+export declare function requestData<T extends object>(metadata: RequestDataMetadata): (target: Prototype<T>, propertyKey: string, indexOrDescriptor: number) => void;
+/**
+ * Decorator aliases.
+ */
+export declare const params: () => (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
+export declare const param: (propertyKey: string, schemaOrType?: DataSchema | DataType) => (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
+export declare const queries: () => (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
+export declare const query: (propertyKey: string, schemaOrType?: DataSchema | DataType) => (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
+export declare const headers: () => (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
+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;
+/**
+ * Request body decorator.
+ *
+ * @param schemaOrType
+ */
+export declare function body(schemaOrType?: DataSchema | DataType): (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;

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

@@ -0,0 +1,84 @@
+import { DataType } from '@e22m4u/ts-data-schema';
+import { DecoratorTargetType } from '@e22m4u/ts-reflector';
+import { getDecoratorTargetType } from '@e22m4u/ts-reflector';
+import { RequestDataSource } from './request-data-metadata.js';
+import { RequestDataReflector } from './request-data-reflector.js';
+/**
+ * Request data decorator.
+ *
+ * @param metadata
+ */
+export function requestData(metadata) {
+    return function (target, propertyKey, indexOrDescriptor) {
+        const decoratorType = getDecoratorTargetType(target, propertyKey, indexOrDescriptor);
+        if (decoratorType !== DecoratorTargetType.INSTANCE_METHOD_PARAMETER)
+            throw new Error('@requestData decorator is only supported ' +
+                'on an instance method parameter.');
+        RequestDataReflector.setMetadata(metadata, target.constructor, indexOrDescriptor, propertyKey);
+    };
+}
+/**
+ * Create data decorator.
+ *
+ * @param source
+ */
+function createDataDecorator(source) {
+    return function () {
+        const schema = { type: DataType.OBJECT };
+        return requestData({ schema, source });
+    };
+}
+/**
+ * Create property decorator.
+ *
+ * @param source
+ */
+function createPropertyDecorator(source) {
+    return function (propertyKey, schemaOrType) {
+        const properties = {};
+        const rootSchema = { type: DataType.OBJECT };
+        if (typeof schemaOrType === 'object') {
+            properties[propertyKey] = schemaOrType;
+            rootSchema.properties = properties;
+        }
+        else if (typeof schemaOrType === 'string') {
+            properties[propertyKey] = { type: schemaOrType };
+            rootSchema.properties = properties;
+        }
+        return requestData({
+            source: source,
+            schema: rootSchema,
+            property: propertyKey,
+        });
+    };
+}
+/**
+ * Decorator aliases.
+ */
+export const params = createDataDecorator(RequestDataSource.PARAMS);
+export const param = createPropertyDecorator(RequestDataSource.PARAMS);
+export const queries = createDataDecorator(RequestDataSource.QUERY);
+export const query = createPropertyDecorator(RequestDataSource.QUERY);
+export const headers = createDataDecorator(RequestDataSource.HEADERS);
+export const header = createPropertyDecorator(RequestDataSource.HEADERS);
+export const cookies = createDataDecorator(RequestDataSource.COOKIE);
+export const cookie = createPropertyDecorator(RequestDataSource.COOKIE);
+export const bodyParam = createPropertyDecorator(RequestDataSource.BODY);
+/**
+ * Request body decorator.
+ *
+ * @param schemaOrType
+ */
+export function body(schemaOrType) {
+    let schema;
+    if (typeof schemaOrType === 'object') {
+        schema = schemaOrType;
+    }
+    else if (typeof schemaOrType === 'string') {
+        schema = { type: schemaOrType };
+    }
+    else {
+        schema = { type: DataType.ANY };
+    }
+    return requestData({ schema, source: RequestDataSource.BODY });
+}

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

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