Add transaction complete event types #2577
Merged
+110
−16
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vctrchu
requested review from
fatbattk,
NathanJolly,
js-goupil and
Alex-Palad
This comment has been minimized.
This comment has been minimized.
vctrchu
commented
Jan 22, 2025
| @@ -34,6 +34,7 @@ export interface LineItem { | |||
| vendor?: string; | |||
| properties: {[key: string]: string}; | |||
| isGiftCard: boolean; | |||
| attributedUserId?: number; | |||
There was a problem hiding this comment.
attributedStaff is known as attributedUserId as defined in the POS model CheckoutLineItem
There was a problem hiding this comment.
Nice, we'll have to map this value over for the cart api as well just fyi
vctrchu
commented
Jan 22, 2025
packages/ui-extensions/src/surfaces/point-of-sale/types/cart.ts
Outdated
Show resolved
Hide resolved
vctrchu
commented
Jan 22, 2025
| @@ -107,3 +108,84 @@ export interface Address { | |||
| provinceCode?: string; | |||
| countryCode?: CountryCode; | |||
| } | |||
|
|
|||
| export type ShippingLine = | |||
There was a problem hiding this comment.
POS model of ShippingLine
vctrchu
commented
Jan 22, 2025
| Retail = 'RETAIL', | ||
| } | ||
|
|
||
| export interface TaxLine { |
There was a problem hiding this comment.
POS model of TaxLine
vctrchu
commented
Jan 22, 2025
packages/ui-extensions/src/surfaces/point-of-sale/event/input/PurchaseCompleteInput.ts
Outdated
Show resolved
Hide resolved
fatbattk
reviewed
Jan 22, 2025
packages/ui-extensions/src/surfaces/point-of-sale/event/input/PurchaseCompleteInput.ts
Outdated
Show resolved
Hide resolved
packages/ui-extensions/src/surfaces/point-of-sale/types/cart.ts
Outdated
Show resolved
Hide resolved
packages/ui-extensions/src/surfaces/point-of-sale/types/cart.ts
Outdated
Show resolved
Hide resolved
js-goupil
reviewed
Jan 22, 2025
packages/ui-extensions/src/surfaces/point-of-sale/types/cart.ts
Outdated
Show resolved
Hide resolved
js-goupil
reviewed
Jan 22, 2025
packages/ui-extensions/src/surfaces/point-of-sale/types/cart.ts
Outdated
Show resolved
Hide resolved
packages/ui-extensions/src/surfaces/point-of-sale/types/cart.ts
Outdated
Show resolved
Hide resolved
js-goupil
approved these changes
Jan 22, 2025
packages/ui-extensions/src/surfaces/point-of-sale/event/input/TransactionCompleteInput.ts
Show resolved
Hide resolved
| lineItems: LineItem[]; | ||
| orderId: number; | ||
| paymentMethods: PaymentMethod[]; | ||
| shippingLines: ShippingLine; |
There was a problem hiding this comment.
I think this is also optional
There was a problem hiding this comment.
Add optional values for
- orderId - checkout interface
- shippingLines - checkout interface
- taxLines - checkout interface
|
|
||
| interface CreditPayment extends BasePayment { | ||
| type: 'CreditCard'; | ||
| lastDigits: string; |
There was a problem hiding this comment.
let's remove this field until we're sure we need it. cc @Alex-Palad
js-goupil
reviewed
Jan 22, 2025
packages/ui-extensions/src/surfaces/point-of-sale/event/targets.ts
Outdated
Show resolved
Hide resolved
Add changeset Fix optionals and remove last digits
vctrchu
force-pushed
the
vic/transaction-complete-types
branch
from
90f01bf to
5074ca0
Compare
js-goupil
approved these changes
Jan 22, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves https://github.com/Shopify/pos-next-react-native/issues/51358
Background
This PR adds proper typing to each property for a transaction complete input. It also encapsulates all the properties in a object to improve usability and seperation from the BaseInput properties. You can find the file for POS
CheckoutStatehereBefore:
After:
Solution
I just copied a lot of the checkout types over. We will need to refactor and remove some definitions. Please help me align with what exact properties we want to define in each of our types of
TaxLines,ShippingLineandPaymentMethod