POS: Receipt Printer #1964

Talej · 2024-01-28T08:19:11Z

Description

Receipt printing functionality for android. Ended up using react-native-print package with a HTML template for receipt layout. The layout should pretty closely match the details shown on the 'Order' view for a paid order.

A print receipt button is shown on the payment completed view and also on the order view for paid orders if:

It's an android device
invoice has been paid
receipt printing isn't disabled in settings

react-native-print doesn't have any way of detecting if there is a printer ahead of calling the print dialog so to handle this I added the disable printer option under the POS settings.

I thought it could possibly also be useful to allow the receipt template HTML to be configuration in the POS settings - although given it is HTML this could be somewhat painful the edit on a device so wanted your input on this...

This pull request is categorized as a:

Checklist

I’ve run yarn run tsc and made sure my code compiles correctly
I’ve run yarn run lint and made sure my code didn’t contain any problematic patterns
I’ve run yarn run prettier and made sure my code is formatted correctly
I’ve run yarn run test and made sure all of the tests pass

Testing

If you modified or added a utility file, did you add new unit tests?

No, I’m a fool
Yes
N/A

I have tested this PR on the following platforms (please specify OS version and phone model/VM):

Android
iOS

I have tested this PR with the following types of nodes (please specify node version and API version where appropriate):

Locales

I’ve added new locale text that requires translations
I’m aware that new translations should be made on the ZEUS Transfix page and not directly to this repo

Third Party Dependencies and Packages

Contributors will need to run yarn after this PR is merged in
3rd party dependencies have been modified:
- verify that package.json and yarn.lock have been properly updated
- verify that dependencies are installed for both iOS and Android platforms

Other:

Changes were made that require an update to the README
Changes were made that require an update to onboarding

Talej · 2024-01-28T08:22:19Z

kaloudis · 2024-01-30T16:06:36Z

I wonder if it's worth distinguishing Print Invoice / Print Receipt depending on where we are in the flow

Talej · 2024-01-30T21:15:06Z

I wonder if it's worth distinguishing Print Invoice / Print Receipt depending on where we are in the flow

Do you mean have a Print Invoice on the order screen before it is paid and Print Receipt after paid?

kaloudis · 2024-01-31T00:34:26Z

I wonder if it's worth distinguishing Print Invoice / Print Receipt depending on where we are in the flow

Do you mean have a Print Invoice on the order screen before it is paid and Print Receipt after paid?

Precisely, and perhaps we add the payment pre-image on the receipt to distinguish them and act as a bit of payment proof

kaloudis · 2024-01-31T00:35:48Z

