ofpos-shared-core 1.1.0

package/dist/models/Transaction.d.ts

@@ -0,0 +1,32 @@
+export declare const transactionTable = "transactions";
+export type TransactionMethod = 'cash' | 'card' | 'voucher' | 'bank_transfer';
+export type TransactionReferenceType = 'sale' | 'purchase' | 'sale_return' | 'purchase_return' | 'receivable_payment' | 'payable_payment' | 'cash_adjustment' | 'expense';
+export type TransactionDirection = 'in' | 'out';
+export interface Transaction {
+    id: string;
+    /** selalu positif */
+    amount: number;
+    method: TransactionMethod;
+    referenceType: TransactionReferenceType;
+    referenceId: string;
+    direction: TransactionDirection;
+    metadata: any | null;
+    date: string;
+    description: string | null;
+    userId: string;
+    version: number;
+    lastModified: string;
+    deleted: boolean;
+}
+export interface TransactionData {
+    /** selalu positif */
+    amount: number;
+    method: TransactionMethod;
+    referenceType: TransactionReferenceType;
+    referenceId: string;
+    direction: TransactionDirection;
+    metadata: any | null;
+    date: string;
+    description: string | null;
+    userId: string;
+}

package/dist/models/Uom.d.ts

@@ -0,0 +1,15 @@
+export declare const uomTable = "uoms";
+export interface Uom {
+    id: string;
+    code: string;
+    name: string;
+    conversionFactor: number;
+    version: number;
+    lastModified: string;
+    deleted: boolean;
+}
+export interface UomData {
+    code: string;
+    name: string;
+    conversionFactor: number;
+}

package/dist/models/User.d.ts

@@ -0,0 +1,21 @@
+export declare const userTable = "users";
+export interface User {
+    id: string;
+    username: string;
+    pinHash: string | null;
+    role: string;
+    email: string | null;
+    failedAttempts: number | null;
+    isLocked: boolean | null;
+    version: number;
+    lastModified: string;
+    deleted: boolean;
+}
+export interface UserData {
+    username: string;
+    pinHash: string | null;
+    role: string;
+    email: string | null;
+    failedAttempts: number | null;
+    isLocked: boolean | null;
+}

package/dist/services/bomService.d.ts

@@ -0,0 +1,71 @@
+import { PosCore } from '../PosCore';
+import { DbAdapter, QueryOptions } from 'ofcore';
+import { Bom, BomData } from '../models/Bom';
+/** Service interface for Bom operations. */
+export interface IBomService {
+    /** Add new Bom. */
+    addBom(data: BomData, tx?: DbAdapter): Promise<Bom>;
+    /** Update existing Bom. */
+    updateBom(id: string, data: Partial<BomData>): Promise<Bom>;
+    /** Get all Boms with complex options. */
+    getBoms(options?: QueryOptions, tx?: DbAdapter): Promise<Bom[]>;
+    /** Get Bom by ID or options. */
+    getBom(idOrOptions: string | QueryOptions, tx?: DbAdapter): Promise<Bom | null>;
+    /** Delete Bom (logical). */
+    deleteBom(id: string, tx?: DbAdapter): Promise<{
+        id: string;
+        queued: boolean;
+    }>;
+    /** Duplicate Bom by ID. */
+    duplicateBom(originalId: string, tx?: DbAdapter): Promise<Bom>;
+    /** Get Boms by primary search key parentItemId. */
+    getBomsByParentItemId(value: string, tx?: DbAdapter): Promise<Bom[]>;
+    /** Get Boms by primary search key componentItemId. */
+    getBomsByComponentItemId(value: string, tx?: DbAdapter): Promise<Bom[]>;
+    /** Get BOMs by Product ID */
+    getBomsByProductId(productId: string, options?: QueryOptions): Promise<Bom[]>;
+    /** Expand BOM recursively */
+    expandBom(parentItemId: string): Promise<Array<{
+        componentItemId: string;
+        quantity: number;
+        uomId: string | null;
+    }>>;
+}
+/** Service implementation for Bom operations. */
+export declare class BomService implements IBomService {
+    private context;
+    private dbAdapter;
+    private syncStore?;
+    /**
+     * Initialize BomService.
+     * @param context - PosCore context
+     */
+    constructor(context: PosCore);
+    /** Add new Bom. */
+    addBom(data: BomData, tx?: DbAdapter): Promise<Bom>;
+    /** Update existing Bom. */
+    updateBom(id: string, data: Partial<BomData>, tx?: DbAdapter): Promise<Bom>;
+    /** Get all Boms with complex options. */
+    getBoms(options?: QueryOptions, tx?: DbAdapter): Promise<Bom[]>;
+    /** Get Bom by ID or options. */
+    getBom(idOrOptions: string | QueryOptions, tx?: DbAdapter): Promise<Bom | null>;
+    /** Delete Bom (logical). */
+    deleteBom(id: string, tx?: DbAdapter): Promise<{
+        id: string;
+        queued: boolean;
+    }>;
+    /** Duplicate Bom by ID. */
+    duplicateBom(originalId: string, tx?: DbAdapter): Promise<Bom>;
+    /** Get Boms by primary search key parentItemId. */
+    getBomsByParentItemId(value: string, tx?: DbAdapter): Promise<Bom[]>;
+    /** Get Boms by primary search key componentItemId. */
+    getBomsByComponentItemId(value: string, tx?: DbAdapter): Promise<Bom[]>;
+    /** Get BOMs by Product ID */
+    getBomsByProductId(productId: string, options?: QueryOptions): Promise<Bom[]>;
+    /** Recursively expand a product BOM into its primitive components with aggregated quantities. */
+    expandBom(parentItemId: string): Promise<Array<{
+        componentItemId: string;
+        quantity: number;
+        uomId: string | null;
+    }>>;
+}

