@paydock/client-sdk 1.120.1 → 1.121.0

package/bundles/widget.umd.js.d.ts

@@ -1,4 +1,4 @@
-import { Observable, Subscriber } from 'rxjs';
+import { Observable } from 'rxjs';
 import { MicroAgent } from '@newrelic/browser-agent/loaders/micro-agent';
 
 declare class ApiCharge {
@@ -117,7 +117,6 @@ declare class ApiBase {
     protected env: Env;
     auth: string;
     authType: API_AUTH_TYPE;
-    private stoppedPooling;
     constructor(auth: string, authType?: API_AUTH_TYPE);
     /**
      * Current method can change environment. By default environment = sandbox.
@@ -129,9 +128,10 @@ declare class ApiBase {
      * @param {string} [alias] - Own domain alias
      */
     setEnv(env: string, alias?: string): ApiBase;
-    longPollingObservable<Req extends object, Res>(method: 'GET' | 'POST', url: string, requestBody: Req, sessionId: string, reconnectInterval?: number): Observable<Res>;
-    longPull(subscriber: Subscriber<any>, method: any, link: any, auth: any, requestBody: any, sessionId: any, reconnectInterval: any): void;
-    destroyLongPolling(): void;
+    requestObservable<Req extends object, Res>(method: 'GET' | 'POST', url: string, requestBody: Req): Observable<Res>;
+    private makeRequest;
+    private onRequestLoad;
+    private onRequestError;
     setAuthType(): API_AUTH_TYPE;
     getClient(method: Extract<HttpRequestMethod, 'GET' | 'POST'>, link: string): {
         config: XMLHttpRequest;
@@ -145,7 +145,7 @@ declare class ApiBase {
         text: string;
         status: number;
     }, cb: any, errorCb: any): any;
-    parserPromise<Res>({ text, status }: {
+    parserPromise<Res>({ text, status, }: {
         text: string;
         status: number;
     }): Promise<Res>;
@@ -159,15 +159,6 @@ declare class ApiBase {
     };
 }
 
-interface BrowserDetails {
-    name: string;
-    java_enabled: string;
-    language: string;
-    screen_height: string;
-    screen_width: string;
-    time_zone: string;
-    color_depth: string;
-}
 /**
  * Interface for browser details response.
  * @interface BrowserDetails
@@ -180,6 +171,15 @@ interface BrowserDetails {
  * @param {string} [time_zone]
  * @param {string} [color_depth]
  * */
+interface BrowserDetails {
+    name: string;
+    java_enabled: string;
+    language: string;
+    screen_height: string;
+    screen_width: string;
+    time_zone: string;
+    color_depth: string;
+}
 /**
  * Class Api include method for working with paydock api
  * @constructor
@@ -453,6 +453,7 @@ interface IParams extends IStyles$1, ITexts, ICommonParams {
     language?: string;
     vault_display_token?: string;
     sdk_origin?: boolean;
+    hide_ui_errors?: boolean;
 }
 interface ICountryPhoneMask {
     preferred_countries?: string[];
@@ -591,6 +592,7 @@ declare enum WALLET_TYPE {
 }
 interface ApplePayStyles {
     button_type?: 'add-money' | 'book' | 'buy' | 'check-out' | 'continue' | 'contribute' | 'donate' | 'order' | 'pay' | 'plain' | 'reload' | 'rent' | 'set-up' | 'subscribe' | 'support' | 'tip' | 'top-up';
+    button_style?: 'black' | 'white' | 'white-outline';
 }
 interface GooglePayStyles {
     button_type?: 'book' | 'buy' | 'checkout' | 'donate' | 'order' | 'pay' | 'plain' | 'subscribe';
@@ -631,6 +633,7 @@ interface IWalletMeta {
     style?: WalletStyles;
     wallets?: WALLET_TYPE[];
     client_id?: string;
+    apple_pay_capabilities?: Array<'credentials_available' | 'credentials_status_unknown' | 'credentials_unavailable'>;
 }
 
 declare class Link {
@@ -940,6 +943,45 @@ interface IElementStyleTitleDescription {
     margin?: string;
 }
 
+declare const ERROR_CATEGORY: {
+    readonly CONFIGURATION: "configuration";
+    readonly IDENTITY: "identity_access_management";
+    readonly INTERNAL: "internal";
+    readonly PROCESS: "process";
+    readonly RESOURCE: "resource";
+    readonly VALIDATION: "validation";
+};
+type ErrorCategory = (typeof ERROR_CATEGORY)[keyof typeof ERROR_CATEGORY];
+declare const ERROR_CAUSE: {
+    readonly ABORTED: "aborted";
+    readonly ACCESS_FORBIDDEN: "access_forbidden";
+    readonly ALREADY_EXISTS: "already_exists";
+    readonly CANCELED: "canceled";
+    readonly INVALID_CONFIGURATION: "invalid_configuration";
+    readonly INVALID_INPUT: "invalid_input";
+    readonly NOT_FOUND: "not_found";
+    readonly NOT_IMPLEMENTED: "not_implemented";
+    readonly RATE_LIMITED: "rate_limited";
+    readonly SERVER_BUSY: "server_busy";
+    readonly SERVICE_UNREACHABLE: "service_unreachable";
+    readonly UNAUTHORIZED: "unauthorized";
+    readonly UNKNOWN: "unknown_error";
+    readonly UNPROCESSABLE_ENTITY: "unprocessable_entity";
+};
+type ErrorCause = (typeof ERROR_CAUSE)[keyof typeof ERROR_CAUSE];
+interface ErrorDetails {
+    cause: ErrorCause;
+    contextId: string;
+    message: string;
+    timestamp: string;
+}
+interface IEventError {
+    cause: ErrorCause;
+    category: ErrorCategory;
+    retryable: boolean;
+    details: ErrorDetails;
+}
+
 /**
  *
  * Class MultiWidget include method for for creating iframe url
@@ -1133,6 +1175,13 @@ declare class MultiWidget {
      * @param {boolean} validateCardNumberInput - [validateCardNumberInput=false] - using this param you allow validation for card number input on supported card types
      */
     setSupportedCardIcons(elements: string[], validateCardNumberInput?: boolean): void;
+    /**
+     * Current method can hide prevent the widget from showing the error messages
+     *
+     * @example
+     * widget.hideUiErrors('id');
+     */
+    hideUiErrors(): void;
     /**
      * Current method can change environment. By default environment = sandbox.
      * Also we can change domain alias for this environment. By default domain_alias = paydock.com
@@ -1164,7 +1213,7 @@ declare class MultiWidget {
      */
     setLanguage(code: any): void;
     getLink(): Link;
-    protected handleErrorEvent(err: IErrorEvent): void;
+    protected handleErrorEvent(event: EventTypes, error: IEventError, purpose: PURPOSE): void;
 }
 
 interface ITriggerData {
@@ -1660,6 +1709,7 @@ interface IEventData$1 {
     widget_id: string;
     data?: any;
     ref_id?: string;
+    error?: IEventError;
 }
 declare const EVENT$1: {
     readonly AFTER_LOAD: "afterLoad";
@@ -1694,13 +1744,6 @@ declare const EVENT$1: {
     readonly DISPATCH_ERROR: "dispatchError";
 };
 type EventTypes = typeof EVENT$1[keyof typeof EVENT$1];
-interface IErrorEvent {
-    event: EventTypes;
-    status?: number;
-    data: {
-        _message: string;
-    } & Record<string, any>;
-}
 interface Listener {
     event: string;
     listener: (event: any) => void;
@@ -2732,7 +2775,7 @@ interface GetConfigResponse {
 declare class ApiCheckoutInternal {
     protected api: ApiInternal;
     constructor(api: ApiInternal);
-    instructions(session_id: string): Observable<object>;
+    instructions(): Observable<object>;
     private getInstructionLink;
     callback(payload: Object): Promise<Object>;
     status(id: string): Promise<Object>;
@@ -3347,7 +3390,7 @@ declare class WalletButtons {
     private setupAuthTokensChangedCallback;
 }
 
-type Instruction = new (selector: string, formSelector: string, api: ApiInternal) => InstructionHandler & InstructionDestroyable & InstructionDecorated;
+type Instruction = new (selector: string, formSelector: string, api: ApiInternal, checkoutWidget: Checkout) => InstructionHandler & InstructionDestroyable & InstructionDecorated;
 interface InstructionHandleable {
     handle(payload: object, eventEmitter: EventEmitter): void;
 }
@@ -3361,7 +3404,8 @@ declare abstract class InstructionHandler implements InstructionHandleable, Inst
     selector: string;
     formSelector: string;
     api: ApiInternal;
-    constructor(selector: string, formSelector: string, api: ApiInternal);
+    protected checkoutWidget?: Checkout;
+    constructor(selector: string, formSelector: string, api: ApiInternal, checkoutWidget?: Checkout);
     instruction: string;
     abstract handle(context: object, eventEmitter?: any): void;
     abstract destroy(): void;
@@ -3379,9 +3423,6 @@ interface IntentTokenPayload {
     version: number;
     env_alias: string;
 }
-declare class InstructionDebugger {
-    constructor(selector: string, formSelector: string, version: number, instructionName: string, context: object, token?: string);
-}
 /**
  * Class CheckoutButton transform usual button into checkout
  *
@@ -3401,15 +3442,26 @@ declare class Checkout {
     protected container: Container;
     protected intentTokenPayload: IntentTokenPayload;
     protected api: ApiInternal;
+    protected checkoutApi: ApiCheckoutInternal;
     protected instructions: InstructionModule;
     protected currentInstruction: InstructionDestroyable & InstructionHandleable;
+    private timeoutTimer;
+    private requestInFlight;
+    private inTimeoutRange;
+    private checkoutFinished;
     constructor(formSelector: string, intentToken: string, debug?: boolean);
+    fetchInstruction(): void;
+    finaliseCheckout(): void;
+    private setupTimeoutTimer;
     private extractIntentTokenPayload;
     private ready;
     private initContractVersion;
-    private listenInstructions;
+    private isTimeoutInstruction;
+    private handleInstruction;
+    private handleTimeoutInstructions;
+    private getInstructionFromResponse;
+    private extractInstructionPayloadFromResponse;
     private setEnv;
-    private createWidgetStructure;
     /**
      * If the payment was successful, the function passed as parameter will be called.
      * Important: Do not perform thread blocking operations in callback such as window.alert() calls.
@@ -3440,8 +3492,12 @@ declare class Checkout {
      * });
      */
     onPaymentExpired(handler: (data: IEventData$1) => void): () => void;
+    createWidgetStructure(): void;
     private setStyles;
 }
+declare class InstructionDebugger {
+    constructor(selector: string, formSelector: string, version: number, instructionName: string, context: object, token?: string);
+}
 
 declare enum EVENT {
     UNAVAILABLE = "unavailable",
@@ -3721,6 +3777,7 @@ interface ApplePayWalletMeta extends BaseWalletMeta {
     supported_networks?: Array<'visa' | 'masterCard' | 'amex' | 'chinaUnionPay' | 'discover' | 'interac' | 'jcb' | 'privateLabel'>;
     required_billing_contact_fields?: Array<'email' | 'name' | 'phone' | 'postalAddress'>;
     required_shipping_contact_fields?: Array<'email' | 'phone'>;
+    apple_pay_capabilities?: Array<'credentials_available' | 'credentials_status_unknown' | 'credentials_unavailable'>;
     supported_countries?: string[];
     style?: {
         button_type?: ApplePayButtonType;
@@ -3772,6 +3829,7 @@ declare class ApplePayWalletButtonExpress extends BaseWalletButton<ApplePayWalle
     private onValidateMerchant;
     private getMerchantSession;
     private onPaymentAuthorized;
+    private formatCapabilities;
     private onCancelPayment;
 }
 

package/bundles/widget.umd.js.min.d.ts

@@ -1,4 +1,4 @@
-import { Observable, Subscriber } from 'rxjs';
+import { Observable } from 'rxjs';
 import { MicroAgent } from '@newrelic/browser-agent/loaders/micro-agent';
 
 declare class ApiCharge {
@@ -117,7 +117,6 @@ declare class ApiBase {
     protected env: Env;
     auth: string;
     authType: API_AUTH_TYPE;
-    private stoppedPooling;
     constructor(auth: string, authType?: API_AUTH_TYPE);
     /**
      * Current method can change environment. By default environment = sandbox.
@@ -129,9 +128,10 @@ declare class ApiBase {
      * @param {string} [alias] - Own domain alias
      */
     setEnv(env: string, alias?: string): ApiBase;
-    longPollingObservable<Req extends object, Res>(method: 'GET' | 'POST', url: string, requestBody: Req, sessionId: string, reconnectInterval?: number): Observable<Res>;
-    longPull(subscriber: Subscriber<any>, method: any, link: any, auth: any, requestBody: any, sessionId: any, reconnectInterval: any): void;
-    destroyLongPolling(): void;
+    requestObservable<Req extends object, Res>(method: 'GET' | 'POST', url: string, requestBody: Req): Observable<Res>;
+    private makeRequest;
+    private onRequestLoad;
+    private onRequestError;
     setAuthType(): API_AUTH_TYPE;
     getClient(method: Extract<HttpRequestMethod, 'GET' | 'POST'>, link: string): {
         config: XMLHttpRequest;
@@ -145,7 +145,7 @@ declare class ApiBase {
         text: string;
         status: number;
     }, cb: any, errorCb: any): any;
-    parserPromise<Res>({ text, status }: {
+    parserPromise<Res>({ text, status, }: {
         text: string;
         status: number;
     }): Promise<Res>;
@@ -159,15 +159,6 @@ declare class ApiBase {
     };
 }
 
-interface BrowserDetails {
-    name: string;
-    java_enabled: string;
-    language: string;
-    screen_height: string;
-    screen_width: string;
-    time_zone: string;
-    color_depth: string;
-}
 /**
  * Interface for browser details response.
  * @interface BrowserDetails
@@ -180,6 +171,15 @@ interface BrowserDetails {
  * @param {string} [time_zone]
  * @param {string} [color_depth]
  * */
+interface BrowserDetails {
+    name: string;
+    java_enabled: string;
+    language: string;
+    screen_height: string;
+    screen_width: string;
+    time_zone: string;
+    color_depth: string;
+}
 /**
  * Class Api include method for working with paydock api
  * @constructor
@@ -453,6 +453,7 @@ interface IParams extends IStyles$1, ITexts, ICommonParams {
     language?: string;
     vault_display_token?: string;
     sdk_origin?: boolean;
+    hide_ui_errors?: boolean;
 }
 interface ICountryPhoneMask {
     preferred_countries?: string[];
@@ -591,6 +592,7 @@ declare enum WALLET_TYPE {
 }
 interface ApplePayStyles {
     button_type?: 'add-money' | 'book' | 'buy' | 'check-out' | 'continue' | 'contribute' | 'donate' | 'order' | 'pay' | 'plain' | 'reload' | 'rent' | 'set-up' | 'subscribe' | 'support' | 'tip' | 'top-up';
+    button_style?: 'black' | 'white' | 'white-outline';
 }
 interface GooglePayStyles {
     button_type?: 'book' | 'buy' | 'checkout' | 'donate' | 'order' | 'pay' | 'plain' | 'subscribe';
@@ -631,6 +633,7 @@ interface IWalletMeta {
     style?: WalletStyles;
     wallets?: WALLET_TYPE[];
     client_id?: string;
+    apple_pay_capabilities?: Array<'credentials_available' | 'credentials_status_unknown' | 'credentials_unavailable'>;
 }
 
 declare class Link {
@@ -940,6 +943,45 @@ interface IElementStyleTitleDescription {
     margin?: string;
 }
 
+declare const ERROR_CATEGORY: {
+    readonly CONFIGURATION: "configuration";
+    readonly IDENTITY: "identity_access_management";
+    readonly INTERNAL: "internal";
+    readonly PROCESS: "process";
+    readonly RESOURCE: "resource";
+    readonly VALIDATION: "validation";
+};
+type ErrorCategory = (typeof ERROR_CATEGORY)[keyof typeof ERROR_CATEGORY];
+declare const ERROR_CAUSE: {
+    readonly ABORTED: "aborted";
+    readonly ACCESS_FORBIDDEN: "access_forbidden";
+    readonly ALREADY_EXISTS: "already_exists";
+    readonly CANCELED: "canceled";
+    readonly INVALID_CONFIGURATION: "invalid_configuration";
+    readonly INVALID_INPUT: "invalid_input";
+    readonly NOT_FOUND: "not_found";
+    readonly NOT_IMPLEMENTED: "not_implemented";
+    readonly RATE_LIMITED: "rate_limited";
+    readonly SERVER_BUSY: "server_busy";
+    readonly SERVICE_UNREACHABLE: "service_unreachable";
+    readonly UNAUTHORIZED: "unauthorized";
+    readonly UNKNOWN: "unknown_error";
+    readonly UNPROCESSABLE_ENTITY: "unprocessable_entity";
+};
+type ErrorCause = (typeof ERROR_CAUSE)[keyof typeof ERROR_CAUSE];
+interface ErrorDetails {
+    cause: ErrorCause;
+    contextId: string;
+    message: string;
+    timestamp: string;
+}
+interface IEventError {
+    cause: ErrorCause;
+    category: ErrorCategory;
+    retryable: boolean;
+    details: ErrorDetails;
+}
+
 /**
  *
  * Class MultiWidget include method for for creating iframe url
@@ -1133,6 +1175,13 @@ declare class MultiWidget {
      * @param {boolean} validateCardNumberInput - [validateCardNumberInput=false] - using this param you allow validation for card number input on supported card types
      */
     setSupportedCardIcons(elements: string[], validateCardNumberInput?: boolean): void;
+    /**
+     * Current method can hide prevent the widget from showing the error messages
+     *
+     * @example
+     * widget.hideUiErrors('id');
+     */
+    hideUiErrors(): void;
     /**
      * Current method can change environment. By default environment = sandbox.
      * Also we can change domain alias for this environment. By default domain_alias = paydock.com
@@ -1164,7 +1213,7 @@ declare class MultiWidget {
      */
     setLanguage(code: any): void;
     getLink(): Link;
-    protected handleErrorEvent(err: IErrorEvent): void;
+    protected handleErrorEvent(event: EventTypes, error: IEventError, purpose: PURPOSE): void;
 }
 
 interface ITriggerData {
@@ -1660,6 +1709,7 @@ interface IEventData$1 {
     widget_id: string;
     data?: any;
     ref_id?: string;
+    error?: IEventError;
 }
 declare const EVENT$1: {
     readonly AFTER_LOAD: "afterLoad";
@@ -1694,13 +1744,6 @@ declare const EVENT$1: {
     readonly DISPATCH_ERROR: "dispatchError";
 };
 type EventTypes = typeof EVENT$1[keyof typeof EVENT$1];
-interface IErrorEvent {
-    event: EventTypes;
-    status?: number;
-    data: {
-        _message: string;
-    } & Record<string, any>;
-}
 interface Listener {
     event: string;
     listener: (event: any) => void;
@@ -2732,7 +2775,7 @@ interface GetConfigResponse {
 declare class ApiCheckoutInternal {
     protected api: ApiInternal;
     constructor(api: ApiInternal);
-    instructions(session_id: string): Observable<object>;
+    instructions(): Observable<object>;
     private getInstructionLink;
     callback(payload: Object): Promise<Object>;
     status(id: string): Promise<Object>;
@@ -3347,7 +3390,7 @@ declare class WalletButtons {
     private setupAuthTokensChangedCallback;
 }
 
-type Instruction = new (selector: string, formSelector: string, api: ApiInternal) => InstructionHandler & InstructionDestroyable & InstructionDecorated;
+type Instruction = new (selector: string, formSelector: string, api: ApiInternal, checkoutWidget: Checkout) => InstructionHandler & InstructionDestroyable & InstructionDecorated;
 interface InstructionHandleable {
     handle(payload: object, eventEmitter: EventEmitter): void;
 }
@@ -3361,7 +3404,8 @@ declare abstract class InstructionHandler implements InstructionHandleable, Inst
     selector: string;
     formSelector: string;
     api: ApiInternal;
-    constructor(selector: string, formSelector: string, api: ApiInternal);
+    protected checkoutWidget?: Checkout;
+    constructor(selector: string, formSelector: string, api: ApiInternal, checkoutWidget?: Checkout);
     instruction: string;
     abstract handle(context: object, eventEmitter?: any): void;
     abstract destroy(): void;
@@ -3379,9 +3423,6 @@ interface IntentTokenPayload {
     version: number;
     env_alias: string;
 }
-declare class InstructionDebugger {
-    constructor(selector: string, formSelector: string, version: number, instructionName: string, context: object, token?: string);
-}
 /**
  * Class CheckoutButton transform usual button into checkout
  *
@@ -3401,15 +3442,26 @@ declare class Checkout {
     protected container: Container;
     protected intentTokenPayload: IntentTokenPayload;
     protected api: ApiInternal;
+    protected checkoutApi: ApiCheckoutInternal;
     protected instructions: InstructionModule;
     protected currentInstruction: InstructionDestroyable & InstructionHandleable;
+    private timeoutTimer;
+    private requestInFlight;
+    private inTimeoutRange;
+    private checkoutFinished;
     constructor(formSelector: string, intentToken: string, debug?: boolean);
+    fetchInstruction(): void;
+    finaliseCheckout(): void;
+    private setupTimeoutTimer;
     private extractIntentTokenPayload;
     private ready;
     private initContractVersion;
-    private listenInstructions;
+    private isTimeoutInstruction;
+    private handleInstruction;
+    private handleTimeoutInstructions;
+    private getInstructionFromResponse;
+    private extractInstructionPayloadFromResponse;
     private setEnv;
-    private createWidgetStructure;
     /**
      * If the payment was successful, the function passed as parameter will be called.
      * Important: Do not perform thread blocking operations in callback such as window.alert() calls.
@@ -3440,8 +3492,12 @@ declare class Checkout {
      * });
      */
     onPaymentExpired(handler: (data: IEventData$1) => void): () => void;
+    createWidgetStructure(): void;
     private setStyles;
 }
+declare class InstructionDebugger {
+    constructor(selector: string, formSelector: string, version: number, instructionName: string, context: object, token?: string);
+}
 
 declare enum EVENT {
     UNAVAILABLE = "unavailable",
@@ -3721,6 +3777,7 @@ interface ApplePayWalletMeta extends BaseWalletMeta {
     supported_networks?: Array<'visa' | 'masterCard' | 'amex' | 'chinaUnionPay' | 'discover' | 'interac' | 'jcb' | 'privateLabel'>;
     required_billing_contact_fields?: Array<'email' | 'name' | 'phone' | 'postalAddress'>;
     required_shipping_contact_fields?: Array<'email' | 'phone'>;
+    apple_pay_capabilities?: Array<'credentials_available' | 'credentials_status_unknown' | 'credentials_unavailable'>;
     supported_countries?: string[];
     style?: {
         button_type?: ApplePayButtonType;
@@ -3772,6 +3829,7 @@ declare class ApplePayWalletButtonExpress extends BaseWalletButton<ApplePayWalle
     private onValidateMerchant;
     private getMerchantSession;
     private onPaymentAuthorized;
+    private formatCapabilities;
     private onCancelPayment;
 }