@soyio/soyio-widget 3.6.0 → 3.7.0

package/README.md

@@ -333,9 +333,46 @@ Note:
 
 ### Privacy Center Events
 
-- **`REQUEST_SUBMITTED`**: This event occurs when a user successfully submits a Data Subject Request. The event object includes:
-  - `eventName`: The name of the event, in this case, `'REQUEST_SUBMITTED'`.
-  - `kind`: The kind of the Data Subject Request submitted. Supported values are: `access`, `opposition`, `rectification`, `suppression` and `portability`
+Every event is delivered through the `onEvent` callback with an `eventName` discriminator. Import the `PrivacyCenterEvent` union type for type narrowing in TypeScript.
+
+- **`REQUEST_SUBMITTED`**: A user successfully submits a Data Subject Request.
+  - `eventName`: `'REQUEST_SUBMITTED'`.
+  - `dataSubjectRequestId`: Identifier of the created request.
+  - `kind`: Uppercase request kind (e.g. `ACCESS`, `OPPOSITION`, `RECTIFICATION`, `SUPPRESSION`, `PORTABILITY`, `REDEC_*`).
+  - `entityId`: Entity identifier if available, otherwise `null`.
+- **`REQUEST_SUBMISSION_FAILED`**: The request submission fails.
+  - `eventName`: `'REQUEST_SUBMISSION_FAILED'`.
+  - `kind`: Uppercase request kind.
+  - `errorCode` (optional): HTTP status as string when available.
+  - `errorMessage` (optional): Error message from the underlying exception.
+- **`VALIDATION_SUCCESSFUL`**: Identity validation linked to a request completes successfully.
+  - `eventName`: `'VALIDATION_SUCCESSFUL'`.
+  - `dataSubjectRequestId`: Identifier of the related request.
+- **`VALIDATION_FAILED`**: Identity validation fails.
+  - `eventName`: `'VALIDATION_FAILED'`.
+  - `dataSubjectRequestId`: Identifier of the related request.
+  - `errorReason` (optional): Reason returned by the validator.
+- **`CONSENT_UPDATED`**: A user grants or revokes a consent successfully.
+  - `eventName`: `'CONSENT_UPDATED'`.
+  - `consentTemplateId`: Identifier of the affected consent template.
+  - `action`: `'grant'` or `'revoke'`.
+  - `actionToken` (optional): Token of the resulting consent action.
+- **`CONSENT_UPDATE_FAILED`**: A consent update fails.
+  - `eventName`: `'CONSENT_UPDATE_FAILED'`.
+  - `consentTemplateId`: Identifier of the affected template.
+  - `action`: `'grant'` or `'revoke'`.
+  - `errorCode` (optional): Error code from the request.
+- **`CONSENT_BATCH_UPDATED`**: The user saves a batch of pending consent changes successfully. Only emitted when the Privacy Center runs in `consentMode: 'batch'`. Fired once with all the changes, not one event per consent.
+  - `eventName`: `'CONSENT_BATCH_UPDATED'`.
+  - `updates`: Array of `{ consentTemplateId, action: 'grant' | 'revoke', actionToken? }`.
+- **`CONSENT_BATCH_UPDATE_FAILED`**: The batch save fails. Only emitted in `consentMode: 'batch'`.
+  - `eventName`: `'CONSENT_BATCH_UPDATE_FAILED'`.
+  - `consentTemplateIds`: Identifiers of the templates included in the failed batch.
+  - `errorCode` (optional): Error code from the request.
+- **`UNEXPECTED_ERROR`**: An uncategorized error occurs inside the flow.
+  - `eventName`: `'UNEXPECTED_ERROR'`.
+  - `context`: Short identifier of where the error happened.
+  - `errorMessage` (optional): Error message from the underlying exception.
 
 ## Consent Form Box
 

package/dist/index.d.ts

@@ -58,6 +58,23 @@ declare const CLOSED_EVENT = "WIDGET_CLOSED";
 
 export { configSchema }
 
