@instafy/cli 0.2.2 → 0.2.4

package/dist/bind/src/starters/ranked/app.js

@@ -0,0 +1,166 @@
+/* Ranked starter: a top-N list ("best X", "top 10"). One layout at every width; the ranking is the order.
+ * You design the content in data.json; keep theme.css and site.js. Restyle only when asked.
+ *
+ * data.json:
+ *   title, lede     the page title and its one-line answer (the verdict, and the biggest unknown if there is one)
+ *   basis           how it is ranked, one line: "Ranked by safety reviews, then price."
+ *   filter (only for a constraint the person stated): {key: "price", max: 300, label: "Under $300"}
+ *   items: [{ref: "option:a", rank, name, why (one short line), badge?, specs: [fact] (at most 3), price?: fact,
+ *            store?: {name, url, readable}, details?: [{label, fact}], sources?: [{name, url}]}]
+ *   badge: only for a label the person must notice. "Our pick" only when it is your own pick and "why" says why;
+ *          a source's pick or award for a row is that row's badge, saying whose ("BabyGearLab's top pick",
+ *          "BabyGearLab: best budget"), never a "Details" toggle. Nothing is added by itself.
+ *   price: the price as a fact (not in specs), with "asof" when the source dates it; a live check replaces it. A
+ *          review site's price is its list price: "list": true, so the row says "list price" and never reads as the
+ *          store's price now. When every price comes from one source on one date, one line under the list names the
+ *          source once ("List prices on BabyGearLab ↗ · seen 5 Aug"), and "Sources" does not name it again.
+ *   details: only facts the row does not already show.
+ *   unchecked: ["what was not checked", …]
+ *   fact: {"v": "$145", "src": "Example Store", "url": "https://…", "date": "2026-10-17", "est": false}
+ * The item shape is the compare starter's, so the same items work there ("Compare these", only when asked).
+ * Query: ?show=all&open=<slug>. Rows: id="row-<slug>", data-ref="<ref>".
+ * SPDX-License-Identifier: AGPL-3.0-only */
+(function () {
+  "use strict";
+  var h = site.h;
+
+  site.start({
+    data: "data.json",
+    state: function (data) { return { show: data.filter ? "fit" : "all", open: "" }; },
+    select: function (ref) { return { open: site.slug(ref) }; },
+    render: render
+  });
+
+  function priceOf(item) { return site.live(item.ref, "price") || item.price || null; }
+  function valueFor(item, key) {
+    if (key === "price") return priceOf(item);
+    var d = (item.details || []).filter(function (x) { return x.key === key; })[0];
+    return d ? d.fact : null;
+  }
+  function fits(data, item) {
+    var f = data.filter;
+    if (!f) return true;
+    var n = site.num(valueFor(item, f.key));
+    if (n == null) return true;
+    return (f.max == null || n <= f.max) && (f.min == null || n >= f.min);
+  }
+  function render(data, st) {
+    site.head(data); // title, lede and the basis line ("Ranked by …") come first, before any button
+    var items = (data.items || []).slice().sort(function (a, b) { return (a.rank || 0) - (b.rank || 0); });
+    var shown = st.show === "all" ? items : items.filter(function (i) { return fits(data, i); });
+    var hidden = items.length - shown.length;
+    var priced = items.some(function (i) { return i.price || i.store; });
+    var shared = sharedPrice(items);
+
+    var bar = document.getElementById("bar");
+    bar.replaceChildren();
+    if (data.filter) {
+      bar.appendChild(site.seg("show", "Show", [{ value: "all", label: "All" }, { value: "fit", label: data.filter.label }], st.show,
+        function (v) { site.setState({ show: v }); }));
+    }
+    if (priced) site.append(bar, site.checkAll(items));
+    bar.hidden = !bar.firstChild;
+
+    var list = document.getElementById("list");
+    list.replaceChildren();
+    if (!items.length) {
+      list.appendChild(site.empty("Nothing ranked yet.", null, "Ask in chat to add some."));
+    } else {
+      var wrap = h("div", { "class": "stack" });
+      var stores = priced ? site.priceNotice(items) : null; // the reason a store can't be read, said once
+      // every store refuses checks from the start and one line already names the list prices: that line says where
+      // today's price is ("Open a store for today's price."), instead of a box about checks nobody was offered
+      var inline = !!(shared && stores && site.storesBlocked(items));
+      if (inline) stores = null;
+      wrap.appendChild(h("ol", { "class": "list ranked" }, shown.map(function (item) { return row(item, st, priced, shared); })));
+      if (hidden > 0) {
+        wrap.appendChild(h("p", { "class": "cap" }, hidden + " hidden · ",
+          h("button", { "class": "link-btn", text: "Show all", attrs: { type: "button", "data-key": "show-all" }, on: { click: function () { site.setState({ show: "all" }); } } })));
+      }
+      if (shared) wrap.appendChild(sharedLine(shared, inline));
+      if (stores) wrap.appendChild(stores);
+      list.appendChild(wrap);
+    }
+
+    var sources = [];
+    items.forEach(function (i) {
+      sources = sources.concat(site.sourcesOf((i.specs || []).concat([i.price])));
+      (i.sources || []).forEach(function (s) { sources.push(s); });
+    });
+    // the line under the list already names the prices' source: "Sources" does not say it a second time
+    if (shared) sources = sources.filter(function (s) { return s.name !== shared.src && !(site.host(s.url) && site.host(s.url) === site.host(shared.url)); });
+    // the footer belongs to a list: an empty page has nothing to confirm
+    site.notes(items.length ? data.unchecked : [], items.length ? sources : []);
+  }
+
+  /** The price fact every priced row shares (same source and date), else null. */
+  function sharedPrice(items) {
+    var facts = items.map(function (i) { return i.price; }).filter(Boolean);
+    if (facts.length < 2) return null;
+    var key = function (f) { return f && f.src && !f.est && f.v != null ? [f.src, f.asof || f.date || "", f.list ? "list" : ""].join("|") : null; };
+    var k = key(facts[0]);
+    return k && facts.every(function (f) { return key(f) === k; }) ? facts[0] : null;
+  }
+  /** "List prices on BabyGearLab ↗ · seen 5 Aug" ("Prices: Store ↗ · …" for a store's own), said once under the
+   * list (" · may have changed" when it is old; "Open a store for today's price." when no store can be checked, as its own sentence, so no wrapped line starts with a dot). */
+  function sharedLine(f, openStore) {
+    var when = site.seen(f);
+    return h("p", { "class": "cap shared-line" }, f.list ? "List prices on " : "Prices: ", site.link(f.url, f.src), when ? [" · ", h("span", { "class": "nowrap", text: when })] : "",
+      site.old(f, true) ? " · may have changed" : "", openStore ? ". Open a store for today's price." : "");
+  }
+  /** Details holds only what the row does not already show, and a source link once: a page on a site the row's
+   * facts already link to is not repeated. */
+  function extras(item) {
+    var onRow = {};
+    (item.specs || []).concat([item.price]).forEach(function (f) { var v = site.valueText(f); if (v) onRow[v.toLowerCase()] = 1; });
+    var facts = (item.details || []).filter(function (d) { var v = site.valueText(d.fact); return v && !onRow[v.toLowerCase()]; }).slice(0, 8);
+    var linked = {};
+    (item.specs || []).concat([item.price], facts.map(function (d) { return d.fact; })).forEach(function (f) {
+      if (f && f.url) { linked[f.url] = 1; if (site.host(f.url)) linked["@" + site.host(f.url)] = 1; }
+    });
+    var sources = (item.sources || []).filter(function (s) { return s && !linked[s.url] && !linked["@" + site.host(s.url)]; });
+    return { facts: facts, sources: sources };
+  }
+  function hasMore(item) { var x = extras(item); return !!(x.facts.length || x.sources.length); }
+
+  function row(item, st, priced, shared) {
+    var open = st.open === site.slug(item.ref);
+    // a badge only when the data names one ("Our pick" when the reason is in "why"; "BabyGearLab's top pick" when a
+    // source picked it). Never added by itself.
+    var badge = item.badge || null;
+    var specs = (item.specs || []).slice(0, 3).map(function (f) {
+      var v = site.valueText(f);
+      return v && !f.src && !f.est ? v + ", not checked" : v;
+    }).filter(Boolean);
+    var live = site.live(item.ref, "price");
+    var details = hasMore(item) ? h("button", {
+      "class": "btn quiet more-btn",
+      text: open ? "Hide details" : "Details",
+      attrs: { type: "button", "aria-expanded": open ? "true" : "false", "aria-label": (open ? "Hide details for " : "Details for ") + item.name, "data-key": "details:" + item.ref },
+      on: { click: function () { site.setState({ open: open ? "" : site.slug(item.ref) }); } }
+    }) : null;
+    return h("li", { "class": "row", attrs: site.rowAttrs(item.ref) },
+      h("span", { "class": "rank", text: item.rank, attrs: { "aria-hidden": "true" } }),
+      h("div", { "class": "row-body" },
+        // "Details" stays at the end of the first line even when a badge wraps under the name
+        h("div", { "class": "name-line" },
+          h("div", { "class": "name-wrap" }, h("span", { "class": "name" }, h("span", { "class": "sr-only", text: "Number " + item.rank + ": " }), item.name),
+            badge ? h("span", { "class": "badge", text: badge }) : null), details),
+        item.why ? h("p", { "class": "why", text: item.why }) : null,
+        specs.length ? h("p", { "class": "cap", text: specs.join(" · ") }) : null,
+        // every priced row has the same price line, with or without a store
+        priced ? site.trust(live || item.price || null, { label: "Price", price: true, ref: item.ref, intent: "read_offer", store: item.store, seed: item.price || null, shared: !live && !!shared && !!item.price }) : null,
+        open && hasMore(item) ? more(item) : null));
+  }
+
+  function more(item) {
+    var x = extras(item);
+    return h("div", { "class": "more" },
+      x.facts.length ? h("dl", { "class": "facts" }, x.facts.map(function (d) {
+        return h("div", null, h("dt", { text: d.label }), h("dd", null, site.trust(d.fact)));
+      })) : null,
+      x.sources.length ? h("p", { "class": "cap" }, "Sources: ", x.sources.map(function (s, i) {
+        return [i ? ", " : "", site.link(s.url, s.name)];
+      })) : null);
+  }
+})();

