@usageflow/express 0.1.0 → 0.1.2

package/README.md

@@ -0,0 +1,90 @@
+# @usageflow/express
+
+Express.js middleware for UsageFlow API tracking. Easily monitor and analyze your Express.js API usage.
+
+⚠️ **Beta Version Notice**: This package is currently in beta. Early adopters may encounter issues. We appreciate your feedback and contributions!
+
+## Installation
+
+```bash
+npm install @usageflow/express
+```
+
+## Quick Start
+
+```javascript
+const express = require("express");
+const { ExpressUsageFlowAPI } = require("@usageflow/express");
+
+const app = express();
+app.use(express.json());
+
+// Initialize UsageFlow
+const usageFlow = new ExpressUsageFlowAPI();
+usageFlow.init("YOUR_API_KEY");
+
+// Create middleware
+const middleware = usageFlow.createMiddleware(
+  [
+    { method: "*", url: "*" }, // Track all routes
+  ],
+  [
+    { method: "GET", url: "/api/health" }, // Whitelist health check
+  ],
+);
+
+// Apply middleware
+app.use(middleware);
+
+// Your routes
+app.get("/api/users", (req, res) => {
+  res.json({ users: ["John", "Jane"] });
+});
+
+app.listen(3000, () => {
+  console.log("Server running on port 3000");
+});
+```
+
+## TypeScript Support
+
+```typescript
+import express from "express";
+import { ExpressUsageFlowAPI } from "@usageflow/express";
+
+const app = express();
+app.use(express.json());
+
+const usageFlow = new ExpressUsageFlowAPI();
+usageFlow.init("YOUR_API_KEY");
+
+// Rest of the code remains the same
+```
+
+## Configuration Options
+
+```typescript
+interface Route {
+    method: string;  // HTTP method or '*' for all methods
+    url: string;     // URL pattern or '*' for all URLs
+}
+
+usageFlow.createMiddleware(
+    routes: Route[],           // Routes to track
+    whitelistRoutes?: Route[] // Routes to exclude from tracking
+);
+```
+
+## Beta Status
+
+This is a beta release meant for early adopters. You may encounter:
+
+- API changes in future versions
+- Incomplete features
+- Potential bugs
+
+We're actively working on improvements and appreciate your feedback!
+
+## License
+
+MIT

package/dist/plugin.d.ts

