@use-stall/types 0.0.1

package/src/orders.d.ts

@@ -0,0 +1,241 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+export interface UnifiedOrderType {
+  id: string;
+  location_id: string;
+  organization_id: string;
+  device_id: string;
+  staff_id: string;
+  order_number: string;
+  status:
+    | "pending"
+    | "processing"
+    | "completed"
+    | "cancelled"
+    | "failed"
+    | "on-hold"
+    | "refunded"
+    | "partially refunded"
+    | "trash";
+  created_at: string;
+  updated_at: string;
+  origin: { name: string; id: string; version: string; [key: string]: string };
+  checkout_token: string;
+  customer_id: string;
+  customer_note: string;
+  billing: UnifiedAddressType;
+  shipping_address: UnifiedAddressType;
+  line_items: UnifiedLineItemType[]; // Array of purchased items (products/variants)
+  currency: string; // Currency of the order
+  payment: UnifiedOrderPaymentDetailsType;
+  subtotal: number | string; // Subtotal price for this item (price * quantity) before tax and discount
+  total: number | string; // Total price for this item (price * quantity)
+  tax: number | string; // Tax for this item
+  tax_lines: UnifiedTaxLineType[]; // Array of applied taxes
+  discount: number | string; // Discount for this item
+  discounts: UnifiedDiscountType[];
+  fulfillment: UnifiedFulfillmentType;
+  refunds: {
+    id: string;
+    reason: string;
+    amount: string;
+    date: string;
+  }[];
+  stall_offline_id: string;
+  stall_offline_created_at: string;
+  stall_offline_updated_at: string;
+  stall_offline_deleted_at: string;
+  metadata: { [key: string]: any }; // Custom metadata
+}
+
+export interface UnifiedLineItemType {
+  id: string; // Unique ID for the line item product/variant id
+  product_id: string; // Linked product ID
+  variant_id: string; // Optional if a product variant was selected
+  sku: string;
+  title: string;
+  thumbnail: string;
+  quantity: number | string;
+  price: number | string; // Price per item
+  original_price: number | string; // Original price useful if oroduct is on sale
+  on_sale: boolean; // If the product is on sale
+  original_total: number | string; // Original price * quantity before sale
+  subtotal: number | string; // Subtotal price for this item (price * quantity) before tax and discount
+  total: number | string; // Total price for this item (price * quantity)
+  tax: number | string; // Tax for this item
+  tax_lines: UnifiedTaxLineType[]; // Array of applied taxes
+  discount: number | string; // Discount for this item
+  discounts: UnifiedDiscountType[];
+  weight: string; // Weight of the product/variant
+  metadata: Record<string, any>; // Optional custom fields
+}
+
+export interface UnifiedAddressType {
+  first_name: string;
+  last_name: string;
+  company: string;
+  address_1: string;
+  address_2: string;
+  city: string;
+  state: string;
+  postcode: string;
+  country: string;
+  email: string;
+  phone: string;
+}
+
+export interface UnifiedTaxLineType {
+  id: string;
+  name: string;
+  rate: number | string;
+  amount: number | string; // Calculated tax amount
+}
+
+export interface UnifiedDiscountType {
+  code: string;
+  amount: number | string; // Discount amount applied
+  type: "percentage" | "fixed" | "code";
+  name: string;
+  metadata: Record<string, any>;
+}
+
+export interface UnifiedOrderPaymentDetailsType {
+  total_amount: number;
+  overcharge_amount: number;
+  currency: string;
+  date: number; // Timestamp in milliseconds
+  timestamp: string; // ISO string format
+  payments: UnifiedOrderPaymentType[];
+  status:
+    | "pending"
+    | "processing"
+    | "paid"
+    | "partially_paid"
+    | "failed"
+    | "refunded";
+  payment_plan: {
+    plan: "full" | "partial" | "layaway" | "installment";
+    details?: {
+      required_deposit: number;
+      interval:
+        | "daily"
+        | "weekly"
+        | "bi-weekly"
+        | "monthly"
+        | "quarterly"
+        | "semi-annually"
+        | "annually";
+      intervals: number;
+      flexible: boolean;
+      start_date: number;
+      end_date: number;
+    };
+  };
+  misc: {
+    split: {
+      is_split: boolean;
+      split_count: number;
+    };
+    tip: number;
+  };
+  metadata?: Record<string, any>;
+}
+
+export interface UnifiedOrderPaymentType {
+  id: string;
+  index?: number;
+  stall_id: string;
+  created_at: number;
+  updated_at: number;
+  completed_at: number;
+  method_id: string; // Reference to UnifiedPaymentMethodType
+  method_name: string;
+  amount: number;
+  currency: string;
+  transaction_id: string;
+  status:
+    | "pending"
+    | "processing"
+    | "successful"
+    | "failed"
+    | "voided"
+    | "refunded";
+  refunded_amount?: number;
+  tendered_amount: number;
+  change_due: number;
+  metadata?: Record<string, any>;
+}
+
+export interface UnifiedFulfillmentType {
+  id: string;
+  status:
+    | "pending"
+    | "fulfilled"
+    | "dispatched"
+    | "cancelled"
+    | "failed"
+    | "on-hold"
+    | "refunded"
+    | string;
+  fulfillment_method: "in-store" | "pick-up" | "delivery" | "shipment";
+  fulfillment_date: string; // Date when the order was fulfilled (ISO format)
+  dispatch_date?: string; // Date when the order was dispatched (ISO format)
+  order_id: string; // Unique ID for the order being fulfilled
+  items: UnifiedFulfilledItemType[]; // List of items being fulfilled
+  tracking_id: string; // Optional tracking number for shipments
+  fulfillment_provider: { id: string; name: string }; // Provider handling the fulfillment
+  assigned_to?: string; // Staff or employee handling fulfillment
+  cost?: number | string; // Cost of shipping (if applicable)
+  notes?: string; // Any notes related to the fulfillment process
+}
+
+export interface UnifiedFulfilledItemType {
+  item_id: string; // Unique ID for the product or variant being fulfilled
+  quantity: number; // Quantity of the product being fulfilled
+  fulfilled_quantity: number; // How many were fulfilled (if partial fulfillment allowed)
+}
+
+export interface LocalSplitPaymentType {
+  split_count: number;
+  split_type: "equal" | "custom";
+  split_amounts: LocalSplitAmountsType[];
+  has_pending: boolean;
+  pending_index: number;
+}
+
+export interface LocalSplitAmountsType {
+  index: number;
+  amount: number;
+  paid: false;
+}
+
+export interface UnifiedOrderRefundType {
+  id: string;
+  amount: string | number;
+  reason: string;
+  date: string;
+  status: "pending" | "processing" | "completed" | "cancelled" | "failed";
+  restock: boolean;
+  refund_type: "amount" | "line_items";
+  metadata: Record<string, any>;
+  line_items: {
+    id: string;
+    quantity: number;
+    name: string;
+    cost_per_item: number;
+  }[];
+  refund_method: {
+    id: string;
+    name: string;
+    status: string;
+    transaction_id: string;
+    refunded_amount: string | number;
+  };
+  staff_id: string;
+  device_id: string;
+  location_id: string;
+  organization_id: string;
+  stall_offline_id: string;
+  stall_offline_created_at: string;
+  stall_offline_updated_at: string;
+  stall_offline_deleted_at: string;
+}

