@sapphire/phisherman 2.0.2-pr-725.25672a58.0 → 3.0.0-pr-935.7da5c8bb

package/README.md

@@ -7,7 +7,6 @@
 **Wrapper around [Phisherman](https://phisherman.gg) to easily check and report domains**
 
 [![GitHub](https://img.shields.io/github/license/sapphiredev/utilities)](https://github.com/sapphiredev/utilities/blob/main/LICENSE.md)
-[![codecov](https://codecov.io/gh/sapphiredev/utilities/branch/main/graph/badge.svg?token=QWL8FB16BR)](https://codecov.io/gh/sapphiredev/utilities)
 [![npm bundle size](https://img.shields.io/bundlephobia/min/@sapphire/phisherman?logo=webpack&style=flat-square)](https://bundlephobia.com/result?p=@sapphire/phisherman)
 [![npm](https://img.shields.io/npm/v/@sapphire/phisherman?color=crimson&logo=npm&style=flat-square)](https://www.npmjs.com/package/@sapphire/phisherman)
 

package/dist/cjs/index.cjs

@@ -9,7 +9,7 @@ var os__default = /*#__PURE__*/_interopDefault(os);
 
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-var packageVersion = "2.0.2-pr-725.25672a58.0";
+var packageVersion = "3.0.0-pr-935.7da5c8bb";
 var agent = `Sapphire Phisherman/${packageVersion} (undici) ${os__default.default.platform()}/${os__default.default.release()} (https://github.com/sapphiredev/utilities/tree/main/packages/phisherman)`;
 var storedApiKey;
 async function checkDomain(domain, apiKey = storedApiKey) {
@@ -113,8 +113,7 @@ async function checkApiKey(apiKey) {
 __name(checkApiKey, "checkApiKey");
 function validateUrl(domain) {
   const regexp = /[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)/gi;
-  if (!domain.match(regexp))
-    throw new Error("[SapphirePhisherman]: Invalid domain provided");
+  if (!domain.match(regexp)) throw new Error("[SapphirePhisherman]: Invalid domain provided");
 }
 __name(validateUrl, "validateUrl");
 
@@ -123,5 +122,5 @@ exports.getDomainInfo = getDomainInfo;
 exports.reportCaughtPhish = reportCaughtPhish;
 exports.reportDomain = reportDomain;
 exports.setApiKey = setApiKey;
-//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.cjs.map
 //# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/lib/Phisherman.ts"],"names":[],"mappings":";;;;AAAA,SAAS,OAAO,cAAc,wBAAoC;AAElE,OAAO,QAAQ;AAGf,IAAM,iBAAyB;AAE/B,IAAM,QAAQ,uBAAuB,cAAc,aAAa,GAAG,SAAS,CAAC,IAAI,GAAG,QAAQ,CAAC;AAI7F,IAAI;AAQJ,eAAsB,YAAY,QAAgB,SAAiB,cAAc;AAChF,cAAY,MAAM;AAClB,QAAM,SAAS,MAAM;AAAA,IACpB,8CAA8C,MAAM;AAAA,IACpD;AAAA,MACC,SAAS;AAAA,QACR,gBAAgB;AAAA,QAChB,cAAc;AAAA,QACd,eAAe,UAAU,MAAM;AAAA,MAChC;AAAA,IACD;AAAA,IACA,iBAAiB;AAAA,EAClB;AAEA,SAAO;AAAA,IACN,GAAG;AAAA,IACH,QAAQ,OAAO,mBAAmB,UAAU,OAAO,mBAAmB,YAAY,QAAQ;AAAA,EAC3F;AACD;AAlBsB;AA0Bf,SAAS,aAAa,QAAgB,SAAiB,cAAc;AAC3E,cAAY,MAAM;AAClB,SAAO;AAAA,IACN;AAAA,IACA;AAAA,MACC,QAAQ,aAAa;AAAA,MACrB,SAAS;AAAA,QACR,gBAAgB;AAAA,QAChB,cAAc;AAAA,QACd,eAAe,UAAU,MAAM;AAAA,MAChC;AAAA,MACA,MAAM,KAAK,UAAU;AAAA,QACpB,KAAK;AAAA,MACN,CAAC;AAAA,IACF;AAAA,IACA,iBAAiB;AAAA,EAClB;AACD;AAjBgB;AAyBhB,eAAsB,cAAc,QAAgB,SAAiB,cAAc;AAClF,cAAY,MAAM;AAClB,QAAM,SAAS,MAAM;AAAA,IACpB,6CAA6C,MAAM;AAAA,IACnD;AAAA,MACC,SAAS;AAAA,QACR,gBAAgB;AAAA,QAChB,cAAc;AAAA,QACd,eAAe,UAAU,MAAM;AAAA,MAChC;AAAA,IACD;AAAA,IACA,iBAAiB;AAAA,EAClB;AACA,SAAO,OAAO,MAAM;AACrB;AAdsB;AAuBf,SAAS,kBAAkB,QAAgB,SAAiB,cAAc,UAA2B,IAAI;AAC/G,SAAO;AAAA,IACN,6CAA6C,MAAM;AAAA,IACnD;AAAA,MACC,QAAQ,aAAa;AAAA,MACrB,SAAS;AAAA,QACR,gBAAgB;AAAA,QAChB,cAAc;AAAA,QACd,eAAe,UAAU,MAAM;AAAA,MAChC;AAAA,MACA,MAAM,KAAK,UAAU;AAAA,QACpB,OAAO,OAAO,OAAO;AAAA,MACtB,CAAC;AAAA,IACF;AAAA,IACA,iBAAiB;AAAA,EAClB;AACD;AAhBgB;AAuBhB,eAAsB,UAAU,KAAa;AAC5C,QAAM,YAAY,GAAG;AACrB,iBAAe;AAChB;AAHsB;AAKtB,eAAe,YAAY,QAAgB;AAC1C,MAAI;AACH,UAAM;AAAA,MACL;AAAA,MACA;AAAA,QACC,SAAS;AAAA,UACR,gBAAgB;AAAA,UAChB,cAAc;AAAA,UACd,eAAe,UAAU,MAAM;AAAA,QAChC;AAAA,MACD;AAAA,MACA,iBAAiB;AAAA,IAClB;AAAA,EACD,SAAS,OAAO;AACf,UAAM,aAAa;AAEnB,QAAI,WAAW,SAAS,OAAO,WAAW,OAAO,EAAE,YAAY,0CAA0C;AACxG,YAAM,IAAI,MAAM,gDAAgD;AAAA,IACjE;AAEA,UAAM;AAAA,EACP;AACD;AAtBe;AAwBf,SAAS,YAAY,QAAgB;AACpC,QAAM,SAAS;AACf,MAAI,CAAC,OAAO,MAAM,MAAM;AAAG,UAAM,IAAI,MAAM,+CAA+C;AAC3F;AAHS","sourcesContent":["import { fetch, FetchMethods, FetchResultTypes, QueryError } from '@sapphire/fetch';\nimport type { PhishermanInfoType, PhishermanReportType, PhishermanReturnType } from './PhishermanTypes';\nimport os from 'node:os';\n\n// eslint-disable-next-line @typescript-eslint/no-inferrable-types\nconst packageVersion: string = '2.0.2-pr-725.25672a58.0';\n\nconst agent = `Sapphire Phisherman/${packageVersion} (undici) ${os.platform()}/${os.release()} (https://github.com/sapphiredev/utilities/tree/main/packages/phisherman)`;\n/**\n * The cached apiKey which was created using {@link setApiKey}\n */\nlet storedApiKey: string;\n\n/**\n * Checks if a link is detected as a scam or phishing link by phisherman.\n * @param domain The domain to check.\n * @param apiKey optionally pass a Phiserman API key for making this request. This will default to {@link storedApiKey}, which can be configured through {@link setApiKey}.\n * @since 1.0.0\n */\nexport async function checkDomain(domain: string, apiKey: string = storedApiKey) {\n\tvalidateUrl(domain);\n\tconst result = await fetch<PhishermanReturnType>(\n\t\t`https://api.phisherman.gg/v2/domains/check/${domain}`,\n\t\t{\n\t\t\theaders: {\n\t\t\t\t'Content-Type': 'application/json',\n\t\t\t\t'User-Agent': agent,\n\t\t\t\tAuthorization: `Bearer ${apiKey}`\n\t\t\t}\n\t\t},\n\t\tFetchResultTypes.JSON\n\t);\n\n\treturn {\n\t\t...result,\n\t\tisScam: result.classification === 'safe' || result.classification === 'unknown' ? false : true\n\t};\n}\n\n/**\n * Report a domain that is confirmed to be a scam or phishing domain to phisherman, to enhance their API.\n * @param domain The domain to report.\n * @param apiKey optionally pass a Phiserman API key for making this request. This will default to {@link storedApiKey}, which can be configured through {@link setApiKey}.\n * @since 1.0.0\n */\nexport function reportDomain(domain: string, apiKey: string = storedApiKey) {\n\tvalidateUrl(domain);\n\treturn fetch<PhishermanReportType>(\n\t\t`https://api.phisherman.gg/v2/phish/report`,\n\t\t{\n\t\t\tmethod: FetchMethods.Put,\n\t\t\theaders: {\n\t\t\t\t'Content-Type': 'application/json',\n\t\t\t\t'User-Agent': agent,\n\t\t\t\tAuthorization: `Bearer ${apiKey}`\n\t\t\t},\n\t\t\tbody: JSON.stringify({\n\t\t\t\turl: domain\n\t\t\t})\n\t\t},\n\t\tFetchResultTypes.JSON\n\t);\n}\n\n/**\n * Returns information for a domain.\n * @param domain The domain to get info about.\n * @param apiKey optionally pass a Phiserman API key for making this request. This will default to {@link storedApiKey}, which can be configured through {@link setApiKey}.\n * @since 1.1.0\n */\nexport async function getDomainInfo(domain: string, apiKey: string = storedApiKey) {\n\tvalidateUrl(domain);\n\tconst result = await fetch<PhishermanInfoType>(\n\t\t`https://api.phisherman.gg/v2/domains/info/${domain}`,\n\t\t{\n\t\t\theaders: {\n\t\t\t\t'Content-Type': 'application/json',\n\t\t\t\t'User-Agent': agent,\n\t\t\t\tAuthorization: `Bearer ${apiKey}`\n\t\t\t}\n\t\t},\n\t\tFetchResultTypes.JSON\n\t);\n\treturn result[domain];\n}\n\n/**\n * Report a caught phish back to phisherman to improve their analytics.\n * @param domain The domain which was caught.\n * @param apiKey @param apiKey optionally pass a Phiserman API key for making this request. This will default to {@link storedApiKey}, which can be configured through {@link setApiKey}.\n * @param guildId The id of the guild in which the domain was caught.\n * @since 1.1.0\n */\nexport function reportCaughtPhish(domain: string, apiKey: string = storedApiKey, guildId: string | number = '') {\n\treturn fetch<PhishermanReportType>(\n\t\t`https://api.phisherman.gg/v2/phish/caught/${domain}`,\n\t\t{\n\t\t\tmethod: FetchMethods.Post,\n\t\t\theaders: {\n\t\t\t\t'Content-Type': 'application/json',\n\t\t\t\t'User-Agent': agent,\n\t\t\t\tAuthorization: `Bearer ${apiKey}`\n\t\t\t},\n\t\t\tbody: JSON.stringify({\n\t\t\t\tguild: Number(guildId)\n\t\t\t})\n\t\t},\n\t\tFetchResultTypes.JSON\n\t);\n}\n\n/**\n * Set the phisherman's API key.\n * @param key The API key to access the phisherman API and cache within the code of the wrapper.\n * @since 1.0.0\n */\nexport async function setApiKey(key: string) {\n\tawait checkApiKey(key);\n\tstoredApiKey = key;\n}\n\nasync function checkApiKey(apiKey: string) {\n\ttry {\n\t\tawait fetch<{ message: string; success: false }>(\n\t\t\t`https://api.phisherman.gg/v2/domains/check/verified.test.phisherman.gg`,\n\t\t\t{\n\t\t\t\theaders: {\n\t\t\t\t\t'Content-Type': 'application/json',\n\t\t\t\t\t'User-Agent': agent,\n\t\t\t\t\tAuthorization: `Bearer ${apiKey}`\n\t\t\t\t}\n\t\t\t},\n\t\t\tFetchResultTypes.JSON\n\t\t);\n\t} catch (error) {\n\t\tconst typedError = error as QueryError;\n\n\t\tif (typedError.code === 401 && typedError.toJSON().message === 'missing permissions or invalid API key') {\n\t\t\tthrow new Error('[SapphirePhisherman]: Invalid API key provided');\n\t\t}\n\n\t\tthrow error;\n\t}\n}\n\nfunction validateUrl(domain: string) {\n\tconst regexp = /[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b([-a-zA-Z0-9()@:%_\\+.~#?&//=]*)/gi;\n\tif (!domain.match(regexp)) throw new Error('[SapphirePhisherman]: Invalid domain provided');\n}\n"]}
+{"version":3,"sources":["../../src/lib/Phisherman.ts"],"names":["os","fetch","FetchResultTypes","FetchMethods"],"mappings":";;;;;;;;;;;AAKA,IAAM,cAAA,GAAyB,uBAAA;AAE/B,IAAM,KAAA,GAAQ,CAAA,oBAAA,EAAuB,cAAc,CAAA,UAAA,EAAaA,mBAAA,CAAG,UAAU,CAAA,CAAA,EAAIA,mBAAA,CAAG,OAAA,EAAS,CAAA,yEAAA,CAAA;AAI7F,IAAI,YAAA;AAQJ,eAAsB,WAAA,CAAY,MAAA,EAAgB,MAAA,GAAiB,YAAA,EAAc;AAChF,EAAA,WAAA,CAAY,MAAM,CAAA;AAClB,EAAA,MAAM,SAAS,MAAMC,WAAA;AAAA,IACpB,8CAA8C,MAAM,CAAA,CAAA;AAAA,IACpD;AAAA,MACC,OAAA,EAAS;AAAA,QACR,cAAA,EAAgB,kBAAA;AAAA,QAChB,YAAA,EAAc,KAAA;AAAA,QACd,aAAA,EAAe,UAAU,MAAM,CAAA;AAAA;AAChC,KACD;AAAA,IACAC,sBAAA,CAAiB;AAAA,GAClB;AAEA,EAAA,OAAO;AAAA,IACN,GAAG,MAAA;AAAA,IACH,QAAQ,MAAA,CAAO,cAAA,KAAmB,UAAU,MAAA,CAAO,cAAA,KAAmB,YAAY,KAAA,GAAQ;AAAA,GAC3F;AACD;AAlBsB,MAAA,CAAA,WAAA,EAAA,aAAA,CAAA;AA0Bf,SAAS,YAAA,CAAa,MAAA,EAAgB,MAAA,GAAiB,YAAA,EAAc;AAC3E,EAAA,WAAA,CAAY,MAAM,CAAA;AAClB,EAAA,OAAOD,WAAA;AAAA,IACN,CAAA,yCAAA,CAAA;AAAA,IACA;AAAA,MACC,QAAQE,kBAAA,CAAa,GAAA;AAAA,MACrB,OAAA,EAAS;AAAA,QACR,cAAA,EAAgB,kBAAA;AAAA,QAChB,YAAA,EAAc,KAAA;AAAA,QACd,aAAA,EAAe,UAAU,MAAM,CAAA;AAAA,OAChC;AAAA,MACA,IAAA,EAAM,KAAK,SAAA,CAAU;AAAA,QACpB,GAAA,EAAK;AAAA,OACL;AAAA,KACF;AAAA,IACAD,sBAAA,CAAiB;AAAA,GAClB;AACD;AAjBgB,MAAA,CAAA,YAAA,EAAA,cAAA,CAAA;AAyBhB,eAAsB,aAAA,CAAc,MAAA,EAAgB,MAAA,GAAiB,YAAA,EAAc;AAClF,EAAA,WAAA,CAAY,MAAM,CAAA;AAClB,EAAA,MAAM,SAAS,MAAMD,WAAA;AAAA,IACpB,6CAA6C,MAAM,CAAA,CAAA;AAAA,IACnD;AAAA,MACC,OAAA,EAAS;AAAA,QACR,cAAA,EAAgB,kBAAA;AAAA,QAChB,YAAA,EAAc,KAAA;AAAA,QACd,aAAA,EAAe,UAAU,MAAM,CAAA;AAAA;AAChC,KACD;AAAA,IACAC,sBAAA,CAAiB;AAAA,GAClB;AACA,EAAA,OAAO,OAAO,MAAM,CAAA;AACrB;AAdsB,MAAA,CAAA,aAAA,EAAA,eAAA,CAAA;AAuBf,SAAS,iBAAA,CAAkB,MAAA,EAAgB,MAAA,GAAiB,YAAA,EAAc,UAA2B,EAAA,EAAI;AAC/G,EAAA,OAAOD,WAAA;AAAA,IACN,6CAA6C,MAAM,CAAA,CAAA;AAAA,IACnD;AAAA,MACC,QAAQE,kBAAA,CAAa,IAAA;AAAA,MACrB,OAAA,EAAS;AAAA,QACR,cAAA,EAAgB,kBAAA;AAAA,QAChB,YAAA,EAAc,KAAA;AAAA,QACd,aAAA,EAAe,UAAU,MAAM,CAAA;AAAA,OAChC;AAAA,MACA,IAAA,EAAM,KAAK,SAAA,CAAU;AAAA,QACpB,KAAA,EAAO,OAAO,OAAO;AAAA,OACrB;AAAA,KACF;AAAA,IACAD,sBAAA,CAAiB;AAAA,GAClB;AACD;AAhBgB,MAAA,CAAA,iBAAA,EAAA,mBAAA,CAAA;AAuBhB,eAAsB,UAAU,GAAA,EAAa;AAC5C,EAAA,MAAM,YAAY,GAAG,CAAA;AACrB,EAAA,YAAA,GAAe,GAAA;AAChB;AAHsB,MAAA,CAAA,SAAA,EAAA,WAAA,CAAA;AAKtB,eAAe,YAAY,MAAA,EAAgB;AAC1C,EAAA,IAAI;AACH,IAAA,MAAMD,WAAA;AAAA,MACL,CAAA,sEAAA,CAAA;AAAA,MACA;AAAA,QACC,OAAA,EAAS;AAAA,UACR,cAAA,EAAgB,kBAAA;AAAA,UAChB,YAAA,EAAc,KAAA;AAAA,UACd,aAAA,EAAe,UAAU,MAAM,CAAA;AAAA;AAChC,OACD;AAAA,MACAC,sBAAA,CAAiB;AAAA,KAClB;AAAA,EACD,SAAS,KAAA,EAAO;AACf,IAAA,MAAM,UAAA,GAAa,KAAA;AAEnB,IAAA,IAAI,WAAW,IAAA,KAAS,GAAA,IAAO,WAAW,MAAA,EAAO,CAAE,YAAY,wCAAA,EAA0C;AACxG,MAAA,MAAM,IAAI,MAAM,gDAAgD,CAAA;AAAA,IACjE;AAEA,IAAA,MAAM,KAAA;AAAA,EACP;AACD;AAtBe,MAAA,CAAA,WAAA,EAAA,aAAA,CAAA;AAwBf,SAAS,YAAY,MAAA,EAAgB;AACpC,EAAA,MAAM,MAAA,GAAS,sFAAA;AACf,EAAA,IAAI,CAAC,OAAO,KAAA,CAAM,MAAM,GAAG,MAAM,IAAI,MAAM,+CAA+C,CAAA;AAC3F;AAHS,MAAA,CAAA,WAAA,EAAA,aAAA,CAAA","file":"index.cjs","sourcesContent":["import { fetch, FetchMethods, FetchResultTypes, QueryError } from '@sapphire/fetch';\nimport type { PhishermanInfoType, PhishermanReportType, PhishermanReturnType } from './PhishermanTypes';\nimport os from 'node:os';\n\n// eslint-disable-next-line @typescript-eslint/no-inferrable-types\nconst packageVersion: string = '3.0.0-pr-935.7da5c8bb';\n\nconst agent = `Sapphire Phisherman/${packageVersion} (undici) ${os.platform()}/${os.release()} (https://github.com/sapphiredev/utilities/tree/main/packages/phisherman)`;\n/**\n * The cached apiKey which was created using {@link setApiKey}\n */\nlet storedApiKey: string;\n\n/**\n * Checks if a link is detected as a scam or phishing link by phisherman.\n * @param domain The domain to check.\n * @param apiKey optionally pass a Phiserman API key for making this request. This will default to {@link storedApiKey}, which can be configured through {@link setApiKey}.\n * @since 1.0.0\n */\nexport async function checkDomain(domain: string, apiKey: string = storedApiKey) {\n\tvalidateUrl(domain);\n\tconst result = await fetch<PhishermanReturnType>(\n\t\t`https://api.phisherman.gg/v2/domains/check/${domain}`,\n\t\t{\n\t\t\theaders: {\n\t\t\t\t'Content-Type': 'application/json',\n\t\t\t\t'User-Agent': agent,\n\t\t\t\tAuthorization: `Bearer ${apiKey}`\n\t\t\t}\n\t\t},\n\t\tFetchResultTypes.JSON\n\t);\n\n\treturn {\n\t\t...result,\n\t\tisScam: result.classification === 'safe' || result.classification === 'unknown' ? false : true\n\t};\n}\n\n/**\n * Report a domain that is confirmed to be a scam or phishing domain to phisherman, to enhance their API.\n * @param domain The domain to report.\n * @param apiKey optionally pass a Phiserman API key for making this request. This will default to {@link storedApiKey}, which can be configured through {@link setApiKey}.\n * @since 1.0.0\n */\nexport function reportDomain(domain: string, apiKey: string = storedApiKey) {\n\tvalidateUrl(domain);\n\treturn fetch<PhishermanReportType>(\n\t\t`https://api.phisherman.gg/v2/phish/report`,\n\t\t{\n\t\t\tmethod: FetchMethods.Put,\n\t\t\theaders: {\n\t\t\t\t'Content-Type': 'application/json',\n\t\t\t\t'User-Agent': agent,\n\t\t\t\tAuthorization: `Bearer ${apiKey}`\n\t\t\t},\n\t\t\tbody: JSON.stringify({\n\t\t\t\turl: domain\n\t\t\t})\n\t\t},\n\t\tFetchResultTypes.JSON\n\t);\n}\n\n/**\n * Returns information for a domain.\n * @param domain The domain to get info about.\n * @param apiKey optionally pass a Phiserman API key for making this request. This will default to {@link storedApiKey}, which can be configured through {@link setApiKey}.\n * @since 1.1.0\n */\nexport async function getDomainInfo(domain: string, apiKey: string = storedApiKey) {\n\tvalidateUrl(domain);\n\tconst result = await fetch<PhishermanInfoType>(\n\t\t`https://api.phisherman.gg/v2/domains/info/${domain}`,\n\t\t{\n\t\t\theaders: {\n\t\t\t\t'Content-Type': 'application/json',\n\t\t\t\t'User-Agent': agent,\n\t\t\t\tAuthorization: `Bearer ${apiKey}`\n\t\t\t}\n\t\t},\n\t\tFetchResultTypes.JSON\n\t);\n\treturn result[domain];\n}\n\n/**\n * Report a caught phish back to phisherman to improve their analytics.\n * @param domain The domain which was caught.\n * @param apiKey @param apiKey optionally pass a Phiserman API key for making this request. This will default to {@link storedApiKey}, which can be configured through {@link setApiKey}.\n * @param guildId The id of the guild in which the domain was caught.\n * @since 1.1.0\n */\nexport function reportCaughtPhish(domain: string, apiKey: string = storedApiKey, guildId: string | number = '') {\n\treturn fetch<PhishermanReportType>(\n\t\t`https://api.phisherman.gg/v2/phish/caught/${domain}`,\n\t\t{\n\t\t\tmethod: FetchMethods.Post,\n\t\t\theaders: {\n\t\t\t\t'Content-Type': 'application/json',\n\t\t\t\t'User-Agent': agent,\n\t\t\t\tAuthorization: `Bearer ${apiKey}`\n\t\t\t},\n\t\t\tbody: JSON.stringify({\n\t\t\t\tguild: Number(guildId)\n\t\t\t})\n\t\t},\n\t\tFetchResultTypes.JSON\n\t);\n}\n\n/**\n * Set the phisherman's API key.\n * @param key The API key to access the phisherman API and cache within the code of the wrapper.\n * @since 1.0.0\n */\nexport async function setApiKey(key: string) {\n\tawait checkApiKey(key);\n\tstoredApiKey = key;\n}\n\nasync function checkApiKey(apiKey: string) {\n\ttry {\n\t\tawait fetch<{ message: string; success: false }>(\n\t\t\t`https://api.phisherman.gg/v2/domains/check/verified.test.phisherman.gg`,\n\t\t\t{\n\t\t\t\theaders: {\n\t\t\t\t\t'Content-Type': 'application/json',\n\t\t\t\t\t'User-Agent': agent,\n\t\t\t\t\tAuthorization: `Bearer ${apiKey}`\n\t\t\t\t}\n\t\t\t},\n\t\t\tFetchResultTypes.JSON\n\t\t);\n\t} catch (error) {\n\t\tconst typedError = error as QueryError;\n\n\t\tif (typedError.code === 401 && typedError.toJSON().message === 'missing permissions or invalid API key') {\n\t\t\tthrow new Error('[SapphirePhisherman]: Invalid API key provided');\n\t\t}\n\n\t\tthrow error;\n\t}\n}\n\nfunction validateUrl(domain: string) {\n\tconst regexp = /[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b([-a-zA-Z0-9()@:%_\\+.~#?&//=]*)/gi;\n\tif (!domain.match(regexp)) throw new Error('[SapphirePhisherman]: Invalid domain provided');\n}\n"]}

package/dist/cjs/index.d.cts

@@ -24,6 +24,9 @@ interface PhishermanInfo {
     phishCaught: number;
     details: Details;
 }
+interface PhishermanInfoType {
+    [key: string]: PhishermanInfo;
+}
 interface Details {
     phishTankId: string;
     urlScanId: string;
@@ -83,4 +86,4 @@ declare function reportCaughtPhish(domain: string, apiKey?: string, guildId?: st
  */
 declare function setApiKey(key: string): Promise<void>;
 
-export { type CheckReturnType, type PhishermanOptions, type PhishermanReportType, type PhishermanReturnType, checkDomain, getDomainInfo, reportCaughtPhish, reportDomain, setApiKey };
+export { type CheckReturnType, type PhishermanInfo, type PhishermanInfoType, type PhishermanOptions, type PhishermanReportType, type PhishermanReturnType, checkDomain, getDomainInfo, reportCaughtPhish, reportDomain, setApiKey };

package/dist/esm/index.d.mts

@@ -24,6 +24,9 @@ interface PhishermanInfo {
     phishCaught: number;
     details: Details;
 }
+interface PhishermanInfoType {
+    [key: string]: PhishermanInfo;
+}
 interface Details {
     phishTankId: string;
     urlScanId: string;
@@ -83,4 +86,4 @@ declare function reportCaughtPhish(domain: string, apiKey?: string, guildId?: st
  */
 declare function setApiKey(key: string): Promise<void>;
 
-export { type CheckReturnType, type PhishermanOptions, type PhishermanReportType, type PhishermanReturnType, checkDomain, getDomainInfo, reportCaughtPhish, reportDomain, setApiKey };
+export { type CheckReturnType, type PhishermanInfo, type PhishermanInfoType, type PhishermanOptions, type PhishermanReportType, type PhishermanReturnType, checkDomain, getDomainInfo, reportCaughtPhish, reportDomain, setApiKey };

package/dist/esm/index.mjs

@@ -1,9 +1,9 @@
 import { fetch, FetchResultTypes, FetchMethods } from '@sapphire/fetch';
-import os from 'node:os';
+import os from 'os';
 
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-var packageVersion = "2.0.2-pr-725.25672a58.0";
+var packageVersion = "3.0.0-pr-935.7da5c8bb";
 var agent = `Sapphire Phisherman/${packageVersion} (undici) ${os.platform()}/${os.release()} (https://github.com/sapphiredev/utilities/tree/main/packages/phisherman)`;
 var storedApiKey;
 async function checkDomain(domain, apiKey = storedApiKey) {
@@ -107,11 +107,10 @@ async function checkApiKey(apiKey) {
 __name(checkApiKey, "checkApiKey");
 function validateUrl(domain) {
   const regexp = /[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)/gi;
-  if (!domain.match(regexp))
-    throw new Error("[SapphirePhisherman]: Invalid domain provided");
+  if (!domain.match(regexp)) throw new Error("[SapphirePhisherman]: Invalid domain provided");
 }
 __name(validateUrl, "validateUrl");
 
 export { checkDomain, getDomainInfo, reportCaughtPhish, reportDomain, setApiKey };
-//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.mjs.map
 //# sourceMappingURL=index.mjs.map

package/dist/esm/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/lib/Phisherman.ts"],"names":[],"mappings":";;;;AAAA,SAAS,OAAO,cAAc,wBAAoC;AAElE,OAAO,QAAQ;AAGf,IAAM,iBAAyB;AAE/B,IAAM,QAAQ,uBAAuB,cAAc,aAAa,GAAG,SAAS,CAAC,IAAI,GAAG,QAAQ,CAAC;AAI7F,IAAI;AAQJ,eAAsB,YAAY,QAAgB,SAAiB,cAAc;AAChF,cAAY,MAAM;AAClB,QAAM,SAAS,MAAM;AAAA,IACpB,8CAA8C,MAAM;AAAA,IACpD;AAAA,MACC,SAAS;AAAA,QACR,gBAAgB;AAAA,QAChB,cAAc;AAAA,QACd,eAAe,UAAU,MAAM;AAAA,MAChC;AAAA,IACD;AAAA,IACA,iBAAiB;AAAA,EAClB;AAEA,SAAO;AAAA,IACN,GAAG;AAAA,IACH,QAAQ,OAAO,mBAAmB,UAAU,OAAO,mBAAmB,YAAY,QAAQ;AAAA,EAC3F;AACD;AAlBsB;AA0Bf,SAAS,aAAa,QAAgB,SAAiB,cAAc;AAC3E,cAAY,MAAM;AAClB,SAAO;AAAA,IACN;AAAA,IACA;AAAA,MACC,QAAQ,aAAa;AAAA,MACrB,SAAS;AAAA,QACR,gBAAgB;AAAA,QAChB,cAAc;AAAA,QACd,eAAe,UAAU,MAAM;AAAA,MAChC;AAAA,MACA,MAAM,KAAK,UAAU;AAAA,QACpB,KAAK;AAAA,MACN,CAAC;AAAA,IACF;AAAA,IACA,iBAAiB;AAAA,EAClB;AACD;AAjBgB;AAyBhB,eAAsB,cAAc,QAAgB,SAAiB,cAAc;AAClF,cAAY,MAAM;AAClB,QAAM,SAAS,MAAM;AAAA,IACpB,6CAA6C,MAAM;AAAA,IACnD;AAAA,MACC,SAAS;AAAA,QACR,gBAAgB;AAAA,QAChB,cAAc;AAAA,QACd,eAAe,UAAU,MAAM;AAAA,MAChC;AAAA,IACD;AAAA,IACA,iBAAiB;AAAA,EAClB;AACA,SAAO,OAAO,MAAM;AACrB;AAdsB;AAuBf,SAAS,kBAAkB,QAAgB,SAAiB,cAAc,UAA2B,IAAI;AAC/G,SAAO;AAAA,IACN,6CAA6C,MAAM;AAAA,IACnD;AAAA,MACC,QAAQ,aAAa;AAAA,MACrB,SAAS;AAAA,QACR,gBAAgB;AAAA,QAChB,cAAc;AAAA,QACd,eAAe,UAAU,MAAM;AAAA,MAChC;AAAA,MACA,MAAM,KAAK,UAAU;AAAA,QACpB,OAAO,OAAO,OAAO;AAAA,MACtB,CAAC;AAAA,IACF;AAAA,IACA,iBAAiB;AAAA,EAClB;AACD;AAhBgB;AAuBhB,eAAsB,UAAU,KAAa;AAC5C,QAAM,YAAY,GAAG;AACrB,iBAAe;AAChB;AAHsB;AAKtB,eAAe,YAAY,QAAgB;AAC1C,MAAI;AACH,UAAM;AAAA,MACL;AAAA,MACA;AAAA,QACC,SAAS;AAAA,UACR,gBAAgB;AAAA,UAChB,cAAc;AAAA,UACd,eAAe,UAAU,MAAM;AAAA,QAChC;AAAA,MACD;AAAA,MACA,iBAAiB;AAAA,IAClB;AAAA,EACD,SAAS,OAAO;AACf,UAAM,aAAa;AAEnB,QAAI,WAAW,SAAS,OAAO,WAAW,OAAO,EAAE,YAAY,0CAA0C;AACxG,YAAM,IAAI,MAAM,gDAAgD;AAAA,IACjE;AAEA,UAAM;AAAA,EACP;AACD;AAtBe;AAwBf,SAAS,YAAY,QAAgB;AACpC,QAAM,SAAS;AACf,MAAI,CAAC,OAAO,MAAM,MAAM;AAAG,UAAM,IAAI,MAAM,+CAA+C;AAC3F;AAHS","sourcesContent":["import { fetch, FetchMethods, FetchResultTypes, QueryError } from '@sapphire/fetch';\nimport type { PhishermanInfoType, PhishermanReportType, PhishermanReturnType } from './PhishermanTypes';\nimport os from 'node:os';\n\n// eslint-disable-next-line @typescript-eslint/no-inferrable-types\nconst packageVersion: string = '2.0.2-pr-725.25672a58.0';\n\nconst agent = `Sapphire Phisherman/${packageVersion} (undici) ${os.platform()}/${os.release()} (https://github.com/sapphiredev/utilities/tree/main/packages/phisherman)`;\n/**\n * The cached apiKey which was created using {@link setApiKey}\n */\nlet storedApiKey: string;\n\n/**\n * Checks if a link is detected as a scam or phishing link by phisherman.\n * @param domain The domain to check.\n * @param apiKey optionally pass a Phiserman API key for making this request. This will default to {@link storedApiKey}, which can be configured through {@link setApiKey}.\n * @since 1.0.0\n */\nexport async function checkDomain(domain: string, apiKey: string = storedApiKey) {\n\tvalidateUrl(domain);\n\tconst result = await fetch<PhishermanReturnType>(\n\t\t`https://api.phisherman.gg/v2/domains/check/${domain}`,\n\t\t{\n\t\t\theaders: {\n\t\t\t\t'Content-Type': 'application/json',\n\t\t\t\t'User-Agent': agent,\n\t\t\t\tAuthorization: `Bearer ${apiKey}`\n\t\t\t}\n\t\t},\n\t\tFetchResultTypes.JSON\n\t);\n\n\treturn {\n\t\t...result,\n\t\tisScam: result.classification === 'safe' || result.classification === 'unknown' ? false : true\n\t};\n}\n\n/**\n * Report a domain that is confirmed to be a scam or phishing domain to phisherman, to enhance their API.\n * @param domain The domain to report.\n * @param apiKey optionally pass a Phiserman API key for making this request. This will default to {@link storedApiKey}, which can be configured through {@link setApiKey}.\n * @since 1.0.0\n */\nexport function reportDomain(domain: string, apiKey: string = storedApiKey) {\n\tvalidateUrl(domain);\n\treturn fetch<PhishermanReportType>(\n\t\t`https://api.phisherman.gg/v2/phish/report`,\n\t\t{\n\t\t\tmethod: FetchMethods.Put,\n\t\t\theaders: {\n\t\t\t\t'Content-Type': 'application/json',\n\t\t\t\t'User-Agent': agent,\n\t\t\t\tAuthorization: `Bearer ${apiKey}`\n\t\t\t},\n\t\t\tbody: JSON.stringify({\n\t\t\t\turl: domain\n\t\t\t})\n\t\t},\n\t\tFetchResultTypes.JSON\n\t);\n}\n\n/**\n * Returns information for a domain.\n * @param domain The domain to get info about.\n * @param apiKey optionally pass a Phiserman API key for making this request. This will default to {@link storedApiKey}, which can be configured through {@link setApiKey}.\n * @since 1.1.0\n */\nexport async function getDomainInfo(domain: string, apiKey: string = storedApiKey) {\n\tvalidateUrl(domain);\n\tconst result = await fetch<PhishermanInfoType>(\n\t\t`https://api.phisherman.gg/v2/domains/info/${domain}`,\n\t\t{\n\t\t\theaders: {\n\t\t\t\t'Content-Type': 'application/json',\n\t\t\t\t'User-Agent': agent,\n\t\t\t\tAuthorization: `Bearer ${apiKey}`\n\t\t\t}\n\t\t},\n\t\tFetchResultTypes.JSON\n\t);\n\treturn result[domain];\n}\n\n/**\n * Report a caught phish back to phisherman to improve their analytics.\n * @param domain The domain which was caught.\n * @param apiKey @param apiKey optionally pass a Phiserman API key for making this request. This will default to {@link storedApiKey}, which can be configured through {@link setApiKey}.\n * @param guildId The id of the guild in which the domain was caught.\n * @since 1.1.0\n */\nexport function reportCaughtPhish(domain: string, apiKey: string = storedApiKey, guildId: string | number = '') {\n\treturn fetch<PhishermanReportType>(\n\t\t`https://api.phisherman.gg/v2/phish/caught/${domain}`,\n\t\t{\n\t\t\tmethod: FetchMethods.Post,\n\t\t\theaders: {\n\t\t\t\t'Content-Type': 'application/json',\n\t\t\t\t'User-Agent': agent,\n\t\t\t\tAuthorization: `Bearer ${apiKey}`\n\t\t\t},\n\t\t\tbody: JSON.stringify({\n\t\t\t\tguild: Number(guildId)\n\t\t\t})\n\t\t},\n\t\tFetchResultTypes.JSON\n\t);\n}\n\n/**\n * Set the phisherman's API key.\n * @param key The API key to access the phisherman API and cache within the code of the wrapper.\n * @since 1.0.0\n */\nexport async function setApiKey(key: string) {\n\tawait checkApiKey(key);\n\tstoredApiKey = key;\n}\n\nasync function checkApiKey(apiKey: string) {\n\ttry {\n\t\tawait fetch<{ message: string; success: false }>(\n\t\t\t`https://api.phisherman.gg/v2/domains/check/verified.test.phisherman.gg`,\n\t\t\t{\n\t\t\t\theaders: {\n\t\t\t\t\t'Content-Type': 'application/json',\n\t\t\t\t\t'User-Agent': agent,\n\t\t\t\t\tAuthorization: `Bearer ${apiKey}`\n\t\t\t\t}\n\t\t\t},\n\t\t\tFetchResultTypes.JSON\n\t\t);\n\t} catch (error) {\n\t\tconst typedError = error as QueryError;\n\n\t\tif (typedError.code === 401 && typedError.toJSON().message === 'missing permissions or invalid API key') {\n\t\t\tthrow new Error('[SapphirePhisherman]: Invalid API key provided');\n\t\t}\n\n\t\tthrow error;\n\t}\n}\n\nfunction validateUrl(domain: string) {\n\tconst regexp = /[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b([-a-zA-Z0-9()@:%_\\+.~#?&//=]*)/gi;\n\tif (!domain.match(regexp)) throw new Error('[SapphirePhisherman]: Invalid domain provided');\n}\n"]}
+{"version":3,"sources":["../../src/lib/Phisherman.ts"],"names":[],"mappings":";;;;;AAKA,IAAM,cAAA,GAAyB,uBAAA;AAE/B,IAAM,KAAA,GAAQ,CAAA,oBAAA,EAAuB,cAAc,CAAA,UAAA,EAAa,EAAA,CAAG,UAAU,CAAA,CAAA,EAAI,EAAA,CAAG,OAAA,EAAS,CAAA,yEAAA,CAAA;AAI7F,IAAI,YAAA;AAQJ,eAAsB,WAAA,CAAY,MAAA,EAAgB,MAAA,GAAiB,YAAA,EAAc;AAChF,EAAA,WAAA,CAAY,MAAM,CAAA;AAClB,EAAA,MAAM,SAAS,MAAM,KAAA;AAAA,IACpB,8CAA8C,MAAM,CAAA,CAAA;AAAA,IACpD;AAAA,MACC,OAAA,EAAS;AAAA,QACR,cAAA,EAAgB,kBAAA;AAAA,QAChB,YAAA,EAAc,KAAA;AAAA,QACd,aAAA,EAAe,UAAU,MAAM,CAAA;AAAA;AAChC,KACD;AAAA,IACA,gBAAA,CAAiB;AAAA,GAClB;AAEA,EAAA,OAAO;AAAA,IACN,GAAG,MAAA;AAAA,IACH,QAAQ,MAAA,CAAO,cAAA,KAAmB,UAAU,MAAA,CAAO,cAAA,KAAmB,YAAY,KAAA,GAAQ;AAAA,GAC3F;AACD;AAlBsB,MAAA,CAAA,WAAA,EAAA,aAAA,CAAA;AA0Bf,SAAS,YAAA,CAAa,MAAA,EAAgB,MAAA,GAAiB,YAAA,EAAc;AAC3E,EAAA,WAAA,CAAY,MAAM,CAAA;AAClB,EAAA,OAAO,KAAA;AAAA,IACN,CAAA,yCAAA,CAAA;AAAA,IACA;AAAA,MACC,QAAQ,YAAA,CAAa,GAAA;AAAA,MACrB,OAAA,EAAS;AAAA,QACR,cAAA,EAAgB,kBAAA;AAAA,QAChB,YAAA,EAAc,KAAA;AAAA,QACd,aAAA,EAAe,UAAU,MAAM,CAAA;AAAA,OAChC;AAAA,MACA,IAAA,EAAM,KAAK,SAAA,CAAU;AAAA,QACpB,GAAA,EAAK;AAAA,OACL;AAAA,KACF;AAAA,IACA,gBAAA,CAAiB;AAAA,GAClB;AACD;AAjBgB,MAAA,CAAA,YAAA,EAAA,cAAA,CAAA;AAyBhB,eAAsB,aAAA,CAAc,MAAA,EAAgB,MAAA,GAAiB,YAAA,EAAc;AAClF,EAAA,WAAA,CAAY,MAAM,CAAA;AAClB,EAAA,MAAM,SAAS,MAAM,KAAA;AAAA,IACpB,6CAA6C,MAAM,CAAA,CAAA;AAAA,IACnD;AAAA,MACC,OAAA,EAAS;AAAA,QACR,cAAA,EAAgB,kBAAA;AAAA,QAChB,YAAA,EAAc,KAAA;AAAA,QACd,aAAA,EAAe,UAAU,MAAM,CAAA;AAAA;AAChC,KACD;AAAA,IACA,gBAAA,CAAiB;AAAA,GAClB;AACA,EAAA,OAAO,OAAO,MAAM,CAAA;AACrB;AAdsB,MAAA,CAAA,aAAA,EAAA,eAAA,CAAA;AAuBf,SAAS,iBAAA,CAAkB,MAAA,EAAgB,MAAA,GAAiB,YAAA,EAAc,UAA2B,EAAA,EAAI;AAC/G,EAAA,OAAO,KAAA;AAAA,IACN,6CAA6C,MAAM,CAAA,CAAA;AAAA,IACnD;AAAA,MACC,QAAQ,YAAA,CAAa,IAAA;AAAA,MACrB,OAAA,EAAS;AAAA,QACR,cAAA,EAAgB,kBAAA;AAAA,QAChB,YAAA,EAAc,KAAA;AAAA,QACd,aAAA,EAAe,UAAU,MAAM,CAAA;AAAA,OAChC;AAAA,MACA,IAAA,EAAM,KAAK,SAAA,CAAU;AAAA,QACpB,KAAA,EAAO,OAAO,OAAO;AAAA,OACrB;AAAA,KACF;AAAA,IACA,gBAAA,CAAiB;AAAA,GAClB;AACD;AAhBgB,MAAA,CAAA,iBAAA,EAAA,mBAAA,CAAA;AAuBhB,eAAsB,UAAU,GAAA,EAAa;AAC5C,EAAA,MAAM,YAAY,GAAG,CAAA;AACrB,EAAA,YAAA,GAAe,GAAA;AAChB;AAHsB,MAAA,CAAA,SAAA,EAAA,WAAA,CAAA;AAKtB,eAAe,YAAY,MAAA,EAAgB;AAC1C,EAAA,IAAI;AACH,IAAA,MAAM,KAAA;AAAA,MACL,CAAA,sEAAA,CAAA;AAAA,MACA;AAAA,QACC,OAAA,EAAS;AAAA,UACR,cAAA,EAAgB,kBAAA;AAAA,UAChB,YAAA,EAAc,KAAA;AAAA,UACd,aAAA,EAAe,UAAU,MAAM,CAAA;AAAA;AAChC,OACD;AAAA,MACA,gBAAA,CAAiB;AAAA,KAClB;AAAA,EACD,SAAS,KAAA,EAAO;AACf,IAAA,MAAM,UAAA,GAAa,KAAA;AAEnB,IAAA,IAAI,WAAW,IAAA,KAAS,GAAA,IAAO,WAAW,MAAA,EAAO,CAAE,YAAY,wCAAA,EAA0C;AACxG,MAAA,MAAM,IAAI,MAAM,gDAAgD,CAAA;AAAA,IACjE;AAEA,IAAA,MAAM,KAAA;AAAA,EACP;AACD;AAtBe,MAAA,CAAA,WAAA,EAAA,aAAA,CAAA;AAwBf,SAAS,YAAY,MAAA,EAAgB;AACpC,EAAA,MAAM,MAAA,GAAS,sFAAA;AACf,EAAA,IAAI,CAAC,OAAO,KAAA,CAAM,MAAM,GAAG,MAAM,IAAI,MAAM,+CAA+C,CAAA;AAC3F;AAHS,MAAA,CAAA,WAAA,EAAA,aAAA,CAAA","file":"index.mjs","sourcesContent":["import { fetch, FetchMethods, FetchResultTypes, QueryError } from '@sapphire/fetch';\nimport type { PhishermanInfoType, PhishermanReportType, PhishermanReturnType } from './PhishermanTypes';\nimport os from 'node:os';\n\n// eslint-disable-next-line @typescript-eslint/no-inferrable-types\nconst packageVersion: string = '3.0.0-pr-935.7da5c8bb';\n\nconst agent = `Sapphire Phisherman/${packageVersion} (undici) ${os.platform()}/${os.release()} (https://github.com/sapphiredev/utilities/tree/main/packages/phisherman)`;\n/**\n * The cached apiKey which was created using {@link setApiKey}\n */\nlet storedApiKey: string;\n\n/**\n * Checks if a link is detected as a scam or phishing link by phisherman.\n * @param domain The domain to check.\n * @param apiKey optionally pass a Phiserman API key for making this request. This will default to {@link storedApiKey}, which can be configured through {@link setApiKey}.\n * @since 1.0.0\n */\nexport async function checkDomain(domain: string, apiKey: string = storedApiKey) {\n\tvalidateUrl(domain);\n\tconst result = await fetch<PhishermanReturnType>(\n\t\t`https://api.phisherman.gg/v2/domains/check/${domain}`,\n\t\t{\n\t\t\theaders: {\n\t\t\t\t'Content-Type': 'application/json',\n\t\t\t\t'User-Agent': agent,\n\t\t\t\tAuthorization: `Bearer ${apiKey}`\n\t\t\t}\n\t\t},\n\t\tFetchResultTypes.JSON\n\t);\n\n\treturn {\n\t\t...result,\n\t\tisScam: result.classification === 'safe' || result.classification === 'unknown' ? false : true\n\t};\n}\n\n/**\n * Report a domain that is confirmed to be a scam or phishing domain to phisherman, to enhance their API.\n * @param domain The domain to report.\n * @param apiKey optionally pass a Phiserman API key for making this request. This will default to {@link storedApiKey}, which can be configured through {@link setApiKey}.\n * @since 1.0.0\n */\nexport function reportDomain(domain: string, apiKey: string = storedApiKey) {\n\tvalidateUrl(domain);\n\treturn fetch<PhishermanReportType>(\n\t\t`https://api.phisherman.gg/v2/phish/report`,\n\t\t{\n\t\t\tmethod: FetchMethods.Put,\n\t\t\theaders: {\n\t\t\t\t'Content-Type': 'application/json',\n\t\t\t\t'User-Agent': agent,\n\t\t\t\tAuthorization: `Bearer ${apiKey}`\n\t\t\t},\n\t\t\tbody: JSON.stringify({\n\t\t\t\turl: domain\n\t\t\t})\n\t\t},\n\t\tFetchResultTypes.JSON\n\t);\n}\n\n/**\n * Returns information for a domain.\n * @param domain The domain to get info about.\n * @param apiKey optionally pass a Phiserman API key for making this request. This will default to {@link storedApiKey}, which can be configured through {@link setApiKey}.\n * @since 1.1.0\n */\nexport async function getDomainInfo(domain: string, apiKey: string = storedApiKey) {\n\tvalidateUrl(domain);\n\tconst result = await fetch<PhishermanInfoType>(\n\t\t`https://api.phisherman.gg/v2/domains/info/${domain}`,\n\t\t{\n\t\t\theaders: {\n\t\t\t\t'Content-Type': 'application/json',\n\t\t\t\t'User-Agent': agent,\n\t\t\t\tAuthorization: `Bearer ${apiKey}`\n\t\t\t}\n\t\t},\n\t\tFetchResultTypes.JSON\n\t);\n\treturn result[domain];\n}\n\n/**\n * Report a caught phish back to phisherman to improve their analytics.\n * @param domain The domain which was caught.\n * @param apiKey @param apiKey optionally pass a Phiserman API key for making this request. This will default to {@link storedApiKey}, which can be configured through {@link setApiKey}.\n * @param guildId The id of the guild in which the domain was caught.\n * @since 1.1.0\n */\nexport function reportCaughtPhish(domain: string, apiKey: string = storedApiKey, guildId: string | number = '') {\n\treturn fetch<PhishermanReportType>(\n\t\t`https://api.phisherman.gg/v2/phish/caught/${domain}`,\n\t\t{\n\t\t\tmethod: FetchMethods.Post,\n\t\t\theaders: {\n\t\t\t\t'Content-Type': 'application/json',\n\t\t\t\t'User-Agent': agent,\n\t\t\t\tAuthorization: `Bearer ${apiKey}`\n\t\t\t},\n\t\t\tbody: JSON.stringify({\n\t\t\t\tguild: Number(guildId)\n\t\t\t})\n\t\t},\n\t\tFetchResultTypes.JSON\n\t);\n}\n\n/**\n * Set the phisherman's API key.\n * @param key The API key to access the phisherman API and cache within the code of the wrapper.\n * @since 1.0.0\n */\nexport async function setApiKey(key: string) {\n\tawait checkApiKey(key);\n\tstoredApiKey = key;\n}\n\nasync function checkApiKey(apiKey: string) {\n\ttry {\n\t\tawait fetch<{ message: string; success: false }>(\n\t\t\t`https://api.phisherman.gg/v2/domains/check/verified.test.phisherman.gg`,\n\t\t\t{\n\t\t\t\theaders: {\n\t\t\t\t\t'Content-Type': 'application/json',\n\t\t\t\t\t'User-Agent': agent,\n\t\t\t\t\tAuthorization: `Bearer ${apiKey}`\n\t\t\t\t}\n\t\t\t},\n\t\t\tFetchResultTypes.JSON\n\t\t);\n\t} catch (error) {\n\t\tconst typedError = error as QueryError;\n\n\t\tif (typedError.code === 401 && typedError.toJSON().message === 'missing permissions or invalid API key') {\n\t\t\tthrow new Error('[SapphirePhisherman]: Invalid API key provided');\n\t\t}\n\n\t\tthrow error;\n\t}\n}\n\nfunction validateUrl(domain: string) {\n\tconst regexp = /[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b([-a-zA-Z0-9()@:%_\\+.~#?&//=]*)/gi;\n\tif (!domain.match(regexp)) throw new Error('[SapphirePhisherman]: Invalid domain provided');\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapphire/phisherman",
-  "version": "2.0.2-pr-725.25672a58.0",
+  "version": "3.0.0-pr-935.7da5c8bb",
   "description": "Wrapper around phisherman to easily check and report domains",
   "author": "@sapphire",
   "license": "MIT",
@@ -20,15 +20,16 @@
   "homepage": "https://github.com/sapphiredev/utilities/tree/main/packages/phisherman",
   "scripts": {
     "lint": "eslint src --ext ts --fix",
-    "build": "tsup && yarn build:rename-cjs-index",
-    "build:rename-cjs-index": "node ../../scripts/rename-cjs-index.mjs",
+    "build": "yarn gen-index && tsup && yarn build:rename-cjs-index",
+    "build:rename-cjs-index": "tsx ../../scripts/rename-cjs-index.cts",
     "docs": "typedoc-json-parser",
     "prepack": "yarn build",
     "bump": "cliff-jumper",
-    "check-update": "cliff-jumper --dry-run"
+    "check-update": "cliff-jumper --dry-run",
+    "gen-index": "tsx ../../scripts/gen-index.cts phisherman --write"
   },
   "dependencies": {
-    "@sapphire/fetch": "^3.0.2"
+    "@sapphire/fetch": "^3.0.5"
   },
   "repository": {
     "type": "git",
@@ -60,12 +61,13 @@
     "access": "public"
   },
   "devDependencies": {
-    "@favware/cliff-jumper": "^3.0.1",
-    "@sapphire/result": "^2.6.6",
+    "@favware/cliff-jumper": "^6.0.0",
+    "@sapphire/result": "^2.7.3",
     "esbuild-plugin-version-injector": "^1.2.1",
-    "tsup": "^8.0.2",
-    "typedoc": "^0.25.12",
-    "typedoc-json-parser": "^9.0.1",
-    "typescript": "^5.4.2"
+    "tsup": "^8.5.0",
+    "tsx": "^4.20.6",
+    "typedoc": "^0.26.11",
+    "typedoc-json-parser": "^10.2.0",
+    "typescript": "~5.4.5"
   }
 }