Initial commit

Author: typeofweb

.eslintrc

@@ -4,19 +4,5 @@
     "project": "tsconfig.eslint.json"
   },
   "plugins": ["@typeofweb/eslint-plugin"],
-  "extends": ["plugin:@typeofweb/recommended"],
-  "rules": {
-    "@typescript-eslint/consistent-type-assertions": "off",
-    "eslint-comments/require-description": "off",
-    "@typescript-eslint/no-non-null-assertion": "off",
-    "@typescript-eslint/no-non-null-asserted-optional-chain": "off"
-  },
-  "overrides": [
-    {
-      "files": ["src/validators/**.ts", "src/modifiers/**.ts", "src/errors.ts"],
-      "rules": {
-        "functional/no-this-expression": 0
-      }
-    }
-  ]
+  "extends": ["plugin:@typeofweb/recommended"]
 }

.prettierrc

@@ -2,5 +2,5 @@
   "semi": true,
   "singleQuote": true,
   "trailingComma": "all",
-  "printWidth": 100
+  "printWidth": 120
 }

README.md

@@ -1 +1,72 @@
 # @typeofweb/server
+
+```ts
+const app = await createApp({
+  host: 'localhost',
+  port: 3000,
+  cors: [],
+});
+
+app.plugin(dbPlugin);
+app.plugin(authPlugin);
+
+app._rawRouter;
+
+app.route({
+  path: '/health-check/:count',
+  method: 'GET',
+  validation: {
+    query: {},
+    params: {
+      count: number(),
+    },
+    payload: {},
+    response: {},
+  },
+  _rawMiddlewares: [],
+  async handler(request) {
+    const { query, params, payload, response } = request;
+    await request.plugins.db.findOne();
+
+    request.events.emit('health-check', params.count);
+
+    request._rawReq;
+    request._rawRes;
+  },
+});
+
+const server = await app.listen();
+```
+
+```ts
+// dbPlugin.ts
+
+declare module '@typeofweb/server' {
+  interface TypeOfWebServerMeta {
+    readonly db: PrismaClient;
+  }
+
+  interface TypeOfWebRequestMeta {
+    readonly auth: { readonly session: Session };
+  }
+
+  interface TypeOfWebServerEvents {
+    readonly 'health-check': number;
+  }
+}
+
+export const dbPlugin = createPlugin('db', async (app) => {
+  return {
+    server: new Prisma(),
+  };
+});
+
+export const authPlugin = createPlugin('auth', async (app) => {
+  return {
+    request(request) {
+      const session = await request.plugins.db.sessions.findOne({ id: request.cookies.session });
+      return { session };
+    },
+  };
+});
+```

examples/simple.ts

@@ -0,0 +1,76 @@
+import { number } from '@typeofweb/schema';
+
+import { createApp, createPlugin } from '../dist/index.js';
+
+declare function findOne(): unknown;
+declare function findMany(): unknown;
+declare module '../dist' {
+  interface TypeOfWebServerMeta {
+    readonly db: {
+      readonly findOne: typeof findOne;
+      readonly findMany: typeof findMany;
+    };
+  }
+
+  interface TypeOfWebEvents {
+    readonly 'health-check': number;
+  }
+}
+
+// plugins
+export const dbPlugin = createPlugin('db', () => {
+  return {
+    server() {
+      return { findOne, findMany };
+    },
+  };
+});
+
+const loggerPlugin = createPlugin('logger', () => {
+  return {
+    server() {
+      console.info('Server started!');
+    },
+    request() {
+      console.info(`Request coming through!`);
+    },
+    response() {
+      console.info(`The server has responded.`);
+    },
+  };
+});
+
+// app
+const app = createApp({
+  hostname: 'localhost',
+  port: 3000,
+  cors: [],
+});
+
+app.plugin(loggerPlugin);
+app.plugin(dbPlugin);
+
+app.route({
+  path: '/health-check/:count',
+  method: 'get',
+  validation: {
+    params: {
+      count: number(),
+    },
+    response: number(),
+  },
+  _rawMiddlewares: [],
+  handler(_request) {
+    // const { query, params } = request;
+    // request.server.plugins.db.findMany();
+    // request.server.events.emit('health-check', 123);
+    return 1;
+  },
+});
+
+app
+  .start()
+  .then((server) => {
+    console.log(`🙌 Server started at ${server.address.toString()}`);
+  })
+  .catch(console.error);

package.json

@@ -3,8 +3,8 @@
   "version": "0.0.0",
   "type": "module",
   "exports": {
-    "import": "./dist/index.mjs",
-    "default": "./dist/index.mjs",
+    "import": "./dist/index.js",
+    "default": "./dist/index.js",
     "require": "./dist/index.cjs"
   },
   "main": "./dist/index.cjs",
@@ -33,37 +33,41 @@
     "server",
     "api"
   ],
