proxymail-qa 0.2.0 → 0.3.0

package/README.md

@@ -86,6 +86,9 @@ cy.task('createAddress').then(({ address }) => {
 // A persona with a date of birth for an age band, and a country.
 await qa.createAddress({ persona: true, age: 'under13', country: 'GB' });
 
+// Find a test account made earlier: an under-18 in GB with a saved password.
+const [teen] = await qa.listAddresses({ tags: ['age-gate'], country: 'GB', maxAge: 17, hasPassword: true });
+
 // The link that opens a mobile app (myapp://…) when the email also has a web one.
 const { value: appLink } = await qa.waitForLink(address, { app: true });
 

package/dist/index.d.ts

@@ -57,6 +57,16 @@ export interface CreateAddressInput {
     dateOfBirth?: string;
     country?: string;
 }
+export interface ListAddressesOptions {
+    limit?: number;
+    before?: string;
+    tags?: string[];
+    country?: string;
+    minAge?: number;
+    maxAge?: number;
+    hasPassword?: boolean;
+    search?: string;
+}
 export interface AddressPatch {
     label?: string | null;
     notes?: string | null;
@@ -146,10 +156,7 @@ export declare class ProxyMailQA {
         password: true;
     }): Promise<CreatedAddressWithPassword>;
     createAddress(input?: CreateAddressInput): Promise<CreatedAddress>;
-    listAddresses(options?: {
-        limit?: number;
-        before?: string;
-    }): Promise<Address[]>;
+    listAddresses(options?: ListAddressesOptions): Promise<Address[]>;
     getAddress(address: string): Promise<Address>;
     updateAddress(address: string, patch: AddressPatch): Promise<Address>;
     deleteAddress(address: string): Promise<void>;

package/dist/index.js

@@ -79,12 +79,26 @@ export class ProxyMailQA {
             country: input.country,
         });
     }
+    // Newest first. With filters, finds test accounts made earlier, such as
+    // an under-18 in GB with a saved password: every filter given must match.
     listAddresses(options = {}) {
         const query = new URLSearchParams();
         if (options.limit)
             query.set('limit', String(options.limit));
         if (options.before)
             query.set('before', options.before);
+        for (const tag of options.tags ?? [])
+            query.append('tag', tag);
+        if (options.country)
+            query.set('country', options.country);
+        if (options.minAge !== undefined)
+            query.set('min_age', String(options.minAge));
+        if (options.maxAge !== undefined)
+            query.set('max_age', String(options.maxAge));
+        if (options.hasPassword !== undefined)
+            query.set('has_password', String(options.hasPassword));
+        if (options.search)
+            query.set('search', options.search);
         return this.request('GET', `/addresses${query.size ? `?${query}` : ''}`);
     }
     getAddress(address) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "proxymail-qa",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Disposable test inboxes for Playwright, Cypress and scripts: create an address, then wait for its verification code or link.",
   "license": "MIT",
   "author": "Proxy Mail QA <hello@proxymail.qa> (https://proxymail.qa)",