@carthooks/arcubase-cli 0.1.2 → 0.1.4

package/sdk-dist/docs/runtime-reference/entity-schema/relationfield.md

@@ -0,0 +1,38 @@
+# relationfield
+
+## Purpose
+
+Derived field that reads a target value through an existing relation field.
+
+## Minimal shape
+
+```json
+{
+  "type": "relationfield",
+  "options": {
+    "relation": {
+      "app_id": 1,
+      "entity_id": 2,
+      "type": "entity"
+    }
+  }
+}
+```
+
+## Available options
+
+- `relation.app_id`
+- `relation.entity_id`
+- `relation.type`
+- `relation.show_fields`
+- `relation.queryFields`
+- `relation.condition`
+- `relation.sorts`
+- `relation.subform_id`
+
+## Constraints
+
+- `options.relation` is required
+- `relation.app_id` and `relation.entity_id` are required
+- use `relation.type = "entity"` in the current direct-write path
+- do not send empty `options`

package/sdk-dist/docs/runtime-reference/entity-schema/rollup.md

@@ -0,0 +1,54 @@
+# rollup
+
+## Purpose
+
+Aggregation field built on top of a `linkto` field.
+
+## Frontend capability flags
+
+- `group: advanced`
+- `readonly: true`
+- `notImportAble: true`
+
+## Minimal shape
+
+```json
+{
+  "type": "rollup",
+  "options": {
+    "relation": {
+      "local_linkto_field_id": 1012,
+      "target_field_id": 2004,
+      "target_field_type": "number"
+    },
+    "aggregation_formula": {
+      "code": "COUNT([[Value]])",
+      "jsonlogic": {
+        "COUNT": [
+          { "value": "Value" }
+        ]
+      }
+    }
+  }
+}
+```
+
+## Common options
+
+- `relation.local_linkto_field_id`
+- `relation.target_field_id`
+- `relation.target_field_type`
+- `aggregation_formula.code`
+- `aggregation_formula.jsonlogic`
+
+## Constraints
+
+- `local_linkto_field_id` must point to a real `linkto`
+- `target_field_id` is required
+- `target_field_type` should be explicit
+- `aggregation_formula` must exist
+- keep `aggregation_formula.code` and `aggregation_formula.jsonlogic` aligned
+- common aggregation formulas include `COUNT([[Value]])`, `sum([[Value]])`, `AVG([[Value]])`, `MAX([[Value]])`, and `MIN([[Value]])`
+- in the current direct-write path, keep only these top-level `options` keys:
+  - `relation`
+  - `aggregation_formula`

package/sdk-dist/docs/runtime-reference/entity-schema/select.md

@@ -0,0 +1,63 @@
+# select
+
+## Purpose
+
+Single-select dropdown field.
+
+## Frontend capability flags
+
+- `group: normal`
+- `operator: text`
+- `switchgroup: text`
+- `useFormula: true`
+- `useRelation: true`
+- `inlineEdtiable: true`
+- `events: ['change']`
+
+## Minimal shape
+
+```json
+{
+  "type": "select",
+  "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": "Option 1" }
+      ]
+    }
+  }
+}
+```
+
+## Common options
+
+- `horizontal`
+- `placeholder`
+- `numberMax`
+- `numberMin`
+- `numberRange`
+- `repeatRemind`
+- `hideInList`
+- `width`
+- `options.items`
+- `options.mode`
+- `options.colorful`
+- `options.relation`
+- `options.relation_filter`
+- `options.international`
+- `options.has_other`
+- `options.other_label`
+
+## Constraints
+
+- `options.items` at least one item
+- `options.mode` common values are `custom` or `relation`
+- when `options.has_other = true`, also provide `options.other_label`
+- keep `options.options.items[*].key` stable once the field is live

package/sdk-dist/docs/runtime-reference/entity-schema/selects.md

@@ -0,0 +1,51 @@
+# selects
+
+## Purpose
+
+Multi-select dropdown field.
+
+## Frontend capability flags
+
+- `group: normal`
+- `useFormula: true`
+- `useRelation: true`
+- `inlineEdtiable: true`
+- `events: ['change']`
+
+## Minimal shape
+
+```json
+{
+  "type": "selects",
+  "options": {
+    "placeholder": "",
+    "lengthLimit": false,
+    "lengthMin": 0,
+    "lengthMax": 10,
+    "options": {
+      "mode": "custom",
+      "colorful": false,
+      "items": [
+        { "key": 1, "value": "Option 1" }
+      ]
+    }
+  }
+}
+```
+
+## Common options
+
+- `placeholder`
+- `lengthLimit`
+- `lengthMin`
+- `lengthMax`
+- `options.items`
+- `options.mode`
+- `options.colorful`
+- `options.relation`
+- `options.relation_filter`
+- `options.international`
+
+## Constraints
+
+- `options.items` at least one item

