diff --git a/.eslintrc.json b/.eslintrc.json new file mode 100644 index 0000000..5501204 --- /dev/null +++ b/.eslintrc.json @@ -0,0 +1,19 @@ +{ + "env": { + "browser": true, + "es2021": true + }, + "extends": [ + "standard-with-typescript", + "plugin:react/recommended", + "eslint:recommended", + "plugin:@typescript-eslint/recommended" + ], + "parserOptions": { + "ecmaVersion": "latest", + "sourceType": "module" + }, + "parser": "@typescript-eslint/parser", + "plugins": ["@typescript-eslint", "react"], + "rules": {} +} diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml new file mode 100644 index 0000000..812cbb7 --- /dev/null +++ b/.github/workflows/main.yaml @@ -0,0 +1,20 @@ +name: CI +on: + push: + branches: + - "**" + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: pnpm/action-setup@v2 + with: + version: 7 + - uses: actions/setup-node@v3 + with: + node-version: 16.x + + - run: pnpm install + - run: pnpm run format && pnpm run build \ No newline at end of file diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml new file mode 100644 index 0000000..407e87e --- /dev/null +++ b/.github/workflows/publish.yaml @@ -0,0 +1,31 @@ +name: Publish +on: + workflow_run: + workflows: [CI] + branches: [main] + types: [completed] + +concurrency: ${{ github.workflow }}-${{ github.ref }} + +permissions: + contents: write + pull-requests: write + +jobs: + publish: + if: ${{ github.event.workflow_run.conclusion == 'success' }} + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: pnpm/action-setup@v2 + with: + version: 7 + - uses: actions/setup-node@v3 + with: + node-version: 16.x + registry-url: 'https://registry.npmjs.org' + + - run: pnpm install + - run: npm publish --access public + env: + NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} \ No newline at end of file diff --git a/.gitignore b/.gitignore index d23f008..b3fc061 100644 --- a/.gitignore +++ b/.gitignore @@ -62,3 +62,4 @@ typings/ .code +bun.lockb \ No newline at end of file diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..e1dd901 --- /dev/null +++ b/Makefile @@ -0,0 +1,9 @@ +deploy: + @npm run build + @npm publish --access public + +format: + npm run format + +lint: + npm run lint diff --git a/README.md b/README.md index 85cf904..25d5987 100644 --- a/README.md +++ b/README.md @@ -28,28 +28,29 @@ yarn add react-korba-payment ```javascript import React from 'react'; -import {useXCheckout} from 'react-korba-payment'; +import { useXCheckout } from 'react-korba-payment'; function App() { - const {handleXCheckoutClick} = useXCheckout({ - config: { - merchantID: '', - orderID: '', - description: 'Ordered goods', - amount: 1.2, - redirectURL: 'http://www.yourawesomeapp.com', - }, - scriptSrc: 'https://paywithkorba.s3-eu-west-1.amazonaws.com/test-checkout.js', + const {pay} = useXCheckout({ + scriptSrc: 'https://paywithkorba.s3-eu-west-1.amazonaws.com/test-checkout.js', // replace with your XCheckout script URL }); return ( -
- -
); -} export default App; ``` @@ -62,28 +63,30 @@ Next.js 13 introduces a new app/ directory folder structure. By default it uses ```javascript 'use client'; import React from 'react'; -import {useXCheckout} from 'react-korba-payment'; - -function CheckoutButton() { - const {handleXCheckoutClick} = useXCheckout({ - config: { - merchantID: '', - orderID: '', - description: 'Ordered goods', - amount: 1.2, - redirectURL: 'http://www.yourawesomeapp.com', - }, - scriptSrc: 'https://paywithkorba.s3-eu-west-1.amazonaws.com/test-checkout.js', +import { useXCheckout } from 'react-korba-payment'; + +export default function CheckoutButton() { + const {pay} = useXCheckout({ + scriptSrc: 'https://paywithkorba.s3-eu-west-1.amazonaws.com/test-checkout.js', // replace with your XCheckout script URL }); return ( - ); } - -export default CheckoutButton; ``` Please checkout [Korba Documentation](https://xchange.korba365.com/docs/) for more. @@ -103,6 +106,7 @@ If you would like to contribute to React Korba Payment(js), 5. Submit a pull request 😉😉 Don't forget to [follow me on instagram](https://instagram.com/1rutmann)! +Don't forget to [follow me on twitter](https://x.com/tswwws)! ## License diff --git a/babel.config.js b/babel.config.js index b9d1741..694b4a3 100644 --- a/babel.config.js +++ b/babel.config.js @@ -4,10 +4,10 @@ module.exports = { '@babel/preset-env', { targets: { - node: 'current' - } - } + node: 'current', + }, + }, ], - '@babel/preset-typescript' - ] + '@babel/preset-typescript', + ], }; diff --git a/dist/index.es.js b/dist/index.es.js index 8f68b85..57acf21 100644 --- a/dist/index.es.js +++ b/dist/index.es.js @@ -1,34 +1,74 @@ -import { useRef, useEffect } from 'react'; +import {useRef, useState, useEffect} from 'react'; -function useXCheckout({ config, scriptSrc }) { - const xcheckoutRef = useRef(null); - useEffect(() => { - const script = document.createElement('script'); - script.src = scriptSrc; - script.async = true; - script.onload = () => { - xcheckoutRef.current = window.XCheckout; - xcheckoutRef.current.configure(config); - }; - document.head.appendChild(script); - return () => { - if (xcheckoutRef.current !== null && typeof xcheckoutRef.current.destroy === 'function') { - xcheckoutRef.current.destroy(); - xcheckoutRef.current = null; - } - document.head.removeChild(script); - }; - }, [config, scriptSrc]); - const handleXCheckoutClick = () => { - if (xcheckoutRef.current !== null) { - xcheckoutRef.current.pay(); - } - else { - console.warn('XCheckout library is not yet loaded'); - } +/** + * Custom hook for integrating Korba XCheckout into a React component. + * + * @param scriptSrc - The source URL of the XCheckout script. + * @returns An object containing the `pay` function and a boolean indicating whether XCheckout is loaded. + * + * @example + * import { useXCheckout } from 'react-korba-payment'; + * + * const { pay, isXCheckoutLoaded } = useXCheckout({ scriptSrc: 'https://paywithkorba.s3-eu-west-1.amazonaws.com/test-checkout.js' }); // replace with your XCheckout script URL + * + * @see UseXCheckoutProps + * @see XCheckoutHooksReturnProps + * + * @see [Package Documentation](https://github.com/eben92/react-korba-payment#readme) + * @see [Korba Documentation](https://xchange.korba365.com/docs/#xcheckout) + */ +function useXCheckout({scriptSrc}) { + const xCheckoutRef = useRef(null); + const [isXCheckoutLoaded, setIsXCheckoutLoaded] = useState(false); + useEffect(() => { + const script = document.createElement('script'); + script.src = scriptSrc; + script.async = true; + script.onload = () => { + xCheckoutRef.current = window.XCheckout; }; - return { handleXCheckoutClick }; + const handleScriptLoad = () => { + xCheckoutRef.current = window.XCheckout; + setIsXCheckoutLoaded(true); + }; + script.addEventListener('load', handleScriptLoad); + document.head.appendChild(script); + return () => { + if (xCheckoutRef.current !== null && typeof xCheckoutRef.current.destroy === 'function') { + xCheckoutRef.current.destroy(); + xCheckoutRef.current = null; + } + document.head.removeChild(script); + setIsXCheckoutLoaded(false); + }; + }, []); + /** + * Executes the XCheckout process with the provided configuration. + * If the XCheckout library is not yet loaded, a warning message is logged. + * @param config - The configuration object for XCheckout. + * @returns void + * @example + * const config = { + * merchantID: 'merchant-id', // your merchant ID. + * orderID: 'order-id', // unique order ID + * description: 'description', // optional + * amount: 100, // in GH₵ + * redirectURL: 'https://example.com/redirect', + * }; + * onXCheckout(config); + * @see XCheckoutConfigProps + * + */ + const pay = (config) => { + if (xCheckoutRef.current !== null) { + xCheckoutRef.current.configure(config); + xCheckoutRef.current.pay(); + return; + } + console.warn('XCheckout library is not yet loaded'); + }; + return {pay, isXCheckoutLoaded}; } -export { useXCheckout }; +export {useXCheckout}; //# sourceMappingURL=index.es.js.map diff --git a/dist/index.es.js.map b/dist/index.es.js.map index 44472ee..c9189d2 100644 --- a/dist/index.es.js.map +++ b/dist/index.es.js.map @@ -1 +1 @@ -{"version":3,"file":"index.es.js","sources":["../libs/use-x-checkout.tsx"],"sourcesContent":["'use client';\r\n\r\nimport {useEffect, useRef} from 'react';\r\nimport type {TXCheckoutRefProps, ICheckoutHooksProps, TUseXCheckoutProps} from './types';\r\n\r\nexport default function useXCheckout({config, scriptSrc}: TUseXCheckoutProps): ICheckoutHooksProps {\r\n const xcheckoutRef = useRef(null);\r\n\r\n useEffect(() => {\r\n const script = document.createElement('script');\r\n script.src = scriptSrc;\r\n script.async = true;\r\n script.onload = () => {\r\n xcheckoutRef.current = window.XCheckout;\r\n xcheckoutRef.current.configure(config);\r\n };\r\n document.head.appendChild(script);\r\n\r\n return () => {\r\n if (xcheckoutRef.current !== null && typeof xcheckoutRef.current.destroy === 'function') {\r\n xcheckoutRef.current.destroy();\r\n xcheckoutRef.current = null;\r\n }\r\n document.head.removeChild(script);\r\n };\r\n }, [config, scriptSrc]);\r\n\r\n const handleXCheckoutClick = (): void => {\r\n if (xcheckoutRef.current !== null) {\r\n xcheckoutRef.current.pay();\r\n } else {\r\n console.warn('XCheckout library is not yet loaded');\r\n }\r\n };\r\n\r\n return {handleXCheckoutClick};\r\n}\r\n"],"names":[],"mappings":";;AAKwB,SAAA,YAAY,CAAC,EAAC,MAAM,EAAE,SAAS,EAAqB,EAAA;AAC1E,IAAA,MAAM,YAAY,GAAG,MAAM,CAA4B,IAAI,CAAC,CAAC;IAE7D,SAAS,CAAC,MAAK;QACb,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;AAChD,QAAA,MAAM,CAAC,GAAG,GAAG,SAAS,CAAC;AACvB,QAAA,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC;AACpB,QAAA,MAAM,CAAC,MAAM,GAAG,MAAK;AACnB,YAAA,YAAY,CAAC,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC;AACxC,YAAA,YAAY,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;AACzC,SAAC,CAAC;AACF,QAAA,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;AAElC,QAAA,OAAO,MAAK;AACV,YAAA,IAAI,YAAY,CAAC,OAAO,KAAK,IAAI,IAAI,OAAO,YAAY,CAAC,OAAO,CAAC,OAAO,KAAK,UAAU,EAAE;AACvF,gBAAA,YAAY,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;AAC/B,gBAAA,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC;AAC7B,aAAA;AACD,YAAA,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;AACpC,SAAC,CAAC;AACJ,KAAC,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;IAExB,MAAM,oBAAoB,GAAG,MAAW;AACtC,QAAA,IAAI,YAAY,CAAC,OAAO,KAAK,IAAI,EAAE;AACjC,YAAA,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;AAC5B,SAAA;AAAM,aAAA;AACL,YAAA,OAAO,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;AACrD,SAAA;AACH,KAAC,CAAC;IAEF,OAAO,EAAC,oBAAoB,EAAC,CAAC;AAChC;;;;"} \ No newline at end of file +{"version":3,"file":"index.es.js","sources":["../libs/use-x-checkout.ts"],"sourcesContent":["import {useEffect, useRef, useState} from 'react';\nimport type {\n XCheckoutRefProps,\n XCheckoutHooksReturnProps,\n UseXCheckoutProps,\n XCheckoutConfigProps,\n} from './types';\n\n/**\n * Custom hook for integrating Korba XCheckout into a React component.\n *\n * @param scriptSrc - The source URL of the XCheckout script.\n * @returns An object containing the `pay` function and a boolean indicating whether XCheckout is loaded.\n *\n * @example\n * import { useXCheckout } from 'react-korba-payment';\n *\n * const { pay, isXCheckoutLoaded } = useXCheckout({ scriptSrc: 'https://paywithkorba.s3-eu-west-1.amazonaws.com/test-checkout.js' }); // replace with your XCheckout script URL\n *\n * @see UseXCheckoutProps\n * @see XCheckoutHooksReturnProps\n *\n * @see [Package Documentation](https://github.com/eben92/react-korba-payment#readme)\n * @see [Korba Documentation](https://xchange.korba365.com/docs/#xcheckout)\n */\nexport default function useXCheckout({scriptSrc}: UseXCheckoutProps): XCheckoutHooksReturnProps {\n const xCheckoutRef = useRef(null);\n const [isXCheckoutLoaded, setIsXCheckoutLoaded] = useState(false);\n\n useEffect(() => {\n const script = document.createElement('script');\n script.src = scriptSrc;\n script.async = true;\n script.onload = () => {\n xCheckoutRef.current = window.XCheckout;\n };\n\n const handleScriptLoad = () => {\n xCheckoutRef.current = window.XCheckout;\n setIsXCheckoutLoaded(true);\n };\n\n script.addEventListener('load', handleScriptLoad);\n document.head.appendChild(script);\n\n return () => {\n if (xCheckoutRef.current !== null && typeof xCheckoutRef.current.destroy === 'function') {\n xCheckoutRef.current.destroy();\n xCheckoutRef.current = null;\n }\n document.head.removeChild(script);\n\n setIsXCheckoutLoaded(false);\n };\n }, []);\n\n /**\n * Executes the XCheckout process with the provided configuration.\n * If the XCheckout library is not yet loaded, a warning message is logged.\n * @param config - The configuration object for XCheckout.\n * @returns void\n * @example\n * const config = {\n * merchantID: 'merchant-id', // your merchant ID.\n * orderID: 'order-id', // unique order ID\n * description: 'description', // optional\n * amount: 100, // in GH₵\n * redirectURL: 'https://example.com/redirect',\n * };\n * onXCheckout(config);\n * @see XCheckoutConfigProps\n *\n */\n const pay = (config: XCheckoutConfigProps): void => {\n if (xCheckoutRef.current !== null) {\n xCheckoutRef.current.configure(config);\n\n xCheckoutRef.current.pay();\n return;\n }\n\n console.warn('XCheckout library is not yet loaded');\n };\n\n return {pay, isXCheckoutLoaded};\n}\n"],"names":[],"mappings":";;AAQA;;;;;;;;;;;;;;;;AAgBG;AACW,SAAU,YAAY,CAAC,EAAC,SAAS,EAAoB,EAAA;AACjE,IAAA,MAAM,YAAY,GAAG,MAAM,CAA2B,IAAI,CAAC,CAAC;IAC5D,MAAM,CAAC,iBAAiB,EAAE,oBAAoB,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAElE,SAAS,CAAC,MAAK;QACb,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;AAChD,QAAA,MAAM,CAAC,GAAG,GAAG,SAAS,CAAC;AACvB,QAAA,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC;AACpB,QAAA,MAAM,CAAC,MAAM,GAAG,MAAK;AACnB,YAAA,YAAY,CAAC,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC;AAC1C,SAAC,CAAC;QAEF,MAAM,gBAAgB,GAAG,MAAK;AAC5B,YAAA,YAAY,CAAC,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC;YACxC,oBAAoB,CAAC,IAAI,CAAC,CAAC;AAC7B,SAAC,CAAC;AAEF,QAAA,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;AAClD,QAAA,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;AAElC,QAAA,OAAO,MAAK;AACV,YAAA,IAAI,YAAY,CAAC,OAAO,KAAK,IAAI,IAAI,OAAO,YAAY,CAAC,OAAO,CAAC,OAAO,KAAK,UAAU,EAAE;AACvF,gBAAA,YAAY,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;AAC/B,gBAAA,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC;aAC7B;AACD,YAAA,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YAElC,oBAAoB,CAAC,KAAK,CAAC,CAAC;AAC9B,SAAC,CAAC;KACH,EAAE,EAAE,CAAC,CAAC;AAEP;;;;;;;;;;;;;;;;AAgBG;AACH,IAAA,MAAM,GAAG,GAAG,CAAC,MAA4B,KAAU;AACjD,QAAA,IAAI,YAAY,CAAC,OAAO,KAAK,IAAI,EAAE;AACjC,YAAA,YAAY,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;AAEvC,YAAA,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;YAC3B,OAAO;SACR;AAED,QAAA,OAAO,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;AACtD,KAAC,CAAC;AAEF,IAAA,OAAO,EAAC,GAAG,EAAE,iBAAiB,EAAC,CAAC;AAClC;;;;"} \ No newline at end of file diff --git a/dist/index.js b/dist/index.js index f1656b7..9255b65 100644 --- a/dist/index.js +++ b/dist/index.js @@ -2,34 +2,74 @@ var react = require('react'); -function useXCheckout({ config, scriptSrc }) { - const xcheckoutRef = react.useRef(null); - react.useEffect(() => { - const script = document.createElement('script'); - script.src = scriptSrc; - script.async = true; - script.onload = () => { - xcheckoutRef.current = window.XCheckout; - xcheckoutRef.current.configure(config); - }; - document.head.appendChild(script); - return () => { - if (xcheckoutRef.current !== null && typeof xcheckoutRef.current.destroy === 'function') { - xcheckoutRef.current.destroy(); - xcheckoutRef.current = null; - } - document.head.removeChild(script); - }; - }, [config, scriptSrc]); - const handleXCheckoutClick = () => { - if (xcheckoutRef.current !== null) { - xcheckoutRef.current.pay(); - } - else { - console.warn('XCheckout library is not yet loaded'); - } +/** + * Custom hook for integrating Korba XCheckout into a React component. + * + * @param scriptSrc - The source URL of the XCheckout script. + * @returns An object containing the `pay` function and a boolean indicating whether XCheckout is loaded. + * + * @example + * import { useXCheckout } from 'react-korba-payment'; + * + * const { pay, isXCheckoutLoaded } = useXCheckout({ scriptSrc: 'https://paywithkorba.s3-eu-west-1.amazonaws.com/test-checkout.js' }); // replace with your XCheckout script URL + * + * @see UseXCheckoutProps + * @see XCheckoutHooksReturnProps + * + * @see [Package Documentation](https://github.com/eben92/react-korba-payment#readme) + * @see [Korba Documentation](https://xchange.korba365.com/docs/#xcheckout) + */ +function useXCheckout({scriptSrc}) { + const xCheckoutRef = react.useRef(null); + const [isXCheckoutLoaded, setIsXCheckoutLoaded] = react.useState(false); + react.useEffect(() => { + const script = document.createElement('script'); + script.src = scriptSrc; + script.async = true; + script.onload = () => { + xCheckoutRef.current = window.XCheckout; }; - return { handleXCheckoutClick }; + const handleScriptLoad = () => { + xCheckoutRef.current = window.XCheckout; + setIsXCheckoutLoaded(true); + }; + script.addEventListener('load', handleScriptLoad); + document.head.appendChild(script); + return () => { + if (xCheckoutRef.current !== null && typeof xCheckoutRef.current.destroy === 'function') { + xCheckoutRef.current.destroy(); + xCheckoutRef.current = null; + } + document.head.removeChild(script); + setIsXCheckoutLoaded(false); + }; + }, []); + /** + * Executes the XCheckout process with the provided configuration. + * If the XCheckout library is not yet loaded, a warning message is logged. + * @param config - The configuration object for XCheckout. + * @returns void + * @example + * const config = { + * merchantID: 'merchant-id', // your merchant ID. + * orderID: 'order-id', // unique order ID + * description: 'description', // optional + * amount: 100, // in GH₵ + * redirectURL: 'https://example.com/redirect', + * }; + * onXCheckout(config); + * @see XCheckoutConfigProps + * + */ + const pay = (config) => { + if (xCheckoutRef.current !== null) { + xCheckoutRef.current.configure(config); + xCheckoutRef.current.pay(); + return; + } + console.warn('XCheckout library is not yet loaded'); + }; + return {pay, isXCheckoutLoaded}; } exports.useXCheckout = useXCheckout; diff --git a/dist/index.js.map b/dist/index.js.map index 0da6a88..224c1c8 100644 --- a/dist/index.js.map +++ b/dist/index.js.map @@ -1 +1 @@ -{"version":3,"file":"index.js","sources":["../libs/use-x-checkout.tsx"],"sourcesContent":["'use client';\r\n\r\nimport {useEffect, useRef} from 'react';\r\nimport type {TXCheckoutRefProps, ICheckoutHooksProps, TUseXCheckoutProps} from './types';\r\n\r\nexport default function useXCheckout({config, scriptSrc}: TUseXCheckoutProps): ICheckoutHooksProps {\r\n const xcheckoutRef = useRef(null);\r\n\r\n useEffect(() => {\r\n const script = document.createElement('script');\r\n script.src = scriptSrc;\r\n script.async = true;\r\n script.onload = () => {\r\n xcheckoutRef.current = window.XCheckout;\r\n xcheckoutRef.current.configure(config);\r\n };\r\n document.head.appendChild(script);\r\n\r\n return () => {\r\n if (xcheckoutRef.current !== null && typeof xcheckoutRef.current.destroy === 'function') {\r\n xcheckoutRef.current.destroy();\r\n xcheckoutRef.current = null;\r\n }\r\n document.head.removeChild(script);\r\n };\r\n }, [config, scriptSrc]);\r\n\r\n const handleXCheckoutClick = (): void => {\r\n if (xcheckoutRef.current !== null) {\r\n xcheckoutRef.current.pay();\r\n } else {\r\n console.warn('XCheckout library is not yet loaded');\r\n }\r\n };\r\n\r\n return {handleXCheckoutClick};\r\n}\r\n"],"names":["useRef","useEffect"],"mappings":";;;;AAKwB,SAAA,YAAY,CAAC,EAAC,MAAM,EAAE,SAAS,EAAqB,EAAA;AAC1E,IAAA,MAAM,YAAY,GAAGA,YAAM,CAA4B,IAAI,CAAC,CAAC;IAE7DC,eAAS,CAAC,MAAK;QACb,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;AAChD,QAAA,MAAM,CAAC,GAAG,GAAG,SAAS,CAAC;AACvB,QAAA,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC;AACpB,QAAA,MAAM,CAAC,MAAM,GAAG,MAAK;AACnB,YAAA,YAAY,CAAC,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC;AACxC,YAAA,YAAY,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;AACzC,SAAC,CAAC;AACF,QAAA,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;AAElC,QAAA,OAAO,MAAK;AACV,YAAA,IAAI,YAAY,CAAC,OAAO,KAAK,IAAI,IAAI,OAAO,YAAY,CAAC,OAAO,CAAC,OAAO,KAAK,UAAU,EAAE;AACvF,gBAAA,YAAY,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;AAC/B,gBAAA,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC;AAC7B,aAAA;AACD,YAAA,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;AACpC,SAAC,CAAC;AACJ,KAAC,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;IAExB,MAAM,oBAAoB,GAAG,MAAW;AACtC,QAAA,IAAI,YAAY,CAAC,OAAO,KAAK,IAAI,EAAE;AACjC,YAAA,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;AAC5B,SAAA;AAAM,aAAA;AACL,YAAA,OAAO,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;AACrD,SAAA;AACH,KAAC,CAAC;IAEF,OAAO,EAAC,oBAAoB,EAAC,CAAC;AAChC;;;;"} \ No newline at end of file +{"version":3,"file":"index.js","sources":["../libs/use-x-checkout.ts"],"sourcesContent":["import {useEffect, useRef, useState} from 'react';\nimport type {\n XCheckoutRefProps,\n XCheckoutHooksReturnProps,\n UseXCheckoutProps,\n XCheckoutConfigProps,\n} from './types';\n\n/**\n * Custom hook for integrating Korba XCheckout into a React component.\n *\n * @param scriptSrc - The source URL of the XCheckout script.\n * @returns An object containing the `pay` function and a boolean indicating whether XCheckout is loaded.\n *\n * @example\n * import { useXCheckout } from 'react-korba-payment';\n *\n * const { pay, isXCheckoutLoaded } = useXCheckout({ scriptSrc: 'https://paywithkorba.s3-eu-west-1.amazonaws.com/test-checkout.js' }); // replace with your XCheckout script URL\n *\n * @see UseXCheckoutProps\n * @see XCheckoutHooksReturnProps\n *\n * @see [Package Documentation](https://github.com/eben92/react-korba-payment#readme)\n * @see [Korba Documentation](https://xchange.korba365.com/docs/#xcheckout)\n */\nexport default function useXCheckout({scriptSrc}: UseXCheckoutProps): XCheckoutHooksReturnProps {\n const xCheckoutRef = useRef(null);\n const [isXCheckoutLoaded, setIsXCheckoutLoaded] = useState(false);\n\n useEffect(() => {\n const script = document.createElement('script');\n script.src = scriptSrc;\n script.async = true;\n script.onload = () => {\n xCheckoutRef.current = window.XCheckout;\n };\n\n const handleScriptLoad = () => {\n xCheckoutRef.current = window.XCheckout;\n setIsXCheckoutLoaded(true);\n };\n\n script.addEventListener('load', handleScriptLoad);\n document.head.appendChild(script);\n\n return () => {\n if (xCheckoutRef.current !== null && typeof xCheckoutRef.current.destroy === 'function') {\n xCheckoutRef.current.destroy();\n xCheckoutRef.current = null;\n }\n document.head.removeChild(script);\n\n setIsXCheckoutLoaded(false);\n };\n }, []);\n\n /**\n * Executes the XCheckout process with the provided configuration.\n * If the XCheckout library is not yet loaded, a warning message is logged.\n * @param config - The configuration object for XCheckout.\n * @returns void\n * @example\n * const config = {\n * merchantID: 'merchant-id', // your merchant ID.\n * orderID: 'order-id', // unique order ID\n * description: 'description', // optional\n * amount: 100, // in GH₵\n * redirectURL: 'https://example.com/redirect',\n * };\n * onXCheckout(config);\n * @see XCheckoutConfigProps\n *\n */\n const pay = (config: XCheckoutConfigProps): void => {\n if (xCheckoutRef.current !== null) {\n xCheckoutRef.current.configure(config);\n\n xCheckoutRef.current.pay();\n return;\n }\n\n console.warn('XCheckout library is not yet loaded');\n };\n\n return {pay, isXCheckoutLoaded};\n}\n"],"names":["useRef","useState","useEffect"],"mappings":";;;;AAQA;;;;;;;;;;;;;;;;AAgBG;AACW,SAAU,YAAY,CAAC,EAAC,SAAS,EAAoB,EAAA;AACjE,IAAA,MAAM,YAAY,GAAGA,YAAM,CAA2B,IAAI,CAAC,CAAC;IAC5D,MAAM,CAAC,iBAAiB,EAAE,oBAAoB,CAAC,GAAGC,cAAQ,CAAC,KAAK,CAAC,CAAC;IAElEC,eAAS,CAAC,MAAK;QACb,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;AAChD,QAAA,MAAM,CAAC,GAAG,GAAG,SAAS,CAAC;AACvB,QAAA,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC;AACpB,QAAA,MAAM,CAAC,MAAM,GAAG,MAAK;AACnB,YAAA,YAAY,CAAC,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC;AAC1C,SAAC,CAAC;QAEF,MAAM,gBAAgB,GAAG,MAAK;AAC5B,YAAA,YAAY,CAAC,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC;YACxC,oBAAoB,CAAC,IAAI,CAAC,CAAC;AAC7B,SAAC,CAAC;AAEF,QAAA,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;AAClD,QAAA,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;AAElC,QAAA,OAAO,MAAK;AACV,YAAA,IAAI,YAAY,CAAC,OAAO,KAAK,IAAI,IAAI,OAAO,YAAY,CAAC,OAAO,CAAC,OAAO,KAAK,UAAU,EAAE;AACvF,gBAAA,YAAY,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;AAC/B,gBAAA,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC;aAC7B;AACD,YAAA,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YAElC,oBAAoB,CAAC,KAAK,CAAC,CAAC;AAC9B,SAAC,CAAC;KACH,EAAE,EAAE,CAAC,CAAC;AAEP;;;;;;;;;;;;;;;;AAgBG;AACH,IAAA,MAAM,GAAG,GAAG,CAAC,MAA4B,KAAU;AACjD,QAAA,IAAI,YAAY,CAAC,OAAO,KAAK,IAAI,EAAE;AACjC,YAAA,YAAY,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;AAEvC,YAAA,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;YAC3B,OAAO;SACR;AAED,QAAA,OAAO,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;AACtD,KAAC,CAAC;AAEF,IAAA,OAAO,EAAC,GAAG,EAAE,iBAAiB,EAAC,CAAC;AAClC;;;;"} \ No newline at end of file diff --git a/dist/types.d.ts b/dist/types.d.ts index a0c9a27..7eb374e 100644 --- a/dist/types.d.ts +++ b/dist/types.d.ts @@ -1,24 +1,24 @@ -export type ICheckoutConfigProps = { +export type XCheckoutConfigProps = { merchantID: string; orderID: string; - description: string; + description?: string; amount: number; redirectURL: string; }; -export type TXCheckoutRefProps = { - configure: (config: ICheckoutConfigProps) => void; +export type XCheckoutRefProps = { + configure: (config: XCheckoutConfigProps) => void; pay: () => void; destroy: () => void; }; -export interface ICheckoutHooksProps { - handleXCheckoutClick: () => void; +export interface XCheckoutHooksReturnProps { + pay: (config: XCheckoutConfigProps) => void; + isXCheckoutLoaded: boolean; } declare global { interface Window { - XCheckout: TXCheckoutRefProps; + XCheckout: XCheckoutRefProps; } } -export type TUseXCheckoutProps = { - config: ICheckoutConfigProps; +export type UseXCheckoutProps = { scriptSrc: string; }; diff --git a/dist/use-x-checkout.d.ts b/dist/use-x-checkout.d.ts index c17260e..ead6b13 100644 --- a/dist/use-x-checkout.d.ts +++ b/dist/use-x-checkout.d.ts @@ -1,2 +1,19 @@ -import type { ICheckoutHooksProps, TUseXCheckoutProps } from './types'; -export default function useXCheckout({ config, scriptSrc }: TUseXCheckoutProps): ICheckoutHooksProps; +import type { XCheckoutHooksReturnProps, UseXCheckoutProps } from './types'; +/** + * Custom hook for integrating Korba XCheckout into a React component. + * + * @param scriptSrc - The source URL of the XCheckout script. + * @returns An object containing the `pay` function and a boolean indicating whether XCheckout is loaded. + * + * @example + * import { useXCheckout } from 'react-korba-payment'; + * + * const { pay, isXCheckoutLoaded } = useXCheckout({ scriptSrc: 'https://paywithkorba.s3-eu-west-1.amazonaws.com/test-checkout.js' }); // replace with your XCheckout script URL + * + * @see UseXCheckoutProps + * @see XCheckoutHooksReturnProps + * + * @see [Package Documentation](https://github.com/eben92/react-korba-payment#readme) + * @see [Korba Documentation](https://xchange.korba365.com/docs/#xcheckout) + */ +export default function useXCheckout({ scriptSrc }: UseXCheckoutProps): XCheckoutHooksReturnProps; diff --git a/examples/nextjs-13/.eslintrc.json b/examples/nextjs-13/.eslintrc.json deleted file mode 100644 index bffb357..0000000 --- a/examples/nextjs-13/.eslintrc.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "extends": "next/core-web-vitals" -} diff --git a/examples/nextjs-13/.gitignore b/examples/nextjs-13/.gitignore deleted file mode 100644 index 409853c..0000000 --- a/examples/nextjs-13/.gitignore +++ /dev/null @@ -1,41 +0,0 @@ -# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. - -# dependencies -/node_modules -/.pnp -.pnp.js - -# testing -/coverage - -# next.js -/.next/ -/out/ - -# production -/build - -# misc -.DS_Store -*.pem - -# debug -npm-debug.log* -yarn-debug.log* -yarn-error.log* -.pnpm-debug.log* - -# local env files -.env*.local - -# vercel -.vercel - -# typescript -*.tsbuildinfo -next-env.d.ts - -.vscode -package-lock.json -yarn.lock -yarn-error.log \ No newline at end of file diff --git a/examples/nextjs-13/README.md b/examples/nextjs-13/README.md deleted file mode 100644 index 5bc7ca2..0000000 --- a/examples/nextjs-13/README.md +++ /dev/null @@ -1,38 +0,0 @@ -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). - -## Getting Started - -First, run the development server: - -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -``` - -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. - -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. - -[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`. - -The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages. - -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. - -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. - -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! - -## Deploy on Vercel - -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. - -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. diff --git a/examples/nextjs-13/app/CheckoutButton.tsx b/examples/nextjs-13/app/CheckoutButton.tsx deleted file mode 100644 index 00496cb..0000000 --- a/examples/nextjs-13/app/CheckoutButton.tsx +++ /dev/null @@ -1,22 +0,0 @@ -'use client'; -import styles from './page.module.css'; -import {useXCheckout} from 'react-korba-payment'; - -export default function CheckoutButton() { - const {handleXCheckoutClick} = useXCheckout({ - config: { - merchantID: '', - orderID: '', - description: 'Ordered goods', - amount: 1.2, - redirectURL: 'http://www.yourawesomeapp.com', - }, - scriptSrc: 'https://paywithkorba.s3-eu-west-1.amazonaws.com/test-checkout.js', - }); - - return ( - - ); -} diff --git a/examples/nextjs-13/app/api/hello/route.ts b/examples/nextjs-13/app/api/hello/route.ts deleted file mode 100644 index d1cc6ee..0000000 --- a/examples/nextjs-13/app/api/hello/route.ts +++ /dev/null @@ -1,3 +0,0 @@ -export async function GET(request: Request) { - return new Response('Hello, Next.js!') -} diff --git a/examples/nextjs-13/app/favicon.ico b/examples/nextjs-13/app/favicon.ico deleted file mode 100644 index 718d6fe..0000000 Binary files a/examples/nextjs-13/app/favicon.ico and /dev/null differ diff --git a/examples/nextjs-13/app/globals.css b/examples/nextjs-13/app/globals.css deleted file mode 100644 index d4f491e..0000000 --- a/examples/nextjs-13/app/globals.css +++ /dev/null @@ -1,107 +0,0 @@ -:root { - --max-width: 1100px; - --border-radius: 12px; - --font-mono: ui-monospace, Menlo, Monaco, 'Cascadia Mono', 'Segoe UI Mono', - 'Roboto Mono', 'Oxygen Mono', 'Ubuntu Monospace', 'Source Code Pro', - 'Fira Mono', 'Droid Sans Mono', 'Courier New', monospace; - - --foreground-rgb: 0, 0, 0; - --background-start-rgb: 214, 219, 220; - --background-end-rgb: 255, 255, 255; - - --primary-glow: conic-gradient( - from 180deg at 50% 50%, - #16abff33 0deg, - #0885ff33 55deg, - #54d6ff33 120deg, - #0071ff33 160deg, - transparent 360deg - ); - --secondary-glow: radial-gradient( - rgba(255, 255, 255, 1), - rgba(255, 255, 255, 0) - ); - - --tile-start-rgb: 239, 245, 249; - --tile-end-rgb: 228, 232, 233; - --tile-border: conic-gradient( - #00000080, - #00000040, - #00000030, - #00000020, - #00000010, - #00000010, - #00000080 - ); - - --callout-rgb: 238, 240, 241; - --callout-border-rgb: 172, 175, 176; - --card-rgb: 180, 185, 188; - --card-border-rgb: 131, 134, 135; -} - -@media (prefers-color-scheme: dark) { - :root { - --foreground-rgb: 255, 255, 255; - --background-start-rgb: 0, 0, 0; - --background-end-rgb: 0, 0, 0; - - --primary-glow: radial-gradient(rgba(1, 65, 255, 0.4), rgba(1, 65, 255, 0)); - --secondary-glow: linear-gradient( - to bottom right, - rgba(1, 65, 255, 0), - rgba(1, 65, 255, 0), - rgba(1, 65, 255, 0.3) - ); - - --tile-start-rgb: 2, 13, 46; - --tile-end-rgb: 2, 5, 19; - --tile-border: conic-gradient( - #ffffff80, - #ffffff40, - #ffffff30, - #ffffff20, - #ffffff10, - #ffffff10, - #ffffff80 - ); - - --callout-rgb: 20, 20, 20; - --callout-border-rgb: 108, 108, 108; - --card-rgb: 100, 100, 100; - --card-border-rgb: 200, 200, 200; - } -} - -* { - box-sizing: border-box; - padding: 0; - margin: 0; -} - -html, -body { - max-width: 100vw; - overflow-x: hidden; -} - -body { - color: rgb(var(--foreground-rgb)); - background: linear-gradient( - to bottom, - transparent, - rgb(var(--background-end-rgb)) - ) - rgb(var(--background-start-rgb)); -} - -a { - color: inherit; - text-decoration: none; -} - -@media (prefers-color-scheme: dark) { - html { - color-scheme: dark; - } -} diff --git a/examples/nextjs-13/app/layout.tsx b/examples/nextjs-13/app/layout.tsx deleted file mode 100644 index 3d9d723..0000000 --- a/examples/nextjs-13/app/layout.tsx +++ /dev/null @@ -1,18 +0,0 @@ -import './globals.css' - -export const metadata = { - title: 'Create Next App', - description: 'Generated by create next app', -} - -export default function RootLayout({ - children, -}: { - children: React.ReactNode -}) { - return ( - - {children} - - ) -} diff --git a/examples/nextjs-13/app/page.module.css b/examples/nextjs-13/app/page.module.css deleted file mode 100644 index 144e09e..0000000 --- a/examples/nextjs-13/app/page.module.css +++ /dev/null @@ -1,20 +0,0 @@ -.main { - display: flex; - flex-direction: column; - justify-content: center; - align-items: center; - padding: 6rem; - min-height: 100vh; -} - -.button { - background: #646cff; - border: 0; - border-radius: 0.5rem; - color: #fff; - cursor: pointer; - font-size: 1.5rem; - font-weight: 600; - padding: 1rem 2rem; - transition: background 300ms; -} diff --git a/examples/nextjs-13/app/page.tsx b/examples/nextjs-13/app/page.tsx deleted file mode 100644 index 7d704b1..0000000 --- a/examples/nextjs-13/app/page.tsx +++ /dev/null @@ -1,10 +0,0 @@ -import styles from './page.module.css'; -import CheckoutButton from './CheckoutButton'; - -export default function Home() { - return ( -
- -
- ); -} diff --git a/examples/nextjs-13/next.config.js b/examples/nextjs-13/next.config.js deleted file mode 100644 index dafb0c8..0000000 --- a/examples/nextjs-13/next.config.js +++ /dev/null @@ -1,8 +0,0 @@ -/** @type {import('next').NextConfig} */ -const nextConfig = { - experimental: { - appDir: true, - }, -} - -module.exports = nextConfig diff --git a/examples/nextjs-13/package.json b/examples/nextjs-13/package.json deleted file mode 100644 index dad6d05..0000000 --- a/examples/nextjs-13/package.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "name": "nextjs-13", - "version": "0.1.0", - "private": true, - "scripts": { - "dev": "next dev", - "build": "next build", - "start": "next start", - "lint": "next lint" - }, - "dependencies": { - "@types/node": "18.16.0", - "@types/react": "18.0.38", - "@types/react-dom": "18.0.11", - "eslint": "8.39.0", - "eslint-config-next": "13.3.1", - "next": "13.3.1", - "react": "18.2.0", - "react-dom": "18.2.0", - "react-korba-payment": "^0.0.8", - "typescript": "5.0.4" - } -} diff --git a/examples/nextjs-13/public/next.svg b/examples/nextjs-13/public/next.svg deleted file mode 100644 index 5174b28..0000000 --- a/examples/nextjs-13/public/next.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/examples/nextjs-13/public/thirteen.svg b/examples/nextjs-13/public/thirteen.svg deleted file mode 100644 index 8977c1b..0000000 --- a/examples/nextjs-13/public/thirteen.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/examples/nextjs-13/public/vercel.svg b/examples/nextjs-13/public/vercel.svg deleted file mode 100644 index d2f8422..0000000 --- a/examples/nextjs-13/public/vercel.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/examples/nextjs-13/tsconfig.json b/examples/nextjs-13/tsconfig.json deleted file mode 100644 index e06a445..0000000 --- a/examples/nextjs-13/tsconfig.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "compilerOptions": { - "target": "es5", - "lib": ["dom", "dom.iterable", "esnext"], - "allowJs": true, - "skipLibCheck": true, - "strict": true, - "forceConsistentCasingInFileNames": true, - "noEmit": true, - "esModuleInterop": true, - "module": "esnext", - "moduleResolution": "node", - "resolveJsonModule": true, - "isolatedModules": true, - "jsx": "preserve", - "incremental": true, - "plugins": [ - { - "name": "next" - } - ], - "paths": { - "@/*": ["./*"] - } - }, - "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"], - "exclude": ["node_modules"] -} diff --git a/examples/reactjs/package.json b/examples/reactjs/package.json index 2b5fa93..f17c6de 100644 --- a/examples/reactjs/package.json +++ b/examples/reactjs/package.json @@ -12,7 +12,7 @@ "dependencies": { "react": "^18.2.0", "react-dom": "^18.2.0", - "react-korba-payment": "^0.0.8" + "react-korba-payment": "latest" }, "devDependencies": { "@types/react": "^18.0.28", @@ -26,4 +26,4 @@ "typescript": "^5.0.2", "vite": "^4.3.0" } -} +} \ No newline at end of file diff --git a/examples/reactjs/src/App.tsx b/examples/reactjs/src/App.tsx index 0466d5d..7773c26 100644 --- a/examples/reactjs/src/App.tsx +++ b/examples/reactjs/src/App.tsx @@ -2,20 +2,24 @@ import {useXCheckout} from 'react-korba-payment'; import './App.css'; function App() { - const {handleXCheckoutClick} = useXCheckout({ - config: { - merchantID: '', - orderID: '', - description: 'Ordered goods', - amount: 1.2, - redirectURL: 'http://www.yourawesomeapp.com', - }, - scriptSrc: 'https://paywithkorba.s3-eu-west-1.amazonaws.com/test-checkout.js', + const {pay} = useXCheckout({ + scriptSrc: 'https://paywithkorba.s3-eu-west-1.amazonaws.com/test-checkout.js', // replace with your XCheckout script URL }); return (
-
diff --git a/libs/types.ts b/libs/types.ts index 53b22e6..1b8233b 100644 --- a/libs/types.ts +++ b/libs/types.ts @@ -1,28 +1,72 @@ -export type ICheckoutConfigProps = { +export type XCheckoutConfigProps = { + /** + * Your merchant ID. + * @see [Korba Documentation](https://xchange.korba365.com/docs/#xcheckout) + */ merchantID: string; + + /** + * Unique order ID. + */ orderID: string; - description: string; + + /** + * Optional description of the order. + */ + description?: string; + + /** + * The amount to be paid in GH₵. + */ amount: number; + + /** + * The URL to redirect to after payment. + */ redirectURL: string; }; -export type TXCheckoutRefProps = { - configure: (config: ICheckoutConfigProps) => void; +export type XCheckoutRefProps = { + configure: (config: XCheckoutConfigProps) => void; pay: () => void; destroy: () => void; }; -export interface ICheckoutHooksProps { - handleXCheckoutClick: () => void; +export interface XCheckoutHooksReturnProps { + /** + * Executes the XCheckout process with the provided configuration. + * If the XCheckout library is not yet loaded, a warning message is logged. + * @param config - The configuration object for XCheckout. + * @returns void + * @example + * const config = { + * merchantID: 'merchant-id', // your merchant ID. + * orderID: 'order-id', // unique order ID + * description: 'description', // optional + * amount: 100, // in GH₵ + * redirectURL: 'https://example.com/redirect', + * }; + * onXCheckout(config); + * @see XCheckoutConfigProps + */ + pay: (config: XCheckoutConfigProps) => void; + + /** + * A boolean flag indicating whether the XCheckout library is loaded. + */ + isXCheckoutLoaded: boolean; } declare global { interface Window { - XCheckout: TXCheckoutRefProps; + XCheckout: XCheckoutRefProps; } } -export type TUseXCheckoutProps = { - config: ICheckoutConfigProps; +export type UseXCheckoutProps = { + /** + * The URL of the XCheckout script. + * @see [Korba Documentation](https://xchange.korba365.com/docs/#xcheckout) + */ scriptSrc: string; }; diff --git a/libs/use-x-checkout.ts b/libs/use-x-checkout.ts new file mode 100644 index 0000000..8c92aaf --- /dev/null +++ b/libs/use-x-checkout.ts @@ -0,0 +1,85 @@ +import {useEffect, useRef, useState} from 'react'; +import type { + XCheckoutRefProps, + XCheckoutHooksReturnProps, + UseXCheckoutProps, + XCheckoutConfigProps, +} from './types'; + +/** + * Custom hook for integrating Korba XCheckout into a React component. + * + * @param scriptSrc - The source URL of the XCheckout script. + * @returns An object containing the `pay` function and a boolean indicating whether XCheckout is loaded. + * + * @example + * import { useXCheckout } from 'react-korba-payment'; + * + * const { pay, isXCheckoutLoaded } = useXCheckout({ scriptSrc: 'https://paywithkorba.s3-eu-west-1.amazonaws.com/test-checkout.js' }); // replace with your XCheckout script URL + * + * @see UseXCheckoutProps + * @see XCheckoutHooksReturnProps + * + * @see [Package Documentation](https://github.com/eben92/react-korba-payment#readme) + * @see [Korba Documentation](https://xchange.korba365.com/docs/#xcheckout) + */ +export default function useXCheckout({scriptSrc}: UseXCheckoutProps): XCheckoutHooksReturnProps { + const xCheckoutRef = useRef(null); + const [isXCheckoutLoaded, setIsXCheckoutLoaded] = useState(false); + + useEffect(() => { + const script = document.createElement('script'); + script.src = scriptSrc; + script.async = true; + script.onload = () => { + xCheckoutRef.current = window.XCheckout; + }; + + const handleScriptLoad = () => { + xCheckoutRef.current = window.XCheckout; + setIsXCheckoutLoaded(true); + }; + + script.addEventListener('load', handleScriptLoad); + document.head.appendChild(script); + + return () => { + if (xCheckoutRef.current !== null && typeof xCheckoutRef.current.destroy === 'function') { + xCheckoutRef.current.destroy(); + xCheckoutRef.current = null; + } + document.head.removeChild(script); + + setIsXCheckoutLoaded(false); + }; + }, []); + + /** + * Executes the XCheckout process with the provided configuration. + * If the XCheckout library is not yet loaded, a warning message is logged. + * @param config - The configuration object for XCheckout. + * @returns void + * @example + * const config = { + * merchantID: 'merchant-id', // your merchant ID. + * orderID: 'order-id', // unique order ID + * description: 'description', // optional + * amount: 100, // in GH₵ + * redirectURL: 'https://example.com/redirect', + * }; + * onXCheckout(config); + * @see XCheckoutConfigProps + */ + const pay = (config: XCheckoutConfigProps): void => { + if (xCheckoutRef.current !== null) { + xCheckoutRef.current.configure(config); + + xCheckoutRef.current.pay(); + return; + } + + console.warn('XCheckout library is not yet loaded'); + }; + + return {pay, isXCheckoutLoaded}; +} diff --git a/libs/use-x-checkout.tsx b/libs/use-x-checkout.tsx deleted file mode 100644 index 31f1e4d..0000000 --- a/libs/use-x-checkout.tsx +++ /dev/null @@ -1,35 +0,0 @@ -import {useEffect, useRef} from 'react'; -import type {TXCheckoutRefProps, ICheckoutHooksProps, TUseXCheckoutProps} from './types'; - -export default function useXCheckout({config, scriptSrc}: TUseXCheckoutProps): ICheckoutHooksProps { - const xcheckoutRef = useRef(null); - - useEffect(() => { - const script = document.createElement('script'); - script.src = scriptSrc; - script.async = true; - script.onload = () => { - xcheckoutRef.current = window.XCheckout; - xcheckoutRef.current.configure(config); - }; - document.head.appendChild(script); - - return () => { - if (xcheckoutRef.current !== null && typeof xcheckoutRef.current.destroy === 'function') { - xcheckoutRef.current.destroy(); - xcheckoutRef.current = null; - } - document.head.removeChild(script); - }; - }, [config, scriptSrc]); - - const handleXCheckoutClick = (): void => { - if (xcheckoutRef.current !== null) { - xcheckoutRef.current.pay(); - } else { - console.warn('XCheckout library is not yet loaded'); - } - }; - - return {handleXCheckoutClick}; -} diff --git a/package.json b/package.json index 3c83055..4b24fd1 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "react-korba-payment", - "version": "0.0.7", + "version": "0.1.2", "description": "ReactJS library for korba payment gateway", "main": "dist/index.js", "module": "dist/index.es.js", @@ -19,7 +19,7 @@ }, "repository": { "type": "git", - "url": "git+https://github.com/rhutmann/react-korba-payment.git" + "url": "git+https://github.com/eben92/react-korba-payment.git" }, "keywords": [ "Javascript", @@ -28,6 +28,7 @@ "Open Source", "payments", "korba", + "korba checkout", "korba payment", "react korba payment", "react korba payment npm", @@ -39,9 +40,9 @@ "author": "\"eben\",", "license": "ISC", "bugs": { - "url": "https://github.com/rhutmann/react-korba-payment/issues" + "url": "https://github.com/eben92/react-korba-payment/issues" }, - "homepage": "https://github.com/rhutmann/react-korba-payment#readme", + "homepage": "https://github.com/eben92/react-korba-payment#readme", "peerDependencies": { "react": "^16.0.0 || ^17.0.0 || ^18.0.0", "react-dom": "^16.0.0 || ^17.0.0 || ^18.0.0" @@ -83,4 +84,4 @@ "ts-jest": "^29.1.0", "typescript": "^5.0.3" } -} +} \ No newline at end of file diff --git a/rollup.config.js b/rollup.config.js index ee364a8..b85803d 100644 --- a/rollup.config.js +++ b/rollup.config.js @@ -11,22 +11,22 @@ export default { file: pkg.main, format: 'cjs', exports: 'named', - sourcemap: true + sourcemap: true, }, { file: pkg.module, format: 'es', exports: 'named', - sourcemap: true - } + sourcemap: true, + }, ], plugins: [ external(), resolve(), typescript({ rollupCommonJSResolveHack: true, - clean: true + clean: true, }), - commonjs() - ] + commonjs(), + ], };