temp-disposable-email 0.0.0

package/dist/esm/utils/delay.d.ts

@@ -0,0 +1,2 @@
+export declare const delay: (ms: number) => Promise<void>;
+//# sourceMappingURL=delay.d.ts.map

package/dist/esm/utils/delay.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"delay.d.ts","sourceRoot":"","sources":["../../../src/utils/delay.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,KAAK,OAAQ,MAAM,KAAG,OAAO,CAAC,IAAI,CACI,CAAC"}

package/dist/esm/utils/delay.js

@@ -0,0 +1,2 @@
+export const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+//# sourceMappingURL=delay.js.map

package/dist/esm/utils/delay.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delay.js","sourceRoot":"","sources":["../../../src/utils/delay.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,EAAU,EAAiB,EAAE,CACjD,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC"}

package/dist/esm/utils/generateRandomName.d.ts

@@ -0,0 +1,2 @@
+export declare const generateRandomName: () => string;
+//# sourceMappingURL=generateRandomName.d.ts.map

package/dist/esm/utils/generateRandomName.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateRandomName.d.ts","sourceRoot":"","sources":["../../../src/utils/generateRandomName.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,kBAAkB,QAAO,MACO,CAAC"}

package/dist/esm/utils/generateRandomName.js

@@ -0,0 +1,2 @@
+export const generateRandomName = () => Math.random().toString(36).substring(2, 15);
+//# sourceMappingURL=generateRandomName.js.map

package/dist/esm/utils/generateRandomName.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateRandomName.js","sourceRoot":"","sources":["../../../src/utils/generateRandomName.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAW,EAAE,CAC7C,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC"}

package/dist/esm/utils/getVerificationCode.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Extracts a verification code from the provided email content.
+ *
+ * This function scans the given text for a sequence of 5 or more
+ * consecutive digits and returns the first valid verification code.
+ * If no valid sequence is found, the function returns `null`.
+ *
+ * @param {string} text - The content of the email, typically the body.
+ * @returns {Promise<string | null>} The first verification code found, or `null` if no valid code exists.
+ *
+ * @example
+ * const emailContent = "Your code is 123456.";
+ * const verificationCode = await getVerificationCode(emailContent);
+ * console.log(verificationCode); // Output: "123456"
+ */
+export declare const getVerificationCode: (text: string) => Promise<string | null>;
+//# sourceMappingURL=getVerificationCode.d.ts.map

package/dist/esm/utils/getVerificationCode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getVerificationCode.d.ts","sourceRoot":"","sources":["../../../src/utils/getVerificationCode.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,eAAO,MAAM,mBAAmB,SACxB,MAAM,KACX,OAAO,CAAC,MAAM,GAAG,IAAI,CAQvB,CAAC"}

package/dist/esm/utils/getVerificationCode.js

@@ -0,0 +1,25 @@
+/**
+ * Extracts a verification code from the provided email content.
+ *
+ * This function scans the given text for a sequence of 5 or more
+ * consecutive digits and returns the first valid verification code.
+ * If no valid sequence is found, the function returns `null`.
+ *
+ * @param {string} text - The content of the email, typically the body.
+ * @returns {Promise<string | null>} The first verification code found, or `null` if no valid code exists.
+ *
+ * @example
+ * const emailContent = "Your code is 123456.";
+ * const verificationCode = await getVerificationCode(emailContent);
+ * console.log(verificationCode); // Output: "123456"
+ */
+export const getVerificationCode = async (text) => {
+    console.log('Extracting the verification code from the email content...');
+    const matches = text.match(/\b\d{5,}\b/);
+    if (matches) {
+        return matches[0];
+    }
+    console.warn('No verification code found in the provided email content.');
+    return null;
+};
+//# sourceMappingURL=getVerificationCode.js.map

package/dist/esm/utils/getVerificationCode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getVerificationCode.js","sourceRoot":"","sources":["../../../src/utils/getVerificationCode.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,EACtC,IAAY,EACY,EAAE;IAC1B,OAAO,CAAC,GAAG,CAAC,4DAA4D,CAAC,CAAC;IAC1E,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IACzC,IAAI,OAAO,EAAE,CAAC;QACZ,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,2DAA2D,CAAC,CAAC;IAC1E,OAAO,IAAI,CAAC;AACd,CAAC,CAAC"}

