@soham20/smart-offline-sdk 0.1.2 → 0.1.4

package/package.json

@@ -1,17 +1,41 @@
 {
   "name": "@soham20/smart-offline-sdk",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Smart offline-first JavaScript SDK with intelligent caching for web applications",
-  "main": "src/sdk/index.js",
+  "main": "./src/index.cjs.js",
+  "module": "./src/index.js",
+  "browser": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./src/index.js",
+      "require": "./src/index.cjs.js",
+      "browser": "./src/index.js",
+      "default": "./src/index.js"
+    },
+    "./client": {
+      "require": "./src/sdk/index.cjs"
+    }
+  },
+  "files": [
+    "src",
+    "smart-offline-sw.js"
+  ],
   "scripts": {
-    "test": "jest",
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
     "build": "echo \"no build step\"",
     "lint": "echo \"no lint configured\""
   },
-  "keywords": [],
+  "keywords": [
+    "offline",
+    "pwa",
+    "service-worker",
+    "cache",
+    "offline-first"
+  ],
   "author": "Atif Sayed",
   "license": "MIT",
-  "type": "commonjs",
+  "type": "module",
   "devDependencies": {
     "jest": "^29.0.0"
   }

package/src/index.cjs.js

@@ -0,0 +1,58 @@
+/**
+ * SmartOffline SDK (CommonJS version)
+ */
+function init(config = {}) {
+  if (typeof navigator === "undefined" || !("serviceWorker" in navigator)) {
+    console.warn("Service Workers not supported");
+    return;
+  }
+
+  const sdkConfig = {
+    pages: config.pages || [],
+    apis: config.apis || [],
+    debug: config.debug || false,
+    frequencyThreshold: config.frequencyThreshold ?? 3,
+    recencyThreshold: config.recencyThreshold ?? 24 * 60 * 60 * 1000,
+    maxResourceSize: config.maxResourceSize ?? Infinity,
+    networkQuality: config.networkQuality ?? "auto",
+    significance: config.significance ?? {},
+  };
+
+  navigator.serviceWorker.register("/smart-offline-sw.js").then(() => {
+    console.log("Smart Offline Service Worker registered");
+
+    navigator.serviceWorker.ready.then(() => {
+      if (navigator.serviceWorker.controller) {
+        navigator.serviceWorker.controller.postMessage({
+          type: "INIT_CONFIG",
+          payload: sdkConfig,
+        });
+
+        if (sdkConfig.debug) {
+          console.log("[SmartOffline] Config sent to SW:", sdkConfig);
+        }
+      }
+    });
+
+    navigator.serviceWorker.addEventListener("controllerchange", () => {
+      if (navigator.serviceWorker.controller) {
+        navigator.serviceWorker.controller.postMessage({
+          type: "INIT_CONFIG",
+          payload: sdkConfig,
+        });
+
+        if (sdkConfig.debug) {
+          console.log(
+            "[SmartOffline] Config sent after controllerchange:",
+            sdkConfig,
+          );
+        }
+      }
+    });
+  });
+}
+
+const SmartOffline = { init };
+
+module.exports = { SmartOffline };
+module.exports.default = SmartOffline;

package/src/index.d.ts

@@ -0,0 +1,25 @@
+export interface SmartOfflineConfig {
+  /** Array of page URL patterns to cache */
+  pages?: string[];
+  /** Array of API URL patterns to cache */
+  apis?: string[];
+  /** Enable debug logging */
+  debug?: boolean;
+  /** Number of accesses before resource is considered "frequent" (default: 3) */
+  frequencyThreshold?: number;
+  /** Milliseconds within which resource is considered "recent" (default: 24h) */
+  recencyThreshold?: number;
+  /** Max bytes to cache per resource; larger resources skipped (default: Infinity) */
+  maxResourceSize?: number;
+  /** Network quality setting: 'auto' | 'fast' | 'slow' (default: 'auto') */
+  networkQuality?: 'auto' | 'fast' | 'slow';
+  /** Manual priority overrides by URL pattern */
+  significance?: Record<string, 'high' | 'normal' | 'low'>;
+}
+
+export interface SmartOfflineSDK {
+  init(config?: SmartOfflineConfig): void;
+}
+
+export declare const SmartOffline: SmartOfflineSDK;
+export default SmartOffline;

package/src/index.js

