@freestyle-sh/with-opencode 0.0.1 → 0.0.2

package/README.md

@@ -50,19 +50,59 @@ const { client } = await vm.opencode.client({
 });
 ```
 
+### With Authentication
+
+```typescript
+import { freestyle, VmSpec } from "freestyle-sandboxes";
+import { VmOpenCode } from "@freestyle-sh/with-opencode";
+
+const { vm } = await freestyle.vms.create({
+  spec: new VmSpec({
+    with: {
+      opencode: new VmOpenCode({
+        server: {
+          username: "serveradmin",
+          password: "secret-server-pass",
+        },
+        web: {
+          username: "webadmin",
+          password: "secret-web-pass",
+        },
+      }),
+    },
+  }),
+});
+
+// URLs will include credentials automatically
+const { url } = await vm.opencode.routeWeb();
+const { client } = await vm.opencode.client();
+```
+
 ## Options
 
 ```typescript
 new VmOpenCode({
-  serverPort: 4096, // Optional: API server port (default: 4096)
-  webPort: 4097,    // Optional: Web UI port (default: 4097)
-})
+  server: {
+    port: 4096, // Optional: API server port (default: 4096)
+    username: "admin", // Optional: Basic auth username (default: "opencode" when password is set)
+    password: "secret", // Optional: Basic auth password
+  },
+  web: {
+    port: 4097, // Optional: Web UI port (default: 4097)
+    username: "admin", // Optional: Basic auth username (default: "opencode" when password is set)
+    password: "secret", // Optional: Basic auth password
+  },
+});
 ```
 
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `serverPort` | `number` | `4096` | Port for the OpenCode API server |
-| `webPort` | `number` | `4097` | Port for the OpenCode web UI |
+| Option            | Type     | Default      | Description                                      |
+| ----------------- | -------- | ------------ | ------------------------------------------------ |
+| `server.port`     | `number` | `4096`       | Port for the OpenCode API server                 |
+| `server.username` | `string` | `"opencode"` | Basic auth username (only used if password set)  |
+| `server.password` | `string` | -            | Basic auth password for the API server           |
+| `web.port`        | `number` | `4097`       | Port for the OpenCode web UI                     |
+| `web.username`    | `string` | `"opencode"` | Basic auth username (only used if password set)  |
+| `web.password`    | `string` | -            | Basic auth password for the web UI               |
 
 ## API
 
@@ -71,9 +111,10 @@ new VmOpenCode({
 Exposes the OpenCode web UI on a public domain.
 
 **Options:**
+
 - `domain?: string` - Custom domain to use. If not specified, generates a random subdomain.
 
-**Returns:** `Promise<{ url: string }>`
+**Returns:** `Promise<{ url: string }>` - URL includes credentials if authentication is configured.
 
 ```typescript
 const { url } = await vm.opencode.routeWeb();
@@ -82,9 +123,10 @@ console.log(`OpenCode UI available at: ${url}`);
 
 ### `vm.opencode.client(options?)`
 
-Creates an OpenCode SDK client connected to the server.
+Creates an OpenCode SDK client connected to the server. The client is automatically configured with credentials if authentication is enabled.
 
 **Options:**
+
 - `domain?: string` - Custom domain for the API endpoint. If not specified, generates a random subdomain.
 
 **Returns:** `Promise<{ client: OpencodeClient }>`

package/dist/index.d.ts

@@ -2,13 +2,32 @@ import * as freestyle_sandboxes from 'freestyle-sandboxes';
 import { VmWith, VmWithInstance, VmSpec } from 'freestyle-sandboxes';
 import * as _opencode_ai_sdk from '@opencode-ai/sdk';
 
