Add pos.prepare-receipt.inject extension target #2597
Conversation
| payments: { | ||
| paymentMethod: PaymentMethod; | ||
| amount: number; | ||
| }[]; |
There was a problem hiding this comment.
@js-goupil This is something to align with checkout-complete
| export enum PrepareReceiptAdditionalLineType { | ||
| Header = 'Header', | ||
| Text = 'Text', | ||
| List = 'List', | ||
| // eslint-disable-next-line @shopify/typescript/prefer-pascal-case-enums | ||
| QRCode = 'QRCode', | ||
| } |
There was a problem hiding this comment.
This is existing ComplianceLines that we can parse. (Except we now use type to detect an error message
Alex-Palad
force-pushed
the
compliance/pos.prepare-receipt.inject-target
branch
2 times, most recently
from
96ace32 to
e465645
Compare
| import {TransactionCompleteInput} from './TransactionCompleteInput'; | ||
|
|
||
| export interface PrepareReceiptInput { | ||
| prepareReceipt: TransactionCompleteInput['transactionComplete']; |
There was a problem hiding this comment.
It uses the same input data as TransactionComplete
We still need separate interface to be flexible, and modify this interface without affecting CheckoutComplete
There was a problem hiding this comment.
Should we opt for a PrepareReceiptInput extends TransactionCompleteInput instead? Alternatively we can move the contents of TransactionCompleteInput into a separate interface called PosCheckout and both inputs can extend that and be empty for now
| @@ -0,0 +1,19 @@ | |||
| import {BaseIntent} from './BaseIntent'; | |||
|
|
|||
| export enum PrepareReceiptAdditionalLineType { | |||
There was a problem hiding this comment.
enums have caused us a lot of headaches with typescript when exporting/importing on the POS side. Can we switch to a type instead?
| | 'List' | ||
| | 'QRCode' | ||
| | 'Error'; | ||
| export interface PrepareReceiptAdditionalLine { |
There was a problem hiding this comment.
Add a line above here please
There was a problem hiding this comment.
Also can we add some inline documentation here? Or was this going to be a follow up task? Remember that the in line docs automatically get compiled into the developer docs, so it's super helpful
There was a problem hiding this comment.
Added some inline doc with examples, but we will need a dedicated page with pictures to show how different lines look
62f2ea6
| @@ -61,6 +61,21 @@ Refer to the [migration guide](/docs/api/pos-ui-extensions/migrating) for more i | |||
| - Removed in POS version: N/A | |||
| - Release day: 1/6/2025 | |||
| ### Features | |||
| - Added support for the ${TargetLink.PosPrepareReceiptInject} target. | |||
There was a problem hiding this comment.
I've been out of the loop for dates but shouldn't this be under the 2025.04 release? Also this addition is duplicated, we have two 2025.01 sections in the version doc now
There was a problem hiding this comment.
Good catch, thank you
Fixed
Alex-Palad
force-pushed
the
compliance/pos.prepare-receipt.inject-target
branch
from
b3c23ad to
a677b87
Compare
|
/shipit |
Background
Part 1/3 of https://github.com/Shopify/retail-hq-store-management/issues/743
Resolves https://github.com/Shopify/retail-hq-store-management/issues/744
Solution
Use this doc to add new event-initiated extension target
🎩
Checklist