package/dist/services/cartService.d.ts

@@ -0,0 +1,65 @@
+import { PosCore } from '../PosCore';
+import { Cart, CartItem, CartMap } from '../stores/cartStore';
+/**
+ * Antarmuka layanan keranjang belanja.
+ */
+export interface ICartService {
+    /** Buat keranjang baru. */
+    createCart(partialCart: Omit<Cart, 'id' | 'createdAt' | 'lastModified'>): Promise<Cart>;
+    /** Perbarui keranjang yang ada. */
+    updateCart(cart: Cart): Promise<void>;
+    /** Hapus keranjang berdasarkan ID. */
+    deleteCart(cartId: string): Promise<void>;
+    /** Ambil keranjang berdasarkan ID. */
+    getCart(cartId: string): Promise<Cart | undefined>;
+    /** Ambil semua keranjang. */
+    getAllCarts(): Promise<CartMap>;
+    /** Bersihkan semua keranjang. */
+    clearAllCarts(): Promise<void>;
+    /** Ambil keranjang yang sedang aktif (tidak terkunci). */
+    getActiveCarts(): Promise<Cart[]>;
+    /** Ambil keranjang berdasarkan ID pelanggan. */
+    getCartByCustomerId(customerId: string): Promise<Cart[]>;
+    /** Ambil keranjang berdasarkan nomor meja. */
+    getCartByTableNumber(tableNumber: string): Promise<Cart[]>;
+    /** Tambah item ke dalam keranjang. */
+    addItemToCart(cartId: string, item: CartItem): Promise<Cart>;
+    /** Hapus item dari keranjang. */
+    removeItemFromCart(cartId: string, itemId: string): Promise<Cart>;
+    updateCartItem(cartId: string, itemId: string, data: CartItem): Promise<Cart>;
+}
+/**
+ * Implementasi layanan keranjang belanja.
+ */
+export declare class CartService implements ICartService {
+    private context;
+    private cartStore;
+    /**
+     * Buat instance CartService.
+     * @param context Konteks PosCore.
+     */
+    constructor(context: PosCore);
+    /** Buat keranjang baru. */
+    createCart(partialCart: Partial<Cart>): Promise<Cart>;
+    /** Perbarui keranjang yang ada. */
+    updateCart(cart: Cart): Promise<void>;
+    /** Hapus keranjang berdasarkan ID. */
+    deleteCart(cartId: string): Promise<void>;
+    /** Ambil keranjang berdasarkan ID. */
+    getCart(cartId: string): Promise<Cart | undefined>;
+    /** Ambil semua keranjang. */
+    getAllCarts(): Promise<CartMap>;
+    /** Bersihkan semua keranjang. */
+    clearAllCarts(): Promise<void>;
+    /** Ambil keranjang yang sedang aktif (tidak terkunci). */
+    getActiveCarts(): Promise<Cart[]>;
+    /** Ambil keranjang berdasarkan ID pelanggan. */
+    getCartByCustomerId(customerId: string): Promise<Cart[]>;
+    /** Ambil keranjang berdasarkan nomor meja. */
+    getCartByTableNumber(tableNumber: string): Promise<Cart[]>;
+    /** Tambah item ke dalam keranjang. */
+    addItemToCart(cartId: string, item: CartItem): Promise<Cart>;
+    /** Hapus item dari keranjang. */
+    removeItemFromCart(cartId: string, itemId: string): Promise<Cart>;
+    updateCartItem(cartId: string, itemId: string, data: CartItem): Promise<Cart>;
+}

