@carthooks/arcubase-cli 0.1.2 → 0.1.4

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

@@ -0,0 +1,33 @@
+# department
+
+## Purpose
+
+Single-department field.
+
+## Frontend capability flags
+
+- `group: normal`
+- `useFormula: true`
+- `useRelation: true`
+- `operator: department`
+- `notImportAble: true`
+- `notExportAble: true`
+- `events: ['change']`
+
+## Minimal shape
+
+```json
+{
+  "type": "department",
+  "options": {}
+}
+```
+
+## Common options
+
+- `placeholder`
+
+## Constraints
+
+- `department` is a single-value field
+- in the current direct-write path, `options` may contain only `placeholder`

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

@@ -0,0 +1,34 @@
+# departments
+
+## Purpose
+
+Multi-department field.
+
+## Frontend capability flags
+
+- `group: normal`
+- `useFormula: true`
+- `useRelation: true`
+- `notImportAble: true`
+- `notExportAble: true`
+- `events: ['change']`
+
+## Minimal shape
+
+```json
+{
+  "type": "departments",
+  "options": {
+    "placeholder": ""
+  }
+}
+```
+
+## Common options
+
+- `placeholder`
+
+## Constraints
+
+- `departments` is a multi-value field
+- in the current direct-write path, `options` may contain only `placeholder`

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

@@ -0,0 +1,39 @@
+# divider
+
+## Purpose
+
+Divider / visual grouping field.
+
+
+
+## Frontend capability flags
+
+- `group: normal`
+- `withoutFieldContainer: true`
+- `custom_permissions: true`
+- `hideInList: true`
+- `readonly: true`
+- `notImportAble: true`
+- `notExportAble: true`
+
+## Minimal shape
+
+```json
+{
+  "type": "divider",
+  "options": {
+    "color": "",
+    "style_id": ""
+  }
+}
+```
+
+## Available options
+
+- `color`
+- `style_id`
+
+## Constraints
+
+- In the current direct-write path, `options.style_id` and `options.color` should both be explicit
+- `divider` is a display-only field and does not carry business values

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

@@ -0,0 +1,53 @@
+# file
+
+## Purpose
+
+File upload field.
+
+## Frontend capability flags
+
+- `group: advanced`
+- `switchgroup: file`
+- `notImportAble: true`
+- `notExportAble: true`
+- `events: ['change']`
+
+## Minimal shape
+
+```json
+{
+  "type": "file",
+  "options": {
+    "placeholder": "",
+    "count_range": false,
+    "count_min": 0,
+    "count_max": 9
+  }
+}
+```
+
+## Common options
+
+- `placeholder`
+- `count_range`
+- `count_min`
+- `count_max`
+- `hideInList`
+
+## Constraints
+
+- when `count_range=true`, it is recommended to provide both `count_min` and `count_max`
+- `required` is controlled by generic field flags, not inside `options`
+- when count limits are disabled in the current direct-write path, use:
+  - `count_range: false`
+  - `count_min: 0`
+  - `count_max: 9`
+
+## Row write rule
+
+When inserting or updating row data for a `file` field:
+
+- do not construct upload payload objects by hand
+- run `arcubase upload <local-file>` first
+- use the returned `data` array directly as the row field value
+- read `../uploads.md`

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

@@ -0,0 +1,44 @@
+# formula
+
+## Purpose
+
+Computed field.
+
+## Frontend capability flags
+
+- `group: advanced`
+- `readonly: true`
+- `notImportAble: true`
+
+## Minimal shape
+
+```json
+{
+  "type": "formula",
+  "options": {
+    "formula": {
+      "code": "[[Field A:1001]]+[[Field B:1002]]",
+      "jsonlogic": {
+        "+": [
+          { "var": "1001" },
+          { "var": "1002" }
+        ]
+      }
+    }
+  }
+}
+```
+
+## Common options
+
+- `formula.code`
+- `formula.jsonlogic`
+
+## Constraints
+
+- `code` and `jsonlogic` must both exist
+- field ids referenced in `code` must exist
+- common referenceable types include `text`, `number`, `datetime`, `select`, `radio`, `checkbox`, and `rollup`
+- if the formula field is inside a subform, it may reference other fields in the same subform
+- in the current editor flow, top-level formulas may reference top-level fields; subform formulas should stay inside the same subform scope
+- in the current direct-write path, keep only `formula` at the top level of `options`

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

@@ -0,0 +1,52 @@
+# image
+
+## Purpose
+
+Image upload field.
+
+## Frontend capability flags
+
+- `group: advanced`
+- `switchgroup: file`
+- `notExportAble: true`
+- `events: ['change']`
+
+## Minimal shape
+
+```json
+{
+  "type": "image",
+  "options": {
+    "count_range": false,
+    "count_min": 0,
+    "count_max": 9,
+    "meta_title": false
+  }
+}
+```
+
+## Common options
+
+- `count_range`
+- `count_min`
+- `count_max`
+- `meta_title`
+- `hideInList`
+
+## Constraints
+
+- when `count_range=true`, it is recommended to provide both `count_min` and `count_max`
+- `required` is controlled by generic field flags, not inside `options`
+- when count limits are disabled in the current direct-write path, use:
+  - `count_range: false`
+  - `count_min: 0`
+  - `count_max: 9`
+
+## Row write rule
+
+When inserting or updating row data for an `image` field:
+
+- do not construct upload payload objects by hand
+- run `arcubase upload <local-file>` first
+- use the returned `data` array directly as the row field value
+- read `../uploads.md`

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

