@redacto.io/consent-sdk-js 1.0.0-beta.1 → 1.1.0

package/dist/redacto.d.mts

@@ -1,9 +1,39 @@
+/**
+ * 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`, 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 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 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;
@@ -24,10 +54,25 @@ type Settings = {
     font?: string;
 };
 
-type ModalOptions = {
+type ModalOptions = SandboxOptions & {
     noticeId: string;
-    accessToken: string;
-    refreshToken: string;
+    /** JWT access token. Optional so sandbox mode (see `token`) can omit it. */
+    accessToken?: string;
+    /** JWT refresh token. Optional; accepted for source-compat, currently unused. */
+    refreshToken?: string;
+    /**
+     * Sandbox test subject email. The static `token` carries no identity, so the
+     * acting principal is read from `email` (or `mobile`) -- both optional, supply
+     * whichever you have. Mirrors the React SDK props.
+     */
+    email?: string;
+    /** Sandbox test subject mobile (used when `email` is absent). */
+    mobile?: string;
+    /**
+     * Sandbox UCIC: the client's own user id / org_user_id, e.g. a UUID or
+     * customer code; optional third identifier alongside email/mobile.
+     */
+    ucic?: string;
     baseUrl?: string;
     /** Go ledger base URL — serves check-consent and the consent write; omit to use the legacy consent server. */
     ledgerBaseUrl?: string;

package/dist/redacto.d.ts

@@ -1,9 +1,39 @@
+/**
+ * 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`, 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 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 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;
@@ -24,10 +54,25 @@ type Settings = {
     font?: string;
 };
 
-type ModalOptions = {
+type ModalOptions = SandboxOptions & {
     noticeId: string;
-    accessToken: string;
-    refreshToken: string;
+    /** JWT access token. Optional so sandbox mode (see `token`) can omit it. */
+    accessToken?: string;
+    /** JWT refresh token. Optional; accepted for source-compat, currently unused. */
+    refreshToken?: string;
+    /**
+     * Sandbox test subject email. The static `token` carries no identity, so the
+     * acting principal is read from `email` (or `mobile`) -- both optional, supply
+     * whichever you have. Mirrors the React SDK props.
+     */
+    email?: string;
+    /** Sandbox test subject mobile (used when `email` is absent). */
+    mobile?: string;
+    /**
+     * Sandbox UCIC: the client's own user id / org_user_id, e.g. a UUID or
+     * customer code; optional third identifier alongside email/mobile.
+     */
+    ucic?: string;
     baseUrl?: string;
     /** Go ledger base URL — serves check-consent and the consent write; omit to use the legacy consent server. */
     ledgerBaseUrl?: string;