@carthooks/arcubase-cli 0.1.10 → 0.1.12

package/sdk-dist/docs/runtime-reference/table-lifecycle.md

@@ -10,18 +10,17 @@ Use this page when the goal is:
 The successful path is command-first:
 
 1. create the app
-2. create the entity shell
-3. fetch the current shell
-4. save the full schema
-5. probe rows with `query-entity`
+2. create the table with non-empty fields
+3. verify the saved table schema
+4. probe rows with `row query`
 
-Do not stop at shell creation.
+Do not create an empty table shell. `table create` requires `fields` and `field_id_seq`.
 
 CLI phase split:
 
 - schema phase uses `arcubase-admin`
 - row phase uses `arcubase`
-- the switch happens immediately after `admin-save-entity`
+- the switch happens immediately after `table update-schema`
 - do not use `arcubase-admin` for row insert or row query
 
 ## Step 1: create the app
@@ -29,7 +28,7 @@ CLI phase split:
 Command:
 
 ```bash
-arcubase-admin app create-app-by-tenants --body-file create-app.json
+arcubase-admin app create --body-file create-app.json | --body-json <json-string>
 ```
 
 Minimal `create-app.json`:
@@ -45,57 +44,141 @@ Rules:
 - `name` is required
 - keep `name` at `20` characters or fewer
 
-## Step 2: create the entity shell
+## Step 2: create the table with schema
 
 Command:
 
 ```bash
-arcubase-admin app create-entity \
-  --id <app_id> \
-  --body-file create-entity.json
+arcubase-admin table create \
+  --app-id <app_id> \
+  --body-json <json-string> | --body-file table-create.json
 ```
 
-Minimal `create-entity.json`:
+Minimal `table-create.json`:
 
 ```json
 {
-  "name": "simple"
+  "name": "Orders",
+  "parent": 0,
+  "schema_version": 0,
+  "field_id_seq": 1004,
+  "layout": [[1001], [1002], [1003]],
+  "fields": [
+    {
+      "id": 1001,
+      "label": "Order No",
+      "type": "text",
+      "required": true,
+      "unique": false,
+      "editable": true,
+      "visible": true,
+      "show_label": true,
+      "scannable": false,
+      "default_value_mode": 0,
+      "description": "",
+      "value": null,
+      "number_decimal": 0,
+      "depends": [],
+      "key": "order_no",
+      "code_index": false,
+      "options": {"type": "text", "placeholder": "", "lengthLimit": false, "lengthMin": 0, "lengthMax": 255},
+      "transfers": null,
+      "children": null
+    },
+    {
+      "id": 1002,
+      "label": "Description",
+      "type": "textarea",
+      "required": false,
+      "unique": false,
+      "editable": true,
+      "visible": true,
+      "show_label": true,
+      "scannable": false,
+      "default_value_mode": 0,
+      "description": "",
+      "value": null,
+      "number_decimal": 0,
+      "depends": [],
+      "key": "description",
+      "code_index": false,
+      "options": {"placeholder": "", "html": false, "size": "default", "lengthLimit": false, "lengthMin": 0, "lengthMax": 2000},
+      "transfers": null,
+      "children": null
+    },
+    {
+      "id": 1003,
+      "label": "Status",
+      "type": "select",
+      "required": true,
+      "unique": false,
+      "editable": true,
+      "visible": true,
+      "show_label": true,
+      "scannable": false,
+      "default_value_mode": 1,
+      "description": "",
+      "value": "draft",
+      "number_decimal": 0,
+      "depends": [],
+      "key": "status",
+      "code_index": false,
+      "options": {
+        "horizontal": false,
+        "numberMax": "",
+        "numberMin": "",
+        "numberRange": false,
+        "repeatRemind": "This value already exists and duplicate submission is not allowed",
+        "options": {
+          "mode": "custom",
+          "colorful": false,
+          "items": [
+            {"key": 1, "value": "draft"},
+            {"key": 2, "value": "active"}
+          ]
+        }
+      },
+      "transfers": null,
+      "children": null
+    }
+  ],
+  "options": {"Buttons": [], "CustomActions": [], "FrontendEvents": [], "TitleFormat": {"Fields": [], "Parts": [], "Body": ""}, "misc": {}},
+  "workflow_enabled": false
 }
 ```
 
 Rules:
 
