@carthooks/arcubase-cli 0.1.2 → 0.1.3

package/sdk-dist/docs/runtime-reference/examples/mes-01/README.md

@@ -0,0 +1,21 @@
+# MES Example 01
+
+This directory is reserved for a generic manufacturing execution example set.
+
+Planned tables:
+
+- `Work Order`
+- `Bill Of Material`
+- `Routing Template`
+- `Production Checkpoint`
+
+Planned field patterns:
+
+- `subform`
+- `relation`
+- `relationfield`
+- `datasets`
+- `member`
+- `status`
+
+All names will remain generic and English-only.

package/sdk-dist/docs/runtime-reference/examples/oms-01/README.md

@@ -0,0 +1,164 @@
+# OMS Example 01
+
+This example set models a compact order-management workflow.
+
+It is intentionally generic:
+
+- no tenant name
+- no company name
+- no country-specific codes
+- no region-specific channel names
+
+## Scope
+
+This set includes:
+
+- `Item Master`
+- `Goods Receipt`
+- `Stock Issue`
+- `Picking List`
+- `Sales Order`
+- `Purchase Order`
+
+## Why these tables
+
+This combination is enough to cover:
+
+- item master records
+- inbound stock
+- outbound stock
+- picking operations
+- sales orders with line items
+- purchase orders with planned and actual receipt subforms
+
+## Important genericization choices
+
+The production references contained market-specific naming such as:
+
+- local barcode naming
+- local purchase wording
+- local shipping wording
+- language-specific labels
+
+This example rewrites them into generic names such as:
+
+- `sku_code`
+- `source_channel`
+- `recipient_name`
+- `goods_receipt`
+- `stock_issue`
+
+## Files
+
+- `app-overview.md`
+- `create-app.json`
+- `sales-order.create-entity.json`
+- `item-master.create-entity.json`
+- `item-master.schema.json`
+- `goods-receipt.schema.json`
+- `stock-issue.schema.json`
+- `picking-list.schema.json`
+- `sales-order.schema.json`
+- `purchase-order.schema.json`
+- `goods-receipt.create-entity.json`
+- `stock-issue.create-entity.json`
+- `picking-list.create-entity.json`
+- `purchase-order.create-entity.json`
+- `sales-order.row.insert.json`
+- `sales-order.query.json`
+- `sales-order.selection.ids.json`
+- `sales-order.selection.condition.json`
+- `sales-order.bulk-update.json`
+
+## Save workflow
+
+For every `*.schema.json` file:
+
+1. create the entity shell
+2. fetch the shell with `admin-get-entity-info`
+3. replace:
+   - `__APP_ID__`
+   - `__ENTITY_ID__`
+   - `__SCHEMA_VERSION__`
+4. save the schema with `admin-save-entity`
+5. probe rows with `query-entity`
+
+These schema files are templates, not live shell exports.
+
+## Minimal command path
+
+Create the app:
+
+```bash
+arcubase-admin app create-app-by-tenants --body-file create-app.json
+```
+
+Create the shell:
+
+```bash
+arcubase-admin app create-entity --id <app_id> --body-file sales-order.create-entity.json
+arcubase-admin app create-entity --id <app_id> --body-file item-master.create-entity.json
+arcubase-admin app create-entity --id <app_id> --body-file goods-receipt.create-entity.json
+arcubase-admin app create-entity --id <app_id> --body-file stock-issue.create-entity.json
+arcubase-admin app create-entity --id <app_id> --body-file picking-list.create-entity.json
+arcubase-admin app create-entity --id <app_id> --body-file purchase-order.create-entity.json
+```
+
+Fetch the shell:
+
+```bash
+arcubase-admin entity admin-get-entity-info --app-id <app_id> --entity-id <entity_id>
+```
+
+Save the schema:
+
+```bash
+arcubase-admin entity admin-save-entity --app-id <app_id> --entity-id <entity_id> --body-file sales-order.schema.json
+arcubase-admin entity admin-save-entity --app-id <app_id> --entity-id <entity_id> --body-file item-master.schema.json
+arcubase-admin entity admin-save-entity --app-id <app_id> --entity-id <entity_id> --body-file goods-receipt.schema.json
+arcubase-admin entity admin-save-entity --app-id <app_id> --entity-id <entity_id> --body-file stock-issue.schema.json
+arcubase-admin entity admin-save-entity --app-id <app_id> --entity-id <entity_id> --body-file picking-list.schema.json
+arcubase-admin entity admin-save-entity --app-id <app_id> --entity-id <entity_id> --body-file purchase-order.schema.json
+```
+
+Insert one row:
+
+```bash
+arcubase workflow insert-entity --app-id <app_id> --entity-id <entity_id> --body-file sales-order.row.insert.json
+```
+
+Query rows:
+
+```bash
+arcubase workflow query-entity --app-id <app_id> --entity-id <entity_id> --body-file sales-order.query.json
+```
+
+## Placeholder rules
+
+The schema files use placeholders for:
+
+- `__APP_ID__`
+- `__ENTITY_ID__`
+- `__SCHEMA_VERSION__`
+
+The relation-based templates also use:
+
+- `__ITEM_MASTER_ENTITY_ID__`
+
+When you replace them, keep these fields as JSON numbers:
+
+- `app_id`
+- `id`
+- `schema_version`
+- relation `app_id`
+- relation `entity_id`
+
+Do not leave the replaced values as JSON strings.
+
+## Dependency order
+
+`Goods Receipt` and `Stock Issue` both depend on an existing `Item Master` entity.
+
+Create and save `Item Master` first, then replace `__ITEM_MASTER_ENTITY_ID__`
+with the numeric entity id of that local `Item Master` shell before you save the
+dependent schemas.

