@sonordev/contracts 2.1.1 → 2.3.0

package/dist/proposal-sitemap.js

@@ -0,0 +1,212 @@
+'use strict';
+
+// src/contracts/proposal-sitemap.ts
+var PROPOSAL_SITEMAP_CONTRACT_VERSION = 1;
+function isRecord(v) {
+  return !!v && typeof v === "object" && !Array.isArray(v);
+}
+function list(v) {
+  return Array.isArray(v) ? v : [];
+}
+function sitemapCount(v) {
+  const n = typeof v === "number" ? v : typeof v === "string" && v.trim() !== "" ? Number(v) : NaN;
+  return Number.isFinite(n) && n >= 0 ? Math.floor(n) : void 0;
+}
+function sitemapPageKey(slug) {
+  if (typeof slug !== "string") return void 0;
+  let s = slug.trim().toLowerCase();
+  if (!s) return void 0;
+  s = s.replace(/^[a-z][a-z0-9+.-]*:\/\/[^/]*/, "");
+  s = s.split(/[?#]/)[0];
+  if (!s.startsWith("/")) s = `/${s}`;
+  s = s.replace(/\/{2,}/g, "/").replace(/\/+$/, "");
+  return s || "/";
+}
+var EXISTING_STATUSES = /* @__PURE__ */ new Set(["rebuild", "optimize", "migrate"]);
+function countSitemapPlan(props) {
+  const p = isRecord(props) ? props : {};
+  const seen = /* @__PURE__ */ new Set();
+  let existing = 0;
+  let added = 0;
+  const take = (node) => {
+    if (!isRecord(node)) return false;
+    const key = sitemapPageKey(node.slug);
+    if (key !== void 0) {
+      if (seen.has(key)) return false;
+      seen.add(key);
+    }
+    if (typeof node.status === "string" && EXISTING_STATUSES.has(node.status)) existing++;
+    else added++;
+    return true;
+  };
+  let core = 0;
+  for (const node of list(p.corePages)) if (take(node)) core++;
+  let architecture = 0;
+  for (const pillar of list(p.pages)) {
+    if (take(pillar)) architecture++;
+    if (!isRecord(pillar)) continue;
+    for (const child of list(pillar.children)) if (take(child)) architecture++;
+  }
+  const articles = isRecord(p.blog) ? sitemapCount(p.blog.count) ?? 0 : 0;
+  return {
+    core,
+    architecture,
+    articles,
+    full: core + architecture + articles,
+    existing: existing + articles,
+    added
+  };
+}
+function sitemapTransformation(props) {
+  const p = isRecord(props) ? props : {};
+  const t = p.transformation;
+  if (!isRecord(t)) return null;
+  const before = sitemapCount(isRecord(t.before) ? t.before.count : void 0);
+  if (before === void 0) return null;
+  const planned = countSitemapPlan(p).architecture;
+  const after = sitemapCount(isRecord(t.after) ? t.after.count : void 0) ?? (planned > 0 ? planned : sitemapCount(p.totalPages) ?? 0);
+  if (after <= 0 || after <= before) return null;
+  return { before, after };
+}
+var SITEMAP_LABEL_MAX = 40;
+var LABEL_KEYS = ["architecture", "pillar", "child"];
+function normalizeSitemapLabels(raw) {
+  if (!isRecord(raw)) return void 0;
+  const out = {};
+  for (const key of LABEL_KEYS) {
+    const v = raw[key];
+    if (typeof v !== "string") continue;
+    if (/[\u0000-\u0008\u000a-\u001f\u007f<>]/.test(v)) continue;
+    const s = v.replace(/\s+/g, " ").trim();
+    if (s && s.length <= SITEMAP_LABEL_MAX) out[key] = s;
+  }
+  return Object.keys(out).length ? out : void 0;
+}
+var CLAIM_RE = /(?<![\d$.,/])(\d{1,5})(?![\d.,/%])(?:[\s-]+(?:[a-z'’&]+[\s-]+){0,3}?)(pages?|urls?)\b/gi;
+var CAPITALIZED_BEFORE_RE = /(?<![\w'’])[A-Z][\w'’.&-]*\s+$/;
+function numberInName(before) {
+  const m = before.match(CAPITALIZED_BEFORE_RE);
+  if (!m) return false;
+  const lead = before.slice(0, m.index);
+  if (/\n\s*$/.test(lead)) return false;
+  const trimmed = lead.replace(/\s+$/, "");
+  return trimmed !== "" && !/[.!?:]$/.test(trimmed);
+}
+function findPageCountClaims(text) {
+  if (typeof text !== "string" || !text) return [];
+  const claims = [];
+  for (const m of text.matchAll(CLAIM_RE)) {
+    if (numberInName(text.slice(0, m.index ?? 0))) continue;
+    claims.push({
+      value: Number(m[1]),
+      unit: m[2].toLowerCase().startsWith("url") ? "url" : "page",
+      text: m[0],
+      index: m.index ?? 0
+    });
+  }
+  return claims;
+}
+function claimFields(section) {
+  const props = isRecord(section.props) ? section.props : {};
+  switch (section.type) {
+    case "GlassHero": {
+      const fields = [["title", props.title], ["subtitle", props.subtitle]];
+      list(props.stats).forEach((st, i) => {
+        if (!isRecord(st)) return;
+        const value = typeof st.value === "number" || typeof st.value === "string" ? String(st.value) : "";
+        fields.push([`stats[${i}]`, `${value} ${typeof st.label === "string" ? st.label : ""}`]);
+      });
+      return fields;
+    }
+    case "ExecutiveSummary":
+      return [["content", props.content]];
+    case "GlassPricing": {
+      const fields = [["note", props.note]];
+      list(props.tiers).forEach((tier, i) => {
+        if (!isRecord(tier)) return;
+        fields.push([`tiers[${i}].name`, tier.name], [`tiers[${i}].description`, tier.description]);
+        list(tier.features).forEach((f, j) => fields.push([`tiers[${i}].features[${j}]`, f]));
+      });
+      return fields;
+    }
+    case "SitemapPlan": {
+      const strategy = isRecord(props.strategy) ? props.strategy : {};
+      return [
+        ["title", props.title],
+        ["subtitle", props.subtitle],
+        ["strategy.headline", strategy.headline],
+        ["strategy.lead", strategy.lead]
+      ];
+    }
+    default:
+      return [];
+  }
+}
+function proposalPageCountIssues(sections) {
+  const secs = list(sections).filter(isRecord);
+  const plan = secs.find((s) => s.type === "SitemapPlan");
+  if (!plan) return [];
+  const planProps = isRecord(plan.props) ? plan.props : {};
+  const counts = countSitemapPlan(planProps);
+  const known = /* @__PURE__ */ new Set([
+    counts.full,
+    counts.core,
+    counts.architecture,
+    counts.articles,
+    counts.existing,
+    counts.added,
+    counts.core + counts.architecture
+  ]);
+  const transformation = isRecord(planProps.transformation) ? planProps.transformation : {};
+  const before = sitemapCount(isRecord(transformation.before) ? transformation.before.count : void 0);
+  if (before !== void 0) known.add(before);
+  for (const s of secs) {
+    const props = isRecord(s.props) ? s.props : {};
+    if (s.type === "MigrationSafetyPlan") {
+      const urls = sitemapCount(props.urlCount);
+      if (urls !== void 0) known.add(urls);
+    }
+    if (s.type === "ContentDepth" && isRecord(props.ledger)) {
+      const measured = sitemapCount(props.ledger.beforePages);
+      if (measured !== void 0) known.add(measured);
+    }
+  }
+  const issues = [];
+  for (const s of secs) {
+    for (const [field, text] of claimFields(s)) {
+      for (const claim of findPageCountClaims(text)) {
+        if (known.has(claim.value)) continue;
+        issues.push({
+          section: String(s.type),
+          field,
+          claimed: claim.value,
+          unit: claim.unit,
+          text: claim.text,
+          planned: counts.full
+        });
+      }
+    }
+  }
+  return issues;
+}
+var SECTION_NAMES = {
+  GlassHero: "The headline",
+  ExecutiveSummary: "The summary",
+  GlassPricing: "The pricing",
+  SitemapPlan: "The site plan"
+};
+function describePageCountIssue(issue) {
+  const where = SECTION_NAMES[issue.section] ?? `The ${issue.section} section`;
+  return `${where} says "${issue.text}", but the site plan adds up to ${issue.planned} ${issue.planned === 1 ? "page" : "pages"}.`;
+}
+
+exports.PROPOSAL_SITEMAP_CONTRACT_VERSION = PROPOSAL_SITEMAP_CONTRACT_VERSION;
+exports.SITEMAP_LABEL_MAX = SITEMAP_LABEL_MAX;
+exports.countSitemapPlan = countSitemapPlan;
+exports.describePageCountIssue = describePageCountIssue;
+exports.findPageCountClaims = findPageCountClaims;
+exports.normalizeSitemapLabels = normalizeSitemapLabels;
+exports.proposalPageCountIssues = proposalPageCountIssues;
+exports.sitemapCount = sitemapCount;
+exports.sitemapPageKey = sitemapPageKey;
+exports.sitemapTransformation = sitemapTransformation;

package/dist/proposal-sitemap.mjs

@@ -0,0 +1,201 @@
+// src/contracts/proposal-sitemap.ts
+var PROPOSAL_SITEMAP_CONTRACT_VERSION = 1;
+function isRecord(v) {
+  return !!v && typeof v === "object" && !Array.isArray(v);
+}
+function list(v) {
+  return Array.isArray(v) ? v : [];
+}
+function sitemapCount(v) {
+  const n = typeof v === "number" ? v : typeof v === "string" && v.trim() !== "" ? Number(v) : NaN;
+  return Number.isFinite(n) && n >= 0 ? Math.floor(n) : void 0;
+}
+function sitemapPageKey(slug) {
+  if (typeof slug !== "string") return void 0;
+  let s = slug.trim().toLowerCase();
+  if (!s) return void 0;
+  s = s.replace(/^[a-z][a-z0-9+.-]*:\/\/[^/]*/, "");
+  s = s.split(/[?#]/)[0];
+  if (!s.startsWith("/")) s = `/${s}`;
+  s = s.replace(/\/{2,}/g, "/").replace(/\/+$/, "");
+  return s || "/";
+}
+var EXISTING_STATUSES = /* @__PURE__ */ new Set(["rebuild", "optimize", "migrate"]);
+function countSitemapPlan(props) {
+  const p = isRecord(props) ? props : {};
+  const seen = /* @__PURE__ */ new Set();
+  let existing = 0;
+  let added = 0;
+  const take = (node) => {
+    if (!isRecord(node)) return false;
+    const key = sitemapPageKey(node.slug);
+    if (key !== void 0) {
+      if (seen.has(key)) return false;
+      seen.add(key);
+    }
+    if (typeof node.status === "string" && EXISTING_STATUSES.has(node.status)) existing++;
+    else added++;
+    return true;
+  };
+  let core = 0;
+  for (const node of list(p.corePages)) if (take(node)) core++;
+  let architecture = 0;
+  for (const pillar of list(p.pages)) {
+    if (take(pillar)) architecture++;
+    if (!isRecord(pillar)) continue;
+    for (const child of list(pillar.children)) if (take(child)) architecture++;
+  }
+  const articles = isRecord(p.blog) ? sitemapCount(p.blog.count) ?? 0 : 0;
+  return {
+    core,
+    architecture,
+    articles,
+    full: core + architecture + articles,
+    existing: existing + articles,
+    added
+  };
+}
+function sitemapTransformation(props) {
+  const p = isRecord(props) ? props : {};
+  const t = p.transformation;
+  if (!isRecord(t)) return null;
+  const before = sitemapCount(isRecord(t.before) ? t.before.count : void 0);
+  if (before === void 0) return null;
+  const planned = countSitemapPlan(p).architecture;
+  const after = sitemapCount(isRecord(t.after) ? t.after.count : void 0) ?? (planned > 0 ? planned : sitemapCount(p.totalPages) ?? 0);
+  if (after <= 0 || after <= before) return null;
+  return { before, after };
+}
+var SITEMAP_LABEL_MAX = 40;
+var LABEL_KEYS = ["architecture", "pillar", "child"];
+function normalizeSitemapLabels(raw) {
+  if (!isRecord(raw)) return void 0;
+  const out = {};
+  for (const key of LABEL_KEYS) {
+    const v = raw[key];
+    if (typeof v !== "string") continue;
+    if (/[\u0000-\u0008\u000a-\u001f\u007f<>]/.test(v)) continue;
+    const s = v.replace(/\s+/g, " ").trim();
+    if (s && s.length <= SITEMAP_LABEL_MAX) out[key] = s;
+  }
+  return Object.keys(out).length ? out : void 0;
+}
+var CLAIM_RE = /(?<![\d$.,/])(\d{1,5})(?![\d.,/%])(?:[\s-]+(?:[a-z'’&]+[\s-]+){0,3}?)(pages?|urls?)\b/gi;
+var CAPITALIZED_BEFORE_RE = /(?<![\w'’])[A-Z][\w'’.&-]*\s+$/;
+function numberInName(before) {
+  const m = before.match(CAPITALIZED_BEFORE_RE);
+  if (!m) return false;
+  const lead = before.slice(0, m.index);
+  if (/\n\s*$/.test(lead)) return false;
+  const trimmed = lead.replace(/\s+$/, "");
+  return trimmed !== "" && !/[.!?:]$/.test(trimmed);
+}
+function findPageCountClaims(text) {
+  if (typeof text !== "string" || !text) return [];
+  const claims = [];
+  for (const m of text.matchAll(CLAIM_RE)) {
+    if (numberInName(text.slice(0, m.index ?? 0))) continue;
+    claims.push({
+      value: Number(m[1]),
+      unit: m[2].toLowerCase().startsWith("url") ? "url" : "page",
+      text: m[0],
+      index: m.index ?? 0
+    });
+  }
+  return claims;
+}
+function claimFields(section) {
+  const props = isRecord(section.props) ? section.props : {};
+  switch (section.type) {
+    case "GlassHero": {
+      const fields = [["title", props.title], ["subtitle", props.subtitle]];
+      list(props.stats).forEach((st, i) => {
+        if (!isRecord(st)) return;
+        const value = typeof st.value === "number" || typeof st.value === "string" ? String(st.value) : "";
+        fields.push([`stats[${i}]`, `${value} ${typeof st.label === "string" ? st.label : ""}`]);
+      });
+      return fields;
+    }
+    case "ExecutiveSummary":
+      return [["content", props.content]];
+    case "GlassPricing": {
+      const fields = [["note", props.note]];
+      list(props.tiers).forEach((tier, i) => {
+        if (!isRecord(tier)) return;
+        fields.push([`tiers[${i}].name`, tier.name], [`tiers[${i}].description`, tier.description]);
+        list(tier.features).forEach((f, j) => fields.push([`tiers[${i}].features[${j}]`, f]));
+      });
+      return fields;
+    }
+    case "SitemapPlan": {
+      const strategy = isRecord(props.strategy) ? props.strategy : {};
+      return [
+        ["title", props.title],
+        ["subtitle", props.subtitle],
+        ["strategy.headline", strategy.headline],
+        ["strategy.lead", strategy.lead]
+      ];
+    }
+    default:
+      return [];
+  }
+}
+function proposalPageCountIssues(sections) {
+  const secs = list(sections).filter(isRecord);
+  const plan = secs.find((s) => s.type === "SitemapPlan");
+  if (!plan) return [];
+  const planProps = isRecord(plan.props) ? plan.props : {};
+  const counts = countSitemapPlan(planProps);
+  const known = /* @__PURE__ */ new Set([
+    counts.full,
+    counts.core,
+    counts.architecture,
+    counts.articles,
+    counts.existing,
+    counts.added,
+    counts.core + counts.architecture
+  ]);
+  const transformation = isRecord(planProps.transformation) ? planProps.transformation : {};
+  const before = sitemapCount(isRecord(transformation.before) ? transformation.before.count : void 0);
+  if (before !== void 0) known.add(before);
+  for (const s of secs) {
+    const props = isRecord(s.props) ? s.props : {};
+    if (s.type === "MigrationSafetyPlan") {
+      const urls = sitemapCount(props.urlCount);
+      if (urls !== void 0) known.add(urls);
+    }
+    if (s.type === "ContentDepth" && isRecord(props.ledger)) {
+      const measured = sitemapCount(props.ledger.beforePages);
+      if (measured !== void 0) known.add(measured);
+    }
+  }
+  const issues = [];
+  for (const s of secs) {
+    for (const [field, text] of claimFields(s)) {
+      for (const claim of findPageCountClaims(text)) {
+        if (known.has(claim.value)) continue;
+        issues.push({
+          section: String(s.type),
+          field,
+          claimed: claim.value,
+          unit: claim.unit,
+          text: claim.text,
+          planned: counts.full
+        });
+      }
+    }
+  }
+  return issues;
+}
+var SECTION_NAMES = {
+  GlassHero: "The headline",
+  ExecutiveSummary: "The summary",
+  GlassPricing: "The pricing",
+  SitemapPlan: "The site plan"
+};
+function describePageCountIssue(issue) {
+  const where = SECTION_NAMES[issue.section] ?? `The ${issue.section} section`;
+  return `${where} says "${issue.text}", but the site plan adds up to ${issue.planned} ${issue.planned === 1 ? "page" : "pages"}.`;
+}
+
+export { PROPOSAL_SITEMAP_CONTRACT_VERSION, SITEMAP_LABEL_MAX, countSitemapPlan, describePageCountIssue, findPageCountClaims, normalizeSitemapLabels, proposalPageCountIssues, sitemapCount, sitemapPageKey, sitemapTransformation };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sonordev/contracts",
-  "version": "2.1.1",
-  "description": "The rules Sonor's sites, APIs and dashboard share: popup blocks and site design tokens, site hosts, SEO page identity, title quality, llms.txt sanitizers, the forms honeypot, fleet heartbeats, slot content and signing, site cache tags, portfolio metrics and the house voice's contraction rule. Pure functions, no dependencies.",
+  "version": "2.3.0",
+  "description": "The rules Sonor's sites, APIs and dashboard share: popup blocks and site design tokens, site hosts, SEO page identity, title quality, llms.txt sanitizers, the forms honeypot, fleet heartbeats, slot content and signing, site cache tags, portfolio metrics, the house voice's contraction rule, how a proposal's site plan counts its pages, and what separates an error page from a page's content. Pure functions, no dependencies.",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -85,6 +85,16 @@
       "import": "./dist/voice.mjs",
       "require": "./dist/voice.js"
     },
+    "./proposal-sitemap": {
+      "types": "./dist/proposal-sitemap.d.ts",
+      "import": "./dist/proposal-sitemap.mjs",
+      "require": "./dist/proposal-sitemap.js"
+    },
+    "./error-page": {
+      "types": "./dist/error-page.d.ts",
+      "import": "./dist/error-page.mjs",
+      "require": "./dist/error-page.js"
+    },
     "./package.json": "./package.json"
   },
   "typesVersions": {