@carthooks/arcubase-cli 0.1.3 → 0.1.5

package/sdk-dist/docs/runtime-reference/uploads.md

@@ -0,0 +1,106 @@
+# Uploads
+
+Use this page when a row contains a `file` or `image` field.
+
+The successful path is:
+
+1. run `arcubase upload <local-file>`
+2. use the returned JSON array directly as the field value
+3. insert or update the row with `arcubase rows insert-entity` or `arcubase rows update-entity-row`
+
+Do not construct `upload_id`, `assets_id`, or OSS form fields by hand.
+
+## Upload one local file
+
+Command:
+
+```bash
+arcubase upload ./contract.pdf
+```
+
+Optional flags:
+
+- `--filename <name>`
+- `--global`
+
+Example:
+
+```bash
+arcubase upload ./lead-photo.jpg --filename lead-photo.jpg
+```
+
+## Upload result shape
+
+The command returns a JSON array.
+
+Example:
+
+```json
+{
+  "data": [
+    {
+      "upload_id": 123456,
+      "file": "contract.pdf",
+      "file_name": "contract.pdf",
+      "meta": {}
+    }
+  ]
+}
+```
+
+Use the `data` array directly as the field value for a `file` or `image` field.
+
+## Insert a row with a file field
+
+```json
+{
+  "fields": {
+    "1001": "Lead A",
+    "1007": [
+      {
+        "upload_id": 123456,
+        "file": "contract.pdf",
+        "file_name": "contract.pdf",
+        "meta": {}
+      }
+    ]
+  }
+}
+```
+
+## Update a row with an image field
+
+```json
+{
+  "data": {
+    "1008": [
+      {
+        "upload_id": 123457,
+        "file": "lead-photo.jpg",
+        "file_name": "lead-photo.jpg",
+        "meta": {}
+      }
+    ]
+  },
+  "changed_fields": [1008]
+}
+```
+
+## Preview an uploaded file
+
+Command:
+
+```bash
+arcubase common upload-preview --body-file preview.json
+```
+
+Example `preview.json`:
+
+```json
+{
+  "upload_id": 123456,
+  "fname": "contract.pdf"
+}
+```
+
+This returns a preview URL for the upload token entry. It does not insert or update a row.

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

@@ -103,6 +103,22 @@ export const adminCommands = [
     "scalarParams": [],
     "responseType": "AppCreateByTenantsRespVO"
   },
+  {
+    "scope": "admin",
+    "module": "app",
+    "functionName": "listApps",
+    "commandPath": [
+      "app",
+      "list-apps"
+    ],
+    "method": "GET",
+    "endpoint": "/apps",
+    "endpointParams": [],
+    "controller": "App.ListApps",
+    "requestType": null,
+    "scalarParams": [],
+    "responseType": "AppListRespVO"
+  },
   {
     "scope": "admin",
     "module": "app",
@@ -3108,88 +3124,6 @@ export const adminCommands = [
       }
     ],
     "responseType": "TenantUsageDailyRespVO"
-  },
-  {
-    "scope": "admin",
-    "module": "workflow",
-    "functionName": "deployEntityWorkflow",
-    "commandPath": [
-      "workflow",
-      "deploy-entity-workflow"
-    ],
-    "method": "POST",
-    "endpoint": "/apps/:app_id/entity/:entity_id/workflow/deploy",
-    "endpointParams": [
-      "app_id",
-      "entity_id"
-    ],
-    "controller": "Entity.WorkflowDeploy",
-    "requestType": "EntityWorkflowDeployReqVO",
-    "scalarParams": [],
-    "responseType": "EntityWorkflowDeployRespVO"
-  },
-  {
-    "scope": "admin",
-    "module": "workflow",
-    "functionName": "getEntityWorkflow",
-    "commandPath": [
-      "workflow",
-      "get-entity-workflow"
-    ],
-    "method": "GET",
-    "endpoint": "/apps/:app_id/entity/:entity_id/workflow",
-    "endpointParams": [
-      "app_id",
-      "entity_id"
-    ],
-    "controller": "Entity.WorkflowGet",
-    "requestType": null,
-    "scalarParams": [
-      {
-        "name": "workingId",
-        "type": "string",
-        "hasDefault": true
-      }
-    ],
-    "responseType": "EntityWorkflowGetRespVO"
-  },
-  {
-    "scope": "admin",
-    "module": "workflow",
-    "functionName": "createEntityWorkflowVersion",
-    "commandPath": [
-      "workflow",
-      "create-entity-workflow-version"
-    ],
-    "method": "POST",
-    "endpoint": "/apps/:app_id/entity/:entity_id/workflow/new",
-    "endpointParams": [
-      "app_id",
-      "entity_id"
-    ],
-    "controller": "Entity.WorkflowNewVersion",
-    "requestType": null,
-    "scalarParams": [],
-    "responseType": "EntityWorkflowNewVersionRespVO"
-  },
-  {
-    "scope": "admin",
-    "module": "workflow",
-    "functionName": "updateEntityWorkflow",
-    "commandPath": [
-      "workflow",
-      "update-entity-workflow"
-    ],
-    "method": "POST",
-    "endpoint": "/apps/:app_id/entity/:entity_id/workflow",
-    "endpointParams": [
-      "app_id",
-      "entity_id"
-    ],
-    "controller": "Entity.WorkflowUpdate",
-    "requestType": "EntityWorkflowUpdateReqVO",
-    "scalarParams": [],
-    "responseType": "EntityWorkflowUpdateRespVO"
   }
 ] as const
 