package/sdk-dist/docs/runtime-reference/examples/oms-01/app-overview.md

@@ -0,0 +1,79 @@
+# OMS Example 01 Overview
+
+## Table set
+
+### 1. Item Master
+
+Purpose:
+
+- hold the canonical item record
+- provide `sku_code`
+- provide item naming and pricing
+
+### 2. Goods Receipt
+
+Purpose:
+
+- record inbound quantities
+- link a receipt row to one item
+
+### 3. Stock Issue
+
+Purpose:
+
+- record outbound quantities
+- link an issue row to one item
+
+### 4. Picking List
+
+Purpose:
+
+- group picked items for fulfillment
+- use a subform for item lines
+
+### 5. Sales Order
+
+Purpose:
+
+- capture recipient information
+- capture one order with multiple line items
+- support search, selection, and bulk update examples
+
+### 6. Purchase Order
+
+Purpose:
+
+- capture ordered quantities
+- track planned receipt slots
+- track actual receipt slots
+- show one `status` field example and two `subform` examples
+
+## Relationship model
+
+- `Goods Receipt` links to `Item Master`
+- `Stock Issue` links to `Item Master`
+- `Sales Order` has `line_items` as a subform
+- `Picking List` has `items` as a subform
+- `Purchase Order` has:
+  - `planned_receipts`
+  - `actual_receipts`
+
+## Field patterns covered
+
+- `text`
+- `textarea`
+- `number`
+- `datetime`
+- `select`
+- `radio`
+- `status`
+- `image`
+- `relation`
+- `subform`
+
+## What was intentionally removed
+
+- country-specific code naming
+- tenant-specific internal labels
+- region-specific channel names
+- company-specific workflow terms

package/sdk-dist/docs/runtime-reference/examples/oms-01/create-app.json

@@ -0,0 +1,3 @@
+{
+  "name": "OMS Example 01"
+}

package/sdk-dist/docs/runtime-reference/examples/oms-01/goods-receipt.create-entity.json

@@ -0,0 +1,3 @@
+{
+  "name": "Goods Receipt"
+}

package/sdk-dist/docs/runtime-reference/examples/oms-01/goods-receipt.schema.json

