@marleena/trb-proto 1.0.37 → 1.0.38

package/README.md

@@ -1,85 +1,43 @@
 # TrB proto
 
-Контракты сервисов и сгенерированный код:
+Protobuf/gRPC-контракты сервисов TrB и сгенерированный код для нескольких языков.
 
-- Go — `gen/go`
-- JavaScript / TypeScript (protobuf + gRPC-Web) — npm-пакет [`@marleena/trb-proto`](https://www.npmjs.com/package/@marleena/trb-proto)
-- Python (protobuf + gRPC) — PyPI-пакет [`trb-proto`](https://pypi.org/project/trb-proto/)
+| Язык | Артефакт | Документация |
+|------|----------|--------------|
+| Go | модуль `github.com/Mar1eena/trb_proto` | [gen/go/README.md](gen/go/README.md) |
+| JavaScript / TypeScript | npm [`@marleena/trb-proto`](https://www.npmjs.com/package/@marleena/trb-proto) | [gen/js-ts/README.md](gen/js-ts/README.md) |
+| Python | PyPI [`trb-proto`](https://pypi.org/project/trb-proto/) | [gen/python/README.md](gen/python/README.md) |
 
 ## Генерация
 
-Нужны `protoc` и плагины: `protoc-gen-go`, `protoc-gen-go-grpc`, `protoc-gen-grpc-gateway`, `protoc-gen-js`, `protoc-gen-grpc-web`.
+Нужны `protoc` и плагины: `protoc-gen-go`, `protoc-gen-go-grpc`, `protoc-gen-grpc-gateway`, `protoc-gen-js`, `protoc-gen-grpc-web`, `grpc_tools` (Python).
 
 ```bash
 make gene
 ```
 
-Собирает Go, JS/TS и descriptor set. Google API-аннотации для JS генерируются отдельно, чтобы не попасть в `gen/go`.
+Собирает Go, JS/TS, Python (indicators) и descriptor set (`gen/desc/trb_protos.pb`). Google API-аннотации для JS генерируются отдельно, чтобы не попасть в `gen/go`.
 
 Другие цели: `make desc`, `make buf`.
 
-## npm
+## Сервисы
 
-```bash
-npm install @marleena/trb-proto
-```
-
-```ts
-import { MessageRequest } from '@marleena/trb-proto/example/Example_pb';
-import { exampleClient } from '@marleena/trb-proto/example/ExampleServiceClientPb';
-
-const client = new exampleClient('https://api.example.com');
-const req = new MessageRequest();
-req.setText('hello');
-```
-
-## Python
-
-```bash
-pip install trb-proto
-```
-
-```python
-from indicators import indicators_pb2 as pb
-from indicators import indicators_pb2_grpc
-
-stub = indicators_pb2_grpc.IndicatorsStub(channel)
-stub.ListSupported(pb.ListSupportedRequest())
-```
-
-Сервисы:
-
-Внешние контракты в `api/`: `api/tinvest`.
+Исходники proto — в `services/`.
 
-Свои сервисы: `clickhouse`, `nats`, `postgresql`, `test`.
+**Внешние контракты** (`services/api/`): `api/tinvest` — зеркало T-Invest API.
 
-`clickhouse` — два proto: `admin.proto` (`trb.clickhouse.v1.ClickHouse_Admin`) и `clickhouse.proto` (`trb.clickhouse.v1.ClickHouse`).
+**Свои сервисы:**
 
-`postgresql` — два proto: `admin.proto` (`trb.postgresql.v1.PostgreSQL_Admin`) и `postgresql.proto` (`trb.postgresql.v1.PostgreSQL`).
+| Каталог | gRPC-сервисы |
+|---------|--------------|
+| `clickhouse` | `ClickHouse_Admin`, `ClickHouse` |
+| `postgresql` | `PostgreSQL_Admin`, `PostgreSQL` |
+| `nats` | `Nats_Admin` |
+| `indicators` | `Indicators` |
+| `test` | `Test` |
 
-`postgresql` (`trb.postgresql.v1.PostgreSQL`) — цели планировщика: `ListSchedulerTargets`, `SyncSchedulerTargets`.
-
-`PostgreSQL_Admin` — DDL, мониторинг и произвольные запросы: базы, схемы, таблицы, колонки, индексы, VACUUM/ANALYZE, процессы, блокировки.
-
-`nats` (`trb.nats.v1.Nats`) — управление JetStream.
-
-`test` (`trb.test.v1.Test`) — тестовый оркестратор.
-
-## CI/CD
-
-[Release](.github/workflows/release.yml) на коммит `v1.2.3` в `main`: npm (если версии ещё нет), PyPI `trb-proto` и `POST /fetch/...` на [pkg.go.dev](https://pkg.go.dev/github.com/Mar1eena/trb_proto).
-
-Trusted Publisher: npm — GitHub `Mar1eena` / `TrB_proto` / `release.yml`; PyPI — [Pending publisher](https://pypi.org/manage/account/publishing/) для `trb-proto`:
-
-| Поле | Значение |
-|---|---|
-| PyPI project name | `trb-proto` |
-| Owner | `Mar1eena` |
-| Repository | `TrB_proto` |
-| Workflow name | `release.yml` |
-| Environment name | *(оставить пустым)* |
-
-Pending publisher нужен **до первого** `make rel`, если проекта `trb-proto` на PyPI ещё нет.
+`clickhouse` — `admin.proto` и `clickhouse.proto`.  
+`postgresql` — `admin.proto` (DDL, мониторинг) и `postgresql.proto` (планировщик: `ListSchedulerTargets`, `SyncSchedulerTargets`).
 
 ## Релиз
 
@@ -87,8 +45,18 @@ Pending publisher нужен **до первого** `make rel`, если про
 make rel
 ```
 
-Собирает proto, поднимает patch-версию, коммитит все изменения с сообщением `v1.2.3` и пушит в `main`. Actions публикует npm и обновляет pkg.go.dev.
+Собирает proto, поднимает patch-версию в `package.json` / `pyproject.toml`, коммитит с сообщением `v1.2.3` и пушит в `main`.
 
 Другой шаг версии: `make rel PART=minor` или `PART=major`.
 
 Для коммита нужны `user.name` и `user.email` в Git.
+
+## CI/CD
+
+[Release](.github/workflows/release.yml) на коммит `v1.2.3` в `main`:
+
+- npm — `@marleena/trb-proto` (если версии ещё нет)
+- PyPI — `trb-proto`
+- Go — обновление [pkg.go.dev](https://pkg.go.dev/github.com/Mar1eena/trb_proto)
+
+Подробности публикации — в README соответствующего языка.

package/gen/js-ts/README.md

@@ -0,0 +1,72 @@
+# TrB proto — JavaScript / TypeScript
+
+Сгенерированные protobuf-сообщения и gRPC-Web клиенты.
+
+## Установка
+
+```bash
+npm install @marleena/trb-proto
+```
+
+Пакет публикуется на npm при релизе (`make rel` → GitHub Actions → `@marleena/trb-proto@x.y.z`).
+
+## Импорты
+
+Пути соответствуют каталогам в `gen/js-ts/`:
+
+```ts
+import { ListCandlesRequest } from '@marleena/trb-proto/clickhouse/clickhouse_pb';
+import { ClickhouseServiceClient } from '@marleena/trb-proto/clickhouse/ClickhouseServiceClientPb';
+
+import { ComputeRequest } from '@marleena/trb-proto/indicators/indicators_pb';
+import { IndicatorsServiceClient } from '@marleena/trb-proto/indicators/IndicatorsServiceClientPb';
+```
+
+T-Invest API:
+
+```ts
+import { SharesResponse } from '@marleena/trb-proto/api/tinvest/instruments_pb';
+import { InstrumentsServiceClient } from '@marleena/trb-proto/api/tinvest/InstrumentsServiceClientPb';
+```
+
+## Пример: gRPC-Web
+
+```ts
+import { ClickhouseServiceClient } from '@marleena/trb-proto/clickhouse/ClickhouseServiceClientPb';
+import { ListCandlesRequest } from '@marleena/trb-proto/clickhouse/clickhouse_pb';
+
+const client = new ClickhouseServiceClient('http://localhost:8081');
+
+const req = new ListCandlesRequest();
+req.setUid('…');
+req.setInterval(5);
+
+client.listCandles(req, {}, (err, resp) => {
+  if (err) throw err;
+  console.log(resp.getCandlesList());
+});
+```
+
+Envoy на `:8081` транскодирует HTTP/JSON ↔ gRPC (см. `TrB_backend/configs/envoy/envoy.yaml`).
+
+## Зависимости пакета
+
+- `google-protobuf`
+- `grpc-web`
+
+## Локальная разработка
+
+```bash
+# в TrB_proto
+make gene
+npm link
+
+# во frontend-проекте
+npm link @marleena/trb-proto
+```
+
+## Trusted Publisher (npm)
+
+GitHub `Mar1eena` / `TrB_proto` / workflow `release.yml`.
+
+[← Корневой README](../../README.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@marleena/trb-proto",
-  "version": "1.0.37",
+  "version": "1.0.38",
   "description": "Generated protobuf messages and gRPC-Web clients for TrB services",
   "license": "MIT",
   "repository": {