About The Project

Inspired by Express.js, Cloud Router makes it easier to build and organize your backend API using Cloudflare Workers. Written in TypeScript, this framework works as a wrapper around your application's logic, handling the execution of middlewares and controller callbacks in an easy-to-use fashion.

Key features:

• Application structuring and organization
• Router registration for API endpoints and middlewares
• Built-in response methods to remove unnecessary boilerplate code

This project should be considered a work in progress, with the goal of adding more features soon. You can suggest any changes by forking this repository and creating a pull request or opening an issue.

Getting Started

To use this package, you need Node.js and npm installed on your local machine.

npm i cloud-router-ts

Usage

// routes.ts
import { Router, ClientRequest, WorkerResponse } from 'cloud-router-ts';

const router = new Router();
router.get('/', (req: ClientRequest, res: WorkerResponse) => {
  return res.json({ data: 'Hello World!' });
});

export default router;

// app.ts
import { App } from 'cloud-router-ts';
import router from './router';

const app = new App();
app.setRouter('api', router);

export default app;

// worker.ts
import { Worker } from 'cloud-router-ts';
import app from './app';

const handler: ExportedHandler = {
  async fetch(request: Request) {
    const worker = new Worker(request, app);
    return worker.listen();
  }
};

export default worker;

For more detailed examples: Example

API

Cloud Router is built upon a foundation of five distinct classes, each serving a specific purpose within its architecture:

1. ClientRequest: This class extends the incoming HTTP Request and augments it with additional properties relevant to the Cloud Router's operations.

2. WorkerResponse: Serving as a placeholder class, WorkerResponse is responsible for encapsulating and managing information pertaining to the Response object. It includes various helper methods to assist in the manipulation and handling of response-related data.

3. Router: The Router class offers a convenient means of registering API routes within the Cloud Router.

4. App: The App class serves as a wrapper for the application logic within the Cloud Router framework, encapsulating the essential functionalities and operations.

5. Worker: Responsible for executing the application logic, the Worker class handles the processing and management of the defined operations within the Cloud Router.

The Cloud Router is further structured around two types of callback functions:

1. Controller
2. Middleware

What sets them apart is the expected return value, where a Controller should return a response, but a middleware could return either a response or void.

| Method/Class | Docs | | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | WorkerResponse | | | .status() | The status function sets the HTTP status code of the response object. It accepts one argument, which is the response code itself, and then returns the WorkerResponse object. | | .json() | The json function takes any valid data types that can be stringified to JSON as its argument and returns a new Response object. | | .send() | The send method takes two arguments: a response body and a 'Content-Type' value for the HTTP header. It returns a new Response object. | | .redirect() | The redirect method returns a new Response object that redirects the incoming request to the specified URL or path. | | .pipe() | The pipe method takes a response object as its argument and pipes it to a new Response object that it returns. | | .setHeaders() | The setHeaders method accepts an object containing multiple headers as argument, attaches it to the response object, and returns the WorkerResponse object. | | .setHeader() | The setHeader method takes two arguments that represent the name and value of a header. It attaches this header information to the response object and returns the WorkerResponse object. | | .clearHeaders() | The clearHeaders method clears all the attached headers from the response object and returns the WorkerResponse object. | | .clearHeader() | The clearHeader method takes a header name as its argument, removes that header from the response object, and returns the WorkerResponse object. | | .getHeaders() | The getHeaders method returns all the headers that are attached to the response object. | | .getHeader() | The getHeader method takes one argument representing the name of a header and returns the corresponding value of that header. | | .setCookie() | The setCookie method accepts three arguments: the name of the cookie, the value of the cookie, and any optional valid cookie options. This method attaches the provided values as a cookie to the response object and subsequently returns the WorkerResponse object. | | .clearCookie() | The clearCookie function takes the name of a client cookie as its argument. It proceeds to assign an expired expiration date to the cookie and attaches it to the response object. This instructs the client's browser to remove the cookie upon receiving the response. Finally, the function returns the WorkerResponse object. | | ClientRequest | | | .param | This property holds the value of the dynamic path provided in the Router registration method. | | ._url | This property holds a URL object representing the request URL. | | .data | This property serves as a placeholder and is primarily intended to facilitate generic typing for the parsed request body. | | .error | This property contains any runtime error object. | | Router | | | .get() | Each Router method registers a new HTTP API endpoint that corresponds to its name. These methods accept two arguments: the path that triggers the execution of the endpoint and a controller function. Dynamic paths can be specified using the syntax path/:nameOfValue, allowing for the extraction of the corresponding value from the req.params object. | | .post() | -"- | | .put() | -"- | | .patch() | -"- | | .delete() | -"- | | .option() | -"- | | .head() | -"- | | App | | | .authenticate() | The authenticate function takes a middleware function as an argument. This callback will be executed first for every incoming request. | | .public() | The public function register a public path within the application. It accepts two arguments: the base URL path that triggers its associated callback and a controller function. These routes are executed after the authentication callback but before any other middlewares. | | .middleware() | The middleware function accepts one or multiple middleware functions as its argument. These middlewares will be executed in order for every incoming request. | | .setRouter() | The setRouter function register a new base router within the application. It accepts three arguments: the base URL path associated with an incoming request that will activate the corresponding callback, an instance of the Router class, and one or multiple middlewares. | | .error() | The error function takes a controller function as its argument. This callback will be executed if an error occurs within your application outside of any lower-level try/catch block. | | .notFound() | The notFound function takes a controller function as its argument. Its callback will be executed if no registered routes match the incoming request URL path. | | .getAuthHandler() | Returns the authentication middleware. | | .getPublicRoutes() | Returns all registered public routes. | | .getMiddlewares() | Returns all application middlewares. | | .getRouters() | Returns all registered routers. | | .getErrorHandler() | Returns the error controller. | | .getNotFoundHandler() | Returns the notFound controller. | | Worker | | | .listen() | The listen function executes the application logic when receiving incoming requests and provides a new Response object as a result. It accepts three arguments: the incoming HTTP request, an instance of the App object, and an object that includes default headers for attaching to all outgoing responses. |

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Author: - https://www.linkedin.com/in/niklas-str%C3%B6mberg-59b428169/

Project Link: https://github.com/Nik-Str/cloud-router