airwallex-payment-elements 0.2.98 → 0.2.99

package/.gitlab-ci.yml

@@ -19,8 +19,8 @@ stages:
 # Unit Test
 
 .bucket_deploy_script: &bucket_deploy_script |-
-  ls
-  gsutil -m cp -r ./output/* gs://${BUCKET_NAME}
+  cd docs
+  gsutil -m cp -r ./public/* gs://${BUCKET_NAME}
   gsutil -m setmeta -r -h "Cache-Control:no-store,no-cache,max-age=0" gs://${BUCKET_NAME}/index.html
 
 
@@ -45,32 +45,47 @@ build:
   stage: build
   script:
     - yarn build
+  artifacts:
+    paths:
+      - dist
+      - lib
+      - public
+
+build-doc:
+  image: node:18.1-alpine
+  stage: build
+  script:
     - yarn typedoc
+    - cd docs
+    - yarn 
+    - yarn typedoc-prepare
+    - apk update && apk upgrade && apk add --no-cache bash git openssh
+    - yarn build
   artifacts:
     paths:
       - dist
       - lib
       - public
-      - output
+      - docs
 
 deploy-doc-staging:
   image: gcr.io/google.com/cloudsdktool/cloud-sdk:alpine
   tags:
     - acquiring
     - staging
-  artifacts:
-    paths:
-      - output
   only:
     - master
   when: manual
+  artifacts:
+    paths:
+      - docs
   script:
     - *bucket_deploy_script
   stage: deploy-doc-staging
   variables:
     BUCKET_NAME: awx-staging-asia-element-integration-doc
   needs:
-    - job: build
+    - job: build-doc
       artifacts: true
 
 # Publish github package

package/catalog-info.yaml

@@ -0,0 +1,66 @@
+# This file is only used by DevHub devhub.awx.im to display software metadata.
+# It can contain multiple catalog entities, separated by ---.
+
+# To learn more about configuring this file, see:
+#  - Backstage official Doc: https://backstage.io/docs/features/software-catalog/descriptor-format
+#  - Backstage System Model: https://backstage.io/docs/features/software-catalog/system-model
+#  - Airwallex catalog files: https://gitlab.awx.im/common/backstage-catalog
+#  - Airwallex FAQ and troubleshooting Doc: https://gitlab.awx.im/common/backstage-catalog/-/tree/master/docs
+
+# To onboard your software to DevHub,
+#  1. Remove the first # symbol in the following lines
+#  2. Replace the Change_Me placeholder with your custom values
+
+---
+#apiVersion: backstage.io/v1alpha1  # [required]
+#kind: Component  # [required] https://backstage.io/docs/features/software-catalog/descriptor-format#kind-component
+#metadata:  # [required]
+#  # Note: The name should be a K8s service name or a library name because a GitLab repository can contain multiple services.
+#  name: Change_Me  # [required] Must be unique per Kind. Must consist of sequences of [a-z0-9A-Z] possibly separated by one of [-_.].
+#
+#  # description: Change_Me_Or_Comment_Out_This_Line  # [optional] A human readable description of the entity, to be shown in DevHub.
+#
+#  annotations:  # [optional] Consumed by plugins.
+#    # Used by GitLab plugins to display PRs, Pipelines and so on. The value format is <gitlab-group>/<gitlab-repo-name>, e.g. gtpn/airwallex-ocs.
+#    gitlab.com/project-slug: acquiring/airwallex-payment-elements
+#    # Used by Kubernetes plugin to display k8s serviceboards. The value is your k8s service name.
+#    backstage.io/kubernetes-id: Change_Me_Or_Comment_Out_This_Line
+#    # Used by Opsgenie plugin to display Who Is On-Call. The value is Opsgenie team name, e.g. "CN DevOps".
+#    opsgenie.com/team: Change_Me_Or_Comment_Out_This_Line
+#    # Used by Opsgenie plugin to display alerts
+#    # This annotation accepts any valid Opsgenie Search queries for alerts, see
+#    # https://support.atlassian.com/opsgenie/docs/search-queries-for-alerts/
+#    opsgenie.com/component-selector: 'Change_Me_Or_Comment_Out_This_Line'
+#
+#  links:  # [optional] A list of links to be shown on entity page.
+#    - url: https://gitlab.awx.im/acquiring/airwallex-payment-elements
+#      title: GitLab Repo
+#      icon: github  # [optional] Available icons: chat, dashboard, docs, email, github, group, help, search, user, warning
+#
+#  # labels:  # [optional] Labels are optional key/value pairs that are attached to the entity.
+#  #   key1: value2
+#  #   key2: value2
+#
+#  # tags:  # [optional] A list of single-valued strings.
+#  #   - value1
+#  #   - value2
+#
+#spec:  # [required]
+#  type: service  # [required] The value is service, library and so on.
+#  lifecycle: production  # [required] The value is one of the experimental, production, deprecated.
+#  # Note: Use only the available group names at https://devhub.awx.im/catalog?filters%5Bkind%5D=group&filters%5Buser%5D=all
+#  owner: Change_Me_Only_Use_Group_Name_in_DevHub  # [required] Group or User in DevHub, e.g. a feature team team-cloud-infra, or a user email prefix andy.wang.
+#
+#  # system: Change_Me_Or_Comment_Out_This_Line  # [optional] An entity reference to the system that the component belongs to.
+#
+#  # dependsOn:  # [optional] An array of entity references to the components and resources that the component depends on.
+#  #   - resource:default/Change_Me
+#  #   - component:default/Change_Me
+#
+#  # providesApis:  # [optional] An array of entity references to the APIs that are provided by the component.
+#  #   - Change_Me
+#  #   - Change_Me
+#
+#  # consumesApis:  # [optional] An array of entity references to the APIs that are consumed by the component.
+#  #   - Change_Me
+#  #   - Change_Me

package/lib/bin/airwallex.cjs.js

@@ -1,3 +1,3 @@
-/* Airwallex Checkout Component Version [0.2.98] */
+/* Airwallex Checkout Component Version [0.2.99] */
 "use strict";Object.defineProperty(exports,"__esModule",{value:!0});const e={prod:"checkout.airwallex.com",demo:"checkout-demo.airwallex.com",staging:"checkout-staging.airwallex.com",qa:"checkoutui.qa.awx.im",preview:"checkoutui.preview.awx.im",dev:"localhost:3000"},r=r=>`https://${e[r]||e.prod}`,o="/assets/elements.bundle.min.js",t=e=>{const r=document.createElement("script");r.src=`${e}${o}`;const t=document.head||document.body;if(!t)throw new Error("Airwallex payment scripts requires a <head> or <body> html element in order to be loaded.");return t.appendChild(r),r};exports.confirmPaymentIntent=async e=>{if(window.Airwallex)return window.Airwallex.confirmPaymentIntent(e);{const e="Please loadAirwallex() before confirmPaymentIntent();";throw console.error(e),new Error(e)}},exports.confirmPaymentIntentWithSavedCard=async e=>{if(window.Airwallex)return window.Airwallex.confirmPaymentIntentWithSavedCard(e);{const e="Please loadAirwallex() before confirmPaymentIntentWithSavedCard();";throw console.error(e),new Error(e)}},exports.createElement=(e,r)=>window.Airwallex?window.Airwallex.createElement(e,r):(console.error("Please loadAirwallex() before createElement();"),null),exports.createPaymentConsent=async e=>{if(window.Airwallex)return window.Airwallex.createPaymentConsent(e);{const e="Please loadAirwallex() before createPaymentConsent();";throw console.error(e),new Error(e)}},exports.createPaymentMethod=async(e,r)=>{if(window.Airwallex)return window.Airwallex.createPaymentMethod(e,r);{const e="Please loadAirwallex() before createPaymentMethod();";throw console.error(e),new Error(e)}},exports.destroyElement=e=>window.Airwallex?window.Airwallex.destroyElement(e):(console.error("Please loadAirwallex() before destroyElement();"),!1),exports.get3dsReturnUrl=e=>window.Airwallex.get3dsReturnUrl(e),exports.getBrowserInfo=e=>window.Airwallex.getBrowserInfo(e),exports.getDeviceFingerprint=e=>window.Airwallex.getDeviceFingerprint(e),exports.getElement=e=>window.Airwallex?window.Airwallex.getElement(e):(console.error("Please loadAirwallex() before getElement();"),null),exports.getGatewayUrl=r,exports.getPaymentIntent=async(e,r)=>{if(window.Airwallex)return window.Airwallex.getPaymentIntent(e,r);{const e="Please loadAirwallex() before getPaymentIntent();";throw console.error(e),new Error(e)}},exports.handle3ds=e=>window.Airwallex.handle3ds(e),exports.init=e=>{window.Airwallex?window.Airwallex.init(e):console.error("Please loadAirwallex() before init();")},exports.loadAirwallex=async e=>{if("undefined"==typeof window)return null;if(window.Airwallex)return window.Airwallex;let n=0;const l=async()=>{const n=document.querySelector(`script[src="${o}"], script[src="${o}/"]`)||t(r((null==e?void 0:e.env)||"prod"));return new Promise(((r,o)=>{n.addEventListener("load",(()=>{window.Airwallex?(window.Airwallex.init(e),r(window.Airwallex)):o(new Error("Failed to load Airwallex on load event"))})),n.addEventListener("error",(()=>{o(new Error("Failed to load Airwallex scripts")),n.remove&&n.remove()}))}))};for(;n<3;)try{return await l()}catch(e){n++,await new Promise((e=>window.setTimeout(e,500)))}return null},exports.loadAirwallexJs=t,exports.redirectToCheckout=e=>{if(window.Airwallex)return window.Airwallex.redirectToCheckout(e);console.error("Please loadAirwallex() before redirectToCheckout();")};
 //# sourceMappingURL=airwallex.cjs.js.map