package/dist/services/categoryService.d.ts

@@ -0,0 +1,54 @@
+import { PosCore } from '../PosCore';
+import { DbAdapter, QueryOptions } from 'ofcore';
+import { Category, CategoryData } from '../models/Category';
+export interface CategoryTreeItem extends Category {
+    children: CategoryTreeItem[];
+}
+/** Service interface for Category operations. */
+export interface ICategoryService {
+    /** Add new Category. */
+    addCategory(data: CategoryData, tx?: DbAdapter): Promise<Category>;
+    /** Update existing Category. */
+    updateCategory(id: string, data: Partial<CategoryData>): Promise<Category>;
+    /** Get all Categories with complex options. */
+    getCategories(options?: QueryOptions, tx?: DbAdapter): Promise<Category[]>;
+    /** Get Category by ID or options. */
+    getCategory(idOrOptions: string | QueryOptions, tx?: DbAdapter): Promise<Category | null>;
+    /** Delete Category (logical). */
+    deleteCategory(id: string, tx?: DbAdapter): Promise<{
+        id: string;
+        queued: boolean;
+    }>;
+    /** Duplicate Category by ID. */
+    duplicateCategory(originalId: string, tx?: DbAdapter): Promise<Category>;
+    /** Fetch nested category tree */
+    fetchNestedCategories(): Promise<CategoryTreeItem[]>;
+}
+/** Service implementation for Category operations. */
+export declare class CategoryService implements ICategoryService {
+    private context;
+    private dbAdapter;
+    private syncStore?;
+    /**
+     * Initialize CategoryService.
+     * @param context - PosCore context
+     */
+    constructor(context: PosCore);
+    /** Add new Category. */
+    addCategory(data: CategoryData, tx?: DbAdapter): Promise<Category>;
+    /** Update existing Category. */
+    updateCategory(id: string, data: Partial<CategoryData>, tx?: DbAdapter): Promise<Category>;
+    /** Get all Categories with complex options. */
+    getCategories(options?: QueryOptions, tx?: DbAdapter): Promise<Category[]>;
+    /** Get Category by ID or options. */
+    getCategory(idOrOptions: string | QueryOptions, tx?: DbAdapter): Promise<Category | null>;
+    /** Delete Category (logical). */
+    deleteCategory(id: string, tx?: DbAdapter): Promise<{
+        id: string;
+        queued: boolean;
+    }>;
+    /** Duplicate Category by ID. */
+    duplicateCategory(originalId: string, tx?: DbAdapter): Promise<Category>;
+    /** Fetch nested category tree */
+    fetchNestedCategories(): Promise<CategoryTreeItem[]>;
+}

package/dist/services/customerGroupService.d.ts