+declare type ConsentBatchUpdate = {
+    consentTemplateId: string;
+    action: PrivacyCenterConsentAction;
+    actionToken?: string;
+};
+
+declare type ConsentBatchUpdatedEvent = {
+    eventName: 'CONSENT_BATCH_UPDATED';
+    updates: ConsentBatchUpdate[];
+};
+
+declare type ConsentBatchUpdateFailedEvent = {
+    eventName: 'CONSENT_BATCH_UPDATE_FAILED';
+    consentTemplateIds: string[];
+    errorCode?: string;
+};
+
 export declare class ConsentBox extends BaseIframeBox<Record<string, unknown>, ConsentConfig> {
     readonly defaultIframePrefix = "consent-box";
     readonly defaultIframeCSSConfig: IframeCSSConfig;
@@ -151,6 +168,20 @@ declare type ConsentState = {
     actionToken: string | null;
 };
 
+declare type ConsentUpdatedEvent = {
+    eventName: 'CONSENT_UPDATED';
+    consentTemplateId: string;
+    action: PrivacyCenterConsentAction;
+    actionToken?: string;
+};
+
+declare type ConsentUpdateFailedEvent = {
+    eventName: 'CONSENT_UPDATE_FAILED';
+    consentTemplateId: string;
+    action: PrivacyCenterConsentAction;
+    errorCode?: string;
+};
+
 declare type CSSProperties = {
     appearance?: string;
     accentColor?: string;
@@ -371,7 +402,7 @@ declare type NewDisclosureRequestProps = {
     customColor?: string;
 };
 
-export declare class PrivacyCenterBox extends BaseIframeBox<Record<string, unknown>, PrivacyCenterConfig> {
+export declare class PrivacyCenterBox extends BaseIframeBox<PrivacyCenterEvent, PrivacyCenterConfig> {
     readonly defaultIframePrefix = "privacy-center";
     protected readonly _uniqueIdentifier = "privacy-center";
     readonly defaultIframeCSSConfig: IframeCSSConfig;
@@ -380,7 +411,7 @@ export declare class PrivacyCenterBox extends BaseIframeBox<Record<string, unkno
     iframeUrl(): string;
 }
 
-declare type PrivacyCenterConfig = BaseConfig & {
+declare type PrivacyCenterConfig = BaseConfig<PrivacyCenterEvent> & {
     enabledFeatures?: PrivacyManagerFeature[];
     enabledRights?: PrivacyCenterRight[];
     enabledKinds?: DataSubjectRequestKind[];
@@ -393,6 +424,7 @@ declare type PrivacyCenterConfig = BaseConfig & {
         allowedExtensions?: string[];
         maxFileSize?: number;
     };
+    rectificationFileRequiredCategories?: UserDataCategoryKey[];
     consentMode?: 'immediate' | 'batch';
     consentRetentionPeriod?: string;
     allowGranularScopeSelection?: boolean;
@@ -415,6 +447,8 @@ declare type PrivacyCenterConfig = BaseConfig & {
     companyId?: never;
 });
 
+declare type PrivacyCenterConsentAction = 'grant' | 'revoke';
+
 declare type PrivacyCenterConsentManagementConfig = {
     scopeGroups?: [
     PrivacyCenterConsentManagementScopeGroupConfig,
@@ -438,6 +472,8 @@ declare type PrivacyCenterContentConfig = {
     rightExamples?: Partial<Record<DataSubjectRequestKind, string>>;
 };
 
+declare type PrivacyCenterEvent = RequestSubmittedEvent | RequestSubmissionFailedEvent | ValidationSuccessfulEvent | ValidationFailedEvent | ConsentUpdatedEvent | ConsentUpdateFailedEvent | ConsentBatchUpdatedEvent | ConsentBatchUpdateFailedEvent | UnexpectedErrorEvent;
+
 declare type PrivacyCenterHeaderCopyConfig = {
     title?: string;
     description?: string;
@@ -467,6 +503,20 @@ declare type Request_2 = 'disclosure' | 'signature' | 'authentication';
 
 declare type RequestConfig = DisclosureRequestConfig | SignatureRequestConfig | AuthRequestConfig;
 
+declare type RequestSubmissionFailedEvent = {
+    eventName: 'REQUEST_SUBMISSION_FAILED';
+    kind: Uppercase<DataSubjectRequestKind>;
+    errorCode?: string;
+    errorMessage?: string;
+};
+
+declare type RequestSubmittedEvent = {
+    eventName: 'REQUEST_SUBMITTED';
+    dataSubjectRequestId: string;
+    kind: Uppercase<DataSubjectRequestKind>;
+    entityId: string | null;
+};
+
 declare type SignatureAttemptProps = {
     signatureAttemptId: `sa_${string}`;
     customColor?: string;
@@ -661,6 +711,18 @@ declare namespace SoyioTypes {
         ConsentEvent,
         ConsentConfig,
         PrivacyCenterConfig,
+        PrivacyCenterEvent,
+        PrivacyCenterConsentAction,
+        RequestSubmittedEvent,
+        RequestSubmissionFailedEvent,
+        ValidationSuccessfulEvent,
+        ValidationFailedEvent,
+        ConsentUpdatedEvent,
+        ConsentUpdateFailedEvent,
+        ConsentBatchUpdate,
+        ConsentBatchUpdatedEvent,
+        ConsentBatchUpdateFailedEvent,
+        UnexpectedErrorEvent,
         ConsentFormConfig,
         ConsentFormEvent,
         ConsentFormLocale,
@@ -745,8 +807,25 @@ export declare class _TooltipManager {
     destroy(): void;
 }
 
+declare type UnexpectedErrorEvent = {
+    eventName: 'UNEXPECTED_ERROR';
+    context: string;
+    errorMessage?: string;
+};
+
 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];
 
+declare type ValidationFailedEvent = {
+    eventName: 'VALIDATION_FAILED';
+    dataSubjectRequestId: string;
+    errorReason?: string;
+};
+
+declare type ValidationSuccessfulEvent = {
+    eventName: 'VALIDATION_SUCCESSFUL';
+    dataSubjectRequestId: string;
+};
+
 export { }