package/sdk-dist/docs/runtime-reference/entity-schema/serialnumber.md

@@ -0,0 +1,48 @@
+# serialnumber
+
+## Purpose
+
+Serial number field.
+
+## Frontend capability flags
+
+- `group: advanced`
+- `operator: text`
+- `switchgroup: text`
+- `inlineEdtiable: true`
+- `oncopy` clears the copied value
+
+## Minimal shape
+
+```json
+{
+  "type": "serialnumber",
+  "options": {
+    "parts": [
+      {
+        "mode": "buildin",
+        "type": "serial",
+        "options": {
+          "length": 6,
+          "lenfixed": true,
+          "random": false,
+          "reset": "no"
+        }
+      }
+    ]
+  }
+}
+```
+
+## Common parts
+
+- `buildin/string`
+- `buildin/date`
+- `buildin/serial`
+- `field`
+
+## Constraints
+
+- `parts` at least one item
+- `buildin/date` requires `format` or `perdefinedFormat`
+- `buildin/serial` requires `length`

package/sdk-dist/docs/runtime-reference/entity-schema/signature.md

@@ -0,0 +1,31 @@
+# signature
+
+## Purpose
+
+Signature field.
+
+## Frontend capability flags
+
+- `notImportAble: true`
+- `notExportAble: true`
+- `events: ['change']`
+
+## Minimal shape
+
+```json
+{
+  "type": "signature",
+  "options": {
+    "placeholder": ""
+  }
+}
+```
+
+## Common options
+
+- `placeholder`
+
+## Constraints
+
+- `required` is controlled by generic field flags
+- In the current direct-write pathyou may keep only an empty `placeholder`

package/sdk-dist/docs/runtime-reference/entity-schema/status.md

@@ -0,0 +1,70 @@
+# status
+
+## Purpose
+
+Status field.
+
+## Frontend capability flags
+
+- `group: normal`
+- `operator: enum`
+- `switchgroup: enum`
+- `useFormula: true`
+- `useRelation: true`
+- `inlineEdtiable: true`
+- `events: ['change']`
+
+## Minimal shape
+
+```json
+{
+  "type": "status",
+  "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, "code": 1, "value": "Pending" }
+      ]
+    }
+  }
+}
+```
+
+## Common options
+
+- `horizontal`
+- `numberMax`
+- `numberMin`
+- `numberRange`
+- `repeatRemind`
+- `hideInList`
+- `options.items`
+- `options.mode`
+- `options.colorful`
+
+## Constraints
+
+- each item must contain at least `code` and `value`
+- keep `code` stable once the field is live
+- row values should use the status `code`
+
+## Save-ready reminder
+
+For `arcubase-admin entity admin-save-entity`, keep the full base `FieldVO`.
+
+The field-specific part only covers `options`. The saved field still needs:
+
+- `id`
+- `label`
+- `required`
+- `editable`
+- `visible`
+- `number_decimal`
+- `key`
+- `children: null`

package/sdk-dist/docs/runtime-reference/entity-schema/subform.md

@@ -0,0 +1,74 @@
+# subform
+
+## Purpose
+
+Subform field.
+
+
+
+## Frontend capability flags
+
+- `group: advanced`
+- `useFormula: true`
+- `useRelation: true`
+
+## Minimal shape
+
+```json
+{
+  "type": "subform",
+  "options": {},
+  "children": []
+}
+```
+
+## Available options
+
+- `lengthLimit`
+- `lengthMin`
+- `lengthMax`
+- `new_record_btn`
+- `hideInList`
+
+## Constraints
+
+- `children: FieldVO[]`
+- Child ids also consume the global field-id space
+- Do not write `layout` separately in the current saved payload
+- The display order of child fields is the order of `children[]`
+- when `new_record_btn` is not configured, prefer `0`
+- when `lengthLimit=true`, it is recommended to provide both `lengthMin` and `lengthMax`
+
+## Row payload
+
+For row commands such as:
+
+- `arcubase workflow insert-entity`
+- `arcubase workflow update-entity-row`
+
+the current writable row shape is:
+
+```json
+[
+  {
+    "id": 0,
+    "fields": {
+      "1007": "SKU-001",
+      "1008": 2
+    }
+  }
+]
+```
+
+Use `id: 0` for a new child row.
+
+Do not use this incorrect shape:
+
+```json
+[
+  {
+    "1007": "SKU-001",
+    "1008": 2
+  }
+]
+```

