lambder 1.0.66 → 1.0.68

package/Readme.md

@@ -1,58 +1,135 @@
 # Lambder
 
-Lambder provides a simplified way to handle AWS Lambda functions with HTTP triggers, offering a clear structure for managing API endpoints, static file serving, hooks, and error handling.
+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.
 
 ## Features
 
-- Easy setup of API paths with conditions and actions.
-- Support for hooks at different stages of the request lifecycle.
-- Integrated cookie and query string parsing.
-- Customizable error handling and fallback mechanisms.
-- CORS support and easy configuration for public paths.
-- Response helpers for JSON, HTML, XML, files, and more.
+- **Simple API & Route Declaration**: Define your APIs and routes using concise and expressive syntax.
+- **Session Management**: Built-in session management to secure and personalize user experiences.
+- **Flexible Hooks System**: Employ hooks to execute code at different stages of the request lifecycle, enabling fine-grained control over the application flow.
+- **Error Handling**: Comprehensive error handling capabilities, including global error handlers and route-specific fallbacks.
+- **Seamless Integration**: Designed to work effortlessly with AWS Lambda and API Gateway, providing a straightforward path to deploy serverless applications.
 
 ## Installation
 
+To include Lambder in your TypeScript project, you can install it using npm or yarn. First, ensure that you have TypeScript set up in your project.
+
 ```bash
 npm install lambder
+# or
+yarn add lambder
 ```
 
-## Quick Start
+## Backend Usage
+
+### Basic Setup
 
 ```typescript
 import Lambder from 'lambder';
-import { APIGatewayProxyEvent, Context } from 'aws-lambda';
+import * as path from 'path';
 
-const app = new Lambder({
-    apiPath: '/api',
-    publicPath: '/public',
+const lambder = new Lambder({
+    apiPath: "/secure",
     isCorsEnabled: true,
+    publicPath: path.resolve(`./public`),
+});
+
+// Define a simple api
+lambder.addApi("fetchData", async (ctx, res) => {
+    const data = await fetchDataSomehow();
+    return res.api({ payload: data });
+});
+
+// Define a simple route
+lambder.addRoute("/hello-world", (ctx, res) => {
+    return res.json({ message: "Hello World" });
+});
+
+// Match all other paths and serve static files from publicPath, if not found, serve index.html
+lambder.addRoute("*", (ctx, res)=>{
+    return res.file(ctx.path, {}, "index.html");
+});
+
+
+// Set a fallback handler for unmatched routes
+lambder.setRouteFallbackHandler((ctx, res) => {
+    return res.status404("Not Found");
 });
 
-// Define a simple API endpoint
-app.addApi('/hello', async (ctx) => {
-    return ctx.resolver.json({ message: 'Hello, World!' });
+// Global error handler
+lambder.setGlobalErrorHandler((err, ctx, res) => {
+    console.error("Error:", err);
+    return res.status500("Internal Server Error");
+});
+
+export const handler = (event, context) => {
+    return lambder.render(event, context);
+};
+```
+
+### Adding Hooks
+
+```typescript
+// Before render hook example
+lambder.addHook("beforeRender", async (ctx, res) => {
+    // Perform actions before rendering
+    if(ctx.method === "POST") {
+        // Validate CSRF token, for example
+    }
+    return ctx; // Return modified context or throw an Error
 });
+```
+
+## 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. 
 
-// Handle 404 Not Found
-app.setGlobalErrorHandler((err: Error) => {
-    return { statusCode: 404, body: 'Not Found' };
+### Installing LambderCaller
+
+LambderCaller is included in the same `lambder` package. Ensure you have `lambder` available in your frontend project.
+
+### Basic Setup
+
+Begin by initializing LambderCaller with your API configuration. This setup assumes your project structure accommodates a place for initiating and configuring API handlers, possibly within a dedicated JavaScript module or directly in your main application file.
+
+```javascript
+import LambderCaller from "lambder/dist/LambderCaller";
+
+const lambderCaller = new LambderCaller({
+    isCorsEnabled: false,
+    apiPath: "/secure", // Your Lambder API endpoint, must be the same as in your backend
+    fetchStartedHandler: ({ activeFetchList }) => {
+        // When any api call starts
+    },
+    fetchEndedHandler: ({ activeFetchList }) => {
+        // When any api call ends
+    },
+    errorMessageHandler: (message) => {
+        console.error("LambderCaller:", message); // Handle error messages
+    },
 });
 
-// Lambda handler
-exports.handler = async (event: APIGatewayProxyEvent, context: Context) => {
-    return app.render(event, context);
+
+const loadPageData = async () => {
+    try {
+        const response = await lambderCaller.api("getCompanyPage", {
+            subdomain: "example", // Pass necessary parameters for your API call
+        });
+    } catch (error) {
+        console.error("Failed to fetch page data:", error);
+    }
 };
+
 ```
 
-## Documentation
+## Advanced Configuration
 
-For more details on how to use Lambder, including the full API reference, visit [Lambder Documentation](#).
+Lambder is designed to be flexible and extensible, allowing for customized behaviors through hooks and custom error handling mechanisms. 
 
 ## Contributing
 
-Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.
+Contributions are welcome! Especially for documentation. If you have an idea for an improvement or have found a bug, please open an issue or submit a pull request.
 
 ## License
 
-MIT License
+This project is licensed under the [MIT License](LICENSE).

package/package.json

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