@@ -0,0 +1,47 @@
+import { PosCore } from '../PosCore';
+import { DbAdapter, QueryOptions } from 'ofcore';
+import { CustomerGroup, CustomerGroupData } from '../models/CustomerGroup';
+/** Service interface for CustomerGroup operations. */
+export interface ICustomerGroupService {
+    /** Add new CustomerGroup. */
+    addCustomerGroup(data: CustomerGroupData, tx?: DbAdapter): Promise<CustomerGroup>;
+    /** Update existing CustomerGroup. */
+    updateCustomerGroup(id: string, data: Partial<CustomerGroupData>): Promise<CustomerGroup>;
+    /** Get all CustomerGroups with complex options. */
+    getCustomerGroups(options?: QueryOptions, tx?: DbAdapter): Promise<CustomerGroup[]>;
+    /** Get CustomerGroup by ID or options. */
+    getCustomerGroup(idOrOptions: string | QueryOptions, tx?: DbAdapter): Promise<CustomerGroup | null>;
+    /** Delete CustomerGroup (logical). */
+    deleteCustomerGroup(id: string, tx?: DbAdapter): Promise<{
+        id: string;
+        queued: boolean;
+    }>;
+    /** Duplicate CustomerGroup by ID. */
+    duplicateCustomerGroup(originalId: string, tx?: DbAdapter): Promise<CustomerGroup>;
+}
+/** Service implementation for CustomerGroup operations. */
+export declare class CustomerGroupService implements ICustomerGroupService {
+    private context;
+    private dbAdapter;
+    private syncStore?;
+    /**
+     * Initialize CustomerGroupService.
+     * @param context - PosCore context
+     */
+    constructor(context: PosCore);
+    /** Add new CustomerGroup. */
+    addCustomerGroup(data: CustomerGroupData, tx?: DbAdapter): Promise<CustomerGroup>;
+    /** Update existing CustomerGroup. */
+    updateCustomerGroup(id: string, data: Partial<CustomerGroupData>, tx?: DbAdapter): Promise<CustomerGroup>;
+    /** Get all CustomerGroups with complex options. */
+    getCustomerGroups(options?: QueryOptions, tx?: DbAdapter): Promise<CustomerGroup[]>;
+    /** Get CustomerGroup by ID or options. */
+    getCustomerGroup(idOrOptions: string | QueryOptions, tx?: DbAdapter): Promise<CustomerGroup | null>;
+    /** Delete CustomerGroup (logical). */
+    deleteCustomerGroup(id: string, tx?: DbAdapter): Promise<{
+        id: string;
+        queued: boolean;
+    }>;
+    /** Duplicate CustomerGroup by ID. */
+    duplicateCustomerGroup(originalId: string, tx?: DbAdapter): Promise<CustomerGroup>;
+}

package/dist/services/customerService.d.ts

