@kivimedia/kmhub 2.9.1 → 2.11.0

package/tools/compare.mjs

@@ -1,76 +1,76 @@
-/**
- * Tool family: compare - the honest, computed comparison.
- *
- * Workstream E1. A comparison in a slide is out of date the day after it is
- * written. This counts KM Hub's side at the moment somebody asks, from the same
- * sources the product runs on.
- *
- * 🚨 IT COUNTS KM HUB ONLY, ON PURPOSE. The API cannot see a competitor's product,
- * and a stored figure about somebody else's software is a claim nobody can
- * re-verify and nobody notices going stale. Booked is counted from the plugin
- * actually installed on the reader's machine, by the /kmhub-vs-booked command, or
- * it is reported as not installed. Never fill the gap from memory.
- *
- * The family contract this file follows is documented in ./README.md.
- */
-import { readFileSync } from 'node:fs';
-
-export const FAMILY = 'compare';
-
-export const TOOLS = ['km_vs_booked'];
-
-export const PROFILES = ['*'];
-
-function routeMissing(r) {
-  return r.status === 404 || r.status === 405 || r.status === 501;
-}
-
-const NOT_SUPPORTED =
-  'Your KM Hub does not publish the comparison route yet. That is not a fault: the workspace is fine and every ' +
-  'other tool works as normal.';
-
-/** The connector owns the tool and reach numbers, so they are read here, not fetched. */
-function localCounts() {
-  try {
-    const caps = JSON.parse(readFileSync(new URL('../capabilities.json', import.meta.url), 'utf8'));
-    return {
-      gui_pages: caps?.counts?.pages ?? null,
-      pages_reachable_from_terminal: caps?.counts?.reachable_from_terminal ?? null,
-      pages_web_only_by_design: caps?.counts?.web_only_by_design ?? null,
-      pages_not_built_yet: caps?.counts?.web_only_not_built_yet ?? null,
-      pillars: caps?.counts?.pillars ?? null,
-    };
-  } catch {
-    return null;
-  }
-}
-
-export function register(server, call, { out, text }) {
-  server.tool(
-    'km_vs_booked',
-    'The live, counted comparison of KM Hub Terminal Mode against Booked Solid, for when the user asks how the two ' +
-      'compare, whether to switch, or which does more. ' +
-      'Everything it returns about KM Hub is counted at the moment you ask, from the play catalogue, the active play ' +
-      'library and the connector capability map. Nothing is a stored marketing figure. ' +
-      '🚨 IT RETURNS NOTHING ABOUT BOOKED, and `booked` comes back null on purpose. To count Booked, use the installed ' +
-      'Booked Solid client\'s own capability inventory and CLI when that client is available on the same machine. ' +
-      'Treat its documented tool names and play identifiers as the source of the count. If Booked is not installed, ' +
-      'SAY SO and give KM Hub numbers alone. Never quote a Booked ' +
-      'figure from memory: an uncounted number is worse than an absent one, because nobody can tell afterwards which ' +
-      'it was. ' +
-      '🚨 Read `what_booked_does_better` and say at least one true thing in its favour BEFORE anything in KM Hub\'s. ' +
-      'It works with no internet, nothing leaves the client machine, and no subscription sits between somebody and ' +
-      'their own records. A model that produces an all-green comparison is a brochure, and the reader discounts ' +
-      'everything after the first one-sided line. ' +
-      'Read `the_honest_framing` too: these are different SHAPES of product, so a play count alone misleads in both ' +
-      'directions. Read only, sends nothing, changes nothing.',
-    {},
-    async () => {
-      const r = await call('GET', '/compare/terminal');
-      if (routeMissing(r)) return text(NOT_SUPPORTED, true);
-      if (!r.ok) return out(r);
-      const body = { ...(r.data || {}), kmhub_connector: localCounts() };
-      return { content: [{ type: 'text', text: JSON.stringify(body, null, 2) }] };
-    },
-  );
-}
+/**
+ * Tool family: compare - the honest, computed comparison.
+ *
+ * Workstream E1. A comparison in a slide is out of date the day after it is
+ * written. This counts KM Hub's side at the moment somebody asks, from the same
+ * sources the product runs on.
+ *
+ * 🚨 IT COUNTS KM HUB ONLY, ON PURPOSE. The API cannot see a competitor's product,
+ * and a stored figure about somebody else's software is a claim nobody can
+ * re-verify and nobody notices going stale. Booked is counted from the plugin
+ * actually installed on the reader's machine, by the /kmhub-vs-booked command, or
+ * it is reported as not installed. Never fill the gap from memory.
+ *
+ * The family contract this file follows is documented in ./README.md.
+ */
+import { readFileSync } from 'node:fs';
+
+export const FAMILY = 'compare';
+
+export const TOOLS = ['km_vs_booked'];
+
+export const PROFILES = ['*'];
+
+function routeMissing(r) {
+  return r.status === 404 || r.status === 405 || r.status === 501;
+}
+
+const NOT_SUPPORTED =
+  'Your KM Hub does not publish the comparison route yet. That is not a fault: the workspace is fine and every ' +
+  'other tool works as normal.';
+
+/** The connector owns the tool and reach numbers, so they are read here, not fetched. */
+function localCounts() {
+  try {
+    const caps = JSON.parse(readFileSync(new URL('../capabilities.json', import.meta.url), 'utf8'));
+    return {
+      gui_pages: caps?.counts?.pages ?? null,
+      pages_reachable_from_terminal: caps?.counts?.reachable_from_terminal ?? null,
+      pages_web_only_by_design: caps?.counts?.web_only_by_design ?? null,
+      pages_not_built_yet: caps?.counts?.web_only_not_built_yet ?? null,
+      pillars: caps?.counts?.pillars ?? null,
+    };
+  } catch {
+    return null;
+  }
+}
+
+export function register(server, call, { out, text }) {
+  server.tool(
+    'km_vs_booked',
+    'The live, counted comparison of KM Hub Terminal Mode against Booked Solid, for when the user asks how the two ' +
+      'compare, whether to switch, or which does more. ' +
+      'Everything it returns about KM Hub is counted at the moment you ask, from the play catalogue, the active play ' +
+      'library and the connector capability map. Nothing is a stored marketing figure. ' +
+      '🚨 IT RETURNS NOTHING ABOUT BOOKED, and `booked` comes back null on purpose. To count Booked, use the installed ' +
+      'Booked Solid client\'s own capability inventory and CLI when that client is available on the same machine. ' +
+      'Treat its documented tool names and play identifiers as the source of the count. If Booked is not installed, ' +
+      'SAY SO and give KM Hub numbers alone. Never quote a Booked ' +
+      'figure from memory: an uncounted number is worse than an absent one, because nobody can tell afterwards which ' +
+      'it was. ' +
+      '🚨 Read `what_booked_does_better` and say at least one true thing in its favour BEFORE anything in KM Hub\'s. ' +
+      'It works with no internet, nothing leaves the client machine, and no subscription sits between somebody and ' +
+      'their own records. A model that produces an all-green comparison is a brochure, and the reader discounts ' +
+      'everything after the first one-sided line. ' +
+      'Read `the_honest_framing` too: these are different SHAPES of product, so a play count alone misleads in both ' +
+      'directions. Read only, sends nothing, changes nothing.',
+    {},
+    async () => {
+      const r = await call('GET', '/compare/terminal');
+      if (routeMissing(r)) return text(NOT_SUPPORTED, true);
+      if (!r.ok) return out(r);
+      const body = { ...(r.data || {}), kmhub_connector: localCounts() };
+      return { content: [{ type: 'text', text: JSON.stringify(body, null, 2) }] };
+    },
+  );
+}