@@ -18,8 +18,11 @@ function init(config = {}) {
     pages: config.pages || [],
     apis: config.apis || [],
     debug: config.debug || false,
-
-    
+    frequencyThreshold: config.frequencyThreshold ?? 3,
+    recencyThreshold: config.recencyThreshold ?? 24 * 60 * 60 * 1000,
+    maxResourceSize: config.maxResourceSize ?? Infinity,
+    networkQuality: config.networkQuality ?? "auto",
+    significance: config.significance ?? {},
   };
 
   navigator.serviceWorker.register("/smart-offline-sw.js").then(() => {
@@ -48,7 +51,7 @@ function init(config = {}) {
         if (sdkConfig.debug) {
           console.log(
             "[SmartOffline] Config sent after controllerchange:",
-            sdkConfig
+            sdkConfig,
           );
         }
       }
@@ -58,5 +61,5 @@ function init(config = {}) {
 
 const SmartOffline = { init };
 
-export { SmartOffline };       // ✅ named export
-export default SmartOffline;  // ✅ default export
+export { SmartOffline }; // ✅ named export
+export default SmartOffline; // ✅ default export

package/CONTRIBUTING.md

@@ -1,5 +0,0 @@
-# Contributing
-
-- Fork the repo and open a PR.
-- Run tests with `npm test`.
-- Follow the code style in existing files.

package/PROJECT_ANALYSIS.md

@@ -1,94 +0,0 @@
-# SmartOffline SDK — Project Analysis
-
-Date: 2026-01-22
-
----
-
-## Project Summary
-
-SmartOffline is a JavaScript SDK that enables offline-first behavior by registering a Service Worker which caches configured pages and API responses. The repository includes a demo, basic tests, and a Node-style test SDK.
-
-Key locations:
-
-- `smart-offline-sw.js` — Service Worker implementing caching, usage tracking, and priority logic.
-- `src/index.js` — Browser SDK entry (`SmartOffline.init`) that registers the SW and sends configuration.
-- `src/usageTracker.js` — IndexedDB-based usage tracker (client-side helper).
-- `src/sdk/index.js` — Small Node test client (`HackvisionClient`) used by tests/examples.
-- `demo/` — Demo page and sample API (`demo/index.html`, `demo/api/profile.json`).
-- `tests/` — `tests/basic.test.js` (Jest) covering the test client.
-
----
-
-## Features That Work (Implemented)
-
-- Service Worker registration via `SmartOffline.init()` (browser).
-- SW intercepts `GET` requests for configured pages and APIs and caches successful network responses.
-- Offline fallback: SW serves cached responses when fetch fails.
-- Usage tracking in IndexedDB (stores `count` and `lastAccessed` per URL) implemented both in `smart-offline-sw.js` and `src/usageTracker.js`.
-- Priority determination (high/normal) based on frequency and recency thresholds.
-- Demo implementation showing SDK usage and an API example.
-- Node test client (`HackvisionClient.echo`) and unit test (`jest`) pass.
-- CI workflow exists to run tests (.github/workflows/ci.yml).
-- Package published as `@soham20/smart-offline-sdk` (v0.1.1).
-
----
-
-## Issues & Gaps (Needs Attention)
-
-- README contains unresolved merge markers. Clean and add clear quickstarts for browser and Node.
-- `package.json` declares `"type": "commonjs"` but `src/index.js` uses ESM-style `export` (module mismatch). This may confuse Node consumers and bundlers.
-- No build/bundling step: source files are published directly. This reduces compatibility across consumers (CJS/ESM/browser UMD). No `dist/` artifacts.
-- Service Worker behavior is not covered by automated integration tests (typical but recommended to add Playwright/Puppeteer tests for offline behavior).
-- Inconsistent public API surface: demo uses `SmartOffline.init()` while package `main` points to `src/sdk/index.js` (Node test client). Clarify and add a top-level entry that documents both browser and Node exports.
-- Privacy/consent: usage tracking stores per-URL usage in IndexedDB — document privacy implications and provide opt-out.
-- No cache eviction / quota management — cache can grow without limits.
-
----
-
-## Short-Term Recommendations (Actionable)
-
-1. Fix `README.md` (remove merge markers) and add clear Quickstart sections for browser and Node usage.
-2. Standardize module format:
-   - Option A: Build ESM + CJS bundles (Rollup) and set `main`/`module`/`exports` in `package.json`.
-   - Option B: Convert `src/index.js` to CommonJS `module.exports` if targeting Node-only.
-3. Add a build step that outputs `dist/` bundles (UMD for browsers, ESM and CJS for Node). Update `package.json` scripts (`build`, `prepublishOnly`).
-4. Add integration tests (Playwright) that:
-   - Serve demo, register SW, fetch a resource online, go offline, and verify cached response is served.
-5. Add cache size management (LRU or simple max-entries) using usage metrics in IndexedDB.
-6. Document the usage tracking behavior and add opt-out configuration (e.g., `trackUsage: false`).
-
----
-
-## Mid/Large-Term Enhancements (Future)
-
-- Prefetching & background sync for high-priority resources.
-- Configurable stale-while-revalidate and TTL per resource.
-- TypeScript conversion + publishing type definitions.
-- Expose a small diagnostics API so apps can query cache status and usage stats.
-- Publish a UMD browser bundle and host on a CDN for direct `<script>` usage.
-- Telemetry (opt-in) and analytics for adoption + cache effectiveness metrics.
-
----
-
-## Suggested Next Steps (I can implement)
-
-- Patch `README.md` to a clean quickstart (browser + Node).
-- Add a small build setup (Rollup) to produce `dist/` artifacts and update `package.json`.
-- Add a Playwright integration test for offline cache validation.
-
-If you want, I can: (pick one or more)
-
-- Fix the `README.md` now.
-- Add a minimal Rollup build and update `package.json`.
-- Add a Playwright test and a small local server script to run it.
-
----
-
-## Notes & Observations
-
-- The published package name changed from `hackvision2026-sdk` (spam-detected) to scoped `@soham20/smart-offline-sdk`, which is preferable.
-- Tests pass (`npm test`). The test target is small (echo), so expand tests to include SDK behavior where feasible.
-
----
-
-_Generated by repository scan on 2026-01-22._