@candesk/contracts 3.1.0 → 3.3.0

package/dist/gen/account.d.ts

@@ -14,6 +14,7 @@ export interface GetAccountResponse {
     isPhoneVerified: boolean;
     isEmailVerified: boolean;
     role: Role;
+    isTelegramLinked: boolean;
 }
 export interface InitEmailChangeRequest {
     email: string;
@@ -31,8 +32,24 @@ export interface ConfirmEmailChangeRequest {
 export interface ConfirmEmailChangeResponse {
     ok: boolean;
 }
+export interface LinkTelegramRequest {
+    userId: string;
+    query: {
+        [key: string]: string;
+    };
+}
+export interface LinkTelegramRequest_QueryEntry {
+    key: string;
+    value: string;
+}
+export interface LinkTelegramResponse {
+    linked: boolean;
+    /** bot link where the user shares the phone number, set only when not linked yet */
+    url: string;
+}
 export interface AccountService {
     getAccount(request: GetAccountRequest): Promise<GetAccountResponse>;
     initEmailChange(request: InitEmailChangeRequest): Promise<InitEmailChangeResponse>;
     confirmEmailChange(request: ConfirmEmailChangeRequest): Promise<ConfirmEmailChangeResponse>;
+    linkTelegram(request: LinkTelegramRequest): Promise<LinkTelegramResponse>;
 }

package/dist/gen/auth.d.ts

@@ -40,9 +40,10 @@ export interface TelegramVerifyRequest_QueryEntry {
     value: string;
 }
 export interface TelegramVerifyResponse {
-    url?: string | undefined;
-    accessToken?: string | undefined;
-    refreshToken?: string | undefined;
+    /** bot link when the phone number is still needed, the tokens are empty then */
+    url: string;
+    accessToken: string;
+    refreshToken: string;
     /** secret for the browser that started the login, set only together with url */
     pollToken: string;
 }
@@ -53,6 +54,8 @@ export interface TelegramCompleteRequest {
 }
 export interface TelegramCompleteResponse {
     sessionId: string;
+    /** true when the bot finished linking Telegram to a logged-in account, session_id is empty then */
+    linked: boolean;
 }
 export interface TelegramConsumeRequest {
     sessionId: string;
@@ -69,6 +72,13 @@ export interface TelegramPollResponse {
     accessToken: string;
     refreshToken: string;
 }
+export interface TelegramStatusRequest {
+    telegramId: string;
+}
+export interface TelegramStatusResponse {
+    /** true when Telegram login lets this user in right away */
+    linked: boolean;
+}
 export interface AuthService {
     sendOtp(request: SendOtpRequest): Promise<SendOtpResponse>;
     verifyOtp(request: VerifyOtpRequest): Promise<VerifyOtpResponse>;
@@ -79,4 +89,5 @@ export interface AuthService {
     telegramComplete(request: TelegramCompleteRequest): Promise<TelegramCompleteResponse>;
     telegramConsume(request: TelegramConsumeRequest): Promise<TelegramConsumeResponse>;
     telegramPoll(request: TelegramPollRequest): Promise<TelegramPollResponse>;
+    telegramStatus(request: TelegramStatusRequest): Promise<TelegramStatusResponse>;
 }

package/dist/nest/account.d.ts

@@ -15,6 +15,7 @@ export interface GetAccountResponse {
     isPhoneVerified: boolean;
     isEmailVerified: boolean;
     role: Role;
+    isTelegramLinked: boolean;
 }
 export interface InitEmailChangeRequest {
     email: string;
@@ -32,16 +33,33 @@ export interface ConfirmEmailChangeRequest {
 export interface ConfirmEmailChangeResponse {
     ok: boolean;
 }
+export interface LinkTelegramRequest {
+    userId: string;
+    query: {
+        [key: string]: string;
+    };
+}
+export interface LinkTelegramRequest_QueryEntry {
+    key: string;
+    value: string;
+}
+export interface LinkTelegramResponse {
+    linked: boolean;
+    /** bot link where the user shares the phone number, set only when not linked yet */
+    url: string;
+}
 export declare const ACCOUNT_V1_PACKAGE_NAME = "account.v1";
 export interface AccountServiceClient {
     getAccount(request: GetAccountRequest): Observable<GetAccountResponse>;
     initEmailChange(request: InitEmailChangeRequest): Observable<InitEmailChangeResponse>;
     confirmEmailChange(request: ConfirmEmailChangeRequest): Observable<ConfirmEmailChangeResponse>;
+    linkTelegram(request: LinkTelegramRequest): Observable<LinkTelegramResponse>;
 }
 export interface AccountServiceController {
     getAccount(request: GetAccountRequest): Promise<GetAccountResponse> | Observable<GetAccountResponse> | GetAccountResponse;
     initEmailChange(request: InitEmailChangeRequest): Promise<InitEmailChangeResponse> | Observable<InitEmailChangeResponse> | InitEmailChangeResponse;
     confirmEmailChange(request: ConfirmEmailChangeRequest): Promise<ConfirmEmailChangeResponse> | Observable<ConfirmEmailChangeResponse> | ConfirmEmailChangeResponse;
+    linkTelegram(request: LinkTelegramRequest): Promise<LinkTelegramResponse> | Observable<LinkTelegramResponse> | LinkTelegramResponse;
 }
 export declare function AccountServiceControllerMethods(): (constructor: Function) => void;
 export declare const ACCOUNT_SERVICE_NAME = "AccountService";

package/dist/nest/account.js

@@ -19,7 +19,7 @@ var Role;
 exports.ACCOUNT_V1_PACKAGE_NAME = "account.v1";
 function AccountServiceControllerMethods() {
     return function (constructor) {
-        const grpcMethods = ["getAccount", "initEmailChange", "confirmEmailChange"];
+        const grpcMethods = ["getAccount", "initEmailChange", "confirmEmailChange", "linkTelegram"];
         for (const method of grpcMethods) {
             const descriptor = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);
             (0, microservices_1.GrpcMethod)("AccountService", method)(constructor.prototype[method], method, descriptor);

package/dist/nest/auth.d.ts

@@ -41,9 +41,10 @@ export interface TelegramVerifyRequest_QueryEntry {
     value: string;
 }
 export interface TelegramVerifyResponse {
-    url?: string | undefined;
-    accessToken?: string | undefined;
-    refreshToken?: string | undefined;
+    /** bot link when the phone number is still needed, the tokens are empty then */
+    url: string;
+    accessToken: string;
+    refreshToken: string;
     /** secret for the browser that started the login, set only together with url */
     pollToken: string;
 }
@@ -54,6 +55,8 @@ export interface TelegramCompleteRequest {
 }
 export interface TelegramCompleteResponse {
     sessionId: string;
+    /** true when the bot finished linking Telegram to a logged-in account, session_id is empty then */
+    linked: boolean;
 }
 export interface TelegramConsumeRequest {
     sessionId: string;
@@ -70,6 +73,13 @@ export interface TelegramPollResponse {
     accessToken: string;
     refreshToken: string;
 }
+export interface TelegramStatusRequest {
+    telegramId: string;
+}
+export interface TelegramStatusResponse {
+    /** true when Telegram login lets this user in right away */
+    linked: boolean;
+}
 export declare const AUTH_V1_PACKAGE_NAME = "auth.v1";
 export interface AuthServiceClient {
     sendOtp(request: SendOtpRequest): Observable<SendOtpResponse>;
@@ -81,6 +91,7 @@ export interface AuthServiceClient {
     telegramComplete(request: TelegramCompleteRequest): Observable<TelegramCompleteResponse>;
     telegramConsume(request: TelegramConsumeRequest): Observable<TelegramConsumeResponse>;
     telegramPoll(request: TelegramPollRequest): Observable<TelegramPollResponse>;
+    telegramStatus(request: TelegramStatusRequest): Observable<TelegramStatusResponse>;
 }
 export interface AuthServiceController {
     sendOtp(request: SendOtpRequest): Promise<SendOtpResponse> | Observable<SendOtpResponse> | SendOtpResponse;
@@ -92,6 +103,7 @@ export interface AuthServiceController {
     telegramComplete(request: TelegramCompleteRequest): Promise<TelegramCompleteResponse> | Observable<TelegramCompleteResponse> | TelegramCompleteResponse;
     telegramConsume(request: TelegramConsumeRequest): Promise<TelegramConsumeResponse> | Observable<TelegramConsumeResponse> | TelegramConsumeResponse;
     telegramPoll(request: TelegramPollRequest): Promise<TelegramPollResponse> | Observable<TelegramPollResponse> | TelegramPollResponse;
+    telegramStatus(request: TelegramStatusRequest): Promise<TelegramStatusResponse> | Observable<TelegramStatusResponse> | TelegramStatusResponse;
 }
 export declare function AuthServiceControllerMethods(): (constructor: Function) => void;
 export declare const AUTH_SERVICE_NAME = "AuthService";

package/dist/nest/auth.js

@@ -23,6 +23,7 @@ function AuthServiceControllerMethods() {
             "telegramComplete",
             "telegramConsume",
             "telegramPoll",
+            "telegramStatus",
         ];
         for (const method of grpcMethods) {
             const descriptor = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@candesk/contracts",
-	"version": "3.1.0",
+	"version": "3.3.0",
 	"description": "Protobuf contracts for Candesk microservices",
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",

package/proto/account.proto

@@ -7,6 +7,8 @@ service AccountService {
 
   rpc InitEmailChange(InitEmailChangeRequest) returns (InitEmailChangeResponse);
   rpc ConfirmEmailChange(ConfirmEmailChangeRequest) returns (ConfirmEmailChangeResponse);
+
+  rpc LinkTelegram(LinkTelegramRequest) returns (LinkTelegramResponse);
 }
 
 message GetAccountRequest {
@@ -20,6 +22,7 @@ message GetAccountResponse {
     bool is_phone_verified = 4;
     bool is_email_verified = 5;
     Role role = 6;
+    bool is_telegram_linked = 7;
 }
 
 message InitEmailChangeRequest {
@@ -42,6 +45,17 @@ message ConfirmEmailChangeResponse {
     bool ok = 1;
 }
 
+message LinkTelegramRequest {
+    string user_id = 1;
+    map<string, string> query = 2;
+}
+
+message LinkTelegramResponse {
+    bool linked = 1;
+    // bot link where the user shares the phone number, set only when not linked yet
+    string url = 2;
+}
+
 enum Role {
     USER = 0;
     ADMIN = 1;

package/proto/auth.proto

@@ -15,6 +15,7 @@ service AuthService {
   rpc TelegramComplete (TelegramCompleteRequest) returns (TelegramCompleteResponse);
   rpc TelegramConsume (TelegramConsumeRequest) returns (TelegramConsumeResponse);
   rpc TelegramPoll (TelegramPollRequest) returns (TelegramPollResponse);
+  rpc TelegramStatus (TelegramStatusRequest) returns (TelegramStatusResponse);
 }
 
 message SendOtpRequest {
@@ -65,11 +66,10 @@ message TelegramVerifyRequest {
 }
 
 message TelegramVerifyResponse {
-  oneof result {
-    string url = 1;
-    string access_token = 2;
-    string refresh_token = 3;
-  }
+  // bot link when the phone number is still needed, the tokens are empty then
+  string url = 1;
+  string access_token = 2;
+  string refresh_token = 3;
   // secret for the browser that started the login, set only together with url
   string poll_token = 4;
 }
@@ -82,6 +82,8 @@ message TelegramCompleteRequest {
 
 message TelegramCompleteResponse {
   string session_id = 1;
+  // true when the bot finished linking Telegram to a logged-in account, session_id is empty then
+  bool linked = 2;
 }
 
 message TelegramConsumeRequest {
@@ -101,4 +103,13 @@ message TelegramPollResponse {
   bool ready = 1;
   string access_token = 2;
   string refresh_token = 3;
+}
+
+message TelegramStatusRequest {
+  string telegram_id = 1;
+}
+
+message TelegramStatusResponse {
+  // true when Telegram login lets this user in right away
+  bool linked = 1;
 }