@3d-outlet/contracts 1.0.0

package/README.md

@@ -0,0 +1,231 @@
+<div align="center">
+
+# 📡 @3d-outlet/contracts
+
+**Protobuf definitions and generated TypeScript types for 3D OUTLET microservices**
+
+[![npm version](https://img.shields.io/npm/v/@3d-outlet/contracts?style=for-the-badge)](https://www.npmjs.com/package/@3d-outlet/contracts)
+[![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg?style=for-the-badge)](https://opensource.org/licenses/ISC)
+
+</div>
+
+---
+
+## ✨ Features
+
+- 🔌 **Protobuf Definitions** - Type-safe gRPC service definitions
+- 📦 **TypeScript Types** - Auto-generated TypeScript interfaces from `.proto` files
+- 🚀 **NestJS Integration** - Ready-to-use with NestJS microservices
+- 🔄 **Event Types** - Shared event interfaces for inter-service communication
+- 💎 **Type Safety** - Full type checking across microservices
+
+---
+
+## 📦 Installation
+
+```bash
+npm install @3d-outlet/contracts
+# or
+pnpm add @3d-outlet/contracts
+# or
+yarn add @3d-outlet/contracts
+# or
+bun add @3d-outlet/contracts
+```
+
+---
+
+## 🚀 Quick Start
+
+### Using Protobuf Services
+
+```typescript
+import { PROTO_PATHS } from '@3d-outlet/contracts'
+
+// In your NestJS microservice
+const app = await NestFactory.createMicroservice(AppModule, {
+	transport: Transport.GRPC,
+	options: {
+		protoPath: PROTO_PATHS.AUTH,
+		package: 'auth.v1'
+	}
+})
+```
+
+### Using Generated Types
+
+```typescript
+import { SendOtpRequest, SendOtpResponse } from '@3d-outlet/contracts'
+
+async function sendOtp(data: SendOtpRequest): Promise<SendOtpResponse> {
+	// Type-safe implementation
+	return { ok: true }
+}
+```
+
+### Using Event Interfaces
+
+```typescript
+import { OtpRequestedEvent } from '@3d-outlet/contracts'
+
+function handleOtpRequested(event: OtpRequestedEvent) {
+	console.log(`OTP requested for ${event.identifier}`)
+}
+```
+
+---
+
+## 📁 Project Structure
+
+```
+contracts/
+├── proto/              # Protobuf definition files
+│   └── auth.proto     # Authentication service definitions
+├── gen/               # Generated TypeScript files (auto-generated)
+│   └── ts/
+├── src/               # Source TypeScript files
+│   ├── events/        # Event interfaces
+│   │   └── auth/      # Auth-related events
+│   └── proto/         # Proto path utilities
+└── dist/              # Compiled JavaScript (after build)
+```
+
+---
+
+## 🛠️ Development
+
+### Prerequisites
+
+- **Node.js**: >= 16.0.0
+- **protoc**: Protocol Buffer compiler
+- **TypeScript**: ^5.9.3
+
+### Installing protoc
+
+**macOS:**
+
+```bash
+brew install protobuf
+```
+
+**Ubuntu/Debian:**
+
+```bash
+sudo apt-get update && sudo apt-get install -y protobuf-compiler
+```
+
+**Windows:** Download from
+
+### Building the Package
+
+```bash
+# Install dependencies
+npm install
+# or
+pnpm install
+# or
+bun install
+
+# Generate TypeScript from Protobuf
+npm run generate
+
+# Build TypeScript
+npm run build
+```
+
+---
+
+## 📋 Available Services
+
+### Auth Service (`auth.v1`)
+
+Authentication and authorization service with OTP-based authentication.
+
+**RPC Methods:**
+
+- `SendOtp` - Send OTP code to user
+- `VerifyOtp` - Verify OTP code and get tokens
+- `Refresh` - Refresh access token
+
+**Example:**
+
+```typescript
+import { AuthServiceController } from '@3d-outlet/contracts'
+
+@Controller()
+export class AuthController implements AuthServiceController {
+	async sendOtp(request: SendOtpRequest): Promise<SendOtpResponse> {
+		// Implementation
+		return { ok: true }
+	}
+}
+```
+
+---
+
+## 🎯 Usage in NestJS
+
+### Client Side
+
+```typescript
+import { ClientGrpc } from '@nestjs/microservices'
+import { AuthServiceClient } from '@3d-outlet/contracts'
+
+@Injectable()
+export class AuthClient {
+	private authService: AuthServiceClient
+
+	constructor(@Inject('AUTH_PACKAGE') private client: ClientGrpc) {}
+
+	onModuleInit() {
+		this.authService = this.client.getService<AuthServiceClient>('AuthService')
+	}
+
+	async sendOtp(identifier: string, type: string) {
+		return this.authService.sendOtp({ identifier, type })
+	}
+}
+```
+
+### Server Side
+
+```typescript
+import { PROTO_PATHS } from '@3d-outlet/contracts'
+
+// In main.ts or app.module.ts
+const microserviceOptions: MicroserviceOptions = {
+	transport: Transport.GRPC,
+	options: {
+		protoPath: PROTO_PATHS.AUTH,
+		package: 'auth.v1',
+		url: '0.0.0.0:5000'
+	}
+}
+```
+
+---
+
+## 📝 License
+
+ISC © [TeaCoder](mailto:admin@teacoder.ru) & [Ilnaz Mingaleev](mailto:development@teamkaif.com)
+
+---
+
+## 👨‍💻 Authors
+
+**TeaCoder (Vadim)**
+
+- Email: [admin@teacoder.ru](mailto:admin@teacoder.ru)
+
+**Ilnaz Mingaleev**
+
+- Email: [development@teamkaif.com](mailto:development@teamkaif.com)
+
+---
+
+<div align="center">
+
+**Made with ❤️ for the 3D OUTLET project (private repo)**  
+Internal use only.
+
+</div>

package/dist/events/auth/index.d.ts

@@ -0,0 +1 @@
+export * from './otp-requested.interface';

package/dist/events/auth/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./otp-requested.interface"), exports);

package/dist/events/auth/otp-requested.interface.d.ts

@@ -0,0 +1,5 @@
+export interface OtpRequestedEvent {
+    identifier: string;
+    type: string;
+    code: string;
+}

package/dist/events/auth/otp-requested.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/events/index.d.ts

@@ -0,0 +1 @@
+export * from './auth';

package/dist/events/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./auth"), exports);

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './events';
+export * from './proto';

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./events"), exports);
+__exportStar(require("./proto"), exports);

package/dist/proto/index.d.ts

@@ -0,0 +1 @@
+export * from './paths';

package/dist/proto/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./paths"), exports);

package/dist/proto/paths.d.ts

@@ -0,0 +1,3 @@
+export declare const PROTO_PATHS: {
+    readonly AUTH: string;
+};

package/dist/proto/paths.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PROTO_PATHS = void 0;
+const path_1 = require("path");
+exports.PROTO_PATHS = {
+    AUTH: (0, path_1.join)(__dirname, '../../proto/auth.proto')
+};

package/gen/ts/auth.ts

@@ -0,0 +1,75 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.10.1
+//   protoc               v3.21.12
+// 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 interface VerifyOtpRequest {
+  identifier: string;
+  type: string;
+  code: string;
+}
+
+export interface VerifyOtpResponse {
+  accessToken: string;
+  refreshToken: string;
+}
+
+export interface RefreshRequest {
+  refreshToken: string;
+}
+
+export interface RefreshResponse {
+  accessToken: string;
+  refreshToken: string;
+}
+
+export const AUTH_V1_PACKAGE_NAME = "auth.v1";
+
+export interface AuthServiceClient {
+  sendOtp(request: SendOtpRequest): Observable<SendOtpResponse>;
+
+  verifyOtp(request: VerifyOtpRequest): Observable<VerifyOtpResponse>;
+
+  refresh(request: RefreshRequest): Observable<RefreshResponse>;
+}
+
+export interface AuthServiceController {
+  sendOtp(request: SendOtpRequest): Promise<SendOtpResponse> | Observable<SendOtpResponse> | SendOtpResponse;
+
+  verifyOtp(request: VerifyOtpRequest): Promise<VerifyOtpResponse> | Observable<VerifyOtpResponse> | VerifyOtpResponse;
+
+  refresh(request: RefreshRequest): Promise<RefreshResponse> | Observable<RefreshResponse> | RefreshResponse;
+}
+
+export function AuthServiceControllerMethods() {
+  return function (constructor: Function) {
+    const grpcMethods: string[] = ["sendOtp", "verifyOtp", "refresh"];
+    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,28 @@
+{
+	"name": "@3d-outlet/contracts",
+	"version": "1.0.0",
+	"description": "Protobuf definitions and generated TypeScript types",
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"scripts": {
+		"build": "tsc -p tsconfig.build.json",
+		"generate": "protoc -I ./proto ./proto/*.proto --ts_proto_out=./gen/ts --ts_proto_opt=nestJs=true,package=omit"
+	},
+	"files": [
+		"dist",
+		"proto",
+		"gen"
+	],
+	"publishConfig": {
+		"access": "public"
+	},
+	"dependencies": {
+		"@nestjs/microservices": "^11.1.9",
+		"rxjs": "^7.8.2",
+		"ts-proto": "^2.8.3"
+	},
+	"devDependencies": {
+		"@types/node": "^24.10.1",
+		"typescript": "^5.9.3"
+	}
+}

package/proto/auth.proto

@@ -0,0 +1,38 @@
+syntax = "proto3";
+
+package auth.v1;
+
+service AuthService {
+	rpc SendOtp (SendOtpRequest) returns (SendOtpResponse);
+	rpc VerifyOtp (VerifyOtpRequest) returns (VerifyOtpResponse);
+	rpc Refresh (RefreshRequest) returns (RefreshResponse);
+}
+
+message SendOtpRequest {
+	string identifier = 1;
+	string type = 2;
+}
+
+message SendOtpResponse {
+	bool ok = 1;
+}
+
+message VerifyOtpRequest {
+	string identifier = 1;
+	string type = 2;
+	string code = 3;
+}
+
+message VerifyOtpResponse {
+	string access_token = 1;
+	string refresh_token = 2;
+}
+
+message RefreshRequest {
+	string refresh_token = 1;
+}
+
+message RefreshResponse {
+	string access_token = 1;
+	string refresh_token = 2;
+}