@eslym/sveltekit-adapter-bun 1.0.13 → 1.0.15

package/README.md

@@ -8,4 +8,65 @@ Another sveltekit adapter for bun, an alternative to [svelte-adapter-bun](https:
 bun add -d @eslym/sveltekit-adapter-bun
 ```
 
-TODO: add documentation
+## Setup dev server
+
+> [!NOTE]  
+> You do not need to do this if you are not using websocket in dev mode.
+
+1. Create an entrypoint file for dev server, e.g. `./dev.ts`
+2. Add the following code to the entrypoint file
+    ```typescript
+    import { patchSvelteKit, startDevServer } from '@eslym/sveltekit-adapter-bun';
+
+    await patchSvelteKit();
+    await startDevServer();
+    ```
+
+3. run `bun dev.ts`
+
+The `patchSvelteKit` function will patch the sveltekit using `bun patch` to let it get the original `Request` object from bun and pass it to the dev server, making `Bun.Server#upgrade` possible. The `startDevServer` function will start the dev server with websocket support.
+
+The `patchSvelteKit` will not impact anything in production build, since the production build will not involve `@sveltejs/kit/node` unless you are using it in your code.
+
+> [!IMPORTANT]
+> This dev server uses bun's internal stuff, so it might break in the future bun version, but the
+> production build will not be affected.
+
+## Use the websocket
+
+```typescript
+// ./src/app.d.ts
+// for the type checking
+
+import type { AdapterPlatform } from '@eslym/sveltekit-adapter-bun';
+
+// See https://kit.svelte.dev/docs/types#app
+// for information about these interfaces
+declare global {
+    namespace App {
+        // interface Error {}
+        // interface Locals {}
+        // interface PageData {}
+        // interface PageState {}
+        interface Platform extends AdapterPlatform {}
+    }
+}
+```
+
+```typescript
+// ./src/routes/echo/+server.ts
+
+export async function GET({ platform }) {
+    // can mark any response for upgrade, if the upgrade failed, the response will be sent as is
+    return platform!.markForUpgrade(
+        new Response('Websocket Requried', {
+            status: 400
+        }),
+        {
+            message(ws, message) {
+                ws.send(message);
+            }
+        }
+    );
+}
+```

package/dist/files/index.js

@@ -1,7 +1,7 @@
 // @bun
 // src/files/server.ts
-import {Server} from "SERVER";
-import {manifest} from "MANIFEST";
+import { Server } from "SERVER";
+import { manifest } from "MANIFEST";
 var server = new Server(manifest);
 await server.init({
   env: Bun.env,
@@ -11,7 +11,7 @@ await server.init({
 });
 
 // node_modules/cac/dist/index.mjs
-import {EventEmitter} from "events";
+import { EventEmitter } from "events";
 function toArr(any) {
   return any == null ? [] : Array.isArray(any) ? any : [any];
 }
@@ -618,16 +618,16 @@ function set_url(request, url) {
   return url;
 }
 function get_basepath() {
-  return basePath;
+  return globalThis[basePath] || "";
 }
 function set_basepath(path) {
-  basePath = path;
+  globalThis[basePath] = path;
 }
 var urls = new WeakMap;
-var basePath;
+var basePath = Symbol.for("app.basepath");
 
 // src/files/static.ts
-import {normalize} from "path/posix";
+import { normalize } from "path/posix";
 
 // src/mapping.ts
 var mapping = {
@@ -859,10 +859,10 @@ function create_fetch({
     resolvers.push((args) => override_origin_with_header(args, hostHeader, protocolHeader));
   }
   resolvers.push(({ request }) => serve_static(request, basePath2));
-  return async (request, srv) => {
+  return (request, srv) => {
     const request_ip = srv.requestIP(request)?.address;
     const try_get_ip = getIp ? () => getIp(request, request_ip) : () => request_ip;
-    return await first_resolve(request, [
+    return first_resolve(request, [
       ...resolvers,
       async (args) => {
         const res = await server.respond(args.request, {
@@ -894,7 +894,7 @@ function create_fetch({
 }
 
 // src/files/index.ts
-import {get_hooks} from "SERVER";
+import { get_hooks } from "SERVER";
 set_basepath(import.meta.dir);
 var hooks = await get_hooks();
 var cli = dist_default(CLI_NAME);
@@ -915,7 +915,7 @@ cli.command("", "Serve the app").alias("serve").option("--port, -p <port>", "Por
     hostname: options.host,
     port: options.port
   };
-  const server4 = Bun.serve({
+  const server2 = Bun.serve({
     ...serverOptions,
     fetch: create_fetch(options),
     websocket: {
@@ -940,8 +940,8 @@ cli.command("", "Serve the app").alias("serve").option("--port, -p <port>", "Por
       }
     }
   });
-  await hooks.afterServe?.(server4, options);
-  console.log(`Serving on ${server4.url}`);
+  await hooks.afterServe?.(server2, options);
+  console.log(`Serving on ${server2.url}`);
 });
 cli.help();
 await hooks.setupCLI?.(cli);
@@ -949,5 +949,6 @@ if (Bun.main === Bun.fileURLToPath(import.meta.url)) {
   cli.parse();
 }
 export {
+  create_fetch as createBunFetch,
   cli
 };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export type { WebSocketHandler } from './types';
+export type { WebSocketHandler, CreateFetchOptions } from './types';
 import type { AdapterOptions, AdapterPlatform } from './types';
 import type { Adapter } from '@sveltejs/kit';
 export * from './dev';

package/dist/index.js

@@ -3,22 +3,22 @@
 var name = "@eslym/sveltekit-adapter-bun";
 
 // src/index.ts
-import {fileURLToPath} from "url";
+import { fileURLToPath } from "url";
 import zlib from "zlib";
 import {
-createReadStream,
-createWriteStream,
-existsSync,
-readFileSync,
-statSync,
-writeFileSync
+  createReadStream,
+  createWriteStream,
+  existsSync,
+  readFileSync,
+  statSync,
+  writeFileSync
 } from "fs";
-import {pipeline} from "stream/promises";
-import {rollup} from "rollup";
-import {nodeResolve} from "@rollup/plugin-node-resolve";
+import { pipeline } from "stream/promises";
+import { rollup } from "rollup";
+import { nodeResolve } from "@rollup/plugin-node-resolve";
 import commonjs from "@rollup/plugin-commonjs";
 import json from "@rollup/plugin-json";
-import {join as join2} from "path/posix";
+import { join as join2 } from "path/posix";
 
 // node_modules/devalue/src/utils.js
 function is_primitive(thing) {
@@ -296,9 +296,16 @@ var symServer = Symbol.for(`${name}/server`);
 var symUpgrades = Symbol.for(`${name}/upgrades`);
 
 // src/dev.ts
-import {dirname, join} from "path";
-import {EventEmitter} from "events";
-import {IncomingMessage, ServerResponse} from "http";
+import { dirname, join } from "path";
+import { EventEmitter } from "events";
+import { IncomingMessage, ServerResponse } from "http";
+function setupBunternal(socket, bunServer, httpServer, httpRes, bunReq) {
+  if (Bun.semver.satisfies(Bun.version, "<1.1.25")) {
+    socket[bunternal] = [bunServer, httpRes, bunReq];
+    return;
+  }
+  socket[bunternal] = [httpServer, httpRes, bunReq];
+}
 async function patchSveltekit() {
   if (!("Bun" in globalThis)) {
     throw new Error("Please run with bun");
@@ -385,7 +392,7 @@ async function startDevServer({
       const req = new IncomingMessage(request);
       const res = new ServerResponse(req, respond);
       const socket = req.socket;
-      setupBunternal(socket, server2, fakeServer, req, request);
+      setupBunternal(socket, server2, fakeServer, res, request);
       req.once("error", raise);
       res.once("error", raise);
       if (request.headers.get("upgrade")) {
@@ -447,11 +454,6 @@ var setResponsePatch = `
 	}
 `;
 var bunternal = Symbol.for("::bunternal::");
-var setupBunternal = Bun.semver.satisfies(Bun.version, "<1.1.25") ? (socket, bunServer, _, httpReq, bunReq) => {
-  socket[bunternal] = [bunServer, httpReq, bunReq];
-} : (socket, _, httpServer, httpReq, bunReq) => {
-  socket[bunternal] = [httpServer, httpReq, bunReq];
-};
 
 // src/index.ts
 async function compress(directory, options) {

package/dist/types.d.ts

@@ -1,18 +1,17 @@
-/// <reference types="bun-types" />
-/// <reference types="node" />
-/// <reference types="bun-types" />
 import type { WebSocketHandler as BunWSHandler, ServerWebSocket } from 'bun';
 import type { Server } from 'bun';
-export type ServeOptions = {
-    port: number;
-    host: string;
-    unixSocket?: string;
+export type CreateFetchOptions = {
     overrideOrigin?: string;
     hostHeader?: string;
     protocolHeader?: string;
     ipHeader?: string;
     xffDepth?: number;
 };
+export type ServeOptions = {
+    port: number;
+    host: string;
+    unixSocket?: string;
+} & CreateFetchOptions;
 export type WebSocketOptions = Omit<BunWSHandler, 'message' | 'open' | 'close' | 'ping' | 'pong' | 'drain'>;
 export interface WebSocketHandler {
     /**

package/package.json

@@ -21,18 +21,18 @@
     }
   },
   "devDependencies": {
-    "@sveltejs/kit": "^2.5.16",
+    "@sveltejs/kit": "^2.5.26",
     "@types/bun": "latest",
     "cac": "^6.7.14",
     "devalue": "^5.0.0",
-    "prettier": "^3.3.2",
-    "typescript": "^5.0.0"
+    "prettier": "^3.3.3",
+    "typescript": "^5.5.4"
   },
   "dependencies": {
     "@rollup/plugin-commonjs": "^26.0.1",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^15.2.3",
-    "rollup": "^4.18.0"
+    "rollup": "^4.21.2"
   },
-  "version": "1.0.13"
+  "version": "v1.0.15"
 }