@redacto.io/consent-sdk-react 10.3.1 → 11.0.0-beta.2

package/dist/index.d.mts

@@ -341,6 +341,11 @@ type ConsentFlowState = "age-check" | "guardian-details" | "digilocker-pending"
  */
 type DigiLockerCallbackProps = {
     accessToken: string;
+    /**
+     * API host, e.g. https://api.redacto.io (recommended). The consent server
+     * URL (…/consent) still works but is deprecated. Defaults to the URL the
+     * notice stored before redirecting.
+     */
     baseUrl?: string;
     onSuccess?: (verificationReference: string) => void;
     onError?: (error: Error, errorCode?: GuardianVerificationErrorCode) => void;
@@ -376,7 +381,17 @@ type Props$1 = Readonly<{
     organisationUuid?: string;
     /** Sandbox workspace UUID (replaces the JWT-decoded workspace in sandbox mode). */
     workspaceUuid?: string;
+    /**
+     * API host, e.g. https://api.redacto.io (recommended). The consent server
+     * URL (…/consent) still works but is deprecated.
+     * When omitted, the SDK's built-in production default is used.
+     */
     baseUrl?: string;
+    /**
+     * @deprecated Read only when `baseUrl` is the consent server URL
+     * (`…/consent`) or omitted, as in earlier releases. Ignored when `baseUrl`
+     * is the API host.
+     */
     ledgerBaseUrl?: string;
     /**
      * Optional code-side styling. The notice's look is set in the Redacto
@@ -452,7 +467,17 @@ type Props = Readonly<{
     notice_uuid: string;
     accessToken?: string;
     refreshToken?: string;
+    /**
+     * API host, e.g. https://api.redacto.io (recommended). The consent server
+     * URL (…/consent) still works but is deprecated.
+     * When omitted, the SDK's built-in production default is used.
+     */
     baseUrl?: string;
+    /**
+     * @deprecated Read only when `baseUrl` is the consent server URL
+     * (`…/consent`) or omitted, as in earlier releases. Ignored when `baseUrl`
+     * is the API host.
+     */
     ledgerBaseUrl?: string;
     /**
      * Optional code-side styling; overrides the appearance set in the Redacto
@@ -468,7 +493,7 @@ type Props = Readonly<{
 }>;
 
 declare const RedactoConsentInline: React.MemoExoticComponent<{
-    ({ org_uuid, workspace_uuid, notice_uuid, accessToken, baseUrl, ledgerBaseUrl, language, onAccept, onError, onValidationChange, settings, applicationId, }: Props): React.JSX.Element | null;
+    ({ org_uuid, workspace_uuid, notice_uuid, accessToken, baseUrl: baseUrlProp, ledgerBaseUrl: ledgerBaseUrlProp, language, onAccept, onError, onValidationChange, settings, applicationId, }: Props): React.JSX.Element | null;
     displayName: string;
 }>;
 
@@ -484,9 +509,18 @@ type RedactoNoticeAssistedProps = {
     workspaceUuid: string;
     /** Notice UUID to fetch and render. */
     noticeUuid: string;
-    /** API base URL (defaults to the production consent API). */
+    /**
+     * API host, e.g. https://api.redacto.io (recommended). The consent server
+     * URL (…/consent) still works but is deprecated.
+     * When omitted, the SDK's built-in production default is used.
+     */
     baseUrl?: string;
-    /** Go ledger base URL — routes the consent write to the ledger; omit to use the legacy consent server. */
+    /**
+     * @deprecated Read only when `baseUrl` is the consent server URL
+     * (`…/consent`) or omitted, as in earlier releases. Ignored when `baseUrl`
+     * is the API host. With the consent server URL, it routes the consent write to
+     * the ledger; omit it there to use the legacy consent server.
+     */
     ledgerBaseUrl?: string;
     /** Called when the agent/customer declines (host should unmount the modal). */
     onDecline?: () => void;
@@ -514,7 +548,7 @@ type RedactoNoticeAssistedProps = {
  * submit, `onComplete` fires immediately with no confirmation screen (mirroring
  * RedactoNoticeConsent's `onAccept`). Steps: `notice` → `verify` (with `otpSent`).
  */
-declare const RedactoNoticeAssisted: ({ organisationUuid, workspaceUuid, noticeUuid, baseUrl, ledgerBaseUrl, onDecline, onComplete, settings, }: RedactoNoticeAssistedProps) => React.JSX.Element;
+declare const RedactoNoticeAssisted: ({ organisationUuid, workspaceUuid, noticeUuid, baseUrl: baseUrlProp, ledgerBaseUrl: ledgerBaseUrlProp, onDecline, onComplete, settings, }: RedactoNoticeAssistedProps) => React.JSX.Element;
 
 /**
  * The notice exactly as the SDK draws it, from content the Redacto console

package/dist/index.d.ts

@@ -341,6 +341,11 @@ type ConsentFlowState = "age-check" | "guardian-details" | "digilocker-pending"
  */
 type DigiLockerCallbackProps = {
     accessToken: string;
+    /**
+     * API host, e.g. https://api.redacto.io (recommended). The consent server
+     * URL (…/consent) still works but is deprecated. Defaults to the URL the
+     * notice stored before redirecting.
+     */
     baseUrl?: string;
     onSuccess?: (verificationReference: string) => void;
     onError?: (error: Error, errorCode?: GuardianVerificationErrorCode) => void;
@@ -376,7 +381,17 @@ type Props$1 = Readonly<{
     organisationUuid?: string;
     /** Sandbox workspace UUID (replaces the JWT-decoded workspace in sandbox mode). */
     workspaceUuid?: string;
+    /**
+     * API host, e.g. https://api.redacto.io (recommended). The consent server
+     * URL (…/consent) still works but is deprecated.
+     * When omitted, the SDK's built-in production default is used.
+     */
     baseUrl?: string;
+    /**
+     * @deprecated Read only when `baseUrl` is the consent server URL
+     * (`…/consent`) or omitted, as in earlier releases. Ignored when `baseUrl`
+     * is the API host.
+     */
     ledgerBaseUrl?: string;
     /**
      * Optional code-side styling. The notice's look is set in the Redacto
@@ -452,7 +467,17 @@ type Props = Readonly<{
     notice_uuid: string;
     accessToken?: string;
     refreshToken?: string;
+    /**
+     * API host, e.g. https://api.redacto.io (recommended). The consent server
+     * URL (…/consent) still works but is deprecated.
+     * When omitted, the SDK's built-in production default is used.
+     */
     baseUrl?: string;
+    /**
+     * @deprecated Read only when `baseUrl` is the consent server URL
+     * (`…/consent`) or omitted, as in earlier releases. Ignored when `baseUrl`
+     * is the API host.
+     */
     ledgerBaseUrl?: string;
     /**
      * Optional code-side styling; overrides the appearance set in the Redacto
@@ -468,7 +493,7 @@ type Props = Readonly<{
 }>;
 
 declare const RedactoConsentInline: React.MemoExoticComponent<{
-    ({ org_uuid, workspace_uuid, notice_uuid, accessToken, baseUrl, ledgerBaseUrl, language, onAccept, onError, onValidationChange, settings, applicationId, }: Props): React.JSX.Element | null;
+    ({ org_uuid, workspace_uuid, notice_uuid, accessToken, baseUrl: baseUrlProp, ledgerBaseUrl: ledgerBaseUrlProp, language, onAccept, onError, onValidationChange, settings, applicationId, }: Props): React.JSX.Element | null;
     displayName: string;
 }>;
 
@@ -484,9 +509,18 @@ type RedactoNoticeAssistedProps = {
     workspaceUuid: string;
     /** Notice UUID to fetch and render. */
     noticeUuid: string;
-    /** API base URL (defaults to the production consent API). */
+    /**
+     * API host, e.g. https://api.redacto.io (recommended). The consent server
+     * URL (…/consent) still works but is deprecated.
+     * When omitted, the SDK's built-in production default is used.
+     */
     baseUrl?: string;
-    /** Go ledger base URL — routes the consent write to the ledger; omit to use the legacy consent server. */
+    /**
+     * @deprecated Read only when `baseUrl` is the consent server URL
+     * (`…/consent`) or omitted, as in earlier releases. Ignored when `baseUrl`
+     * is the API host. With the consent server URL, it routes the consent write to
+     * the ledger; omit it there to use the legacy consent server.
+     */
     ledgerBaseUrl?: string;
     /** Called when the agent/customer declines (host should unmount the modal). */
     onDecline?: () => void;
@@ -514,7 +548,7 @@ type RedactoNoticeAssistedProps = {
  * submit, `onComplete` fires immediately with no confirmation screen (mirroring
  * RedactoNoticeConsent's `onAccept`). Steps: `notice` → `verify` (with `otpSent`).
  */
-declare const RedactoNoticeAssisted: ({ organisationUuid, workspaceUuid, noticeUuid, baseUrl, ledgerBaseUrl, onDecline, onComplete, settings, }: RedactoNoticeAssistedProps) => React.JSX.Element;
+declare const RedactoNoticeAssisted: ({ organisationUuid, workspaceUuid, noticeUuid, baseUrl: baseUrlProp, ledgerBaseUrl: ledgerBaseUrlProp, onDecline, onComplete, settings, }: RedactoNoticeAssistedProps) => React.JSX.Element;
 
 /**
  * The notice exactly as the SDK draws it, from content the Redacto console