gender-api.com-client 1.0.12 → 2.0.2

package/README.md

@@ -1,248 +1,107 @@
-Official Gender-API.com JavaScript And TypeScript Client
-=========================
+# Gender-API.com Client for JavaScript and TypeScript
 
-This library is still beta. If you experience some problems or if you have some questions feel free to contact us.
+Official Node.js client for [Gender-API.com](https://gender-api.com).  
+Determine the gender of a first name, full name, or email address with ease using our V2 API.
 
-About
-------------
-Gender-API.com JavaScript and TypeScript client.
+[![npm version](https://badge.fury.io/js/gender-api.com-client.svg)](https://badge.fury.io/js/gender-api.com-client)
 
-Homepage: <https://gender-api.com>
+## Features
 
-FAQ: <https://gender-api.com/en/frequently-asked-questions>
+- **Full V2 API Support**: Access all latest endpoints.
+- **TypeScript Support**: First-class type definitions included.
+- **Modern Promise-based API**: Uses async/await and `fetch` (Node 20+).
+- **Batch Processing**: Resolve up to 100 names in a single request.
 
-API Docs: <https://gender-api.com/en/api-docs>
+## Installation
 
-Contact: <https://gender-api.com/en/contact>
-
-Installation
-------------
-
-```
-my-project$ npm i gender-api.com-client --save
+```bash
+npm install gender-api.com-client --save
 ```
 
-Usage
-------------
-#### [TypeScript Examples](#typescript)
-#### [JavaScript Example](#javascript)
+*Requires Node.js 20 or higher.*
 
-API-Key
------------
-Get a free API key here: <https://gender-api.com/en/account>
+## Usage
 
-## TypeScript
-can also be used with Angular 2+.
+First, get your free API Key from [Gender-API.com Account](https://gender-api.com/en/account).
 
-### Simple Usage
+### Basic Example (TypeScript / ES Modules)
 
 ```typescript
-import {Client as GenderApiClient, ResultSingleName} from "gender-api.com-client";
-
-const genderApiClient = new GenderApiClient("your API key");
-
-try {
-    genderApiClient.getByFirstName('theresa', (response: ResultSingleName) => {
-      console.log(response.gender); //female
-      console.log(response.accuracy); //98
-    });
-  
-    genderApiClient.getByFirstNameAndCountry('john', 'US', (response: ResultSingleName) => {
-      console.log(response.gender); //male
-      console.log(response.accuracy); //99
-    });
-}
-catch(e) {
-  console.log('Error:', e);
-}
-```
+import { Client } from 'gender-api.com-client';
 
-### Split First and Last Name
+const client = new Client('YOUR_API_KEY');
 
-```typescript
-import {Client as GenderApiClient, ResultSplit} from "gender-api.com-client";
-
-const genderApiClient = new GenderApiClient("your API key");
-
-try {
-    genderApiClient.getByFirstNameAndLastName('theresa miller', (response: ResultSplit) => {
-      console.log(response.gender); //female
-      console.log(response.accuracy); //98
-      console.log(response.first_name); //Theresa
-      console.log(response.last_name); //Miller
-    });
-  
-    genderApiClient.getByFirstNameAndLastNameAndCountry('john johnson', 'US', (response: ResultSplit) => {
-      console.log(response.gender); //male
-      console.log(response.accuracy); //99
-      console.log(response.first_name); //John
-      console.log(response.last_name); //Johnson
-    });
-}
-catch(e) {
-  console.log('Error:', e);
-}
-```
-
-### Email Address
+async function checkGender() {
+  try {
+    // By First Name
+    const result = await client.getByFirstName('Theresa');
+    console.log(`${result.first_name} is ${result.gender} (Probability: ${result.probability})`);
 
-```typescript
-import {Client as GenderApiClient, ResultEmailAddress} from "gender-api.com-client";
-
-const genderApiClient = new GenderApiClient("your API key");
-
-try {
-    genderApiClient.getByEmailAddress('theresa.miller@gmail.com', (response: ResultEmailAddress) => {
-      console.log(response.gender); //female
-      console.log(response.accuracy); //98
-      console.log(response.first_name); //Theresa
-      console.log(response.last_name); //Miller
-    });
-  
-    genderApiClient.getByEmailAddressAndCountry('john.johnson44@hotmail.com', 'US', (response: ResultEmailAddress) => {
-      console.log(response.gender); //male
-      console.log(response.accuracy); //99
-      console.log(response.first_name); //John
-      console.log(response.last_name); //Johnson
-    });
-}
-catch(e) {
-  console.log('Error:', e);
+    // By Full Name
+    const fullResult = await client.getByFullName('John Smith');
+    console.log(`${fullResult.first_name} ${fullResult.last_name} is ${fullResult.gender}`);
+    
+  } catch (error) {
+    console.error('Error:', error);
+  }
 }
+
+checkGender();
 ```
 
-### Statistics
+### Common Scenarios
 
+#### 1. Check a First Name
 ```typescript
-import {Client as GenderApiClient, ResultStats} from "gender-api.com-client";
-
-const genderApiClient = new GenderApiClient("your API key");
-
-try {
-    genderApiClient.getStats((response: ResultStats) => {
-      console.log(response.is_limit_reached); //false
-      console.log(response.remaining_requests); //Available Credits
-      console.log(response.amount_month_start); //Credits at the start of the month
-      console.log(response.amount_month_bought); //Credits bought this month
-    });
-    
-}
-catch(e) {
-  console.log('Error:', e);
-}
+const result = await client.getByFirstName('Andrea', { country: 'IT' });
+// Andrea in Italy is usually male
 ```
 
-## JavaScript
-
-### Simple Usage
-
-```javascript
-try {
-    var GenderApi = require('gender-api.com-client');
-
-    var genderApiClient = new GenderApi.Client('your api key');
-
-    genderApiClient.getByFirstName('theresa', function (response) {
-        console.log(response.gender); //female
-        console.log(response.accuracy); //98
-    });
-
-    genderApiClient.getByFirstNameAndCountry('john', 'US', function (response) {
-        console.log(response.gender); //male
-        console.log(response.accuracy); //99
-    });
-
-}
-catch(e) {
-    console.log('Error:', e);
-}
+#### 2. Check an Email Address
+```typescript
+const result = await client.getByEmailAddress('marie.curie@example.com');
+console.log(result.gender); // female
 ```
 
-### Split First and Last Name
-
-```javascript
-try {
-    var GenderApi = require('gender-api.com-client');
+#### 3. Batch Processing (Multiple Names)
+Process lists efficiently using the batch endpoints.
 
-    var genderApiClient = new GenderApi.Client('your api key');
+```typescript
+const names = [
+  { id: '1', first_name: 'Theresa', country: 'US' },
+  { id: '2', first_name: 'John', country: 'US' }
+];
 
-    genderApiClient.getByFirstNameAndLastName('theresa miller', function (response) {
-        console.log(response.gender); //female
-        console.log(response.accuracy); //98
-        console.log(response.first_name); //Theresa
-        console.log(response.last_name); //Miller
-    });
+const results = await client.getByFirstNameMultiple(names);
 
-    genderApiClient.getByFirstNameAndLastNameAndCountry('john johnson', 'US', function (response) {
-        console.log(response.gender); //male
-        console.log(response.accuracy); //99
-        console.log(response.first_name); //John
-        console.log(response.last_name); //Johnson
-    });
-}
-catch(e) {
-    console.log('Error:', e);
-}
+results.forEach(r => {
+  console.log(`ID: ${r.input.id}, Gender: ${r.gender}`);
+});
 ```
 
-### Email Address
-
-```javascript
-try {
-    var GenderApi = require('gender-api.com-client');
-
-    var genderApiClient = new GenderApi.Client('your api key');
-
-    genderApiClient.getByEmailAddress('theresa.miller@gmail.com', function (response) {
-        console.log(response.gender); //female
-        console.log(response.accuracy); //98
-        console.log(response.first_name); //Theresa
-        console.log(response.last_name); //Miller
-    });
+#### 4. Account Statistics
+Check your remaining credits.
 
-    genderApiClient.getByEmailAddressAndCountry('john.johnson44@hotmail.com', 'US', function (response) {
-        console.log(response.gender); //male
-        console.log(response.accuracy); //99
-        console.log(response.first_name); //John
-        console.log(response.last_name); //Johnson
-    });
-}
-catch (e) {
-    console.log('Error:', e);
-}
+```typescript
+const stats = await client.getStatistics();
+console.log(`Credits Remaining: ${stats.remaining_credits}`);
 ```
 
-### Statistics
+## API Reference
 
-```javascript
-try {
-    var GenderApi = require('gender-api.com-client');
+The `Client` class provides the following methods:
 
-    var genderApiClient = new GenderApi.Client('your api key');
-
-    genderApiClient.getStats(function (response) {
-        console.log(response.is_limit_reached); //false
-        console.log(response.remaining_requests); //Available Credits
-        console.log(response.amount_month_start); //Credits at the start of the month
-        console.log(response.amount_month_bought); //Credits bought this month
-    });
-}
-catch (e) {
-    console.log('Error:', e);
-    }
-```
+- `getByFirstName(firstName: string, options?: RequestOptions)`
+- `getByFullName(fullName: string, options?: RequestOptions)`
+- `getByEmailAddress(email: string, options?: RequestOptions)`
+- `getByFirstNameMultiple(items: FirstNameRequestItem[])`
+- `getByFullNameMultiple(items: FullNameRequestItem[])`
+- `getByEmailAddressMultiple(items: EmailRequestItem[])`
+- `getCountryOfOrigin(request: CountryOfOriginRequest)`
+- `getStatistics()`
 
+All methods return a `Promise` that resolves to the result object or throws an error.
 
-Testing
-------------
+## License
 
-```
-gender-api-client-npm$ KEY=<your API key> npm run test
-```
-
-Build project
-------------
-
-```
-gender-api-client-npm$ npm run build
-```
+MIT

package/dist/index.d.ts

@@ -1,6 +1,2 @@
 export * from './lib/client';
-export * from './lib/result/email-address';
-export * from './lib/result/multiple-names';
-export * from './lib/result/single-name';
-export * from './lib/result/split';
-export * from './lib/result/stats';
+export * from './lib/models';

package/dist/index.js

@@ -1,11 +1,18 @@
 "use strict";
-function __export(m) {
-    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
-}
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-__export(require("./lib/client"));
-__export(require("./lib/result/email-address"));
-__export(require("./lib/result/multiple-names"));
-__export(require("./lib/result/single-name"));
-__export(require("./lib/result/split"));
-__export(require("./lib/result/stats"));
+__exportStar(require("./lib/client"), exports);
+__exportStar(require("./lib/models"), exports);

package/dist/lib/client.d.ts

@@ -1,73 +1,15 @@
+import { FirstNameRequest, FullNameRequest, EmailRequest, FirstNameRequestMultipleItem, FullNameRequestMultipleItem, EmailRequestMultipleItem, CountryOfOriginRequest, SingleNameResult, FullNameResult, EmailResult, StatisticResult, CountryOfOriginResult } from "./models";
 export declare class Client {
-    apiKey: string;
-    host: string;
-    /**
-     * @param {string} apiKey
-     */
+    private apiKey;
+    private readonly baseUrl;
     constructor(apiKey: string);
-    /**
-     * @param {string} firstName
-     * @param {Function} callback
-     * @throws Exception
-     * @return void
-     */
-    getByFirstName(firstName: string, callback: Function): void;
-    /**
-     * @param {string} firstName
-     * @param {string} country
-     * @param {Function} callback
-     * @throws Exception
-     * @return void
-     */
-    getByFirstNameAndCountry(firstName: string, country: string, callback: Function): void;
-    /**
-     * @param {string[]} firstNames
-     * @param {string} country
-     * @param {Function} callback
-     * @throws Exception
-     * @return void
-     */
-    getByMultipleNamesAndCountry(firstNames: string[], country: string, callback: Function): void;
-    /**
-     * @param {string} fullName
-     * @param {Function} callback
-     * @throws Exception
-     * @return void
-     */
-    getByFirstNameAndLastName(fullName: string, callback: Function): void;
-    /**
-     * @param {string} fullName
-     * @param {string} country
-     * @param {Function} callback
-     * @throws Exception
-     * @return void
-     */
-    getByFirstNameAndLastNameAndCountry(fullName: string, country: string, callback: Function): void;
-    /**
-     * @param {string} emailAddress
-     * @param {Function} callback
-     * @throws Exception
-     * @return void
-     */
-    getByEmailAddress(emailAddress: string, callback: Function): void;
-    /**
-     * @param {string} emailAddress
-     * @param {string} country
-     * @param {Function} callback
-     * @throws Exception
-     * @return void
-     */
-    getByEmailAddressAndCountry(emailAddress: string, country: string, callback: Function): void;
-    /**
-     * @param {Function} callback
-     * @throws Exception
-     * @return void
-     */
-    getStats(callback: Function): void;
-    /**
-     * @param {string} method
-     * @param data
-     * @param {Function} callback
-     */
-    private performRequest(method, data, callback);
+    private request;
+    getByFirstName(firstName: string, options?: Omit<FirstNameRequest, 'first_name'>): Promise<SingleNameResult>;
+    getByFullName(fullName: string, options?: Omit<FullNameRequest, 'full_name'>): Promise<FullNameResult>;
+    getByEmailAddress(email: string, options?: Omit<EmailRequest, 'email'>): Promise<EmailResult>;
+    getByFirstNameMultiple(items: FirstNameRequestMultipleItem[]): Promise<SingleNameResult[]>;
+    getByFullNameMultiple(items: FullNameRequestMultipleItem[]): Promise<FullNameResult[]>;
+    getByEmailAddressMultiple(items: EmailRequestMultipleItem[]): Promise<EmailResult[]>;
+    getCountryOfOrigin(request: CountryOfOriginRequest): Promise<CountryOfOriginResult>;
+    getStatistics(): Promise<StatisticResult>;
 }

package/dist/lib/client.js

@@ -1,146 +1,78 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var multiple_names_1 = require("./result/multiple-names");
-var Client = /** @class */ (function () {
-    /**
-     * @param {string} apiKey
-     */
-    function Client(apiKey) {
+exports.Client = void 0;
+class Client {
+    apiKey;
+    baseUrl = 'https://gender-api.com/v2';
+    constructor(apiKey) {
         this.apiKey = apiKey;
-        this.host = 'https://gender-api.com';
     }
-    /**
-     * @param {string} firstName
-     * @param {Function} callback
-     * @throws Exception
-     * @return void
-     */
-    Client.prototype.getByFirstName = function (firstName, callback) {
-        return this.getByFirstNameAndCountry(firstName, '', callback);
-    };
-    /**
-     * @param {string} firstName
-     * @param {string} country
-     * @param {Function} callback
-     * @throws Exception
-     * @return void
-     */
-    Client.prototype.getByFirstNameAndCountry = function (firstName, country, callback) {
-        this.performRequest('get', {
-            name: firstName,
-            country: country
-        }, function (json) {
-            callback(json);
+    async request(endpoint, method, body) {
+        const headers = {
+            'Authorization': `Bearer ${this.apiKey}`,
+            'Content-Type': 'application/json',
+            'User-Agent': 'Gender-API-Client/2.0.0 (Node.js)'
+        };
+        const response = await fetch(`${this.baseUrl}${endpoint}`, {
+            method,
+            headers,
+            body: body ? JSON.stringify(body) : undefined,
         });
-    };
-    /**
-     * @param {string[]} firstNames
-     * @param {string} country
-     * @param {Function} callback
-     * @throws Exception
-     * @return void
-     */
-    Client.prototype.getByMultipleNamesAndCountry = function (firstNames, country, callback) {
-        this.performRequest('get', {
-            name: firstNames.join(';'),
-            country: country,
-            multi: 'true',
-        }, function (json) {
-            var names = [];
-            for (var _i = 0, _a = json.result; _i < _a.length; _i++) {
-                var name_1 = _a[_i];
-                names.push(name_1);
+        if (!response.ok) {
+            let errorDetail = response.statusText;
+            try {
+                const errorJson = await response.json();
+                if (errorJson && errorJson.detail) {
+                    errorDetail = errorJson.detail;
+                }
             }
-            callback(new multiple_names_1.ResultMultipleNames(names));
-        });
-    };
-    /**
-     * @param {string} fullName
-     * @param {Function} callback
-     * @throws Exception
-     * @return void
-     */
-    Client.prototype.getByFirstNameAndLastName = function (fullName, callback) {
-        this.getByFirstNameAndLastNameAndCountry(fullName, '', callback);
-    };
-    /**
-     * @param {string} fullName
-     * @param {string} country
-     * @param {Function} callback
-     * @throws Exception
-     * @return void
-     */
-    Client.prototype.getByFirstNameAndLastNameAndCountry = function (fullName, country, callback) {
-        this.performRequest('get', {
-            split: fullName,
-            country: country
-        }, function (json) {
-            callback(json);
-        });
-    };
-    /**
-     * @param {string} emailAddress
-     * @param {Function} callback
-     * @throws Exception
-     * @return void
-     */
-    Client.prototype.getByEmailAddress = function (emailAddress, callback) {
-        this.getByEmailAddressAndCountry(emailAddress, '', callback);
-    };
-    /**
-     * @param {string} emailAddress
-     * @param {string} country
-     * @param {Function} callback
-     * @throws Exception
-     * @return void
-     */
-    Client.prototype.getByEmailAddressAndCountry = function (emailAddress, country, callback) {
-        this.performRequest('get', {
-            email: emailAddress,
-            country: country
-        }, function (json) {
-            callback(json);
-        });
-    };
-    /**
-     * @param {Function} callback
-     * @throws Exception
-     * @return void
-     */
-    Client.prototype.getStats = function (callback) {
-        this.performRequest('get-stats', {}, function (json) {
-            callback(json);
-        });
-    };
-    /**
-     * @param {string} method
-     * @param data
-     * @param {Function} callback
-     */
-    Client.prototype.performRequest = function (method, data, callback) {
-        var formData = '';
-        var dataKeys = Object.keys(data);
-        for (var i = 0; i < dataKeys.length; i++) {
-            formData += '&' + dataKeys[i] + '=' + encodeURI(data[dataKeys[i]]);
+            catch (e) {
+                // Ignore json parse error
+            }
+            throw new Error(`API Error ${response.status}: ${errorDetail}`);
         }
-        var endpoint = '/' + method + '?key=' + this.apiKey + formData;
-        var https = require('https');
-        https.get(this.host + endpoint, function (resp) {
-            var data = '';
-            resp.on('data', function (chunk) {
-                data += chunk;
-            });
-            resp.on('end', function () {
-                var json = JSON.parse(data);
-                if (json.errmsg) {
-                    throw new Error(json.errno + ': ' + json.errmsg);
-                }
-                callback(json);
-            });
-        }).on("error", function (err) {
-            throw new Error(err.message);
-        });
-    };
-    return Client;
-}());
+        const data = await response.json();
+        // Handle cases where API returns 200 but body is an error
+        if (data && data.status && data.detail && typeof data.status === 'number' && data.status >= 400) {
+            throw new Error(`API Error ${data.status}: ${data.detail}`);
+        }
+        return data;
+    }
+    async getByFirstName(firstName, options) {
+        const body = {
+            first_name: firstName,
+            ...options
+        };
+        return this.request('/gender/by-first-name', 'POST', body);
+    }
+    async getByFullName(fullName, options) {
+        const body = {
+            full_name: fullName,
+            ...options
+        };
+        return this.request('/gender/by-full-name', 'POST', body);
+    }
+    async getByEmailAddress(email, options) {
+        const body = {
+            email: email,
+            ...options
+        };
+        return this.request('/gender/by-email-address', 'POST', body);
+    }
+    async getByFirstNameMultiple(items) {
+        return this.request('/gender/by-first-name-multiple', 'POST', items);
+    }
+    async getByFullNameMultiple(items) {
+        return this.request('/gender/by-full-name-multiple', 'POST', items);
+    }
+    async getByEmailAddressMultiple(items) {
+        return this.request('/gender/by-email-address-multiple', 'POST', items);
+    }
+    async getCountryOfOrigin(request) {
+        return this.request('/country-of-origin', 'POST', request);
+    }
+    async getStatistics() {
+        return this.request('/statistic', 'GET');
+    }
+}
 exports.Client = Client;

package/dist/lib/models.d.ts

@@ -0,0 +1,89 @@
+export interface NameRequest {
+    country?: string;
+    locale?: string;
+    ip?: string;
+}
+export interface FirstNameRequest extends NameRequest {
+    first_name: string;
+}
+export interface FullNameRequest extends NameRequest {
+    full_name: string;
+}
+export interface EmailRequest extends NameRequest {
+    email: string;
+}
+export interface MultipleNameRequestItem {
+    id: string;
+    country?: string;
+    locale?: string;
+    ip?: string;
+}
+export interface FirstNameRequestMultipleItem extends MultipleNameRequestItem {
+    first_name: string;
+}
+export interface FullNameRequestMultipleItem extends MultipleNameRequestItem {
+    full_name: string;
+}
+export interface EmailRequestMultipleItem extends MultipleNameRequestItem {
+    email: string;
+}
+export interface CountryOfOriginRequest {
+    first_name: string;
+    full_name?: string;
+    email?: string;
+}
+export interface ResultDetails {
+    credits_used: number;
+    samples: number;
+    country: string | null;
+    first_name_sanitized: string;
+    duration: string;
+}
+export interface Result {
+    input: any;
+    details: ResultDetails;
+    result_found: boolean;
+    probability: number;
+    gender: 'male' | 'female' | 'unknown';
+}
+export interface SingleNameResult extends Result {
+    first_name: string;
+}
+export interface FullNameResult extends Result {
+    first_name: string;
+    last_name?: string;
+}
+export interface EmailResult extends Result {
+    first_name: string;
+    last_name?: string;
+}
+export interface CountryOfOriginItem {
+    country_name: string;
+    country: string;
+    probability: number;
+    continental_region: string;
+    statistical_region: string;
+}
+export interface CountryOfOriginResult {
+    input: CountryOfOriginRequest;
+    details: ResultDetails;
+    result_found: boolean;
+    country_of_origin: CountryOfOriginItem[];
+    country_of_origin_map_url: string;
+    first_name: string;
+    probability: number;
+    gender: 'male' | 'female' | 'unknown';
+}
+export interface UsageLastMonth {
+    date: string;
+    credits_used: number;
+}
+export interface StatisticResult {
+    is_limit_reached: boolean;
+    remaining_credits: number;
+    details: {
+        credits_used: number;
+        duration: string;
+    };
+    usage_last_month: UsageLastMonth;
+}

package/dist/lib/models.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/test/integration.test.d.ts

@@ -0,0 +1 @@
+import 'dotenv/config';

package/dist/test/integration.test.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_test_1 = require("node:test");
+const chai_1 = require("chai");
+const client_1 = require("../lib/client");
+require("dotenv/config");
+const apiKey = process.env.GENDER_API_KEY || '';
+(0, node_test_1.describe)('Integration Tests', { skip: !apiKey ? 'No GENDER_API_KEY provided' : false }, () => {
+    let client;
+    (0, node_test_1.before)(() => {
+        client = new client_1.Client(apiKey);
+    });
+    (0, node_test_1.it)('should get gender by first name', async () => {
+        const result = await client.getByFirstName('Theresa', { country: 'US' });
+        (0, chai_1.expect)(result.gender).to.equal('female');
+        (0, chai_1.expect)(result.first_name).to.equal('Theresa');
+        (0, chai_1.expect)(result.result_found).to.be.true;
+    });
+    (0, node_test_1.it)('should get gender by full name', async () => {
+        const result = await client.getByFullName('John Smith', { country: 'US' });
+        (0, chai_1.expect)(result.gender).to.equal('male');
+        (0, chai_1.expect)(result.first_name).to.equal('John');
+        (0, chai_1.expect)(result.last_name).to.equal('Smith');
+        (0, chai_1.expect)(result.result_found).to.be.true;
+    });
+    (0, node_test_1.it)('should get gender by email address', async () => {
+        const result = await client.getByEmailAddress('theresa.miller@gmail.com');
+        (0, chai_1.expect)(result.gender).to.equal('female');
+        (0, chai_1.expect)(result.first_name).to.equal('Theresa');
+        (0, chai_1.expect)(result.last_name).to.equal('Miller');
+    });
+    (0, node_test_1.it)('should get multiple names (first name)', async () => {
+        const items = [
+            { id: '1', first_name: 'Theresa', country: 'US' },
+            { id: '2', first_name: 'John', country: 'US' }
+        ];
+        const results = await client.getByFirstNameMultiple(items);
+        (0, chai_1.expect)(results).to.have.lengthOf(2);
+        const theresa = results.find(r => r.input.id === '1');
+        const john = results.find(r => r.input.id === '2');
+        (0, chai_1.expect)(theresa?.gender).to.equal('female');
+        (0, chai_1.expect)(john?.gender).to.equal('male');
+    });
+    (0, node_test_1.it)('should get multiple names (full name)', async () => {
+        const items = [
+            { id: '1', full_name: 'Theresa Miller', country: 'US' },
+            { id: '2', full_name: 'John Smith', country: 'US' }
+        ];
+        const results = await client.getByFullNameMultiple(items);
+        (0, chai_1.expect)(results).to.have.lengthOf(2);
+        const theresa = results.find(r => r.input.id === '1');
+        (0, chai_1.expect)(theresa?.gender).to.equal('female');
+    });
+    (0, node_test_1.it)('should get multiple names (email)', async () => {
+        const items = [
+            { id: '1', email: 'theresa.miller@gmail.com' },
+            { id: '2', email: 'john.smith@gmail.com' }
+        ];
+        const results = await client.getByEmailAddressMultiple(items);
+        (0, chai_1.expect)(results).to.have.lengthOf(2);
+        (0, chai_1.expect)(results[0].result_found).to.be.true;
+    });
+    (0, node_test_1.it)('should get statistics', async () => {
+        const stats = await client.getStatistics();
+        (0, chai_1.expect)(stats).to.have.property('remaining_credits');
+        (0, chai_1.expect)(stats.is_limit_reached).to.be.a('boolean');
+    });
+    (0, node_test_1.it)('should get country of origin', async (t) => {
+        try {
+            const result = await client.getCountryOfOrigin({ first_name: 'Sven' });
+            (0, chai_1.expect)(result.country_of_origin).to.be.an('array');
+            if (result.country_of_origin.length > 0) {
+                (0, chai_1.expect)(result.country_of_origin[0]).to.have.property('country');
+            }
+        }
+        catch (e) {
+            // Some keys do not support this endpoint, verify if error is 402/403 or similar
+            // For now, if it fails, we can skip manually or log.
+            // node:test context allowed t.skip()
+            t.skip(`Skipping Country of Origin test: ${e.message}`);
+        }
+    });
+    (0, node_test_1.it)('should throw error for invalid request', async () => {
+        let error;
+        try {
+            await client.getByFirstName('');
+        }
+        catch (e) {
+            error = e;
+        }
+        (0, chai_1.expect)(error).to.exist;
+        (0, chai_1.expect)(error.message).to.contain('Error');
+    });
+});

package/package.json

@@ -1,12 +1,19 @@
 {
   "name": "gender-api.com-client",
-  "version": "1.0.12",
-  "description": "JavaScript and TypeScript client for Gender-API.com",
+  "version": "2.0.2",
+  "description": "Modern JavaScript and TypeScript client for Gender-API.com",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
   "scripts": {
     "build": "tsc",
-    "test": "mocha --reporter spec"
+    "test": "tsx --test test/**/*.ts",
+    "prepublishOnly": "npm run build"
   },
   "readme": "README.md",
   "repository": {
@@ -17,7 +24,8 @@
     "gender",
     "genderize",
     "api",
-    "gender-api.com"
+    "gender-api.com",
+    "typescript"
   ],
   "author": "Gender-API.com",
   "license": "MIT",
@@ -25,9 +33,12 @@
     "url": "https://github.com/markus-perl/gender-api-client-npm/issues"
   },
   "homepage": "https://github.com/markus-perl/gender-api-client-npm#readme",
-  "dependencies": {},
   "devDependencies": {
-    "@types/node": "^9.6.0",
-    "mocha": "^5.0.5"
+    "@types/chai": "^5.0.0",
+    "@types/node": "^20.0.0",
+    "chai": "^5.0.0",
+    "dotenv": "^16.0.0",
+    "tsx": "^4.21.0",
+    "typescript": "^5.0.0"
   }
 }

package/dist/lib/result/abstract.d.ts

@@ -1,2 +0,0 @@
-export declare abstract class ResultAbstract {
-}

package/dist/lib/result/abstract.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var ResultAbstract = /** @class */ (function () {
-    function ResultAbstract() {
-    }
-    return ResultAbstract;
-}());
-exports.ResultAbstract = ResultAbstract;

package/dist/lib/result/email-address.d.ts

@@ -1,15 +0,0 @@
-import { ResultAbstract } from "./abstract";
-export declare class ResultEmailAddress extends ResultAbstract {
-    name_sanitized: string;
-    first_name: string;
-    last_name: string;
-    email: string;
-    mail_provider: string;
-    country: string;
-    gender: string;
-    samples: number;
-    accuracy: number;
-    duration: string;
-    credits_used: number;
-    constructor(name_sanitized: string, first_name: string, last_name: string, email: string, mail_provider: string, country: string, gender: string, samples: number, accuracy: number, duration: string, credits_used: number);
-}

package/dist/lib/result/email-address.js

@@ -1,33 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = Object.setPrototypeOf ||
-        ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-        function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
-    return function (d, b) {
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-var abstract_1 = require("./abstract");
-var ResultEmailAddress = /** @class */ (function (_super) {
-    __extends(ResultEmailAddress, _super);
-    function ResultEmailAddress(name_sanitized, first_name, last_name, email, mail_provider, country, gender, samples, accuracy, duration, credits_used) {
-        var _this = _super.call(this) || this;
-        _this.name_sanitized = name_sanitized;
-        _this.first_name = first_name;
-        _this.last_name = last_name;
-        _this.email = email;
-        _this.mail_provider = mail_provider;
-        _this.country = country;
-        _this.gender = gender;
-        _this.samples = samples;
-        _this.accuracy = accuracy;
-        _this.duration = duration;
-        _this.credits_used = credits_used;
-        return _this;
-    }
-    return ResultEmailAddress;
-}(abstract_1.ResultAbstract));
-exports.ResultEmailAddress = ResultEmailAddress;

package/dist/lib/result/multiple-names.d.ts

@@ -1,10 +0,0 @@
-import { ResultAbstract } from "./abstract";
-import { ResultSingleName } from "./single-name";
-export declare class ResultMultipleNames extends ResultAbstract {
-    names: ResultSingleName[];
-    constructor(names: ResultSingleName[]);
-    /**
-     * @returns {ResultSingleName[]}
-     */
-    getNames(): ResultSingleName[];
-}

package/dist/lib/result/multiple-names.js

@@ -1,29 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = Object.setPrototypeOf ||
-        ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-        function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
-    return function (d, b) {
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-var abstract_1 = require("./abstract");
-var ResultMultipleNames = /** @class */ (function (_super) {
-    __extends(ResultMultipleNames, _super);
-    function ResultMultipleNames(names) {
-        var _this = _super.call(this) || this;
-        _this.names = names;
-        return _this;
-    }
-    /**
-     * @returns {ResultSingleName[]}
-     */
-    ResultMultipleNames.prototype.getNames = function () {
-        return this.names;
-    };
-    return ResultMultipleNames;
-}(abstract_1.ResultAbstract));
-exports.ResultMultipleNames = ResultMultipleNames;

package/dist/lib/result/single-name.d.ts

@@ -1,11 +0,0 @@
-import { ResultAbstract } from "./abstract";
-export declare class ResultSingleName extends ResultAbstract {
-    name_sanitized: string;
-    country: string;
-    gender: string;
-    samples: number;
-    accuracy: number;
-    duration: string;
-    credits_used: number;
-    constructor(name_sanitized: string, country: string, gender: string, samples: number, accuracy: number, duration: string, credits_used: number);
-}

package/dist/lib/result/single-name.js

@@ -1,29 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = Object.setPrototypeOf ||
-        ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-        function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
-    return function (d, b) {
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-var abstract_1 = require("./abstract");
-var ResultSingleName = /** @class */ (function (_super) {
-    __extends(ResultSingleName, _super);
-    function ResultSingleName(name_sanitized, country, gender, samples, accuracy, duration, credits_used) {
-        var _this = _super.call(this) || this;
-        _this.name_sanitized = name_sanitized;
-        _this.country = country;
-        _this.gender = gender;
-        _this.samples = samples;
-        _this.accuracy = accuracy;
-        _this.duration = duration;
-        _this.credits_used = credits_used;
-        return _this;
-    }
-    return ResultSingleName;
-}(abstract_1.ResultAbstract));
-exports.ResultSingleName = ResultSingleName;

package/dist/lib/result/split.d.ts

@@ -1,12 +0,0 @@
-import { ResultAbstract } from "./abstract";
-export declare class ResultSplit extends ResultAbstract {
-    last_name: string;
-    first_name: string;
-    name: string;
-    gender: string;
-    samples: number;
-    accuracy: number;
-    duration: string;
-    credits_used: number;
-    constructor(last_name: string, first_name: string, name: string, gender: string, samples: number, accuracy: number, duration: string, credits_used: number);
-}

package/dist/lib/result/split.js

@@ -1,30 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = Object.setPrototypeOf ||
-        ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-        function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
-    return function (d, b) {
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-var abstract_1 = require("./abstract");
-var ResultSplit = /** @class */ (function (_super) {
-    __extends(ResultSplit, _super);
-    function ResultSplit(last_name, first_name, name, gender, samples, accuracy, duration, credits_used) {
-        var _this = _super.call(this) || this;
-        _this.last_name = last_name;
-        _this.first_name = first_name;
-        _this.name = name;
-        _this.gender = gender;
-        _this.samples = samples;
-        _this.accuracy = accuracy;
-        _this.duration = duration;
-        _this.credits_used = credits_used;
-        return _this;
-    }
-    return ResultSplit;
-}(abstract_1.ResultAbstract));
-exports.ResultSplit = ResultSplit;

package/dist/lib/result/stats.d.ts

@@ -1,10 +0,0 @@
-import { ResultAbstract } from "./abstract";
-export declare class ResultStats extends ResultAbstract {
-    key: string;
-    is_limit_reached: boolean;
-    remaining_requests: Number;
-    amount_month_start: Number;
-    amount_month_bought: Number;
-    duration: string;
-    constructor(key: string, is_limit_reached: boolean, remaining_requests: Number, amount_month_start: Number, amount_month_bought: Number, duration: string);
-}

package/dist/lib/result/stats.js

@@ -1,28 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = Object.setPrototypeOf ||
-        ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-        function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
-    return function (d, b) {
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-var abstract_1 = require("./abstract");
-var ResultStats = /** @class */ (function (_super) {
-    __extends(ResultStats, _super);
-    function ResultStats(key, is_limit_reached, remaining_requests, amount_month_start, amount_month_bought, duration) {
-        var _this = _super.call(this) || this;
-        _this.key = key;
-        _this.is_limit_reached = is_limit_reached;
-        _this.remaining_requests = remaining_requests;
-        _this.amount_month_start = amount_month_start;
-        _this.amount_month_bought = amount_month_bought;
-        _this.duration = duration;
-        return _this;
-    }
-    return ResultStats;
-}(abstract_1.ResultAbstract));
-exports.ResultStats = ResultStats;