@pay-com/js 1.1.0

package/lib/index.d.ts

@@ -0,0 +1,393 @@
+import EventEmitter from 'events';
+import * as CSS from 'csstype';
+
+interface PayComScriptQueryParameters {
+  identifier: string;
+  sandbox?: boolean;
+  debug?: boolean;
+}
+
+interface PayComScriptOptions extends PayComScriptQueryParameters {
+  sdkBaseURL?: string;
+}
+
+type PayCustomPseudos = ':error'
+
+type PayCssConfig = Partial<
+  Record<CSS.SimplePseudos | PayCustomPseudos, CSS.Properties>
+> &
+  CSS.Properties
+interface CheckoutStyles {
+  base?: PayCssConfig
+  number?: PayCssConfig
+  cvv?: PayCssConfig
+  expiry?: PayCssConfig
+  name?: PayCssConfig
+  checkboxes?: {
+    buttonBackground?: string
+    labelColor?: string
+  }
+  submit?: PayCssConfig
+}
+
+interface CheckoutFieldConfig {
+  label?: string
+  labelStyle?: PayCssConfig
+  errorMessageStyle?: PayCssConfig
+  inputSize?: 'small' | 'medium' | 'large'
+  placeholder?: string
+  style?: PayCssConfig
+}
+
+interface CheckoutFormConfig {
+  base?: {
+    inputSpacing?: string
+    formTitle?: string
+    titleStyles?: PayCssConfig
+    style?: PayCssConfig
+  }
+  number?: CheckoutFieldConfig
+  cvv?: CheckoutFieldConfig
+  expiry?: CheckoutFieldConfig
+  name?: CheckoutFieldConfig
+}
+
+interface CheckoutToggles {
+  /**
+   * If false, the form will render without a submission button.
+   * @default true
+   */
+  submitButton?: boolean
+  /**
+   * If false, the form will render without a title.
+   * @default true
+   */
+  withTitle?: boolean
+  /**
+   * If false, the form will render without a card holder name.
+   * @default true
+   */
+  withCardHolderName?: boolean
+  /**
+   * If false, the wrapping element of the form will be a div instead of a form.
+   * Good for when the form is embedded inside a larger form.
+   * @default true
+   */
+  formWrapper?: boolean
+  /**
+   * If true, will display save for future use checkbox under the form.
+   * @default false
+   */
+  saveSourceForFutureUseCheckbox?: boolean
+  /**
+   * If true, will display our accept T&A checkbox under the form.
+   * @default false
+   */
+  acceptTermsAndConditionsCheckbox?: boolean
+  /**
+   * If true, will render native browser checkboxes instead of ours.
+   * @default false
+   */
+  nativeCheckboxes?: boolean
+}
+
+interface PaypalOpts {
+  container: string
+  onClickValidation: () => Promise<boolean>
+}
+
+interface RenderOpts {
+  container: string
+  button?: boolean
+  toggles?: CheckoutToggles
+  formConfig?: CheckoutFormConfig
+  localizations?: {
+    [language: string]: LanguageLocalizationOverride
+  }
+  style?: CheckoutStyles
+}
+
+interface UniversalToggles {
+  /**
+   * If false, the form will render without a submission button.
+   * @default true
+   */
+  submitButton?: boolean
+
+  /**
+   * If true, displays the card bin as well as last 4.
+   * @default false
+   */
+  savedCardsBins?: boolean | 2 | 3 | 4 | 5 | 6
+
+  /**
+   * If true, the CVV in saved payment method will be inline
+   * @default false
+   */
+  savedPaymentMethodInlineCvv?: boolean
+
+  /**
+   * A title to display above the Universal form.
+   */
+  title?: string
+}
+
+type LanguageLocalizationOverride = {
+  cardForm?: {
+    nameOnCard?: string
+    cardNumber?: string
+    cvv?: string
+    expiryDate?: string
+    title?: string
+    checkboxes?: {
+      saveCardForFutureUse?: string
+      agreeToTermsAndConditions?: string
+    }
+    submit?: {
+      pay?: string
+      save_card?: string
+      DEPOSIT?: string
+    }
+  }
+  existingSource?: {
+    delete?: string
+  }
+  dividers?: {
+    myPaymentMethods?: string
+    otherPaymentMethods?: string
+    showOtherWaysToPay?: string
+    payWithCard?: string
+    payWith?: string
+    savedPaymentMethods?: string
+  }
+}
+
+interface DividerStyle {
+  text: PayCssConfig
+  divider: {
+    color: PayCssConfig['color']
+    height: PayCssConfig['height']
+  }
+}
+
+interface UniversalOpts {
+  container: string
+  cardForm?: Omit<RenderOpts, 'container' | 'style'>
+  toggles?: UniversalToggles
+  apmsOnClickValidation?: () => Promise<boolean>
+  localizations?: {
+    [language: string]: LanguageLocalizationOverride
+  }
+  style?: {
+    cardForm?: CheckoutStyles
+    base?: PayCssConfig
+    submit?: PayCssConfig
+    savedPaymentMethods?: PayCssConfig
+    expressCheckout?: PayCssConfig
+    apmButtons?: PayCssConfig
+    dividers?: {
+      showOtherWaysToPay?: DividerStyle
+      payWith?: DividerStyle
+      savedPaymentMethods?: DividerStyle
+    }
+    existingSource?: {
+      deleteText?: PayCssConfig
+      cvv?: {
+        style?: PayCssConfig
+        labelStyle?: PayCssConfig
+        errorMessageStyle?: PayCssConfig
+      }
+      icons?: {
+        delete?: PayCssConfig
+        confirmDeletion?: PayCssConfig
+        cancelDeletion?: PayCssConfig
+      }
+      base?: PayCssConfig & { ':selected'?: PayCssConfig }
+      radioButton?: {
+        color?: PayCssConfig['color']
+        ':selected'?: {
+          color?: PayCssConfig['color']
+        }
+      }
+    }
+  }
+  paymentMethods?: Array<string>
+}
+
+interface SubmitOpts {
+  token?: string
+}
+
+type FailureError = {
+  message: string
+  data?: Record<string, unknown>
+}
+
+interface CheckoutOpts {
+  /**
+   * @deprecated Got replaced by clientSecret
+   */
+  token?: string | (() => Promise<string>)
+  clientSecret?: string | (() => Promise<string>)
+  currency?: string
+  onSuccess?: (payment: Record<string, unknown>) => void
+  onFailure?: (error: FailureError) => void
+  mode?: modeOpts
+  throwOnSubmitFailure?: boolean
+  paymentFailurePopupConfig?: {
+    sessionExpiredPopupText?: string
+    maxAttemptsReachedPopupText?: string
+    style?: PayCssConfig
+  }
+  toggles?: {
+    displayFailureMessages: boolean
+    displayEndOfSessionFailureMessages?: boolean
+    disableAdditionalFields?: boolean
+  }
+}
+
+interface PayComOpts {
+  identifier?: string
+  riskIdentifier?: string
+  sandbox?: boolean
+  debug?: boolean
+}
+
+enum EVENT_TYPES {
+  THREE_DS_INIT = 'three_ds_init',
+  THREE_DS_CHALLENGE = 'three_ds_challenge',
+  THREE_DS_DONE = 'three_ds_done',
+  CONTENT_READY = 'content_ready',
+  PAYMENT_SUCCESS = 'payment_success',
+  SETUP_SUCCESS = 'setup_success',
+  PAYMENT_FAILURE = 'payment_failure',
+  SETUP_FAILURE = 'setup_failure',
+  PAYMENT_PROCESSING = 'payment_processing',
+  SETUP_PROCESSING = 'setup_processing',
+  SESSION_EXPIRED = 'session_expired',
+  MAX_ATTEMPTS_REACHED = 'max_attempts_reached'
+}
+
+type ListenerFn = (
+  eventName: EVENT_TYPES,
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  callback: (...params: any[]) => void
+) => EventEmitter
+
+enum ELEMENT_TYPES {
+  CHECKOUT = 'checkout',
+  UNIVERSAL = 'universal',
+  PAYPAL = 'paypal'
+}
+
+type FormattedErrors = {
+  valid: boolean
+  invalidFields: string[]
+}
+type RenderFn = (renderOpts: RenderOpts) => Promise<void>
+type PaypalFn = (paypalOpts: PaypalOpts) => Promise<void>
+type UniversalFn = (universalOpts: UniversalOpts) => Promise<void>
+type SubmitFn = (
+  opts?: SubmitOpts,
+  frameType?: ELEMENT_TYPES
+) => Promise<void | Record<string, unknown>>
+
+interface UpdateOpts {
+  amount: number
+  currency?: string
+}
+type UpdateFn = (updateOpts: UpdateOpts) => Promise<void>
+
+type ValidateFn = (frameType?: ELEMENT_TYPES) => Promise<FormattedErrors | void>
+type ResetFn = (frameType?: ELEMENT_TYPES) => Promise<void>
+
+type UpdateTransactionDetailsOpts = {
+  consumer?: {
+    firstName?: string
+    lastName?: string
+    email?: string
+    phone?: string
+  }
+  billing?: {
+    addressLine: string
+    addressLine2?: string
+    zip: string
+    city: string
+    state?: string
+    countryAlpha2: string
+  }
+  shipping?: {
+    addressLine: string
+    addressLine2?: string
+    zip: string
+    city: string
+    state?: string
+    countryAlpha2: string
+  }
+}
+
+type PayOpts = {
+  source: string
+}
+
+type PayFn = (Opts: PayOpts) => Promise<unknown>
+
+type UpdateTransactionDetailsFn = (
+  config: UpdateTransactionDetailsOpts
+) => Promise<unknown>
+
+type CheckoutObject = {
+  on: ListenerFn
+  once: ListenerFn
+  removeListener: ListenerFn
+  EVENT_TYPES: typeof EVENT_TYPES
+  render: RenderFn
+  paypal: PaypalFn
+  universal: UniversalFn
+  update: UpdateFn
+  updateTransactionDetails: UpdateTransactionDetailsFn
+  submit: SubmitFn
+  validate: ValidateFn
+  reset: ResetFn
+  pay: PayFn
+}
+
+type CheckoutFunction = (opts: CheckoutOpts) => CheckoutObject
+
+type PayComFunction = (opts: PayComOpts) => Promise<{
+  checkout: CheckoutFunction
+}>
+
+interface PayComNamespace {
+  com: PayComFunction
+  riskIdentifier: string
+}
+
+declare module '@pay-com/js' {
+  export function loadScript(
+    options: PayComScriptOptions,
+    PromisePonyfill?: PromiseConstructor
+  ): Promise<PayComNamespace | null>
+
+  export function loadCustomScript(options: {
+    url: string
+    attributes?: Record<string, string>
+    PromisePonyfill?: PromiseConstructor
+  }): Promise<void>
+
+  export const version: string
+}
+
+declare global {
+  interface Window {
+    Pay?: PayComNamespace
+  }
+}
+
+declare const _default: {
+    com: (options: PayComScriptOptions, PromisePonyfill?: PromiseConstructor) => Promise<{
+        checkout: CheckoutFunction;
+    }>;
+};
+
+export { CheckoutFunction, CheckoutObject, CheckoutToggles, EVENT_TYPES, ListenerFn, PayComFunction, PayComNamespace, PaypalOpts, RenderOpts, SubmitOpts, UniversalOpts, UpdateTransactionDetailsOpts, _default as default };

