@stonyx/rest-server 0.2.0

package/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  pull_request:
+    branches:
+      - dev
+      - main
+
+concurrency:
+  group: ci-${{ github.head_ref || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 24.13.0
+          cache: 'pnpm'
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Run tests
+        run: pnpm test

package/LICENSE.md

@@ -0,0 +1,203 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2025] [Stone Costa]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+   

package/README.md

@@ -0,0 +1,172 @@
+# @stonyx/rest-server
+
+REST server module for the [Stonyx framework](https://github.com/abofs/stonyx), providing dynamic route registration and built-in request handling with optional authentication hooks.
+
+## Highlights
+
+* **Zero configuration for routes:** Simply drop your request class files into the configured `requests` directory and the RestServer automatically mounts them.
+* **Automatic path generation:** Filenames become route paths (with optional camelCase conversion).
+* **Built-in JSON & CORS handling:** No need to manually configure Express middleware.
+* **Authorization hooks per request:** Add authentication logic per class with minimal boilerplate.
+* **Singleton server:** Only one RestServer instance runs, preventing accidental multiple listeners.
+* **Framework integration:** Works seamlessly as part of the Stonyx framework—auto-initialized with the rest of your modules.
+
+## RestServer
+
+The `RestServer` class wraps an Express.js instance to provide:
+
+* Singleton REST server instance
+* Dynamic route mounting from a directory
+* Automatic CORS and JSON body handling
+* Authorization hooks per request class
+
+### Usage example
+
+This module is part of the **Stonyx framework**. To use it, first configure the `restServer` key in your `environment.js` file:
+
+```js
+const {
+  REST_CORS_ORIGIN,
+  REST_PORT,
+  REST_REQUEST_PATH
+} = process;
+
+export default {
+    restServer: {
+       origin: REST_CORS_ORIGIN ?? '*',
+       dir: REST_REQUEST_PATH ?? './requests',
+       port: REST_PORT ?? 2666,
+       logColor: 'yellow'
+   }
+};
+```
+
+Then initialize the Stonyx framework, which auto-initializes all of its modules, including `@stonyx/rest-server`:
+
+```js
+import Stonyx from 'stonyx';
+import config from './config/environment.js';
+
+new Stonyx(config);
+```
+
+For further framework initialization instructions, see the [Stonyx repository](https://github.com/abofs/stonyx).
+
+### Optional Direct Usage
+
+If needed, you can also directly access the `RestServer`:
+
+```js
+import RestServer from '@stonyx/rest-server';
+
+const server = new RestServer();
+await server.init();
+
+// Close server when needed
+RestServer.close();
+```
+
+### Configuration Options
+
+Configuration is read from `stonyx/config` under `restServer`:
+
+|       Option      |         Type        | Default     | Description                                                |
+| :---------------: | :-----------------: | :---------- | :--------------------------------------------------------- |
+|       `dir`       |      **String**     | `undefined` | Directory containing request classes to mount as routes    |
+| `camelCaseRoutes` |     **Boolean**     | `true`      | Convert filenames to camelCase when generating route paths |
+|       `port`      |      **Number**     | `3000`      | Port to listen on                                          |
+|      `origin`     | **String \| Array** | `'*'`       | CORS origin(s) allowed                                     |
+|    `statusMap`    |      **Object**     | `{}`        | Optional mapping of HTTP status codes to custom messages   |
+|      `debug`      |     **Boolean**     | `false`     | Enable debug logging during route setup                    |
+
+## Request Class
+
+The `Request` class provides a structured way to define route handlers and authorization hooks. Route classes extend `Request` and define:
+
+* `handlers` — an object mapping HTTP methods to route paths and handler functions
+* Optional `auth(request, state)` — authentication middleware returning a status code if unauthorized
+
+### Usage example
+
+```js
+import { Request } from '@stonyx/rest-server';
+
+export default class MyRequest extends Request {
+  handlers = {
+    get: {
+      '/': (_req, _state) => ({ message: 'Hello world' }),
+      '/error': (_req, _state) => 500
+    }
+  }
+
+  auth(req, state) {
+    if (!req.headers.authorization) return 401;
+  }
+}
+```
+
+### Handler Features
+
+* Middleware support by passing an array of functions for a route
+* Automatic binding of `this` for instance methods
+* Returns integers as HTTP status codes
+* Returns objects as JSON responses
+* Undefined responses default to `200 OK`
+* Invalid HTTP methods are skipped with a warning
+
+## Example Project Structure
+
+Here’s an example of how to structure your `requests` directory for dynamic route loading:
+
+```
+project-root/
+├─ config/
+│  └─ environment.js       # contains restServer configuration
+├─ requests/
+│  ├─ public.js            # PublicRequest class
+│  └─ private.js           # PrivateRequest class
+├─ src/
+│  └─ main.js              # Optional direct usage of RestServer
+└─ package.json
+```
+
+* `public.js` — contains public-facing routes without authentication
+* `private.js` — contains routes with authentication via the `auth` hook
+
+The `RestServer` will automatically mount these routes using the filenames as paths (`/public` and `/private` by default, or camelCased if configured).
+
+Perfect! Here’s a self-contained **“Example Requests”** section with sample `curl` calls:
+
+---
+
+### Example Requests
+
+Assuming you have `public.js` and `private.js` routes mounted, you can test them like this:
+
+```bash
+# Public route - should return 200 OK with JSON
+curl http://localhost:2666/public
+
+# Public route with no return - defaults to 200 OK
+curl http://localhost:2666/public/success
+
+# Private route - authenticated request
+curl http://localhost:2666/private/success -H "Authorization: token"
+
+# Private route - unauthenticated request
+curl http://localhost:2666/private/failure
+# Returns HTTP 505 as defined by the auth hook
+```
+
+**Notes:**
+
+* Public routes can be accessed without authentication.
+* Private routes use the `auth` hook defined in the request class.
+* Integer returns from handlers are treated as HTTP status codes.
+* Objects returned from handlers are sent as JSON responses.
+
+---
+
+## License
+
+Apache — do what you want, just keep attribution.

package/config/environment.js

@@ -0,0 +1,17 @@
+const {
+  REST_CORS_ORIGIN,
+  REST_CORS_METHODS,
+  REST_HEALTH_CHECK_DISABLE,
+  REST_PORT,
+  REST_REQUEST_PATH
+} = process;
+
+export default {
+  enableHealthCheck: REST_HEALTH_CHECK_DISABLE !== 'true',
+  origin: REST_CORS_ORIGIN ?? '*',
+  methods: REST_CORS_METHODS ?? 'GET,POST,PATCH,PUT,DELETE',
+  dir: REST_REQUEST_PATH ?? './requests',
+  port: REST_PORT ?? 2666,
+  logColor: 'yellow',
+  logMethod: 'api'
+};

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@stonyx/rest-server",
+  "keywords": [
+    "stonyx-async",
+    "stonyx-module"
+  ],
+  "version": "0.2.0",
+  "description": "Rest Server Module for Stonyx Framework",
+  "main": "src/main.js",
+  "type": "module",
+  "exports": {
+    ".": "./src/main.js"
+  },
+  "author": "Stone Costa",
+  "license": "Apache-2.0",
+  "contributors": [
+    "Stone Costa <stone.costa@synamicd.com>"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "cors": "^2.8.5",
+    "express": "^5.1.0",
+    "stonyx": "^0.2.2"
+  },
+  "devDependencies": {
+    "@stonyx/utils": "^0.2.2",
+    "qunit": "^2.24.1",
+    "sinon": "^21.0.0"
+  },
+  "scripts": {
+    "test": "qunit --require ./stonyx-bootstrap.cjs"
+  }
+}

package/src/main.js

@@ -0,0 +1,89 @@
+/*
+ * Copyright 2025 Stone Costa
+ *
+ * Licensed under the Apache License, Version 2.0 (the 'License');
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import cors from 'cors';
+import express from 'express';
+import config from 'stonyx/config';
+import log from 'stonyx/log';
+import { forEachFileImport } from '@stonyx/utils/file';
+
+export { default as Request } from './request.js';
+
+export default class RestServer {
+  constructor() {
+    if (RestServer.instance) return RestServer.instance;
+    RestServer.instance = this;
+
+    this.api = new express();
+  }
+
+  static close() {
+    if (!RestServer.instance) throw new Error('RestServer has not been initialized yet');
+
+    RestServer.instance.server.close();
+  }
+  
+  async init() {
+    await this.setupRouter();
+    
+    const { port } = config.restServer;
+
+    // start REST server
+    this.server = this.api.listen(port);
+    log.title(`API Server is listening on port ${port}`);
+  }
+
+  async setupRouter() {
+    const { camelCaseRoutes, dir, enableHealthCheck } = config.restServer;
+    this.setupGlobalMiddleware();
+
+    try {
+      await forEachFileImport(dir, this.mountRoute.bind(this), { rawName: !camelCaseRoutes, ignoreAccessFailure: true });
+
+      if (enableHealthCheck) this.api.get('/health', (_req, res) => res.sendStatus(200));
+    } catch (error) {
+      if (config.debug) console.log(error);
+      throw log.error(`Unable to dynamically configure routes from files in ${dir}`);
+    }
+  }
+
+  async setupGlobalMiddleware() {
+    const { origin, methods } = config.restServer;
+
+    this.api.use([
+      cors({ origin, methods }),
+      express.json()
+    ]);
+  }
+
+  async mountRoute(routeClass, { name, options }) {
+    const { api } = this;
+    const classInstance = new routeClass(options);
+    const route = name === 'index' ? '/' : `/${name}`;
+    const { expressInstance, authorization } = classInstance;
+    
+    const routeCalls = [ expressInstance ];
+
+    // Assign auth callback if it exists
+    if (authorization) routeCalls.unshift(authorization.bind(classInstance));
+
+    classInstance.registerCalls();
+    expressInstance.mountpath = route;
+    
+    // Mount handler to main api instance
+    api.use(route, ...routeCalls);
+  }
+}

package/src/request.js

@@ -0,0 +1,85 @@
+import express from 'express';
+import config from 'stonyx/config';
+import { makeArray } from '@stonyx/utils/object';
+
+const METHODS = new Set(['get', 'post', 'put', 'delete', 'patch']);
+
+export default class Request {
+  static stateProp = '__stonyxState';
+
+  static getState(req) {
+    const { stateProp } = Request;
+    if (req[stateProp] !== undefined) return req[stateProp];
+    
+    req[stateProp] = {};
+    return req[stateProp];
+  }
+
+  static sendStatusResponse(res, status) {
+    const statusMap = config.restServer?.statusMap || {};
+    const message = statusMap[status] || '';
+  
+    return message ? res.status(status).send(message) : res.sendStatus(status);
+  }
+
+  constructor() {
+    const api = express();
+    api.disable('x-powered-by');
+    
+    this.expressInstance = api;
+  }
+
+  // auth hook wrapper
+  authorization(req, res, next) {
+    if (!this.auth) return next();
+
+    const status = this.auth(req, Request.getState(req));
+    if (status) return Request.sendStatusResponse(res, status);
+
+    next();
+  }
+
+  registerCalls() {
+    const { expressInstance } = this;
+    const { getState } = Request;
+    
+    for (const [method, handlers] of Object.entries(this.handlers)) {
+      if (!METHODS.has(method)) {
+        console.warn(`Method "${method}" is not a valid HTTP method. Skipping...`);
+        continue;
+      }
+
+      for (const [route, handler] of Object.entries(handlers)) {
+        expressInstance[method](route, async (req, res) => {
+          const callStack = makeArray(handler);
+          const mainCall = callStack.pop();
+          const { sendStatusResponse } = Request;
+          let response;
+
+          // Run middleware
+          while(callStack.length) {
+            response = await callStack.shift().bind(this)(req, getState(req));
+            if (response !== undefined) break;
+          }
+
+          if (response === undefined) response = await mainCall(req, getState(req));
+          if (Number.isInteger(response)) return sendStatusResponse(res, response);
+          
+          // Handle pipe if set via call state object
+          const { pipe } = getState(req);
+          if (pipe) {
+            const { headers, source } = pipe;
+
+            if (headers) for (const [key, value] of Object.entries(headers)) res.set(key, value);
+            return source.pipe(res);
+          }
+
+          if (response === undefined) return res.sendStatus(200);
+          if (typeof response !== 'object') return sendStatusResponse(res, 500);
+
+          res.send(response);
+        });
+      }
+    }
+  }
+}

package/stonyx-bootstrap.cjs

@@ -0,0 +1,12 @@
+/**
+ * commonJS Bootstrap loading - Stonyx must be loaded first, prior to the rest of the application
+ */
+const { default:Stonyx } = require('stonyx');
+const { default:config } = require('./config/environment.js');
+
+// Override dir for tests
+config.dir = './test/sample/requests';
+
+new Stonyx(config, __dirname);
+
+module.exports = Stonyx;