@notabene/javascript-sdk 2.0.0-next.2 → 2.0.0-next.20

package/src/ivms/types.ts

@@ -1,283 +1,349 @@
 /**
- * 5.3.8
- * NaturalPersonNameTypeCode
+ * ISO-3166 Alpha-2 country code
+ * @example "US" for United States, "GB" for United Kingdom
+ * @public
+ */
+export type ISOCountryCode = string;
+
+/**
+ * A point in time, represented as a day within the calendar year. Compliant with ISO 8601.
+ * Format: YYYY-MM-DD
+ * @example "2023-05-15" for May 15, 2023
+ * @public
+ */
+export type ISODate = `${number}-${number}-${number}`;
+
+/**
+ * Natural Person Name Type Code
+ * Specifies the type of name for a natural person
  *
- * `ALIA` Alias name  - A name other than the legal name by which a natural person is also known.
- * `BIRT` Name at birth - The name given to a natural person at birth.
- * `MAID` Maiden name - The original name of a natural person who has changed their name after marriage.
- * `LEGL` Legal name - The name that identifies a natural person for legal, official or administrative purposes.
- * `MISC` Unspecified - A name by which a natural person may be known but which cannot otherwise be categorized or the category of which the sender is unable to determine.
+ * @public
  */
 export type NaturalPersonNameTypeCode =
-  | 'ALIA'
-  | 'BIRT'
-  | 'MAID'
-  | 'LEGL'
-  | 'MISC';
+  | 'ALIA' // Alias name: A name other than the legal name by which a natural person is also known
+  | 'BIRT' // Name at birth: The name given to a natural person at birth
+  | 'MAID' // Maiden name: The original name of a natural person who has changed their name after marriage
+  | 'LEGL' // Legal name: The name that identifies a natural person for legal, official or administrative purposes
+  | 'MISC'; // Unspecified: A name by which a natural person may be known but which cannot otherwise be categorized
 
 /**
- * 5.3.9
- * LegalPersonNameTypeCode
- *
- * `LEGL` Legal name - Official name under which an organisation is registered.
- * `SHRT` Short name - Specifies the short name of the organisation.
- * `TRAD` Trading name - Name used by a business for commercial purposes, although its registered legal name, used for contracts and other formal situations, may be another.
+ * Legal Person Name Type Code
+ * Specifies the type of name for a legal person
+ * @public
  */
-export type LegalPersonNameTypeCode = 'LEGL' | 'SHRT' | 'TRAD';
+export type LegalPersonNameTypeCode =
+  | 'LEGL' // Legal name: Official name under which an organisation is registered
+  | 'SHRT' // Short name: Specifies the short name of the organisation
+  | 'TRAD'; // Trading name: Name used by a business for commercial purposes
 
 /**
- * 5.3.11
- * AddressTypeCode
- *
- * `HOME` Residential - Address is the home address.
- * `BIZZ` Business - Address is the business address.
- * `GEOG` Geographic - Address is the unspecified physical (geographical) address suitable for identification of the natural or legal person.
+ * Address Type Code
+ * Specifies the type of address
+ * @public
  */
-export type AddressTypeCode = 'HOME' | 'BIZZ' | 'GEOG';
+export type AddressTypeCode =
+  | 'HOME' // Residential: Address is the home address
+  | 'BIZZ' // Business: Address is the business address
+  | 'GEOG'; // Geographic: Address is the unspecified physical (geographical) address
 
 /**
- * 5.3.14
- * NationalIdentifierTypeCode
- *
- * `ARNU` Alien registration number - Number assigned by a government agency to identify foreign nationals.
- * `CCPT` Passport number - Number assigned by a passport authority.
- * `RAID` Registration authority identifier - Identifier of a legal entity as maintained by a registration authority.
- * `DRLC` Driver license number - Number assigned to a driver's license.
- * `FIIN` Foreign investment identity number - Number assigned to a foreign investor (other than the alien number).
- * `TXID` Tax identification number - Number assigned by a tax authority to an entity.
- * `SOCS` Social security number - Number assigned by a social security agency.
- * `IDCD` Identity card number - Number assigned by a national authority to an identity card.
- * `LEIX` Legal Entity Identifier - Legal Entity Identifier (LEI) assigned in accordance with ISO 17442 11 .
- * `MISC` Unspecified - A national identifier which may be known but which cannot otherwise be categorized or the category of which the sender is unable to determine.
+ * National Identifier Type Code
+ * Specifies the type of national identifier
+ * @public
  */
 export type NationalIdentifierTypeCode =
