@carthooks/arcubase-cli 0.1.21 → 0.1.22

package/dist/generated/command_registry.generated.js

@@ -152,6 +152,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",
@@ -587,6 +729,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"
     }
 ];
 export const userCommands = [
@@ -613,6 +937,56 @@ export const userCommands = [
         ],
         "responseType": "GlobalActionEntryRespVO"
     },
+    {
+        "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",
@@ -1034,6 +1408,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/dist/generated/help_examples.generated.d.ts

@@ -248,6 +248,83 @@ export declare const helpExamplesIndex: {
             readonly notes: readonly ["actor means Arcubase role id", "condition mode \"and\" and \"or\" are canonical; legacy \"all\" also reads as AND", "nested OR uses subset and leaves the wrapper column/operator empty"];
         }];
     };
+    readonly "admin.dashboard.update-layout": {
+        readonly command: readonly ["dashboard", "update-layout"];
+        readonly examples: readonly [{
+            readonly title: "place one dashboard widget in the top-left area";
+            readonly body: readonly [{
+                readonly id: 2188892001;
+                readonly x: 0;
+                readonly y: 0;
+                readonly w: 12;
+                readonly h: 6;
+            }];
+            readonly notes: readonly ["the request body is a top-level array", "do not wrap the array as {\"layout\":[...]}"];
+        }];
+    };
+    readonly "admin.widget.create": {
+        readonly command: readonly ["widget", "create"];
+        readonly examples: readonly [{
+            readonly title: "create a dashboard chart widget";
+            readonly body: {
+                readonly type: "chart";
+                readonly options: {
+                    readonly dashboard_id: 2188892001;
+                };
+            };
+            readonly notes: readonly ["do not set options.type by hand", "dashboard_id selects a dashboard widget", "use widget update next to save chart options"];
+        }, {
+            readonly title: "create an ingress list widget";
+            readonly body: {
+                readonly type: "list";
+                readonly options: {
+                    readonly ingress_id: 2188893001;
+                };
+            };
+            readonly notes: readonly ["ingress_id selects an ingress widget", "do not place ingress widgets with dashboard update-layout"];
+        }];
+    };
+    readonly "admin.widget.preview-data": {
+        readonly command: readonly ["widget", "preview-data"];
+        readonly examples: readonly [{
+            readonly title: "preview dashboard chart data from a table";
+            readonly body: {
+                readonly dataSource: 2188891001;
+                readonly dataSourceType: "entity";
+                readonly dimensions: readonly [{
+                    readonly IsField: true;
+                    readonly FieldID: 1004;
+                    readonly Name: "Source";
+                }];
+                readonly measures: readonly [{
+                    readonly FieldID: 1005;
+                    readonly Aggregate: "sum";
+                    readonly Name: "Total Amount";
+                }];
+            };
+            readonly notes: readonly ["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"];
+        }, {
+            readonly title: "preview count and distinct_count in one grouped chart";
+            readonly body: {
+                readonly dataSource: 2188891001;
+                readonly dataSourceType: "entity";
+                readonly dimensions: readonly [{
+                    readonly IsField: true;
+                    readonly FieldID: 1004;
+                    readonly Name: "Source";
+                }];
+                readonly measures: readonly [{
+                    readonly Aggregate: "count";
+                    readonly Name: "Lead Count";
+                }, {
+                    readonly FieldID: 1002;
+                    readonly Aggregate: "distinct_count";
+                    readonly Name: "Distinct Customers";
+                }];
+            };
+            readonly notes: readonly ["supported Aggregate values are sum, avg, max, min, count, and distinct_count", "unsupported aggregate names fail local body validation before the request is sent"];
+        }];
+    };
     readonly "user.row.bulk-update": {
         readonly command: readonly ["row", "bulk-update"];
         readonly examples: readonly [{

package/dist/generated/help_examples.generated.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"help_examples.generated.d.ts","sourceRoot":"","sources":["../../src/generated/help_examples.generated.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,oBAAoB,GAAG;IACjC,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,KAAK,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;CAC1B,CAAA;AAED,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmbgF,CAAA"}
+{"version":3,"file":"help_examples.generated.d.ts","sourceRoot":"","sources":["../../src/generated/help_examples.generated.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,oBAAoB,GAAG;IACjC,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,KAAK,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;CAC1B,CAAA;AAED,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6iBgF,CAAA"}

package/dist/generated/help_examples.generated.js

@@ -339,6 +339,128 @@ 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"
+                ]
+            }
+        ]
+    },
     "user.row.bulk-update": {
         "command": [
             "row",