@fiatconnect/fiatconnect-types - npm Package Compare versions

Comparing version 3.2.0 to 3.3.0

CHANGELOG.md

@@ -5,2 +5,7 @@ # Changelog
 
+## [3.3.0](https://github.com/fiatconnect/fiatconnect-types/compare/v3.2.0...v3.3.0) (2022-05-23)
+### Features
+
+* **batch updates:** Updated types for TransferStatusResponse, TransferStatus. Added new FiatAccountSchema types ([#26]((https://github.com/fiatconnect/fiatconnect-types/issues/26))) ([dcdf20c](https://github.com/fiatconnect/fiatconnect-types/commit/dcdf20c649817fd7301f999ee1af8de769851bae))
+
 ## [3.2.0](https://github.com/fiatconnect/fiatconnect-types/compare/v3.1.0...v3.2.0) (2022-05-02)
@@ -7,0 +12,0 @@

dist/index.d.ts

@@ -102,2 +102,4 @@ export declare type ClockResponse = {
     fiatAccountId: string;
+    transferId: string;
+    transferAddress: string;
 };
@@ -111,3 +113,7 @@ export declare type FiatAccountId = string;
     TransferStarted = "TransferStarted",
-    TransferPending = "TransferPending",
+    TransferFiatFundsDebited = "TransferFiatFundsDebited",
+    TransferSendingCryptoFunds = "TransferSendingCryptoFunds",
+    TransferAmlFailed = "TransferAmlFailed",
+    TransferReadyForUserToSendCryptoFunds = "TransferReadyForUserToSendCryptoFunds",
+    TransferReceivedCryptoFunds = "TransferReceivedCryptoFunds",
     TransferComplete = "TransferComplete",
@@ -173,3 +179,4 @@ TransferFailed = "TransferFailed"
     IssuedTooEarly = "IssuedTooEarly",
-    ExpirationTooLong = "ExpirationTooLong"
+    ExpirationTooLong = "ExpirationTooLong",
+    InvalidFiatAccount = "InvalidFiatAccount"
 }
@@ -207,13 +214,36 @@ export declare enum Network {
 export declare enum FiatAccountSchema {
-    AccountNumber = "AccountNumber"
+    AccountNumber = "AccountNumber",
+    MobileMoney = "MobileMoney",
+    DuniaWallet = "DuniaWallet"
 }
 export declare enum FiatAccountType {
-    BankAccount = "BankAccount"
+    BankAccount = "BankAccount",
+    MobileMoney = "MobileMoney",
+    DuniaWallet = "DuniaWallet"
 }
-export interface AccountNumber {
+interface RequiredFiatAccountSchemaFields {
     accountName: string;
     institutionName: string;
+    fiatAccountType: FiatAccountType;
+}
+export declare type AccountNumber = RequiredFiatAccountSchemaFields & {
     accountNumber: string;
     country: string;
     fiatAccountType: FiatAccountType.BankAccount;
+};
+export declare type MobileMoney = RequiredFiatAccountSchemaFields & {
+    mobile: string;
+    country: string;
+    operator: SupportedOperatorEnum;
+    fiatAccountType: FiatAccountType.MobileMoney;
+};
+export declare type DuniaWallet = RequiredFiatAccountSchemaFields & {
+    mobile: string;
+    fiatAccountType: FiatAccountType.DuniaWallet;
+};
+export declare enum SupportedOperatorEnum {
+    ORANGE = "ORANGE",
+    MOOV = "MOOV",
+    MTN = "MTN",
+    WAVE = "WAVE"
 }
@@ -241,1 +271,2 @@ export interface PersonalDataAndDocumentsKyc {
 }
+export {};

dist/index.js

@@ -15,3 +15,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FiatAccountType = exports.FiatAccountSchema = exports.KycSchema = exports.CryptoType = exports.FiatType = exports.Network = exports.FiatConnectError = exports.WebhookEventType = exports.FeeFrequency = exports.FeeType = exports.KycStatus = exports.TransferStatus = exports.TransferType = void 0;
+exports.SupportedOperatorEnum = exports.FiatAccountType = exports.FiatAccountSchema = exports.KycSchema = exports.CryptoType = exports.FiatType = exports.Network = exports.FiatConnectError = exports.WebhookEventType = exports.FeeFrequency = exports.FeeType = exports.KycStatus = exports.TransferStatus = exports.TransferType = void 0;
 var TransferType;
@@ -25,3 +25,7 @@ (function (TransferType) {
     TransferStatus["TransferStarted"] = "TransferStarted";
-    TransferStatus["TransferPending"] = "TransferPending";
+    TransferStatus["TransferFiatFundsDebited"] = "TransferFiatFundsDebited";
+    TransferStatus["TransferSendingCryptoFunds"] = "TransferSendingCryptoFunds";
+    TransferStatus["TransferAmlFailed"] = "TransferAmlFailed";
+    TransferStatus["TransferReadyForUserToSendCryptoFunds"] = "TransferReadyForUserToSendCryptoFunds";
+    TransferStatus["TransferReceivedCryptoFunds"] = "TransferReceivedCryptoFunds";
     TransferStatus["TransferComplete"] = "TransferComplete";
@@ -79,2 +83,3 @@ TransferStatus["TransferFailed"] = "TransferFailed";
     FiatConnectError["ExpirationTooLong"] = "ExpirationTooLong";
+    FiatConnectError["InvalidFiatAccount"] = "InvalidFiatAccount";
 })(FiatConnectError = exports.FiatConnectError || (exports.FiatConnectError = {}));
@@ -128,2 +133,4 @@ var Network;
     FiatAccountSchema["AccountNumber"] = "AccountNumber";
+    FiatAccountSchema["MobileMoney"] = "MobileMoney";
+    FiatAccountSchema["DuniaWallet"] = "DuniaWallet";
 })(FiatAccountSchema = exports.FiatAccountSchema || (exports.FiatAccountSchema = {}));
@@ -133,3 +140,12 @@ var FiatAccountType;
     FiatAccountType["BankAccount"] = "BankAccount";
+    FiatAccountType["MobileMoney"] = "MobileMoney";
+    FiatAccountType["DuniaWallet"] = "DuniaWallet";
 })(FiatAccountType = exports.FiatAccountType || (exports.FiatAccountType = {}));
