@operstack/audit 0.17.2 → 0.18.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@operstack/audit",
-  "version": "0.17.2",
+  "version": "0.18.0",
   "description": "SEO, AEO and GEO audit generator: collect public signals from a site into audit.json, let an analyst or an agent fill the narrative, render the OperStack report as HTML and PDF.",
   "type": "module",
   "license": "MIT",

package/src/index.mjs

@@ -1,7 +1,7 @@
 export { collect, computeScores, computeOverall, verifyScores, SCORE_AREAS } from './collect.mjs';
 // Единственная копия движка видимости. Сайты и актор зовут его отсюда, своих копий больше нет.
 export { checkVisibility, normaliseInput, parseRobots, agentVerdict, MESSAGES as VISIBILITY_MESSAGES, VISIBILITY_DEFAULTS } from './visibility.mjs';
-export { render, checkNarrative } from './render.mjs';
+export { render, checkNarrative, overallSummary } from './render.mjs';
 export { localiseChecks, localiseBasisNote, untranslated, AREAS_RU } from './i18n.mjs';
 export { buildFixPlan, renderFixPlan, renderFixChecklist, buildFixReport, renderFixReport, FIX_ACTIONS } from './fix.mjs';
 export { buildFoundationScope, renderFoundationScope, renderFoundationChecklist } from './foundation.mjs';

package/src/render.mjs

@@ -9,6 +9,7 @@ import { tmpdir } from 'node:os';
 import { join } from 'node:path';
 import { computeScores, computeOverall } from './collect.mjs';
 import { localiseBasisNote, AREAS_RU } from './i18n.mjs';
+import { MESSAGES as VISIBILITY_MESSAGES } from './visibility.mjs';
 import { softenHex } from './agency.mjs';
 
 const esc = (s) => String(s ?? '').replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;');
