@togatherlabs/shared-protos 1.0.8

package/README.md

@@ -0,0 +1,73 @@
+# 📦 ToGather TypeScript Package
+
+This package contains a shared **TypeScript package** used across the ToGather ecosystem.
+
+It provides reusable modules, types, and utilities that ensure **consistency**, **type safety**, and **faster development** across all ToGather backend and frontend services.
+
+## 🚀 Overview
+
+This package is published to the **ToGather NPM organization** under:
+
+```bash
+@togatherr/togather-shared-protos
+```
+
+It is designed for internal use within our microservices architecture.
+
+## 📦 Installation
+
+Install the package using **pnpm**:
+
+```bash
+pnpm add @togatherr/togather-shared-protos
+```
+
+## 🧠 Usage Example
+
+```ts
+import { LoginRequestSchema } from "@togatherr/togather-shared-protos";
+```
+
+## 🧮 Versioning Rules
+
+We use **Semantic Versioning (SemVer)**:
+
+| 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
+
+- Added new optional field in proto → **minor**
+- Fixed type mismatch in existing interface → **patch**
+- Renamed or removed a field/function → **major**
+
+## 🚀 Publishing a New Version
+
+After your changes are merged:
+
+```bash
+# Step 1: Bump version
+npm version patch   # or minor / major
+
+# Step 2: Publish
+npm publish
+```
+
+Then update dependent services:
+
+## ✅ Best Practices
+
+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.
+
+---
+
+Made with ❤️ by the **ToGather Engineering Team**.  
+Please follow the contribution guide and coding standards before submitting PRs.

package/generate-indexes.js

@@ -0,0 +1,93 @@
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+// Find directories
+function findProtoDirectories(dir, baseDir) {
+  const results = [];
+  const entries = fs.readdirSync(dir, { withFileTypes: true });
+
+  for (const entry of entries) {
+    if (entry.isDirectory()) {
+      const fullPath = path.join(dir, entry.name);
+      const files = fs.readdirSync(fullPath);
+
+      const hasProtoFiles = files.some(
+        (f) => f.endsWith("_pb.js") || f.endsWith("_connect.js")
+      );
+
+      if (hasProtoFiles) {
+        const relativePath = path.relative(baseDir, fullPath);
+        results.push({ fullPath, relativePath });
+      }
+
+      results.push(...findProtoDirectories(fullPath, baseDir));
+    }
+  }
+
+  return results;
+}
+
+//generate index.js for barriel export
+function generateIndexFile(dir) {
+  const files = fs.readdirSync(dir);
+  const exports = [];
+
+  for (const file of files) {
+    if (file.endsWith("_pb.js")) {
+      exports.push(`export * from './${file}';`);
+    }
+    if (file.endsWith("_connect.js")) {
+      exports.push(`export * from './${file}';`);
+    }
+  }
+  console.log(exports);
+  if (exports.length > 0) {
+    const indexPath = path.join(dir, "index.js");
+    const content = exports.join("\n");
+    fs.writeFileSync(indexPath, content);
+    const indexDtsPath = path.join(dir, "index.d.ts");
+    const contentDts = exports.join("\n");
+    fs.writeFileSync(indexDtsPath, contentDts);
+    console.log(`created ${path.relative(process.cwd(), indexPath)}`);
+  }
+}
+
+// update package.json
+function updatePackageJsonExports(protoDirs, srcDir) {
+  const packageJsonPath = path.join(__dirname, "package.json");
+  const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf8"));
+  const exports = {
+    "./*": "./dist/*",
+  };
+  for (const { relativePath } of protoDirs) {
+    const exportPath = "./" + relativePath;
+
+    exports[exportPath] = {
+      types: "./dist/" + relativePath + "/index.d.ts",
+      import: "./dist/" + relativePath + "/index.js",
+      require:"./dist/" + relativePath + "/index.js",
+      default: "./dist/" + relativePath + "/index.js",
+    };
+  }
+  packageJson.exports = exports;
+
+  fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));
+
+  console.log("Updated package.json exports");
+}
+
+// Main execution
+const srcDir = path.join(__dirname, "dist");
+
+const protoDirs = findProtoDirectories(srcDir, srcDir);
+console.log("protoDirs");
+console.log(protoDirs);
+for (const { fullPath } of protoDirs) {
+  console.log(fullPath);
+  generateIndexFile(fullPath);
+}
+updatePackageJsonExports(protoDirs, srcDir);
+console.log("DONE ..");

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@togatherlabs/shared-protos",
+  "version": "1.0.8",
+  "description": "Generated TypeScript gRPC definitions for Togather shared protos",
+  "type": "module",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "lint": "buf lint",
+    "generate": "tsc && node generate-indexes.js"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "packageManager": "pnpm@10.7.1",
+  "peerDependencies": {
+    "@bufbuild/protobuf": "^2.9.0",
+    "@connectrpc/connect": "^2.1.0"
+  },
+  "exports": {
+    "./*": "./dist/*",
+    "./authservice/admin/v1": {
+      "types": "./dist/authservice/admin/v1/index.d.ts",
+      "import": "./dist/authservice/admin/v1/index.js",
+      "default": "./dist/authservice/admin/v1/index.js"
+    }
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,47 @@
+{
+  // Visit https://aka.ms/tsconfig to read more about this file
+  "compilerOptions": {
+    // File Layout
+    "rootDir": "./src",
+    "outDir": "./dist",
+
+    // Environment Settings
+    // See also https://aka.ms/tsconfig/module
+    "module": "nodenext",
+    "target": "esnext",
+    "types": [],
+    // For nodejs:
+    // "lib": ["esnext"],
+    // "types": ["node"],
+    // and npm install -D @types/node
+
+    // Other Outputs
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true,
+
+    // Stricter Typechecking Options
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+
+    // Style Options
+    // "noImplicitReturns": true,
+    // "noImplicitOverride": true,
+    // "noUnusedLocals": true,
+    // "noUnusedParameters": true,
+    // "noFallthroughCasesInSwitch": true,
+    // "noPropertyAccessFromIndexSignature": true,
+
+    // Recommended Options
+    "strict": true,
+    "jsx": "react-jsx",
+    "verbatimModuleSyntax": true,
+    "isolatedModules": true,
+    "noUncheckedSideEffectImports": true,
+    "moduleDetection": "force",
+    "skipLibCheck": true
+  },
+
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}