@simplipayng/checkout 0.0.1-security → 1.4.3

package/dist/types.d.ts

@@ -0,0 +1,117 @@
+/**
+ * Configuration for SimpliPay Checkout
+ */
+export interface SimpliPayConfig {
+    /** Your SimpliPay public key */
+    publicKey: string;
+    /** Environment: 'development' | 'production' */
+    environment?: 'development' | 'production';
+    /** Custom API base URL (optional) */
+    baseUrl?: string;
+}
+/**
+ * Payment data for checkout
+ */
+export interface PaymentData {
+    /** Organization ID from SimpliPay */
+    organizationId: string;
+    /** Customer email address */
+    email: string;
+    /** Customer phone number (with country code, e.g., +2348012345678) */
+    phone: string;
+    /** Payment amount */
+    amount: number;
+    /** Currency code (e.g., 'NGN') */
+    currency: string;
+    /** Unique transaction reference */
+    transactionRef: string;
+    /** Your customer's unique identifier */
+    customerId: string;
+    /** Service ID for the payment */
+    serviceId?: string;
+    /** Payment narration/description */
+    narration?: string;
+    /** Merchant/business name to display */
+    merchantName?: string;
+    /** Additional metadata */
+    metadata?: Record<string, any>;
+}
+/**
+ * Callback functions for checkout events
+ */
+export interface CheckoutCallbacks {
+    /** Called when payment is successful */
+    onSuccess: (result: TransactionResult) => void;
+    /** Called when payment fails */
+    onError: (error: TransactionError) => void;
+    /** Called when user closes the checkout */
+    onClose: () => void;
+    /** Called before payment initiation (optional) */
+    onBeforePayment?: () => void | Promise<void>;
+}
+/**
+ * Transaction result on successful payment
+ */
+export interface TransactionResult {
+    success: true;
+    transactionRef: string;
+    message: string;
+    amount: number;
+    currency: string;
+    paymentMethod: string;
+    responseCode?: string;
+}
+/**
+ * Transaction error
+ */
+export interface TransactionError {
+    success: false;
+    message: string;
+    code?: string;
+    transactionRef?: string;
+}
+/**
+ * Props for SimpliPayCheckout component
+ */
+export interface SimpliPayCheckoutProps {
+    /** Whether to show the checkout modal */
+    isOpen: boolean;
+    /** Payment data */
+    paymentData: PaymentData;
+    /** SimpliPay configuration */
+    config: SimpliPayConfig;
+    /** Callback functions */
+    callbacks: CheckoutCallbacks;
+}
+/**
+ * Internal checkout state
+ */
+export type CheckoutStep = 'card' | 'pin' | 'otp' | 'success' | 'error';
+export interface CardDetails {
+    pan: string;
+    expiryDate: string;
+    cvv: string;
+}
+export interface TransactionRequest {
+    organizationId: string;
+    transactionRef: string;
+    customerId: string;
+    customerEmail: string;
+    customerPhone: string;
+    amount: number;
+    currency: string;
+    paymentMethod: 'CARD' | 'BANK' | 'USSD';
+    serviceId?: string;
+    authData: string;
+    narration?: string;
+}
+export interface OtpAuthRequest {
+    transactionRef: string;
+    otp: string;
+}
+export interface ApiResponse {
+    success: boolean;
+    message: string;
+    data?: any;
+    responseCode?: string;
+}

package/dist/utils/api.d.ts

@@ -0,0 +1,6 @@
+import { AxiosInstance } from 'axios';
+import { SimpliPayConfig, TransactionRequest, OtpAuthRequest, ApiResponse } from '../types';
+export declare const createApiClient: (config: SimpliPayConfig) => AxiosInstance;
+export declare const initiatePayment: (client: AxiosInstance, payload: TransactionRequest) => Promise<ApiResponse>;
+export declare const verifyOtp: (client: AxiosInstance, payload: OtpAuthRequest) => Promise<ApiResponse>;
+export declare const resendOtp: (client: AxiosInstance, transactionRef: string) => Promise<ApiResponse>;

package/dist/utils/encryption.d.ts

@@ -0,0 +1,10 @@
+export interface AuthDataParams {
+    version: string;
+    pan: string;
+    pin: string;
+    expiryDate: string;
+    cvv: string;
+}
+export declare const generateAuthData: ({ version, pan, pin, expiryDate, cvv, }: AuthDataParams) => Promise<string>;
+export declare const formatExpiryForApi: (expiry: string) => string;
+export declare const cleanPan: (pan: string) => string;

package/dist/utils/validation.d.ts

@@ -0,0 +1,14 @@
+import * as Yup from 'yup';
+export declare const cardFormSchema: Yup.ObjectSchema<{
+    pan: string;
+    expiryDate: string;
+    cvv: string;
+}, Yup.AnyObject, {
+    pan: undefined;
+    expiryDate: undefined;
+    cvv: undefined;
+}, "">;
+export type CardType = 'visa' | 'mastercard' | 'verve' | 'unknown';
+export declare const detectCardType: (cardNumber: string) => CardType;
+export declare const formatCardNumber: (value: string) => string;
+export declare const formatExpiryDate: (value: string) => string;

package/package.json

@@ -1,6 +1,94 @@
 {
   "name": "@simplipayng/checkout",
-  "version": "0.0.1-security",
-  "description": "security holding package",
-  "repository": "npm/security-holder"
+  "version": "1.4.3",
+  "type": "module",
+  "description": "SimpliPay Checkout - A React component for accepting card payments",
+  "main": "dist/index.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "keywords": [
+    "simplipay",
+    "checkout",
+    "payment",
+    "react",
+    "card-payment",
+    "nigeria",
+    "fintech"
+  ],
+  "author": "SimpliPay",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/simplipayng/checkout.git"
+  },
+  "homepage": "https://simplipay.ng",
+  "peerDependencies": {
+    "react": ">=17.0.0",
+    "react-dom": ">=17.0.0"
+  },
+  "dependencies": {
+    "axios": "^1.6.2",
+    "formik": "^2.4.5",
+    "node-forge": "^1.3.1",
+    "react-bootstrap": "^2.10.10",
+    "react-otp-input": "^3.1.0",
+    "react-query": "^3.39.3",
+    "react-router-dom": "^7.10.1",
+    "react-spinners-kit": "^1.9.1",
+    "react-toastify": "^9.1.3",
+    "web-vitals": "^5.1.0",
+    "yup": "^1.4.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^25.0.8",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^15.3.1",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@testing-library/jest-dom": "^5.17.0",
+    "@testing-library/react": "^13.4.0",
+    "@testing-library/user-event": "^13.5.0",
+    "@types/jest": "^27.5.2",
+    "@types/node": "^16.18.65",
+    "@types/react": "^18.2.39",
+    "@types/react-dom": "^18.2.17",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-scripts": "5.0.1",
+    "rollup": "^4.53.3",
+    "rollup-plugin-dts": "^6.3.0",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
+    "rollup-plugin-postcss": "^4.0.2",
+    "sass": "^1.69.5",
+    "typescript": "^4.9.5"
+  },
+  "scripts": {
+    "start": "react-scripts start",
+    "build": "rollup -c",
+    "build:demo": "react-scripts build",
+    "test": "react-scripts test",
+    "prepublishOnly": "npm run build",
+    "lint": "eslint src --ext .ts,.tsx"
+  },
+  "eslintConfig": {
+    "extends": [
+      "react-app",
+      "react-app/jest"
+    ]
+  },
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  }
 }