Merge pull request #607 from ClarityCafe/v4

V4.x Rewrite

.github/workflows/test.yml

@@ -0,0 +1,41 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: BunJS CI
+
+on:
+  push:
+    branches: ["**"]
+  pull_request:
+    branches: ["**"]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        bun-version: [latest, 1.1]
+
+    steps:
+      - uses: actions/checkout@v4.1.7
+      - name: Use Bun.js ${{ matrix.bun-version }}
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: ${{ matrix.bun-version }}
+
+      - name: Get Dependencies
+        run: bun install
+#      - name: Get CodeClimate Coverage
+#        run: |
+#          curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+#          chmod +x ./cc-test-reporter
+#          ./cc-test-reporter before-build
+
+      - name: Run Coverage and Lint
+        run: |
+          echo 'SAUCENAO_TOKEN=${{ secrets.SAUCENAO_TOKEN }}' > ./.env.test.local
+          bun run coverage
+#          ./cc-test-reporter after-build --exit-code $(echo $?)
+#        env:
+#          CC_TEST_REPORTER_ID: bda3746e9ecd039cee2dcfb3c1e4efc59c712a40fa3b9316e281eb00d61c613e

.idx/dev.nix

@@ -4,5 +4,6 @@
     pkgs.vim
     pkgs.git
     pkgs.bun
+    pkgs.deno
     ];
 }

.vscode/launch.json

@@ -0,0 +1,37 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "bun",
+            "internalConsoleOptions": "neverOpen",
+            "request": "launch",
+            "name": "Debug File",
+            "program": "${file}",
+            "cwd": "${workspaceFolder}",
+            "envFile": ".env.test.local",
+            "stopOnEntry": false,
+            "watchMode": false
+        },
+        {
+            "type": "bun",
+            "internalConsoleOptions": "neverOpen",
+            "request": "launch",
+            "name": "Run File",
+            "program": "${file}",
+            "cwd": "${workspaceFolder}",
+            "noDebug": true,
+            "watchMode": false
+        },
+        {
+            "type": "bun",
+            "internalConsoleOptions": "neverOpen",
+            "request": "attach",
+            "name": "Attach Bun",
+            "url": "ws://localhost:6499/",
+            "stopOnEntry": false
+        }
+    ]
+}

CHANGELOG.md

@@ -11,7 +11,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - **BREAKING** - Interfaces have been renamed to use the hungarian notation style (e.g. `SagiriResult` is now `ISagiriResult`). Please adapt your code accordingly.
 - **BREAKING** - ESM support has been added to allow the module to be used on Node.js 16+ code that uses ESM code.
-- **NEW** - Package is now published in the [JSR](https://jsr.io) registry. To install the package, run `npm install jsr:@clarity/sagiri`.
+- **BREAKING** - Bun and Deno support has been added. Library contributors are encouraged to try the library on these platforms and avoid any Node.js specific code.
+- **NEW** - Package is now published in the [JSR](https://jsr.io) registry. To install the package, run `deno install jsr:@clarity/sagiri`.
+- **NEW** - Library now uses the native [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). A [node-fetch](https://npmjs.com/package/node-fetch) fallback is provided for LTS versions below 21.x - however this will be removed once 18 and 20.x versions become deprecated.
 
 ## [3.6.0] - 2024-04-10
 

eslint.config.mjs

@@ -10,7 +10,8 @@ export default [
   {
     ignores: [
       "*.config.*",
-      "tests/**"
+      "tests/**",
+      "dist/**"
     ]
   }
 ];

jsr.json

@@ -1,5 +1,5 @@
 {
   "name": "@clarity/sagiri",
-  "version": "4.0.1",
-  "exports": "./lib/index.ts"
+  "version": "4.0.2",
+  "exports": "./lib/sagiri.ts"
 }

lib/errors.ts

@@ -1,17 +1,27 @@
+/**
+ * Represents an error specific to the Sagiri library.
+ */
 export class SagiriError extends Error {
   constructor(code: number, message: string) {
     super(`${message} (${code})`);
     this.name = "SagiriError";
   }
 }
 
+/**
+ * Represents an error specific to the Sagiri client.
+ */
 export class SagiriClientError extends SagiriError {
   constructor(code: number, message: string) {
     super(code, message);
     this.name = "SagiriClientError";
   }
 }
 
+/**
+ * Represents a error specific to the SauceNAO API.
+ * @extends SagiriError
+ */
 export class SagiriServerError extends SagiriError {
   constructor(code: number, message: string) {
     super(code, message);

lib/interfaces.ts

@@ -0,0 +1,27 @@
+import type { IResult } from "./response";
+
+/**
+ * Represents the valid options to pass on to SauceNAO.
+ */
+export interface IOptions {
+  results?: number;
+  mask?: number[];
+  excludeMask?: number[];
+  getRatings?: boolean;
+  testMode?: boolean;
+  db?: number;
+}
+
+/**
+ * Represents the result of a Sagiri search.
+ */
+export interface ISagiriResult {
+  url: string;
+  site: string;
+  index: number;
+  similarity: number;
+  thumbnail: string;
+  authorName: string | null;
+  authorUrl: string | null;
+  raw: IResult;
+}

lib/response.ts

@@ -119,6 +119,11 @@ export interface IResponse {
   results: IResult[];
 }
 
+export interface IHeaderStatus {
+  status: number;
+  message: string;
+}
+
 export interface IHeader {
   account_type: string;
   index: { [id: string]: IHeaderIndex | undefined }; // do i wanna generic this to be id value?