@b9g/shovel 0.2.3 → 0.2.4

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2023 Brian Kim
+Copyright 2026 Brian Kim
 
 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:
 

package/README.md

@@ -1,15 +1,31 @@
-# Shovel.js 🪏
+# Shovel.js
 
-**The portable meta-framework built on web standards.**
+**Run Service Workers anywhere.**
 
-Shovel is a CLI platform for developing and deploying service workers as application servers.
+Shovel is a meta-framework for building server applications using the ServiceWorker API. Write once, deploy to Node.js, Bun, or Cloudflare Workers.
 
-```javascript
-// src/server.ts
+```typescript
+// server.ts
 import {Router} from "@b9g/router";
+
 const router = new Router();
 
-router.route("/").get(() => new Response("Hello world"));
+router.route("/kv/:key")
+  .get(async (req, ctx) => {
+    const cache = await self.caches.open("kv");
+    const cached = await cache.match(ctx.params.key);
+    return cached ?? new Response(null, {status: 404});
+  })
+  .put(async (req, ctx) => {
+    const cache = await self.caches.open("kv");
+    await cache.put(ctx.params.key, new Response(await req.text()));
+    return new Response(null, {status: 201});
+  })
+  .delete(async (req, ctx) => {
+    const cache = await self.caches.open("kv");
+    await cache.delete(ctx.params.key);
+    return new Response(null, {status: 204});
+  });
 
 self.addEventListener("fetch", (ev) => {
   ev.respondWith(router.handle(ev.request));
@@ -17,30 +33,20 @@ self.addEventListener("fetch", (ev) => {
 ```
 
 ```bash
-shovel develop src/server.ts
-```
-## Quick Start
+$ shovel develop server.ts
+listening on http://localhost:7777
 
-```javascript
-// src/server.js
-import {Router} from "@b9g/router";
+$ curl -X PUT :7777/kv/hello -d "world"
 
-const router = new Router();
-
-router.route("/").get(() => new Response("Hello World"));
-
-router.route("/greet/:name").get((request, {params}) => {
-  return new Response(`Hello ${params.name}`);
-});
-
-self.addEventListener("fetch", (event) => {
-  event.respondWith(router.handle(event.request));
-});
+$ curl :7777/kv/hello
+world
 ```
 
+## Quick Start
+
 ```bash
 # Create a new project
-npm create @b9g/shovel my-app
+npm create shovel my-app
 
 # Development with hot reload
 npx @b9g/shovel develop src/server.ts
@@ -51,19 +57,23 @@ npx @b9g/shovel build src/server.ts --platform=bun
 npx @b9g/shovel build src/server.ts --platform=cloudflare
 ```
 
+## Documentation
+
+Visit [shovel.js.org](https://shovel.js.org) for guides and API reference.
 
 ## Web Standards
+
 Shovel is obsessively standards-first. All Shovel APIs use web standards, and Shovel implements/shims useful standards when they're missing.
 
-  | API | Standard | Purpose |
-  |-----|----------|--------------|
-  | `fetch()` | [Fetch](https://fetch.spec.whatwg.org) | Networking |
-  | `install`, `activate`, `fetch` events | [Service Workers](https://w3c.github.io/ServiceWorker/) | Server lifecycle |
-  | `AsyncContext.Variable` | [TC39 Stage 2](https://github.com/tc39/proposal-async-context) | Request-scoped state |
-  | `self.caches` | [Cache API](https://w3c.github.io/ServiceWorker/#cache-interface) | Response caching |
-  | `self.directories` | [FileSystem API](https://fs.spec.whatwg.org/) | Storage (local, S3, R2) |
-  | `self.cookieStore` | [CookieStore API](https://cookiestore.spec.whatwg.org) | Cookie management |
-  | `URLPattern` | [URLPattern](https://urlpattern.spec.whatwg.org/) | Route matching |
+| API | Standard | Purpose |
+|-----|----------|---------|
+| `fetch()` | [Fetch](https://fetch.spec.whatwg.org) | Networking |
+| `install`, `activate`, `fetch` events | [Service Workers](https://w3c.github.io/ServiceWorker/) | Server lifecycle |
+| `AsyncContext.Variable` | [TC39 Stage 2](https://github.com/tc39/proposal-async-context) | Request-scoped state |
+| `self.caches` | [Cache API](https://w3c.github.io/ServiceWorker/#cache-interface) | Response caching |
+| `self.directories` | [FileSystem API](https://fs.spec.whatwg.org/) | Storage (local, S3, R2) |
+| `self.cookieStore` | [CookieStore API](https://cookiestore.spec.whatwg.org) | Cookie management |
+| `URLPattern` | [URLPattern](https://urlpattern.spec.whatwg.org/) | Route matching |
 
 Your code uses standards. Shovel makes them work everywhere.
 
@@ -87,7 +97,7 @@ The core abstraction is the **ServiceWorker-style storage pattern**. Globals pro
 const cache  = await self.caches.open("sessions");     // Cache API
 const dir    = await self.directories.open("uploads"); // FileSystem API
 const db     = self.databases.get("main");             // Zen DB (opened on activate)
-const logger = self.loggers.get(["app", "requests"]); // LogTape
+const logger = self.loggers.get(["app", "requests"]);  // LogTape
 ```
 
 Each storage type is:
@@ -168,27 +178,27 @@ Shovel's configuration follows these principles:
 
 ```json
 {
-  "port": "PORT || 3000",
-  "host": "HOST || localhost",
-  "workers": "WORKERS ?? 1",
+  "port": "$PORT || 7777",
+  "host": "$HOST || localhost",
+  "workers": "$WORKERS ?? 1",
   "caches": {
     "sessions": {
       "module": "@b9g/cache-redis",
       "export": "RedisCache",
-      "url": "REDIS_URL"
+      "url": "$REDIS_URL"
     }
   },
   "directories": {
     "uploads": {
       "module": "@b9g/filesystem-s3",
       "export": "S3Directory",
-      "bucket": "S3_BUCKET"
+      "bucket": "$S3_BUCKET"
     }
   },
   "databases": {
     "main": {
       "module": "@b9g/zen/bun",
-      "url": "DATABASE_URL"
+      "url": "$DATABASE_URL"
     }
   },
   "logging": {
@@ -213,7 +223,7 @@ Configure cache backends using `module` and `export`:
     "sessions": {
       "module": "@b9g/cache-redis",
       "export": "RedisCache",
-      "url": "REDIS_URL"
+      "url": "$REDIS_URL"
     }
   }
 }
@@ -292,7 +302,7 @@ Configure database drivers using the same `module`/`export` pattern:
   "databases": {
     "main": {
       "module": "@b9g/zen/bun",
-      "url": "DATABASE_URL"
+      "url": "$DATABASE_URL"
     }
   }
 }
@@ -359,7 +369,7 @@ $DATADIR/uploads        → joins env var with path segment
 
 ```json
 {
-  "port": "$PORT || 3000",
+  "port": "$PORT || 7777",
   "host": "$HOST || 0.0.0.0",
   "directories": {
     "server": { "path": "[outdir]/server" },
@@ -388,17 +398,17 @@ console.log(config.port); // Resolved value
 | Package | Description |
 |---------|-------------|
 | `@b9g/shovel` | CLI for development and deployment |
-| `@b9g/platform` | Core runtime and platform APIs |
-| `@b9g/platform-node` | Node.js adapter |
-| `@b9g/platform-bun` | Bun.js adapter |
-| `@b9g/platform-cloudflare` | Cloudflare Workers adapter |
 | `@b9g/router` | URLPattern-based routing with middleware |
 | `@b9g/cache` | Cache API implementation |
 | `@b9g/filesystem` | File System Access implementation |
-| `@b9g/match-pattern` | URLPattern with extensions (100% WPT) |
 | `@b9g/async-context` | AsyncContext.Variable implementation |
 | `@b9g/http-errors` | Standard HTTP error classes |
 | `@b9g/assets` | Static asset handling |
+| `@b9g/platform` | Core runtime and platform APIs |
+| `@b9g/platform-node` | Node.js adapter |
+| `@b9g/platform-bun` | Bun adapter |
+| `@b9g/platform-cloudflare` | Cloudflare Workers adapter |
+| `@b9g/match-pattern` | URLPattern with extensions (100% WPT) |
 
 ## License
 

package/bin/cli.js

@@ -5,7 +5,7 @@ import {
   DEFAULTS,
   findProjectRoot,
   loadConfig
-} from "../src/_chunks/chunk-NZVIBZYG.js";
+} from "../src/_chunks/chunk-7GONPLNW.js";
 
 // bin/cli.ts
 import { resolve, relative } from "path";
@@ -75,15 +75,23 @@ program.command("develop <entrypoint>").description("Start development server wi
   DEFAULTS.WORKERS
 ).option("--platform <name>", "Runtime platform (node, cloudflare, bun)").action(async (entrypoint, options) => {
   checkPlatformReexec(options);
-  const { developCommand } = await import("../src/_chunks/develop-6DPQE5H4.js");
+  const { developCommand } = await import("../src/_chunks/develop-JUQG2G7M.js");
   await developCommand(entrypoint, options, config);
 });
+program.command("create [name]").description("Create a new Shovel project").action(async (name) => {
+  if (name) {
+    process.argv = [process.argv[0], process.argv[1], name];
+  } else {
+    process.argv = [process.argv[0], process.argv[1]];
+  }
+  await import("./create.js");
+});
 program.command("build <entrypoint>").description("Build app for production").option("--platform <name>", "Runtime platform (node, cloudflare, bun)").option(
   "--lifecycle [stage]",
   "Run ServiceWorker lifecycle after build (install or activate, default: activate)"
 ).action(async (entrypoint, options) => {
   checkPlatformReexec(options);
-  const { buildCommand } = await import("../src/_chunks/build-BM4A74RI.js");
+  const { buildCommand } = await import("../src/_chunks/build-KBQU2OA7.js");
   await buildCommand(entrypoint, options, config);
   process.exit(0);
 });

package/bin/create.js

@@ -134,7 +134,7 @@ async function main() {
     console.info(`  npm install`);
     console.info(`  npm run dev`);
     console.info("");
-    console.info("Your app will be available at: http://localhost:3000");
+    console.info("Your app will be available at: http://localhost:7777");
     console.info("");
   } catch (error) {
     s.stop("Failed to create project");
@@ -497,7 +497,7 @@ npm install
 npm run dev
 \`\`\`
 
-Open http://localhost:3000
+Open http://localhost:7777
 
 ## Scripts
 

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "@b9g/shovel",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "ServiceWorker-first universal deployment platform. Write ServiceWorker apps once, deploy anywhere (Node/Bun/Cloudflare). Registry-based multi-app orchestration.",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bikeshaving/shovel.git"
+  },
   "bin": {
     "shovel": "bin/cli.js",
     "create-shovel": "bin/create.js",
@@ -10,15 +14,15 @@
     "create": "bin/create.js"
   },
   "dependencies": {
-    "@b9g/async-context": "^0.2.0",
-    "@b9g/cache": "^0.2.0",
-    "@b9g/filesystem": "^0.1.8",
-    "@b9g/http-errors": "^0.2.0",
-    "@b9g/node-webworker": "^0.2.0",
-    "@b9g/platform": "^0.1.15",
-    "@b9g/platform-bun": "^0.1.13",
-    "@b9g/platform-cloudflare": "^0.1.13",
-    "@b9g/platform-node": "^0.1.15",
+    "@b9g/async-context": "^0.2.1",
+    "@b9g/cache": "^0.2.1",
+    "@b9g/filesystem": "^0.1.9",
+    "@b9g/http-errors": "^0.2.1",
+    "@b9g/node-webworker": "^0.2.1",
+    "@b9g/platform": "^0.1.16",
+    "@b9g/platform-bun": "^0.1.14",
+    "@b9g/platform-cloudflare": "^0.1.14",
+    "@b9g/platform-node": "^0.1.16",
     "@clack/prompts": "^0.7.0",
     "@esbuild-plugins/node-globals-polyfill": "^0.2.3",
     "@esbuild-plugins/node-modules-polyfill": "^0.2.2",
@@ -29,18 +33,11 @@
     "zod": "^3.23.0"
   },
   "devDependencies": {
-    "@b9g/assets": "^0.2.0",
-    "@b9g/cache": "^0.2.0",
+    "@b9g/assets": "^0.2.1",
     "@b9g/crank": "^0.7.2",
-    "@logtape/file": "^1.0.0",
-    "@b9g/filesystem": "^0.1.8",
-    "@b9g/http-errors": "^0.2.0",
     "@b9g/libuild": "^0.1.22",
-    "@b9g/platform": "^0.1.15",
-    "@b9g/platform-bun": "^0.1.13",
-    "@b9g/platform-cloudflare": "^0.1.13",
-    "@b9g/platform-node": "^0.1.15",
-    "@b9g/router": "^0.2.0",
+    "@b9g/router": "^0.2.1",
+    "@logtape/file": "^1.0.0",
     "@types/bun": "^1.3.4",
     "@typescript-eslint/eslint-plugin": "^8.0.0",
     "@typescript-eslint/parser": "^8.0.0",

package/src/_chunks/{build-BM4A74RI.js → build-KBQU2OA7.js}

@@ -1,11 +1,11 @@
 import {
   ServerBundler,
   loadPlatformModule
-} from "./chunk-WVHECOTO.js";
+} from "./chunk-ABGHNBNM.js";
 import {
   findProjectRoot,
   findWorkspaceRoot
-} from "./chunk-NZVIBZYG.js";
+} from "./chunk-7GONPLNW.js";
 
 // src/commands/build.ts
 import { resolve, join, dirname, basename } from "path";

package/src/_chunks/{chunk-NZVIBZYG.js → chunk-7GONPLNW.js}

@@ -36,7 +36,7 @@ import { z } from "zod";
 var DANGEROUS_KEYS = /* @__PURE__ */ new Set(["__proto__", "constructor", "prototype"]);
 var DEFAULTS = {
   SERVER: {
-    PORT: 3e3,
+    PORT: 7777,
     HOST: "0.0.0.0"
   },
   WORKERS: 1

package/src/_chunks/{chunk-WVHECOTO.js → chunk-ABGHNBNM.js}

@@ -4,7 +4,7 @@ import {
   generateStorageTypes,
   getNodeModulesPath,
   loadRawConfig
-} from "./chunk-NZVIBZYG.js";
+} from "./chunk-7GONPLNW.js";
 
 // src/utils/bundler.ts
 import * as ESBuild2 from "esbuild";

package/src/_chunks/{develop-6DPQE5H4.js → develop-JUQG2G7M.js}

@@ -1,10 +1,10 @@
 import {
   ServerBundler,
   loadPlatformModule
-} from "./chunk-WVHECOTO.js";
+} from "./chunk-ABGHNBNM.js";
 import {
   DEFAULTS
-} from "./chunk-NZVIBZYG.js";
+} from "./chunk-7GONPLNW.js";
 
 // src/commands/develop.ts
 import { getLogger } from "@logtape/logtape";