add service code + eslint + nats adaptor with his firsts tests

.eslintignore

@@ -0,0 +1,4 @@
+dist/
+jest.config.js
+tests/
+.eslintrc.cjs

.eslintrc.cjs

@@ -0,0 +1,11 @@
+/* eslint-env node */
+module.exports = {
+    extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'],
+    parser: '@typescript-eslint/parser',
+    plugins: ['@typescript-eslint'],
+    root: true,
+    parserOptions: {
+        project: true,
+        tsconfigRootDir: __dirname,
+    },
+};

.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+dist/

jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};

package.json

@@ -0,0 +1,33 @@
+{
+  "name": "nano-service",
+  "version": "0.0.1",
+  "description": "typescript library for making micro service",
+  "main": "dist/lib.js",
+  "types": "dist/lib.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "scripts": {
+    "lint": "eslint .",
+    "test": "jest",
+    "build": "tsc -p tsconfig.build.json"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitea.qpismont.fr/qpismont/nano-service"
+  },
+  "author": "qpismont",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/jest": "^29.5.6",
+    "@typescript-eslint/eslint-plugin": "^6.8.0",
+    "@typescript-eslint/parser": "^6.8.0",
+    "eslint": "^8.51.0",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.2.2"
+  },
+  "dependencies": {
+    "nats": "^2.17.0"
+  }
+}

src/adaptors/adaptor.ts

@@ -0,0 +1,8 @@
+import { AdaptorSubscribeTypeFn } from "../types";
+
+export default interface Adaptor {
+    subscribe(subject: string, fn: AdaptorSubscribeTypeFn): void;
+    request(subject: string, req: string): Promise<string>;
+    listen(serviceName: string): Promise<void>;
+    stop(): Promise<void>;
+}

src/adaptors/nats.ts

@@ -0,0 +1,51 @@
+import { AdaptorSubscribeTypeFn } from "../types";
+import Adaptor from "./adaptor";
+import { NatsConnection, connect, ConnectionOptions, StringCodec, Codec, Subscription } from "nats";
+
+export default class NatsAdaptor implements Adaptor {
+
+    private options: ConnectionOptions;
+
+    private nc?: NatsConnection;
+
+    private callbacks: Record<string, AdaptorSubscribeTypeFn>;
+
+    private sc: Codec<string>;
+
+    private sub?: Subscription;
+
+    constructor(options: ConnectionOptions) {
+        this.options = options;
+        this.sc = StringCodec();
+        this.callbacks = {};
+    }
+
+    async listen(serviceName: string) {
+        this.nc = await connect(this.options);
+
+        this.sub = this.nc.subscribe(`${serviceName}.*`);
+        (async (sub: Subscription) => {
+            for await (const msg of sub) {
+                const res = await this.callbacks[msg.subject](this.sc.decode(msg.data));
+                msg.respond(this.sc.encode(res));
+            }
+        })(this.sub);
+    }
+
+    subscribe(subject: string, fn: AdaptorSubscribeTypeFn) {
+        this.callbacks[subject] = fn;
+    }
+
+    async request(subject: string, req: string): Promise<string> {
+        if(this.nc) {
+            const msg = await this.nc.request(subject, this.sc.encode(req));
+            return this.sc.decode(msg.data);
+        } else {
+            throw new Error("nats connection is not initialized");
+        }   
+    }
+
+    async stop(): Promise<void> {
+        this.nc?.drain();
+    }
+}

src/lib.ts

@@ -0,0 +1,2 @@
+export * from "./service";
+export * from "./adaptors/nats";

src/messages.ts

@@ -0,0 +1,15 @@
+export interface Request<T> {
+    service: string;
+    subject: string;
+    data: T
+}
+
+export interface Message<T> {
+    from: string;
+    data: T;
+}
+
+export interface Response<T> {
+    data?: T,
+    statusCode: number
+}

src/service.ts

@@ -0,0 +1,56 @@
+import Adaptor from "./adaptors/adaptor";
+import { Request, Response } from "./messages";
+import { RouteSubscribeTypeFn } from "./types";
+
+export default class Service {
+
+    private name: string;
+
+    private adaptors: Record<string, Adaptor>;
+
+    constructor(name: string) {
+        this.name = name;
+        this.adaptors = {};
+    }
+
+    public addAdaptor(name: string, adaptor: Adaptor) {
+        this.adaptors[name] = adaptor;
+    }
+
+    public async subscribe<T, U>(adaptor: string, subject: string, fn: RouteSubscribeTypeFn<T, U>) {
+        this.adaptors[adaptor].subscribe(`${this.name}.${subject}`, async (rawReq) => {
+            const msg: Request<T> = JSON.parse(rawReq);
+            const res = await fn({ data: msg.data, from: this.name });
+
+            return JSON.stringify(res);
+        });
+    }
+
+    public async request<T, U>(adaptor: string, req: Request<T>): Promise<Response<U>> {
+        if(!this.adaptors[adaptor]) {
+            throw new Error(`${adaptor} adaptor not exist`);
+        }
+        
+        const rawReq = JSON.stringify(req);
+
+        try {
+            const rawRes = await this.adaptors[adaptor].request(`${req.service}.${req.subject}`, rawReq);
+
+            return JSON.parse(rawRes);
+        } catch(err) {
+            return { statusCode: 500 }
+        }    
+    }
+
+    public async listen() {
+        for(const index in this.adaptors) {
+            await this.adaptors[index].listen(this.name);
+        }
+    }
+
+    public async stop() {
+        for(const index in this.adaptors) {
+            await this.adaptors[index].stop();
+        } 
+    }
+}

src/types.ts

@@ -0,0 +1,4 @@
+import { Message, Response } from "./messages";
+
+export type AdaptorSubscribeTypeFn = (msg: string) => Promise<string>;
+export type RouteSubscribeTypeFn<T, U> = (msg: Message<T>) => Promise<Response<U>>;

tests/lib.test.ts

@@ -0,0 +1,35 @@
+import NatsAdaptor from "../src/adaptors/nats";
+import { Message } from "../src/messages";
+import Service from "../src/service";
+
+let srv!: Service;
+
+const serviceName = "test-service";
+const adaptorName = "nats";
+const subject = "test";
+
+const dataExpected = "hello world";
+const statusCodeExpected = 200;
+
+beforeEach(() => {
+    srv = new Service(serviceName);
+});
+
+afterEach(async () => {
+    await srv.stop();
+});
+
+test('nats adaptor', async () => {
+    srv.addAdaptor(adaptorName, new NatsAdaptor({ servers: ['127.0.0.1:4222'] }));
+    srv.subscribe(adaptorName, subject, async (msg: Message<string>) => {
+        return {data: msg.data, statusCode: statusCodeExpected};
+    });
+
+    await srv.listen();
+    
+    const res = await srv.request(adaptorName, {service: serviceName, subject: subject, data: dataExpected});
+
+    expect(res.data).toBe(dataExpected);
+    expect(res.statusCode).toBe(statusCodeExpected);
+});
+

tsconfig.build.json

@@ -0,0 +1,6 @@
+{
+    "extends": "./tsconfig.json",
+    "exclude": [
+      "tests/**/*"
+    ]
+  }

tsconfig.json

@@ -0,0 +1,110 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "ESNext",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "NodeNext",                                /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    //"moduleResolution": "NodeNext",                    /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./dist",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    "allowSyntheticDefaultImports": false,               /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  },
+  "include": ["./src/**/*", "./tests/**/*"]
+}