creditchek-react-sdk 1.0.0

package/README.md

@@ -0,0 +1,76 @@
+<p align="center">
+    <img title="CreeditChek" height="200" src="https://docs.creditchek.africa/img/nav_logo.svg" width="50%"/>
+</p>
+
+# CreditChek React SDK
+
+## Introduction
+
+The CreditChek Secured SDK Engine is a lightweight product that gives businesses access to a pool of CreditChek API services and a decision engine.
+
+The CreditChek Secured SDK Engine uses the same technology as our main application to allow your customers to carry out assessments. The customer assessments help you determine the decisions to make when they apply to your product. With our Secured SDK, you are able to customize the functionalities according to how you see fit for your business. The assessments carried out on this secured SDK includes:
+
+- Identity verification
+- Credit Bereau History search
+- Income Assessments
+- Automated immediate credit decision outcome
+
+
+## Installation
+
+Install the SDK
+
+```bash
+$ npm install creditchek-react-sdk
+
+# or
+$ yarn add creditchek-react-sdk
+
+```
+
+
+## Usage
+
+Add CreditChek SDK to your projects using the following simple guide:
+
+```javascript
+import creditchekSDK from 'creditchek-react-sdk';
+
+export default function App() {
+    const handleClick = () => {
+        creditchekSDK.open({
+        businessId: 'YOUR_BUSINESS_ID',
+        appId: "YOUR_APP_ID",
+        publicKey: "YOUR_APP_PUBLIC_KEY",
+        incomeForm: "XXXX", // short/long
+        module: ["xxxx"], 
+            onComplete: (result) => {
+                console.log("Result:", result);
+            },
+        });
+    };
+
+    return (
+        <div className="App">
+            <h1>CreditChek SDK Test</h1>
+            <button onClick={handleClick}>Launch SDK</button>
+        </div>
+    );
+}
+```
+
+
+## Parameters
+
+| Parameter           | Always Required ? | Description          |
+| ------------------- | ----------------- | ---------------------|
+| businessId          | True              | This is your Business ID and can be found in the top right corner after logging in to the CreditChek B2B portal |
+| appId               | True              | This is the ID of the app you want to connect for your SDK operations. It can be found on the app section on the B2B dashboard |
+| publicKey           | True              | This is the your API public key. It can be found on the app section of the dashboard. |
+| incomeForm          | False             | This determines whether users will need to fill additional information for income assessments. Default is "short", other option is "long". |
+| module              | True              | This is an array of strings that determine the layout of the SDK by module selection. At least one must be included. Options - "identity", "income", "credit", "recova" |
+
+
+# Support
+
+For additional assistance using this library, please create an issue on the Github repo or contact the team via [email](mailto:support@creditchek.africa).

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+type TModules = "identity" | "income" | "credit" | "recova";
+type CreditChekOptions = {
+    publicKey: string;
+    module: TModules[];
+    onComplete: () => void;
+};
+declare const creditchekSDK: {
+    open: ({ publicKey, module, onComplete }: CreditChekOptions) => void;
+};
+export default creditchekSDK;

package/dist/index.js

@@ -0,0 +1,18 @@
+var creditchekSDK = {
+    open: function (_a) {
+        var publicKey = _a.publicKey, module = _a.module, onComplete = _a.onComplete;
+        var url = "https://securedwidget.creditchek.africa/" +
+            "?publicKey=".concat(encodeURIComponent(publicKey || "")) +
+            "&module=".concat(module === null || module === void 0 ? void 0 : module.join(",")) +
+            "&source=react";
+        var win = window.open(url, '_blank');
+        // Simulated callback logic (for demo purposes)
+        var interval = setInterval(function () {
+            if (win === null || win === void 0 ? void 0 : win.closed) {
+                clearInterval(interval);
+                onComplete();
+            }
+        }, 500);
+    },
+};
+export default creditchekSDK;

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "creditchek-react-sdk",
+  "version": "1.0.0",
+  "description": "This is a react package to run assessments on creditchek",
+  "keywords": [],
+  "homepage": "https://github.com/Tibesti/creditchek-react-sdk#readme",
+  "bugs": {
+    "url": "https://github.com/Tibesti/creditchek-react-sdk/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Tibesti/creditchek-react-sdk.git"
+  },
+  "license": "ISC",
+  "author": "Tobiloba Olugbemi",
+  "type": "commonjs",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc"
+  },
+  "dependencies": {
+    "react": "^19.1.0"
+  },
+  "devDependencies": {
+    "@types/react": "^19.1.3",
+    "typescript": "^5.8.3"
+  }
+}

package/src/index.ts

@@ -0,0 +1,50 @@
+type TModules = "identity" | "income" | "credit" | "recova";
+type CreditChekOptions = {
+    publicKey: string;
+    module: TModules[];
+    onComplete: (result?: any) => void;
+    onClose?: () => void;
+    postMessageParam?: string;
+  };
+  
+  const creditchekSDK = {
+    open: ({ publicKey, module, onComplete, onClose, postMessageParam = "result" }: CreditChekOptions) => {
+      var url = 
+          "https://securedwidget.creditchek.africa/"+
+          `?publicKey=${encodeURIComponent(publicKey||"")}`+
+          `&module=${module?.join(",")}`+
+          `&source=react`;
+      const win = window.open(url, '_blank');
+  
+      // Listen for postMessage from the widget
+      const messageHandler = (event: MessageEvent) => {
+        // Verify origin for security
+        if (event.origin === 'https://securedwidget.creditchek.africa') {
+          if (event.data && typeof event.data === 'object') {
+            // Check if the specified parameter exists in the message
+            if (postMessageParam && event.data[postMessageParam] !== undefined) {
+              // Clean up listener
+              window.removeEventListener('message', messageHandler);
+              clearInterval(interval);
+              
+              // Pass the result to onComplete
+              onComplete(event.data);
+            }
+          }
+        }
+      };
+      
+      window.addEventListener('message', messageHandler);
+  
+      // Fallback: Check if window is closed (for demo purposes)
+      const interval = setInterval(() => {
+        if (win?.closed) {
+          clearInterval(interval);
+          window.removeEventListener('message', messageHandler);
+          onClose?.();
+        }
+      }, 500);
+    },
+  };
+  
+  export default creditchekSDK;

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+    "compilerOptions": {
+      "target": "ES5",
+      "module": "ESNext",
+      "lib": ["dom", "esnext"],
+      "declaration": true,
+      "outDir": "dist",
+      "strict": true,
+      "esModuleInterop": true,
+      "skipLibCheck": true,
+      "forceConsistentCasingInFileNames": true,
+      "moduleResolution": "node"
+    },
+    "include": ["src"]
+  }