@seatwave/contracts 1.0.0 → 1.0.1

package/gen/auth.ts

@@ -10,36 +10,113 @@ import { Observable } from "rxjs";
 
 export const protobufPackage = "auth.v1";
 
+/** Request to send a one-time password (OTP) to the user. */
 export interface SendOtpRequest {
+  /** The user identifier: either phone number or email address. */
   identifier: string;
+  /** The type of identifier: "phone" or "email". */
   type: string;
 }
 
+/** Response for SendOtp request. */
 export interface SendOtpResponse {
+  /** True if OTP was successfully sent. */
   ok: boolean;
 }
 
+/** Request to verify a one-time password (OTP). */
+export interface VerifyOtpRequest {
+  /** The user identifier: either phone number or email address. */
+  identifier: string;
+  /** The type of identifier: "phone" or "email". */
+  type: string;
+  /** The OTP code sent to the user. */
+  code: string;
+}
+
+/** Response for VerifyOtp request. */
+export interface VerifyOtpResponse {
+  /** JWT access token. */
+  accessToken: string;
+  /** Refresh token to obtain new access tokens. */
+  refreshToken: string;
+}
+
+/** Request to refresh an access token. */
+export interface RefreshRequest {
+  /** The refresh token issued previously. */
+  refreshToken: string;
+}
+
+/** Response for Refresh request. */
+export interface RefreshResponse {
+  /** New JWT access token. */
+  accessToken: string;
+  /** New refresh token. */
+  refreshToken: string;
+}
+
 export const AUTH_V1_PACKAGE_NAME = "auth.v1";
 
-/** AuthService handles user authentication operations */
+/**
+ * AuthService handles all user authentication operations such as sending
+ * OTP codes, verifying them, and refreshing access tokens.
+ */
 
 export interface AuthServiceClient {
-  /** Send a verification code to the user by phone or email */
+  /**
+   * Sends a one-time verification code to the user via phone or email.
+   * The user provides an identifier (phone number or email) and type.
+   */
 
   sendOtp(request: SendOtpRequest): Observable<SendOtpResponse>;
+
+  /**
+   * Verifies a one-time password (OTP) sent to the user.
+   * The request must include the identifier, type, and OTP code.
+   */
+
+  verifyOtp(request: VerifyOtpRequest): Observable<VerifyOtpResponse>;
+
+  /**
+   * Refreshes the access token using a valid refresh token.
+   * Returns a new access token and refresh token.
+   */
+
+  refresh(request: RefreshRequest): Observable<RefreshResponse>;
 }
 
-/** AuthService handles user authentication operations */
+/**
+ * AuthService handles all user authentication operations such as sending
+ * OTP codes, verifying them, and refreshing access tokens.
+ */
 
 export interface AuthServiceController {
-  /** Send a verification code to the user by phone or email */
+  /**
+   * Sends a one-time verification code to the user via phone or email.
+   * The user provides an identifier (phone number or email) and type.
+   */
 
   sendOtp(request: SendOtpRequest): Promise<SendOtpResponse> | Observable<SendOtpResponse> | SendOtpResponse;
+
+  /**
+   * Verifies a one-time password (OTP) sent to the user.
+   * The request must include the identifier, type, and OTP code.
+   */
+
+  verifyOtp(request: VerifyOtpRequest): Promise<VerifyOtpResponse> | Observable<VerifyOtpResponse> | VerifyOtpResponse;
+
+  /**
+   * Refreshes the access token using a valid refresh token.
+   * Returns a new access token and refresh token.
+   */
+
+  refresh(request: RefreshRequest): Promise<RefreshResponse> | Observable<RefreshResponse> | RefreshResponse;
 }
 
 export function AuthServiceControllerMethods() {
   return function (constructor: Function) {
-    const grpcMethods: string[] = ["sendOtp"];
+    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);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seatwave/contracts",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Protobuf definitions and generated TypeScript types",
   "scripts": {
     "generate": "protoc -I ./proto ./proto/*.proto --ts_proto_out=./gen --ts_proto_opt=nestJs=true,package=omit"

package/proto/auth.proto

@@ -2,17 +2,69 @@ syntax = "proto3";
 
 package auth.v1;
 
-// AuthService handles user authentication operations
+// AuthService handles all user authentication operations such as sending
+// OTP codes, verifying them, and refreshing access tokens.
 service AuthService {
-  // Send a verification code to the user by phone or email
+  // Sends a one-time verification code to the user via phone or email.
+  // The user provides an identifier (phone number or email) and type.
   rpc SendOtp (SendOtpRequest) returns (SendOtpResponse);
+
+  // Verifies a one-time password (OTP) sent to the user.
+  // The request must include the identifier, type, and OTP code.
+  rpc VerifyOtp (VerifyOtpRequest) returns (VerifyOtpResponse);
+
+  // Refreshes the access token using a valid refresh token.
+  // Returns a new access token and refresh token.
+  rpc Refresh (RefreshRequest) returns (RefreshResponse);
 }
 
+// Request to send a one-time password (OTP) to the user.
 message SendOtpRequest {
+  // The user identifier: either phone number or email address.
   string identifier = 1;
-  string type       = 2;
+
+  // The type of identifier: "phone" or "email".
+  string type = 2;
 }
 
+// Response for SendOtp request.
 message SendOtpResponse {
-    bool ok = 1;
-}
+  // True if OTP was successfully sent.
+  bool ok = 1;
+}
+
+// Request to verify a one-time password (OTP).
+message VerifyOtpRequest {
+  // The user identifier: either phone number or email address.
+  string identifier = 1;
+
+  // The type of identifier: "phone" or "email".
+  string type = 2;
+
+  // The OTP code sent to the user.
+  string code = 3;
+}
+
+// Response for VerifyOtp request.
+message VerifyOtpResponse {
+  // JWT access token.
+  string access_token = 1;
+
+  // Refresh token to obtain new access tokens.
+  string refresh_token = 2;
+}
+
+// Request to refresh an access token.
+message RefreshRequest {
+  // The refresh token issued previously.
+  string refresh_token = 1;
+}
+
+// Response for Refresh request.
+message RefreshResponse {
+  // New JWT access token.
+  string access_token = 1;
+
+  // New refresh token.
+  string refresh_token = 2;
+}