@@ -1,5 +1,5 @@
-import { Request, Response, NextFunction } from 'express';
-import { UsageFlowAPI, Route, RequestMetadata } from '@usageflow/core';
+import { Request, Response, NextFunction } from "express";
+import { UsageFlowAPI, Route, RequestMetadata } from "@usageflow/core";
 declare global {
     namespace Express {
         interface Request {

package/dist/plugin.js

@@ -7,42 +7,42 @@ class ExpressUsageFlowAPI extends core_1.UsageFlowAPI {
         const headers = this.sanitizeHeaders(request.headers);
         // Get client IP, handling forwarded headers
         let clientIP = request.ip;
-        const forwardedFor = request.headers['x-forwarded-for'];
-        if (forwardedFor && typeof forwardedFor === 'string') {
-            clientIP = forwardedFor.split(',')[0].trim();
+        const forwardedFor = request.headers["x-forwarded-for"];
+        if (forwardedFor && typeof forwardedFor === "string") {
+            clientIP = forwardedFor.split(",")[0].trim();
         }
         const metadata = {
             method: request.method,
-            url: request.route?.path || request.path || request.url || '/',
-            rawUrl: request.originalUrl || '/',
-            clientIP: request.ip || 'unknown',
-            userAgent: request.headers['user-agent'],
+            url: request.route?.path || request.path || request.url || "/",
+            rawUrl: request.originalUrl || "/",
+            clientIP: request.ip || "unknown",
+            userAgent: request.headers["user-agent"],
             timestamp: new Date().toISOString(),
             headers,
             queryParams: request.query,
             pathParams: request.params,
-            body: request.body
+            body: request.body,
         };
         return metadata;
     }
     async executeRequestWithMetadata(ledgerId, metadata, request, response) {
         if (!this.apiKey) {
-            throw new Error('API key not initialized');
+            throw new Error("API key not initialized");
         }
         const headers = {
-            'x-usage-key': this.apiKey,
-            'Content-Type': 'application/json'
+            "x-usage-key": this.apiKey,
+            "Content-Type": "application/json",
         };
         const payload = {
             alias: ledgerId,
             amount: 1,
-            metadata
+            metadata,
         };
         try {
             const response = await fetch(`${this.usageflowUrl}/api/v1/ledgers/measure/allocate`, {
-                method: 'POST',
+                method: "POST",
                 headers,
-                body: JSON.stringify(payload)
+                body: JSON.stringify(payload),
             });
             const data = await response.json();
             if (response.status === 400) {
@@ -53,12 +53,13 @@ class ExpressUsageFlowAPI extends core_1.UsageFlowAPI {
                 request.usageflow.metadata = metadata;
             }
             else {
-                throw new Error(data.message || 'Unknown error occurred');
+                throw new Error(data.message || "Unknown error occurred");
             }
         }
         catch (error) {
-            if (error.message == 'Failed to use resource after retries: Faile to preform operation') {
-                throw new Error('Failed to allocate resource');
+            if (error.message ==
+                "Failed to use resource after retries: Faile to preform operation") {
+                throw new Error("Failed to allocate resource");
             }
             throw error;
         }
@@ -71,12 +72,12 @@ class ExpressUsageFlowAPI extends core_1.UsageFlowAPI {
             const method = request.method;
             const url = request.route?.path || request.path || request.url;
             request.usageflow = {
-                startTime: Date.now()
+                startTime: Date.now(),
             };
-            if (this.shouldSkipRoute(method, url || '', whitelistMap)) {
+            if (this.shouldSkipRoute(method, url || "", whitelistMap)) {
                 return next();
             }
-            if (!this.shouldMonitorRoute(method, url || '', routesMap)) {
+            if (!this.shouldMonitorRoute(method, url || "", routesMap)) {
                 return next();
             }
             const metadata = await this.collectRequestMetadata(request);
@@ -86,14 +87,14 @@ class ExpressUsageFlowAPI extends core_1.UsageFlowAPI {
                 const originalEnd = response.end;
                 response.end = function (chunk, encoding, cb) {
                     if (!request.usageflow?.eventId) {
-                        return originalEnd.call(this, chunk, encoding || 'utf8', cb);
+                        return originalEnd.call(this, chunk, encoding || "utf8", cb);
                     }
                     const metadata = request.usageflow?.metadata || {};
                     metadata.responseStatusCode = response.statusCode;
                     // Add response body to metadata if it exists
                     if (chunk) {
                         try {
-                            if (typeof chunk === 'string') {
+                            if (typeof chunk === "string") {
                                 // Try to parse as JSON if it's a string
                                 try {
                                     const parsed = JSON.parse(chunk);
@@ -105,7 +106,7 @@ class ExpressUsageFlowAPI extends core_1.UsageFlowAPI {
                                 }
                             }
                             else if (Buffer.isBuffer(chunk)) {
-                                const str = chunk.toString('utf8');
+                                const str = chunk.toString("utf8");
                                 // Try to parse as JSON if it's a buffer
                                 try {
                                     const parsed = JSON.parse(str);
@@ -116,47 +117,47 @@ class ExpressUsageFlowAPI extends core_1.UsageFlowAPI {
                                     metadata.body = str;
                                 }
                             }
-                            else if (typeof chunk === 'object') {
+                            else if (typeof chunk === "object") {
                                 metadata.body = chunk;
                             }
                         }
                         catch (error) {
-                            console.error('Error parsing response body:', error);
+                            console.error("Error parsing response body:", error);
                         }
                     }
                     const headers = {
-                        'x-usage-key': self.apiKey,
-                        'Content-Type': 'application/json'
+                        "x-usage-key": self.apiKey,
+                        "Content-Type": "application/json",
                     };
                     const payload = {
-                        alias: `${request.method} ${request.route?.path || request.path || request.url || '/'}`,
+                        alias: `${request.method} ${request.route?.path || request.path || request.url || "/"}`,
                         amount: 1,
                         allocationId: request.usageflow?.eventId,
-                        metadata
+                        metadata,
                     };
                     fetch(`${self.usageflowUrl}/api/v1/ledgers/measure/allocate/use`, {
-                        method: 'POST',
+                        method: "POST",
                         headers,
-                        body: JSON.stringify(payload)
-                    }).catch(error => {
-                        console.error('Error finalizing request:', error);
+                        body: JSON.stringify(payload),
+                    }).catch((error) => {
+                        console.error("Error finalizing request:", error);
                     });
                     // Handle the different overloads
-                    if (typeof chunk === 'function') {
-                        return originalEnd.call(this, undefined, 'utf8', chunk);
+                    if (typeof chunk === "function") {
+                        return originalEnd.call(this, undefined, "utf8", chunk);
                     }
-                    if (typeof encoding === 'function') {
-                        return originalEnd.call(this, chunk, 'utf8', encoding);
+                    if (typeof encoding === "function") {
+                        return originalEnd.call(this, chunk, "utf8", encoding);
                     }
-                    return originalEnd.call(this, chunk, encoding || 'utf8', cb);
+                    return originalEnd.call(this, chunk, encoding || "utf8", cb);
                 };
                 next();
             }
             catch (error) {
-                console.error('Error executing request with metadata:', error);
+                console.error("Error executing request with metadata:", error);
                 response.status(400).json({
                     message: error.message,
-                    blocked: true
+                    blocked: true,
                 });
                 return;
             }
@@ -164,5 +165,4 @@ class ExpressUsageFlowAPI extends core_1.UsageFlowAPI {
     }
 }
 exports.ExpressUsageFlowAPI = ExpressUsageFlowAPI;
-;
 //# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":";;;AACA,0CAAuE;AAcvE,MAAa,mBAAoB,SAAQ,mBAAY;IACzC,KAAK,CAAC,sBAAsB,CAAC,OAAgB;QACjD,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,OAAiC,CAAC,CAAC;QAEhF,4CAA4C;QAC5C,IAAI,QAAQ,GAAG,OAAO,CAAC,EAAE,CAAC;QAC1B,MAAM,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACxD,IAAI,YAAY,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;YACnD,QAAQ,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACjD,CAAC;QAED,MAAM,QAAQ,GAAoB;YAC9B,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,GAAG,EAAE,OAAO,CAAC,KAAK,EAAE,IAAI,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,IAAI,GAAG;YAC9D,MAAM,EAAE,OAAO,CAAC,WAAW,IAAI,GAAG;YAClC,QAAQ,EAAE,OAAO,CAAC,EAAE,IAAI,SAAS;YACjC,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,YAAY,CAAW;YAClD,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACnC,OAAO;YACP,WAAW,EAAE,OAAO,CAAC,KAA4B;YACjD,UAAU,EAAE,OAAO,CAAC,MAAM;YAC1B,IAAI,EAAE,OAAO,CAAC,IAAI;SACrB,CAAC;QAEF,OAAO,QAAQ,CAAC;IACpB,CAAC;IAEO,KAAK,CAAC,0BAA0B,CACpC,QAAgB,EAChB,QAAyB,EACzB,OAAgB,EAChB,QAAkB;QAElB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC/C,CAAC;QAED,MAAM,OAAO,GAAG;YACZ,aAAa,EAAE,IAAI,CAAC,MAAM;YAC1B,cAAc,EAAE,kBAAkB;SACrC,CAAC;QAEF,MAAM,OAAO,GAAG;YACZ,KAAK,EAAE,QAAQ;YACf,MAAM,EAAE,CAAC;YACT,QAAQ;SACX,CAAC;QAEF,IAAI,CAAC;YACD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,YAAY,kCAAkC,EAAE;gBACjF,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;aAChC,CAAC,CAAC;YAEH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YAEnC,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC1B,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAClC,CAAC;YAED,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACd,OAAO,CAAC,SAAU,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;gBAC1C,OAAO,CAAC,SAAU,CAAC,QAAQ,GAAG,QAAQ,CAAC;YAC3C,CAAC;iBAAM,CAAC;gBACJ,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,wBAAwB,CAAC,CAAC;YAC9D,CAAC;QACL,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YAClB,IAAI,KAAK,CAAC,OAAO,IAAI,kEAAkE,EAAE,CAAC;gBACtF,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;YACnD,CAAC;YACD,MAAM,KAAK,CAAC;QAChB,CAAC;IACL,CAAC;IAEM,gBAAgB,CAAC,MAAe,EAAE,kBAA2B,EAAE;QAClE,MAAM,SAAS,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAC/C,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC;QAC3D,MAAM,IAAI,GAAG,IAAI,CAAC;QAElB,OAAO,KAAK,EAAE,OAAgB,EAAE,QAAkB,EAAE,IAAkB,EAAE,EAAE;YACtE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YAC9B,MAAM,GAAG,GAAG,OAAO,CAAC,KAAK,EAAE,IAAI,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC;YAE/D,OAAO,CAAC,SAAS,GAAG;gBAChB,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;aACxB,CAAC;YAEF,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,EAAE,YAAY,CAAC,EAAE,CAAC;gBACxD,OAAO,IAAI,EAAE,CAAC;YAClB,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,EAAE,SAAS,CAAC,EAAE,CAAC;gBACzD,OAAO,IAAI,EAAE,CAAC;YAClB,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;YAE5D,IAAI,CAAC;gBACD,MAAM,IAAI,CAAC,0BAA0B,CACjC,GAAG,MAAM,IAAI,GAAG,EAAE,EAClB,QAAQ,EACR,OAAO,EACP,QAAQ,CACX,CAAC;gBAEF,wBAAwB;gBACxB,MAAM,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC;gBACjC,QAAQ,CAAC,GAAG,GAAG,UAA0B,KAAW,EAAE,QAAyB,EAAE,EAAe;oBAC5F,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,EAAE,CAAC;wBAC9B,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,IAAI,MAAM,EAAE,EAAE,CAAC,CAAC;oBACjE,CAAC;oBAED,MAAM,QAAQ,GAAG,OAAO,CAAC,SAAS,EAAE,QAAQ,IAAI,EAAE,CAAC;oBAClD,QAAgB,CAAC,kBAAkB,GAAG,QAAQ,CAAC,UAAU,CAAC;oBAE3D,6CAA6C;oBAC7C,IAAI,KAAK,EAAE,CAAC;wBACR,IAAI,CAAC;4BACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gCAC5B,wCAAwC;gCACxC,IAAI,CAAC;oCACD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;oCAChC,QAAgB,CAAC,IAAI,GAAG,MAAM,CAAC;gCACpC,CAAC;gCAAC,MAAM,CAAC;oCACL,0CAA0C;oCACzC,QAAgB,CAAC,IAAI,GAAG,KAAK,CAAC;gCACnC,CAAC;4BACL,CAAC;iCAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gCAChC,MAAM,GAAG,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;gCACnC,wCAAwC;gCACxC,IAAI,CAAC;oCACD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oCAC9B,QAAgB,CAAC,IAAI,GAAG,MAAM,CAAC;gCACpC,CAAC;gCAAC,MAAM,CAAC;oCACL,0CAA0C;oCACzC,QAAgB,CAAC,IAAI,GAAG,GAAG,CAAC;gCACjC,CAAC;4BACL,CAAC;iCAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gCAClC,QAAgB,CAAC,IAAI,GAAG,KAAK,CAAC;4BACnC,CAAC;wBACL,CAAC;wBAAC,OAAO,KAAK,EAAE,CAAC;4BACb,OAAO,CAAC,KAAK,CAAC,8BAA8B,EAAE,KAAK,CAAC,CAAC;wBACzD,CAAC;oBACL,CAAC;oBAID,MAAM,OAAO,GAAG;wBACZ,aAAa,EAAE,IAAI,CAAC,MAAO;wBAC3B,cAAc,EAAE,kBAAkB;qBACrC,CAAC;oBAEF,MAAM,OAAO,GAAG;wBACZ,KAAK,EAAE,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,KAAK,EAAE,IAAI,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,IAAI,GAAG,EAAE;wBACvF,MAAM,EAAE,CAAC;wBACT,YAAY,EAAE,OAAO,CAAC,SAAS,EAAE,OAAO;wBACxC,QAAQ;qBACX,CAAC;oBAEF,KAAK,CAAC,GAAG,IAAI,CAAC,YAAY,sCAAsC,EAAE;wBAC9D,MAAM,EAAE,MAAM;wBACd,OAAO;wBACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;qBAChC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;wBACb,OAAO,CAAC,KAAK,CAAC,2BAA2B,EAAE,KAAK,CAAC,CAAC;oBACtD,CAAC,CAAC,CAAC;oBAEH,iCAAiC;oBACjC,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;wBAC9B,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;oBAC5D,CAAC;oBACD,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE,CAAC;wBACjC,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;oBAC3D,CAAC;oBACD,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,IAAI,MAAM,EAAE,EAAE,CAAC,CAAC;gBACjE,CAAwB,CAAC;gBAEzB,IAAI,EAAE,CAAC;YACX,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBAClB,OAAO,CAAC,KAAK,CAAC,wCAAwC,EAAE,KAAK,CAAC,CAAC;gBAC/D,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBACtB,OAAO,EAAE,KAAK,CAAC,OAAO;oBACtB,OAAO,EAAE,IAAI;iBAChB,CAAC,CAAC;gBACH,OAAO;YACX,CAAC;QACL,CAAC,CAAC;IACN,CAAC;CACJ;AA7LD,kDA6LC;AAAA,CAAC"}
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":";;;AACA,0CAAuE;AAcvE,MAAa,mBAAoB,SAAQ,mBAAY;IAC3C,KAAK,CAAC,sBAAsB,CAClC,OAAgB;QAEhB,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAClC,OAAO,CAAC,OAAiC,CAC1C,CAAC;QAEF,4CAA4C;QAC5C,IAAI,QAAQ,GAAG,OAAO,CAAC,EAAE,CAAC;QAC1B,MAAM,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACxD,IAAI,YAAY,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;YACrD,QAAQ,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC/C,CAAC;QAED,MAAM,QAAQ,GAAoB;YAChC,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,GAAG,EAAE,OAAO,CAAC,KAAK,EAAE,IAAI,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,IAAI,GAAG;YAC9D,MAAM,EAAE,OAAO,CAAC,WAAW,IAAI,GAAG;YAClC,QAAQ,EAAE,OAAO,CAAC,EAAE,IAAI,SAAS;YACjC,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,YAAY,CAAW;YAClD,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACnC,OAAO;YACP,WAAW,EAAE,OAAO,CAAC,KAA4B;YACjD,UAAU,EAAE,OAAO,CAAC,MAAM;YAC1B,IAAI,EAAE,OAAO,CAAC,IAAI;SACnB,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEO,KAAK,CAAC,0BAA0B,CACtC,QAAgB,EAChB,QAAyB,EACzB,OAAgB,EAChB,QAAkB;QAElB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,CAAC;QAED,MAAM,OAAO,GAAG;YACd,aAAa,EAAE,IAAI,CAAC,MAAM;YAC1B,cAAc,EAAE,kBAAkB;SACnC,CAAC;QAEF,MAAM,OAAO,GAAG;YACd,KAAK,EAAE,QAAQ;YACf,MAAM,EAAE,CAAC;YACT,QAAQ;SACT,CAAC;QAEF,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAC1B,GAAG,IAAI,CAAC,YAAY,kCAAkC,EACtD;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;aAC9B,CACF,CAAC;YAEF,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YAEnC,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC5B,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAChC,CAAC;YAED,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;gBAChB,OAAO,CAAC,SAAU,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;gBAC1C,OAAO,CAAC,SAAU,CAAC,QAAQ,GAAG,QAAQ,CAAC;YACzC,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,wBAAwB,CAAC,CAAC;YAC5D,CAAC;QACH,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,IACE,KAAK,CAAC,OAAO;gBACb,kEAAkE,EAClE,CAAC;gBACD,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;YACjD,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAEM,gBAAgB,CAAC,MAAe,EAAE,kBAA2B,EAAE;QACpE,MAAM,SAAS,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAC/C,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC;QAC3D,MAAM,IAAI,GAAG,IAAI,CAAC;QAElB,OAAO,KAAK,EAAE,OAAgB,EAAE,QAAkB,EAAE,IAAkB,EAAE,EAAE;YACxE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YAC9B,MAAM,GAAG,GAAG,OAAO,CAAC,KAAK,EAAE,IAAI,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC;YAE/D,OAAO,CAAC,SAAS,GAAG;gBAClB,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;aACtB,CAAC;YAEF,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,EAAE,YAAY,CAAC,EAAE,CAAC;gBAC1D,OAAO,IAAI,EAAE,CAAC;YAChB,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,EAAE,SAAS,CAAC,EAAE,CAAC;gBAC3D,OAAO,IAAI,EAAE,CAAC;YAChB,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;YAE5D,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,0BAA0B,CACnC,GAAG,MAAM,IAAI,GAAG,EAAE,EAClB,QAAQ,EACR,OAAO,EACP,QAAQ,CACT,CAAC;gBAEF,wBAAwB;gBACxB,MAAM,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC;gBACjC,QAAQ,CAAC,GAAG,GAAG,UAEb,KAAW,EACX,QAAyB,EACzB,EAAe;oBAEf,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,EAAE,CAAC;wBAChC,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,IAAI,MAAM,EAAE,EAAE,CAAC,CAAC;oBAC/D,CAAC;oBAED,MAAM,QAAQ,GAAG,OAAO,CAAC,SAAS,EAAE,QAAQ,IAAI,EAAE,CAAC;oBAClD,QAAgB,CAAC,kBAAkB,GAAG,QAAQ,CAAC,UAAU,CAAC;oBAE3D,6CAA6C;oBAC7C,IAAI,KAAK,EAAE,CAAC;wBACV,IAAI,CAAC;4BACH,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gCAC9B,wCAAwC;gCACxC,IAAI,CAAC;oCACH,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;oCAChC,QAAgB,CAAC,IAAI,GAAG,MAAM,CAAC;gCAClC,CAAC;gCAAC,MAAM,CAAC;oCACP,0CAA0C;oCACzC,QAAgB,CAAC,IAAI,GAAG,KAAK,CAAC;gCACjC,CAAC;4BACH,CAAC;iCAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gCAClC,MAAM,GAAG,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;gCACnC,wCAAwC;gCACxC,IAAI,CAAC;oCACH,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oCAC9B,QAAgB,CAAC,IAAI,GAAG,MAAM,CAAC;gCAClC,CAAC;gCAAC,MAAM,CAAC;oCACP,0CAA0C;oCACzC,QAAgB,CAAC,IAAI,GAAG,GAAG,CAAC;gCAC/B,CAAC;4BACH,CAAC;iCAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gCACpC,QAAgB,CAAC,IAAI,GAAG,KAAK,CAAC;4BACjC,CAAC;wBACH,CAAC;wBAAC,OAAO,KAAK,EAAE,CAAC;4BACf,OAAO,CAAC,KAAK,CAAC,8BAA8B,EAAE,KAAK,CAAC,CAAC;wBACvD,CAAC;oBACH,CAAC;oBAED,MAAM,OAAO,GAAG;wBACd,aAAa,EAAE,IAAI,CAAC,MAAO;wBAC3B,cAAc,EAAE,kBAAkB;qBACnC,CAAC;oBAEF,MAAM,OAAO,GAAG;wBACd,KAAK,EAAE,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,KAAK,EAAE,IAAI,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,IAAI,GAAG,EAAE;wBACvF,MAAM,EAAE,CAAC;wBACT,YAAY,EAAE,OAAO,CAAC,SAAS,EAAE,OAAO;wBACxC,QAAQ;qBACT,CAAC;oBAEF,KAAK,CAAC,GAAG,IAAI,CAAC,YAAY,sCAAsC,EAAE;wBAChE,MAAM,EAAE,MAAM;wBACd,OAAO;wBACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;qBAC9B,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;wBACjB,OAAO,CAAC,KAAK,CAAC,2BAA2B,EAAE,KAAK,CAAC,CAAC;oBACpD,CAAC,CAAC,CAAC;oBAEH,iCAAiC;oBACjC,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;wBAChC,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;oBAC1D,CAAC;oBACD,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE,CAAC;wBACnC,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;oBACzD,CAAC;oBACD,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,IAAI,MAAM,EAAE,EAAE,CAAC,CAAC;gBAC/D,CAAwB,CAAC;gBAEzB,IAAI,EAAE,CAAC;YACT,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBACpB,OAAO,CAAC,KAAK,CAAC,wCAAwC,EAAE,KAAK,CAAC,CAAC;gBAC/D,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBACxB,OAAO,EAAE,KAAK,CAAC,OAAO;oBACtB,OAAO,EAAE,IAAI;iBACd,CAAC,CAAC;gBACH,OAAO;YACT,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF;AA1MD,kDA0MC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usageflow/express",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "UsageFlow plugin for Express applications",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -10,9 +10,15 @@
     "prepare": "npm run build"
   },
   "dependencies": {
-    "@usageflow/core": "^0.1.0",
+    "@usageflow/core": "^0.1.2",
     "express": "^4.18.0"
   },
+  "homepage": "https://usageflow.io",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/usageflow/js-mongorepo.git",
+    "directory": "packages/express"
+  },
   "devDependencies": {
     "@types/express": "^4.17.0",
     "@types/node": "^20.0.0",

package/src/plugin.ts

@@ -1,205 +1,218 @@
-import { Request, Response, NextFunction } from 'express';
-import { UsageFlowAPI, Route, RequestMetadata } from '@usageflow/core';
+import { Request, Response, NextFunction } from "express";
+import { UsageFlowAPI, Route, RequestMetadata } from "@usageflow/core";
 
 declare global {
-    namespace Express {
-        interface Request {
-            usageflow?: {
-                startTime: number;
-                eventId?: string;
-                metadata?: RequestMetadata;
-            };
-        }
+  namespace Express {
+    interface Request {
+      usageflow?: {
+        startTime: number;
+        eventId?: string;
+        metadata?: RequestMetadata;
+      };
     }
+  }
 }
 
 export class ExpressUsageFlowAPI extends UsageFlowAPI {
-    private async collectRequestMetadata(request: Request): Promise<RequestMetadata> {
-        const headers = this.sanitizeHeaders(request.headers as Record<string, string>);
-
-        // Get client IP, handling forwarded headers
-        let clientIP = request.ip;
-        const forwardedFor = request.headers['x-forwarded-for'];
-        if (forwardedFor && typeof forwardedFor === 'string') {
-            clientIP = forwardedFor.split(',')[0].trim();
-        }
-
-        const metadata: RequestMetadata = {
-            method: request.method,
-            url: request.route?.path || request.path || request.url || '/',
-            rawUrl: request.originalUrl || '/',
-            clientIP: request.ip || 'unknown',
-            userAgent: request.headers['user-agent'] as string,
-            timestamp: new Date().toISOString(),
-            headers,
-            queryParams: request.query as Record<string, any>,
-            pathParams: request.params,
-            body: request.body
-        };
-
-        return metadata;
+  private async collectRequestMetadata(
+    request: Request,
+  ): Promise<RequestMetadata> {
+    const headers = this.sanitizeHeaders(
+      request.headers as Record<string, string>,
+    );
+
+    // Get client IP, handling forwarded headers
+    let clientIP = request.ip;
+    const forwardedFor = request.headers["x-forwarded-for"];
+    if (forwardedFor && typeof forwardedFor === "string") {
+      clientIP = forwardedFor.split(",")[0].trim();
     }
 
-    private async executeRequestWithMetadata(
-        ledgerId: string,
-        metadata: RequestMetadata,
-        request: Request,
-        response: Response
-    ): Promise<void> {
-        if (!this.apiKey) {
-            throw new Error('API key not initialized');
-        }
-
-        const headers = {
-            'x-usage-key': this.apiKey,
-            'Content-Type': 'application/json'
-        };
-
-        const payload = {
-            alias: ledgerId,
-            amount: 1,
-            metadata
-        };
-
-        try {
-            const response = await fetch(`${this.usageflowUrl}/api/v1/ledgers/measure/allocate`, {
-                method: 'POST',
-                headers,
-                body: JSON.stringify(payload)
-            });
-
-            const data = await response.json();
-
-            if (response.status === 400) {
-                throw new Error(data.message);
-            }
-
-            if (response.ok) {
-                request.usageflow!.eventId = data.eventId;
-                request.usageflow!.metadata = metadata;
-            } else {
-                throw new Error(data.message || 'Unknown error occurred');
-            }
-        } catch (error: any) {
-            if (error.message == 'Failed to use resource after retries: Faile to preform operation') {
-                throw new Error('Failed to allocate resource');
-            }
-            throw error;
-        }
+    const metadata: RequestMetadata = {
+      method: request.method,
+      url: request.route?.path || request.path || request.url || "/",
+      rawUrl: request.originalUrl || "/",
+      clientIP: request.ip || "unknown",
+      userAgent: request.headers["user-agent"] as string,
+      timestamp: new Date().toISOString(),
+      headers,
+      queryParams: request.query as Record<string, any>,
+      pathParams: request.params,
+      body: request.body,
+    };
+
+    return metadata;
+  }
+
+  private async executeRequestWithMetadata(
+    ledgerId: string,
+    metadata: RequestMetadata,
+    request: Request,
+    response: Response,
+  ): Promise<void> {
+    if (!this.apiKey) {
+      throw new Error("API key not initialized");
     }
 
-    public createMiddleware(routes: Route[], whitelistRoutes: Route[] = []) {
-        const routesMap = this.createRoutesMap(routes);
-        const whitelistMap = this.createRoutesMap(whitelistRoutes);
-        const self = this;
-
-        return async (request: Request, response: Response, next: NextFunction) => {
-            const method = request.method;
-            const url = request.route?.path || request.path || request.url;
-
-            request.usageflow = {
-                startTime: Date.now()
-            };
-
-            if (this.shouldSkipRoute(method, url || '', whitelistMap)) {
-                return next();
+    const headers = {
+      "x-usage-key": this.apiKey,
+      "Content-Type": "application/json",
+    };
+
+    const payload = {
+      alias: ledgerId,
+      amount: 1,
+      metadata,
+    };
+
+    try {
+      const response = await fetch(
+        `${this.usageflowUrl}/api/v1/ledgers/measure/allocate`,
+        {
+          method: "POST",
+          headers,
+          body: JSON.stringify(payload),
+        },
+      );
+
+      const data = await response.json();
+
+      if (response.status === 400) {
+        throw new Error(data.message);
+      }
+
+      if (response.ok) {
+        request.usageflow!.eventId = data.eventId;
+        request.usageflow!.metadata = metadata;
+      } else {
+        throw new Error(data.message || "Unknown error occurred");
+      }
+    } catch (error: any) {
+      if (
+        error.message ==
+        "Failed to use resource after retries: Faile to preform operation"
+      ) {
+        throw new Error("Failed to allocate resource");
+      }
+      throw error;
+    }
+  }
+
+  public createMiddleware(routes: Route[], whitelistRoutes: Route[] = []) {
+    const routesMap = this.createRoutesMap(routes);
+    const whitelistMap = this.createRoutesMap(whitelistRoutes);
+    const self = this;
+
+    return async (request: Request, response: Response, next: NextFunction) => {
+      const method = request.method;
+      const url = request.route?.path || request.path || request.url;
+
+      request.usageflow = {
+        startTime: Date.now(),
+      };
+
+      if (this.shouldSkipRoute(method, url || "", whitelistMap)) {
+        return next();
+      }
+
+      if (!this.shouldMonitorRoute(method, url || "", routesMap)) {
+        return next();
+      }
+
+      const metadata = await this.collectRequestMetadata(request);
+
+      try {
+        await this.executeRequestWithMetadata(
+          `${method} ${url}`,
+          metadata,
+          request,
+          response,
+        );
+
+        // Capture response data
+        const originalEnd = response.end;
+        response.end = function (
+          this: Response,
+          chunk?: any,
+          encoding?: BufferEncoding,
+          cb?: () => void,
+        ) {
+          if (!request.usageflow?.eventId) {
+            return originalEnd.call(this, chunk, encoding || "utf8", cb);
+          }
+
+          const metadata = request.usageflow?.metadata || {};
+          (metadata as any).responseStatusCode = response.statusCode;
+
+          // Add response body to metadata if it exists
+          if (chunk) {
+            try {
+              if (typeof chunk === "string") {
+                // Try to parse as JSON if it's a string
+                try {
+                  const parsed = JSON.parse(chunk);
+                  (metadata as any).body = parsed;
+                } catch {
+                  // If not valid JSON, use the string as is
+                  (metadata as any).body = chunk;
+                }
+              } else if (Buffer.isBuffer(chunk)) {
+                const str = chunk.toString("utf8");
+                // Try to parse as JSON if it's a buffer
+                try {
+                  const parsed = JSON.parse(str);
+                  (metadata as any).body = parsed;
+                } catch {
+                  // If not valid JSON, use the string as is
+                  (metadata as any).body = str;
+                }
+              } else if (typeof chunk === "object") {
+                (metadata as any).body = chunk;
+              }
+            } catch (error) {
+              console.error("Error parsing response body:", error);
             }
+          }
 
-            if (!this.shouldMonitorRoute(method, url || '', routesMap)) {
-                return next();
-            }
+          const headers = {
+            "x-usage-key": self.apiKey!,
+            "Content-Type": "application/json",
+          };
 
-            const metadata = await this.collectRequestMetadata(request);
+          const payload = {
+            alias: `${request.method} ${request.route?.path || request.path || request.url || "/"}`,
+            amount: 1,
+            allocationId: request.usageflow?.eventId,
+            metadata,
+          };
 
-            try {
-                await this.executeRequestWithMetadata(
-                    `${method} ${url}`,
-                    metadata,
-                    request,
-                    response
-                );
-
-                // Capture response data
-                const originalEnd = response.end;
-                response.end = function (this: Response, chunk?: any, encoding?: BufferEncoding, cb?: () => void) {
-                    if (!request.usageflow?.eventId) {
-                        return originalEnd.call(this, chunk, encoding || 'utf8', cb);
-                    }
-
-                    const metadata = request.usageflow?.metadata || {};
-                    (metadata as any).responseStatusCode = response.statusCode;
-
-                    // Add response body to metadata if it exists
-                    if (chunk) {
-                        try {
-                            if (typeof chunk === 'string') {
-                                // Try to parse as JSON if it's a string
-                                try {
-                                    const parsed = JSON.parse(chunk);
-                                    (metadata as any).body = parsed;
-                                } catch {
-                                    // If not valid JSON, use the string as is
-                                    (metadata as any).body = chunk;
-                                }
-                            } else if (Buffer.isBuffer(chunk)) {
-                                const str = chunk.toString('utf8');
-                                // Try to parse as JSON if it's a buffer
-                                try {
-                                    const parsed = JSON.parse(str);
-                                    (metadata as any).body = parsed;
-                                } catch {
-                                    // If not valid JSON, use the string as is
-                                    (metadata as any).body = str;
-                                }
-                            } else if (typeof chunk === 'object') {
-                                (metadata as any).body = chunk;
-                            }
-                        } catch (error) {
-                            console.error('Error parsing response body:', error);
-                        }
-                    }
-
-
-
-                    const headers = {
-                        'x-usage-key': self.apiKey!,
-                        'Content-Type': 'application/json'
-                    };
-
-                    const payload = {
-                        alias: `${request.method} ${request.route?.path || request.path || request.url || '/'}`,
-                        amount: 1,
-                        allocationId: request.usageflow?.eventId,
-                        metadata
-                    };
-
-                    fetch(`${self.usageflowUrl}/api/v1/ledgers/measure/allocate/use`, {
-                        method: 'POST',
-                        headers,
-                        body: JSON.stringify(payload)
-                    }).catch(error => {
-                        console.error('Error finalizing request:', error);
-                    });
-
-                    // Handle the different overloads
-                    if (typeof chunk === 'function') {
-                        return originalEnd.call(this, undefined, 'utf8', chunk);
-                    }
-                    if (typeof encoding === 'function') {
-                        return originalEnd.call(this, chunk, 'utf8', encoding);
-                    }
-                    return originalEnd.call(this, chunk, encoding || 'utf8', cb);
-                } as typeof response.end;
-
-                next();
-            } catch (error: any) {
-                console.error('Error executing request with metadata:', error);
-                response.status(400).json({
-                    message: error.message,
-                    blocked: true
-                });
-                return;
-            }
-        };
-    }
-};
+          fetch(`${self.usageflowUrl}/api/v1/ledgers/measure/allocate/use`, {
+            method: "POST",
+            headers,
+            body: JSON.stringify(payload),
+          }).catch((error) => {
+            console.error("Error finalizing request:", error);
+          });
+
+          // Handle the different overloads
+          if (typeof chunk === "function") {
+            return originalEnd.call(this, undefined, "utf8", chunk);
+          }
+          if (typeof encoding === "function") {
+            return originalEnd.call(this, chunk, "utf8", encoding);
+          }
+          return originalEnd.call(this, chunk, encoding || "utf8", cb);
+        } as typeof response.end;
+
+        next();
+      } catch (error: any) {
+        console.error("Error executing request with metadata:", error);
+        response.status(400).json({
+          message: error.message,
+          blocked: true,
+        });
+        return;
+      }
+    };
+  }
+}