package/jest.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  testMatch: ['<rootDir>/tests/*.test.ts'],
+  moduleNameMapper: {
+    '^@/(.*)$': '<rootDir>/src/$1',
+  },
+};

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "temp-disposable-email",
+  "version": "0.0.0",
+  "description": "Generating Temporary email address for testing, retrieving email from the temporary email address",
+  "main": "dist/cjs/index.js",
+  "exports": {
+    ".": {
+      "require": "./dist/cjs/index.js",
+      "import": "./dist/esm/index.js"
+    }
+  },
+  "types": "dist/esm/index.d.ts",
+  "scripts": {
+    "build": "tsc -p tsconfig.json && tsc -p tsconfig.cjs.json",
+    "test": "jest",
+    "test:cypress": "cypress run",
+    "test:playwright": "playwright test",
+    "lint": "eslint src --fix",
+    "prepare": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/pirasanthan-jesugeevegan/temp-disposable-email.git"
+  },
+  "keywords": [
+    "temp-email",
+    "disposable-email",
+    "email",
+    "email-testing",
+    "automation",
+    "polling",
+    "cypress",
+    "playwright"
+  ],
+  "author": "Pirasanthan Jesugeevegan",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/issues"
+  },
+  "homepage": "https://github.com/pirasanthan-jesugeevegan/temp-disposable-email#readme",
+  "dependencies": {
+    "axios": "^1.7.8",
+    "dotenv": "^16.4.5",
+    "temp-disposable-email": "^1.6.4",
+    "tslib": "^2.8.1"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.49.0",
+    "@types/cypress": "^1.1.6",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.10.0",
+    "axios-mock-adapter": "^2.1.0",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.7.2"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  }
+}

package/playwright.config.ts

@@ -0,0 +1,78 @@
+import { defineConfig, devices } from '@playwright/test';
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// import dotenv from 'dotenv';
+// import path from 'path';
+// dotenv.config({ path: path.resolve(__dirname, '.env') });
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+export default defineConfig({
+  testDir: './examples/playwright',
+  /* Run tests in files in parallel */
+  fullyParallel: true,
+  /* Fail the build on CI if you accidentally left test.only in the source code. */
+  forbidOnly: !!process.env.CI,
+  /* Retry on CI only */
+  retries: process.env.CI ? 2 : 0,
+  /* Opt out of parallel tests on CI. */
+  workers: process.env.CI ? 1 : undefined,
+  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+  reporter: 'html',
+  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
+  use: {
+    /* Base URL to use in actions like `await page.goto('/')`. */
+    // baseURL: 'http://127.0.0.1:3000',
+
+    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+    trace: 'on-first-retry',
+  },
+
+  /* Configure projects for major browsers */
+  projects: [
+    {
+      name: 'chromium',
+      use: { ...devices['Desktop Chrome'] },
+    },
+
+    // {
+    //   name: 'firefox',
+    //   use: { ...devices['Desktop Firefox'] },
+    // },
+
+    // {
+    //   name: 'webkit',
+    //   use: { ...devices['Desktop Safari'] },
+    // },
+    /* Test against mobile viewports. */
+    // {
+    //   name: 'Mobile Chrome',
+    //   use: { ...devices['Pixel 5'] },
+    // },
+    // {
+    //   name: 'Mobile Safari',
+    //   use: { ...devices['iPhone 12'] },
+    // },
+
+    /* Test against branded browsers. */
+    // {
+    //   name: 'Microsoft Edge',
+    //   use: { ...devices['Desktop Edge'], channel: 'msedge' },
+    // },
+    // {
+    //   name: 'Google Chrome',
+    //   use: { ...devices['Desktop Chrome'], channel: 'chrome' },
+    // },
+  ],
+
+  /* Run your local dev server before starting the tests */
+  // webServer: {
+  //   command: 'npm run start',
+  //   url: 'http://127.0.0.1:3000',
+  //   reuseExistingServer: !process.env.CI,
+  // },
+});

