@tsed/platform-fulmine 0.0.0-stage → 8.45.2

package/lib/esm/components/PlatformFulmine.js

@@ -0,0 +1,92 @@
+import Http from "node:http";
+import { getHostInfoFromPort, isFunction } from "@tsed/core";
+import { configuration, constant, injector, logger, ProviderScope } from "@tsed/di";
+import { PlatformExpress, PlatformExpressHandler, PlatformExpressResponse } from "@tsed/platform-express";
+import { adapter, application, PlatformBuilder, PlatformHandler, PlatformResponse } from "@tsed/platform-http";
+import fulmine from "fulmine.js";
+/**
+ * Ts.ED on [fulmine.js](https://github.com/nigrosimone/fulmine.js), an Express 5 compatible framework on
+ * uWebSockets.js. The Express adapter does the routing; this platform changes what owns the socket: the app
+ * listens on uWebSockets.js itself instead of being passed to `http.createServer()`.
+ *
+ * @platform
+ */
+export class PlatformFulmine extends PlatformExpress {
+    constructor() {
+        super(...arguments);
+        // @ts-ignore PlatformExpress types NAME as the literal "express"
+        this.NAME = "fulmine";
+    }
+    static create(module, settings = {}) {
+        return new PlatformBuilder({
+            httpsPort: false,
+            httpPort: false,
+            ...PlatformBuilder.options(PlatformFulmine, module, settings)
+        });
+    }
+    static bootstrap(module, settings = {}) {
+        return new PlatformBuilder(PlatformBuilder.options(PlatformFulmine, module, settings)).bootstrap();
+    }
+    createApp() {
+        const app = constant("fulmine.app") || fulmine();
+        return { app, callback: () => app };
+    }
+    /**
+     * The app is the server: it binds on uWebSockets.js and answers as an `http.Server`. TLS belongs to
+     * uWebSockets.js too, see `fulmine({uwsOptions})`.
+     */
+    getServers() {
+        // as createServer() decides it in platform-http: every value but false enables it, 0 included
+        if (constant("httpsPort") !== false) {
+            throw new Error("PlatformFulmine: set TLS on the fulmine app with fulmine({uwsOptions}) and the fulmine.app setting");
+        }
+        const app = application().getApp();
+        const port = constant("httpPort");
+        // useValue as a function: DI calls a function given as useValue, and the fulmine app is one
+        injector().add(Http.Server, { scope: ProviderScope.SINGLETON, useValue: () => (port !== false ? app : null) });
+        injector().invoke(Http.Server);
+        if (port === false) {
+            return [];
+        }
+        return [
+            async () => {
+                const hostInfo = getHostInfoFromPort("http", port);
+                await new Promise((resolve, reject) => {
+                    app.listen(Number(hostInfo.port), hostInfo.address, (err) => (err ? reject(err) : resolve()));
+                });
+                hostInfo.port = app.address().port;
+                logger().info(`Listen server on ${hostInfo.toString()}`);
+                configuration().set("httpPort", `${hostInfo.address}:${hostInfo.port}`);
+                return app;
+            }
+        ];
+    }
+    statics(_endpoint, options) {
+        const { root, ...props } = options;
+        const middleware = fulmine.static(root, props);
+        return (req, res, next) => (res.headersSent ? next() : middleware(req, res, next));
+    }
+    bodyParser(type, additionalOptions = {}) {
+        // fulmine.bodyParser.<type> is a parser that replaces the fulmine one, or the options of the fulmine one
+        const configured = constant(`fulmine.bodyParser.${type}`);
+        const parser = isFunction(configured) ? configured : fulmine[type];
+        const { verify, ...configuredOptions } = isFunction(configured) ? {} : configured || {};
+        const options = type === "urlencoded" ? { extended: true, ...configuredOptions } : configuredOptions;
+        if (type === "urlencoded") {
+            this.app.getApp().set("query parser", "extended");
+        }
+        // rawBody is only known once the routes are mapped, so it is read per request, as in PlatformExpress
+        options.verify = (req, res, buffer, encoding) => {
+            if (constant("rawBody")) {
+                req.rawBody = buffer;
+            }
+            verify?.(req, res, buffer, encoding);
+            return true;
+        };
+        return parser({ ...options, ...additionalOptions });
+    }
+}
+adapter(PlatformFulmine, [
+    { token: PlatformHandler, useClass: PlatformExpressHandler },
+    { token: PlatformResponse, useClass: PlatformExpressResponse }
+]);