-  | 'ARNU'
-  | 'CCPT'
-  | 'RAID'
-  | 'DRLC'
-  | 'FIIN'
-  | 'TXID'
-  | 'SOCS'
-  | 'IDCD'
-  | 'LEIX'
-  | 'MISC';
+  | 'ARNU' // Alien registration number
+  | 'CCPT' // Passport number
+  | 'RAID' // Registration authority identifier
+  | 'DRLC' // Driver license number
+  | 'FIIN' // Foreign investment identity number
+  | 'TXID' // Tax identification number
+  | 'SOCS' // Social security number
+  | 'IDCD' // Identity card number
+  | 'LEIX' // Legal Entity Identifier
+  | 'MISC'; // Unspecified
 
 /**
- * 5.3.16
- * TransliterationMethodCode
- *
- * `arab` Arabic (Arabic language) - ISO 233-2:1993
- * `aran` Arabic (Persian language) - ISO 233-3:1999
- * `armn` Armenian - ISO 9985:1996
- * `cyrl` Cyrillic - ISO 9:1995
- * `deva` Devanagari & related Indic - ISO 15919:2001
- * `geor` Georgian - ISO 9984:1996
- * `grek` Greek - ISO 843:1997
- * `hani` Han (Hanzi, Kanji, Hanja) - ISO 7098:2015
- * `hebr` Hebrew - ISO 259-2:1994
- * `kana` Kana - ISO 3602:1989
- * `kore` Korean - Revised Romanization of Korean
- * `thai` Thai - ISO 11940-2:2007
- * `othr` Script other than those listed above - Unspecified
+ * Transliteration Method Code
+ * Specifies the method used to transliterate text
+ * @public
  */
 export type TransliterationMethodCode =