@@ -0,0 +1,159 @@
+{
+  "id": "__ENTITY_ID__",
+  "app_id": "__APP_ID__",
+  "name": "Goods Receipt",
+  "workflow_enabled": false,
+  "fields": [
+    {
+      "id": 1001,
+      "label": "Linked Item",
+      "type": "relation",
+      "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": "linked_item",
+      "code_index": false,
+      "options": {
+        "relation": {
+          "app_id": "__APP_ID__",
+          "entity_id": "__ITEM_MASTER_ENTITY_ID__",
+          "type": "entity",
+          "show_fields": [],
+          "queryFields": [],
+          "condition": {},
+          "sorts": [
+            { "column": "updated_at", "order": "desc" }
+          ]
+        }
+      },
+      "transfers": null,
+      "children": null
+    },
+    {
+      "id": 1002,
+      "label": "SKU Code",
+      "type": "text",
+      "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": "sku_code",
+      "code_index": false,
+      "options": {},
+      "transfers": null,
+      "children": null
+    },
+    {
+      "id": 1003,
+      "label": "Item Name",
+      "type": "text",
+      "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": "item_name",
+      "code_index": false,
+      "options": {},
+      "transfers": null,
+      "children": null
+    },
+    {
+      "id": 1004,
+      "label": "Supplier Name",
+      "type": "text",
+      "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": "supplier_name",
+      "code_index": false,
+      "options": {},
+      "transfers": null,
+      "children": null
+    },
+    {
+      "id": 1005,
+      "label": "Received Quantity",
+      "type": "number",
+      "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": "received_quantity",
+      "code_index": false,
+      "options": {
+        "mode": "number"
+      },
+      "transfers": null,
+      "children": null
+    },
+    {
+      "id": 1006,
+      "label": "Received At",
+      "type": "datetime",
+      "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": "received_at",
+      "code_index": false,
+      "options": {
+        "type": "date"
+      },
+      "transfers": null,
+      "children": null
+    }
+  ],
+  "layout": [
+    [1001],
+    [1002, 1003],
+    [1004],
+    [1005, 1006]
+  ],
+  "options": {},
+  "schema_version": "__SCHEMA_VERSION__",
+  "field_id_seq": 1007
+}

package/sdk-dist/docs/runtime-reference/examples/oms-01/item-master.create-entity.json

@@ -0,0 +1,3 @@
+{
+  "name": "Item Master"
+}

package/sdk-dist/docs/runtime-reference/examples/oms-01/item-master.schema.json

@@ -0,0 +1,179 @@
+{
+  "id": "__ENTITY_ID__",
+  "app_id": "__APP_ID__",
+  "name": "Item Master",
+  "workflow_enabled": false,
+  "fields": [
+    {
+      "id": 1001,
+      "label": "Item Name",
+      "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": "item_name",
+      "code_index": false,
+      "options": {},
+      "transfers": null,
+      "children": null
+    },
+    {
+      "id": 1002,
+      "label": "SKU Code",
+      "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": "sku_code",
+      "code_index": false,
+      "options": {},
+      "transfers": null,
+      "children": null
+    },
+    {
+      "id": 1003,
+      "label": "External Item ID",
+      "type": "text",
+      "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": "external_item_id",
+      "code_index": false,
+      "options": {},
+      "transfers": null,
+      "children": null
+    },
+    {
+      "id": 1004,
+      "label": "Category",
+      "type": "select",
+      "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": "category",
+      "code_index": false,
+      "options": {
+        "horizontal": false,
+        "options": {
+          "mode": "custom",
+          "colorful": false,
+          "items": [
+            { "key": 1, "value": "Standard" },
+            { "key": 2, "value": "Bundle" },
+            { "key": 3, "value": "Consumable" }
+          ]
+        }
+      },
+      "transfers": null,
+      "children": null
+    },
+    {
+      "id": 1005,
+      "label": "Unit Price",
+      "type": "number",
+      "required": false,
+      "unique": false,
+      "editable": true,
+      "visible": true,
+      "show_label": true,
+      "scannable": false,
+      "default_value_mode": 0,
+      "description": "",
+      "value": null,
+      "number_decimal": 2,
+      "depends": [],
+      "key": "unit_price",
+      "code_index": false,
+      "options": {
+        "mode": "number"
+      },
+      "transfers": null,
+      "children": null
+    },
+    {
+      "id": 1006,
+      "label": "Wholesale Price",
+      "type": "number",
+      "required": false,
+      "unique": false,
+      "editable": true,
+      "visible": true,
+      "show_label": true,
+      "scannable": false,
+      "default_value_mode": 0,
+      "description": "",
+      "value": null,
+      "number_decimal": 2,
+      "depends": [],
+      "key": "wholesale_price",
+      "code_index": false,
+      "options": {
+        "mode": "number"
+      },
+      "transfers": null,
+      "children": null
+    },
+    {
+      "id": 1007,
+      "label": "Image",
+      "type": "image",
+      "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": "image",
+      "code_index": false,
+      "options": {},
+      "transfers": null,
+      "children": null
+    }
+  ],
+  "layout": [
+    [1001, 1002],
+    [1003, 1004],
+    [1005, 1006],
+    [1007]
+  ],
+  "options": {},
+  "schema_version": "__SCHEMA_VERSION__",
+  "field_id_seq": 1008
+}

package/sdk-dist/docs/runtime-reference/examples/oms-01/picking-list.create-entity.json

@@ -0,0 +1,3 @@
+{
+  "name": "Picking List"
+}