vimp-engine 0.38.3 → 0.40.0

package/src/client/components/view/Voice.js

@@ -0,0 +1,172 @@
+// Singleton VoiceView
+
+let voiceView;
+
+const SVG_NS = 'http://www.w3.org/2000/svg';
+const RING_RADIUS = 15;
+const RING_LENGTH = 2 * Math.PI * RING_RADIUS;
+
+// константная разметка значка микрофона: капсула, дуга держателя, ножка
+// (перечёркивание — .voice-cross)
+const MIC_SVG =
+  '<rect x="9" y="3" width="6" height="11" rx="3"/>' +
+  '<path d="M5 11a7 7 0 0 0 14 0M12 18v3"/>' +
+  '<path class="voice-cross" d="M4 4l16 16"/>';
+
+function createIcon() {
+  const svg = document.createElementNS(SVG_NS, 'svg');
+
+  svg.setAttribute('class', 'voice-icon');
+  svg.setAttribute('aria-hidden', 'true');
+  svg.setAttribute('viewBox', '0 0 24 24');
+  svg.innerHTML = MIC_SVG;
+
+  return svg;
+}
+
+export default class VoiceView {
+  /**
+   * @param {Object} model
+   * @param {HTMLElement} container - точка монтирования (контейнер игры).
+   */
+  constructor(model, container = document.body) {
+    if (voiceView) {
+      return voiceView;
+    }
+
+    voiceView = this;
+
+    this._hud = document.createElement('div');
+    this._hud.id = 'voice-hud';
+
+    const own = document.createElement('div');
+    const incoming = document.createElement('div');
+    const ring = document.createElementNS(SVG_NS, 'svg');
+
+    own.className = 'voice-own';
+    incoming.className = 'voice-incoming';
+
+    ring.setAttribute('class', 'voice-ring');
+    ring.setAttribute('aria-hidden', 'true');
+    ring.setAttribute('viewBox', '0 0 36 36');
+    ring.innerHTML = `<circle cx="18" cy="18" r="${RING_RADIUS}"/>`;
+    this._circle = ring.firstChild;
+    this._circle.style.strokeDasharray = String(RING_LENGTH);
+
+    this._timerElem = document.createElement('span');
+    this._timerElem.className = 'voice-timer';
+    this._timerElem.setAttribute('aria-hidden', 'true');
+
+    this._textElem = document.createElement('span');
+    this._textElem.className = 'voice-text';
+    this._textElem.setAttribute('role', 'status');
+    this._textElem.setAttribute('aria-live', 'polite');
+
+    this._nameElem = document.createElement('span');
+    this._nameElem.className = 'voice-name';
+
+    own.append(createIcon(), ring, this._timerElem, this._textElem);
+    incoming.append(createIcon(), this._nameElem);
+    this._hud.append(own, incoming);
+    container.appendChild(this._hud);
+
+    this._own = null;
+    this._raf = null;
+
+    model.publisher.on('own', 'renderOwn', this);
+    model.publisher.on('incoming', 'renderIncoming', this);
+  }
+
+  // свой эфир: класс состояния, текст, цикл отсчёта
+  renderOwn(data) {
+    const { kind, text, endsAt, totalMs } = data;
+
+    for (const name of ['talking', 'busy', 'cooldown', 'error']) {
+      this._hud.classList.toggle(`is-${name}`, name === kind);
+    }
+
+    this._textElem.textContent = text;
+
+    if (kind === 'talking' || kind === 'cooldown') {
+      this._own = { kind, endsAt, totalMs };
+
+      if (this._raf === null) {
+        this._raf = requestAnimationFrame(() => this._tick());
+      }
+
+      return;
+    }
+
+    this._stopCountdown();
+  }
+
+  // чужой эфир: ник как текст, цвет как у чата
+  renderIncoming(speaker) {
+    this._hud.classList.toggle('is-incoming', Boolean(speaker));
+
+    for (const className of [...this._nameElem.classList]) {
+      if (className.startsWith('voice-team')) {
+        this._nameElem.classList.remove(className);
+      }
+    }
+
+    if (!speaker) {
+      this._nameElem.textContent = '';
+      this._nameElem.style.removeProperty('--voice-name-color');
+
+      return;
+    }
+
+    this._nameElem.textContent = speaker.name;
+
+    if (Number.isInteger(speaker.teamId)) {
+      this._nameElem.classList.add(`voice-team${speaker.teamId}`);
+    }
+
+    if (speaker.color) {
+      this._nameElem.style.setProperty('--voice-name-color', speaker.color);
+    } else {
+      this._nameElem.style.removeProperty('--voice-name-color');
+    }
+  }
+
+  destroy() {
+    this._stopCountdown();
+    this._hud.remove();
+  }
+
+  _tick() {
+    const own = this._own;
+
+    this._raf = null;
+
+    // вид сменился после планирования кадра
+    if (!own || (own.kind !== 'talking' && own.kind !== 'cooldown')) {
+      return;
+    }
+
+    const remaining = Math.max(0, own.endsAt - performance.now());
+
+    this._timerElem.textContent = `${(remaining / 1000).toFixed(1)}s`;
+
+    // у кулдауна кольца нет
+    this._circle.style.strokeDashoffset = String(
+      own.kind === 'talking' && own.totalMs > 0
+        ? RING_LENGTH * (1 - remaining / own.totalMs)
+        : RING_LENGTH,
+    );
+
+    this._raf = requestAnimationFrame(() => this._tick());
+  }
+
+  _stopCountdown() {
+    if (this._raf !== null) {
+      cancelAnimationFrame(this._raf);
+      this._raf = null;
+    }
+
+    this._own = null;
+    this._timerElem.textContent = '';
+    this._circle.style.strokeDashoffset = String(RING_LENGTH);
+  }
+}

