lambder 1.0.82 → 1.0.84

package/Readme.md

@@ -1,6 +1,6 @@
 # Lambder - Serverless NodeJS Web Framework
 
-Lambder is a dynamic serverless framework designed to facilitate the management and implementation of routes and APIs within AWS Lambda functions, specifically tailored for TypeScript projects. It provides a streamlined approach to handling HTTP requests, managing sessions, and defining API routes, making serverless application development more intuitive and structured.
+Lambder is a highly opinionated dynamic serverless framework designed to facilitate the management and implementation of routes and APIs within AWS Lambda functions, specifically tailored for TypeScript projects. It provides a streamlined approach to handling HTTP requests, managing sessions, and defining API routes, making serverless application development more intuitive and structured.
 
 ## Features
 
@@ -35,9 +35,8 @@ const lambder = new Lambder({
 });
 
 // Define a simple api
-lambder.addApi("getCompanyPage", async (ctx, res) => {
-    const { host, path, get, post, cookie, headers } = ctx;
-    const companyName = post.payload.companyName;
+lambder.addApi("getCompanyPage", async ({ apiPayload }, res) => {
+    const companyName = apiPayload.companyName;
     const data = await fetchDataSomehow(companyName);
     return res.api({ payload: data });
 });
@@ -97,8 +96,11 @@ For more details on route matching, please check [path-to-regexp](https://www.np
 ```typescript
 // Define a simple api
 lambder.addApi("getCompanyPage", async (ctx, res) => {
-    const { host, path, get, post, cookie, headers, apiName, apiPayload } = ctx;
-    const companyName = post.payload.companyName;
+    const { 
+        host, path, get, post, cookie, headers, 
+        apiName, apiPayload
+    } = ctx;
+    const companyName = apiPayload.companyName;
     const data = await fetchDataSomehow(companyName);
     return res.api({ payload: data });
 });
@@ -130,6 +132,89 @@ lambder.addHook("beforeRender", async (ctx, res) => {
 });
 ```
 
+### Render Context (ctx) Variables
+```typescript
+lambder.addApi("getCompanyName", async (ctx, res) => {
+    const { 
+        host, // Request host. Exp: "www.example.com"
+        path, // Request path. Exp: "/index.html" or "/user/342"
+        get, // Get request query in JSON format. Exp: { userId: 342 }
+        post, // Post request body after JSON parsed. Exp: { userId: 342 }
+        cookie, // Cookies in an object. Exp: { "rememberMe": "true" }
+        headers, // Request Headers in an object. Exp: { "User-Agent": "....", ... }
+        apiName, // In this function it would return "getCompanyName"
+        apiPayload, // Same as post.payload 
+    } = ctx;
+    return res.json({});
+});
+```
+
+### Resolver Methods
+
+```typescript
+lambder.addApi("getCompanyName", async (ctx, res) => {
+    res.raw(param);
+    // Directly sends a custom HTTP response defined by the param object. 
+    // Useful for sending non-standard responses.
+    res.json(data, headers);
+    // Sends a JSON response with the specified data and optional headers. 
+    // It sets the Content-Type header to application/json.
+
+    res.xml(data);
+    // Sends an XML response with the given data. 
+    // Automatically encodes the response in base64 and sets 
+    // the Content-Type header to application/xml.
+
+    res.html(data, headers); 
+    // Sends an HTML response containing the provided data with optional headers. 
+    // The response is base64 encoded, and the Content-Type header is set to text/html.
+
+    res.status301(url, headers); 
+    // Redirects the client to the specified url with a 301 status code and optional headers. 
+    // Useful for permanent redirections.
+
+    res.status404(data, headers); 
+    // Sends a 404 Not Found response with custom data and optional headers. 
+    // The response is base64 encoded, and the Content-Type header is set to text/html.
+
+    res.cors(); 
+    // Sends a 200 OK response with CORS headers enabled. 
+    // This is typically used in response to a preflight request in a CORS scenario.
+
+    res.fileBase64(fileBase64, mimeType, headers); 
+    // Sends a file response with the content provided in base64 format,
+    //   the specified mimeType, and optional headers.
+
+    res.file(filePath, headers, fallbackFilePath); 
+    // Serves a file from the server's public directory, with optional headers. 
+    // If the file is not found and a fallbackFilePath is provided, 
+    //   attempts to serve the fallback file. 
+    //   Returns a JSON error if neither file is found.
+
+    res.api({ payload, versionExpired, sessionExpired, notAuthorized, message, errorMessage }, headers); 
+    // Sends a standardized API response including the payload and status 
+    //    flags like versionExpired, sessionExpired, notAuthorized, along with 
+    //    optional messages and headers.
+
+    // res.die.* 
+    // Acts the same as res.* but will:
+    //  - Immediately return the value
+    //  - Terminate the function
+    //  - Skip the afterRender hooks
+    
+    res.die.raw(param); 
+    res.die.json(data, headers); 
+    res.die.xml(data); 
+    res.die.html(data, headers); 
+    res.die.status301(url, headers); 
+    res.die.status404(data, headers); 
+    res.die.cors(); 
+    res.die.fileBase64(fileBase64, mimeType, headers); 
+    res.die.file(filePath, headers, fallbackFilePath); 
+    res.die.api({ payload, versionExpired, sessionExpired, notAuthorized, message, errorMessage }, headers); 
+});
+```
+
 ## Frontend Usage with LambderCaller
 
 LambderCaller is a frontend companion library for Lambder, it is only 2kb compressed, and designed to simplify making API requests to your Lambder backend services. 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lambder",
-  "version": "1.0.82",
+  "version": "1.0.84",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",