temp-disposable-email 1.11.5 → 1.11.7

package/README.md

@@ -61,7 +61,11 @@ To use the package, import the functions in your TypeScript or JavaScript projec
 #### Using ES Modules (Recommended)
 
 ```typescript
-import { createInbox, getMessage, deleteAccount } from 'temp-disposable-email';
+import {
+  createInbox,
+  getRecentEmail,
+  deleteAccount,
+} from 'temp-disposable-email';
 ```
 
 #### Using CommonJS
@@ -69,7 +73,7 @@ import { createInbox, getMessage, deleteAccount } from 'temp-disposable-email';
 ```javascript
 const {
   createInbox,
-  getMessage,
+  getRecentEmail,
   deleteAccount,
 } = require('temp-disposable-email');
 ```
@@ -129,10 +133,24 @@ console.log('Account deleted');
 
 ## Example Workflow
 
+### Playwright Example
+
+For using temp-disposable-email with Playwright, see the example in the [Playwright folder](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/tree/master/examples/playwright).
+
+### Cypress Example
+
+For using temp-disposable-email with Cypress, see the example in the [Cypress folder](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/tree/master/examples/cypress).
+
+### Node Example
+
 Here's a complete example of creating an inbox, retrieving a message, and deleting the account:
 
 ```typescript
-import { createInbox, getMessage, deleteAccount } from 'temp-disposable-email';
+import {
+  createInbox,
+  getRecentEmail,
+  deleteAccount,
+} from 'temp-disposable-email';
 
 async function run() {
   try {
@@ -141,7 +159,7 @@ async function run() {
     console.log('Created email:', email);
 
     // Get the first available message from the inbox
-    const message = await getMessage({
+    const message = await getRecentEmail({
       maxWaitTime: 50000,
       waitInterval: 3000,
       logPolling: true,
@@ -184,7 +202,7 @@ run();
 
 ## Get Email Options
 
-You can configure polling behavior by passing an options object to `getMessage`. The available options are:
+You can configure polling behavior by passing an options object to `getRecentEmail`. The available options are:
 
 - `maxWaitTime` (Optional): The maximum time to wait for messages (in milliseconds).
 - `waitInterval` (Optional): The interval between polling attempts (in milliseconds).

package/cypress.config.ts

@@ -1,6 +1,7 @@
 import { defineConfig } from 'cypress';
 
 export default defineConfig({
+  defaultCommandTimeout: 60000,
   e2e: {
     specPattern: 'examples/cypress/e2e/**/*.cy.ts',
     supportFile: 'examples/cypress/support/e2e.ts',

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

@@ -13,5 +13,5 @@
  * const verificationCode = await getVerificationCode(emailContent);
  * console.log(verificationCode); // Output: "123456"
  */
-export declare const getVerificationCode: (text: string) => Promise<string | null>;
+export declare const getVerificationCode: (text: string | undefined) => Promise<string>;
 //# sourceMappingURL=getVerificationCode.d.ts.map

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

@@ -1 +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"}
+{"version":3,"file":"getVerificationCode.d.ts","sourceRoot":"","sources":["../../../src/utils/getVerificationCode.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,eAAO,MAAM,mBAAmB,SACxB,MAAM,GAAG,SAAS,KACvB,OAAO,CAAC,MAAM,CAOhB,CAAC"}

package/dist/cjs/utils/getVerificationCode.js

@@ -22,8 +22,7 @@ const getVerificationCode = async (text) => {
     if (matches) {
         return matches[0];
     }
-    console.warn('No verification code found in the provided email content.');
-    return null;
+    throw new Error('No verification code found in the provided email content.');
 };
 exports.getVerificationCode = getVerificationCode;
 //# sourceMappingURL=getVerificationCode.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"getVerificationCode.js","sourceRoot":"","sources":["../../../src/utils/getVerificationCode.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEI,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;AAVW,QAAA,mBAAmB,uBAU9B"}
+{"version":3,"file":"getVerificationCode.js","sourceRoot":"","sources":["../../../src/utils/getVerificationCode.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEI,MAAM,mBAAmB,GAAG,KAAK,EACtC,IAAwB,EACP,EAAE;IACnB,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,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;AAC/E,CAAC,CAAC;AATW,QAAA,mBAAmB,uBAS9B"}

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

@@ -13,5 +13,5 @@
  * const verificationCode = await getVerificationCode(emailContent);
  * console.log(verificationCode); // Output: "123456"
  */
-export declare const getVerificationCode: (text: string) => Promise<string | null>;
+export declare const getVerificationCode: (text: string | undefined) => Promise<string>;
 //# sourceMappingURL=getVerificationCode.d.ts.map

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

@@ -1 +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"}
+{"version":3,"file":"getVerificationCode.d.ts","sourceRoot":"","sources":["../../../src/utils/getVerificationCode.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,eAAO,MAAM,mBAAmB,SACxB,MAAM,GAAG,SAAS,KACvB,OAAO,CAAC,MAAM,CAOhB,CAAC"}

package/dist/esm/utils/getVerificationCode.js

@@ -19,7 +19,6 @@ export const getVerificationCode = async (text) => {
     if (matches) {
         return matches[0];
     }
-    console.warn('No verification code found in the provided email content.');
-    return null;
+    throw new Error('No verification code found in the provided email content.');
 };
 //# sourceMappingURL=getVerificationCode.js.map

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

@@ -1 +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"}
+{"version":3,"file":"getVerificationCode.js","sourceRoot":"","sources":["../../../src/utils/getVerificationCode.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,EACtC,IAAwB,EACP,EAAE;IACnB,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,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;AAC/E,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "temp-disposable-email",
-  "version": "1.11.5",
+  "version": "1.11.7",
   "description": "Generating Temporary email address for testing, retrieving email from the temporary email address",
   "main": "dist/cjs/index.js",
   "exports": {
@@ -41,7 +41,7 @@
   "dependencies": {
     "axios": "^1.7.8",
     "dotenv": "^16.4.5",
-    "temp-disposable-email": "^1.6.4",
+    "temp-disposable-email": "^1.11.5",
     "tslib": "^2.8.1"
   },
   "devDependencies": {

package/src/utils/getVerificationCode.ts

@@ -15,13 +15,12 @@
  */
 
 export const getVerificationCode = async (
-  text: string
-): Promise<string | null> => {
+  text: string | undefined
+): Promise<string> => {
   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;
+  throw new Error('No verification code found in the provided email content.');
 };