+var SupportedOperatorEnum;
+(function (SupportedOperatorEnum) {
+    SupportedOperatorEnum["ORANGE"] = "ORANGE";
+    SupportedOperatorEnum["MOOV"] = "MOOV";
+    SupportedOperatorEnum["MTN"] = "MTN";
+    SupportedOperatorEnum["WAVE"] = "WAVE";
+})(SupportedOperatorEnum = exports.SupportedOperatorEnum || (exports.SupportedOperatorEnum = {}));
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "@fiatconnect/fiatconnect-types",
-  "version": "3.2.0",
+  "version": "3.3.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": {

src/index.ts

@@ -179,3 +179,5 @@
   fiatAccountId: string
-}
+  transferId: string
+  transferAddress: string
+};
 
@@ -195,3 +197,7 @@ /*
   TransferStarted = 'TransferStarted',
-  TransferPending = 'TransferPending',
+  TransferFiatFundsDebited = 'TransferFiatFundsDebited',
+  TransferSendingCryptoFunds = 'TransferSendingCryptoFunds',
+  TransferAmlFailed = 'TransferAmlFailed',
+  TransferReadyForUserToSendCryptoFunds = 'TransferReadyForUserToSendCryptoFunds',
+  TransferReceivedCryptoFunds = 'TransferReceivedCryptoFunds',
   TransferComplete = 'TransferComplete',
@@ -270,2 +276,3 @@ TransferFailed = 'TransferFailed',
   ExpirationTooLong = 'ExpirationTooLong',
+  InvalidFiatAccount = 'InvalidFiatAccount',
 }
@@ -319,12 +326,20 @@
 export enum FiatAccountSchema {
-  AccountNumber = 'AccountNumber'
+  AccountNumber = 'AccountNumber',
+  MobileMoney = 'MobileMoney',
+  DuniaWallet = 'DuniaWallet',
 }
 
 export enum FiatAccountType {
-  BankAccount = 'BankAccount'
+  BankAccount = 'BankAccount',
+  MobileMoney = 'MobileMoney',
+  DuniaWallet = 'DuniaWallet'
 }
 
-export interface AccountNumber {
-  accountName: string,
-  institutionName: string,
+interface RequiredFiatAccountSchemaFields {
+  accountName: string;
+  institutionName: string;
+  fiatAccountType: FiatAccountType,
+}
+
+export type AccountNumber = RequiredFiatAccountSchemaFields & {
   accountNumber: string,
@@ -334,3 +349,21 @@ country: string,
 }
+export type MobileMoney = RequiredFiatAccountSchemaFields & {
+  mobile: string,
+  country: string,
+  operator: SupportedOperatorEnum,
+  fiatAccountType: FiatAccountType.MobileMoney
+}
 
+export type DuniaWallet = RequiredFiatAccountSchemaFields & {
+  mobile: string;
+  fiatAccountType: FiatAccountType.DuniaWallet;
+};
+
+export enum SupportedOperatorEnum {
+  ORANGE = 'ORANGE',
+  MOOV = 'MOOV',
+  MTN = 'MTN',
+  WAVE = 'WAVE',
+}
+
 // https://github.com/fiatconnect/specification/blob/5929f7ea8ca99796608e89a9c8da4c1033dacf05/fiatconnect-api.md#728-personaldataanddocuments
@@ -337,0 +370,0 @@ export interface PersonalDataAndDocumentsKyc {

New alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

35380

increased by12.23%

Lines of code

779

increased by10.97%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes