@notabene/javascript-sdk 2.9.3 → 2.10.0-next.4

package/src/types.ts

@@ -301,6 +301,7 @@ export interface VASP extends Agent {
   logo?: URI;
   website?: URI;
   countryOfRegistration?: ISOCountryCode;
+  jurisdictions?: string;
 }
 
 /**
@@ -757,7 +758,6 @@ export type FieldOptions =
   | string[] // fields to show
   | {
       optional: boolean; // Shown but optional
-      transmit: boolean; // Transmit as part of IVMS 101 to counterparty
     };
 
 /**
@@ -850,6 +850,7 @@ export interface TransactionOptions {
     fallbacks?: ProofTypes[];
     deminimis?: ThresholdOptions;
   };
+  jurisdiction?: string;
   allowedAgentTypes?: AgentType[]; // Defaults to All
   allowedCounterpartyTypes?: PersonType[]; // Defaults to All
   fields?: FieldTypes;
@@ -879,6 +880,8 @@ export enum CMType {
   INVALID = 'invalid',
   ERROR = 'error',
   CANCEL = 'cancel',
+  WARNING = 'warning',
+  INFO = 'info',
 }
 
 /**
@@ -955,6 +958,30 @@ export type InvalidValue<T> = {
   errors: ValidationError[];
 };
 
+/**
+ * Represents a warning component message
+ * @param message - Warning message
+ * @param description - Description of the warning message
+ * @public
+ */
+export type Warning = {
+  type: CMType.WARNING;
+  message: string;
+  description?: string;
+};
+
+/**
+ * Represents an info component message
+ * @param message - Info message
+ * @param description - Description of the info message
+ * @public
+ */
+export type Info = {
+  type: CMType.INFO;
+  message: string;
+  description?: string;
+};
+
 /**
  * Union type representing all possible messages that can be sent from a component
  *
@@ -972,8 +999,11 @@ export type InvalidValue<T> = {
  * @see {@link Completed} For successful completion message format
  * @see {@link Cancel} For cancellation message format
  * @see {@link Error} For error message format
+ * @see {@link Ready} For ready message format
  * @see {@link ResizeRequest} For resize message format
  * @see {@link InvalidValue} For validation failure message format
+ * @see {@link Warning} For warning message format
+ * @see {@link Info} For info message format
  * @public
  */
 export type ComponentMessage<T> =
@@ -982,7 +1012,9 @@ export type ComponentMessage<T> =
   | Error
   | Ready
   | ResizeRequest
