@soyio/soyio-widget 3.2.0 → 3.4.0

package/README.md

@@ -12,6 +12,8 @@
 </a>
 </p>
 
+This package is validated by the Soyio SDK CI workflow.
+
 ## Table of Contents
 
 - [Installation](#installation)
@@ -81,7 +83,7 @@ The **`ConsentBox`** is a component that allows you to embed a consent request d
     appearance: {}, // Optional
     actionToken: "<action token>", // Optional
     entityId: "<entity id>", // Optional
-    context: "<context>", // Optional
+    origin: "<origin>", // Optional
     onReady: () => console.log("ConsentBox is ready"), // Optional
     optionalReconsentBehavior: "notice", // Optional
     mandatoryReconsentBehavior: "notice", // Optional
@@ -193,6 +195,18 @@ The `PrivacyCenterBox` lets you embed the Privacy Center inside your page. You c
       { id: "op_rectification", label: "Rectification" },
     ],
 
+    // Customize which user data categories appear in DSR dropdowns (optional)
+    requestableDataCategories: [
+      {
+        value: "user.contact.email",
+        label: "Primary email",
+        description: "The email address we use for this account.",
+      },
+      {
+        value: "user.name.first",
+      },
+    ],
+
     // Override the "exercise your rights" link shown in consent-only mode (optional)
     externalRightsExerciseUrl: "https://privacy.example.com/rights",
 
@@ -240,6 +254,8 @@ The `PrivacyCenterBox` lets you embed the Privacy Center inside your page. You c
     consentRetentionPeriod: "30 days", // Optional: prevents immediate revoke for this period
     allowGranularScopeSelection: true, // Optional: only applies when templates have multiple scopes
     groupConsentsByScope: true, // Optional: groups consent templates by scope in consent management
+    origin: "<origin>", // Optional: attached to consent actions captured here
+    metadata: { key: "value" }, // Optional: attached to consent actions captured here
     onEvent: (event) => console.log(event),
     onReady: () => console.log("PrivacyCenterBox is ready"), // Optional
     isSandbox: true, // Optional
@@ -271,6 +287,14 @@ The `PrivacyCenterBox` lets you embed the Privacy Center inside your page. You c
   - `allowedExtensions`: Array of allowed file extensions (e.g. `['pdf', 'jpg']`). Default: `['pdf', 'png', 'jpeg', 'jpg']`.
   - `maxFileSize`: Maximum file size in bytes. Default: `5 * 1024 * 1024` (5MB).
 - `redecOperationIds`: Optional array of `{ id, label }` values for the Redec operation select. Required if `redec` right is included in `enabledRights` param.
+- `requestableDataCategories`: Optional array of `{ value, label?, description? }` objects to customize the categories shown in DSR dropdowns.
+  - `value`: Must be a canonical `user` data category taxonomy key such as `user.contact.email`, `user.name.first`, or `user.labor_activity.salary`.
+  - `label`: Optional override for the option label shown to end users.
+  - `description`: Optional override for the option helper text shown in the dropdown.
+  - When omitted, the Privacy Center keeps the default grouped category list.
+  - When provided, the Privacy Center uses the configured list and order.
+  - Non-`user` taxonomy values are ignored.
+  - Backend `blacklistedDataCategories` can still hide configured values.
 - `externalRightsExerciseUrl`: Optional URL used by required consent alerts when users need to exercise their rights outside the embedded privacy center.
 - `appearance.config.showHeader`: Optional boolean to show/hide the privacy center header (title and description).
 - `content.header`: Optional object with `title` and `description` overrides for the privacy center header copy.
@@ -287,6 +311,8 @@ The `PrivacyCenterBox` lets you embed the Privacy Center inside your page. You c
 - `groupConsentsByScope`: Optional boolean, groups consent templates by scope in consent management. This must be enabled for `consentManagement.scopeGroups` to apply.
 - `consentManagement.scopeGroups`: Optional array to customize accordion groups in consent management. Each group requires a `title` and a `scopes` array with `{ scopeType: 'product' | 'branch', scopeId: string }` entries. Scopes not included in custom groups keep the default scope grouping.
 - `showBatchConsentConfirmation`: Optional boolean, whether to show a confirmation dialog before saving consent changes in batch mode.
+- `origin`: Optional string attached to every consent action captured by the Privacy Center. Useful to identify the business context where the consent was given (e.g. `"my-onboarding-flow"`).
+- `metadata`: Optional object with arbitrary metadata attached to every consent action captured by the Privacy Center. The object must be serializable to JSON; properties with non-serializable values (like functions or `undefined`) will be omitted.
 - `appearance`: Customize the iframe appearance. See Appearance section below.
 - `onEvent`: Callback that receives events from the iframe.
 - `onReady`: Optional callback fired when the iframe becomes ready.
@@ -294,7 +320,7 @@ The `PrivacyCenterBox` lets you embed the Privacy Center inside your page. You c
 Note:
 - When `sessionToken` is provided, do not pass `companyId`.
 - `consentManagement.scopeGroups` is applied during initial iframe URL render and also synchronized through `SET_PRIVACY_CENTER_CONFIG` updates.
