Merge pull request #2577 from Shopify/vic/transaction-complete-types

Add transaction complete event types
Shopify · Jan 22, 2025 · a3a9109 · a3a9109
2 parents 9a3debd + 5074ca0
commit a3a9109
Show file tree

Hide file tree

Showing 9 changed files with 110 additions and 16 deletions.
diff --git a/.changeset/large-laws-breathe.md b/.changeset/large-laws-breathe.md
@@ -0,0 +1,6 @@
+---
+'@shopify/ui-extensions': minor
+'@shopify/ui-extensions-react': minor
+---
+
+Adds POS UI Extension: TransactionCompleteInput property typing and payment interfaces
diff --git a/packages/ui-extensions/src/surfaces/point-of-sale/api.ts b/packages/ui-extensions/src/surfaces/point-of-sale/api.ts
@@ -91,8 +91,12 @@ export type {
   LineItemDiscount,
   CustomSale,
   Address,
+  ShippingLine,
+  TaxLine,
 } from './types/cart';
 
+export type {PaymentMethod} from './types/payment';
+
 export type {MultipleResourceResult} from './types/multiple-resource-result';
 
 export type {PaginatedResult} from './types/paginated-result';

diff --git a/packages/ui-extensions/src/surfaces/point-of-sale/event/input/PurchaseCompleteInput.ts b/packages/ui-extensions/src/surfaces/point-of-sale/event/input/PurchaseCompleteInput.ts
diff --git a/packages/ui-extensions/src/surfaces/point-of-sale/event/input/TransactionCompleteInput.ts b/packages/ui-extensions/src/surfaces/point-of-sale/event/input/TransactionCompleteInput.ts
@@ -0,0 +1,20 @@
+import {
+  Discount,
+  LineItem,
+  PaymentMethod,
+  ShippingLine,
+  TaxLine,
+} from '../../api';
+import {BaseInput} from './BaseInput';
+
+export interface TransactionCompleteInput extends BaseInput {
+  transactionComplete: {
+    discounts: Discount[];
+    draftCheckoutId: number;
+    lineItems: LineItem[];
+    orderId?: number;
+    paymentMethods: PaymentMethod[];
+    shippingLines?: ShippingLine;
+    taxLines?: TaxLine[];
+  };
+}
diff --git a/packages/ui-extensions/src/surfaces/point-of-sale/event/targets.ts b/packages/ui-extensions/src/surfaces/point-of-sale/event/targets.ts
@@ -4,11 +4,11 @@ import {
   CashTrackingSessionCompleteInput,
   CashTrackingSessionCancelInput,
 } from './input/CashTrackingSessionInput';
-import {PurchaseCompleteInput} from './input/PurchaseCompleteInput';
+import {TransactionCompleteInput} from './input/TransactionCompleteInput';
 
 export interface EventExtensionTargets {
   'pos.transaction-complete.event.observe': (
-    input: PurchaseCompleteInput,
+    input: TransactionCompleteInput,
   ) => BaseIntent;
   'pos.cash-tracking-session-start.event.observe': (
     input: CashTrackingSessionStartInput,

diff --git a/packages/ui-extensions/src/surfaces/point-of-sale/input.ts b/packages/ui-extensions/src/surfaces/point-of-sale/input.ts
@@ -1,4 +1,4 @@
 export type {BaseInput} from './event/input/BaseInput';
-export type {PurchaseCompleteInput} from './event/input/PurchaseCompleteInput';
+export type {TransactionCompleteInput} from './event/input/TransactionCompleteInput';
 
 export type {Device} from './types/device';
diff --git a/packages/ui-extensions/src/surfaces/point-of-sale/types/cart.ts b/packages/ui-extensions/src/surfaces/point-of-sale/types/cart.ts
@@ -34,6 +34,7 @@ export interface LineItem {
   vendor?: string;
   properties: {[key: string]: string};
   isGiftCard: boolean;
+  attributedUserId?: number;
 }
 
 export interface Discount {
@@ -107,3 +108,29 @@ export interface Address {
   provinceCode?: string;
   countryCode?: CountryCode;
 }
+
+export type ShippingLine = CalculatedShippingLine | CustomShippingLine;
+
+export interface CalculatedShippingLine {
+  uuid: string;
+  price: string;
+  title: string;
+  methodType: 'SHIPPING' | 'RETAIL';
+  type: 'Calculated';
+}
+
+export interface CustomShippingLine {
+  uuid: string;
+  price: string;
+  title: string;
+  type: 'Custom';
+}
+
+export interface TaxLine {
+  uuid: string;
+  price: string;
+  rate: number;
+  rateRange?: {min: number; max: number};
+  title: string;
+  enabled: boolean;
+}
diff --git a/packages/ui-extensions/src/surfaces/point-of-sale/types/device.ts b/packages/ui-extensions/src/surfaces/point-of-sale/types/device.ts
@@ -4,9 +4,9 @@ export interface Device {
    */
   name: string;
   /**
-   * The string ID of the device
+   * The ID of the device
    */
-  deviceId: string;
+  deviceId: number;
   /**
    * Whether the device is a tablet
    */

diff --git a/packages/ui-extensions/src/surfaces/point-of-sale/types/payment.ts b/packages/ui-extensions/src/surfaces/point-of-sale/types/payment.ts
@@ -0,0 +1,48 @@
+export type PaymentMethod =
+  | CashPayment
+  | CreditPayment
+  | GiftCardPayment
+  | ShopPayPayment
+  | CustomPayment
+  | UnknownPayment;
+
+export type CardSource = 'manual' | 'swiped' | 'emv';
+
+interface BasePayment {
+  amount: string;
+}
+
+interface CreditPayment extends BasePayment {
+  type: 'CreditCard';
+  brand: string;
+  tipAmount: string;
+  cardSource?: CardSource;
+  hasPendingOfflineTransactions: boolean;
+}
+
+interface CashPayment extends BasePayment {
+  type: 'Cash';
+  changeAmount: string;
+  roundedAmount?: string;
+}
+
+interface GiftCardPayment extends BasePayment {
+  type: 'GiftCard';
+  lastCharacters: string;
+  balance?: string;
+}
+
+interface ShopPayPayment extends BasePayment {
+  type: 'ShopPay';
+  isInstallmentsPayment: boolean;
+  orderTransactionId?: string;
+}
+
+interface CustomPayment extends BasePayment {
+  type: 'Custom';
+  name: string;
+}
+
+interface UnknownPayment extends BasePayment {
+  type: 'Unknown';
+}