package/lib/esm/index.js

@@ -0,0 +1,6 @@
+/**
+ * @file Automatically generated by @tsed/barrels.
+ */
+export * from "./components/PlatformFulmine.js";
+export * from "./interfaces/interfaces.js";
+export * from "./interfaces/PlatformFulmineSettings.js";

package/lib/esm/interfaces/PlatformFulmineSettings.js

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

package/lib/esm/interfaces/interfaces.js

@@ -0,0 +1 @@
+export * from "./PlatformFulmineSettings.js";

package/lib/types/components/PlatformFulmine.d.ts

@@ -0,0 +1,26 @@
+import { Type } from "@tsed/core";
+import { PlatformExpress } from "@tsed/platform-express";
+import { PlatformBuilder, PlatformStaticsOptions } from "@tsed/platform-http";
+/**
+ * Ts.ED on [fulmine.js](https://github.com/nigrosimone/fulmine.js), an Express 5 compatible framework on
+ * uWebSockets.js. The Express adapter does the routing; this platform changes what owns the socket: the app
+ * listens on uWebSockets.js itself instead of being passed to `http.createServer()`.
+ *
+ * @platform
+ */
+export declare class PlatformFulmine extends PlatformExpress {
+    readonly NAME = "fulmine";
+    static create(module: Type<any>, settings?: Partial<TsED.Configuration>): PlatformBuilder<any>;
+    static bootstrap(module: Type<any>, settings?: Partial<TsED.Configuration>): Promise<PlatformBuilder<any>>;
+    createApp(): {
+        app: any;
+        callback: () => any;
+    };
+    /**
+     * The app is the server: it binds on uWebSockets.js and answers as an `http.Server`. TLS belongs to
+     * uWebSockets.js too, see `fulmine({uwsOptions})`.
+     */
+    getServers(): any[];
+    statics(_endpoint: string, options: PlatformStaticsOptions): (req: any, res: any, next: any) => any;
+    bodyParser(type: "json" | "text" | "urlencoded", additionalOptions?: any): any;
+}

package/lib/types/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @file Automatically generated by @tsed/barrels.
+ */
+export * from "./components/PlatformFulmine.js";
+export * from "./interfaces/interfaces.js";
+export * from "./interfaces/PlatformFulmineSettings.js";

package/lib/types/interfaces/PlatformFulmineSettings.d.ts

@@ -0,0 +1,18 @@
+import type { Options, OptionsJson, OptionsText, OptionsUrlencoded } from "body-parser";
+import type { NextHandleFunction } from "connect";
+export interface PlatformFulmineSettings {
+    /**
+     * The fulmine application to use instead of a new `fulmine()`, to pass options such as
+     * `uwsOptions` for TLS.
+     */
+    app?: any;
+    /**
+     * body parser configuration, a function given here replaces the fulmine parser
+     */
+    bodyParser?: {
+        json?: ((opts?: OptionsJson) => NextHandleFunction) | OptionsJson;
+        text?: ((opts?: OptionsText) => NextHandleFunction) | OptionsText;
+        raw?: ((opts?: Options) => NextHandleFunction) | Options;
+        urlencoded?: ((opts?: OptionsUrlencoded) => NextHandleFunction) | OptionsUrlencoded;
+    };
+}

package/lib/types/interfaces/interfaces.d.ts

@@ -0,0 +1,12 @@
+import { PlatformFulmineSettings } from "./PlatformFulmineSettings.js";
+export * from "./PlatformFulmineSettings.js";
+declare global {
+    namespace TsED {
+        interface Configuration {
+            /**
+             * Configuration related to the fulmine.js platform application.
+             */
+            fulmine: PlatformFulmineSettings;
+        }
+    }
+}

