@nirvana/contracts

Protocol Buffers контракты для платформы Nirvana.

Описание

Этот пакет содержит определения .proto файлов и автоматически генерируемый TypeScript код для взаимодействия между микросервисами платформы Nirvana. Используется ts-proto для генерации типобезопасного кода, совместимого с NestJS.

Установка

npm install @nirvana/contracts

Структура проекта

contracts/
├── proto/           # Исходные .proto файлы
│   └── auth.proto   # Контракты сервиса аутентификации
├── gen/             # Автоматически сгенерированный TypeScript код
│   └── auth.ts
└── package.json

Доступные контракты

Auth Service

Сервис аутентификации с методами:

• SendOtp - Отправка одноразового пароля

Пример использования:

import { SendOtpRequest, SendOtpResponse, AuthServiceClient } from '@nirvana/contracts/gen/auth';

// В NestJS микросервисе
const request: SendOtpRequest = {
  identifier: '[email protected]',
  type: 'email'
};

const response: SendOtpResponse = await authService.sendOtp(request);

Разработка

Требования

• Node.js >= 16
• Protocol Buffers компилятор (protoc)

Установка зависимостей

npm install

Генерация TypeScript кода

После изменения .proto файлов необходимо перегенерировать TypeScript код:

npm run generate

Очистка сгенерированных файлов

npm run clean

Добавление новых контрактов

1. Создайте новый .proto файл в директории proto/
2. Определите ваши сообщения и сервисы согласно Protocol Buffers синтаксису
3. Запустите генерацию: npm run generate
4. Сгенерированный TypeScript код появится в директории gen/

Пример структуры .proto файла

syntax = "proto3";

package your_service.v1;

service YourService {
    rpc YourMethod (YourRequest) returns (YourResponse);
}

message YourRequest {
    string field = 1;
}

message YourResponse {
    bool success = 1;
}

CI/CD

Пакет автоматически публикуется в NPM при изменениях через GitHub Actions workflow.

Лицензия

ISC