@applite/duticotac 0.0.1

package/README.md

@@ -0,0 +1,155 @@
+# @applite/duticotac
+
+A lightweight JavaScript SDK for interacting with Duticotac platform APIs.
+
+## Installation
+
+```bash
+pnpm add @applite/duticotac
+```
+
+## Usage
+
+Each method accepts a **single object** that always includes `apiKey`, plus fields required by the specific route.
+
+### Instantiate the client
+
+```ts
+import { DuticotacSDK } from "@applite/duticotac";
+
+const duticotac = new DuticotacSDK({
+  baseUrl: "https://api.example.com", // optional, defaults to relative paths
+});
+```
+
+### Get balance
+
+```ts
+await duticotac.balance.balance({
+  apiKey: "api_key_abc",
+  appId: "app_123", // optional
+});
+```
+
+### Manage offers
+
+```ts
+// Create an offer
+await duticotac.offer.create({
+  apiKey: "api_key_abc",
+  appId: "app_123", // optional
+  name: "Offer Name",
+  ref: "offer-ref",
+  price: 1000,
+  platform: "DUTICOTAC",
+  type: "STATIC", // optional
+  description: "Offer description", // optional
+});
+
+// List offers
+await duticotac.offer.list({
+  apiKey: "api_key_abc",
+  appId: "app_123", // optional
+});
+
+// Get offer by reference
+await duticotac.offer.get({
+  apiKey: "api_key_abc",
+  ref: "offer-ref",
+  appId: "app_123", // optional
+});
+
+// Update offer
+await duticotac.offer.update({
+  apiKey: "api_key_abc",
+  ref: "offer-ref",
+  appId: "app_123", // optional
+  name: "Updated Name", // optional
+  price: 1500, // optional
+});
+
+// Delete offer
+await duticotac.offer.delete({
+  apiKey: "api_key_abc",
+  ref: "offer-ref",
+  appId: "app_123", // optional
+});
+```
+
+### Mobile money operations
+
+```ts
+// Cash in
+await duticotac.mobileMoney.cashin({
+  apiKey: "api_key_abc",
+  appId: "app_123", // optional
+  amount: 1000,
+  phone: "+2250700000000",
+  paymentMethod: "OM_CI",
+  password: "password123",
+});
+
+// Cash out
+await duticotac.mobileMoney.cashout({
+  apiKey: "api_key_abc",
+  appId: "app_123", // optional
+  transactionId: "txn_123",
+  ref: "ref_123",
+  phone: "+2250700000000",
+  name: "John Doe",
+  email: "john@example.com",
+  paymentMethod: "OM_CI",
+  amount: 1000, // optional
+  otp: "1234", // optional
+});
+```
+
+### Payment methods
+
+```ts
+// Get payment methods
+await duticotac.paymentMethod.get({
+  apiKey: "api_key_abc",
+  appId: "app_123", // optional
+});
+
+// Set payment methods
+await duticotac.paymentMethod.set({
+  apiKey: "api_key_abc",
+  appId: "app_123", // optional
+  providers: ["OM_CI", "MTN_CI"],
+});
+```
+
+### Webhooks
+
+```ts
+// Get webhook URL
+await duticotac.webhook.get({
+  apiKey: "api_key_abc",
+  appId: "app_123", // optional
+});
+
+// Set webhook URL
+await duticotac.webhook.set({
+  apiKey: "api_key_abc",
+  appId: "app_123", // optional
+  url: "https://example.com/webhook",
+});
+```
+
+### Transactions
+
+```ts
+// Get transaction
+await duticotac.transaction.get({
+  id: "transaction_id",
+});
+```
+
+## Scripts
+
+- `pnpm build` – build CJS/ESM bundles with type declarations.
+- `pnpm dev` – watch mode for development.
+- `pnpm test` – run the build with declaration output to validate types.
+

package/dist/index.d.mts

