feat(*): fish fish wrapper

[JPBM135]

Will write everything when ready!

Readme preview

fishfish-js 🐟

The fishfish-js is a simple and easy to use JavaScript wrapper for the fishfish API and WebSocket.

• Typed
• Objected oriented
• Cache

Documentation: API Docs

Installation

npm install fishfish-js
# or
yarn add fishfish-js

How to use?

Static:

import { getAllDomains, getAllUrls, Category } from 'fishfish-js';

const ScamDomains = await getAllDomains(Category.Phishing);
const ScamUrls = await getAllUrls(Category.Phishing);

FishFish Auth:

It is recommended to have one FishFishAuth class and use it for all other classes to avoid unnecessary session tokens.

import { FishFishAuth, Permission } from 'fishfish-js';

const FishAuth = new FishFishAuth({
	apiKey: 'real-api-key',
});

// Infer the apiKey from the env FISHFISH_API_KEY
const FishAuth = new FishFishAuth();

console.log(await FishFish.getSessionToken());

FishFish API:

import { FishFishAuth, FishFishApi, Permission } from 'fishfish-js';

const FishApi = new FishFishApi({
	auth: {
		apiKey: 'real-api-key',
	},
});

const FullScamDomains = await FishApi.getAllDomains(Category.Phishing, { full: true });

Or by using the FishFishAuth class:

import { FishFishAuth, FishFishApi } from 'fishfish-js';

const FishAuth = new FishFishAuth({
	apiKey: 'real-api-key',
});

const FishApi = new FishFishApi({
	auth: FishAuth,
});

const FullScamDomains = await FishApi.getAllUrls(Category.Phishing, { full: true });

FishFish WebSocket:

Receive real-time updates from the fishfish WebSocket.

Pass your own callback function to the FishFishWebSocket class:

import { FishFishWebSocket } from 'fishfish-js';

const FishWebSocket = new FishFishWebSocket({
	auth: {
		apiKey: 'real-api-key',
	},
	callback: (data) => console.log(data),
});

Or use the FishFishApi class to receive the data and cache it:

import { FishFishWebSocket, FishFishApi } from 'fishfish-js';

const manager = new FishFishApi({
	auth: {
		apiKey: 'real-api-key',
	},
});

const FishWebSocket = new FishFishWebSocket({
	manager,
});

// or

const FishWebApi = new FishFishApi({
	auth: {
		apiKey: 'real-api-key',
	},
	webSocket: true,
});

• Base code
• Testing
• CI
• Husky
• Lintstaged

---

• (GET domains / urls) Only require auth if the full is set to true