lambder 1.0.113 → 1.0.114

package/Readme.md

@@ -5,7 +5,7 @@ Lambder is a highly opinionated dynamic serverless framework designed to facilit
 ## Features
 
 - **Simple API & Route Declaration**: Define your APIs and routes using concise and expressive syntax.
-- **Session Management**: IN PROGRESS: Built-in session management to secure and personalize user experiences.
+- **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.
@@ -30,11 +30,21 @@ import * as path from 'path';
 
 const lambder = new Lambder({
     apiPath: "/secure",
-    isCorsEnabled: true,
     publicPath: path.resolve(`./public`),
     // ejsPath: path.resolve(`./ejs-templates`),
 });
 
+
+// Enable session
+lambder.enableDdbSession({
+    tableName: "website-session",
+    tableRegion: "us-east-1",
+    sessionSalt: "8p6Vt+4b1w3N8d/dcJ47QF3DRkp9koFg0G" // Change salt
+});
+
+// Enable Cors
+lambder.setIsCorsEnabled(true);
+
 // Define a simple api
 lambder.addApi("getCompanyPage", async ({ apiPayload }, res) => {
     const companyName = apiPayload.companyName;
@@ -42,6 +52,13 @@ lambder.addApi("getCompanyPage", async ({ apiPayload }, res) => {
     return res.api(data);
 });
 
+// Start a session from an API
+lambder.addApi("loginUser", async (ctx, res) => {
+    const user = await fetchUserData();
+    await lambder.getSessionController(ctx).startSession(user.id);
+    return res.api({ success: true });
+});
+
 // Define a simple route
 lambder.addRoute("/hello-world", (ctx, res) => {
     return res.html("Hello World");
@@ -114,6 +131,29 @@ export const handler = (event, context) => {
 ### Adding APIs
 
 For more details on route matching, please check [path-to-regexp](https://www.npmjs.com/package/path-to-regexp) package.
+```typescript
+// Add routes
+lambder.addRoute(pathAsString, async (ctx, res) => {});
+lambder.addRoute(pathAsRegex, async (ctx, res) => {});
+lambder.addRoute(matchFunction, async (ctx, res) => {});
+
+// Add apis
+lambder.addApi(apiNameAsString, async (ctx, res) => {});
+lambder.addApi(apiNameAsRegex, async (ctx, res) => {});
+lambder.addApi(matchFunction, async (ctx, res) => {});
+
+// Add only session accessible routes
+lambder.addSessionRoute(pathAsString, async (ctx, res) => {});
+lambder.addSessionRoute(pathAsRegex, async (ctx, res) => {});
+lambder.addSessionRoute(matchFunction, async (ctx, res) => {});
+
+// Add only session accessible apis
+lambder.addSessionApi(apiNameAsString, async (ctx, res) => {});
+lambder.addSessionApi(apiNameAsRegex, async (ctx, res) => {});
+lambder.addSessionApi(matchFunction, async (ctx, res) => {});
+
+```
+
 
 ```typescript
 // Define a simple api
@@ -128,6 +168,21 @@ lambder.addApi("getCompanyPage", async (ctx, res) => {
 });
 ```
 
+```typescript
+// Define an only session accessible api
+lambder.addSessionApi("getCompanyPage", async (ctx, res) => {
+    const { 
+        host, path, get, post, cookie, headers, 
+        session, apiName, apiPayload
+    } = ctx;
+    
+    const companyName = session.data.companyName;
+    const data = await fetchDataSomehow(companyName);
+    return res.api(data);
+});
+```
+
+
 
 ### Adding Routes
 ```typescript
@@ -161,6 +216,32 @@ lambder.addModule(async (lambder: Lambder): Promise<void> => {
 });
 ```
 
+### Session Management
+
+```typescript
+lambder.addApi("getCompanyPage", async (ctx, res) => {
+    const sessionController = lambder.getSessionController(ctx);
+    const userId = "37234";
+    await sessionController.startSession(userId, { "business": "Session data goes here"  });
+    console.log(ctx.session?.userKey); // "37234"
+    console.log(ctx.session?.data?.business); // "Session data goes here"
+
+    await sessionController.updateSessionData({ "business2": "Session data updated"  });
+    console.log(ctx.session?.userKey); // "37234"
+    console.log(ctx.session?.data?.business); // undefined
+    console.log(ctx.session?.data?.business2); // "Session data updated"
+    
+    await sessionController.deleteSession(); // End session
+    console.log(ctx.session?.userKey); // undefined
+    console.log(ctx.session?.data?.business); // undefined
+    
+    await sessionController.deleteSessionAll(); // End session for this user in all devices
+    console.log(ctx.session?.userKey); // undefined
+    console.log(ctx.session?.data?.business); // undefined
+
+});
+```
+
 ### EJS Templates: 
 
 EJS templates have the variables `page` and `partial` available:

package/dist/Lambder.d.ts

@@ -49,9 +49,8 @@ export default class Lambder {
         apiPath?: string;
         ejsPath?: string;
         apiVersion?: string;
-        isCorsEnabled?: boolean;
     });
-    enableCORS(isCorsEnabled: boolean): void;
+    setIsCorsEnabled(isCorsEnabled: boolean): void;
     enableDdbSession({ tableName, tableRegion, sessionSalt }: {
         tableName: string;
         tableRegion: string;
@@ -84,7 +83,7 @@ export default class Lambder {
     addHook(hookEvent: 'fallback', hookFn: HookFallbackFunction, priority?: number): Promise<void>;
     getSessionController(ctx: LambderRenderContext): {
         startSession: (userKey: string, data?: any, ttlInSeconds?: number) => Promise<LambderSessionContext>;
-        editSession: (newData: any) => Promise<LambderSessionContext>;
+        updateSessionData: (newData: any) => Promise<LambderSessionContext>;
         deleteSession: () => Promise<void>;
         deleteSessionAll: () => Promise<void>;
     };

package/dist/Lambder.js

@@ -60,7 +60,7 @@ export default class Lambder {
         };
         this.utils = new LambderUtils({ ejsPath });
     }
-    enableCORS(isCorsEnabled) {
+    setIsCorsEnabled(isCorsEnabled) {
         this.isCorsEnabled = isCorsEnabled;
     }
     enableDdbSession({ tableName, tableRegion, sessionSalt }, { partitionKey, sortKey } = { partitionKey: "pk", sortKey: "sk" }) {
@@ -221,12 +221,12 @@ export default class Lambder {
                 ctx.session = await this.lambderSession.createSession(userKey, data, ttlInSeconds);
                 return ctx.session;
             },
-            editSession: async (newData) => {
+            updateSessionData: async (newData) => {
                 if (!this.lambderSession)
                     throw "Session is not enabled. Use lambder.enableDdbSession(...) to configure.";
                 if (!ctx.session)
                     throw "Session not found.";
-                ctx.session = await this.lambderSession.editSession(ctx.session, newData);
+                ctx.session = await this.lambderSession.updateSessionData(ctx.session, newData);
                 return ctx.session;
             },
             deleteSession: async () => {

package/dist/LambderSession.d.ts

@@ -28,7 +28,7 @@ export default class LambderSession {
     private ddbQueryAllByPartitionKey;
     private ddbDeleteAllByPartitionKey;
     createSession(userKey: string, data?: any, ttlInSeconds?: number): Promise<LambderSessionContext>;
-    editSession(session: LambderSessionContext, newData?: any): Promise<LambderSessionContext>;
+    updateSessionData(session: LambderSessionContext, newData?: any): Promise<LambderSessionContext>;
     getSession(sessionToken: string): Promise<LambderSessionContext | null>;
     isSessionValid(session: any, sessionToken: any, csrfToken: any, skipCsrfTokenCheck?: boolean): boolean;
     deleteSession(session: Record<string, any>): Promise<boolean>;

package/dist/LambderSession.js

@@ -80,7 +80,7 @@ export default class LambderSession {
         await this.ddbPutItem(session);
         return session;
     }
-    async editSession(session, newData) {
+    async updateSessionData(session, newData) {
         if (!session)
             throw "Invalid session";
         session.data = newData;

package/package.json

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

package/src/Lambder.ts

@@ -96,7 +96,7 @@ export default class Lambder {
     
     constructor(
         { publicPath, apiPath, ejsPath, apiVersion }: 
-        { publicPath: string, apiPath?: string, ejsPath?: string, apiVersion?: string, isCorsEnabled?: boolean, }
+        { publicPath: string, apiPath?: string, ejsPath?: string, apiVersion?: string }
     ){
         this.publicPath = publicPath || "/incorrect-path-not-found";
         this.ejsPath = ejsPath || "/incorrect-ejs-path-not-found";
@@ -113,7 +113,7 @@ export default class Lambder {
         this.utils = new LambderUtils({ ejsPath });
     }
 
-    enableCORS(isCorsEnabled: boolean){
+    setIsCorsEnabled(isCorsEnabled: boolean){
         this.isCorsEnabled = isCorsEnabled;
     }
 
@@ -295,10 +295,10 @@ export default class Lambder {
                 ctx.session = await this.lambderSession.createSession(userKey, data, ttlInSeconds);
                 return ctx.session;
             },
-            editSession: async (newData: any): Promise<LambderSessionContext> => {
+            updateSessionData: async (newData: any): Promise<LambderSessionContext> => {
                 if(!this.lambderSession) throw "Session is not enabled. Use lambder.enableDdbSession(...) to configure.";
                 if(!ctx.session) throw "Session not found.";
-                ctx.session = await this.lambderSession.editSession(ctx.session, newData);
+                ctx.session = await this.lambderSession.updateSessionData(ctx.session, newData);
                 return ctx.session;
             },
             deleteSession: async () => {

package/src/LambderSession.ts

@@ -116,7 +116,7 @@ export default class LambderSession{
         return session;
     }
 
-    public async editSession(
+    public async updateSessionData(
         session: LambderSessionContext,
         newData?: any
     ): Promise<LambderSessionContext> {