package/lib/bin/airwallex.es.js

@@ -1,3 +1,3 @@
-/* Airwallex Checkout Component Version [0.2.98] */
+/* Airwallex Checkout Component Version [0.2.99] */
 const e={prod:"checkout.airwallex.com",demo:"checkout-demo.airwallex.com",staging:"checkout-staging.airwallex.com",qa:"checkoutui.qa.awx.im",preview:"checkoutui.preview.awx.im",dev:"localhost:3000"},r=r=>`https://${e[r]||e.prod}`,o="/assets/elements.bundle.min.js",l=e=>{const r=document.createElement("script");r.src=`${e}${o}`;const l=document.head||document.body;if(!l)throw new Error("Airwallex payment scripts requires a <head> or <body> html element in order to be loaded.");return l.appendChild(r),r},n=async e=>{if("undefined"==typeof window)return null;if(window.Airwallex)return window.Airwallex;let n=0;const i=async()=>{const n=document.querySelector(`script[src="${o}"], script[src="${o}/"]`)||l(r((null==e?void 0:e.env)||"prod"));return new Promise(((r,o)=>{n.addEventListener("load",(()=>{window.Airwallex?(window.Airwallex.init(e),r(window.Airwallex)):o(new Error("Failed to load Airwallex on load event"))})),n.addEventListener("error",(()=>{o(new Error("Failed to load Airwallex scripts")),n.remove&&n.remove()}))}))};for(;n<3;)try{return await i()}catch(e){n++,await new Promise((e=>window.setTimeout(e,500)))}return null},i=e=>{window.Airwallex?window.Airwallex.init(e):console.error("Please loadAirwallex() before init();")},t=e=>{if(window.Airwallex)return window.Airwallex.redirectToCheckout(e);console.error("Please loadAirwallex() before redirectToCheckout();")},w=(e,r)=>window.Airwallex?window.Airwallex.createElement(e,r):(console.error("Please loadAirwallex() before createElement();"),null),a=e=>window.Airwallex?window.Airwallex.destroyElement(e):(console.error("Please loadAirwallex() before destroyElement();"),!1),d=e=>window.Airwallex?window.Airwallex.getElement(e):(console.error("Please loadAirwallex() before getElement();"),null),c=async e=>{if(window.Airwallex)return window.Airwallex.confirmPaymentIntent(e);{const e="Please loadAirwallex() before confirmPaymentIntent();";throw console.error(e),new Error(e)}},s=async e=>{if(window.Airwallex)return window.Airwallex.confirmPaymentIntentWithSavedCard(e);{const e="Please loadAirwallex() before confirmPaymentIntentWithSavedCard();";throw console.error(e),new Error(e)}},x=async(e,r)=>{if(window.Airwallex)return window.Airwallex.createPaymentMethod(e,r);{const e="Please loadAirwallex() before createPaymentMethod();";throw console.error(e),new Error(e)}},m=async(e,r)=>{if(window.Airwallex)return window.Airwallex.getPaymentIntent(e,r);{const e="Please loadAirwallex() before getPaymentIntent();";throw console.error(e),new Error(e)}},A=async e=>{if(window.Airwallex)return window.Airwallex.createPaymentConsent(e);{const e="Please loadAirwallex() before createPaymentConsent();";throw console.error(e),new Error(e)}},u=e=>window.Airwallex.getBrowserInfo(e),f=e=>window.Airwallex.getDeviceFingerprint(e),h=e=>window.Airwallex.get3dsReturnUrl(e),y=e=>window.Airwallex.handle3ds(e);export{c as confirmPaymentIntent,s as confirmPaymentIntentWithSavedCard,w as createElement,A as createPaymentConsent,x as createPaymentMethod,a as destroyElement,h as get3dsReturnUrl,u as getBrowserInfo,f as getDeviceFingerprint,d as getElement,r as getGatewayUrl,m as getPaymentIntent,y as handle3ds,i as init,n as loadAirwallex,l as loadAirwallexJs,t as redirectToCheckout};
 //# sourceMappingURL=airwallex.es.js.map

