@operstack/audit 0.17.1 → 0.18.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@operstack/audit",
-  "version": "0.17.1",
+  "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/collect.mjs

@@ -500,9 +500,14 @@ export async function collect(startUrl, { pages = 20, log = () => {}, backlinks
   if (visibility) log('visibility score: taken from the check the visitor already ran');
   else { log('visibility score'); visibility = await checkVisibility(startUrl, { ...VISIBILITY_DEFAULTS, lang }); }
   const measuredAt = visibility && visibility.checkedAt ? visibility.checkedAt : null;
+  /* Из чего сложился балл, словами для отчёта: сколько страниц прочитано и дочиталась ли карта
+   * сайта. Без этого подпись под баллом обещает точность, которой у восьмисекундной проверки нет. */
+  const basis = visibility && visibility.ok
+    ? { pages: (visibility.sample || []).length, sitemapRead: Boolean(visibility.sitemap && visibility.sitemap.found), sitemapUnchecked: Boolean(visibility.sitemap && visibility.sitemap.unchecked) }
+    : null;
   const overall = visibility && visibility.ok
-    ? { score: visibility.score, grade: visibility.grade, areas: visibility.areas, source: givenVisibility ? 'visibility:reused' : 'visibility', measuredAt, ms: visibility.ms }
-    : { score: null, grade: 'not measured', areas: [], source: givenVisibility ? 'visibility:reused' : 'visibility', error: (visibility && visibility.error) || 'no visibility result' };
+    ? { score: visibility.score, grade: visibility.grade, areas: visibility.areas, basis, source: givenVisibility ? 'visibility:reused' : 'visibility', measuredAt, ms: visibility.ms }
+    : { score: null, grade: 'not measured', areas: [], basis: null, source: givenVisibility ? 'visibility:reused' : 'visibility', error: (visibility && visibility.error) || 'no visibility result' };
   // Шесть областей отчёта остаются, но это другое измерение, а не разбивка общего балла.
   const reportScore = computeOverall(checks);
 

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;');
@@ -29,7 +30,15 @@ const LABELS = {
     grades: { A: 'Strong', B: 'Workable', C: 'Weak', D: 'Poor', E: 'Critical' },
     // Заголовок это то же измерение, что на странице проверки. Подпись обязана это говорить,
     // иначе читатель снова начнёт сводить его с шестью областями ниже.
-    overallNote: 'The same measurement the free check at oper-stack.com/ai-visibility gives for this site: the same code, the same settings. The five areas below add up to it exactly, so you can recompute it by hand.',
+    // Подпись обязана сказать три вещи: откуда число, что именно успели прочитать, и почему
+    // повтор может дать на пункт-другой иначе. Без последнего человек читает разницу как ошибку.
+    overallNote: (o) => {
+      const read = o.basis ? `It was read from ${o.basis.pages} page${o.basis.pages === 1 ? '' : 's'} of the site${o.basis.sitemapUnchecked ? ', and the sitemap did not answer in time, which is not counted against the score either way' : o.basis.sitemapRead ? ' and its sitemap' : ''}. ` : '';
+      const where = o.source === 'visibility:reused'
+        ? `This is the same figure you already saw on the free check${o.measuredAt ? ` on ${String(o.measuredAt).slice(0, 10)}` : ''}. It is not measured again here, so the page, the email and this report always carry one number. `
+        : 'Measured here by the same code and the same settings as the free check at oper-stack.com/ai-visibility. ';
+      return `${where}${read}The five areas below add up to it exactly, so you can recompute it by hand. Running the check again can move it by a point or two: a check that answers in time on one run may not on the next, and this score never counts against a site what it could not read.`;
+    },
     secondMeasure: 'A second, separate measurement: how this report scores its own checks',
     secOverview: 'Site overview', overviewEyebrow: '02 · Overview', whatSiteIs: 'What the site is', parameter: 'Parameter', value: 'Value', pagesSampled: 'Pages sampled', colUrl: 'URL', colTitle: 'Title', colWords: 'Words',
     secCritical: 'Critical issues', criticalEyebrow: '03 · P0', criticalTitle: 'Critical issues, fix first', whatItCosts: 'What it costs', theFix: 'Fix', noBody: 'This issue has no description in the audit file.', noCritical: 'No critical defects were found in the public signals.',
@@ -56,7 +65,15 @@ const LABELS = {
     notMeasured: 'не измерялось',
     overallLabel: 'Балл видимости в ИИ',
     grades: { A: 'Сильно', B: 'Рабочее состояние', C: 'Слабо', D: 'Плохо', E: 'Критично' },
-    overallNote: 'То же измерение, что даёт бесплатная проверка на oper-stack.com/ai-visibility для этого сайта: тот же код, те же настройки. Пять областей ниже дают в сумме ровно этот балл, его можно сложить руками.',
+    overallNote: (o) => {
+      const p = o.basis ? o.basis.pages : 0;
+      const pl = ruPages(p);
+      const read = o.basis ? `Прочитано ${p} ${pl} сайта${o.basis.sitemapUnchecked ? ', а карта сайта не ответила вовремя, и это не зачтено ни в плюс, ни в минус' : o.basis.sitemapRead ? ' и его карта' : ''}. ` : '';
+      const where = o.source === 'visibility:reused'
+        ? `Это ровно то число, которое вы уже видели в бесплатной проверке${o.measuredAt ? ` ${String(o.measuredAt).slice(0, 10)}` : ''}. Здесь оно не меряется заново, поэтому страница, письмо и этот отчёт всегда несут одно число. `
+        : 'Измерено здесь тем же кодом и с теми же настройками, что у бесплатной проверки на oper-stack.com/ai-visibility. ';
+      return `${where}${read}Пять областей ниже дают в сумме ровно этот балл, его можно сложить руками. Повторная проверка может дать на пункт-другой иначе: проверка, которая успела ответить в один прогон, может не успеть в следующий, а балл никогда не засчитывает сайту в минус то, что не удалось прочитать.`;
+    },
     secondMeasure: 'Второе, отдельное измерение: как этот отчёт оценивает собственные проверки',
     secOverview: 'О сайте', overviewEyebrow: '02 · Обзор', whatSiteIs: 'Что это за сайт', parameter: 'Параметр', value: 'Значение', pagesSampled: 'Проверенные страницы', colUrl: 'Адрес', colTitle: 'Заголовок', colWords: 'Слов',
     secCritical: 'Критичное', criticalEyebrow: '03 · Срочно', criticalTitle: 'Что чинить первым', whatItCosts: 'Чем это грозит', theFix: 'Как чинится', noBody: 'У этой проблемы нет описания в файле аудита.', noCritical: 'Критичных дефектов в публичных сигналах не найдено.',
@@ -78,11 +95,46 @@ const LABELS = {
 const STATUS_KEYS = { ok: 'statusOk', warn: 'statusWarn', bad: 'statusBad', na: 'statusNa' };
 const STATUS_CLASS = { ok: 'status-ok', warn: 'status-warn', bad: 'status-bad', na: 'status-na' };
 const STATUS_UNUSED = { ok: ['✓ OK', 'status-ok'], warn: ['△ Partial', 'status-warn'], bad: ['✗ Problem', 'status-bad'], na: ['· Note', 'status-na'] };
+/** Склонение «страница»: 1 страница, 4 страницы, 5 страниц. Подпись под баллом читает человек. */
+const ruPages = (n) => { const a = Math.abs(n) % 100; const b = a % 10; if (a > 10 && a < 20) return 'страниц'; if (b === 1) return 'страница'; if (b >= 2 && b <= 4) return 'страницы'; return 'страниц'; };
+
 /** Склонение «балл» для русской подписи под общим баллом: 21 балл, 72 балла, 75 баллов. */
 const ruPoints = (n) => { const a = Math.abs(n) % 100; const b = a % 10; if (a > 10 && a < 20) return 'баллов'; if (b === 1) return 'балл'; if (b >= 2 && b <= 4) return 'балла'; return 'баллов'; };
 
 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) => {
@@ -192,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)}</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}`); } };
@@ -147,6 +147,81 @@ ok('параметры нельзя поменять на ходу', Object.isFr
   is('и отчёт печатает именно его', Number((toHtml(audit, null).match(/overall-num[^>]*>(\d+)<span>/) || [])[1]), 63);
 }
 
+/*
+ * Подпись под баллом обязана объяснить человеку три вещи, иначе он прочитает разницу в пару
+ * пунктов как ошибку: откуда взялось число, что успели прочитать, и почему повтор может дать
+ * иначе. Это критерий приёмки, а не украшение: человек, прочитавший сначала страницу, а потом
+ * отчёт, не должен удивиться.
+ */
+{
+  const audit = JSON.parse(readFileSync(new URL('../examples/sample-audit.json', import.meta.url), 'utf8'));
+  const areas = [{ id: 'access', label: 'Access', score: 20, max: 25 }, { id: 'index', label: 'Index', score: 10, max: 15 },
+    { id: 'entity', label: 'Entity', score: 12, max: 20 }, { id: 'content', label: 'Content', score: 14, max: 25 }, { id: 'trust', label: 'Trust', score: 5, max: 15 }];
+  const note = (a) => ((toHtml(a, null).match(/overall-note">([^<]*)</) || [])[1] || '');
+
+  for (const lang of ['en', 'ru']) {
+    audit.meta.lang = lang;
+
+    audit.overall = { score: 61, grade: 'B', areas, source: 'visibility:reused', measuredAt: '2026-09-14T20:00:00.000Z', basis: { pages: 4, sitemapRead: true, sitemapUnchecked: false } };
+    const reused = note(audit);
+    ok(`${lang}: сказано, что число уже видели на проверке`, lang === 'en' ? /already saw on the free check/.test(reused) : /уже видели в бесплатной проверке/.test(reused));
+    ok(`${lang}: сказано, что здесь не меряли заново`, lang === 'en' ? /not measured again here/.test(reused) : /не меряется заново/.test(reused));
+    ok(`${lang}: названа дата измерения`, /2026-09-14/.test(reused));
+    ok(`${lang}: сказано, сколько страниц прочитано`, /4/.test(reused));
+    ok(`${lang}: предупреждает про разброс в пункт-другой`, lang === 'en' ? /a point or two/.test(reused) : /на пункт-другой/.test(reused));
+
+    audit.overall = { score: 61, grade: 'B', areas, source: 'visibility', basis: { pages: 1, sitemapRead: false, sitemapUnchecked: true } };
+    const fresh = note(audit);
+    ok(`${lang}: при собственном измерении сказано именно это`, lang === 'en' ? /Measured here by the same code/.test(fresh) : /Измерено здесь тем же кодом/.test(fresh));
+    ok(`${lang}: непрочитанная карта сайта названа, а не спрятана`, lang === 'en' ? /sitemap did not answer in time/.test(fresh) : /карта сайта не ответила вовремя/.test(fresh));
+    ok(`${lang}: и сказано, что она не зачтена в минус`, lang === 'en' ? /not counted against the score/.test(fresh) : /не зачтено ни в плюс, ни в минус/.test(fresh));
+    ok(`${lang}: в подписи нет чужого языка`, lang === 'en' ? !/[А-Яа-яЁё]/.test(fresh) : !/Measured|sitemap did/.test(fresh));
+  }
+
+  // Русское склонение в подписи: человек это читает.
+  audit.meta.lang = 'ru';
+  for (const [n, word] of [[1, 'страница'], [2, 'страницы'], [5, 'страниц'], [11, 'страниц'], [21, 'страница']]) {
+    audit.overall = { score: 61, grade: 'B', areas, source: 'visibility', basis: { pages: n, sitemapRead: true, sitemapUnchecked: false } };
+    ok(`ru: ${n} ${word}`, new RegExp(`Прочитано ${n} ${word} сайта`).test(note(audit)));
+  }
+}
+
+// ---- один блок «балл и области» на отчёт и на письмо
+//
+// Письмо собирало свою формулировку и свою цифру, отчёт свою. Разошлись. Теперь обе стороны
+// зовут 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');