eventmodeler 0.4.7 → 0.6.0

package/dist/slices/guide/guides/information-flow.js

@@ -52,47 +52,47 @@ Field types: \`UUID\`, \`String\`, \`Int\`, \`Long\`, \`Double\`, \`Decimal\`, \
 
 \`\`\`bash
 # Add a simple field
-eventmodeler add field --read-model "OrderSummary" --xml '<field name="orderId" type="UUID"/>'
+eventmodeler add field "OrderSummary" '{"name": "orderId", "type": "UUID"}'
 
 # Add an optional field
-eventmodeler add field --read-model "OrderSummary" --xml '<field name="cancelledAt" type="DateTime" isOptional="true"/>'
+eventmodeler add field "OrderSummary" '{"name": "cancelledAt", "type": "DateTime", "isOptional": true}'
 
 # Add a list field
-eventmodeler add field --read-model "OrderSummary" --xml '<field name="itemIds" type="UUID" isList="true"/>'
+eventmodeler add field "OrderSummary" '{"name": "itemIds", "type": "UUID", "isList": true}'
 
 # Add a complex/nested field
-eventmodeler add field --read-model "OrderSummary" --xml '<field name="shippingAddress" type="Custom">
-  <field name="street" type="String"/>
-  <field name="city" type="String"/>
-  <field name="postalCode" type="String"/>
-</field>'
+eventmodeler add field "OrderSummary" '{"name": "shippingAddress", "type": "Custom", "subfields": [
+  {"name": "street", "type": "String"},
+  {"name": "city", "type": "String"},
+  {"name": "postalCode", "type": "String"}
+]}'
 \`\`\`
 
 **CRITICAL: Custom fields MUST contain subfields.** A Custom field without subfields is invalid.
 
 ### Lists and Custom Types
 
-**List of custom objects** - combine \`type="Custom"\` with \`isList="true"\`:
+**List of custom objects** - combine \`"type": "Custom"\` with \`"isList": true\`:
 \`\`\`bash
-eventmodeler add field --read-model "OrderSummary" --xml '<field name="lineItems" type="Custom" isList="true">
-  <field name="productId" type="UUID"/>
-  <field name="productName" type="String"/>
-  <field name="quantity" type="Int"/>
-  <field name="unitPrice" type="Decimal"/>
-</field>'
+eventmodeler add field "OrderSummary" '{"name": "lineItems", "type": "Custom", "isList": true, "subfields": [
+  {"name": "productId", "type": "UUID"},
+  {"name": "productName", "type": "String"},
+  {"name": "quantity", "type": "Int"},
+  {"name": "unitPrice", "type": "Decimal"}
+]}'
 \`\`\`
 
 **Nested custom types** - subfields can themselves be Custom:
 \`\`\`bash
-eventmodeler add field --read-model "OrderSummary" --xml '<field name="customer" type="Custom">
-  <field name="customerId" type="UUID"/>
-  <field name="name" type="String"/>
-  <field name="billingAddress" type="Custom">
-    <field name="street" type="String"/>
-    <field name="city" type="String"/>
-    <field name="country" type="String"/>
-  </field>
-</field>'
+eventmodeler add field "OrderSummary" '{"name": "customer", "type": "Custom", "subfields": [
+  {"name": "customerId", "type": "UUID"},
+  {"name": "name", "type": "String"},
+  {"name": "billingAddress", "type": "Custom", "subfields": [
+    {"name": "street", "type": "String"},
+    {"name": "city", "type": "String"},
+    {"name": "country", "type": "String"}
+  ]}
+]}'
 \`\`\`
 
 ---
@@ -104,42 +104,32 @@ Field mappings define how data flows from source elements to target elements. Wh
 ### Command Syntax
 
 \`\`\`bash
-eventmodeler map fields --flow "<Source>→<Target>" --xml '<mapping from="sourceField" to="targetField"/>'
+eventmodeler map fields --from "<source>" --to "<target>" '[{"from": "sourceField", "to": "targetField"}]'
 \`\`\`
 
 Or with multiple mappings:
 
 \`\`\`bash
-eventmodeler map fields --flow "<Source>→<Target>" --xml '
-  <mapping from="orderId" to="orderId"/>
-  <mapping from="customerId" to="customerId"/>
-  <mapping from="totalAmount" to="total"/>
-'
+eventmodeler map fields --from "OrderPlaced" --to "OrderSummary" '[
+  {"from": "orderId", "to": "orderId"},
+  {"from": "customerId", "to": "customerId"},
+  {"from": "totalAmount", "to": "total"}
+]'
 \`\`\`
 
-### Flow Identifier Formats
+### Source/Target Formats
 
-The \`--flow\` argument accepts:
+The \`--from\` and \`--to\` arguments accept:
 
-1. **Name arrow format** (most common): \`"SourceName→TargetName"\` or \`"SourceName->TargetName"\`
-2. **Element ID prefix** (for duplicates): \`"id:abc12345→TargetName"\`
-3. **Flow ID directly**: The UUID of the flow itself
-
-### JSON Alternative
-
-\`\`\`bash
-eventmodeler map fields --flow "OrderPlaced→OrderSummary" --json '[
-  {"from": "orderId", "to": "orderId"},
-  {"from": "customerId", "to": "customerId"}
-]'
-\`\`\`
+1. **Element name** (most common): \`"OrderPlaced"\`
+2. **Element ID prefix** (for duplicates): \`"id:abc12345"\`
 
 ### Workflow
 
 1. **Find flows needing mappings**: \`eventmodeler show model-completeness\`
 2. **See source fields**: \`eventmodeler show event "OrderPlaced"\`
 3. **See target fields**: \`eventmodeler show completeness "OrderSummary"\`
-4. **Create mappings**: \`eventmodeler map fields --flow "OrderPlaced→OrderSummary" --xml '...'\`
+4. **Create mappings**: \`eventmodeler map fields --from "OrderPlaced" --to "OrderSummary" '[...]'\`
 5. **Verify**: \`eventmodeler show completeness "OrderSummary"\`
 
 ### Mapping Nested Fields
@@ -147,11 +137,11 @@ eventmodeler map fields --flow "OrderPlaced→OrderSummary" --json '[
 For Custom (nested) field types, use dot notation:
 
 \`\`\`bash
-eventmodeler map fields --flow "OrderPlaced→OrderSummary" --xml '
-  <mapping from="shippingAddress.street" to="deliveryAddress.street"/>
-  <mapping from="shippingAddress.city" to="deliveryAddress.city"/>
-  <mapping from="shippingAddress.postalCode" to="deliveryAddress.zip"/>
-'
+eventmodeler map fields --from "OrderPlaced" --to "OrderSummary" '[
+  {"from": "shippingAddress.street", "to": "deliveryAddress.street"},
+  {"from": "shippingAddress.city", "to": "deliveryAddress.city"},
+  {"from": "shippingAddress.postalCode", "to": "deliveryAddress.zip"}
+]'
 \`\`\`
 
 ### Multiple Flows to Same Target
@@ -160,17 +150,17 @@ A read model often receives data from multiple events. Map each flow separately:
 
 \`\`\`bash
 # Initial data from OrderPlaced
-eventmodeler map fields --flow "OrderPlaced→OrderSummary" --xml '
-  <mapping from="orderId" to="orderId"/>
-  <mapping from="customerId" to="customerId"/>
-  <mapping from="totalAmount" to="total"/>
-'
+eventmodeler map fields --from "OrderPlaced" --to "OrderSummary" '[
+  {"from": "orderId", "to": "orderId"},
+  {"from": "customerId", "to": "customerId"},
+  {"from": "totalAmount", "to": "total"}
+]'
 
 # Status updates from OrderShipped
-eventmodeler map fields --flow "OrderShipped→OrderSummary" --xml '
-  <mapping from="shippedAt" to="shippedDate"/>
-  <mapping from="trackingNumber" to="trackingNumber"/>
-'
+eventmodeler map fields --from "OrderShipped" --to "OrderSummary" '[
+  {"from": "shippedAt", "to": "shippedDate"},
+  {"from": "trackingNumber", "to": "trackingNumber"}
+]'
 \`\`\`
 
 ### Updating Existing Mappings
@@ -183,10 +173,10 @@ Running \`map fields\` again **merges** with existing mappings:
 
 | Pattern | Example |
 |---------|---------|
-| Identity | \`<mapping from="orderId" to="orderId"/>\` |
-| Rename | \`<mapping from="totalAmount" to="total"/>\` |
-| Nested to flat | \`<mapping from="customer.id" to="customerId"/>\` |
-| Flat to nested | \`<mapping from="street" to="address.street"/>\` |
+| Identity | \`{"from": "orderId", "to": "orderId"}\` |
+| Rename | \`{"from": "totalAmount", "to": "total"}\` |
+| Nested to flat | \`{"from": "customer.id", "to": "customerId"}\` |
+| Flat to nested | \`{"from": "street", "to": "address.street"}\` |
 
 ---
 
@@ -197,11 +187,9 @@ Use \`update field\` to modify field attributes without changing the field's nam
 ### Command Syntax
 
 \`\`\`bash
-eventmodeler update field --<element-type> "<name>" --field "<field-name>" [options]
+eventmodeler update field <element-name> --field "<field-name>" [options]
 \`\`\`
 
-Element types: \`--command\`, \`--event\`, \`--read-model\`, \`--screen\`, \`--processor\`
-
 ### Available Options
 
 | Option | Values | Description |
@@ -215,19 +203,19 @@ Element types: \`--command\`, \`--event\`, \`--read-model\`, \`--screen\`, \`--p
 
 \`\`\`bash
 # Mark a field as optional
-eventmodeler update field --event "OrderPlaced" --field "promoCode" --optional true
+eventmodeler update field "OrderPlaced" --field "promoCode" --optional true
 
 # Mark a field as system-generated
-eventmodeler update field --event "OrderPlaced" --field "orderId" --generated true
+eventmodeler update field "OrderPlaced" --field "orderId" --generated true
 
 # Mark screen fields as user input
-eventmodeler update field --screen "Checkout" --field "email" --user-input true
+eventmodeler update field "Checkout" --field "email" --user-input true
 
 # Change a field's type
-eventmodeler update field --read-model "OrderSummary" --field "total" --type Decimal
+eventmodeler update field "OrderSummary" --field "total" --type Decimal
 
 # Combine multiple updates
-eventmodeler update field --event "UserRegistered" --field "createdAt" --generated true --optional false
+eventmodeler update field "UserRegistered" --field "createdAt" --generated true --optional false
 \`\`\`
 
 ### Updating Nested Fields
@@ -235,7 +223,7 @@ eventmodeler update field --event "UserRegistered" --field "createdAt" --generat
 Use dot notation for fields inside Custom types:
 
 \`\`\`bash
-eventmodeler update field --event "OrderPlaced" --field "shippingAddress.postalCode" --optional true
+eventmodeler update field "OrderPlaced" --field "shippingAddress.postalCode" --optional true
 \`\`\`
 
 ### Field Property Meanings
@@ -252,13 +240,13 @@ eventmodeler update field --event "OrderPlaced" --field "shippingAddress.postalC
 
 \`\`\`bash
 # Remove a field from an event
-eventmodeler remove field --event "OrderPlaced" --field "legacyId"
+eventmodeler remove field "OrderPlaced" --field "legacyId"
 
 # Remove a field from a read model
-eventmodeler remove field --read-model "OrderSummary" --field "deprecatedStatus"
+eventmodeler remove field "OrderSummary" --field "deprecatedStatus"
 
 # Remove a nested field using dot notation
-eventmodeler remove field --event "OrderPlaced" --field "metadata.debugInfo"
+eventmodeler remove field "OrderPlaced" --field "metadata.debugInfo"
 \`\`\`
 
 **Caution**: Removing a field may break existing field mappings. Check completeness first:
@@ -292,16 +280,16 @@ eventmodeler show aggregate-completeness "<aggregate-name>"
 ## Common Mistakes
 
 - **Creating empty Custom fields**: Custom fields MUST have subfields.
-  - Wrong: \`<field name="address" type="Custom"/>\`
-  - Right: \`<field name="address" type="Custom"><field name="street" type="String"/>...</field>\`
+  - Wrong: \`{"name": "address", "type": "Custom"}\`
+  - Right: \`{"name": "address", "type": "Custom", "subfields": [{"name": "street", "type": "String"}, ...]}\`
 
-- **Using "List" as a field type**: Use \`isList="true"\` with a valid type instead.
-  - Wrong: \`<field name="items" type="List"/>\`
-  - Right: \`<field name="items" type="String" isList="true"/>\`
+- **Using "List" as a field type**: Use \`"isList": true\` with a valid type instead.
+  - Wrong: \`{"name": "items", "type": "List"}\`
+  - Right: \`{"name": "items", "type": "String", "isList": true}\`
 
 - **Using wrong attribute names**: Always use camelCase attributes.
-  - Wrong: \`optional="true"\`, \`generated="true"\`, \`list="true"\`
-  - Right: \`isOptional="true"\`, \`isGenerated="true"\`, \`isList="true"\`
+  - Wrong: \`"optional": true\`, \`"generated": true\`, \`"list": true\`
+  - Right: \`"isOptional": true\`, \`"isGenerated": true\`, \`"isList": true\`
 
 ## Best Practices
 

package/dist/slices/guide/guides/scenarios.js

@@ -67,59 +67,61 @@ For slices where a user action triggers a command:
 
 \`\`\`bash
 # Happy path - command succeeds
-eventmodeler add scenario --slice "<slice-name>" --xml '<scenario name="Successfully place order" description="A registered customer can place an order with valid items">
-  <given>
-    <event name="CustomerRegistered">
-      <field name="customerId">cust-123</field>
-    </event>
-  </given>
-  <when>
-    <command name="PlaceOrder">
-      <field name="customerId">cust-123</field>
-      <field name="items">[{"productId": "prod-1", "quantity": 2}]</field>
-    </command>
-  </when>
-  <then type="events">
-    <event name="OrderPlaced">
-      <field name="orderId">order-456</field>
-      <field name="customerId">cust-123</field>
-    </event>
-  </then>
-</scenario>'
+eventmodeler add scenario --slice "<slice-name>" '{
+  "name": "Successfully place order",
+  "description": "A registered customer can place an order with valid items",
+  "given": [
+    {"event": "CustomerRegistered", "fieldValues": {"customerId": "cust-123"}}
+  ],
+  "when": {
+    "command": "PlaceOrder",
+    "commandFieldValues": {"customerId": "cust-123", "items": [{"productId": "prod-1", "quantity": 2}]}
+  },
+  "then": {
+    "type": "events",
+    "events": [
+      {"event": "OrderPlaced", "fieldValues": {"orderId": "order-456", "customerId": "cust-123"}}
+    ]
+  }
+}'
 \`\`\`
 
 \`\`\`bash
 # Validation error
-eventmodeler add scenario --slice "<slice-name>" --xml '<scenario name="Cannot place empty order" description="Orders must contain at least one item - empty item lists are rejected">
-  <when>
-    <command name="PlaceOrder">
-      <field name="customerId">cust-123</field>
-      <field name="items">[]</field>
-    </command>
-  </when>
-  <then type="error" errorType="ValidationError">Order must contain at least one item</then>
-</scenario>'
+eventmodeler add scenario --slice "<slice-name>" '{
+  "name": "Cannot place empty order",
+  "description": "Orders must contain at least one item - empty item lists are rejected",
+  "when": {
+    "command": "PlaceOrder",
+    "commandFieldValues": {"customerId": "cust-123", "items": []}
+  },
+  "then": {
+    "type": "error",
+    "errorType": "ValidationError",
+    "errorMessage": "Order must contain at least one item"
+  }
+}'
 \`\`\`
 
 \`\`\`bash
 # Business rule violation
-eventmodeler add scenario --slice "Cancel Order" --xml '<scenario name="Cannot cancel shipped order" description="Once an order has been shipped, it can no longer be cancelled">
-  <given>
-    <event name="OrderPlaced">
-      <field name="orderId">order-123</field>
-    </event>
-    <event name="OrderShipped">
-      <field name="orderId">order-123</field>
-      <field name="shippedAt">2024-01-15T10:00:00Z</field>
-    </event>
-  </given>
-  <when>
-    <command name="CancelOrder">
-      <field name="orderId">order-123</field>
-    </command>
-  </when>
-  <then type="error" errorType="BusinessRuleViolation">Cannot cancel an order that has already shipped</then>
-</scenario>'
+eventmodeler add scenario --slice "Cancel Order" '{
+  "name": "Cannot cancel shipped order",
+  "description": "Once an order has been shipped, it can no longer be cancelled",
+  "given": [
+    {"event": "OrderPlaced", "fieldValues": {"orderId": "order-123"}},
+    {"event": "OrderShipped", "fieldValues": {"orderId": "order-123", "shippedAt": "2024-01-15T10:00:00Z"}}
+  ],
+  "when": {
+    "command": "CancelOrder",
+    "commandFieldValues": {"orderId": "order-123"}
+  },
+  "then": {
+    "type": "error",
+    "errorType": "BusinessRuleViolation",
+    "errorMessage": "Cannot cancel an order that has already shipped"
+  }
+}'
 \`\`\`
 
 ---
@@ -140,38 +142,33 @@ For slices where events trigger a processor to issue a command. Use the simpler
 
 \`\`\`bash
 # Payment received triggers shipment initiation
-# Given: OrderPlaced + PaymentReceived → Then: InitiateShipment command
-eventmodeler add scenario --slice "Auto Ship Order" --xml '<scenario name="Payment triggers shipment" description="Given an order has been placed and payment received, the system automatically initiates shipment">
-  <given>
-    <event name="OrderPlaced">
-      <field name="orderId">order-123</field>
-      <field name="customerId">cust-456</field>
-    </event>
-    <event name="PaymentReceived">
-      <field name="orderId">order-123</field>
-      <field name="amount">99.99</field>
-    </event>
-  </given>
-  <then type="command">
-    <command name="InitiateShipment">
-      <field name="orderId">order-123</field>
-      <field name="warehouseId">wh-001</field>
-    </command>
-  </then>
-</scenario>'
+eventmodeler add scenario --slice "Auto Ship Order" '{
+  "name": "Payment triggers shipment",
+  "description": "Given an order has been placed and payment received, the system automatically initiates shipment",
+  "given": [
+    {"event": "OrderPlaced", "fieldValues": {"orderId": "order-123", "customerId": "cust-456"}},
+    {"event": "PaymentReceived", "fieldValues": {"orderId": "order-123", "amount": 99.99}}
+  ],
+  "then": {
+    "type": "command",
+    "command": "InitiateShipment",
+    "commandFieldValues": {"orderId": "order-123", "warehouseId": "wh-001"}
+  }
+}'
 \`\`\`
 
 \`\`\`bash
 # Negative case - conditions not met, no command dispatched
-eventmodeler add scenario --slice "Auto Ship Order" --xml '<scenario name="No shipment without payment" description="Given only an order placed (no payment), the system should not initiate shipment">
-  <given>
-    <event name="OrderPlaced">
-      <field name="orderId">order-123</field>
-      <field name="customerId">cust-456</field>
-    </event>
-  </given>
-  <then type="noCommand"/>
-</scenario>'
+eventmodeler add scenario --slice "Auto Ship Order" '{
+  "name": "No shipment without payment",
+  "description": "Given only an order placed (no payment), the system should not initiate shipment",
+  "given": [
+    {"event": "OrderPlaced", "fieldValues": {"orderId": "order-123", "customerId": "cust-456"}}
+  ],
+  "then": {
+    "type": "noCommand"
+  }
+}'
 \`\`\`
 
 ---
@@ -181,14 +178,18 @@ eventmodeler add scenario --slice "Auto Ship Order" --xml '<scenario name="No sh
 For state-view slices, test that events project correctly to read models:
 
 \`\`\`bash
-eventmodeler add scenario --slice "<slice-name>" --xml '<scenario name="Order appears in summary" description="After placing an order, it should be visible in the order summary with pending status">
-  <then type="readModelAssertion">
-    <read-model name="OrderSummary">
-      <field name="orderId">order-456</field>
-      <field name="status">pending</field>
-    </read-model>
-  </then>
-</scenario>'
+eventmodeler add scenario --slice "<slice-name>" '{
+  "name": "Order appears in summary",
+  "description": "After placing an order, it should be visible in the order summary with pending status",
+  "given": [
+    {"event": "OrderPlaced", "fieldValues": {"orderId": "order-456", "customerId": "cust-123", "status": "pending"}}
+  ],
+  "then": {
+    "type": "readModelAssertion",
+    "readModel": "OrderSummary",
+    "expected": {"orderId": "order-456", "status": "pending"}
+  }
+}'
 \`\`\`
 
 ---
@@ -201,62 +202,6 @@ eventmodeler add scenario --slice "<slice-name>" --xml '<scenario name="Order ap
 | Automation | Given (Events) → Then | Command or noCommand |
 | State-View | Given → Then | Read Model Assertion |
 
-## JSON Format Alternative
-
-You can also use JSON format:
-
-**State-Change Scenario:**
-\`\`\`bash
-eventmodeler add scenario --slice "<slice-name>" --json '{
-  "name": "Successfully place order",
-  "description": "A registered customer can place an order",
-  "given": [
-    { "event": "CustomerRegistered", "fieldValues": { "customerId": "cust-123" } }
-  ],
-  "when": {
-    "command": "PlaceOrder",
-    "commandFieldValues": { "customerId": "cust-123", "items": [] }
-  },
-  "then": {
-    "type": "events",
-    "events": [
-      { "event": "OrderPlaced", "fieldValues": { "orderId": "order-456" } }
-    ]
-  }
-}'
-\`\`\`
-
-**Automation Scenario (Given-Then format):**
-\`\`\`bash
-eventmodeler add scenario --slice "<slice-name>" --json '{
-  "name": "Payment triggers shipment",
-  "description": "Given order placed and payment received, shipment is initiated",
-  "given": [
-    { "event": "OrderPlaced", "fieldValues": { "orderId": "order-123" } },
-    { "event": "PaymentReceived", "fieldValues": { "orderId": "order-123", "amount": 99.99 } }
-  ],
-  "then": {
-    "type": "command",
-    "command": "InitiateShipment",
-    "commandFieldValues": { "orderId": "order-123" }
-  }
-}'
-\`\`\`
-
-**Automation Scenario (negative case):**
-\`\`\`bash
-eventmodeler add scenario --slice "<slice-name>" --json '{
-  "name": "No shipment without payment",
-  "description": "Given only order placed (no payment), no command dispatched",
-  "given": [
-    { "event": "OrderPlaced", "fieldValues": { "orderId": "order-123" } }
-  ],
-  "then": {
-    "type": "noCommand"
-  }
-}'
-\`\`\`
-
 ## Best Practices
 
 1. **Write clear descriptions** - Explain why this scenario matters and what business rule it captures

package/dist/slices/guide/index.js

@@ -1,9 +1,9 @@
-import { meta as exploreMeta, content as exploreContent } from './guides/explore.js';
-import { meta as scenariosMeta, content as scenariosContent } from './guides/scenarios.js';
-import { meta as informationFlowMeta, content as informationFlowContent } from './guides/information-flow.js';
-import { meta as createSlicesMeta, content as createSlicesContent } from './guides/create-slices.js';
-import { meta as connectSlicesMeta, content as connectSlicesContent } from './guides/connect-slices.js';
-import { meta as codegenMeta, content as codegenContent } from './guides/codegen.js';
+import { meta as exploreMeta, content as exploreContent } from './guides/explore';
+import { meta as scenariosMeta, content as scenariosContent } from './guides/scenarios';
+import { meta as informationFlowMeta, content as informationFlowContent } from './guides/information-flow';
+import { meta as createSlicesMeta, content as createSlicesContent } from './guides/create-slices';
+import { meta as connectSlicesMeta, content as connectSlicesContent } from './guides/connect-slices';
+import { meta as codegenMeta, content as codegenContent } from './guides/codegen';
 const GUIDES = [
     { meta: exploreMeta, content: exploreContent },
     { meta: createSlicesMeta, content: createSlicesContent },