@e22m4u/ts-rest-router 0.0.2

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

@@ -0,0 +1,60 @@
+import { expect } from 'chai';
+import { describe } from 'mocha';
+import { Reflector } from '@e22m4u/ts-reflector';
+import { RequestDataSource } from './request-data-metadata.js';
+import { RequestDataReflector } from './request-data-reflector.js';
+import { REQUEST_DATA_METADATA_KEY } from './request-data-metadata.js';
+describe('RequestDataReflector', function () {
+    describe('setMetadata', function () {
+        it('sets a given value as target metadata', function () {
+            class Target {
+            }
+            const md1 = { source: RequestDataSource.PARAMS };
+            const md2 = { source: RequestDataSource.QUERY };
+            RequestDataReflector.setMetadata(md1, Target, 0, 'propertyKey');
+            RequestDataReflector.setMetadata(md2, Target, 1, 'propertyKey');
+            const res = Reflector.getOwnMetadata(REQUEST_DATA_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 = { source: RequestDataSource.PARAMS };
+            const md2 = { source: RequestDataSource.QUERY };
+            RequestDataReflector.setMetadata(md1, Target, 0, 'propertyKey');
+            const res1 = Reflector.getOwnMetadata(REQUEST_DATA_METADATA_KEY, Target, 'propertyKey');
+            expect(res1).to.be.instanceof(Map);
+            expect(res1.get(0)).to.be.eq(md1);
+            RequestDataReflector.setMetadata(md2, Target, 0, 'propertyKey');
+            const res2 = Reflector.getOwnMetadata(REQUEST_DATA_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 = { source: RequestDataSource.PARAMS };
+            const md2 = { source: RequestDataSource.QUERY };
+            const mdMap = new Map([
+                [0, md1],
+                [1, md2],
+            ]);
+            Reflector.defineMetadata(REQUEST_DATA_METADATA_KEY, mdMap, Target, 'propertyKey');
+            const res = RequestDataReflector.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 = RequestDataReflector.getMetadata(Target, 'propertyKey');
+            expect(res).to.be.instanceof(Map);
+            expect(res).to.be.empty;
+        });
+    });
+});

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

@@ -0,0 +1 @@
+export * from './not-a-controller-error.js';

package/dist/esm/errors/index.js

@@ -0,0 +1 @@
+export * from './not-a-controller-error.js';

package/dist/esm/errors/not-a-controller-error.d.ts

@@ -0,0 +1,12 @@
+import { Errorf } from '@e22m4u/js-format';
+/**
+ * Not a controller error.
+ */
+export declare class NotAControllerError extends Errorf {
+    /**
+     * Constructor.
+     *
+     * @param value
+     */
+    constructor(value: unknown);
+}

package/dist/esm/errors/not-a-controller-error.js

@@ -0,0 +1,14 @@
+import { Errorf } from '@e22m4u/js-format';
+/**
+ * Not a controller error.
+ */
+export class NotAControllerError extends Errorf {
+    /**
+     * Constructor.
+     *
+     * @param value
+     */
+    constructor(value) {
+        super('%v is not a controller, do use @controller decorator on it.', value);
+    }
+}

package/dist/esm/index.d.ts

@@ -0,0 +1,5 @@
+export * from './utils/index.js';
+export * from './rest-router.js';
+export * from './errors/index.js';
+export * from './decorators/index.js';
+export * from './controller-registry.js';

package/dist/esm/index.js

@@ -0,0 +1,5 @@
+export * from './utils/index.js';
+export * from './rest-router.js';
+export * from './errors/index.js';
+export * from './decorators/index.js';
+export * from './controller-registry.js';

package/dist/esm/rest-router.d.ts

@@ -0,0 +1,19 @@
+import { Constructor } from './types.js';
+import { DebuggableService } from './debuggable-service.js';
+import { ControllerRootOptions } from './controller-registry.js';
+/**
+ * Rest router.
+ */
+export declare class RestRouter extends DebuggableService {
+    /**
+     * Request listener.
+     */
+    get requestListener(): import("http").RequestListener;
+    /**
+     * Add controller.
+     *
+     * @param ctor
+     * @param options
+     */
+    addController<T extends object>(ctor: Constructor<T>, options?: ControllerRootOptions): this;
+}

package/dist/esm/rest-router.js

@@ -0,0 +1,24 @@
+import { TrieRouter } from '@e22m4u/js-trie-router';
+import { DebuggableService } from './debuggable-service.js';
+import { ControllerRegistry } from './controller-registry.js';
+/**
+ * Rest router.
+ */
+export class RestRouter extends DebuggableService {
+    /**
+     * Request listener.
+     */
+    get requestListener() {
+        return this.getService(TrieRouter).requestListener;
+    }
+    /**
+     * Add controller.
+     *
+     * @param ctor
+     * @param options
+     */
+    addController(ctor, options) {
+        this.getService(ControllerRegistry).addController(ctor, options);
+        return this;
+    }
+}

package/dist/esm/types.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Function type that excludes
+ * class and constructor types.
+ */
+export type Callable<T = unknown> = (...args: any[]) => T;
+/**
+ * Callable type with the "new" operator
+ * that allows class and constructor types.
+ */
+export interface Constructor<T = unknown> {
+    new (...args: any[]): T;
+}
+/**
+ * Object prototype that excludes
+ * function and scalar values.
+ */
+export type Prototype<T = unknown> = T & object & {
+    bind?: never;
+} & {
+    call?: never;
+} & {
+    prototype?: object;
+};
+/**
+ * Make a specific property as optional.
+ */
+export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+/**
+ * A part of the Flatten type.
+ */
+export type Identity<T> = T;
+/**
+ * Makes T more human-readable.
+ */
+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.
+ */
+export type NoUndef<T> = Exclude<T, null | undefined>;
+/**
+ * Object type with open properties.
+ */
+export type AnyObject = {
+    [property: PropertyKey]: any;
+};

package/dist/esm/types.js

@@ -0,0 +1,2 @@
+/* eslint @typescript-eslint/no-explicit-any: 0 */
+export {};

package/dist/esm/utils/capitalize.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Capitalize.
+ *
+ * @param input
+ */
+export declare function capitalize(input: string): string;

package/dist/esm/utils/capitalize.js

@@ -0,0 +1,8 @@
+/**
+ * Capitalize.
+ *
+ * @param input
+ */
+export function capitalize(input) {
+    return input.charAt(0).toUpperCase() + input.slice(1);
+}

package/dist/esm/utils/capitalize.spec.d.ts

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

package/dist/esm/utils/capitalize.spec.js

@@ -0,0 +1,8 @@
+import { expect } from 'chai';
+import { capitalize } from './capitalize.js';
+describe('capitalize', function () {
+    it('makes the first letter to upper case', function () {
+        expect(capitalize('foo')).to.be.eq('Foo');
+        expect(capitalize('foo bar')).to.be.eq('Foo bar');
+    });
+});

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

@@ -0,0 +1,11 @@
+import { format } from '@e22m4u/js-format';
+/**
+ * Debugger.
+ */
+export type Debugger = (...args: Parameters<typeof format>) => void;
+/**
+ * Create debugger.
+ *
+ * @param name
+ */
+export declare function createDebugger(name: string): Debugger;

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

@@ -0,0 +1,15 @@
+import DebugFactory from 'debug';
+import { format } from '@e22m4u/js-format';
+/**
+ * Create debugger.
+ *
+ * @param name
+ */
+export function createDebugger(name) {
+    const debug = DebugFactory(`tsRestRouter:${name}`);
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    return function (message, ...args) {
+        const interpolatedMessage = format(message, ...args);
+        return debug(interpolatedMessage);
+    };
+}

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

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

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

@@ -0,0 +1,8 @@
+import { expect } from 'chai';
+import { createDebugger } from './create-debugger.js';
+describe('createDebugger', function () {
+    it('returns a function', function () {
+        const res = createDebugger('name');
+        expect(typeof res).to.be.eq('function');
+    });
+});

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

@@ -0,0 +1,10 @@
+import { Constructor } from '../types.js';
+/**
+ * Create error.
+ *
+ * @param {Function} errorCtor
+ * @param {string} message
+ * @param {*[]|undefined} args
+ * @returns {object}
+ */
+export declare function createError<T>(errorCtor: Constructor<T>, message: string, ...args: unknown[]): T;

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

@@ -0,0 +1,13 @@
+import { format } from '@e22m4u/js-format';
+/**
+ * Create error.
+ *
+ * @param {Function} errorCtor
+ * @param {string} message
+ * @param {*[]|undefined} args
+ * @returns {object}
+ */
+export function createError(errorCtor, message, ...args) {
+    const interpolatedMessage = format(message, ...args);
+    return new errorCtor(interpolatedMessage);
+}

package/dist/esm/utils/create-error.spec.d.ts

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

package/dist/esm/utils/create-error.spec.js

@@ -0,0 +1,8 @@
+import { expect } from 'chai';
+import { createError } from './create-error.js';
+describe('createError', function () {
+    it('interpolates the given message with arguments', function () {
+        const res = createError(Error, 'My %s', 'message');
+        expect(res.message).to.be.eq('My message');
+    });
+});

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

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

package/dist/esm/utils/index.js

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

package/dist/esm/utils/to-camel-case.d.ts

@@ -0,0 +1,6 @@
+/**
+ * To camel case.
+ *
+ * @param input
+ */
+export declare function toCamelCase(input: string): string;

package/dist/esm/utils/to-camel-case.js

@@ -0,0 +1,11 @@
+/**
+ * To camel case.
+ *
+ * @param input
+ */
+export function toCamelCase(input) {
+    return input
+        .replace(/(^\w|[A-Z]|\b\w)/g, c => c.toUpperCase())
+        .replace(/\W+/g, '')
+        .replace(/(^\w)/g, c => c.toLowerCase());
+}

package/dist/esm/utils/to-camel-case.spec.d.ts

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

package/dist/esm/utils/to-camel-case.spec.js

@@ -0,0 +1,10 @@
+import { expect } from 'chai';
+import { toCamelCase } from './to-camel-case.js';
+describe('toCamelCase', function () {
+    it('returns a camelCase string', function () {
+        expect(toCamelCase('TestString')).to.be.eq('testString');
+        expect(toCamelCase('test-string')).to.be.eq('testString');
+        expect(toCamelCase('test string')).to.be.eq('testString');
+        expect(toCamelCase('Test string')).to.be.eq('testString');
+    });
+});

package/dist/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../src/controller-registry.spec.ts","../src/controller-registry.ts","../src/debuggable-service.spec.ts","../src/debuggable-service.ts","../src/index.ts","../src/rest-router.ts","../src/types.ts","../src/decorators/index.ts","../src/decorators/action/action-decorator.spec.ts","../src/decorators/action/action-decorator.ts","../src/decorators/action/action-metadata.ts","../src/decorators/action/action-reflector.spec.ts","../src/decorators/action/action-reflector.ts","../src/decorators/action/index.ts","../src/decorators/controller/controller-decorator.spec.ts","../src/decorators/controller/controller-decorator.ts","../src/decorators/controller/controller-metadata.ts","../src/decorators/controller/controller-reflector.spec.ts","../src/decorators/controller/controller-reflector.ts","../src/decorators/controller/index.ts","../src/decorators/request-context/index.ts","../src/decorators/request-context/request-context-decorator.spec.ts","../src/decorators/request-context/request-context-decorator.ts","../src/decorators/request-context/request-context-metadata.ts","../src/decorators/request-context/request-context-reflector.spec.ts","../src/decorators/request-context/request-context-reflector.ts","../src/decorators/request-data/index.ts","../src/decorators/request-data/request-data-decorator.spec.ts","../src/decorators/request-data/request-data-decorator.ts","../src/decorators/request-data/request-data-metadata.ts","../src/decorators/request-data/request-data-reflector.spec.ts","../src/decorators/request-data/request-data-reflector.ts","../src/errors/index.ts","../src/errors/not-a-controller-error.ts","../src/utils/capitalize.spec.ts","../src/utils/capitalize.ts","../src/utils/create-debugger.spec.ts","../src/utils/create-debugger.ts","../src/utils/create-error.spec.ts","../src/utils/create-error.ts","../src/utils/index.ts","../src/utils/to-camel-case.spec.ts","../src/utils/to-camel-case.ts"],"version":"5.6.3"}

package/eslint.config.js

@@ -0,0 +1,43 @@
+import globals from 'globals';
+import eslintJs from '@eslint/js';
+import eslintTypescript from 'typescript-eslint';
+import eslintMochaPlugin from 'eslint-plugin-mocha';
+import eslintPrettierConfig from 'eslint-config-prettier';
+import eslintChaiExpectPlugin from 'eslint-plugin-chai-expect';
+
+export default [
+  {
+    ignores: ['**/*.js'],
+  },
+  {
+    files: ['src/**/*.ts'],
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globals.es2021,
+        ...globals.mocha,
+      },
+      parser: eslintTypescript.parser,
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+    plugins: {
+      '@typescript-eslint': eslintTypescript.plugin,
+      'mocha': eslintMochaPlugin,
+      'chai-expect': eslintChaiExpectPlugin,
+    },
+    rules: {
+      ...eslintJs.configs.recommended.rules,
+      ...eslintPrettierConfig.rules,
+      ...eslintMochaPlugin.configs.flat.recommended.rules,
+      ...eslintChaiExpectPlugin.configs['recommended-flat'].rules,
+      ...eslintTypescript.configs.recommended.reduce(
+        (rules, config) => ({...rules, ...config.rules}),
+        {},
+      ),
+      '@typescript-eslint/no-unused-expressions': 'off',
+    },
+  },
+];

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@e22m4u/ts-rest-router",
+  "version": "0.0.2",
+  "description": "Controllers-based REST router implementation for TypeScript",
+  "author": "e22m4u <e22m4u@yandex.ru>",
+  "keywords": [
+    "rest",
+    "http",
+    "router",
+    "server",
+    "controller"
+  ],
+  "homepage": "https://github.com/e22m4u/ts-rest-router",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/e22m4u/ts-rest-router.git"
+  },
+  "type": "module",
+  "module": "./dist/esm/index.js",
+  "main": "./dist/cjs/index.cjs",
+  "exports": {
+    "types": "./dist/esm/index.d.ts",
+    "import": "./dist/esm/index.js",
+    "require": "./dist/cjs/index.cjs"
+  },
+  "engines": {
+    "node": ">=16"
+  },
+  "scripts": {
+    "build:esm": "tsc --build",
+    "build:cjs": "rimraf ./dist/cjs && node --no-warnings=ExperimentalWarning build-cjs.js",
+    "build": "rimraf dist && npm run build:esm && npm run build:cjs",
+    "lint": "eslint ./src",
+    "lint:fix": "eslint ./src --fix",
+    "format": "prettier --write \"./src/**/*.ts\"",
+    "test": "npm run lint && c8 --reporter=text-summary mocha --bail",
+    "test:coverage": "npm run lint && c8 --reporter=text mocha --bail",
+    "prepare": "husky"
+  },
+  "dependencies": {
+    "@e22m4u/js-format": "0.1.x",
+    "@e22m4u/js-service": "0.1.x",
+    "@e22m4u/js-trie-router": "0.0.x",
+    "@e22m4u/ts-data-schema": "0.0.x",
+    "@e22m4u/ts-reflector": "0.1.x",
+    "debug": "~4.3.7",
+    "http-errors": "~2.0.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "~19.5.0",
+    "@commitlint/config-conventional": "~19.5.0",
+    "@eslint/js": "~9.14.0",
+    "@types/chai": "~5.0.1",
+    "@types/debug": "~4.1.12",
+    "@types/http-errors": "~2.0.4",
+    "@types/mocha": "~10.0.9",
+    "@types/node": "~22.9.0",
+    "c8": "~10.1.2",
+    "chai": "~5.1.2",
+    "esbuild": "~0.24.0",
+    "eslint": "~9.14.0",
+    "eslint-config-prettier": "~9.1.0",
+    "eslint-plugin-chai-expect": "~3.1.0",
+    "eslint-plugin-mocha": "~10.5.0",
+    "husky": "~9.1.6",
+    "mocha": "~10.8.2",
+    "prettier": "~3.3.3",
+    "rimraf": "~6.0.1",
+    "tsx": "~4.19.2",
+    "typescript": "~5.6.3",
+    "typescript-eslint": "~8.13.0"
+  },
+  "license": "MIT"
+}