-  | InvalidValue<T>;
+  | InvalidValue<T>
+  | Warning
+  | Info;
 
 /**
  * Host Message Type enum representing different message types that can be sent
@@ -1113,6 +1145,7 @@ export enum ProofTypes {
   MicroTransfer = 'microtransfer',
   Screenshot = 'screenshot',
   Connect = 'connect',
+  CONCORDIUM = 'concordium',
 }
 
 /**
@@ -1174,6 +1207,7 @@ export interface SignatureProof extends OwnershipProof {
     | ProofTypes.SIWE
     | ProofTypes.CIP8
     | ProofTypes.XRP_ED25519
+    | ProofTypes.CONCORDIUM
     | ProofTypes.XLM_ED25519;
 
   proof: string;

package/src/utils/connections.ts

@@ -9,35 +9,55 @@ import { seal, unseal } from './encryption';
 
 export type TransactionType = 'withdraw' | 'deposit';
 export type ConnectionStatus = 'active' | 'completed' | 'closed';
+
 export interface ConnectionData<T extends ComponentRequest> {
-  tx: T;
-  authToken?: string;
-  txOptions?: TransactionOptions;
-  result?: TransactionResponse<T>;
+  readonly tx: T;
+  readonly authToken?: string;
+  readonly txOptions?: TransactionOptions;
+  readonly result?: TransactionResponse<T>;
 }
 
 export interface ConnectionMetadata {
-  nodeUrl?: string;
-  participants: string[];
-  transactionType: TransactionType;
+  readonly nodeUrl?: string;
+  readonly participants: readonly string[];
+  readonly transactionType: TransactionType;
+  readonly locale?: string;
 }
+
 export interface ConnectionResponse<T extends ComponentRequest> {
-  id: UUID;
-  version: number;
-  status: ConnectionStatus;
-  metadata: ConnectionMetadata;
-  data: ConnectionData<T>;
-  key: string;
+  readonly id: UUID;
+  readonly version: number;
+  readonly status: ConnectionStatus;
+  readonly metadata: ConnectionMetadata;
+  readonly data: ConnectionData<T>;
+  readonly key: string;
 }
 
-export interface ConnectionResult<T extends ComponentRequest> {
-  id: UUID;
-  metadata: ConnectionMetadata;
-  status: ConnectionStatus;
-  tx?: T;
-  result?: TransactionResponse<T>;
-}
+export type ConnectionResult<T extends ComponentRequest> =
+  | {
+      readonly id: UUID;
+      readonly metadata: ConnectionMetadata;
+      readonly status: 'closed';
+    }
+  | {
+      readonly id: UUID;
+      readonly metadata: ConnectionMetadata;
+      readonly status: 'completed';
+      readonly result: TransactionResponse<T>;
+    }
+  | {
+      readonly id: UUID;
+      readonly metadata: ConnectionMetadata;
+      readonly status: 'active';
+      readonly tx: T;
+    };
 
+/**
+ * Retrieves and processes connection refresh data
+ * @template T Type of component request
+ * @param refreshSource Source information for the refresh operation
+ * @returns Promise resolving to connection result with decrypted data
+ */
 export async function getRefreshResult<T extends ComponentRequest>(
   refreshSource: RefreshSource,
 ): Promise<ConnectionResult<T>> {
@@ -99,8 +119,9 @@ export class ConnectionManager {
 
   /**
    * Creates a new encrypted connection
+   * @template T Type of component request
    * @param data The component request data to encrypt and store
-   * @param participants Array of participant identifiers
+   * @param metadata Connection metadata including participants and transaction type
    * @returns Promise resolving to connection details including ID, version, and encryption key
    */
   async create<T extends ComponentRequest>(
@@ -143,9 +164,12 @@ export class ConnectionManager {
 
   /**
    * Updates an existing connection with new encrypted data
+   * @template T Type of component request
    * @param id Connection ID
    * @param data New data to encrypt and store
    * @param version Current version number
+   * @param status New connection status
+   * @param key Current encryption key
    * @returns Promise resolving to updated connection details including new encryption key
    */
   async update<T extends ComponentRequest>(
@@ -192,6 +216,7 @@ export class ConnectionManager {
 
   /**
    * Retrieves and decrypts connection data
+   * @template T Type of component request
    * @param id Connection ID
    * @param key Encryption key from previous create/update operation
    * @returns Promise resolving to connection details including decrypted data
@@ -233,6 +258,7 @@ export class ConnectionManager {
   /**
    * Closes a connection
    * @param id Connection ID
+   * @returns Promise resolving when the connection is closed
    */
   async close(id: UUID): Promise<void> {
     const response = await fetch(`${this.endpoint}/${id}`, {

package/src/utils/encryption.ts

@@ -3,15 +3,16 @@
  */
 export interface Sealed {
   /** Base64-encoded ciphertext combined with initialization vector (IV) */
-  ciphertext: string;
+  readonly ciphertext: string;
   /** Base64-encoded encryption key */
-  key: string;
+  readonly key: string;
 }
 
 /**
  * Encrypts an object using AES-GCM encryption.
  * @template T Type of data to encrypt
  * @param data Data to encrypt
+ * @param existingKey Optional existing key to use for encryption
  * @returns Promise resolving to a Sealed object containing ciphertext and key
  */
 export async function seal<T>(data: T, existingKey?: string): Promise<Sealed> {
@@ -56,7 +57,6 @@ export async function seal<T>(data: T, existingKey?: string): Promise<Sealed> {
  * @param sealed Sealed object containing ciphertext and key
  * @returns Promise resolving to the original decrypted data
  */
-
 export async function unseal<T>({ ciphertext, key }: Sealed): Promise<T> {
   // Split the IV and the ciphertext
   const [ivBase64, ciphertextBase64] = ciphertext.split('-');
@@ -91,7 +91,11 @@ export async function unseal<T>({ ciphertext, key }: Sealed): Promise<T> {
   return JSON.parse(decoder.decode(plaintextBuffer));
 }
 
-// Utility function to convert ArrayBuffer to Base64
+/**
+ * Converts an ArrayBuffer to a Base64 string
+ * @param buffer The ArrayBuffer to convert
+ * @returns Base64 encoded string
+ */
 function arrayBufferToBase64(buffer: ArrayBuffer): string {
   const uint8Array = new Uint8Array(buffer);
   let binary = '';
@@ -101,8 +105,11 @@ function arrayBufferToBase64(buffer: ArrayBuffer): string {
   return btoa(binary);
 }
 
-// Utility function to convert Base64 to ArrayBuffer
-
+/**
+ * Converts a Base64 string to a Uint8Array
+ * @param base64 The Base64 string to convert
+ * @returns Uint8Array containing the decoded data
+ */
 function base64ToUint8Array(base64: string): Uint8Array {
   const binary = atob(base64);
   const buffer = new Uint8Array(binary.length);

package/docs/notabene/interfaces/ConnectionResult.md

@@ -1,61 +0,0 @@
-[**@notabene/javascript-sdk**](../../README.md)
-
-***
-
-[@notabene/javascript-sdk](../../modules.md) / [notabene](../README.md) / ConnectionResult
-
-# Interface: ConnectionResult\<T\>
-
-## Type Parameters
-
-• **T** *extends* [`ComponentRequest`](../../types/interfaces/ComponentRequest.md)
-
-## Properties
-
-### id
-
-> **id**: `string`
-
-#### Defined in
-
-[utils/connections.ts:34](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L34)
-
-***
-
-### metadata
-
-> **metadata**: [`ConnectionMetadata`](ConnectionMetadata.md)
-
-#### Defined in
-
-[utils/connections.ts:35](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L35)
-
-***
-
-### result?
-
-> `optional` **result**: [`TransactionResponse`](../../types/interfaces/TransactionResponse.md)\<`T`\>
-
-#### Defined in
-
-[utils/connections.ts:38](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L38)
-
-***
-
-### status
-
-> **status**: [`ConnectionStatus`](../type-aliases/ConnectionStatus.md)
-
-#### Defined in
-
-[utils/connections.ts:36](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L36)
-
-***
-
-### tx?
-
-> `optional` **tx**: `T`
-
-#### Defined in
-
-[utils/connections.ts:37](https://gitlab.com/notabene/open-source/javascript-sdk/-/blob/f6a0825d098b61a3bc31d6c197072643eb78a452/src/utils/connections.ts#L37)