package/src/organizations.d.ts

@@ -0,0 +1,67 @@
+export interface OrganizationType {
+  business_type: string;
+  organization_name: string;
+  organization_size: number | string;
+  base_currency: string;
+  business_address: string;
+  owner: string;
+  locations: string[]; // redudant field,  Maximum is 30
+  id: string;
+  created_at: number;
+  updated_at?: number;
+  active: boolean;
+  subscription?: {
+    last_payment_id: string;
+    metadata: {
+      date: string;
+      org_id: string;
+      owner: string;
+      price: string;
+    };
+    product: string;
+    subscription: string;
+  };
+  logo?: string;
+  connector?: { id: string; config: { [key: string]: string } };
+  receipt_config?: ReceiptType;
+  taxes?: {
+    default_tax_region: UnifiedTaxRegionType;
+  };
+  stall_modules?: OrganizationStallModulesType;
+}
+
+export interface OrganizationStallModulesType {
+  locations: boolean;
+  collections: boolean;
+  suppliers: boolean;
+  purchase_orders: boolean;
+  discounts: boolean;
+  taxes: boolean;
+  chart_of_accounts: boolean;
+  transactions: boolean;
+  invoices: boolean;
+  bills: boolean;
+}
+
+export interface ReceiptType {
+  logo: string;
+  showStoreLocation: boolean;
+  showStorePhone: boolean;
+  header: string;
+  footer: string;
+  headerText: string;
+  footerText: string;
+  headerColor: string;
+  footerColor: string;
+  headerFontSize: string;
+  footerFontSize: string;
+  headerFontFamily: string;
+  footerFontFamily: string;
+  headerAlignment: string;
+  footerAlignment: string;
+  includeQR: boolean;
+  includeBarcode: boolean;
+  qrValue: string;
+  barcodeValue: string;
+  receipt_size: number;
+}

