@notabene/javascript-sdk 2.14.2-next.5 → 2.15.0-next.1

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.
@@ -73,6 +73,26 @@ export declare interface Agent {
73
73
  verified?: boolean;
74
74
  }
75
75
 
76
+ /**
77
+ * Explicit layout configuration for the agent selection step.
78
+ *
79
+ * @remarks
80
+ * Controls which options appear in the main selection area vs. behind the
81
+ * "Can't find what you're looking for?" fallback toggle.
82
+ *
83
+ * When the main section has no options (empty or all filtered out), fallback options
84
+ * are promoted and shown inline. When the main section has only one option, a dedicated
85
+ * single-option layout is used.
86
+ *
87
+ * @public
88
+ */
89
+ export declare interface AgentSections {
90
+ /** Options shown in the main selection area (always visible) */
91
+ main?: SectionOption[];
92
+ /** Options shown behind the "Can't find what you're looking for?" fallback toggle */
93
+ fallback?: SectionOption[];
94
+ }
95
+
76
96
  /**
77
97
  * The type of Agent. Either a wallet or a VASP
78
98
  * @public
@@ -1694,6 +1714,25 @@ export declare interface ScreenshotProof extends OwnershipProof {
1694
1714
  url: string;
1695
1715
  }
1696
1716
 
1717
+ /**
1718
+ * Options that can be placed in either the main or fallback sections of the agent selection step.
1719
+ *
1720
+ * @remarks
1721
+ * Combines proof types from {@link ProofTypes} with additional UI-specific options:
1722
+ * - `ProofTypes.SelfDeclaration` — ownership proof via self-declaration
1723
+ * - `ProofTypes.Screenshot` — ownership proof via screenshot upload
1724
+ * - `ProofTypes.MicroTransfer` — ownership proof via micro-transfer
1725
+ * - `'signature'` — wallet connection for ownership proof via signature
1726
+ * - `'manual-signing'` — ownership proof via manual message signing
1727
+ * - `'add-vasp'` — manually add an unlisted exchange/VASP (hosted flow)
1728
+ *
1729
+ * Options are automatically filtered by flow (e.g. `add-vasp` is ignored in self-hosted).
1730
+ * Including an option implicitly enables that capability.
1731
+ *
1732
+ * @public
1733
+ */
1734
+ export declare type SectionOption = ProofTypes.SelfDeclaration | ProofTypes.Screenshot | ProofTypes.MicroTransfer | 'signature' | 'manual-signing' | 'add-vasp';
1735
+
1697
1736
  /**
1698
1737
  * Interface for signature-based ownership proofs that use cryptographic message signing
1699
1738
  *
@@ -1914,6 +1953,11 @@ export declare interface TransactionIVMS101Request {
1914
1953
  * @public
1915
1954
  */
