temp-disposable-email 1.9.0 → 1.10.0

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+# [1.10.0](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/compare/v1.9.0...v1.10.0) (2024-11-28)
+
+
+### Features
+
+* add Playwright testing framework and configuration; update .gitignore and package files ([64911b1](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/commit/64911b1a222c8000a3b94268c29e4ca9b495658b))
+* update README with ES Modules and CommonJS usage examples; bump version to 1.8.0 and add Cypress test script ([e795bd3](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/commit/e795bd3f9f736a4c237d00037c2528348eb01e05))
+
+
+
 # [1.9.0](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/compare/v1.8.0...v1.9.0) (2024-11-28)
 
 
@@ -39,12 +49,3 @@
 
 
 
-## [1.6.2](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/compare/v1.6.1...v1.6.2) (2024-11-28)
-
-
-### Bug Fixes
-
-* downgrade version to 1.6.0 in package-lock.json and update BASE_URL handling ([919c24e](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/commit/919c24e563a7541f2a4163f79f49bd6e545f9dd6))
-
-
-

package/README.md

@@ -33,10 +33,18 @@ npm install temp-disposable-email
 
 To use the package, import the functions in your TypeScript or JavaScript project:
 
+#### Using ES Modules (Recommended)
+
 ```typescript
 import { createInbox, getMessage, deleteAccount } from 'temp-disposable-email';
 ```
 
+#### Using CommonJS
+
+```javascript
+import { createInbox, getMessage, deleteAccount } from 'temp-disposable-email';
+```
+
 ### 2\. Create an Inbox
 
 This function creates a new disposable email account using a random username or a specified one. It also authenticates and generates a token for accessing messages.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "temp-disposable-email",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "description": "",
   "main": "dist/cjs/index.js",
   "exports": {
@@ -13,6 +13,8 @@
   "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"
   },
@@ -43,6 +45,7 @@
     "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",

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,
+  // },
+});