@redacto.io/consent-sdk-js 1.0.0 → 1.2.0-beta.0

package/dist/redacto.d.mts

@@ -1,24 +1,40 @@
 /**
  * Optional sandbox options shared by the SDK's public option shapes and the
  * internal API params. When `token` is set the call sends the single
- * `X-Consent-Token` header instead of `Authorization: Bearer`, injects the
- * subject into each request's own payload, and takes org/workspace from these
- * fields instead of decoding the JWT.
+ * `X-Consent-Token` header instead of `Authorization: Bearer`, carries every
+ * supplied identifier in each request's own payload, and takes org/workspace
+ * from these fields instead of decoding the JWT.
  */
 type SandboxOptions = {
     token?: string;
-    /** UCIC — the client's own user id (`org_user_id`); takes precedence over the subject. */
+    /** UCIC — the client's own user id (`org_user_id`); takes precedence for the principal. */
     sandboxUcic?: string;
+    /** Email — carried on every request like a live JWT's `user_data.primary_email`. */
+    sandboxEmail?: string;
+    /** Mobile — carried on every request like a live JWT's `user_data.primary_mobile`. */
+    sandboxMobile?: string;
+    /**
+     * @deprecated Use `sandboxEmail` / `sandboxMobile` (and/or `email` / `mobile`)
+     * instead. Still accepted for backward compatibility: a value containing "@"
+     * is treated as the email, otherwise the mobile.
+     */
     sandboxSubject?: string;
     organisationUuid?: string;
     workspaceUuid?: string;
 };