package/src/payments.d.ts

@@ -0,0 +1,55 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+export interface UnifiedPaymentMethodType {
+  id: string;
+  external_id: string;
+  name: string;
+  description: string;
+  processing_type: "online" | "manual" | "hardware";
+  provider_id: string;
+  provider_name: string;
+  icon: string;
+  enabled: boolean;
+  editable: boolean;
+  sort_order: number;
+  supported_options: UnifiedPaymentMethodSupportedOptionsType;
+  supported_currencies: string[]; // Supported currencies (e.g., ["USD", "EUR"])
+  payment_plan: {
+    default: "full" | "partial" | "layaway" | "installment";
+    options: Array<"full" | "partial" | "layaway" | "installment">;
+  };
+  config?: UnifiedPaymentMethodConfigType;
+  rules: UnifiedPaymentMethodRulesType;
+  metadata?: Record<string, any>;
+}
+
+export interface UnifiedPaymentMethodSupportedOptionsType {
+  refunds: boolean;
+  void: boolean;
+  tipping: boolean;
+  split: boolean;
+  offline: boolean;
+  register: boolean; // Track register sessions
+}
+
+export interface UnifiedPaymentMethodConfigType {
+  auth_type: "none" | "basic" | "bearer" | "apikey";
+  headers: Record<string, any>;
+  params: Record<string, any>;
+  body: Record<string, any>;
+  method: "GET" | "POST" | "PUT" | "PATCH";
+  endpoint: string;
+  callback_url: string;
+  webhook_url: string;
+  redirect: boolean;
+  redirect_url: string;
+}
+
+interface UnifiedPaymentMethodRulesType {
+  minimum_amount: number;
+  maximum_amount: number;
+  requires_approval: boolean;
+  marks_as_paid: boolean;
+  marks_as_fulfilled: boolean;
+  open_drawer: boolean;
+  has_tendered_amount: boolean;
+}

package/src/pos.d.ts

