eventmodeler 0.4.7 → 0.6.0

package/dist/slices/guide/guides/create-slices.js

@@ -1,9 +1,9 @@
 export const meta = {
     name: 'create-slices',
-    description: 'Create state-change, automation, and state-view slices with fields and flows',
+    description: 'Understand slice types, fields, and how to build slices with flows',
 };
 export const content = `
-# Creating Slices
+# Understanding Slices
 
 There are three slice types in an event model. Each represents a different pattern of data flow.
 
@@ -28,51 +28,47 @@ Use state-change slices when:
 - That action changes the state of an entity
 - Examples: "Place Order", "Cancel Subscription", "Update Profile", "Add Item to Cart"
 
-### Command Syntax
+### Building a State-Change Slice
 
-\`\`\`bash
-eventmodeler create state-change-slice --xml '<state-change-slice name="Slice Name" [after="Other Slice"]>
-  <screen name="Screen Name">
-    <field name="fieldName" type="Type"/>
-  </screen>
-  <command name="CommandName">
-    <field name="fieldName" type="Type"/>
-  </command>
-  <event name="EventName">
-    <field name="fieldName" type="Type"/>
-  </event>
-</state-change-slice>'
-\`\`\`
+To build a state-change slice, you add the individual elements and connect them with flows:
+
+1. Add a screen, a command, and an event (using \`add field\` to define their fields)
+2. Create flows: Screen → Command, Command → Event
+3. Map the fields on each flow
 
 ### Example: Place Order Slice
 
+First, add fields to each element:
 \`\`\`bash
-eventmodeler create state-change-slice --xml '<state-change-slice name="Place Order">
-  <screen name="Checkout Screen">
-    <field name="customerId" type="UUID"/>
-    <field name="items" type="String" isUserInput="true"/>
-    <field name="shippingAddress" type="String" isUserInput="true"/>
-  </screen>
-  <command name="PlaceOrder">
-    <field name="customerId" type="UUID"/>
-    <field name="items" type="String"/>
-    <field name="shippingAddress" type="String"/>
-  </command>
-  <event name="OrderPlaced">
-    <field name="orderId" type="UUID" isGenerated="true"/>
-    <field name="customerId" type="UUID"/>
-    <field name="items" type="String"/>
-    <field name="shippingAddress" type="String"/>
-    <field name="placedAt" type="DateTime" isGenerated="true"/>
-  </event>
-</state-change-slice>'
+eventmodeler add field "Checkout Screen" '{"name": "customerId", "type": "UUID"}'
+eventmodeler add field "Checkout Screen" '{"name": "items", "type": "String", "isUserInput": true}'
+eventmodeler add field "Checkout Screen" '{"name": "shippingAddress", "type": "String", "isUserInput": true}'
+
+eventmodeler add field "PlaceOrder" '{"name": "customerId", "type": "UUID"}'
+eventmodeler add field "PlaceOrder" '{"name": "items", "type": "String"}'
+eventmodeler add field "PlaceOrder" '{"name": "shippingAddress", "type": "String"}'
+
+eventmodeler add field "OrderPlaced" '{"name": "orderId", "type": "UUID", "isGenerated": true}'
+eventmodeler add field "OrderPlaced" '{"name": "customerId", "type": "UUID"}'
+eventmodeler add field "OrderPlaced" '{"name": "items", "type": "String"}'
+eventmodeler add field "OrderPlaced" '{"name": "shippingAddress", "type": "String"}'
+eventmodeler add field "OrderPlaced" '{"name": "placedAt", "type": "DateTime", "isGenerated": true}'
 \`\`\`
 
-### Automatic Behavior
+Then connect with flows:
+\`\`\`bash
+eventmodeler create flow --from "Checkout Screen" --to "PlaceOrder"
+eventmodeler create flow --from "PlaceOrder" --to "OrderPlaced"
+\`\`\`
 
-1. **Positioning**: Places slice at end, or use \`after="Slice Name"\` or \`before="Slice Name"\`
-2. **Field mappings**: Automatically inferred by matching field names between Screen → Command and Command → Event
-3. **Flows**: Automatically creates Screen→Command and Command→Event flows
+Then map fields on the flows:
+\`\`\`bash
+eventmodeler map fields --from "PlaceOrder" --to "OrderPlaced" '[
+  {"from": "customerId", "to": "customerId"},
+  {"from": "items", "to": "items"},
+  {"from": "shippingAddress", "to": "shippingAddress"}
+]'
+\`\`\`
 
 ---
 
@@ -96,54 +92,37 @@ Use automation slices when:
 - No direct user interaction triggers the action
 - Examples: "Auto-assign Reviewer", "Send Reminder Email", "Calculate Shipping", "Process Payment"
 
-### Command Syntax
+### Building an Automation Slice
 
-\`\`\`bash
-eventmodeler create automation-slice --xml '<automation-slice name="Slice Name" [after="Other Slice"]>
-  <read-model name="ReadModelName">
-    <field name="fieldName" type="Type"/>
-  </read-model>
-  <processor name="Processor Name"/>
-  <command name="CommandName">
-    <field name="fieldName" type="Type"/>
-  </command>
-  <event name="EventName">
-    <field name="fieldName" type="Type"/>
-  </event>
-</automation-slice>'
-\`\`\`
+1. Add a read model, processor, command, and event with their fields
+2. Create internal flows: ReadModel → Processor, Processor → Command, Command → Event
+3. Connect external events to the read model with flows
 
 ### Example: Auto-Fulfill Order
 
 \`\`\`bash
-eventmodeler create automation-slice --xml '<automation-slice name="Auto Fulfill Order" after="Place Order">
-  <read-model name="OrderReadyForFulfillment">
-    <field name="orderId" type="UUID"/>
-    <field name="isPaid" type="Boolean"/>
-    <field name="shippingAddress" type="String"/>
-  </read-model>
-  <processor name="Order Fulfillment Processor"/>
-  <command name="FulfillOrder">
-    <field name="orderId" type="UUID"/>
-    <field name="warehouseId" type="UUID" isGenerated="true"/>
-  </command>
-  <event name="OrderFulfilled">
-    <field name="orderId" type="UUID"/>
-    <field name="warehouseId" type="UUID"/>
-    <field name="fulfilledAt" type="DateTime" isGenerated="true"/>
-  </event>
-</automation-slice>'
-\`\`\`
+eventmodeler add field "OrderReadyForFulfillment" '{"name": "orderId", "type": "UUID"}'
+eventmodeler add field "OrderReadyForFulfillment" '{"name": "isPaid", "type": "Boolean"}'
+eventmodeler add field "OrderReadyForFulfillment" '{"name": "shippingAddress", "type": "String"}'
 
-### Automatic Behavior
+eventmodeler add field "FulfillOrder" '{"name": "orderId", "type": "UUID"}'
+eventmodeler add field "FulfillOrder" '{"name": "warehouseId", "type": "UUID", "isGenerated": true}'
+
+eventmodeler add field "OrderFulfilled" '{"name": "orderId", "type": "UUID"}'
+eventmodeler add field "OrderFulfilled" '{"name": "warehouseId", "type": "UUID"}'
+eventmodeler add field "OrderFulfilled" '{"name": "fulfilledAt", "type": "DateTime", "isGenerated": true}'
+\`\`\`
 
-1. **Positioning**: Places slice at end, or use \`after="Slice Name"\` or \`before="Slice Name"\`
-2. **Field mappings**: Automatically inferred by matching field names: ReadModel → Command, Command → Event
-3. **Flows**: Automatically creates ReadModel → Processor, Processor → Command, Command → Event
+Connect internal flows:
+\`\`\`bash
+eventmodeler create flow --from "OrderReadyForFulfillment" --to "Order Fulfillment Processor"
+eventmodeler create flow --from "Order Fulfillment Processor" --to "FulfillOrder"
+eventmodeler create flow --from "FulfillOrder" --to "OrderFulfilled"
+\`\`\`
 
 ### Connecting Trigger Events
 
-After creating the automation slice, connect external events to its read model:
+Connect external events to the automation's read model:
 
 \`\`\`bash
 eventmodeler create flow --from "OrderPlaced" --to "OrderReadyForFulfillment"
@@ -157,7 +136,6 @@ eventmodeler create flow --from "PaymentReceived" --to "OrderReadyForFulfillment
 | Inside automation slice | Standalone slice |
 | Feeds a Processor | Feeds a Screen |
 | "What the processor needs" | "What the user sees" |
-| Created with automation-slice | Created with state-view-slice |
 
 ---
 
@@ -177,39 +155,31 @@ Use state-view slices when:
 - You want to aggregate data from multiple events
 - Examples: "Order Summary", "User Dashboard", "Inventory Levels", "Account Balance"
 
-### Command Syntax
+### Building a State-View Slice
 
-\`\`\`bash
-eventmodeler create state-view-slice --xml '<state-view-slice name="Slice Name" [after="Other Slice"]>
-  <read-model name="ReadModelName">
-    <field name="fieldName" type="Type"/>
-  </read-model>
-</state-view-slice>'
-\`\`\`
+1. Add the read model with its fields
+2. Create flows from events to the read model
+3. Map the fields on each flow
 
 ### Example: Order Summary View
 
 \`\`\`bash
-eventmodeler create state-view-slice --xml '<state-view-slice name="View Order Summary" after="Place Order">
-  <read-model name="OrderSummary">
-    <field name="orderId" type="UUID"/>
-    <field name="customerId" type="UUID"/>
-    <field name="customerName" type="String"/>
-    <field name="status" type="String"/>
-    <field name="totalAmount" type="Decimal"/>
-    <field name="itemCount" type="Int"/>
-    <field name="placedAt" type="DateTime"/>
-    <field name="lastUpdatedAt" type="DateTime"/>
-  </read-model>
-</state-view-slice>'
+eventmodeler add field "OrderSummary" '{"name": "orderId", "type": "UUID"}'
+eventmodeler add field "OrderSummary" '{"name": "customerId", "type": "UUID"}'
+eventmodeler add field "OrderSummary" '{"name": "customerName", "type": "String"}'
+eventmodeler add field "OrderSummary" '{"name": "status", "type": "String"}'
+eventmodeler add field "OrderSummary" '{"name": "totalAmount", "type": "Decimal"}'
+eventmodeler add field "OrderSummary" '{"name": "itemCount", "type": "Int"}'
+eventmodeler add field "OrderSummary" '{"name": "placedAt", "type": "DateTime"}'
+eventmodeler add field "OrderSummary" '{"name": "lastUpdatedAt", "type": "DateTime"}'
 \`\`\`
 
 ### Connecting Events After Creation
 
-The \`create state-view-slice\` command only creates the read model. To complete the picture:
+To complete the picture:
 
 1. Create flows from events: \`eventmodeler create flow --from "EventName" --to "ReadModelName"\`
-2. Map fields: \`eventmodeler map fields --flow "EventName→ReadModelName" --xml '...'\`
+2. Map fields: \`eventmodeler map fields --from "EventName" --to "ReadModelName" '[...]'\`
 3. Verify: \`eventmodeler show completeness "ReadModelName"\`
 
 ---
@@ -220,74 +190,74 @@ The \`create state-view-slice\` command only creates the read model. To complete
 
 ## Field Attributes
 
-- \`isOptional="true"\` - Field may not have a value
-- \`isGenerated="true"\` - System-generated (e.g., IDs, timestamps), not from user input
-- \`isUserInput="true"\` - Entered by the user on the screen
-- \`isList="true"\` - Field is a list/array of the specified type
+- \`"isOptional": true\` - Field may not have a value
+- \`"isGenerated": true\` - System-generated (e.g., IDs, timestamps), not from user input
+- \`"isUserInput": true\` - Entered by the user on the screen
+- \`"isList": true\` - Field is a list/array of the specified type
 
 ## Working with Lists and Custom Types
 
-**List of primitives** - use \`isList="true"\` with any valid type:
-\`\`\`xml
-<field name="tags" type="String" isList="true"/>
-<field name="quantities" type="Int" isList="true"/>
+**List of primitives** - use \`"isList": true\` with any valid type:
+\`\`\`json
+{"name": "tags", "type": "String", "isList": true}
+{"name": "quantities", "type": "Int", "isList": true}
 \`\`\`
 
 ### Custom Types (Nested Objects)
 
-**CRITICAL: Custom fields MUST contain subfields.** The \`type="Custom"\` indicates a nested object structure, and the nested \`<field>\` elements define its properties. A Custom field without subfields is invalid and creates an empty, useless type.
+**CRITICAL: Custom fields MUST contain subfields.** The \`"type": "Custom"\` indicates a nested object structure, and the \`"subfields"\` array defines its properties. A Custom field without subfields is invalid and creates an empty, useless type.
 
 **Custom type with nested fields:**
-\`\`\`xml
-<field name="address" type="Custom">
-  <field name="street" type="String"/>
-  <field name="city" type="String"/>
-  <field name="postalCode" type="String"/>
-</field>
+\`\`\`json
+{"name": "address", "type": "Custom", "subfields": [
+  {"name": "street", "type": "String"},
+  {"name": "city", "type": "String"},
+  {"name": "postalCode", "type": "String"}
+]}
 \`\`\`
 
-**List of custom objects** - combine \`type="Custom"\` with \`isList="true"\`:
-\`\`\`xml
-<field name="lineItems" type="Custom" isList="true">
-  <field name="productId" type="UUID"/>
-  <field name="quantity" type="Int"/>
-  <field name="unitPrice" type="Decimal"/>
-</field>
+**List of custom objects** - combine \`"type": "Custom"\` with \`"isList": true\`:
+\`\`\`json
+{"name": "lineItems", "type": "Custom", "isList": true, "subfields": [
+  {"name": "productId", "type": "UUID"},
+  {"name": "quantity", "type": "Int"},
+  {"name": "unitPrice", "type": "Decimal"}
+]}
 \`\`\`
 
 **Nested custom types** - subfields can themselves be Custom types:
-\`\`\`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>
+\`\`\`json
+{"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"}
+  ]}
+]}
 \`\`\`
 
 ## Common Mistakes
 
 - **Creating empty Custom fields**: Custom fields MUST have subfields that define their structure.
-  - 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**: "List" is not a valid 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**: "List" is not a valid 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"\`, \`user-input="true"\`
-  - Right: \`isOptional="true"\`, \`isGenerated="true"\`, \`isList="true"\`, \`isUserInput="true"\`
+  - Wrong: \`"optional": true\`, \`"generated": true\`, \`"list": true\`, \`"user-input": true\`
+  - Right: \`"isOptional": true\`, \`"isGenerated": true\`, \`"isList": true\`, \`"isUserInput": true\`
 
 ## Workflow
 
 1. **Understand the action** - What is the user/system trying to do?
 2. **Design the fields** - What information flows through this slice?
 3. **Propose before creating** - Get approval on the design first
-4. **Create the slice** - Run the command
+4. **Create the elements and flows** - Add fields and connect with flows
 5. **Verify** - \`eventmodeler show slice "<name>"\`
 6. **Connect** - Create flows to/from other slices as needed
 

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

@@ -44,7 +44,7 @@ eventmodeler list aggregates  # All aggregates (event groupings)
 eventmodeler list actors      # All actors (user/system roles)
 \`\`\`
 
-All \`list\` commands support \`--format xml|json\`.
+All \`list\` commands output JSON.
 
 ## Searching
 
@@ -59,9 +59,9 @@ Searches across all entity names: slices, events, commands, read models, aggrega
 \`\`\`bash
 eventmodeler show slice "<name>"
 \`\`\`
-Returns XML with:
+Returns JSON with:
 - All components in the slice (screens, commands, events, read-models, processors)
-- **Inline flow annotations** on each component showing \`<flows-from>\` and \`<flows-to>\` connections
+- **Flow annotations** on each component showing incoming and outgoing connections
 - Fields on each component with types and attributes
 - Information flow (which components connect to which)
 - **Inbound flows**: External elements flowing INTO this slice (with field mappings)
@@ -79,28 +79,39 @@ The inbound/outbound flows show cross-slice dependencies - crucial for understan
   - A read model assertion (expected state)
 
 Example scenario in slice output:
-\`\`\`xml
-<scenarios>
-  <scenario name="Successfully place order">
-    <given>
-      <event type="CustomerRegistered">customerId: "123"</event>
-    </given>
-    <when>
-      <command type="PlaceOrder">customerId: "123", items: [...]</command>
-    </when>
-    <then>
-      <event type="OrderPlaced">orderId: "456", customerId: "123"</event>
-    </then>
-  </scenario>
-  <scenario name="Cannot place order without items">
-    <when>
-      <command type="PlaceOrder">customerId: "123", items: []</command>
-    </when>
-    <then>
-      <error type="ValidationError">Order must contain at least one item</error>
-    </then>
-  </scenario>
-</scenarios>
+\`\`\`json
+{
+  "scenarios": [
+    {
+      "name": "Successfully place order",
+      "given": [
+        { "event": "CustomerRegistered", "fieldValues": { "customerId": "123" } }
+      ],
+      "when": {
+        "command": "PlaceOrder",
+        "commandFieldValues": { "customerId": "123", "items": ["..."] }
+      },
+      "then": {
+        "type": "events",
+        "events": [
+          { "event": "OrderPlaced", "fieldValues": { "orderId": "456", "customerId": "123" } }
+        ]
+      }
+    },
+    {
+      "name": "Cannot place order without items",
+      "when": {
+        "command": "PlaceOrder",
+        "commandFieldValues": { "customerId": "123", "items": [] }
+      },
+      "then": {
+        "type": "error",
+        "errorType": "ValidationError",
+        "errorMessage": "Order must contain at least one item"
+      }
+    }
+  ]
+}
 \`\`\`
 
 Reading scenarios helps understand:
@@ -114,7 +125,7 @@ Reading scenarios helps understand:
 eventmodeler show event "<name>"
 eventmodeler show command "<name>"
 \`\`\`
-Returns XML with the element's fields and connections.
+Returns JSON with the element's fields and connections.
 
 ### Show Read Models, Screens, and Processors
 \`\`\`bash