spark-html-offline 0.1.0 → 0.1.2

package/README.md

@@ -17,11 +17,10 @@ offline();
 ```
 
 ```js
-// vite.config.js — emits /spark-sw.js in build, serves it in dev
-import spark from 'spark-html/vite';
-import offlineSw from 'spark-html-offline/vite';
+// spark.config.js — writes /spark-sw.js in build, serves it in dev
+import offlineSw from 'spark-html-offline/bun';
 
-export default { plugins: [spark(), offlineSw()] };
+export default { pipeline: [offlineSw()] };
 ```
 
 ```html
@@ -54,9 +53,9 @@ own assets behave exactly as before.
 ## Options
 
 ```js
-// vite.config.js
+// spark.config.js
 offlineSw({
-  file: 'spark-sw.js',        // emitted worker file name
+  file: 'spark-sw.js',        // written worker file name
   include: ['/components/'],  // ALSO cache these same-origin paths
   exclude: ['/api/'],         // never touch these (substring match)
   cacheName: 'spark-offline-v1',
@@ -77,7 +76,7 @@ just without the safety net.
 
 ## No build step?
 
-You don't need Vite. Generate the worker once and host it next to
+You don't need the build step. Generate the worker once and host it next to
 `index.html`:
 
 ```js
@@ -96,7 +95,33 @@ Then call `offline()` from any `<script type="module">`.
 | `swSource(options?)` | The full worker source as a string. |
 | `shouldHandle(url, origin, config?)` | The matching rule the worker uses (exported for tests/tooling). |
 | `CACHE_NAME` | Default cache bucket name (`'spark-offline-v1'`). |
