@molecule-dev/ticketapp-contracts 1.0.0

package/.claude/settings.local.json

@@ -0,0 +1,8 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(protoc:*)",
+      "Bash(npm install:*)"
+    ]
+  }
+}

package/.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+name: Publish Package
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish:
+    name: Publish to NPM
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+
+      - name: Install deps
+        uses: yarn install --frozen-lockfile
+
+      - name: Generate TS Protobuf
+        uses: yarn run generate
+
+      - name: Publish to NPM
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.npmginore

@@ -0,0 +1,40 @@
+# Node / package managers
+node_modules
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+# Build tools & configs
+.eslintrc
+.eslintrc.*
+.prettierrc
+.prettierrc.*
+.editorconfig
+tsconfig*.json
+jest.config.*
+vitest.config.*
+webpack.config.*
+rollup.config.*
+vite.config.*
+
+
+# Git & GitHub
+.git
+.gitignore
+.github
+
+# Environment files
+.env
+.env.*
+.env.local
+
+# Docs & misc
+docs
+examples
+*.md
+
+# OS / IDE
+.DS_Store
+.idea
+.vscode

package/README.md

@@ -0,0 +1,49 @@
+# Contracts
+
+Protocol Buffer definitions and generated TypeScript code.
+
+## Directory Structure
+
+- `proto/` - Protocol Buffer definition files (.proto)
+- `gen/` - Generated TypeScript files
+
+## Generating TypeScript from Proto Files
+
+To generate TypeScript files from the proto definitions, run:
+
+```bash
+protoc \
+  --proto_path=./proto \
+  --ts_proto_out=./gen \
+  --ts_proto_opt=nestJs=true,package=omit \
+  ./proto/*.proto
+```
+
+### Prerequisites
+
+Make sure you have `ts-proto` installed globally:
+
+```bash
+npm install -g ts-proto
+```
+
+### Options
+
+- `--proto_path=./proto` - Specifies the directory containing proto files
+- `--ts_proto_out=./gen` - Output directory for generated TypeScript files
+- `--ts_proto_opt` - ts-proto options:
+  - `nestJs=true` - Generate NestJS-compatible code with decorators
+  - `addGrpcMetadata=true` - Add gRPC metadata parameter to methods
+  - `addNestjsRestParameter=true` - Add rest parameter for additional arguments
+  - `outputServices=grpc-js` - Generate service definitions for @grpc/grpc-js
+  - `useExactTypes=false` - Use simpler type definitions
+- `./proto/*.proto` - Input proto files
+
+### Using in NestJS
+
+The generated code includes:
+
+- `AuthServiceController` - Interface for your controller implementation
+- `AuthServiceControllerMethods()` - Decorator to apply to your controller class
+- `AuthServiceClient` - Interface for client-side usage
+- `AuthServiceService` - gRPC service definition for module configuration

package/gen/auth.ts

@@ -0,0 +1,47 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.10.1
+//   protoc               v6.33.2
+// source: auth.proto
+
+/* eslint-disable */
+import { GrpcMethod, GrpcStreamMethod } from "@nestjs/microservices";
+import { Observable } from "rxjs";
+
+export const protobufPackage = "auth.v1";
+
+export interface SendOtpRequest {
+  identifier: string;
+  type: string;
+}
+
+export interface SendOtpResponse {
+  ok: boolean;
+}
+
+export const AUTH_V1_PACKAGE_NAME = "auth.v1";
+
+export interface AuthServiceClient {
+  sendOtp(request: SendOtpRequest): Observable<SendOtpResponse>;
+}
+
+export interface AuthServiceController {
+  sendOtp(request: SendOtpRequest): Promise<SendOtpResponse> | Observable<SendOtpResponse> | SendOtpResponse;
+}
+
+export function AuthServiceControllerMethods() {
+  return function (constructor: Function) {
+    const grpcMethods: string[] = ["sendOtp"];
+    for (const method of grpcMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);
+      GrpcMethod("AuthService", method)(constructor.prototype[method], method, descriptor);
+    }
+    const grpcStreamMethods: string[] = [];
+    for (const method of grpcStreamMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);
+      GrpcStreamMethod("AuthService", method)(constructor.prototype[method], method, descriptor);
+    }
+  };
+}
+
+export const AUTH_SERVICE_NAME = "AuthService";

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@molecule-dev/ticketapp-contracts",
+  "version": "1.0.0",
+  "license": "ISC",
+  "type": "module",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "Protocol Buffer definitions and generated TypeScript code",
+  "scripts": {
+    "generate": "protoc   --proto_path=./proto   --ts_proto_out=./gen   --ts_proto_opt=nestJs=true,package=omit   ./proto/*.proto"
+  },
+  "dependencies": {
+    "@nestjs/microservices": "^11.1.11",
+    "rxjs": "^7.8.2"
+  }
+}

package/proto/auth.proto

@@ -0,0 +1,16 @@
+syntax = "proto3";
+
+package auth.v1;
+
+service AuthService { 
+    rpc sendOtp(SendOtpRequest) returns (SendOtpResponse);
+}
+
+message  SendOtpRequest {
+    string identifier = 1;
+    string type = 2;
+}
+
+message SendOtpResponse {
+    bool ok = 1;
+}