@carthooks/arcubase-cli 0.1.19 → 0.1.21

package/sdk-dist/docs/runtime-reference/help-examples/user/row/bulk-update.json

@@ -0,0 +1,23 @@
+{
+  "scope": "user",
+  "command": ["row", "bulk-update"],
+  "examples": [
+    {
+      "title": "bulk update explicit row ids",
+      "body": {
+        "selection": {"type": "ids", "ids": [2188890411, 2188890412], "length": 2},
+        "fields": [{"id": 1003, "action": {"type": "set", "value": 2}}]
+      }
+    },
+    {
+      "title": "bulk update rows selected by a search condition",
+      "body": {
+        "selection": {"type": "condition", "condition": {"selectAll": true, "q": "SO-1001"}, "length": 0},
+        "fields": [{"id": 1003, "action": {"type": "set", "value": 2}}]
+      },
+      "notes": [
+        "condition selection uses row-query style keys such as q, tab, and filter_:1002"
+      ]
+    }
+  ]
+}

package/sdk-dist/docs/runtime-reference/help-examples/user/row/selection-action.json

@@ -0,0 +1,25 @@
+{
+  "scope": "user",
+  "command": ["row", "selection-action"],
+  "examples": [
+    {
+      "title": "run a custom action against explicit row ids",
+      "body": {
+        "selection": {"type": "ids", "ids": [2188890411], "length": 1}
+      },
+      "notes": [
+        "pass the backend action code with --action",
+        "for query action, use ids or all selection instead of condition selection"
+      ]
+    },
+    {
+      "title": "run a custom action against a filtered selection",
+      "body": {
+        "selection": {"type": "condition", "condition": {"selectAll": true, "q": "SO-1001"}, "length": 0}
+      },
+      "notes": [
+        "condition selection uses row-query style keys such as q, tab, and filter_:1002"
+      ]
+    }
+  ]
+}

package/sdk-dist/generated/command_registry.generated.ts

@@ -475,6 +475,27 @@ export const adminCommands = [
     "queryParams": [],
     "responseType": "AppIngressUpdateRespVO"
   },
+  {
+    "scope": "admin",
+    "module": "access-rule",
+    "functionName": "bulkApplyEntityIngress",
+    "commandPath": [
+      "access-rule",
+      "bulk-apply"
+    ],
+    "method": "POST",
+    "endpoint": "/api/apps/:app_id/access-rules/bulk-apply",
+    "pathParams": [
+      {
+        "param": "app_id",
+        "flag": "app-id"
+      }
+    ],
+    "controller": "App.IngressBulkApply",
+    "requestType": "AppIngressBulkApplyReqVO",
+    "queryParams": [],
+    "responseType": "AppIngressBulkApplyRespVO"
+  },
   {
     "scope": "admin",
     "module": "workflow",

package/sdk-dist/generated/help_examples.generated.ts

@@ -0,0 +1,444 @@
+// Generated by scripts/generate-help-examples.mjs. Do not edit by hand.
+
+export type GeneratedHelpExample = {
+  title: string
+  body?: unknown
+  notes?: readonly string[]
+}
+
+export const helpExamplesIndex = {
+  "admin.access-rule.assign-users": {
+    "command": [
+      "access-rule",
+      "assign-users"
+    ],
+    "examples": [
+      {
+        "title": "replace user_scope with user, department, and actor scopes",
+        "body": {
+          "update": [
+            "user_scope"
+          ],
+          "options": {
+            "user_scope": [
+              {
+                "type": "user",
+                "id": 2188889901
+              },
+              {
+                "type": "department",
+                "id": 2188881201
+              },
+              {
+                "type": "actor",
+                "id": 2188883301
+              }
+            ]
+          }
+        },
+        "notes": [
+          "id must be numeric arcubaseUserId, department ID, or actor ID",
+          "assign-users updates user_scope only and preserves the existing policy"
+        ]
+      }
+    ]
+  },
+  "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",
+      "create"
+    ],
+    "examples": [
+      {
+        "title": "full access for a specific arcubaseUserId",
+        "body": {
+          "name": "Admin full access",
+          "enabled": true,
+          "type": "form",
+          "options": {
+            "user_scope": [
+              {
+                "type": "user",
+                "id": 2188889977
+              }
+            ],
+            "policy": {
+              "key": "custom",
+              "actions": [
+                "view",
+                "add",
+                "edit",
+                "delete"
+              ],
+              "all_fields_read": true,
+              "all_fields_write": true
+            },
+            "list_options": {}
+          }
+        }
+      },
+      {
+        "title": "department can view/add/edit only rows created by themselves",
+        "body": {
+          "name": "Sales own 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": {}
+          }
+        },
+        "notes": [
+          "department scope includes child departments",
+          "row-owner isolation uses [[current_user]] on creator"
+        ]
+      },
+      {
+        "title": "role actor can view rows matching a complex AND/OR condition",
+        "body": {
+          "name": "Sales manager review 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": [
+          "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"
+        ]
+      }
+    ]
+  },
+  "user.row.bulk-update": {
+    "command": [
+      "row",
+      "bulk-update"
+    ],
+    "examples": [
+      {
+        "title": "bulk update explicit row ids",
+        "body": {
+          "selection": {
+            "type": "ids",
+            "ids": [
+              2188890411,
+              2188890412
+            ],
+            "length": 2
+          },
+          "fields": [
+            {
+              "id": 1003,
+              "action": {
+                "type": "set",
+                "value": 2
+              }
+            }
+          ]
+        }
+      },
+      {
+        "title": "bulk update rows selected by a search condition",
+        "body": {
+          "selection": {
+            "type": "condition",
+            "condition": {
+              "selectAll": true,
+              "q": "SO-1001"
+            },
+            "length": 0
+          },
+          "fields": [
+            {
+              "id": 1003,
+              "action": {
+                "type": "set",
+                "value": 2
+              }
+            }
+          ]
+        },
+        "notes": [
+          "condition selection uses row-query style keys such as q, tab, and filter_:1002"
+        ]
+      }
+    ]
+  },
+  "user.row.selection-action": {
+    "command": [
+      "row",
+      "selection-action"
+    ],
+    "examples": [
+      {
+        "title": "run a custom action against explicit row ids",
+        "body": {
+          "selection": {
+            "type": "ids",
+            "ids": [
+              2188890411
+            ],
+            "length": 1
+          }
+        },
+        "notes": [
+          "pass the backend action code with --action",
+          "for query action, use ids or all selection instead of condition selection"
+        ]
+      },
+      {
+        "title": "run a custom action against a filtered selection",
+        "body": {
+          "selection": {
+            "type": "condition",
+            "condition": {
+              "selectAll": true,
+              "q": "SO-1001"
+            },
+            "length": 0
+          }
+        },
+        "notes": [
+          "condition selection uses row-query style keys such as q, tab, and filter_:1002"
+        ]
+      }
+    ]
+  }
+} as const satisfies Record<string, { command: readonly string[]; examples: readonly GeneratedHelpExample[] }>

