Merge pull request #1074 from AbleKSaju/feat-pos-print-template

feat: print template for POS
frappe · Jan 3, 2025 · cdeb7a9 · cdeb7a9
2 parents 74bd577 + fda3718
commit cdeb7a9
Show file tree

Hide file tree

Showing 12 changed files with 245 additions and 26 deletions.
diff --git a/main/getPrintTemplates.ts b/main/getPrintTemplates.ts
@@ -2,7 +2,7 @@ import fs from 'fs/promises';
 import path from 'path';
 import { TemplateFile } from 'utils/types';
 
-export async function getTemplates() {
+export async function getTemplates(posTemplateWidth?: number) {
   const paths = await getPrintTemplatePaths();
   if (!paths) {
     return [];
@@ -13,7 +13,17 @@ export async function getTemplates() {
     const filePath = path.join(paths.root, file);
     const template = await fs.readFile(filePath, 'utf-8');
     const { mtime } = await fs.stat(filePath);
-    templates.push({ template, file, modified: mtime.toISOString() });
+    const width =
+      file?.split('-')[1]?.split('.')[0] === 'POS' ? posTemplateWidth ?? 0 : 0;
+    const height = file?.split('-')[1]?.split('.')[0] === 'POS' ? 22 : 0;
+
+    templates.push({
+      template,
+      file,
+      modified: mtime.toISOString(),
+      width,
+      height,
+    });
   }
 
   return templates;

diff --git a/main/preload.ts b/main/preload.ts
@@ -75,9 +75,10 @@ const ipc = {
     };
   },
 
-  async getTemplates(): Promise<TemplateFile[]> {
+  async getTemplates(posTemplateWidth?: number): Promise<TemplateFile[]> {
     return (await ipcRenderer.invoke(
-      IPC_ACTIONS.GET_TEMPLATES
+      IPC_ACTIONS.GET_TEMPLATES,
+      posTemplateWidth
     )) as TemplateFile[];
   },
 

diff --git a/main/registerIpcMainActionListeners.ts b/main/registerIpcMainActionListeners.ts
@@ -205,9 +205,12 @@ export default function registerIpcMainActionListeners(main: Main) {
     };
   });
 
-  ipcMain.handle(IPC_ACTIONS.GET_TEMPLATES, async () => {
-    return getTemplates();
-  });
+  ipcMain.handle(
+    IPC_ACTIONS.GET_TEMPLATES,
+    async (_, posPrintWidth?: number) => {
+      return getTemplates(posPrintWidth);
+    }
+  );
 
   /**
    * Database Related Actions

diff --git a/models/baseModels/Invoice/Invoice.ts b/models/baseModels/Invoice/Invoice.ts
@@ -395,6 +395,13 @@ export abstract class Invoice extends Transactional {
     return taxArr;
   }
 
+  async getTotalTax() {
+    const taxArr = await this.getTaxSummary();
+    return taxArr
+      .map(({ amount }) => amount)
+      .reduce((a, b) => a.add(b), this.fyo.pesa(0));
+  }
+
   async getTax(tax: string) {
     if (!this._taxes[tax]) {
       this._taxes[tax] = await this.fyo.doc.getDoc('Tax', tax);

diff --git a/models/baseModels/PrintSettings/PrintSettings.ts b/models/baseModels/PrintSettings/PrintSettings.ts
@@ -12,6 +12,7 @@ export class PrintSettings extends Doc {
   font?: string;
   displayLogo?: boolean;
   displayTime?: boolean;
+  posPrintWidth?: number;
   amountInWords?: boolean;
   override hidden: HiddenMap = {};
 }
diff --git a/schemas/app/PrintSettings.json b/schemas/app/PrintSettings.json
@@ -126,6 +126,13 @@
       "label": "Display Time In Invoice",
       "fieldtype": "Check",
       "section": "Customizations"
+    },
+    {
+      "fieldname": "posPrintWidth",
+      "label": "Pos Print Width",
+      "fieldtype": "Float",
+      "default": 8,
+      "section": "Customizations"
     }
   ]
 }
diff --git a/src/pages/POS/POS.vue b/src/pages/POS/POS.vue
@@ -575,8 +575,8 @@ export default defineComponent({
     async createTransaction(shouldPrint = false) {
       try {
         await this.validate();
-        await this.submitSinvDoc(shouldPrint);
-        await this.makePayment();
+        await this.submitSinvDoc();
+        await this.makePayment(shouldPrint);
         await this.makeStockTransfer();
         await this.afterTransaction();
         await this.setItems();
@@ -587,7 +587,7 @@ export default defineComponent({
         });
       }
     },
-    async makePayment() {
+    async makePayment(shouldPrint: boolean) {
       this.paymentDoc = this.sinvDoc.getPayment() as Payment;
       const paymentMethod = this.paymentMethod;
 
@@ -623,6 +623,13 @@ export default defineComponent({
       try {
         await this.paymentDoc?.sync();
         await this.paymentDoc?.submit();
+
+        if (shouldPrint) {
+          await routeTo(
+            // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+            `/print/${this.sinvDoc.schemaName}/${this.sinvDoc.name}`
+          );
+        }
       } catch (error) {
         return showToast({
           type: 'error',
@@ -660,20 +667,13 @@ export default defineComponent({
         });
       }
     },
-    async submitSinvDoc(shouldPrint: boolean) {
-      this.sinvDoc.once('afterSubmit', async () => {
+    async submitSinvDoc() {
+      this.sinvDoc.once('afterSubmit', () => {
         showToast({
           type: 'success',
           message: t`Sales Invoice ${this.sinvDoc.name as string} is Submitted`,
           duration: 'short',
         });
-
-        if (shouldPrint) {
-          await routeTo(
-            // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-            `/print/${this.sinvDoc.schemaName}/${this.sinvDoc.name}`
-          );
-        }
       });
 
       try {

diff --git a/src/pages/TemplateBuilder/TemplateBuilder.vue b/src/pages/TemplateBuilder/TemplateBuilder.vue
@@ -91,7 +91,6 @@
             :container-styles="{ 'border-radius': '0px' }"
             @change="async (value) => await setType(value)"
           />
-
           <!-- Display Doc -->
           <Link
             v-if="doc.type"

diff --git a/src/utils/printTemplates.ts b/src/utils/printTemplates.ts
@@ -13,12 +13,19 @@ import {
   showExportInFolder,
 } from './ui';
 import { Money } from 'pesa';
+import { SalesInvoice } from 'models/baseModels/SalesInvoice/SalesInvoice';
 
 export type PrintTemplateHint = {
   [key: string]: string | PrintTemplateHint | PrintTemplateHint[];
 };
 type PrintTemplateData = Record<string, unknown>;
-type TemplateUpdateItem = { name: string; template: string; type: string };
+type TemplateUpdateItem = {
+  name: string;
+  template: string;
+  type: string;
+  width: number;
+  height: number;
+};
 
 const printSettingsFields = [
   'logo',
@@ -40,6 +47,28 @@ export async function getPrintTemplatePropValues(
   const values: PrintValues = { doc: {}, print: {} };
   values.doc = await getPrintTemplateDocValues(doc);
 
+  const totalTax = await (doc as Invoice)?.getTotalTax();
+  const paymentId = await (doc as SalesInvoice).getPaymentIds();
+
+  if (paymentId.length) {
+    const paymentDoc = await fyo.doc.getDoc(
+      ModelNameEnum.Payment,
+      paymentId[0]
+    );
+
+    (values.doc as PrintTemplateData).paymentMethod = paymentDoc.paymentMethod;
+
+    (values.doc as PrintTemplateData).paidAmount = doc.fyo.format(
+      paymentDoc.amount as Money,
+      ModelNameEnum.Currency
+    );
+  }
+
+  (values.doc as PrintTemplateData).subTotal = doc.fyo.format(
+    (doc.grandTotal as Money).sub(totalTax),
+    ModelNameEnum.Currency
+  );
+
   const printSettings = await fyo.doc.getDoc(ModelNameEnum.PrintSettings);
   const printValues = await getPrintTemplateDocValues(
     printSettings,
@@ -413,7 +442,9 @@ function getAllCSSAsStyleElem() {
 }
 
 export async function updatePrintTemplates(fyo: Fyo) {
-  const templateFiles = await ipc.getTemplates();
+  const templateFiles = await ipc.getTemplates(
+    fyo.singles.PrintSettings?.posPrintWidth as number
+  );
   const existingTemplates = (await fyo.db.getAll(ModelNameEnum.PrintTemplate, {
     fields: ['name', 'modified'],
     filters: { isCustom: false },
@@ -438,20 +469,29 @@ export async function updatePrintTemplates(fyo: Fyo) {
 
   const isLogging = fyo.store.skipTelemetryLogging;
   fyo.store.skipTelemetryLogging = true;
-  for (const { name, type, template } of updateList) {
+  for (const { name, type, template, width, height } of updateList) {
     const doc = await getDocFromNameIfExistsElseNew(
       ModelNameEnum.PrintTemplate,
       name
     );
 
-    await doc.set({ name, type, template, isCustom: false });
+    const updateData = {
+      name,
+      type,
+      template,
+      isCustom: false,
+      ...(width ? { width } : {}),
+      ...(height ? { height } : {}),
+    };
+
+    await doc.set(updateData);
     await doc.sync();
   }
   fyo.store.skipTelemetryLogging = isLogging;
 }
 
 function getPrintTemplateUpdateList(
-  { file, template, modified: modifiedString }: TemplateFile,
+  { file, template, modified: modifiedString, width, height }: TemplateFile,
   nameModifiedMap: Record<string, Date>,
   fyo: Fyo
 ): TemplateUpdateItem[] {
@@ -465,6 +505,8 @@ function getPrintTemplateUpdateList(
     }
 
     templateList.push({
+      height,
+      width,
       name,
       type,
       template,

diff --git a/src/utils/ui.ts b/src/utils/ui.ts
@@ -827,6 +827,7 @@ export const printSizes = [
   'B7',
   'B8',
   'B9',
+  'POS',
   'Letter',
   'Legal',
   'Executive',
@@ -923,6 +924,10 @@ export const paperSizeMap: Record<
     width: 4.4,
     height: 6.2,
   },
+  POS: {
+    width: 8,
+    height: 22,
+  },
   Letter: {
     width: 21.59,
     height: 27.94,