react-native-unit-components 1.15.0 → 2.0.0

package/src/types/shared/error.types.ts

@@ -1,38 +1,39 @@
-export type UNError = {
-  errors: UNErrorData[]
+export type UNComponentsError = {
+  errors: UNComponentsErrorData[]
 }
 
-export type UNErrorData = {
+export type UNComponentsErrorData = {
   status?: string,
   title: string,
   detail?: string,
   details?: string,
-  meta?: UNErrorMeta
-  code?: UNErrorCodes,
+  meta?: UNComponentsErrorMeta
+  code?: UNComponentsErrorCodes,
   error?: Error
 }
 
-interface UNErrorMeta {
+interface UNComponentsErrorMeta {
   meta: Record<string, string>,
 }
 
-export enum UNErrorCodes {
-    FEATURE_DISABLED = 'feature_disabled',
-    INVALID_VALUE = 'invalid_value',
-    LIMITS_EXCEEDED = 'limits_exceeded',
-    NOT_FOUND = 'not_found',
-    ACCOUNT_CUSTOMER_MISMATCH = 'account_customer_mismatch',
-    NOT_SUPPORTED_FOR_ACCOUNT_STATUS = 'not_supported_for_account_status',
-    NOT_SUPPORTED_FOR_ACCOUNT_TYPE = 'not_supported_for_account_type',
-    NOT_SUPPORTED_FOR_CARD = 'not_supported_for_card',
-    NOT_SUPPORTED_FOR_CARD_STATUS = 'not_supported_for_card_status',
-    NOT_SUPPORTED_FOR_CARD_TYPE = 'not_supported_for_card_type',
-    INVALID_NONCE = 'invalid_nonce',
-    NOT_SUPPORTED_FOR_PAYMENT_TYPE = 'not_supported_for_payment_type',
-    PAYMENT_INVALID = 'payment_invalid',
-    UNAUTHORIZED = 'unauthorized',
-    FORBIDDEN = 'forbidden',
-    ALREADY_EXISTS = 'already_exists',
-    CUSTOMER_NAME_UNDELIVERABLE = 'customer_name_undeliverable',
-    CUSTOMER_ADDRESS_UNDELIVERABLE = 'customer_address_undeliverable',
+export enum UNComponentsErrorCodes {
+  FEATURE_DISABLED = 'feature_disabled',
+  INVALID_VALUE = 'invalid_value',
+  LIMITS_EXCEEDED = 'limits_exceeded',
+  NOT_FOUND = 'not_found',
+  ACCOUNT_CUSTOMER_MISMATCH = 'account_customer_mismatch',
+  NOT_SUPPORTED_FOR_ACCOUNT_STATUS = 'not_supported_for_account_status',
+  NOT_SUPPORTED_FOR_ACCOUNT_TYPE = 'not_supported_for_account_type',
+  NOT_SUPPORTED_FOR_CARD = 'not_supported_for_card',
+  NOT_SUPPORTED_FOR_CARD_STATUS = 'not_supported_for_card_status',
+  NOT_SUPPORTED_FOR_CARD_TYPE = 'not_supported_for_card_type',
+  INVALID_NONCE = 'invalid_nonce',
+  NOT_SUPPORTED_FOR_PAYMENT_TYPE = 'not_supported_for_payment_type',
+  PAYMENT_INVALID = 'payment_invalid',
+  UNAUTHORIZED = 'unauthorized',
+  FORBIDDEN = 'forbidden',
+  ALREADY_EXISTS = 'already_exists',
+  CUSTOMER_NAME_UNDELIVERABLE = 'customer_name_undeliverable',
+  CUSTOMER_ADDRESS_UNDELIVERABLE = 'customer_address_undeliverable',
+  MISSING_TOKEN = 'missing_token'
 }

package/src/types/shared/index.ts

@@ -1,16 +1,20 @@
-export * from './bookPayment.types';
+export * from './payment';
+export * from './transaction';
+export * from './authorization.types';
 export * from './card.types';
 export * from './onLoadResponse.types';
-export * from './achCredit.types';
-export * from './payments.types';
+export * from './ach.types';
 export * from './account.types';
 export * from './checkDeposit.types';
+export * from './counterparty.types';
 export * from './activity.types';
+export * from './customer.types';
 export * from './fonts.types';
 export * from './error.types';
 export * from './versioning.types';
 export * from './multipleCards.types';
-export * from './fundAccountPayment.types';
 export * from './payeeManagement.types';
+export * from './repayment.types';
+export * from './multiFactorAuthentication.types';
 export * from './env.types';
 export * from './securitySettings';

package/src/types/shared/multiFactorAuthentication.types.ts

@@ -1,17 +1,17 @@
 export interface UNMultiFactorVerification {
-	type: string
+  type: string
 
-	attributes: {
-		verificationToken: string
-		phoneLast4Digits?: string
-	}
+  attributes: {
+    verificationToken: string
+    phoneLast4Digits?: string
+  }
 }
 
 export interface UNCustomerTokenVerification extends UNMultiFactorVerification {
-	type: 'customerTokenVerification'
+  type: 'customerTokenVerification'
 }
 
 export type UNMultiFactorAuthenticationFinished = {
   token: string
-	expiresIn: number
+  expiresIn: number
 }

package/src/types/shared/multipleCards.types.ts

@@ -1,8 +1,8 @@
-import type { UNCardData } from './card.types';
+import type { UNCard } from './card.types';
 
 export enum UNMultipleCardsComponentPaginationType {
   infiniteScroll = 'infiniteScroll',
   pagination = 'pagination'
 }
 
-export type UNMultipleCardsOnLoadData = UNCardData[];
+export type UNMultipleCardsOnLoadData = UNCard[];

package/src/types/shared/onLoadResponse.types.ts

@@ -1,9 +1,9 @@
-import type { UNError } from './error.types';
+import type { UNComponentsError } from './error.types';
 
-export type UNOnLoadResponseData<T> = {
+export type UNComponentsOnLoadResponseData<T> = {
   data: T,
 }
 
-export type UNOnLoadResponse<T> =
-  | UNOnLoadResponseData<T>
-  | UNError
+export type UNComponentsOnLoadResponse<T> =
+  | UNComponentsOnLoadResponseData<T>
+  | UNComponentsError

package/src/types/shared/payeeManagement.types.ts

@@ -1,80 +1,9 @@
-import { UNConnectedAccountStatus, UNConnectionAccountType, UNCounterpartyAccountType, UNCounterpartyPermission, UNCounterpartyType } from './payments.types';
-
-export type UNPayeeConnectedAccount = {
-	type: 'plaidConnectedAccount'
-	id: string
-	attributes: {
-		mask: string
-		name: string
-		type: string
-		subType: string
-		createdAt: string
-		updatedAt: string
-		status: UNConnectedAccountStatus
-		connectionType: UNConnectionAccountType
-	}
-	relationships: {
-		customer: {
-			data: {
-				type: 'customer'
-				id: number
-			}
-		}
-	}
-}
-
-export type UNPayeeCounterparty = {
-  id: string,
-  type: string,
-	attributes: {
-		name: string
-		bank?: string
-		routingNumber: string
-		accountNumber: string
-		accountType: UNCounterpartyAccountType
-		type: UNCounterpartyType
-		permissions: UNCounterpartyPermission
-		tags?: {[key: string]: string}
-	},
-  relationships: {
-		customer: {
-			data: {
-				type: 'customer'
-				id: number
-			}
-		}
-	}
-}
-
 export enum UNPayeeManagementMenuItem {
-  sendFunds = 'sendFunds',
-  delete = 'delete'
+	sendFunds = 'sendFunds',
+	delete = 'delete'
 }
 
 export enum UNPayeeManagementComponentPaginationType {
-  infiniteScroll = 'infiniteScroll',
-  pagination = 'pagination'
-}
-
-export type UNPayeeOnLoadCounterparty = {
-	id: string
-	attributes: {
-		name: string
-		bank?: string
-		routingNumber: string
-		accountNumber: string
-		accountType: UNCounterpartyAccountType
-		type: UNCounterpartyType
-		permissions: UNCounterpartyPermission
-		createdAt: Date
-		tags: {[key: string]: string}
-	}
-	relationships: {
-		customer: {
-			data: {
-				type: 'customer'
-				id: number
-			}
-		}
-	}
+	infiniteScroll = 'infiniteScroll',
+	pagination = 'pagination'
 }

package/src/types/shared/payment/achPayment.types.ts

@@ -0,0 +1,47 @@
+import { UNDirection, UNOrg } from '../types';
+import { UNAchCounterparty, UNCents, UNCounterpartyVerificationMethod, UNPaymentStatus, UNPaymentType, UNRelationshipsAccount, UNRelationshipsCounterparty, UNRelationshipsCustomer, UNRelationshipsRecurringPayment, UNRelationshipsTransaction } from './payments.types';
+
+export type UNACHPayment = {
+  type: UNPaymentType.AchPayment
+  id: string
+  attributes: UNAchPaymentAttributes
+  relationships: {
+    account: {
+      data: UNRelationshipsAccount
+    }
+    customer?: {
+      data: UNRelationshipsCustomer
+    }
+    customers?: {
+      data: UNRelationshipsCustomer[]
+    }
+    transaction?: {
+      data: UNRelationshipsTransaction
+    }
+    counterparty?: {
+      data: UNRelationshipsCounterparty
+    }
+    recurringPayment?: {
+      data: UNRelationshipsRecurringPayment
+    }
+    org?: {
+      data: UNOrg
+    }
+  }
+}
+
+export type UNAchPaymentAttributes = {
+  createdAt: Date
+  amount: UNCents
+  direction: UNDirection
+  description: string
+  status: UNPaymentStatus
+  settlementDate?: Date
+  reason?: string
+  tags?: { [key: string]: string }
+  addenda?: string
+  counterparty: UNAchCounterparty
+  expectedCompletionDate?: Date
+  counterpartyVerificationMethod?: keyof typeof UNCounterpartyVerificationMethod
+  sameDay?: boolean
+}

package/src/types/shared/payment/billPayment.types.ts

@@ -0,0 +1,33 @@
+import { UNDirection, UNOrg } from '../types';
+import { UNCents, UNPaymentStatus, UNPaymentType, UNRelationshipsAccount, UNRelationshipsCustomer, UNRelationshipsTransaction } from './payments.types';
+
+export type UNBillPayment = {
+  type: UNPaymentType.BillPayment
+  id: string
+  attributes: {
+    createdAt: Date
+    amount: UNCents
+    direction: UNDirection
+    description: string
+    status: UNPaymentStatus
+    reason?: string
+    tags?: { [key: string]: string }
+  }
+  relationships: {
+    account: {
+      data: UNRelationshipsAccount
+    }
+    customer?: {
+      data: UNRelationshipsCustomer
+    }
+    customers?: {
+      data: UNRelationshipsCustomer[]
+    }
+    transaction?: {
+      data: UNRelationshipsTransaction
+    }
+    org?: {
+      data: UNOrg
+    }
+  }
+}

package/src/types/shared/payment/bookPayment.types.ts

@@ -0,0 +1,48 @@
+import { UNDirection, UNOrg } from '../types';
+import { UNCents, UNPaymentStatus, UNPaymentType, UNRelationshipsAccount, UNRelationshipsCustomer, UNRelationshipsRecurringPayment, UNRelationshipsTransaction } from './payments.types';
+
+export type UNBookPayment = {
+  type: UNPaymentType.BookPayment
+  id: string
+  attributes: {
+    createdAt: Date
+    amount: UNCents
+    direction: UNDirection
+    description: string
+    status: UNPaymentStatus
+    reason?: string
+    tags?: { [key: string]: string }
+  }
+  relationships: {
+    account: {
+      data: UNRelationshipsAccount
+    }
+    customer?: {
+      data: UNRelationshipsCustomer
+    }
+    customers?: {
+      data: UNRelationshipsCustomer[]
+    }
+    transaction?: {
+      data: UNRelationshipsTransaction
+    }
+    counterpartyAccount: {
+      data: {
+        type: string
+        id: number
+      }
+    }
+    counterpartyCustomer: {
+      data: {
+        type: string
+        id: number
+      }
+    }
+    recurringPayment?: {
+      data: UNRelationshipsRecurringPayment
+    }
+    org?: {
+      data: UNOrg
+    }
+  }
+}

package/src/types/shared/payment/index.ts

@@ -0,0 +1,5 @@
+export * from './achPayment.types';
+export * from './billPayment.types';
+export * from './bookPayment.types';
+export * from './wirePayment.types';
+export * from './payments.types';

package/src/types/shared/payment/payments.types.ts

@@ -0,0 +1,79 @@
+import { UNCounterpartyAccountType } from '../counterparty.types';
+import { UNACHPayment } from './achPayment.types';
+import { UNBillPayment } from './billPayment.types';
+import { UNBookPayment } from './bookPayment.types';
+import { UNWirePayment } from './wirePayment.types';
+
+export type UNPayment = UNACHPayment | UNBookPayment | UNWirePayment | UNBillPayment
+
+export enum UNPaymentType {
+  AchPayment = 'achPayment',
+  BookPayment = 'bookPayment',
+  WirePayment = 'wirePayment',
+  BillPayment = 'billPayment',
+  CardToCardPayment = 'cardToCardPayment',
+}
+
+export type UNPaymentStatus = 'Sent' | 'Rejected' | 'Pending' | 'Clearing' | 'Canceled' | 'Returned' | 'PendingReview'
+
+export type UNAchCounterparty = {
+  name: string
+  accountNumber: string
+  routingNumber: string
+  accountType: UNCounterpartyAccountType
+}
+
+export enum UNPlaidAccountFilter {
+  checking = 'checking',
+  savings = 'savings',
+}
+
+export function parseUNAccountFilters(input?: string | null): UNPlaidAccountFilter[] {
+  if (!input) return [];
+
+  return input
+    .split(',')
+    .map(s => s.trim())
+    .filter((s): s is UNPlaidAccountFilter => s in UNPlaidAccountFilter);
+}
+
+export enum UNCounterpartyVerificationMethod {
+  Plaid = 'Plaid',
+}
+
+export enum UNCardNetwork {
+  Visa = 'Visa',
+  Diners = 'Diners',
+  Maestro = 'Maestro',
+  Generic = 'Generic',
+  Discover = 'Discover',
+  MasterCard = 'MasterCard',
+  AmericanExpress = 'AmericanExpress',
+}
+
+export type UNCents = number
+
+export type UNRelationshipsTransaction = {
+  type: string
+  id: number
+}
+
+export type UNRelationshipsCounterparty = {
+  type: string
+  id: number
+}
+
+export type UNRelationshipsRecurringPayment = {
+  type: string
+  id: number
+}
+
+export type UNRelationshipsAccount = {
+  type: string
+  id: string
+}
+
+export type UNRelationshipsCustomer = {
+  type: string
+  id: string
+}

package/src/types/shared/payment/wirePayment.types.ts

@@ -0,0 +1,47 @@
+import { UNAddress, UNDirection, UNOrg } from '../types';
+import { UNCents, UNPaymentStatus, UNPaymentType, UNRelationshipsAccount, UNRelationshipsCustomer, UNRelationshipsTransaction } from './payments.types';
+
+export type UNWirePayment = {
+  type: UNPaymentType.WirePayment
+  id: string
+  attributes: {
+    createdAt: Date
+    amount: UNCents
+    direction: UNDirection
+    description: string
+    status: UNPaymentStatus
+    counterparty: UNWirePaymentCounterparty
+    reason?: string
+    tags?: { [key: string]: string }
+  }
+  relationships: {
+    account: {
+      data: UNRelationshipsAccount
+    }
+    customer?: {
+      data: UNRelationshipsCustomer
+    }
+    customers?: {
+      data: UNRelationshipsCustomer[]
+    }
+    transaction?: {
+      data: UNRelationshipsTransaction
+    }
+    counterpartyAccount: {
+      data: {
+        type: string
+        id: number
+      }
+    }
+    org?: {
+      data: UNOrg
+    }
+  }
+}
+
+type UNWirePaymentCounterparty = {
+  name: string
+  routingNumber: string
+  accountNumber: string
+  address: UNAddress
+}

package/src/types/shared/repayment.types.ts

@@ -1,12 +1,13 @@
-export type UNRepaymentData = UNCreditAccountRepaymentData
-
-export type UNCreditAccountRepaymentData = {
-	type: 'creditAccountRepaymentInformation'
-	attributes: {
-		remainingAmountDue: number // Cents
-		remainingAmountOverdue: number // Cents
-		statementPeriodStart: string // "2023-07-01",
-		statementPeriodEnd: string // "2023-07-31",
-		nextRepaymentDueDate: string // "2023-08-13"
-	}
+export type UNCreditAccountRepaymentInformation = {
+  type: 'creditAccountRepaymentInformation'
+  attributes: UNCreditAccountRepaymentInformationAttributes
 }
+
+export interface UNCreditAccountRepaymentInformationAttributes {
+  initiatedRepayments: number // Cents
+  remainingAmountDue: number // Cents
+  remainingAmountOverdue: number // Cents
+  statementPeriodStart: string // "2023-07-01",
+  statementPeriodEnd: string // "2023-07-31",
+  nextRepaymentDueDate: string // "2023-08-13"
+}

package/src/types/shared/securitySettings.ts

@@ -1,8 +1,8 @@
-export enum UNSnapshotProtectionStrategy {
+export enum UNComponentsSnapshotProtectionStrategy {
   FullProtection = 'fullProtection',
   None = 'none'
 }
 
-export interface UNSecuritySettings {
-  snapshotProtectionStrategy: UNSnapshotProtectionStrategy
+export interface UNComponentsSecuritySettings {
+  snapshotProtectionStrategy: UNComponentsSnapshotProtectionStrategy
 }

package/src/types/shared/transaction/UNAccountLowBalanceClosureTransaction.ts

@@ -0,0 +1,43 @@
+import { UNCents } from '../payment/payments.types';
+import { UNDirection } from '../types';
+import { UNTransactionTypes } from './transactions.types';
+
+export type UNAccountLowBalanceClosureTransaction = {
+  type: UNTransactionTypes.AccountLowBalanceClosure
+  id: number
+  attributes: {
+    createdAt: Date
+    amount: UNCents
+    direction: UNDirection
+    balance: UNCents
+    summary: string
+  }
+  relationships: {
+    account: {
+      data: {
+        type: string
+        id: number
+      }
+    }
+    customer?: {
+      data: {
+        type: string
+        id: number
+      }
+    }
+    customers?: {
+      data: [
+        {
+          type: 'customer'
+          id: string
+        }
+      ]
+    }
+    org?: {
+      data: {
+        type: string
+        id: number
+      }
+    }
+  }
+}; 

package/src/types/shared/transaction/UNAdjustmentTransaction.ts

@@ -0,0 +1,43 @@
+import { UNCents } from '../payment/payments.types';
+import { UNTransactionTypes } from './transactions.types';
+import { UNDirection } from '../types';
+
+export type UNAdjustmentTransaction = {
+  type: UNTransactionTypes.Adjustment
+  id: number
+  attributes: {
+    createdAt: Date
+    amount: UNCents
+    direction: UNDirection
+    balance: UNCents
+    summary: string
+  }
+  relationships: {
+    account: {
+      data: {
+        type: string
+        id: number
+      }
+    }
+    customer?: {
+      data: {
+        type: string
+        id: number
+      }
+    }
+    customers?: {
+      data: [
+        {
+          type: 'customer'
+          id: string
+        }
+      ]
+    }
+    org?: {
+      data: {
+        type: string
+        id: number
+      }
+    }
+  }
+}; 

package/src/types/shared/transaction/UNAtmTransaction.ts

@@ -0,0 +1,48 @@
+import { UNCents } from '../payment/payments.types';
+import { UNDirection } from '../types';
+import { UNTransactionTypes } from './transactions.types';
+
+export type UNAtmTransaction = {
+  type: UNTransactionTypes.ATM
+  id: number
+  attributes: {
+    createdAt: Date
+    amount: UNCents
+    direction: UNDirection
+    balance: UNCents
+    summary: string
+    atmName: string
+    atmLocation?: string
+    interchange?: number | null
+    networkTransactionId?: string
+    cardLast4Digits: string
+  }
+  relationships: {
+    account: {
+      data: {
+        type: string
+        id: number
+      }
+    }
+    customer?: {
+      data: {
+        type: string
+        id: number
+      }
+    }
+    customers?: {
+      data: [
+        {
+          type: 'customer'
+          id: string
+        }
+      ]
+    }
+    org?: {
+      data: {
+        type: string
+        id: number
+      }
+    }
+  }
+};