@globalpayments/js 1.8.3 → 1.8.9

package/types/ui/iframe-field/action-accumulate-data-and-tokenize.d.ts

@@ -1,3 +1,9 @@
 import { IDictionary } from "../../internal/lib/util";
 declare const _default: (id: string, type: string, data: IDictionary) => void;
+/**
+ * Once data is accumulated from the other hosted fields,
+ * the `card-number` / `account-number` hosted field initiates
+ * the tokenization request with the configured gateway.
+ *
+ */
 export default _default;

package/types/ui/iframe-field/action-card-track-button-click.d.ts

@@ -1,2 +1,8 @@
 declare const _default: (id: string) => void;
+/**
+ * Once initiated, the hosted field accepts track data via a
+ * human input device (HID) into a hidden text field
+ *
+ * @param id ID of the hosted field
+ */
 export default _default;

package/types/ui/iframe-field/action-get-cvv.d.ts

@@ -1,2 +1,9 @@
 declare const _default: (id: string, type: string) => void;
+/**
+ * Gets the value of the `card-cvv` hosted field
+ *
+ * @param id ID of the hosted field
+ * @param type Field type of the hosted field
+ * @returns
+ */
 export default _default;

package/types/ui/iframe-field/action-payment-request-complete.d.ts

@@ -1,3 +1,13 @@
 import { IDictionary } from "../../internal/lib/util";
 declare const _default: (id: string, data: IDictionary) => Promise<void>;
+/**
+ * Completes a payment via the PaymentRequest API
+ * after the integrator performs the server-side
+ * authorization request. This is triggered in the parent
+ * window, but the PaymentRequest functionality and
+ * data only exists within the hoted field.
+ *
+ * @param id ID of the hosted field
+ * @param data Payment status from the integrator
+ */
 export default _default;

package/types/ui/iframe-field/action-payment-request-start.d.ts

@@ -1,3 +1,14 @@
 import { IDictionary } from "../../internal/lib/util";
 declare const _default: (id: string, data: IDictionary) => Promise<void>;
+/**
+ * Initiates a payment card via the PaymentRequest API
+ * to leverage card data stored in a cardholder's
+ * browser, tokenizing it via the configured gateway
+ * implementation. This is triggered in the parent
+ * window, but the PaymentRequest functionality and
+ * data only exists within the hosted field.
+ *
+ * @param id ID of the hosted field
+ * @param data PaymentRequest details
+ */
 export default _default;

package/types/ui/iframe-field/action-request-data.d.ts

@@ -1,3 +1,12 @@
 import { IDictionary } from "../../internal/lib/util";
 declare const _default: (id: string, type: string, data: IDictionary) => void;
+/**
+ * Causes the hosted field to send its data to the `card-number`
+ * field for tokenization when triggered by the
+ * `ui:iframe-field:request-data` event.
+ *
+ * @param id ID of the hosted field
+ * @param type Field type of the hosted field
+ * @param data Information about the recipient hosted field
+ */
 export default _default;

package/types/ui/iframe-field/action-set-card-type.d.ts

@@ -1,2 +1,11 @@
 declare const _default: (cardType?: string | undefined) => void;
+/**
+ * Sets the class list of a hosted field to include
+ * the card type inferred from the `card-number` field
+ * emitting the `ui:iframe-field:card-type` through
+ * the parent window.
+ *
+ * @param cardType The inferred card type
+ * @returns
+ */
 export default _default;

package/types/ui/iframe-field/action-set-focus.d.ts

@@ -1,2 +1,5 @@
 declare const _default: () => void;
+/**
+ * Sets input focus on the hosted field
+ */
 export default _default;

package/types/ui/iframe-field/action-set-label.d.ts

@@ -1,2 +1,7 @@
 declare const _default: (text: string) => void;
+/**
+ * Sets the label of a hosted field
+ *
+ * @param text The desired input label
+ */
 export default _default;

package/types/ui/iframe-field/action-set-placeholder.d.ts

@@ -1,2 +1,7 @@
 declare const _default: (placeholder: string) => void;
+/**
+ * Sets the placeholder text of a hosted field
+ *
+ * @param placeholder The desired palceholder text
+ */
 export default _default;

package/types/ui/iframe-field/action-set-text.d.ts

@@ -1,2 +1,7 @@
 declare const _default: (text: string) => void;
+/**
+ * Sets the text content of a hosted field
+ *
+ * @param text The desired text value
+ */
 export default _default;

package/types/ui/iframe-field/action-set-type-cvv.d.ts

@@ -0,0 +1,10 @@
+declare const _default: (maxlength: string) => void;
+/**
+ * Change values of maxlength and placeholder attributes of the cvv input
+ * depending on card type
+ *
+ * @param maxlength The maximum number of characters desired
+ * @param placeholder Placeholder for show
+ * @param id cvv input id
+ */
+export default _default;

package/types/ui/iframe-field/action-set-value.d.ts

@@ -1,2 +1,7 @@
 declare const _default: (text: string) => void;
+/**
+ * Sets the value of a hosted field
+ *
+ * @param text The desired input value
+ */
 export default _default;

