Add TTL support for cache and update README with caching details.

README.md

@@ -44,15 +44,17 @@ If you want to load LilTag asynchronously and initialize it only after the scrip
 
 ## Usage
 
-### 1. Loading Configuration from a URL
+### Loading Configuration
+
+#### 1. Loading Configuration from a URL
 You can initialize LilTag by providing a URL to a JSON configuration file. The configuration file should contain the tags you want to inject into your web page.
 
 ```javascript
 const lilTag = new LilTag("path_or_url/to/liltag_config.json");
 lilTag.init();
 ```
 
-#### JSON Configuration Example
+##### JSON Configuration Example
 ```json
 {
     "tags": [
@@ -91,7 +93,7 @@ lilTag.init();
 }
 ```
 
-### 2. Providing the Configuration Directly
+#### 2. Providing the Configuration Directly
 If you prefer to provide the configuration directly within your code, you can pass it as an object to the lilTagInit function.
 
 ```javascript
@@ -117,6 +119,17 @@ const lilTag = new LilTag({
 lilTag.init();
 ```
 
+### Enabling Caching
+
+You can enable caching to avoid fetching the configuration on every page load. The enableCache() method allows you to specify a TTL (time-to-live) in seconds.
+
+```javascript 
+// Enable caching with a TTL of 2 hours (7200 seconds)
+const lilTag = new LilTag('https://example.com/liltag-config.json');
+lilTag.enableCache(7200);
+lilTag.init();
+```
+
 ## Configuration Options
 Each tag in the configuration file or object should have the following properties:
 

dist/liltag.js

@@ -43,9 +43,15 @@ class LilTag {
     constructor(config) {
         this.config = config;
         this.cacheEnabled = false;
+        this.cacheTTL = LilTag.CACHE_DEFAULT_TTL;
     }
-    enableCache() {
+    /**
+     * Enable caching with a specific TTL (time-to-live) in seconds.
+     * @param ttl - Time in seconds for which the cache is valid.
+     */
+    enableCache(ttl = LilTag.CACHE_DEFAULT_TTL) {
         this.cacheEnabled = true;
+        this.cacheTTL = ttl;
     }
     init() {
         if (this.config === "") {
@@ -91,8 +97,10 @@ class LilTag {
         const cachedEntry = cacheData[url];
         if (!cachedEntry)
             return null;
-        const oneDay = 24 * 60 * 60 * 1000;
-        if (Date.now() - cachedEntry.timestamp > oneDay) {
+        // Calculate TTL in milliseconds
+        const ttlInMilliseconds = this.cacheTTL * 1000;
+        // Check if the cache has expired
+        if (Date.now() - cachedEntry.timestamp > ttlInMilliseconds) {
             delete cacheData[url];
             localStorage.setItem(LilTag.CACHE_KEY, JSON.stringify(cacheData));
             return null;
@@ -206,6 +214,7 @@ class LilTag {
 }
 LilTag.DATA_ATTRIBUTE = "data-tag-id";
 LilTag.CACHE_KEY = "LilTagConfigCache";
+LilTag.CACHE_DEFAULT_TTL = 3600;
 exports["default"] = LilTag;
 
 })();

src/liltag.ts

@@ -37,12 +37,19 @@ interface Config {
 export default class LilTag {
     private static readonly DATA_ATTRIBUTE = "data-tag-id";
     private static readonly CACHE_KEY = "LilTagConfigCache";
+    private static readonly CACHE_DEFAULT_TTL = 3600;
     private cacheEnabled: boolean = false;
+    private cacheTTL: number = LilTag.CACHE_DEFAULT_TTL;
 
     constructor(private config: Config | string) {}
 
-    public enableCache(): void {
+    /**
+     * Enable caching with a specific TTL (time-to-live) in seconds.
+     * @param ttl - Time in seconds for which the cache is valid.
+     */
+    public enableCache(ttl: number = LilTag.CACHE_DEFAULT_TTL): void {
         this.cacheEnabled = true;
+        this.cacheTTL = ttl;
     }
 
     public init(): void {
@@ -92,9 +99,11 @@ export default class LilTag {
         const cachedEntry = cacheData[url];
         if (!cachedEntry) return null;
 
-        const oneDay = 24 * 60 * 60 * 1000;
+        // Calculate TTL in milliseconds
+        const ttlInMilliseconds = this.cacheTTL * 1000;
 
-        if (Date.now() - cachedEntry.timestamp > oneDay) {
+        // Check if the cache has expired
+        if (Date.now() - cachedEntry.timestamp > ttlInMilliseconds) {
             delete cacheData[url];
             localStorage.setItem(LilTag.CACHE_KEY, JSON.stringify(cacheData));
             return null;