package/src/client/lib/formBuilder.js

@@ -4,9 +4,10 @@ import { resolveDescriptor } from '../../lib/formControls.js';
 import { toDisplay, toStored, isNumericField } from '../../lib/formUnit.js';
 
 // Общий билдер полей форм (room-форма и auth-форма используют один
-// контракт дескрипторов — docs.vimp.lgick.dev/en/plugin-api, раздел "Form
-// schema"). control: 'select'|'text'|'checkbox'|'radio'; все контролы —
-// нативные элементы формы, без визуальной кастомизации.
+// контракт дескрипторов —
+// VIMP docs: plugin-api.md § "Form schema"). control:
+// 'select'|'text'|'checkbox'|'radio'; все контролы — нативные элементы формы,
+// без визуальной кастомизации.
 //
 // Имя контрола приезжает от игры и разрешается через append-only реестр
 // (lib/formControls.js): имена, выведенные из эксплуатации в v3 ('range',
@@ -270,8 +271,8 @@ const builders = {
 // control» на имени, которое реестр считает живым
 export const FORM_CONTROLS = Object.keys(builders);
 
-// строит одно поле формы по дескриптору (docs.vimp.lgick.dev/en/plugin-api,
-// "Form schema")
+// строит одно поле формы по дескриптору
+// (VIMP docs: plugin-api.md § "Form schema")
 export function buildField(descriptor, ctx = {}) {
   // алиас выведенного контрола ('range' → numeric 'text') разрешается
   // здесь же, где строится поле, и теми же правилами, что в валидации
@@ -292,7 +293,7 @@ export function buildField(descriptor, ctx = {}) {
 }
 
 // засеивает default каждого дескриптора room-формы значением из roomDefaults
-// (docs.vimp.lgick.dev/en/plugin-api "Form schema": roomDefaults остаётся
+// (VIMP docs: plugin-api.md § "Form schema": roomDefaults остаётся
 // единственным источником значений по умолчанию); явный descriptor.default,
 // если он есть в схеме, побеждает. Вынесено из populateRoomForm (main.js),
 // чтобы этот же код был накрыт тестом, а не продублирован в нём

package/src/client/lib/hostVoteCommand.js

@@ -1,6 +1,6 @@
 // Голосование «Change host» (host-migration этап 10): команда /changehost и
 // окно у гостей. Голоса считает мастер, поэтому команда в лобби-режиме не
-// уходит хосту. В solo/dedicated мастера нет — команда остаётся обычным
+// уходит хосту. В solo мастера нет — команда остаётся обычным
 // текстом для игры.
 
 // имя голосования движка; префикс '@' зарезервирован движком
@@ -13,7 +13,7 @@ const COMMAND = '/changehost';
 /**
  * Разбор сообщения чата.
  * @param {string} text
- * @param {string} bootMode - 'lobby' | 'solo' | 'dedicated'.
+ * @param {string} bootMode - 'lobby' | 'solo'.
  * @returns {'start'|'usage'|null} null — не перехватывать.
  */
 export function parseChangeHost(text, bootMode) {

package/src/client/lib/pickActiveGame.js

@@ -19,23 +19,14 @@ export function isGameAvailable(manifest) {
 }
 
 /**
- * Активная игра вкладки.
- *
- * Обе ветки фильтруются одинаково: сохранённый выбор игры (`gameId`) тоже мог
- * указывать на игру, ставшую недоступной после обновления движка, и брать её
- * «раз уж попросили» значило бы падать там, где можно объяснить.
+ * Активная игра вкладки: первая доступная игра каталога.
  * @param {Array<Object>} manifests - Каталог мастера.
- * @param {string} [gameId] - Сохранённый выбор игры (boot.gameId).
  * @returns {Object|undefined} Манифест активной игры.
  * @throws {Error} Если каталог непустой, но играбельной игры в нём нет —
  *   с причиной по каждой строке.
  */
-export function pickActiveGame(manifests, gameId) {
-  const active = gameId
-    ? manifests.find(
-        manifest => manifest.id === gameId && isGameAvailable(manifest),
-      )
-    : manifests.find(isGameAvailable);
+export function pickActiveGame(manifests) {
+  const active = manifests.find(isGameAvailable);
 
   if (active) {
     return active;

package/src/client/lib/retryOnNetworkError.js

@@ -19,15 +19,6 @@ export class NetworkFailure extends Error {
 
 export const isNetworkFailure = error => error instanceof NetworkFailure;
 
-/**
- * Оборачивает отказ чтения тела ответа: SyntaxError — это мусор в JSON,
- * любой другой отказ (TypeError обрыва) — сбой сети.
- * @param {Error} error
- * @returns {Error}
- */
-export const bodyReadFailure = error =>
-  error instanceof SyntaxError ? error : new NetworkFailure(error);
-
 /**
  * @param {Function} doFetch - (...args) => Promise<Response>: сам fetch.
  * @param {*} url

package/src/client/lib/voiceState.js

@@ -0,0 +1,78 @@
+// Сервис пула зависимостей `voice`: кто сейчас в эфире.
+//
+// Сервис только читает (его получают парты игры — индикаторы над танком,
+// на радаре); пишет хранилище, которым владеет движок: оно применяет
+// разобранные сообщения VOICE_DATA. START/STOP приходят только слушателям
+// канала, поэтому противник при командном режиме не узнаёт о говорящем
+// ничего.
+//
+// Ключи — строки: id в part приходит ключом кадра (строкой), а на проводе
+// это число.
+export function createVoiceState({ now = () => performance.now() } = {}) {
+  // String(speakerId) → { talkId, since, name }
+  const talks = new Map();
+  let enabled = false;
+
+  const service = Object.freeze({
+    // связь в этом матче включена (конфиг + контур с ретранслятором)
+    get enabled() {
+      return enabled;
+    },
+
+    isTalking(id) {
+      return talks.has(String(id));
+    },
+
+    // момент START по часам клиента (мс performance.now) или null — фаза
+    // анимации индикатора
+    talkingSince(id) {
+      return talks.get(String(id))?.since ?? null;
+    },
+  });
+
+  const store = {
+    setEnabled(flag) {
+      enabled = flag === true;
+    },
+
+    // разобранное parseVoiceMessage; прочие типы игнорируются
+    apply(message) {
+      if (message?.type === 'start') {
+        talks.set(String(message.speakerId), {
+          talkId: message.talkId,
+          since: now(),
+          name: message.name,
+        });
+      } else if (message?.type === 'stop') {
+        const key = String(message.speakerId);
+
+        // поздний STOP старого эфира не гасит новый
+        if (talks.get(key)?.talkId === message.talkId) {
+          talks.delete(key);
+        }
+      }
+    },
+
+    // эфир, не закрытый STOP дольше maxAgeMs, гаснет сам (страховка при
+    // потерянном STOP). Возвращает число погашенных
+    expire(maxAgeMs) {
+      const current = now();
+      let removed = 0;
+
+      for (const [key, talk] of talks) {
+        if (current - talk.since > maxAgeMs) {
+          talks.delete(key);
+          removed += 1;
+        }
+      }
+
+      return removed;
+    },
+
+    clear() {
+      talks.clear();
+    },
+  };
+
+  return { service, store };
+}