@@ -0,0 +1,133 @@
+import { PosCore } from '../PosCore';
+import { DbAdapter, QueryOptions } from 'ofcore';
+import { Customer, CustomerData } from '../models/Customer';
+/** Service interface for Customer operations. */
+export interface ICustomerService {
+    /** Add new Customer. */
+    addCustomer(data: CustomerData, tx?: DbAdapter): Promise<Customer>;
+    /** Update existing Customer. */
+    updateCustomer(id: string, data: Partial<CustomerData>): Promise<Customer>;
+    /** Get all Customers with complex options. */
+    getCustomers(options?: QueryOptions, tx?: DbAdapter): Promise<Customer[]>;
+    /** Get Customer by ID or options. */
+    getCustomer(idOrOptions: string | QueryOptions, tx?: DbAdapter): Promise<Customer | null>;
+    /** Delete Customer (logical). */
+    deleteCustomer(id: string, tx?: DbAdapter): Promise<{
+        id: string;
+        queued: boolean;
+    }>;
+    /** Duplicate Customer by ID. */
+    duplicateCustomer(originalId: string, tx?: DbAdapter): Promise<Customer>;
+    /** Search Customer by full-text keyword. */
+    searchCustomers(keyword: string, options?: QueryOptions, tx?: DbAdapter): Promise<Customer[]>;
+    /** Earn loyalty points from valid business event (e.g., sale posting). */
+    earnLoyaltyPoints(input: {
+        customerId: string;
+        referenceType: string;
+        referenceId: string;
+        baseAmount: number;
+        earnRate: number;
+        expiresAt?: string | null;
+        note?: string | null;
+        date?: string;
+    }): Promise<{
+        earnedPoints: number;
+        balance: number;
+    }>;
+    /** Redeem available loyalty points using FIFO on expiring buckets. */
+    redeemLoyaltyPoints(input: {
+        customerId: string;
+        referenceType: string;
+        referenceId: string;
+        points: number;
+        note?: string | null;
+        date?: string;
+    }): Promise<{
+        redeemedPoints: number;
+        balance: number;
+    }>;
+    /** Expire points that have passed expiry date. */
+    expireLoyaltyPoints(input?: {
+        customerId?: string;
+        asOfDate?: string;
+    }): Promise<{
+        expiredPoints: number;
+        affectedCustomers: number;
+    }>;
+    /** Snapshot loyalty account summary per customer. */
+    getLoyaltySummary(customerId: string): Promise<{
+        customerId: string;
+        pointsBalance: number;
+        totalEarned: number;
+        totalRedeemed: number;
+        totalExpired: number;
+    }>;
+}
+/** Service implementation for Customer operations. */
+export declare class CustomerService implements ICustomerService {
+    private context;
+    private dbAdapter;
+    private syncStore?;
+    /**
+     * Initialize CustomerService.
+     * @param context - PosCore context
+     */
+    constructor(context: PosCore);
+    private runInTransaction;
+    private getOrCreateLoyaltyAccount;
+    /** Add new Customer. */
+    addCustomer(data: CustomerData, tx?: DbAdapter): Promise<Customer>;
+    /** Update existing Customer. */
+    updateCustomer(id: string, data: Partial<CustomerData>, tx?: DbAdapter): Promise<Customer>;
+    /** Get all Customers with complex options. */
+    getCustomers(options?: QueryOptions, tx?: DbAdapter): Promise<Customer[]>;
+    /** Get Customer by ID or options. */
+    getCustomer(idOrOptions: string | QueryOptions, tx?: DbAdapter): Promise<Customer | null>;
+    /** Delete Customer (logical). */
+    deleteCustomer(id: string, tx?: DbAdapter): Promise<{
+        id: string;
+        queued: boolean;
+    }>;
+    /** Duplicate Customer by ID. */
+    duplicateCustomer(originalId: string, tx?: DbAdapter): Promise<Customer>;
+    /** Search Customer by full-text keyword. */
+    searchCustomers(keyword: string, options?: QueryOptions, tx?: DbAdapter): Promise<Customer[]>;
+    earnLoyaltyPoints(input: {
+        customerId: string;
+        referenceType: string;
+        referenceId: string;
+        baseAmount: number;
+        earnRate: number;
+        expiresAt?: string | null;
+        note?: string | null;
+        date?: string;
+    }): Promise<{
+        earnedPoints: number;
+        balance: number;
+    }>;
+    redeemLoyaltyPoints(input: {
+        customerId: string;
+        referenceType: string;
+        referenceId: string;
+        points: number;
+        note?: string | null;
+        date?: string;
+    }): Promise<{
+        redeemedPoints: number;
+        balance: number;
+    }>;
+    expireLoyaltyPoints(input?: {
+        customerId?: string;
+        asOfDate?: string;
+    }): Promise<{
+        expiredPoints: number;
+        affectedCustomers: number;
+    }>;
+    getLoyaltySummary(customerId: string): Promise<{
+        customerId: string;
+        pointsBalance: number;
+        totalEarned: number;
+        totalRedeemed: number;
+        totalExpired: number;
+    }>;
+}

package/dist/services/documentNumberPolicy.d.ts

@@ -0,0 +1,15 @@
+import { PosCore } from '../PosCore';
+export type DocumentType = 'sale' | 'purchase' | 'order';
+export declare class DocumentNumberPolicy {
+    private context;
+    private readonly storage;
+    private queue;
+    constructor(context: PosCore);
+    private getBranchSegment;
+    private getDateSegment;
+    private getCounterKey;
+    private withLock;
+    next(type: DocumentType, dateIso: string): Promise<string>;
+    withNote(note: string | null | undefined, docNo: string): string;
+    extractDocNo(note: string | null | undefined): string | null;
+}

