react-nomba-checkout-sdk 1.0.0

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "react-nomba-checkout-sdk",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "rm -rf dist && rollup -c --bundleConfigAsCjs",
+    "build:watch": "rm -rf dist && rollup -c --watch --bundleConfigAsCjs",
+    "format": "prettier --write '**/**/*.{js,}'",
+    "lint": "eslint .",
+    "lint:fix": "npm run lint -- --fix",
+    "test": "jest --env=jsdom",
+    "test:watch": "jest --watch --verbose --env=jsdom"
+  },
+  "keywords": [],
+  "author": "Israel Itua",
+  "license": "ISC",
+  "description": "Nomba checkout sdk for react apps.",
+  "peerDependencies": {
+    "react": "^15.0.0 || ^16.0.0 || ^17.0.0 || ^18.0.0",
+    "react-dom": "^15.0.0 || ^16.0.0 || ^17.0.0 || ^18.0.0"
+  },
+  "dependencies": {
+    "axios": "^1.7.9",
+    "react": "^15.0.0 || ^16.0.0 || ^17.0.0 || ^18.0.0",
+    "react-dom": "^15.0.0 || ^16.0.0 || ^17.0.0 || ^18.0.0",
+    "react-test-renderer": "^18.3.1",
+    "rollup-plugin-postcss": "^4.0.2",
+    "styled-components": "^6.1.14"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.25.2",
+    "@babel/preset-env": "^7.25.3",
+    "@babel/preset-typescript": "^7.24.7",
+    "@eslint/js": "^9.8.0",
+    "@rollup/plugin-commonjs": "^28.0.2",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^16.0.0",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@testing-library/react": "^16.0.0",
+    "@testing-library/react-hooks": "^8.0.1",
+    "@types/jest": "^29.5.12",
+    "@types/react": "^18.3.3",
+    "@types/react-dom": "^18.3.0",
+    "@typescript-eslint/eslint-plugin": "^6.17.0",
+    "@typescript-eslint/parser": "^6.17.0",
+    "babel-eslint": "^10.1.0",
+    "babel-jest": "^29.5.0",
+    "eslint": "^9.8.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-config-standard": "^17.0.0",
+    "eslint-plugin-jest": "^28.7.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-react": "^7.35.0",
+    "globals": "^15.9.0",
+    "jest": "^29.5.0",
+    "jest-environment-jsdom": "^29.5.0",
+    "prettier": "^3.3.3",
+    "rollup": "^4.20.0",
+    "rollup-plugin-babel": "^4.4.0",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
+    "rollup-plugin-typescript2": "^0.36.0",
+    "ts-jest": "^29.2.4",
+    "typescript": "^5.5.4",
+    "typescript-eslint": "^8.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kudi-inc/react-nomba-checkout-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/kudi-inc/react-nomba-checkout-sdk/issues"
+  },
+  "homepage": "https://github.com/kudi-inc/react-nomba-checkout-sdk#readme"
+}

package/rollup.config.js

@@ -0,0 +1,43 @@
+import typescript from "rollup-plugin-typescript2";
+import commonjs from "@rollup/plugin-commonjs";
+import external from "rollup-plugin-peer-deps-external";
+import resolve from "@rollup/plugin-node-resolve";
+import postcss from "rollup-plugin-postcss";
+import json from "@rollup/plugin-json";
+import pkg from "./package.json";
+
+export default {
+  input: "src/index.tsx",
+  output: [
+    {
+      file: pkg.main,
+      format: "cjs",
+      exports: "named",
+      sourcemap: true,
+    },
+    {
+      file: pkg.module,
+      format: "es",
+      exports: "named",
+      sourcemap: true,
+    },
+  ],
+  plugins: [
+    external(),
+    resolve({
+      browser: true,
+      preferBuiltins: false,
+    }),
+    json(),
+    typescript({
+      clean: true,
+    }),
+    commonjs(),
+    postcss({
+      extract: true,
+      modules: true,
+      minimize: true,
+      sourceMap: true,
+    }),
+  ],
+};

package/src/apis/handleApiCall.ts

