@domandigital/craft 0.20.2 → 0.20.4

package/design-review.schema.json

@@ -0,0 +1,421 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://unpkg.com/@domandigital/craft/design-review.schema.json",
+  "title": "design-review.json",
+  "description": "A review of a page, kept apart from the art direction: what was said, how well the visitor's problem is known, what was proposed, and the smallest change that answers it. The reasoning rules (observed needs something inspected, structural change needs reasons, nothing duplicated, unexamined widths stay unknown) are enforced by `craft direction review`; this schema only checks the shape.",
+  "type": "object",
+  "required": [
+    "version",
+    "subject",
+    "notes"
+  ],
+  "properties": {
+    "$schema": {
+      "type": "string"
+    },
+    "version": {
+      "const": 1
+    },
+    "subject": {
+      "type": "string",
+      "minLength": 1
+    },
+    "notes": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/note"
+      }
+    },
+    "context": {
+      "enum": [
+        "publication",
+        "protected-staging"
+      ],
+      "default": "publication",
+      "description": "Protected staging may reserve marked placeholders; outstanding requirements still block publication."
+    }
+  },
+  "$defs": {
+    "proposal": {
+      "type": "object",
+      "required": [
+        "change",
+        "step"
+      ],
+      "properties": {
+        "change": {
+          "type": "string",
+          "minLength": 1
+        },
+        "step": {
+          "enum": [
+            "copy",
+            "relocate",
+            "group",
+            "imagery",
+            "trust-placement",
+            "adjust-component",
+            "remove-redundancy",
+            "restructure",
+            "new-component"
+          ],
+          "description": "Smallest first. restructure and new-component are structural."
+        },
+        "adds": {
+          "type": "array",
+          "items": {
+            "enum": [
+              "carousel",
+              "javascript",
+              "dependency",
+              "animation",
+              "testimonial",
+              "cta",
+              "duplicate-content"
+            ]
+          },
+          "description": "Things that cost something. Each needs a reason."
+        },
+        "touches": {
+          "enum": [
+            "hero",
+            "logos",
+            "stats",
+            "cards",
+            "marquee",
+            "text",
+            "other",
+            "cta-band",
+            "footer-cta",
+            "pricing",
+            "testimonials",
+            "faq",
+            "process",
+            "features",
+            "team",
+            "contact"
+          ],
+          "description": "The section role it moves, removes or replaces."
+        },
+        "comparisons": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": [
+              "existing",
+              "samePurpose",
+              "because"
+            ],
+            "properties": {
+              "existing": {
+                "type": "string",
+                "minLength": 1
+              },
+              "samePurpose": {
+                "type": "boolean"
+              },
+              "because": {
+                "type": "string",
+                "minLength": 1
+              }
+            }
+          }
+        }
+      }
+    },
+    "note": {
+      "type": "object",
+      "required": [
+        "id",
+        "lens",
+        "observation",
+        "raisedBy",
+        "basis",
+        "evidence",
+        "recommend"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1
+        },
+        "page": {
+          "enum": [
+            "home",
+            "service",
+            "about",
+            "pricing",
+            "booking",
+            "contact",
+            "article",
+            "landing"
+          ]
+        },
+        "lens": {
+          "enum": [
+            "relevance",
+            "hierarchy",
+            "evidence",
+            "identity",
+            "action",
+            "disclosure",
+            "personality",
+            "differentiation",
+            "mobile"
+          ]
+        },
+        "observation": {
+          "type": "string",
+          "description": "What was said or seen, as it was said."
+        },
+        "raisedBy": {
+          "type": "string",
+          "description": "Who said it, or what found it."
+        },
+        "problem": {
+          "type": "string",
+          "description": "The visitor's problem underneath it, in the visitor's terms."
+        },
+        "basis": {
+          "enum": [
+            "observed",
+            "inferred",
+            "preference",
+            "unknown"
+          ],
+          "description": "observed needs something inspected; reported evidence alone makes it inferred."
+        },
+        "evidence": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": [
+              "kind",
+              "ref"
+            ],
+            "properties": {
+              "kind": {
+                "enum": [
+                  "screenshot",
+                  "rendered",
+                  "source",
+                  "measurement",
+                  "content",
+                  "audit",
+                  "stakeholder",
+                  "customer"
+                ]
+              },
+              "ref": {
+                "type": "string",
+                "minLength": 1
+              },
+              "viewport": {
+                "enum": [
+                  "mobile",
+                  "tablet",
+                  "desktop"
+                ]
+              },
+              "note": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "impact": {
+          "type": "string",
+          "description": "What the problem costs this visitor, about this client's job."
+        },
+        "appliesTo": {
+          "type": "array",
+          "items": {
+            "enum": [
+              "mobile",
+              "tablet",
+              "desktop"
+            ]
+          }
+        },
+        "suggested": {
+          "$ref": "#/$defs/proposal",
+          "description": "What the person proposed, judged apart from the problem."
+        },
+        "existing": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "What the page already has that bears on this."
+        },
+        "recommend": {
+          "type": "object",
+          "required": [
+            "class"
+          ],
+          "properties": {
+            "change": {
+              "type": "string",
+              "minLength": 1
+            },
+            "step": {
+              "enum": [
+                "copy",
+                "relocate",
+                "group",
+                "imagery",
+                "trust-placement",
+                "adjust-component",
+                "remove-redundancy",
+                "restructure",
+                "new-component"
+              ],
+              "description": "Smallest first. restructure and new-component are structural."
+            },
+            "adds": {
+              "type": "array",
+              "items": {
+                "enum": [
+                  "carousel",
+                  "javascript",
+                  "dependency",
+                  "animation",
+                  "testimonial",
+                  "cta",
+                  "duplicate-content"
+                ]
+              },
+              "description": "Things that cost something. Each needs a reason."
+            },
+            "touches": {
+              "enum": [
+                "hero",
+                "logos",
+                "stats",
+                "cards",
+                "marquee",
+                "text",
+                "other",
+                "cta-band",
+                "footer-cta",
+                "pricing",
+                "testimonials",
+                "faq",
+                "process",
+                "features",
+                "team",
+                "contact"
+              ],
+              "description": "The section role it moves, removes or replaces."
+            },
+            "class": {
+              "enum": [
+                "confirmed-correction",
+                "design-hypothesis",
+                "optional-refinement",
+                "no-change"
+              ],
+              "description": "no-change is a result, not a failure to answer."
+            },
+            "because": {
+              "type": "string"
+            },
+            "whyEnough": {
+              "type": "string"
+            },
+            "smaller": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "required": [
+                  "step",
+                  "whyNot"
+                ],
+                "properties": {
+                  "step": {
+                    "enum": [
+                      "copy",
+                      "relocate",
+                      "group",
+                      "imagery",
+                      "trust-placement",
+                      "adjust-component",
+                      "remove-redundancy",
+                      "restructure",
+                      "new-component"
+                    ]
+                  },
+                  "whyNot": {
+                    "type": "string"
+                  }
+                }
+              }
+            },
+            "validation": {
+              "type": "string"
+            },
+            "requires": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "required": [
+                  "what"
+                ],
+                "properties": {
+                  "what": {
+                    "type": "string"
+                  },
+                  "source": {
+                    "type": "string"
+                  },
+                  "phase": {
+                    "enum": [
+                      "implementation",
+                      "publication"
+                    ],
+                    "default": "implementation"
+                  },
+                  "placeholder": {
+                    "type": "string",
+                    "description": "Describe the explicitly marked placeholder used only in protected staging."
+                  },
+                  "kind": {
+                    "enum": [
+                      "asset",
+                      "fact"
+                    ],
+                    "default": "fact"
+                  }
+                }
+              }
+            },
+            "comparisons": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "required": [
+                  "existing",
+                  "samePurpose",
+                  "because"
+                ],
+                "properties": {
+                  "existing": {
+                    "type": "string",
+                    "minLength": 1
+                  },
+                  "samePurpose": {
+                    "type": "boolean"
+                  },
+                  "because": {
+                    "type": "string",
+                    "minLength": 1
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/dist/{chunk-TCMM3PTK.js → chunk-2276FJVN.js}

@@ -5,7 +5,7 @@ import {
 import {
   describeTypicality,
   loadNull
-} from "./chunk-YRXMPI3T.js";
+} from "./chunk-KQF44RI3.js";
 import {
   SOURCE_FILE,
   finish,
@@ -14,7 +14,7 @@ import {
   parseFlags,
   prepareReport,
   readPaths
-} from "./chunk-JLLULDVW.js";
+} from "./chunk-NQAYRK2K.js";
 import {
   toJson
 } from "./chunk-QIEDBL4J.js";

package/dist/{chunk-IJXDBYHH.js → chunk-GBDPNNC2.js}

@@ -4,13 +4,13 @@ import {
   formatDirectionMatches,
   summariseDirection,
   validateDirection
-} from "./chunk-2OBDCIVW.js";
+} from "./chunk-S3L7TEJF.js";
 import {
   loadNull
-} from "./chunk-YRXMPI3T.js";
+} from "./chunk-KQF44RI3.js";
 import {
   parseFlags
-} from "./chunk-JLLULDVW.js";
+} from "./chunk-NQAYRK2K.js";
 import {
   toJson
 } from "./chunk-QIEDBL4J.js";