@@ -0,0 +1,82 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+export interface PosTileType {
+  position: number;
+  type: "product" | "category" | "collection" | "action" | "custom";
+  label: string;
+  image: {
+    type: "icon" | "image";
+    src: string;
+  };
+  color: string;
+  action_id: string;
+  author: "system" | "external";
+  id: string;
+  metadata: Record<string, any>;
+  live?: {
+    live: boolean;
+    method_id: string;
+    order_key: string;
+  };
+}
+
+export interface PosTilesPageType {
+  page_index: number;
+  title: string;
+  locked: boolean;
+  limit: number | "unlimited";
+  tiles: PosTileType[];
+}
+
+export interface ActivePosTileTabType
+  extends Pick<PosTilesPageType, "page_index" | "title" | "limit" | "locked"> {
+  tiles_count: number;
+}
+
+export interface PosTilesProfileType {
+  access: {
+    type: "global" | "custom";
+    user_id: string;
+  };
+  pages: PosTilesPageType[];
+  type: "retail" | "restaurant";
+  id: string;
+}
+
+export interface PosTileSlotType {
+  index: number;
+  tile: PosTileType | null;
+}
+
+export interface ShortcutType {
+  id: string;
+  position: number;
+  author: "system" | "external";
+  icon: {
+    type: "local" | "external";
+    src: string;
+  };
+  action_id: string;
+  title: string;
+  component?: React.ComponentType<any>;
+}
+
+export interface ShortcutActionType {
+  id: string;
+  description: string;
+  author: string;
+  action: (...args: any[]) => void;
+}
+
+export interface LocalTilesPagesConfigType {
+  view: "grid" | "list";
+  locked: boolean;
+}
+
+export interface ActionsEntryType {
+  [key: string]: ActionEntryType;
+}
+
+export interface ActionEntryType {
+  action: React.ComponentType<any>;
+  props: Record<string, any>;
+}

package/src/product.d.ts

