@vantagepay/vantagepay 0.17.3 → 0.18.0

package/package.json

@@ -1,26 +1,34 @@
 {
   "name": "@vantagepay/vantagepay",
-  "version": "0.17.3",
+  "version": "0.18.0",
   "description": "VantagePay API wrapper and SDK for integrating into VantagePay payment, consumer and merchant services.",
-  "main": "./dist/index.js",
-  "module": "./dist/index.mjs",
-  "unpkg": "./dist/index.umd.js",
-  "source": "./src/index.ts",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
   "repository": {
     "type": "git",
     "url": ""
   },
   "scripts": {
-    "build": "microbundle --tsconfig tsconfig.json --globals @microsoft/signalr=signalR",
-    "dev": "microbundle watch --tsconfig tsconfig.json --globals @microsoft/signalr=signalR",
+    "generate-types": "barrelsby -c .barrelsbyrc.json",
+    "build": "tsup",
+    "dev": "tsup --watch",
     "test": "jest --coverage",
+    "test:integration": "jest --config jest.integration.config.js",
     "format": "npx prettier --write .",
     "ncu": "npx npm-check-updates --interactive"
   },
   "dependencies": {
     "@microsoft/signalr": "^10.0.0",
-    "axios": "^1.13.4",
-    "axios-auth-refresh": "^3.3.6",
+    "axios": "^1.16.0",
+    "axios-auth-refresh": "^5.0.2",
     "axios-retry": "^4.5.0",
     "pubsub-js": "^1.9.5",
     "qrcode": "^1.5.4"
@@ -30,9 +38,11 @@
     "@types/jest": "^30.0.0",
     "@types/pubsub-js": "^1.8.6",
     "@types/qrcode": "^1.5.6",
-    "jest": "^30.2.0",
-    "microbundle": "0.15.1",
-    "ts-jest": "^29.4.6"
+    "barrelsby": "^2.8.1",
+    "jest": "^30.4.2",
+    "ts-jest": "^29.4.9",
+    "tsup": "^8.5.1",
+    "typescript": "^6.0.3"
   },
   "keywords": [
     "vantagepay",
@@ -43,6 +53,8 @@
   "author": "VantagePay <npm@vantagepay.com>",
   "license": "MIT",
   "files": [
-    "dist"
+    "dist",
+    "CHANGELOG.md",
+    "LICENSE"
   ]
 }

package/dist/apiConfig.d.ts

@@ -1,10 +0,0 @@
-import { AxiosRequestHeaders } from 'axios';
-export type ApiConfig = {
-    baseUrl?: string;
-    headers?: AxiosRequestHeaders;
-    language?: string;
-    retries?: number;
-    consoleLogging?: boolean;
-    logBatchSize?: number;
-    logBatchInterval?: number;
-};

package/dist/apiError.d.ts

@@ -1,5 +0,0 @@
-export declare class ApiError extends Error {
-    statusCode: number;
-    result: any;
-    constructor(statusCode: number, result: any, message?: string);
-}

package/dist/apiTokens.d.ts

@@ -1,7 +0,0 @@
-declare class ApiTokens {
-    accessToken: string | null;
-    refreshToken: string | null;
-    decodeToken(token?: string): any;
-}
-declare const _default: ApiTokens;
-export default _default;

package/dist/authentication/index.d.ts

@@ -1,26 +0,0 @@
-import { BaseApi } from '../baseApi';
-import { FaceCheckResult } from '../common/types';
-import { FaceMovementDetectionLevel } from '../lookups/types';
-import { TokenResponse } from './types';
-export declare class Authentication extends BaseApi {
-    isLoggedIn(): boolean;
-    login(username: string, password: string): Promise<TokenResponse>;
-    logout(): Promise<void>;
-    refresh(token?: string): Promise<TokenResponse>;
-    checkLiveness(base64Images: string[]): Promise<FaceMovementDetectionLevel>;
-    checkFace(base64Image: string): Promise<FaceCheckResult>;
-    changePassword(oldPassword: string, newPassword: string): Promise<TokenResponse>;
-    forgotPassword(username: string): Promise<void>;
-    validateOtp(otpValue: string): Promise<TokenResponse>;
-    resendOtp(): Promise<void>;
-    resendEmailAddressVerification(): Promise<void>;
-    getCurrentConsumerReference(token?: string): string;
-    getCurrentMerchantReference(token?: string): string;
-    getCurrentBusinessReference(token?: string): string;
-    getCurrentTerminalReference(token?: string): string;
-    getCurrentUserReference(token?: string): string;
-    getCurrentUserName(token?: string): string;
-    getRedirectAction(token?: string): string;
-    getMobileNumber(token?: string): string;
-    getEmailAddress(token?: string): string;
-}

package/dist/authentication/types.d.ts

@@ -1,77 +0,0 @@
-/** Model to hold information to change a user's password. */
-export declare class ChangePasswordRequest {
-    /** Gets or sets the old password. */
-    oldPassword?: string;
-    /** Gets or sets the new password (required). */
-    newPassword: string;
-    /** Gets or sets the reset code that need to be supplied if you are not authenticated. */
-    resetCode?: string;
-    /** Gets or sets the reference of the user that is linked to this login information. */
-    userReference?: string;
-}
-export declare class ForgotPasswordRequest {
-    username: string;
-}
-export declare class LivenessRequest {
-    base64Images: string[];
-}
-/** Model to hold login information that can be used to access the system and generate tokens. */
-export declare class LoginCredentials {
-    /** Gets or sets the username (required). */
-    username: string;
-    /** Gets or sets the password (required). */
-    password: string;
-    /** Indicates whether the user is locked out. */
-    isLockedOut: boolean;
-    /** Gets the reason (if any) of why the user has been locked out. */
-    reasonForLockout?: string;
-}
-/** Provides details for the reason why a login attempt failed (401 errors). */
-export declare class LoginErrorResponse {
-    /** Gets or sets a value indicating whether either the username or password credentials provided to login are invalid. */
-    invalidUsernameOrPassword?: boolean;
-    /** Gets or sets a value indicating whether the user is required to change their password first before attempting to login. */
-    mustChangePassword?: boolean;
-    /** Gets or sets a value indicating whether the user is required to validate their phone number first (OTP or phone call) before attempting to login. */
-    mustValidatePhoneNumber?: boolean;
-    /** Gets or sets a value indicating whether the user is required to validate their email address first before attempting to login. */
-    mustValidateEmailAddress?: boolean;
-    /** Gets or sets a value indicating whether the user has been deactivated. */
-    deactivated?: boolean;
-    /** Gets or sets a value indicating whether further information about the user is required and the registration process needs to be complete before attempting to login. */
-    registrationRequired?: boolean;
-    /** Gets or sets a value indicating whether the user is currently locked out. */
-    lockedOut?: boolean;
-    /** Gets or sets an access token that can be used to call the change password end-point. */
-    changePasswordAccessToken?: string;
-    /** Gets or sets an access token that can be used to call the change password end-point. */
-    validatePhoneNumberAccessToken?: string;
-    /** Gets or sets an access token that can be used to call the resend email verification end-point, and view current merchant / consumer details. */
-    resendEmailVerificationToken?: string;
-}
-/** Model to hold the credentials for a login attempt. */
-export declare class LoginRequest {
-    /** Gets or sets the username (required). */
-    username: string;
-    /** Gets or sets the password (required). */
-    password: string;
-}
-export declare class OtpVerificationRequest {
-    otpValue: string;
-}
-export declare class OtpVerificationResponse {
-    userAccountExists: boolean;
-    accessToken: string;
-}
-export declare class SelfieRequest {
-    base64Image?: string;
-}
-/** Provides token information for successful login and refresh operations. */
-export declare class TokenResponse {
-    /** Gets or sets a JWT Refresh token that can be used to request a new Access tokens. */
-    refreshToken?: string;
-    /** Gets or sets a JWT Access token that can be used to make API calls. */
-    accessToken?: string;
-    /** Gets or sets the amount of time (in seconds) for which the Access token will be valid. */
-    accessTokenValidForSeconds: number;
-}

package/dist/baseApi.d.ts

@@ -1,10 +0,0 @@
-import { AxiosInstance } from 'axios';
-export { default as ApiTokens } from './apiTokens';
-export declare abstract class BaseApi {
-    private readonly axiosInstance;
-    protected readonly consoleLogging: boolean;
-    protected readonly events: PubSubJS.Base<any, PubSubJS.Message>;
-    constructor(axiosInstance: AxiosInstance, consoleLogging?: boolean);
-    protected request<T>(endpoint: string, method: string, body?: any, token?: string | null): Promise<T>;
-    private convertDatesToIso;
-}

package/dist/common/types.d.ts

@@ -1,115 +0,0 @@
-import { Country } from '../lookups/types';
-import { Currency } from '../lookups/types';
-import { IdentityDocumentType } from '../lookups/types';
-/** Model to hold address details. */
-export declare class Address {
-    /** Gets the address reference. */
-    reference?: string;
-    /** Gets or sets the address external reference if linked to another system. */
-    yourReference?: string;
-    /** Gets or sets the type of address the details are referring to. */
-    addressType: AddressType;
-    /** Gets or sets first line of the address (required). */
-    addressLine1: string;
-    /** Gets or sets second line of the address. */
-    addressLine2?: string;
-    /** Gets or sets third line of the address. */
-    addressLine3?: string;
-    /** Gets or sets postal code of the address. */
-    postalCode?: string;
-    /** Gets or sets 3 character ISO country code the address resides in. */
-    countryIsoCode: Country;
-    /** Gets or sets city the address resides in (required). */
-    city: string;
-    /** Gets or sets state/province the address resides in. */
-    state?: string;
-    /** Gets or sets additional location information for the address so that it can be pinned on a map. */
-    location?: Location;
-    /** Gets or sets the description of the address. */
-    description?: string;
-    /** Gets a single-line formatted string of the address. */
-    formatted: string;
-    isActive: boolean;
-}
-export declare enum AddressType {
-    MAIN = "MAIN",
-    POST = "POST",
-    BILL = "BILL",
-    SHIP = "SHIP"
-}
-/** Model to hold account balance details. */
-export declare class Balance {
-    currency: Currency;
-    availableAmountInCents?: number;
-    currentAmountInCents?: number;
-}
-export declare enum BankAccountType {
-    SAVINGS = "SAVINGS",
-    CURRENT = "CURRENT",
-    FIXED = "FIXED",
-    MONEYMARKET = "MONEYMARKET",
-    CODA = "CODA",
-    BOND = "BOND"
-}
-/** Model to capture generic contact/lead data. */
-export declare class ContactDetails {
-    details: {
-        [key: string]: string;
-    };
-}
-export declare class FaceCheckResult {
-    faceCount: number;
-    containsNoise: boolean;
-    isLowQuality: boolean;
-    isOverExposed: boolean;
-    isUnderExposed: boolean;
-    isBlurry: boolean;
-    isWearingMask: boolean;
-    foreheadNotIncluded: boolean;
-    eyesNotIncluded: boolean;
-    mouthNotIncluded: boolean;
-    faceLeft?: number;
-    faceTop?: number;
-    faceWidth?: number;
-    faceHeight?: number;
-    problems: string[];
-}
-/** Model to hold identification details. */
-export declare class IdentityDocument {
-    /** Gets or sets the identification document reference. */
-    reference?: string;
-    /** Gets or sets the type of identification document submitted by the consumer. */
-    identityDocumentType: IdentityDocumentType;
-    /** Gets or sets the 3 character ISO country code where the document was issued. */
-    countryIsoCode: Country;
-    /** Gets or sets the encrypted identification number. */
-    identityNumber: string;
-    /** Gets or sets the place of issuance. */
-    placeOfIssuance?: string;
-    /** Gets or sets the date at which the identification document was issued. */
-    effectiveDate?: Date;
-    /** Gets or sets the date at which the identification document expires. */
-    expiryDate?: Date;
-}
-/** Model to hold location data. */
-export declare class Location {
-    /** A latitude value expressed as a 64 bit floating point number (required). */
-    latitude: number;
-    /** A longitude value expressed as a 64 bit floating point number (required). */
-    longitude: number;
-    /** The time zone for this location. */
-    timeZone?: string;
-    /** The description of this location (if available). */
-    description?: string;
-}
-export declare class NameAndReference {
-    name: string;
-    reference: string;
-    externalReference: string;
-}
-/** Model to hold API endpoint and access token for an environment. */
-export declare class SwitchEnvironmentInfo {
-    name: string;
-    accessToken: string;
-    apiBaseUrl: string;
-}

package/dist/consumers/index.d.ts

@@ -1,21 +0,0 @@
-import { BaseApi } from '../baseApi';
-import { Balance, ContactDetails } from '../common/types';
-import { Consumer, ConsumerFile, Message } from './types';
-export declare class Consumers extends BaseApi {
-    createConsumer(request: Consumer): Promise<Consumer>;
-    updateConsumer(request: Consumer): Promise<Consumer>;
-    deleteConsumer(): Promise<void>;
-    getConsumer(): Promise<Consumer>;
-    getConsumerAgreement(): Promise<string>;
-    acceptConsumerAgreement(): Promise<void>;
-    stopCard(cardReference: string, reason?: string): Promise<void>;
-    stopDebitOrders(debitOrderReferences: string[]): Promise<void>;
-    disputeDebitOrders(debitOrderReferences: string[]): Promise<void>;
-    getBankAccountBalance(bankAccountReference: string): Promise<Balance>;
-    downloadFile(fileReference: string, queryParameters?: Record<string, string>): Promise<ConsumerFile | null>;
-    submitFeedback(description: string): Promise<void>;
-    getAllMessages(): Promise<Message[]>;
-    getMessage(messageReference: string): Promise<Message>;
-    deleteMessage(messageReference: string): Promise<void>;
-    contactSupport(request: ContactDetails): Promise<void>;
-}