@@ -0,0 +1,20 @@
+import axios from "axios";
+
+export const handleApiCall = async (
+  url: string,
+  method: string,
+  body?: {} | null,
+  customHeaders?: { [key: string]: string }
+) => {
+  const options = {
+    method: method,
+    headers: {
+      "content-type": "application/json",
+      ...customHeaders,
+    },
+    data: body && body,
+    url: `https://vendor-api.kudi.ai/v1${url}`,
+  };
+  const response = await axios(options);
+  return response;
+};

package/src/apis/useCardCheckout.ts

@@ -0,0 +1,35 @@
+import { handleApiCall } from "./handleApiCall";
+
+interface CardCheckoutPayload {
+  orderReference: string;
+  cardDetails: string;
+  saveCard?: boolean;
+  accountId?: string;
+}
+
+export const useCardCheckout = async (payload: CardCheckoutPayload) => {
+  try {
+    const response = await handleApiCall(
+      "/checkout/checkout-card-detail",
+      "POST",
+      {
+        ...payload,
+        key: "",
+        deviceInformation: {
+          httpBrowserLanguage: navigator.language,
+          httpBrowserJavaEnabled: "true",
+          httpBrowserJavaScriptEnabled: "true",
+          httpBrowserColorDepth: window.screen.colorDepth.toString(),
+          httpBrowserScreenHeight: window.screen.height.toString(),
+          httpBrowserScreenWidth: window.screen.width.toString(),
+          httpBrowserTimeDifference: new Date().getTimezoneOffset().toString(),
+          userAgentBrowserValue: navigator.userAgent,
+          deviceChannel: "Browser",
+        },
+      }
+    );
+    return response.data;
+  } catch (error: any) {
+    return error;
+  }
+};

package/src/apis/useCardCheckoutOtp.ts

@@ -0,0 +1,21 @@
+import { handleApiCall } from "./handleApiCall";
+
+interface OtpRequest {
+  otp: string;
+  orderReference: string | undefined;
+  transactionId?: string | undefined;
+  accountId?: string;
+}
+
+export const useCardCheckoutOtp = async (payload: OtpRequest) => {
+  try {
+    const response = await handleApiCall(
+      "/checkout/checkout-card-otp",
+      "POST",
+      payload
+    );
+    return response.data;
+  } catch (error: any) {
+    return error;
+  }
+};

package/src/apis/useFetchUssdBanks.ts

@@ -0,0 +1,10 @@
+import { handleApiCall } from "./handleApiCall";
+
+export const useFetchUssdBanks = async () => {
+  try {
+    const response = await handleApiCall(`/checkout/ussd/banks`, "GET");
+    return response.data;
+  } catch (error: any) {
+    return error;
+  }
+};

package/src/apis/useGenerateQrCode.ts

@@ -0,0 +1,13 @@
+import { handleApiCall } from "./handleApiCall";
+
+export const useGenerateQrCode = async (orderReference: string) => {
+  try {
+    const response = await handleApiCall(
+      `/checkout/qr/${orderReference}`,
+      "GET"
+    );
+    return response.data;
+  } catch (error: any) {
+    return error;
+  }
+};

package/src/apis/useGetOrder.ts

@@ -0,0 +1,13 @@
+import { handleApiCall } from "./handleApiCall";
+
+export const useGetOrder = async (orderReference: string) => {
+  try {
+    const response = await handleApiCall(
+      `/checkout/order/${orderReference}`,
+      "GET"
+    );
+    return response.data;
+  } catch (error: any) {
+    return error;
+  }
+};

package/src/apis/useGetUssdCode.ts

@@ -0,0 +1,28 @@
+import { handleApiCall } from "./handleApiCall";
+
+interface UssdCodeRequest {
+  ussdBankId: string;
+  bankName: string;
+  bankCode: string;
+  processor: string;
+  processorCodeName: string;
+  ussdCodeFormat: string;
+  enabled: boolean;
+  promptMessage: string;
+}
+
+export const useGetUssdCode = async (payload: {
+  ussdCode: UssdCodeRequest;
+  orderId: string;
+}) => {
+  try {
+    const response = await handleApiCall(
+      `/checkout/ussd/code`,
+      "POST",
+      payload
+    );
+    return response.data;
+  } catch (error: any) {
+    return error;
+  }
+};

package/src/apis/useResendOtp.ts