package/sdk-dist/docs/runtime-reference/entity-schema/tags.md

@@ -0,0 +1,19 @@
+# tags
+
+## Purpose
+
+System tags field.
+
+## Frontend capability flags
+
+- `operator: $in`
+- `useFormula: false`
+- `useRelation: false`
+- `notImportAble: true`
+- `notExportAble: true`
+- `readonly: true`
+
+## Usage rules
+
+- Do not manually add `tags` when creating a normal business schema
+- This is a system-managed field and is not part of normal manual schema modeling

package/sdk-dist/docs/runtime-reference/entity-schema/text.md

@@ -0,0 +1,76 @@
+# text
+
+## Purpose
+
+Single-line text field.
+
+
+
+## Frontend capability flags
+
+- `group: normal`
+- `uniqueAble: true`
+- `useFormula: true`
+- `useRelation: true`
+- `switchgroup: text`
+- `inlineEdtiable: true`
+- `events: ['change']`
+
+## Minimal shape
+
+```json
+{
+  "type": "text",
+  "options": {
+    "placeholder": "",
+    "type": "text",
+    "lengthLimit": false,
+    "lengthMin": 0,
+    "lengthMax": 255
+  }
+}
+```
+
+## Available options
+
+- `placeholder`
+- `type`
+- `lengthLimit`
+- `lengthMin`
+- `lengthMax`
+- `link`
+
+## Constraints
+
+- it can participate in formula and relation conditions
+- it may be marked `unique`
+- when `lengthLimit=true`, it is recommended to provide both `lengthMin` and `lengthMax`
+- in the current direct-write path, prefer the default `"text"` type
+
+## Save-ready reminder
+
+For `arcubase-admin entity admin-save-entity`, do not send only `type + options`.
+
+Wrap this field-specific shape in the full base `FieldVO` described in `entity-schema.md`, including:
+
+- `id`
+- `label`
+- `required`
+- `unique`
+- `editable`
+- `visible`
+- `show_label`
+- `scannable`
+- `default_value_mode`
+- `description`
+- `value`
+- `number_decimal`
+- `depends`
+- `key`
+- `code_index`
+- `transfers`
+- `children`
+
+## Common mistakes
+
+- `lengthLimit=true` but `lengthMax` is missing

package/sdk-dist/docs/runtime-reference/entity-schema/textarea.md

@@ -0,0 +1,47 @@
+# textarea
+
+## Purpose
+
+Multi-line text field.
+
+
+
+## Frontend capability flags
+
+- `group: normal`
+- `useFormula: true`
+- `useRelation: true`
+- `hideInList: true`
+- `inlineEdtiable: false`
+- `events: ['change']`
+
+## Minimal shape
+
+```json
+{
+  "type": "textarea",
+  "options": {
+    "placeholder": "",
+    "html": false,
+    "size": "default",
+    "lengthLimit": false,
+    "lengthMin": 0,
+    "lengthMax": 2000
+  }
+}
+```
+
+## Available options
+
+- `placeholder`
+- `html`
+- `size`
+- `lengthLimit`
+- `lengthMin`
+- `lengthMax`
+
+## Constraints
+
+- `placeholder` matters only when `html=false`
+- when `lengthLimit=true`, it is recommended to provide both `lengthMin` and `lengthMax`
+- keep `size` within the values returned by the current editor; do not invent extra enum values

package/sdk-dist/docs/runtime-reference/entity-schema/workflow_status.md

@@ -0,0 +1,17 @@
+# workflow_status
+
+## Purpose
+
+Workflow system status field.
+
+## Frontend capability flags
+
+- `useFormula: false`
+- `useRelation: false`
+- `notImportAble: true`
+- `notExportAble: true`
+
+## Usage rules
+
+- Do not manually add `workflow_status` when creating a normal business schema
+- This is a system-managed field and is not part of normal manual schema modeling