package/lib/index.esm.js

@@ -0,0 +1 @@
+function e(e,t,n,r){return new(n||(n=Promise))((function(o,i){function u(e){try{a(r.next(e))}catch(e){i(e)}}function c(e){try{a(r.throw(e))}catch(e){i(e)}}function a(e){var t;e.done?o(e.value):(t=e.value,t instanceof n?t:new n((function(e){e(t)}))).then(u,c)}a((r=r.apply(e,t||[])).next())}))}function t(e,t){var n,r,o,i,u={label:0,sent:function(){if(1&o[0])throw o[1];return o[1]},trys:[],ops:[]};return i={next:c(0),throw:c(1),return:c(2)},"function"==typeof Symbol&&(i[Symbol.iterator]=function(){return this}),i;function c(c){return function(a){return function(c){if(n)throw new TypeError("Generator is already executing.");for(;i&&(i=0,c[0]&&(u=0)),u;)try{if(n=1,r&&(o=2&c[0]?r.return:c[0]?r.throw||((o=r.return)&&o.call(r),0):r.next)&&!(o=o.call(r,c[1])).done)return o;switch(r=0,o&&(c=[2&c[0],o.value]),c[0]){case 0:case 1:o=c;break;case 4:return u.label++,{value:c[1],done:!1};case 5:u.label++,r=c[1],c=[0];continue;case 7:c=u.ops.pop(),u.trys.pop();continue;default:if(!(o=u.trys,(o=o.length>0&&o[o.length-1])||6!==c[0]&&2!==c[0])){u=0;continue}if(3===c[0]&&(!o||c[1]>o[0]&&c[1]<o[3])){u.label=c[1];break}if(6===c[0]&&u.label<o[1]){u.label=o[1],o=c;break}if(o&&u.label<o[2]){u.label=o[2],u.ops.push(c);break}o[2]&&u.ops.pop(),u.trys.pop();continue}c=t.call(e,u)}catch(e){c=[6,e],r=0}finally{n=o=0}if(5&c[0])throw c[1];return{value:c[0]?c[1]:void 0,done:!0}}([c,a])}}}function n(e,t){void 0===t&&(t={});var n=document.createElement("script");return n.src=e,Object.keys(t).forEach((function(e){n.setAttribute(e,t[e]),"data-csp-nonce"===e&&n.setAttribute("nonce",t["data-csp-nonce"])})),n}function r(e,t){if(i(e,t),"undefined"==typeof window)return t.resolve(null);var r=e.sdkBaseURL,u="",c=window.location.hostname;u=r||(["localhost","dev","staging"].some((function(e){return window.location.hostname.includes(e)}))?"https://js.dev.pay.com/v1.js":c.includes(".sandbox.")?"https://js.sandbox.pay.com/v1.js":"https://js.pay.com/v1.js");var a="Pay",s=o(a);return function(e,t){var r=document.querySelector('script[src="'.concat(e,'"]'));if(null===r)return null;var o=n(e,t),i=Object.assign({},r.dataset);if(delete i.uidAuto,Object.keys(i).length!==Object.keys(o.dataset).length)return null;var u=!0;return Object.keys(i).forEach((function(e){i[e]!==o.dataset[e]&&(u=!1)})),u?r:null}(u)&&s?t.resolve(s):function(e,t){i(e,t);var r=e.url,o=e.attributes;if("string"!=typeof r||0===r.length)throw new Error("Invalid url.");if(void 0!==o&&"object"!=typeof o)throw new Error("Expected attributes to be an object.");return new t((function(e,t){return"undefined"==typeof window?e():function(e){var t=e.url,r=e.attributes,o=e.onSuccess,i=e.onError,u=n(t,r);u.onerror=i,u.onload=o,document.head.insertBefore(u,document.head.firstElementChild)}({url:r,attributes:o,onSuccess:function(){return e()},onError:function(){return t(new Error('The script "'.concat(r,'" failed to load.')))}})}))}({url:u},t).then((function(){var e=o(a);if(e)return e;throw new Error("The window.".concat(a," global variable is not available."))}))}function o(e){return window[e]}function i(e,t){if("object"!=typeof e||null===e)throw new Error("Expected an options object.");if(void 0!==t&&"function"!=typeof t)throw new Error("Expected PromisePonyfill to be a function.")}"function"==typeof SuppressedError&&SuppressedError;var u={com:function(n,o){return void 0===o&&(o=function(){if("undefined"==typeof Promise)throw new Error("Promise is undefined. To resolve the issue, use a Promise polyfill.");return Promise}()),e(void 0,void 0,void 0,(function(){var e;return t(this,(function(t){switch(t.label){case 0:return[4,r(n,o)];case 1:if(!(e=t.sent()))throw new Error("Wrong script URL provided");return[2,e.com(n)]}}))}))}};export{u as default};

