@forklaunch/hyper-express 0.1.33 → 0.2.1

package/lib/index.d.mts

@@ -0,0 +1,95 @@
+import { AnySchemaValidator } from '@forklaunch/validator';
+import { ForklaunchExpressLikeApplication, ForklaunchExpressLikeRouter, ForklaunchRouter, TypedMiddlewareDefinition, ParamsDictionary, ForklaunchRequest, ForklaunchResponse, ForklaunchStatusResponse, ForklaunchSendableData } from '@forklaunch/core/http';
+import { Server, MiddlewareHandler, Router as Router$1, Request as Request$1, Response as Response$1 } from '@forklaunch/hyper-express-fork';
+import * as uWebsockets from 'uWebSockets.js';
+import { ParsedQs } from 'qs';
+
+/**
+ * Represents an application built on top of Hyper-Express and Forklaunch.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ */
+declare class Application<SV extends AnySchemaValidator> extends ForklaunchExpressLikeApplication<SV, Server, MiddlewareHandler> {
+    /**
+     * Creates an instance of the Application class.
+     *
+     * @param {SV} schemaValidator - The schema validator.
+     */
+    constructor(schemaValidator: SV);
+    /**
+     * Starts the server and sets up Swagger documentation.
+     *
+     * @param {string | number} arg0 - The port number or UNIX path to listen on.
+     * @param {...unknown[]} args - Additional arguments.
+     * @returns {Promise<uWebsockets.us_listen_socket>} - A promise that resolves with the listening socket.
+     */
+    listen(port: number, callback?: (listen_socket: uWebsockets.us_listen_socket) => void): Promise<uWebsockets.us_listen_socket>;
+    listen(port: number, host?: string, callback?: (listen_socket: uWebsockets.us_listen_socket) => void): Promise<uWebsockets.us_listen_socket>;
+    listen(unix_path: string, callback?: (listen_socket: uWebsockets.us_listen_socket) => void): Promise<uWebsockets.us_listen_socket>;
+}
+
+declare class Router<SV extends AnySchemaValidator, BasePath extends `/${string}`> extends ForklaunchExpressLikeRouter<SV, BasePath, MiddlewareHandler, Router$1> implements ForklaunchRouter<SV> {
+    basePath: BasePath;
+    constructor(basePath: BasePath, schemaValidator: SV);
+    route(path: string): this;
+    any: TypedMiddlewareDefinition<this, SV>;
+}
+
+/**
+ * Extends the Forklaunch request interface with properties from Hyper-Express's request interface.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @template P - A type for request parameters, defaulting to ParamsDictionary.
+ * @template _ResBody - A type for the response body, defaulting to unknown.
+ * @template ReqBody - A type for the request body, defaulting to unknown.
+ * @template ReqQuery - A type for the request query, defaulting to ParsedQs.
+ * @template LocalsObj - A type for local variables, defaulting to an empty object.
+ */
+interface Request<SV extends AnySchemaValidator, P extends ParamsDictionary, ReqBody extends Record<string, unknown>, ReqQuery extends ParsedQs, ReqHeaders extends Record<string, string>, LocalsObj extends Record<string, unknown>> extends ForklaunchRequest<SV, P, ReqBody, ReqQuery, ReqHeaders>, Omit<Request$1<LocalsObj>, 'method' | 'params' | 'query' | 'headers'> {
+    /** The request body */
+    body: ReqBody;
+    /** The request query parameters */
+    query: ReqQuery;
+    /** The request parameters */
+    params: P;
+}
+/**
+ * Extends the Forklaunch response interface with properties from Hyper-Express's response interface.
+ *
+ * @template ResBody - A type for the response body, defaulting to unknown.
+ * @template LocalsObj - A type for local variables, defaulting to an empty object.
+ * @template StatusCode - A type for the status code, defaulting to number.
+ */
+interface Response<ResBodyMap extends Record<number, unknown>, ResHeaders extends Record<string, string>, LocalsObj extends Record<string, unknown>> extends ForklaunchResponse<ResBodyMap, ResHeaders, LocalsObj>, Omit<Response$1<LocalsObj>, 'getHeaders' | 'setHeader' | 'headersSent' | 'send' | 'status' | 'statusCode' | 'json' | 'jsonp' | 'end'>, ForklaunchStatusResponse<ForklaunchSendableData> {
+    /** The body data of the response */
+    bodyData: unknown;
+    /** If cors are applied to the response */
+    cors: boolean;
+    /** The status code of the response */
+    _status_code: number;
+    /** Whether the response is corked */
+    _cork: boolean;
+    /** Whether the response is currently corked */
+    _corked: boolean;
+}
+
+type App<SV extends AnySchemaValidator> = Application<SV>;
+/**
+ * Creates a new instance of Application with the given schema validator.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @param {SV} schemaValidator - The schema validator.
+ * @returns {Application<SV>} - The new application instance.
+ */
+declare function forklaunchExpress<SV extends AnySchemaValidator>(schemaValidator: SV): Application<SV>;
+/**
+ * Creates a new instance of Router with the given base path and schema validator.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @param {string} basePath - The base path for the router.
+ * @param {SV} schemaValidator - The schema validator.
+ * @returns {Router<SV>} - The new router instance.
+ */
+declare function forklaunchRouter<SV extends AnySchemaValidator, BasePath extends `/${string}`>(basePath: BasePath, schemaValidator: SV): Router<SV, BasePath>;
+
+export { type App, Application, type Request, type Response, Router, forklaunchExpress, forklaunchRouter };

