@temboplus/tembo-dashboard 0.0.1

package/dist/modules/payout/payout.model.d.ts

@@ -0,0 +1,156 @@
+import { Amount, AmountJson, Bank } from "@temboplus/frontend-core";
+import { BANK_PAYOUT_CHANNEL, MOBILE_PAYOUT_CHANNEL, PAYOUT_CHANNEL, PAYOUT_STATUS } from "./payout.dtos";
+export interface PayoutStatusInfo {
+    label: string;
+    description: string;
+    category: "success" | "pending" | "failed";
+    color: "success" | "warning" | "error";
+    userFriendlyMessage: string;
+}
+export declare const PAYOUT_STATUS_INFO: Record<PAYOUT_STATUS, PayoutStatusInfo>;
+export interface MobileChannelInfo {
+    networkOperator: string;
+    serviceName: string;
+}
+export declare const MOBILE_CHANNEL_INFO: Record<MOBILE_PAYOUT_CHANNEL, MobileChannelInfo>;
+export declare function isMobileChannel(channel: PAYOUT_CHANNEL): channel is MOBILE_PAYOUT_CHANNEL;
+export declare function isBankChannel(channel: PAYOUT_CHANNEL): channel is BANK_PAYOUT_CHANNEL;
+export declare function getFailedStatuses(): PAYOUT_STATUS[];
+export interface PayoutData {
+    id: string;
+    serviceCode: PAYOUT_CHANNEL;
+    msisdn: string;
+    amount: number;
+    transactionDate: string;
+    statusDescription: string;
+    statusCodeText: PAYOUT_STATUS;
+    transactionId: string;
+    transactionRef: string;
+    recipientNames?: string;
+    narration: string;
+    serviceFee?: number;
+    notes?: string;
+    swiftCode?: string;
+    createdAt: string;
+    updatedAt: string;
+    statusCode: string;
+    countryCode: string;
+    postedAmount?: string;
+    walletId?: string;
+    currencyCode: string;
+    externalId?: string | null;
+    cbaReferenceNo?: string;
+    beepTransactionId?: string;
+    receiptNumber?: string;
+    reversedTransactionId?: string | null;
+    serviceFeeTransactionId?: string;
+    isReconciled?: number;
+    requestId?: string;
+}
+export interface PayoutJson {
+    id: string;
+    serviceCode: PAYOUT_CHANNEL;
+    msisdn: string;
+    amount: AmountJson;
+    transactionDate: string;
+    statusDescription: string;
+    statusCodeText: PAYOUT_STATUS;
+    transactionId: string;
+    transactionRef: string;
+    recipientNames?: string;
+    narration: string;
+    serviceFee?: AmountJson;
+    notes?: string;
+    swiftCode?: string;
+    createdAt: string;
+    updatedAt: string;
+    statusCode: string;
+    countryCode: string;
+    postedAmount?: AmountJson;
+    walletId?: string;
+    currencyCode: string;
+    externalId?: string | null;
+    cbaReferenceNo?: string;
+    beepTransactionId?: string;
+    receiptNumber?: string;
+    reversedTransactionId?: string | null;
+    serviceFeeTransactionId?: string;
+    isReconciled?: number;
+    requestId?: string;
+}
+/**
+ * Represents a payout transaction
+ */
+export declare class Payout {
+    readonly id: string;
+    readonly serviceCode: PAYOUT_CHANNEL;
+    readonly msisdn: string;
+    readonly amount: Amount;
+    readonly transactionDate: Date;
+    readonly statusDescription: string;
+    readonly statusCodeText: PAYOUT_STATUS;
+    readonly transactionId: string;
+    readonly transactionRef: string;
+    readonly recipientNames?: string;
+    readonly narration: string;
+    readonly serviceFee?: Amount;
+    readonly notes?: string;
+    readonly swiftCode?: string;
+    readonly createdAt: Date;
+    readonly updatedAt: Date;
+    readonly statusCode: string;
+    readonly countryCode: string;
+    readonly postedAmount?: Amount;
+    readonly walletId?: string;
+    readonly currencyCode: string;
+    readonly externalId?: string | null;
+    readonly cbaReferenceNo?: string;
+    readonly beepTransactionId?: string;
+    readonly receiptNumber?: string;
+    readonly reversedTransactionId?: string | null;
+    readonly serviceFeeTransactionId?: string;
+    readonly isReconciled?: number;
+    readonly requestId?: string;
+    constructor(data: PayoutData);
+    /**
+     * Check if payout is pending
+     */
+    isPending(): boolean;
+    /**
+     * Check if payout was successful
+     */
+    isSuccessful(): boolean;
+    /**
+     * Check if payout failed
+     */
+    isFailed(): boolean;
+    /**
+     * Get status color and label
+     */
+    getStatusInfo(): PayoutStatusInfo;
+    /**
+     * Get channel information with bank detection for bank transfers
+     */
+    getChannelInfo(): MobileChannelInfo | Bank | undefined;
+    /**
+     * Get provider name from channel
+     */
+    getProviderName(): string;
+    /**
+     * Create Payout instance from raw API data
+     */
+    static from(data: any): Payout | undefined;
+    static createMany(dataArray: any[]): Payout[];
+    /**
+     * Create Payout instance from JSON representation (with Amount objects serialized)
+     */
+    static fromJson(json: PayoutJson): Payout | undefined;
+    /**
+     * Create multiple Payout instances from JSON array
+     */
+    static createManyFromJson(jsonArray: PayoutJson[]): Payout[];
+    /**
+     * Convert to JSON representation with proper typing
+     */
+    toJson(): PayoutJson;
+}

