@argus-labs/proto
Version:
Generated TypeScript protobuf definitions for Argus Labs World Engine
64 lines (45 loc) • 1.47 kB
Markdown
# @argus-labs/proto
Generated TypeScript protobuf definitions for Argus Labs World Engine.
## Installation
```bash
npm install @argus-labs/proto
# or
pnpm add @argus-labs/proto
# or
yarn add @argus-labs/proto
```
## Usage
### Import all types
```typescript
import * as proto from '@argus-labs/proto'
// Use types
const query: proto.QueryRequest = {
// ...
}
```
### Import specific modules
```typescript
// Gateway types
import { QueryRequest, QueryResponse } from '@argus-labs/proto/gateway/v1/query_pb'
import { SendCommandRequest, SendCommandResponse } from '@argus-labs/proto/gateway/v1/send_command_pb'
// ISC types
import { Event } from '@argus-labs/proto/isc/v1/event_pb'
import { Command, SignedCommand } from '@argus-labs/proto/isc/v1/command_pb'
// Micro types
import { ServiceAddress } from '@argus-labs/proto/micro/v1/service_pb'
```
## Generated Files
This package contains auto-generated TypeScript definitions from protobuf files:
- **Gateway v1**: Communication protocols for the gateway service
- **ISC v1**: Inter-service communication types (commands, events, queries, epochs)
- **Micro v1**: Microservice utilities (ping/pong, service addressing)
- **Google RPC**: Standard Google RPC types
- **Buf Validate**: Validation rules for protobuf messages
## Development
These files are auto-generated. Do not edit them directly. To regenerate:
```bash
# From the root of the go-ecs repository
pnpm buf generate
```
## License
ISC