Another nit: the header. Instead of Tax Receipt maybe we leverage the store name (not sure if it's currently exposed in the Standalone POS config - if not would be nice to leverage like we do for Square and add to the invoice memo as well as the receipt title here)

Talej · 2024-02-05T04:02:10Z

Added merchant name setting for standalone POS
Added merchant name in print title, falls back on Tax Receipt / Tax Invoice
Added Print Invoice option on un-paid orders
Added preimage to paid receipt
Fixed issue with missing payment details

kaloudis · 2024-02-07T04:48:27Z

package.json

@@ -111,6 +111,7 @@
    "react-native-notifications": "5.1.0",
    "react-native-os": "aprock/react-native-os#5/head",
    "react-native-permissions": "3.8.0",
+    "react-native-print": "^0.11.0",


let's lock in the version number here

kaloudis · 2024-02-07T04:50:19Z

views/Order.tsx

+                    ? merchantName
+                    : isPaid
+                    ? 'Tax Receipt'
+                    : 'Invoice';


We need these titles localized

kaloudis · 2024-02-09T17:59:35Z

Nice job only showing the printer setting for Android, but I think it would be better to make it opt in rather than opt out as most merchants likely won't have a printer module.

Talej · 2024-02-10T06:43:07Z

Nice job only showing the printer setting for Android, but I think it would be better to make it opt in rather than opt out as most merchants likely won't have a printer module.

Makes total sense. Flipped the setting from disable to enable.

kaloudis · 2024-02-13T15:59:29Z

locales/en.json

    "pos.views.Settings.PointOfSale.authWarning": "Warning: no password or PIN set",
    "pos.views.Settings.PointOfSale.backendWarning": "Warning: currently only LND nodes are able to mark orders as paid",
    "pos.views.Settings.PointOfSale.currencyError": "Error: currency must be set first",
+    "pos.print.taxReceipt": "Tax Receipt",


nit: can we just make this Receipt instead of Tax Receipt

kaloudis · 2024-02-13T16:00:02Z

@Talej can you provide an example of what these receipts look like when the merchant provides their store name in settings?

Talej · 2024-02-15T06:06:18Z

@Talej can you provide an example of what these receipts look like when the merchant provides their store name in settings?

shubhamkmr04

It would be better if we give a paddingBottom here.

shubhamkmr04

Also can we also handle the case so the user don't get this error if the device is not connected to a printer.

Talej · 2024-02-19T03:57:03Z

Also can we also handle the case so the user don't get this error if the device is not connected to a printer.

This actually looks like the package isn't loading for you rather than anything to do with not connecting to a printer.

I have tried with various devices and even if there is no printer it still works without error (it gives an option to export as PDF). I have added in some extra checks to prevent the error but would be useful if you could debug a bit further to see why it wasn't loading.

shubhamkmr04 · 2024-02-19T08:03:42Z

This actually looks like the package isn't loading for you rather than anything to do with not connecting to a printer.

I have tried with various devices and even if there is no printer it still works without error (it gives an option to export as PDF). I have added in some extra checks to prevent the error but would be useful if you could debug a bit further to see why it wasn't loading.

Ah, got it! I managed to pinpoint the issue on my end, and now I'm getting the option to download PDFs. Thanks!

shubhamkmr04 · 2024-02-19T08:05:34Z

views/Order.tsx

@@ -116,7 +116,8 @@ export default class OrderView extends React.Component<OrderProps, OrderState> {
        const { changeUnits, units } = UnitsStore;
        const fiat = settings.fiat;
        const disableTips: boolean = settings?.pos?.disableTips || false;
-        const enablePrinter: boolean = settings?.pos?.enablePrinter || false;
+        const enablePrinter: boolean =
+            (settings?.pos?.enablePrinter && RNPrint) || false;


I guess we can remove this condition now, so the user can see the PRINT button even if the printer is not connected and use it to download the receipt.

possibly can't hurt to leave it in there just in case

shubhamkmr04

tACK

kaloudis

LGTM. Great job, @Talej!

Talej added 3 commits January 28, 2024 19:01

Initial receipt printer implementation

dfca1ac

removed unused line

2399311

Merge branch 'master' into receipts

6db5132

kaloudis changed the title ~~Receipt Printer~~ POS: Receipt Printer Jan 28, 2024

kaloudis added this to the v0.8.2 milestone Jan 28, 2024

kaloudis added the Point of Sale label Jan 31, 2024

feedback changes

c1ccafa

kaloudis reviewed Feb 7, 2024

View reviewed changes

Talej added 2 commits February 7, 2024 16:11

feedback changes

fa329f9

missed lockfiles

ca4ba57

Flipped disable printer setting to enable printer

d3de193

kaloudis reviewed Feb 13, 2024

View reviewed changes

Changed Tax Receipt to Receipt

9c1e8f8

shubhamkmr04 reviewed Feb 16, 2024

View reviewed changes

Talej added 2 commits February 19, 2024 14:48

detect RNPrint loaded

29bd63f

Merge branch 'master' into receipts

95621d0

shubhamkmr04 reviewed Feb 19, 2024

View reviewed changes

shubhamkmr04 approved these changes Feb 23, 2024

View reviewed changes

kaloudis approved these changes Feb 23, 2024

View reviewed changes

kaloudis merged commit a24349e into ZeusLN:master Feb 23, 2024
3 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

POS: Receipt Printer #1964

POS: Receipt Printer #1964

Talej commented Jan 28, 2024

Talej commented Jan 28, 2024

kaloudis commented Jan 30, 2024

Talej commented Jan 30, 2024

kaloudis commented Jan 31, 2024

kaloudis commented Jan 31, 2024

Talej commented Feb 5, 2024

kaloudis Feb 7, 2024

Talej Feb 7, 2024

kaloudis Feb 7, 2024

Talej Feb 7, 2024

kaloudis commented Feb 9, 2024

Talej commented Feb 10, 2024

kaloudis Feb 13, 2024

kaloudis commented Feb 13, 2024

Talej commented Feb 15, 2024

shubhamkmr04 left a comment

shubhamkmr04 left a comment

Talej commented Feb 19, 2024

shubhamkmr04 commented Feb 19, 2024

shubhamkmr04 Feb 19, 2024

Talej Feb 19, 2024

shubhamkmr04 left a comment

kaloudis left a comment

POS: Receipt Printer #1964

POS: Receipt Printer #1964

Conversation

Talej commented Jan 28, 2024

Description

Checklist

Testing

Locales

Third Party Dependencies and Packages

Other:

Talej commented Jan 28, 2024

kaloudis commented Jan 30, 2024

Talej commented Jan 30, 2024

kaloudis commented Jan 31, 2024

kaloudis commented Jan 31, 2024

Talej commented Feb 5, 2024

kaloudis Feb 7, 2024

Choose a reason for hiding this comment

Talej Feb 7, 2024

Choose a reason for hiding this comment

kaloudis Feb 7, 2024

Choose a reason for hiding this comment

Talej Feb 7, 2024

Choose a reason for hiding this comment

kaloudis commented Feb 9, 2024

Talej commented Feb 10, 2024

kaloudis Feb 13, 2024

Choose a reason for hiding this comment

kaloudis commented Feb 13, 2024

Talej commented Feb 15, 2024

shubhamkmr04 left a comment

Choose a reason for hiding this comment

shubhamkmr04 left a comment

Choose a reason for hiding this comment

Talej commented Feb 19, 2024

shubhamkmr04 commented Feb 19, 2024

shubhamkmr04 Feb 19, 2024

Choose a reason for hiding this comment

Talej Feb 19, 2024

Choose a reason for hiding this comment

shubhamkmr04 left a comment

Choose a reason for hiding this comment

kaloudis left a comment

Choose a reason for hiding this comment