@use-stall/types 0.2.4 → 0.2.6

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@use-stall/types",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "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

@@ -1,4 +1,4 @@
-type ModuleKey =
+export type ConnectorModuleKey =
   | "products"
   | "variants"
   | "collections"
@@ -24,7 +24,7 @@ type ModuleKey =
   | "fulfillments"; // Individual fulfillment instances for an order
 
 export interface ConnectorModulesType {
-  [key in ModuleKey]: {
+  [key in ConnectorModuleKey]: {
     supported: boolean;
     actions: {
       create: boolean;

package/src/fulfillment.d.ts

@@ -1,5 +1,5 @@
 import type { UnifiedCustomerAddressType } from "./customers";
-export type FulfillmentMethods =
+export type UnifiedFulfillmentMethods =
   | "shipment" // via carrier / courier to an address
   | "local_delivery" // delivered by merchant or local fleet
   | "pickup" // customer picks up at a physical location / collection
@@ -7,25 +7,25 @@ export type FulfillmentMethods =
   | "digital" // purely digital delivery (email, download, etc.)
   | "service"; // in-person or remote service fulfillment
 
-export interface FulfillmentProvider {
+export interface UnifiedFulfillmentProvider {
   id: string;
   title: string;
   description: string;
   logo: string;
-  supported_methods: FulfillmentMethodType[];
+  supported_methods: UnifiedFulfillmentMethodType[];
   supported_countries: string[];
   integration_url: string;
   integration_docs: string;
   active: boolean;
 }
 
-export interface FulfillmentMethodType {
-  type: FulfillmentMethods;
+export interface UnifiedFulfillmentMethodType {
+  type: UnifiedFulfillmentMethods;
   offline_support: boolean;
   instant: boolean; // whether the fulfillment is done instantly like collection/pickup
 }
 
-export interface FulfillmentProviderConfigType {
+export interface UnifiedFulfillmentProviderConfigType {
   id: string;
   provider: string; // provider id
   mode: "live" | "test";
@@ -36,7 +36,7 @@ export interface FulfillmentProviderConfigType {
   updated_at: string;
 }
 
-export type FulFillmentStatus =
+export type UnifiedFulfillmentStatus =
   | "pending"
   | "packing"
   | "dispatched"
@@ -45,7 +45,7 @@ export type FulFillmentStatus =
   | "cancelled"
   | "returned";
 
-export interface FulFillmentLineItem {
+export interface UnifiedFulfillmentLineItem {
   id: string;
   sku: string;
   name: string;
@@ -59,7 +59,7 @@ export interface FulFillmentLineItem {
   amount: number;
 }
 
-export interface OrderFulfillment {
+export interface UnifiedFulfillmentType {
   id: string;
   order_id: string;
   tracking_number: string;

package/src/orders.d.ts

@@ -1,23 +1,28 @@
 import type { UnifiedCustomerAddressType } from "./customers";
+import type { UnifiedFulfillmentStatus, UnifiedFulfillmentType } from "./fulfillment";
+import type { UnifiedPaymentCollectionType } from "./payments";
+
+export type UnifiedOrderStatuses =
+  | "pending"
+  | "processing"
+  | "completed"
+  | "cancelled"
+  | "failed"
+  | "on-hold"
+  | "refunded"
+  | "partially refunded"
+  | "trash";
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
 export interface UnifiedOrderType {
   id: string;
   location_id: string;
   organization_id: string;
+  channel_id: string;
   device_id: string;
   staff_id: string;
   order_number: string;
-  status:
-    | "pending"
-    | "processing"
-    | "completed"
-    | "cancelled"
-    | "failed"
-    | "on-hold"
-    | "refunded"
-    | "partially refunded"
-    | "trash";
+  status: UnifiedOrderStatuses;
   created_at: string;
   updated_at: string;
   origin: { name: string; id: string; version: string; [key: string]: string };
@@ -35,7 +40,10 @@ export interface UnifiedOrderType {
   tax_lines: UnifiedTaxLineType[]; // Array of applied taxes
   discount: number | string; // Discount for this item
   discounts: UnifiedDiscountType[];
-  fulfillment: UnifiedFulfillmentType;
+  fulfillment: {
+    status: UnifiedFulfillmentStatus;
+    fulfillments: UnifiedFulfillmentType;
+  };
   refunds: {
     id: string;
     reason: string;
@@ -88,100 +96,16 @@ export interface UnifiedDiscountType {
 
 export interface UnifiedOrderPaymentDetailsType {
   total_amount: number;
+  tip_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;
+  payments: UnifiedPaymentCollectionType[];
+  status: "pending" | "processing" | "paid" | "partially_paid";
   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";
@@ -211,13 +135,7 @@ export interface UnifiedOrderRefundType {
     name: string;
     cost_per_item: number;
   }[];
-  refund_method: {
-    id: string;
-    name: string;
-    status: string;
-    transaction_id: string;
-    refunded_amount: string | number;
-  };
+  payments: UnifiedPaymentCollectionType[];
   staff_id: string;
   device_id: string;
   location_id: string;

package/src/organizations.d.ts

@@ -25,6 +25,9 @@ export interface OrganizationType {
   created_at: number;
   updated_at: number;
   connector?: ConnectorConfigurationType;
+  timezone: string;
+  onboarded: boolean;
+  country: string;
 }
 
 export interface ReceiptType {

package/src/payments.d.ts

@@ -1,4 +1,4 @@
-export type MethodsType =
+export type UnifiedMethodsType =
   | "terminal"
   | "soft_pos" // mobile tap to pay on android and ios
   | "online_checkout"
@@ -8,25 +8,25 @@ export type MethodsType =
   | "cash"
   | "manual";
 
-export interface PaymentProviderType {
+export interface UnifiedPaymentProviderType {
   id: string;
   title: string;
   description: string;
   logo: string;
-  supported_methods: PaymentMethodType[];
+  supported_methods: UnifiedPaymentMethodType[];
   supported_countries: string[];
   integration_url: string;
   integration_docs: string;
   active: boolean;
 }
 
-export interface PaymentMethodType {
-  type: MethodsType;
+export interface UnifiedPaymentMethodType {
+  type: UnifiedMethodsType;
   offline_support: boolean;
   instant_clear: boolean; // whether the payment is cleared instantly like cash or custom
 }
 
-export interface PaymentProviderConfigType {
+export interface UnifiedPaymentProviderConfigType {
   id: string;
   provider: string; // provider id
   mode: "live" | "test";
@@ -38,28 +38,127 @@ export interface PaymentProviderConfigType {
   updated_at: string;
 }
 
-export type PaymentCollectionStatus =
+export type UnifiedPaymentCollectionStatus =
   | "pending"
   | "processing"
   | "completed"
   | "failed"
-  | "cancelled"
-  | "refunded"
-  | "partially_refunded";
+  | "cancelled";
 
-export interface PaymentCollectionType {
+export type UnifiedPaymentCollectionTransactionType =
+  | "sale"
+  | "return"
+  | "refund"
+  | "void"
+  | "pay-out"
+  | "pay-in";
+
+export interface UnifiedPaymentCollectionType {
   id: string;
+  order_id: string;
+  user_id: string;
+  session_id: string;
   organization: string;
   location: string;
   created_at: string;
   updated_at: string;
-  status: PaymentCollectionStatus;
+  status: UnifiedPaymentCollectionStatus;
+  type: UnifiedPaymentCollectionTransactionType;
   amount: {
     currency: string;
     value: number;
   };
   provider_id: string;
-  payment_method: PaymentMethodType;
+  payment_method: UnifiedPaymentMethodType;
   note: string;
   metadata: Record<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"
+  }
+}

package/src/product.d.ts

@@ -9,6 +9,7 @@ export interface UnifiedProductType {
   created_at: string;
   updated_at: string;
   deleted_at: string;
+  channels: string[]; // Channel ids of where this product is available
   status: "draft" | "private" | "publish" | "pending";
   type: "simple" | "variable" | "grouped";
   thumbnail: string;
@@ -24,118 +25,27 @@ export interface UnifiedProductType {
   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
+  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
+  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 {
+export interface UnifiedProductPriceType {
   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;
+  currency_code: string;
+  amount: number;
   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;
+  updated_at: string;
+  deleted_at: string;
+  channel_id: string;
 }
 
 export interface UnifiedAttributeType {