@sapphire/phisherman 2.0.2-next.8aee4b20 → 2.0.2-next.8bfb0191
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/index.cjs +2 -2
- package/dist/cjs/index.cjs.map +1 -1
- package/dist/esm/index.mjs +2 -2
- package/dist/esm/index.mjs.map +1 -1
- package/package.json +4 -4
package/dist/cjs/index.cjs
CHANGED
|
@@ -9,7 +9,7 @@ var os__default = /*#__PURE__*/_interopDefault(os);
|
|
|
9
9
|
|
|
10
10
|
var __defProp = Object.defineProperty;
|
|
11
11
|
var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
|
|
12
|
-
var packageVersion = "2.0.2-next.
|
|
12
|
+
var packageVersion = "2.0.2-next.8bfb0191";
|
|
13
13
|
var agent = `Sapphire Phisherman/${packageVersion} (undici) ${os__default.default.platform()}/${os__default.default.release()} (https://github.com/sapphiredev/utilities/tree/main/packages/phisherman)`;
|
|
14
14
|
var storedApiKey;
|
|
15
15
|
async function checkDomain(domain, apiKey = storedApiKey) {
|
|
@@ -122,5 +122,5 @@ exports.getDomainInfo = getDomainInfo;
|
|
|
122
122
|
exports.reportCaughtPhish = reportCaughtPhish;
|
|
123
123
|
exports.reportDomain = reportDomain;
|
|
124
124
|
exports.setApiKey = setApiKey;
|
|
125
|
-
//# sourceMappingURL=
|
|
125
|
+
//# sourceMappingURL=index.cjs.map
|
|
126
126
|
//# sourceMappingURL=index.cjs.map
|
package/dist/cjs/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/lib/Phisherman.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"sources":["../../src/lib/Phisherman.ts"],"names":["os","fetch","FetchResultTypes","FetchMethods"],"mappings":";;;;;;;;;;;AAKA,IAAM,cAAyB,GAAA,qBAAA,CAAA;AAE/B,IAAM,KAAA,GAAQ,CAAuB,oBAAA,EAAA,cAAc,CAAa,UAAA,EAAAA,mBAAA,CAAG,UAAU,CAAA,CAAA,EAAIA,mBAAG,CAAA,OAAA,EAAS,CAAA,yEAAA,CAAA,CAAA;AAI7F,IAAI,YAAA,CAAA;AAQJ,eAAsB,WAAA,CAAY,MAAgB,EAAA,MAAA,GAAiB,YAAc,EAAA;AAChF,EAAA,WAAA,CAAY,MAAM,CAAA,CAAA;AAClB,EAAA,MAAM,SAAS,MAAMC,WAAA;AAAA,IACpB,8CAA8C,MAAM,CAAA,CAAA;AAAA,IACpD;AAAA,MACC,OAAS,EAAA;AAAA,QACR,cAAgB,EAAA,kBAAA;AAAA,QAChB,YAAc,EAAA,KAAA;AAAA,QACd,aAAA,EAAe,UAAU,MAAM,CAAA,CAAA;AAAA,OAChC;AAAA,KACD;AAAA,IACAC,sBAAiB,CAAA,IAAA;AAAA,GAClB,CAAA;AAEA,EAAO,OAAA;AAAA,IACN,GAAG,MAAA;AAAA,IACH,QAAQ,MAAO,CAAA,cAAA,KAAmB,UAAU,MAAO,CAAA,cAAA,KAAmB,YAAY,KAAQ,GAAA,IAAA;AAAA,GAC3F,CAAA;AACD,CAAA;AAlBsB,MAAA,CAAA,WAAA,EAAA,aAAA,CAAA,CAAA;AA0Bf,SAAS,YAAA,CAAa,MAAgB,EAAA,MAAA,GAAiB,YAAc,EAAA;AAC3E,EAAA,WAAA,CAAY,MAAM,CAAA,CAAA;AAClB,EAAO,OAAAD,WAAA;AAAA,IACN,CAAA,yCAAA,CAAA;AAAA,IACA;AAAA,MACC,QAAQE,kBAAa,CAAA,GAAA;AAAA,MACrB,OAAS,EAAA;AAAA,QACR,cAAgB,EAAA,kBAAA;AAAA,QAChB,YAAc,EAAA,KAAA;AAAA,QACd,aAAA,EAAe,UAAU,MAAM,CAAA,CAAA;AAAA,OAChC;AAAA,MACA,IAAA,EAAM,KAAK,SAAU,CAAA;AAAA,QACpB,GAAK,EAAA,MAAA;AAAA,OACL,CAAA;AAAA,KACF;AAAA,IACAD,sBAAiB,CAAA,IAAA;AAAA,GAClB,CAAA;AACD,CAAA;AAjBgB,MAAA,CAAA,YAAA,EAAA,cAAA,CAAA,CAAA;AAyBhB,eAAsB,aAAA,CAAc,MAAgB,EAAA,MAAA,GAAiB,YAAc,EAAA;AAClF,EAAA,WAAA,CAAY,MAAM,CAAA,CAAA;AAClB,EAAA,MAAM,SAAS,MAAMD,WAAA;AAAA,IACpB,6CAA6C,MAAM,CAAA,CAAA;AAAA,IACnD;AAAA,MACC,OAAS,EAAA;AAAA,QACR,cAAgB,EAAA,kBAAA;AAAA,QAChB,YAAc,EAAA,KAAA;AAAA,QACd,aAAA,EAAe,UAAU,MAAM,CAAA,CAAA;AAAA,OAChC;AAAA,KACD;AAAA,IACAC,sBAAiB,CAAA,IAAA;AAAA,GAClB,CAAA;AACA,EAAA,OAAO,OAAO,MAAM,CAAA,CAAA;AACrB,CAAA;AAdsB,MAAA,CAAA,aAAA,EAAA,eAAA,CAAA,CAAA;AAuBf,SAAS,iBAAkB,CAAA,MAAA,EAAgB,MAAiB,GAAA,YAAA,EAAc,UAA2B,EAAI,EAAA;AAC/G,EAAO,OAAAD,WAAA;AAAA,IACN,6CAA6C,MAAM,CAAA,CAAA;AAAA,IACnD;AAAA,MACC,QAAQE,kBAAa,CAAA,IAAA;AAAA,MACrB,OAAS,EAAA;AAAA,QACR,cAAgB,EAAA,kBAAA;AAAA,QAChB,YAAc,EAAA,KAAA;AAAA,QACd,aAAA,EAAe,UAAU,MAAM,CAAA,CAAA;AAAA,OAChC;AAAA,MACA,IAAA,EAAM,KAAK,SAAU,CAAA;AAAA,QACpB,KAAA,EAAO,OAAO,OAAO,CAAA;AAAA,OACrB,CAAA;AAAA,KACF;AAAA,IACAD,sBAAiB,CAAA,IAAA;AAAA,GAClB,CAAA;AACD,CAAA;AAhBgB,MAAA,CAAA,iBAAA,EAAA,mBAAA,CAAA,CAAA;AAuBhB,eAAsB,UAAU,GAAa,EAAA;AAC5C,EAAA,MAAM,YAAY,GAAG,CAAA,CAAA;AACrB,EAAe,YAAA,GAAA,GAAA,CAAA;AAChB,CAAA;AAHsB,MAAA,CAAA,SAAA,EAAA,WAAA,CAAA,CAAA;AAKtB,eAAe,YAAY,MAAgB,EAAA;AAC1C,EAAI,IAAA;AACH,IAAM,MAAAD,WAAA;AAAA,MACL,CAAA,sEAAA,CAAA;AAAA,MACA;AAAA,QACC,OAAS,EAAA;AAAA,UACR,cAAgB,EAAA,kBAAA;AAAA,UAChB,YAAc,EAAA,KAAA;AAAA,UACd,aAAA,EAAe,UAAU,MAAM,CAAA,CAAA;AAAA,SAChC;AAAA,OACD;AAAA,MACAC,sBAAiB,CAAA,IAAA;AAAA,KAClB,CAAA;AAAA,WACQ,KAAO,EAAA;AACf,IAAA,MAAM,UAAa,GAAA,KAAA,CAAA;AAEnB,IAAA,IAAI,WAAW,IAAS,KAAA,GAAA,IAAO,WAAW,MAAO,EAAA,CAAE,YAAY,wCAA0C,EAAA;AACxG,MAAM,MAAA,IAAI,MAAM,gDAAgD,CAAA,CAAA;AAAA,KACjE;AAEA,IAAM,MAAA,KAAA,CAAA;AAAA,GACP;AACD,CAAA;AAtBe,MAAA,CAAA,WAAA,EAAA,aAAA,CAAA,CAAA;AAwBf,SAAS,YAAY,MAAgB,EAAA;AACpC,EAAA,MAAM,MAAS,GAAA,sFAAA,CAAA;AACf,EAAI,IAAA,CAAC,OAAO,KAAM,CAAA,MAAM,GAAS,MAAA,IAAI,MAAM,+CAA+C,CAAA,CAAA;AAC3F,CAAA;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 = '2.0.2-next.8bfb0191';\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/esm/index.mjs
CHANGED
|
@@ -3,7 +3,7 @@ import os from 'node:os';
|
|
|
3
3
|
|
|
4
4
|
var __defProp = Object.defineProperty;
|
|
5
5
|
var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
|
|
6
|
-
var packageVersion = "2.0.2-next.
|
|
6
|
+
var packageVersion = "2.0.2-next.8bfb0191";
|
|
7
7
|
var agent = `Sapphire Phisherman/${packageVersion} (undici) ${os.platform()}/${os.release()} (https://github.com/sapphiredev/utilities/tree/main/packages/phisherman)`;
|
|
8
8
|
var storedApiKey;
|
|
9
9
|
async function checkDomain(domain, apiKey = storedApiKey) {
|
|
@@ -112,5 +112,5 @@ function validateUrl(domain) {
|
|
|
112
112
|
__name(validateUrl, "validateUrl");
|
|
113
113
|
|
|
114
114
|
export { checkDomain, getDomainInfo, reportCaughtPhish, reportDomain, setApiKey };
|
|
115
|
-
//# sourceMappingURL=
|
|
115
|
+
//# sourceMappingURL=index.mjs.map
|
|
116
116
|
//# sourceMappingURL=index.mjs.map
|
package/dist/esm/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/lib/Phisherman.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"sources":["../../src/lib/Phisherman.ts"],"names":[],"mappings":";;;;;AAKA,IAAM,cAAyB,GAAA,qBAAA,CAAA;AAE/B,IAAM,KAAA,GAAQ,CAAuB,oBAAA,EAAA,cAAc,CAAa,UAAA,EAAA,EAAA,CAAG,UAAU,CAAA,CAAA,EAAI,EAAG,CAAA,OAAA,EAAS,CAAA,yEAAA,CAAA,CAAA;AAI7F,IAAI,YAAA,CAAA;AAQJ,eAAsB,WAAA,CAAY,MAAgB,EAAA,MAAA,GAAiB,YAAc,EAAA;AAChF,EAAA,WAAA,CAAY,MAAM,CAAA,CAAA;AAClB,EAAA,MAAM,SAAS,MAAM,KAAA;AAAA,IACpB,8CAA8C,MAAM,CAAA,CAAA;AAAA,IACpD;AAAA,MACC,OAAS,EAAA;AAAA,QACR,cAAgB,EAAA,kBAAA;AAAA,QAChB,YAAc,EAAA,KAAA;AAAA,QACd,aAAA,EAAe,UAAU,MAAM,CAAA,CAAA;AAAA,OAChC;AAAA,KACD;AAAA,IACA,gBAAiB,CAAA,IAAA;AAAA,GAClB,CAAA;AAEA,EAAO,OAAA;AAAA,IACN,GAAG,MAAA;AAAA,IACH,QAAQ,MAAO,CAAA,cAAA,KAAmB,UAAU,MAAO,CAAA,cAAA,KAAmB,YAAY,KAAQ,GAAA,IAAA;AAAA,GAC3F,CAAA;AACD,CAAA;AAlBsB,MAAA,CAAA,WAAA,EAAA,aAAA,CAAA,CAAA;AA0Bf,SAAS,YAAA,CAAa,MAAgB,EAAA,MAAA,GAAiB,YAAc,EAAA;AAC3E,EAAA,WAAA,CAAY,MAAM,CAAA,CAAA;AAClB,EAAO,OAAA,KAAA;AAAA,IACN,CAAA,yCAAA,CAAA;AAAA,IACA;AAAA,MACC,QAAQ,YAAa,CAAA,GAAA;AAAA,MACrB,OAAS,EAAA;AAAA,QACR,cAAgB,EAAA,kBAAA;AAAA,QAChB,YAAc,EAAA,KAAA;AAAA,QACd,aAAA,EAAe,UAAU,MAAM,CAAA,CAAA;AAAA,OAChC;AAAA,MACA,IAAA,EAAM,KAAK,SAAU,CAAA;AAAA,QACpB,GAAK,EAAA,MAAA;AAAA,OACL,CAAA;AAAA,KACF;AAAA,IACA,gBAAiB,CAAA,IAAA;AAAA,GAClB,CAAA;AACD,CAAA;AAjBgB,MAAA,CAAA,YAAA,EAAA,cAAA,CAAA,CAAA;AAyBhB,eAAsB,aAAA,CAAc,MAAgB,EAAA,MAAA,GAAiB,YAAc,EAAA;AAClF,EAAA,WAAA,CAAY,MAAM,CAAA,CAAA;AAClB,EAAA,MAAM,SAAS,MAAM,KAAA;AAAA,IACpB,6CAA6C,MAAM,CAAA,CAAA;AAAA,IACnD;AAAA,MACC,OAAS,EAAA;AAAA,QACR,cAAgB,EAAA,kBAAA;AAAA,QAChB,YAAc,EAAA,KAAA;AAAA,QACd,aAAA,EAAe,UAAU,MAAM,CAAA,CAAA;AAAA,OAChC;AAAA,KACD;AAAA,IACA,gBAAiB,CAAA,IAAA;AAAA,GAClB,CAAA;AACA,EAAA,OAAO,OAAO,MAAM,CAAA,CAAA;AACrB,CAAA;AAdsB,MAAA,CAAA,aAAA,EAAA,eAAA,CAAA,CAAA;AAuBf,SAAS,iBAAkB,CAAA,MAAA,EAAgB,MAAiB,GAAA,YAAA,EAAc,UAA2B,EAAI,EAAA;AAC/G,EAAO,OAAA,KAAA;AAAA,IACN,6CAA6C,MAAM,CAAA,CAAA;AAAA,IACnD;AAAA,MACC,QAAQ,YAAa,CAAA,IAAA;AAAA,MACrB,OAAS,EAAA;AAAA,QACR,cAAgB,EAAA,kBAAA;AAAA,QAChB,YAAc,EAAA,KAAA;AAAA,QACd,aAAA,EAAe,UAAU,MAAM,CAAA,CAAA;AAAA,OAChC;AAAA,MACA,IAAA,EAAM,KAAK,SAAU,CAAA;AAAA,QACpB,KAAA,EAAO,OAAO,OAAO,CAAA;AAAA,OACrB,CAAA;AAAA,KACF;AAAA,IACA,gBAAiB,CAAA,IAAA;AAAA,GAClB,CAAA;AACD,CAAA;AAhBgB,MAAA,CAAA,iBAAA,EAAA,mBAAA,CAAA,CAAA;AAuBhB,eAAsB,UAAU,GAAa,EAAA;AAC5C,EAAA,MAAM,YAAY,GAAG,CAAA,CAAA;AACrB,EAAe,YAAA,GAAA,GAAA,CAAA;AAChB,CAAA;AAHsB,MAAA,CAAA,SAAA,EAAA,WAAA,CAAA,CAAA;AAKtB,eAAe,YAAY,MAAgB,EAAA;AAC1C,EAAI,IAAA;AACH,IAAM,MAAA,KAAA;AAAA,MACL,CAAA,sEAAA,CAAA;AAAA,MACA;AAAA,QACC,OAAS,EAAA;AAAA,UACR,cAAgB,EAAA,kBAAA;AAAA,UAChB,YAAc,EAAA,KAAA;AAAA,UACd,aAAA,EAAe,UAAU,MAAM,CAAA,CAAA;AAAA,SAChC;AAAA,OACD;AAAA,MACA,gBAAiB,CAAA,IAAA;AAAA,KAClB,CAAA;AAAA,WACQ,KAAO,EAAA;AACf,IAAA,MAAM,UAAa,GAAA,KAAA,CAAA;AAEnB,IAAA,IAAI,WAAW,IAAS,KAAA,GAAA,IAAO,WAAW,MAAO,EAAA,CAAE,YAAY,wCAA0C,EAAA;AACxG,MAAM,MAAA,IAAI,MAAM,gDAAgD,CAAA,CAAA;AAAA,KACjE;AAEA,IAAM,MAAA,KAAA,CAAA;AAAA,GACP;AACD,CAAA;AAtBe,MAAA,CAAA,WAAA,EAAA,aAAA,CAAA,CAAA;AAwBf,SAAS,YAAY,MAAgB,EAAA;AACpC,EAAA,MAAM,MAAS,GAAA,sFAAA,CAAA;AACf,EAAI,IAAA,CAAC,OAAO,KAAM,CAAA,MAAM,GAAS,MAAA,IAAI,MAAM,+CAA+C,CAAA,CAAA;AAC3F,CAAA;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 = '2.0.2-next.8bfb0191';\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
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sapphire/phisherman",
|
|
3
|
-
"version": "2.0.2-next.
|
|
3
|
+
"version": "2.0.2-next.8bfb0191",
|
|
4
4
|
"description": "Wrapper around phisherman to easily check and report domains",
|
|
5
5
|
"author": "@sapphire",
|
|
6
6
|
"license": "MIT",
|
|
@@ -61,11 +61,11 @@
|
|
|
61
61
|
"access": "public"
|
|
62
62
|
},
|
|
63
63
|
"devDependencies": {
|
|
64
|
-
"@favware/cliff-jumper": "^4.0.
|
|
64
|
+
"@favware/cliff-jumper": "^4.0.3",
|
|
65
65
|
"@sapphire/result": "^2.6.6",
|
|
66
66
|
"esbuild-plugin-version-injector": "^1.2.1",
|
|
67
|
-
"tsup": "^8.
|
|
68
|
-
"tsx": "^4.
|
|
67
|
+
"tsup": "^8.2.4",
|
|
68
|
+
"tsx": "^4.17.0",
|
|
69
69
|
"typedoc": "^0.25.13",
|
|
70
70
|
"typedoc-json-parser": "^10.0.0",
|
|
71
71
|
"typescript": "~5.4.5"
|