@orochibraru/svelte-smol 1.8.2 → 1.8.3

package/README.md

@@ -10,6 +10,9 @@ no JS files to ship, just one binary plus its static assets.
 bun add -d @orochibraru/svelte-smol
 ```
 
+Every merge to `main` ships as `@orochibraru/svelte-smol@canary`; stable
+releases go out under `latest`.
+
 ## Usage
 
 ```typescript
@@ -29,28 +32,68 @@ The compile step runs under the Bun runtime, so build with:
 bun run vite build
 ```
 
-## SvelteKit 3
+## SvelteKit 2 and SvelteKit 3
 
-SvelteKit 3 (prerelease) is supported by the same package: the adapter detects
-which SvelteKit is building the app. Pass it to the Vite plugin instead of
-`svelte.config.js`:
+One package supports both. There is no flag to set: at build time the adapter
+checks which SvelteKit is running the build and uses the matching
+implementation. Upgrading SvelteKit is enough to switch.
 
-```typescript
-// vite.config.js
-import { sveltekit } from "@sveltejs/kit/vite";
-import { defineConfig } from "vite";
-import adapter from "@orochibraru/svelte-smol";
+|                     | SvelteKit 2                             | SvelteKit 3 (prerelease)                       |
+| ------------------- | --------------------------------------- | ---------------------------------------------- |
+| Adapter config      | `svelte.config.js`                      | `vite.config.js`, passed to `sveltekit()`      |
+| Static assets       | `client/` and `prerendered/` beside it  | embedded in the executable                     |
+| Build options       | top level (`compile`, `target`, …)      | under `buildOptions`                           |
+| `Bun.serve` options | `serveOptions`                          | `serverOptions` (JSON-serializable only)       |
+| Public origin       | `ORIGIN` env var                        | `ORIGIN` env var, else `paths.origin`          |
 
-export default defineConfig({
-  plugins: [sveltekit({ adapter: adapter() })],
-});
+The rest of this README covers SvelteKit 2. For SvelteKit 3's options,
+environment variables and output, see [SvelteKit 3](docs/sveltekit-3.md).
+
+### Upgrading to SvelteKit 3
+
+1. Install SvelteKit 3: `bun add -d @sveltejs/kit@next`.
+2. Move the adapter from `svelte.config.js` into the Vite plugin:
+
+   ```typescript
+   // vite.config.js
+   import { sveltekit } from "@sveltejs/kit/vite";
+   import { defineConfig } from "vite";
+   import adapter from "@orochibraru/svelte-smol";
+
+   export default defineConfig({
+     plugins: [sveltekit({ adapter: adapter() })],
+   });
+   ```
+
+3. Rename your options and env vars:
+
+   | SvelteKit 2                       | SvelteKit 3                                      |
+   | --------------------------------- | ------------------------------------------------ |
+   | `compile: false`                  | `buildOptions: { compile: false }`               |
+   | `target: "bun-linux-x64"`         | `buildOptions: { compile: "bun-linux-x64" }`     |
+   | `name: "app"`                     | `buildOptions: { compile: { outfile: "app" } }`  |
+   | `bytecode`, `minify`, `sourcemap` | `buildOptions.*`                                 |
+   | `serveOptions`                    | `serverOptions` (JSON-serializable only)         |
+   | `serveAssets: false`              | removed, assets are embedded                     |
+   | `IDLE_TIMEOUT`                    | `CONNECTION_IDLE_TIMEOUT`                        |
+   | `ASSETS_DIR`                      | removed, assets are embedded                     |
+
+4. Deploy the `build/server` executable on its own: it no longer needs the
+   `client/` and `prerendered/` folders next to it.
+
+`out`, `healthcheck` and `envPrefix` work the same on both. `precompress` too,
+except that SvelteKit 3 ignores it when compiling, since it has no asset files
+to serve. Options that belong to the other SvelteKit version fail the build instead of
+being ignored:
+
+```text
+svelte-smol: compile not supported with SvelteKit 3. See https://github.com/orochibraru/svelte-smol/blob/main/docs/sveltekit-3.md for the option mapping.
 ```
 