@@ -0,0 +1,67 @@
+# linkto
+
+## Purpose
+
+Relation picker field.
+
+## Frontend capability flags
+
+- `group: advanced`
+- `hideInList: true`
+- `hideInViewMode: false`
+- `inlineEdtiable: true`
+- `notImportAble: true`
+- `notExportAble: true`
+- `events: ['change']`
+
+## Minimal shape
+
+```json
+{
+  "type": "linkto",
+  "options": {
+    "placeholder": "",
+    "mode": "manual",
+    "structure": "multiple",
+    "relation": {
+      "app_id": 1,
+      "entity_id": 2,
+      "type": "entity",
+      "show_fields": [1001],
+      "queryFields": [1001],
+      "condition": { "mode": "and", "conditions": [] },
+      "sorts": [{ "column": "updated_at", "order": "desc" }]
+    },
+    "backfill": []
+  }
+}
+```
+
+## Common options
+
+- `placeholder`
+- `mode`
+- `structure`
+- `backfill`
+- `addValue`
+- `relation.app_id`
+- `relation.entity_id`
+- `relation.type`
+- `relation.show_fields`
+- `relation.queryFields`
+- `relation.condition`
+- `relation.sorts`
+- `relation.subform_id`
+
+## Constraints
+
+- `relation.app_id` and `relation.entity_id` are required
+- `relation.show_fields` should be explicit
+- `relation.sorts` should include at least one default sort
+- row CRUD may store an empty array when no linked record is selected
+- `mode` current common values are:
+  - `auto`
+  - `manual`
+- `structure` current common values are:
+  - `single`
+  - `multiple`

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

@@ -0,0 +1,32 @@
+# location
+
+## Purpose
+
+Location field.
+
+## Frontend capability flags
+
+- `group: advanced`
+- `useFormula: true`
+- `useRelation: true`
+- `events: ['change']`
+
+## Minimal shape
+
+```json
+{
+  "type": "location",
+  "options": {
+    "placeholder": ""
+  }
+}
+```
+
+## Common options
+
+- `placeholder`
+
+## Constraints
+
+- In the current direct-write pathyou may keep only an empty `placeholder`
+- other behavior depends on runtime location capability; do not extend the schema with extra custom structure

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

@@ -0,0 +1,41 @@
+# lookup
+
+## Purpose
+
+Lookup field that pulls a value from the target entity of a `linkto` field.
+
+## Frontend capability flags
+
+- `group: advanced`
+- `readonly: true`
+- `notImportAble: true`
+
+## Minimal shape
+
+```json
+{
+  "type": "lookup",
+  "options": {
+    "relation": {
+      "local_linkto_field_id": 1012,
+      "target_field_id": 2003,
+      "target_field_type": "text"
+    }
+  }
+}
+```
+
+## Common options
+
+- `relation.local_linkto_field_id`
+- `relation.target_field_id`
+- `relation.target_field_type`
+
+## Constraints
+
+- `local_linkto_field_id` must point to a real `linkto`
+- `target_field_id` is required
+- `target_field_type` should be explicit
+- `local_linkto_field_id` should point to a `linkto` field in the same scope as the lookup field
+- after choosing the target field, the current field `label` should usually match the target field name
+- in the current direct-write path, keep only `relation` at the top level of `options`

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

@@ -0,0 +1,37 @@
+# member
+
+## Purpose
+
+Single-member field.
+
+## Frontend capability flags
+
+- `group: normal`
+- `useFormula: true`
+- `useRelation: true`
+- `operator: member`
+- `notImportAble: true`
+
+## Minimal shape
+
+```json
+{
+  "type": "member",
+  "options": {}
+}
+```
+
+## Common options
+
+- `placeholder`
+
+## Default value
+
+- `value` may be null
+- if you need to represent the current user, prefer:
+  - `${CURRENT_USER}`
+
+## Constraints
+
+- `member` is a single-value field
+- `value` must not be an array

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

@@ -0,0 +1,31 @@
+# members
+
+## Purpose
+
+Multi-member field.
+
+## Frontend capability flags
+
+- `group: normal`
+- `useFormula: true`
+- `useRelation: true`
+- `notImportAble: true`
+- `events: ['change']`
+
+## Minimal shape
+
+```json
+{
+  "type": "members",
+  "options": {}
+}
+```
+
+## Common options
+
+- `placeholder`
+
+## Constraints
+
+- `members` is a multi-value field
+- in the current direct-write path, `options` may contain only `placeholder`

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