package/lib/bin/airwallex.iife.js

@@ -1,3 +1,3 @@
-/* Airwallex Checkout Component Version [0.2.98] */
+/* Airwallex Checkout Component Version [0.2.99] */
 var Airwallex=function(e){"use strict";const r={prod:"checkout.airwallex.com",demo:"checkout-demo.airwallex.com",staging:"checkout-staging.airwallex.com",qa:"checkoutui.qa.awx.im",preview:"checkoutui.preview.awx.im",dev:"localhost:3000"},n=e=>`https://${r[e]||r.prod}`,o="/assets/elements.bundle.min.js",l=e=>{const r=document.createElement("script");r.src=`${e}${o}`;const n=document.head||document.body;if(!n)throw new Error("Airwallex payment scripts requires a <head> or <body> html element in order to be loaded.");return n.appendChild(r),r};return e.confirmPaymentIntent=async e=>{if(window.Airwallex)return window.Airwallex.confirmPaymentIntent(e);{const e="Please loadAirwallex() before confirmPaymentIntent();";throw console.error(e),new Error(e)}},e.confirmPaymentIntentWithSavedCard=async e=>{if(window.Airwallex)return window.Airwallex.confirmPaymentIntentWithSavedCard(e);{const e="Please loadAirwallex() before confirmPaymentIntentWithSavedCard();";throw console.error(e),new Error(e)}},e.createElement=(e,r)=>window.Airwallex?window.Airwallex.createElement(e,r):(console.error("Please loadAirwallex() before createElement();"),null),e.createPaymentConsent=async e=>{if(window.Airwallex)return window.Airwallex.createPaymentConsent(e);{const e="Please loadAirwallex() before createPaymentConsent();";throw console.error(e),new Error(e)}},e.createPaymentMethod=async(e,r)=>{if(window.Airwallex)return window.Airwallex.createPaymentMethod(e,r);{const e="Please loadAirwallex() before createPaymentMethod();";throw console.error(e),new Error(e)}},e.destroyElement=e=>window.Airwallex?window.Airwallex.destroyElement(e):(console.error("Please loadAirwallex() before destroyElement();"),!1),e.get3dsReturnUrl=e=>window.Airwallex.get3dsReturnUrl(e),e.getBrowserInfo=e=>window.Airwallex.getBrowserInfo(e),e.getDeviceFingerprint=e=>window.Airwallex.getDeviceFingerprint(e),e.getElement=e=>window.Airwallex?window.Airwallex.getElement(e):(console.error("Please loadAirwallex() before getElement();"),null),e.getGatewayUrl=n,e.getPaymentIntent=async(e,r)=>{if(window.Airwallex)return window.Airwallex.getPaymentIntent(e,r);{const e="Please loadAirwallex() before getPaymentIntent();";throw console.error(e),new Error(e)}},e.handle3ds=e=>window.Airwallex.handle3ds(e),e.init=e=>{window.Airwallex?window.Airwallex.init(e):console.error("Please loadAirwallex() before init();")},e.loadAirwallex=async e=>{if("undefined"==typeof window)return null;if(window.Airwallex)return window.Airwallex;let r=0;const t=async()=>{const r=document.querySelector(`script[src="${o}"], script[src="${o}/"]`)||l(n((null==e?void 0:e.env)||"prod"));return new Promise(((n,o)=>{r.addEventListener("load",(()=>{window.Airwallex?(window.Airwallex.init(e),n(window.Airwallex)):o(new Error("Failed to load Airwallex on load event"))})),r.addEventListener("error",(()=>{o(new Error("Failed to load Airwallex scripts")),r.remove&&r.remove()}))}))};for(;r<3;)try{return await t()}catch(e){r++,await new Promise((e=>window.setTimeout(e,500)))}return null},e.loadAirwallexJs=l,e.redirectToCheckout=e=>{if(window.Airwallex)return window.Airwallex.redirectToCheckout(e);console.error("Please loadAirwallex() before redirectToCheckout();")},Object.defineProperty(e,"__esModule",{value:!0}),e}({});
 //# sourceMappingURL=airwallex.iife.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "airwallex-payment-elements",