@@ -0,0 +1,232 @@
+export interface UnifiedProductType {
+  id: string;
+  sku: string;
+  barcode: string;
+  title: string;
+  handle: string;
+  description: string;
+  body_html: string;
+  created_at: string;
+  updated_at: string;
+  deleted_at: string;
+  status: "draft" | "private" | "publish" | "pending";
+  type: "simple" | "variable" | "grouped";
+  thumbnail: string;
+  images: UnifiedProductImagesType[];
+  brand: string;
+  tags: string[];
+  categories: string[];
+  attributes: UnifiedAttributeType[];
+  collections: string[];
+  variants: string[];
+  price: number | string;
+  sale_price: number | string;
+  price_currency: string;
+  cost_price: number | string;
+  taxable: boolean;
+  tax_class: string;
+  on_sale: boolean;
+  track_inventory: boolean;
+  unavailable?: number | string; // Items not available for sale (e.g., damaged, expired)
+  committed?: number | string; // Items reserved for existing orders but not yet shipped
+  in_stock: number | string; // Items available for new orders (In Stock)
+  on_hand?: number | string; // Total items physically present at the location
+  low_stock_threshold: number | string; // Low stock threshold specific to the location'
+  locations: string[];
+  weight: string;
+  metadata: { [key: string]: string }; // add date in milliseconds
+}
+
+export interface AttributeType {
+  id: string;
+  position: number;
+  name: string;
+  options: string[];
+}
+
+export interface VariantsType {
+  id: string;
+  sku: string;
+  barcode: string;
+  product_id: string;
+  date: string;
+  title: string;
+  description: string;
+  price: number | string;
+  cost_price: number | string;
+  sale_price: number | string;
+  on_sale: boolean;
+  status: "draft" | "private" | "publish" | "pending";
+  track_inventory: boolean;
+  unavailable: number | string; // Items not available for sale (e.g., damaged, expired)
+  committed: number | string; // Items reserved for existing orders but not yet shipped
+  in_stock: number | string; // Items available for new orders (In Stock)
+  on_hand: number | string; // Total items physically present at the location
+  low_stock_threshold: number | string; // Low stock threshold specific to the location
+  weight: string;
+  thumbnail: string;
+  attributes: VariantsAttributeType[];
+  metadata: { [key: string]: string };
+}
+
+export interface VariantsAttributeType {
+  id: string;
+  name: string;
+  option: string;
+}
+
+export interface LocationStockType {
+  location_id: string;
+  unavailable: number | string; // Items not available for sale (e.g., damaged, expired)
+  committed: number | string; // Items reserved for existing orders but not yet shipped
+  in_stock: number | string; // Items available for new orders (In Stock)
+  on_hand: number | string; // Total items physically present at the location
+  low_stock_threshold: number | string; // Low stock threshold specific to the location
+}
+
+export interface LocationInventoryItemType {
+  id: string;
+  location_id: string;
+  product_id: string;
+  variant_id: string;
+  unavailable: number | string; // Items not available for sale (e.g., damaged, expired)
+  committed: number | string; // Items reserved for existing orders but not yet shipped
+  in_stock: number | string; // Items available for new orders (In Stock)
+  on_hand: number | string; // Total items physically present at the location
+  low_stock_threshold: number | string; // Low stock threshold specific to the location
+  last_updated_at: string;
+  created_at: string;
+}
+
+export interface CategoryType {
+  id: string;
+  name: string;
+  description: string;
+  thumbnail: string;
+  metadata: { [key: string]: string };
+  date: string;
+  count: number;
+  parent_id: string;
+}
+
+export interface CollectionType {
+  id: string;
+  name: string;
+  description: string;
+  thumbnail: string;
+  items: {
+    type: "product" | "category";
+    id: string;
+  }[];
+  metadata: { [key: string]: string };
+}
+
+export interface BrandType {
+  id: string;
+  name: string;
+  description: string;
+  logo: string;
+  metadata: { [key: string]: string };
+}
+
+export interface ProductImagesType {
+  index: number;
+  id: number;
+  src: string;
+  name: string;
+  alt: string;
+  date: string;
+}
+
+export interface UnifiedAttributeType {
+  id: string;
+  position: number;
+  name: string;
+  options: string[];
+}
+
+export interface UnifiedVariantsType {
+  id: string;
+  sku: string;
+  barcode: string;
+  product_id: string;
+  date: string;
+  title: string;
+  description: string;
+  price: number | string;
+  cost_price: number | string;
+  sale_price: number | string;
+  on_sale: boolean;
+  status: "draft" | "private" | "publish" | "pending";
+  tax_class: string;
+  track_inventory: boolean;
+  unavailable?: number | string; // Items not available for sale (e.g., damaged, expired)
+  committed?: number | string; // Items reserved for existing orders but not yet shipped
+  in_stock: number | string; // Items available for new orders (In Stock)
+  on_hand?: number | string; // Total items physically present at the location
+  low_stock_threshold: number | string; // Low stock threshold specific to the location
+  weight: string;
+  thumbnail: string;
+  attributes: UnifiedVariantsAttributeType[];
+  metadata: { [key: string]: string };
+}
+
+export interface UnifiedVariantsAttributeType {
+  id: string;
+  name: string;
+  option: string;
+}
+
+export interface UnifiedLocationStockType {
+  id: string;
+  location_id: string;
+  product_id: string;
+  variant_id: string;
+  unavailable: number | string; // Items not available for sale (e.g., damaged, expired)
+  committed: number | string; // Items reserved for existing orders but not yet shipped
+  in_stock: number | string; // Items available for new orders (In Stock)
+  on_hand: number | string; // Total items physically present at the location
+  low_stock_threshold: number | string; // Low stock threshold specific to the location
+  last_updatedAt: string;
+  created_at: string;
+}
+
+export interface UnifiedCategoryType {
+  id: string;
+  name: string;
+  description: string;
+  thumbnail: string;
+  metadata: { [key: string]: string };
+  date: string;
+  count: number;
+  parent_id: string;
+}
+
+export interface UnifiedCollectionType {
+  id: string;
+  name: string;
+  description: string;
+  thumbnail: string;
+  metadata: { [key: string]: string };
+  linked_products: string[];
+  linked_categories: string[];
+  createAt: string;
+  lastUpdatedAt: string;
+}
+
+export interface UnifiedBrandType {
+  id: string;
+  name: string;
+  description: string;
+  logo: string;
+  metadata: { [key: string]: string };
+}
+
+export interface UnifiedProductImagesType {
+  index: number;
+  id: number;
+  src: string;
+  name: string;
+  alt: string;
+  date: string;
+}