@iexec/web3mail/src/utils/validators.ts

This product enables users to confidentially store data–such as mail address, documents, personal information ...

import { isAddress } from 'ethers';
import { IExec } from 'iexec';
import { NULL_ADDRESS } from 'iexec/utils';
import { ValidationError, boolean, number, object, string } from 'yup';

export const isValidProvider = async (iexec: IExec) => {
  const client = await iexec.config.resolveContractsClient();
  if (!client.signer) {
    throw new Error(
      'Unauthorized method. Please log in with your wallet, you must set a valid provider with a signer.'
    );
  }
};

export const throwIfMissing = (): never => {
  throw new ValidationError('Missing parameter');
};

const isUndefined = (value: unknown) => value === undefined;
const isAddressTest = (value: string) => isAddress(value);

export const addressSchema = () =>
  string()
    .transform((value: string) => value?.toLowerCase() || value)
    .test(
      'is-address',
      '${path} should be an ethereum address',
      (value) => isUndefined(value) || isAddressTest(value)
    );

// 78 char length for email subject (rfc2822)
export const emailSubjectSchema = () => string().max(78).strict();

// Limit of 512,000 bytes (512 kilo-bytes)
export const emailContentSchema = () => string().max(512000);

// 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();

// Used to identify the email campaign, minimum of 3 characters and max of 10
export const labelSchema = () => string().trim().min(3).max(10).optional();

export const positiveNumberSchema = () =>
  number().integer().min(0).typeError('${path} must be a non-negative number');

export const booleanSchema = () =>
  boolean().strict().typeError('${path} should be a boolean');

const isPositiveIntegerStringTest = (value: string) => /^\d+$/.test(value);

const stringSchema = () =>
  string().strict().typeError('${path} should be a string');

const positiveIntegerStringSchema = () =>
  string().test(
    'is-positive-int',
    '${path} should be a positive integer',
    (value) => isUndefined(value) || isPositiveIntegerStringTest(value)
  );

const positiveStrictIntegerStringSchema = () =>
  string().test(
    'is-positive-strict-int',
    '${path} should be a strictly positive integer',
    (value) =>
      isUndefined(value) ||
      (value !== '0' && isPositiveIntegerStringTest(value))
  );

export const campaignRequestSchema = () =>
  object({
    app: addressSchema().required(),
    appmaxprice: positiveIntegerStringSchema().required(),
    workerpool: addressSchema().required(),
    workerpoolmaxprice: positiveIntegerStringSchema().required(),
    dataset: addressSchema().oneOf([NULL_ADDRESS]).required(),
    datasetmaxprice: positiveIntegerStringSchema().oneOf(['0']).required(),
    params: stringSchema()
      .test(
        'is-valid-bulk-params',
        '${path} should be a valid JSON string with bulk_cid field',
        (value) => {
          try {
            // eslint-disable-next-line @typescript-eslint/naming-convention
            const { bulk_cid } = JSON.parse(value);
            if (typeof bulk_cid === 'string') {
              return true;
            }
          } catch {}
          return false;
        }
      )
      .required(),
    requester: addressSchema().required(),
    beneficiary: addressSchema().required(),
    callback: addressSchema().required(),
    category: positiveIntegerStringSchema().required(),
    volume: positiveStrictIntegerStringSchema().required(),
    tag: stringSchema().required(),
    trust: positiveIntegerStringSchema().required(),
    salt: stringSchema().required(),
    sign: stringSchema().required(),
  })
    .strict()
    .typeError('${path} should be a BulkRequest object')
    .test('is-defined', '${path} is required', (value) => {
      // Check if value is undefined, null, or an empty object (which would be coerced from undefined)
      return (
        value !== undefined &&
        value !== null &&
        !(typeof value === 'object' && Object.keys(value).length === 0)
      );
    });