package/dist/{chunk-YRXMPI3T.js → chunk-KQF44RI3.js}

@@ -3,7 +3,7 @@ import {
 } from "./chunk-OQXTQQAU.js";
 import {
   parseFlags
-} from "./chunk-JLLULDVW.js";
+} from "./chunk-NQAYRK2K.js";
 import {
   toJson
 } from "./chunk-QIEDBL4J.js";

package/dist/{chunk-JLLULDVW.js → chunk-NQAYRK2K.js}

@@ -379,6 +379,7 @@ Usage
   craft direction init [--snapshot <file | url>] [--client <name>] [--brief "<text>"] [--out <file>]
   craft direction validate [--snapshot <file | url>] [--page home] [--estate <estate.json>] [--direction <file>] [--strict] [--json]
   craft direction research [--brief "<who, where, what>"] [--visual]
+  craft direction review --notes <design-review.json> [--direction <file>] [--json]
   craft direction propose [--snapshot <file>] [--estate <estate.json | dir>] [--out <file>]
   craft null build --brief "<text>" --out <dir> [--runs 20] [--parallel 4] [--model <name>]
   craft null import <dir> --builder <name> --brief "<text>" [--out <dir>] [--model <name>]
@@ -501,6 +502,7 @@ var VALUE_FLAGS = {
   "--component": "component",
   "--competitor": "competitor",
   "--page": "page",
+  "--notes": "notes",
   "--builder": "builder",
   "--scheme": "scheme"
 };
