@rsconcept/rstool 0.6.0 → 0.6.1

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.
@@ -1,6 +1,8 @@
1
1
  # Portal REST API
2
2
 
3
- Справка только для чтения существующих КС, ОСС и RSModel. `rstool` сам не ходит в REST API: он работает с in-memory сессиями.
3
+ Справка для чтения существующих КС, ОСС и RSModel из Portal и переноса КС в `rstool`.
4
+ `rstool` сам не ходит в REST API: он работает с in-memory сессиями.
5
+ Агент получает JSON Portal отдельно, затем переносит конституенты через контракт `rstool`.
4
6
 
5
7
  ## Хосты
6
8
 
@@ -16,17 +18,93 @@
16
18
  - Модель → `GET /api/models/:id`.
17
19
  - OpenAPI JSON → `GET https://api.portal.acconcept.ru/schema`.
18
20
 
21
+ Для UI-ссылки `https://portal.acconcept.ru/rsforms/856` агент должен ходить на:
22
+
23
+ ```text
24
+ GET https://api.portal.acconcept.ru/api/rsforms/856
25
+ GET https://api.portal.acconcept.ru/api/rsforms/856/details
26
+ ```
27
+
28
+ Не переноси UI query/hash вроде `?tab=editor`.
29
+
30
+ ## Доступ
31
+
32
+ - `access_policy: "public"` читается без авторизации.
33
+ - Приватная схема или модель вернёт `403` и не предназначена для агентов.
34
+ - Если нужны только `title`, `alias`, `description`, `owner`, `access_policy`, не запрашивай `/details`.
35
+
36
+ ## Формат `GET /api/rsforms/:id/details`
37
+
38
+ Ответ содержит метаданные объекта библиотеки и массив `items[]` с конституентами.
39
+ Для анализа КС обычно нужны только корневые `title`, `alias`, `description` и поля каждой конституенты.
40
+
41
+ | Portal JSON | `rstool` | Примечание |
42
+ | --------------------- | ------------------------ | ----------------------------------------------------- |
43
+ | `id` | `draft.id` | Стабильный id внутри сессии |
44
+ | `alias` | `draft.alias` | `X1`, `C1`, `S1`, `D1`, `F1`, `P1`, `A1`, `T1` |
45
+ | `cst_type` | `draft.cstType` | Значения совпадают с `CstType` |
46
+ | `definition_formal` | `draft.definitionFormal` | Пустая строка допустима только для `basic`/`constant` |
47
+ | `term_raw` | `draft.term` | Для редактирования сохраняй raw, не resolved |
48
+ | `definition_raw` | `draft.definitionText` | Для редактирования сохраняй raw, не resolved |
49
+ | `convention` | `draft.convention` | Соглашение, не формальная проверка |
50
+ | `term_resolved` | не переносить | Только отображение после resolver |
51
+ | `definition_resolved` | не переносить | Только отображение после resolver |
52
+ | `typification_manual` | обычно не переносить | Переопределение типизации |
53
+ | `term_forms` | обычно не переносить | Словоформы термина |
54
+ | `crucial` | обычно не переносить | UI/Portal-флаг |
55
+ | `value_is_property` | обычно не переносить | Переопределение класса интерпретируемости |
56
+
57
+ `inheritance`, `attribution`, `oss`, `models`, `versions`, `editors` полезны для контекста Portal, но не нужны для базовой проверки RSLang в `rstool`.
58
+
19
59
  ## Как перенести КС в rstool
20
60
 
21
61
  1. Получи `GET /api/rsforms/:id/details`.
