@edirect/tokenization 0.0.4 → 0.0.5

package/README.md

@@ -10,6 +10,12 @@ To install the necessary dependencies, run:
 npm install --save @edirect/tokenization
 ```
 
+## Important Note
+
+This client **caches** the **configurations** for `5 minutes` and the **tokens** for `1 minute`.
+
+This is to avoid making unnecessary requests to the tokenization service. If you want to change any configuration on the tokenization service, you'll need to wait for the cache to expire.
+
 ## Usage
 
 The `Tokenization` class provides methods to tokenize and detokenize payloads. Below is an example of how to use the class.

package/dist/index.js

@@ -102,7 +102,9 @@ var TokenEvaluator = class {
 };
 
 // src/core/app.ts
+var import_lru_cache = require("lru-cache");
 var TokenizationApp = class {
+  cache;
   tokenizationService;
   configurationService;
   evaluator;
@@ -110,22 +112,38 @@ var TokenizationApp = class {
     this.tokenizationService = tokenizationService;
     this.configurationService = configurationService;
     this.evaluator = new TokenEvaluator(evaluator);
+    this.cache = new import_lru_cache.LRUCache({
+      max: 5e3,
+      ttl: 1e3 * 60 * 1,
+      // 1 minute
+      allowStale: false,
+      updateAgeOnGet: false,
+      updateAgeOnHas: false
+    });
   }
   async tokenize(auth, tenant, configKey, payload) {
     const config = await this.configurationService.get(auth, tenant, configKey);
     if (!config) return payload;
     if ((!config.fields || config.fields.length === 0) && config.defaultClassification === 0)
       return payload;
-    const processedPayload = await this.processRequest(config, payload);
-    const tokenPayload = await this.tokenizationService.tokenize(
-      auth,
-      tenant,
-      configKey,
-      processedPayload
-    );
     const respPayload = payload;
-    for (const key in tokenPayload) {
-      set(respPayload, key.split("."), tokenPayload[key]);
+    const processedPayload = await this.processRequest(config, payload);
+    if (Object.keys(processedPayload.notFound).length > 0) {
+      const tokenPayload = await this.tokenizationService.tokenize(
+        auth,
+        tenant,
+        configKey,
+        processedPayload.notFound
+      );
+      for (const key in tokenPayload) {
+        set(respPayload, key.split("."), tokenPayload[key]);
+        this.cache.set(key, tokenPayload[key]);
+      }
+    }
+    if (Object.keys(processedPayload.found).length > 0) {
+      for (const key in processedPayload.found) {
+        set(respPayload, key.split("."), processedPayload.found[key]);
+      }
     }
     return respPayload;
   }
@@ -134,27 +152,47 @@ var TokenizationApp = class {
     if (!config) return payload;
     if ((!config.fields || config.fields.length === 0) && config.defaultClassification === 0)
       return payload;
-    const processedPayload = this.processRequest(config, payload);
-    const tokenPayload = await this.tokenizationService.detokenize(
-      auth,
-      tenant,
-      configKey,
-      processedPayload
-    );
     const respPayload = payload;
-    for (const key in tokenPayload) {
-      set(respPayload, key.split("."), tokenPayload[key]);
+    const processedPayload = this.processRequest(config, payload);
+    if (Object.keys(processedPayload.notFound).length > 0) {
+      const tokenPayload = await this.tokenizationService.detokenize(
+        auth,
+        tenant,
+        configKey,
+        processedPayload.notFound
+      );
+      for (const key in tokenPayload) {
+        set(respPayload, key.split("."), tokenPayload[key]);
+        this.cache.set(key, tokenPayload[key]);
+      }
+    }
+    if (Object.keys(processedPayload.found).length > 0) {
+      for (const key in processedPayload.found) {
+        set(respPayload, key.split("."), processedPayload.found[key]);
+      }
     }
     return respPayload;
   }
   processRequest(config, payload) {
     if (config.fields.length === 0) {
-      return payload;
+      return {
+        found: payload,
+        notFound: {}
+      };
     }
-    const req = {};
+    const req = {
+      found: {},
+      notFound: {}
+    };
     traverse(payload, (value, path) => {
       if (this.evaluator.shouldTokenizeField(config, path)) {
-        req[path.join(".")] = value;
+        const pathName = path.join(".");
+        const fromCache = this.cache.get(pathName);
+        if (fromCache) {
+          req.found[pathName] = fromCache;
+        } else {
+          req.notFound[pathName] = value;
+        }
       }
     });
     return req;
@@ -162,14 +200,28 @@ var TokenizationApp = class {
 };
 
 // src/core/services/configuration.ts
+var import_lru_cache2 = require("lru-cache");
 var ConfigurationService = class {
   constructor(baseUrl) {
     this.baseUrl = baseUrl;
     if (!this.baseUrl) {
       throw new Error("Configuration Service BaseUrl is required");
     }
+    this.cache = new import_lru_cache2.LRUCache({
+      max: 100,
+      ttl: 1e3 * 60 * 5,
+      // 5 minutes
+      allowStale: false,
+      updateAgeOnGet: false,
+      updateAgeOnHas: false
+    });
   }
+  cache;
   async get(auth, tenant, config) {
+    const cached = this.cache.get(`${tenant}/${config}`);
+    if (cached) {
+      return cached;
+    }
     const resp = await fetch(
       `${this.baseUrl}/api/v1/${tenant}/${config}/config`,
       {
@@ -186,6 +238,7 @@ var ConfigurationService = class {
       throw new Error("Failed to get configuration");
     }
     const data = await resp.json();
+    this.cache.set(`${tenant}/${config}`, data);
     return data;
   }
   async create(auth, tenant, config) {

package/dist/index.mjs

@@ -76,7 +76,9 @@ var TokenEvaluator = class {
 };
 
 // src/core/app.ts
+import { LRUCache } from "lru-cache";
 var TokenizationApp = class {
+  cache;
   tokenizationService;
   configurationService;
   evaluator;
@@ -84,22 +86,38 @@ var TokenizationApp = class {
     this.tokenizationService = tokenizationService;
     this.configurationService = configurationService;
     this.evaluator = new TokenEvaluator(evaluator);
+    this.cache = new LRUCache({
+      max: 5e3,
+      ttl: 1e3 * 60 * 1,
+      // 1 minute
+      allowStale: false,
+      updateAgeOnGet: false,
+      updateAgeOnHas: false
+    });
   }
   async tokenize(auth, tenant, configKey, payload) {
     const config = await this.configurationService.get(auth, tenant, configKey);
     if (!config) return payload;
     if ((!config.fields || config.fields.length === 0) && config.defaultClassification === 0)
       return payload;
-    const processedPayload = await this.processRequest(config, payload);
-    const tokenPayload = await this.tokenizationService.tokenize(
-      auth,
-      tenant,
-      configKey,
-      processedPayload
-    );
     const respPayload = payload;
-    for (const key in tokenPayload) {
-      set(respPayload, key.split("."), tokenPayload[key]);
+    const processedPayload = await this.processRequest(config, payload);
+    if (Object.keys(processedPayload.notFound).length > 0) {
+      const tokenPayload = await this.tokenizationService.tokenize(
+        auth,
+        tenant,
+        configKey,
+        processedPayload.notFound
+      );
+      for (const key in tokenPayload) {
+        set(respPayload, key.split("."), tokenPayload[key]);
+        this.cache.set(key, tokenPayload[key]);
+      }
+    }
+    if (Object.keys(processedPayload.found).length > 0) {
+      for (const key in processedPayload.found) {
+        set(respPayload, key.split("."), processedPayload.found[key]);
+      }
     }
     return respPayload;
   }
@@ -108,27 +126,47 @@ var TokenizationApp = class {
     if (!config) return payload;
     if ((!config.fields || config.fields.length === 0) && config.defaultClassification === 0)
       return payload;
-    const processedPayload = this.processRequest(config, payload);
-    const tokenPayload = await this.tokenizationService.detokenize(
-      auth,
-      tenant,
-      configKey,
-      processedPayload
-    );
     const respPayload = payload;
-    for (const key in tokenPayload) {
-      set(respPayload, key.split("."), tokenPayload[key]);
+    const processedPayload = this.processRequest(config, payload);
+    if (Object.keys(processedPayload.notFound).length > 0) {
+      const tokenPayload = await this.tokenizationService.detokenize(
+        auth,
+        tenant,
+        configKey,
+        processedPayload.notFound
+      );
+      for (const key in tokenPayload) {
+        set(respPayload, key.split("."), tokenPayload[key]);
+        this.cache.set(key, tokenPayload[key]);
+      }
+    }
+    if (Object.keys(processedPayload.found).length > 0) {
+      for (const key in processedPayload.found) {
+        set(respPayload, key.split("."), processedPayload.found[key]);
+      }
     }
     return respPayload;
   }
   processRequest(config, payload) {
     if (config.fields.length === 0) {
-      return payload;
+      return {
+        found: payload,
+        notFound: {}
+      };
     }
-    const req = {};
+    const req = {
+      found: {},
+      notFound: {}
+    };
     traverse(payload, (value, path) => {
       if (this.evaluator.shouldTokenizeField(config, path)) {
-        req[path.join(".")] = value;
+        const pathName = path.join(".");
+        const fromCache = this.cache.get(pathName);
+        if (fromCache) {
+          req.found[pathName] = fromCache;
+        } else {
+          req.notFound[pathName] = value;
+        }
       }
     });
     return req;
@@ -136,14 +174,28 @@ var TokenizationApp = class {
 };
 
 // src/core/services/configuration.ts
+import { LRUCache as LRUCache2 } from "lru-cache";
 var ConfigurationService = class {
   constructor(baseUrl) {
     this.baseUrl = baseUrl;
     if (!this.baseUrl) {
       throw new Error("Configuration Service BaseUrl is required");
     }
+    this.cache = new LRUCache2({
+      max: 100,
+      ttl: 1e3 * 60 * 5,
+      // 5 minutes
+      allowStale: false,
+      updateAgeOnGet: false,
+      updateAgeOnHas: false
+    });
   }
+  cache;
   async get(auth, tenant, config) {
+    const cached = this.cache.get(`${tenant}/${config}`);
+    if (cached) {
+      return cached;
+    }
     const resp = await fetch(
       `${this.baseUrl}/api/v1/${tenant}/${config}/config`,
       {
@@ -160,6 +212,7 @@ var ConfigurationService = class {
       throw new Error("Failed to get configuration");
     }
     const data = await resp.json();
+    this.cache.set(`${tenant}/${config}`, data);
     return data;
   }
   async create(auth, tenant, config) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edirect/tokenization",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "Javascript library for tokenization service",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -32,5 +32,8 @@
     "tsup": "^8.3.5",
     "typescript": "^5.7.2",
     "vitest": "^2.1.8"
+  },
+  "dependencies": {
+    "lru-cache": "^11.0.2"
   }
 }