feat(*): fish fish wrapper

.eslintrc.json

@@ -0,0 +1,24 @@
+{
+	"root": true,
+	"parserOptions": {
+		"project": "./tsconfig.eslint.json"
+	},
+	"ignorePatterns": [
+		"**/dist/*"
+	],
+	"env": {
+		"jest": true
+	},
+	"extends": [
+		"neon/common",
+		"neon/node",
+		"neon/typescript",
+		"neon/prettier"
+	],
+	"rules": {
+		"@typescript-eslint/consistent-type-definitions": [
+			"error",
+			"interface"
+		]
+	}
+}

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.gitignore

@@ -5,6 +5,7 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 lerna-debug.log*
+.pnpm-debug.log*
 
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
@@ -41,8 +42,8 @@ build/Release
 node_modules/
 jspm_packages/
 
-# TypeScript v1 declaration files
-typings/
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
 
 # TypeScript cache
 *.tsbuildinfo
@@ -53,6 +54,9 @@ typings/
 # Optional eslint cache
 .eslintcache
 
+# Optional stylelint cache
+.stylelintcache
+
 # Microbundle cache
 .rpt2_cache/
 .rts2_cache_cjs/
@@ -68,29 +72,41 @@ typings/
 # Yarn Integrity file
 .yarn-integrity
 
-# dotenv environment variables file
+# dotenv environment variable files
 .env
-.env.test
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
 
 # parcel-bundler cache (https://parceljs.org/)
 .cache
+.parcel-cache
 
 # Next.js build output
 .next
+out
 
 # Nuxt.js build / generate output
 .nuxt
 dist
 
 # Gatsby files
 .cache/
-# Comment in the public line in if your project uses Gatsby and *not* Next.js
+# Comment in the public line in if your project uses Gatsby and not Next.js
 # https://nextjs.org/blog/next-9-1#public-directory-support
 # public
 
 # vuepress build output
 .vuepress/dist
 
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
 # Serverless directories
 .serverless/
 
@@ -102,3 +118,17 @@ dist
 
 # TernJS port file
 .tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+# macOS
+.DS_Store
+.vercel

.prettierrc.json

@@ -0,0 +1,8 @@
+{
+	"printWidth": 120,
+	"useTabs": true,
+	"singleQuote": true,
+	"quoteProps": "as-needed",
+	"trailingComma": "all",
+	"endOfLine": "lf"
+}

.swcrc

@@ -0,0 +1,27 @@
+{
+	"exclude": [
+		".*/types/.*\\.ts$"
+	],
+	"jsc": {
+		"parser": {
+			"syntax": "typescript",
+			"tsx": false,
+			"decorators": true
+		},
+		"transform": {
+			"legacyDecorator": true,
+			"decoratorMetadata": true,
+			"treatConstEnumAsEnum": true,
+			"useDefineForClassFields": true
+		},
+		"target": "es2022",
+		"keepClassNames": true,
+		"preserveAllComments": false,
+		"externalHelpers": true
+	},
+	"module": {
+		"type": "nodenext"
+	},
+	"sourceMaps": true,
+	"isModule": true
+}

.vscode/settings.json

@@ -0,0 +1,9 @@
+{
+	"editor.defaultFormatter": "esbenp.prettier-vscode",
+	"editor.formatOnSave": true,
+	"editor.codeActionsOnSave": {
+		"source.fixAll": true,
+		"source.organizeImports": false
+	},
+	"eslint.workingDirectories": [{ "pattern": "./packages/*" }]
+}

.yarnrc.yml

@@ -0,0 +1,11 @@
+nodeLinker: node-modules
+
+plugins:
+  - path: .yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs
+    spec: '@yarnpkg/plugin-interactive-tools'
+  - path: .yarn/plugins/@yarnpkg/plugin-workspace-tools.cjs
+    spec: '@yarnpkg/plugin-workspace-tools'
+  - path: .yarn/plugins/@yarnpkg/plugin-version.cjs
+    spec: '@yarnpkg/plugin-version'
+
+yarnPath: .yarn/releases/yarn-3.2.2.cjs

package.json

@@ -0,0 +1,43 @@
+{
+	"name": "fishfish-js",
+	"version": "1.0.0",
+	"description": "",
+	"scripts": {
+		"test": "vitest run",
+		"build:clean": "del-cli dist",
+		"build:check": "tsc --emitDeclarationOnly",
+		"build:esm": "swc ./src --out-dir ./dist",
+		"build": "yarn build:clean && yarn build:check && yarn build:esm",
+		"lint": "prettier --check . && eslint src --ext ts",
+		"format": "prettier --write . && eslint src --ext ts --fix",
+		"fmt": "yarn format",
+		"prepack": "yarn build && yarn lint"
+	},
+	"type": "module",
+	"keywords": [
+		"fishfish",
+		"anti-scam",
+		"api",
+		"wrapper"
+	],
+	"author": "JPBM135 <jpedrobm0@gmail.com>",
+	"license": "AGPL-3.0",
+	"devDependencies": {
+		"@swc/cli": "^0.1.57",
+		"@swc/core": "^1.3.3",
+		"@types/node": "^18.7.23",
+		"del-cli": "^5.0.0",
+		"eslint": "^8.22.0",
+		"eslint-config-neon": "^0.1.33",
+		"prettier": "^2.7.1",
+		"typescript": "^4.7.4",
+		"vitest": "^0.24.3"
+	},
+	"engines": {
+		"node": ">=17.9.0"
+	},
+	"packageManager": "yarn@3.2.2",
+	"dependencies": {
+		"undici": "^5.11.0"
+	}
+}

src/constants.ts

@@ -0,0 +1,18 @@
+export const API_BASE_URL = 'https://api.fishfish.gg/v1';
+
+/**
+ * The categories of entries.
+ */
+export enum Category {
+	Malware = 'malware',
+	Phishing = 'phishing',
+	Safe = 'safe',
+}
+
+/**
+ * The permissions for the session token.
+ */
+export enum Permission {
+	Domains = 'domains',
+	Urls = 'urls',
+}

src/errors.ts

@@ -0,0 +1,11 @@
+export enum ErrorsMessages {
+	API_KEY_UNAUTHORIZED = 'The API key provided is invalid or does not have the required permissions.',
+	CACHE_DISABLED = "Cannot get cache because it's explicitly disabled.",
+	INVALID_TYPE = 'Expected a string but received: ',
+	MISSING_CATEGORY = 'You need to provide a category to fetch all entries.',
+	MISSING_DEFAULT_PERMISSIONS = 'You need to provide at least one permission for the session token.',
+	MISSING_FIELD_CREATE = 'The category and description fields are required when creating a new entry.',
+	MISSING_FIELD_UPDATE = 'You need to provide at least one field to update.',
+	RATE_LIMITED = 'You are being rate limited.',
+	SESSION_TOKEN_UNAUTHORIZED = 'The session token provided is invalid or has expired.',
+}

src/index.ts

@@ -0,0 +1,4 @@
+export * from './constants.js';
+export * from './errors.js';
+export * from './types.js';
+export * from './main.js';