package/src/index.ts

@@ -0,0 +1,11 @@
+import * as dotenv from 'dotenv';
+dotenv.config();
+
+export { createInbox, deleteAccount } from './services/accountService';
+export {
+  getRecentEmail,
+  deleteMessage,
+  MessageContent,
+  GetEmailOptions,
+} from './services/messageService';
+export { getVerificationCode } from './utils/getVerificationCode';

package/src/services/accountService.ts

@@ -0,0 +1,103 @@
+import axios from 'axios';
+import { authenticate, getToken } from './authService';
+import { generateRandomName } from '../utils/generateRandomName';
+import { delay } from '../utils/delay';
+import { BASE_URL } from '../utils/constant';
+
+let accountId: string | null = null;
+/**
+ * Creates a new email inbox with a unique address.
+ *
+ * This function selects an available domain, generates an email
+ * address, and attempts to create an account on the Mail.tm service.
+ * If account creation is rate-limited, the function retries with a
+ * delay. Upon successful creation, it authenticates the account and
+ * stores the token and account ID for future API calls.
+ *
+ * @param {string} [username] - Optional username; a random one is generated if not provided.
+ * @returns {Promise<string>} The generated email address.
+ *
+ * @throws {Error} If no domains are available or account creation fails.
+ *
+ * @example
+ * const email = await createInbox("customUser");
+ * console.log(email); // Outputs: "customUser@mail.tm"
+ */
+
+export const createInbox = async (username?: string): Promise<string> => {
+  const domainsResponse = await axios.get(`${BASE_URL}/domains`, {
+    headers: { accept: 'application/ld+json' },
+  });
+  const domains = domainsResponse.data['hydra:member'].map(
+    (domain: { domain: string }) => domain.domain
+  );
+  if (domains.length === 0) throw new Error('No available domains.');
+
+  const emailAddress = `${username || generateRandomName()}@${domains[0]}`;
+  const password = generateRandomName();
+
+  let attempts = 0;
+  const maxRetries = 5;
+
+  while (attempts < maxRetries) {
+    try {
+      const accountResponse = await axios.post(
+        `${BASE_URL}/accounts`,
+        { address: emailAddress, password },
+        {
+          headers: {
+            accept: 'application/json',
+            'Content-Type': 'application/json',
+          },
+        }
+      );
+      accountId = accountResponse.data.id;
+      await authenticate(emailAddress, password);
+      return emailAddress;
+    } catch (error: any) {
+      if (error.response?.status === 429) {
+        attempts++;
+        const retryAfter = error.response.headers['retry-after']
+          ? parseInt(error.response.headers['retry-after'])
+          : 5;
+        await delay(retryAfter * 1000);
+      } else {
+        throw error;
+      }
+    }
+  }
+  throw new Error('Failed to create account after multiple retries.');
+};
+
+/**
+ * Deletes the account created during `createInbox`.
+ *
+ * This function removes the email account from the Mail.tm service
+ * and clears the stored authentication token and account ID.
+ * Subsequent API calls requiring authentication will fail until a
+ * new account is created.
+ *
+ * @returns {Promise<void>} Resolves when the account is successfully deleted.
+ *
+ * @throws {Error} If no account is authenticated or deletion fails.
+ *
+ * @example
+ * await deleteAccount();
+ * console.log("Account deleted successfully.");
+ */
+export const deleteAccount = async (): Promise<void> => {
+  const token = getToken();
+  if (!token || !accountId) {
+    throw new Error(
+      'Account information missing. Create and authenticate an account first.'
+    );
+  }
+
+  await axios.delete(`${BASE_URL}/accounts/${accountId}`, {
+    headers: {
+      accept: '*/*',
+      Authorization: `Bearer ${token}`,
+    },
+  });
+  accountId = null;
+};

package/src/services/authService.ts