22
- 2. Создай `createSession`.
23
- 3. Перенеси конституенты через `addOrUpdateConstituenta`: `alias`, `cstType`, `definitionFormal`, `term`, `definitionText`, `convention`.
24
- 4. Работай локально: анализ, правки, вычисления.
25
- 5. Для передачи результата используй `exportSession`.
62
+ 2. Создай `createSession({ title, alias, comment: description })`.
63
+ 3. Иди по `items[]` в порядке ответа API.
64
+ 4. Для каждого элемента вызови `addOrUpdateConstituenta(sessionId, { draft })`.
65
+ 5. Проверь `listDiagnostics(sessionId)`.
66
+ 6. Работай локально: анализ, правки, вычисления, маленькая КМ.
67
+ 7. Для сохранения рабочей сессии используй `exportSession`.
68
+ 8. Для загрузки схемы обратно в Portal используй `exportPortalSchema`.
69
+
70
+ Portal JSON из `/details` **не является** форматом `exportSession` и не передаётся
71
+ в `importSession` напрямую. Его нужно перенести через `addOrUpdateConstituenta`
72
+ или через отдельный адаптер, если он появится в контракте.
73
+
74
+ Минимальный маппинг:
75
+
76
+ ```ts
77
+ const session = tool.createSession({
78
+ title: portal.title,
79
+ alias: portal.alias,
80
+ comment: portal.description
81
+ });
82
+
83
+ for (const item of portal.items) {
84
+ tool.addOrUpdateConstituenta(session.sessionId, {
85
+ draft: {
86
+ id: item.id,
87
+ alias: item.alias,
88
+ cstType: item.cst_type,
89
+ definitionFormal: item.definition_formal ?? '',
90
+ term: item.term_raw ?? '',
91
+ definitionText: item.definition_raw ?? '',
92
+ convention: item.convention ?? ''
93
+ }
94
+ });
95
+ }
96
+ ```
97
+
98
+ ## Практика для агентов
99
+
100
+ - Запрашивай API host, а не UI host: `https://api.portal.acconcept.ru/api/...`.
101
+ - Для больших схем используй увеличенный таймаут. В PowerShell вызывай `curl.exe`,
102
+ а не alias `curl` (`Invoke-WebRequest`), если нужен CLI-синтаксис curl.
103
+ - Сначала бери метаданные, если нужно только название или доступность схемы.
26
104
 
27
105
  ## Не делай
28
106
 
29
107
  - Не парси HTML SPA.
30
- - Не переноси UI query/hash вроде `?tab=editor` в REST.
31
108
  - Не запрашивай UI напрямую, используй преобразованные API запросы.
109
+ - Не передавай `/details` JSON в `importSession`.
32
110
  - Не запрашивай `/details`, если нужны только метаданные.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rsconcept/rstool",
3
- "version": "0.6.0",
3
+ "version": "0.6.1",
4
4
  "description": "Agent-facing library for incremental RSForm construction, RSLang analysis, diagnostics, modeling, and evaluation. Wraps @rsconcept/domain with a deterministic session contract and stdio wrapper.",
5
5
  "license": "MIT",
6
6
  "author": "IRBorisov",
@@ -46,6 +46,21 @@
46
46
  9. Сохрани: `exportSession` / `importSession`.
47
47
  10. Для загрузки в Portal: `exportPortalSchema` (схема) или `exportPortalModel` (модель).
48
48
 
49
+ ### Оценка или правка КС из Portal
50
+
51
+ Когда пользователь даёт UI-ссылку вида `https://portal.acconcept.ru/rsforms/:id`,
52
+ не открывай SPA и не парси HTML. Преобразуй ссылку в REST API по правилам
53
+ [PORTAL-API.md](../../docs/PORTAL-API.md): метаданные `GET /api/rsforms/:id`,
54
+ полная КС `GET /api/rsforms/:id/details`, версия `GET /api/library/:id/versions/:version`.
55
+
56
+ Portal JSON из `/details` не является форматом `exportSession` и не передаётся в
57
+ `importSession` напрямую. Создай `createSession({ title, alias, comment: description })`
58
+ и перенеси `items[]` через `addOrUpdateConstituenta`, сохраняя raw-поля:
59
+ `cst_type → cstType`, `definition_formal → definitionFormal`,
60
+ `term_raw → term`, `definition_raw → definitionText`, `convention → convention`.
61
+ После переноса запусти `listDiagnostics`; для результата в Portal используй
62
+ `exportPortalSchema`, а для локального снапшота — `exportSession`.
63
+
49
64
  ### Концептуализация (КС из содержания источника)
50
65
 
51
66
  Когда нужно построить или существенно развить КС по тексту ПО, требованиям или предметному описанию. Правила редукции, слоёв и паттернов — [CONCEPTUAL-SCHEMA.md](../../docs/CONCEPTUAL-SCHEMA.md).
@@ -186,6 +186,10 @@ interface AnalysisResult {
186
186
  - `state.model.items[]` — присутствует, если заданы значения интерпретации.
187
187
  - `diagnostics[]` — накопленные диагностики со смещениями и кодами.
188
188
 
189
+ `importSession(payload)` принимает только этот формат `exportSession`. JSON Portal из
190
+ `GET /api/rsforms/:id/details` сначала переноси в сессию через `createSession` и
191
+ `addOrUpdateConstituenta`; поля и REST-пути описаны в `docs/PORTAL-API.md`.
192
+
189
193
  ## JSON импорта Portal
190
194
 
191
195
  Для **Load from JSON** на существующей схеме или модели Portal: