@usageflow/express 0.1.2 → 0.1.5

package/dist/plugin.d.ts

@@ -15,4 +15,5 @@ export declare class ExpressUsageFlowAPI extends UsageFlowAPI {
     private collectRequestMetadata;
     private executeRequestWithMetadata;
     createMiddleware(routes: Route[], whitelistRoutes?: Route[]): (request: Request, response: Response, next: NextFunction) => Promise<void>;
+    protected guessLedgerId(request: Request): string;
 }

package/dist/plugin.js

@@ -15,12 +15,12 @@ class ExpressUsageFlowAPI extends core_1.UsageFlowAPI {
             method: request.method,
             url: request.route?.path || request.path || request.url || "/",
             rawUrl: request.originalUrl || "/",
-            clientIP: request.ip || "unknown",
+            clientIP: clientIP || "unknown",
             userAgent: request.headers["user-agent"],
             timestamp: new Date().toISOString(),
             headers,
-            queryParams: request.query,
-            pathParams: request.params,
+            queryParams: Object.keys(request.query).length > 0 ? request.query : null,
+            pathParams: Object.keys(request.params).length > 0 ? request.params : null,
             body: request.body,
         };
         return metadata;
@@ -81,8 +81,9 @@ class ExpressUsageFlowAPI extends core_1.UsageFlowAPI {
                 return next();
             }
             const metadata = await this.collectRequestMetadata(request);
+            let ledgerId = this.guessLedgerId(request);
             try {
-                await this.executeRequestWithMetadata(`${method} ${url}`, metadata, request, response);
+                await this.executeRequestWithMetadata(ledgerId, metadata, request, response);
                 // Capture response data
                 const originalEnd = response.end;
                 response.end = function (chunk, encoding, cb) {
@@ -129,8 +130,12 @@ class ExpressUsageFlowAPI extends core_1.UsageFlowAPI {
                         "x-usage-key": self.apiKey,
                         "Content-Type": "application/json",
                     };
+                    if (request.usageflow?.startTime) {
+                        metadata.requestDuration =
+                            Date.now() - request.usageflow.startTime;
+                    }
                     const payload = {
-                        alias: `${request.method} ${request.route?.path || request.path || request.url || "/"}`,
+                        alias: ledgerId,
                         amount: 1,
                         allocationId: request.usageflow?.eventId,
                         metadata,
@@ -142,7 +147,7 @@ class ExpressUsageFlowAPI extends core_1.UsageFlowAPI {
                     }).catch((error) => {
                         console.error("Error finalizing request:", error);
                     });
-                    // Handle the different overloads
+                    // Handle the different overloadsx
                     if (typeof chunk === "function") {
                         return originalEnd.call(this, undefined, "utf8", chunk);
                     }
@@ -163,6 +168,44 @@ class ExpressUsageFlowAPI extends core_1.UsageFlowAPI {
             }
         };
     }
+    guessLedgerId(request) {
+        const method = request.method;
+        const url = request.route?.path || request.path;
+        const config = this.apiConfig;
+        if (!config?.identityFieldName || !config?.identityFieldLocation) {
+            return `${method} ${url}`;
+        }
+        const fieldName = config.identityFieldName;
+        const location = config.identityFieldLocation;
+        switch (location) {
+            case "path_params":
+                if (request.params?.[fieldName]) {
+                    return `${method} ${url} ${request.params[fieldName]}`;
+                }
+                break;
+            case "query_params":
+                if (request.query?.[fieldName]) {
+                    return `${method} ${url} ${request.query[fieldName]}`;
+                }
+                break;
+            case "body":
+                if (request.body?.[fieldName]) {
+                    return `${method} ${url} ${request.body[fieldName]}`;
+                }
+                break;
+            case "bearer_token":
+                const authHeader = request.headers.authorization;
+                const token = this.extractBearerToken(authHeader);
+                if (token) {
+                    const claims = this.decodeJwtUnverified(token);
+                    if (claims?.[fieldName]) {
+                        return `${method} ${url} ${claims[fieldName]}`;
+                    }
+                }
+                break;
+        }
+        return `${method} ${url}`;
+    }
 }
 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;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"}
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":";;;AACA,0CAAuE;AAcvE,MAAa,mBAAoB,SAAQ,mBAAY;IACzC,KAAK,CAAC,sBAAsB,CAChC,OAAgB;QAEhB,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAChC,OAAO,CAAC,OAAiC,CAC5C,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;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,QAAQ,IAAI,SAAS;YAC/B,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,YAAY,CAAW;YAClD,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACnC,OAAO;YACP,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI;YACzE,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI;YAC1E,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,CACxB,GAAG,IAAI,CAAC,YAAY,kCAAkC,EACtD;gBACI,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;aAChC,CACJ,CAAC;YAEF,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,IACI,KAAK,CAAC,OAAO;gBACb,kEAAkE,EACpE,CAAC;gBACC,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;YAC5D,IAAI,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;YAE3C,IAAI,CAAC;gBACD,MAAM,IAAI,CAAC,0BAA0B,CACjC,QAAQ,EACR,QAAQ,EACR,OAAO,EACP,QAAQ,CACX,CAAC;gBAEF,wBAAwB;gBACxB,MAAM,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC;gBACjC,QAAQ,CAAC,GAAG,GAAG,UAEX,KAAW,EACX,QAAyB,EACzB,EAAe;oBAEf,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,GACV,OAAO,CAAC,SAAS,EAAE,QAAQ,IAAI,EAAE,CAAC;oBACtC,QAAQ,CAAC,kBAAkB,GAAG,QAAQ,CAAC,UAAU,CAAC;oBAElD,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;oBAED,MAAM,OAAO,GAAG;wBACZ,aAAa,EAAE,IAAI,CAAC,MAAO;wBAC3B,cAAc,EAAE,kBAAkB;qBACrC,CAAC;oBAEF,IAAI,OAAO,CAAC,SAAS,EAAE,SAAS,EAAE,CAAC;wBAC/B,QAAQ,CAAC,eAAe;4BACpB,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC;oBACjD,CAAC;oBAED,MAAM,OAAO,GAAG;wBACZ,KAAK,EAAE,QAAQ;wBACf,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,CAAC,KAAK,EAAE,EAAE;wBACf,OAAO,CAAC,KAAK,CAAC,2BAA2B,EAAE,KAAK,CAAC,CAAC;oBACtD,CAAC,CAAC,CAAC;oBAEH,kCAAkC;oBAClC,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;IAES,aAAa,CAAC,OAAgB;QACpC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC9B,MAAM,GAAG,GAAG,OAAO,CAAC,KAAK,EAAE,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;QAChD,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAA;QAE7B,IAAI,CAAC,MAAM,EAAE,iBAAiB,IAAI,CAAC,MAAM,EAAE,qBAAqB,EAAE,CAAC;YAC/D,OAAO,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC;QAC9B,CAAC;QAED,MAAM,SAAS,GAAG,MAAM,CAAC,iBAAiB,CAAC;QAC3C,MAAM,QAAQ,GAAG,MAAM,CAAC,qBAAqB,CAAC;QAE9C,QAAQ,QAAQ,EAAE,CAAC;YACf,KAAK,aAAa;gBACd,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC9B,OAAO,GAAG,MAAM,IAAI,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC3D,CAAC;gBACD,MAAM;YACV,KAAK,cAAc;gBACf,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC7B,OAAO,GAAG,MAAM,IAAI,GAAG,IAAI,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC1D,CAAC;gBACD,MAAM;YACV,KAAK,MAAM;gBACP,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC5B,OAAO,GAAG,MAAM,IAAI,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;gBACzD,CAAC;gBACD,MAAM;YACV,KAAK,cAAc;gBACf,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC;gBACjD,MAAM,KAAK,GAAG,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;gBAClD,IAAI,KAAK,EAAE,CAAC;oBACR,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;oBAC/C,IAAI,MAAM,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC;wBACtB,OAAO,GAAG,MAAM,IAAI,GAAG,IAAI,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;oBACnD,CAAC;gBACL,CAAC;gBACD,MAAM;QACd,CAAC;QAED,OAAO,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC;IAC9B,CAAC;CACJ;AA5PD,kDA4PC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usageflow/express",
-  "version": "0.1.2",
+  "version": "0.1.5",
   "description": "UsageFlow plugin for Express applications",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -10,7 +10,7 @@
     "prepare": "npm run build"
   },
   "dependencies": {
-    "@usageflow/core": "^0.1.2",
+    "@usageflow/core": "^0.1.3",
     "express": "^4.18.0"
   },
   "homepage": "https://usageflow.io",

package/src/plugin.ts

@@ -2,217 +2,267 @@ 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();
-    }
+    private async collectRequestMetadata(
+        request: Request,
+    ): Promise<RequestMetadata> {
+        const headers = this.sanitizeHeaders(
+            request.headers as Record<string, string>,
+        );
 
-    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");
-    }
+        // 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 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: clientIP || "unknown",
+            userAgent: request.headers["user-agent"] as string,
+            timestamp: new Date().toISOString(),
+            headers,
+            queryParams: Object.keys(request.query).length > 0 ? request.query : null,
+            pathParams: Object.keys(request.params).length > 0 ? request.params : null,
+            body: request.body,
+        };
+
+        return metadata;
     }
-  }
 
-  public createMiddleware(routes: Route[], whitelistRoutes: Route[] = []) {
-    const routesMap = this.createRoutesMap(routes);
-    const whitelistMap = this.createRoutesMap(whitelistRoutes);
-    const self = this;
+    private async executeRequestWithMetadata(
+        ledgerId: string,
+        metadata: RequestMetadata,
+        request: Request,
+        response: Response,
+    ): Promise<void> {
+        if (!this.apiKey) {
+            throw new Error("API key not initialized");
+        }
 
-    return async (request: Request, response: Response, next: NextFunction) => {
-      const method = request.method;
-      const url = request.route?.path || request.path || request.url;
+        const headers = {
+            "x-usage-key": this.apiKey,
+            "Content-Type": "application/json",
+        };
 
-      request.usageflow = {
-        startTime: Date.now(),
-      };
+        const payload = {
+            alias: ledgerId,
+            amount: 1,
+            metadata,
+        };
 
-      if (this.shouldSkipRoute(method, url || "", whitelistMap)) {
-        return next();
-      }
+        try {
+            const response = await fetch(
+                `${this.usageflowUrl}/api/v1/ledgers/measure/allocate`,
+                {
+                    method: "POST",
+                    headers,
+                    body: JSON.stringify(payload),
+                },
+            );
 
-      if (!this.shouldMonitorRoute(method, url || "", routesMap)) {
-        return next();
-      }
+            const data = await response.json();
 
-      const metadata = await this.collectRequestMetadata(request);
+            if (response.status === 400) {
+                throw new Error(data.message);
+            }
 
-      try {
-        await this.executeRequestWithMetadata(
-          `${method} ${url}`,
-          metadata,
-          request,
-          response,
-        );
+            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);
+            let ledgerId = this.guessLedgerId(request);
 
-        // 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);
+                await this.executeRequestWithMetadata(
+                    ledgerId,
+                    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: Record<string, any> =
+                        request.usageflow?.metadata || {};
+                    metadata.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",
+                    };
+
+                    if (request.usageflow?.startTime) {
+                        metadata.requestDuration =
+                            Date.now() - request.usageflow.startTime;
+                    }
+
+                    const payload = {
+                        alias: ledgerId,
+                        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 overloadsx
+                    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;
             }
-          }
+        };
+    }
 
-          const headers = {
-            "x-usage-key": self.apiKey!,
-            "Content-Type": "application/json",
-          };
+    protected guessLedgerId(request: Request): string {
+        const method = request.method;
+        const url = request.route?.path || request.path;
+        const config = this.apiConfig
 
-          const payload = {
-            alias: `${request.method} ${request.route?.path || request.path || request.url || "/"}`,
-            amount: 1,
-            allocationId: request.usageflow?.eventId,
-            metadata,
-          };
+        if (!config?.identityFieldName || !config?.identityFieldLocation) {
+            return `${method} ${url}`;
+        }
 
-          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;
-      }
-    };
-  }
+        const fieldName = config.identityFieldName;
+        const location = config.identityFieldLocation;
+
+        switch (location) {
+            case "path_params":
+                if (request.params?.[fieldName]) {
+                    return `${method} ${url} ${request.params[fieldName]}`;
+                }
+                break;
+            case "query_params":
+                if (request.query?.[fieldName]) {
+                    return `${method} ${url} ${request.query[fieldName]}`;
+                }
+                break;
+            case "body":
+                if (request.body?.[fieldName]) {
+                    return `${method} ${url} ${request.body[fieldName]}`;
+                }
+                break;
+            case "bearer_token":
+                const authHeader = request.headers.authorization;
+                const token = this.extractBearerToken(authHeader);
+                if (token) {
+                    const claims = this.decodeJwtUnverified(token);
+                    if (claims?.[fieldName]) {
+                        return `${method} ${url} ${claims[fieldName]}`;
+                    }
+                }
+                break;
+        }
+
+        return `${method} ${url}`;
+    }
 }