@@ -0,0 +1,23 @@
+import axios from 'axios';
+import { BASE_URL } from '../utils/constant';
+
+let token: string | null = null;
+
+export const authenticate = async (
+  email: string,
+  password: string
+): Promise<void> => {
+  const response = await axios.post(
+    `${BASE_URL}/token`,
+    { address: email, password },
+    {
+      headers: {
+        accept: 'application/json',
+        'Content-Type': 'application/json',
+      },
+    }
+  );
+  token = response.data.token;
+};
+
+export const getToken = (): string | null => token;

package/src/services/messageService.ts

@@ -0,0 +1,155 @@
+import axios from 'axios';
+import { getToken } from './authService';
+import { BASE_URL } from '../utils/constant';
+import { fetchMessageContent, fetchMessages } from '../utils/api';
+
+export interface MessageContent {
+  from: { address: string };
+  to: { address: string }[];
+  subject: string;
+  intro: string;
+  text: string;
+  html: string;
+}
+export interface GetEmailOptions {
+  maxWaitTime?: number;
+  waitInterval?: number;
+  logPolling?: boolean;
+  deleteAfterRead?: boolean;
+}
+
+/**
+ * Retrieves the latest message from the inbox.
+ *
+ * If messages are available, this function fetches the first one and
+ * returns its details. Polling options can be specified to wait for
+ * messages if the inbox is empty. Optionally, the message can be
+ * deleted after reading.
+ *
+ * @param {GetEmailOptions} [options] - Optional settings for polling and deletion.
+ * @returns {Promise<MessageContent | null>} The email content (sender, recipient, subject, text, HTML), or `null` if no messages are found.
+ *
+ * @throws {Error} If no messages are available within the polling timeout or authentication fails.
+ *
+ * @example
+ * const message = await getRecentEmail({ maxWaitTime: 5000, waitInterval: 1000, logPolling: true });
+ * console.log(message.subject); // Outputs: "Hello!"
+ */
+export const getRecentEmail = async (
+  options?: GetEmailOptions
+): Promise<MessageContent | null> => {
+  const token = getToken();
+  const {
+    maxWaitTime = 30000,
+    waitInterval = 2000,
+    logPolling = false,
+    deleteAfterRead = false,
+  } = options || {};
+  if (!token)
+    throw new Error('Authentication required. Call createInbox() first.');
+
+  if (!options) {
+    const messages = await fetchMessages();
+    if (messages.length === 0) throw new Error('No messages available');
+    const messageId = messages[0].id;
+    const { from, to, subject, intro, text, html } = await fetchMessageContent(
+      messageId
+    );
+    if (deleteAfterRead) {
+      await deleteMessage(messageId);
+    }
+    return {
+      from: from.address,
+      to: to[0].address,
+      subject,
+      intro,
+      text,
+      html,
+    };
+  }
+
+  const startTime = Date.now();
+
+  if (logPolling) {
+    console.log(
+      `Polling started with a timeout of ${
+        maxWaitTime / 1000
+      }sec and interval of ${waitInterval / 1000}sec.`
+    );
+  }
+  while (Date.now() - startTime < maxWaitTime) {
+    const messages = await fetchMessages();
+    if (messages.length > 0) {
+      if (logPolling) {
+        console.log(`Found ${messages.length} message(s), fetching details...`);
+      }
+      const messageId = messages[0].id;
+      if (logPolling) {
+        console.log(`Message retrieved`);
+      }
+      const { from, to, subject, intro, text, html } =
+        await fetchMessageContent(messageId);
+
+      if (deleteAfterRead) {
+        await deleteMessage(messageId);
+      }
+      return {
+        from: from.address,
+        to: to[0].address,
+        subject,
+        intro,
+        text,
+        html,
+      };
+    }
+    await new Promise((resolve) => setTimeout(resolve, waitInterval));
+    if (logPolling) {
+      console.log(
+        `No messages found, waiting for ${waitInterval / 1000} seconds...`
+      );
+    }
+  }
+  if (logPolling) {
+    console.log(
+      `Waiting timeout of ${
+        maxWaitTime / 1000
+      } seconds reached. No messages found.`
+    );
+  }
+  throw new Error(
+    `No messages available within ${maxWaitTime / 1000} seconds timeout`
+  );
+};
+
+/**
+ * Deletes a message by its unique ID from the Mail.tm inbox.
+ *
+ * This function requires a valid authentication token. If the
+ * token is not set, an error is thrown. The message is deleted
+ * using the Mail.tm API, and a success or failure message is logged.
+ *
+ * @param {string} messageId - The unique ID of the message to delete.
+ * @returns {Promise<void>} Resolves after the message is deleted.
+ *
+ * @throws {Error} If authentication is missing or the deletion fails.
+ *
+ * @example
+ * await deleteMessage("12345");
+ * console.log("Message deleted successfully.");
+ */
+export const deleteMessage = async (messageId: string): Promise<void> => {
+  const token = getToken();
+  if (!token)
+    throw new Error('Authentication required. Call createInbox() first.');
+
+  try {
+    await axios.delete(`${BASE_URL}/messages/${messageId}`, {
+      headers: {
+        accept: '*/*',
+        Authorization: `Bearer ${token}`,
+      },
+    });
+  } catch (error) {
+    console.error(`Failed to delete message with ID ${messageId}: ${error}`);
+  }
+};

