@sebbo2002/genderize 5.0.2-develop.9 → 6.0.0

package/README.md

@@ -6,15 +6,13 @@
 
 <br />
 
-`genderize` is a simple client for [genderize.io](https://genderize.io/), a gender prediction API using a person's 
-name. The library supports both normal and batch usage, allows free and paid usage via an optional API key, and makes it 
+`genderize` is a simple client for [genderize.io](https://genderize.io/), a gender prediction API using a person's
+name. The library supports both normal and batch usage, allows free and paid usage via an optional API key, and makes it
 very easy to access rate limiting information. It's written in TypeScript.
 
-
 ## 📦 Installation
 
-	npm install @sebbo2002/genderize
-
+    npm install @sebbo2002/genderize
 
 ## ⚡️ Quick Start
 
@@ -36,15 +34,13 @@ await genderize.predict('Alex', 'US');
 await genderize.predict(['Noah', 'Evelyn']);
 
 // { limit: 1000, remaining: 978, reset: 2022-05-23T00:00:02.203Z }
-genderize.limit
+genderize.limit;
 ```
 
-
 ## 📑 API-Reference
 
 Every hot detail about the API can be found in [the documentation](https://sebbo2002.github.io/genderize/develop/reference/).
 
-
 ## 🚦 Tests
 
 ```
@@ -52,7 +48,6 @@ npm test
 npm run coverage
 ```
 
-
 ## 🙆🏼‍♂️ Copyright and license
 
 Copyright (c) Sebastian Pekarek under the [MIT license](LICENSE).

package/dist/index.cjs

@@ -0,0 +1,2 @@
+"use strict";var a=Object.defineProperty;var p=Object.getOwnPropertyDescriptor;var g=Object.getOwnPropertyNames;var u=Object.prototype.hasOwnProperty;var l=(i,e)=>{for(var r in e)a(i,r,{get:e[r],enumerable:!0})},m=(i,e,r,t)=>{if(e&&typeof e=="object"||typeof e=="function")for(let n of g(e))!u.call(i,n)&&n!==r&&a(i,n,{get:()=>e[n],enumerable:!(t=p(e,n))||t.enumerable});return i};var c=i=>m(a({},"__esModule",{value:!0}),i);var y={};l(y,{GenderizeGender:()=>o,default:()=>s});module.exports=c(y);var o=(r=>(r.FEMALE="female",r.MALE="male",r))(o||{}),s=class i{get limit(){if(this.latestHeaders){let e=i.getIntHeader(this.latestHeaders[0].get("x-rate-limit-limit")),r=i.getIntHeader(this.latestHeaders[0].get("x-rate-limit-remaining")),t=i.getIntHeader(this.latestHeaders[0].get("x-rate-limit-reset"));if(e!==void 0&&r!==void 0&&t!==void 0)return{limit:e,remaining:r,reset:new Date(this.latestHeaders[1].getTime()+t*1e3)}}return null}apiKey;latestHeaders=null;constructor(e){this.apiKey=e}static getIntHeader(e){if(Array.isArray(e))return this.getIntHeader(e[0]);if(e!=null)return parseInt(e)}params(e,r){let t=new URLSearchParams;if(Array.isArray(e)&&e.length>10)throw new Error(`Too many names given: ${e.length} names provided, but 10 is the maximum allowed`);if(Array.isArray(e)&&e.length===0)throw new Error("No name given, but at least one is required");return Array.isArray(e)?e.forEach(n=>t.append("name",n)):t.append("name",e),r&&t.append("country_id",r),this.apiKey&&t.append("apikey",this.apiKey),Array.isArray(e)?t.toString().replace(/name=/g,"name[]="):t.toString()}async predict(e,r){let t=new URLSearchParams(this.params(e,r)),n=await fetch("https://api.genderize.io/?"+t,{headers:{"Content-Type":"application/json"}});if(!n.ok)throw new Error(`Unable to query genderize.io: ${await n.text()}`);let d=await n.json();return this.latestHeaders=[n.headers,new Date],d}};0&&(module.exports={GenderizeGender});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/lib/index.ts"],"sourcesContent":["/**\n * Enum that can be used to compare and check the results\n */\nexport enum GenderizeGender {\n    FEMALE = 'female',\n    MALE = 'male',\n}\n\nexport interface GenderizeLimit {\n    /**\n     * The amount of names available in the current time window\n     */\n    limit: number;\n\n    /**\n     * The number of names left in the current time window\n     */\n    remaining: number;\n\n    /**\n     * Next time window start time\n     *\n     * ```javascript\n     * import Genderize from '@sebbo2002/genderize';\n     * const genderize = new Genderize('API-KEY');\n     *\n     * // execute a predicition\n     *\n     * genderize.limit?.reset.toString()\n     * ```\n     */\n    reset: Date;\n}\nexport interface GenderizeResponse {\n    /**\n     * The number of data rows examined in order\n     * to calculate the API response\n     */\n    count: number;\n\n    /**\n     * Either a [[`GenderizeGender`]] value (male/female) or null\n     * if the API was not able to predict a gender.\n     */\n    gender: GenderizeGender | null;\n\n    /**\n     * Name which was used for this prediction\n     */\n    name: string;\n\n    /**\n     * Value between 0 and 1 (including)\n     */\n    probability: number;\n}\n\nexport interface GenderizeResponseWithCountry extends GenderizeResponse {\n    /**\n     * ISO 3166-1 alpha-2 country code which was used for this prediction\n     */\n    country_id: string;\n}\n\nexport default class Genderize {\n    /**\n     * Outputs information about the current state of the rate limit. Updated and cached\n     * each time [[`predict`]] is called. If no information is available, for example because\n     * [[`predict`]] has not been executed yet, `null` is returned. Otherwise the response is\n     * of type [[`GenderizeLimit`]].\n     */\n    get limit(): GenderizeLimit | null {\n        if (this.latestHeaders) {\n            const limit = Genderize.getIntHeader(\n                this.latestHeaders[0].get('x-rate-limit-limit'),\n            );\n            const remaining = Genderize.getIntHeader(\n                this.latestHeaders[0].get('x-rate-limit-remaining'),\n            );\n            const reset = Genderize.getIntHeader(\n                this.latestHeaders[0].get('x-rate-limit-reset'),\n            );\n\n            if (\n                limit !== undefined &&\n                remaining !== undefined &&\n                reset !== undefined\n            ) {\n                return {\n                    limit,\n                    remaining,\n                    reset: new Date(\n                        this.latestHeaders[1].getTime() + reset * 1000,\n                    ),\n                };\n            }\n        }\n\n        return null;\n    }\n    private readonly apiKey;\n\n    private latestHeaders: [Headers, Date] | null = null;\n\n    /**\n     * Usually you get an `Genderize` instance like this:\n     * ```javascript\n     * import Genderize from '@sebbo2002/genderize';\n     * const genderize = new Genderize('API-KEY');\n     * ```\n     *\n     * You can get an API key from [store.genderize.io](https://store.genderize.io/).\n     *\n     * If you don't have an API key yet, you can start with the free plan:\n     * ```javascript\n     * import Genderize from '@sebbo2002/genderize';\n     * const genderize = new Genderize();\n     * ```\n     */\n    constructor(apiKey?: string) {\n        this.apiKey = apiKey;\n    }\n\n    /**\n     * @internal\n     */\n    static getIntHeader(\n        value: null | string | string[] | undefined,\n    ): number | undefined {\n        if (Array.isArray(value)) {\n            return this.getIntHeader(value[0]);\n        }\n\n        if (value === undefined || value === null) {\n            return undefined;\n        }\n\n        return parseInt(value);\n    }\n\n    /**\n     * Internal function which builds the url parameters\n     * used to query the prediction endpoint.\n     *\n     * @internal\n     */\n    params(names: string | string[], country?: string): string {\n        const searchParams = new URLSearchParams();\n        if (Array.isArray(names) && names.length > 10) {\n            throw new Error(\n                `Too many names given: ${names.length} names provided, but 10 is the maximum allowed`,\n            );\n        }\n        if (Array.isArray(names) && names.length === 0) {\n            throw new Error('No name given, but at least one is required');\n        }\n\n        if (Array.isArray(names)) {\n            names.forEach((name) => searchParams.append('name', name));\n        } else {\n            searchParams.append('name', names);\n        }\n\n        if (country) {\n            searchParams.append('country_id', country);\n        }\n\n        if (this.apiKey) {\n            searchParams.append('apikey', this.apiKey);\n        }\n        if (Array.isArray(names)) {\n            return searchParams.toString().replace(/name=/g, 'name[]=');\n        }\n\n        return searchParams.toString();\n    }\n\n    /**\n     * Predict a single name\n     *\n     * ```typescript\n     * import Genderize from '@sebbo2002/genderize';\n     * const genderize = new Genderize('API-KEY');\n     * genderize.predict('Mia').then(result => {\n     *     console.log(result);\n     * });\n     * ```\n     *\n     * ```json\n     * {\n     *   name: 'Mia',\n     *   gender: 'female',\n     *   probability: 0.96,\n     *   count: 19266\n     * }\n     * ```\n     */\n    async predict(name: string): Promise<GenderizeResponse>;\n    /**\n     * Predict multiple names. Works for up to 10 names at the same time.\n     *\n     * Please check [this list](https://genderize.io/our-data) if you're unsure about\n     * the country code you have to use.\n     *\n     * It is recommended to check the count of the response when using localization.\n     * If the count is very low or gender is null, you can fallback to a request\n     * with no localization.\n     *\n     * ```typescript\n     * import Genderize from '@sebbo2002/genderize';\n     * const genderize = new Genderize('API-KEY');\n     * genderize.predict(['Noah', 'Evelyn']).then(result => {\n     *     console.log(result);\n     * });\n     * ```\n     *\n     * ```json\n     * [\n     *   { name: 'Noah', gender: 'male', probability: 0.88, count: 3939 },\n     *   { name: 'Evelyn', gender: 'female', probability: 0.98, count: 12188 }\n     * ]\n     * ```\n     */\n    async predict(names: string[]): Promise<GenderizeResponse[]>;\n    /**\n     * Predict a single name with a given ISO 3166-1 alpha-2 country code\n     *\n     * ```typescript\n     * import Genderize from '@sebbo2002/genderize';\n     * const genderize = new Genderize('API-KEY');\n     * genderize.predict('Mia', 'DE').then(result => {\n     *     console.log(result);\n     * });\n     * ```\n     *\n     * ```json\n     * {\n     *   name: 'Mia',\n     *   gender: 'female',\n     *   probability: 0.97,\n     *   count: 1786,\n     *   country_id: 'DE'\n     * }\n     * ```\n     */\n    async predict(\n        name: string,\n        country: string,\n    ): Promise<GenderizeResponseWithCountry>;\n    /**\n     * Predict multiple names with a given ISO 3166-1 alpha-2\n     * country code. Works for up to 10 names at the same time.\n     *\n     * Please check [this list](https://genderize.io/our-data) if you're unsure about\n     * the country code you have to use.\n     *\n     * It is recommended to check the count of the response when using localization.\n     * If the count is very low or gender is null, you can fallback to a request\n     * with no localization.\n     *\n     * ```typescript\n     * import Genderize from '@sebbo2002/genderize';\n     * const genderize = new Genderize('API-KEY');\n     * genderize.predict(['Noah', 'Evelyn'], 'DE').then(result => {\n     *     console.log(result);\n     * });\n     * ```\n     *\n     * ```json\n     * [\n     *   { name: 'Noah', gender: 'male', probability: 1, count: 608, country_id: 'DE' },\n     *   { name: 'Evelyn', gender: 'female', probability: 0.97, count: 1665, country_id: 'DE' }\n     * ]\n     * ```\n     */\n    async predict(\n        names: string[],\n        country: string,\n    ): Promise<GenderizeResponseWithCountry[]>;\n    async predict(\n        names: string | string[],\n        country?: string,\n    ): Promise<\n        | GenderizeResponse\n        | GenderizeResponse[]\n        | GenderizeResponseWithCountry\n        | GenderizeResponseWithCountry[]\n    > {\n        const queryString = new URLSearchParams(this.params(names, country));\n        const response = await fetch(\n            'https://api.genderize.io/?' + queryString,\n            {\n                headers: {\n                    'Content-Type': 'application/json',\n                },\n            },\n        );\n        if (!response.ok) {\n            throw new Error(\n                `Unable to query genderize.io: ${await response.text()}`,\n            );\n        }\n\n        const body = (await response.json()) as\n            | GenderizeResponse\n            | GenderizeResponse[];\n        this.latestHeaders = [response.headers, new Date()];\n        return body;\n    }\n}\n"],"mappings":"yaAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,qBAAAE,EAAA,YAAAC,IAAA,eAAAC,EAAAJ,GAGO,IAAKE,OACRA,EAAA,OAAS,SACTA,EAAA,KAAO,OAFCA,OAAA,IA6DSC,EAArB,MAAqBE,CAAU,CAO3B,IAAI,OAA+B,CAC/B,GAAI,KAAK,cAAe,CACpB,IAAMC,EAAQD,EAAU,aACpB,KAAK,cAAc,CAAC,EAAE,IAAI,oBAAoB,CAClD,EACME,EAAYF,EAAU,aACxB,KAAK,cAAc,CAAC,EAAE,IAAI,wBAAwB,CACtD,EACMG,EAAQH,EAAU,aACpB,KAAK,cAAc,CAAC,EAAE,IAAI,oBAAoB,CAClD,EAEA,GACIC,IAAU,QACVC,IAAc,QACdC,IAAU,OAEV,MAAO,CACH,MAAAF,EACA,UAAAC,EACA,MAAO,IAAI,KACP,KAAK,cAAc,CAAC,EAAE,QAAQ,EAAIC,EAAQ,GAC9C,CACJ,CAER,CAEA,OAAO,IACX,CACiB,OAET,cAAwC,KAiBhD,YAAYC,EAAiB,CACzB,KAAK,OAASA,CAClB,CAKA,OAAO,aACHC,EACkB,CAClB,GAAI,MAAM,QAAQA,CAAK,EACnB,OAAO,KAAK,aAAaA,EAAM,CAAC,CAAC,EAGrC,GAA2BA,GAAU,KAIrC,OAAO,SAASA,CAAK,CACzB,CAQA,OAAOC,EAA0BC,EAA0B,CACvD,IAAMC,EAAe,IAAI,gBACzB,GAAI,MAAM,QAAQF,CAAK,GAAKA,EAAM,OAAS,GACvC,MAAM,IAAI,MACN,yBAAyBA,EAAM,MAAM,gDACzC,EAEJ,GAAI,MAAM,QAAQA,CAAK,GAAKA,EAAM,SAAW,EACzC,MAAM,IAAI,MAAM,6CAA6C,EAgBjE,OAbI,MAAM,QAAQA,CAAK,EACnBA,EAAM,QAASG,GAASD,EAAa,OAAO,OAAQC,CAAI,CAAC,EAEzDD,EAAa,OAAO,OAAQF,CAAK,EAGjCC,GACAC,EAAa,OAAO,aAAcD,CAAO,EAGzC,KAAK,QACLC,EAAa,OAAO,SAAU,KAAK,MAAM,EAEzC,MAAM,QAAQF,CAAK,EACZE,EAAa,SAAS,EAAE,QAAQ,SAAU,SAAS,EAGvDA,EAAa,SAAS,CACjC,CAwGA,MAAM,QACFF,EACAC,EAMF,CACE,IAAMG,EAAc,IAAI,gBAAgB,KAAK,OAAOJ,EAAOC,CAAO,CAAC,EAC7DI,EAAW,MAAM,MACnB,6BAA+BD,EAC/B,CACI,QAAS,CACL,eAAgB,kBACpB,CACJ,CACJ,EACA,GAAI,CAACC,EAAS,GACV,MAAM,IAAI,MACN,iCAAiC,MAAMA,EAAS,KAAK,CAAC,EAC1D,EAGJ,IAAMC,EAAQ,MAAMD,EAAS,KAAK,EAGlC,YAAK,cAAgB,CAACA,EAAS,QAAS,IAAI,IAAM,EAC3CC,CACX,CACJ","names":["index_exports","__export","GenderizeGender","Genderize","__toCommonJS","_Genderize","limit","remaining","reset","apiKey","value","names","country","searchParams","name","queryString","response","body"]}

package/dist/index.d.cts

@@ -5,32 +5,6 @@ declare enum GenderizeGender {
     FEMALE = "female",
     MALE = "male"
 }
-interface GenderizeResponse {
-    /**
-     * Name which was used for this prediction
-     */
-    name: string;
-    /**
-     * Either a [[`GenderizeGender`]] value (male/female) or null
-     * if the API was not able to predict a gender.
-     */
-    gender: GenderizeGender | null;
-    /**
-     * Value between 0 and 1 (including)
-     */
-    probability: number;
-    /**
-     * The number of data rows examined in order
-     * to calculate the API response
-     */
-    count: number;
-}
-interface GenderizeResponseWithCountry extends GenderizeResponse {
-    /**
-     * ISO 3166-1 alpha-2 country code which was used for this prediction
-     */
-    country_id: string;
-}
 interface GenderizeLimit {
     /**
      * The amount of names available in the current time window
@@ -54,7 +28,40 @@ interface GenderizeLimit {
      */
     reset: Date;
 }
+interface GenderizeResponse {
+    /**
+     * The number of data rows examined in order
+     * to calculate the API response
+     */
+    count: number;
+    /**
+     * Either a [[`GenderizeGender`]] value (male/female) or null
+     * if the API was not able to predict a gender.
+     */
+    gender: GenderizeGender | null;
+    /**
+     * Name which was used for this prediction
+     */
+    name: string;
+    /**
+     * Value between 0 and 1 (including)
+     */
+    probability: number;
+}
+interface GenderizeResponseWithCountry extends GenderizeResponse {
+    /**
+     * ISO 3166-1 alpha-2 country code which was used for this prediction
+     */
+    country_id: string;
+}
 declare class Genderize {
+    /**
+     * Outputs information about the current state of the rate limit. Updated and cached
+     * each time [[`predict`]] is called. If no information is available, for example because
+     * [[`predict`]] has not been executed yet, `null` is returned. Otherwise the response is
+     * of type [[`GenderizeLimit`]].
+     */
+    get limit(): GenderizeLimit | null;
     private readonly apiKey;
     private latestHeaders;
     /**
@@ -76,14 +83,7 @@ declare class Genderize {
     /**
      * @internal
      */
-    static getIntHeader(value: string | string[] | null | undefined): number | undefined;
-    /**
-     * Outputs information about the current state of the rate limit. Updated and cached
-     * each time [[`predict`]] is called. If no information is available, for example because
-     * [[`predict`]] has not been executed yet, `null` is returned. Otherwise the response is
-     * of type [[`GenderizeLimit`]].
-     */
-    get limit(): GenderizeLimit | null;
+    static getIntHeader(value: null | string | string[] | undefined): number | undefined;
     /**
      * Internal function which builds the url parameters
      * used to query the prediction endpoint.

package/dist/index.d.ts

@@ -5,32 +5,6 @@ declare enum GenderizeGender {
     FEMALE = "female",
     MALE = "male"
 }
-interface GenderizeResponse {
-    /**
-     * Name which was used for this prediction
-     */
-    name: string;
-    /**
-     * Either a [[`GenderizeGender`]] value (male/female) or null
-     * if the API was not able to predict a gender.
-     */
-    gender: GenderizeGender | null;
-    /**
-     * Value between 0 and 1 (including)
-     */
-    probability: number;
-    /**
-     * The number of data rows examined in order
-     * to calculate the API response
-     */
-    count: number;
-}
-interface GenderizeResponseWithCountry extends GenderizeResponse {
-    /**
-     * ISO 3166-1 alpha-2 country code which was used for this prediction
-     */
-    country_id: string;
-}
 interface GenderizeLimit {
     /**
      * The amount of names available in the current time window
@@ -54,7 +28,40 @@ interface GenderizeLimit {
      */
     reset: Date;
 }
+interface GenderizeResponse {
+    /**
+     * The number of data rows examined in order
+     * to calculate the API response
+     */
+    count: number;
+    /**
+     * Either a [[`GenderizeGender`]] value (male/female) or null
+     * if the API was not able to predict a gender.
+     */
+    gender: GenderizeGender | null;
+    /**
+     * Name which was used for this prediction
+     */
+    name: string;
+    /**
+     * Value between 0 and 1 (including)
+     */
+    probability: number;
+}
+interface GenderizeResponseWithCountry extends GenderizeResponse {
+    /**
+     * ISO 3166-1 alpha-2 country code which was used for this prediction
+     */
+    country_id: string;
+}
 declare class Genderize {
+    /**
+     * Outputs information about the current state of the rate limit. Updated and cached
+     * each time [[`predict`]] is called. If no information is available, for example because
+     * [[`predict`]] has not been executed yet, `null` is returned. Otherwise the response is
+     * of type [[`GenderizeLimit`]].
+     */
+    get limit(): GenderizeLimit | null;
     private readonly apiKey;
     private latestHeaders;
     /**
@@ -76,14 +83,7 @@ declare class Genderize {
     /**
      * @internal
      */
-    static getIntHeader(value: string | string[] | null | undefined): number | undefined;
-    /**
-     * Outputs information about the current state of the rate limit. Updated and cached
-     * each time [[`predict`]] is called. If no information is available, for example because
-     * [[`predict`]] has not been executed yet, `null` is returned. Otherwise the response is
-     * of type [[`GenderizeLimit`]].
-     */
-    get limit(): GenderizeLimit | null;
+    static getIntHeader(value: null | string | string[] | undefined): number | undefined;
     /**
      * Internal function which builds the url parameters
      * used to query the prediction endpoint.

package/dist/index.js

@@ -1,2 +1,2 @@
-var o=(t=>(t.FEMALE="female",t.MALE="male",t))(o||{}),s=class i{apiKey;latestHeaders=null;constructor(e){this.apiKey=e}static getIntHeader(e){if(Array.isArray(e))return this.getIntHeader(e[0]);if(e!=null)return parseInt(e)}get limit(){if(this.latestHeaders){let e=i.getIntHeader(this.latestHeaders[0].get("x-rate-limit-limit")),t=i.getIntHeader(this.latestHeaders[0].get("x-rate-limit-remaining")),r=i.getIntHeader(this.latestHeaders[0].get("x-rate-limit-reset"));if(e!==void 0&&t!==void 0&&r!==void 0)return{limit:e,remaining:t,reset:new Date(this.latestHeaders[1].getTime()+r*1e3)}}return null}params(e,t){let r=new URLSearchParams;if(Array.isArray(e)&&e.length>10)throw new Error(`Too many names given: ${e.length} names provided, but 10 is the maximum allowed`);if(Array.isArray(e)&&e.length===0)throw new Error("No name given, but at least one is required");return Array.isArray(e)?e.forEach(n=>r.append("name",n)):r.append("name",e),t&&r.append("country_id",t),this.apiKey&&r.append("apikey",this.apiKey),Array.isArray(e)?r.toString().replace(/name=/g,"name[]="):r.toString()}async predict(e,t){let r=new URLSearchParams(this.params(e,t)),n=await fetch("https://api.genderize.io/?"+r,{headers:{"Content-Type":"application/json"}});if(!n.ok)throw new Error(`Unable to query genderize.io: ${await n.text()}`);let a=await n.json();return this.latestHeaders=[n.headers,new Date],a}};export{o as GenderizeGender,s as default};
+var o=(t=>(t.FEMALE="female",t.MALE="male",t))(o||{}),s=class i{get limit(){if(this.latestHeaders){let e=i.getIntHeader(this.latestHeaders[0].get("x-rate-limit-limit")),t=i.getIntHeader(this.latestHeaders[0].get("x-rate-limit-remaining")),r=i.getIntHeader(this.latestHeaders[0].get("x-rate-limit-reset"));if(e!==void 0&&t!==void 0&&r!==void 0)return{limit:e,remaining:t,reset:new Date(this.latestHeaders[1].getTime()+r*1e3)}}return null}apiKey;latestHeaders=null;constructor(e){this.apiKey=e}static getIntHeader(e){if(Array.isArray(e))return this.getIntHeader(e[0]);if(e!=null)return parseInt(e)}params(e,t){let r=new URLSearchParams;if(Array.isArray(e)&&e.length>10)throw new Error(`Too many names given: ${e.length} names provided, but 10 is the maximum allowed`);if(Array.isArray(e)&&e.length===0)throw new Error("No name given, but at least one is required");return Array.isArray(e)?e.forEach(n=>r.append("name",n)):r.append("name",e),t&&r.append("country_id",t),this.apiKey&&r.append("apikey",this.apiKey),Array.isArray(e)?r.toString().replace(/name=/g,"name[]="):r.toString()}async predict(e,t){let r=new URLSearchParams(this.params(e,t)),n=await fetch("https://api.genderize.io/?"+r,{headers:{"Content-Type":"application/json"}});if(!n.ok)throw new Error(`Unable to query genderize.io: ${await n.text()}`);let a=await n.json();return this.latestHeaders=[n.headers,new Date],a}};export{o as GenderizeGender,s as default};
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/lib/index.ts"],"sourcesContent":["/**\n * Enum that can be used to compare and check the results\n */\nexport enum GenderizeGender {\n    FEMALE = 'female',\n    MALE = 'male'\n}\n\nexport interface GenderizeResponse {\n    /**\n     * Name which was used for this prediction\n     */\n    name: string;\n\n    /**\n     * Either a [[`GenderizeGender`]] value (male/female) or null\n     * if the API was not able to predict a gender.\n     */\n    gender: GenderizeGender | null;\n\n    /**\n     * Value between 0 and 1 (including)\n     */\n    probability: number;\n\n    /**\n     * The number of data rows examined in order\n     * to calculate the API response\n     */\n    count: number;\n}\nexport interface GenderizeResponseWithCountry extends GenderizeResponse {\n    /**\n     * ISO 3166-1 alpha-2 country code which was used for this prediction\n     */\n    country_id: string;\n}\n\nexport interface GenderizeLimit {\n    /**\n     * The amount of names available in the current time window\n     */\n    limit: number;\n\n    /**\n     * The number of names left in the current time window\n     */\n    remaining: number;\n\n    /**\n     * Next time window start time\n     *\n     * ```javascript\n     * import Genderize from '@sebbo2002/genderize';\n     * const genderize = new Genderize('API-KEY');\n     *\n     * // execute a predicition\n     *\n     * genderize.limit?.reset.toString()\n     * ```\n     */\n    reset: Date;\n}\n\nexport default class Genderize {\n    private readonly apiKey;\n    private latestHeaders: [Headers, Date] | null = null;\n\n    /**\n     * Usually you get an `Genderize` instance like this:\n     * ```javascript\n     * import Genderize from '@sebbo2002/genderize';\n     * const genderize = new Genderize('API-KEY');\n     * ```\n     *\n     * You can get an API key from [store.genderize.io](https://store.genderize.io/).\n     *\n     * If you don't have an API key yet, you can start with the free plan:\n     * ```javascript\n     * import Genderize from '@sebbo2002/genderize';\n     * const genderize = new Genderize();\n     * ```\n     */\n    constructor(apiKey?: string) {\n        this.apiKey = apiKey;\n    }\n\n    /**\n     * @internal\n     */\n    static getIntHeader(value: string | string[] | null | undefined): number | undefined {\n        if(Array.isArray(value)) {\n            return this.getIntHeader(value[0]);\n        }\n\n        if(value === undefined || value === null) {\n            return undefined;\n        }\n\n        return parseInt(value);\n    }\n\n    /**\n     * Outputs information about the current state of the rate limit. Updated and cached\n     * each time [[`predict`]] is called. If no information is available, for example because\n     * [[`predict`]] has not been executed yet, `null` is returned. Otherwise the response is\n     * of type [[`GenderizeLimit`]].\n     */\n    get limit(): GenderizeLimit | null {\n\n        if (this.latestHeaders) {\n            const limit = Genderize.getIntHeader(this.latestHeaders[0].get('x-rate-limit-limit'));\n            const remaining = Genderize.getIntHeader(this.latestHeaders[0].get('x-rate-limit-remaining'));\n            const reset = Genderize.getIntHeader(this.latestHeaders[0].get('x-rate-limit-reset'));\n\n            if (limit !== undefined && remaining !== undefined && reset !== undefined) {\n                return {\n                    limit,\n                    remaining,\n                    reset: new Date(this.latestHeaders[1].getTime() + (reset * 1000))\n                };\n            }\n        }\n\n        return null;\n    }\n\n    /**\n     * Internal function which builds the url parameters\n     * used to query the prediction endpoint.\n     *\n     * @internal\n     */\n    params(names: string | string[], country?: string): string {\n        const searchParams = new URLSearchParams();\n        if(Array.isArray(names) && names.length > 10) {\n            throw new Error(`Too many names given: ${names.length} names provided, but 10 is the maximum allowed`);\n        }\n        if(Array.isArray(names) && names.length === 0) {\n            throw new Error('No name given, but at least one is required');\n        }\n\n        if(Array.isArray(names)) {\n            names.forEach(name => searchParams.append('name', name));\n        } else {\n            searchParams.append('name', names);\n        }\n\n        if(country) {\n            searchParams.append('country_id', country);\n        }\n\n        if(this.apiKey) {\n            searchParams.append('apikey', this.apiKey);\n        }\n        if(Array.isArray(names)) {\n            return searchParams.toString()\n                .replace(/name=/g, 'name[]=');\n        }\n\n        return searchParams.toString();\n    }\n\n    /**\n     * Predict a single name\n     *\n     * ```typescript\n     * import Genderize from '@sebbo2002/genderize';\n     * const genderize = new Genderize('API-KEY');\n     * genderize.predict('Mia').then(result => {\n     *     console.log(result);\n     * });\n     * ```\n     *\n     * ```json\n     * {\n     *   name: 'Mia',\n     *   gender: 'female',\n     *   probability: 0.96,\n     *   count: 19266\n     * }\n     * ```\n     */\n    async predict(name: string): Promise<GenderizeResponse>;\n\n    /**\n     * Predict multiple names. Works for up to 10 names at the same time.\n     *\n     * Please check [this list](https://genderize.io/our-data) if you're unsure about\n     * the country code you have to use.\n     *\n     * It is recommended to check the count of the response when using localization.\n     * If the count is very low or gender is null, you can fallback to a request\n     * with no localization.\n     *\n     * ```typescript\n     * import Genderize from '@sebbo2002/genderize';\n     * const genderize = new Genderize('API-KEY');\n     * genderize.predict(['Noah', 'Evelyn']).then(result => {\n     *     console.log(result);\n     * });\n     * ```\n     *\n     * ```json\n     * [\n     *   { name: 'Noah', gender: 'male', probability: 0.88, count: 3939 },\n     *   { name: 'Evelyn', gender: 'female', probability: 0.98, count: 12188 }\n     * ]\n     * ```\n     */\n    async predict(names: string[]): Promise<GenderizeResponse[]>;\n\n    /**\n     * Predict a single name with a given ISO 3166-1 alpha-2 country code\n     *\n     * ```typescript\n     * import Genderize from '@sebbo2002/genderize';\n     * const genderize = new Genderize('API-KEY');\n     * genderize.predict('Mia', 'DE').then(result => {\n     *     console.log(result);\n     * });\n     * ```\n     *\n     * ```json\n     * {\n     *   name: 'Mia',\n     *   gender: 'female',\n     *   probability: 0.97,\n     *   count: 1786,\n     *   country_id: 'DE'\n     * }\n     * ```\n     */\n    async predict(name: string, country: string): Promise<GenderizeResponseWithCountry>;\n\n    /**\n     * Predict multiple names with a given ISO 3166-1 alpha-2\n     * country code. Works for up to 10 names at the same time.\n     *\n     * Please check [this list](https://genderize.io/our-data) if you're unsure about\n     * the country code you have to use.\n     *\n     * It is recommended to check the count of the response when using localization.\n     * If the count is very low or gender is null, you can fallback to a request\n     * with no localization.\n     *\n     * ```typescript\n     * import Genderize from '@sebbo2002/genderize';\n     * const genderize = new Genderize('API-KEY');\n     * genderize.predict(['Noah', 'Evelyn'], 'DE').then(result => {\n     *     console.log(result);\n     * });\n     * ```\n     *\n     * ```json\n     * [\n     *   { name: 'Noah', gender: 'male', probability: 1, count: 608, country_id: 'DE' },\n     *   { name: 'Evelyn', gender: 'female', probability: 0.97, count: 1665, country_id: 'DE' }\n     * ]\n     * ```\n     */\n    async predict(names: string[], country: string): Promise<GenderizeResponseWithCountry[]>;\n\n    async predict(names: string | string[], country?: string): Promise<GenderizeResponse | GenderizeResponse[] | GenderizeResponseWithCountry | GenderizeResponseWithCountry[]> {\n        const queryString = new URLSearchParams(this.params(names, country));\n        const response = await fetch('https://api.genderize.io/?' + queryString, {\n            headers: {\n                'Content-Type': 'application/json'\n            }\n        });\n        if(!response.ok) {\n            throw new Error(`Unable to query genderize.io: ${await response.text()}`);\n        }\n\n        const body = await response.json() as GenderizeResponse | GenderizeResponse[];\n        this.latestHeaders = [response.headers, new Date()];\n        return body;\n    }\n}\n"],"mappings":"AAGO,IAAKA,OACRA,EAAA,OAAS,SACTA,EAAA,KAAO,OAFCA,OAAA,IA6DSC,EAArB,MAAqBC,CAAU,CACV,OACT,cAAwC,KAiBhD,YAAYC,EAAiB,CACzB,KAAK,OAASA,CAClB,CAKA,OAAO,aAAaC,EAAiE,CACjF,GAAG,MAAM,QAAQA,CAAK,EAClB,OAAO,KAAK,aAAaA,EAAM,CAAC,CAAC,EAGrC,GAA0BA,GAAU,KAIpC,OAAO,SAASA,CAAK,CACzB,CAQA,IAAI,OAA+B,CAE/B,GAAI,KAAK,cAAe,CACpB,IAAMC,EAAQH,EAAU,aAAa,KAAK,cAAc,CAAC,EAAE,IAAI,oBAAoB,CAAC,EAC9EI,EAAYJ,EAAU,aAAa,KAAK,cAAc,CAAC,EAAE,IAAI,wBAAwB,CAAC,EACtFK,EAAQL,EAAU,aAAa,KAAK,cAAc,CAAC,EAAE,IAAI,oBAAoB,CAAC,EAEpF,GAAIG,IAAU,QAAaC,IAAc,QAAaC,IAAU,OAC5D,MAAO,CACH,MAAAF,EACA,UAAAC,EACA,MAAO,IAAI,KAAK,KAAK,cAAc,CAAC,EAAE,QAAQ,EAAKC,EAAQ,GAAK,CACpE,CAER,CAEA,OAAO,IACX,CAQA,OAAOC,EAA0BC,EAA0B,CACvD,IAAMC,EAAe,IAAI,gBACzB,GAAG,MAAM,QAAQF,CAAK,GAAKA,EAAM,OAAS,GACtC,MAAM,IAAI,MAAM,yBAAyBA,EAAM,MAAM,gDAAgD,EAEzG,GAAG,MAAM,QAAQA,CAAK,GAAKA,EAAM,SAAW,EACxC,MAAM,IAAI,MAAM,6CAA6C,EAgBjE,OAbG,MAAM,QAAQA,CAAK,EAClBA,EAAM,QAAQG,GAAQD,EAAa,OAAO,OAAQC,CAAI,CAAC,EAEvDD,EAAa,OAAO,OAAQF,CAAK,EAGlCC,GACCC,EAAa,OAAO,aAAcD,CAAO,EAG1C,KAAK,QACJC,EAAa,OAAO,SAAU,KAAK,MAAM,EAE1C,MAAM,QAAQF,CAAK,EACXE,EAAa,SAAS,EACxB,QAAQ,SAAU,SAAS,EAG7BA,EAAa,SAAS,CACjC,CAsGA,MAAM,QAAQF,EAA0BC,EAAoI,CACxK,IAAMG,EAAc,IAAI,gBAAgB,KAAK,OAAOJ,EAAOC,CAAO,CAAC,EAC7DI,EAAW,MAAM,MAAM,6BAA+BD,EAAa,CACrE,QAAS,CACL,eAAgB,kBACpB,CACJ,CAAC,EACD,GAAG,CAACC,EAAS,GACT,MAAM,IAAI,MAAM,iCAAiC,MAAMA,EAAS,KAAK,CAAC,EAAE,EAG5E,IAAMC,EAAO,MAAMD,EAAS,KAAK,EACjC,YAAK,cAAgB,CAACA,EAAS,QAAS,IAAI,IAAM,EAC3CC,CACX,CACJ","names":["GenderizeGender","Genderize","_Genderize","apiKey","value","limit","remaining","reset","names","country","searchParams","name","queryString","response","body"]}
+{"version":3,"sources":["../src/lib/index.ts"],"sourcesContent":["/**\n * Enum that can be used to compare and check the results\n */\nexport enum GenderizeGender {\n    FEMALE = 'female',\n    MALE = 'male',\n}\n\nexport interface GenderizeLimit {\n    /**\n     * The amount of names available in the current time window\n     */\n    limit: number;\n\n    /**\n     * The number of names left in the current time window\n     */\n    remaining: number;\n\n    /**\n     * Next time window start time\n     *\n     * ```javascript\n     * import Genderize from '@sebbo2002/genderize';\n     * const genderize = new Genderize('API-KEY');\n     *\n     * // execute a predicition\n     *\n     * genderize.limit?.reset.toString()\n     * ```\n     */\n    reset: Date;\n}\nexport interface GenderizeResponse {\n    /**\n     * The number of data rows examined in order\n     * to calculate the API response\n     */\n    count: number;\n\n    /**\n     * Either a [[`GenderizeGender`]] value (male/female) or null\n     * if the API was not able to predict a gender.\n     */\n    gender: GenderizeGender | null;\n\n    /**\n     * Name which was used for this prediction\n     */\n    name: string;\n\n    /**\n     * Value between 0 and 1 (including)\n     */\n    probability: number;\n}\n\nexport interface GenderizeResponseWithCountry extends GenderizeResponse {\n    /**\n     * ISO 3166-1 alpha-2 country code which was used for this prediction\n     */\n    country_id: string;\n}\n\nexport default class Genderize {\n    /**\n     * Outputs information about the current state of the rate limit. Updated and cached\n     * each time [[`predict`]] is called. If no information is available, for example because\n     * [[`predict`]] has not been executed yet, `null` is returned. Otherwise the response is\n     * of type [[`GenderizeLimit`]].\n     */\n    get limit(): GenderizeLimit | null {\n        if (this.latestHeaders) {\n            const limit = Genderize.getIntHeader(\n                this.latestHeaders[0].get('x-rate-limit-limit'),\n            );\n            const remaining = Genderize.getIntHeader(\n                this.latestHeaders[0].get('x-rate-limit-remaining'),\n            );\n            const reset = Genderize.getIntHeader(\n                this.latestHeaders[0].get('x-rate-limit-reset'),\n            );\n\n            if (\n                limit !== undefined &&\n                remaining !== undefined &&\n                reset !== undefined\n            ) {\n                return {\n                    limit,\n                    remaining,\n                    reset: new Date(\n                        this.latestHeaders[1].getTime() + reset * 1000,\n                    ),\n                };\n            }\n        }\n\n        return null;\n    }\n    private readonly apiKey;\n\n    private latestHeaders: [Headers, Date] | null = null;\n\n    /**\n     * Usually you get an `Genderize` instance like this:\n     * ```javascript\n     * import Genderize from '@sebbo2002/genderize';\n     * const genderize = new Genderize('API-KEY');\n     * ```\n     *\n     * You can get an API key from [store.genderize.io](https://store.genderize.io/).\n     *\n     * If you don't have an API key yet, you can start with the free plan:\n     * ```javascript\n     * import Genderize from '@sebbo2002/genderize';\n     * const genderize = new Genderize();\n     * ```\n     */\n    constructor(apiKey?: string) {\n        this.apiKey = apiKey;\n    }\n\n    /**\n     * @internal\n     */\n    static getIntHeader(\n        value: null | string | string[] | undefined,\n    ): number | undefined {\n        if (Array.isArray(value)) {\n            return this.getIntHeader(value[0]);\n        }\n\n        if (value === undefined || value === null) {\n            return undefined;\n        }\n\n        return parseInt(value);\n    }\n\n    /**\n     * Internal function which builds the url parameters\n     * used to query the prediction endpoint.\n     *\n     * @internal\n     */\n    params(names: string | string[], country?: string): string {\n        const searchParams = new URLSearchParams();\n        if (Array.isArray(names) && names.length > 10) {\n            throw new Error(\n                `Too many names given: ${names.length} names provided, but 10 is the maximum allowed`,\n            );\n        }\n        if (Array.isArray(names) && names.length === 0) {\n            throw new Error('No name given, but at least one is required');\n        }\n\n        if (Array.isArray(names)) {\n            names.forEach((name) => searchParams.append('name', name));\n        } else {\n            searchParams.append('name', names);\n        }\n\n        if (country) {\n            searchParams.append('country_id', country);\n        }\n\n        if (this.apiKey) {\n            searchParams.append('apikey', this.apiKey);\n        }\n        if (Array.isArray(names)) {\n            return searchParams.toString().replace(/name=/g, 'name[]=');\n        }\n\n        return searchParams.toString();\n    }\n\n    /**\n     * Predict a single name\n     *\n     * ```typescript\n     * import Genderize from '@sebbo2002/genderize';\n     * const genderize = new Genderize('API-KEY');\n     * genderize.predict('Mia').then(result => {\n     *     console.log(result);\n     * });\n     * ```\n     *\n     * ```json\n     * {\n     *   name: 'Mia',\n     *   gender: 'female',\n     *   probability: 0.96,\n     *   count: 19266\n     * }\n     * ```\n     */\n    async predict(name: string): Promise<GenderizeResponse>;\n    /**\n     * Predict multiple names. Works for up to 10 names at the same time.\n     *\n     * Please check [this list](https://genderize.io/our-data) if you're unsure about\n     * the country code you have to use.\n     *\n     * It is recommended to check the count of the response when using localization.\n     * If the count is very low or gender is null, you can fallback to a request\n     * with no localization.\n     *\n     * ```typescript\n     * import Genderize from '@sebbo2002/genderize';\n     * const genderize = new Genderize('API-KEY');\n     * genderize.predict(['Noah', 'Evelyn']).then(result => {\n     *     console.log(result);\n     * });\n     * ```\n     *\n     * ```json\n     * [\n     *   { name: 'Noah', gender: 'male', probability: 0.88, count: 3939 },\n     *   { name: 'Evelyn', gender: 'female', probability: 0.98, count: 12188 }\n     * ]\n     * ```\n     */\n    async predict(names: string[]): Promise<GenderizeResponse[]>;\n    /**\n     * Predict a single name with a given ISO 3166-1 alpha-2 country code\n     *\n     * ```typescript\n     * import Genderize from '@sebbo2002/genderize';\n     * const genderize = new Genderize('API-KEY');\n     * genderize.predict('Mia', 'DE').then(result => {\n     *     console.log(result);\n     * });\n     * ```\n     *\n     * ```json\n     * {\n     *   name: 'Mia',\n     *   gender: 'female',\n     *   probability: 0.97,\n     *   count: 1786,\n     *   country_id: 'DE'\n     * }\n     * ```\n     */\n    async predict(\n        name: string,\n        country: string,\n    ): Promise<GenderizeResponseWithCountry>;\n    /**\n     * Predict multiple names with a given ISO 3166-1 alpha-2\n     * country code. Works for up to 10 names at the same time.\n     *\n     * Please check [this list](https://genderize.io/our-data) if you're unsure about\n     * the country code you have to use.\n     *\n     * It is recommended to check the count of the response when using localization.\n     * If the count is very low or gender is null, you can fallback to a request\n     * with no localization.\n     *\n     * ```typescript\n     * import Genderize from '@sebbo2002/genderize';\n     * const genderize = new Genderize('API-KEY');\n     * genderize.predict(['Noah', 'Evelyn'], 'DE').then(result => {\n     *     console.log(result);\n     * });\n     * ```\n     *\n     * ```json\n     * [\n     *   { name: 'Noah', gender: 'male', probability: 1, count: 608, country_id: 'DE' },\n     *   { name: 'Evelyn', gender: 'female', probability: 0.97, count: 1665, country_id: 'DE' }\n     * ]\n     * ```\n     */\n    async predict(\n        names: string[],\n        country: string,\n    ): Promise<GenderizeResponseWithCountry[]>;\n    async predict(\n        names: string | string[],\n        country?: string,\n    ): Promise<\n        | GenderizeResponse\n        | GenderizeResponse[]\n        | GenderizeResponseWithCountry\n        | GenderizeResponseWithCountry[]\n    > {\n        const queryString = new URLSearchParams(this.params(names, country));\n        const response = await fetch(\n            'https://api.genderize.io/?' + queryString,\n            {\n                headers: {\n                    'Content-Type': 'application/json',\n                },\n            },\n        );\n        if (!response.ok) {\n            throw new Error(\n                `Unable to query genderize.io: ${await response.text()}`,\n            );\n        }\n\n        const body = (await response.json()) as\n            | GenderizeResponse\n            | GenderizeResponse[];\n        this.latestHeaders = [response.headers, new Date()];\n        return body;\n    }\n}\n"],"mappings":"AAGO,IAAKA,OACRA,EAAA,OAAS,SACTA,EAAA,KAAO,OAFCA,OAAA,IA6DSC,EAArB,MAAqBC,CAAU,CAO3B,IAAI,OAA+B,CAC/B,GAAI,KAAK,cAAe,CACpB,IAAMC,EAAQD,EAAU,aACpB,KAAK,cAAc,CAAC,EAAE,IAAI,oBAAoB,CAClD,EACME,EAAYF,EAAU,aACxB,KAAK,cAAc,CAAC,EAAE,IAAI,wBAAwB,CACtD,EACMG,EAAQH,EAAU,aACpB,KAAK,cAAc,CAAC,EAAE,IAAI,oBAAoB,CAClD,EAEA,GACIC,IAAU,QACVC,IAAc,QACdC,IAAU,OAEV,MAAO,CACH,MAAAF,EACA,UAAAC,EACA,MAAO,IAAI,KACP,KAAK,cAAc,CAAC,EAAE,QAAQ,EAAIC,EAAQ,GAC9C,CACJ,CAER,CAEA,OAAO,IACX,CACiB,OAET,cAAwC,KAiBhD,YAAYC,EAAiB,CACzB,KAAK,OAASA,CAClB,CAKA,OAAO,aACHC,EACkB,CAClB,GAAI,MAAM,QAAQA,CAAK,EACnB,OAAO,KAAK,aAAaA,EAAM,CAAC,CAAC,EAGrC,GAA2BA,GAAU,KAIrC,OAAO,SAASA,CAAK,CACzB,CAQA,OAAOC,EAA0BC,EAA0B,CACvD,IAAMC,EAAe,IAAI,gBACzB,GAAI,MAAM,QAAQF,CAAK,GAAKA,EAAM,OAAS,GACvC,MAAM,IAAI,MACN,yBAAyBA,EAAM,MAAM,gDACzC,EAEJ,GAAI,MAAM,QAAQA,CAAK,GAAKA,EAAM,SAAW,EACzC,MAAM,IAAI,MAAM,6CAA6C,EAgBjE,OAbI,MAAM,QAAQA,CAAK,EACnBA,EAAM,QAASG,GAASD,EAAa,OAAO,OAAQC,CAAI,CAAC,EAEzDD,EAAa,OAAO,OAAQF,CAAK,EAGjCC,GACAC,EAAa,OAAO,aAAcD,CAAO,EAGzC,KAAK,QACLC,EAAa,OAAO,SAAU,KAAK,MAAM,EAEzC,MAAM,QAAQF,CAAK,EACZE,EAAa,SAAS,EAAE,QAAQ,SAAU,SAAS,EAGvDA,EAAa,SAAS,CACjC,CAwGA,MAAM,QACFF,EACAC,EAMF,CACE,IAAMG,EAAc,IAAI,gBAAgB,KAAK,OAAOJ,EAAOC,CAAO,CAAC,EAC7DI,EAAW,MAAM,MACnB,6BAA+BD,EAC/B,CACI,QAAS,CACL,eAAgB,kBACpB,CACJ,CACJ,EACA,GAAI,CAACC,EAAS,GACV,MAAM,IAAI,MACN,iCAAiC,MAAMA,EAAS,KAAK,CAAC,EAC1D,EAGJ,IAAMC,EAAQ,MAAMD,EAAS,KAAK,EAGlC,YAAK,cAAgB,CAACA,EAAS,QAAS,IAAI,IAAM,EAC3CC,CACX,CACJ","names":["GenderizeGender","Genderize","_Genderize","limit","remaining","reset","apiKey","value","names","country","searchParams","name","queryString","response","body"]}

package/package.json

@@ -1,60 +1,64 @@
 {
-  "author": "Sebastian Pekarek <mail@sebbo.net>",
-  "bugs": {
-    "url": "https://github.com/sebbo2002/genderize/issues"
-  },
-  "description": "genderize is a simple client for genderize.io, a gender prediction API",
-  "devDependencies": {
-    "@eslint/js": "^9.23.0",
-    "@qiwi/semantic-release-gh-pages-plugin": "^5.4.3",
-    "@semantic-release/changelog": "^6.0.3",
-    "@semantic-release/exec": "^7.0.3",
-    "@semantic-release/git": "^10.0.1",
-    "@semantic-release/npm": "^12.0.1",
-    "@types/mocha": "^10.0.10",
-    "@types/node": "^22.14.0",
-    "c8": "^10.1.3",
-    "eslint": "^9.24.0",
-    "eslint-plugin-jsonc": "^2.20.0",
-    "esm": "^3.2.25",
-    "license-checker": "^25.0.1",
-    "mocha": "^11.1.0",
-    "mochawesome": "^7.1.3",
-    "semantic-release-license": "^1.0.3",
-    "source-map-support": "^0.5.21",
-    "tsup": "^8.4.0",
-    "tsx": "^4.19.3",
-    "typedoc": "^0.28.2",
-    "typescript": "^5.8.3",
-    "typescript-eslint": "^8.29.0"
-  },
-  "engines": {
-    "node": "18 || 20 || >=22.0.0"
-  },
-  "exports": {
-    "import": "./dist/lib/index.js",
-    "require": "./dist/lib/index.cjs"
-  },
-  "files": [
-    "/dist"
-  ],
-  "homepage": "https://github.com/sebbo2002/genderize#readme",
-  "license": "MIT",
-  "main": "./dist/index.js",
-  "module": "./dist/index.js",
-  "name": "@sebbo2002/genderize",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/sebbo2002/genderize.git"
-  },
-  "scripts": {
-    "build": "tsup && cp ./dist/index.d.ts ./dist/index.d.cts",
-    "build-all": "./.github/workflows/build.sh",
-    "coverage": "c8 mocha",
-    "license-check": "license-checker --production --summary",
-    "lint": "eslint .",
-    "test": "mocha"
-  },
-  "type": "module",
-  "version": "5.0.2-develop.9"
+    "author": "Sebastian Pekarek <mail@sebbo.net>",
+    "bugs": {
+        "url": "https://github.com/sebbo2002/genderize/issues"
+    },
+    "description": "genderize is a simple client for genderize.io, a gender prediction API",
+    "devDependencies": {
+        "@eslint/js": "^9.25.0",
+        "@qiwi/semantic-release-gh-pages-plugin": "^5.4.3",
+        "@semantic-release/changelog": "^6.0.3",
+        "@semantic-release/exec": "^7.0.3",
+        "@semantic-release/git": "^10.0.1",
+        "@semantic-release/npm": "^12.0.1",
+        "@types/mocha": "^10.0.10",
+        "@types/node": "^22.14.0",
+        "c8": "^10.1.3",
+        "eslint": "^9.25.1",
+        "eslint-config-prettier": "^10.1.2",
+        "eslint-plugin-jsonc": "^2.20.0",
+        "eslint-plugin-perfectionist": "^4.12.3",
+        "esm": "^3.2.25",
+        "husky": "^9.1.7",
+        "license-checker": "^25.0.1",
+        "mocha": "^11.1.0",
+        "mochawesome": "^7.1.3",
+        "prettier": "^3.5.3",
+        "semantic-release-license": "^1.0.3",
+        "source-map-support": "^0.5.21",
+        "tsup": "^8.4.0",
+        "tsx": "^4.19.3",
+        "typedoc": "^0.28.2",
+        "typescript": "^5.8.3",
+        "typescript-eslint": "^8.31.1"
+    },
+    "engines": {
+        "node": "20 || >=22.0.0"
+    },
+    "exports": {
+        "import": "./dist/lib/index.js",
+        "require": "./dist/lib/index.cjs"
+    },
+    "files": [
+        "/dist"
+    ],
+    "homepage": "https://github.com/sebbo2002/genderize#readme",
+    "license": "MIT",
+    "main": "./dist/index.js",
+    "module": "./dist/index.js",
+    "name": "@sebbo2002/genderize",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/sebbo2002/genderize.git"
+    },
+    "scripts": {
+        "build": "tsup && cp ./dist/index.d.ts ./dist/index.d.cts",
+        "build-all": "./.github/workflows/build.sh",
+        "coverage": "c8 mocha",
+        "license-check": "license-checker --production --summary",
+        "lint": "npx eslint . --fix && npx prettier . --write",
+        "test": "mocha"
+    },
+    "type": "module",
+    "version": "6.0.0"
 }