@bibike/erp-sdk 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,748 @@
+/**
+ * Bibike ERP SDK Types
+ */
+interface ApiResponse<T> {
+    success: boolean;
+    data?: T;
+    message?: string;
+    error?: string;
+    code?: string;
+}
+interface PaginatedResponse<T> {
+    success: boolean;
+    data: T[];
+    pagination: {
+        page: number;
+        per_page: number;
+        total: number;
+        total_pages: number;
+    };
+}
+interface PaginationParams {
+    page?: number;
+    per_page?: number;
+    [key: string]: string | number | boolean | undefined;
+}
+interface DateRangeParams {
+    start_date?: string;
+    end_date?: string;
+    [key: string]: string | number | boolean | undefined;
+}
+interface LoginCredentials {
+    email: string;
+    password: string;
+}
+interface AuthResponse {
+    token: string;
+    user: User;
+    expires_at: string;
+}
+interface User {
+    id: number;
+    email: string;
+    full_name: string;
+    role: string;
+    organization_id: number;
+    organization_name?: string;
+    permissions?: string[];
+}
+interface Product {
+    id: number;
+    organization_id: number;
+    name: string;
+    sku: string;
+    barcode?: string;
+    description?: string;
+    category?: string;
+    category_id?: number;
+    unit_id?: number;
+    unit_name?: string;
+    unit_price: number;
+    cost_price?: number;
+    reorder_level?: number;
+    is_active: boolean;
+    created_at: string;
+    updated_at?: string;
+}
+interface CreateProductInput {
+    name: string;
+    sku?: string;
+    barcode?: string;
+    description?: string;
+    category?: string;
+    category_id?: number;
+    unit_id?: number;
+    unit_price: number;
+    cost_price?: number;
+    reorder_level?: number;
+}
+interface UpdateProductInput extends Partial<CreateProductInput> {
+    is_active?: boolean;
+}
+interface InventoryItem {
+    id: number;
+    product_id: number;
+    product_name: string;
+    sku: string;
+    warehouse_id?: number;
+    warehouse_name?: string;
+    shop_id?: number;
+    shop_name?: string;
+    quantity: number;
+    reorder_level?: number;
+}
+interface StockTransfer {
+    id: number;
+    transfer_number: string;
+    from_warehouse_id?: number;
+    from_shop_id?: number;
+    to_warehouse_id?: number;
+    to_shop_id?: number;
+    status: 'pending' | 'approved' | 'completed' | 'cancelled';
+    notes?: string;
+    created_at: string;
+    items?: StockTransferItem[];
+}
+interface StockTransferItem {
+    product_id: number;
+    quantity: number;
+}
+interface CreateTransferInput {
+    from_warehouse_id?: number;
+    from_shop_id?: number;
+    to_warehouse_id?: number;
+    to_shop_id?: number;
+    notes?: string;
+    items: StockTransferItem[];
+}
+interface StockAdjustment {
+    id: number;
+    product_id: number;
+    warehouse_id?: number;
+    shop_id?: number;
+    quantity: number;
+    adjustment_type: 'increase' | 'decrease';
+    reason: string;
+    notes?: string;
+    created_at: string;
+}
+interface CreateAdjustmentInput {
+    product_id: number;
+    warehouse_id?: number;
+    shop_id?: number;
+    quantity: number;
+    adjustment_type: 'increase' | 'decrease';
+    reason: string;
+    notes?: string;
+}
+interface Sale {
+    id: number;
+    sale_number: string;
+    customer_id?: number;
+    customer_name?: string;
+    total_amount: number;
+    discount_amount?: number;
+    tax_amount?: number;
+    payment_method?: string;
+    payment_status: 'pending' | 'partial' | 'paid';
+    status: 'draft' | 'completed' | 'voided';
+    sale_date: string;
+    notes?: string;
+    created_at: string;
+    items?: SaleItem[];
+}
+interface SaleItem {
+    product_id: number;
+    product_name?: string;
+    quantity: number;
+    unit_price: number;
+    discount?: number;
+    total: number;
+}
+interface CreateSaleInput {
+    customer_id?: number;
+    warehouse_id?: number;
+    shop_id?: number;
+    payment_method?: string;
+    discount_amount?: number;
+    notes?: string;
+    sale_date?: string;
+    items: Array<{
+        product_id: number;
+        quantity: number;
+        unit_price?: number;
+        discount?: number;
+    }>;
+}
+interface Quotation {
+    id: number;
+    quotation_number: string;
+    customer_id?: number;
+    customer_name?: string;
+    total_amount: number;
+    status: 'draft' | 'sent' | 'accepted' | 'rejected' | 'expired';
+    valid_until?: string;
+    created_at: string;
+    items?: SaleItem[];
+}
+interface SalesOrder {
+    id: number;
+    order_number: string;
+    customer_id?: number;
+    customer_name?: string;
+    total_amount: number;
+    status: 'pending' | 'confirmed' | 'processing' | 'shipped' | 'delivered' | 'cancelled';
+    order_date: string;
+    items?: SaleItem[];
+}
+interface Customer {
+    id: number;
+    organization_id: number;
+    name: string;
+    email?: string;
+    phone?: string;
+    address?: string;
+    tin?: string;
+    credit_limit?: number;
+    balance?: number;
+    is_active: boolean;
+    created_at: string;
+}
+interface CreateCustomerInput {
+    name: string;
+    email?: string;
+    phone?: string;
+    address?: string;
+    tin?: string;
+    credit_limit?: number;
+}
+interface Supplier {
+    id: number;
+    organization_id: number;
+    name: string;
+    email?: string;
+    phone?: string;
+    address?: string;
+    tin?: string;
+    balance?: number;
+    is_active: boolean;
+    created_at: string;
+}
+interface CreateSupplierInput {
+    name: string;
+    email?: string;
+    phone?: string;
+    address?: string;
+    tin?: string;
+}
+interface PurchaseOrder {
+    id: number;
+    order_number: string;
+    supplier_id: number;
+    supplier_name?: string;
+    total_amount: number;
+    status: 'draft' | 'pending' | 'approved' | 'submitted' | 'received' | 'cancelled';
+    order_date: string;
+    expected_date?: string;
+    items?: PurchaseOrderItem[];
+}
+interface PurchaseOrderItem {
+    product_id: number;
+    product_name?: string;
+    quantity: number;
+    unit_price: number;
+    total: number;
+}
+interface CreatePurchaseOrderInput {
+    supplier_id: number;
+    warehouse_id?: number;
+    expected_date?: string;
+    notes?: string;
+    items: Array<{
+        product_id: number;
+        quantity: number;
+        unit_price: number;
+    }>;
+}
+interface PurchaseRequisition {
+    id: number;
+    requisition_number: string;
+    status: 'draft' | 'pending' | 'approved' | 'rejected' | 'ordered';
+    priority: 'low' | 'normal' | 'high' | 'urgent';
+    requested_by: number;
+    approved_by?: number;
+    notes?: string;
+    created_at: string;
+    items?: Array<{
+        product_id: number;
+        quantity: number;
+        notes?: string;
+    }>;
+}
+interface Account {
+    id: number;
+    code: string;
+    name: string;
+    type: 'asset' | 'liability' | 'equity' | 'revenue' | 'expense';
+    parent_id?: number;
+    opening_balance: number;
+    current_balance: number;
+    is_active: boolean;
+}
+interface JournalEntry {
+    id: number;
+    entry_number: string;
+    entry_date: string;
+    description: string;
+    status: 'draft' | 'posted' | 'voided';
+    total_debit: number;
+    total_credit: number;
+    lines?: JournalLine[];
+}
+interface JournalLine {
+    account_id: number;
+    account_name?: string;
+    debit: number;
+    credit: number;
+    description?: string;
+}
+interface CreateJournalEntryInput {
+    entry_date: string;
+    description: string;
+    lines: Array<{
+        account_id: number;
+        debit: number;
+        credit: number;
+        description?: string;
+    }>;
+}
+interface TaxRate {
+    id: number;
+    name: string;
+    rate: number;
+    type: 'vat' | 'wht' | 'other';
+    is_active: boolean;
+}
+interface Employee {
+    id: number;
+    employee_number: string;
+    full_name: string;
+    email?: string;
+    phone?: string;
+    department_id?: number;
+    department_name?: string;
+    position_id?: number;
+    position_name?: string;
+    hire_date: string;
+    employment_status: 'active' | 'on_leave' | 'suspended' | 'terminated';
+    employment_type: 'full_time' | 'part_time' | 'contract' | 'intern';
+    basic_salary?: number;
+}
+interface Department {
+    id: number;
+    name: string;
+    description?: string;
+    manager_id?: number;
+}
+interface Position {
+    id: number;
+    name: string;
+    department_id?: number;
+    min_salary?: number;
+    max_salary?: number;
+}
+interface Attendance {
+    id: number;
+    employee_id: number;
+    employee_name?: string;
+    date: string;
+    check_in?: string;
+    check_out?: string;
+    status: 'present' | 'absent' | 'late' | 'half_day' | 'on_leave';
+}
+interface LeaveRequest {
+    id: number;
+    employee_id: number;
+    employee_name?: string;
+    leave_type_id: number;
+    leave_type_name?: string;
+    start_date: string;
+    end_date: string;
+    days: number;
+    status: 'pending' | 'approved' | 'rejected' | 'cancelled';
+    reason?: string;
+}
+interface Lead {
+    id: number;
+    lead_number: string;
+    name: string;
+    email?: string;
+    phone?: string;
+    company?: string;
+    source?: string;
+    status: 'new' | 'contacted' | 'qualified' | 'converted' | 'lost';
+    assigned_to?: number;
+    created_at: string;
+}
+interface Opportunity {
+    id: number;
+    opportunity_number: string;
+    name: string;
+    customer_id?: number;
+    customer_name?: string;
+    value: number;
+    stage_id?: number;
+    stage_name?: string;
+    probability?: number;
+    expected_close_date?: string;
+    is_won?: boolean;
+    owner_id?: number;
+}
+interface Activity {
+    id: number;
+    activity_number: string;
+    type: 'call' | 'email' | 'meeting' | 'task' | 'note';
+    subject: string;
+    description?: string;
+    due_date?: string;
+    status: 'pending' | 'completed' | 'cancelled';
+    assigned_to?: number;
+    opportunity_id?: number;
+    customer_id?: number;
+}
+interface Webhook {
+    id: number;
+    url: string;
+    events: string[];
+    is_active: boolean;
+    created_at: string;
+    recent_deliveries?: WebhookDelivery[];
+}
+interface WebhookDelivery {
+    id: number;
+    event: string;
+    status_code: number;
+    success: boolean;
+    created_at: string;
+}
+interface CreateWebhookInput {
+    url: string;
+    events: WebhookEvent[];
+}
+type WebhookEvent = 'sale.created' | 'sale.completed' | 'sale.voided' | 'inventory.stock_in' | 'inventory.stock_out' | 'inventory.low_stock' | 'purchase.created' | 'purchase.received' | 'customer.created' | 'customer.updated' | 'product.created' | 'product.updated';
+interface POSSession {
+    id: number;
+    user_id: number;
+    cashier_name?: string;
+    warehouse_id?: number;
+    warehouse_name?: string;
+    shop_id?: number;
+    shop_name?: string;
+    opening_balance: number;
+    closing_balance?: number;
+    expected_balance?: number;
+    difference?: number;
+    status: 'open' | 'closed';
+    opened_at: string;
+    closed_at?: string;
+    sales?: Sale[];
+}
+interface SalesReport {
+    periods: Array<{
+        period: string;
+        sales_count: number;
+        total_sales: number;
+        total_discounts: number;
+        avg_sale: number;
+    }>;
+    totals: {
+        total_count: number;
+        total_amount: number;
+        total_discounts: number;
+    };
+    filters: {
+        start_date: string;
+        end_date: string;
+        group_by: string;
+    };
+}
+interface InventoryReport {
+    summary: {
+        total_products: number;
+        total_quantity: number;
+        total_cost_value: number;
+        total_retail_value: number;
+    };
+    low_stock_count: number;
+    out_of_stock_count: number;
+}
+interface ProfitLossReport {
+    revenue: number;
+    cost_of_goods_sold: number;
+    gross_profit: number;
+    gross_margin: number;
+    purchases: number;
+    net_profit: number;
+    period: {
+        start_date: string;
+        end_date: string;
+    };
+}
+interface DashboardStats {
+    today_sales: {
+        count: number;
+        total: number;
+    };
+    month_sales: {
+        count: number;
+        total: number;
+    };
+    low_stock_count: number;
+    pending_orders: number;
+}
+interface Warehouse {
+    id: number;
+    name: string;
+    address?: string;
+    is_active: boolean;
+}
+interface Shop {
+    id: number;
+    name: string;
+    address?: string;
+    is_active: boolean;
+}
+interface Location {
+    id: number;
+    name: string;
+    type_id: number;
+    type_name?: string;
+    address?: string;
+    is_active: boolean;
+}
+
+/**
+ * Bibike ERP SDK Client
+ */
+
+interface BibikeConfig {
+    baseUrl: string;
+    token?: string;
+    timeout?: number;
+    headers?: Record<string, string>;
+}
+declare class BibikeClient {
+    private baseUrl;
+    private token;
+    private timeout;
+    private customHeaders;
+    constructor(config: BibikeConfig);
+    login(credentials: LoginCredentials): Promise<AuthResponse>;
+    logout(): Promise<void>;
+    me(): Promise<User>;
+    setToken(token: string): void;
+    readonly products: {
+        list: (params?: PaginationParams & {
+            search?: string;
+            category?: string;
+        }) => Promise<ApiResponse<Product[]>>;
+        get: (id: number) => Promise<ApiResponse<Product>>;
+        create: (data: CreateProductInput) => Promise<ApiResponse<Product>>;
+        update: (id: number, data: UpdateProductInput) => Promise<ApiResponse<Product>>;
+        delete: (id: number) => Promise<ApiResponse<unknown>>;
+        search: (query: string) => Promise<ApiResponse<Product[]>>;
+    };
+    readonly inventory: {
+        list: (params?: {
+            warehouse_id?: number;
+            shop_id?: number;
+            low_stock?: boolean;
+        }) => Promise<ApiResponse<InventoryItem[]>>;
+        transfers: () => Promise<ApiResponse<StockTransfer[]>>;
+        createTransfer: (data: CreateTransferInput) => Promise<ApiResponse<StockTransfer>>;
+        approveTransfer: (id: number) => Promise<ApiResponse<unknown>>;
+        adjustments: () => Promise<ApiResponse<StockAdjustment[]>>;
+        createAdjustment: (data: CreateAdjustmentInput) => Promise<ApiResponse<StockAdjustment>>;
+        lowStock: () => Promise<ApiResponse<Product[]>>;
+        outOfStock: () => Promise<ApiResponse<Product[]>>;
+        valuation: () => Promise<ApiResponse<unknown>>;
+        movementHistory: (params?: DateRangeParams & {
+            product_id?: number;
+        }) => Promise<ApiResponse<unknown>>;
+    };
+    readonly sales: {
+        list: (params?: PaginationParams & DateRangeParams & {
+            customer_id?: number;
+        }) => Promise<ApiResponse<Sale[]>>;
+        get: (id: number) => Promise<ApiResponse<Sale>>;
+        create: (data: CreateSaleInput) => Promise<ApiResponse<Sale>>;
+        quotations: (params?: PaginationParams & {
+            status?: string;
+        }) => Promise<ApiResponse<Quotation[]>>;
+        createQuotation: (data: CreateSaleInput & {
+            valid_until?: string;
+        }) => Promise<ApiResponse<Quotation>>;
+        orders: (params?: PaginationParams & {
+            status?: string;
+        }) => Promise<ApiResponse<SalesOrder[]>>;
+        createOrder: (data: CreateSaleInput) => Promise<ApiResponse<SalesOrder>>;
+        analytics: (params?: DateRangeParams) => Promise<ApiResponse<unknown>>;
+    };
+    readonly customers: {
+        list: (params?: PaginationParams & {
+            search?: string;
+        }) => Promise<ApiResponse<Customer[]>>;
+        get: (id: number) => Promise<ApiResponse<Customer>>;
+        create: (data: CreateCustomerInput) => Promise<ApiResponse<Customer>>;
+        update: (id: number, data: Partial<CreateCustomerInput>) => Promise<ApiResponse<Customer>>;
+        delete: (id: number) => Promise<ApiResponse<unknown>>;
+        balance: (id: number) => Promise<ApiResponse<{
+            balance: number;
+        }>>;
+    };
+    readonly suppliers: {
+        list: (params?: PaginationParams & {
+            search?: string;
+        }) => Promise<ApiResponse<Supplier[]>>;
+        get: (id: number) => Promise<ApiResponse<Supplier>>;
+        create: (data: CreateSupplierInput) => Promise<ApiResponse<Supplier>>;
+        update: (id: number, data: Partial<CreateSupplierInput>) => Promise<ApiResponse<Supplier>>;
+        delete: (id: number) => Promise<ApiResponse<unknown>>;
+    };
+    readonly purchasing: {
+        orders: (params?: PaginationParams & {
+            status?: string;
+            supplier_id?: number;
+        }) => Promise<ApiResponse<PurchaseOrder[]>>;
+        getOrder: (id: number) => Promise<ApiResponse<PurchaseOrder>>;
+        createOrder: (data: CreatePurchaseOrderInput) => Promise<ApiResponse<PurchaseOrder>>;
+        approveOrder: (id: number) => Promise<ApiResponse<unknown>>;
+        requisitions: (params?: PaginationParams & {
+            status?: string;
+        }) => Promise<ApiResponse<PurchaseRequisition[]>>;
+        createRequisition: (data: {
+            items: Array<{
+                product_id: number;
+                quantity: number;
+            }>;
+        }) => Promise<ApiResponse<PurchaseRequisition>>;
+        analytics: (params?: DateRangeParams) => Promise<ApiResponse<unknown>>;
+    };
+    readonly accounting: {
+        accounts: (params?: {
+            type?: string;
+            is_active?: boolean;
+        }) => Promise<ApiResponse<Account[]>>;
+        getAccount: (id: number) => Promise<ApiResponse<Account>>;
+        createAccount: (data: {
+            code: string;
+            name: string;
+            type: string;
+            parent_id?: number;
+        }) => Promise<ApiResponse<Account>>;
+        journals: (params?: PaginationParams & {
+            status?: string;
+        }) => Promise<ApiResponse<JournalEntry[]>>;
+        getJournal: (id: number) => Promise<ApiResponse<JournalEntry>>;
+        createJournal: (data: CreateJournalEntryInput) => Promise<ApiResponse<JournalEntry>>;
+        postJournal: (id: number) => Promise<ApiResponse<unknown>>;
+        trialBalance: (asOfDate?: string) => Promise<ApiResponse<unknown>>;
+        taxRates: () => Promise<ApiResponse<TaxRate[]>>;
+    };
+    readonly hr: {
+        employees: (params?: PaginationParams & {
+            department_id?: number;
+            status?: string;
+        }) => Promise<ApiResponse<Employee[]>>;
+        getEmployee: (id: number) => Promise<ApiResponse<Employee>>;
+        createEmployee: (data: Partial<Employee>) => Promise<ApiResponse<Employee>>;
+        departments: () => Promise<ApiResponse<Department[]>>;
+        positions: () => Promise<ApiResponse<Position[]>>;
+        attendance: (params?: DateRangeParams & {
+            employee_id?: number;
+        }) => Promise<ApiResponse<Attendance[]>>;
+        clockIn: (employeeId: number) => Promise<ApiResponse<unknown>>;
+        clockOut: (employeeId: number) => Promise<ApiResponse<unknown>>;
+        leaveRequests: (params?: {
+            employee_id?: number;
+            status?: string;
+        }) => Promise<ApiResponse<LeaveRequest[]>>;
+        approveLeave: (id: number) => Promise<ApiResponse<unknown>>;
+    };
+    readonly crm: {
+        leads: (params?: PaginationParams & {
+            status?: string;
+            assigned_to?: number;
+        }) => Promise<ApiResponse<Lead[]>>;
+        getLead: (id: number) => Promise<ApiResponse<Lead>>;
+        createLead: (data: Partial<Lead>) => Promise<ApiResponse<Lead>>;
+        convertLead: (id: number) => Promise<ApiResponse<unknown>>;
+        opportunities: (params?: PaginationParams & {
+            stage_id?: number;
+        }) => Promise<ApiResponse<Opportunity[]>>;
+        getOpportunity: (id: number) => Promise<ApiResponse<Opportunity>>;
+        createOpportunity: (data: Partial<Opportunity>) => Promise<ApiResponse<Opportunity>>;
+        activities: (params?: {
+            type?: string;
+            status?: string;
+            opportunity_id?: number;
+        }) => Promise<ApiResponse<Activity[]>>;
+        createActivity: (data: Partial<Activity>) => Promise<ApiResponse<Activity>>;
+        pipeline: () => Promise<ApiResponse<unknown>>;
+    };
+    readonly webhooks: {
+        list: () => Promise<ApiResponse<Webhook[]>>;
+        get: (id: number) => Promise<ApiResponse<Webhook>>;
+        create: (data: CreateWebhookInput) => Promise<ApiResponse<{
+            id: number;
+            secret: string;
+        }>>;
+        update: (id: number, data: {
+            url?: string;
+            events?: string[];
+            is_active?: boolean;
+        }) => Promise<ApiResponse<unknown>>;
+        delete: (id: number) => Promise<ApiResponse<unknown>>;
+        logs: (id: number) => Promise<ApiResponse<unknown>>;
+        test: (id: number) => Promise<ApiResponse<unknown>>;
+    };
+    readonly pos: {
+        sessions: () => Promise<ApiResponse<POSSession[]>>;
+        getSession: (id: number) => Promise<ApiResponse<POSSession>>;
+        openSession: (data: {
+            warehouse_id?: number;
+            shop_id?: number;
+            opening_balance?: number;
+        }) => Promise<ApiResponse<{
+            id: number;
+        }>>;
+        closeSession: (id: number, data: {
+            closing_balance: number;
+            notes?: string;
+        }) => Promise<ApiResponse<unknown>>;
+    };
+    readonly reports: {
+        sales: (params?: DateRangeParams & {
+            group_by?: "day" | "week" | "month";
+        }) => Promise<ApiResponse<SalesReport>>;
+        inventory: () => Promise<ApiResponse<InventoryReport>>;
+        profitLoss: (params?: DateRangeParams) => Promise<ApiResponse<ProfitLossReport>>;
+        dashboard: () => Promise<ApiResponse<DashboardStats>>;
+    };
+    readonly locations: {
+        warehouses: () => Promise<ApiResponse<Warehouse[]>>;
+        shops: () => Promise<ApiResponse<Shop[]>>;
+        all: (params?: {
+            type_id?: number;
+            capability?: string;
+        }) => Promise<ApiResponse<Location[]>>;
+    };
+    private request;
+}
+declare class BibikeApiError extends Error {
+    readonly statusCode: number;
+    readonly code?: string | undefined;
+    constructor(message: string, statusCode: number, code?: string | undefined);
+}
+
+export { type Account, type Activity, type ApiResponse, type Attendance, type AuthResponse, BibikeApiError, BibikeClient, type BibikeConfig, type CreateAdjustmentInput, type CreateCustomerInput, type CreateJournalEntryInput, type CreateProductInput, type CreatePurchaseOrderInput, type CreateSaleInput, type CreateSupplierInput, type CreateTransferInput, type CreateWebhookInput, type Customer, type DashboardStats, type DateRangeParams, type Department, type Employee, type InventoryItem, type InventoryReport, type JournalEntry, type JournalLine, type Lead, type LeaveRequest, type Location, type LoginCredentials, type Opportunity, type POSSession, type PaginatedResponse, type PaginationParams, type Position, type Product, type ProfitLossReport, type PurchaseOrder, type PurchaseOrderItem, type PurchaseRequisition, type Quotation, type Sale, type SaleItem, type SalesOrder, type SalesReport, type Shop, type StockAdjustment, type StockTransfer, type StockTransferItem, type Supplier, type TaxRate, type UpdateProductInput, type User, type Warehouse, type Webhook, type WebhookDelivery, type WebhookEvent };