fix(docs): remove @errors annotations and fix TypeScript errors in code samples

Author: abbesBenayache

package-lock.json

@@ -11,10 +11,10 @@
     "format": "prettier --ignore-path .gitignore --write ."
   },
   "dependencies": {
-    "@iexec/dataprotector": "^2.0.0-beta.20",
+    "@iexec/dataprotector": "^2.0.0-beta.21",
     "@iexec/dataprotector-deserializer": "^0.1.1",
-    "@iexec/web3mail": "^1.6.0",
-    "@iexec/web3telegram": "^0.1.0-alpha.4",
+    "@iexec/web3mail": "^1.7.0",
+    "@iexec/web3telegram": "^0.1.0-alpha.7",
     "@reown/appkit": "^1.7.17",
     "@reown/appkit-adapter-wagmi": "^1.7.17",
     "@tailwindcss/vite": "^4.1.11",
@@ -23,7 +23,7 @@
     "@wagmi/vue": "^0.1.24",
     "clsx": "^2.1.1",
     "figlet": "^1.8.2",
-    "iexec": "^8.18.0",
+    "iexec": "^8.22.0",
     "pinia": "^3.0.3",
     "reka-ui": "^2.4.1",
     "tailwind-merge": "^3.3.1",

package.json

@@ -91,7 +91,7 @@ const grantedAccess = await dataProtectorCore.grantAccess({
 import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector';
 const web3Provider = getWeb3Provider('PRIVATE_KEY');
 const dataProtectorCore = new IExecDataProtectorCore(web3Provider);
-
+// ---cut---
 // For bulk campaigns, recipients must grant access with allowBulk: true
 const grantedAccess = await dataProtectorCore.grantAccess({
   protectedData: '0x123abc...',

src/guides/use-iapp/integrate-web3-messaging.md

@@ -225,6 +225,11 @@ configured:
   accesses)
 
 ```ts twoslash
+import { IExecDataProtectorCore, getWeb3Provider } from '@iexec/dataprotector';
+
+const web3Provider = getWeb3Provider('PRIVATE_KEY');
+const dataProtectorCore = new IExecDataProtectorCore(web3Provider);
+// ---cut---
 const grantedAccess = await dataProtectorCore.grantAccess({
   protectedData: '0x123abc...',
   authorizedApp: '0x456def...',

src/references/dataProtector/methods/grantAccess.md

@@ -75,6 +75,10 @@ the Data Protector SDK.
 :::
 
 ```ts twoslash
+import { IExecWeb3mail, getWeb3Provider } from '@iexec/web3mail';
+
+const web3Provider = getWeb3Provider('PRIVATE_KEY');
+const web3mail = new IExecWeb3mail(web3Provider);
 // Fetch contacts with bulk access
 const bulkContacts = await web3mail.fetchMyContacts({
   bulkOnly: true, // [!code focus]

src/references/web3mail/methods/fetchMyContacts.md

@@ -95,8 +95,14 @@ the Data Protector SDK.
 :::
 
 ```ts twoslash
+import { IExecWeb3mail, getWeb3Provider } from '@iexec/web3mail';
+
+const web3Provider = getWeb3Provider('PRIVATE_KEY');
+const web3mail = new IExecWeb3mail(web3Provider);
+// ---cut---
 // Fetch contacts with bulk access for a specific user
 const bulkContacts = await web3mail.fetchUserContacts({
+  userAddress: '0x789cba...',
   bulkOnly: true, // [!code focus]
 });
 ```

src/references/web3mail/methods/fetchUserContacts.md

@@ -30,7 +30,7 @@ This method is part of a two-step bulk campaign process:
 ```ts twoslash [Browser]
 import { IExecWeb3mail } from '@iexec/web3mail';
 
-const web3Provider = window.ethereum;
+const web3Provider = (window as any).ethereum;
 const web3mail = new IExecWeb3mail(web3Provider);
 
 // Fetch contacts with bulk access
@@ -81,6 +81,14 @@ An array of `GrantedAccess` objects representing contacts who have granted you
 access to their protected data with bulk processing capability.
 
 ```ts twoslash
+import { IExecWeb3mail } from '@iexec/web3mail';
+
+const web3Provider = (window as any).ethereum;
+const web3mail = new IExecWeb3mail(web3Provider);
+// Fetch contacts with bulk access
+const contacts = await web3mail.fetchMyContacts({ bulkOnly: true });
+const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
+
 const emailCampaign = await web3mail.prepareEmailCampaign({
   grantedAccesses: grantedAccessArray, // [!code focus]
   emailSubject: 'My subject',
@@ -95,6 +103,14 @@ const emailCampaign = await web3mail.prepareEmailCampaign({
 The email subject that will be sent to all recipients.
 
 ```ts twoslash
+import { IExecWeb3mail } from '@iexec/web3mail';
+
+const web3Provider = (window as any).ethereum;
+const web3mail = new IExecWeb3mail(web3Provider);
+// Fetch contacts with bulk access
+const contacts = await web3mail.fetchMyContacts({ bulkOnly: true });
+const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
+
 const emailCampaign = await web3mail.prepareEmailCampaign({
   grantedAccesses: grantedAccessArray,
   emailSubject: 'My email subject', // [!code focus]
@@ -112,6 +128,14 @@ The email content that will be sent to all recipients. The content is encrypted
 and stored in IPFS.
 
 ```ts twoslash
+import { IExecWeb3mail } from '@iexec/web3mail';
+
+const web3Provider = (window as any).ethereum;
+const web3mail = new IExecWeb3mail(web3Provider);
+// Fetch contacts with bulk access
+const contacts = await web3mail.fetchMyContacts({ bulkOnly: true });
+const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
+
 const emailCampaign = await web3mail.prepareEmailCampaign({
   grantedAccesses: grantedAccessArray,
   emailSubject: 'My email subject',
@@ -128,6 +152,14 @@ const emailCampaign = await web3mail.prepareEmailCampaign({
 The MIME type of the email content (e.g., `'text/plain'`, `'text/html'`).
 
 ```ts twoslash
+import { IExecWeb3mail } from '@iexec/web3mail';
+
+const web3Provider = (window as any).ethereum;
+const web3mail = new IExecWeb3mail(web3Provider);
+// Fetch contacts with bulk access
+const contacts = await web3mail.fetchMyContacts({ bulkOnly: true });
+const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
+
 const emailCampaign = await web3mail.prepareEmailCampaign({
   grantedAccesses: grantedAccessArray,
   emailSubject: 'My email subject',
@@ -145,6 +177,14 @@ const emailCampaign = await web3mail.prepareEmailCampaign({
 Limits the number of protected data items processed per task.
 
 ```ts twoslash
+import { IExecWeb3mail } from '@iexec/web3mail';
+
+const web3Provider = (window as any).ethereum;
+const web3mail = new IExecWeb3mail(web3Provider);
+// Fetch contacts with bulk access
+const contacts = await web3mail.fetchMyContacts({ bulkOnly: true });
+const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
+
 const emailCampaign = await web3mail.prepareEmailCampaign({
   grantedAccesses: grantedAccessArray,
   emailSubject: 'My email subject',
@@ -163,6 +203,14 @@ The workerpool address or ENS name that will execute the bulk campaign tasks.
 You can specify this during preparation or when sending the campaign.
 
 ```ts twoslash
+import { IExecWeb3mail } from '@iexec/web3mail';
+
+const web3Provider = (window as any).ethereum;
+const web3mail = new IExecWeb3mail(web3Provider);
+// Fetch contacts with bulk access
+const contacts = await web3mail.fetchMyContacts({ bulkOnly: true });
+const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
+
 const emailCampaign = await web3mail.prepareEmailCampaign({
   grantedAccesses: grantedAccessArray,
   emailSubject: 'My email subject',
@@ -182,6 +230,14 @@ using their infrastructure to run the Web3Mail app. You can specify this during
 preparation or when sending the campaign.
 
 ```ts twoslash
+import { IExecWeb3mail } from '@iexec/web3mail';
+
+const web3Provider = (window as any).ethereum;
+const web3mail = new IExecWeb3mail(web3Provider);
+// Fetch contacts with bulk access
+const contacts = await web3mail.fetchMyContacts({ bulkOnly: true });
+const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
+
 const emailCampaign = await web3mail.prepareEmailCampaign({
   grantedAccesses: grantedAccessArray,
   emailSubject: 'My email subject',
@@ -197,6 +253,14 @@ const emailCampaign = await web3mail.prepareEmailCampaign({
 An optional label to identify or categorize the campaign.
 
 ```ts twoslash
+import { IExecWeb3mail } from '@iexec/web3mail';
+
+const web3Provider = (window as any).ethereum;
+const web3mail = new IExecWeb3mail(web3Provider);
+// Fetch contacts with bulk access
+const contacts = await web3mail.fetchMyContacts({ bulkOnly: true });
+const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
+
 const emailCampaign = await web3mail.prepareEmailCampaign({
   grantedAccesses: grantedAccessArray,
   emailSubject: 'My email subject',
@@ -215,6 +279,14 @@ The maximum amount (in nRLC) you are willing to pay for accessing the protected
 data.
 
 ```ts twoslash
+import { IExecWeb3mail } from '@iexec/web3mail';
+
+const web3Provider = (window as any).ethereum;
+const web3mail = new IExecWeb3mail(web3Provider);
+// Fetch contacts with bulk access
+const contacts = await web3mail.fetchMyContacts({ bulkOnly: true });
+const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
+
 const emailCampaign = await web3mail.prepareEmailCampaign({
   grantedAccesses: grantedAccessArray,
   emailSubject: 'My email subject',
@@ -233,6 +305,14 @@ The maximum amount (in nRLC) you are willing to pay the Web3Mail app provider
 for using the Web3Mail application.
 
 ```ts twoslash
+import { IExecWeb3mail } from '@iexec/web3mail';
+
+const web3Provider = (window as any).ethereum;
+const web3mail = new IExecWeb3mail(web3Provider);
+// Fetch contacts with bulk access
+const contacts = await web3mail.fetchMyContacts({ bulkOnly: true });
+const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
+
 const emailCampaign = await web3mail.prepareEmailCampaign({
   grantedAccesses: grantedAccessArray,
   emailSubject: 'My email subject',
@@ -255,7 +335,20 @@ The prepared bulk request object that contains all the necessary information to
 process the bulk campaign. This object should be passed to `sendEmailCampaign`
 to execute the campaign.
 
-```ts
+```ts twoslash
+import { IExecWeb3mail } from '@iexec/web3mail';
+
+const web3Provider = (window as any).ethereum;
+const web3mail = new IExecWeb3mail(web3Provider);
+// Fetch contacts and prepare campaign
+const contacts = await web3mail.fetchMyContacts({ bulkOnly: true });
+const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
+const emailCampaign = await web3mail.prepareEmailCampaign({
+  grantedAccesses: grantedAccessArray,
+  emailSubject: 'My email subject',
+  emailContent: 'My email content',
+});
+
 // Use the campaignRequest to send the campaign
 const result = await web3mail.sendEmailCampaign({
   campaignRequest: emailCampaign.campaignRequest, // [!code focus]
@@ -271,7 +364,7 @@ Here's a complete example showing the two-step campaign process:
 ```ts twoslash [Browser]
 import { IExecWeb3mail } from '@iexec/web3mail';
 
-const web3Provider = window.ethereum;
+const web3Provider = (window as any).ethereum;
 const web3mail = new IExecWeb3mail(web3Provider);
 
 // Step 1: Fetch contacts with bulk access

src/references/web3mail/methods/prepareEmailCampaign.md

@@ -34,10 +34,13 @@ Before using this method, make sure you have:
 ```ts twoslash [Browser]
 import { IExecWeb3mail } from '@iexec/web3mail';
 
-const web3Provider = window.ethereum;
+const web3Provider = (window as any).ethereum;
 const web3mail = new IExecWeb3mail(web3Provider);
 
-// Step 1: Prepare the campaign
+// Step 1: Fetch contacts and prepare the campaign
+const contacts = await web3mail.fetchMyContacts({ bulkOnly: true });
+const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
+
 const emailCampaign = await web3mail.prepareEmailCampaign({
   grantedAccesses: grantedAccessArray,
   emailSubject: 'My email subject',
@@ -57,7 +60,10 @@ import { IExecWeb3mail, getWeb3Provider } from '@iexec/web3mail';
 const web3Provider = getWeb3Provider('PRIVATE_KEY');
 const web3mail = new IExecWeb3mail(web3Provider);
 
-// Step 1: Prepare the campaign
+// Step 1: Fetch contacts and prepare the campaign
+const contacts = await web3mail.fetchMyContacts({ bulkOnly: true });
+const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
+
 const emailCampaign = await web3mail.prepareEmailCampaign({
   grantedAccesses: grantedAccessArray,
   emailSubject: 'My email subject',
@@ -88,6 +94,19 @@ the necessary information to process the bulk campaign, including the grouped
 protected data and campaign metadata.
 
 ```ts twoslash
+import { IExecWeb3mail } from '@iexec/web3mail';
+
+const web3Provider = (window as any).ethereum;
+const web3mail = new IExecWeb3mail(web3Provider);
+// Fetch contacts and prepare campaign
+const contacts = await web3mail.fetchMyContacts({ bulkOnly: true });
+const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
+const emailCampaign = await web3mail.prepareEmailCampaign({
+  grantedAccesses: grantedAccessArray,
+  emailSubject: 'My email subject',
+  emailContent: 'My email content',
+});
+
 const result = await web3mail.sendEmailCampaign({
   campaignRequest: emailCampaign.campaignRequest, // [!code focus]
 });
@@ -102,6 +121,19 @@ const result = await web3mail.sendEmailCampaign({
 The workerpool address or ENS name that will execute the bulk campaign tasks.
 
 ```ts twoslash
+import { IExecWeb3mail } from '@iexec/web3mail';
+
+const web3Provider = (window as any).ethereum;
+const web3mail = new IExecWeb3mail(web3Provider);
+// Fetch contacts and prepare campaign
+const contacts = await web3mail.fetchMyContacts({ bulkOnly: true });
+const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
+const emailCampaign = await web3mail.prepareEmailCampaign({
+  grantedAccesses: grantedAccessArray,
+  emailSubject: 'My email subject',
+  emailContent: 'My email content',
+});
+
 const result = await web3mail.sendEmailCampaign({
   campaignRequest: emailCampaign.campaignRequest,
   workerpoolAddressOrEns: '0xa5de76...', // [!code focus]
@@ -129,12 +161,25 @@ Each task may process multiple protected data items depending on the bulk
 request configuration.
 
 ```ts twoslash
+import { IExecWeb3mail } from '@iexec/web3mail';
+
+const web3Provider = (window as any).ethereum;
+const web3mail = new IExecWeb3mail(web3Provider);
+// Fetch contacts and prepare campaign
+const contacts = await web3mail.fetchMyContacts({ bulkOnly: true });
+const grantedAccessArray = contacts.map((contact) => contact.grantedAccess);
+const emailCampaign = await web3mail.prepareEmailCampaign({
+  grantedAccesses: grantedAccessArray,
+  emailSubject: 'My email subject',
+  emailContent: 'My email content',
+});
+
 const result = await web3mail.sendEmailCampaign({
   campaignRequest: emailCampaign.campaignRequest,
 });
 
 console.log(`Created ${result.tasks.length} tasks`);
-result.tasks.forEach((task, index) => {
+result.tasks.forEach((task: { taskId: string; dealId: string; bulkIndex: number }, index: number) => {
   console.log(
     `Task ${index + 1}: ${task.taskId} (Deal: ${task.dealId}, Bulk Index: ${task.bulkIndex})`
   );
@@ -149,10 +194,9 @@ sending the campaign:
 ::: code-group
 
 ```ts twoslash [Browser]
-// ---cut---
 import { IExecWeb3mail } from '@iexec/web3mail';
 
-const web3Provider = window.ethereum;
+const web3Provider = (window as any).ethereum;
 const web3mail = new IExecWeb3mail(web3Provider);
 
 // Step 1: Fetch contacts with bulk access capability
@@ -196,7 +240,7 @@ if (contacts.length === 0) {
   console.log('No contacts with bulk access found.');
   // Recipients need to grant access with bulk processing enabled
   // See: grantAccess method in Data Protector SDK
-  return;
+  // Note: In a real application, you would handle this case appropriately
 }
 
 // Step 2: Extract grantedAccess from contacts

src/references/web3mail/methods/sendEmailCampaign.md

@@ -69,6 +69,11 @@ and
 for bulk campaigns.
 
 ```ts twoslash
+import { IExecWeb3telegram, getWeb3Provider } from '@iexec/web3telegram';
+
+const web3Provider = getWeb3Provider('PRIVATE_KEY');
+const web3telegram = new IExecWeb3telegram(web3Provider);
+// ---cut---
 const contactsList = await web3telegram.fetchMyContacts({
   bulkOnly: true, // [!code focus]
 });