@@ -0,0 +1,12 @@
+import { handleApiCall } from "./handleApiCall";
+
+export const useResendOtp = async (orderReference: string) => {
+  try {
+    const response = await handleApiCall("/checkout/resend-otp", "POST", {
+      orderReference,
+    });
+    return response.data;
+  } catch (error: any) {
+    return error;
+  }
+};

package/src/apis/useVerifyOrderStatus.ts

@@ -0,0 +1,14 @@
+import { handleApiCall } from "./handleApiCall";
+
+export const useVerifyOrderStatus = async (orderReference: string) => {
+  try {
+    const response = await handleApiCall(
+      "/checkout/confirm-transaction-receipt",
+      "POST",
+      { orderReference }
+    );
+    return response.data;
+  } catch (error: any) {
+    return error;
+  }
+};

package/src/assets/CloseIcon.tsx

@@ -0,0 +1,19 @@
+import React from "react";
+
+export const CloseIcon = () => (
+  <svg
+    width="32"
+    height="32"
+    viewBox="0 0 32 32"
+    fill="none"
+    xmlns="http://www.w3.org/2000/svg"
+  >
+    <rect width="32" height="32" rx="16" fill="#F2F2F2" fill-opacity="0.64" />
+    <path
+      fill-rule="evenodd"
+      clip-rule="evenodd"
+      d="M11.7646 11.7646C11.8948 11.6344 12.1059 11.6344 12.236 11.7646L16.0003 15.5289L19.7646 11.7646C19.8948 11.6344 20.1059 11.6344 20.236 11.7646C20.3662 11.8948 20.3662 12.1059 20.236 12.236L16.4717 16.0003L20.236 19.7646C20.3662 19.8948 20.3662 20.1059 20.236 20.236C20.1059 20.3662 19.8948 20.3662 19.7646 20.236L16.0003 16.4717L12.236 20.236C12.1059 20.3662 11.8948 20.3662 11.7646 20.236C11.6344 20.1059 11.6344 19.8948 11.7646 19.7646L15.5289 16.0003L11.7646 12.236C11.6344 12.1059 11.6344 11.8948 11.7646 11.7646Z"
+      fill="#0D0D0D"
+    />
+  </svg>
+);

package/src/assets/Loader.tsx

@@ -0,0 +1,18 @@
+import React from "react";
+
+const Loader = () => (
+  <svg
+    width="18"
+    height="21"
+    viewBox="0 0 18 21"
+    fill="none"
+    xmlns="http://www.w3.org/2000/svg"
+  >
+    <path
+      d="M10.3203 8.49095L12.002 7.47669L13.6836 6.46243L15.3652 5.44817L17.0468 4.43393V0.545959L15.3652 1.56021L13.6836 2.57447L12.002 3.58872L10.3203 4.60297L8.63871 5.6172V7.56118L6.95709 6.54697L5.27546 5.53271L3.50974 4.51845L1.82811 3.5042L0.146484 2.48994V6.37789L1.82811 7.39215L3.50974 8.40641L5.19136 9.42067L6.87298 10.4349L8.5546 11.4492L6.87298 12.4634L5.19136 13.4777L3.50974 14.4919L1.82811 15.5062L0.146484 16.3514V20.2394L1.82811 19.2251L3.50974 18.2108L5.19136 17.1966L6.87298 16.1824L8.5546 15.1681V13.2241L10.2362 14.2383L11.9179 15.2526L13.5995 16.2669L15.2811 17.2811L16.9628 18.2954V14.4074L15.2811 13.3932L13.5995 12.3789L11.9179 11.3646L10.2362 10.3504L8.5546 9.33613L10.3203 8.49095Z"
+      fill="#121212"
+    />
+  </svg>
+);
+
+export default Loader;

package/src/components/NombaCheckoutButton.tsx