-  "version": "0.2.98",
+  "version": "0.2.99",
   "module": "lib/bin/airwallex.es.js",
   "main": "lib/bin/airwallex.cjs.js",
   "bin": "lib/bin/airwallex.cjs.js",
@@ -102,6 +102,8 @@
   "dependencies": {
     "@types/applepayjs": "^3.0.3",
     "@types/googlepay": "^0.6.4",
-    "csstype": "^3.0.6"
+    "csstype": "^3.0.6",
+    "typedoc-plugin-markdown": "^3.14.0",
+    "typedoc-plugin-merge-modules": "^4.0.1"
   }
 }

package/typedocconfig.js

@@ -2,7 +2,7 @@ module.exports = {
   entryPoints: ['src/index.ts'],
   entryPointStrategy: 'Expand',
   tsconfig: 'tsconfig.json',
-  out: './output',
+  out: './docs/source/sdk-reference',
   excludePrivate: true,
   excludeProtected: true,
   excludeExternals: true,
@@ -10,12 +10,12 @@ module.exports = {
   readme: 'README.md',
   name: 'airwallex-payment-elements',
   favicon: 'public/favicon.ico',
-  customTitle: 'Airwallex payment element integration doc',
-  customDescription:
-    'This airwallex-payment-elements library is a lightweight javascript SDK that allows merchants to conveniently integrate the Airwallex checkout flow on their website.',
-  sidebarLinks: {
-    'Integration Examples': 'https://github.com/airwallex/airwallex-payment-demo/tree/master/integrations',
-  },
+  categorizeByGroup: true,
+  mergeModulesRenameDefaults: true,
+  allReflectionsHaveOwnDocument: true,
+  categoryOrder: ['modules', 'functions', 'interfaces', 'types'],
+  mergeModulesMergeMode: 'off',
+  hideBreadcrumbs: 'true',
   externalSymbolLinkMappings: {
     // used by {@link !Promise}
     global: {

package/types/element.d.ts

@@ -113,6 +113,7 @@ export type PaymentMethodType =
   | 'applepay'
   | 'card'
   | 'wechatpay'
+  | 'airwallex_pay'
   | PaymentMethodWithRedirect
   | DirectDebitPaymentMethod;