@togatherlabs/shared-protos

TypeScript bindings for ToGather shared protocol buffer definitions.

This package provides type-safe gRPC and ConnectRPC interfaces generated from .proto files, ensuring consistency across all ToGather microservices.

Installation

pnpm add @togatherlabs/shared-protos

Usage

Import the generated types and services in your application:

import { AdminService } from "@togatherlabs/shared-protos/authservice/admin/v1";
import { UserService } from "@togatherlabs/shared-protos/userservice/user/v1";

Available Modules

• authservice/admin/v1 - Admin authentication service definitions
• userservice/user/v1 - User service definitions

Package Structure

dist/
├── authservice/
│   └── admin/
│       └── v1/
│           ├── admin_pb.d.ts
│           ├── admin_pb.js
│           └── index.js
└── userservice/
    └── user/
        └── v1/
            ├── user_pb.d.ts
            ├── user_pb.js
            └── index.js

Examples

• Added new optional field to proto → Minor
• Fixed type definition error → Patch
• Removed or renamed existing field → Major

Development

This package is auto-generated from proto definitions. Do not edit the generated files manually.

To regenerate:

# In the root repository
pnpm generate

Publishing

This package is automatically published via the root repository's publish script.

See the main repository README for publishing instructions.

Dependencies

Peer Dependencies:

• @bufbuild/protobuf ^2.9.0
• @connectrpc/connect ^2.1.0

Make sure these are installed in your consuming application.

Best Practices

1. Always use the latest version - Keep this package updated across all services
2. Import from specific paths - Use deep imports for better tree-shaking
3. Handle breaking changes carefully - Review changelog before major version updates
4. Type safety - Leverage TypeScript's type checking with these definitions

Support

For issues or questions, please refer to the main repository.

Maintained by the ToGather Engineering Team