@togatherlabs/shared-protos 1.0.20 → 1.0.21

package/README.md

@@ -1,73 +1,90 @@
-# 📦 ToGather TypeScript Package
+# @togatherlabs/shared-protos
 
-This package contains a shared **TypeScript package** used across the ToGather ecosystem.
+TypeScript bindings for ToGather shared protocol buffer definitions.
 
-It provides reusable modules, types, and utilities that ensure **consistency**, **type safety**, and **faster development** across all ToGather backend and frontend services.
+This package provides type-safe gRPC and ConnectRPC interfaces generated from `.proto` files, ensuring consistency across all ToGather microservices.
 
-## Overview
-
-This package is published to the **ToGather NPM organization** under:
+## Installation
 
 ```bash
-@togatherr/togather-shared-protos
+pnpm add @togatherlabs/shared-protos
 ```
 
-It is designed for internal use within our microservices architecture.
+## Usage
 
-## Installation
+Import the generated types and services in your application:
 
-Install the package using **pnpm**:
-
-```bash
-pnpm add @togatherr/togather-shared-protos
+```typescript
+import { AdminService } from "@togatherlabs/shared-protos/authservice/admin/v1";
+import { UserService } from "@togatherlabs/shared-protos/userservice/user/v1";
 ```
 
-## Usage Example
+### Available Modules
 
-```ts
-import { LoginRequestSchema } from "@togatherr/togather-shared-protos";
-```
+- `authservice/admin/v1` - Admin authentication service definitions
+- `userservice/user/v1` - User service definitions
 
-## Versioning Rules
+## Package Structure
 
-We use **Semantic Versioning (SemVer)**:
+```
+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
+```
 
-| Change Type | Example             | Description                                  |
-| ----------- | ------------------- | -------------------------------------------- |
-| **Patch**   | `npm version patch` | Fixes or small improvements (no API changes) |
-| **Minor**   | `npm version minor` | Adds backward-compatible features            |
-| **Major**   | `npm version major` | Breaking changes (API or behavior changes)   |
+### Examples
 
-### 🔍 Examples
+- Added new optional field to proto → **Minor**
+- Fixed type definition error → **Patch**
+- Removed or renamed existing field → **Major**
 
-- Added new optional field in proto → **minor**
-- Fixed type mismatch in existing interface → **patch**
-- Renamed or removed a field/function → **major**
+## Development
 
-## 🚀 Publishing a New Version
+This package is auto-generated from proto definitions. Do not edit the generated files manually.
 
-After your changes are merged:
+To regenerate:
 
 ```bash