package/dist/modules/payout/payout.query-builder.d.ts

@@ -0,0 +1,15 @@
+import { QueryBuilder } from "@/lib/query";
+import { PAYOUT_STATUS, PAYOUT_CHANNEL, PayoutQueryParamsDTO } from "./payout.dtos";
+/**
+ * Specialized query builder for payout queries
+ */
+export declare class PayoutQueryBuilder extends QueryBuilder {
+    whereStatus(status: PAYOUT_STATUS): this;
+    whereChannel(channel: PAYOUT_CHANNEL): this;
+    wherePending(): this;
+    whereSuccessful(): this;
+    whereFailed(): this;
+    whereAmountBetween(min: number, max: number): this;
+    whereRecipient(msisdn: string): this;
+    toPayoutQuery(): PayoutQueryParamsDTO;
+}

package/dist/modules/payout/payout.repository.d.ts

@@ -0,0 +1,34 @@
+import { BaseRepository, PaginationDTO } from "@/lib/api";
+import { payoutContract } from "./payout.api-contract";
+import { type PayoutQueryParamsDTO } from "./payout.dtos";
+import { Payout } from "./payout.model";
+import { WalletInfo, TransactionSummary } from "@/lib/models";
+/**
+ * Repository class for managing payouts through API interactions.
+ * Handles payout operations, filtering, and transaction management.
+ */
+export declare class PayoutRepository extends BaseRepository<typeof payoutContract> {
+    constructor(options?: {
+        token?: string;
+        root?: string;
+    });
+    /**
+     * Get all payouts with filtering and pagination
+     */
+    getPayouts(query?: PayoutQueryParamsDTO): Promise<{
+        payouts: Payout[];
+        pagination: PaginationDTO;
+    }>;
+    /**
+     * Get a specific payout by ID
+     */
+    getPayout(id: string): Promise<Payout>;
+    /**
+     * Get payout summary statistics
+     */
+    getPayoutSummary(): Promise<TransactionSummary>;
+    /**
+     * Get account balance and status information
+     */
+    getAccountBalance(): Promise<WalletInfo>;
+}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@temboplus/tembo-dashboard",
+  "version": "0.0.1",
+  "description": "A foundational library for Temboplus-Dashboard projects providing type-safe data layer abstraction with API contracts, domain models, and repositories.",
+  "main": "./dist/index.cjs.js",
+  "module": "./dist/index.esm.js",
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.esm.js",
+      "require": "./dist/index.cjs.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "rollup -c rollup.config.js",
+    "prepare": "npm run build",
+    "dev": "npm run build -- --watch",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TemboPlus-Frontend/tembo-dashboard-js.git"
+  },
+  "keywords": [
+    "temboplus",
+    "tembo-dashboard"
+  ],
+  "author": "Okello Gerald",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/TemboPlus-Frontend/tembo-dashboard-js/issues"
+  },
+  "homepage": "https://github.com/TemboPlus-Frontend/tembo-dashboard-js#readme",
+  "peerDependencies": {
+    "@temboplus/frontend-core": "^0.2.11",
+    "@ts-rest/core": "^3.52.1",
+    "tslib": "^2.8.1",
+    "uuid": "^11.1.0",
+    "zod": "^3.24.2"
+  },
+  "devDependencies": {
+    "@rollup/plugin-alias": "^5.1.1",
+    "@rollup/plugin-commonjs": "^28.0.3",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^12.1.3",
+    "@types/jest": "^29.5.14",
+    "jest": "^29.7.0",
+    "rollup": "^4.39.0",
+    "ts-jest": "^29.3.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.3"
+  }
+}