Final: Library Working

Author: hoangsonww

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Son Nguyen
+
+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.

README.md

@@ -40,7 +40,6 @@ Currently available as a Node.js package on NPM. **NPM Page:** [https://www.npmj
   - [Node.js Example](#nodejs-example)
 - [API Reference](#api-reference)
 - [Testing](#testing)
-- [Building & Publishing](#building--publishing)
 - [Contributing](#contributing)
 - [License](#license)
 
@@ -89,10 +88,10 @@ Example:
 import { enableGhostCache } from "ghost-cache";
 
 enableGhostCache({
-  ttl: 120000,          // Cache entries expire in 2 minutes
-  persistent: true,       // Enable persistent caching
-  maxEntries: 200,        // Allow up to 200 in-memory entries
-  storage: "localStorage" // Use localStorage for persistence
+  ttl: 120000, // Cache entries expire in 2 minutes
+  persistent: true, // Enable persistent caching
+  maxEntries: 200, // Allow up to 200 in-memory entries
+  storage: "localStorage", // Use localStorage for persistence
 });
 ```
 
@@ -110,8 +109,8 @@ enableGhostCache();
 
 // Regular fetch calls remain unchanged
 fetch("https://pokeapi.co/api/v2/pokemon/ditto")
-  .then(res => res.json())
-  .then(data => console.log("Fetched data:", data));
+  .then((res) => res.json())
+  .then((data) => console.log("Fetched data:", data));
 
 // Disable GhostCache to restore original fetch behavior
 // disableGhostCache();
@@ -133,8 +132,9 @@ const api = axios.create({ baseURL: "https://pokeapi.co/api/v2" });
 registerAxios(api);
 
 // Make requests using Axios. Subsequent calls will be served from the cache.
-api.get("/pokemon/ditto")
-  .then(response => console.log("Axios fetched:", response.data));
+api
+  .get("/pokemon/ditto")
+  .then((response) => console.log("Axios fetched:", response.data));
 ```
 
 ### Manual Cache API
@@ -163,7 +163,7 @@ Enable persistent caching using the browser's localStorage:
 ```ts
 enableGhostCache({
   persistent: true,
-  storage: "localStorage"
+  storage: "localStorage",
 });
 ```
 
@@ -174,7 +174,7 @@ Use sessionStorage for caching that lasts only for the browser session:
 ```ts
 enableGhostCache({
   persistent: true,
-  storage: "sessionStorage"
+  storage: "sessionStorage",
 });
 ```
 
@@ -185,7 +185,7 @@ Use IndexedDB for structured, persistent storage:
 ```ts
 enableGhostCache({
   persistent: true,
-  storage: "indexedDB"
+  storage: "indexedDB",
 });
 ```
 
@@ -202,7 +202,7 @@ await redisClient.connect();
 
 enableGhostCache({
   persistent: true,
-  storage: new RedisAdapter(redisClient)
+  storage: new RedisAdapter(redisClient),
 });
 ```
 
@@ -226,7 +226,7 @@ const App: React.FC = () => {
 
   useEffect(() => {
     fetch("https://pokeapi.co/api/v2/pokemon/ditto")
-      .then(res => res.json())
+      .then((res) => res.json())
       .then(setPokemon);
   }, []);
 
@@ -262,11 +262,12 @@ const api = axios.create({ baseURL: "https://pokeapi.co/api/v2" });
 registerAxios(api);
 
 // Use Axios to make requests
-api.get("/pokemon/ditto")
-  .then(response => {
+api
+  .get("/pokemon/ditto")
+  .then((response) => {
     console.log("Node.js Axios fetched:", response.data);
   })
-  .catch(error => {
+  .catch((error) => {
     console.error("Error:", error);
   });
 ```
@@ -313,33 +314,7 @@ GhostCache comes with a comprehensive Jest test suite. To run tests:
 
 Tests use the Pokémon API (`https://pokeapi.co/api/v2/pokemon/ditto`) to verify that caching works for both `fetch()` and Axios requests.
 
----
-
-## Building & Publishing
-
-### Building
-
-Compile the TypeScript source:
-
-```bash
-npm run build
-```
-
-### Publishing
-
-1. Login to npm:
-
-   ```bash
-   npm login
-   ```
-
-2. Publish the package:
-
-   ```bash
-   npm publish --access public
-   ```
-
----
+> Note: There may be path/import issues. If you encounter any, please check the test files and adjust the import paths accordingly.
 
 ## Contributing
 
@@ -361,10 +336,8 @@ For major changes, please open an issue first to discuss what you would like to
 
 GhostCache is released under the MIT License.
 
----
-
 ## Final Remarks
 
 GhostCache is designed to be a simple yet powerful tool for improving the performance of your web applications by reducing unnecessary network calls. With support for multiple storage adapters and both `fetch()` and Axios, it adapts to a wide range of project needs.
 
-Happy caching!
+Happy caching! 🎉

__tests__/ghostCache.test.js

@@ -1,72 +1,103 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+var __awaiter =
+  (this && this.__awaiter) ||
+  function (thisArg, _arguments, P, generator) {
+    function adopt(value) {
+      return value instanceof P
+        ? value
+        : new P(function (resolve) {
+            resolve(value);
+          });
+    }
     return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
+      function fulfilled(value) {
+        try {
+          step(generator.next(value));
+        } catch (e) {
+          reject(e);
+        }
+      }
+      function rejected(value) {
+        try {
+          step(generator["throw"](value));
+        } catch (e) {
+          reject(e);
+        }
+      }
+      function step(result) {
+        result.done
+          ? resolve(result.value)
+          : adopt(result.value).then(fulfilled, rejected);
+      }
+      step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
+  };
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
 Object.defineProperty(exports, "__esModule", { value: true });
 const src_1 = require("../src");
 const axios_1 = __importDefault(require("axios"));
 jest.setTimeout(10000);
 describe("GhostCache - API Caching Tests", () => {
-    const POKEMON_API = "https://pokeapi.co/api/v2/pokemon/ditto";
-    beforeAll(() => {
-        // Enable caching with a TTL of 5 seconds, no persistent storage for testing
-        (0, src_1.enableGhostCache)({ ttl: 5000, persistent: false });
-    });
-    afterEach(() => {
-        (0, src_1.clearGhostCache)();
-    });
-    afterAll(() => {
-        (0, src_1.disableGhostCache)();
-    });
-    it("fetches data from the Pokémon API via fetch", () => __awaiter(void 0, void 0, void 0, function* () {
-        const response = yield fetch(POKEMON_API);
-        const data = yield response.json();
-        expect(data).toHaveProperty("name", "ditto");
+  const POKEMON_API = "https://pokeapi.co/api/v2/pokemon/ditto";
+  beforeAll(() => {
+    // Enable caching with a TTL of 5 seconds, no persistent storage for testing
+    (0, src_1.enableGhostCache)({ ttl: 5000, persistent: false });
+  });
+  afterEach(() => {
+    (0, src_1.clearGhostCache)();
+  });
+  afterAll(() => {
+    (0, src_1.disableGhostCache)();
+  });
+  it("fetches data from the Pokémon API via fetch", () =>
+    __awaiter(void 0, void 0, void 0, function* () {
+      const response = yield fetch(POKEMON_API);
+      const data = yield response.json();
+      expect(data).toHaveProperty("name", "ditto");
     }));
-    it("returns cached data on subsequent fetch calls", () => __awaiter(void 0, void 0, void 0, function* () {
-        const startTime = Date.now();
-        const response1 = yield fetch(POKEMON_API);
-        const data1 = yield response1.json();
-        const networkTime = Date.now() - startTime;
-        expect(data1).toHaveProperty("name", "ditto");
-        const cacheStartTime = Date.now();
-        const response2 = yield fetch(POKEMON_API);
-        const data2 = yield response2.json();
-        const cacheTime = Date.now() - cacheStartTime;
-        expect(data2).toHaveProperty("name", "ditto");
-        expect(cacheTime).toBeLessThan(networkTime);
+  it("returns cached data on subsequent fetch calls", () =>
+    __awaiter(void 0, void 0, void 0, function* () {
+      const startTime = Date.now();
+      const response1 = yield fetch(POKEMON_API);
+      const data1 = yield response1.json();
+      const networkTime = Date.now() - startTime;
+      expect(data1).toHaveProperty("name", "ditto");
+      const cacheStartTime = Date.now();
+      const response2 = yield fetch(POKEMON_API);
+      const data2 = yield response2.json();
+      const cacheTime = Date.now() - cacheStartTime;
+      expect(data2).toHaveProperty("name", "ditto");
+      expect(cacheTime).toBeLessThan(networkTime);
     }));
-    it("expires cache after TTL for fetch", () => __awaiter(void 0, void 0, void 0, function* () {
-        const response1 = yield fetch(POKEMON_API);
-        const data1 = yield response1.json();
-        expect(data1).toHaveProperty("name", "ditto");
-        // Wait 6 seconds (beyond the 5-second TTL)
-        yield new Promise(resolve => setTimeout(resolve, 6000));
-        const response2 = yield fetch(POKEMON_API);
-        const data2 = yield response2.json();
-        expect(data2).toHaveProperty("name", "ditto");
+  it("expires cache after TTL for fetch", () =>
+    __awaiter(void 0, void 0, void 0, function* () {
+      const response1 = yield fetch(POKEMON_API);
+      const data1 = yield response1.json();
+      expect(data1).toHaveProperty("name", "ditto");
+      // Wait 6 seconds (beyond the 5-second TTL)
+      yield new Promise((resolve) => setTimeout(resolve, 6000));
+      const response2 = yield fetch(POKEMON_API);
+      const data2 = yield response2.json();
+      expect(data2).toHaveProperty("name", "ditto");
     }));
-    it("allows manual cache set and get", () => __awaiter(void 0, void 0, void 0, function* () {
-        yield (0, src_1.setCache)("test-key", { foo: "bar" });
-        const cached = yield (0, src_1.getCache)("test-key");
-        expect(cached).toEqual({ foo: "bar" });
+  it("allows manual cache set and get", () =>
+    __awaiter(void 0, void 0, void 0, function* () {
+      yield (0, src_1.setCache)("test-key", { foo: "bar" });
+      const cached = yield (0, src_1.getCache)("test-key");
+      expect(cached).toEqual({ foo: "bar" });
     }));
-    it("works with Axios", () => __awaiter(void 0, void 0, void 0, function* () {
-        const api = axios_1.default.create();
-        (0, src_1.registerAxios)(api);
-        const response1 = yield api.get(POKEMON_API);
-        expect(response1.data).toHaveProperty("name", "ditto");
-        // Second request should come from cache
-        const response2 = yield api.get(POKEMON_API);
-        expect(response2.data).toHaveProperty("name", "ditto");
+  it("works with Axios", () =>
+    __awaiter(void 0, void 0, void 0, function* () {
+      const api = axios_1.default.create();
+      (0, src_1.registerAxios)(api);
+      const response1 = yield api.get(POKEMON_API);
+      expect(response1.data).toHaveProperty("name", "ditto");
+      // Second request should come from cache
+      const response2 = yield api.get(POKEMON_API);
+      expect(response2.data).toHaveProperty("name", "ditto");
     }));
 });

__tests__/ghostCache.test.ts

@@ -4,7 +4,7 @@ import {
   disableGhostCache,
   getCache,
   setCache,
-  registerAxios
+  registerAxios,
 } from "../src/index.js";
 import axios from "axios";
 
@@ -53,7 +53,7 @@ describe("GhostCache - API Caching Tests", () => {
     expect(d1).toHaveProperty("name", "ditto");
 
     // Wait 6 seconds to exceed the TTL of 5 seconds.
-    await new Promise(resolve => setTimeout(resolve, 6000));
+    await new Promise((resolve) => setTimeout(resolve, 6000));
 
     const r2 = await fetch(POKEMON_API);
     const d2 = await r2.json();

index.d.ts

@@ -1,5 +1,3 @@
-// index.d.ts
-
 export interface IStorageAdapter {
   getItem(key: string): Promise<string | null>;
   setItem(key: string, value: string): Promise<void>;

jest.config.cjs

@@ -1,4 +1,3 @@
-// jest.config.cjs
 module.exports = {
   preset: "ts-jest/presets/default-esm",
   testEnvironment: "node",