@notabene/javascript-sdk 2.17.0 → 2.18.0
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.
- package/README.md +102 -0
- package/dist/cjs/notabene.cjs +5 -5
- package/dist/cjs/notabene.d.ts +38 -1
- package/dist/cjs/package.json +1 -1
- package/dist/esm/notabene.d.ts +38 -1
- package/dist/esm/notabene.js +480 -479
- package/dist/esm/package.json +1 -1
- package/dist/notabene.d.ts +38 -1
- package/dist/notabene.js +480 -479
- package/package.json +2 -2
- package/src/notabene.ts +4 -0
- package/src/types.ts +39 -1
- package/src/utils/arbitraries.ts +30 -0
package/dist/cjs/notabene.d.ts
CHANGED
|
@@ -753,6 +753,26 @@ 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 contact support action.
|
|
758
|
+
*
|
|
759
|
+
* @remarks
|
|
760
|
+
* Contact support is **enabled** by including `'contact-support'` in
|
|
761
|
+
* `agentSections.main` or `agentSections.fallback`. This object only
|
|
762
|
+
* configures the behaviour when the feature is enabled.
|
|
763
|
+
*
|
|
764
|
+
* - With `contactSupport: { supportUrl: "..." }` — clicking sends an info
|
|
765
|
+
* message to the host **and** attempts to open the URL as a fallback.
|
|
766
|
+
* - Without `contactSupport` — clicking only sends an info message; the
|
|
767
|
+
* host decides what to do.
|
|
768
|
+
*
|
|
769
|
+
* @public
|
|
770
|
+
*/
|
|
771
|
+
export declare interface ContactSupportConfig {
|
|
772
|
+
/** URL to open when the user clicks the support button */
|
|
773
|
+
supportUrl: string;
|
|
774
|
+
}
|
|
775
|
+
|
|
756
776
|
/**
|
|
757
777
|
* Metadata for Cosmos ownership proofs
|
|
758
778
|
* @remarks
|
|
@@ -1156,14 +1176,24 @@ export declare enum IdentityVerificationMethod {
|
|
|
1156
1176
|
* Represents an info component message
|
|
1157
1177
|
* @param message - Info message
|
|
1158
1178
|
* @param description - Description of the info message
|
|
1179
|
+
* @param identifier - Identifier code of the info message
|
|
1159
1180
|
* @public
|
|
1160
1181
|
*/
|
|
1161
1182
|
declare type Info = {
|
|
1162
1183
|
type: CMType.INFO;
|
|
1163
1184
|
message: string;
|
|
1164
1185
|
description?: string;
|
|
1186
|
+
identifier?: InfoIdentifierCode;
|
|
1165
1187
|
};
|
|
1166
1188
|
|
|
1189
|
+
/**
|
|
1190
|
+
* Identifier codes for info messages
|
|
1191
|
+
* @public
|
|
1192
|
+
*/
|
|
1193
|
+
export declare enum InfoIdentifierCode {
|
|
1194
|
+
CONTACT_SUPPORT = "CONTACT_SUPPORT"
|
|
1195
|
+
}
|
|
1196
|
+
|
|
1167
1197
|
/**
|
|
1168
1198
|
* Intermediary VASP
|
|
1169
1199
|
* Represents an intermediary Virtual Asset Service Provider
|
|
@@ -2924,13 +2954,14 @@ export declare interface ScreenshotProof extends OwnershipProof {
|
|
|
2924
2954
|
* - `'signature'` — wallet connection for ownership proof via signature
|
|
2925
2955
|
* - `'manual-signing'` — ownership proof via manual message signing
|
|
2926
2956
|
* - `'add-vasp'` — manually add an unlisted exchange/VASP (hosted flow)
|
|
2957
|
+
* - `'contact-support'` — show a contact support button
|
|
2927
2958
|
*
|
|
2928
2959
|
* Options are automatically filtered by flow (e.g. `add-vasp` is ignored in self-hosted).
|
|
2929
2960
|
* Including an option implicitly enables that capability.
|
|
2930
2961
|
*
|
|
2931
2962
|
* @public
|
|
2932
2963
|
*/
|
|
2933
|
-
export declare type SectionOption = 'self-declaration' | 'screenshot' | 'microtransfer' | 'signature' | 'manual-signing' | 'add-vasp';
|
|
2964
|
+
export declare type SectionOption = 'self-declaration' | 'screenshot' | 'microtransfer' | 'signature' | 'manual-signing' | 'add-vasp' | 'contact-support';
|
|
2934
2965
|
|
|
2935
2966
|
/**
|
|
2936
2967
|
* Interface for signature-based ownership proofs that use cryptographic message signing
|
|
@@ -3299,6 +3330,12 @@ export declare interface TransactionOptions {
|
|
|
3299
3330
|
vasps?: VASPOptions;
|
|
3300
3331
|
hide?: ValidationSections[];
|
|
3301
3332
|
counterpartyAssist?: CounterpartyAssistConfig;
|
|
3333
|
+
/**
|
|
3334
|
+
* Configuration for the contact support button.
|
|
3335
|
+
* Enablement is controlled via `agentSections` — include `'contact-support'`
|
|
3336
|
+
* in `main` or `fallback` to show the button.
|
|
3337
|
+
*/
|
|
3338
|
+
contactSupport?: ContactSupportConfig;
|
|
3302
3339
|
autoSubmit?: boolean;
|
|
3303
3340
|
}
|
|
3304
3341
|
|
package/dist/cjs/package.json
CHANGED
package/dist/esm/notabene.d.ts
CHANGED
|
@@ -753,6 +753,26 @@ 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 contact support action.
|
|
758
|
+
*
|
|
759
|
+
* @remarks
|
|
760
|
+
* Contact support is **enabled** by including `'contact-support'` in
|
|
761
|
+
* `agentSections.main` or `agentSections.fallback`. This object only
|
|
762
|
+
* configures the behaviour when the feature is enabled.
|
|
763
|
+
*
|
|
764
|
+
* - With `contactSupport: { supportUrl: "..." }` — clicking sends an info
|
|
765
|
+
* message to the host **and** attempts to open the URL as a fallback.
|
|
766
|
+
* - Without `contactSupport` — clicking only sends an info message; the
|
|
767
|
+
* host decides what to do.
|
|
768
|
+
*
|
|
769
|
+
* @public
|
|
770
|
+
*/
|
|
771
|
+
export declare interface ContactSupportConfig {
|
|
772
|
+
/** URL to open when the user clicks the support button */
|
|
773
|
+
supportUrl: string;
|
|
774
|
+
}
|
|
775
|
+
|
|
756
776
|
/**
|
|
757
777
|
* Metadata for Cosmos ownership proofs
|
|
758
778
|
* @remarks
|
|
@@ -1156,14 +1176,24 @@ export declare enum IdentityVerificationMethod {
|
|
|
1156
1176
|
* Represents an info component message
|
|
1157
1177
|
* @param message - Info message
|
|
1158
1178
|
* @param description - Description of the info message
|
|
1179
|
+
* @param identifier - Identifier code of the info message
|
|
1159
1180
|
* @public
|
|
1160
1181
|
*/
|
|
1161
1182
|
declare type Info = {
|
|
1162
1183
|
type: CMType.INFO;
|
|
1163
1184
|
message: string;
|
|
1164
1185
|
description?: string;
|
|
1186
|
+
identifier?: InfoIdentifierCode;
|
|
1165
1187
|
};
|
|
1166
1188
|
|
|
1189
|
+
/**
|
|
1190
|
+
* Identifier codes for info messages
|
|
1191
|
+
* @public
|
|
1192
|
+
*/
|
|
1193
|
+
export declare enum InfoIdentifierCode {
|
|
1194
|
+
CONTACT_SUPPORT = "CONTACT_SUPPORT"
|
|
1195
|
+
}
|
|
1196
|
+
|
|
1167
1197
|
/**
|
|
1168
1198
|
* Intermediary VASP
|
|
1169
1199
|
* Represents an intermediary Virtual Asset Service Provider
|
|
@@ -2924,13 +2954,14 @@ export declare interface ScreenshotProof extends OwnershipProof {
|
|
|
2924
2954
|
* - `'signature'` — wallet connection for ownership proof via signature
|
|
2925
2955
|
* - `'manual-signing'` — ownership proof via manual message signing
|
|
2926
2956
|
* - `'add-vasp'` — manually add an unlisted exchange/VASP (hosted flow)
|
|
2957
|
+
* - `'contact-support'` — show a contact support button
|
|
2927
2958
|
*
|
|
2928
2959
|
* Options are automatically filtered by flow (e.g. `add-vasp` is ignored in self-hosted).
|
|
2929
2960
|
* Including an option implicitly enables that capability.
|
|
2930
2961
|
*
|
|
2931
2962
|
* @public
|
|
2932
2963
|
*/
|
|
2933
|
-
export declare type SectionOption = 'self-declaration' | 'screenshot' | 'microtransfer' | 'signature' | 'manual-signing' | 'add-vasp';
|
|
2964
|
+
export declare type SectionOption = 'self-declaration' | 'screenshot' | 'microtransfer' | 'signature' | 'manual-signing' | 'add-vasp' | 'contact-support';
|
|
2934
2965
|
|
|
2935
2966
|
/**
|
|
2936
2967
|
* Interface for signature-based ownership proofs that use cryptographic message signing
|
|
@@ -3299,6 +3330,12 @@ export declare interface TransactionOptions {
|
|
|
3299
3330
|
vasps?: VASPOptions;
|
|
3300
3331
|
hide?: ValidationSections[];
|
|
3301
3332
|
counterpartyAssist?: CounterpartyAssistConfig;
|
|
3333
|
+
/**
|
|
3334
|
+
* Configuration for the contact support button.
|
|
3335
|
+
* Enablement is controlled via `agentSections` — include `'contact-support'`
|
|
3336
|
+
* in `main` or `fallback` to show the button.
|
|
3337
|
+
*/
|
|
3338
|
+
contactSupport?: ContactSupportConfig;
|
|
3302
3339
|
autoSubmit?: boolean;
|
|
3303
3340
|
}
|
|
3304
3341
|
|