@vnejs/docs 0.2.21 → 0.2.22
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +13 -1
- package/README.md +1 -1
- package/package.json +1 -1
- package/plugins/core/storage.md +3 -3
- package/plugins/core/vendors.md +2 -6
- package/plugins/scenario/fastforward.md +16 -5
package/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,18 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
-
Краткая история изменений
|
|
3
|
+
Краткая история изменений движка (плагины, helpers, packages, CLI и прочий runtime) и внешнего API. Версии — релизы пакета `@vnejs/docs`.
|
|
4
|
+
|
|
5
|
+
## 0.2.22
|
|
6
|
+
|
|
7
|
+
- `scenario/fastforward` — цикл автоклика в модуле `fastforward.emit`; провал `CHECK` эмитит `STOP`. `isFastforwardOn` сбрасывается через `setValue(false)` в `init`, не на `SYSTEM.STARTED`. Визиты в `shared.fastforwardStorage`; диск в `fastforward.storage`. API: `shared.fastforwardStorage`, `EVENTS.FASTFORWARD.VISIT_ADD`, модули `fastforward.emit`, `fastforward.scenario`, `fastforward.storage`.
|
|
8
|
+
- `core/vendors` — события `UID`, `HASH`, `DATE`, `DEBOUNCE` сняты; остались `CLONE`, `SCREEN`. Вместо них: `crypto.randomUUID()`, `hashSha256`, `formatTimestamp`, `debounce`.
|
|
9
|
+
- `helpers/hash-sha256` — SHA-256 объекта: `hashSha256(value, maxLength?)`; ключи канонизируются. `maxLength` пока не передают.
|
|
10
|
+
- `helpers/format-timestamp` — `formatTimestamp({ ts, format })`; токены `YYYY`, `MM`, `DD`, `HH`, `mm`, `ss`.
|
|
11
|
+
- `helpers/debounce` — `debounce({ fn, wait, maxWait, leading, trailing })`.
|
|
12
|
+
- `core/logs`, `text/text`, `canvas/bg`, `canvas/video`, `views.screens/history` — uid через `crypto.randomUUID()`, не `VENDORS.UID`.
|
|
13
|
+
- `core/scenario`, `core/state`, `scenario/fastforward` — хеш строки / visits через `hashSha256`, не `VENDORS.HASH`.
|
|
14
|
+
- `views.screens/save` — дата и время слота через `formatTimestamp`, не `VENDORS.DATE`.
|
|
15
|
+
- `platform/electron` — сохранение state через `debounce`, не `VENDORS.DEBOUNCE`.
|
|
4
16
|
|
|
5
17
|
## 0.2.21
|
|
6
18
|
|
package/README.md
CHANGED
|
@@ -28,7 +28,7 @@ npm i @vnejs/docs
|
|
|
28
28
|
- [Сценарий — guide](./scenario.guide/README.md) — синтаксис `.vne` и тематические гайды
|
|
29
29
|
- [Сценарий — catalog](./scenario.catalog/README.md) — каталог `$` / `%` команд
|
|
30
30
|
- [Архитектура](./architecture.md) — каталоги монорепы и их связи, mermaid-диаграммы
|
|
31
|
-
- [Changelog](./CHANGELOG.md) — изменения
|
|
31
|
+
- [Changelog](./CHANGELOG.md) — изменения движка и API по версиям `@vnejs/docs`
|
|
32
32
|
|
|
33
33
|
## Быстрый ориентир по монорепе
|
|
34
34
|
|
package/package.json
CHANGED
package/plugins/core/storage.md
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
|
|
11
11
|
- Если `group` не передан — подставляется `_` (default group).
|
|
12
12
|
- `key` может содержать `:` (например settings `vne:volume:common`).
|
|
13
|
-
- `module` может содержать `.` (например `vars.global`, `fastforward.
|
|
13
|
+
- `module` может содержать `.` (например `vars.global`, `fastforward.storage`).
|
|
14
14
|
|
|
15
15
|
Примеры:
|
|
16
16
|
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
|-------|-----------------|
|
|
19
19
|
| `{ module: "settings", key: "vne:volume:common" }` | `settings/_/vne:volume:common` |
|
|
20
20
|
| `{ module: "save", group: "0", key: "3" }` | `save/0/3` |
|
|
21
|
-
| `{ module: "fastforward.
|
|
21
|
+
| `{ module: "fastforward.storage", group: "intro", key: "hash" }` | `fastforward.storage/intro/hash` |
|
|
22
22
|
|
|
23
23
|
## Диск (desktop / Steam)
|
|
24
24
|
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
| `_` или не задан | `{module}.json` |
|
|
28
28
|
| любая другая | `{module}/{group}.json` |
|
|
29
29
|
|
|
30
|
-
Примеры: `settings.json`, `save/0.json`, `save/autosave.json`, `fastforward.
|
|
30
|
+
Примеры: `settings.json`, `save/0.json`, `save/autosave.json`, `fastforward.storage/intro.json`.
|
|
31
31
|
|
|
32
32
|
## События
|
|
33
33
|
|
package/plugins/core/vendors.md
CHANGED
|
@@ -2,18 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
Пакет: `@vnejs/plugins.core.vendors` · namespace: `VENDORS`
|
|
4
4
|
|
|
5
|
-
Обёртки над сторонними утилитами: clone,
|
|
5
|
+
Обёртки над сторонними утилитами: clone, скриншот.
|
|
6
6
|
|
|
7
7
|
## События
|
|
8
8
|
|
|
9
9
|
| Ключ | Строка | Смысл |
|
|
10
10
|
|------|--------|-------|
|
|
11
|
-
| `UID` | `vne:vendors:uid` | Сгенерировать уникальный идентификатор uuid4. |
|
|
12
|
-
| `HASH` | `vne:vendors:hash` | MD5-хеш объекта (идентификация строки сценария, проверка сохранений). |
|
|
13
|
-
| `DATE` | `vne:vendors:date` | Форматирование timestamp через dayjs. Payload: `{ ts?, format? }`. |
|
|
14
11
|
| `CLONE` | `vne:vendors:clone` | Deep clone через lodash (state, stack, args). |
|
|
15
12
|
| `SCREEN` | `vne:vendors:screen` | Скриншот DOM через html2canvas → webp data URL. Payload: `{ width?, height?, quality?, id? }`. |
|
|
16
|
-
| `DEBOUNCE` | `vne:vendors:debounce` | Вернуть lodash-debounced функцию. Payload: `{ func?, wait?, options? }`. |
|
|
17
13
|
|
|
18
14
|
## Константы
|
|
19
15
|
|
|
@@ -31,7 +27,7 @@
|
|
|
31
27
|
|
|
32
28
|
| Модуль | Зона ответственности |
|
|
33
29
|
|--------|----------------------|
|
|
34
|
-
| `vendors` |
|
|
30
|
+
| `vendors` | clone. |
|
|
35
31
|
| `vendors.screen` | html2canvas screenshot; на init помечает media-элементы ignore. |
|
|
36
32
|
|
|
37
33
|
## Близкие плагины
|
|
@@ -15,11 +15,14 @@
|
|
|
15
15
|
| `EMIT_CHECK` | `vne:fastforward:emit_check` | Инициировать действие или цикл. |
|
|
16
16
|
| `CHECK` | `vne:fastforward:check` | Проверить состояние или наличие ресурса. |
|
|
17
17
|
| `CHANGED` | `vne:fastforward:changed` | Зафиксировать изменение состояния. |
|
|
18
|
+
| `VISIT_ADD` | `vne:fastforward:visit_add` | Записать визит: `shared.fastforwardStorage` + стейт и `STORAGE.SET`. Payload: `key`, `group`, поля `SCENARIO.EXEC`. |
|
|
18
19
|
| `CLEAR` | `vne:fastforward:clear` | Очистить накопленное состояние. |
|
|
19
20
|
|
|
20
21
|
## Константы
|
|
21
22
|
|
|
22
|
-
|
|
23
|
+
| Ключ | Смысл |
|
|
24
|
+
|------|--------|
|
|
25
|
+
| `SOURCE` | `"fastforward"` — ключ в SourcesSet соседних плагинов. |
|
|
23
26
|
|
|
24
27
|
## Параметры
|
|
25
28
|
|
|
@@ -37,12 +40,22 @@
|
|
|
37
40
|
| `DELAY` (`vne:fastforward:delay`) | `number` | Настройка `vne:fastforward:delay` в `shared.settings`. |
|
|
38
41
|
| `ENABLED` (`vne:fastforward:enabled`) | `boolean` | Включить или выключить функцию. |
|
|
39
42
|
|
|
43
|
+
## Shared
|
|
44
|
+
|
|
45
|
+
| Поле | Тип | Смысл |
|
|
46
|
+
|------|-----|--------|
|
|
47
|
+
| `isFastforwardOn` | `boolean` | Режим прокрутки включён. В `init` модуля `fastforward` сбрасывается через `setValue(false)`; дальше — `START` / `STOP` / `TOGGLE`. |
|
|
48
|
+
| `fastforwardStorage` | `Set<string>` | Хеши уже просмотренных строк; наполняется из `STORAGE` в `init` модуля `fastforward.storage`. |
|
|
49
|
+
|
|
40
50
|
## Модули
|
|
41
51
|
|
|
42
52
|
| Модуль | Зона ответственности |
|
|
43
53
|
|--------|----------------------|
|
|
44
|
-
| `fastforward` |
|
|
45
|
-
| `fastforward.
|
|
54
|
+
| `fastforward` | `STOP`, `START`, `CHECK`, `TOGGLE`; в `init` — `setValue(false)`. |
|
|
55
|
+
| `fastforward.emit` | Цикл `EMIT` / `EMIT_CHECK`: `CHECK` → `INTERACT.EMIT`; провал `CHECK` → `STOP`. |
|
|
56
|
+
| `fastforward.scenario` | `SCENARIO.EXEC` → hash стейта `fastforward.visits` и `VISIT_ADD`. |
|
|
57
|
+
| `fastforward.visits` | `VISIT_ADD` пишет в `shared.fastforwardStorage` и снимок стейта. `CHECK` читает Set. |
|
|
58
|
+
| `fastforward.storage` | `VISIT_ADD` → `STORAGE.SET` с `module` = `this.name`. `GET_ALL` / `RM_ALL` / `CLEAR`. `group` = label, `key` = hash; при init hash берётся из хвоста ключа. На диске: `fastforward.storage/{label}.json`. |
|
|
46
59
|
|
|
47
60
|
## Близкие плагины
|
|
48
61
|
|
|
@@ -53,8 +66,6 @@
|
|
|
53
66
|
- [settings.md](../core/settings.md) — `SETTINGS`: EVENTS.INIT
|
|
54
67
|
- [state.md](../core/state.md) — `STATE`: EVENTS.CLEAR, EVENTS.SET
|
|
55
68
|
- [storage.md](../core/storage.md) — `STORAGE`: EVENTS.GET_ALL, EVENTS.SET, EVENTS.RM_ALL
|
|
56
|
-
- [system.md](../core/system.md) — `SYSTEM`: EVENTS.STARTED
|
|
57
|
-
- [vendors.md](../core/vendors.md) — `VENDORS`: EVENTS.HASH
|
|
58
69
|
|
|
59
70
|
### Остальные
|
|
60
71
|
|