@use-stall/types 0.2.6 → 0.2.8

package/index.d.ts

@@ -24,3 +24,4 @@ export * from "./src/extensions";
 export * from "./src/connectors";
 export * from "./src/pin-auth";
 export * from "./src/integrations";
+export * from "./src/promotions";

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@use-stall/types",
-  "version": "0.2.6",
+  "version": "0.2.8",
   "description": "Type declarations for Stall SDKs",
   "types": "index.d.ts",
   "type": "module",
   "main": "index.js",
   "module": "index.js",
   "unpkg": "index.js",
-  "private":false
+  "private": false
 }

package/src/connectors.d.ts

@@ -6,19 +6,16 @@ export type ConnectorModuleKey =
   | "tags"
   | "inventory_levels" // For products with stock tracking
   | "inventory_history" // History of inventory levels at a specific point in time
-  | "coupons"
-  | "gift_cards"
+  | "promotions"
   | "orders"
   | "order_notes" // Activities related to order
   | "refunds" // Activities related to refunds
   | "payment_providers"
   | "payments" // Create, Read, Update, Delete, Webhooks
-  | "receipts" // These are not tax invoices but rather and indication of a successful payment
   | "tax_regions" // can be tax class or groups in other data sources
   | "tax_rates"
   | "customers"
   | "locations" // Can be stock locations, warehouses, or any other location-related data
-  | "sessions_tracking" // This will be used for cash tracking and tracking the POS/Flex user
   | "fulfillment_types" // Like delivery, pickup, etc.
   | "fulfillment_providers" // Providers third party or custom like DHL, FedEx, UPS, etc.
   | "fulfillments"; // Individual fulfillment instances for an order

package/src/customers.d.ts

@@ -10,14 +10,16 @@ export interface UnifiedCustomerType {
   last_name: string;
   addresses: UnifiedCustomerAddressType[];
   phone: string;
-  metadata: Record<string, any>;
+  metadata: {
+    stall_offline_id?: string;
+    stall_offline_created_at?: string;
+    stall_offline_updated_at?: string;
+    stall_offline_deleted_at?: string;
+    [key: string]: any;
+  };
   created_at: string;
   updated_at: string;
   deleted_at: string;
-  stall_offline_id: string;
-  stall_offline_created_at: string;
-  stall_offline_updated_at: string;
-  stall_offline_deleted_at: string;
 }
 
 export interface UnifiedCustomerAddressType {

package/src/fulfillment.d.ts

@@ -79,5 +79,11 @@ export interface UnifiedFulfillmentType {
     destination: UnifiedCustomerAddressType;
     departure: UnifiedCustomerAddressType;
   };
-  metadata: Record<string, any>;
+  metadata: {
+    stall_offline_id?: string;
+    stall_offline_created_at?: string;
+    stall_offline_updated_at?: string;
+    stall_offline_deleted_at?: string;
+    [key: string]: any;
+  };
 }

package/src/inventory.d.ts

@@ -1,58 +1,65 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 export interface UnifiedInventoryLevelType {
-    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;
-    metadata: Record<string, any>;
-  }
-  export interface ExtendedUnifiedInventoryLevelType
-    extends UnifiedInventoryLevelType {
-    title: string;
-    thumbnail: string;
-    options: string[];
-    is_new: boolean;
-  }
-  
-  export interface InventoryAdjustmentRequestType {
-    id: string;
-    batch?: string;
-    items: ExtendedUnifiedInventoryLevelType[];
-    reason: string;
-    location_id: string;
-    organization_id: string;
-    device_id: string;
-    staff_id: string;
-    user_id: string;
-    stall_offline_id: string;
-    stall_offline_created_at: string;
-    stall_offline_updated_at: string;
-    stall_offline_deleted_at: string;
-  }
-  
-  export interface UnifiedInventoryLevelChangeLogType {
-    id: string;
-    date: string;
-    inventory_item_id: string;
-    unavailable: number | string;
-    committed: number | string;
-    in_stock: number | string;
-    on_hand: number | string;
-    reason: string;
-    batch: string;
-    device_id: string;
-    staff_id: string;
-    location_id: string;
-    user_id: string;
-    stall_offline_id: string;
-    stall_offline_created_at: string;
-    stall_offline_updated_at: string;
-    stall_offline_deleted_at: string;
-  }
+  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;
+  metadata: {
+    stall_offline_id?: string;
+    stall_offline_created_at?: string;
+    stall_offline_updated_at?: string;
+    stall_offline_deleted_at?: string;
+    [key: string]: any;
+  };
+}
+
+export interface ExtendedUnifiedInventoryLevelType
+  extends UnifiedInventoryLevelType {
+  title: string;
+  thumbnail: string;
+  options: string[];
+  is_new: boolean;
+}
+
+export interface InventoryAdjustmentRequestType {
+  id: string;
+  batch?: string;
+  items: ExtendedUnifiedInventoryLevelType[];
+  reason: string;
+  location_id: string;
+  organization_id: string;
+  device_id: string;
+  staff_id: string;
+  user_id: string;
+  stall_offline_id: string;
+  stall_offline_created_at: string;
+  stall_offline_updated_at: string;
+  stall_offline_deleted_at: string;
+}
+
+export interface UnifiedInventoryLevelChangeLogType {
+  id: string;
+  date: string;
+  inventory_item_id: string;
+  unavailable: number | string;
+  committed: number | string;
+  in_stock: number | string;
+  on_hand: number | string;
+  reason: string;
+  batch: string;
+  device_id: string;
+  staff_id: string;
+  location_id: string;
+  user_id: string;
+  stall_offline_id: string;
+  stall_offline_created_at: string;
+  stall_offline_updated_at: string;
+  stall_offline_deleted_at: string;
+}

package/src/locations.d.ts