-- `content.header`, `content.consentManagement.header`, `appearance.config.showConsentManagementHeader`, and `externalRightsExerciseUrl` are applied through `SET_PRIVACY_CENTER_CONFIG`; those overrides may briefly appear after the iframe is ready.
+- `content.header`, `content.consentManagement.header`, `appearance.config.showConsentManagementHeader`, `externalRightsExerciseUrl`, and `requestableDataCategories` are applied through `SET_PRIVACY_CENTER_CONFIG`; those overrides may briefly appear after the iframe is ready.
 
 ### Privacy Center Events
 
@@ -1244,7 +1270,7 @@ export default function PrivacyCenterContainer() {
 To run the widget customization smoke test locally:
 
 ```sh
-yarn run smoke
+pnpm smoke
 ```
 
 The smoke test configuration is loaded from `smoke-test/.env.development`. You can modify this file to change the default values:
@@ -1261,6 +1287,15 @@ To test DSR rights in the Privacy Center tab, add these parameters to the JSON c
 ```json
 {
   "enabledRights": ["arsop", "redec"],
+  "requestableDataCategories": [
+    {
+      "value": "user.contact.email",
+      "label": "Primary email"
+    },
+    {
+      "value": "user.name.first"
+    }
+  ],
   "redecOperationIds": [
     { "id": "op_update", "label": "Update" },
     { "id": "op_rectification", "label": "Rectification" }

package/dist/index.d.ts

@@ -345,9 +345,12 @@ declare type PrivacyCenterConfig = BaseConfig & {
     showBatchConsentConfirmation?: boolean;
     consentManagement?: PrivacyCenterConsentManagementConfig;
     redecOperationIds?: RedecOperationId[];
+    requestableDataCategories?: PrivacyCenterRequestableDataCategoryOption[];
     content?: PrivacyCenterContentConfig;
     header?: PrivacyCenterHeaderCopyConfig;
     rightExamples?: PrivacyCenterContentConfig['rightExamples'];
+    origin?: string;
+    metadata?: Record<string, unknown>;
 } & ({
     companyId: `com_${string}`;
     sessionToken?: never;
@@ -384,6 +387,12 @@ declare type PrivacyCenterHeaderCopyConfig = {
     description?: string;
 };
 
+declare type PrivacyCenterRequestableDataCategoryOption = {
+    value: UserDataCategoryKey;
+    label?: string;
+    description?: string;
+};
+
 declare type PrivacyCenterRight = 'arsop' | 'redec';
 
 declare type PrivacyCenterScopeReference = {
@@ -656,4 +665,8 @@ export declare class _TooltipManager {
     destroy(): void;
 }
 
+declare const USER_DATA_CATEGORY_KEYS: readonly ["user", "user.account", "user.authorization", "user.behavior", "user.biometric", "user.childrens", "user.contact", "user.content", "user.demographic", "user.location", "user.device", "user.payment", "user.social", "user.unique_id", "user.telemetry", "user.user_sensor", "user.workplace", "user.sensor", "user.financial", "user.government_id", "user.health_and_medical", "user.name", "user.criminal_history", "user.privacy_preferences", "user.job_title", "user.account.settings", "user.account.username", "user.authorization.credentials", "user.authorization.biometric", "user.authorization.password", "user.behavior.browsing_history", "user.behavior.media_consumption", "user.behavior.purchase_history", "user.behavior.search_history", "user.biometric.fingerprint", "user.biometric.retinal", "user.biometric.voice", "user.biometric.health", "user.contact.address", "user.contact.email", "user.contact.phone_number", "user.contact.url", "user.contact.fax_number", "user.contact.organization", "user.contact.address.city", "user.contact.address.country", "user.contact.address.postal_code", "user.contact.address.state", "user.contact.address.street", "user.content.private", "user.content.public", "user.content.self_image", "user.demographic.age_range", "user.demographic.date_of_birth", "user.demographic.gender", "user.demographic.language", "user.demographic.marital_status", "user.demographic.political_opinion", "user.demographic.profile", "user.demographic.race_ethnicity", "user.demographic.religious_belief", "user.demographic.sexual_orientation", "user.demographic.nationality", "user.device.cookie", "user.device.cookie_id", "user.device.device_id", "user.device.ip_address", "user.financial.bank_account", "user.financial.credit_card", "user.government_id.birth_certificate", "user.government_id.drivers_license_number", "user.government_id.immigration", "user.government_id.national_identification_number", "user.government_id.passport_number", "user.government_id.vehicle_registration", "user.health_and_medical.genetic", "user.health_and_medical.insurance_beneficiary_id", "user.health_and_medical.record_id", "user.labor_activity", "user.labor_activity.profession", "user.labor_activity.job_title", "user.labor_activity.worker_type", "user.labor_activity.salary", "user.labor_activity.workplace", "user.location.imprecise", "user.location.precise", "user.name.first", "user.name.last", "user.unique_id.pseudonymous"];
+
+declare type UserDataCategoryKey = (typeof USER_DATA_CATEGORY_KEYS)[number];
+
 export { }