@@ -0,0 +1,67 @@
+import React, { Component } from "react";
+import { NombaCheckoutModal } from "./NombaCheckoutModal";
+
+interface NombaCheckoutButtonProps {
+  orderId: string;
+  buttonText?: string;
+  buttonStyle?: React.CSSProperties;
+  children?: React.ReactNode;
+  onClose: () => void;
+}
+
+interface NombaCheckoutButtonState {
+  showModal: boolean;
+}
+
+class NombaCheckoutButton extends Component<
+  NombaCheckoutButtonProps,
+  NombaCheckoutButtonState
+> {
+  constructor(props: NombaCheckoutButtonProps) {
+    super(props);
+    this.state = {
+      showModal: false,
+    };
+  }
+
+  handleClose = () => {
+    this.setState({ showModal: false });
+    this.props.onClose?.();
+  };
+
+  render() {
+    const { orderId, children, buttonStyle, buttonText } = this.props;
+    const { showModal } = this.state;
+
+    return (
+      <div>
+        <button
+          style={buttonStyle || styles.button}
+          onClick={
+            showModal
+              ? () => this.handleClose()
+              : () => this.setState({ showModal: true })
+          }
+        >
+          {children || buttonText || "Pay with Nomba"}
+        </button>
+
+        {showModal && (
+          <NombaCheckoutModal orderId={orderId} onClose={this.handleClose} />
+        )}
+      </div>
+    );
+  }
+}
+const styles: { [key: string]: React.CSSProperties } = {
+  button: {
+    height: "48px",
+    width: "100%",
+    background: "#ffcc00",
+    fontSize: "16px",
+    fontWeight: 500,
+    borderRadius: "8px",
+  },
+};
+
+export { NombaCheckoutButton };

package/src/components/NombaCheckoutModal.tsx

@@ -0,0 +1,132 @@
+import React, { Component } from "react";
+import "../styles.css";
+import Loader from "../assets/Loader";
+import { CloseIcon } from "../assets/CloseIcon";
+
+interface NombaCheckoutModalProps {
+  orderId: string;
+  onClose: () => void;
+}
+
+interface NombaCheckoutModalState {
+  isLoading: boolean;
+}
+
+class NombaCheckoutModal extends Component<
+  NombaCheckoutModalProps,
+  NombaCheckoutModalState
+> {
+  constructor(props: NombaCheckoutModalProps) {
+    super(props);
+    this.state = {
+      isLoading: true,
+    };
+  }
+
+  handleClose = () => {
+    this.props.onClose?.();
+  };
+
+  handleIframeLoad = () => {
+    this.setState({ isLoading: false });
+  };
+
+  render() {
+    const { orderId } = this.props;
+    const { isLoading } = this.state;
+
+    return (
+      <div style={modalStyles.overlay} onClick={this.handleClose}>
+        <div style={modalStyles.modal} onClick={(e) => e.stopPropagation()}>
+          <div style={modalStyles.content}>
+            {isLoading && (
+              <div style={modalStyles.loader}>
+                <div className="spinner"></div>
+                <Loader />
+              </div>
+            )}
+
+            <button style={modalStyles.closeButton} onClick={this.handleClose}>
+              <CloseIcon />
+            </button>
+
+            <iframe
+              src={`https://checkout.nomba.com/pay/${orderId}`}
+              allow="clipboard-write clipboard-read"
+              width="100%"
+              height="80vh"
+              style={modalStyles.iframe}
+              title="Nomba checkout"
+              onLoad={this.handleIframeLoad}
+            />
+          </div>
+        </div>
+      </div>
+    );
+  }
+}
+
+const modalStyles: { [key: string]: React.CSSProperties } = {
+  overlay: {
+    position: "fixed",
+    top: 0,
+    left: 0,
+    right: 0,
+    bottom: 0,
+    backgroundColor: "rgba(0, 0, 0, 0.5)",
+    display: "flex",
+    justifyContent: "center",
+    alignItems: "center",
+    zIndex: 9999,
+  },
+  modal: {
+    backgroundColor: "white",
+    width: "100%",
+    maxWidth: "60vw",
+    borderRadius: "8px",
+    boxShadow: "0 4px 8px rgba(0, 0, 0, 0.1)",
+    position: "relative",
+    height: "600px",
+    maxHeight: "95vh",
+  },
+  header: {
+    position: "relative",
+    display: "flex",
+    justifyContent: "space-between",
+    alignItems: "center",
+  },
+  closeButton: {
+    position: "absolute",
+    top: "16px",
+    right: "16px",
+    border: "none",
+    background: "transparent",
+  },
+  content: {
+    position: "relative",
+  },
+  iframe: {
+    border: "none",
+    borderRadius: "8px",
+    width: "100%",
+    maxHeight: "95vh",
+    height: "600px",
+    display: "block",
+  },
+  loader: {
+    position: "absolute",
+    top: 0,
+    left: 0,
+    width: "100%",
+    height: "100%",
+    backgroundColor: "rgba(255, 255, 255, 0.8)",
+    display: "flex",
+    flexDirection: "column",
+    alignItems: "center",
+    justifyContent: "center",
+    fontSize: "18px",
+    fontWeight: "bold",
+  },
+};
+
+export { NombaCheckoutModal };