@@ -1,14 +1,21 @@
-import { UnifiedTaxRegionType } from "./taxes";
-
-export interface LocationType {
+export interface UnifiedLocationType {
+  id: string;
   name: string;
   address: string;
   city: string;
   country: string;
-  org_id: string;
-  id: string;
+  region: string;
+  base_currency: string;
+  timezone: string;
+  organization_id: string;
   created_at: string;
   updated_at: string;
   active: boolean;
-  region?: UnifiedTaxRegionType;
+  metadata: {
+    stall_offline_id?: string;
+    stall_offline_created_at?: string;
+    stall_offline_updated_at?: string;
+    stall_offline_deleted_at?: string;
+    [key: string]: any;
+  };
 }

package/src/orders.d.ts

@@ -1,5 +1,8 @@
 import type { UnifiedCustomerAddressType } from "./customers";
-import type { UnifiedFulfillmentStatus, UnifiedFulfillmentType } from "./fulfillment";
+import type {
+  UnifiedFulfillmentStatus,
+  UnifiedFulfillmentType,
+} from "./fulfillment";
 import type { UnifiedPaymentCollectionType } from "./payments";
 
 export type UnifiedOrderStatuses =
@@ -50,11 +53,13 @@ export interface UnifiedOrderType {
     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
+  metadata: {
+    stall_offline_id: string;
+    stall_offline_created_at: string;
+    stall_offline_updated_at: string;
+    stall_offline_deleted_at: string;
+    [key: string]: any;
+  }; // Custom metadata
 }
 
 export interface UnifiedLineItemType {
@@ -87,9 +92,10 @@ export interface UnifiedTaxLineType {
 }
 
 export interface UnifiedDiscountType {
+  promotion_id: string;
   code: string;
   amount: number | string; // Discount amount applied
-  type: "percentage" | "fixed" | "code";
+  type: "percentage" | "fixed" | "buy_x_get_y";
   name: string;
   metadata: Record<string, any>;
 }
@@ -145,3 +151,15 @@ export interface UnifiedOrderRefundType {
   stall_offline_updated_at: string;
   stall_offline_deleted_at: string;
 }
+
+export interface UnifiedOrderNote {
+  id: string;
+  order_id: string;
+  note: string;
+  visibility: "internal" | "customer" | "system";
+  source: "admin" | "customer" | "system" | "automation";
+  created_by: string;
+  created_at: string;
+  updated_at: string;
+  metadata: Record<string, unknown>;
+}

package/src/payments.d.ts

@@ -71,94 +71,39 @@ export interface UnifiedPaymentCollectionType {
   provider_id: string;
   payment_method: UnifiedPaymentMethodType;
   note: string;
-  metadata: Record<string, any>;
+  metadata: {
+    stall_offline_id?: string;
+    stall_offline_created_at?: string;
+    stall_offline_updated_at?: string;
+    stall_offline_deleted_at?: string;
+    [key: string]: any;
+  };
 }
 
-export const medusa = {
-  "product": {
-    "variants": [
-      {
-        "prices": [
-          {
-            "id": "string",
-            "title": "string",
-            "currency_code": "usd",
-            "amount": 0,
-            "raw_amount": {},
-            "min_quantity": 0,
-            "max_quantity": 0,
-            "price_set_id": "string",
-            "created_at": "2019-08-24T14:15:22Z",
-            "updated_at": "2019-08-24T14:15:22Z",
-            "deleted_at": "2019-08-24T14:15:22Z"
-          }
-        ],
-        "id": "string",
-        "title": "string",
-        "sku": "string",
-        "barcode": "string",
-        "ean": "string",
-        "upc": "string",
-        "allow_backorder": true,
-        "manage_inventory": true,
-        "hs_code": "string",
-        "origin_country": "string",
-        "mid_code": "string",
-        "material": "string",
-        "weight": 0,
-        "length": 0,
-        "height": 0,
-        "width": 0,
-        "options": [
-          {"id": "string", "value": "string"}
-        ],
-        "created_at": "2019-08-24T14:15:22Z",
-        "updated_at": "2019-08-24T14:15:22Z",
-        "deleted_at": "2019-08-24T14:15:22Z",
-        "images": [
-          {
-            "id": "string",
-            "url": "string",
-            "rank": 0
-          }
-        ],
-        "thumbnail": "string"
-      }
-    ],
-    "type": {
-      "id": "string",
-      "value": "string",
-      "created_at": "2019-08-24T14:15:22Z",
-      "updated_at": "2019-08-24T14:15:22Z"
-    },
-    "length": 0,
-    "title": "string",
-    "status": "draft",
-    "options": [
-      {"id": "string", "title": "string"}
-    ],
-    "description": "string",
-    "id": "string",
-    "created_at": "2019-08-24T14:15:22Z",
-    "updated_at": "2019-08-24T14:15:22Z",
-    "handle": "string",
-    "subtitle": "string",
-    "is_giftcard": true,
-    "thumbnail": "string",
-    "width": 0,
-    "weight": 0,
-    "height": 0,
-    "origin_country": "string",
-    "hs_code": "string",
-    "mid_code": "string",
-    "material": "string",
-    "collection_id": "string",
-    "type_id": "string",
-    "images": [
-      {"id": "string", "url": "string", "rank": 0}
-    ],
-    "discountable": true,
-    "external_id": "string",
-    "deleted_at": "2019-08-24T14:15:22Z"
-  }
+export interface UnifiedFlexSessionType {
+  id: string;
+  device_id: string;
+  staff_id: string;
+  location_id: string;
+  opening_date: number;
+  opening_date_string: string;
+  closing_date: number;
+  closing_date_string: string;
+  last_activity_date: number;
+  duration: number; // Duration in miliseconds
+  opening_cash_balance: number;
+  closing_cash_balance_declared: number;
+  closing_cash_balance_system_calculated: number;
+  cash_difference: number;
+  cash_excess: number;
+  running_cash_balance: number;
+  paid_in: number; // Total value of cash paid into the register during the session
+  paid_out: number; // Total value of cash paid out of the register during the session
+  non_cash_tender_total: number; // Total value of non-cash transactions during the session
+  total_amount: number; // Total value of all transactions
+  number_of_transactions: number;
+  status: "open" | "closed" | "pending";
+  notes: string;
+  closing_remarks: string;
+  metadata: Record<string, any>;
 }

package/src/product.d.ts

@@ -34,7 +34,30 @@ export interface UnifiedProductType {
   low_stock_threshold: number | string; // Low stock threshold specific to the location'
   locations: string[];
   weight: string;
-  metadata: { [key: string]: string }; // add date in milliseconds
+  metadata: {
+    stall_offline_id?: string;
+    stall_offline_created_at?: string;
+    stall_offline_updated_at?: string;
+    stall_offline_deleted_at?: string;
+    [key: string]: any;
+  }; // add date in milliseconds
+}
+
+export interface UnifiedTagProductTag {
+  id: string;
+  name: string;
+  slug: string;
+  description: string;
+  created_at: string;
+  updated_at: string;
+  deleted_at: string;
+  metadata: {
+    stall_offline_id?: string;
+    stall_offline_created_at?: string;
+    stall_offline_updated_at?: string;
+    stall_offline_deleted_at?: string;
+    [key: string]: any;
+  };
 }
 
 export interface UnifiedProductPriceType {
@@ -78,7 +101,13 @@ export interface UnifiedVariantsType {
   weight: string;
   thumbnail: string;
   attributes: UnifiedVariantsAttributeType[];
-  metadata: { [key: string]: string };
+  metadata: {
+    stall_offline_id?: string;
+    stall_offline_created_at?: string;
+    stall_offline_updated_at?: string;
+    stall_offline_deleted_at?: string;
+    [key: string]: any;
+  };
 }
 
 export interface UnifiedVariantsAttributeType {
@@ -106,7 +135,13 @@ export interface UnifiedCategoryType {
   name: string;
   description: string;
   thumbnail: string;
-  metadata: { [key: string]: string };
+  metadata: {
+    stall_offline_id?: string;
+    stall_offline_created_at?: string;
+    stall_offline_updated_at?: string;
+    stall_offline_deleted_at?: string;
+    [key: string]: any;
+  };
   date: string;
   count: number;
   parent_id: string;
@@ -117,7 +152,13 @@ export interface UnifiedCollectionType {
   name: string;
   description: string;
   thumbnail: string;
-  metadata: { [key: string]: string };
+  metadata: {
+    stall_offline_id?: string;
+    stall_offline_created_at?: string;
+    stall_offline_updated_at?: string;
+    stall_offline_deleted_at?: string;
+    [key: string]: any;
+  };
   linked_products: string[];
   linked_categories: string[];
   createAt: string;

package/src/promotions.d.ts

@@ -0,0 +1,82 @@
+export interface UnifiedPromotion {
+  id: string;
+  title: string;
+  code: string;
+  /** Lifecycle */
+  status: "draft" | "active" | "disabled";
+  is_automatic: boolean;
+  /** Limits & usage */
+  usage_limit: number;
+  usage_limit_per_customer?: number;
+  usage_count: number;
+  /** Validity */
+  starts_at: string;
+  ends_at: string;
+  /** Priority & stacking */
+  priority: number;
+  is_stackable: boolean;
+  /** Eligibility */
+  eligibility_rules: UnifiedPromotionRule[];
+  /** How the promotion applies */
+  application: UnifiedPromotionApplication;
+  metadata: {
+    stall_offline_id?: string;
+    stall_offline_created_at?: string;
+    stall_offline_updated_at?: string;
+    stall_offline_deleted_at?: string;
+    [key: string]: unknown;
+  };
+}
+export type UnifiedPromotionApplicationType =
+  | "percentage"
+  | "fixed_amount"
+  | "buy_x_get_y"
+  | "free_shipping"
+  | "gift_card"
+  | "store_credit";
+
+export interface UnifiedPromotionApplication {
+  type: UnifiedPromotionApplicationType;
+  /** Percentage or fixed value (minor units) */
+  value: number;
+  currency: string;
+  /** Target of application */
+  target_type: "items" | "shipping" | "order";
+  /** Allocation strategy */
+  allocation: "each" | "total";
+  /** Quantity constraints */
+  max_quantity: number;
+  /** buy_x_get_y specific */
+  buy_x_get_y: UnifiedBuyXGetYApplication;
+  /** Stored value */
+  balance: number;
+}
+
+export interface UnifiedBuyXGetYApplication {
+  buy_quantity: number;
+  get_quantity: number;
+  /** What qualifies as X */
+  buy_rules: UnifiedPromotionRule[];
+  /** What qualifies as Y */
+  get_rules: UnifiedPromotionRule[];
+  /** Percentage applied to Y */
+  discount_percentage: number;
+  /** Max applications per order */
+  max_applications?: number;
+}
+
+export type UnifiedPromotionRuleAttribute =
+  | "cart_subtotal"
+  | "product_id"
+  | "collection_id"
+  | "customer_id"
+  | "customer_group_id"
+  | "shipping_method";
+
+export interface UnifiedPromotionRule {
+  id: string;
+  description: string;
+  attribute: UnifiedPromotionRuleAttribute;
+  operator: "eq" | "neq" | "gt" | "gte" | "lt" | "lte" | "in" | "not_in";
+  values: string[];
+}

package/src/taxes.d.ts

@@ -9,7 +9,13 @@ export interface UnifiedTaxRegionType {
   postal_codes: string[]; // Specific ZIP codes if applicable
   tax_inclusive: boolean; // Whether prices include tax
   is_default?: boolean; // Whether this is the default region
-  metadata: { [key: string]: string }; // Additional metadata
+  metadata: {
+    stall_offline_id?: string;
+    stall_offline_created_at?: string;
+    stall_offline_updated_at?: string;
+    stall_offline_deleted_at?: string;
+    [key: string]: string;
+  }; // Additional metadata
 }
 
 export interface UnifiedTaxClassType {
@@ -28,5 +34,11 @@ export interface UnifiedTaxRateType {
   code: string; // Optional description
   compound: boolean; // Whether this is a compound tax rate
   priority: number; // Priority order
-  metadata: { [key: string]: any }; // Additional metadata
-}
+  metadata: {
+    stall_offline_id?: string;
+    stall_offline_created_at?: string;
+    stall_offline_updated_at?: string;
+    stall_offline_deleted_at?: string;
+    [key: string]: any;
+  }; // Additional metadata
+}

package/src/register-sessions.d.ts

@@ -1,73 +0,0 @@
-import { Timestamp } from "firebase/firestore";
-
-/* eslint-disable @typescript-eslint/no-explicit-any */
-export interface UnifiedRegisterSessionType {
-  id: string;
-  device_id: string;
-  staff_id: string;
-  location_id: string;
-  opening_date: Timestamp;
-  opening_date_string: string;
-  closing_date: Timestamp;
-  closing_date_string: string;
-  last_activity_date: Timestamp;
-  duration: number; // Duration in miliseconds
-  opening_cash_balance: number;
-  closing_cash_balance_declared: number;
-  closing_cash_balance_system_calculated: number;
-  cash_difference: number;
-  cash_excess: number;
-  running_cash_balance: number;
-  paid_in: number; // Total value of cash paid into the register during the session
-  paid_out: number; // Total value of cash paid out of the register during the session
-  non_cash_tender_total: number; // Total value of non-cash transactions during the session
-  total_amount: number; // Total value of all transactions
-  number_of_transactions: number;
-  status: "open" | "closed" | "pending";
-  notes: string;
-  closing_remarks: string;
-  metadata: Record<string, any>;
-}
-
-export interface UnifiedSessionTransactionType {
-  id: string;
-  date: Timestamp;
-  date_string: string;
-  order_id: string;
-  session_id: string;
-  location_id: string;
-  staff_id: string;
-  transaction_type:
-    | "sale"
-    | "return"
-    | "refund"
-    | "void"
-    | "pay-out"
-    | "pay-in";
-  tender_type: string; // e.g., "Cash", "Credit Card", "Gift Card"
-  total_amount: number;
-  note: string;
-  metadata: Record<string, any>;
-  payment_method: {
-    name: string;
-    id: string;
-  };
-}
-
-export interface UpdateSessionBalanceProps {
-  amount: number;
-  note: string;
-  transaction_type:
-    | "sale"
-    | "return"
-    | "refund"
-    | "void"
-    | "pay-out"
-    | "pay-in";
-  tender_type: string;
-  order_id?: string;
-  payment_method: {
-    name: string;
-    id: string;
-  };
-}