package/dist/bind/src/starters/ranked/bound.json

@@ -0,0 +1,26 @@
+{
+  "version": 1,
+  "title": "Top three options",
+  "intents": {
+    "read_offer": {
+      "label": "Check price",
+      "describe": "Read one option's price from its store page (schema.org data). The URL comes from data.json, never from the click.",
+      "executor": "script",
+      "handler": "handlers/read_offer.mjs",
+      "params": {
+        "type": "object",
+        "required": ["ref"],
+        "additionalProperties": false,
+        "properties": {
+          "ref": { "type": "string", "maxLength": 80, "pattern": "^[a-z][a-z0-9-]{0,23}:[a-z0-9-]{1,50}$" }
+        }
+      },
+      "target": { "records": "data/records/read_offer.json" },
+      "lanes": ["local"],
+      "pending": "item",
+      "cooldown_s": 10,
+      "timeout_s": 45
+    }
+  },
+  "results": { "files": ["data/records/read_offer.json"], "poll_s": 3, "sse": true }
+}

package/dist/bind/src/starters/ranked/data.json

@@ -0,0 +1,142 @@
+{
+  "title": "Top three options",
+  "lede": "Option A is the best all-round pick. Option C costs least, but its price was not checked.",
+  "basis": "Ranked by review scores, then price.",
+  "items": [
+    {
+      "ref": "option:option-a",
+      "rank": 1,
+      "name": "Option A",
+      "why": "Best reviewed, and the lightest",
+      "specs": [
+        {
+          "v": "8.9 oz",
+          "src": "Maker",
+          "url": "https://example.com/option-a/specs",
+          "date": "2026-10-17"
+        },
+        {
+          "v": "2-year warranty",
+          "src": "Maker",
+          "url": "https://example.com/option-a/warranty",
+          "date": "2026-10-17"
+        }
+      ],
+      "price": {
+        "v": "$145",
+        "src": "Example Store",
+        "url": "https://example.com/option-a",
+        "date": "2026-10-17"
+      },
+      "store": {
+        "name": "Example Store",
+        "url": "https://example.com/option-a",
+        "readable": true
+      },
+      "details": [
+        {
+          "label": "Review score",
+          "fact": {
+            "v": "4.6 of 5",
+            "src": "Example Reviews",
+            "url": "https://example.com/reviews/option-a",
+            "date": "2026-10-16"
+          }
+        },
+        {
+          "label": "Colours",
+          "fact": {
+            "v": "Black, white",
+            "src": "Maker",
+            "url": "https://example.com/option-a/specs",
+            "date": "2026-10-17"
+          }
+        }
+      ],
+      "sources": [
+        {
+          "name": "Example Reviews",
+          "url": "https://example.com/reviews/option-a"
+        }
+      ],
+      "badge": "Our pick"
+    },
+    {
+      "ref": "option:option-b",
+      "rank": 2,
+      "name": "Option B",
+      "why": "Nearly as good, a little heavier",
+      "specs": [
+        {
+          "v": "about 9.5 oz",
+          "n": 9.5,
+          "est": true
+        },
+        {
+          "v": "1-year warranty",
+          "src": "Maker",
+          "url": "https://example.com/option-b/warranty",
+          "date": "2026-10-17"
+        }
+      ],
+      "price": {
+        "v": "$139",
+        "src": "Example Store",
+        "url": "https://example.com/option-b",
+        "date": "2026-10-17"
+      },
+      "store": {
+        "name": "Example Store",
+        "url": "https://example.com/option-b",
+        "readable": true
+      },
+      "details": [
+        {
+          "label": "Review score",
+          "fact": {
+            "v": "4.4 of 5",
+            "src": "Example Reviews",
+            "url": "https://example.com/reviews/option-b",
+            "date": "2026-10-16"
+          }
+        }
+      ]
+    },
+    {
+      "ref": "option:option-c",
+      "rank": 3,
+      "name": "Option C",
+      "why": "The lowest price, fewer reviews",
+      "specs": [
+        {
+          "v": "9.8 oz",
+          "src": "Maker",
+          "url": "https://example.com/option-c/specs",
+          "date": "2026-10-17"
+        }
+      ],
+      "price": {
+        "note": "the store blocks price checks"
+      },
+      "store": {
+        "name": "Other Store",
+        "url": "https://example.org/option-c",
+        "readable": false
+      },
+      "details": [
+        {
+          "label": "Review score",
+          "fact": {
+            "v": "4.1 of 5",
+            "src": "Example Reviews",
+            "url": "https://example.com/reviews/option-c",
+            "date": "2026-10-16"
+          }
+        }
+      ]
+    }
+  ],
+  "unchecked": [
+    "Check Option B's weight on the maker's spec sheet before you buy"
+  ]
+}

package/dist/bind/src/starters/ranked/index.html

@@ -0,0 +1,23 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover">
+<meta name="theme-color" content="#FFFFFF" media="(prefers-color-scheme: light)">
+<meta name="theme-color" content="#141414" media="(prefers-color-scheme: dark)">
+<title>Top picks</title>
+<link rel="stylesheet" href="theme.css">
+<!-- Restyle only when asked: override --if-* tokens in a <style> here, after theme.css. -->
+</head>
+<body>
+<main class="page">
+  <header class="head"><h1 class="title" id="title">Top picks</h1><p class="lede" id="lede"></p></header>
+  <div class="bar" id="bar" hidden></div>
+  <section id="list"></section>
+  <footer class="notes" id="notes" hidden></footer>
+</main>
+<script src="__bind/client.js"></script>
+<script src="site.js"></script>
+<script src="app.js"></script>
+</body>
+</html>