@buzztech/boi-ui 0.2.0

package/dist/composables/useEdocBanks.d.ts

@@ -0,0 +1,53 @@
+import { EdocBank } from '../types/edoc';
+export interface UseEdocBanksOptions {
+    get: (url: string) => Promise<{
+        data?: unknown;
+    }>;
+    /** Path or absolute URL; or a getter so it stays in sync with props (e.g. integration base URL). */
+    getBanksUrl?: string | (() => string);
+    fallbackBanksUrl?: string | (() => string);
+}
+export declare function useEdocBanks(options: UseEdocBanksOptions): {
+    edocBanks: import('vue').Ref<{
+        bankId: number;
+        name: string;
+        icon?: string | undefined;
+        bankCode: string;
+        code?: string | undefined;
+        enabled?: boolean | undefined;
+        mandateEnabled?: boolean | undefined;
+        bankInstructions?: string[] | undefined;
+    }[], EdocBank[] | {
+        bankId: number;
+        name: string;
+        icon?: string | undefined;
+        bankCode: string;
+        code?: string | undefined;
+        enabled?: boolean | undefined;
+        mandateEnabled?: boolean | undefined;
+        bankInstructions?: string[] | undefined;
+    }[]>;
+    banks: import('vue').Ref<{
+        bankId: number;
+        name: string;
+        icon?: string | undefined;
+        bankCode: string;
+        code?: string | undefined;
+        enabled?: boolean | undefined;
+        mandateEnabled?: boolean | undefined;
+        bankInstructions?: string[] | undefined;
+    }[], EdocBank[] | {
+        bankId: number;
+        name: string;
+        icon?: string | undefined;
+        bankCode: string;
+        code?: string | undefined;
+        enabled?: boolean | undefined;
+        mandateEnabled?: boolean | undefined;
+        bankInstructions?: string[] | undefined;
+    }[]>;
+    loading: import('vue').Ref<boolean, boolean>;
+    error: import('vue').Ref<string | null, string | null>;
+    loadBanksForStatement: () => Promise<EdocBank[]>;
+    invalidateCache: () => void;
+};

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+import { App } from 'vue';
+export { default as BoiButton } from './components/BoiButton.vue';
+export { default as Button } from './components/Button.vue';
+export { default as EmtsIntegration } from './components/EmtsIntegration.vue';
+export { default as BankStatementIntegration } from './components/BankStatementIntegration.vue';
+export { default as BankSelect } from './components/BankSelect.vue';
+export { default as FileInput } from './components/FileInput.vue';
+export { useEdocBanks } from './composables/useEdocBanks';
+export type { UseEdocBanksOptions } from './composables/useEdocBanks';
+export { useAccountVerification } from './composables/useAccountVerification';
+export type { VerifyBankAccountFn, VerificationState } from './composables/useAccountVerification';
+export { edocApi } from './api/edoc';
+export type { EdocApi } from './api/edoc';
+export { bankStatementsApi, bankStatementsUrls } from './api/bankStatements';
+export { filesApi } from './api/files';
+export type { EdocBank, BankStatementRecord, EdocConsentInitializePayload, EdocAttachAccountPayload, EdocGetTransactionsPayload, BankOption, IndustrialSectorOption, } from './types/edoc';
+export declare function install(_app: App): void;
+declare const _default: {
+    install: typeof install;
+};
+export default _default;

package/dist/lib/utils.d.ts

@@ -0,0 +1 @@
+export declare function cn(...classes: Array<any>): string;

package/dist/types/edoc.d.ts

@@ -0,0 +1,73 @@
+export interface EdocBank {
+    bankId: number;
+    name: string;
+    icon?: string;
+    bankCode: string;
+    code?: string;
+    enabled?: boolean;
+    mandateEnabled?: boolean;
+    bankInstructions?: string[];
+}
+export interface BankStatementRecord {
+    id: number;
+    loan_application_id?: number;
+    bank: string;
+    account_number: string;
+    account_name?: string;
+    account_type?: string;
+    bvn?: string;
+    email: string;
+    bank_statement?: string;
+    /**
+     * Client-only: S3 key for the uploaded PDF used for “View document”.
+     * Kept when API/poll sets `bank_statement` to the EDOC CSV object key.
+     */
+    uploaded_statement_path?: string;
+    /** Presigned or public URL from API (Boi BankStatement $appends) */
+    bank_statement_view_url?: string | null;
+    csv_url?: string;
+    csv_view_url?: string | null;
+    consent_id?: string;
+    edoc_status: 'pending' | 'processing' | 'completed' | 'failed';
+    statement_generated: boolean;
+    otp?: string;
+    showOtpInput?: boolean;
+}
+export interface EdocConsentInitializePayload {
+    email: string;
+    firstName: string;
+    lastName: string;
+    statementDuration?: string;
+    redirectionUrl?: string;
+    referenceId?: string;
+    state?: string;
+    fundType?: string;
+    industrialSector?: string;
+}
+export interface EdocAttachAccountPayload {
+    consentId: string;
+    bankId: number;
+    accountNumber: string;
+    accountType?: string;
+    statementDuration?: string;
+    monthType?: string;
+    uploadType?: string;
+}
+export interface EdocGetTransactionsPayload {
+    consentId: string;
+    verificationCode?: string;
+    bankStatementId?: number;
+}
+export interface BankOption {
+    value: string;
+    label: string;
+    /** Shown in search (e.g. FCMB); also include in searchKeywords if you only pass one */
+    shortName?: string;
+    searchKeywords?: string[];
+}
+export interface IndustrialSectorOption {
+    value: string | number;
+    label?: string;
+    name?: string;
+    id?: string | number;
+}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@buzztech/boi-ui",
+  "publishConfig": {
+    "access": "public"
+  },
+  "version": "0.2.0",
+  "description": "BOI Vue 3 TypeScript UI package",
+  "type": "module",
+  "keywords": [
+    "vue",
+    "vue3",
+    "typescript",
+    "boi",
+    "edoc",
+    "bank-statements"
+  ],
+  "homepage": "https://github.com/BuzzTechnics/boi-ui#readme",
+  "bugs": {
+    "url": "https://github.com/BuzzTechnics/boi-ui/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/BuzzTechnics/boi-ui.git"
+  },
+  "main": "./dist/boi-ui.umd.cjs",
+  "module": "./dist/boi-ui.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/boi-ui.js",
+      "require": "./dist/boi-ui.umd.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "dev": "vite",
+    "prepublishOnly": "npm run build",
+    "build": "vue-tsc -b && vite build",
+    "type-check": "vue-tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "peerDependencies": {
+    "vue": "^3.4.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "@vitejs/plugin-vue": "^5.0.0",
+    "@vue/test-utils": "^2.4.0",
+    "happy-dom": "^15.11.0",
+    "typescript": "~5.6.0",
+    "vite": "^6.0.0",
+    "vite-plugin-dts": "^4.0.0",
+    "vitest": "^2.0.0",
+    "vue": "^3.4.0",
+    "vue-tsc": "^2.0.0"
+  }
+}