1916
1955
  export declare interface TransactionOptions {
1956
+ /**
1957
+ * Explicit layout configuration for the agent selection step.
1958
+ * When provided, takes precedence over legacy fields (`proofs.fallbacks`, `vasps.addUnknown`).
1959
+ */
1960
+ agentSections?: AgentSections;
1917
1961
  proofs?: {
1918
1962
  reuseProof?: boolean;
1919
1963
  microTransfer?: {
@@ -1931,7 +1975,6 @@ export declare interface TransactionOptions {
1931
1975
  hide?: ValidationSections[];
1932
1976
  counterpartyAssist?: CounterpartyAssistConfig;
1933
1977
  autoSubmit?: boolean;
1934
- supportUrl?: string;
1935
1978
  }
1936
1979
 
1937
1980
  /**
@@ -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.14.2-next.5",
13
+ "version": "2.15.0-next.1",
14
14
  "source": "src/notabene.ts",
15
15
  "main": "dist/cjs/notabene.cjs",
16
16
  "module": "dist/esm/notabene.js",
@@ -73,6 +73,26 @@ export declare interface Agent {
73
73
  verified?: boolean;
74
74
  }
75
75
 
76
+ /**
77
+ * Explicit layout configuration for the agent selection step.
78
+ *
79
+ * @remarks
80
+ * Controls which options appear in the main selection area vs. behind the
81
+ * "Can't find what you're looking for?" fallback toggle.
82
+ *
83
+ * When the main section has no options (empty or all filtered out), fallback options
84
+ * are promoted and shown inline. When the main section has only one option, a dedicated
85
+ * single-option layout is used.
86
+ *
87
+ * @public
88
+ */
89
+ export declare interface AgentSections {
90
+ /** Options shown in the main selection area (always visible) */
91
+ main?: SectionOption[];
92
+ /** Options shown behind the "Can't find what you're looking for?" fallback toggle */
93
+ fallback?: SectionOption[];
94
+ }
95
+
76
96
  /**
77
97
  * The type of Agent. Either a wallet or a VASP
78
98
  * @public
@@ -1694,6 +1714,25 @@ export declare interface ScreenshotProof extends OwnershipProof {
1694
1714
  url: string;
1695
1715
  }
1696
1716
 
1717
+ /**
1718
+ * Options that can be placed in either the main or fallback sections of the agent selection step.
1719
+ *
1720
+ * @remarks
1721
+ * Combines proof types from {@link ProofTypes} with additional UI-specific options:
1722
+ * - `ProofTypes.SelfDeclaration` — ownership proof via self-declaration
1723
+ * - `ProofTypes.Screenshot` — ownership proof via screenshot upload
1724
+ * - `ProofTypes.MicroTransfer` — ownership proof via micro-transfer
1725
+ * - `'signature'` — wallet connection for ownership proof via signature
1726
+ * - `'manual-signing'` — ownership proof via manual message signing
1727
+ * - `'add-vasp'` — manually add an unlisted exchange/VASP (hosted flow)
1728
+ *
1729
+ * Options are automatically filtered by flow (e.g. `add-vasp` is ignored in self-hosted).
1730
+ * Including an option implicitly enables that capability.
1731
+ *
1732
+ * @public
1733
+ */
1734
+ export declare type SectionOption = ProofTypes.SelfDeclaration | ProofTypes.Screenshot | ProofTypes.MicroTransfer | 'signature' | 'manual-signing' | 'add-vasp';
1735
+
1697
1736
  /**
1698
1737
  * Interface for signature-based ownership proofs that use cryptographic message signing
1699
1738
  *
@@ -1914,6 +1953,11 @@ export declare interface TransactionIVMS101Request {
1914
1953
  * @public
1915
1954
  */
1916
1955
  export declare interface TransactionOptions {
1956
+ /**
1957
+ * Explicit layout configuration for the agent selection step.
1958
+ * When provided, takes precedence over legacy fields (`proofs.fallbacks`, `vasps.addUnknown`).
1959
+ */
1960
+ agentSections?: AgentSections;
1917
1961
  proofs?: {
1918
1962
  reuseProof?: boolean;
1919
1963
  microTransfer?: {
@@ -1931,7 +1975,6 @@ export declare interface TransactionOptions {
1931
1975
  hide?: ValidationSections[];
1932
1976
  counterpartyAssist?: CounterpartyAssistConfig;
1933
1977
  autoSubmit?: boolean;
1934
- supportUrl?: string;
1935
1978
  }
1936
1979
 
1937
1980
  /**
@@ -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.14.2-next.5",
13
+ "version": "2.15.0-next.1",
14
14
  "source": "src/notabene.ts",
15
15
  "main": "dist/cjs/notabene.cjs",
16
16
  "module": "dist/esm/notabene.js",
@@ -73,6 +73,26 @@ export declare interface Agent {
73
73
  verified?: boolean;
74
74
  }
75
75
 
76
+ /**
77
+ * Explicit layout configuration for the agent selection step.
78
+ *
79
+ * @remarks
80
+ * Controls which options appear in the main selection area vs. behind the
81
+ * "Can't find what you're looking for?" fallback toggle.
82
+ *
83
+ * When the main section has no options (empty or all filtered out), fallback options
84
+ * are promoted and shown inline. When the main section has only one option, a dedicated
85
+ * single-option layout is used.
86
+ *
87
+ * @public
88
+ */
89
+ export declare interface AgentSections {
90
+ /** Options shown in the main selection area (always visible) */
91
+ main?: SectionOption[];
92
+ /** Options shown behind the "Can't find what you're looking for?" fallback toggle */
93
+ fallback?: SectionOption[];
94
+ }
95
+
76
96
  /**
77
97
  * The type of Agent. Either a wallet or a VASP
78
98
  * @public
@@ -1694,6 +1714,25 @@ export declare interface ScreenshotProof extends OwnershipProof {
1694
1714
  url: string;
1695
1715
  }
1696
1716
 
1717
+ /**
1718
+ * Options that can be placed in either the main or fallback sections of the agent selection step.
1719
+ *
1720
+ * @remarks
1721
+ * Combines proof types from {@link ProofTypes} with additional UI-specific options:
1722
+ * - `ProofTypes.SelfDeclaration` — ownership proof via self-declaration
1723
+ * - `ProofTypes.Screenshot` — ownership proof via screenshot upload
1724
+ * - `ProofTypes.MicroTransfer` — ownership proof via micro-transfer
1725
+ * - `'signature'` — wallet connection for ownership proof via signature
1726
+ * - `'manual-signing'` — ownership proof via manual message signing
1727
+ * - `'add-vasp'` — manually add an unlisted exchange/VASP (hosted flow)
1728
+ *
1729
+ * Options are automatically filtered by flow (e.g. `add-vasp` is ignored in self-hosted).
1730
+ * Including an option implicitly enables that capability.
1731
+ *
1732
+ * @public
1733
+ */
1734
+ export declare type SectionOption = ProofTypes.SelfDeclaration | ProofTypes.Screenshot | ProofTypes.MicroTransfer | 'signature' | 'manual-signing' | 'add-vasp';
1735
+
1697
1736
  /**
1698
1737
  * Interface for signature-based ownership proofs that use cryptographic message signing
1699
1738
  *
@@ -1914,6 +1953,11 @@ export declare interface TransactionIVMS101Request {
1914
1953
  * @public
1915
1954
  */
1916
1955
  export declare interface TransactionOptions {
1956
+ /**
1957
+ * Explicit layout configuration for the agent selection step.
1958
+ * When provided, takes precedence over legacy fields (`proofs.fallbacks`, `vasps.addUnknown`).
1959
+ */
1960
+ agentSections?: AgentSections;
1917
1961
  proofs?: {
1918
1962
  reuseProof?: boolean;
1919
1963
  microTransfer?: {
@@ -1931,7 +1975,6 @@ export declare interface TransactionOptions {
1931
1975
  hide?: ValidationSections[];
1932
1976
  counterpartyAssist?: CounterpartyAssistConfig;
1933
1977
  autoSubmit?: boolean;
1934
- supportUrl?: string;
1935
1978
  }
1936
1979
 
1937
1980
  /**
package/package.json CHANGED
@@ -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.14.2-next.5",
13
+ "version": "2.15.0-next.1",
14
14
  "source": "src/notabene.ts",
15
15
  "main": "dist/cjs/notabene.cjs",
16
16
  "module": "dist/esm/notabene.js",
package/src/notabene.ts CHANGED
@@ -2,6 +2,7 @@ import EmbeddedComponent from './components/EmbeddedComponent';
2
2
  import type {
3
3
  Account,
4
4
  Agent,
5
+ AgentSections,
5
6
  BlockchainAddress,
6
7
  CAIP10,
7
8
  CAIP19,
@@ -45,6 +46,7 @@ import type {
45
46
  RefreshSource,
46
47
  ResizeRequest,
47
48
  ScreenshotProof,
49
+ SectionOption,
48
50
  SignatureProof,
49
51
  SIWXInput,
50
52
  SolanaMetadata,
@@ -123,6 +125,7 @@ export {
123
125
  export type {
124
126
  Account,
125
127
  Agent,
128
+ AgentSections,
126
129
  BlockchainAddress,
127
130
  CAIP10,
128
131
  CAIP19,
@@ -167,6 +170,7 @@ export type {
167
170
  RefreshSource,
168
171
  ResizeRequest,
169
172
  ScreenshotProof,
173
+ SectionOption,
170
174
  SignatureProof,
171
175
  SIWXInput,
172
176
  SolanaMetadata,
package/src/types.ts CHANGED
@@ -860,18 +860,68 @@ export interface ThresholdOptions {
860
860
  currency: ISOCurrency; // Currency of threshold
861
861
  proofTypes?: ProofTypes[]; // If left empty no proof will be required under threshold
862
862
  }
863
+ /**
864
+ * Options that can be placed in either the main or fallback sections of the agent selection step.
865
+ *
866
+ * @remarks
867
+ * Combines proof types from {@link ProofTypes} with additional UI-specific options:
868
+ * - `ProofTypes.SelfDeclaration` — ownership proof via self-declaration
869
+ * - `ProofTypes.Screenshot` — ownership proof via screenshot upload
870
+ * - `ProofTypes.MicroTransfer` — ownership proof via micro-transfer
871
+ * - `'signature'` — wallet connection for ownership proof via signature
872
+ * - `'manual-signing'` — ownership proof via manual message signing
873
+ * - `'add-vasp'` — manually add an unlisted exchange/VASP (hosted flow)
874
+ *
875
+ * Options are automatically filtered by flow (e.g. `add-vasp` is ignored in self-hosted).
876
+ * Including an option implicitly enables that capability.
877
+ *
878
+ * @public
879
+ */
880
+ export type SectionOption =
881
+ | ProofTypes.SelfDeclaration
882
+ | ProofTypes.Screenshot
883
+ | ProofTypes.MicroTransfer
884
+ | 'signature'
885
+ | 'manual-signing'
886
+ | 'add-vasp';
887
+
888
+ /**
889
+ * Explicit layout configuration for the agent selection step.
890
+ *
891
+ * @remarks
892
+ * Controls which options appear in the main selection area vs. behind the
893
+ * "Can't find what you're looking for?" fallback toggle.
894
+ *
895
+ * When the main section has no options (empty or all filtered out), fallback options
896
+ * are promoted and shown inline. When the main section has only one option, a dedicated
897
+ * single-option layout is used.
898
+ *
899
+ * @public
900
+ */
901
+ export interface AgentSections {
902
+ /** Options shown in the main selection area (always visible) */
903
+ main?: SectionOption[];
904
+ /** Options shown behind the "Can't find what you're looking for?" fallback toggle */
905
+ fallback?: SectionOption[];
906
+ }
907
+
863
908
  /**
864
909
  * Configuration options for Transaction components
865
910
  * @public
866
911
  */
867
912
  export interface TransactionOptions {
913
+ /**
914
+ * Explicit layout configuration for the agent selection step.
915
+ * When provided, takes precedence over legacy fields (`proofs.fallbacks`, `vasps.addUnknown`).
916
+ */
917
+ agentSections?: AgentSections;
868
918
  proofs?: {
869
919
  reuseProof?: boolean; // Defaults true
870
920
  microTransfer?: {
871
921
  destination: BlockchainAddress;
872
922
  amountSubunits: string;
873
923
  };
874
- fallbacks?: ProofTypes[];
924
+ fallbacks?: ProofTypes[]; // Legacy — replaced by agentSections.fallback
875
925
  deminimis?: ThresholdOptions;
876
926
  };
877
927
  jurisdiction?: string;
@@ -882,7 +932,6 @@ export interface TransactionOptions {
882
932
  hide?: ValidationSections[]; // You can hide a specific section of the component by listing it here
883
933
  counterpartyAssist?: CounterpartyAssistConfig;
884
934
  autoSubmit?: boolean; // Defaults to false
885
- supportUrl?: string;
886
935
  }
887
936
  /**
888
937
  * Component Message Type enum representing different message types that can be sent