@mikitasazan/notify 1.6.2 → 1.8.0

package/dist/cli-flags.js

@@ -14,7 +14,7 @@ export const KNOWN_FLAGS = new Set([
     'command', 'command-note', 'commit-body', 'commit-title', 'commit-url', 'detail',
     'expected', 'filename', 'item',
     'item-group', 'job', 'key', 'last-seen', 'line', 'logs', 'note',
-    'number', 'path', 'period', 'project', 'reviewer', 'stat', 'status',
+    'aside', 'number', 'path', 'period', 'project', 'reviewer', 'stat', 'status',
     'target', 'title', 'url', 'via', 'workflow-name', 'workflow-url',
     // Флаги без значения. Живут здесь же, чтобы разбор и список не разошлись.
     'json', 'recovered', 'dry-run'

package/dist/cli.js

@@ -236,6 +236,7 @@ else {
                 project: project(),
                 job: one('job') ?? '(no name)',
                 status: jobStatus(),
+                aside: one('aside'),
                 expected: one('expected'),
                 lastSeen: one('last-seen'),
                 stats: pairs('stat'),
@@ -254,7 +255,9 @@ else {
                 type: 'report',
                 project: project(),
                 title: one('title') ?? '(no title)',
-                period: one('period'),
+                // `--period` is the old spelling of `--aside`; both fill the same
+                // slot, and two senders still use the old one.
+                aside: one('aside') ?? one('period'),
                 lines: pairs('line'),
                 items: items(),
                 url: one('url')

package/dist/events.d.ts

@@ -111,6 +111,14 @@ export type NotifyEvent = Keyed & (
      * ПОЛНОМУ тегу. Один поток на задачу это чинит.
      */
     status: 'ok' | 'fail' | 'disabled' | 'silent';
+    /**
+     * The one qualifier the name needs to be readable on its own, printed in
+     * brackets right after it: `Yandex game import (reporting again)`. It is
+     * the same slot a report uses for the day it covers. Anything that is a
+     * FACT about the job goes in a row of its own; this is for the word that
+     * finishes the name.
+     */
+    aside?: string;
     /** Как часто задача обязана отмечаться — для `silent` и для возврата из него. */
     expected?: string;
     /** Когда её видели в последний раз. */
@@ -162,7 +170,13 @@ export type NotifyEvent = Keyed & (
     type: 'report';
     project: Project;
     title: string;
-    period?: string;
+    /**
+     * Printed in brackets after the title — which day the report covers, or
+     * which day its arrows are measured against. Same slot, same name, as a
+     * job's. `period` is the old spelling of this field and the CLI still
+     * accepts `--period` for it.
+     */
+    aside?: string;
     /** Пусто/не передано, когда используются `groups` — два вида отчёта не смешиваются в одном событии. */
     lines?: Array<[label: string, value: string | number, group?: string]>;
     /**

package/dist/render.d.ts

@@ -46,6 +46,24 @@ export declare const slug: (raw: string) => string;
  * заголовок и есть единственное стабильное поле).
  */
 export declare const eventKey: (e: NotifyEvent) => string;
+/**
+ * Третий тег — ИСХОД, и он есть всегда. Владелец: «не хватает тега fail или
+ * похожего, чтобы фейлы можно было группировать и ок можно было группировать».
+ * Одно нажатие в Telegram собирает все падения проекта разом, каким бы типом
+ * они ни пришли — выкатка, проверка, задача по расписанию, авария.
+ *
+ * The value comes from the ICON, never from the status word. The icon is
+ * already the single source of truth for the sound, and a second list of "what
+ * counts as broken" would drift from the first — it already did once, when a
+ * red card arrived silent.
+ *
+ * One icon meaning, one tag. A watchdog that SWITCHED SOMETHING OFF is not a
+ * failure and must not be filed under the same word as one: the owner read
+ * `#fail` under a 🚫 and said so. Nor is a task that has simply gone quiet —
+ * nobody knows yet whether it broke, and `#unknown` is the honest word for it.
+ */
+export declare const OUTCOME_TAG: Readonly<Record<string, string>>;
+export declare const outcomeTag: (e: NotifyEvent) => string;
 /**
  * Строка тегов для свободного HTML (`sendReport`). Тег — это ФИЛЬТР владельца,
  * и к формату тела он отношения не имеет: дневной отчёт остаётся свободным

package/dist/render.js

@@ -19,7 +19,7 @@
  * строка разделяет БЛОКИ ПО СМЫСЛУ (шапка / суть / действия), не механически
  * после каждой строки.
  */
-import { ICON, LOUD, iconFor } from "./events.js";
+import { ICON, iconFor } from "./events.js";
 /** Первая буква — заглавная, остальное как есть (ga4/GitHub остаются собой). */
 /**
  * Ярлык с большой буквы — но НЕ у имени, которое пишется со строчной нарочно:
@@ -414,6 +414,10 @@ const renderDeploy = (e) => {
         ...twoBlocks([field('Target', e.target), field('Reason', e.note)], [fieldLink('Commit', e.commitUrl, e.commit), titleField(e.commitTitle), bodyQuote(e.commitBody)])
     ]);
 };
+const schedule = (expected, lastSeen, lastLabel) => {
+    const rows = [field('Expected', expected), field(lastLabel, lastSeen)].filter((r) => r !== null);
+    return rows.length > 0 ? ['', group('Schedule'), ...rows] : [];
+};
 const renderJob = (e) => {
     const icon = iconFor(e);
     const hasItems = (e.items ?? []).length > 0;
@@ -424,22 +428,18 @@ const renderJob = (e) => {
     // were two words for one thing, and the outcome that took the first line is
     // already the icon, and now the third tag too.
     //
-    // `disabled` and `silent` keep a word of their own. A red mark reads as
-    // "it broke", and neither of those is that: one was switched off on purpose
-    // and the other has not been heard from at all.
-    const state = e.status === 'disabled'
-        ? 'switched off, not broken'
-        : e.status === 'silent'
-            ? 'no word from it at all'
-            : undefined;
+    // There is no `State:` row. It said "switched off, not broken" under a 🚫
+    // and "no word from it at all" under a ❓ — the third way of saying what the
+    // icon says and what the third tag now says too. The icon table on the
+    // catalogue page defines both marks.
     return join([
-        typeLine(icon, 'Job', e.job, e.workflowUrl ?? e.url),
-        field('State', state),
+        typeLine(icon, 'Job', e.job, e.workflowUrl ?? e.url, e.aside),
         field('Reason', e.note),
-        field('Expected', e.expected),
-        // `Last run` when the task is alive, `Last seen` when it is not: the same
-        // timestamp answers two different questions.
-        field(e.status === 'silent' ? 'Last seen' : 'Last run', e.lastSeen),
+        // The timetable is a different subject from this event: how often the task
+        // owes a sign of life and when it last gave one. It stood in a bare run
+        // under `Reason:` and read as more of the same. `Last run` when the task
+        // is alive, `Last seen` when it is not — one timestamp, two questions.
+        ...schedule(e.expected, e.lastSeen, e.status === 'silent' ? 'Last seen' : 'Last run'),
         ...labelled(e.stats),
         hasItems ? '' : null,
         // Heading ONLY for `disabled`. It used to print for any job carrying a
@@ -464,7 +464,7 @@ const renderReport = (e) => {
         // without a word.
         const numbers = labelled(e.lines);
         return join([
-            typeLine(iconFor(e), 'Report', e.title, e.url, e.period),
+            typeLine(iconFor(e), 'Report', e.title, e.url, e.aside),
             // Rows with no group of their own sit flush against the header instead of
             // forming a separate slab under a blank line. `labelled` puts the blank
             // line before the first group itself, so there is none here.
@@ -477,7 +477,7 @@ const renderReport = (e) => {
     return join([
         // Both analytics jobs send a link to the day's snapshot in docs/. It used to
         // hang off a trailing `Details: open` row; now it is the report's own name.
-        typeLine(iconFor(e), 'Report', e.title, e.url, e.period),
+        typeLine(iconFor(e), 'Report', e.title, e.url, e.aside),
         // Flush against the header — see the branch above.
         ...labelled(e.lines),
         items.length > 0 ? '' : null,
@@ -560,8 +560,7 @@ const renderHeartbeatMiss = (e) => {
         // copy of that watchdog can, and the card it gets must obey the template.
         typeLine(icon, 'Heartbeat', e.job, undefined, action),
         field('Reason', e.note),
-        field('Expected', e.expected),
-        field(e.recovered ? 'Last run' : 'Last seen', e.lastSeen)
+        ...schedule(e.expected, e.lastSeen, e.recovered ? 'Last run' : 'Last seen')
     ]);
 };
 const RENDERERS = {
@@ -640,21 +639,28 @@ export const eventKey = (e) => {
  * Одно нажатие в Telegram собирает все падения проекта разом, каким бы типом
  * они ни пришли — выкатка, проверка, задача по расписанию, авария.
  *
- * Значение берётся у ЗНАЧКА, а не у слова статуса, и это не мелочь: значок уже
- * единственный источник правды про звук, и второй список «что считать
- * падением» разошёлся бы с первым — так уже было, когда красная карточка
- * приходила беззвучной. Громкий значок — `#fail`, зелёный — `#ok`, всё
- * остальное (завели задачу, открыли PR, попросили правки, отчёт) — `#news`:
- * это новость, а не приговор робота.
+ * The value comes from the ICON, never from the status word. The icon is
+ * already the single source of truth for the sound, and a second list of "what
+ * counts as broken" would drift from the first — it already did once, when a
+ * red card arrived silent.
+ *
+ * One icon meaning, one tag. A watchdog that SWITCHED SOMETHING OFF is not a
+ * failure and must not be filed under the same word as one: the owner read
+ * `#fail` under a 🚫 and said so. Nor is a task that has simply gone quiet —
+ * nobody knows yet whether it broke, and `#unknown` is the honest word for it.
  */
-const OK_ICONS = new Set([ICON.ok, ICON.landed, ICON.approved]);
-const outcomeTag = (e) => {
-    const icon = iconFor(e);
-    if (LOUD.has(icon)) {
-        return 'fail';
-    }
-    return OK_ICONS.has(icon) ? 'ok' : 'news';
+export const OUTCOME_TAG = {
+    [ICON.red]: 'fail',
+    [ICON.alarm]: 'fail',
+    [ICON.off]: 'off',
+    [ICON.unknown]: 'unknown',
+    [ICON.ok]: 'ok',
+    [ICON.landed]: 'ok',
+    [ICON.approved]: 'ok'
 };
+// Everything left over — a task was opened, a PR opened, edits asked for, a
+// digest — is news: something happened, no verdict was passed.
+export const outcomeTag = (e) => OUTCOME_TAG[iconFor(e)] ?? 'news';
 const tagsLine = (e) => `#${TYPE_TAG[e.type]} #${esc(eventKey(e))} #${outcomeTag(e)}`;
 /**
  * Строка тегов для свободного HTML (`sendReport`). Тег — это ФИЛЬТР владельца,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikitasazan/notify",
-  "version": "1.6.2",
+  "version": "1.8.0",
   "description": "Единая типизированная отправка Telegram-уведомлений (форум-темы, маршрутизация, ретраи) для всех проектов",
   "type": "module",
   "license": "MIT",