+type SelectionControlType = "checkbox" | "radio" | "dropdown";
 type Settings = {
     button: {
+        /** Styles the "accept selected" button. */
         accept: {
             backgroundColor: string;
             textColor: string;
         };
+        /** Optional: the accept-all shortcut falls back to `accept` when unset. */
+        acceptAll?: {
+            backgroundColor: string;
+            textColor: string;
+        };
         decline: {
             backgroundColor: string;
             textColor: string;
@@ -37,6 +53,8 @@ type Settings = {
     textColor?: string;
     borderColor?: string;
     font?: string;
+    selectionControl?: SelectionControlType;
+    confirmBeforeSubmit?: boolean;
 };
 
 type ModalOptions = SandboxOptions & {
@@ -73,6 +91,8 @@ type ModalOptions = SandboxOptions & {
     digilockerCallbackUrl?: string;
     includeFullyConsentedData?: boolean;
     reviewModeButtonText?: string;
+    defaultOpenProducts?: string[];
+    otpGate?: OtpGateOptions;
 };
 type InlineOptions = {
     target: string | HTMLElement;
@@ -98,6 +118,68 @@ type DigiLockerCallbackOptions = {
     onSuccess?: (verificationReference: string) => void;
     onError?: (error: Error, errorCode?: string) => void;
 };
+type OtpVerifyResult = {
+    ok: boolean;
+    message?: string;
+};
+type OtpGateOptions = {
+    required: boolean;
+    onVerify: (code: string) => Promise<OtpVerifyResult>;
+    title?: string;
+    description?: string;
+    submitLabel?: string;
+};
+
+type AssistedOptions = {
+    organisationUuid: string;
+    workspaceUuid: string;
+    noticeUuid: string;
+    baseUrl?: string;
+    ledgerBaseUrl?: string;
+    onDecline?: () => void;
+    onComplete?: () => void;
+    onError?: (error: Error) => void;
+};
+
+type PrivacyCenterOptions = {
+    /** Element, or CSS selector for it, that the Privacy Center is mounted in. */
+    target: string | HTMLElement;
+    /** The organisation's Privacy Center slug. Required unless `url` is given. */
+    slug?: string;
+    /** Full URL of the hosted Privacy Center, e.g. on a custom domain. Wins over `slug`. */
+    url?: string;
+    /** Where the hosted Privacy Center lives. Defaults to Redacto's production console. */
+    origin?: string;
+    /** Language to open in (`en`, `hi`, …), sent as `?lang=`. */
+    language?: string;
+    /**
+     * A fixed height (`640` or `"80vh"`). Leave it out (or pass `"auto"`) to let
+     * the frame grow to fit the page, starting at 720px.
+     */
+    height?: number | string;
+    /** The frame's accessible title. Defaults to "Privacy Center". */
+    title?: string;
+};
+type PrivacyCenterHandle = {
+    iframe: HTMLIFrameElement;
+    /** Removes the frame and stops listening for its height. */
+    destroy: () => void;
+};
+
+type ApiErrorCode = "INVALID_TOKEN" | "TOKEN_TENANT_MISMATCH" | "UNAUTHORIZED" | "USER_NOT_FOUND" | "USER_EMAIL_MISMATCH" | "USER_MOBILE_MISMATCH" | "USER_CONTACT_MISMATCH" | "NO_IDENTIFIER_PROVIDED" | "INVALID_PAYLOAD" | "VALIDATION_ERROR" | "NOTICE_NOT_FOUND" | "NOTICE_CONFIGURATION_NOT_FOUND" | "NOTICE_STILL_IN_DRAFT" | "CONSENT_ALREADY_PROVIDED" | "PURPOSE_NOT_FOUND" | "INVALID_PURPOSE" | "INVALID_DATA_ELEMENTS" | "MISSING_PURPOSE" | "MISSING_DATA_ELEMENTS" | "REQUIRED_DATA_ELEMENT_NOT_ENABLED" | "AUDIO_NOT_FOUND" | "INVALID_LANGUAGE" | "VERIFICATION_FAILED" | "VERIFICATION_EXPIRED" | "GUARDIAN_INFO_NOT_FOUND" | "GUARDIAN_SESSION_INVALID" | "SESSION_EXPIRED" | "INTERNAL_ERROR";
+type ApiErrorCodeLike = ApiErrorCode | (string & {});
+
+declare class ApiError extends Error {
+    readonly status: number;
+    readonly code?: ApiErrorCodeLike;
+    readonly shouldRequestNew?: boolean;
+    constructor(opts: {
+        status: number;
+        code?: ApiErrorCodeLike;
+        message: string;
+        shouldRequestNew?: boolean;
+    });
+}
 
 /**
  * Initialize a modal consent dialog.
@@ -109,6 +191,13 @@ declare function init(options: ModalOptions): void;
  * Renders consent purposes inside a target container element.
  */
 declare function inline(options: InlineOptions): void;
+declare function updateToken(accessToken: string): void;
+declare function assisted(options: AssistedOptions): void;
+/**
+ * Mount the hosted Privacy Center in an iframe inside a target element.
+ * Returns a handle whose `destroy()` removes it.
+ */
+declare function privacyCenter(options: PrivacyCenterOptions): PrivacyCenterHandle;
 /**
  * Destroy all active consent instances.
  */
@@ -121,9 +210,12 @@ declare function digilockerCallback(options: DigiLockerCallbackOptions): void;
 declare const RedactoConsent: {
     init: typeof init;
     inline: typeof inline;
+    assisted: typeof assisted;
+    privacyCenter: typeof privacyCenter;
     destroy: typeof destroy;
     digilockerCallback: typeof digilockerCallback;
+    updateToken: typeof updateToken;
     version: string;
 };
 
-export { type DigiLockerCallbackOptions, type InlineOptions, type ModalOptions, type Settings, RedactoConsent as default, destroy, digilockerCallback, init, inline };
+export { ApiError, type ApiErrorCode, type AssistedOptions, type DigiLockerCallbackOptions, type InlineOptions, type ModalOptions, type OtpGateOptions, type OtpVerifyResult, type PrivacyCenterHandle, type PrivacyCenterOptions, type Settings, assisted, RedactoConsent as default, destroy, digilockerCallback, init, inline, privacyCenter, updateToken };

package/dist/redacto.d.ts

@@ -1,24 +1,40 @@
 /**
  * Optional sandbox options shared by the SDK's public option shapes and the
  * internal API params. When `token` is set the call sends the single
- * `X-Consent-Token` header instead of `Authorization: Bearer`, injects the
- * subject into each request's own payload, and takes org/workspace from these
- * fields instead of decoding the JWT.
+ * `X-Consent-Token` header instead of `Authorization: Bearer`, carries every
+ * supplied identifier in each request's own payload, and takes org/workspace
+ * from these fields instead of decoding the JWT.
  */
 type SandboxOptions = {
     token?: string;
-    /** UCIC — the client's own user id (`org_user_id`); takes precedence over the subject. */
+    /** UCIC — the client's own user id (`org_user_id`); takes precedence for the principal. */
     sandboxUcic?: string;
+    /** Email — carried on every request like a live JWT's `user_data.primary_email`. */
+    sandboxEmail?: string;
+    /** Mobile — carried on every request like a live JWT's `user_data.primary_mobile`. */
+    sandboxMobile?: string;
+    /**
+     * @deprecated Use `sandboxEmail` / `sandboxMobile` (and/or `email` / `mobile`)
+     * instead. Still accepted for backward compatibility: a value containing "@"
+     * is treated as the email, otherwise the mobile.
+     */
     sandboxSubject?: string;
     organisationUuid?: string;
     workspaceUuid?: string;
 };
+type SelectionControlType = "checkbox" | "radio" | "dropdown";
 type Settings = {
     button: {
+        /** Styles the "accept selected" button. */
         accept: {
             backgroundColor: string;
             textColor: string;
         };
+        /** Optional: the accept-all shortcut falls back to `accept` when unset. */
+        acceptAll?: {
+            backgroundColor: string;
+            textColor: string;
+        };
         decline: {
             backgroundColor: string;
             textColor: string;
@@ -37,6 +53,8 @@ type Settings = {
     textColor?: string;
     borderColor?: string;
     font?: string;
+    selectionControl?: SelectionControlType;
+    confirmBeforeSubmit?: boolean;
 };
 
 type ModalOptions = SandboxOptions & {
@@ -73,6 +91,8 @@ type ModalOptions = SandboxOptions & {
     digilockerCallbackUrl?: string;
     includeFullyConsentedData?: boolean;
     reviewModeButtonText?: string;
+    defaultOpenProducts?: string[];
+    otpGate?: OtpGateOptions;
 };
 type InlineOptions = {
     target: string | HTMLElement;
@@ -98,6 +118,68 @@ type DigiLockerCallbackOptions = {
     onSuccess?: (verificationReference: string) => void;
     onError?: (error: Error, errorCode?: string) => void;
 };
+type OtpVerifyResult = {
+    ok: boolean;
+    message?: string;
+};
+type OtpGateOptions = {
+    required: boolean;
+    onVerify: (code: string) => Promise<OtpVerifyResult>;
+    title?: string;
+    description?: string;
+    submitLabel?: string;
+};
+
+type AssistedOptions = {
+    organisationUuid: string;
+    workspaceUuid: string;
+    noticeUuid: string;
+    baseUrl?: string;
+    ledgerBaseUrl?: string;
+    onDecline?: () => void;
+    onComplete?: () => void;
+    onError?: (error: Error) => void;
+};
+
+type PrivacyCenterOptions = {
+    /** Element, or CSS selector for it, that the Privacy Center is mounted in. */
+    target: string | HTMLElement;
+    /** The organisation's Privacy Center slug. Required unless `url` is given. */
+    slug?: string;
+    /** Full URL of the hosted Privacy Center, e.g. on a custom domain. Wins over `slug`. */
+    url?: string;
+    /** Where the hosted Privacy Center lives. Defaults to Redacto's production console. */
+    origin?: string;
+    /** Language to open in (`en`, `hi`, …), sent as `?lang=`. */
+    language?: string;
+    /**
+     * A fixed height (`640` or `"80vh"`). Leave it out (or pass `"auto"`) to let
+     * the frame grow to fit the page, starting at 720px.
+     */
+    height?: number | string;
+    /** The frame's accessible title. Defaults to "Privacy Center". */
+    title?: string;
+};
+type PrivacyCenterHandle = {
+    iframe: HTMLIFrameElement;
+    /** Removes the frame and stops listening for its height. */
+    destroy: () => void;
+};
+
+type ApiErrorCode = "INVALID_TOKEN" | "TOKEN_TENANT_MISMATCH" | "UNAUTHORIZED" | "USER_NOT_FOUND" | "USER_EMAIL_MISMATCH" | "USER_MOBILE_MISMATCH" | "USER_CONTACT_MISMATCH" | "NO_IDENTIFIER_PROVIDED" | "INVALID_PAYLOAD" | "VALIDATION_ERROR" | "NOTICE_NOT_FOUND" | "NOTICE_CONFIGURATION_NOT_FOUND" | "NOTICE_STILL_IN_DRAFT" | "CONSENT_ALREADY_PROVIDED" | "PURPOSE_NOT_FOUND" | "INVALID_PURPOSE" | "INVALID_DATA_ELEMENTS" | "MISSING_PURPOSE" | "MISSING_DATA_ELEMENTS" | "REQUIRED_DATA_ELEMENT_NOT_ENABLED" | "AUDIO_NOT_FOUND" | "INVALID_LANGUAGE" | "VERIFICATION_FAILED" | "VERIFICATION_EXPIRED" | "GUARDIAN_INFO_NOT_FOUND" | "GUARDIAN_SESSION_INVALID" | "SESSION_EXPIRED" | "INTERNAL_ERROR";
+type ApiErrorCodeLike = ApiErrorCode | (string & {});
+
+declare class ApiError extends Error {
+    readonly status: number;
+    readonly code?: ApiErrorCodeLike;
+    readonly shouldRequestNew?: boolean;
+    constructor(opts: {
+        status: number;
+        code?: ApiErrorCodeLike;
+        message: string;
+        shouldRequestNew?: boolean;
+    });
+}
 
 /**
  * Initialize a modal consent dialog.
@@ -109,6 +191,13 @@ declare function init(options: ModalOptions): void;
  * Renders consent purposes inside a target container element.
  */
 declare function inline(options: InlineOptions): void;
+declare function updateToken(accessToken: string): void;
+declare function assisted(options: AssistedOptions): void;
+/**
+ * Mount the hosted Privacy Center in an iframe inside a target element.
+ * Returns a handle whose `destroy()` removes it.
+ */
+declare function privacyCenter(options: PrivacyCenterOptions): PrivacyCenterHandle;
 /**
  * Destroy all active consent instances.
  */
@@ -121,9 +210,12 @@ declare function digilockerCallback(options: DigiLockerCallbackOptions): void;
 declare const RedactoConsent: {
     init: typeof init;
     inline: typeof inline;
+    assisted: typeof assisted;
+    privacyCenter: typeof privacyCenter;
     destroy: typeof destroy;
     digilockerCallback: typeof digilockerCallback;
+    updateToken: typeof updateToken;
     version: string;
 };
 
-export { type DigiLockerCallbackOptions, type InlineOptions, type ModalOptions, type Settings, RedactoConsent as default, destroy, digilockerCallback, init, inline };
+export { ApiError, type ApiErrorCode, type AssistedOptions, type DigiLockerCallbackOptions, type InlineOptions, type ModalOptions, type OtpGateOptions, type OtpVerifyResult, type PrivacyCenterHandle, type PrivacyCenterOptions, type Settings, assisted, RedactoConsent as default, destroy, digilockerCallback, init, inline, privacyCenter, updateToken };