@notabene/javascript-sdk 2.11.0 → 2.13.0-next.1

package/docs/types/interfaces/TransactionOptions.md

@@ -94,10 +94,6 @@ Configuration options for Transaction components
 
 > **destination**: `string`
 
-##### microTransfer.timeout?
-
-> `optional` **timeout**: `number`
-
 #### reuseProof?
 
 > `optional` **reuseProof**: `boolean`

package/package.json

@@ -10,7 +10,7 @@
   "author": "Notabene <developers@notabene.id>",
   "license": "MIT",
   "packageManager": "yarn@4.5.1",
-  "version": "2.11.0",
+  "version": "2.13.0-next.1",
   "source": "src/notabene.ts",
   "main": "dist/cjs/notabene.cjs",
   "module": "dist/esm/notabene.js",

package/src/notabene.ts

@@ -13,6 +13,7 @@ import type {
   ComponentResponse,
   ConnectionOptions,
   ConnectionRequest,
+  CosmosMetadata,
   Counterparty,
   CounterpartyAssistConfig,
   CryptoCredential,
@@ -65,14 +66,18 @@ import type {
 import {
   AgentType,
   CMType,
+  CodeVerificationStatus,
   ErrorIdentifierCode,
   HMType,
+  IdentityVerificationMethod,
+  OAuthProvider,
   PersonType,
   ProofStatus,
   ProofTypes,
   Status,
   ValidationSections,
   VASPSearchControl,
+  WarningIdentifierCode,
 } from './types';
 import { type MessageCallback } from './utils/MessageEventManager';
 import { decodeFragmentToObject, encodeObjectToFragment } from './utils/urls';
@@ -91,15 +96,19 @@ export {
 export {
   AgentType,
   CMType,
+  CodeVerificationStatus,
   decodeFragmentToObject,
   ErrorIdentifierCode,
   HMType,
+  IdentityVerificationMethod,
+  OAuthProvider,
   PersonType,
   ProofStatus,
   ProofTypes,
   Status,
   ValidationSections,
   VASPSearchControl,
+  WarningIdentifierCode,
 };
 export type {
   Account,
@@ -115,6 +124,7 @@ export type {
   ComponentResponse,
   ConnectionOptions,
   ConnectionRequest,
+  CosmosMetadata,
   Counterparty,
   CounterpartyAssistConfig,
   CryptoCredential,

package/src/types.ts

@@ -491,7 +491,7 @@ export type LegalPersonFields = Partial<{
  * @public
  */
 type OriginatorFields = {
-  source?: Source;
+  source?: Source | Source[];
 };
 
 /**
@@ -561,6 +561,7 @@ export interface ComponentRequest {
  * @public
  */
 export interface Transaction extends ComponentRequest {
+  transactionId?: string;
   agent: Agent;
   counterparty: Counterparty;
   asset: TransactionAsset;
@@ -582,14 +583,6 @@ export interface Refreshable {
   refreshSource?: RefreshSource;
 }
 
-/**
- * Extended transaction interface for deposits
- * @public
- */
-export interface DepositTransaction extends Transaction {
-  transactionId?: string; // Optional transactionId of a Notabene transaction. Will be returned with the payload to assist updating the Transaction
-}
-
 /**
  * An object representing a withdrawal transaction
  * @public
@@ -603,10 +596,7 @@ export interface Withdrawal
  * An object representing a deposit transaction
  * @public
  */
-export interface Deposit
-  extends OriginatorFields,
-    DepositTransaction,
-    Refreshable {}
+export interface Deposit extends OriginatorFields, Transaction, Refreshable {}
 
 /**
  * An object representing a request for a deposit
@@ -793,6 +783,47 @@ export type VASPOptions = {
   searchable?: VASPSearchControl[]; // If array left empty all VASPs will be searchable
 };
 
+/**
+ * Available methods for identity verification
+ * @public
+ */
+export enum IdentityVerificationMethod {
+  SMS = 'sms',
+  EMAIL = 'email',
+}
+
+/**
+ * Status of a code verification
+ * @public
+ */
+export enum CodeVerificationStatus {
+  PENDING = 'pending',
+  APPROVED = 'approved',
+  FAILED = 'failed',
+  EXPIRED = 'expired',
+  MAX_ATTEMPTS_REACHED = 'max_attempts_reached',
+  UNREACHABLE = 'unreachable',
+}
+
+/**
+ * Supported OAuth providers for authentication
+ * @public
+ */
+export enum OAuthProvider {
+  COINBASE = 'coinbase',
+}
+
+/**
+ * Configuration options for identity verification
+ * @public
+ */
+export type IdentityVerificationConfig = {
+  /** The required verification method. If not specified, none will be used */
+  requiredMethod?: IdentityVerificationMethod;
+  /** OAuth provider(s) to use for authentication. Can be a single provider or array of providers */
+  oAuth?: OAuthProvider[] | OAuthProvider;
+};
+
 /**
  * Counterparty Assist Configuration options for recipient selection
  *
@@ -805,6 +836,7 @@ export type CounterpartyAssistConfig =
   | boolean
   | {
       counterpartyTypes: PersonType[];
+      identityVerification?: IdentityVerificationConfig;
     };
 
 /**
@@ -845,7 +877,6 @@ export interface TransactionOptions {
     microTransfer?: {
       destination: BlockchainAddress;
       amountSubunits: string;
-      timeout?: number; // Time to verify in seconds
     };
     fallbacks?: ProofTypes[];
     deminimis?: ThresholdOptions;
@@ -923,6 +954,18 @@ export enum ErrorIdentifierCode {
   TOKEN_INVALID = 'TOKEN_INVALID',
 }
 
+/**
+ * Identifier codes for warning messages
+ * @public
+ */
+export enum WarningIdentifierCode {
+  WALLET_ADDRESS_NOT_CONNECTED = 'WALLET_ADDRESS_NOT_CONNECTED',
+  WALLET_LOCKED = 'WALLET_LOCKED',
+  WALLET_UNREACHABLE = 'WALLET_UNREACHABLE',
+  JURISDICTIONAL_REQUIREMENTS_UNAVAILABLE = 'JURISDICTIONAL_REQUIREMENTS_UNAVAILABLE',
+  IDV_UNAVAILABLE = 'IDV_UNAVAILABLE',
+}
+
 /**
  * Represents an error component message
  * @param message - Error message
@@ -962,12 +1005,14 @@ export type InvalidValue<T> = {
  * Represents a warning component message
  * @param message - Warning message
  * @param description - Description of the warning message
+ * @param identifier - Identifier code of the warning message
  * @public
  */
 export type Warning = {
   type: CMType.WARNING;
   message: string;
   description?: string;
+  identifier?: WarningIdentifierCode;
 };
 
 /**
@@ -1145,6 +1190,7 @@ export enum ProofTypes {
   XRP_ED25519 = 'xrp-ed25519',
   XLM_ED25519 = 'xlm-ed25519',
   CIP8 = 'cip-8',
+  COSMOS = 'cosmos-ecdsa',
   MicroTransfer = 'microtransfer',
   Screenshot = 'screenshot',
   Connect = 'connect',
@@ -1235,6 +1281,16 @@ export interface SolanaMetadata {
   message: SIWXInput;
 }
 
+/**
+ * Metadata for Cosmos ownership proofs
+ * @remarks
+ * - Includes the public key
+ * @public
+ */
+export interface CosmosMetadata {
+  pub_key: { type: string; value: string };
+}
+
 /**
  * Interface for signature-based ownership proofs that use cryptographic message signing
  *
@@ -1268,7 +1324,8 @@ export interface SignatureProof extends OwnershipProof {
     | ProofTypes.CIP8
     | ProofTypes.XRP_ED25519
     | ProofTypes.CONCORDIUM
-    | ProofTypes.XLM_ED25519;
+    | ProofTypes.XLM_ED25519
+    | ProofTypes.COSMOS;
 
   proof: string;
   attestation: string;
@@ -1278,7 +1335,8 @@ export interface SignatureProof extends OwnershipProof {
     | {
         cardanoCoseKey?: string; // Cardano COSE key https://cips.cardano.org/cip/CIP-0030
       }
-    | SolanaMetadata;
+    | SolanaMetadata
+    | CosmosMetadata;
 }
 
 /**

package/src/utils/arbitraries.ts

@@ -208,7 +208,6 @@ export const arbitraryTransactionOptions =
             fc.record({
               destination: arbitraryBlockchainAddress(),
               amountSubunits: fc.string(),
-              timeout: fc.option(fc.nat()),
             }),
           ),
           fallbacks: fc.option(

package/src/utils/connections.ts

@@ -15,6 +15,8 @@ export interface ConnectionData<T extends ComponentRequest> {
   readonly authToken?: string;
   readonly txOptions?: TransactionOptions;
   readonly result?: TransactionResponse<T>;
+  readonly phoneNumber?: string;
+  readonly email?: string;
 }
 
 export interface ConnectionMetadata {