c15t 1.0.0 → 1.0.2

package/CHANGELOG.md

@@ -1,12 +1,26 @@
 # c15t
 
+## 1.0.1
+
+### Patch Changes
+
+- [`08446ae`](https://github.com/c15t/c15t/commit/08446aef443a20a2262477a1dca3569d6bf672ad) Thanks [@BurnedChris](https://github.com/BurnedChris)! - # Removal of localstorage option in offline and custom
+
+  - **Documentation**
+    - Updated offline mode documentation to remove references to the `localStorageKey` configuration option.
+  - **Bug Fixes**
+    - Removed the ability to customize the localStorage key for storing consent data; a fixed key is now always used.
+  - **Refactor**
+    - Streamlined internal handling of localStorage keys by removing related configuration options and parameters.
+  - **Tests**
+    - Updated and removed tests related to custom localStorage key usage.
 
 ## 1.0.0-rc.1
 
 ### Patch Changes
 
 - Refactored package.json imports
-  
+
 ## 0.0.1-beta.10
 
 ### Patch Changes

package/dist/client/client-c15t.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client-c15t.d.ts","sourceRoot":"","sources":["../../src/client/client-c15t.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,qBAAqB,EACrB,kBAAkB,EAClB,yBAAyB,EACzB,wBAAwB,EACxB,qBAAqB,EACrB,MAAM,eAAe,CAAC;AAEvB,OAAO,KAAK,EACX,uBAAuB,EACvB,uBAAuB,EACvB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAEN,KAAK,YAAY,EACjB,KAAK,eAAe,EACpB,KAAK,WAAW,EAChB,MAAM,SAAS,CAAC;AAgBjB;;GAEG;AACH,MAAM,WAAW,iBAAiB;IACjC;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,KAAK,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,uBAAuB,CAAC;IAEpC;;;OAGG;IACH,QAAQ,CAAC,EAAE,WAAW,CAAC;IAEvB;;;;OAIG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;CAC1B;AAuCD;;;GAGG;AACH,qBAAa,UAAW,YAAW,uBAAuB;IACzD;;;OAGG;IACH,OAAO,CAAC,UAAU,CAAS;IAE3B;;;OAGG;IACH,OAAO,CAAC,OAAO,CAAyB;IAExC;;;OAGG;IACH,OAAO,CAAC,WAAW,CAAC,CAAe;IAEnC;;;OAGG;IACH,OAAO,CAAC,SAAS,CAAC,CAA0B;IAE5C;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAc;IAE9B;;;OAGG;IACH,OAAO,CAAC,WAAW,CAAc;IAEjC;;;;OAIG;gBACS,OAAO,EAAE,iBAAiB;IA2CtC;;;;;;OAMG;IACH,OAAO,CAAC,UAAU;IAwBlB;;;;OAIG;IACH,YAAY,IAAI,uBAAuB,GAAG,SAAS;IAInD;;OAEG;IACH,YAAY,CAAC,SAAS,EAAE,uBAAuB,GAAG,IAAI;IAItD;;OAEG;IACH,OAAO,CAAC,qBAAqB;IAoB7B;;OAEG;YACW,OAAO;IA4SrB;;;OAGG;IACG,iBAAiB,CACtB,OAAO,CAAC,EAAE,YAAY,CAAC,yBAAyB,CAAC,GAC/C,OAAO,CAAC,eAAe,CAAC,yBAAyB,CAAC,CAAC;IAyDtD;;;;OAIG;YACW,+BAA+B;IAoD7C;;;OAGG;IACG,UAAU,CACf,OAAO,CAAC,EAAE,YAAY,CAAC,kBAAkB,EAAE,qBAAqB,CAAC,GAC/D,OAAO,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC;IAqD/C;;;;OAIG;YACW,4BAA4B;IAwF1C;;OAEG;IACG,aAAa,CAClB,OAAO,CAAC,EAAE,YAAY,CAAC,qBAAqB,EAAE,wBAAwB,CAAC,GACrE,OAAO,CAAC,eAAe,CAAC,qBAAqB,CAAC,CAAC;IAUlD;;OAEG;IACG,MAAM,CAAC,YAAY,EAAE,QAAQ,GAAG,OAAO,EAAE,SAAS,GAAG,OAAO,EACjE,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,YAAY,CAAC,YAAY,EAAE,QAAQ,EAAE,SAAS,CAAC,GACvD,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;IAIzC;;;OAGG;IACH,OAAO,CAAC,8BAA8B;IA8CtC;;;OAGG;YACW,yBAAyB;CAqFvC"}
+{"version":3,"file":"client-c15t.d.ts","sourceRoot":"","sources":["../../src/client/client-c15t.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,qBAAqB,EACrB,kBAAkB,EAClB,yBAAyB,EACzB,wBAAwB,EACxB,qBAAqB,EACrB,MAAM,eAAe,CAAC;AAEvB,OAAO,KAAK,EACX,uBAAuB,EACvB,uBAAuB,EACvB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAEN,KAAK,YAAY,EACjB,KAAK,eAAe,EACpB,KAAK,WAAW,EAChB,MAAM,SAAS,CAAC;AAgBjB;;GAEG;AACH,MAAM,WAAW,iBAAiB;IACjC;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,KAAK,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,uBAAuB,CAAC;IAEpC;;;OAGG;IACH,QAAQ,CAAC,EAAE,WAAW,CAAC;IAEvB;;;;OAIG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;CAC1B;AAuCD;;;GAGG;AACH,qBAAa,UAAW,YAAW,uBAAuB;IACzD;;;OAGG;IACH,OAAO,CAAC,UAAU,CAAS;IAE3B;;;OAGG;IACH,OAAO,CAAC,OAAO,CAAyB;IAExC;;;OAGG;IACH,OAAO,CAAC,WAAW,CAAC,CAAe;IAEnC;;;OAGG;IACH,OAAO,CAAC,SAAS,CAAC,CAA0B;IAE5C;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAc;IAE9B;;;OAGG;IACH,OAAO,CAAC,WAAW,CAAc;IAEjC;;;;OAIG;gBACS,OAAO,EAAE,iBAAiB;IA2CtC;;;;;;OAMG;IACH,OAAO,CAAC,UAAU;IAwBlB;;;;OAIG;IACH,YAAY,IAAI,uBAAuB,GAAG,SAAS;IAInD;;OAEG;IACH,YAAY,CAAC,SAAS,EAAE,uBAAuB,GAAG,IAAI;IAItD;;OAEG;IACH,OAAO,CAAC,qBAAqB;IAoB7B;;OAEG;YACW,OAAO;IA4SrB;;;OAGG;IACG,iBAAiB,CACtB,OAAO,CAAC,EAAE,YAAY,CAAC,yBAAyB,CAAC,GAC/C,OAAO,CAAC,eAAe,CAAC,yBAAyB,CAAC,CAAC;IAyDtD;;;;OAIG;YACW,+BAA+B;IAmD7C;;;OAGG;IACG,UAAU,CACf,OAAO,CAAC,EAAE,YAAY,CAAC,kBAAkB,EAAE,qBAAqB,CAAC,GAC/D,OAAO,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC;IAqD/C;;;;OAIG;YACW,4BAA4B;IAuF1C;;OAEG;IACG,aAAa,CAClB,OAAO,CAAC,EAAE,YAAY,CAAC,qBAAqB,EAAE,wBAAwB,CAAC,GACrE,OAAO,CAAC,eAAe,CAAC,qBAAqB,CAAC,CAAC;IAUlD;;OAEG;IACG,MAAM,CAAC,YAAY,EAAE,QAAQ,GAAG,OAAO,EAAE,SAAS,GAAG,OAAO,EACjE,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,YAAY,CAAC,YAAY,EAAE,QAAQ,EAAE,SAAS,CAAC,GACvD,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;IAIzC;;;OAGG;IACH,OAAO,CAAC,8BAA8B;IA8CtC;;;OAGG;YACW,yBAAyB;CAqFvC"}

package/dist/client/client-offline.d.ts

@@ -13,11 +13,6 @@ export interface OfflineClientOptions {
      * Global callbacks for handling API responses
      */
     callbacks?: ConsentManagerCallbacks;
-    /**
-     * Custom localStorage key to check for consent banner visibility
-     * @default 'c15t-consent'
-     */
-    localStorageKey?: string;
 }
 /**
  * Offline implementation of the consent client interface.
@@ -29,11 +24,6 @@ export declare class OfflineClient implements ConsentManagerInterface {
      * @internal
      */
     private callbacks?;
-    /**
-     * LocalStorage key for consent banner visibility
-     * @internal
-     */
-    private localStorageKey;
     /**
      * Creates a new Offline client instance.
      *

package/dist/client/client-offline.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client-offline.d.ts","sourceRoot":"","sources":["../../src/client/client-offline.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,qBAAqB,EACrB,kBAAkB,EAClB,yBAAyB,EACzB,wBAAwB,EACxB,qBAAqB,EACrB,MAAM,eAAe,CAAC;AAEvB,OAAO,KAAK,EACX,uBAAuB,EACvB,uBAAuB,EACvB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE7D;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACpC;;OAEG;IACH,SAAS,CAAC,EAAE,uBAAuB,CAAC;IAEpC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,qBAAa,aAAc,YAAW,uBAAuB;IAC5D;;;OAGG;IACH,OAAO,CAAC,SAAS,CAAC,CAA0B;IAE5C;;;OAGG;IACH,OAAO,CAAC,eAAe,CAAS;IAEhC;;;;OAIG;gBACS,OAAO,GAAE,oBAAyB;IAK9C;;;;OAIG;IACH,YAAY,IAAI,uBAAuB,GAAG,SAAS;IAInD;;OAEG;IACH,YAAY,CAAC,SAAS,EAAE,uBAAuB,GAAG,IAAI;IAItD;;OAEG;IACH,OAAO,CAAC,qBAAqB;IAS7B;;OAEG;YACW,qBAAqB;IAyBnC;;;OAGG;IACG,iBAAiB,CACtB,OAAO,CAAC,EAAE,YAAY,CAAC,yBAAyB,CAAC,GAC/C,OAAO,CAAC,eAAe,CAAC,yBAAyB,CAAC,CAAC;IA4CtD;;;OAGG;IACG,UAAU,CACf,OAAO,CAAC,EAAE,YAAY,CAAC,kBAAkB,EAAE,qBAAqB,CAAC,GAC/D,OAAO,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC;IA+B/C;;OAEG;IACG,aAAa,CAClB,OAAO,CAAC,EAAE,YAAY,CAAC,qBAAqB,EAAE,wBAAwB,CAAC,GACrE,OAAO,CAAC,eAAe,CAAC,qBAAqB,CAAC,CAAC;IAOlD;;OAEG;IACG,MAAM,CAAC,YAAY,EAAE,QAAQ,GAAG,OAAO,EAAE,SAAS,GAAG,OAAO,EACjE,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,YAAY,CAAC,YAAY,EAAE,QAAQ,EAAE,SAAS,CAAC,GACvD,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;CAGzC"}
+{"version":3,"file":"client-offline.d.ts","sourceRoot":"","sources":["../../src/client/client-offline.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,qBAAqB,EACrB,kBAAkB,EAClB,yBAAyB,EACzB,wBAAwB,EACxB,qBAAqB,EACrB,MAAM,eAAe,CAAC;AAEvB,OAAO,KAAK,EACX,uBAAuB,EACvB,uBAAuB,EACvB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE7D;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACpC;;OAEG;IACH,SAAS,CAAC,EAAE,uBAAuB,CAAC;CACpC;AAED;;;GAGG;AACH,qBAAa,aAAc,YAAW,uBAAuB;IAC5D;;;OAGG;IACH,OAAO,CAAC,SAAS,CAAC,CAA0B;IAE5C;;;;OAIG;gBACS,OAAO,GAAE,oBAAyB;IAI9C;;;;OAIG;IACH,YAAY,IAAI,uBAAuB,GAAG,SAAS;IAInD;;OAEG;IACH,YAAY,CAAC,SAAS,EAAE,uBAAuB,GAAG,IAAI;IAItD;;OAEG;IACH,OAAO,CAAC,qBAAqB;IAS7B;;OAEG;YACW,qBAAqB;IAyBnC;;;OAGG;IACG,iBAAiB,CACtB,OAAO,CAAC,EAAE,YAAY,CAAC,yBAAyB,CAAC,GAC/C,OAAO,CAAC,eAAe,CAAC,yBAAyB,CAAC,CAAC;IA4CtD;;;OAGG;IACG,UAAU,CACf,OAAO,CAAC,EAAE,YAAY,CAAC,kBAAkB,EAAE,qBAAqB,CAAC,GAC/D,OAAO,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC;IA+B/C;;OAEG;IACG,aAAa,CAClB,OAAO,CAAC,EAAE,YAAY,CAAC,qBAAqB,EAAE,wBAAwB,CAAC,GACrE,OAAO,CAAC,eAAe,CAAC,qBAAqB,CAAC,CAAC;IAOlD;;OAEG;IACG,MAAM,CAAC,YAAY,EAAE,QAAQ,GAAG,OAAO,EAAE,SAAS,GAAG,OAAO,EACjE,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,YAAY,CAAC,YAAY,EAAE,QAAQ,EAAE,SAAS,CAAC,GACvD,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;CAGzC"}

package/dist/index.cjs

@@ -322,13 +322,12 @@ class C15tClient {
     async offlineFallbackForConsentBanner(options) {
         let shouldShow = true;
         let hasLocalStorageAccess = false;
-        const localStorageKey = 'c15t-consent';
         try {
             if ('undefined' != typeof window && window.localStorage) {
                 window.localStorage.setItem('c15t-storage-test-key', 'test');
                 window.localStorage.removeItem('c15t-storage-test-key');
                 hasLocalStorageAccess = true;
-                const storedConsent = window.localStorage.getItem(localStorageKey);
+                const storedConsent = window.localStorage.getItem('c15t-consent');
                 shouldShow = null === storedConsent;
             }
         } catch (error) {
@@ -374,13 +373,12 @@ class C15tClient {
         }
     }
     async offlineFallbackForSetConsent(options) {
-        const localStorageKey = 'c15t-consent';
         const pendingSubmissionsKey = 'c15t-pending-consent-submissions';
         try {
             if ('undefined' != typeof window && window.localStorage) {
                 window.localStorage.setItem('c15t-storage-test-key', 'test');
                 window.localStorage.removeItem('c15t-storage-test-key');
-                window.localStorage.setItem(localStorageKey, JSON.stringify({
+                window.localStorage.setItem('c15t-consent', JSON.stringify({
                     timestamp: new Date().toISOString(),
                     preferences: options?.body?.preferences || {}
                 }));
@@ -570,10 +568,8 @@ class CustomClient {
 }
 class OfflineClient {
     callbacks;
-    localStorageKey;
     constructor(options = {}){
         this.callbacks = options.callbacks;
-        this.localStorageKey = options.localStorageKey || 'c15t-consent';
     }
     getCallbacks() {
         return this.callbacks;
@@ -604,7 +600,7 @@ class OfflineClient {
             if ('undefined' != typeof window && window.localStorage) {
                 window.localStorage.setItem('c15t-storage-test-key', 'test');
                 window.localStorage.removeItem('c15t-storage-test-key');
-                const storedConsent = window.localStorage.getItem(this.localStorageKey);
+                const storedConsent = window.localStorage.getItem('c15t-consent');
                 shouldShow = null === storedConsent;
             }
         } catch (error) {
@@ -631,7 +627,7 @@ class OfflineClient {
             if ('undefined' != typeof window && window.localStorage) {
                 window.localStorage.setItem('c15t-storage-test-key', 'test');
                 window.localStorage.removeItem('c15t-storage-test-key');
-                window.localStorage.setItem(this.localStorageKey, JSON.stringify({
+                window.localStorage.setItem('c15t-consent', JSON.stringify({
                     timestamp: new Date().toISOString(),
                     preferences: options?.body?.preferences || {}
                 }));

package/dist/index.js

@@ -287,13 +287,12 @@ class C15tClient {
     async offlineFallbackForConsentBanner(options) {
         let shouldShow = true;
         let hasLocalStorageAccess = false;
-        const localStorageKey = 'c15t-consent';
         try {
             if ('undefined' != typeof window && window.localStorage) {
                 window.localStorage.setItem('c15t-storage-test-key', 'test');
                 window.localStorage.removeItem('c15t-storage-test-key');
                 hasLocalStorageAccess = true;
-                const storedConsent = window.localStorage.getItem(localStorageKey);
+                const storedConsent = window.localStorage.getItem('c15t-consent');
                 shouldShow = null === storedConsent;
             }
         } catch (error) {
@@ -339,13 +338,12 @@ class C15tClient {
         }
     }
     async offlineFallbackForSetConsent(options) {
-        const localStorageKey = 'c15t-consent';
         const pendingSubmissionsKey = 'c15t-pending-consent-submissions';
         try {
             if ('undefined' != typeof window && window.localStorage) {
                 window.localStorage.setItem('c15t-storage-test-key', 'test');
                 window.localStorage.removeItem('c15t-storage-test-key');
-                window.localStorage.setItem(localStorageKey, JSON.stringify({
+                window.localStorage.setItem('c15t-consent', JSON.stringify({
                     timestamp: new Date().toISOString(),
                     preferences: options?.body?.preferences || {}
                 }));
@@ -535,10 +533,8 @@ class CustomClient {
 }
 class OfflineClient {
     callbacks;
-    localStorageKey;
     constructor(options = {}){
         this.callbacks = options.callbacks;
-        this.localStorageKey = options.localStorageKey || 'c15t-consent';
     }
     getCallbacks() {
         return this.callbacks;
@@ -569,7 +565,7 @@ class OfflineClient {
             if ('undefined' != typeof window && window.localStorage) {
                 window.localStorage.setItem('c15t-storage-test-key', 'test');
                 window.localStorage.removeItem('c15t-storage-test-key');
-                const storedConsent = window.localStorage.getItem(this.localStorageKey);
+                const storedConsent = window.localStorage.getItem('c15t-consent');
                 shouldShow = null === storedConsent;
             }
         } catch (error) {
@@ -596,7 +592,7 @@ class OfflineClient {
             if ('undefined' != typeof window && window.localStorage) {
                 window.localStorage.setItem('c15t-storage-test-key', 'test');
                 window.localStorage.removeItem('c15t-storage-test-key');
-                window.localStorage.setItem(this.localStorageKey, JSON.stringify({
+                window.localStorage.setItem('c15t-consent', JSON.stringify({
                     timestamp: new Date().toISOString(),
                     preferences: options?.body?.preferences || {}
                 }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "c15t",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "license": "GPL-3.0-only",
   "type": "module",
   "exports": {