+  "dependencies": {
+    "@typeofweb/schema": "0.8.0-3",
+    "@types/express": "4.17.12",
+    "express": "4.17.1",
+    "stoppable": "1.1.0"
+  },
   "devDependencies": {
     "@rollup/plugin-commonjs": "19.0.0",
-    "@rollup/plugin-node-resolve": "13.0.0",
+    "@rollup/plugin-json": "4.1.0",
     "@rollup/plugin-typescript": "8.2.1",
     "@tsconfig/node12": "1.0.7",
     "@tsconfig/node14": "1.0.0",
     "@typeofweb/eslint-plugin": "0.1.10",
     "@types/jest": "26.0.23",
     "@types/node": "12",
-    "@types/qs": "6.9.6",
-    "@types/ramda": "0.27.40",
+    "@types/stoppable": "1.1.1",
     "all-contributors-cli": "6.20.0",
     "eslint": "7.28.0",
     "fast-check": "2.16.0",
     "husky": "6.0.0",
     "jest": "27.0.4",
     "lint-staged": "11.0.0",
+    "nodemon": "2.0.7",
     "prettier": "2.3.1",
-    "qs": "6.10.1",
-    "ramda": "0.27.1",
     "rimraf": "3.0.2",
     "rollup": "2.51.1",
     "rollup-plugin-filesize": "9.1.1",
     "rollup-plugin-license": "2.5.0",
     "rollup-plugin-prettier": "2.1.0",
     "rollup-plugin-terser": "7.0.2",
     "ts-jest": "27.0.3",
+    "ts-node": "10.0.0",
     "tsd": "https://github.com/typeofweb/tsd#pkg",
     "tslib": "2.2.0",
-    "typescript": "4.3.2",
-    "weak-napi": "2.0.2"
+    "typescript": "4.3.2"
   },
   "scripts": {
     "prejest": "yarn build",
@@ -73,7 +77,8 @@
     "build": "rimraf dist && rollup --config",
     "build:watch": "rollup --config --watch",
     "prepublishOnly": "yarn build",
-    "prepare": "husky install"
+    "prepare": "husky install",
+    "ts-node": "nodemon -w dist -e js -x 'node --loader ts-node/esm'"
   },
   "lint-staged": {
     "**/*.ts": [

rollup.config.js

@@ -1,15 +1,16 @@
 // @ts-check
 import commonjs from '@rollup/plugin-commonjs';
-import resolve from '@rollup/plugin-node-resolve';
 import typescript from '@rollup/plugin-typescript';
 import prettier from 'rollup-plugin-prettier';
 import { terser } from 'rollup-plugin-terser';
 import filesize from 'rollup-plugin-filesize';
 import license from 'rollup-plugin-license';
+import json from '@rollup/plugin-json';
 
 import pkg from './package.json';
 
 const shouldCompress = process.env.COMPRESS_BUNDLES ? true : false;
+const shouldPrettify = !shouldCompress && (process.env.PRETTIFY ? true : false);
 
 const rollupConfig = [
   {
@@ -22,15 +23,22 @@ const rollupConfig = [
         entryFileNames: pkg.exports.import.replace(/^\.\//, ''),
         sourcemap: true,
         plugins: [
-          shouldCompress
-            ? terser({
-                compress: true,
-                mangle: true,
-                ecma: 2019,
-              })
-            : prettier({
-                parser: 'typescript',
-              }),
+          ...(shouldCompress
+            ? [
+                terser({
+                  compress: true,
+                  mangle: true,
+                  ecma: 2020,
+                }),
+              ]
+            : []),
+          ...(shouldPrettify
+            ? [
+                prettier({
+                  parser: 'typescript',
+                }),
+              ]
+            : []),
         ],
       },
       {
@@ -40,20 +48,27 @@ const rollupConfig = [
         entryFileNames: pkg.exports.require.replace(/^\.\//, ''),
         sourcemap: true,
         plugins: [
-          shouldCompress
-            ? terser({
-                compress: true,
-                mangle: true,
-                ecma: 2019,
-              })
-            : prettier({
-                parser: 'typescript',
-              }),
+          ...(shouldCompress
+            ? [
+                terser({
+                  compress: true,
+                  mangle: true,
+                  ecma: 2020,
+                }),
+              ]
+            : []),
+          ...(shouldPrettify
+            ? [
+                prettier({
+                  parser: 'typescript',
+                }),
+              ]
+            : []),
         ],
       },
     ],
     plugins: [
-      resolve(),
+      json(),
       commonjs({
         include: 'node_modules/**',
       }),

src/index.ts

@@ -1 +1,8 @@
-export {};
+export { createApp } from './modules/app';
+export { HttpStatusCode } from './modules/httpStatusCodes';
+export { createPlugin } from './modules/plugins';
+
+export type { HttpMethod } from './modules/httpStatusCodes';
+export type { TypeOfWebApp, AppOptions, TypeOfWebServer } from './modules/shared';
+
+export type { TypeOfWebServerMeta, TypeOfWebRequestMeta, TypeOfWebEvents } from './modules/augment';