ux: allow custom views

fyo/model/doc.ts

@@ -223,6 +223,30 @@ export class Doc extends Observable<DocValue | Doc[]> {
     return true;
   }
 
+  get canUndoSubmit() {
+    if (!this.canCancel) {
+      return false;
+    }
+
+    if (this.fyo.singles.SystemSettings?.provisionalModeSince == null) {
+      return false;
+    }
+
+    const submittedAt: Date = (this.submittedAt || this.created) as Date;
+    if (!submittedAt) {
+      return false;
+    }
+
+    if (
+      submittedAt <
+      (this.fyo.singles.SystemSettings.provisionalModeSince as Date)
+    ) {
+      return false;
+    }
+
+    return true;
+  }
+
   get canCancel() {
     if (!this.schema.isSubmittable) {
       return false;
@@ -344,14 +368,17 @@ export class Doc extends Observable<DocValue | Doc[]> {
     value?: DocValue | Doc[] | DocValueMap[]
   ): boolean {
     if (fieldname === 'numberSeries' && !this.notInserted) {
+      // console.log("cannot set %s, numberSeries inserted", fieldname)
       return false;
     }
 
     if (value === undefined) {
+      // console.log("cannot set %s, undefined value", fieldname)
       return false;
     }
 
     if (this.fieldMap[fieldname] === undefined) {
+      // console.log("cannot set %s, no fieldMap", fieldname, this.fieldMap)
       return false;
     }
 
@@ -940,12 +967,27 @@ export class Doc extends Observable<DocValue | Doc[]> {
 
     await this.trigger('beforeSubmit');
     await this.setAndSync('submitted', true);
+    await this.setAndSync('submittedAt', new Date());
     await this.trigger('afterSubmit');
 
     this.fyo.telemetry.log(Verb.Submitted, this.schemaName);
     this.fyo.doc.observer.trigger(`submit:${this.schemaName}`, this.name);
   }
 
+  async submitUndo() {
+    if (!this.schema.isSubmittable || !this.submitted || this.cancelled) {
+      return;
+    }
+
+    await this.trigger('beforeSubmitUndo');
+    await this.setAndSync('submitted', false);
+    await this.setAndSync('submittedAt', null);
+    await this.trigger('afterSubmitUndo');
+
+    this.fyo.telemetry.log(Verb.SubmitUndone, this.schemaName);
+    this.fyo.doc.observer.trigger(`submitUndo:${this.schemaName}`, this.name);
+  }
+
   async cancel() {
     if (!this.schema.isSubmittable || !this.submitted || this.cancelled) {
       return;
@@ -1058,6 +1100,8 @@ export class Doc extends Observable<DocValue | Doc[]> {
   async afterSync() {}
   async beforeSubmit() {}
   async afterSubmit() {}
+  async beforeSubmitUndo() {}
+  async afterSubmitUndo() {}
   async beforeRename() {}
   async afterRename() {}
   async beforeCancel() {}

fyo/telemetry/types.ts

@@ -8,6 +8,7 @@ export enum Verb {
   Created = 'created',
   Deleted = 'deleted',
   Submitted = 'submitted',
+  SubmitUndone = 'submitUndone',
   Cancelled = 'cancelled',
   Imported = 'imported',
   Exported = 'exported',

main.ts

@@ -6,6 +6,7 @@
 
 import { emitMainProcessError } from 'backend/helpers';
 import {
+  shell,
   app,
   BrowserWindow,
   BrowserWindowConstructorOptions,
@@ -22,6 +23,17 @@
 import registerIpcMainMessageListeners from './main/registerIpcMainMessageListeners';
 import registerProcessListeners from './main/registerProcessListeners';
 
+const EXTENSIONS = {
+  '.js': 'text/javascript',
+  '.css': 'text/css',
+  '.html': 'text/html',
+  '.svg': 'image/svg+xml',
+  '.json': 'application/json',
+  '.pdf': 'application/pdf',
+}
+
+const MIME_TYPES = Object.fromEntries(Object.entries(EXTENSIONS).map(([ext, mime]) => [mime, ext]))
+
 export class Main {
   title = 'Frappe Books';
   icon: string;
@@ -119,6 +131,11 @@
     const options = this.getOptions();
     this.mainWindow = new BrowserWindow(options);
 
+    this.mainWindow.webContents.setWindowOpenHandler(({ url }) => {
+      shell.openExternal(url);
+      return { action: 'deny' };
+    });
+
     if (this.isDevelopment) {
       this.setViteServerURL();
     } else {
@@ -189,16 +206,9 @@
 
   fs.readFile(filePath, (_, data) => {
     const extension = path.extname(filePath).toLowerCase();
-    const mimeType =
-      {
-        '.js': 'text/javascript',
-        '.css': 'text/css',
-        '.html': 'text/html',
-        '.svg': 'image/svg+xml',
-        '.json': 'application/json',
-      }[extension] ?? '';
+    const mimeType = EXTENSIONS[extension] ?? '';
 
     callback({ mimeType, data });
   });
 }
 

main/preload.ts

@@ -117,6 +117,10 @@
     ipcRenderer.send(IPC_MESSAGES.OPEN_EXTERNAL, link);
   },
 
+  openDataURL(link: string, filename: string) {
+    ipcRenderer.send(IPC_MESSAGES.OPEN_DATA_URL, {link, filename});
+  },
+
   async deleteFile(filePath: string) {
     return (await ipcRenderer.invoke(
       IPC_ACTIONS.DELETE_FILE,

main/registerIpcMainMessageListeners.ts

@@ -1,8 +1,36 @@
-import { ipcMain, Menu, shell } from 'electron';
+import { ipcMain, Menu, shell, app } from 'electron';
+import fs from 'fs';
+import path from 'path';
 import { Main } from '../main';
 import { IPC_MESSAGES } from '../utils/messages';
 import { emitMainProcessError } from 'backend/helpers';
 
+function parseDataURL(url) {
+  const regex = /^data:([a-z]+\/[a-z0-9-+.]+(;[a-z0-9-.!#$%*+.{}|~`]+=[a-z0-9-.!#$%*+.{}()_|~`]+)*)?(;base64)?,([a-z0-9!$&',()*+;=\-._~:@\/?%\s<>]*?)$/i;
+
+  const parts = url.trim().match(regex);
+  if (!parts) return null
+
+  const parsed = {};
+
+  parsed.mediaType = (parts[1] || 'text/plain;charset=us-ascii').toLowerCase();
+
+  const mediaTypeParts = parsed.mediaType.split(';').map(x => x.toLowerCase());
+  parsed.contentType = mediaTypeParts[0];
+
+  mediaTypeParts.slice(1).forEach((attribute) => {
+    const p = attribute.split('=');
+    parsed[p[0]] = p[1];
+  });
+
+  parsed.base64   = !!parts[parts.length - 2];
+  parsed.data     = parts[parts.length - 1] || '';
+  parsed.encoding = parsed.base64 ? 'base64' : 'utf8';
+  parsed.buffer   = Buffer.from(parsed.base64 ? parsed.data : decodeURIComponent(parsed.data), parsed.encoding)
+
+  return parsed;
+}
+
 export default function registerIpcMainMessageListeners(main: Main) {
   ipcMain.on(IPC_MESSAGES.OPEN_MENU, (event) => {
     if (event.sender === null) {
@@ -49,6 +77,17 @@
     shell.openExternal(link).catch((err) => emitMainProcessError(err));
   });
 
+  ipcMain.on(IPC_MESSAGES.OPEN_DATA_URL, (_, {link, filename}: {link: string, filename: string}) => {
+    let data = parseDataURL(link)
+    if (data) {
+      const s = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
+      const temp = Array.apply(null, Array(16)).map(function() { return s.charAt(Math.floor(Math.random() * s.length)); }).join('');
+      const filepath = path.join(app.getPath("temp"), temp + ' ' + filename)
+      fs.writeFileSync(filepath, data.buffer)
+      shell.openPath(filepath)
+    }
+  });
+
   ipcMain.on(IPC_MESSAGES.SHOW_ITEM_IN_FOLDER, (_, filePath: string) => {
     return shell.showItemInFolder(filePath);
   });

models/Transactional/Transactional.ts

@@ -56,6 +56,15 @@ export abstract class Transactional extends Doc {
     await posting.post();
   }
 
+  async afterSubmitUndo(): Promise<void> {
+    await super.afterSubmitUndo();
+    if (!this.isTransactional) {
+      return;
+    }
+
+    await this._deletePostings();
+  }
+
   async afterCancel(): Promise<void> {
     await super.afterCancel();
     if (!this.isTransactional) {
@@ -76,6 +85,10 @@ export abstract class Transactional extends Doc {
       return;
     }
 
+    await this._deletePostings();
+  }
+
+  async _deletePostings(): Promise<void> {
     const ledgerEntryIds = (await this.fyo.db.getAll(
       ModelNameEnum.AccountingLedgerEntry,
       {

models/baseModels/Invoice/Invoice.ts

@@ -245,9 +245,29 @@ export abstract class Invoice extends Transactional {
     }
   }
 
+  async afterSubmitUndo() {
+    await super.afterSubmitUndo();
+    await this._cancelPayments({ undo: true });
+    await this._updatePartyOutStanding();
+    await this._updateIsItemsReturned();
+    await this._removeLoyaltyPointEntry();
+    this.reduceUsedCountOfCoupons();
+  }
+
+  async _undoPayments() {
+    const paymentIds = await this.getPaymentIds();
+    for (const paymentId of paymentIds) {
+      const paymentDoc = (await this.fyo.doc.getDoc(
+        'Payment',
+        paymentId
+      )) as Payment;
+      await paymentDoc.cancel();
+    }
+  }
+
   async afterCancel() {
     await super.afterCancel();
-    await this._cancelPayments();
+    await this._cancelPayments({ undo: false });
     await this._updatePartyOutStanding();
     await this._updateIsItemsReturned();
     await this._removeLoyaltyPointEntry();
@@ -258,14 +278,18 @@ export abstract class Invoice extends Transactional {
     await removeLoyaltyPoint(this);
   }
 
-  async _cancelPayments() {
+  async _cancelPayments({ undo }: { undo: boolean }) {
     const paymentIds = await this.getPaymentIds();
     for (const paymentId of paymentIds) {
       const paymentDoc = (await this.fyo.doc.getDoc(
         'Payment',
         paymentId
       )) as Payment;
-      await paymentDoc.cancel();
+      if (undo) {
+        await paymentDoc.submitUndo();
+      } else {
+        await paymentDoc.cancel();
+      }
     }
   }
 

models/baseModels/Payment/Payment.ts

@@ -442,6 +442,11 @@ export class Payment extends Transactional {
     }
   }
 
+  async afterSubmitUndo() {
+    await super.afterSubmitUndo();
+    await this.revertOutstandingAmount();
+  }
+
   async afterCancel() {
     await super.afterCancel();
     await this.revertOutstandingAmount();

models/baseModels/SidebarEntry/SidebarEntry.ts

@@ -0,0 +1,22 @@
+import { Doc } from 'fyo/model/doc';
+
+export class SidebarEntry extends Doc {
+  section?: string;
+  route?:   string;
+  model?:   string;
+  filters?: string;
+
+  fullRoute() {
+    switch(this.route) {
+      case '/list':
+        return `/list/${this.model}/${this.name}`;
+      default:
+        return this.route;
+    }
+  }
+
+  parsedFilters() {
+    return JSON.parse(this.filters)
+  }
+}
+

models/index.ts

@@ -30,6 +30,7 @@
 import { SalesQuote } from './baseModels/SalesQuote/SalesQuote';
 import { SalesQuoteItem } from './baseModels/SalesQuoteItem/SalesQuoteItem';
 import { SetupWizard } from './baseModels/SetupWizard/SetupWizard';
+import { SidebarEntry } from `./baseModels/SidebarEntry/SidebarEntry`;
 import { Tax } from './baseModels/Tax/Tax';
 import { TaxSummary } from './baseModels/TaxSummary/TaxSummary';
 import { Batch } from './inventory/Batch';
@@ -83,6 +84,7 @@
   SalesQuoteItem,
   SerialNumber,
   SetupWizard,
+  SidebarEntry,
   PrintTemplate,
   Tax,
   TaxSummary,

models/inventory/StockManager.ts

@@ -46,6 +46,10 @@ export class StockManager {
     await this.#sync();
   }
 
+  async undoTransfers() {
+    await this.cancelTransfers();
+  }
+
   async cancelTransfers() {
     const { referenceName, referenceType } = this.details;
     await this.fyo.db.deleteAll(ModelNameEnum.StockLedgerEntry, {

models/inventory/StockMovement.ts

@@ -69,6 +69,11 @@ export class StockMovement extends Transfer {
     await updateSerialNumbers(this, false);
   }
 
+  async afterSubmitUndo(): Promise<void> {
+    await super.afterSubmitUndo();
+    await updateSerialNumbers(this, true);
+  }
+
   async afterCancel(): Promise<void> {
     await super.afterCancel();
     await updateSerialNumbers(this, true);

models/inventory/StockTransfer.ts

@@ -217,6 +217,13 @@ export abstract class StockTransfer extends Transfer {
     await this._updateItemsReturned();
   }
 
+  async afterSubmitUndo() {
+    await super.afterSubmitUndo();
+    await updateSerialNumbers(this, false, this.isReturn);
+    await this._updateBackReference();
+    await this._updateItemsReturned();
+  }
+
   async afterCancel(): Promise<void> {
     await super.afterCancel();
     await updateSerialNumbers(this, true, this.isReturn);