@use-stall/types 0.3.18 → 0.5.0

package/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./src/billing-payments";
+export * from "./src/catalog";
 export * from "./src/components";
 export * from "./src/customers";
 export * from "./src/device";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@use-stall/types",
-  "version": "0.3.18",
+  "version": "0.5.0",
   "description": "Type declarations for Stall SDKs",
   "types": "index.d.ts",
   "type": "module",

package/src/catalog.d.ts

@@ -0,0 +1,58 @@
+import {
+  UnifiedAttributeType,
+  UnifiedVariantsAttributeType,
+  UnifiedProductImagesType,
+} from "./product";
+
+/**
+ * The sellable projection of a product variant — a product/variant/inventory join, already
+ * scoped to one location and one sales channel. Computed server-side (stall-database) so
+ * every consumer (Terminal, any other channel) gets the same answer for "what can I sell,
+ * at what price, and how much is there" without doing any of that joining itself.
+ */
+export interface UnifiedCatalogVariantType {
+  id: string; // variant id
+  title: string;
+  description: string;
+  thumbnail: string;
+  sku: string;
+  barcode: string;
+  price: number;
+  sale_price: number;
+  price_currency: string;
+  on_sale: boolean;
+  default: boolean;
+  attributes: UnifiedVariantsAttributeType[]; // this variant's selected options, e.g. [{ name: "Size", option: "M" }]
+  inventory: {
+    unavailable: number; // at this location
+    committed: number; // at this location
+    in_stock: number; // at this location — available for new orders
+    on_hand: number; // at this location
+  };
+}
+
+/**
+ * A sellable product — the entity Terminal (and any other selling channel) should fetch
+ * instead of raw products. Only published products/variants that are assigned to the
+ * requested location and sales channel are ever included; nothing here needs client-side
+ * filtering or computation.
+ */
+export interface UnifiedCatalogType {
+  id: string; // product id
+  title: string;
+  handle: string;
+  description: string;
+  body_html: string;
+  thumbnail: string;
+  images: UnifiedProductImagesType[];
+  tax_class: string;
+  taxable: boolean;
+  categories: string[];
+  collections: string[];
+  brand: string;
+  tags: string[];
+  track_inventory: boolean; // from this product's default (or first) sellable variant
+  attributes: UnifiedAttributeType[]; // the axes of variation, e.g. [{ name: "Size", options: ["S","M","L"] }]
+  variants: CatalogVariantType[]; // already filtered to this location + sales channel
+  stock: number; // combined in_stock across variants, at this location
+}

package/src/payments.d.ts

@@ -33,6 +33,22 @@ export interface UnifiedPaymentMethodType {
   instant_clear: boolean; // whether the payment is cleared instantly like cash or custom
 }
 
+// The method actually used to collect one specific payment — richer than
+// UnifiedPaymentMethodType (which just describes what a provider supports), since it
+// captures the named device config and this collection's own details. No optional fields —
+// original_amount/cash always carry real (possibly zero) values so callers never need to
+// null-check them.
+export interface UnifiedChargedPaymentMethodType extends UnifiedPaymentMethodType {
+  name: string;
+  method_id: string; // the device's payment-method serial/reference; distinct from the
+  // top-level UnifiedPaymentCollectionType.external_id (an external provider's own reference)
+  original_amount: number;
+  cash: {
+    tendered: number;
+    change: number;
+  };
+}
+
 export interface UnifiedPaymentProviderConfigType {
   id: string;
   provider: string; // provider id
@@ -53,7 +69,8 @@ export interface UnifiedPaymentProviderConfigType {
 
 export interface FrontendPaymentMethodType {
   id: string;
-  provider: {
+  // Absent for methods with no payment gateway to resolve, e.g. cash.
+  provider?: {
     id: string; // provider id
     name: string;
     logo: string;
@@ -98,7 +115,7 @@ export interface UnifiedPaymentCollectionType {
   };
   provider_id: string;
   external_id: string;
-  payment_method: UnifiedPaymentMethodType;
+  payment_method: UnifiedChargedPaymentMethodType;
   note: string;
   device: {
     id: string;