ux: allow to create custom sidebar entries

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',

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';
+import type { QueryFilter } from 'utils/db/types';
+
+export class SidebarEntry extends Doc {
+  section?: string;
+  route?: string;
+  model?: string;
+  filters?: string;
+
+  fullRoute(): string {
+    switch (this.route) {
+      case '/list':
+        return `/list/${this.model!}/${this.name!}`;
+      default:
+        return this.route!;
+    }
+  }
+
+  parsedFilters(): QueryFilter {
+    return JSON.parse(this.filters!) as QueryFilter;
+  }
+}

models/index.ts

@@ -30,6 +30,7 @@ import { SalesInvoiceItem } from './baseModels/SalesInvoiceItem/SalesInvoiceItem
 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 @@ export const models = {
   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);

models/inventory/Transfer.ts

@@ -21,6 +21,19 @@ export abstract class Transfer extends Transactional {
     await this._getStockManager().createTransfers(transferDetails);
   }
 
+  async beforeSubmitUndo(): Promise<void> {
+    await super.beforeSubmitUndo();
+    const transferDetails = this._getTransferDetails();
+    const stockManager = this._getStockManager();
+    stockManager.isCancelled = true;
+    await stockManager.validateCancel(transferDetails);
+  }
+
+  async afterSubmitUndo(): Promise<void> {
+    await super.afterSubmitUndo();
+    await this._getStockManager().undoTransfers();
+  }
+
   async beforeCancel(): Promise<void> {
     await super.beforeCancel();
     const transferDetails = this._getTransferDetails();

models/types.ts

@@ -23,6 +23,7 @@ export enum ModelNameEnum {
   LoyaltyPointEntry = 'LoyaltyPointEntry',
   CollectionRulesItems = 'CollectionRulesItems',
   CouponCode = 'CouponCode',
+  SidebarEntry = 'SidebarEntry',
 
   AppliedCouponCodes = 'AppliedCouponCodes',
   Payment = 'Payment',

schemas/app/SidebarEntry.json

@@ -0,0 +1,46 @@
+{
+  "name": "SidebarEntry",
+  "label": "Sidebar Entry",
+  "naming": "manual",
+  "fields": [
+    {
+      "fieldname": "name",
+      "section": "Default",
+      "label": "Name",
+      "fieldtype": "Data",
+      "required": true,
+      "placeholder": "Entry Name"
+    },
+    {
+      "fieldname": "section",
+      "section": "Default",
+      "label": "Section",
+      "fieldtype": "Data",
+      "required": false
+    },
+    {
+      "fieldname": "route",
+      "section": "Default",
+      "label": "Route",
+      "fieldtype": "Data",
+      "required": true,
+      "default": "/list"
+    },
+    {
+      "fieldname": "model",
+      "section": "Default",
+      "label": "Document Type",
+      "fieldtype": "Data",
+      "required": true,
+      "default": "JournalEntry"
+    },
+    {
+      "fieldname": "filters",
+      "section": "Default",
+      "label": "Filters",
+      "fieldtype": "Data",
+      "required": true,
+      "default": "{}"
+    }
+  ]
+}

schemas/core/SystemSettings.json

@@ -125,6 +125,13 @@
       "default": false,
       "description": "Sets the theme of the app.",
       "section": "Theme"
+    },
+    {
+      "fieldname": "provisionalModeSince",
+      "label": "Provisional Mode Since",
+      "fieldtype": "Datetime",
+      "description": "Date since the provisional mode is set, or NULL for definitive mode",
+      "hidden": true
     }
   ],
   "quickEditFields": [

schemas/meta/submittable.json

@@ -9,6 +9,14 @@
       "meta": true,
       "section": "System"
     },
+    {
+      "fieldname": "submittedAt",
+      "label": "Submition Date",
+      "fieldtype": "Datetime",
+      "required": false,
+      "meta": true,
+      "section": "System"
+    },
     {
       "fieldname": "cancelled",
       "label": "Cancelled",

schemas/schemas.ts

@@ -48,6 +48,7 @@ import PurchaseReceiptItem from './app/inventory/PurchaseReceiptItem.json';
 import SerialNumber from './app/inventory/SerialNumber.json';
 import Shipment from './app/inventory/Shipment.json';
 import ShipmentItem from './app/inventory/ShipmentItem.json';
+import SidebarEntry from './app/SidebarEntry.json';
 import StockLedgerEntry from './app/inventory/StockLedgerEntry.json';
 import StockMovement from './app/inventory/StockMovement.json';
 import StockMovementItem from './app/inventory/StockMovementItem.json';
@@ -92,6 +93,7 @@ export const appSchemas: Schema[] | SchemaStub[] = [
   SetupWizard as Schema,
   GetStarted as Schema,
   PrintTemplate as Schema,
+  SidebarEntry as Schema,
 
   Color as Schema,
   Currency as Schema,