package/package.json

@@ -1,6 +1,123 @@
 {
   "name": "@tsed/platform-fulmine",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "8.45.2",
+  "description": "A TypeScript Framework on top of fulmine.js, the Express 5 API on uWebSockets.js",
+  "keywords": [
+    "Controller",
+    "Decorator",
+    "Express",
+    "Inject",
+    "TypeScript",
+    "api",
+    "decorator",
+    "decorators",
+    "di",
+    "express",
+    "fulmine",
+    "ioc",
+    "mvc",
+    "rest",
+    "server",
+    "typescript",
+    "uWebSockets",
+    "uws"
+  ],
+  "homepage": "https://github.com/tsedio/tsed/tree/production/packages/platform/platform-fulmine",
+  "bugs": {
+    "url": "https://github.com/tsedio/tsed/issues"
+  },
+  "license": "MIT",
+  "author": "Romain Lenzotti",
+  "repository": "https://github.com/tsedio/tsed",
+  "source": "./src/index.ts",
+  "type": "module",
+  "main": "./lib/esm/index.js",
+  "module": "./lib/esm/index.js",
+  "typings": "./lib/types/index.d.ts",
+  "exports": {
+    ".": {
+      "tsed-source": "./src/index.ts",
+      "types": "./lib/types/index.d.ts",
+      "import": "./lib/esm/index.js",
+      "default": "./lib/esm/index.js"
+    }
+  },
+  "scripts": {
+    "build": "yarn barrels && yarn build:ts",
+    "barrels": "barrels",
+    "test": "vitest run",
+    "build:ts": "tsc --build tsconfig.esm.json",
+    "test:ci": "vitest run --coverage.thresholds.autoUpdate=true"
+  },
+  "dependencies": {
+    "tslib": ">=2.7.0"
+  },
+  "devDependencies": {
+    "@tsed/barrels": "8.45.2",
+    "@tsed/core": "8.45.2",
+    "@tsed/di": "8.45.2",
+    "@tsed/platform-express": "8.45.2",
+    "@tsed/platform-http": "8.45.2",
+    "@tsed/platform-test-sdk": "8.45.2",
+    "@tsed/platform-views": "8.45.2",
+    "@tsed/typescript": "8.45.2",
+    "@types/compression": "1.7.5",
+    "@types/cookie-parser": "1.4.7",
+    "@types/express": "^5.0.6",
+    "@types/express-session": "1.18.1",
+    "@types/method-override": "0.0.35",
+    "compression": "1.8.0",
+    "cookie-parser": "1.4.7",
+    "express": "5.2.1",
+    "express-session": "1.18.1",
+    "fulmine.js": "5.25.7",
+    "method-override": "3.0.0",
+    "typescript": "6.0.2",
+    "vitest": "4.1.4"
+  },
+  "peerDependencies": {
+    "@tsed/core": ">=8.0.0",
+    "@tsed/di": ">=8.0.0",
+    "@tsed/json-mapper": ">=8.0.0",
+    "@tsed/logger": ">=8.0.0",
+    "@tsed/openspec": ">=8.0.0",
+    "@tsed/platform-express": ">=8.0.0",
+    "@tsed/platform-http": ">=8.0.0",
+    "@tsed/platform-views": ">=8.0.0",
+    "@tsed/schema": ">=8.0.0",
+    "express": ">=5.0.0",
+    "fulmine.js": "^5.25.7"
+  },
+  "peerDependenciesMeta": {
+    "@tsed/core": {
+      "optional": false
+    },
+    "@tsed/di": {
+      "optional": false
+    },
+    "@tsed/json-mapper": {
+      "optional": false
+    },
+    "@tsed/logger": {
+      "optional": false
+    },
+    "@tsed/platform-express": {
+      "optional": false
+    },
+    "@tsed/platform-http": {
+      "optional": false
+    },
+    "@tsed/platform-views": {
+      "optional": true
+    },
+    "@tsed/schema": {
+      "optional": false
+    },
+    "express": {
+      "optional": false
+    },
+    "fulmine.js": {
+      "optional": false
+    }
+  }
 }

