@sapphire/phisherman 0.1.0-next.68fba03.0

package/LICENSE.md

@@ -0,0 +1,24 @@
+# The MIT License (MIT)
+
+Copyright © `2020` `The Sapphire Community and its contributors`
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the “Software”), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,126 @@
+<div align="center">
+
+![Sapphire Logo](https://cdn.skyra.pw/gh-assets/sapphire-banner.png)
+
+# @sapphire/phisherman
+
+**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)
+
+</div>
+
+## Description
+
+With @sapphire/phisherman, you can have an out of the box integration with [Phisherman](https://phisherman.gg). Phisherman is a centralised database of phishing and scam links. It is designed for use with Discord bots, allowing them to utilise the Phisherman API to cross-check URLs against our known phishing links.
+
+Note: Phisherman is currently in early access. For more information or to request access, please visit their [discord server](https://discord.gg/QwrpmTgvWy).
+
+## Features
+
+-   Fully ready for TypeScript!
+-   Includes ESM ready entrypoint
+-   Easy to use
+
+## Installation
+
+You can use the following command to install this package, or replace `npm install` with your package manager of choice.
+
+```sh
+npm install @sapphire/phisherman
+```
+
+---
+
+## Usage
+
+**Note:** While this section uses `import`, it maps 1:1 with CommonJS' require syntax. For example, `import { check } from '@sapphire/phisherman'` is the same as `const { checkDomain } = require('@sapphire/phisherman')`.
+
+Before you do anything make sure to set the apiKey like this:
+
+```typescript
+import { setApiKey } from '@sapphire/phisherman';
+
+setApiKey('your-api-key');
+```
+
+The main use you will have for phisherman is checking whether an URL is safe or not. You can do so with:
+
+```typescript
+import { checkDomain } from '@sapphire/phisherman';
+
+checkDomain('some-domain');
+```
+
+If you have an URL that didn't pass the check, but you are sure is actually a phishing site, you can use the following to report it to phisherman:
+
+```typescript
+import { reportDomain } from '@sapphire/phisherman';
+
+reportDomain('some-domain');
+```
+
+## Buy us some doughnuts
+
+Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!
+
+We accept donations through Open Collective, Ko-fi, Paypal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.
+
+|   Donate With   |                       Address                       |
+| :-------------: | :-------------------------------------------------: |
+| Open Collective | [Click Here](https://sapphirejs.dev/opencollective) |
+|      Ko-fi      |      [Click Here](https://sapphirejs.dev/kofi)      |
+|     Patreon     |    [Click Here](https://sapphirejs.dev/patreon)     |
+|     PayPal      |     [Click Here](https://sapphirejs.dev/paypal)     |
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center"><a href="https://favware.tech/"><img src="https://avatars3.githubusercontent.com/u/4019718?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jeroen Claassens</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=favna" title="Code">💻</a> <a href="#infra-favna" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#projectManagement-favna" title="Project Management">📆</a> <a href="https://github.com/sapphiredev/utilities/commits?author=favna" title="Documentation">📖</a> <a href="https://github.com/sapphiredev/utilities/commits?author=favna" title="Tests">⚠️</a></td>
+    <td align="center"><a href="https://github.com/kyranet"><img src="https://avatars0.githubusercontent.com/u/24852502?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Antonio Román</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=kyranet" title="Code">💻</a> <a href="#projectManagement-kyranet" title="Project Management">📆</a> <a href="https://github.com/sapphiredev/utilities/pulls?q=is%3Apr+reviewed-by%3Akyranet" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/sapphiredev/utilities/commits?author=kyranet" title="Tests">⚠️</a></td>
+    <td align="center"><a href="https://github.com/PyroTechniac"><img src="https://avatars2.githubusercontent.com/u/39341355?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Gryffon Bellish</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=PyroTechniac" title="Code">💻</a> <a href="https://github.com/sapphiredev/utilities/pulls?q=is%3Apr+reviewed-by%3APyroTechniac" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/sapphiredev/utilities/commits?author=PyroTechniac" title="Tests">⚠️</a></td>
+    <td align="center"><a href="https://github.com/vladfrangu"><img src="https://avatars3.githubusercontent.com/u/17960496?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Vlad Frangu</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=vladfrangu" title="Code">💻</a> <a href="https://github.com/sapphiredev/utilities/issues?q=author%3Avladfrangu" title="Bug reports">🐛</a> <a href="https://github.com/sapphiredev/utilities/pulls?q=is%3Apr+reviewed-by%3Avladfrangu" title="Reviewed Pull Requests">👀</a> <a href="#userTesting-vladfrangu" title="User Testing">📓</a> <a href="https://github.com/sapphiredev/utilities/commits?author=vladfrangu" title="Tests">⚠️</a></td>
+    <td align="center"><a href="https://github.com/Stitch07"><img src="https://avatars0.githubusercontent.com/u/29275227?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Stitch07</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=Stitch07" title="Code">💻</a> <a href="#projectManagement-Stitch07" title="Project Management">📆</a> <a href="https://github.com/sapphiredev/utilities/commits?author=Stitch07" title="Tests">⚠️</a></td>
+    <td align="center"><a href="https://github.com/apps/depfu"><img src="https://avatars3.githubusercontent.com/in/715?v=4?s=100" width="100px;" alt=""/><br /><sub><b>depfu[bot]</b></sub></a><br /><a href="#maintenance-depfu[bot]" title="Maintenance">🚧</a></td>
+    <td align="center"><a href="https://github.com/apps/allcontributors"><img src="https://avatars0.githubusercontent.com/in/23186?v=4?s=100" width="100px;" alt=""/><br /><sub><b>allcontributors[bot]</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=allcontributors[bot]" title="Documentation">📖</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/Nytelife26"><img src="https://avatars1.githubusercontent.com/u/22531310?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Tyler J Russell</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=Nytelife26" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/Alcremie"><img src="https://avatars0.githubusercontent.com/u/54785334?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ivan Lieder</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=Alcremie" title="Code">💻</a> <a href="https://github.com/sapphiredev/utilities/issues?q=author%3AAlcremie" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://github.com/RealShadowNova"><img src="https://avatars3.githubusercontent.com/u/46537907?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Hezekiah Hendry</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=RealShadowNova" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/Vetlix"><img src="https://avatars.githubusercontent.com/u/31412314?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Vetlix</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=Vetlix" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/ethamitc"><img src="https://avatars.githubusercontent.com/u/27776796?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ethan Mitchell</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=ethamitc" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/noftaly"><img src="https://avatars.githubusercontent.com/u/34779161?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Elliot</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=noftaly" title="Code">💻</a></td>
+    <td align="center"><a href="https://jurien.dev"><img src="https://avatars.githubusercontent.com/u/5418114?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jurien Hamaker</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=jurienhamaker" title="Code">💻</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://fanoulis.dev/"><img src="https://avatars.githubusercontent.com/u/38255093?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Charalampos Fanoulis</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=cfanoulis" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/apps/dependabot"><img src="https://avatars.githubusercontent.com/in/29110?v=4?s=100" width="100px;" alt=""/><br /><sub><b>dependabot[bot]</b></sub></a><br /><a href="#maintenance-dependabot[bot]" title="Maintenance">🚧</a></td>
+    <td align="center"><a href="https://kaname.netlify.app/"><img src="https://avatars.githubusercontent.com/u/56084970?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Kaname</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=kaname-png" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/nandhagk"><img src="https://avatars.githubusercontent.com/u/62976649?v=4?s=100" width="100px;" alt=""/><br /><sub><b>nandhagk</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/issues?q=author%3Anandhagk" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://megatank58.me/"><img src="https://avatars.githubusercontent.com/u/51410502?v=4?s=100" width="100px;" alt=""/><br /><sub><b>megatank58</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=megatank58" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/UndiedGamer"><img src="https://avatars.githubusercontent.com/u/84702365?v=4?s=100" width="100px;" alt=""/><br /><sub><b>UndiedGamer</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=UndiedGamer" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/Lioness100"><img src="https://avatars.githubusercontent.com/u/65814829?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Lioness100</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=Lioness100" title="Documentation">📖</a> <a href="https://github.com/sapphiredev/utilities/commits?author=Lioness100" title="Code">💻</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://gitlab.com/DavidPH/"><img src="https://avatars.githubusercontent.com/u/44669930?v=4?s=100" width="100px;" alt=""/><br /><sub><b>David</b></sub></a><br /><a href="https://github.com/sapphiredev/utilities/commits?author=DavidPHH" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/apps/renovate"><img src="https://avatars.githubusercontent.com/in/2740?v=4?s=100" width="100px;" alt=""/><br /><sub><b>renovate[bot]</b></sub></a><br /><a href="#maintenance-renovate[bot]" title="Maintenance">🚧</a></td>
+    <td align="center"><a href="https://renovate.whitesourcesoftware.com/"><img src="https://avatars.githubusercontent.com/u/25180681?v=4?s=100" width="100px;" alt=""/><br /><sub><b>WhiteSource Renovate</b></sub></a><br /><a href="#maintenance-renovate-bot" title="Maintenance">🚧</a></td>
+  </tr>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './lib/Phisherman';
+export type { CheckReturnType, PhishermanOptions, PhishermanReportType, PhishermanReturnType } from './lib/PhishermanTypes';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,YAAY,EAAE,eAAe,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC"}

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+(0, tslib_1.__exportStar)(require("./lib/Phisherman"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,gEAAiC"}

package/dist/index.mjs

@@ -0,0 +1,6 @@
+import mod from "./index.js";
+
+export default mod;
+export const checkDomain = mod.checkDomain;
+export const reportDomain = mod.reportDomain;
+export const setApiKey = mod.setApiKey;

package/dist/lib/Phisherman.d.ts

@@ -0,0 +1,26 @@
+import type { PhishermanReportType } from './PhishermanTypes';
+/**
+ * Checks if a link is detected as a scam or phishing link by phisherman.
+ * @param domain The domain to check.
+ * @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}.
+ * @since 1.0.0
+ */
+export declare function checkDomain(domain: string, apiKey?: string): Promise<{
+    isScam: boolean;
+    verifiedPhish: boolean;
+    classification: "malicious" | "suspicious" | "safe" | "unknown";
+}>;
+/**
+ * Report a domain that is confirmed to be a scam or phishing domain to phisherman, to enhance their API.
+ * @param domain The domain to report.
+ * @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}.
+ * @since 1.0.0
+ */
+export declare function reportDomain(domain: string, apiKey?: string): Promise<PhishermanReportType>;
+/**
+ * Set the phisherman's API key.
+ * @param key The API key to access the phisherman API and cache within the code of the wrapper.
+ * @since 1.0.0
+ */
+export declare function setApiKey(key: string): Promise<void>;
+//# sourceMappingURL=Phisherman.d.ts.map

package/dist/lib/Phisherman.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Phisherman.d.ts","sourceRoot":"","sources":["../../src/lib/Phisherman.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,oBAAoB,EAAwB,MAAM,mBAAmB,CAAC;AAKpF;;;;;GAKG;AACH,wBAAsB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,GAAE,MAAqB;;;;GAiB9E;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,GAAE,MAAqB,iCAgBzE;AAED;;;;GAIG;AACH,wBAAsB,SAAS,CAAC,GAAG,EAAE,MAAM,iBAG1C"}

package/dist/lib/Phisherman.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setApiKey = exports.reportDomain = exports.checkDomain = void 0;
+const tslib_1 = require("tslib");
+const fetch_1 = require("@sapphire/fetch");
+const node_os_1 = (0, tslib_1.__importDefault)(require("node:os"));
+let storedApiKey;
+/**
+ * Checks if a link is detected as a scam or phishing link by phisherman.
+ * @param domain The domain to check.
+ * @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}.
+ * @since 1.0.0
+ */
+async function checkDomain(domain, apiKey = storedApiKey) {
+    const result = await (0, fetch_1.fetch)(`https://api.phisherman.gg/v2/domains/check/${domain}`, {
+        headers: {
+            'Content-Type': 'application/json',
+            'User-Agent': `Sapphire Phisherman/1.0.0 (node-fetch) ${node_os_1.default.platform()}/${node_os_1.default.release()} (https://github.com/sapphiredev/utilities/tree/main/packages/phisherman)`,
+            Authorization: `Bearer ${apiKey}`
+        }
+    }, "json" /* JSON */);
+    return {
+        ...result,
+        isScam: result.classification === 'safe' || result.classification === 'unknown' ? false : true
+    };
+}
+exports.checkDomain = checkDomain;
+/**
+ * Report a domain that is confirmed to be a scam or phishing domain to phisherman, to enhance their API.
+ * @param domain The domain to report.
+ * @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}.
+ * @since 1.0.0
+ */
+function reportDomain(domain, apiKey = storedApiKey) {
+    return (0, fetch_1.fetch)(`https://api.phisherman.gg/v2/phish/report`, {
+        method: "PUT" /* Put */,
+        headers: {
+            'Content-Type': 'application/json',
+            'User-Agent': `Sapphire Phisherman/1.0.0 (node-fetch) ${node_os_1.default.platform()}/${node_os_1.default.release()} (https://github.com/sapphiredev/utilities/tree/main/packages/phisherman)`,
+            Authorization: `Bearer ${apiKey}`
+        },
+        body: JSON.stringify({
+            url: domain
+        })
+    }, "json" /* JSON */);
+}
+exports.reportDomain = reportDomain;
+/**
+ * Set the phisherman's API key.
+ * @param key The API key to access the phisherman API and cache within the code of the wrapper.
+ * @since 1.0.0
+ */
+async function setApiKey(key) {
+    await checkApiKey(key);
+    storedApiKey = key;
+}
+exports.setApiKey = setApiKey;
+async function checkApiKey(apiKey) {
+    try {
+        await (0, fetch_1.fetch)(`https://api.phisherman.gg/v2/domains/check/verified.test.phisherman.gg`, {
+            headers: {
+                'Content-Type': 'application/json',
+                'User-Agent': `Sapphire Phisherman/1.0.0 (node-fetch) ${node_os_1.default.platform()}/${node_os_1.default.release()} (https://github.com/sapphiredev/utilities/tree/main/packages/phisherman)`,
+                Authorization: `Bearer ${apiKey}`
+            }
+        }, "json" /* JSON */);
+    }
+    catch (error) {
+        const typedError = error;
+        if (typedError.code === 401 && typedError.toJSON().message === 'missing permissions or invalid API key') {
+            throw new Error('[SapphirePhisherman]: Invalid API key provided');
+        }
+        throw error;
+    }
+}
+//# sourceMappingURL=Phisherman.js.map

package/dist/lib/Phisherman.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Phisherman.js","sourceRoot":"","sources":["../../src/lib/Phisherman.ts"],"names":[],"mappings":";;;;AAAA,2CAAoF;AAEpF,mEAAyB;AAEzB,IAAI,YAAoB,CAAC;AAEzB;;;;;GAKG;AACI,KAAK,UAAU,WAAW,CAAC,MAAc,EAAE,SAAiB,YAAY;IAC9E,MAAM,MAAM,GAAG,MAAM,IAAA,aAAK,EACzB,8CAA8C,MAAM,EAAE,EACtD;QACC,OAAO,EAAE;YACR,cAAc,EAAE,kBAAkB;YAClC,YAAY,EAAE,0CAA0C,iBAAE,CAAC,QAAQ,EAAE,IAAI,iBAAE,CAAC,OAAO,EAAE,2EAA2E;YAChK,aAAa,EAAE,UAAU,MAAM,EAAE;SACjC;KACD,oBAED,CAAC;IAEF,OAAO;QACN,GAAG,MAAM;QACT,MAAM,EAAE,MAAM,CAAC,cAAc,KAAK,MAAM,IAAI,MAAM,CAAC,cAAc,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI;KAC9F,CAAC;AACH,CAAC;AAjBD,kCAiBC;AAED;;;;;GAKG;AACH,SAAgB,YAAY,CAAC,MAAc,EAAE,SAAiB,YAAY;IACzE,OAAO,IAAA,aAAK,EACX,2CAA2C,EAC3C;QACC,MAAM,iBAAkB;QACxB,OAAO,EAAE;YACR,cAAc,EAAE,kBAAkB;YAClC,YAAY,EAAE,0CAA0C,iBAAE,CAAC,QAAQ,EAAE,IAAI,iBAAE,CAAC,OAAO,EAAE,2EAA2E;YAChK,aAAa,EAAE,UAAU,MAAM,EAAE;SACjC;QACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;YACpB,GAAG,EAAE,MAAM;SACX,CAAC;KACF,oBAED,CAAC;AACH,CAAC;AAhBD,oCAgBC;AAED;;;;GAIG;AACI,KAAK,UAAU,SAAS,CAAC,GAAW;IAC1C,MAAM,WAAW,CAAC,GAAG,CAAC,CAAC;IACvB,YAAY,GAAG,GAAG,CAAC;AACpB,CAAC;AAHD,8BAGC;AAED,KAAK,UAAU,WAAW,CAAC,MAAc;IACxC,IAAI;QACH,MAAM,IAAA,aAAK,EACV,wEAAwE,EACxE;YACC,OAAO,EAAE;gBACR,cAAc,EAAE,kBAAkB;gBAClC,YAAY,EAAE,0CAA0C,iBAAE,CAAC,QAAQ,EAAE,IAAI,iBAAE,CAAC,OAAO,EAAE,2EAA2E;gBAChK,aAAa,EAAE,UAAU,MAAM,EAAE;aACjC;SACD,oBAED,CAAC;KACF;IAAC,OAAO,KAAK,EAAE;QACf,MAAM,UAAU,GAAG,KAAmB,CAAC;QAEvC,IAAI,UAAU,CAAC,IAAI,KAAK,GAAG,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC,OAAO,KAAK,wCAAwC,EAAE;YACxG,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;SAClE;QAED,MAAM,KAAK,CAAC;KACZ;AACF,CAAC"}

package/dist/lib/PhishermanTypes.d.ts

@@ -0,0 +1,15 @@
+export interface PhishermanOptions {
+    apiKey: string;
+}
+export interface PhishermanReturnType {
+    verifiedPhish: boolean;
+    classification: 'malicious' | 'suspicious' | 'safe' | 'unknown';
+}
+export declare type CheckReturnType = PhishermanReturnType & {
+    isScam: boolean;
+};
+export interface PhishermanReportType {
+    success: boolean;
+    message: string;
+}
+//# sourceMappingURL=PhishermanTypes.d.ts.map

package/dist/lib/PhishermanTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PhishermanTypes.d.ts","sourceRoot":"","sources":["../../src/lib/PhishermanTypes.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,iBAAiB;IACjC,MAAM,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,oBAAoB;IACpC,aAAa,EAAE,OAAO,CAAC;IACvB,cAAc,EAAE,WAAW,GAAG,YAAY,GAAG,MAAM,GAAG,SAAS,CAAC;CAChE;AAED,oBAAY,eAAe,GAAG,oBAAoB,GAAG;IACpD,MAAM,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF,MAAM,WAAW,oBAAoB;IACpC,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CAChB"}

package/dist/lib/PhishermanTypes.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=PhishermanTypes.js.map

package/dist/lib/PhishermanTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PhishermanTypes.js","sourceRoot":"","sources":["../../src/lib/PhishermanTypes.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,57 @@
+{
+	"name": "@sapphire/phisherman",
+	"version": "0.1.0-next.68fba03.0",
+	"description": "Wrapper around phisherman to easily check and report domains",
+	"author": "@sapphire",
+	"license": "MIT",
+	"main": "dist/index.js",
+	"module": "dist/index.mjs",
+	"types": "dist/index.d.ts",
+	"typedocMain": "src/index.ts",
+	"exports": {
+		"import": "./dist/index.mjs",
+		"require": "./dist/index.js"
+	},
+	"homepage": "https://github.com/sapphiredev/utilities/tree/main/packages/phisherman",
+	"scripts": {
+		"lint": "eslint src --ext ts --fix",
+		"build": "tsc -b src && yarn esm:default",
+		"esm:default": "gen-esm-wrapper dist/index.js dist/index.mjs",
+		"prepublishOnly": "yarn build"
+	},
+	"dependencies": {
+		"@sapphire/fetch": "^2.0.3"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/sapphiredev/utilities.git",
+		"directory": "packages/phisherman"
+	},
+	"files": [
+		"dist",
+		"!dist/*.tsbuildinfo"
+	],
+	"engines": {
+		"node": ">=16.6.0",
+		"npm": ">=7.0.0"
+	},
+	"keywords": [
+		"sapphiredev",
+		"bot",
+		"typescript",
+		"ts",
+		"yarn",
+		"discord",
+		"sapphire",
+		"phisherman",
+		"scam",
+		"detection"
+	],
+	"bugs": {
+		"url": "https://github.com/sapphiredev/utilities/issues"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"gitHead": "68fba03bcbd3af14e66b25357d1eafd0cc315f0f"
+}