package/lib/index.d.ts

@@ -1,7 +1,79 @@
 import { AnySchemaValidator } from '@forklaunch/validator';
-import { Application } from './src/hyperExpressApplication';
-import { Router } from './src/hyperExpressRouter';
-export type App<SV extends AnySchemaValidator> = Application<SV>;
+import { ForklaunchExpressLikeApplication, ForklaunchExpressLikeRouter, ForklaunchRouter, TypedMiddlewareDefinition, ParamsDictionary, ForklaunchRequest, ForklaunchResponse, ForklaunchStatusResponse, ForklaunchSendableData } from '@forklaunch/core/http';
+import { Server, MiddlewareHandler, Router as Router$1, Request as Request$1, Response as Response$1 } from '@forklaunch/hyper-express-fork';
+import * as uWebsockets from 'uWebSockets.js';
+import { ParsedQs } from 'qs';
+
+/**
+ * Represents an application built on top of Hyper-Express and Forklaunch.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ */
+declare class Application<SV extends AnySchemaValidator> extends ForklaunchExpressLikeApplication<SV, Server, MiddlewareHandler> {
+    /**
+     * Creates an instance of the Application class.
+     *
+     * @param {SV} schemaValidator - The schema validator.
+     */
+    constructor(schemaValidator: SV);
+    /**
+     * Starts the server and sets up Swagger documentation.
+     *
+     * @param {string | number} arg0 - The port number or UNIX path to listen on.
+     * @param {...unknown[]} args - Additional arguments.
+     * @returns {Promise<uWebsockets.us_listen_socket>} - A promise that resolves with the listening socket.
+     */
+    listen(port: number, callback?: (listen_socket: uWebsockets.us_listen_socket) => void): Promise<uWebsockets.us_listen_socket>;
+    listen(port: number, host?: string, callback?: (listen_socket: uWebsockets.us_listen_socket) => void): Promise<uWebsockets.us_listen_socket>;
+    listen(unix_path: string, callback?: (listen_socket: uWebsockets.us_listen_socket) => void): Promise<uWebsockets.us_listen_socket>;
+}
+
+declare class Router<SV extends AnySchemaValidator, BasePath extends `/${string}`> extends ForklaunchExpressLikeRouter<SV, BasePath, MiddlewareHandler, Router$1> implements ForklaunchRouter<SV> {
+    basePath: BasePath;
+    constructor(basePath: BasePath, schemaValidator: SV);
+    route(path: string): this;
+    any: TypedMiddlewareDefinition<this, SV>;
+}
+
+/**
+ * Extends the Forklaunch request interface with properties from Hyper-Express's request interface.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @template P - A type for request parameters, defaulting to ParamsDictionary.
+ * @template _ResBody - A type for the response body, defaulting to unknown.
+ * @template ReqBody - A type for the request body, defaulting to unknown.
+ * @template ReqQuery - A type for the request query, defaulting to ParsedQs.
+ * @template LocalsObj - A type for local variables, defaulting to an empty object.
+ */
+interface Request<SV extends AnySchemaValidator, P extends ParamsDictionary, ReqBody extends Record<string, unknown>, ReqQuery extends ParsedQs, ReqHeaders extends Record<string, string>, LocalsObj extends Record<string, unknown>> extends ForklaunchRequest<SV, P, ReqBody, ReqQuery, ReqHeaders>, Omit<Request$1<LocalsObj>, 'method' | 'params' | 'query' | 'headers'> {
+    /** The request body */
+    body: ReqBody;
+    /** The request query parameters */
+    query: ReqQuery;
+    /** The request parameters */
+    params: P;
+}
+/**
+ * Extends the Forklaunch response interface with properties from Hyper-Express's response interface.
+ *
+ * @template ResBody - A type for the response body, defaulting to unknown.
+ * @template LocalsObj - A type for local variables, defaulting to an empty object.
+ * @template StatusCode - A type for the status code, defaulting to number.
+ */
+interface Response<ResBodyMap extends Record<number, unknown>, ResHeaders extends Record<string, string>, LocalsObj extends Record<string, unknown>> extends ForklaunchResponse<ResBodyMap, ResHeaders, LocalsObj>, Omit<Response$1<LocalsObj>, 'getHeaders' | 'setHeader' | 'headersSent' | 'send' | 'status' | 'statusCode' | 'json' | 'jsonp' | 'end'>, ForklaunchStatusResponse<ForklaunchSendableData> {
+    /** The body data of the response */
+    bodyData: unknown;
+    /** If cors are applied to the response */
+    cors: boolean;
+    /** The status code of the response */
+    _status_code: number;
+    /** Whether the response is corked */
+    _cork: boolean;
+    /** Whether the response is currently corked */
+    _corked: boolean;
+}
+
+type App<SV extends AnySchemaValidator> = Application<SV>;
 /**
  * Creates a new instance of Application with the given schema validator.
  *
@@ -9,7 +81,7 @@ export type App<SV extends AnySchemaValidator> = Application<SV>;
  * @param {SV} schemaValidator - The schema validator.
  * @returns {Application<SV>} - The new application instance.
  */