@@ -102,6 +103,38 @@ const ruPoints = (n) => { const a = Math.abs(n) % 100; const b = a % 10; if (a >
 
 const scoreClass = (n) => (n === null || n === undefined ? '' : n <= 3 ? 'low' : n <= 6 ? 'mid' : 'ok');
 
+/**
+ * Балл видимости и всё, что про него надо сказать словами, одним объектом.
+ *
+ * Простым языком: это тот самый блок, который стоит на первой странице отчёта. Письмо печатает
+ * его же. Раньше письмо собирало свою формулировку и свою цифру, и человек получал на странице
+ * одно, в письме другое, а в PDF третье. Теперь текст ровно один и живёт здесь.
+ *
+ * Названия областей берутся по `id`, а не по готовой подписи из замера: замер мог пройти на
+ * английской странице, а отчёт уходить русскому покупателю, и тогда подпись пришла бы на чужом
+ * языке. Язык отчёта главнее языка замера.
+ *
+ * Возвращает null, если балла нет: движок отказывается мерить закрытые и приватные адреса, и в
+ * этом случае честнее не называть цифру вовсе, чем подставить ноль.
+ */
+export function overallSummary(overall, { lang = 'en' } = {}) {
+  if (!overall || overall.score === null || overall.score === undefined) return null;
+  const key = lang === 'ru' ? 'ru' : 'en';
+  const L = LABELS[key];
+  const names = VISIBILITY_MESSAGES[key].area;
+  return {
+    label: L.overallLabel,
+    score: overall.score,
+    grade: (L.grades && L.grades[overall.grade]) || overall.grade,
+    note: L.overallNote(overall),
+    areas: (Array.isArray(overall.areas) ? overall.areas : []).map((x) => ({
+      id: x.id, label: (x.id && names[x.id]) || x.label, score: x.score, max: x.max,
+    })),
+    secondMeasure: L.secondMeasure,
+    secondMeasureFoot: L.scorecardFoot.replace(/<\/?strong>/g, ''),
+  };
+}
+
 export function checkNarrative(audit) {
   const out = [];
   const walk = (v, path) => {
@@ -211,14 +244,13 @@ export function toHtml(audit, brand = null) {
    * независимое измерение по проверкам самого отчёта, а не разбивка заголовка. Сводить их с
    * заголовком не нужно и не получится, и об этом сказано словами.
    */
-  const overall = a.overall && a.overall.score !== undefined ? a.overall : null;
-  const overallAreas = overall && Array.isArray(overall.areas) ? overall.areas : [];
-  const overallBlock = !overall || overall.score === null ? '' : `<div class="overall">
-    <div class="overall-num ${scoreClass(Math.round(overall.score / 10))}">${overall.score}<span>/100</span></div>
-    <div class="overall-side"><div class="overall-label">${esc(L.overallLabel)}</div>
-      <div class="overall-grade">${esc((L.grades && L.grades[overall.grade]) || overall.grade)}</div>
-      <div class="overall-note">${esc(L.overallNote(overall))}</div></div></div>`
-    + (overallAreas.length ? `<table class="areas"><tr>${overallAreas.map((x) => `<th>${esc(x.label)}</th>`).join('')}</tr><tr>${overallAreas.map((x) => `<td>${x.score}<span>/${x.max}</span></td>`).join('')}</tr></table>` : '');
+  const head = overallSummary(a.overall, { lang: a.meta?.lang === 'ru' ? 'ru' : 'en' });
+  const overallBlock = !head ? '' : `<div class="overall">
+    <div class="overall-num ${scoreClass(Math.round(head.score / 10))}">${head.score}<span>/100</span></div>
+    <div class="overall-side"><div class="overall-label">${esc(head.label)}</div>
+      <div class="overall-grade">${esc(head.grade)}</div>
+      <div class="overall-note">${esc(head.note)}</div></div></div>`
+    + (head.areas.length ? `<table class="areas"><tr>${head.areas.map((x) => `<th>${esc(x.label)}</th>`).join('')}</tr><tr>${head.areas.map((x) => `<td>${x.score}<span>/${x.max}</span></td>`).join('')}</tr></table>` : '');
   const scoreCards = Object.entries(measured).map(([label, n]) => {
     const basis = scoreBasis[label] || {};
     const shown = (L.areas && L.areas[label]) || label;

package/src/test-overall.mjs

@@ -12,7 +12,7 @@ import { readFileSync } from 'node:fs';
 import { createServer } from 'node:http';
 import { collect, computeOverall, computeScores, verifyScores, SCORE_AREAS } from './collect.mjs';
 import { checkVisibility, VISIBILITY_DEFAULTS } from './visibility.mjs';
-import { toHtml } from './render.mjs';
+import { toHtml, overallSummary } from './render.mjs';
 
 let bad = 0;
 const ok = (n, c) => { if (c) console.log(`ok   ${n}`); else { bad++; console.error(`FAIL ${n}`); } };
@@ -186,6 +186,42 @@ ok('параметры нельзя поменять на ходу', Object.isFr
   }
 }
 
+// ---- один блок «балл и области» на отчёт и на письмо
+//
+// Письмо собирало свою формулировку и свою цифру, отчёт свою. Разошлись. Теперь обе стороны
+// зовут overallSummary, и разойтись нечему: текст ровно один и живёт в пакете.
+{
+  const areas = [{ id: 'access', label: 'Can AI crawlers read it', score: 20, max: 25 },
+    { id: 'index', label: 'Is there a map for agents (llms.txt)', score: 5, max: 15 },
+    { id: 'entity', label: 'Is the entity clear (schema)', score: 12, max: 20 },
+    { id: 'content', label: 'Is there something to quote', score: 18, max: 25 },
+    { id: 'trust', label: 'Can it be dated and trusted', score: 8, max: 15 }];
+  const overall = { score: 63, grade: 'B', areas, source: 'visibility:reused', measuredAt: '2026-09-14T20:00:00.000Z', basis: { pages: 4, sitemapRead: true, sitemapUnchecked: false } };
+
+  const ru = overallSummary(overall, { lang: 'ru' });
+  const en = overallSummary(overall, { lang: 'en' });
+  is('заголовок письма это заголовок отчёта', ru.score, 63);
+  is('сумма пяти областей даёт заголовок', ru.areas.reduce((a, x) => a + x.score, 0), ru.score);
+  ok('оценка словом переведена', ru.grade === 'Рабочее состояние' && en.grade === 'Workable');
+  const fixture = JSON.parse(readFileSync(new URL('../examples/sample-audit.json', import.meta.url), 'utf8'));
+  fixture.meta.lang = 'ru'; fixture.overall = overall;
+  ok('подпись та же, что печатает отчёт', ru.note === (toHtml(fixture, null).match(/overall-note">([^<]*)</) || [])[1]);
+
+  // Замер мог пройти на английской странице, а отчёт уходит русскому покупателю: язык отчёта главнее.
+  ok('названия областей на языке отчёта, а не замера', ru.areas[0].label === 'Могут ли роботы ИИ прочитать сайт');
+  ok('и в английском они английские', en.areas[0].label === 'Can AI crawlers read it');
+  ok('в русском блоке нет английских названий', !ru.areas.some((x) => /[A-Za-z]{4}/.test(x.label.replace('llms.txt', ''))));
+
+  // Шесть областей отчёта это второе измерение, и подпись обязана это говорить в обоих языках.
+  ok('подзаголовок второго измерения есть', /Второе, отдельное измерение/.test(ru.secondMeasure) && /second, separate measurement/.test(en.secondMeasure));
+  ok('и сказано, что складывать их с заголовком не надо', /в сумме его не дают/.test(ru.secondMeasureFoot) && /will not add up to it/.test(en.secondMeasureFoot));
+  ok('в подписи второго измерения нет разметки', !/</.test(ru.secondMeasureFoot) && !/</.test(en.secondMeasureFoot));
+
+  // Балла может не быть: движок не мерит закрытые адреса. Тогда письмо не называет цифру вовсе.
+  is('без балла блока нет', overallSummary({ score: null, grade: 'not measured', areas: [] }, { lang: 'ru' }), null);
+  is('и на пустом объекте тоже', overallSummary(null, { lang: 'en' }), null);
+}
+
 // ---- движок в пакете это та же программа, что стоит на сайтах
 {
   const here = readFileSync(new URL('./visibility.mjs', import.meta.url), 'utf8');