@use-stall/types 0.3.17 → 0.4.0

package/package.json

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

package/src/device.d.ts

@@ -7,6 +7,7 @@ export interface DeviceType {
   organization: string;
   locations: string[];
   name: string;
+  type: "terminal" | "flex";
   description: string;
   code: string;
   paired: boolean;

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;