-- this only creates the shell
-- this does not mean row CRUD is ready
+- `fields` must be non-empty
+- `field_id_seq` must be greater than every `field.id`
+- use `text`, not `string`
+- use `member`, not `user`
+- for `select`, use `options.options.items`
 
-## Step 3: fetch the current shell
+## Step 3: verify the saved schema
 
 Command:
 
 ```bash
-arcubase-admin entity admin-get-entity-info \
+arcubase-admin table get \
   --app-id <app_id> \
   --table-id <table_id>
 ```
 
-Use the returned shell as the base for `save-entity.json`.
-
 Rules:
 
-- do not invent `schema_version`
-- do not invent top-level `options`
-- keep `id`, `app_id`, `name`, and `workflow_enabled` from the shell
-- normalize shell placeholder `null` values before save
+- success requires non-empty `fields`
+- do not call the table ready until row probe succeeds
 
-## Step 4: save the full schema
+## Update existing schema
 
 Command:
 
 ```bash
-arcubase-admin entity admin-save-entity \
+arcubase-admin table update-schema \
   --app-id <app_id> \
   --table-id <table_id> \
-  --body-file save-entity.json
+  --body-json <json-string> | --body-file save-entity.json
 ```
 
 Read before writing `save-entity.json`:
@@ -104,12 +187,12 @@ Read before writing `save-entity.json`:
 2. `entity-schema/README.md`
 3. the exact field-type pages you need
 
-After `admin-save-entity`, switch binaries:
+After schema save, switch binaries:
 
 - use `arcubase row create` for row insertion
 - use `arcubase row query` for readiness and row reads
 
-## Step 5: probe readiness
+## Step 4: probe readiness
 
 Command:
 
@@ -117,7 +200,7 @@ Command:
 arcubase row query \
   --app-id <app_id> \
   --table-id <table_id> \
-  --body-file query.json
+  --body-json <json-string> | --body-file query.json
 ```
 
 Minimal `query.json`:
@@ -132,4 +215,4 @@ Minimal `query.json`:
 Rules:
 
 - only call the table ready after this command succeeds
-- if shell creation succeeded but `query-entity` still fails, the table is not ready
+- if shell creation succeeded but `row query` still fails, the table is not ready

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

@@ -4,71 +4,61 @@ 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 row create` or `arcubase row update`
+1. run `arcubase upload token`
+2. upload the file through the returned token data
+3. use `arcubase upload preview`, `arcubase upload mobile`, or `arcubase upload check-mobile` only when the task requires that exact API
+4. insert or update the row with `arcubase row create` or `arcubase row update`
 
 Do not construct `upload_id`, `assets_id`, or OSS form fields by hand.
 
-## Upload one local file
+## Upload Token
 
 Command:
 
 ```bash
-arcubase upload ./contract.pdf
+arcubase upload token --body-json '{"global":false}'
 ```
 
-Optional flags:
+Body type: `GetUploadTokenReqVO`.
 
-- `--filename <name>`
-- `--global`
+Supported body fields:
 
-Example:
+- `global`
+
+## Preview
 
 ```bash
-arcubase upload ./lead-photo.jpg --filename lead-photo.jpg
+arcubase upload preview --body-file preview.json | --body-json <json-string>
 ```
 
-## Upload result shape
-
-The command returns a JSON array.
-
-Example:
+Example `preview.json`:
 
 ```json
 {
-  "data": [
-    {
-      "upload_id": 123456,
-      "file": "contract.pdf",
-      "file_name": "contract.pdf",
-      "meta": {}
-    }
-  ]
+  "upload_id": 123456,
+  "fname": "contract.pdf"
 }
 ```
 
-Use the `data` array directly as the field value for a `file` or `image` field.
+## Mobile Upload
 
-## Insert a row with a file field
+```bash
+arcubase upload mobile --body-file mobile-upload.json | --body-json <json-string>
+```
 