package/src/utils/api.ts

@@ -0,0 +1,38 @@
+import axios from 'axios';
+import { BASE_URL } from './constant';
+import { getToken } from '../services/authService';
+
+export const getAuthHeaders = () => {
+  const token = getToken();
+  if (!token) {
+    throw new Error('Authentication required. Token not found.');
+  }
+  return {
+    accept: 'application/json',
+    Authorization: `Bearer ${token}`,
+  };
+};
+
+export const fetchMessages = async (): Promise<any[]> => {
+  try {
+    const res = await axios.get(`${BASE_URL}/messages`, {
+      headers: getAuthHeaders(),
+    });
+    return res.data;
+  } catch (error) {
+    console.error('Error fetching messages:', error);
+    throw new Error('Failed to fetch messages. Please try again later.');
+  }
+};
+
+export const fetchMessageContent = async (messageId: string): Promise<any> => {
+  try {
+    const res = await axios.get(`${BASE_URL}/messages/${messageId}`, {
+      headers: getAuthHeaders(),
+    });
+    return res.data;
+  } catch (error) {
+    console.error(`Error fetching message content for ID ${messageId}:`, error);
+    throw new Error('Failed to fetch message content. Please try again later.');
+  }
+};

package/src/utils/constant.ts

@@ -0,0 +1 @@
+export const BASE_URL = process.env.BASE_URL;

package/src/utils/delay.ts

@@ -0,0 +1,2 @@
+export const delay = (ms: number): Promise<void> =>
+  new Promise((resolve) => setTimeout(resolve, ms));

package/src/utils/generateRandomName.ts

@@ -0,0 +1,2 @@
+export const generateRandomName = (): string =>
+  Math.random().toString(36).substring(2, 15);

package/src/utils/getVerificationCode.ts

@@ -0,0 +1,27 @@
+/**
+ * Extracts a verification code from the provided email content.
+ *
+ * This function scans the given text for a sequence of 5 or more
+ * consecutive digits and returns the first valid verification code.
+ * If no valid sequence is found, the function returns `null`.
+ *
+ * @param {string} text - The content of the email, typically the body.
+ * @returns {Promise<string | null>} The first verification code found, or `null` if no valid code exists.
+ *
+ * @example
+ * const emailContent = "Your code is 123456.";
+ * const verificationCode = await getVerificationCode(emailContent);
+ * console.log(verificationCode); // Output: "123456"
+ */
+
+export const getVerificationCode = async (
+  text: string
+): Promise<string | null> => {
+  console.log('Extracting the verification code from the email content...');
+  const matches = text.match(/\b\d{5,}\b/);
+  if (matches) {
+    return matches[0];
+  }
+  console.warn('No verification code found in the provided email content.');
+  return null;
+};

package/tsconfig.cjs.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "module": "CommonJS",
+    "target": "ESNext",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "outDir": "./dist/cjs",
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "skipLibCheck": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "examples"]
+}

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "module": "ESNext",
+    "target": "ESNext",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "outDir": "./dist/esm",
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "skipLibCheck": true,
+    "types": ["jest", "node"]
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "examples"]
+}