package/readme.md

@@ -0,0 +1,106 @@
+<p style="text-align: center" align="center">
+ <a href="https://tsed.dev" target="_blank"><img src="https://tsed.dev/tsed-og.png" width="200" alt="Ts.ED logo"/></a>
+</p>
+
+<div align="center">
+   <h1>Platform fulmine.js</h1>
+
+[![Build & Release](https://github.com/tsedio/tsed/workflows/Build%20&%20Release/badge.svg)](https://github.com/tsedio/tsed/actions?query=workflow%3A%22Build+%26+Release%22)
+[![PR Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/tsedio/tsed/blob/master/CONTRIBUTING.md)
+[![npm version](https://badge.fury.io/js/%40tsed%2Fcommon.svg)](https://badge.fury.io/js/%40tsed%2Fcommon)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+[![github](https://img.shields.io/static/v1?label=Github%20sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/romakita)
+[![opencollective](https://img.shields.io/static/v1?label=OpenCollective%20sponsor&message=%E2%9D%A4&logo=OpenCollective&color=%23fe8e86)](https://opencollective.com/tsed)
+
+</div>
+
+<div align="center">
+  <a href="https://tsed.dev">Website</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://tsed.dev/getting-started/">Getting started</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://slack.tsed.dev">Slack</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://twitter.com/TsED_io">Twitter</a>
+</div>
+
+<hr />
+
+A package of Ts.ED framework. See website: https://tsed.dev/getting-started/
+
+## Installation
+
+Run npm command (or yarn):
+
+```bash
+npm install --save @tsed/platform-fulmine @tsed/platform-express fulmine.js express
+```
+
+[fulmine.js](https://github.com/nigrosimone/fulmine.js) is an Express 5 compatible framework on
+uWebSockets.js. The platform uses the Express adapter for the routing, so the Express middlewares of a Ts.ED
+app stay the same, and the app listens on uWebSockets.js instead of the http server of node. `express` is
+still needed, as a peer of `@tsed/platform-express`.
+
+About the install:
+
+- fulmine.js depends on `uWebSockets.js` from GitHub (`github:uNetworking/uWebSockets.js#v20.71.0`), not from the npm
+  registry, so the install needs access to github.com. Behind a registry mirror or a proxy that only allows npm, it fails.
+- uWebSockets.js is a native addon with prebuilt binaries: Node 22, 24 or 26 on Linux or macOS (x64 or arm64) or
+  Windows (x64). Not Alpine (glibc 2.38+ is needed).
+- On Bun and Deno fulmine.js does not load uWebSockets.js and listens with their own `node:http`, plain HTTP only.
+
+## Usage
+
+```typescript
+import {PlatformFulmine} from "@tsed/platform-fulmine";
+import {Server} from "./Server.js";
+
+const platform = await PlatformFulmine.bootstrap(Server, {httpPort: 8083});
+await platform.listen();
+```
+
+To pass options to fulmine, such as TLS with `uwsOptions`, give your own app:
+
+```typescript
+import fulmine from "fulmine.js";
+
+const platform = await PlatformFulmine.bootstrap(Server, {
+  httpPort: 8443,
+  fulmine: {
+    app: fulmine({uwsOptions: {key_file_name: "key.pem", cert_file_name: "cert.pem"}})
+  }
+});
+```
+
+`httpsPort` is not supported: TLS belongs to uWebSockets.js, set it on the fulmine app.
+
+See [Ts.ED capabilities](https://tsed.dev/introduction/capabilities.html) for more information.
+
+## Contributors
+
+Please read [contributing guidelines here](https://tsed.dev/contributing.html)
+
+<a href="https://github.com/tsedio/tsed/graphs/contributors"><img src="https://opencollective.com/tsed/contributors.svg?width=890" /></a>
+
+## Backers
+
+Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/tsed#backer)]
+
+<a href="https://opencollective.com/tsed#backers" target="_blank"><img src="https://opencollective.com/tsed/backers.svg?width=890"></a>
+
+## Sponsors
+
+Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/tsed#sponsor)]
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2016 - 2022 Romain Lenzotti
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.