@carthooks/arcubase-cli 0.1.20 → 0.1.22

package/src/generated/help_examples.generated.ts

@@ -43,6 +43,161 @@ export const helpExamplesIndex = {
       }
     ]
   },
+  "admin.access-rule.bulk-apply": {
+    "command": [
+      "access-rule",
+      "bulk-apply"
+    ],
+    "examples": [
+      {
+        "title": "upsert permission matrix by rule name in one transaction",
+        "body": {
+          "mode": "upsert_by_name",
+          "items": [
+            {
+              "table_id": 2188893443,
+              "name": "Customer archive - sales owns rows",
+              "enabled": true,
+              "type": "form",
+              "options": {
+                "user_scope": [
+                  {
+                    "type": "department",
+                    "id": 2188881201
+                  }
+                ],
+                "policy": {
+                  "key": "custom",
+                  "actions": [
+                    "view",
+                    "add",
+                    "edit"
+                  ],
+                  "all_fields_read": true,
+                  "all_fields_write": true,
+                  "condition": {
+                    "mode": "and",
+                    "conditions": [
+                      {
+                        "column": "creator",
+                        "operator": "$eq",
+                        "value": "[[current_user]]",
+                        "value_from": 0,
+                        "value_relation": ""
+                      }
+                    ]
+                  }
+                },
+                "list_options": {}
+              }
+            },
+            {
+              "table_id": 2188893444,
+              "name": "Lead review - manager queue",
+              "enabled": true,
+              "type": "form",
+              "options": {
+                "user_scope": [
+                  {
+                    "type": "actor",
+                    "id": 2188883301
+                  }
+                ],
+                "policy": {
+                  "key": "custom",
+                  "actions": [
+                    "view",
+                    "edit"
+                  ],
+                  "all_fields_read": true,
+                  "all_fields_write": true,
+                  "condition": {
+                    "mode": "and",
+                    "conditions": [
+                      {
+                        "column": ":1004",
+                        "operator": "$eq",
+                        "value": "pending",
+                        "value_from": 0,
+                        "value_relation": ""
+                      },
+                      {
+                        "column": "",
+                        "operator": "",
+                        "value": null,
+                        "value_from": 0,
+                        "value_relation": "",
+                        "subset": {
+                          "mode": "or",
+                          "conditions": [
+                            {
+                              "column": "creator",
+                              "operator": "$eq",
+                              "value": "[[current_user]]",
+                              "value_from": 0,
+                              "value_relation": ""
+                            },
+                            {
+                              "column": ":1005",
+                              "operator": "$eq",
+                              "value": "high",
+                              "value_from": 0,
+                              "value_relation": ""
+                            }
+                          ]
+                        }
+                      }
+                    ]
+                  }
+                },
+                "list_options": {}
+              }
+            }
+          ]
+        },
+        "notes": [
+          "mode upsert_by_name is for idempotent setup; rule names must be unique within each table",
+          "department, actor, and specific user scopes all use options.user_scope",
+          "row-owner isolation uses [[current_user]] in policy.condition"
+        ]
+      },
+      {
+        "title": "preview updates for existing rule ids",
+        "body": {
+          "mode": "update_existing",
+          "dry_run": true,
+          "items": [
+            {
+              "table_id": 2188893443,
+              "rule_id": 2188893557,
+              "enabled": true,
+              "options": {
+                "user_scope": [
+                  {
+                    "type": "user",
+                    "id": 2188889901
+                  }
+                ],
+                "policy": {
+                  "key": "custom",
+                  "actions": [
+                    "view"
+                  ],
+                  "all_fields_read": true,
+                  "all_fields_write": false
+                },
+                "list_options": {}
+              }
+            }
+          ]
+        },
+        "notes": [
+          "dry_run true returns the planned operations without writing",
+          "update_existing requires rule_id on every item"
+        ]
+      }
+    ]
+  },
   "admin.access-rule.create": {
     "command": [
       "access-rule",
@@ -191,6 +346,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",

package/src/generated/type_index.generated.ts

@@ -9,6 +9,10 @@ export const typeIndex = {
     "file": "types/app.ts",
     "dependencies": []
   },
+  "AppIngressBulkApplyReqVO": {
+    "file": "types/ingress.ts",
+    "dependencies": []
+  },
   "AppIngressCreateReqVO": {
     "file": "types/ingress.ts",
     "dependencies": []
@@ -17,10 +21,47 @@ export const typeIndex = {
     "file": "types/ingress.ts",
     "dependencies": []
   },
+  "AppNewWidgetsReqVO": {
+    "file": "types/widgets.ts",
+    "dependencies": []
+  },
+  "AppPreviewWidgetsDataReqVO": {
+    "file": "types/widgets.ts",
+    "dependencies": []
+  },
   "AppUpdateAppReqVO": {
     "file": "types/app.ts",
     "dependencies": []
   },
+  "AppUpdateWidgetsIngressOptionsReqVO": {
+    "file": "types/widgets.ts",
+    "dependencies": []
+  },
+  "AppUpdateWidgetsReqVO": {
+    "file": "types/widgets.ts",
+    "dependencies": []
+  },
+  "DashboardCreateReqVO": {
+    "file": "types/dashboard.ts",
+    "dependencies": []
+  },
+  "DashboardUpdateLayoutReqVO": {
+    "file": "types/dashboard.ts",
+    "dependencies": [
+      {
+        "symbol": "LayoutPosition",
+        "file": "types/dashboard.ts"
+      }
+    ]
+  },
+  "DashboardUpdateOptionsReqVO": {
+    "file": "types/dashboard.ts",
+    "dependencies": []
+  },
+  "DashboardUpdateTitleReqVO": {
+    "file": "types/dashboard.ts",
+    "dependencies": []
+  },
   "EntityBulkUpdateReqVO": {
     "file": "types/user-action.ts",
     "dependencies": []
@@ -30,7 +71,7 @@ export const typeIndex = {
     "dependencies": []
   },
   "EntityQueryRelationReqVO": {
-    "file": "types/user-action.ts",
+    "file": "types/common.ts",
     "dependencies": []
   },
   "EntityQueryReqVO": {
@@ -69,6 +110,10 @@ export const typeIndex = {
     "file": "types/workflow.ts",
     "dependencies": []
   },
+  "FetchWidgetsDataReqVO": {
+    "file": "types/user-action.ts",
+    "dependencies": []
+  },
   "GetUploadTokenReqVO": {
     "file": "types/user-action.ts",
     "dependencies": []

package/src/generated/zod_registry.generated.ts

@@ -34,16 +34,54 @@ export const PermitUserScopeSchema: z.ZodTypeAny = z.lazy(() => z.object({ "data
 
 export const EntityIngressOptionsSchema: z.ZodTypeAny = z.lazy(() => z.object({ "i18n_name": I18NTextSchema.optional(), "list_options": PermitEntityListOptionsSchema.optional(), "policy": PermitPolicySchema.optional(), "user_scope": z.array(PermitUserScopeSchema).optional() }).strict())
 
+export const AppIngressBulkApplyItemVOSchema: z.ZodTypeAny = z.lazy(() => z.object({ "enabled": z.boolean().optional(), "name": z.string().optional(), "options": EntityIngressOptionsSchema.optional(), "rule_id": z.number().optional(), "table_id": z.number().optional(), "type": z.string().optional() }).strict())
+
+export const AppIngressBulkApplyReqVOSchema: z.ZodTypeAny = z.lazy(() => z.object({ "dry_run": z.boolean().optional(), "items": z.array(AppIngressBulkApplyItemVOSchema).optional(), "mode": z.string().optional() }).strict())
+
 export const AppIngressCreateReqVOSchema: z.ZodTypeAny = z.lazy(() => z.object({ "enabled": z.boolean().optional(), "entity_id": z.number().optional(), "icon_name": z.string().optional(), "name": z.string().optional(), "options": EntityIngressOptionsSchema.optional(), "type": z.string().optional(), "url": z.string().optional() }).strict())
 
 export const AppIngressUpdateReqVOSchema: z.ZodTypeAny = z.lazy(() => z.object({ "enabled": z.boolean().optional(), "name": z.string().optional(), "options": EntityIngressOptionsSchema.optional(), "update": z.array(z.string()).optional() }).strict())
 
+export const WidgetsTypeCodeSchema: z.ZodTypeAny = z.lazy(() => z.union([z.literal(1), z.literal(2)]))
+
+export const WidgetsTypeSchema: z.ZodTypeAny = z.lazy(() => z.object({ "dashboard_id": z.number().optional(), "ingress_id": z.number().optional(), "type": WidgetsTypeCodeSchema.optional() }).strict())
+
+export const AppNewWidgetsReqVOSchema: z.ZodTypeAny = z.lazy(() => z.object({ "options": WidgetsTypeSchema.optional(), "type": z.string().optional() }).strict())
+
+export const CubeDimensionSchema: z.ZodTypeAny = z.lazy(() => z.object({ "FieldID": z.number().optional(), "IsField": z.boolean().optional(), "Label": z.string().optional(), "Name": z.string().optional(), "Options": z.record(z.string(), z.any()).optional(), "OrderBy": z.string().optional(), "PropName": z.string().optional() }).strict())
+
+export const CubeMeasureAggregateSchema: z.ZodTypeAny = z.lazy(() => z.union([z.literal("sum"), z.literal("avg"), z.literal("max"), z.literal("min"), z.literal("count"), z.literal("distinct_count")]))
+
+export const CubeMeasureSchema: z.ZodTypeAny = z.lazy(() => z.object({ "Aggregate": CubeMeasureAggregateSchema.optional(), "FieldID": z.number().optional(), "Label": z.string().optional(), "Name": z.string().optional(), "Options": z.record(z.string(), z.any()).optional(), "OrderBy": z.string().optional() }).strict())
+
+export const AppPreviewWidgetsDataReqVOSchema: z.ZodTypeAny = z.lazy(() => z.object({ "conditions": PermitConditionSetSchema.optional(), "dataSource": z.number().optional(), "dataSourceType": z.string().optional(), "dimensions": z.array(CubeDimensionSchema).optional(), "measures": z.array(CubeMeasureSchema).optional() }).strict())
+
 export const GormDeletedAtSchema: z.ZodTypeAny = z.lazy(() => z.object({ "Time": z.string().optional(), "Valid": z.boolean().optional() }).strict())
 
 export const AppOptionsSchema: z.ZodTypeAny = z.lazy(() => z.object({ "use_home_dashboard": z.boolean().optional() }).strict())
 
 export const AppUpdateAppReqVOSchema: z.ZodTypeAny = z.lazy(() => z.object({ "CreatedAt": z.string().optional(), "DeletedAt": GormDeletedAtSchema.optional(), "ID": z.number().optional(), "Options": AppOptionsSchema.optional(), "UpdatedAt": z.string().optional(), "changed": z.array(z.string()).optional(), "has_workflow": z.boolean().optional(), "icon_color": z.string().optional(), "icon_name": z.string().optional(), "name": z.string().optional(), "tenant_id": z.number().optional(), "use_home_dashboard": z.boolean().optional() }).strict())
 
+export const WidgetsListViewOptionsSchema: z.ZodTypeAny = z.lazy(() => z.object({ "cond_follow": z.boolean().optional(), "cond_follow_cols": z.array(z.string()).optional(), "cond_follow_tab": z.boolean().optional(), "link": z.record(z.string(), z.any()).optional() }).strict())
+
+export const AppUpdateWidgetsIngressOptionsReqVOSchema: z.ZodTypeAny = z.lazy(() => z.object({ "options": WidgetsListViewOptionsSchema.optional() }).strict())
+
+export const ChartOptionSchema: z.ZodTypeAny = z.lazy(() => z.object({ "conditions": PermitConditionSetSchema.optional(), "dimensions": z.array(CubeDimensionSchema).optional(), "entity_id": z.number().optional(), "measures": z.array(CubeMeasureSchema).optional(), "options": z.record(z.string(), z.any()).optional(), "type": z.string().optional() }).strict())
+
+export const WidgetsOptionSchema: z.ZodTypeAny = z.lazy(() => z.object({ "charts": ChartOptionSchema.optional(), "ingress": WidgetsListViewOptionsSchema.optional(), "render": z.record(z.string(), z.any()).optional() }).strict())
+
+export const AppUpdateWidgetsReqVOSchema: z.ZodTypeAny = z.lazy(() => z.object({ "entity_id": z.number().optional(), "options": WidgetsOptionSchema.optional() }).strict())
+
+export const DashboardCreateReqVOSchema: z.ZodTypeAny = z.lazy(() => z.object({ "name": z.string().optional() }).strict())
+
+export const LayoutPositionSchema: z.ZodTypeAny = z.lazy(() => z.object({ "h": z.number().optional(), "id": z.number().optional(), "w": z.number().optional(), "x": z.number().optional(), "y": z.number().optional() }).strict())
+
+export const DashboardUpdateLayoutReqVOSchema: z.ZodTypeAny = z.lazy(() => z.array(LayoutPositionSchema))
+
+export const DashboardUpdateOptionsReqVOSchema: z.ZodTypeAny = z.lazy(() => z.object({ "changed": z.array(z.string()).optional(), "i18n_name": z.record(z.string(), z.string()).optional(), "theme": z.object({ "gutter": z.number().optional(), "has_shadow": z.boolean().optional(), "round_corners": z.number().optional() }).strict().optional(), "users": z.array(PermitUserScopeSchema).optional() }).strict())
+
+export const DashboardUpdateTitleReqVOSchema: z.ZodTypeAny = z.lazy(() => z.object({ "name": z.string().optional() }).strict())
+
 export const EntityBulkUpdateActionVOSchema: z.ZodTypeAny = z.lazy(() => z.object({ "number_add": z.number().optional(), "number_mul": z.number().optional(), "number_sub": z.number().optional(), "text_append": z.string().optional(), "text_prepend": z.string().optional(), "text_replace": z.string().optional(), "text_search": z.string().optional(), "type": z.string().optional(), "value": z.any().optional() }).strict())
 
 export const EntityBulkUpdateFieldVOSchema: z.ZodTypeAny = z.lazy(() => z.object({ "action": EntityBulkUpdateActionVOSchema.optional(), "id": z.number().optional() }).strict())
@@ -140,6 +178,10 @@ export const EntityWorkflowDeployReqVOSchema: z.ZodTypeAny = z.lazy(() => z.obje
 
 export const EntityWorkflowUpdateReqVOSchema: z.ZodTypeAny = z.lazy(() => z.object({ "diagram": WorkflowConfigDiagramSchema.optional(), "id": z.number().optional(), "options": WorkflowOptionsSchema.optional() }).strict())
 
+export const EntityUtilsQueryOrderSchema: z.ZodTypeAny = z.lazy(() => z.object({ "column": z.string().optional(), "order": z.string().optional() }).strict())
+
+export const FetchWidgetsDataReqVOSchema: z.ZodTypeAny = z.lazy(() => z.object({ "dashboard_id": z.number().optional(), "ingress_hash_id": z.string().optional(), "ingress_id": z.number().optional(), "querys": z.object({ "search": z.record(z.string(), z.any()).optional(), "sorts": z.array(EntityUtilsQueryOrderSchema).optional() }).strict().optional(), "type": WidgetsTypeCodeSchema.optional() }).strict())
+
 export const GetUploadTokenReqVOSchema: z.ZodTypeAny = z.lazy(() => z.object({ "global": z.boolean().optional() }).strict())
 
 export const InsertReqVOSchema: z.ZodTypeAny = z.lazy(() => z.object({ "fields": z.record(z.string(), z.any()).optional(), "policy_id": z.string().optional() }).strict())
@@ -165,9 +207,18 @@ export const UserProfileUpdateReqVOSchema: z.ZodTypeAny = z.lazy(() => z.object(
 export const generatedRequestTypes = [
   "AppCreateByTenantsReqVO",
   "AppCreateEntityReqVO",
+  "AppIngressBulkApplyReqVO",
   "AppIngressCreateReqVO",
   "AppIngressUpdateReqVO",
+  "AppNewWidgetsReqVO",
+  "AppPreviewWidgetsDataReqVO",
   "AppUpdateAppReqVO",
+  "AppUpdateWidgetsIngressOptionsReqVO",
+  "AppUpdateWidgetsReqVO",
+  "DashboardCreateReqVO",
+  "DashboardUpdateLayoutReqVO",
+  "DashboardUpdateOptionsReqVO",
+  "DashboardUpdateTitleReqVO",
   "EntityBulkUpdateReqVO",
   "EntityDoActionReqVO",
   "EntityQueryRelationReqVO",
@@ -180,6 +231,7 @@ export const generatedRequestTypes = [
   "EntityWorkflowApproveUsersReqVO",
   "EntityWorkflowDeployReqVO",
   "EntityWorkflowUpdateReqVO",
+  "FetchWidgetsDataReqVO",
   "GetUploadTokenReqVO",
   "InsertReqVO",
   "MobileUploadCheckReqVO",
@@ -191,9 +243,18 @@ export const generatedRequestTypes = [
 export const bodySchemas = {
   "AppCreateByTenantsReqVO": AppCreateByTenantsReqVOSchema,
   "AppCreateEntityReqVO": AppCreateEntityReqVOSchema,
+  "AppIngressBulkApplyReqVO": AppIngressBulkApplyReqVOSchema,
   "AppIngressCreateReqVO": AppIngressCreateReqVOSchema,
   "AppIngressUpdateReqVO": AppIngressUpdateReqVOSchema,
+  "AppNewWidgetsReqVO": AppNewWidgetsReqVOSchema,
+  "AppPreviewWidgetsDataReqVO": AppPreviewWidgetsDataReqVOSchema,
   "AppUpdateAppReqVO": AppUpdateAppReqVOSchema,
+  "AppUpdateWidgetsIngressOptionsReqVO": AppUpdateWidgetsIngressOptionsReqVOSchema,
+  "AppUpdateWidgetsReqVO": AppUpdateWidgetsReqVOSchema,
+  "DashboardCreateReqVO": DashboardCreateReqVOSchema,
+  "DashboardUpdateLayoutReqVO": DashboardUpdateLayoutReqVOSchema,
+  "DashboardUpdateOptionsReqVO": DashboardUpdateOptionsReqVOSchema,
+  "DashboardUpdateTitleReqVO": DashboardUpdateTitleReqVOSchema,
   "EntityBulkUpdateReqVO": EntityBulkUpdateReqVOSchema,
   "EntityDoActionReqVO": EntityDoActionReqVOSchema,
   "EntityQueryRelationReqVO": EntityQueryRelationReqVOSchema,
@@ -206,6 +267,7 @@ export const bodySchemas = {
   "EntityWorkflowApproveUsersReqVO": EntityWorkflowApproveUsersReqVOSchema,
   "EntityWorkflowDeployReqVO": EntityWorkflowDeployReqVOSchema,
   "EntityWorkflowUpdateReqVO": EntityWorkflowUpdateReqVOSchema,
+  "FetchWidgetsDataReqVO": FetchWidgetsDataReqVOSchema,
   "GetUploadTokenReqVO": GetUploadTokenReqVOSchema,
   "InsertReqVO": InsertReqVOSchema,
   "MobileUploadCheckReqVO": MobileUploadCheckReqVOSchema,