feat: add api to specify default column order in active view

Signed-off-by: Pranav C <pranavxc@gmail.com>

packages/nc-gui/components/smartsheet/header/Menu.vue

@@ -132,8 +132,6 @@ const duplicateColumn = async () => {
   }
 
   try {
-    await $api.dbTableColumn.create(meta!.value!.id!, columnCreatePayload)
-    await getMeta(meta!.value!.id!, true)
 
     const gridViewColumnList = await $api.dbViewColumn.list(view.value?.id as string)
 
@@ -145,9 +143,15 @@ const duplicateColumn = async () => {
 
     let newColumnOrder = (gridViewColumnList[currentColumnIndex].order! + gridViewColumnList[currentColumnIndex + 1]?.order) / 2
 
-    await $api.dbViewColumn.update(view.value!.id!, gridViewColumnList[gridViewColumnList.length - 1].id, {
+    await $api.dbTableColumn.create(meta!.value!.id!, {
+      ...columnCreatePayload,
+      columnOrder: {
         order: newColumnOrder,
+        viewId: view.value?.id as string,
+      },
     })
+    await getMeta(meta!.value!.id!, true)
+
 
     eventBus.emit(SmartsheetStoreEvents.FIELD_RELOAD)
   } catch (e: any) {

packages/nocodb-sdk/src/lib/Api.ts

@@ -571,8 +571,7 @@ export interface HookLogType {
   updated_at?: string;
 }
 
-export type ColumnReqType =
+export interface NormalColumnRequestType {
-  | {
   uidt?:
     | 'ID'
     | 'SingleLineText'
@@ -628,33 +627,52 @@ export type ColumnReqType =
   dtxp?: string;
   dtxs?: string;
   au?: boolean;
-      ''?: string;
 }
-  | {
+
+export interface LinkToAnotherColumnReqType {
   uidt: 'LinkToAnotherRecord';
   title: string;
+  virtual?: boolean;
   parentId: string;
   childId: string;
   type: 'hm' | 'bt' | 'mm';
 }
-  | {
+
+export interface RollupColumnReqType {
   uidt?: 'Rollup';
   title?: string;
   fk_relation_column_id?: string;
   fk_rollup_column_id?: string;
   rollup_function?: string;
 }
-  | {
+
+export interface LookupColumnReqType {
   uidt?: 'Lookup';
   title?: string;
   fk_relation_column_id?: string;
   fk_lookup_column_id?: string;
 }
-  | {
+
+export interface FormulaColumnReqType {
   uidt?: string;
   formula_raw?: string;
   formula?: string;
   title?: string;
+}
+
+export type ColumnReqType = (
+  | NormalColumnRequestType
+  | LinkToAnotherColumnReqType
+  | RollupColumnReqType
+  | FormulaColumnReqType
+  | LookupColumnReqType
+) & {
+  column_name?: string;
+  title?: string;
+  columnOrder?: {
+    viewId?: string;
+    order?: number;
+  };
 };
 
 export interface UserInfoType {

packages/nocodb/src/lib/meta/api/columnApis.ts

@@ -15,9 +15,13 @@ import {
 import {
   AuditOperationSubTypes,
   AuditOperationTypes,
+  ColumnReqType,
   isVirtualCol,
+  LinkToAnotherColumnReqType,
   LinkToAnotherRecordType,
+  LookupColumnReqType,
   RelationTypes,
+  RollupColumnReqType,
   substituteColumnAliasWithIdInFormula,
   substituteColumnIdWithAliasInFormula,
   TableType,
@@ -96,7 +100,10 @@ async function createHmAndBtColumn(
   }
 }
 
-export async function columnAdd(req: Request, res: Response<TableType>) {
+export async function columnAdd(
+  req: Request<any, any, ColumnReqType & { uidt: UITypes }>,
+  res: Response<TableType>
+) {
   const table = await Model.getWithInfo({
     id: req.params.tableId,
   });
@@ -121,7 +128,7 @@ export async function columnAdd(req: Request, res: Response<TableType>) {
     NcError.badRequest('Duplicate column alias');
   }
 
-  let colBody = req.body;
+  let colBody: any = req.body;
   switch (colBody.uidt) {
     case UITypes.Rollup:
       {
@@ -137,7 +144,7 @@ export async function columnAdd(req: Request, res: Response<TableType>) {
 
         const relation = await (
           await Column.get({
-            colId: req.body.fk_relation_column_id,
+            colId: (req.body as RollupColumnReqType).fk_relation_column_id,
           })
         ).getColOptions<LinkToAnotherRecordType>();
 
@@ -163,7 +170,8 @@ export async function columnAdd(req: Request, res: Response<TableType>) {
         const relatedTable = await relatedColumn.getModel();
         if (
           !(await relatedTable.getColumns()).find(
-            (c) => c.id === req.body.fk_rollup_column_id
+            (c) =>
+              c.id === (req.body as RollupColumnReqType).fk_rollup_column_id
           )
         )
           throw new Error('Rollup column not found in related table');
@@ -183,7 +191,7 @@ export async function columnAdd(req: Request, res: Response<TableType>) {
 
         const relation = await (
           await Column.get({
-            colId: req.body.fk_relation_column_id,
+            colId: (req.body as LookupColumnReqType).fk_relation_column_id,
           })
         ).getColOptions<LinkToAnotherRecordType>();
 
@@ -209,7 +217,8 @@ export async function columnAdd(req: Request, res: Response<TableType>) {
         const relatedTable = await relatedColumn.getModel();
         if (
           !(await relatedTable.getColumns()).find(
-            (c) => c.id === req.body.fk_lookup_column_id
+            (c) =>
+              c.id === (req.body as LookupColumnReqType).fk_lookup_column_id
           )
         )
           throw new Error('Lookup column not found in related table');
@@ -227,14 +236,21 @@ export async function columnAdd(req: Request, res: Response<TableType>) {
         validateParams(['parentId', 'childId', 'type'], req.body);
 
         // get parent and child models
-        const parent = await Model.getWithInfo({ id: req.body.parentId });
+        const parent = await Model.getWithInfo({
-        const child = await Model.getWithInfo({ id: req.body.childId });
+          id: (req.body as LinkToAnotherColumnReqType).parentId,
+        });
+        const child = await Model.getWithInfo({
+          id: (req.body as LinkToAnotherColumnReqType).childId,
+        });
         let childColumn: Column;
 
         const sqlMgr = await ProjectMgrv2.getSqlMgr({
           id: base.project_id,
         });
-        if (req.body.type === 'hm' || req.body.type === 'bt') {
+        if (
+          (req.body as LinkToAnotherColumnReqType).type === 'hm' ||
+          (req.body as LinkToAnotherColumnReqType).type === 'bt'
+        ) {
           // populate fk column name
           const fkColName = getUniqueColumnName(
             await child.getColumns(),
@@ -285,7 +301,7 @@ export async function columnAdd(req: Request, res: Response<TableType>) {
             childColumn = await Column.get({ colId: id });
 
             // ignore relation creation if virtual
-            if (!req.body.virtual) {
+            if (!(req.body as LinkToAnotherColumnReqType).virtual) {
               // create relation
               await sqlMgr.sqlOpPlus(base, 'relationCreate', {
                 childColumn: fkColName,
@@ -315,11 +331,11 @@ export async function columnAdd(req: Request, res: Response<TableType>) {
             child,
             parent,
             childColumn,
-            req.body.type,
+            (req.body as LinkToAnotherColumnReqType).type as RelationTypes,
-            req.body.title,
+            (req.body as LinkToAnotherColumnReqType).title,
-            req.body.virtual
+            (req.body as LinkToAnotherColumnReqType).virtual
           );
-        } else if (req.body.type === 'mm') {
+        } else if ((req.body as LinkToAnotherColumnReqType).type === 'mm') {
           const aTn = `${project?.prefix ?? ''}_nc_m2m_${randomID()}`;
           const aTnAlias = aTn;
 
@@ -378,7 +394,7 @@ export async function columnAdd(req: Request, res: Response<TableType>) {
             columns: associateTableCols,
           });
 
-          if (!req.body.virtual) {
+          if (!(req.body as LinkToAnotherColumnReqType).virtual) {
             const rel1Args = {
               ...req.body,
               childTable: aTn,
@@ -412,7 +428,7 @@ export async function columnAdd(req: Request, res: Response<TableType>) {
             childCol,
             null,
             null,
-            req.body.virtual,
+            (req.body as LinkToAnotherColumnReqType).virtual,
             true
           );
           await createHmAndBtColumn(
@@ -421,7 +437,7 @@ export async function columnAdd(req: Request, res: Response<TableType>) {
             parentCol,
             null,
             null,
-            req.body.virtual,
+            (req.body as LinkToAnotherColumnReqType).virtual,
             true
           );
 

packages/nocodb/src/lib/models/Column.ts

@@ -5,7 +5,7 @@ import RollupColumn from './RollupColumn';
 import SelectOption from './SelectOption';
 import Model from './Model';
 import NocoCache from '../cache/NocoCache';
-import { AllowedColumnTypesForQrCode, ColumnType, UITypes } from 'nocodb-sdk';
+import { ColumnReqType, AllowedColumnTypesForQrCode, ColumnType, UITypes } from 'nocodb-sdk';
 import {
   CacheDelDirection,
   CacheGetType,

packages/nocodb/src/lib/models/GridViewColumn.ts

@@ -70,9 +70,11 @@ export default class GridViewColumn implements GridColumnType {
     const insertObj = {
       fk_view_id: column.fk_view_id,
       fk_column_id: column.fk_column_id,
-      order: await ncMeta.metaGetNextOrder(MetaTable.GRID_VIEW_COLUMNS, {
+      order:
+        column?.order ??
+        (await ncMeta.metaGetNextOrder(MetaTable.GRID_VIEW_COLUMNS, {
           fk_view_id: column.fk_view_id,
-      }),
+        })),
       show: column.show,
       project_id: column.project_id,
       base_id: column.base_id,

packages/nocodb/src/lib/models/View.ts

@@ -13,7 +13,13 @@ import GalleryView from './GalleryView';
 import GridViewColumn from './GridViewColumn';
 import Sort from './Sort';
 import Filter from './Filter';
-import { isSystemColumn, UITypes, ViewType, ViewTypes } from 'nocodb-sdk';
+import {
+  ColumnReqType,
+  isSystemColumn,
+  UITypes,
+  ViewType,
+  ViewTypes,
+} from 'nocodb-sdk';
 import GalleryViewColumn from './GalleryViewColumn';
 import FormViewColumn from './FormViewColumn';
 import KanbanViewColumn from './KanbanViewColumn';
@@ -442,9 +448,9 @@ export default class View implements ViewType {
     param: {
       fk_column_id: any;
       fk_model_id: any;
-      order;
+      order?: number;
       show;
-    },
+    } & Pick<ColumnReqType, 'columnOrder'>,
     ncMeta = Noco.ncMeta
   ) {
     const insertObj = {
@@ -456,33 +462,21 @@ export default class View implements ViewType {
     const views = await this.list(param.fk_model_id, ncMeta);
 
     for (const view of views) {
+      const modifiedInsertObj = { ...insertObj, fk_view_id: view.id };
+
+      if (param.columnOrder?.viewId === view.id) {
+        modifiedInsertObj.order = param.columnOrder?.order;
+      }
+
       switch (view.type) {
         case ViewTypes.GRID:
-          await GridViewColumn.insert(
+          await GridViewColumn.insert(modifiedInsertObj, ncMeta);
-            {
-              ...insertObj,
-              fk_view_id: view.id,
-            },
-            ncMeta
-          );
           break;
         case ViewTypes.GALLERY:
-          await GalleryViewColumn.insert(
+          await GalleryViewColumn.insert(modifiedInsertObj, ncMeta);
-            {
-              ...insertObj,
-              fk_view_id: view.id,
-            },
-            ncMeta
-          );
           break;
         case ViewTypes.KANBAN:
-          await KanbanViewColumn.insert(
+          await KanbanViewColumn.insert(modifiedInsertObj, ncMeta);
-            {
-              ...insertObj,
-              fk_view_id: view.id,
-            },
-            ncMeta
-          );
           break;
       }
     }

scripts/sdk/swagger.json

@@ -8957,9 +8957,7 @@
           }
         }
       },
-      "ColumnReq": {
+      "NormalColumnRequest": {
-        "oneOf": [
-          {
         "properties": {
           "uidt": {
             "type": "string",
@@ -9070,13 +9068,10 @@
           },
           "au": {
             "type": "boolean"
-              },
-              "": {
-                "type": "string"
           }
         }
       },
-          {
+      "LinkToAnotherColumnReq": {
         "properties": {
           "uidt": {
             "type": "string",
@@ -9087,6 +9082,9 @@
           "title": {
             "type": "string"
           },
+          "virtual": {
+            "type": "boolean"
+          },
           "parentId": {
             "type": "string"
           },
@@ -9110,7 +9108,7 @@
           "type"
         ]
       },
-          {
+      "RollupColumnReq": {
         "properties": {
           "uidt": {
             "type": "string",
@@ -9132,7 +9130,7 @@
           }
         }
       },
-          {
+      "LookupColumnReq": {
         "properties": {
           "uidt": {
             "type": "string",
@@ -9151,7 +9149,7 @@
           }
         }
       },
-          {
+      "FormulaColumnReq": {
         "properties": {
           "uidt": {
             "type": "string"
@@ -9166,6 +9164,49 @@
             "type": "string"
           }
         }
+      },
+      "ColumnReq": {
+        "allOf": [
+          {
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/NormalColumnRequest"
+              },
+              {
+                "$ref": "#/components/schemas/LinkToAnotherColumnReq"
+              },
+              {
+                "$ref": "#/components/schemas/RollupColumnReq"
+              },
+              {
+                "$ref": "#/components/schemas/FormulaColumnReq"
+              },
+              {
+                "$ref": "#/components/schemas/LookupColumnReq"
+              }
+            ]
+          },
+          {
+            "type": "object",
+            "properties": {
+              "column_name": {
+                "type": "string"
+              },
+              "title": {
+                "type": "string"
+              },
+              "columnOrder": {
+                "type": "object",
+                "properties": {
+                  "viewId": {
+                    "type": "string"
+                  },
+                  "order": {
+                    "type": "integer"
+                  }
+                }
+              }
+            }
           }
         ],
         "description": "",