package/lib/index.js

@@ -0,0 +1 @@
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):(e="undefined"!=typeof globalThis?globalThis:e||self).Pay=t()}(this,(function(){"use strict";function e(e,t,n,r){return new(n||(n=Promise))((function(o,i){function u(e){try{a(r.next(e))}catch(e){i(e)}}function c(e){try{a(r.throw(e))}catch(e){i(e)}}function a(e){var t;e.done?o(e.value):(t=e.value,t instanceof n?t:new n((function(e){e(t)}))).then(u,c)}a((r=r.apply(e,t||[])).next())}))}function t(e,t){var n,r,o,i,u={label:0,sent:function(){if(1&o[0])throw o[1];return o[1]},trys:[],ops:[]};return i={next:c(0),throw:c(1),return:c(2)},"function"==typeof Symbol&&(i[Symbol.iterator]=function(){return this}),i;function c(c){return function(a){return function(c){if(n)throw new TypeError("Generator is already executing.");for(;i&&(i=0,c[0]&&(u=0)),u;)try{if(n=1,r&&(o=2&c[0]?r.return:c[0]?r.throw||((o=r.return)&&o.call(r),0):r.next)&&!(o=o.call(r,c[1])).done)return o;switch(r=0,o&&(c=[2&c[0],o.value]),c[0]){case 0:case 1:o=c;break;case 4:return u.label++,{value:c[1],done:!1};case 5:u.label++,r=c[1],c=[0];continue;case 7:c=u.ops.pop(),u.trys.pop();continue;default:if(!(o=u.trys,(o=o.length>0&&o[o.length-1])||6!==c[0]&&2!==c[0])){u=0;continue}if(3===c[0]&&(!o||c[1]>o[0]&&c[1]<o[3])){u.label=c[1];break}if(6===c[0]&&u.label<o[1]){u.label=o[1],o=c;break}if(o&&u.label<o[2]){u.label=o[2],u.ops.push(c);break}o[2]&&u.ops.pop(),u.trys.pop();continue}c=t.call(e,u)}catch(e){c=[6,e],r=0}finally{n=o=0}if(5&c[0])throw c[1];return{value:c[0]?c[1]:void 0,done:!0}}([c,a])}}}function n(e,t){void 0===t&&(t={});var n=document.createElement("script");return n.src=e,Object.keys(t).forEach((function(e){n.setAttribute(e,t[e]),"data-csp-nonce"===e&&n.setAttribute("nonce",t["data-csp-nonce"])})),n}function r(e,t){if(i(e,t),"undefined"==typeof window)return t.resolve(null);var r=e.sdkBaseURL,u="",c=window.location.hostname;u=r||(["localhost","dev","staging"].some((function(e){return window.location.hostname.includes(e)}))?"https://js.dev.pay.com/v1.js":c.includes(".sandbox.")?"https://js.sandbox.pay.com/v1.js":"https://js.pay.com/v1.js");var a="Pay",s=o(a);return function(e,t){var r=document.querySelector('script[src="'.concat(e,'"]'));if(null===r)return null;var o=n(e,t),i=Object.assign({},r.dataset);if(delete i.uidAuto,Object.keys(i).length!==Object.keys(o.dataset).length)return null;var u=!0;return Object.keys(i).forEach((function(e){i[e]!==o.dataset[e]&&(u=!1)})),u?r:null}(u)&&s?t.resolve(s):function(e,t){i(e,t);var r=e.url,o=e.attributes;if("string"!=typeof r||0===r.length)throw new Error("Invalid url.");if(void 0!==o&&"object"!=typeof o)throw new Error("Expected attributes to be an object.");return new t((function(e,t){return"undefined"==typeof window?e():function(e){var t=e.url,r=e.attributes,o=e.onSuccess,i=e.onError,u=n(t,r);u.onerror=i,u.onload=o,document.head.insertBefore(u,document.head.firstElementChild)}({url:r,attributes:o,onSuccess:function(){return e()},onError:function(){return t(new Error('The script "'.concat(r,'" failed to load.')))}})}))}({url:u},t).then((function(){var e=o(a);if(e)return e;throw new Error("The window.".concat(a," global variable is not available."))}))}function o(e){return window[e]}function i(e,t){if("object"!=typeof e||null===e)throw new Error("Expected an options object.");if(void 0!==t&&"function"!=typeof t)throw new Error("Expected PromisePonyfill to be a function.")}"function"==typeof SuppressedError&&SuppressedError;return{com:function(n,o){return void 0===o&&(o=function(){if("undefined"==typeof Promise)throw new Error("Promise is undefined. To resolve the issue, use a Promise polyfill.");return Promise}()),e(void 0,void 0,void 0,(function(){var e;return t(this,(function(t){switch(t.label){case 0:return[4,r(n,o)];case 1:if(!(e=t.sent()))throw new Error("Wrong script URL provided");return[2,e.com(n)]}}))}))}}}));

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@pay-com/js",
+  "version": "1.1.0",
+  "description": "",
+  "keywords": [],
+  "license": "ISC",
+  "author": "",
+  "main": "lib/index.js",
+  "module": "lib/index.esm.js",
+  "types": "lib/index.d.ts",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "files": [
+    "lib/*.js",
+    "lib/*.d.ts"
+  ],
+  "scripts": {
+    "build:watch": "rollup -c --watch",
+    "build": "rollup -c",
+    "prepublishOnly": "npm run build",
+    "prepublish": "npm run build"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^21.0.0",
+    "@rollup/plugin-node-resolve": "^13.0.5",
+    "csstype": "^3.0.9",
+    "events": "^3.3.0",
+    "rollup": "^2.70.1",
+    "rollup-plugin-copy": "^3.4.0",
+    "rollup-plugin-dts": "^4.0.0",
+    "rollup-plugin-node-builtins": "^2.1.2",
+    "rollup-plugin-svg": "^2.0.0",
+    "rollup-plugin-terser": "^7.0.2",
+    "rollup-plugin-typescript2": "^0.34.1",
+    "typescript": "^4.4.4"
+  }
+}