@solidgate/client-sdk-loader 1.0.0

package/src/interfaces/Transaction.ts

@@ -0,0 +1,57 @@
+export default interface Transaction {
+  descriptor?: string
+  amount: number
+  card_token?: {
+    token: string
+  }
+  card: {
+    bank?: string
+    bin: number
+    brand?: string
+    card_exp_month: string
+    card_exp_year: number
+    card_holder?: string
+    card_type?: string
+    country?: string
+    number?: string
+    card_token?: {
+      token: string
+    }
+  }
+  created_at: string
+  currency: string
+  id: string
+  operation: string
+  status: string
+  updated_at: string
+  refund_reason?: string
+  refund_reason_code?: string
+  marketing_amount?: number
+  marketing_currency?: string
+  finance_fee_amount?: string | number
+  finance_fee_currency?: string | number
+  billing_details?: {
+    address?: string
+    city?: string
+    country?: string
+    state?: string
+    zip?: string
+  }
+  error?: {
+    code: string
+    message: string
+    recommended_message_for_user?: string
+  }
+  finance?: {
+    amount: number
+    currency: string
+    internal?: {
+      amount: number
+      currency: string
+    }
+    external?: {
+      amount: number
+      currency: string
+    }
+  }
+}

package/src/interfaces/UpdateConfig.ts

@@ -0,0 +1,4 @@
+export default interface UpdateConfig {
+  partialIntent: string
+  signature: string
+}

package/src/interfaces/messages/ErrorMessage.ts

@@ -0,0 +1,10 @@
+import Message from './Message'
+
+import MessageType from '../../enums/MessageType'
+
+export default interface ErrorMessage extends Message<MessageType.Error> {
+  value: {
+    code?: string
+    message?: string | string[]
+  }
+}

package/src/interfaces/messages/FailMessage.ts

@@ -0,0 +1,12 @@
+import Message from './Message'
+import OrderShort from '../OrderShort'
+
+import MessageType from '../../enums/MessageType'
+import PayableEntity from '../../enums/PayableEntity'
+
+export default interface FailMessage extends Message<MessageType.Fail> {
+  code?: string
+  message?: string
+  order?: OrderShort
+  entity: PayableEntity
+}

package/src/interfaces/messages/InteractionMessage.ts

@@ -0,0 +1,28 @@
+import Message from "./Message"
+
+import FieldName from '../../enums/FieldName'
+import InteractionType from '../../enums/InteractionType'
+import InteractionTargetType from '../../enums/InteractionTargetType'
+import MessageType from "../../enums/MessageType"
+
+export default interface InteractionMessage
+  extends Message<MessageType.Interaction> {
+  target: {
+    type: InteractionTargetType
+    name: FieldName | 'submit' | 'googlePay' | 'applePay'
+    interaction: InteractionType
+  }
+  cardForm: {
+    fields: Partial<
+      Record<
+        FieldName,
+        {
+          isValid: boolean
+          isTouched: boolean
+        }
+      >
+    >
+    isValid: boolean
+    isTouched: boolean
+  }
+}

package/src/interfaces/messages/Message.ts

@@ -0,0 +1,5 @@
+import MessageType from '../../enums/MessageType'
+
+export default interface Message<T extends MessageType> {
+  type: T
+}

package/src/interfaces/messages/MountedMessage.ts

@@ -0,0 +1,7 @@
+import Message from './Message'
+
+import MessageType from '../../enums/MessageType'
+
+export default interface MountedMessage extends Message<MessageType.Mounted> {
+  entity: 'applebtn' | 'googlebtn' | 'form'
+}

package/src/interfaces/messages/OrderStatusMessage.ts

@@ -0,0 +1,9 @@
+import Message from './Message'
+import OrderStatus from '../OrderStatus'
+
+import MessageType from '../../enums/MessageType'
+
+export default interface OrderStatusMessage
+  extends Message<MessageType.OrderStatus> {
+  response: OrderStatus
+}

package/src/interfaces/messages/ResizeMessage.ts

@@ -0,0 +1,8 @@
+import Message from './Message'
+
+import MessageType from '../../enums/MessageType'
+
+export default interface ResizeMessage extends Message<MessageType.Resize> {
+  height: number
+  width: number
+}

package/src/interfaces/messages/SubmitMessage.ts

@@ -0,0 +1,8 @@
+import Message from './Message'
+
+import MessageType from '../../enums/MessageType'
+import PayableEntity from '../../enums/PayableEntity'
+
+export default interface SubmitMessage extends Message<MessageType.Submit> {
+  entity: PayableEntity
+}

package/src/interfaces/messages/SuccessMessage.ts

