refactor: SendTelegramResponse conditional typing

Author: PierreJeanjacquot

src/web3telegram/IExecWeb3telegram.ts

@@ -1,10 +1,6 @@
 import { AbstractProvider, AbstractSigner, Eip1193Provider } from 'ethers';
 import { IExec } from 'iexec';
-import {
-  IExecDataProtectorCore,
-  ProcessBulkRequestResponse,
-  ProcessBulkRequestParams,
-} from '@iexec/dataprotector';
+import { IExecDataProtectorCore } from '@iexec/dataprotector';
 import { GraphQLClient } from 'graphql-request';
 import { fetchUserContacts } from './fetchUserContacts.js';
 import { fetchMyContacts } from './fetchMyContacts.js';
@@ -17,7 +13,7 @@ import {
   Web3TelegramConfigOptions,
   Web3SignerProvider,
   FetchMyContactsParams,
-  SendTelegramSingleResponse,
+  SendTelegramResponse,
 } from './types.js';
 import { getChainDefaultConfig } from '../config/config.js';
 import { isValidProvider } from '../utils/validators.js';
@@ -114,12 +110,9 @@ export class IExecWeb3telegram {
     });
   }
 
-  async sendTelegram(
-    args: SendTelegramParams
-  ): Promise<
-    | ProcessBulkRequestResponse<ProcessBulkRequestParams>
-    | SendTelegramSingleResponse
-  > {
+  async sendTelegram<Params extends SendTelegramParams>(
+    args: Params
+  ): Promise<SendTelegramResponse<Params>> {
     await this.init();
     await isValidProvider(this.iexec);
     return sendTelegram({
@@ -133,11 +126,11 @@ export class IExecWeb3telegram {
       dappAddressOrENS: this.dappAddressOrENS,
       dappWhitelistAddress: this.dappWhitelistAddress,
       graphQLClient: this.graphQLClient,
-    });
+    } as any) as Promise<SendTelegramResponse<Params>>;
   }
 
   private async resolveConfig(): Promise<Web3telegramResolvedConfig> {
-    const chainId = await getChainIdFromProvider(this.ethProvider as any);
+    const chainId = await getChainIdFromProvider(this.ethProvider);
     const chainDefaultConfig = getChainDefaultConfig(chainId, {
       allowExperimentalNetworks: this.options.allowExperimentalNetworks,
     });
@@ -149,7 +142,7 @@ export class IExecWeb3telegram {
 
     try {
       iexec = new IExec(
-        { ethProvider: this.ethProvider as any },
+        { ethProvider: this.ethProvider },
         {
           ipfsGatewayURL: ipfsGateway,
           ...this.options?.iexecOptions,

src/web3telegram/sendTelegram.ts

@@ -1,8 +1,4 @@
 import { Buffer } from 'buffer';
-import {
-  ProcessBulkRequestResponse,
-  ProcessBulkRequestParams,
-} from '@iexec/dataprotector';
 import {
   MAX_DESIRED_APP_ORDER_PRICE,
   MAX_DESIRED_DATA_ORDER_PRICE,
@@ -20,7 +16,12 @@ import {
   senderNameSchema,
   booleanSchema,
 } from '../utils/validators.js';
-import { SendTelegramParams, SendTelegramSingleResponse } from './types.js';
+import {
+  Address,
+  GrantedAccess,
+  SendTelegramParams,
+  SendTelegramResponse,
+} from './types.js';
 import {
   DappAddressConsumer,
   DappWhitelistAddressConsumer,
@@ -33,7 +34,7 @@ import {
 
 export type SendTelegram = typeof sendTelegram;
 
-export const sendTelegram = async ({
+export const sendTelegram = async <Params extends SendTelegramParams>({
   graphQLClient = throwIfMissing(),
   iexec = throwIfMissing(),
   dataProtector = throwIfMissing(),
@@ -57,11 +58,12 @@ export const sendTelegram = async ({
   DappWhitelistAddressConsumer &
   IpfsNodeConfigConsumer &
   IpfsGatewayConfigConsumer &
-  SendTelegramParams &
-  DataProtectorConsumer): Promise<
-  | ProcessBulkRequestResponse<ProcessBulkRequestParams>
-  | SendTelegramSingleResponse
-> => {
+  DataProtectorConsumer &
+  Params & {
+    protectedData?: Address;
+    grantedAccess?: GrantedAccess[];
+    maxProtectedDataPerTask?: number;
+  }): Promise<SendTelegramResponse<Params>> => {
   try {
     const vUseVoucher = booleanSchema()
       .label('useVoucher')
@@ -154,13 +156,20 @@ export const sendTelegram = async ({
         bulkAccesses: grantedAccess,
         maxProtectedDataPerTask: vMaxProtectedDataPerTask,
       });
-      const processBulkRequestResponse: ProcessBulkRequestResponse<ProcessBulkRequestParams> =
-        await dataProtector.processBulkRequest({
+      const processBulkRequestResponse = await dataProtector.processBulkRequest(
+        {
           bulkRequest: bulkRequest.bulkRequest,
           useVoucher: vUseVoucher,
           workerpool: vWorkerpoolAddressOrEns,
-        });
-      return processBulkRequestResponse;
+        }
+      );
+      return {
+        tasks: processBulkRequestResponse.tasks.map((task) => ({
+          taskId: task.taskId,
+          dealId: task.dealId,
+          bulkIndex: task.bulkIndex,
+        })),
+      } as SendTelegramResponse<Params>;
     }
 
     // Single processing mode - protectedData is required
@@ -198,7 +207,7 @@ export const sendTelegram = async ({
 
     return {
       taskId: result.taskId,
-    };
+    } as SendTelegramResponse<Params>;
   } catch (error) {
     //  Protocol error detected, re-throwing as-is
     if ((error as any)?.isProtocolError === true) {

src/web3telegram/types.ts

@@ -35,17 +35,9 @@ export type Contact = {
   grantedAccess: GrantedAccess;
 };
 
-export type SendTelegramParams = {
+type SendTelegramCommonParams = {
   senderName?: string;
   telegramContent: string;
-  protectedData?: Address;
-  /**
-   * Granted access to process.
-   * use prepareBulkRequest of dataprotector to create a bulk request.
-   * if not provided, the single message will be processed.
-   */
-  grantedAccess?: GrantedAccess[];
-  maxProtectedDataPerTask?: number;
   label?: string;
   workerpoolAddressOrEns?: AddressOrENS;
   dataMaxPrice?: number;
@@ -54,6 +46,23 @@ export type SendTelegramParams = {
   useVoucher?: boolean;
 };
 
+export type SendTelegramParams =
+  | ({
+      /**
+       * protected data to process.
+       */
+      protectedData: Address;
+    } & SendTelegramCommonParams)
+  | ({
+      /**
+       * Granted access to process in bulk.
+       * use `fetchMyContacts({ bulkOnly: true })` to get granted accesses.
+       * if not provided, the single message will be processed.
+       */
+      grantedAccess: GrantedAccess[];
+      maxProtectedDataPerTask?: number;
+    } & SendTelegramCommonParams);
+
 export type FetchMyContactsParams = {
   /**
    * Get contacts for this specific user only
@@ -69,10 +78,27 @@ export type FetchUserContactsParams = {
   userAddress: Address;
 } & FetchMyContactsParams;
 
-export type SendTelegramSingleResponse = {
+type SendTelegramSingleResponse = {
   taskId: string;
 };
 
+type SendTelegramBulkResponse = {
+  tasks: {
+    bulkIndex: number;
+    taskId: string;
+    dealId: string;
+  }[];
+};
+
+export type SendTelegramResponse<Params = { protectedData: Address }> =
+  Params extends {
+    grantedAccess: GrantedAccess[];
+  }
+    ? SendTelegramBulkResponse
+    : never & Params extends { protectedData: Address }
+    ? SendTelegramSingleResponse
+    : never;
+
 /**
  * Configuration options for web3telegram.
  */

tests/e2e/sendTelegramBulk.test.ts

@@ -1,7 +1,5 @@
 import {
     IExecDataProtectorCore,
-    ProcessBulkRequestResponse,
-    ProcessBulkRequestParams,
     ProtectedDataWithSecretProps,
 } from '@iexec/dataprotector';
 import { beforeAll, describe, expect, it } from '@jest/globals';
@@ -10,7 +8,7 @@ import {
     DEFAULT_CHAIN_ID,
     getChainDefaultConfig,
 } from '../../src/config/config.js';
-import { Contact, IExecWeb3telegram, SendTelegramSingleResponse } from '../../src/index.js';
+import { Contact, IExecWeb3telegram } from '../../src/index.js';
 import {
     MAX_EXPECTED_BLOCKTIME,
     MAX_EXPECTED_WEB2_SERVICES_TIME,
@@ -203,7 +201,7 @@ describe('web3telegram.sendTelegram() - Bulk Processing', () => {
                 }
 
                 // Process the bulk request
-                const result: ProcessBulkRequestResponse<ProcessBulkRequestParams> | SendTelegramSingleResponse = await web3telegram.sendTelegram({
+                const result = await web3telegram.sendTelegram({
                     telegramContent: 'Bulk test message',
                     // protectedData is optional when grantedAccess is provided
                     grantedAccess: bulkOrders,