@soyio/soyio-widget 2.25.1 → 2.25.2

package/README.md

@@ -86,6 +86,7 @@ The **`ConsentBox`** is a component that allows you to embed a consent request d
     optionalReconsentBehavior: "notice", // Optional
     mandatoryReconsentBehavior: "notice", // Optional
     allowGranularScopeSelection: true, // Optional
+    metadata: { key: "value" }, // Optional
   };
 
   // Wait for DOM to be fully loaded
@@ -142,6 +143,7 @@ The `onEvent` follows the following format:
 
   We don't support hiding the mandatory consent, and we strongly recommend using `notice` so the user doesn't have to give the consent again and knows what they have already given consent to.
 - **`allowGranularScopeSelection`**: Enables selecting consent at a more granular scope when the template supports granular scopes.
+- **`metadata`**: An optional object with arbitrary metadata to attach to the consent. This metadata will be included in the consent record. The object must be serializable to JSON; properties with non-serializable values (like functions or `undefined`) will be omitted.
 
 ## Privacy Center
 

package/dist/index.d.ts

@@ -85,6 +85,7 @@ declare type ConsentConfig = BaseConfig & {
     optionalReconsentBehavior?: 'notice' | 'askAgain' | 'hide';
     mandatoryReconsentBehavior?: 'notice' | 'askAgain';
     allowGranularScopeSelection?: boolean;
+    metadata?: Record<string, unknown>;
 };
 
 declare type ConsentEvent = ConsentCheckboxChangeEvent;