@@ -0,0 +1,291 @@
+interface HttpClientConfig {
+    /**
+     * Base URL used for every request.
+     * Defaults to `https://api.applite.freddydro.dev`.
+     */
+    baseUrl?: string;
+    /**
+     * Optional headers that should be sent with every request.
+     */
+    headers?: HeadersInit;
+    /**
+     * Custom fetch implementation for environments where the global fetch is
+     * not available or needs to be mocked during testing.
+     */
+    fetchFn?: typeof fetch;
+    /**
+     * API key injected into every request body automatically.
+     */
+    apiKey?: string;
+    /**
+     * Optional app ID injected into every request body automatically.
+     */
+    appId?: string | null;
+}
+interface ApiSuccessResponse<T> {
+    success: true;
+    data: T;
+    error?: unknown;
+}
+interface ApiErrorResponse {
+    success: false;
+    error?: unknown;
+}
+type ApiResponse<T> = ApiSuccessResponse<T> | ApiErrorResponse;
+declare class HttpClient {
+    private readonly baseUrl;
+    private readonly headers;
+    private readonly fetchImpl;
+    private readonly apiKey?;
+    private readonly appId?;
+    constructor(config?: HttpClientConfig);
+    post<T>(path: string, body: Record<string, unknown> | object): Promise<ApiSuccessResponse<T>>;
+}
+
+interface GetBalanceParams {
+    apiKey?: string;
+    appId?: string | null;
+}
+declare class BalanceModule {
+    private readonly http;
+    constructor(http: HttpClient);
+    balance(params?: GetBalanceParams): Promise<ApiSuccessResponse<number | null>>;
+}
+
+type TransactionStatus = "PENDING" | "CONFIRMED" | "CANCELLED" | "FAILED";
+type PlatformType = "STORE" | "TRANSPORT" | "RESTAURATION" | "MULTI_SERVICE" | "E_LEARNING" | "DUTICOTAC";
+type PaymentProvider = "CASH" | "OM_CI" | "MTN_CI" | "MOOV_CI" | "WAVE_CI" | "CREDIT_CARD" | "IAP";
+type Currency = "USD" | "EUR" | "XOF" | "XAF";
+type CoreApp = "XORAIA" | "MONSMSPRO" | "FREE";
+type DuTicOTacOfferType = "STATIC" | "DYNAMIC";
+/** @deprecated Use `PaymentProvider` instead */
+type PaymentMethod = PaymentProvider;
+/** @deprecated Use `PaymentProvider` instead */
+type TransactionProvider = PaymentProvider;
+/** @deprecated Use `PlatformType` instead */
+type PlateformType = PlatformType;
+
+interface OfferModel {
+    id: string;
+    name: string;
+    ref: string;
+    price: number;
+    description: string;
+    platform: string;
+    createdAt: string;
+    app: OfferAppModel;
+    _count: PaymentLinksCountModel;
+}
+interface OfferAppModel {
+    id: string;
+    duticotacSettings: DuticotacSettingModel[];
+}
+interface DuticotacSettingModel {
+    id: string;
+    providers: PaymentProvider[];
+}
+interface PaymentLinksCountModel {
+    paymentLinks: number;
+}
+
+interface CreateOfferParams {
+    apiKey?: string;
+    appId?: string | null;
+    name: string;
+    ref: string;
+    price: number;
+    platform: PlatformType;
+    type?: DuTicOTacOfferType;
+    description?: string | null;
+}
+interface ListOffersParams {
+    apiKey?: string;
+    appId?: string | null;
+}
+interface GetOfferByRefParams {
+    apiKey?: string;
+    ref: string;
+    appId?: string | null;
+}
+interface UpdateOfferParams {
+    apiKey?: string;
+    ref: string;
+    appId?: string | null;
+    name?: string | null;
+    price?: number | null;
+    type?: DuTicOTacOfferType | null;
+    description?: string | null;
+    platform?: PlatformType | null;
+}
+interface DeleteOfferParams {
+    apiKey?: string;
+    ref: string;
+    appId?: string | null;
+}
+declare class OfferModule {
+    private readonly http;
+    constructor(http: HttpClient);
+    create(params: CreateOfferParams): Promise<ApiSuccessResponse<OfferModel>>;
+    list(params?: ListOffersParams): Promise<ApiSuccessResponse<OfferModel[]>>;
+    get(params: GetOfferByRefParams): Promise<ApiSuccessResponse<OfferModel>>;
+    update(params: UpdateOfferParams): Promise<ApiSuccessResponse<OfferModel>>;
+    delete(params: DeleteOfferParams): Promise<ApiSuccessResponse<unknown>>;
+}
+
+interface TransactionModel {
+    id: string;
+    ref: string;
+    productId?: string | null;
+    offerId?: string | null;
+    idFromClient?: string | null;
+    token: string;
+    provider: PaymentProvider;
+    amount: number;
+    fees: number;
+    platform: PlatformType;
+    status: TransactionStatus;
+    appId: string;
+    customerId: string;
+    currency: string;
+    createdAt: string;
+    updatedAt: string;
+    paymentUrl?: string | null;
+}
+
+interface CashInParams {
+    apiKey?: string;
+    appId?: string | null;
+    amount: number;
+    phone: string;
+    paymentMethod: PaymentProvider;
+    password: string;
+    country?: string;
+    currency?: string;
+}
+interface CashOutParams {
+    apiKey?: string;
+    appId?: string | null;
+    transactionId: string;
+    amount?: number | null;
+    ref?: string;
+    phone: string;
+    name: string;
+    email: string;
+    otp?: string | null;
+    paymentMethod: PaymentProvider;
+    plateform?: PlatformType;
+    customerId?: string | null;
+    kolaboReference?: string | null;
+    idFromClient?: string | null;
+    app?: CoreApp;
+    country?: string;
+    currency?: string;
+}
+interface CashInWebhookParams {
+    apiKey?: string;
+    appId?: string | null;
+    service_id: string;
+    gu_transaction_id: string;
+    status: "FAILED" | "SUCCESSFUL";
+    partner_transaction_id: string;
+    call_back_url: string;
+    commission?: number | null;
+    message?: string | null;
+}
+interface CashOutWebhookParams {
+    apiKey?: string;
+    appId?: string | null;
+    service_id: string;
+    gu_transaction_id: string;
+    status: "FAILED" | "SUCCESSFUL";
+    partner_transaction_id: string;
+    call_back_url: string;
+    commission?: number | null;
+    message?: string | null;
+}
+declare class MobileMoneyModule {
+    private readonly http;
+    constructor(http: HttpClient);
+    cashin(params: CashInParams): Promise<ApiSuccessResponse<TransactionModel>>;
+    cashout(params: CashOutParams): Promise<ApiSuccessResponse<TransactionModel>>;
+    handleCashinWebhook(params: CashInWebhookParams): Promise<ApiSuccessResponse<unknown>>;
+    handleCashoutWebhook(params: CashOutWebhookParams): Promise<ApiSuccessResponse<unknown>>;
+}
+
+interface GetPaymentMethodsParams {
+    apiKey?: string;
+    appId?: string | null;
+}
+interface SetPaymentMethodsParams {
+    apiKey?: string;
+    appId?: string | null;
+    providers: PaymentProvider[];
+}
+declare class PaymentMethodModule {
+    private readonly http;
+    constructor(http: HttpClient);
+    get(params?: GetPaymentMethodsParams): Promise<ApiSuccessResponse<PaymentProvider[]>>;
+    set(params: SetPaymentMethodsParams): Promise<ApiSuccessResponse<PaymentProvider[]>>;
+}
+
+interface GetWebhookParams {
+    apiKey?: string;
+    appId?: string | null;
+}
+interface SetWebhookParams {
+    apiKey?: string;
+    appId?: string | null;
+    url: string;
+}
+declare class WebhookModule {
+    private readonly http;
+    constructor(http: HttpClient);
+    get(params?: GetWebhookParams): Promise<ApiSuccessResponse<string>>;
+    set(params: SetWebhookParams): Promise<ApiSuccessResponse<unknown>>;
+}
+
+interface GetTransactionParams {
+    id: string;
+}
+interface PollOptions {
+    /** Minimum interval between polls in ms. Default: 2000 */
+    intervalMs?: number;
+    /** Total timeout in ms. Default: 90000 (90s) */
+    timeoutMs?: number;
+    /** Called on each poll attempt */
+    onPoll?: (attempt: number, elapsedMs: number) => void;
+    /** AbortSignal to cancel polling externally */
+    signal?: AbortSignal;
+}
+declare class TransactionModule {
+    private readonly http;
+    constructor(http: HttpClient);
+    get(params: GetTransactionParams): Promise<ApiSuccessResponse<TransactionModel>>;
+    poll(id: string, options?: PollOptions): Promise<ApiSuccessResponse<TransactionModel>>;
+}
+
+declare class DuticotacError extends Error {
+    readonly code: string;
+    constructor(code: string, message?: string);
+}
+
+declare const ERROR_MESSAGES: Record<string, string>;
+declare function getErrorMessage(code: string): string;
+
+declare function getProviderName(provider: PaymentProvider): string;
+declare function getProviderLogo(provider: PaymentProvider): string;
+
+interface DuticotacSDKConfig extends HttpClientConfig {
+}
+declare class DuticotacSDK {
+    readonly http: HttpClient;
+    readonly balance: BalanceModule;
+    readonly offer: OfferModule;
+    readonly mobileMoney: MobileMoneyModule;
+    readonly paymentMethod: PaymentMethodModule;
+    readonly webhook: WebhookModule;
+    readonly transaction: TransactionModule;
+    constructor(config?: DuticotacSDKConfig);
+}
+
+export { type ApiErrorResponse, type ApiResponse, type ApiSuccessResponse, BalanceModule, type CashInParams, type CashInWebhookParams, type CashOutParams, type CashOutWebhookParams, type CoreApp, type CreateOfferParams, type Currency, type DeleteOfferParams, type DuTicOTacOfferType, DuticotacError, DuticotacSDK, type DuticotacSDKConfig, type DuticotacSettingModel, ERROR_MESSAGES, type GetBalanceParams, type GetOfferByRefParams, type GetPaymentMethodsParams, type GetTransactionParams, type GetWebhookParams, HttpClient, type HttpClientConfig, type ListOffersParams, MobileMoneyModule, type OfferAppModel, type OfferModel, OfferModule, type PaymentLinksCountModel, type PaymentMethod, PaymentMethodModule, type PaymentProvider, type PlateformType, type PlatformType, type PollOptions, type SetPaymentMethodsParams, type SetWebhookParams, type TransactionModel, TransactionModule, type TransactionProvider, type TransactionStatus, type UpdateOfferParams, WebhookModule, getErrorMessage, getProviderLogo, getProviderName };