klaim 1.6.0 → 1.6.2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "klaim",
-    "version": "1.6.0",
+    "version": "1.6.2",
     "author": "antharuu",
     "repository": {
         "type": "git",
@@ -9,22 +9,22 @@
     "main": "dist/klaim.cjs.js",
     "module": "dist/klaim.es.js",
     "devDependencies": {
-        "@eslint/js": "^9.6.0",
+        "@eslint/js": "^9.7.0",
         "@stylistic/eslint-plugin": "^2.3.0",
         "@types/bun": "latest",
         "@types/eslint__js": "^8.42.3",
-        "@types/node": "^20.14.9",
-        "@vitest/coverage-v8": "^1.6.0",
-        "@vitest/ui": "^1.6.0",
+        "@types/node": "^20.14.10",
+        "@vitest/coverage-v8": "^2.0.2",
+        "@vitest/ui": "^2.0.2",
         "dotenv-cli": "^7.4.2",
-        "eslint": "^9.6.0",
-        "eslint-plugin-jsdoc": "^48.5.0",
+        "eslint": "^9.7.0",
+        "eslint-plugin-jsdoc": "^48.7.0",
         "eslint-plugin-simple-import-sort": "^12.1.1",
         "jsdom": "^24.1.0",
-        "release-it": "^17.4.1",
-        "typescript-eslint": "^7.15.0",
+        "release-it": "^17.5.0",
+        "typescript-eslint": "^7.16.0",
         "vite": "^5.3.3",
-        "vitest": "^1.6.0",
+        "vitest": "^2.0.2",
         "yup": "^1.4.0"
     },
     "bugs": {

package/src/core/Cache.ts

@@ -1,72 +1,72 @@
-/**
- * A simple cache implementation that stores key-value pairs with a time-to-live (TTL) in milliseconds.
- */
-export class Cache {
-    private static _instance: Cache;
-
-    private cache: Map<string, { data: any; expiry: number }>;
-
-    /**
-     * Private constructor to prevent instantiation from outside the class.
-     */
-    private constructor () {
-        this.cache = new Map();
-    }
-
-    /**
-     * Provides access to the singleton instance of the class.
-     *
-     * @returns The singleton instance of Cache.
-     */
-    public static get i (): Cache {
-        if (!Cache._instance) {
-            Cache._instance = new Cache();
-        }
-        return Cache._instance;
-    }
-
-    /**
-     * Sets the cache for a specific key.
-     *
-     * @param key The key to cache the value under.
-     * @param value The value to be cached.
-     * @param ttl Time to live in milliseconds.
-     */
-    public set (key: string, value: any, ttl: number = 0): void {
-        const expiry = Date.now() + ttl;
-        this.cache.set(key, { data: value, expiry });
-    }
-
-    /**
-     * Checks if the cache has a valid entry for the given key.
-     *
-     * @param key The key to check in the cache.
-     * @returns True if a valid cache entry exists, otherwise false.
-     */
-    public has (key: string): boolean {
-        const cacheEntry = this.cache.get(key);
-        if (!cacheEntry) {
-            return false;
-        }
-
-        if (Date.now() > cacheEntry.expiry) {
-            this.cache.delete(key);
-            return false;
-        }
-
-        return true;
-    }
-
-    /**
-     * Gets the cached value for the given key.
-     *
-     * @param key The key to retrieve from the cache.
-     * @returns The cached value or null if not found or expired.
-     */
-    public get (key: string): any | null {
-        if (this.has(key)) {
-            return this.cache.get(key)!.data;
-        }
-        return null;
-    }
-}
+/**
+ * A simple cache implementation that stores key-value pairs with a time-to-live (TTL) in milliseconds.
+ */
+export class Cache {
+    private static _instance: Cache;
+
+    private cache: Map<string, { data: any; expiry: number }>;
+
+    /**
+     * Private constructor to prevent instantiation from outside the class.
+     */
+    private constructor () {
+        this.cache = new Map();
+    }
+
+    /**
+     * Provides access to the singleton instance of the class.
+     *
+     * @returns The singleton instance of Cache.
+     */
+    public static get i (): Cache {
+        if (!Cache._instance) {
+            Cache._instance = new Cache();
+        }
+        return Cache._instance;
+    }
+
+    /**
+     * Sets the cache for a specific key.
+     *
+     * @param key The key to cache the value under.
+     * @param value The value to be cached.
+     * @param ttl Time to live in milliseconds.
+     */
+    public set (key: string, value: any, ttl: number = 0): void {
+        const expiry = Date.now() + ttl;
+        this.cache.set(key, { data: value, expiry });
+    }
+
+    /**
+     * Checks if the cache has a valid entry for the given key.
+     *
+     * @param key The key to check in the cache.
+     * @returns True if a valid cache entry exists, otherwise false.
+     */
+    public has (key: string): boolean {
+        const cacheEntry = this.cache.get(key);
+        if (!cacheEntry) {
+            return false;
+        }
+
+        if (Date.now() > cacheEntry.expiry) {
+            this.cache.delete(key);
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Gets the cached value for the given key.
+     *
+     * @param key The key to retrieve from the cache.
+     * @returns The cached value or null if not found or expired.
+     */
+    public get (key: string): any | null {
+        if (this.has(key)) {
+            return this.cache.get(key)!.data;
+        }
+        return null;
+    }
+}

package/src/core/Element.ts

@@ -1,150 +1,150 @@
-import cleanUrl from "../tools/cleanUrl";
-import toCamelCase from "../tools/toCamelCase";
-
-import { Api } from "./Api";
-import { Route } from "./Route";
-
-export type IHeaders = Record<string, string>;
-
-export interface ICallbackBeforeArgs {
-    route: Route;
-    api: Api;
-    url: string;
-    config: Record<string, unknown>;
-}
-
-export interface ICallbackAfterArgs {
-    route: Route;
-    api: Api;
-    response: Response;
-    data: any;
-}
-
-export interface ICallbackCallArgs {
-}
-
-export type ICallback<ArgsType> = (args: ArgsType) => Partial<ArgsType> | void;
-
-interface IElementCallbacks {
-    before: (ICallback<ICallbackBeforeArgs>) | null;
-    after: (ICallback<ICallbackAfterArgs>) | null;
-    call: (ICallback<ICallbackCallArgs>) | null;
-}
-
-export interface IElement {
-    name: string;
-    url: string;
-    headers: IHeaders;
-    callbacks: IElementCallbacks;
-    cache: false | number;
-    retry: false | number;
-
-    before: (callback: ICallback<ICallbackBeforeArgs>) => this;
-    after: (callback: ICallback<ICallbackAfterArgs>) => this;
-    onCall: (callback: ICallback<ICallbackCallArgs>) => this;
-
-    withCache: (duration?: number) => this;
-    withRetry: (maxRetries?: number) => this;
-}
-
-/**
- * Represents an element (API or Route)
- */
-export abstract class Element implements IElement {
-    public name: string;
-
-    public url: string;
-
-    public headers: IHeaders;
-
-    public callbacks: IElementCallbacks = {
-        /**
-         * Called before the request is sent
-         */
-        before: null,
-        /**
-         * Called after the request is sent and before the data is returned
-         */
-        after: null,
-        /**
-         * Called when the route is called (call also includes retries)
-         */
-        call: null
-    };
-
-    public cache: false | number = false;
-
-    public retry: false | number = false;
-
-    /**
-     * Constructor
-     *
-     * @param name - The name of the element
-     * @param url - The base URL of the element
-     * @param headers - The headers to be sent with each request
-     */
-    protected constructor (name: string, url: string, headers: IHeaders = {}) {
-        this.name = toCamelCase(name);
-        if (this.name !== name) {
-            console.warn(`Name "${name}" has been camelCased to "${this.name}"`);
-        }
-
-        this.url = cleanUrl(url);
-        this.headers = headers || {};
-    }
-
-    /**
-     * Sets the before callback
-     *
-     * @param callback - The callback
-     * @returns The route
-     */
-    public before (callback: ICallback<ICallbackBeforeArgs> | null): this {
-        this.callbacks.before = callback;
-        return this;
-    }
-
-    /**
-     * Sets the after callback
-     *
-     * @param callback - The callback
-     * @returns The route
-     */
-    public after (callback: ICallback<ICallbackAfterArgs>): this {
-        this.callbacks.after = callback;
-        return this;
-    }
-
-    /**
-     * Sets the onCall callback
-     *
-     * @param callback - The callback
-     * @returns The route
-     */
-    public onCall (callback: ICallback<ICallbackCallArgs>): this {
-        this.callbacks.call = callback;
-        return this;
-    }
-
-    /**
-     * Enables caching for the Route
-     *
-     * @param duration - The duration to cache the response for seconds (default: 20)
-     * @returns The Route
-     */
-    public withCache (duration = 20): this {
-        this.cache = duration;
-        return this;
-    }
-
-    /**
-     * Enables retry for the Route
-     *
-     * @param maxRetries - The maximum number of retries (default: 3)
-     * @returns The Route
-     */
-    public withRetry (maxRetries = 2): this {
-        this.retry = maxRetries;
-        return this;
-    }
-}
+import cleanUrl from "../tools/cleanUrl";
+import toCamelCase from "../tools/toCamelCase";
+
+import { Api } from "./Api";
+import { Route } from "./Route";
+
+export type IHeaders = Record<string, string>;
+
+export interface ICallbackBeforeArgs {
+    route: Route;
+    api: Api;
+    url: string;
+    config: Record<string, unknown>;
+}
+
+export interface ICallbackAfterArgs {
+    route: Route;
+    api: Api;
+    response: Response;
+    data: any;
+}
+
+export interface ICallbackCallArgs {
+}
+
+export type ICallback<ArgsType> = (args: ArgsType) => Partial<ArgsType> | void;
+
+interface IElementCallbacks {
+    before: (ICallback<ICallbackBeforeArgs>) | null;
+    after: (ICallback<ICallbackAfterArgs>) | null;
+    call: (ICallback<ICallbackCallArgs>) | null;
+}
+
+export interface IElement {
+    name: string;
+    url: string;
+    headers: IHeaders;
+    callbacks: IElementCallbacks;
+    cache: false | number;
+    retry: false | number;
+
+    before: (callback: ICallback<ICallbackBeforeArgs>) => this;
+    after: (callback: ICallback<ICallbackAfterArgs>) => this;
+    onCall: (callback: ICallback<ICallbackCallArgs>) => this;
+
+    withCache: (duration?: number) => this;
+    withRetry: (maxRetries?: number) => this;
+}
+
+/**
+ * Represents an element (API or Route)
+ */
+export abstract class Element implements IElement {
+    public name: string;
+
+    public url: string;
+
+    public headers: IHeaders;
+
+    public callbacks: IElementCallbacks = {
+        /**
+         * Called before the request is sent
+         */
+        before: null,
+        /**
+         * Called after the request is sent and before the data is returned
+         */
+        after: null,
+        /**
+         * Called when the route is called (call also includes retries)
+         */
+        call: null
+    };
+
+    public cache: false | number = false;
+
+    public retry: false | number = false;
+
+    /**
+     * Constructor
+     *
+     * @param name - The name of the element
+     * @param url - The base URL of the element
+     * @param headers - The headers to be sent with each request
+     */
+    protected constructor (name: string, url: string, headers: IHeaders = {}) {
+        this.name = toCamelCase(name);
+        if (this.name !== name) {
+            console.warn(`Name "${name}" has been camelCased to "${this.name}"`);
+        }
+
+        this.url = cleanUrl(url);
+        this.headers = headers || {};
+    }
+
+    /**
+     * Sets the before callback
+     *
+     * @param callback - The callback
+     * @returns The route
+     */
+    public before (callback: ICallback<ICallbackBeforeArgs> | null): this {
+        this.callbacks.before = callback;
+        return this;
+    }
+
+    /**
+     * Sets the after callback
+     *
+     * @param callback - The callback
+     * @returns The route
+     */
+    public after (callback: ICallback<ICallbackAfterArgs>): this {
+        this.callbacks.after = callback;
+        return this;
+    }
+
+    /**
+     * Sets the onCall callback
+     *
+     * @param callback - The callback
+     * @returns The route
+     */
+    public onCall (callback: ICallback<ICallbackCallArgs>): this {
+        this.callbacks.call = callback;
+        return this;
+    }
+
+    /**
+     * Enables caching for the Route
+     *
+     * @param duration - The duration to cache the response for seconds (default: 20)
+     * @returns The Route
+     */
+    public withCache (duration = 20): this {
+        this.cache = duration;
+        return this;
+    }
+
+    /**
+     * Enables retry for the Route
+     *
+     * @param maxRetries - The maximum number of retries (default: 3)
+     * @returns The Route
+     */
+    public withRetry (maxRetries = 2): this {
+        this.retry = maxRetries;
+        return this;
+    }
+}