@@ -631,7 +633,7 @@ async function briefFor(flags, cwd) {
     if (typeof brief === "string" && brief.trim()) return brief;
   } else if (flags.direction) throw new Error(`no such file: ${flags.direction}`);
   if (flags.null) {
-    const { loadNull } = await import("./cli-KJRHO3YO.js");
+    const { loadNull } = await import("./cli-AFKXDGUH.js");
     return loadNull(flags.null, cwd).brief;
   }
   return void 0;
@@ -657,37 +659,37 @@ async function compareWithCompetitor(flags, io) {
 function run(argv, io) {
   const [command, ...rest] = argv;
   if (command === "direction") {
-    return import("./cli-YQEVPRL5.js").then((m) => m.runDirection(rest, io));
+    return import("./cli-6AZVLNWL.js").then((m) => m.runDirection(rest, io));
   }
   if (command === "report" || command === "retrofit") {
-    return import("./cli-A6SNEMRL.js").then((m) => m.runReport(command, rest, io));
+    return import("./cli-7HKVVL3P.js").then((m) => m.runReport(command, rest, io));
   }
   if (command === "register") {
     return import("./cli-ZXDGVDYU.js").then((m) => m.runRegister(rest, io));
   }
   if (command === "estate") {
-    return import("./cli-DZGQOIBX.js").then((m) => m.runEstate(rest, io));
+    return import("./cli-QGJB6OUB.js").then((m) => m.runEstate(rest, io));
   }
   if (command === "null") {
-    return import("./cli-KJRHO3YO.js").then((m) => m.runNull(rest, io));
+    return import("./cli-AFKXDGUH.js").then((m) => m.runNull(rest, io));
   }
   if (command === "calibrate") {
-    return import("./cli-LVYTLT2A.js").then((m) => m.runCalibrate(rest, io));
+    return import("./cli-AK4EQHUF.js").then((m) => m.runCalibrate(rest, io));
   }
   if (command === "tells" && rest[0] === "harvest") {
-    return import("./cli-KJRHO3YO.js").then((m) => m.runHarvest(rest, io)).catch((error) => {
+    return import("./cli-AFKXDGUH.js").then((m) => m.runHarvest(rest, io)).catch((error) => {
       io.err(`craft: ${error.message}`);
       return 2;
     });
   }
   if (command === "phone-first") {
-    return import("./cli-FF2YDHA4.js").then((m) => m.runPhoneFirst(rest, io));
+    return import("./cli-6INEFJYN.js").then((m) => m.runPhoneFirst(rest, io));
   }
   if (command === "viewports") {
     return import("./viewports-cli-WWWWEBKI.js").then((m) => m.runViewports(rest, io));
   }
   if (command === "snapshot" || command === "audit") {
-    return import("./cli-U7PJQKZT.js").then((m) => m.runAudit(command, rest, io));
+    return import("./cli-OYVZOHHV.js").then((m) => m.runAudit(command, rest, io));
   }
   if (!command || command === "help" || command === "--help" || command === "-h") {
     io.out(HELP);