@carthooks/arcubase-cli 0.1.18 → 0.1.20

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

@@ -0,0 +1,289 @@
+// 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.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/zod_registry.generated.ts

@@ -12,7 +12,7 @@ export const PermitColumnSchema: z.ZodTypeAny = z.lazy(() => z.object({ "field_i
 
 export const PermitSearchColumnSchema: z.ZodTypeAny = z.lazy(() => z.object({ "default": z.boolean().optional(), "default_value": z.array(z.number()).optional(), "field_id": z.number().optional(), "infilter": z.boolean().optional(), "is_field": z.boolean().optional(), "pinned": z.boolean().optional(), "prop": z.string().optional(), "wildcard": z.boolean().optional() }).strict())
 
-export const PermitEntityPropSchema: z.ZodTypeAny = z.lazy(() => z.union([z.literal("created"), z.literal("updated"), z.literal("creator")]))
+export const PermitEntityPropSchema: z.ZodTypeAny = z.lazy(() => z.string().min(1))
 
 export const PermitValueFromSchema: z.ZodTypeAny = z.lazy(() => z.union([z.literal(1), z.literal(2), z.literal(3)]))
 

package/sdk-dist/types/common.ts

@@ -291,6 +291,7 @@ export interface ActionBulkUpdateAction {
 
 export interface KioskConfig {
   interactiveMode?: string;
+  lookupCondition?: PermitConditionSet;
   lookupFields?: number[];
   options?: Record<string, any>;
   printers?: Record<string, any>[];

package/sdk-dist/types/entity.ts

@@ -11,7 +11,7 @@
  */
 
 /** @format int32 */
-import type { PermitEntityEvent, NotificationPayloadMode, NotificationNotificationType, MagicStringPartType, ActionBulkUpdate, ActionBulkUpdateAction, GormDeletedAt, KioskConfig, KioskScreen, AiOptions, ApiEndpoint, ApiEndpointParam, ApiOptions, App, AppOptions, Assets, Button, CustomAction, EntityFrontEvent, EntityKioskFlow, EntityOptions, EntityPrintTemplate, Fields, MagicString, MagicStringPart, PermitUserScope, ErrorResponse } from './common'
+import type { PermitValueFrom, PermitEntityProp, PermitEntityEvent, NotificationPayloadMode, NotificationNotificationType, MagicStringPartType, ActionBulkUpdate, ActionBulkUpdateAction, GormDeletedAt, KioskConfig, KioskScreen, AiOptions, ApiEndpoint, ApiEndpointParam, ApiOptions, App, AppOptions, Assets, Button, CustomAction, EntityFrontEvent, EntityKioskFlow, EntityOptions, EntityPrintTemplate, Fields, MagicString, MagicStringPart, PermitConditionSet, PermitRecordCondition, PermitUserScope, ErrorResponse } from './common'
 
 export enum FieldInitMode {
   FieldInitModeStatic = 0,

package/sdk-dist/types/kiosk-ui.ts

@@ -11,7 +11,7 @@
  */
 
 /** @format int32 */
-import type { WorkflowStateType, PermitEntityEvent, NotificationPayloadMode, NotificationNotificationType, PronounsType, MagicStringPartType, KioskConfig, KioskScreen, AiOptions, ApiEndpoint, ApiEndpointParam, ApiOptions, Button, CustomAction, DataRecord, EntityFrontEvent, EntityOptions, EntityVO, Fields, MagicString, MagicStringPart, DataRecordProcess, DataRecordResource, DataRecordTrans, PostqueryAppendData, PostqueryUserData, PostqueryAssetsData, PostqueryDepartmentData, PostqueryLinktoData, StorageUrlSets, ErrorResponse, OpenAPITenantInfo } from './common'
+import type { WorkflowStateType, PermitValueFrom, PermitEntityProp, PermitEntityEvent, NotificationPayloadMode, NotificationNotificationType, PronounsType, MagicStringPartType, KioskConfig, KioskScreen, AiOptions, ApiEndpoint, ApiEndpointParam, ApiOptions, Button, CustomAction, DataRecord, EntityFrontEvent, EntityOptions, EntityVO, Fields, MagicString, MagicStringPart, DataRecordProcess, DataRecordResource, DataRecordTrans, PermitConditionSet, PermitRecordCondition, PostqueryAppendData, PostqueryUserData, PostqueryAssetsData, PostqueryDepartmentData, PostqueryLinktoData, StorageUrlSets, ErrorResponse, OpenAPITenantInfo } from './common'
 
 export interface CheckPrintDuplicateReqVO {
   /** kiosk flow id */

package/sdk-dist/types/tenant.ts

@@ -11,7 +11,7 @@
  */
 
 /** @format int32 */
-import type { MagicStringPartType, GormDeletedAt, KioskConfig, KioskScreen, ApiEndpoint, ApiEndpointParam, EntityKioskFlow, MagicString, MagicStringPart, PermitUserScope, SqlNullTime, CommonPagination, ErrorResponse } from './common'
+import type { PermitValueFrom, PermitEntityProp, MagicStringPartType, GormDeletedAt, KioskConfig, KioskScreen, ApiEndpoint, ApiEndpointParam, EntityKioskFlow, MagicString, MagicStringPart, PermitConditionSet, PermitRecordCondition, PermitUserScope, SqlNullTime, CommonPagination, ErrorResponse } from './common'
 
 export enum TenantUserMetaDataPolicy {
   TenantUserMetaDataPolicyNone = 1,

package/src/generated/help_examples.generated.ts

@@ -0,0 +1,289 @@
+// 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.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/src/generated/zod_registry.generated.ts

@@ -12,7 +12,7 @@ export const PermitColumnSchema: z.ZodTypeAny = z.lazy(() => z.object({ "field_i
 
 export const PermitSearchColumnSchema: z.ZodTypeAny = z.lazy(() => z.object({ "default": z.boolean().optional(), "default_value": z.array(z.number()).optional(), "field_id": z.number().optional(), "infilter": z.boolean().optional(), "is_field": z.boolean().optional(), "pinned": z.boolean().optional(), "prop": z.string().optional(), "wildcard": z.boolean().optional() }).strict())
 
-export const PermitEntityPropSchema: z.ZodTypeAny = z.lazy(() => z.union([z.literal("created"), z.literal("updated"), z.literal("creator")]))
+export const PermitEntityPropSchema: z.ZodTypeAny = z.lazy(() => z.string().min(1))
 
 export const PermitValueFromSchema: z.ZodTypeAny = z.lazy(() => z.union([z.literal(1), z.literal(2), z.literal(3)]))