package/sdk-dist/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": []

package/sdk-dist/generated/zod_registry.generated.ts

@@ -34,6 +34,10 @@ 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())
@@ -165,6 +169,7 @@ export const UserProfileUpdateReqVOSchema: z.ZodTypeAny = z.lazy(() => z.object(
 export const generatedRequestTypes = [
   "AppCreateByTenantsReqVO",
   "AppCreateEntityReqVO",
+  "AppIngressBulkApplyReqVO",
   "AppIngressCreateReqVO",
   "AppIngressUpdateReqVO",
   "AppUpdateAppReqVO",
@@ -191,6 +196,7 @@ export const generatedRequestTypes = [
 export const bodySchemas = {
   "AppCreateByTenantsReqVO": AppCreateByTenantsReqVOSchema,
   "AppCreateEntityReqVO": AppCreateEntityReqVOSchema,
+  "AppIngressBulkApplyReqVO": AppIngressBulkApplyReqVOSchema,
   "AppIngressCreateReqVO": AppIngressCreateReqVOSchema,
   "AppIngressUpdateReqVO": AppIngressUpdateReqVOSchema,
   "AppUpdateAppReqVO": AppUpdateAppReqVOSchema,

package/sdk-dist/types/ingress.ts

@@ -53,6 +53,37 @@ export interface AppIngressBlockVO {
   content?: string;
 }
 
+export interface AppIngressBulkApplyItemRespVO {
+  enabled?: boolean;
+  index?: number;
+  name?: string;
+  operation?: string;
+  rule_id?: number;
+  table_id?: number;
+}
+
+export interface AppIngressBulkApplyItemVO {
+  enabled?: boolean;
+  name?: string;
+  options?: EntityIngressOptions;
+  rule_id?: number;
+  table_id?: number;
+  type?: string;
+}
+
+export interface AppIngressBulkApplyReqVO {
+  dry_run?: boolean;
+  items?: AppIngressBulkApplyItemVO[];
+  mode?: string;
+}
+
+export interface AppIngressBulkApplyRespVO {
+  app_id?: number;
+  applied_count?: number;
+  dry_run?: boolean;
+  items?: AppIngressBulkApplyItemRespVO[];
+}
+
 export interface AppIngressCreateReqVO {
   enabled?: boolean;
   entity_id?: number;

package/src/generated/command_registry.generated.ts

@@ -475,6 +475,27 @@ export const adminCommands = [
     "queryParams": [],
     "responseType": "AppIngressUpdateRespVO"
   },
+  {
+    "scope": "admin",
+    "module": "access-rule",
+    "functionName": "bulkApplyEntityIngress",
+    "commandPath": [
+      "access-rule",
+      "bulk-apply"
+    ],
+    "method": "POST",
+    "endpoint": "/api/apps/:app_id/access-rules/bulk-apply",
+    "pathParams": [
+      {
+        "param": "app_id",
+        "flag": "app-id"
+      }
+    ],
+    "controller": "App.IngressBulkApply",
+    "requestType": "AppIngressBulkApplyReqVO",
+    "queryParams": [],
+    "responseType": "AppIngressBulkApplyRespVO"
+  },
   {
     "scope": "admin",
     "module": "workflow",