@notabene/javascript-sdk 2.17.0 → 2.18.0-next.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -753,6 +753,43 @@ export declare type ConnectionResult<T extends ComponentRequest> = {
753
753
 
754
754
  export declare type ConnectionStatus = 'active' | 'completed' | 'closed';
755
755
 
756
+ /**
757
+ * Configuration for the terms and conditions consent checkbox.
758
+ *
759
+ * @remarks
760
+ * - `undefined` or `true`: show default T&C (current behavior)
761
+ * - `false`: hide T&C entirely
762
+ * - `{ label?, description? }`: show with custom text (translations are the customer's responsibility)
763
+ *
764
+ * @public
765
+ */
766
+ export declare type ConsentConfig = boolean | {
767
+ /** Custom label text. Replaces the default "Accept terms and conditions". */
768
+ label?: string;
769
+ /** Custom description text. Replaces the default sharing-info description. */
770
+ description?: string;
771
+ };
772
+
773
+ /**
774
+ * Configuration for the contact support action.
775
+ *
776
+ * @remarks
777
+ * Contact support is **enabled** by including `'contact-support'` in
778
+ * `agentSections.main` or `agentSections.fallback`. This object only
779
+ * configures the behaviour when the feature is enabled.
780
+ *
781
+ * - With `contactSupport: { supportUrl: "..." }` — clicking sends an info
782
+ * message to the host **and** attempts to open the URL as a fallback.
783
+ * - Without `contactSupport` — clicking only sends an info message; the
784
+ * host decides what to do.
785
+ *
786
+ * @public
787
+ */
788
+ export declare interface ContactSupportConfig {
789
+ /** URL to open when the user clicks the support button */
790
+ supportUrl: string;
791
+ }
792
+
756
793
  /**
757
794
  * Metadata for Cosmos ownership proofs
758
795
  * @remarks
@@ -1156,14 +1193,24 @@ export declare enum IdentityVerificationMethod {
1156
1193
  * Represents an info component message
1157
1194
  * @param message - Info message
1158
1195
  * @param description - Description of the info message
1196
+ * @param identifier - Identifier code of the info message
1159
1197
  * @public
1160
1198
  */
1161
1199
  declare type Info = {
1162
1200
  type: CMType.INFO;
1163
1201
  message: string;
1164
1202
  description?: string;
1203
+ identifier?: InfoIdentifierCode;
1165
1204
  };
1166
1205
 
1206
+ /**
1207
+ * Identifier codes for info messages
1208
+ * @public
1209
+ */
1210
+ export declare enum InfoIdentifierCode {
1211
+ CONTACT_SUPPORT = "CONTACT_SUPPORT"
1212
+ }
1213
+
1167
1214
  /**
1168
1215
  * Intermediary VASP
1169
1216
  * Represents an intermediary Virtual Asset Service Provider
@@ -2924,13 +2971,14 @@ export declare interface ScreenshotProof extends OwnershipProof {
2924
2971
  * - `'signature'` — wallet connection for ownership proof via signature
2925
2972
  * - `'manual-signing'` — ownership proof via manual message signing
2926
2973
  * - `'add-vasp'` — manually add an unlisted exchange/VASP (hosted flow)
2974
+ * - `'contact-support'` — show a contact support button
2927
2975
  *
2928
2976
  * Options are automatically filtered by flow (e.g. `add-vasp` is ignored in self-hosted).
2929
2977
  * Including an option implicitly enables that capability.
2930
2978
  *
2931
2979
  * @public
2932
2980
  */
2933
- export declare type SectionOption = 'self-declaration' | 'screenshot' | 'microtransfer' | 'signature' | 'manual-signing' | 'add-vasp';
2981
+ export declare type SectionOption = 'self-declaration' | 'screenshot' | 'microtransfer' | 'signature' | 'manual-signing' | 'add-vasp' | 'contact-support';
2934
2982
 
2935
2983
  /**
2936
2984
  * Interface for signature-based ownership proofs that use cryptographic message signing
@@ -3299,6 +3347,8 @@ export declare interface TransactionOptions {
3299
3347
  vasps?: VASPOptions;
3300
3348
  hide?: ValidationSections[];
3301
3349
  counterpartyAssist?: CounterpartyAssistConfig;
3350
+ contactSupport?: ContactSupportConfig;
3351
+ consent?: ConsentConfig;
3302
3352
  autoSubmit?: boolean;
3303
3353
  }
3304
3354
 
@@ -10,7 +10,7 @@
10
10
  "author": "Notabene <developers@notabene.id>",
11
11
  "license": "MIT",
12
12
  "packageManager": "yarn@4.5.1",
13
- "version": "2.17.0",
13
+ "version": "2.18.0-next.3",
14
14
  "source": "src/notabene.ts",
15
15
  "main": "dist/cjs/notabene.cjs",
16
16
  "module": "dist/esm/notabene.js",
@@ -753,6 +753,43 @@ export declare type ConnectionResult<T extends ComponentRequest> = {
753
753
 
754
754
  export declare type ConnectionStatus = 'active' | 'completed' | 'closed';
755
755
 
756
+ /**
757
+ * Configuration for the terms and conditions consent checkbox.
758
+ *
759
+ * @remarks
760
+ * - `undefined` or `true`: show default T&C (current behavior)
761
+ * - `false`: hide T&C entirely
762
+ * - `{ label?, description? }`: show with custom text (translations are the customer's responsibility)
763
+ *
764
+ * @public
765
+ */
766
+ export declare type ConsentConfig = boolean | {
767
+ /** Custom label text. Replaces the default "Accept terms and conditions". */
768
+ label?: string;
769
+ /** Custom description text. Replaces the default sharing-info description. */
770
+ description?: string;
771
+ };
772
+
773
+ /**
774
+ * Configuration for the contact support action.
775
+ *
776
+ * @remarks
777
+ * Contact support is **enabled** by including `'contact-support'` in
778
+ * `agentSections.main` or `agentSections.fallback`. This object only
779
+ * configures the behaviour when the feature is enabled.
780
+ *
781
+ * - With `contactSupport: { supportUrl: "..." }` — clicking sends an info
782
+ * message to the host **and** attempts to open the URL as a fallback.
783
+ * - Without `contactSupport` — clicking only sends an info message; the
784
+ * host decides what to do.
785
+ *
786
+ * @public
787
+ */
788
+ export declare interface ContactSupportConfig {
789
+ /** URL to open when the user clicks the support button */
790
+ supportUrl: string;
791
+ }
792
+
756
793
  /**
757
794
  * Metadata for Cosmos ownership proofs
758
795
  * @remarks
@@ -1156,14 +1193,24 @@ export declare enum IdentityVerificationMethod {
1156
1193
  * Represents an info component message
1157
1194
  * @param message - Info message
1158
1195
  * @param description - Description of the info message
1196
+ * @param identifier - Identifier code of the info message
1159
1197
  * @public
1160
1198
  */
1161
1199
  declare type Info = {
1162
1200
  type: CMType.INFO;
1163
1201
  message: string;
1164
1202
  description?: string;
1203
+ identifier?: InfoIdentifierCode;
1165
1204
  };
1166
1205
 
1206
+ /**
1207
+ * Identifier codes for info messages
1208
+ * @public
1209
+ */
1210
+ export declare enum InfoIdentifierCode {
1211
+ CONTACT_SUPPORT = "CONTACT_SUPPORT"
1212
+ }
1213
+
1167
1214
  /**
1168
1215
  * Intermediary VASP
1169
1216
  * Represents an intermediary Virtual Asset Service Provider
@@ -2924,13 +2971,14 @@ export declare interface ScreenshotProof extends OwnershipProof {
2924
2971
  * - `'signature'` — wallet connection for ownership proof via signature
2925
2972
  * - `'manual-signing'` — ownership proof via manual message signing
2926
2973
  * - `'add-vasp'` — manually add an unlisted exchange/VASP (hosted flow)
2974
+ * - `'contact-support'` — show a contact support button
2927
2975
  *
2928
2976
  * Options are automatically filtered by flow (e.g. `add-vasp` is ignored in self-hosted).
2929
2977
  * Including an option implicitly enables that capability.
2930
2978
  *
2931
2979
  * @public
2932
2980
  */
2933
- export declare type SectionOption = 'self-declaration' | 'screenshot' | 'microtransfer' | 'signature' | 'manual-signing' | 'add-vasp';
2981
+ export declare type SectionOption = 'self-declaration' | 'screenshot' | 'microtransfer' | 'signature' | 'manual-signing' | 'add-vasp' | 'contact-support';
2934
2982
 
2935
2983
  /**
2936
2984
  * Interface for signature-based ownership proofs that use cryptographic message signing
@@ -3299,6 +3347,8 @@ export declare interface TransactionOptions {
3299
3347
  vasps?: VASPOptions;
3300
3348
  hide?: ValidationSections[];
3301
3349
  counterpartyAssist?: CounterpartyAssistConfig;
3350
+ contactSupport?: ContactSupportConfig;
3351
+ consent?: ConsentConfig;
3302
3352
  autoSubmit?: boolean;
3303
3353
  }
3304
3354