-On SvelteKit 3 the assets are embedded in the executable and the options
-change (`buildOptions`, `serverOptions`). Options meant for the other SvelteKit
-version fail the build. See [SvelteKit 3](docs/sveltekit-3.md) for the options,
-environment variables and the migration table. The rest of this README covers
-SvelteKit 2.
+Going back to SvelteKit 2 is the same steps in reverse.
+
+SvelteKit 2 support will be deprecated once SvelteKit 3 is stable, and removed
+in the next major version of this package.
 
 ## Output
 
@@ -130,7 +173,7 @@ runtime the first time you use a target.
 | `PORT`                | `3000`     | Listen port                                                                                     |
 | `SOCKET_PATH`         | —          | Listen on a Unix socket instead of `HOST`/`PORT`                                                |
 | `ASSETS_DIR`          | —          | Override where `client/` and `prerendered/` are looked up (absolute, or relative to the binary) |
-| `ORIGIN`              | —          | Absolute origin used for request URL resolution                                                 |
+| `ORIGIN`              | —          | Public origin, read at runtime (Kit 2 and 3; on Kit 3 it overrides `paths.origin`)              |
 | `PROTOCOL_HEADER`     | —          | Header carrying the forwarded protocol (e.g. `x-forwarded-proto`)                               |
 | `HOST_HEADER`         | —          | Header carrying the forwarded host                                                              |
 | `PORT_HEADER`         | —          | Header carrying the forwarded port                                                              |

package/dist/kit3/templates/env.ts

@@ -5,6 +5,7 @@ const expected = new Set([
 	"SOCKET_PATH",
 	"HOST",
 	"PORT",
+	"ORIGIN",
 	"REUSE_PORT",
 	"IPV6_ONLY",
 	"CONNECTION_IDLE_TIMEOUT",

package/dist/kit3/templates/handler.ts

@@ -9,6 +9,8 @@ const protocol_header = env("PROTOCOL_HEADER", "").toLowerCase();
 const host_header = env("HOST_HEADER", "").toLowerCase();
 const port_header = env("PORT_HEADER", "").toLowerCase();
 const xff_depth = number_env("XFF_DEPTH", 1, { min: 1 });
+// runtime wins over paths.origin: the same build is deployed at different origins
+const origin_env = parse_origin(env("ORIGIN", undefined));
 
 await server.init({
 	env: Bun.env as Record<string, string>,
@@ -43,6 +45,7 @@ function normalize_request(request: Request): Request | Response {
 		const url = new URL(request.url);
 		const request_origin =
 			same_host_remote_origin(request, url) ||
+			origin_env ||
 			origin ||
 			get_origin(request, url);
 		return request_origin === url.origin
@@ -56,6 +59,19 @@ function normalize_request(request: Request): Request | Response {
 	}
 }
 
+function parse_origin(value: string | undefined): string | undefined {
+	// empty means unset, as in the Kit 2 handler
+	if (!value) return undefined;
+	// .origin drops any path or trailing slash, so the url.origin comparison holds
+	const url = URL.parse(value);
+	if (!url || !/^https?:$/.test(url.protocol)) {
+		throw new Error(
+			`Invalid value for environment variable ${env_prefix}ORIGIN: ${JSON.stringify(value)} (expected an absolute URL, e.g. https://my.site)`,
+		);
+	}
+	return url.origin;
+}
+
 function get_origin(request: Request, url: URL): string {
 	// assume TLS terminates upstream, like adapter-node; an http origin would fail CSRF checks
 	const protocol = decodeURIComponent(

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@orochibraru/svelte-smol",
-	"version": "1.8.2",
+	"version": "1.8.3",
 	"type": "module",
 	"main": "./dist/index.js",
 	"keywords": [
@@ -36,7 +36,7 @@
 		"build": "rm -rf dist && tsc -p tsconfig.build.json && cp -R kit2/templates dist/kit2/templates && cp -R kit3/templates dist/kit3/templates",
 		"prepack": "bun run build",
 		"typecheck": "tsc --noEmit -p tsconfig.json && tsc --noEmit -p kit2 && tsc --noEmit -p kit3",
-		"test": "bun test index.test.ts",
+		"test": "bun test index.test.ts handler.test.ts",
 		"test:integration": "bun test integration",
 		"lint": "biome check .",
 		"lint:fix": "biome check --write .",