@@ -0,0 +1,70 @@
+# number
+
+## Purpose
+
+Numeric field.
+
+## Frontend capability flags
+
+- `group: normal`
+- `uniqueAble: true`
+- `useFormula: true`
+- `useRelation: true`
+- `switchgroup: number`
+- `inlineEdtiable: true`
+- `events: ['change']`
+
+## Minimal shape
+
+```json
+{
+  "type": "number",
+  "number_decimal": 0,
+  "options": {
+    "link": {},
+    "mode": "number",
+    "numberMax": "",
+    "numberMin": "",
+    "numberRange": false,
+    "placeholder": "",
+    "repeatRemind": "This value already exists and duplicate submission is not allowed"
+  }
+}
+```
+
+## Common options
+
+- `link`
+- `mode`
+- `placeholder`
+- `unit`
+- `number_thousand_separator`
+- `numberMax`
+- `numberMin`
+- `numberRange`
+- `repeatRemind`
+- `number_spec_decimal`
+- `default_formula`
+- `default_formula_jsonlogic`
+- `hideInList`
+
+## Constraints
+
+- `mode` should be `number` or `percent`
+- `number_decimal` must be a non-negative integer
+- if you include `number_spec_decimal`, keep it consistent with `number_decimal`
+- when `mode = "percent"`, keep the stored `number_decimal` explicit in the final payload
+- when `numberRange=true`, it is recommended to provide both `numberMin` and `numberMax`
+
+## Save-ready reminder
+
+For `arcubase-admin entity admin-save-entity`, keep the full base `FieldVO`.
+
+In practice, do not forget:
+
+- `number_decimal`
+- `value`
+- `depends`
+- `key`
+- `transfers`
+- `children: null`

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

@@ -0,0 +1,50 @@
+# query
+
+## Purpose
+
+Selection-query field based on relation config.
+
+## Minimal shape
+
+```json
+{
+  "type": "query",
+  "options": {
+    "mode": "manual",
+    "structure": "multiple",
+    "addValue": true,
+    "relation": {
+      "app_id": 1,
+      "entity_id": 2,
+      "type": "entity",
+      "show_fields": [1001],
+      "queryFields": [1001],
+      "condition": { "mode": "and", "conditions": [] },
+      "sorts": [{ "column": "updated_at", "order": "desc" }]
+    }
+  }
+}
+```
+
+## Common options
+
+- `mode`
+- `structure`
+- `addValue`
+- `relation.app_id`
+- `relation.entity_id`
+- `relation.type`
+- `relation.show_fields`
+- `relation.queryFields`
+- `relation.condition`
+- `relation.sorts`
+
+## Constraints
+
+- `relation.app_id` and `relation.entity_id` are required
+- `relation.type` must be explicit; use `entity`
+- `relation.show_fields` should be explicit
+- `relation.queryFields` should be explicit in manual mode
+- `relation.sorts` should include at least one default sort
+- `mode` current common values are `auto` and `manual`
+- `structure` current common values are `single` and `multiple`

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

@@ -0,0 +1,53 @@
+# radio
+
+## Purpose
+
+Single-select enum field.
+
+## Frontend capability flags
+
+- `group: normal`
+- `useFormula: true`
+- `useRelation: true`
+- `switchgroup: text`
+- `events: ['change']`
+
+## Minimal shape
+
+```json
+{
+  "type": "radio",
+  "options": {
+    "horizontal": false,
+    "options": {
+      "mode": "custom",
+      "colorful": false,
+      "items": [
+        { "key": 1, "value": "Option 1" }
+      ]
+    }
+  }
+}
+```
+
+## Common options
+
+- `horizontal`
+- `hideInList`
+- `link`
+- `numberMax`
+- `numberMin`
+- `numberRange`
+- `repeatRemind`
+- `width`
+- `options.items`
+- `options.mode`
+- `options.colorful`
+- `options.has_other`
+- `options.other_label`
+
+## Constraints
+
+- `options.items` at least one item
+- when `options.has_other = true`, also provide `options.other_label`
+- `horizontal` controls display only; it does not change the row payload shape

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

@@ -0,0 +1,55 @@
+# relation
+
+## Purpose
+
+Entity relation field.
+
+## Minimal shape
+
+```json
+{
+  "type": "relation",
+  "options": {
+    "backfill": [],
+    "placeholder": "",
+    "relation": {
+      "app_id": 1,
+      "entity_id": 2,
+      "type": "entity",
+      "show_fields": [1001],
+      "queryFields": [1001],
+      "condition": { "mode": "and", "conditions": [] },
+      "sorts": [{ "column": "updated_at", "order": "desc" }]
+    }
+  }
+}
+```
+
+## Common options
+
+- `backfill`
+- `placeholder`
+- `mode`
+- `structure`
+- `addValue`
+- `relation.app_id`
+- `relation.entity_id`
+- `relation.type`
+- `relation.show_fields`
+- `relation.queryFields`
+- `relation.condition`
+- `relation.sorts`
+- `relation.subform_id`
+- `width`
+
+## Constraints
+
+- `relation.app_id` and `relation.entity_id` are required
+- `relation.show_fields` should be explicit
+- `relation.sorts` should include at least one default sort
+- In the current direct-write path, `mode` common values:
+  - `auto`
+  - `manual`
+- In the current direct-write path, `structure` common values:
+  - `single`
+  - `multiple`