Type Definitions

All TypeScript types exported by @pyyupsk/storehub.

Product Types

Product

interface Product {
  id: string;
  name: string;
  category?: string;
  priceType: PriceType;
  unitPrice?: number;
  cost?: number | null;
  barcode?: string;
  trackStockLevel: boolean;
  isParentProduct: boolean;
  variantGroups?: VariantGroup[];
  parentProductId?: string;
  variationValues?: VariationValue[];
  sku?: string;
}

PriceType

type PriceType = "Fixed" | "Variable";

VariantGroup

interface VariantGroup {
  id: string;
  name: string;
  options: VariantGroupOption[];
}

VariantGroupOption

interface VariantGroupOption {
  id: string;
  optionValue: string;
  priceDifference: number;
  isDefault?: boolean;
}

VariationValue

interface VariationValue {
  variantGroupId: string;
  value: string;
}

---

Customer Types

Customer

interface Customer {
  refId: string;
  firstName: string;
  lastName: string;
  phone?: string;
  email?: string;
  createdTime: string;
  modifiedTime: string;
  tags: CustomerTag[];
  birthday: null;
  state?: string;
  loyalty?: number;
}

CustomerTag

type CustomerTag = "" | "ปลีก" | "ราคาส่ง 1" | "ราคาส่ง 2";

CustomerSearchParams

interface CustomerSearchParams {
  firstName?: string;
  lastName?: string;
  email?: string;
  phone?: string;
}

---

Transaction Types

Transaction

interface Transaction {
  refId: string;
  invoiceNumber: string;
  storeId: string;
  registerId: string;
  employeeId: string;
  transactionType: "Sale" | "Return";
  transactionTime: string;
  total: number;
  subTotal: number;
  tax: number;
  discount: number;
  tableId: null | string;
  roundedAmount: number;
  serviceCharge: number;
  seniorDiscount: number;
  pwdDiscount: number;
  athleteAndCoachDiscount: number;
  medalOfValorDiscount: number;
  soloParentDiscount: number;
  isMemcApplied: boolean;
  promotions: TransactionPromotion[];
  items: TransactionItem[];
  payments: TransactionPayment[];
  isCancelled: boolean;
  terminalNumber: number;
  channel: string;
  customerRefId?: string;
  cancelledTime?: string;
  cancelledBy?: string;
  returnReason?: string;
  saleInvoiceNumber?: string;
}

TransactionItem

interface TransactionItem {
  productId: string;
  quantity: number;
  total: number;
  subTotal: number;
  tax?: number;
  taxCode: string;
  discount: number;
  unitPrice?: number;
  itemType: string;
  notes: string;
  deductedTax: number;
  promotions: unknown[];
  selectedOptions?: TransactionSelectedOption[];
}

TransactionPayment

interface TransactionPayment {
  paymentMethod: string;
  amount: number;
}

TransactionPromotion

interface TransactionPromotion {
  id: string;
  name: string;
  discount: number;
  tax: number;
}

TransactionSelectedOption

interface TransactionSelectedOption {
  groupId: string;
  optionId: string;
  optionValue: string;
  quantity: number;
}

TransactionSearchParams

type TransactionSearchParams = QueryParams;

---

Inventory Types

Stock

interface Stock {
  productId: string;
  quantityOnHand: number;
  warningStock?: number;
}

---

Employee Types

Employee

interface Employee {
  id: string;
  firstName: string;
  lastName: string;
  email: string;
  phone: string;
  createdTime: string;
  modifiedTime: string;
}

EmployeeSearchParams

interface EmployeeSearchParams {
  modifiedSince?: string | Date;
}

---

Store Types

Store

interface Store {
  id: string;
  name: string;
  address1: string;
  address2: string;
  city: string;
  state: string;
  country: string;
  postalCode: string;
  phone: string;
  email: string;
  website: string;
}

---

Timesheet Types

Timesheet

interface Timesheet {
  employeeId: string;
  storeId: string;
  clockInTime: string;
  clockOutTime: string;
}

TimesheetSearchParams

interface TimesheetSearchParams {
  storeId?: string;
  employeeId?: string;
  from?: string | Date;
  to?: string | Date;
}

---

Core Types

StoreHubClientConfig

interface StoreHubClientConfig {
  storeName: string;
  apiToken: string;
  baseUrl?: string;
  fetcher?: FetchLike;
}

StoreHubApiError

class StoreHubApiError extends Error {
  status: number;
  url: string;
  responseBody: string | undefined;
}

QueryParams

type QueryParams = Record<string, PrimitiveQueryValue>;

type PrimitiveQueryValue = string | number | boolean | Date | null | undefined;