@platfformx/proto-contracts 1.0.0

package/.github/workflows/publish.npm.yml

@@ -0,0 +1,34 @@
+name: Publish Build
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    name: Build job
+    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
+
+      - name: Install protoc
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y protobuf-compiler
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Generate Ts protobuf
+        run: yarn run generate
+
+      - name: Build
+        run: yarn run build

package/eslint.config.mjs

@@ -0,0 +1,35 @@
+// @ts-check
+import eslint from '@eslint/js';
+import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  {
+    ignores: ['eslint.config.mjs'],
+  },
+  eslint.configs.recommended,
+  ...tseslint.configs.recommendedTypeChecked,
+  eslintPluginPrettierRecommended,
+  {
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globals.jest,
+      },
+      sourceType: 'commonjs',
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  },
+  {
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-floating-promises': 'warn',
+      '@typescript-eslint/no-unsafe-argument': 'warn',
+      'prettier/prettier': ['error', { endOfLine: 'auto' }],
+    },
+  },
+);

package/gen/ts/auth-service/account.ts

@@ -0,0 +1,52 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.11.8
+//   protoc               v7.34.0
+// source: auth-service/account.proto
+
+/* eslint-disable */
+import { GrpcMethod, GrpcStreamMethod } from "@nestjs/microservices";
+import { Observable } from "rxjs";
+
+export const protobufPackage = "auth_service.v1";
+
+export interface GetAccountRequest {
+  id: string;
+}
+
+export interface GetAccountResponse {
+  id: string;
+  phone: string;
+  email: string;
+  isPhoneVerified: boolean;
+  isEmailVerified: boolean;
+}
+
+export const AUTH_SERVICE_V1_PACKAGE_NAME = "auth_service.v1";
+
+export interface AccountServiceClient {
+  getAccount(request: GetAccountRequest): Observable<GetAccountResponse>;
+}
+
+export interface AccountServiceController {
+  getAccount(
+    request: GetAccountRequest,
+  ): Promise<GetAccountResponse> | Observable<GetAccountResponse> | GetAccountResponse;
+}
+
+export function AccountServiceControllerMethods() {
+  return function (constructor: Function) {
+    const grpcMethods: string[] = ["getAccount"];
+    for (const method of grpcMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);
+      GrpcMethod("AccountService", method)(constructor.prototype[method], method, descriptor);
+    }
+    const grpcStreamMethods: string[] = [];
+    for (const method of grpcStreamMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);
+      GrpcStreamMethod("AccountService", method)(constructor.prototype[method], method, descriptor);
+    }
+  };
+}
+
+export const ACCOUNT_SERVICE_NAME = "AccountService";

package/gen/ts/auth-service/auth.ts

@@ -0,0 +1,47 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.11.8
+//   protoc               v7.34.0
+// source: auth-service/auth.proto
+
+/* eslint-disable */
+import { GrpcMethod, GrpcStreamMethod } from "@nestjs/microservices";
+import { Observable } from "rxjs";
+
+export const protobufPackage = "auth_service.v1";
+
+export interface LoginRequest {
+  email: string;
+  password: string;
+}
+
+export interface LoginResponse {
+  accessToken: string;
+}
+
+export const AUTH_SERVICE_V1_PACKAGE_NAME = "auth_service.v1";
+
+export interface AuthServiceClient {
+  login(request: LoginRequest): Observable<LoginResponse>;
+}
+
+export interface AuthServiceController {
+  login(request: LoginRequest): Promise<LoginResponse> | Observable<LoginResponse> | LoginResponse;
+}
+
+export function AuthServiceControllerMethods() {
+  return function (constructor: Function) {
+    const grpcMethods: string[] = ["login"];
+    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,25 @@
+{
+  "name": "@platfformx/proto-contracts",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc",
+    "generate": "mkdirp gen/ts && globstar -- protoc -I=proto proto/**/*.proto --ts_proto_out=./gen/ts --ts_proto_opt=nestJs=true,esModuleInterop=true"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "type": "module",
+  "devDependencies": {
+    "@types/node": "^25.7.0",
+    "globstar": "^1.0.0",
+    "mkdirp": "^3.0.1",
+    "ts-proto": "^2.11.8",
+    "typescript": "^6.0.3"
+  },
+  "dependencies": {}
+}

package/proto/auth-service/account.proto

@@ -0,0 +1,24 @@
+syntax = "proto3";
+
+package auth_service.v1;
+
+
+
+service AccountService {
+  rpc GetAccount (GetAccountRequest) returns (GetAccountResponse);
+
+}
+
+message GetAccountRequest {
+  string id = 1;
+}
+
+message GetAccountResponse {
+  string id = 1;
+  string phone = 2;
+  string email = 3;
+  bool is_phone_verified = 4;
+  bool is_email_verified = 5;
+
+}
+

package/proto/auth-service/auth.proto

@@ -0,0 +1,18 @@
+syntax = "proto3";
+
+package auth_service.v1;
+
+
+
+service AuthService {
+  rpc Login (LoginRequest) returns (LoginResponse);
+}
+
+message LoginRequest {
+  string email = 1;
+  string password = 2;
+}
+
+message LoginResponse {
+  string access_token = 1;
+}

package/src/index.ts

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

package/src/paths/index.ts

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

package/src/paths/proto-paths.ts

@@ -0,0 +1,6 @@
+import { join } from 'path';
+
+export const PROTO_PATHS = {
+  ACCOUNT: join(__dirname, '../../proto/auth-service/account.proto'),
+  AUTH: join(__dirname, '../../proto/auth-service/auth.proto'),
+} as const;

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "target": "esnext",
+    "types": ["node"],
+    "sourceMap": true,
+    "declaration": true,
+    "outDir": "./dist",
+    "rootDir": ".",
+    "strictNullChecks": false,
+    "noUncheckedIndexedAccess": true,
+    "strict": true,
+    "verbatimModuleSyntax": true,
+    "strictNullChecks": false,
+    "skipLibCheck": true
+  },
+  "include": ["src/**/*"]
+}