@@ -4307,10 +4241,10 @@ export const userCommands = [
   },
   {
     "scope": "user",
-    "module": "workflow",
+    "module": "rows",
     "functionName": "putEntityQueryKeeper",
     "commandPath": [
-      "workflow",
+      "rows",
       "put-entity-query-keeper"
     ],
     "method": "POST",
@@ -4326,10 +4260,10 @@ export const userCommands = [
   },
   {
     "scope": "user",
-    "module": "workflow",
+    "module": "rows",
     "functionName": "queryEntity",
     "commandPath": [
-      "workflow",
+      "rows",
       "query-entity"
     ],
     "method": "POST",
@@ -4345,10 +4279,10 @@ export const userCommands = [
   },
   {
     "scope": "user",
-    "module": "workflow",
+    "module": "rows",
     "functionName": "filterEntityQuery",
     "commandPath": [
-      "workflow",
+      "rows",
       "filter-entity-query"
     ],
     "method": "POST",
@@ -4364,10 +4298,10 @@ export const userCommands = [
   },
   {
     "scope": "user",
-    "module": "workflow",
+    "module": "rows",
     "functionName": "queryEntitySelection",
     "commandPath": [
-      "workflow",
+      "rows",
       "query-entity-selection"
     ],
     "method": "POST",
@@ -4384,29 +4318,10 @@ export const userCommands = [
   },
   {
     "scope": "user",
-    "module": "workflow",
-    "functionName": "resolveEntityWorkflow",
-    "commandPath": [
-      "workflow",
-      "resolve-entity-workflow"
-    ],
-    "method": "POST",
-    "endpoint": "/entity/:app_id/:entity_id/resolve-workflow",
-    "endpointParams": [
-      "app_id",
-      "entity_id"
-    ],
-    "controller": "UserAction.EntityResolveWorkflow",
-    "requestType": "EntityResolveWorkflowReqVO",
-    "scalarParams": [],
-    "responseType": "EntityResolveWorkflowRespVO"
-  },
-  {
-    "scope": "user",
-    "module": "workflow",
+    "module": "rows",
     "functionName": "getEntityRow",
     "commandPath": [
-      "workflow",
+      "rows",
       "get-entity-row"
     ],
     "method": "GET",
@@ -4429,10 +4344,10 @@ export const userCommands = [
   },
   {
     "scope": "user",
-    "module": "workflow",
+    "module": "rows",
     "functionName": "deleteEntityRow",
     "commandPath": [
-      "workflow",
+      "rows",
       "delete-entity-row"
     ],
     "method": "POST",
@@ -4448,10 +4363,10 @@ export const userCommands = [
   },
   {
     "scope": "user",
-    "module": "workflow",
+    "module": "rows",
     "functionName": "restoreEntityRow",
     "commandPath": [
-      "workflow",
+      "rows",
       "restore-entity-row"
     ],
     "method": "POST",
@@ -4467,10 +4382,10 @@ export const userCommands = [
   },
   {
     "scope": "user",
-    "module": "workflow",
+    "module": "rows",
     "functionName": "updateEntityRow",
     "commandPath": [
-      "workflow",
+      "rows",
       "update-entity-row"
     ],
     "method": "PUT",
@@ -4487,10 +4402,10 @@ export const userCommands = [
   },
   {
     "scope": "user",
-    "module": "workflow",
+    "module": "rows",
     "functionName": "validateEntityUniq",
     "commandPath": [
-      "workflow",
+      "rows",
       "validate-entity-uniq"
     ],
     "method": "POST",
@@ -4506,10 +4421,10 @@ export const userCommands = [
   },
   {
     "scope": "user",
-    "module": "workflow",
+    "module": "rows",
     "functionName": "insertEntity",
     "commandPath": [
-      "workflow",
+      "rows",
       "insert-entity"
     ],
     "method": "POST",
@@ -4525,10 +4440,10 @@ export const userCommands = [
   },
   {
     "scope": "user",
-    "module": "workflow",
+    "module": "rows",
     "functionName": "prepareEntityInsert",
     "commandPath": [
-      "workflow",
+      "rows",
       "prepare-entity-insert"
     ],
     "method": "POST",
@@ -4544,48 +4459,10 @@ export const userCommands = [
   },
   {
     "scope": "user",
-    "module": "workflow",
-    "functionName": "queryEntityWorkflowApproveUsers",
-    "commandPath": [
-      "workflow",
-      "query-entity-workflow-approve-users"
-    ],
-    "method": "POST",
-    "endpoint": "/entity/:app_id/:entity_id/query-approve-users",
-    "endpointParams": [
-      "app_id",
-      "entity_id"
-    ],
-    "controller": "UserAction.EntityWorkflowApproveUsers",
-    "requestType": null,
-    "scalarParams": [],
-    "responseType": "EntityWorkflowApproveUsersRespVO"
-  },
-  {
-    "scope": "user",
-    "module": "workflow",
-    "functionName": "queryEntityWorkflowNodes",
-    "commandPath": [
-      "workflow",
-      "query-entity-workflow-nodes"
-    ],
-    "method": "POST",
-    "endpoint": "/entity/:app_id/:entity_id/query-workflow-nodes",
-    "endpointParams": [
-      "app_id",
-      "entity_id"
-    ],
-    "controller": "UserAction.EntityWorkflowNodes",
-    "requestType": null,
-    "scalarParams": [],
-    "responseType": "EntityWorkflowNodesRespVO"
-  },
-  {
-    "scope": "user",
-    "module": "workflow",
+    "module": "rows",
     "functionName": "getEntitySubformItems",
     "commandPath": [
-      "workflow",
+      "rows",
       "get-entity-subform-items"
     ],
     "method": "POST",

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

@@ -282,10 +282,6 @@ export const typeIndex = {
     "file": "/opt/arcubase-sdk/types/user-action.ts",
     "dependencies": []
   },
-  "EntityResolveWorkflowReqVO": {
-    "file": "/opt/arcubase-sdk/types/user-action.ts",
-    "dependencies": []
-  },
   "EntitySaveCustomKeysReqVO": {
     "file": "/opt/arcubase-sdk/types/entity.ts",
     "dependencies": [
@@ -344,14 +340,6 @@ export const typeIndex = {
     "file": "/opt/arcubase-sdk/types/common.ts",
     "dependencies": []
   },
-  "EntityWorkflowDeployReqVO": {
-    "file": "/opt/arcubase-sdk/types/workflow.ts",
-    "dependencies": []
-  },
-  "EntityWorkflowUpdateReqVO": {
-    "file": "/opt/arcubase-sdk/types/workflow.ts",
-    "dependencies": []
-  },
   "FetchWidgetsDataReqVO": {
     "file": "/opt/arcubase-sdk/types/user-action.ts",
     "dependencies": []

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

@@ -268,8 +268,6 @@ export const EntityQueryOrderVOSchema: z.ZodTypeAny = z.lazy(() => z.object({ "c
 
 export const EntityQueryReqVOSchema: z.ZodTypeAny = z.lazy(() => z.object({ "limit": z.number().optional(), "offset": z.number().optional(), "policy_id": z.string().optional(), "search": z.record(z.string(), z.any()).optional(), "sorts": z.array(EntityQueryOrderVOSchema).optional(), "view_mode": z.string().optional(), "withSubForm": z.boolean().optional() }).strict())
 
-export const EntityResolveWorkflowReqVOSchema: z.ZodTypeAny = z.lazy(() => z.object({ "approve_users": z.array(z.number()).optional(), "closeCurrentTasks": z.boolean().optional(), "node_id": z.number().optional(), "policy_id": z.string().optional(), "record_id": z.number().optional(), "version_id": z.number().optional() }).strict())
-
 export const EntitySaveCustomKeysFieldVOSchema: z.ZodTypeAny = z.lazy(() => z.object({ "id": z.number().optional(), "key": z.string().optional() }).strict())
 
 export const EntitySaveCustomKeysReqVOSchema: z.ZodTypeAny = z.lazy(() => z.array(EntitySaveCustomKeysFieldVOSchema))
@@ -314,34 +312,6 @@ export const EntityValidateUniqFieldVOSchema: z.ZodTypeAny = z.lazy(() => z.obje
 
 export const EntityValidateUniqReqVOSchema: z.ZodTypeAny = z.lazy(() => z.object({ "fields": z.array(EntityValidateUniqFieldVOSchema).optional(), "record_id": z.number().optional() }).strict())
 
-export const ActionBulkUpdateActionSchema: 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 ActionBulkUpdateSchema: z.ZodTypeAny = z.lazy(() => z.object({ "action": ActionBulkUpdateActionSchema.optional(), "id": z.number().optional() }).strict())
-
-export const WorkflowActionConfigSchema: z.ZodTypeAny = z.lazy(() => z.object({ "enabled": z.boolean().optional(), "options": z.object({ "comment_required": z.boolean().optional(), "desc": z.string().optional(), "modifiers": z.array(ActionBulkUpdateSchema).optional() }).strict().optional() }).strict())
-
-export const WorkflowVoteTypeSchema: z.ZodTypeAny = z.lazy(() => z.union([z.literal(0), z.literal(1)]))
-
-export const NotificationWebhookConfigSchema: z.ZodTypeAny = z.lazy(() => z.object({ "mode": NotificationPayloadModeSchema.optional(), "template": z.string().optional(), "url": z.string().optional(), "version": z.string().optional() }).strict())
-
-export const WorkflowConfigNodeSchema: z.ZodTypeAny = z.lazy(() => z.object({ "data": z.object({ "actions": z.record(z.string(), WorkflowActionConfigSchema).optional(), "approver_actions": z.array(z.number()).optional(), "approvers": z.array(PermitUserScopeSchema).optional(), "auto_forward": z.boolean().optional(), "cc": z.array(PermitUserScopeSchema).optional(), "fields": z.array(z.number()).optional(), "notify_email": z.boolean().optional(), "notify_email_tmpl": z.object({ "body": z.string().optional(), "subject": z.string().optional() }).strict().optional(), "submit_condition": z.array(z.number()).optional(), "use_cc": z.boolean().optional(), "vote_type": WorkflowVoteTypeSchema.optional(), "webhooks": z.array(NotificationWebhookConfigSchema).optional() }).strict().optional(), "events": z.array(z.number()).optional(), "id": z.string().optional(), "label": z.string().optional(), "mode": z.string().optional(), "position": z.array(z.number()).optional(), "type": z.string().optional() }).strict())
-
-export const WorkflowConfigDiagramSchema: z.ZodTypeAny = z.lazy(() => z.object({ "edges": z.array(z.number()).optional(), "id_seq": z.number().optional(), "nodes": z.array(WorkflowConfigNodeSchema).optional(), "viewport": z.array(z.number()).optional() }).strict())
-
-export const WorkflowAutoApproveRuleSchema: z.ZodTypeAny = z.lazy(() => z.union([z.literal(1), z.literal(2), z.literal(3)]))
-
-export const WorkflowRetractRuleSchema: z.ZodTypeAny = z.lazy(() => z.union([z.literal(1), z.literal(2), z.literal(3)]))
-
-export const WorkflowSLATriggerSchema: z.ZodTypeAny = z.lazy(() => z.object({ "hasUpdateField": z.boolean().optional(), "hasWebhook": z.boolean().optional(), "modifiers": z.array(ActionBulkUpdateSchema).optional(), "time_point": z.number().optional(), "webhook": NotificationWebhookConfigSchema.optional() }).strict())
-
-export const WorkflowSLAConfigSchema: z.ZodTypeAny = z.lazy(() => z.object({ "ddl": z.number().optional(), "enabled": z.boolean().optional(), "id": z.string().optional(), "name": z.string().optional(), "nodes": z.array(z.string()).optional(), "triggers": z.array(WorkflowSLATriggerSchema).optional() }).strict())
-
-export const WorkflowOptionsSchema: z.ZodTypeAny = z.lazy(() => z.object({ "allow_urge": z.boolean().optional(), "allow_view_diagram": z.boolean().optional(), "auto_approve_rule": WorkflowAutoApproveRuleSchema.optional(), "retract_rule": WorkflowRetractRuleSchema.optional(), "sla": z.array(WorkflowSLAConfigSchema).optional() }).strict())
-
-export const EntityWorkflowDeployReqVOSchema: z.ZodTypeAny = z.lazy(() => z.object({ "diagram": WorkflowConfigDiagramSchema.optional(), "id": z.number().optional(), "options": WorkflowOptionsSchema.optional() }).strict())
-
-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())
@@ -518,7 +488,6 @@ export const generatedRequestTypes = [
   "EntityQueryLinkToValuesReqVO",
   "EntityQueryRelationReqVO",
   "EntityQueryReqVO",
-  "EntityResolveWorkflowReqVO",
   "EntitySaveCustomKeysReqVO",
   "EntitySaveNameReqVO",
   "EntitySaveReqVO",
@@ -531,8 +500,6 @@ export const generatedRequestTypes = [
   "EntityUpdateReqVO",
   "EntityUpdateSuccessScreenReqVO",
   "EntityValidateUniqReqVO",
-  "EntityWorkflowDeployReqVO",
-  "EntityWorkflowUpdateReqVO",
   "FetchWidgetsDataReqVO",
   "GetOrganizationTreeReqVO",
   "GetOrganizationUsersReqVO",
@@ -648,7 +615,6 @@ export const bodySchemas = {
   "EntityQueryLinkToValuesReqVO": EntityQueryLinkToValuesReqVOSchema,
   "EntityQueryRelationReqVO": EntityQueryRelationReqVOSchema,
   "EntityQueryReqVO": EntityQueryReqVOSchema,
-  "EntityResolveWorkflowReqVO": EntityResolveWorkflowReqVOSchema,
   "EntitySaveCustomKeysReqVO": EntitySaveCustomKeysReqVOSchema,
   "EntitySaveNameReqVO": EntitySaveNameReqVOSchema,
   "EntitySaveReqVO": EntitySaveReqVOSchema,
@@ -661,8 +627,6 @@ export const bodySchemas = {
   "EntityUpdateReqVO": EntityUpdateReqVOSchema,
   "EntityUpdateSuccessScreenReqVO": EntityUpdateSuccessScreenReqVOSchema,
   "EntityValidateUniqReqVO": EntityValidateUniqReqVOSchema,
-  "EntityWorkflowDeployReqVO": EntityWorkflowDeployReqVOSchema,
-  "EntityWorkflowUpdateReqVO": EntityWorkflowUpdateReqVOSchema,
   "FetchWidgetsDataReqVO": FetchWidgetsDataReqVOSchema,
   "GetOrganizationTreeReqVO": GetOrganizationTreeReqVOSchema,
   "GetOrganizationUsersReqVO": GetOrganizationUsersReqVOSchema,

package/sdk-dist/types/app.ts

@@ -86,6 +86,11 @@ export interface AppGetEntitiesEntityVO {
   total_number?: number;
 }
 
+export interface AppListItemVO {
+  id?: number;
+  name?: string;
+}
+
 export interface AppGetEntitySharesRespVO {
   shares?: AppEntityShareItemVO[];
 }
@@ -177,6 +182,8 @@ export interface IngressGroupReqVO {
 
 export type AppGetEntitiesRespVO = AppGetEntitiesEntityVO[];
 
+export type AppListRespVO = AppListItemVO[];
+
 export type AppUpdateI18nReqVO = AppUpdateI18NReqVO;
 
 export type AppUpdateI18nRespVO = AppUpdateI18NRespVO;