-  | 'arab'
-  | 'aran'
-  | 'armn'
-  | 'cyrl'
-  | 'deva'
-  | 'geor'
-  | 'grek'
-  | 'hani'
-  | 'hebr'
-  | 'kana'
-  | 'kore'
-  | 'thai'
-  | 'othr';
+  | 'arab' // Arabic (Arabic language) - ISO 233-2:1993
+  | 'aran' // Arabic (Persian language) - ISO 233-3:1999
+  | 'armn' // Armenian - ISO 9985:1996
+  | 'cyrl' // Cyrillic - ISO 9:1995
+  | 'deva' // Devanagari & related Indic - ISO 15919:2001
+  | 'geor' // Georgian - ISO 9984:1996
+  | 'grek' // Greek - ISO 843:1997
+  | 'hani' // Han (Hanzi, Kanji, Hanja) - ISO 7098:2015
+  | 'hebr' // Hebrew - ISO 259-2:1994
+  | 'kana' // Kana - ISO 3602:1989
+  | 'kore' // Korean - Revised Romanization of Korean
+  | 'thai' // Thai - ISO 11940-2:2007
+  | 'othr'; // Script other than those listed above - Unspecified
 
 /**
- * 5.2.8
- * NationalIdentification
+ * National Identification
+ * Represents a national identifier for a person or entity
+ * @public
  */
 export type NationalIdentification = {
-  nationalIdentifier?: string; //Max35Text
+  /** National identifier (max 35 characters) */
+  nationalIdentifier?: string;
+  /** Type of national identifier */
   nationalIdentifierType?: NationalIdentifierTypeCode;
-  countryOfIssue?: string; //CountryCode (^[A-Z]{2}$)
-  registrationAuthority?: string; //RegistrationAuthority (^RA([0-9]{6})$)
+  /** Country that issued the national identifier */
+  countryOfIssue?: ISOCountryCode;
+  /** Registration authority (format: RA followed by 6 digits) */
+  registrationAuthority?: string;
 };
 
 /**
- * 5.2.7
- * DateAndPlaceOfBirth
+ * Date and Place of Birth
+ * Represents the date and place of birth for a natural person
+ * @public
  */
 export type DateAndPlaceOfBirth = {
-  dateOfBirth?: string; //YYYY-MM-DD
-  placeOfBirth?: string; //Max70Text
+  /** Date of birth in ISO 8601 format (YYYY-MM-DD) */
+  dateOfBirth?: ISODate;
+  /** Place of birth (max 70 characters) */
+  placeOfBirth?: string;
 };
 
 /**
- * 5.2.6
  * Address
+ * Represents a physical address
+ * @public
  */
 export type Address = {
-  addressType?: AddressTypeCode;
-  department?: string; //Max50Text
-  subDepartment?: string; //Max70Text
-  streetName?: string; //Max70Text
-  buildingNumber?: string; //Max16Text
-  buildingName?: string; //Max35Text
-  floor?: string; //Max70Text
-  postBox?: string; //Max16Text
-  room?: string; //Max70Text
-  postCode?: string; //Max16Text
-  townName?: string; //Max35Text
-  townLocationName?: string; //Max35Text
-  districtName?: string; //Max35Text
-  countrySubDivision?: string; //Max35Text
-  addressLine?: string[]; //Max35Text max 7 items in array
-  country?: string; //CountryCode (^[A-Z]= {2}$)
+  /** Identifies the nature of the address. */
+  addressType: AddressTypeCode;
+  /** Identification of a division of a large organisation or building. */
+  department?: string;
+  /** Identification of a sub-division of a large organisation or building. */
+  subDepartment?: string;
+  /** Name of a street or thoroughfare. */
+  streetName?: string;
+  /** Number that identifies the position of a building on a street. */
+  buildingNumber?: string;
+  /** Name of the building or house. */
+  buildingName?: string;
+  /** Floor or storey within a building. */
+  floor?: string;
+  /** Numbered box in a post office. */
+  postBox?: string;
+  /** Building room number. */
+  room?: string;
+  /** Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. */
+  postcode?: string;
+  /** Name of a built-up area, with defined boundaries, and a local government. */
+  townName: string;
+  /** Specific location name within the town. */
+  townLocationName?: string;
+  /** Identifies a subdivision within a country subdivision. */
+  districtName?: string;
+  /** Identifies a subdivision of a country such as state, region, province. */
+  countrySubDivision?: string;
+  /** Information that locates and identifies a specific address, presented in free format text. */
+  addressLine?: string[];
+  /** Nation with its own government. */
+  country: ISOCountryCode;
 };
 
 /**
- * 5.2.5
- * LocalNaturalPersonNameID
+ * Local Natural Person Name ID
+ * Represents a local name identifier for a natural person
+ * @public
  */
 export type LocalNaturalPersonNameID = {
-  primaryIdentifier?: string; //LocalMax100Text
-  secondaryIdentifier?: string; //LocalMax100Text
+  /** Primary identifier, maximum 100 characters in local format */
+  primaryIdentifier?: string;
+  /** Secondary identifier, maximum 100 characters in local format */
+  secondaryIdentifier?: string;
+  /** Type of name identifier */
   nameIdentifierType?: NaturalPersonNameTypeCode;
 };
 
 /**
- * 5.2.4
- * NaturalPersonNameID
+ * Natural Person Name ID
+ * Represents a name identifier for a natural person
+ * @public
  */
 export type NaturalPersonNameID = {
-  primaryIdentifier?: string; //Max100Text
-  secondaryIdentifier?: string; //Max100Text
+  /** Primary identifier, maximum 100 characters */
+  primaryIdentifier?: string;
+  /** Secondary identifier, maximum 100 characters */
+  secondaryIdentifier?: string;
+  /** Type of name identifier */
   nameIdentifierType?: NaturalPersonNameTypeCode;
 };
 
 /**
- * 5.2.3
- * NaturalPersonName
+ * Natural Person Name
+ * Represents the full name structure for a natural person
+ * @public
  */
 export type NaturalPersonName = {
+  /** Array of name identifiers */
   nameIdentifier?: NaturalPersonNameID[];
+  /** Array of local name identifiers */
   localNameIdentifier?: LocalNaturalPersonNameID[];
+  /** Array of phonetic name identifiers */
   phoneticNameIdentifier?: LocalNaturalPersonNameID[];
 };
 
 /**
- * 5.2.2
- * NaturalPerson
+ * Natural Person
+ * Represents a natural person with all associated information
+ * @public
  */
 export type NaturalPerson = {
-  name?: NaturalPersonName[];
+  /** The distinct words used as identification for an individual */
+  name: NaturalPersonName;
+  /** The particulars of a location at which a person may be communicated with */
   geographicAddress?: Address[];
+  /** A distinct identifier used by governments to uniquely identify a natural person */
   nationalIdentification?: NationalIdentification;
-  customerIdentification?: string; //Max50Text
+  /** A distinct identifier that uniquely identifies the person to the institution in context */
+  customerIdentification?: string;
+  /** Date and place of birth of a person */
   dateAndPlaceOfBirth?: DateAndPlaceOfBirth;
-  countryOfResidence?: string; //CountryCode (^[A-Z]{2}$)
+  /** Country in which a person resides (the place of a person's home) */
+  countryOfResidence?: ISOCountryCode;
 };
 
 /**
- * 5.2.12
- * LocalLegalPersonNameID
+ * Local Legal Person Name ID
+ * Represents a local name identifier for a legal person
+ * @public
  */
 export type LocalLegalPersonNameID = {
-  legalPersonName?: string; //LocalMax100Text
+  /** Name of the legal person, maximum 100 characters in local format */
+  legalPersonName?: string;
+  /** Type of legal person name identifier */
   legalPersonNameIdentifierType?: LegalPersonNameTypeCode;
 };
 
 /**
- * 5.2.11
- * LegalPersonNameID
+ * Legal Person Name ID
+ * Represents a name identifier for a legal person
+ * @public
  */
 export type LegalPersonNameID = {
-  legalPersonName?: string; //Max100Text
-  legalPersonNameIdentifierType?: LegalPersonNameTypeCode;
+  /** Name by which the legal person is known */
+  legalPersonName: string;
+  /** The nature of the name specified */
+  legalPersonNameIdentifierType: LegalPersonNameTypeCode;
 };
 
 /**
- * 5.2.10
- * LegalPersonName
+ * Legal Person Name
+ * Represents the full name structure for a legal person
+ * @public
  */
 export type LegalPersonName = {
-  nameIdentifier?: LegalPersonNameID[];
+  /** Array of name identifiers */
+  nameIdentifier: LegalPersonNameID[];
+  /** Array of local name identifiers */
   localNameIdentifier?: LocalLegalPersonNameID[];
+  /** Array of phonetic name identifiers */
   phoneticNameIdentifier?: LocalLegalPersonNameID[];
 };
 
 /**
- * 5.2.9
- * LegalPerson
+ * Legal Person
+ * Represents a legal person with all associated information
+ * @public
  */
 export type LegalPerson = {
-  name?: LegalPersonName;
+  /** The name of the legal person */
+  name: LegalPersonName;
+  /** The address of the legal person */
   geographicAddress?: Address[];
-  customerNumber?: string; //Max50Text
+  /** A distinct identifier that uniquely identifies the person to the institution in context */
+  customerNumber?: string;
+  /** A distinct identifier used by governments to uniquely identify a legal person */
   nationalIdentification?: NationalIdentification;
-  countryOfRegistration?: string; //CountryCode (^[A-Z]{2}$);
+  /** The country in which the legal person is registered */
+  countryOfRegistration?: ISOCountryCode;
 };
 
 /**
- * 5.2.1
  * Person
+ * Represents either a natural person or a legal person
+ * @public
  */
 export type Person = {
+  /** Natural person information */
   naturalPerson?: NaturalPerson;
+  /** Legal person information */
   legalPerson?: LegalPerson;
 };
 
 /**
- * 5.2.13
- * IntermediaryVASP
+ * Intermediary VASP
+ * Represents an intermediary Virtual Asset Service Provider
+ * @public
  */
 export type IntermediaryVASP = {
+  /** The intermediary VASP information */
   intermediaryVASP?: Person;
+  /** The sequence number of this VASP in the transfer path */
   sequence?: number;
 };
 
 /**
- * 6.2
- * The originator is defined in Section 1.1 as the account holder who allows the VA transfer from that account or, where there is no account, the natural or legal person that places the order with the originating VASP to perform the VA transfer.
+ * Originator
+ * Represents the account holder who initiates the VA transfer
+ * @public
  */
 export type Originator = {
+  /** Array of persons associated with the originator */
   originatorPersons?: Person[];
-  accountNumber?: string[]; //Max100Text
+  /** Array of account numbers, maximum 100 characters each */
+  accountNumber?: string[];
 };
 
 /**
- * 6.3
- * The beneficiary is defined in Section 1.1 as the natural or legal person or legal arrangement who is identified by the originator as the receiver of the requested VA transfer.
+ * Beneficiary
+ * Represents the receiver of the requested VA transfer
+ * @public
  */
 export type Beneficiary = {
+  /** Array of persons associated with the beneficiary */
   beneficiaryPersons?: Person[];
-  accountNumber?: string[]; //max100
+  /** Array of account numbers, maximum 100 characters each */
+  accountNumber?: string[];
 };
 
 /**
- * 6.4
- * The originating VASP is defined in Section 1.1 as the VASP which initiates the VA transfer, and transfers the VA upon receiving the request for a VA transfer on behalf of the originator.
+ * Originating VASP
+ * Represents the VASP which initiates the VA transfer
+ * @public
  */
 export type OriginatingVASP = {
+  /** The originating VASP information */
   originatingVASP?: Person;
 };
 
 /**
- * 6.5
- * The originating VASP is defined in Section 1.1 as the VASP which initiates the VA transfer, and transfers the VA upon receiving the request for a VA transfer on behalf of the originator.
+ * Beneficiary VASP
+ * Represents the VASP which receives the VA transfer
+ * @public
  */
 export type BeneficiaryVASP = {
+  /** The beneficiary VASP information */
   beneficiaryVASP?: Person;
 };
 
 /**
- * 6.6
- * The transfer path refers to the intermediary VASP(s) participating in a serial chain that receive(s) and retransmit(s) a VA transfer on behalf of the originating VASP and the beneficiary VASP, or another intermediary VASP, together with their corresponding sequence number.
+ * Transfer Path
+ * Represents the path of intermediary VASPs in a transfer
+ * @public
  */
 export type TransferPath = {
+  /** Array of intermediary VASPs involved in the transfer */
   transferPath?: IntermediaryVASP[];
 };
 