package/src/index.tsx

@@ -0,0 +1,24 @@
+import { NombaCheckoutButton } from "./components/NombaCheckoutButton";
+import { NombaCheckoutModal } from "./components/NombaCheckoutModal";
+
+import { useGetOrder } from "./apis/useGetOrder";
+import { useCardCheckout } from "./apis/useCardCheckout";
+import { useCardCheckoutOtp } from "./apis/useCardCheckoutOtp";
+import { useGenerateQrCode } from "./apis/useGenerateQrCode";
+import { useVerifyOrderStatus } from "./apis/useVerifyOrderStatus";
+import { useResendOtp } from "./apis/useResendOtp";
+import { useFetchUssdBanks } from "./apis/useFetchUssdBanks";
+import { useGetUssdCode } from "./apis/useGetUssdCode";
+
+export {
+  NombaCheckoutButton,
+  NombaCheckoutModal,
+  useGetOrder,
+  useCardCheckout,
+  useCardCheckoutOtp,
+  useResendOtp,
+  useGenerateQrCode,
+  useVerifyOrderStatus,
+  useFetchUssdBanks,
+  useGetUssdCode,
+};

package/src/styles.css

@@ -0,0 +1,14 @@
+.spinner {
+  width: 40px;
+  height: 40px;
+  border: 4px solid rgba(0, 0, 0, 0.1);
+  border-top-color: #000;
+  border-radius: 50%;
+  animation: spin 1s linear infinite;
+}
+
+@keyframes spin {
+  to {
+    transform: rotate(360deg);
+  }
+}

package/tsconfig.json

@@ -0,0 +1,80 @@
+{
+  "compilerOptions": {
+    /* Basic Options */
+    // "incremental": true,                   /* Enable incremental compilation */
+    "target": "es5" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */,
+    "module": "esnext" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */,
+    "lib": [
+      "es6",
+      "dom",
+      "es2016",
+      "es2017",
+      "esnext"
+    ] /* Specify library files to be included in the compilation. */,
+    "allowJs": false /* Allow javascript files to be compiled. */,
+    // "checkJs": true,                       /* Report errors in .js files. */
+    "jsx": "react" /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */,
+    "declaration": true /* Generates corresponding '.d.ts' file. */,
+    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    "sourceMap": true /* Generates corresponding '.map' file. */,
+    "outDir": "./dist" /* Redirect output structure to the directory. */,
+    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                     /* Enable project compilation */
+    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    "noEmit": true /* Do not emit outputs. */,
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    "isolatedModules": true /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */,
+    /* Strict Type-Checking Options */
+    "strict": true /* Enable all strict type-checking options. */,
+    "noImplicitAny": true /* Raise error on expressions and declarations with an implied 'any' type. */,
+    "strictNullChecks": true /* Enable strict null checks. */,
+    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    "noImplicitThis": true /* Raise error on 'this' expressions with an implied 'any' type. */,
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+    "skipLibCheck": true,
+    /* Additional Checks */
+    "noUnusedLocals": true /* Report errors on unused locals. */,
+    "noUnusedParameters": true /* Report errors on unused parameters. */,
+    "noImplicitReturns": true /* Report error when not all code paths in function return a value. */,
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+
+    /* Module Resolution Options */
+    "moduleResolution": "node" /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */,
+    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    // "types": [],                           /* Type declaration files to be included in compilation. */
+    "allowSyntheticDefaultImports": true /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */,
+    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+
+    /* Advanced Options */
+    "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
+  },
+  "include": ["src"],
+  "exclude": [
+    "node_modules",
+    "test",
+    "example",
+    "dist",
+    "**/*.spec.ts",
+    "rollup.config.js",
+    "build"
+  ]
+}