refactor(browser): HawkStorage abstraction added

Author: Reversean

.github/workflows/main.yml

@@ -22,13 +22,15 @@ jobs:
       CI_JOB_NUMBER: 2
     steps:
       - uses: actions/checkout@v1
+        with:
+          fetch-depth: 0
       - name: Use Node.js from .nvmrc
         uses: actions/setup-node@v6
         with:
           node-version-file: '.nvmrc'
       - run: corepack enable
       - run: yarn install
-      - run: yarn workspace @hawk.so/javascript test
+      - run: yarn test:modified origin/${{ github.event.pull_request.base.ref }}
 
   build:
     runs-on: ubuntu-latest

package.json

@@ -15,6 +15,8 @@
     "dev": "yarn workspace @hawk.so/javascript dev",
     "build:all": "yarn workspaces foreach -Apt run build",
     "build:modified": "yarn workspaces foreach --since=\"$@\" -Rpt run build",
+    "test:all": "yarn workspaces foreach -Apt run test",
+    "test:modified": "yarn workspaces foreach --since=\"$@\" -Rpt run test",
     "stats": "yarn workspace @hawk.so/javascript stats",
     "lint": "eslint -c ./.eslintrc.cjs packages/*/src --ext .ts,.js --fix",
     "lint-test": "eslint -c ./.eslintrc.cjs packages/*/src --ext .ts,.js"

packages/browser/package.json

@@ -17,7 +17,10 @@
     }
   },
   "scripts": {
-    "build": "vite build"
+    "build": "vite build",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "lint": "eslint --fix \"src/**/*.{js,ts}\""
   },
   "repository": {
     "type": "git",
@@ -33,8 +36,14 @@
     "url": "https://github.com/codex-team/hawk.javascript/issues"
   },
   "homepage": "https://github.com/codex-team/hawk.javascript#readme",
+  "dependencies": {
+    "@hawk.so/core": "workspace:^"
+  },
   "devDependencies": {
+    "@vitest/coverage-v8": "^4.0.18",
+    "jsdom": "^28.0.0",
     "vite": "^7.3.1",
-    "vite-plugin-dts": "^4.2.4"
+    "vite-plugin-dts": "^4.2.4",
+    "vitest": "^4.0.18"
   }
 }

packages/browser/src/index.ts

@@ -0,0 +1 @@
+export { HawkLocalStorage } from './storages/hawk-local-storage';

packages/browser/src/storages/hawk-local-storage.ts

@@ -0,0 +1,21 @@
+import type { HawkStorage } from '@hawk.so/core';
+
+/**
+ * {@link HawkStorage} implementation backed by the browser's {@linkcode localStorage}.
+ */
+export class HawkLocalStorage implements HawkStorage {
+  /** @inheritDoc */
+  public getItem(key: string): string | null {
+    return localStorage.getItem(key);
+  }
+
+  /** @inheritDoc */
+  public setItem(key: string, value: string): void {
+    localStorage.setItem(key, value);
+  }
+
+  /** @inheritDoc */
+  public removeItem(key: string): void {
+    localStorage.removeItem(key);
+  }
+}

packages/browser/tests/hawk-local-storage.test.ts

@@ -0,0 +1,56 @@
+import { beforeEach, afterEach, describe, it, expect, vi, Mock } from "vitest";
+import { HawkLocalStorage } from "../src";
+
+describe('HawkLocalStorage', () => {
+  let getItemSpy: Mock<(key: string) => string | null>;
+  let setItemSpy: Mock<(key: string, value: string) => void>;
+  let removeItemSpy: Mock<(key: string) => void>;
+  let storage: HawkLocalStorage;
+
+  beforeEach(() => {
+    localStorage.clear();
+    storage = new HawkLocalStorage();
+    getItemSpy = vi.spyOn(Storage.prototype, 'getItem');
+    setItemSpy = vi.spyOn(Storage.prototype, 'setItem');
+    removeItemSpy = vi.spyOn(Storage.prototype, 'removeItem');
+  });
+
+  afterEach(() => {
+    vi.restoreAllMocks();
+  });
+
+  it('should return null when key does not exist', () => {
+    expect(storage.getItem('foo')).toBeNull();
+    expect(getItemSpy).toHaveBeenCalledOnce();
+  });
+
+  it('should return value when key exists in storage', () => {
+    localStorage.setItem('foo', 'bar');
+
+    expect(storage.getItem('foo')).toEqual('bar');
+    expect(getItemSpy).toHaveBeenCalledWith('foo');
+  });
+
+  it('should persist item via setItem()', () => {
+    storage.setItem('foo', 'bar');
+
+    expect(setItemSpy).toHaveBeenCalledWith('foo', 'bar');
+    expect(localStorage.getItem('foo')).toEqual('bar');
+  });
+
+  it('should remove item via removeItem()', () => {
+    localStorage.setItem('foo', 'bar');
+    storage.removeItem('foo');
+
+    expect(removeItemSpy).toHaveBeenCalledWith('foo');
+    expect(localStorage.getItem('foo')).toBeNull();
+  });
+
+  it('should not affect other keys when removing', () => {
+    localStorage.setItem('foo', 'bar');
+    storage.removeItem('baz');
+
+    expect(removeItemSpy).toHaveBeenCalledWith('baz');
+    expect(localStorage.getItem('foo')).toEqual('bar');
+  });
+});

packages/browser/tsconfig.test.json

@@ -0,0 +1,13 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": null,
+    "declaration": false,
+    "types": ["vitest/globals"]
+  },
+  "include": [
+    "src/**/*",
+    "tests/**/*",
+    "vitest.config.ts"
+  ]
+}

packages/browser/vitest.config.ts

@@ -0,0 +1,16 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    globals: true,
+    environment: 'jsdom',
+    include: ['tests/**/*.test.ts'],
+    typecheck: {
+      tsconfig: './tsconfig.test.json',
+    },
+    coverage: {
+      provider: 'v8',
+      include: ['src/**/*.ts'],
+    },
+  },
+});

packages/core/package.json

@@ -17,7 +17,8 @@
     }
   },
   "scripts": {
-    "build": "vite build"
+    "build": "vite build",
+    "lint": "eslint --fix \"src/**/*.{js,ts}\""
   },
   "repository": {
     "type": "git",

packages/core/src/index.ts

@@ -0,0 +1 @@
+export type { HawkStorage } from './storages/hawk-storage';