feat: add hints to import fields

packages/server/src/models/Bill.Settings.ts

@@ -132,6 +132,7 @@ export default {
           relationModel: 'Item',
           relationImportMatch: ['name', 'code'],
           required: true,
+          importHint: "Matches the item name or code."
         },
         rate: {
           name: 'Rate',

packages/server/src/models/BillPayment.Settings.ts

@@ -84,6 +84,7 @@ export default {
       name: 'bill_payment.field.payment_number',
       fieldType: 'text',
       unique: true,
+      importHint: "The payment number should be unique."
     },
     paymentAccountId: {
       name: 'bill_payment.field.payment_account',
@@ -91,6 +92,7 @@ export default {
       relationModel: 'Account',
       relationImportMatch: ['name', 'code'],
       required: true,
+      importHint: "Matches the account name or code."
     },
     exchangeRate: {
       name: 'bill_payment.field.exchange_rate',
@@ -118,6 +120,7 @@ export default {
           relationModel: 'Bill',
           relationImportMatch: 'billNumber',
           required: true,
+          importHint: "Matches the bill number."
         },
         paymentAmount: {
           name: 'bill_payment.field.entries.payment_amount',

packages/server/src/models/CreditNote.Meta.ts

@@ -130,6 +130,7 @@ export default {
           relationModel: 'Item',
           relationImportMatch: ['name', 'code'],
           required: true,
+          importHint: 'Matches the item name or code.',
         },
         rate: {
           name: 'Rate',

packages/server/src/models/Expense.Settings.ts

@@ -68,6 +68,7 @@ export default {
       relationModel: 'Account',
       relationImportMatch: ['name', 'code'],
       required: true,
+      importHint: "Matches the account name or code."
     },
     referenceNo: {
       name: 'expense.field.reference_no',
@@ -101,6 +102,7 @@ export default {
           relationModel: 'Account',
           relationImportMatch: ['name', 'code'],
           required: true,
+          importHint: "Matches the account name or code."
         },
         amount: {
           name: 'expense.field.amount',

packages/server/src/models/Item.Settings.ts

@@ -124,117 +124,82 @@ export default {
   fields2: {
     type: {
       name: 'item.field.type',
-      column: 'type',
       fieldType: 'enumeration',
       options: [
         { key: 'inventory', label: 'item.field.type.inventory' },
         { key: 'service', label: 'item.field.type.service' },
         { key: 'non-inventory', label: 'item.field.type.non-inventory' },
       ],
+      required: true,
     },
     name: {
       name: 'item.field.name',
-      column: 'name',
       fieldType: 'text',
+      required: true,
     },
     code: {
       name: 'item.field.code',
-      column: 'code',
       fieldType: 'text',
     },
     sellable: {
       name: 'item.field.sellable',
-      column: 'sellable',
       fieldType: 'boolean',
     },
     purchasable: {
       name: 'item.field.purchasable',
-      column: 'purchasable',
       fieldType: 'boolean',
     },
-    sell_price: {
-      name: 'item.field.cost_price',
-      column: 'sell_price',
+    sellPrice: {
+      name: 'item.field.sell_price',
       fieldType: 'number',
     },
     cost_price: {
+      name: 'item.field.cost_price',
+      fieldType: 'number',
+    },
+    costAccount: {
       name: 'item.field.cost_account',
-      column: 'cost_price',
-      fieldType: 'number',
+      fieldType: 'relation',
+      relationModel: 'Account',
+      relationImportMatch: ['name', 'code'],
+      importHint: 'Matches the account name or code.',
     },
-    cost_account: {
+    sellAccount: {
       name: 'item.field.sell_account',
-      column: 'cost_account_id',
       fieldType: 'relation',
-
-      relationType: 'enumeration',
-      relationKey: 'costAccount',
-
-      relationEntityLabel: 'name',
-      relationEntityKey: 'slug',
+      relationModel: 'Account',
+      relationImportMatch: ['name', 'code'],
+      importHint: 'Matches the account name or code.',
     },
-    sell_account: {
-      name: 'item.field.sell_description',
-      column: 'sell_account_id',
-      fieldType: 'relation',
-
-      relationType: 'enumeration',
-      relationKey: 'sellAccount',
-
-      relationEntityLabel: 'name',
-      relationEntityKey: 'slug',
-    },
-    inventory_account: {
+    inventoryAccount: {
       name: 'item.field.inventory_account',
-      column: 'inventory_account_id',
-
-      relationType: 'enumeration',
-      relationKey: 'inventoryAccount',
-
-      relationEntityLabel: 'name',
-      relationEntityKey: 'slug',
+      fieldType: 'relation',
+      relationModel: 'Account',
+      relationImportMatch: ['name', 'code'],
+      importHint: 'Matches the account name or code.',
     },
-    sell_description: {
-      name: 'Sell description',
-      column: 'sell_description',
+    sellDescription: {
+      name: 'Sell Description',
       fieldType: 'text',
     },
-    purchase_description: {
-      name: 'Purchase description',
-      column: 'purchase_description',
+    purchaseDescription: {
+      name: 'Purchase Description',
       fieldType: 'text',
     },
-    quantity_on_hand: {
-      name: 'item.field.quantity_on_hand',
-      column: 'quantity_on_hand',
-      fieldType: 'number',
-    },
     note: {
       name: 'item.field.note',
-      column: 'note',
       fieldType: 'text',
     },
     category: {
       name: 'item.field.category',
-      column: 'category_id',
-
-      relationType: 'enumeration',
-      relationKey: 'category',
-
-      relationEntityLabel: 'name',
-      relationEntityKey: 'id',
+      fieldType: 'relation',
+      relationModel: 'ItemCategory',
+      relationImportMatch: ['name'],
+      importHint: "Matches the category name."
     },
     active: {
       name: 'item.field.active',
-      column: 'active',
       fieldType: 'boolean',
-      filterable: false,
-    },
-    created_at: {
-      name: 'item.field.created_at',
-      column: 'created_at',
-      columnType: 'date',
-      fieldType: 'date',
     },
   },
 };

packages/server/src/models/PaymentReceive.Settings.ts

@@ -84,10 +84,12 @@ export default {
       relationModel: 'Account',
       relationImportMatch: ['name', 'code'],
       required: true,
+      importHint: "Matches the account name or code."
     },
     paymentReceiveNo: {
       name: 'payment_receive.field.payment_receive_no',
       fieldType: 'text',
+      importHint: "The payment number should be unique."
     },
     statement: {
       name: 'payment_receive.field.statement',
@@ -106,6 +108,7 @@ export default {
           relationModel: 'SaleInvoice',
           relationImportMatch: 'invoiceNo',
           required: true,
+          importHint: "Matches the invoice number."
         },
         paymentAmount: {
           name: 'payment_receive.field.entries.payment_amount',

packages/server/src/models/SaleEstimate.Settings.ts

@@ -132,6 +132,7 @@ export default {
           relationModel: 'Item',
           relationImportMatch: ['name', 'code'],
           required: true,
+          importHint: "Matches the item name or code."
         },
         rate: {
           name: 'invoice.field.rate',

packages/server/src/models/SaleInvoice.Settings.ts

@@ -142,6 +142,7 @@ export default {
           relationModel: 'Item',
           relationImportMatch: ['name', 'code'],
           required: true,
+          importHint: "Matches the item name or code."
         },
         rate: {
           name: 'invoice.field.rate',

packages/server/src/models/SaleReceipt.Settings.ts

@@ -126,6 +126,7 @@ export default {
           relationModel: 'Item',
           relationImportMatch: ['name', 'code'],
           required: true,
+          importHint: "Matches the item name or code."
         },
         rate: {
           name: 'invoice.field.rate',

packages/server/src/models/UncategorizedCashflowTransaction.meta.ts

@@ -53,23 +53,19 @@ export default {
     },
     payee: {
       name: 'Payee',
-      column: 'payee',
       fieldType: 'text',
     },
     description: {
       name: 'Description',
-      column: 'description',
       fieldType: 'text',
     },
     referenceNo: {
       name: 'Reference No.',
-      column: 'reference_no',
       fieldType: 'text',
     },
     amount: {
       name: 'Amount',
-      column: 'Amount',
-      fieldType: 'numeric',
+      fieldType: 'number',
       required: true,
     },
   },

packages/server/src/models/VendorCredit.Meta.ts

@@ -122,6 +122,7 @@ export default {
           relationModel: 'Item',
           relationImportMatch: ['name', 'code'],
           required: true,
+          importHint: "Matches the item name or code."
         },
         rate: {
           name: 'Rate',