@@ -285,9 +351,21 @@ export type TransferPath = {
  * 6.7
  * Data describing the contents of the payload.
  */
-export type PayloadMetadata = {
-  transferPath?: TransliterationMethodCode[];
-};
+export interface PayloadMetadata {
+  /** The method used to map from a national system of writing to Latin script. */
+  transliterationMethod?: TransliterationMethodCode[];
+  /** The version of IVMS 101 to which the payload complies. */
+  payloadVersion: PayloadVersionCode;
+}
+/**
+ * The version of IVMS 101 to which the payload complies.
+ */
+export enum PayloadVersionCode {
+  /** Published May 2020 */
+  V101 = '101',
+  /** Published August 2023 */
+  V101_2023 = '101.2023',
+}
 
 /**
  * IVMS101 definition

package/src/locales.ts

@@ -0,0 +1,47 @@
+export const languages = {
+  ar: 'العربية (Arabic)',
+  bg: 'български (Bulgarian)',
+  ca: 'Català (Catalan)',
+  cs: 'Čeština (Czech)',
+  da: 'Dansk (Danish)',
+  de: 'Deutsch (German)',
+  el: 'Ελληνικά (Greek)',
+  en: 'English (English)',
+  es: 'Español (Spanish)',
+  et: 'Eesti (Estonian)',
+  fa: 'فارسی (Persian)',
+  fi: 'Suomi (Finnish)',
+  fr: 'Français (French)',
+  he: 'עברית (Hebrew)',
+  hr: 'Hrvatski (Croatian)',
+  hu: 'Magyar (Hungarian)',
+  hy: 'Հայերեն (Armenian)',
+  id: 'Bahasa Indonesia (Indonesian)',
+  is: 'Íslenska (Icelandic)',
+  it: 'Italiano (Italian)',
+  ja: '日本語 (Japanese)',
+  ka: 'ქართული (Georgian)',
+  ko: '한국어 (Korean)',
+  lt: 'Lietuvių (Lithuanian)',
+  lv: 'Latviešu (Latvian)',
+  mn: 'Монгол (Mongolian)',
+  ms: 'Bahasa Melayu (Malay)',
+  mt: 'Malti (Maltese)',
+  nl: 'Nederlands (Dutch)',
+  no: 'Norsk (Norwegian)',
+  pl: 'Polski (Polish)',
+  pt: 'Português (Portuguese)',
+  ro: 'Română (Romanian)',
+  ru: 'Русский (Russian)',
+  sk: 'Slovenčina (Slovak)',
+  sl: 'Slovenščina (Slovenian)',
+  sr: 'Српски (Serbian)',
+  sv: 'Svenska (Swedish)',
+  sw: 'Kiswahili (Swahili)',
+  th: 'ไทย (Thai)',
+  tl: 'Tagalog (Tagalog)',
+  tr: 'Türkçe (Turkish)',
+  uk: 'Українська (Ukrainian)',
+  vi: 'Tiếng Việt (Vietnamese)',
+  zh: '中文 (Chinese)',
+};