-| `spark-html-offline/vite` | Vite plugin — emits the worker in build, serves it in dev. |
+| `spark-html-offline/bun` | Build step — writes the worker in build, serves it in dev. |
+
+## The Spark family
+
+Small, single-purpose packages that share one philosophy: no compiler, no
+virtual DOM, no build step required. Add only what you use.
+
+| Package | What it does |
+|---|---|
+| [`spark-html`](https://www.npmjs.com/package/spark-html) | The runtime — components, reactivity, stores, forms, scoped styles. 13 kB gzip, 0 deps. |
+| [`spark-html-router`](https://www.npmjs.com/package/spark-html-router) | `<template route>` routing — nested routes/layouts, `route.query`, active links. |
+| [`spark-html-theme`](https://www.npmjs.com/package/spark-html-theme) | Dark/light/system theming in one line — persisted, no flash. |
+| [`spark-html-head`](https://www.npmjs.com/package/spark-html-head) | Reactive `<title>`/`<meta>` per route + a `head` store. |
+| [`spark-html-motion`](https://www.npmjs.com/package/spark-html-motion) | Enter/leave transitions on if/each blocks — `transition="fade|slide|scale"`. |
+| [`spark-html-devtools`](https://www.npmjs.com/package/spark-html-devtools) | In-page devtools — live stores, component tree, patch activity. |
+| [`spark-html-query`](https://www.npmjs.com/package/spark-html-query) | Declarative async data — a self-fetching store (`loading`/`error`/`data`/`refetch`). |
+| [`spark-html-persist`](https://www.npmjs.com/package/spark-html-persist) | Persist stores to localStorage/sessionStorage in one line. |
+| [`spark-html-websocket`](https://www.npmjs.com/package/spark-html-websocket) | A WebSocket as a reactive store — auto-reconnect, JSON, `send()`. |
+| [`spark-prerender`](https://www.npmjs.com/package/spark-prerender) | Build-time SEO prerender + sitemap/robots — no SSR server. |
+| [`spark-html-image`](https://www.npmjs.com/package/spark-html-image) | Build-time image optimization — webp/avif + responsive `srcset`, zero config. |
+| [`spark-html-font`](https://www.npmjs.com/package/spark-html-font) | Font loading optimizer — preload + size-adjusted fallbacks, no FOUT. |
+| [`spark-html-manifest`](https://www.npmjs.com/package/spark-html-manifest) | PWA manifest + icons + head tags (and optional service worker) from one config. |
+| [`spark-html-offline`](https://www.npmjs.com/package/spark-html-offline) | Offline URL imports — a service worker that caches CDN components. |
+| [`spark-html-sri`](https://www.npmjs.com/package/spark-html-sri) | Subresource Integrity — hash + verify assets and remote components. |
+| [`create-spark-html-app`](https://www.npmjs.com/package/create-spark-html-app) | Scaffold a spark-html app in one command. |
+| [`prettier-plugin-spark`](https://www.npmjs.com/package/prettier-plugin-spark) | Prettier for components — formats `<script>`/`<style>`, markup stays byte-for-byte. |
+| [`spark-html-language-server`](https://www.npmjs.com/package/spark-html-language-server) | LSP — diagnostics, go-to-definition, prop autocomplete, hover docs. |
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spark-html-offline",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Offline-capable URL imports for spark-html — a tiny service worker that caches CDN-imported components on first fetch and serves them when the network is gone. Zero dependencies.",
   "type": "module",
   "main": "./src/index.js",
@@ -11,9 +11,8 @@
       "types": "./src/index.d.ts",
       "default": "./src/index.js"
     },
-    "./vite": {
-      "types": "./src/vite.d.ts",
-      "default": "./src/vite.js"
+    "./bun": {
+      "default": "./src/bun.js"
     }
   },
   "scripts": {

package/src/bun.js

@@ -0,0 +1,33 @@
+/**
+ * spark-html-offline/bun — emit + serve the worker file, as a spark-html-bun
+ * pipeline step.
+ *
+ *   • run({ outDir }) — write the generated service worker into the output dir
+ *     (default /spark-sw.js) so offline() finds it in production.
+ *   • devRoutes() — serve the same source in dev, so the worker can be
+ *     exercised locally too (it only touches cross-origin URLs by default, so
+ *     HMR and local files are unaffected).
+ *
+ *   import offline from 'spark-html-offline/bun';
+ *   export default { pipeline: [offline({ include: ['/components/'] })] };
+ */
+import { join, resolve } from 'node:path';
+import { writeFile } from 'node:fs/promises';
+import { existsSync } from 'node:fs';
+import { swSource } from './index.js';
+
+export default function sparkOffline(options = {}) {
+  const file = (options.file || 'spark-sw.js').replace(/^\//, '');
+  const source = swSource(options);
+  return {
+    name: 'spark-html-offline',
+    async run({ outDir }) {
+      const root = resolve(outDir);
+      if (!existsSync(root)) return;
+      await writeFile(join(root, file), source, 'utf8');
+    },
+    devRoutes() {
+      return { [`/${file}`]: { type: 'text/javascript', body: () => source } };
+    },
+  };
+}

package/src/index.d.ts

@@ -1,4 +1,4 @@
-/** Options shared by the worker generator and the vite plugin. */
+/** Options shared by the worker generator and the build step. */
 export interface OfflineSwOptions {
   /** Same-origin URL substrings to cache too (e.g. ['/components/']). */
   include?: string[];
@@ -39,8 +39,8 @@ declare const _default: {
 };
 export default _default;
 
-/** Vite plugin: emits the worker in build, serves it in dev. */
-export interface OfflineVitePluginOptions extends OfflineSwOptions {
-  /** Emitted file name (default 'spark-sw.js'). */
+/** spark-html-bun build step: writes the worker in build, serves it in dev. */
+export interface OfflineBuildOptions extends OfflineSwOptions {
+  /** Written file name (default 'spark-sw.js'). */
   file?: string;
 }

package/src/index.js

@@ -12,8 +12,8 @@
  *   import { offline } from 'spark-html-offline';
  *   offline();
  *
- *   // vite.config.js — emits + serves the worker file for you
- *   import offlineSw from 'spark-html-offline/vite';
+ *   // spark.config.js — writes + serves the worker file for you
+ *   import offlineSw from 'spark-html-offline/bun';
  *   plugins: [spark(), offlineSw()]
  *
  * Works with any CDN (esm.sh, unpkg, jsdelivr, your own). By default it
@@ -53,7 +53,7 @@ export function shouldHandle(url, origin, config) {
 
 /**
  * The service-worker source, as a string — write it to a file served from
- * your origin (the vite plugin does this for you as /spark-sw.js).
+ * your origin (the bun build step does this for you as /spark-sw.js).
  *
  * Strategy: cache-first with background revalidation (stale-while-
  * revalidate). First visit fetches + caches; every visit after serves

package/src/vite.d.ts

@@ -1,8 +0,0 @@
-import type { OfflineVitePluginOptions } from './index.js';
-
-/** Vite plugin: emits the service worker in build, serves it in dev. */
-export default function sparkOffline(options?: OfflineVitePluginOptions): {
-  name: string;
-  configureServer(server: unknown): void;
-  generateBundle(): void;
-};

package/src/vite.js

@@ -1,35 +0,0 @@
-/**
- * spark-html-offline/vite — emit + serve the worker file.
- *
- * Build: writes the generated service worker into the output dir (default
- * name /spark-sw.js) so `offline()` finds it in production.
- * Dev: serves the same source from the dev server, so the worker can be
- * exercised locally too (it only touches cross-origin URLs by default, so
- * HMR and local files are unaffected).
- *
- *   import offlineSw from 'spark-html-offline/vite';
- *   plugins: [spark(), offlineSw({ include: ['/components/'] })]
- */
-import { swSource } from './index.js';
-
-export default function sparkOffline(options = {}) {
-  const file = (options.file || 'spark-sw.js').replace(/^\//, '');
-  const source = swSource(options);
-  return {
-    name: 'spark-html-offline',
-    configureServer(server) {
-      server.middlewares.use((req, res, next) => {
-        if ((req.url || '').split('?')[0] === `/${file}`) {
-          res.setHeader('Content-Type', 'text/javascript');
-          res.setHeader('Cache-Control', 'no-cache');
-          res.end(source);
-          return;
-        }
-        next();
-      });
-    },
-    generateBundle() {
-      this.emitFile({ type: 'asset', fileName: file, source });
-    },
-  };
-}