package/types/ui/iframe-field/index.d.ts

@@ -12,8 +12,28 @@ export interface IUIFormField {
     value?: string;
 }
 export declare const fieldTypeAutocompleteMap: IDictionary;
+/**
+ * Represents logic surrounding individual hosted fields.
+ *
+ * Static methods are ran within the iframe / child window.
+ *
+ * Instance methods are ran within the parent window.
+ */
 export declare class IframeField extends EventEmitter {
+    /**
+     * Sets up the hosted field's iframe for further
+     * processing, and registers the hosted field
+     * with the parent window.
+     *
+     * @param type Field type of the hosted field
+     */
     static register(type: string): void;
+    /**
+     * Sets the hosted field's `lang` attribute on the `html` element
+     * with the globally configured value.
+     *
+     * @param lang The configured language code
+     */
     static setHtmlLang(lang: string): void;
     /**
      * Creates the inner field within the iframe window and sets
@@ -49,11 +69,17 @@ export declare class IframeField extends EventEmitter {
      * Sets the iframe window's postMessage handler in order to
      * react to parent/sibling events.
      *
-     * @param id Field ID
-     * @param type Field type
+     * @param id ID of the hosted field
+     * @param type Field type of the hosted field
      * @param targetOrigin Parent window's origin
      */
     static addMessageListener(id: string, type: string, targetOrigin: string): void;
+    /**
+     * Triggers a resize of the hosted field's iframe element
+     * within the parent window.
+     *
+     * @param id ID of the hosted field
+     */
     static triggerResize(id: string): void;
     container: Element | null;
     frame: HTMLIFrameElement;
@@ -61,14 +87,65 @@ export declare class IframeField extends EventEmitter {
     targetNode: any;
     type: "button" | "input";
     url: string;
+    /**
+     * Instantiates a new IframeField object for a hosted field
+     *
+     * @param type Field type of the hosted field
+     * @param opts Options for creating the iframe / hosted field
+     * @param src URL for the hosted field's iframe
+     */
     constructor(type: string, opts: IUIFormField, src: string);
+    /**
+     * Appends additional CSS rules to the hosted field
+     *
+     * @param json New CSS rules
+     */
     addStylesheet(json: IDictionary): void;
+    /**
+     * Gets the CVV value from the `card-cvv` hosted field.
+     *
+     * Used by gateway implementations that do not store the CVV
+     * with the token value:
+     *
+     * - TransIT (tsep)
+     * - Heartland Bill pay (billpay)
+     *
+     * @returns A promise that resolves with the CVV value
+     */
     getCvv(): Promise<unknown>;
+    /**
+     * Sets input focus on the hosted field
+     */
     setFocus(): void;
+    /**
+     * Sets the placeholder text of a hosted field
+     *
+     * @param placeholder The desired palceholder text
+     */
     setPlaceholder(placeholder: string): void;
+    /**
+     * Sets the text content of a hosted field
+     *
+     * @param text The desired text value
+     */
     setText(text: string): void;
+    /**
+     * Sets the value of a hosted field
+     *
+     * @param value The desired input value
+     */
     setValue(value: string): void;
+    /**
+     * Sets the label of a hosted field
+     *
+     * @param label The desired input label
+     */
     setLabel(label: string): void;
+    /**
+     * Sets the title of a hosted field
+     *
+     * @param title The desired title
+     */
     setTitle(title: string): void;
     private makeFrame;
 }

package/types/ui/index.d.ts

@@ -1,3 +1,10 @@
 import UIForm from "./form";
 export * from "./iframe-field";
+/**
+ * Allows integrators to custom payment data entry forms for credit
+ * card, eCheck / ACH, or gift and loyalty cards.
+ *
+ * @param options Form options.
+ * @returns
+ */
 export declare function form(options: any): UIForm;

package/dist/field.html

@@ -1,45 +0,0 @@
-<!doctype html>
-<html>
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-    <meta name="viewport" content="width=device-width,initial-scale=1.0">
-    <title>Secure Payment Field</title>
-    <style type="text/css">
-      html, #secure-payment-field-body,
-      #secure-payment-field-wrapper {
-        display: flex;
-        margin: 0;
-        padding: 0;
-        width: 100%;
-        flex: 1 1 auto;
-      }
-      #secure-payment-field {
-        margin: 0;
-        width: 100%;
-        flex: 1 1 auto;
-      }
-      .offscreen, .autocomplete-hidden {
-        height: 1px;
-        width: 1px;
-        position: absolute;
-      }
-      .offscreen {
-        top: -10em;
-      }
-      .autocomplete-hidden {
-        opacity: 0;
-        top: -1px;
-      }
-    </style>
-  </head>
-  <body id="secure-payment-field-body">
-    <main id="secure-payment-field-wrapper">
-      <div class="extra-div-1"></div>
-      <div class="extra-div-2"></div>
-    </main>
-    <script type="text/javascript" src="globalpayments.js"></script>
-    <script>
-      GlobalPayments.ui.IframeField.register(window.name);
-    </script>
-  </body>
-</html>