@mafianacho/nacholens 0.0.0-stage → 0.3.0

package/models/demo-shop/changes.auto.json

@@ -0,0 +1,121 @@
+{
+  "title": "show shipping status on the order list",
+  "summary": "Generated from git diff: 4 changed steps, 3 changed components (browser, api, shipping), 2 changed files outside the model, 1 ignored files.",
+  "ref": "demo/shop (built by nacholens demo) 030bf9c..e9f3087",
+  "components": [
+    {
+      "id": "browser",
+      "change": "modified",
+      "note": "End of a changed step: list-orders/response"
+    },
+    {
+      "id": "api",
+      "change": "modified",
+      "note": "End of a changed step: list-orders/shipping"
+    },
+    {
+      "id": "shipping",
+      "change": "added",
+      "note": "Component evidence code changed: api.js:12"
+    }
+  ],
+  "steps": [
+    {
+      "useCase": "list-orders",
+      "step": "shipping",
+      "change": "added",
+      "note": "Evidence code added: api.js:12-18"
+    },
+    {
+      "useCase": "list-orders",
+      "step": "shape",
+      "change": "modified",
+      "note": "Evidence code changed: api.js:65"
+    },
+    {
+      "useCase": "list-orders",
+      "step": "response",
+      "change": "modified",
+      "note": "Evidence code changed: api.js:65, public/app.js:16"
+    },
+    {
+      "useCase": "place-order",
+      "step": "insert",
+      "change": "modified",
+      "note": "Evidence code changed: api.js:73"
+    }
+  ],
+  "details": [
+    {
+      "component": "api",
+      "kind": "part",
+      "id": "track",
+      "change": "added",
+      "note": "Evidence code added: api.js:12-18"
+    },
+    {
+      "component": "api",
+      "kind": "wire",
+      "id": "session>orders-post",
+      "change": "modified",
+      "note": "Evidence code changed: api.js:73"
+    },
+    {
+      "component": "api",
+      "kind": "wire",
+      "id": "orders-get>track",
+      "change": "modified",
+      "note": "Evidence code changed: api.js:64"
+    },
+    {
+      "component": "api",
+      "kind": "wire",
+      "id": "track>fetch-ext",
+      "change": "added",
+      "note": "Evidence code added: api.js:15"
+    },
+    {
+      "component": "api",
+      "kind": "wire",
+      "id": "orders-post>db-module",
+      "change": "modified",
+      "note": "Evidence code changed: api.js:73"
+    },
+    {
+      "component": "shipping",
+      "kind": "endpoint",
+      "id": "track",
+      "change": "modified",
+      "note": "Evidence code changed: api.js:15-16"
+    }
+  ],
+  "unmapped": [
+    {
+      "file": "public/format.js",
+      "category": "code",
+      "status": "modified",
+      "lines": "3 (1 hunk)",
+      "hint": "Not in the evidence of any use-case step: add the path to the model, or confirm the change is unrelated"
+    },
+    {
+      "file": "public/styles.css",
+      "category": "style",
+      "status": "modified",
+      "lines": "5 (1 hunk)",
+      "hint": "Not in the evidence of any use-case step: add the path to the model, or confirm the change is unrelated"
+    }
+  ],
+  "ignored": [
+    {
+      "file": "README.md",
+      "reason": "docs"
+    }
+  ],
+  "generated": {
+    "by": "nacholens diff",
+    "base": "030bf9c56ec32a5a14c831cc73c8915a1b0a1eba",
+    "head": "e9f308776fd0d64ac269e02a5581415c2dfabf43",
+    "modelCommit": "e9f308776fd0d64ac269e02a5581415c2dfabf43",
+    "lineTranslation": false
+  }
+}

package/models/demo-shop/changes.example.json

@@ -0,0 +1,16 @@
+{
+  "title": "Order list shows shipping status",
+  "summary": "The order list now asks the shipping tracker for the status of each order and shows it next to the order. Creating an order also generates a tracking code. (Hand-written example of the change-metadata format; nacholens diff produces the same shape automatically.)",
+  "ref": "demo/shop v1 → v2 (api.js, public/app.js)",
+  "components": [
+    { "id": "api", "change": "modified", "note": "New trackShipping() calls the tracker for every order that has a tracking code; new orders get a TRK- code." },
+    { "id": "browser", "change": "modified", "note": "The list renders a readable shipping status per order." },
+    { "id": "shipping", "change": "added", "note": "New third-party dependency: GET /track per order." }
+  ],
+  "steps": [
+    { "useCase": "list-orders", "step": "shipping", "change": "added", "note": "New call: one tracker lookup per order with a tracking code, run in parallel. A failure degrades to \"unknown\"." },
+    { "useCase": "list-orders", "step": "shape", "change": "modified", "note": "Each order now carries a shipping field." },
+    { "useCase": "list-orders", "step": "response", "change": "modified", "note": "The page prints the status next to each order." },
+    { "useCase": "place-order", "step": "insert", "change": "modified", "note": "The inserted row includes a generated tracking code." }
+  ]
+}

package/models/demo-shop/intent.example.json

@@ -0,0 +1,75 @@
+{
+  "schemaVersion": 1,
+  "title": "Show the delivery status in the order list",
+  "source": "Example planning note (demo shop)",
+  "expectations": [
+    {
+      "id": "ship-lookup",
+      "text": "The order list asks the carrier for the status and shows it",
+      "useCase": "list-orders",
+      "check": {
+        "type": "step",
+        "match": {
+          "kind": "call",
+          "to": "shipping"
+        }
+      }
+    },
+    {
+      "id": "ship-fail-soft",
+      "text": "The order list still shows when the carrier lookup fails",
+      "useCase": "list-orders",
+      "check": {
+        "type": "step",
+        "match": {
+          "text": "failed lookup|instead of failing"
+        }
+      }
+    },
+    {
+      "id": "login-first",
+      "text": "The order list reads orders only after checking the sign-in (session)",
+      "useCase": "list-orders",
+      "check": {
+        "type": "order",
+        "first": {
+          "table": "sessions",
+          "op": "read"
+        },
+        "then": {
+          "table": "orders",
+          "op": "read"
+        }
+      }
+    },
+    {
+      "id": "admin-only",
+      "text": "Only admins can see the sales report",
+      "useCase": "sales-report",
+      "check": {
+        "type": "order",
+        "first": {
+          "text": "admin"
+        },
+        "then": {
+          "to": "analytics"
+        }
+      }
+    },
+    {
+      "id": "address-check",
+      "text": "Creating an order validates the delivery address",
+      "useCase": "place-order",
+      "check": {
+        "type": "step",
+        "match": {
+          "text": "address"
+        }
+      }
+    },
+    {
+      "id": "ship-wording",
+      "text": "Delivery status words are easy for customers to understand"
+    }
+  ]
+}