@@ -0,0 +1,10 @@
+import Message from './Message'
+import OrderShort from '../OrderShort'
+
+import MessageType from '../../enums/MessageType'
+import PayableEntity from '../../enums/PayableEntity'
+
+export default interface SuccessMessage extends Message<MessageType.Success> {
+  order: OrderShort
+  entity: PayableEntity
+}

package/src/services/SdkLoader.test.ts

@@ -0,0 +1,90 @@
+import ClientSdk from '../interfaces/ClientSdk'
+
+declare global {
+  interface Window {
+    PaymentFormSdk?: ClientSdk
+  }
+}
+
+describe('SdkLoader', () => {
+  afterEach(() => {
+    jest.resetModules()
+
+    document.head.innerHTML = ''
+
+    delete window.PaymentFormSdk
+  })
+
+  it('just returns sdk if already loaded', async () => {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const SdkLoader = require('./SdkLoader').default
+
+    window.PaymentFormSdk = Symbol() as unknown as ClientSdk
+
+    expect(await SdkLoader.load()).toEqual(window.PaymentFormSdk)
+  })
+
+  it('creates script with proper src', () => {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const SdkLoader = require('./SdkLoader').default
+
+    SdkLoader.load()
+
+    const script = document.getElementById(
+      'solid-payment-form-source'
+    ) as HTMLScriptElement
+
+    expect(script.src).toEqual('https://cdn.solidgate.com/js/solid-form.js')
+    expect(script.async).toBeTruthy()
+  })
+
+  it('resolves PaymentFormSdk after script loading', async () => {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const SdkLoader = require('./SdkLoader').default
+
+    const promise = SdkLoader.load()
+
+    const script = document.getElementById(
+      'solid-payment-form-source'
+    ) as HTMLScriptElement
+
+    window.PaymentFormSdk = Symbol() as unknown as ClientSdk
+
+    if (script.onload) {
+      script.onload(new Event('load'))
+    }
+
+    expect(await promise).toEqual(window.PaymentFormSdk)
+  })
+
+  it('rejects load attempt after script loading error', () => {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const SdkLoader = require('./SdkLoader').default
+
+    const promise = SdkLoader.load()
+
+    const script = document.getElementById(
+      'solid-payment-form-source'
+    ) as HTMLScriptElement
+
+    const error = new Event('load')
+
+    if (script.onerror) {
+      script.onerror(error)
+    }
+
+    expect(promise).rejects.toEqual(error)
+  })
+
+  it('creates only one script after double initialization', () => {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const SdkLoader = require('./SdkLoader').default
+
+    SdkLoader.load()
+    SdkLoader.load()
+
+    const scripts = document.getElementsByTagName('script')
+
+    expect(scripts.length).toEqual(1)
+  })
+})

package/src/services/SdkLoader.ts

@@ -0,0 +1,48 @@
+import ClientSdk from '../interfaces/ClientSdk'
+
+declare global {
+  interface Window {
+    PaymentFormSdk?: ClientSdk
+  }
+}
+
+export default class SdkLoader {
+  static #CloudfrontSrc = 'https://cdn.solidgate.com/js/solid-form.js'
+
+  static #loadAttempt: Promise<ClientSdk> | null = null
+
+  static load (): Promise<ClientSdk> {
+    if (window.PaymentFormSdk) {
+      return Promise.resolve(window.PaymentFormSdk)
+    }
+
+    if (this.#loadAttempt) {
+      return this.#loadAttempt
+    }
+
+    this.#loadAttempt = new Promise<ClientSdk>((resolve, reject) => {
+      try {
+        const script = document.createElement('script')
+        script.async = true
+
+        script.src = this.#CloudfrontSrc
+        script.id = 'solid-payment-form-source'
+
+        script.onerror = e => {
+          this.#loadAttempt = null
+          reject(e)
+        }
+
+        script.onload = () => {
+          resolve(window.PaymentFormSdk as ClientSdk)
+        }
+
+        document.head.appendChild(script)
+      } catch (e) {
+        reject(e)
+      }
+    })
+
+    return this.#loadAttempt
+  }
+}

package/tsconfig.json

@@ -0,0 +1,33 @@
+{
+  "compilerOptions": {
+    "incremental": true,
+    "target": "es2015",
+    "module": "commonjs",
+    "lib": ["es2017", "es7", "es6", "dom"],
+    "declaration": true,
+    "outDir": "dist",
+    "allowJs": true,
+    "strict": true,
+    "noImplicitAny": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "strictBindCallApply": true,
+    "strictPropertyInitialization": true,
+    "noImplicitThis": true,
+    "alwaysStrict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true,
+    "moduleResolution": "node",
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "noFallthroughCasesInSwitch": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true
+  },
+  "include": [
+    "src/index.ts"
+  ]
+}