-# Step 1: Bump version
-npm version patch   # or minor / major
-
-# Step 2: Publish
-npm publish
+# In the root repository
+pnpm generate
 ```
 
-Then update dependent services:
+## Publishing
+
+This package is automatically published via the root repository's publish script.
+
+See the [main repository README](../../README.md) 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
 
-## ✅ Best Practices
+## Support
 
-1. **Never edit generated files manually** – always regenerate.
-2. **Always bump versions** when a change affects consumers.
-3. **Keep exports minimal** – expose only what’s needed.
-4. **Ensure backward compatibility** where possible.
-5. **Document breaking changes** in PR descriptions.
-6. **Verify builds locally** before publishing.
+For issues or questions, please refer to the [main repository](https://github.com/CrossroadsAcademy/togather-shared-protos).
 
 ---
 
-Made with ❤️ by the **ToGather Engineering Team**.  
-Please follow the contribution guide and coding standards before submitting PRs.
+Maintained by the ToGather Engineering Team

package/dist/userservice/user/v1/user_pb.d.ts

@@ -19,9 +19,9 @@ export type GetProfileRequest = Message<"userservice.user.v1.GetProfileRequest">
  */
 export declare const GetProfileRequestSchema: GenMessage<GetProfileRequest>;
 /**
- * @generated from message userservice.user.v1.GetProfileResponse
+ * @generated from message userservice.user.v1.User
  */
-export type GetProfileResponse = Message<"userservice.user.v1.GetProfileResponse"> & {
+export type User = Message<"userservice.user.v1.User"> & {
     /**
      * @generated from field: string id = 1;
      */
@@ -51,6 +51,20 @@ export type GetProfileResponse = Message<"userservice.user.v1.GetProfileResponse
      */
     updatedAt: string;
 };
+/**
+ * Describes the message userservice.user.v1.User.
+ * Use `create(UserSchema)` to create a new message.
+ */
+export declare const UserSchema: GenMessage<User>;
+/**
+ * @generated from message userservice.user.v1.GetProfileResponse
+ */
+export type GetProfileResponse = Message<"userservice.user.v1.GetProfileResponse"> & {
+    /**
+     * @generated from field: userservice.user.v1.User user = 1;
+     */
+    user?: User;
+};
 /**
  * Describes the message userservice.user.v1.GetProfileResponse.
  * Use `create(GetProfileResponseSchema)` to create a new message.

package/dist/userservice/user/v1/user_pb.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"user_pb.d.ts","sourceRoot":"","sources":["../../../../src/userservice/user/v1/user_pb.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAEpF,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,6BAA6B,EAAE,OACoa,CAAC;AAEjd;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,uCAAuC,CAAC,GAAG;IACjF;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,uBAAuB,EAAE,UAAU,CAAC,iBAAiB,CACnB,CAAC;AAEhD;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC,wCAAwC,CAAC,GAAG;IACnF;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,wBAAwB,EAAE,UAAU,CAAC,kBAAkB,CACrB,CAAC;AAEhD;;GAEG;AACH,eAAO,MAAM,WAAW,EAAE,UAAU,CAAC;IACnC;;OAEG;IACH,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,KAAK,EAAE,OAAO,uBAAuB,CAAC;QACtC,MAAM,EAAE,OAAO,wBAAwB,CAAC;KACzC,CAAC;CACH,CAC8C,CAAC"}
+{"version":3,"file":"user_pb.d.ts","sourceRoot":"","sources":["../../../../src/userservice/user/v1/user_pb.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAEpF,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,6BAA6B,EAAE,OACoe,CAAC;AAEjhB;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,uCAAuC,CAAC,GAAG;IACjF;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,uBAAuB,EAAE,UAAU,CAAC,iBAAiB,CACnB,CAAC;AAEhD;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,OAAO,CAAC,0BAA0B,CAAC,GAAG;IACvD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,UAAU,EAAE,UAAU,CAAC,IAAI,CACO,CAAC;AAEhD;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC,wCAAwC,CAAC,GAAG;IACnF;;OAEG;IACH,IAAI,CAAC,EAAE,IAAI,CAAC;CACb,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,wBAAwB,EAAE,UAAU,CAAC,kBAAkB,CACrB,CAAC;AAEhD;;GAEG;AACH,eAAO,MAAM,WAAW,EAAE,UAAU,CAAC;IACnC;;OAEG;IACH,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,KAAK,EAAE,OAAO,uBAAuB,CAAC;QACtC,MAAM,EAAE,OAAO,wBAAwB,CAAC;KACzC,CAAC;CACH,CAC8C,CAAC"}

package/dist/userservice/user/v1/user_pb.js

@@ -5,17 +5,22 @@ import { fileDesc, messageDesc, serviceDesc } from "@bufbuild/protobuf/codegenv2
 /**
  * Describes the file userservice/user/v1/user.proto.
  */
-export const file_userservice_user_v1_user = /*@__PURE__*/ fileDesc("Ch51c2Vyc2VydmljZS91c2VyL3YxL3VzZXIucHJvdG8SE3VzZXJzZXJ2aWNlLnVzZXIudjEiHwoRR2V0UHJvZmlsZVJlcXVlc3QSCgoCaWQYASABKAkiggEKEkdldFByb2ZpbGVSZXNwb25zZRIKCgJpZBgBIAEoCRIMCgRuYW1lGAIgASgJEg0KBWVtYWlsGAMgASgJEgsKA2RvYhgEIAEoCRIOCgZnZW5kZXIYBSABKAkSEgoKY3JlYXRlZF9hdBgGIAEoCRISCgp1cGRhdGVkX2F0GAcgASgJMmwKC1VzZXJTZXJ2aWNlEl0KCkdldFByb2ZpbGUSJi51c2Vyc2VydmljZS51c2VyLnYxLkdldFByb2ZpbGVSZXF1ZXN0GicudXNlcnNlcnZpY2UudXNlci52MS5HZXRQcm9maWxlUmVzcG9uc2ViBnByb3RvMw");
+export const file_userservice_user_v1_user = /*@__PURE__*/ fileDesc("Ch51c2Vyc2VydmljZS91c2VyL3YxL3VzZXIucHJvdG8SE3VzZXJzZXJ2aWNlLnVzZXIudjEiHwoRR2V0UHJvZmlsZVJlcXVlc3QSCgoCaWQYASABKAkidAoEVXNlchIKCgJpZBgBIAEoCRIMCgRuYW1lGAIgASgJEg0KBWVtYWlsGAMgASgJEgsKA2RvYhgEIAEoCRIOCgZnZW5kZXIYBSABKAkSEgoKY3JlYXRlZF9hdBgGIAEoCRISCgp1cGRhdGVkX2F0GAcgASgJIj0KEkdldFByb2ZpbGVSZXNwb25zZRInCgR1c2VyGAEgASgLMhkudXNlcnNlcnZpY2UudXNlci52MS5Vc2VyMmwKC1VzZXJTZXJ2aWNlEl0KCkdldFByb2ZpbGUSJi51c2Vyc2VydmljZS51c2VyLnYxLkdldFByb2ZpbGVSZXF1ZXN0GicudXNlcnNlcnZpY2UudXNlci52MS5HZXRQcm9maWxlUmVzcG9uc2ViBnByb3RvMw");
 /**
  * Describes the message userservice.user.v1.GetProfileRequest.
  * Use `create(GetProfileRequestSchema)` to create a new message.
  */
 export const GetProfileRequestSchema = /*@__PURE__*/ messageDesc(file_userservice_user_v1_user, 0);
+/**
+ * Describes the message userservice.user.v1.User.
+ * Use `create(UserSchema)` to create a new message.
+ */
+export const UserSchema = /*@__PURE__*/ messageDesc(file_userservice_user_v1_user, 1);
 /**
  * Describes the message userservice.user.v1.GetProfileResponse.
  * Use `create(GetProfileResponseSchema)` to create a new message.
  */
-export const GetProfileResponseSchema = /*@__PURE__*/ messageDesc(file_userservice_user_v1_user, 1);
+export const GetProfileResponseSchema = /*@__PURE__*/ messageDesc(file_userservice_user_v1_user, 2);
 /**
  * @generated from service userservice.user.v1.UserService
  */

package/dist/userservice/user/v1/user_pb.js.map

@@ -1 +1 @@
-{"version":3,"file":"user_pb.js","sourceRoot":"","sources":["../../../../src/userservice/user/v1/user_pb.ts"],"names":[],"mappings":"AAAA,gEAAgE;AAChE,mGAAmG;AACnG,oBAAoB;AAGpB,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAGlF;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAY,aAAa,CACjE,QAAQ,CAAC,ocAAoc,CAAC,CAAC;AAYjd;;;GAGG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAkC,aAAa,CACjF,WAAW,CAAC,6BAA6B,EAAE,CAAC,CAAC,CAAC;AA0ChD;;;GAGG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAmC,aAAa,CACnF,WAAW,CAAC,6BAA6B,EAAE,CAAC,CAAC,CAAC;AAEhD;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GASnB,aAAa,CAChB,WAAW,CAAC,6BAA6B,EAAE,CAAC,CAAC,CAAC"}
+{"version":3,"file":"user_pb.js","sourceRoot":"","sources":["../../../../src/userservice/user/v1/user_pb.ts"],"names":[],"mappings":"AAAA,gEAAgE;AAChE,mGAAmG;AACnG,oBAAoB;AAGpB,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAGlF;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAY,aAAa,CACjE,QAAQ,CAAC,ogBAAogB,CAAC,CAAC;AAYjhB;;;GAGG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAkC,aAAa,CACjF,WAAW,CAAC,6BAA6B,EAAE,CAAC,CAAC,CAAC;AA0ChD;;;GAGG;AACH,MAAM,CAAC,MAAM,UAAU,GAAqB,aAAa,CACvD,WAAW,CAAC,6BAA6B,EAAE,CAAC,CAAC,CAAC;AAYhD;;;GAGG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAmC,aAAa,CACnF,WAAW,CAAC,6BAA6B,EAAE,CAAC,CAAC,CAAC;AAEhD;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GASnB,aAAa,CAChB,WAAW,CAAC,6BAA6B,EAAE,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@togatherlabs/shared-protos",
-  "version": "1.0.20",
+  "version": "1.0.21",
   "description": "Generated TypeScript gRPC definitions for Togather shared protos",
   "type": "module",
   "publishConfig": {