@neocash/bnpl-widget 0.1.1

package/dist/types.d.ts

@@ -0,0 +1,195 @@
+export interface CartItem {
+    name: string;
+    qty: number;
+    /** Unit price in **kobo**. e.g. ₦2,000 → 200000 */
+    price: number;
+    imageUrl?: string;
+}
+export interface Cart {
+    items: CartItem[];
+    /** Cart total in **kobo**. e.g. ₦240,000 → 24000000 */
+    total: number;
+    currency?: string;
+}
+export interface PartnerPrefill {
+    firstName?: string;
+    lastName?: string;
+    phone?: string;
+    email?: string;
+    bvn?: string;
+    employer?: string;
+    role?: string;
+    /** Monthly salary in **kobo**. e.g. ₦850,000 → 85000000 */
+    monthlySalary?: number;
+    officeAddress?: string;
+    homeAddress?: string;
+}
+export interface InitOptions {
+    publicKey: string;
+    cart: Cart;
+    partnerPrefill?: PartnerPrefill;
+    container?: HTMLElement | string;
+    onClose?: () => void;
+    onApprovalPending?: (applicationId: string) => void;
+    onError?: (err: Error) => void;
+    /** Internal staging override. Not part of the stable public API. */
+    apiBase?: string;
+    /**
+     * Where the lazy-loaded Amplify Liveness chunk lives. Defaults to the
+     * directory of the main script (captured from document.currentScript at
+     * load time). Set explicitly when serving the chunk from a different
+     * origin or path.
+     */
+    assetPrefix?: string;
+}
+export interface WidgetHandle {
+    close: () => void;
+}
+export type CartMode = 'hold' | 'release';
+export interface MerchantInfo {
+    name: string;
+    cart_mode: CartMode;
+}
+export type InterestType = 'flat' | 'reducing_balance';
+export interface SessionConfig {
+    /** Monthly interest rate on the financed amount, e.g. 0.05 = 5%. */
+    monthly_interest_rate: number;
+    /** How interest is computed across the tenure. */
+    interest_type: InterestType;
+    /** Processing fee, as a fraction of the cart total, e.g. 0.015 = 1.5%. */
+    processing_fee_rate: number;
+    /** Minimum financeable amount in **kobo**. */
+    min_amount_kobo: number;
+    /** Maximum financeable amount in **kobo**. */
+    max_amount_kobo: number;
+    /** Repayment-term bounds, in days. */
+    min_tenure_days: number;
+    max_tenure_days: number;
+    /** Minimum fraction of the cart the borrower must pay today, e.g. 0.20. */
+    min_pay_now_rate: number;
+    /** Discrete term choices for the tenure slider, in days. */
+    tenure_day_options: number[];
+}
+export interface Bank {
+    code: string;
+    name: string;
+}
+export interface CreateSessionRequest {
+    public_key: string;
+    cart: Cart;
+    partner_prefill?: PartnerPrefill;
+}
+export interface CreateSessionResponse {
+    session_token: string;
+    merchant: MerchantInfo;
+    config: SessionConfig;
+    banks: Bank[];
+    prefill: PartnerPrefill;
+}
+export interface SendOtpResponse {
+    resend_after_seconds: number;
+}
+export interface VerifyOtpResponse {
+    verified: boolean;
+    attempts_left?: number;
+}
+export interface AwsCredentials {
+    accessKeyId: string;
+    secretAccessKey: string;
+    sessionToken: string;
+    /** ISO-8601 timestamp at which the credentials expire. */
+    expiration: string;
+}
+export interface LivenessStartResponse {
+    rekognition_session_id: string;
+    region: string;
+    /**
+     * Present only for live-mode merchants. STS-vended, scoped to
+     * `rekognition:StartFaceLivenessSession`, ~15 min TTL. Test-mode merchants
+     * (rekognition_session_id starts with "rl-test-") get no credentials and
+     * the widget routes to its in-process placeholder.
+     */
+    credentials?: AwsCredentials;
+}
+export interface LivenessResultRequest {
+    rekognition_session_id: string;
+}
+export type CustomerStatus = 'new' | 'returning';
+export interface LivenessResultResponse {
+    passed: boolean;
+    attempts_left?: number;
+    customer_status?: CustomerStatus;
+}
+export interface CustomerProfile {
+    first_name: string;
+    last_name: string;
+    email: string;
+    phone: string;
+    bvn_masked: string;
+    employer: string;
+    role: string;
+    /** Monthly salary in **kobo** (wire value; divide by 100 before displaying). */
+    monthly_salary: number;
+    office_address: string;
+    home_address: string;
+}
+export interface CreditCheckResponse {
+    status: 'approved' | 'declined';
+    reason?: string;
+    requires?: ('employment_update' | 'bank_statement')[];
+}
+export interface IdentityRequest {
+    first_name: string;
+    last_name: string;
+    email: string;
+    bvn: string;
+}
+export interface IdentityResponse {
+    status: 'pass' | 'cant_offer' | 'cant_verify';
+    reasons?: string[];
+}
+export interface IdentityStatusResponse {
+    face_match: 'pending' | 'pass' | 'fail';
+}
+export interface EmploymentRequest {
+    employer: string;
+    role: string;
+    /** Monthly salary in **kobo**. Widget converts from the naira the user typed. */
+    monthly_salary: number;
+    office_address: string;
+    home_address: string;
+    location?: {
+        lat: number;
+        lng: number;
+        accuracy?: number;
+    };
+}
+export interface MonoLinkTokenResponse {
+    public_key: string;
+    /** Mono customer id (cus_*). Created server-side via Mono's Create Customer API. */
+    customer_ref: string;
+    /**
+     * Unique reference for this linking attempt. Backend stores
+     * `reference → session_id` so it can stitch the Mono webhook
+     * back to the BNPL session when the user completes linking.
+     */
+    reference: string;
+    scope: string[];
+}
+export interface FinalizeRequest {
+    email: string;
+    /** Repayment term the customer picked, in days. */
+    tenure_days: number;
+    /** Amount the customer chose to finance (cart total − pay-now), in **kobo**. */
+    financed_kobo: number;
+}
+export interface FinalizeResponse {
+    application_id: string;
+    status: 'pending_review';
+    est_decision_seconds: number;
+}
+export interface ApiErrorShape {
+    code?: string;
+    status?: number;
+    retryable?: boolean;
+}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@neocash/bnpl-widget",
+  "version": "0.1.1",
+  "description": "Embeddable NeoCash BNPL checkout widget",
+  "license": "UNLICENSED",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "unpkg": "dist/neocash-bnpl.iife.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "node build.mjs",
+    "build:all": "npm run build && npm run types",
+    "watch": "node build.mjs --watch",
+    "types": "tsc",
+    "prepack": "npm run build:all",
+    "size": "gzip -c dist/neocash-bnpl.iife.js | wc -c"
+  },
+  "dependencies": {
+    "preact": "^10.22.0"
+  },
+  "devDependencies": {
+    "@aws-amplify/ui-react": "^6.5.0",
+    "@aws-amplify/ui-react-liveness": "^3.2.0",
+    "@types/react": "^18.3.0",
+    "@types/react-dom": "^18.3.0",
+    "aws-amplify": "^6.6.0",
+    "esbuild": "^0.24.0",
+    "react": "^18.3.0",
+    "react-dom": "^18.3.0",
+    "typescript": "^5.6.0"
+  }
+}