package/dist/services/expenseService.d.ts

@@ -0,0 +1,47 @@
+import { PosCore } from '../PosCore';
+import { DbAdapter, QueryOptions } from 'ofcore';
+import { Expense, ExpenseData } from '../models/Expense';
+/** Service interface for Expense operations. */
+export interface IExpenseService {
+    /** Add new Expense. */
+    addExpense(data: ExpenseData, tx?: DbAdapter): Promise<Expense>;
+    /** Update existing Expense. */
+    updateExpense(id: string, data: Partial<ExpenseData>): Promise<Expense>;
+    /** Get all Expenses with complex options. */
+    getExpenses(options?: QueryOptions, tx?: DbAdapter): Promise<Expense[]>;
+    /** Get Expense by ID or options. */
+    getExpense(idOrOptions: string | QueryOptions, tx?: DbAdapter): Promise<Expense | null>;
+    /** Delete Expense (logical). */
+    deleteExpense(id: string, tx?: DbAdapter): Promise<{
+        id: string;
+        queued: boolean;
+    }>;
+    /** Duplicate Expense by ID. */
+    duplicateExpense(originalId: string, tx?: DbAdapter): Promise<Expense>;
+}
+/** Service implementation for Expense operations. */
+export declare class ExpenseService implements IExpenseService {
+    private context;
+    private dbAdapter;
+    private syncStore?;
+    /**
+     * Initialize ExpenseService.
+     * @param context - PosCore context
+     */
+    constructor(context: PosCore);
+    /** Add new Expense. */
+    addExpense(data: ExpenseData, tx?: DbAdapter): Promise<Expense>;
+    /** Update existing Expense. */
+    updateExpense(id: string, data: Partial<ExpenseData>, tx?: DbAdapter): Promise<Expense>;
+    /** Get all Expenses with complex options. */
+    getExpenses(options?: QueryOptions, tx?: DbAdapter): Promise<Expense[]>;
+    /** Get Expense by ID or options. */
+    getExpense(idOrOptions: string | QueryOptions, tx?: DbAdapter): Promise<Expense | null>;
+    /** Delete Expense (logical). */
+    deleteExpense(id: string, tx?: DbAdapter): Promise<{
+        id: string;
+        queued: boolean;
+    }>;
+    /** Duplicate Expense by ID. */
+    duplicateExpense(originalId: string, tx?: DbAdapter): Promise<Expense>;
+}

package/dist/services/exportAdapter.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Adapter ekspor dokumen, abstraksi untuk menulis dan membagikan file.
+ */
+import { PosCore } from "../PosCore";
+/**
+ * Antarmuka adapter ekspor dokumen.
+ */
+export interface ExportAdapter {
+    /**
+     * Dapatkan path dokumen berdasarkan nama file.
+     * @param fileName Nama file yang diinginkan.
+     */
+    getDocumentPath(fileName: string): string;
+    /**
+     * Tulis konten ke file pada path tertentu.
+     * @param path Lokasi file.
+     * @param content Konten yang akan ditulis.
+     */
+    writeFile(path: string, content: string): Promise<void>;
+    /**
+     * Bagikan file melalui mekanisme platform.
+     * @param path Lokasi file yang akan dibagikan.
+     */
+    share(path: string): Promise<void>;
+}
+/**
+ * Implementasi default ExportAdapter yang melempar error pada operasi tertentu.
+ */
+export declare class DefaultExportAdapter implements ExportAdapter {
+    private context;
+    /**
+     * Buat instance DefaultExportAdapter.
+     * @param context Konteks PosCore.
+     */
+    constructor(context: PosCore);
+    /**
+     * Dapatkan path dokumen (default hanya nama file).
+     */
+    getDocumentPath(fileName: string): string;
+    /**
+     * Tulis konten ke file (tidak diimplementasikan pada platform ini).
+     */
+    writeFile(path: string, content: string): Promise<void>;
+    /**
+     * Bagikan file (tidak diimplementasikan pada platform ini).
+     */
+    share(path: string): Promise<void>;
+}