+type OpenCodeAuthOptions = {
+    password?: string;
+    username?: string;
+};
+type ResolvedOpenCodeAuthOptions = {
+    password: string;
+    username: string;
+} | {
+    password?: undefined;
+    username?: undefined;
+};
 type OpenCodeOptions = {
-    serverPort?: number;
-    webPort?: number;
+    server?: {
+        port?: number;
+    } & OpenCodeAuthOptions;
+    web?: {
+        port?: number;
+    } & OpenCodeAuthOptions;
 };
 type OpenCodeResolvedOptions = {
-    serverPort: number;
-    webPort: number;
+    server: {
+        port: number;
+    } & ResolvedOpenCodeAuthOptions;
+    web: {
+        port: number;
+    } & ResolvedOpenCodeAuthOptions;
 };
 declare class VmOpenCode extends VmWith<VmOpenCodeInstance> {
     options: OpenCodeResolvedOptions;
@@ -37,4 +56,4 @@ declare class VmOpenCodeInstance extends VmWithInstance {
 }
 
 export { VmOpenCode };
-export type { OpenCodeOptions, OpenCodeResolvedOptions };
+export type { OpenCodeAuthOptions, OpenCodeOptions, OpenCodeResolvedOptions, ResolvedOpenCodeAuthOptions };

package/dist/index.js

@@ -1,16 +1,24 @@
 import { VmWith, VmSpec, VmWithInstance } from 'freestyle-sandboxes';
 import { createOpencodeClient } from '@opencode-ai/sdk';
 
+function resolveAuth(opts) {
+  return opts?.password ? { password: opts.password, username: opts.username ?? "opencode" } : {};
+}
 class VmOpenCode extends VmWith {
   options;
   constructor(options) {
     super();
     this.options = {
-      serverPort: options?.serverPort ?? 4096,
-      webPort: options?.webPort ?? 4097
+      server: {
+        port: options?.server?.port ?? 4096,
+        ...resolveAuth(options?.server)
+      },
+      web: { port: options?.web?.port ?? 4097, ...resolveAuth(options?.web) }
     };
   }
   configureSnapshotSpec(spec) {
+    const webAuthEnv = this.options.web.username ? `OPENCODE_SERVER_USERNAME=${this.options.web.username} OPENCODE_SERVER_PASSWORD=${this.options.web.password}`.trim() : "";
+    const serverAuthEnv = this.options.server.username ? `OPENCODE_SERVER_USERNAME=${this.options.server.username} OPENCODE_SERVER_PASSWORD=${this.options.server.password}`.trim() : "";
     return this.composeSpecs(
       spec,
       new VmSpec({
@@ -27,7 +35,7 @@ class VmOpenCode extends VmWith {
               #!/bin/bash
 
               export PATH="$HOME/.local/bin:$PATH"
-              /root/.opencode/bin/opencode web --hostname 0.0.0.0 --port ${this.options.webPort}
+              ${webAuthEnv} /root/.opencode/bin/opencode web --hostname 0.0.0.0 --port ${this.options.web.port}
               `
           },
           "/opt/run-opencode-server.sh": {
@@ -35,7 +43,7 @@ class VmOpenCode extends VmWith {
               #!/bin/bash
 
               export PATH="$HOME/.local/bin:$PATH"
-              /root/.opencode/bin/opencode serve --hostname 0.0.0.0 --port ${this.options.serverPort}
+              ${serverAuthEnv} /root/.opencode/bin/opencode serve --hostname 0.0.0.0 --port ${this.options.server.port}
               `
           }
         },
@@ -95,10 +103,10 @@ class VmOpenCodeInstance extends VmWithInstance {
     this.builder = builder;
   }
   webPort() {
-    return this.builder.options.webPort;
+    return this.builder.options.web.port;
   }
   serverPort() {
-    return this.builder.options.serverPort;
+    return this.builder.options.server.port;
   }
   async client({ domain } = {}) {
     const resolvedDomain = domain ?? `${crypto.randomUUID()}-opencode.style.dev`;
@@ -110,7 +118,12 @@ class VmOpenCodeInstance extends VmWithInstance {
     });
     return {
       client: createOpencodeClient({
-        baseUrl: `https://${resolvedDomain}`
+        baseUrl: `https://${resolvedDomain}`,
+        headers: this.builder.options.server.username ? {
+          Authorization: `Basic ${btoa(
+            `${this.builder.options.server.username}:${this.builder.options.server.password}`
+          )}`
+        } : {}
       })
     };
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@freestyle-sh/with-opencode",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "packageManager": "pnpm@10.11.0",
   "private": false,
   "dependencies": {