@fiatconnect/fiatconnect-types - npm Package Compare versions

Comparing version 1.0.0 to 2.0.0

CHANGELOG.md

@@ -5,4 +5,8 @@ # Changelog
 
+### 2.0.0 (2022-03-11)
+
+Adds support for `PersonalDataAndDocumentsKyc` KYC schema, and removes the mock KYC schema `MockNameAndAddressKyc`.
+
 ### 1.0.0 (2022-03-01)
 
 Initial version of type definitions for the FiatConnect SDK and FiatConnect API implementations.

dist/index.d.ts

@@ -147,3 +147,3 @@ export declare type QuoteRequestQuery = {
 export declare enum KycSchema {
-    MockNameAndAddress = "MockNameAndAddress"
+    PersonalDataAndDocuments = "PersonalDataAndDocuments"
 }
@@ -165,14 +165,22 @@ export declare enum FiatAccountSchema {
 }
-export interface MockNameAndAddressKyc {
+export interface PersonalDataAndDocumentsKyc {
     firstName: string;
+    middleName?: string;
     lastName: string;
-    address: PostalAddress;
+    dateOfBirth: {
+        day: string;
+        month: string;
+        year: string;
+    };
+    address: {
+        address1: string;
+        address2?: string;
+        isoCountryCode: string;
+        isoRegionCode: string;
+        city: string;
+        postalCode?: string;
+    };
+    phoneNumber: string;
+    selfieDocument: string;
+    identificationDocument: string;
 }
-export interface PostalAddress {
-    address1: string;
-    address2?: string;
-    city: string;
-    region: string;
-    postalCode: string;
-    isoCountryCode: string;
-}

dist/index.js

@@ -93,3 +93,3 @@ "use strict";
 (function (KycSchema) {
-    KycSchema["MockNameAndAddress"] = "MockNameAndAddress";
+    KycSchema["PersonalDataAndDocuments"] = "PersonalDataAndDocuments";
 })(KycSchema = exports.KycSchema || (exports.KycSchema = {}));
@@ -96,0 +96,0 @@ var FiatAccountSchema;

package.json

 {
   "name": "@fiatconnect/fiatconnect-types",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Types used in the FiatConnect specification. Offered as standalone module for payment providers and wallets to both use for FiatConnect APIs and integrations.",
@@ -5,0 +5,0 @@ "scripts": {

README.md

@@ -32,5 +32,12 @@ # fiatconnect-types
 - [Submitting a pull request](https://github.com/fiatconnect/fiatconnect-types/pulls)
-- Deploying
+- Publishing updates
   - Request access to our [NPM organization](https://www.npmjs.com/org/fiatconnect) on [Valora Discord](https://discord.gg/rwxxsZjJbd)
-  - Make sure you are on branch `main`
+  - Make sure you are on the latest version of branch `main`
+  - Check out a release branch
   - Run `yarn prepublish && yarn release`
+  - Add release notes to `CHANGELOG.md`
+  - Once code review has taken place:
+    - Merge your branch
+    - Run `git push origin vX.Y.Z` to push your tag (where X.Y.Z is the version you are trying to publish)
+    - [Create a release](https://github.com/fiatconnect/fiatconnect-types/releases) with the new tag 
+    - Run `npm publish --public`

src/index.ts

@@ -240,3 +240,3 @@
 export enum KycSchema {
-  MockNameAndAddress = 'MockNameAndAddress',
+  PersonalDataAndDocuments = 'PersonalDataAndDocuments',
 }
@@ -262,15 +262,23 @@
 
-export interface MockNameAndAddressKyc {
+// https://github.com/fiatconnect/specification/blob/5929f7ea8ca99796608e89a9c8da4c1033dacf05/fiatconnect-api.md#728-personaldataanddocuments
+export interface PersonalDataAndDocumentsKyc {
   firstName: string
+  middleName?: string
   lastName: string
-  address: PostalAddress
+  dateOfBirth: {
+    day: string
+    month: string
+    year: string
+  }
+  address: {
+    address1: string
+    address2?: string
+    isoCountryCode: string
+    isoRegionCode: string
+    city: string
+    postalCode?: string
+  }
+  phoneNumber: string
+  selfieDocument: string
+  identificationDocument: string
 }
-
-export interface PostalAddress {
-  address1: string
-  address2?: string
-  city: string
-  region: string // in the US this means state
-  postalCode: string
-  isoCountryCode: string
-}

No alert changes

Improved metrics

Total package byte prevSize

24397

increased by4.52%

Lines of code

563

increased by3.11%

Number of lines in readme file

43

increased by19.44%

No dependency changes