@carthooks/arcubase-cli 0.1.21 → 0.1.23

package/sdk-dist/types/user-action.ts

@@ -11,7 +11,7 @@
  */
 
 /** @format int32 */
-import type { WorkflowStateType, PermitValueFrom, PermitEntityProp, PermitEntityEvent, NotificationPayloadMode, NotificationNotificationType, WidgetsTypeCode, PronounsType, MagicStringPartType, CubeMeasureAggregate, GormDeletedAt, AiOptions, ApiEndpoint, ApiEndpointParam, ApiOptions, App, AppOptions, Assets, Button, ChartOption, CubeDimension, CubeMeasure, CustomAction, DashboardOptions, DashboardWidgets, DataRecord, EntityFrontEvent, EntityOptions, EntityPrintTemplate, EntityVO, Fields, IngressGroup, IngressItem, MagicString, MagicStringPart, Tenant, TenantDepartment, User, WidgetsListViewOptions, WidgetsOption, DataRecordProcess, DataRecordResource, DataRecordTrans, I18NText, PermitColumn, PermitConditionSet, PermitEntityListOptions, PermitEntityListTab, PermitEntityListWidget, PermitFieldPermit, PermitPolicy, PermitRecordCondition, PermitSearchColumn, PermitUserScope, PostqueryAppendData, PostqueryUserData, PostqueryAssetsData, PostqueryDepartmentData, PostqueryLinktoData, SqlNullTime, StorageUrlSets, CommonPagination, EntityValidateUniqFieldVO, EntityValidateUniqReqVO, EntityValidateUniqRespVO, EntityWorkflowNodeVO, EntityWorkflowVersionVO, ErrorResponse, UploadPreviewReqVO } from './common'
+import type { WorkflowStateType, PermitValueFrom, PermitEntityProp, PermitEntityEvent, NotificationPayloadMode, NotificationNotificationType, WidgetsTypeCode, PronounsType, MagicStringPartType, CubeMeasureAggregate, GormDeletedAt, AiOptions, ApiEndpoint, ApiEndpointParam, ApiOptions, App, AppOptions, Assets, Button, ChartOption, CubeDimension, CubeMeasure, CustomAction, DashboardOptions, DashboardWidgets, DataRecord, EntityFrontEvent, EntityOptions, EntityPrintTemplate, EntityVO, Fields, IngressGroup, IngressItem, MagicString, MagicStringPart, Tenant, TenantDepartment, User, WidgetsListViewOptions, WidgetsOption, DataRecordProcess, DataRecordResource, DataRecordTrans, I18NText, PermitColumn, PermitConditionSet, PermitEntityListOptions, PermitEntityListTab, PermitEntityListWidget, PermitFieldPermit, PermitPermit, PermitPolicy, PermitRecordCondition, PermitSearchColumn, PermitUserScope, PostqueryAppendData, PostqueryUserData, PostqueryAssetsData, PostqueryDepartmentData, PostqueryLinktoData, SqlNullTime, StorageUrlSets, CommonPagination, EntityQueryLinkToValuesReqVO, EntityQueryRelationReqVO, EntityQueryRelationRespVO, EntityValidateUniqFieldVO, EntityValidateUniqReqVO, EntityValidateUniqRespVO, EntityWorkflowNodeVO, EntityWorkflowVersionVO, ErrorResponse, UploadPreviewReqVO } from './common'
 
 export enum EventTrigger {
   EventTriggerAutomate = 1,
@@ -149,12 +149,6 @@ export interface PermitFilterCond {
   number_in?: number[];
 }
 
-export interface PermitPermit {
-  all_fields_read?: boolean;
-  all_fields_write?: boolean;
-  fields?: PermitFieldPermit[];
-}
-
 export interface AppDetailDashboardVO {
   id?: number;
   name?: string;
@@ -470,47 +464,11 @@ export interface EntityQueryFilterRespVO {
   items?: any;
 }
 
-export interface EntityQueryLinkToValuesReqVO {
-  addition?: boolean;
-  data?: Record<string, any>;
-  entity?: boolean;
-  field_id?: number;
-  input?: string;
-  limit?: number;
-  offset?: number;
-  policies?: boolean;
-  query?: string;
-  record_id?: number;
-  total?: boolean;
-}
-
 export interface EntityQueryOrderVO {
   column?: string;
   order?: string;
 }
 
-export interface EntityQueryRelationReqVO {
-  addition?: boolean;
-  data?: Record<string, any>;
-  entity?: boolean;
-  field_id?: number;
-  input?: string;
-  limit?: number;
-  offset?: number;
-  policies?: boolean;
-  query?: string;
-  total?: boolean;
-}
-
-export interface EntityQueryRelationRespVO {
-  add_policy?: PermitPolicy;
-  addition?: PostqueryAppendData;
-  entity?: EntityVO;
-  records?: DataRecord[];
-  total?: number;
-  view_policy?: PermitPolicy;
-}
-
 export interface EntityQueryReqVO {
   limit?: number;
   offset?: number;

package/src/generated/command_registry.generated.ts

@@ -167,6 +167,148 @@ export const adminCommands = [
     "queryParams": [],
     "responseType": "boolean"
   },
+  {
+    "scope": "admin",
+    "module": "dashboard",
+    "functionName": "getDashboardList",
+    "commandPath": [
+      "dashboard",
+      "list"
+    ],
+    "method": "GET",
+    "endpoint": "/api/apps/:app_id/dashboard",
+    "pathParams": [
+      {
+        "param": "app_id",
+        "flag": "app-id"
+      }
+    ],
+    "controller": "Dashboard.GetList",
+    "requestType": null,
+    "queryParams": [],
+    "responseType": "DashboardGetListRespVO"
+  },
+  {
+    "scope": "admin",
+    "module": "dashboard",
+    "functionName": "createDashboard",
+    "commandPath": [
+      "dashboard",
+      "create"
+    ],
+    "method": "POST",
+    "endpoint": "/api/apps/:app_id/dashboard",
+    "pathParams": [
+      {
+        "param": "app_id",
+        "flag": "app-id"
+      }
+    ],
+    "controller": "Dashboard.Create",
+    "requestType": "DashboardCreateReqVO",
+    "queryParams": [],
+    "responseType": "DashboardCreateRespVO"
+  },
+  {
+    "scope": "admin",
+    "module": "dashboard",
+    "functionName": "getDashboardOptions",
+    "commandPath": [
+      "dashboard",
+      "get-options"
+    ],
+    "method": "GET",
+    "endpoint": "/api/apps/:app_id/dashboard/:dashboard_id/options",
+    "pathParams": [
+      {
+        "param": "app_id",
+        "flag": "app-id"
+      },
+      {
+        "param": "dashboard_id",
+        "flag": "dashboard-id"
+      }
+    ],
+    "controller": "Dashboard.FetchOptions",
+    "requestType": null,
+    "queryParams": [],
+    "responseType": "DashboardFetchOptionsRespVO"
+  },
+  {
+    "scope": "admin",
+    "module": "dashboard",
+    "functionName": "updateDashboardOptions",
+    "commandPath": [
+      "dashboard",
+      "update-options"
+    ],
+    "method": "PUT",
+    "endpoint": "/api/apps/:app_id/dashboard/:dashboard_id/options",
+    "pathParams": [
+      {
+        "param": "app_id",
+        "flag": "app-id"
+      },
+      {
+        "param": "dashboard_id",
+        "flag": "dashboard-id"
+      }
+    ],
+    "controller": "Dashboard.UpdateOptions",
+    "requestType": "DashboardUpdateOptionsReqVO",
+    "queryParams": [],
+    "responseType": "DashboardUpdateOptionsRespVO"
+  },
+  {
+    "scope": "admin",
+    "module": "dashboard",
+    "functionName": "updateDashboardLayout",
+    "commandPath": [
+      "dashboard",
+      "update-layout"
+    ],
+    "method": "PUT",
+    "endpoint": "/api/apps/:app_id/dashboard/:dashboard_id/layout",
+    "pathParams": [
+      {
+        "param": "app_id",
+        "flag": "app-id"
+      },
+      {
+        "param": "dashboard_id",
+        "flag": "dashboard-id"
+      }
+    ],
+    "controller": "Dashboard.UpdateLayout",
+    "requestType": "DashboardUpdateLayoutReqVO",
+    "queryParams": [],
+    "responseType": "DashboardUpdateLayoutRespVO"
+  },
+  {
+    "scope": "admin",
+    "module": "dashboard",
+    "functionName": "updateDashboardTitle",
+    "commandPath": [
+      "dashboard",
+      "rename"
+    ],
+    "method": "PUT",
+    "endpoint": "/api/apps/:app_id/dashboard/:dashboard_id/label",
+    "pathParams": [
+      {
+        "param": "app_id",
+        "flag": "app-id"
+      },
+      {
+        "param": "dashboard_id",
+        "flag": "dashboard-id"
+      }
+    ],
+    "controller": "Dashboard.UpdateTitle",
+    "requestType": "DashboardUpdateTitleReqVO",
+    "queryParams": [],
+    "responseType": "DashboardUpdateTitleRespVO"
+  },
   {
     "scope": "admin",
     "module": "table",
@@ -602,6 +744,188 @@ export const adminCommands = [
     "requestType": "EntityWorkflowUpdateReqVO",
     "queryParams": [],
     "responseType": "EntityWorkflowUpdateRespVO"
+  },
+  {
+    "scope": "admin",
+    "module": "widget",
+    "functionName": "widgetsList",
+    "commandPath": [
+      "widget",
+      "list"
+    ],
+    "method": "GET",
+    "endpoint": "/api/apps/:app_id/widgets",
+    "pathParams": [
+      {
+        "param": "app_id",
+        "flag": "app-id"
+      }
+    ],
+    "controller": "App.WidgetsList",
+    "requestType": null,
+    "queryParams": [
+      {
+        "key": "type",
+        "flag": "type",
+        "type": "string",
+        "hasDefault": true
+      },
+      {
+        "key": "dashboard_id",
+        "flag": "dashboard-id",
+        "type": "number",
+        "hasDefault": true
+      },
+      {
+        "key": "ingress_id",
+        "flag": "ingress-id",
+        "type": "number",
+        "hasDefault": true
+      }
+    ],
+    "responseType": "AppWidgetsListRespVO"
+  },
+  {
+    "scope": "admin",
+    "module": "widget",
+    "functionName": "getWidgets",
+    "commandPath": [
+      "widget",
+      "get"
+    ],
+    "method": "GET",
+    "endpoint": "/api/apps/:app_id/widgets/:widgets_id",
+    "pathParams": [
+      {
+        "param": "app_id",
+        "flag": "app-id"
+      },
+      {
+        "param": "widgets_id",
+        "flag": "widget-id"
+      }
+    ],
+    "controller": "App.GetWidgets",
+    "requestType": null,
+    "queryParams": [],
+    "responseType": "AppGetWidgetsRespVO"
+  },
+  {
+    "scope": "admin",
+    "module": "widget",
+    "functionName": "newWidgets",
+    "commandPath": [
+      "widget",
+      "create"
+    ],
+    "method": "POST",
+    "endpoint": "/api/apps/:app_id/widgets",
+    "pathParams": [
+      {
+        "param": "app_id",
+        "flag": "app-id"
+      }
+    ],
+    "controller": "App.NewWidgets",
+    "requestType": "AppNewWidgetsReqVO",
+    "queryParams": [],
+    "responseType": "AppNewWidgetsRespVO"
+  },
+  {
+    "scope": "admin",
+    "module": "widget",
+    "functionName": "updateWidgets",
+    "commandPath": [
+      "widget",
+      "update"
+    ],
+    "method": "PUT",
+    "endpoint": "/api/apps/:app_id/widgets/:widgets_id",
+    "pathParams": [
+      {
+        "param": "app_id",
+        "flag": "app-id"
+      },
+      {
+        "param": "widgets_id",
+        "flag": "widget-id"
+      }
+    ],
+    "controller": "App.UpdateWidgets",
+    "requestType": "AppUpdateWidgetsReqVO",
+    "queryParams": [],
+    "responseType": "AppUpdateWidgetsRespVO"
+  },
+  {
+    "scope": "admin",
+    "module": "widget",
+    "functionName": "updateWidgetsIngressOptions",
+    "commandPath": [
+      "widget",
+      "update-ingress-options"
+    ],
+    "method": "PUT",
+    "endpoint": "/api/apps/:app_id/widgets/:widgets_id/ingress-options",
+    "pathParams": [
+      {
+        "param": "app_id",
+        "flag": "app-id"
+      },
+      {
+        "param": "widgets_id",
+        "flag": "widget-id"
+      }
+    ],
+    "controller": "App.UpdateWidgetsIngressOptions",
+    "requestType": "AppUpdateWidgetsIngressOptionsReqVO",
+    "queryParams": [],
+    "responseType": "AppUpdateWidgetsIngressOptionsRespVO"
+  },
+  {
+    "scope": "admin",
+    "module": "widget",
+    "functionName": "previewWidgetsData",
+    "commandPath": [
+      "widget",
+      "preview-data"
+    ],
+    "method": "POST",
+    "endpoint": "/api/apps/:app_id/widgets-preview",
+    "pathParams": [
+      {
+        "param": "app_id",
+        "flag": "app-id"
+      }
+    ],
+    "controller": "App.PreviewWidgetsData",
+    "requestType": "AppPreviewWidgetsDataReqVO",
+    "queryParams": [],
+    "responseType": "AppPreviewWidgetsDataRespVO"
+  },
+  {
+    "scope": "admin",
+    "module": "widget",
+    "functionName": "deleteWidgets",
+    "commandPath": [
+      "widget",
+      "delete"
+    ],
+    "method": "DELETE",
+    "endpoint": "/api/apps/:app_id/widgets/:widgets_id",
+    "pathParams": [
+      {
+        "param": "app_id",
+        "flag": "app-id"
+      },
+      {
+        "param": "widgets_id",
+        "flag": "widget-id"
+      }
+    ],
+    "controller": "App.DeleteWidgets",
+    "requestType": null,
+    "queryParams": [],
+    "responseType": "boolean"
   }
 ] as const
 
@@ -629,6 +953,77 @@ export const userCommands = [
     ],
     "responseType": "GlobalActionEntryRespVO"
   },
+  {
+    "scope": "user",
+    "module": "app",
+    "functionName": "getAppDetail",
+    "commandPath": [
+      "app",
+      "get"
+    ],
+    "method": "GET",
+    "endpoint": "/api/apps/:id",
+    "pathParams": [
+      {
+        "param": "id",
+        "flag": "app-id"
+      }
+    ],
+    "controller": "UserAction.AppDetail",
+    "requestType": null,
+    "queryParams": [],
+    "responseType": "AppDetailRespVO"
+  },
+  {
+    "scope": "user",
+    "module": "dashboard",
+    "functionName": "getDashboard",
+    "commandPath": [
+      "dashboard",
+      "get"
+    ],
+    "method": "GET",
+    "endpoint": "/api/dashboard/:app_id/:dashboard_id",
+    "pathParams": [
+      {
+        "param": "app_id",
+        "flag": "app-id"
+      },
+      {
+        "param": "dashboard_id",
+        "flag": "dashboard-id"
+      }
+    ],
+    "controller": "UserAction.DashboardGet",
+    "requestType": null,
+    "queryParams": [],
+    "responseType": "DashboardGetRespVO"
+  },
+  {
+    "scope": "user",
+    "module": "dashboard",
+    "functionName": "getDashboardWidgets",
+    "commandPath": [
+      "dashboard",
+      "widgets"
+    ],
+    "method": "GET",
+    "endpoint": "/api/dashboard/:app_id/:dashboard_id/widgets",
+    "pathParams": [
+      {
+        "param": "app_id",
+        "flag": "app-id"
+      },
+      {
+        "param": "dashboard_id",
+        "flag": "dashboard-id"
+      }
+    ],
+    "controller": "UserAction.DashboardWidgets",
+    "requestType": null,
+    "queryParams": [],
+    "responseType": "DashboardWidgets[]"
+  },
   {
     "scope": "user",
     "module": "table",
@@ -1050,6 +1445,27 @@ export const userCommands = [
     "queryParams": [],
     "responseType": "MobileUploadCheckRespVO"
   },
+  {
+    "scope": "user",
+    "module": "widget",
+    "functionName": "fetchWidgetsData",
+    "commandPath": [
+      "widget",
+      "data"
+    ],
+    "method": "POST",
+    "endpoint": "/api/apps/:app_id/widgets-data",
+    "pathParams": [
+      {
+        "param": "app_id",
+        "flag": "app-id"
+      }
+    ],
+    "controller": "UserAction.FetchWidgetsData",
+    "requestType": "FetchWidgetsDataReqVO",
+    "queryParams": [],
+    "responseType": "FetchWidgetsDataRespVO"
+  },
   {
     "scope": "user",
     "module": "profile",

package/src/generated/help_examples.generated.ts

@@ -346,6 +346,190 @@ export const helpExamplesIndex = {
       }
     ]
   },
+  "admin.dashboard.update-layout": {
+    "command": [
+      "dashboard",
+      "update-layout"
+    ],
+    "examples": [
+      {
+        "title": "place one dashboard widget in the top-left area",
+        "body": [
+          {
+            "id": 2188892001,
+            "x": 0,
+            "y": 0,
+            "w": 12,
+            "h": 6
+          }
+        ],
+        "notes": [
+          "the request body is a top-level array",
+          "do not wrap the array as {\"layout\":[...]}"
+        ]
+      }
+    ]
+  },
+  "admin.widget.create": {
+    "command": [
+      "widget",
+      "create"
+    ],
+    "examples": [
+      {
+        "title": "create a dashboard chart widget",
+        "body": {
+          "type": "chart",
+          "options": {
+            "dashboard_id": 2188892001
+          }
+        },
+        "notes": [
+          "do not set options.type by hand",
+          "dashboard_id selects a dashboard widget",
+          "use widget update next to save chart options"
+        ]
+      },
+      {
+        "title": "create an ingress list widget",
+        "body": {
+          "type": "list",
+          "options": {
+            "ingress_id": 2188893001
+          }
+        },
+        "notes": [
+          "ingress_id selects an ingress widget",
+          "do not place ingress widgets with dashboard update-layout"
+        ]
+      }
+    ]
+  },
+  "admin.widget.preview-data": {
+    "command": [
+      "widget",
+      "preview-data"
+    ],
+    "examples": [
+      {
+        "title": "preview dashboard chart data from a table",
+        "body": {
+          "dataSource": 2188891001,
+          "dataSourceType": "entity",
+          "dimensions": [
+            {
+              "IsField": true,
+              "FieldID": 1004,
+              "Name": "Source"
+            }
+          ],
+          "measures": [
+            {
+              "FieldID": 1005,
+              "Aggregate": "sum",
+              "Name": "Total Amount"
+            }
+          ]
+        },
+        "notes": [
+          "preview-data does not accept --widget-id",
+          "do not send widget_id or id in the request body",
+          "copy dimensions and measures from the chart query you want to preview"
+        ]
+      },
+      {
+        "title": "preview count and distinct_count in one grouped chart",
+        "body": {
+          "dataSource": 2188891001,
+          "dataSourceType": "entity",
+          "dimensions": [
+            {
+              "IsField": true,
+              "FieldID": 1004,
+              "Name": "Source"
+            }
+          ],
+          "measures": [
+            {
+              "Aggregate": "count",
+              "Name": "Lead Count"
+            },
+            {
+              "FieldID": 1002,
+              "Aggregate": "distinct_count",
+              "Name": "Distinct Customers"
+            }
+          ]
+        },
+        "notes": [
+          "supported Aggregate values are sum, avg, max, min, count, and distinct_count",
+          "unsupported aggregate names fail local body validation before the request is sent"
+        ]
+      },
+      {
+        "title": "preview filtered distinct_count grouped by source",
+        "body": {
+          "dataSource": 2188891001,
+          "dataSourceType": "entity",
+          "dimensions": [
+            {
+              "IsField": true,
+              "FieldID": 1004,
+              "Name": "Source"
+            }
+          ],
+          "conditions": {
+            "mode": "and",
+            "conditions": [
+              {
+                "column": ":1006",
+                "operator": "$eq",
+                "value": "yes"
+              }
+            ]
+          },
+          "measures": [
+            {
+              "FieldID": 1002,
+              "Aggregate": "distinct_count",
+              "Name": "Distinct Customers"
+            }
+          ]
+        },
+        "notes": [
+          "use conditions, not filters, for chart data filtering",
+          "for saved charts put the same condition set under options.charts.conditions",
+          "do not remove the condition and hand-calculate filtered statistics from row query results"
+        ]
+      }
+    ]
+  },
+  "admin.widget.update-ingress-options": {
+    "command": [
+      "widget",
+      "update-ingress-options"
+    ],
+    "examples": [
+      {
+        "title": "adjust an ingress list widget display configuration",
+        "body": {
+          "options": {
+            "cond_follow": true,
+            "cond_follow_tab": true,
+            "cond_follow_cols": [
+              ":1001",
+              ":1002"
+            ]
+          }
+        },
+        "notes": [
+          "use this only for widgets created with options.ingress_id",
+          "do not use dashboard update-layout for ingress widgets",
+          "verify with widget get after updating ingress options"
+        ]
+      }
+    ]
+  },
   "user.row.bulk-update": {
     "command": [
       "row",