@iexec/web3mail 0.1.1 → 0.3.0

package/README.md

@@ -16,7 +16,7 @@ Web3mail is composed of 2 methods:
 
 <div align="center">
 
-[![npm](https://img.shields.io/npm/v/web3mail-sdk)](https://www.npmjs.com/package/@iexec/web3mail)[![license](https://img.shields.io/badge/license-Apache%202-blue)](/LICENSE)
+[![npm](https://img.shields.io/npm/v/@iexec/web3mail)](https://www.npmjs.com/package/@iexec/web3mail)[![license](https://img.shields.io/badge/license-Apache%202-blue)](/LICENSE)
 
 </div>
 

package/dist/config/config.d.ts

@@ -3,3 +3,4 @@ export declare const WORKERPOOL_ADDRESS = "prod-v8-bellecour.main.pools.iexec.et
 export declare const DATAPROTECTOR_SUBGRAPH_ENDPOINT = "https://thegraph-product.iex.ec/subgraphs/name/bellecour/dataprotector";
 export declare const MAX_DESIRED_APP_ORDER_PRICE = 0;
 export declare const MAX_DESIRED_WORKERPOOL_ORDER_PRICE = 0;
+export declare const DEFAULT_CONTENT_TYPE = "text/plain";

package/dist/config/config.js

@@ -3,3 +3,4 @@ export const WORKERPOOL_ADDRESS = 'prod-v8-bellecour.main.pools.iexec.eth';
 export const DATAPROTECTOR_SUBGRAPH_ENDPOINT = 'https://thegraph-product.iex.ec/subgraphs/name/bellecour/dataprotector';
 export const MAX_DESIRED_APP_ORDER_PRICE = 0;
 export const MAX_DESIRED_WORKERPOOL_ORDER_PRICE = 0;
+export const DEFAULT_CONTENT_TYPE = 'text/plain';

package/dist/utils/generateUniqueId.d.ts

@@ -1 +1 @@
-export declare function generateSecureUniqueId(length: number): string;
+export declare function generateSecureUniqueId(length: any): string;

package/dist/utils/generateUniqueId.js

@@ -1,5 +1,5 @@
-import crypto from 'crypto';
+import { randomBytes } from '@ethersproject/random';
+import { hexlify } from '@ethersproject/bytes';
 export function generateSecureUniqueId(length) {
-    const buffer = crypto.randomBytes(length);
-    return buffer.toString('hex');
+    return hexlify(randomBytes(length));
 }

package/dist/utils/validators.d.ts

@@ -2,3 +2,5 @@ export declare const throwIfMissing: () => never;
 export declare const addressOrEnsSchema: () => import("yup").StringSchema<string, import("yup").AnyObject, undefined, "">;
 export declare const emailSubjectSchema: () => import("yup").StringSchema<string, import("yup").AnyObject, undefined, "">;
 export declare const emailContentSchema: () => import("yup").StringSchema<string, import("yup").AnyObject, undefined, "">;
+export declare const contentTypeSchema: () => import("yup").StringSchema<string, import("yup").AnyObject, undefined, "">;
+export declare const senderNameSchema: () => import("yup").StringSchema<string, import("yup").AnyObject, undefined, "">;

package/dist/utils/validators.js

@@ -14,3 +14,8 @@ export const addressOrEnsSchema = () => string()
 export const emailSubjectSchema = () => string().max(78).strict();
 // 4096 bytes is the current max length for iExec SMS secrets
 export const emailContentSchema = () => string().max(4096).strict();
+// Valid content types for the variable 'contentType'
+const validContentTypes = ['text/plain', 'text/html'];
+export const contentTypeSchema = () => string().oneOf(validContentTypes, 'Invalid contentType').optional();
+// Minimum of 3 characters and max of 20 to avoid sender being flagged as spam
+export const senderNameSchema = () => string().trim().min(3).max(20).optional();

package/dist/web3mail/sendEmail.d.ts

@@ -1,2 +1,2 @@
 import { IExecConsumer, SendEmailParams, SendEmailResponse, SubgraphConsumer } from './types.js';
-export declare const sendEmail: ({ graphQLClient, iexec, emailSubject, emailContent, protectedData, }: IExecConsumer & SubgraphConsumer & SendEmailParams) => Promise<SendEmailResponse>;
+export declare const sendEmail: ({ graphQLClient, iexec, emailSubject, emailContent, contentType, senderName, protectedData, }: IExecConsumer & SubgraphConsumer & SendEmailParams) => Promise<SendEmailResponse>;

package/dist/web3mail/sendEmail.js

@@ -7,12 +7,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { MAX_DESIRED_APP_ORDER_PRICE, MAX_DESIRED_WORKERPOOL_ORDER_PRICE, WEB3_MAIL_DAPP_ADDRESS, WORKERPOOL_ADDRESS, } from '../config/config.js';
+import { DEFAULT_CONTENT_TYPE, MAX_DESIRED_APP_ORDER_PRICE, MAX_DESIRED_WORKERPOOL_ORDER_PRICE, WEB3_MAIL_DAPP_ADDRESS, WORKERPOOL_ADDRESS, } from '../config/config.js';
 import { WorkflowError } from '../utils/errors.js';
 import { generateSecureUniqueId } from '../utils/generateUniqueId.js';
 import { checkProtectedDataValidity } from '../utils/subgraphQuery.js';
-import { addressOrEnsSchema, emailContentSchema, emailSubjectSchema, throwIfMissing, } from '../utils/validators.js';
-export const sendEmail = ({ graphQLClient = throwIfMissing(), iexec = throwIfMissing(), emailSubject, emailContent, protectedData, }) => __awaiter(void 0, void 0, void 0, function* () {
+import { addressOrEnsSchema, contentTypeSchema, emailContentSchema, emailSubjectSchema, senderNameSchema, throwIfMissing, } from '../utils/validators.js';
+export const sendEmail = ({ graphQLClient = throwIfMissing(), iexec = throwIfMissing(), emailSubject, emailContent, contentType = DEFAULT_CONTENT_TYPE, senderName, protectedData, }) => __awaiter(void 0, void 0, void 0, function* () {
     var _a, _b, _c, _d, _e;
     try {
         const vDatasetAddress = addressOrEnsSchema()
@@ -27,6 +27,13 @@ export const sendEmail = ({ graphQLClient = throwIfMissing(), iexec = throwIfMis
             .required()
             .label('emailContent')
             .validateSync(emailContent);
+        const vContentType = contentTypeSchema()
+            .required()
+            .label('contentType')
+            .validateSync(contentType);
+        const vSenderName = senderNameSchema()
+            .label('senderName')
+            .validateSync(senderName);
         // Check protected data validity through subgraph
         const isValidProtectedData = yield checkProtectedDataValidity(graphQLClient, vDatasetAddress);
         if (!isValidProtectedData) {
@@ -85,8 +92,10 @@ export const sendEmail = ({ graphQLClient = throwIfMissing(), iexec = throwIfMis
         // Push requester secrets
         const emailSubjectId = generateSecureUniqueId(16);
         const emailContentId = generateSecureUniqueId(16);
+        const optionsId = generateSecureUniqueId(16);
         yield iexec.secrets.pushRequesterSecret(emailSubjectId, vEmailSubject);
         yield iexec.secrets.pushRequesterSecret(emailContentId, vEmailContent);
+        yield iexec.secrets.pushRequesterSecret(optionsId, JSON.stringify({ contentType: vContentType, senderName: vSenderName }));
         // Create and sign request order
         const requestorderToSign = yield iexec.order.createRequestorder({
             app: WEB3_MAIL_DAPP_ADDRESS,
@@ -101,6 +110,7 @@ export const sendEmail = ({ graphQLClient = throwIfMissing(), iexec = throwIfMis
                 iexec_secrets: {
                     1: emailSubjectId,
                     2: emailContentId,
+                    3: optionsId,
                 },
             },
         });

package/dist/web3mail/types.d.ts

@@ -1,5 +1,5 @@
-import { EnhancedWallet, IExec } from 'iexec';
 import { GraphQLClient } from 'graphql-request';
+import { EnhancedWallet, IExec } from 'iexec';
 export type Web3SignerProvider = EnhancedWallet;
 export type IExecConsumer = {
     iexec: IExec;
@@ -15,6 +15,8 @@ export type SendEmailParams = {
     emailSubject: string;
     emailContent: string;
     protectedData: Address;
+    contentType?: string;
+    senderName?: string;
 };
 export type SendEmailResponse = {
     taskId: Address;

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@iexec/web3mail",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "description": "This product enables users to confidentially store data–such as mail address, documents, personal information ...",
-  "main": "./dist/bundle.js",
+  "main": "./dist/index.js",
   "type": "module",
   "types": "dist/index.d.ts",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "node": "./dist/index.js",
-      "default": "./dist/bundle.js"
+      "default": "./dist/index.js"
     }
   },
   "files": [
@@ -18,8 +18,7 @@
     "dist"
   ],
   "scripts": {
-    "build": "rm -rf dist && tsc && webpack",
-    "start": "node dist/bundle.js",
+    "build": "rm -rf dist && tsc",
     "test": "rm -rf dist && tsc && NODE_OPTIONS=--experimental-vm-modules npx jest --coverage",
     "lint": "eslint . --ext .ts",
     "format": "prettier --write \"src/**/*.ts\"",
@@ -42,9 +41,6 @@
     "@iexec/dataprotector": "^0.1.0",
     "@types/jest": "^29.5.1",
     "@typescript-eslint/eslint-plugin": "^5.54.0",
-    "assert": "^2.0.0",
-    "constants-browserify": "^1.0.0",
-    "crypto-browserify": "^3.12.0",
     "eslint": "^8.35.0",
     "eslint-config-prettier": "^8.6.0",
     "eslint-config-standard-with-typescript": "^34.0.0",
@@ -53,15 +49,15 @@
     "eslint-plugin-promise": "^6.1.1",
     "jest": "^29.5.0",
     "prettier": "^2.8.4",
-    "stream-browserify": "^3.0.0",
     "ts-jest": "^29.1.0",
     "ts-loader": "^9.4.2",
-    "typescript": "^4.9.5",
-    "webpack-cli": "^5.0.1"
+    "typescript": "^4.9.5"
   },
   "dependencies": {
+    "@ethersproject/bytes": "^5.7.0",
+    "@ethersproject/random": "^5.7.0",
     "graphql-request": "^6.1.0",
-    "iexec": "^8.1.5",
+    "iexec": "^8.2.1",
     "yup": "^1.1.1"
   }
 }

package/src/config/config.ts

@@ -4,3 +4,4 @@ export const DATAPROTECTOR_SUBGRAPH_ENDPOINT =
   'https://thegraph-product.iex.ec/subgraphs/name/bellecour/dataprotector';
 export const MAX_DESIRED_APP_ORDER_PRICE = 0;
 export const MAX_DESIRED_WORKERPOOL_ORDER_PRICE = 0;
+export const DEFAULT_CONTENT_TYPE = 'text/plain';

package/src/utils/generateUniqueId.ts

@@ -1,6 +1,6 @@
-import crypto from 'crypto';
+import { randomBytes } from '@ethersproject/random';
+import { hexlify } from '@ethersproject/bytes';
 
-export function generateSecureUniqueId(length: number): string {
-  const buffer = crypto.randomBytes(length);
-  return buffer.toString('hex');
+export function generateSecureUniqueId(length) {
+  return hexlify(randomBytes(length));
 }

package/src/utils/validators.ts

@@ -25,3 +25,12 @@ export const emailSubjectSchema = () => string().max(78).strict();
 
 // 4096 bytes is the current max length for iExec SMS secrets
 export const emailContentSchema = () => string().max(4096).strict();
+
+// Valid content types for the variable 'contentType'
+const validContentTypes = ['text/plain', 'text/html'];
+
+export const contentTypeSchema = () =>
+  string().oneOf(validContentTypes, 'Invalid contentType').optional();
+
+// Minimum of 3 characters and max of 20 to avoid sender being flagged as spam
+export const senderNameSchema = () => string().trim().min(3).max(20).optional();

package/src/web3mail/sendEmail.ts

@@ -1,4 +1,5 @@
 import {
+  DEFAULT_CONTENT_TYPE,
   MAX_DESIRED_APP_ORDER_PRICE,
   MAX_DESIRED_WORKERPOOL_ORDER_PRICE,
   WEB3_MAIL_DAPP_ADDRESS,
@@ -9,8 +10,10 @@ import { generateSecureUniqueId } from '../utils/generateUniqueId.js';
 import { checkProtectedDataValidity } from '../utils/subgraphQuery.js';
 import {
   addressOrEnsSchema,
+  contentTypeSchema,
   emailContentSchema,
   emailSubjectSchema,
+  senderNameSchema,
   throwIfMissing,
 } from '../utils/validators.js';
 import {
@@ -25,6 +28,8 @@ export const sendEmail = async ({
   iexec = throwIfMissing(),
   emailSubject,
   emailContent,
+  contentType = DEFAULT_CONTENT_TYPE,
+  senderName,
   protectedData,
 }: IExecConsumer &
   SubgraphConsumer &
@@ -42,6 +47,13 @@ export const sendEmail = async ({
       .required()
       .label('emailContent')
       .validateSync(emailContent);
+    const vContentType = contentTypeSchema()
+      .required()
+      .label('contentType')
+      .validateSync(contentType);
+    const vSenderName = senderNameSchema()
+      .label('senderName')
+      .validateSync(senderName);
 
     // Check protected data validity through subgraph
     const isValidProtectedData = await checkProtectedDataValidity(
@@ -128,9 +140,13 @@ export const sendEmail = async ({
     // Push requester secrets
     const emailSubjectId = generateSecureUniqueId(16);
     const emailContentId = generateSecureUniqueId(16);
+    const optionsId = generateSecureUniqueId(16);
     await iexec.secrets.pushRequesterSecret(emailSubjectId, vEmailSubject);
     await iexec.secrets.pushRequesterSecret(emailContentId, vEmailContent);
-
+    await iexec.secrets.pushRequesterSecret(
+      optionsId,
+      JSON.stringify({ contentType: vContentType, senderName: vSenderName })
+    );
     // Create and sign request order
     const requestorderToSign = await iexec.order.createRequestorder({
       app: WEB3_MAIL_DAPP_ADDRESS,
@@ -145,6 +161,7 @@ export const sendEmail = async ({
         iexec_secrets: {
           1: emailSubjectId,
           2: emailContentId,
+          3: optionsId,
         },
       },
     });

package/src/web3mail/types.ts

@@ -1,5 +1,5 @@
-import { EnhancedWallet, IExec } from 'iexec';
 import { GraphQLClient } from 'graphql-request';
+import { EnhancedWallet, IExec } from 'iexec';
 
 export type Web3SignerProvider = EnhancedWallet;
 
@@ -20,6 +20,8 @@ export type SendEmailParams = {
   emailSubject: string;
   emailContent: string;
   protectedData: Address;
+  contentType?: string;
+  senderName?: string;
 };
 
 export type SendEmailResponse = {