@iexec/web3mail 0.2.0 → 0.3.0

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

@@ -3,3 +3,4 @@ export declare const addressOrEnsSchema: () => import("yup").StringSchema<string
 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

@@ -17,3 +17,5 @@ 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, contentType, 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

@@ -11,8 +11,8 @@ import { DEFAULT_CONTENT_TYPE, MAX_DESIRED_APP_ORDER_PRICE, MAX_DESIRED_WORKERPO
 import { WorkflowError } from '../utils/errors.js';
 import { generateSecureUniqueId } from '../utils/generateUniqueId.js';
 import { checkProtectedDataValidity } from '../utils/subgraphQuery.js';
-import { addressOrEnsSchema, contentTypeSchema, emailContentSchema, emailSubjectSchema, throwIfMissing, } from '../utils/validators.js';
-export const sendEmail = ({ graphQLClient = throwIfMissing(), iexec = throwIfMissing(), emailSubject, emailContent, contentType = DEFAULT_CONTENT_TYPE, 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()
@@ -31,6 +31,9 @@ export const sendEmail = ({ graphQLClient = throwIfMissing(), iexec = throwIfMis
             .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) {
@@ -92,7 +95,7 @@ export const sendEmail = ({ graphQLClient = throwIfMissing(), iexec = throwIfMis
         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 }));
+        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,

package/dist/web3mail/types.d.ts

@@ -16,6 +16,7 @@ export type SendEmailParams = {
     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.2.0",
+  "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/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

@@ -31,3 +31,6 @@ 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

@@ -13,6 +13,7 @@ import {
   contentTypeSchema,
   emailContentSchema,
   emailSubjectSchema,
+  senderNameSchema,
   throwIfMissing,
 } from '../utils/validators.js';
 import {
@@ -28,6 +29,7 @@ export const sendEmail = async ({
   emailSubject,
   emailContent,
   contentType = DEFAULT_CONTENT_TYPE,
+  senderName,
   protectedData,
 }: IExecConsumer &
   SubgraphConsumer &
@@ -45,11 +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(
@@ -141,7 +145,7 @@ export const sendEmail = async ({
     await iexec.secrets.pushRequesterSecret(emailContentId, vEmailContent);
     await iexec.secrets.pushRequesterSecret(
       optionsId,
-      JSON.stringify({ contentType: vContentType })
+      JSON.stringify({ contentType: vContentType, senderName: vSenderName })
     );
     // Create and sign request order
     const requestorderToSign = await iexec.order.createRequestorder({

package/src/web3mail/types.ts

@@ -21,6 +21,7 @@ export type SendEmailParams = {
   emailContent: string;
   protectedData: Address;
   contentType?: string;
+  senderName?: string;
 };
 
 export type SendEmailResponse = {