-export declare function forklaunchExpress<SV extends AnySchemaValidator>(schemaValidator: SV): Application<SV>;
+declare function forklaunchExpress<SV extends AnySchemaValidator>(schemaValidator: SV): Application<SV>;
 /**
  * Creates a new instance of Router with the given base path and schema validator.
  *
@@ -18,8 +90,6 @@ export declare function forklaunchExpress<SV extends AnySchemaValidator>(schemaV
  * @param {SV} schemaValidator - The schema validator.
  * @returns {Router<SV>} - The new router instance.
  */
-export declare function forklaunchRouter<SV extends AnySchemaValidator, BasePath extends `/${string}`>(basePath: BasePath, schemaValidator: SV): Router<SV, BasePath>;
-export type { Application } from './src/hyperExpressApplication';
-export type { Router } from './src/hyperExpressRouter';
-export * from './src/types/hyperExpress.types';
-//# sourceMappingURL=index.d.ts.map
+declare function forklaunchRouter<SV extends AnySchemaValidator, BasePath extends `/${string}`>(basePath: BasePath, schemaValidator: SV): Router<SV, BasePath>;
+
+export { type App, Application, type Request, type Response, Router, forklaunchExpress, forklaunchRouter };

package/lib/index.js

@@ -1,25 +1,259 @@
-import { Application } from './src/hyperExpressApplication';
-import { Router } from './src/hyperExpressRouter';
-/**
- * Creates a new instance of Application with the given schema validator.
- *
- * @template SV - A type that extends AnySchemaValidator.
- * @param {SV} schemaValidator - The schema validator.
- * @returns {Application<SV>} - The new application instance.
- */
-export function forklaunchExpress(schemaValidator) {
-    return new Application(schemaValidator);
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// index.ts
+var index_exports = {};
+__export(index_exports, {
+  forklaunchExpress: () => forklaunchExpress,
+  forklaunchRouter: () => forklaunchRouter
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/hyperExpressApplication.ts
+var import_http = require("@forklaunch/core/http");
+var import_hyper_express_fork = require("@forklaunch/hyper-express-fork");
+
+// src/middleware/swagger.middleware.ts
+var import_live_directory = __toESM(require("live-directory"));
+var import_absolute_path = __toESM(require("swagger-ui-dist/absolute-path"));
+var import_swagger_ui_express = __toESM(require("swagger-ui-express"));
+function swaggerRedirect(path) {
+  return (req, res, next) => {
+    if (req.path === path) {
+      res.redirect(`${path}/`);
+    }
+    return next?.();
+  };
 }
-/**
- * Creates a new instance of Router with the given base path and schema validator.
- *
- * @template SV - A type that extends AnySchemaValidator.
- * @param {string} basePath - The base path for the router.
- * @param {SV} schemaValidator - The schema validator.
- * @returns {Router<SV>} - The new router instance.
- */
-export function forklaunchRouter(basePath, schemaValidator) {
-    const router = new Router(basePath, schemaValidator);
-    return router;
+function swagger(path, document, opts, options, customCss, customfavIcon, swaggerUrl, customSiteTitle) {
+  const LiveAssets = new import_live_directory.default((0, import_absolute_path.default)(), {
+    filter: {
+      keep: {
+        names: [
+          "swagger-ui-bundle.js",
+          "swagger-ui-standalone-preset.js",
+          "swagger-ui-init.js",
+          "swagger-ui.css",
+          "favicon-32x32.png",
+          "favicon-16x16.png"
+        ]
+      }
+    },
+    cache: {
+      max_file_count: 10,
+      max_file_size: 1024 * 1024 * 1.5
+    }
+  });
+  const serve = import_swagger_ui_express.default.serve[0];
+  const staticAssets = (req, res, next) => {
+    const filePath = req.path.replace(path, "");
+    const file = LiveAssets.get(filePath);
+    if (file === void 0) {
+      if (next) {
+        return next();
+      }
+      return res.status(404).send();
+    }
+    const fileParts = file.path.split(".");
+    const extension = fileParts[fileParts.length - 1];
+    const content = file.content;
+    return res.type(extension).send(content);
+  };
+  const ui = import_swagger_ui_express.default.setup(
+    document,
+    opts,
+    options,
+    customCss,
+    customfavIcon,
+    swaggerUrl,
+    customSiteTitle
+  );
+  return [serve, staticAssets, ui];
 }
-export * from './src/types/hyperExpress.types';
+
+// src/hyperExpressApplication.ts
+var Application = class extends import_http.ForklaunchExpressLikeApplication {
+  /**
+   * Creates an instance of the Application class.
+   *
+   * @param {SV} schemaValidator - The schema validator.
+   */
+  constructor(schemaValidator) {
+    super(schemaValidator, new import_hyper_express_fork.Server());
+  }
+  listen(arg0, arg1, arg2) {
+    if (typeof arg0 === "number") {
+      const port = arg0 || Number(process.env.PORT);
+      this.internal.set_error_handler((_req, res, err) => {
+        res.locals.errorMessage = err.message;
+        console.error(err);
+        res.status(
+          res.statusCode && res.statusCode >= 400 ? res.statusCode : 500
+        ).send(`Internal server error:
+
+${err.message}`);
+      });
+      const swaggerPath = `/api${process.env.VERSION ?? "/v1"}${process.env.SWAGGER_PATH ?? "/swagger"}`;
+      this.internal.use(swaggerPath, swaggerRedirect(swaggerPath));
+      this.internal.get(
+        `${swaggerPath}/*`,
+        swagger(
+          swaggerPath,
+          (0, import_http.generateSwaggerDocument)(this.schemaValidator, port, this.routers)
+        )
+      );
+      if (arg1 && typeof arg1 === "string") {
+        return this.internal.listen(port, arg1, arg2);
+      } else if (arg1 && typeof arg1 === "function") {
+        return this.internal.listen(port, arg1);
+      }
+    }
+    return this.internal.listen(
+      arg0,
+      arg1
+    );
+  }
+};
+
+// src/hyperExpressRouter.ts
+var import_http3 = require("@forklaunch/core/http");
+var import_hyper_express_fork2 = require("@forklaunch/hyper-express-fork");
+
+// src/middleware/contentParse.middleware.ts
+async function contentParse(req) {
+  console.debug("[MIDDLEWARE] contentParse started");
+  switch (req.headers["content-type"] && req.headers["content-type"].split(";")[0]) {
+    case "application/json":
+      req.body = await req.json();
+      break;
+    case "application/x-www-form-urlencoded":
+      req.body = await req.urlencoded();
+      break;
+    case "text/plain":
+      req.body = await req.text();
+      break;
+    case "application/octet-stream":
+      req.body = await req.buffer();
+      break;
+    default:
+      req.body = await req.json();
+      break;
+  }
+}
+
+// src/middleware/enrichResponseTransmission.middleware.ts
+var import_http2 = require("@forklaunch/core/http");
+function enrichResponseTransmission(req, res, next) {
+  console.debug("[MIDDLEWARE] enrichResponseTransmission");
+  const originalSend = res.send;
+  const originalJson = res.json;
+  const originalSetHeader = res.setHeader;
+  res.json = function(data) {
+    res.bodyData = data;
+    const result = originalJson.call(this, data);
+    return result;
+  };
+  res.send = function(data) {
+    if (!res.bodyData) {
+      res.bodyData = data;
+      res.statusCode = res._status_code;
+    }
+    return (0, import_http2.enrichExpressLikeSend)(
+      this,
+      req,
+      res,
+      originalSend,
+      data,
+      !res.cors && (res._cork && !res._corked || !res._cork)
+    );
+  };
+  res.setHeader = function(name, value) {
+    let stringifiedValue;
+    if (Array.isArray(value)) {
+      stringifiedValue = value.map(
+        (v) => typeof v !== "string" ? JSON.stringify(v) : v
+      );
+    } else {
+      stringifiedValue = typeof value !== "string" ? JSON.stringify(value) : value;
+    }
+    return originalSetHeader.call(this, name, stringifiedValue);
+  };
+  next();
+}
+
+// src/middleware/polyfillGetHeaders.middleware.ts
+function polyfillGetHeaders(_req, res, next) {
+  console.debug("[MIDDLEWARE] polyfillGetHeaders started");
+  res.getHeaders = () => {
+    return res._headers;
+  };
+  next?.();
+}
+
+// src/hyperExpressRouter.ts
+var Router = class extends import_http3.ForklaunchExpressLikeRouter {
+  constructor(basePath, schemaValidator) {
+    super(basePath, schemaValidator, new import_hyper_express_fork2.Router());
+    this.basePath = basePath;
+    this.internal.use(polyfillGetHeaders);
+    this.internal.use(contentParse);
+    this.internal.use(
+      enrichResponseTransmission
+    );
+  }
+  route(path) {
+    this.internal.route(path);
+    return this;
+  }
+  any = (pathOrContractDetailsOrMiddlewareOrTypedHandler, contractDetailsOrMiddlewareOrTypedHandler, ...middlewareOrMiddlewareWithTypedHandler) => {
+    return this.registerMiddlewareHandler(
+      this.internal.any,
+      pathOrContractDetailsOrMiddlewareOrTypedHandler,
+      contractDetailsOrMiddlewareOrTypedHandler,
+      ...middlewareOrMiddlewareWithTypedHandler
+    );
+  };
+  // TODO: Implement the rest of the methods
+  // upgrade
+  // ws
+};
+
+// index.ts
+function forklaunchExpress(schemaValidator) {
+  return new Application(schemaValidator);
+}
+function forklaunchRouter(basePath, schemaValidator) {
+  const router = new Router(basePath, schemaValidator);
+  return router;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  forklaunchExpress,
+  forklaunchRouter
+});