-```json
-{
-  "fields": {
-    "1001": "Lead A",
-    "1007": [
-      {
-        "upload_id": 123456,
-        "file": "contract.pdf",
-        "file_name": "contract.pdf",
-        "meta": {}
-      }
-    ]
-  }
-}
+Body type: `MobileUploadReqVO`.
+
+## Check Mobile Upload
+
+```bash
+arcubase upload check-mobile --body-file mobile-upload-check.json | --body-json <json-string>
 ```
 
-## Update a row with an image field
+Body type: `MobileUploadCheckReqVO`.
+
+## Row Field Value
+
+After upload returns a file value array, use the returned array directly as the field value for a `file` or `image` field.
 
 ```json
 {
@@ -85,22 +75,3 @@ Use the `data` array directly as the field value for a `file` or `image` field.
   "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/docs/runtime-reference/workflow/README.md

@@ -1,19 +1,135 @@
 # Workflow Runtime Reference
 
-This directory is reserved for future workflow runtime docs.
+Use this page for workflow runtime actions with `arcubase`.
 
-It will follow the same single-path distribution model as entity schema docs:
+## Process Map
 
-- Development source of truth:
-  - `misc/packages/@carthooks/arcubase-cli/docs/runtime-reference/workflow/`
-- Runtime location:
-  - `/opt/arcubase-sdk/docs/runtime-reference/workflow/`
-- Distribution path:
-  - `sdk-dist/docs/runtime-reference/workflow/`
+```bash
+arcubase workflow process-map \
+  --app-id <app_id> \
+  --table-id <table_id> \
+  --row-id <row_id>
+```
 
-Expected coverage later:
+## Approve
 
-- workflow configuration lifecycle
-- real writable structure for nodes, edges, actions, and conditions
-- integration points between workflow and entity schema
-- common failure cases and debugging guidance
+Body type: `EntityDoActionReqVO`.
+
+```bash
+arcubase workflow approve \
+  --app-id <app_id> \
+  --table-id <table_id> \
+  --row-id <row_id> \
+  --body-json '{"task_id":2188890521,"fields":{"1004":"checked"},"changed":[1004],"comment":{"content":"Approved"}}'
+```
+
+Required:
+
+- `task_id`
+- node-required fields in `fields`
+- changed field ids in `changed`
+
+## Rollback
+
+Body type: `EntityDoActionReqVO`.
+
+```bash
+arcubase workflow rollback \
+  --app-id <app_id> \
+  --table-id <table_id> \
+  --row-id <row_id> \
+  --body-json '{"task_id":2188890521,"backstep":2188890602,"comment":{"content":"Need changes"}}'
+```
+
+Required:
+
+- `task_id`
+- `backstep`
+
+## Countersign
+
+Body type: `EntityDoActionReqVO`.
+
+```bash
+arcubase workflow countersign \
+  --app-id <app_id> \
+  --table-id <table_id> \
+  --row-id <row_id> \
+  --body-json '{"task_id":2188890521,"comment":{"content":"Add countersign"}}'
+```
+
+## Forward
+
+Body type: `EntityDoActionReqVO`.
+
+```bash
+arcubase workflow forward \
+  --app-id <app_id> \
+  --table-id <table_id> \
+  --row-id <row_id> \
+  --body-json '{"task_id":2188890521,"user":[{"type":"member","id":2188889902}],"comment":{"content":"Please review"}}'
+```
+
+Required:
+
+- `task_id`
+- `user`
+
+## Retract
+
+Body type: `EntityDoActionReqVO`.
+
+```bash
+arcubase workflow retract \
+  --app-id <app_id> \
+  --table-id <table_id> \
+  --row-id <row_id> \
+  --body-json '{"task_id":2188890521,"comment":{"content":"Retract"}}'
+```
+
+Required:
+
+- `task_id`
+
+## Resolve
+
+Body type: `EntityResolveWorkflowReqVO`.
+
+```bash
+arcubase workflow resolve \
+  --app-id <app_id> \
+  --table-id <table_id> \
+  --body-json '{"version_id":2188890601,"node_id":2188890602,"record_id":2188890411,"approve_users":[2188889901],"closeCurrentTasks":true}'
+```
+
+Required:
+
+- `version_id`
+- `node_id`
+- `record_id`
+- `approve_users`
+
+## Query Approve Users
+
+Body type: `EntityWorkflowApproveUsersReqVO`.
+
+```bash
+arcubase workflow query-approve-users \
+  --app-id <app_id> \
+  --table-id <table_id> \
+  --body-json '{"version_id":2188890601,"node_id":2188890602,"record_id":2188890411}'
+```
+
+Required:
+
+- `version_id`
+- `node_id`
+- `record_id`
+
+## Query Nodes
+
+```bash
+arcubase workflow query-nodes \
+  --app-id <app_id> \
+  --table-id <table_id>
+```