okengine 0.2.8 → 0.3.2

package/src/docker/stack-id.ts

@@ -54,9 +54,33 @@ export function hostPortForInstance(
   if (role === "store.sql") return 15_000 + n;
   if (role === "store.kv") return 16_000 + n;
   if (role === "signal") return 17_000 + n;
+  if (role === "store.files") return 18_000 + n;
+  if (role === "channel.email") return 20_000 + n;
+  if (role === "vault") return 22_000 + n;
   return defaultHostPort(role, containerPort) + n;
 }
 
+/**
+ * Host port for a recipe's additional published port.
+ *
+ * Built-in roles use disjoint ranges so an offset cannot move Mailpit's UI
+ * onto RustFS's API port (for example, `8025 + 975 = 9000`).
+ *
+ * @param role - Role key
+ * @param hostPort - Recipe's default additional host port
+ * @param instanceId - 6-hex stack id
+ */
+export function extraHostPortForInstance(
+  role: string,
+  hostPort: number,
+  instanceId: string,
+): number {
+  const n = instancePortOffset(instanceId);
+  if (role === "store.files") return 19_000 + n;
+  if (role === "channel.email") return 21_000 + n;
+  return hostPort + n;
+}
+
 /**
  * Parse role credentials from an existing `.env.docker` body (reuse on restart).
  *
@@ -67,29 +91,16 @@ export function parseStackCredentials(
   text: string,
   roles: readonly string[],
 ): Record<string, ServiceCredentials> {
-  const map = new Map<string, string>();
-  for (const line of text.split("\n")) {
-    const trimmed = line.trim();
-    if (!trimmed || trimmed.startsWith("#")) continue;
-    const eq = trimmed.indexOf("=");
-    if (eq <= 0) continue;
-    const key = trimmed.slice(0, eq);
-    let value = trimmed.slice(eq + 1);
-    if (
-      (value.startsWith('"') && value.endsWith('"')) ||
-      (value.startsWith("'") && value.endsWith("'"))
-    ) {
-      value = value.slice(1, -1);
-    }
-    map.set(key, value);
-  }
-
+  const map = parseDotenv(text);
   const out: Record<string, ServiceCredentials> = {};
   for (const role of roles) {
     const prefix = envPrefix(role);
-    const user = map.get(`${prefix}_USER`);
-    const password = map.get(`${prefix}_PASSWORD`);
-    const database = map.get(`${prefix}_DB`);
+    const user =
+      map.get(`${prefix}_USER`) ?? (role === "store.files" ? map.get("S3_ACCESS_KEY_ID") : "oke");
+    const password =
+      map.get(`${prefix}_PASSWORD`) ??
+      (role === "store.files" ? map.get("S3_SECRET_ACCESS_KEY") : undefined);
+    const database = map.get(`${prefix}_DB`) ?? "oke";
     if (user && password && database) {
       out[role] = { user, password, database };
     }
@@ -97,6 +108,36 @@ export function parseStackCredentials(
   return out;
 }
 
+/** Optional `.env.docker` keys preserved when generated files refresh. */
+export const STACK_CONTROL_KEYS = [
+  "PGDATA",
+  "POSTGRES_INITDB_ARGS",
+  "OKE_STORE_KV_MAXMEMORY",
+  "OKE_STORE_KV_MAXMEMORY_POLICY",
+  "S3_REGION",
+  "S3_SESSION_TOKEN",
+  "SMTP_USER",
+  "SMTP_PASSWORD",
+  "MP_MAX_MESSAGES",
+  "MP_SMTP_AUTH_ACCEPT_ANY",
+  "MP_SMTP_AUTH_ALLOW_INSECURE",
+] as const;
+
+/**
+ * Read supported user controls from an existing `.env.docker`.
+ *
+ * @param text - Dotenv contents
+ */
+export function parseStackControls(text: string): Record<string, string> {
+  const parsed = parseDotenv(text);
+  return Object.fromEntries(
+    STACK_CONTROL_KEYS.flatMap((key) => {
+      const value = parsed.get(key);
+      return value === undefined ? [] : [[key, value]];
+    }),
+  );
+}
+
 /**
  * Load credentials from `docker/.env.docker` when present.
  *
@@ -118,3 +159,41 @@ export async function loadExistingStackCredentials(
   }
   return undefined;
 }
+
+/**
+ * Load optional controls from `docker/.env.docker` when present.
+ *
+ * @param cwd - Project root
+ */
+export async function loadExistingStackControls(
+  cwd: string,
+): Promise<Readonly<Record<string, string>> | undefined> {
+  const candidates = [resolve(cwd, DEFAULT_DOCKER_DIR, ".env.docker"), resolve(cwd, ".env.docker")];
+  for (const path of candidates) {
+    const file = Bun.file(path);
+    if (!(await file.exists())) continue;
+    const controls = parseStackControls(await file.text());
+    if (Object.keys(controls).length > 0) return controls;
+  }
+  return undefined;
+}
+
+function parseDotenv(text: string): Map<string, string> {
+  const map = new Map<string, string>();
+  for (const line of text.split("\n")) {
+    const trimmed = line.trim();
+    if (!trimmed || trimmed.startsWith("#")) continue;
+    const eq = trimmed.indexOf("=");
+    if (eq <= 0) continue;
+    const key = trimmed.slice(0, eq);
+    let value = trimmed.slice(eq + 1);
+    if (
+      (value.startsWith('"') && value.endsWith('"')) ||
+      (value.startsWith("'") && value.endsWith("'"))
+    ) {
+      value = value.slice(1, -1);
+    }
+    map.set(key, value);
+  }
+  return map;
+}

package/src/docker/stack.ts

@@ -4,8 +4,15 @@
 
 import { buildSpecs } from "./compose.ts";
 import { recipeFor } from "./recipes/index.ts";
+import { extraHostPortForInstance } from "./stack-id.ts";
 import type { DeriveOptions, ServiceSpec } from "./types.ts";
 
+/** Extra published host↔container mapping for stack preview. */
+export interface StackExtraPort {
+  readonly hostPort: number;
+  readonly containerPort: number;
+}
+
 /** One resolved stack row for preview. */
 export interface StackRow {
   readonly role: string;
@@ -14,12 +21,14 @@ export interface StackRow {
   readonly service: string;
   readonly containerPort: number;
   readonly hostPort: number;
+  /** Additional published ports (Mailpit UI, RustFS console, …). */
+  readonly extraPorts: readonly StackExtraPort[];
 }
 
 /**
  * Resolve stack preview rows from image pins.
  *
- * @param options - Images (+ optional recipes)
+ * @param options - Images (+ optional recipes / instanceId)
  */
 export function resolveStack(options: DeriveOptions): readonly StackRow[] {
   const specs = buildSpecs(options);
@@ -38,13 +47,35 @@ export function formatStackPreview(rows: readonly StackRow[]): string {
     "--------------  ---------  ---------------------------------  --------------",
   ];
   for (const r of rows) {
-    lines.push(
-      `${pad(r.role, 14)}  ${pad(r.recipe, 9)}  ${pad(r.image, 33)}  ${r.hostPort}:${r.containerPort}`,
-    );
+    const ports = [
+      `${r.hostPort}:${r.containerPort}`,
+      ...r.extraPorts.map((p) => `${p.hostPort}:${p.containerPort}`),
+    ].join(", ");
+    lines.push(`${pad(r.role, 14)}  ${pad(r.recipe, 9)}  ${pad(r.image, 33)}  ${ports}`);
   }
   return `${lines.join("\n")}\n`;
 }
 
+/**
+ * Resolve additional published ports for a service (instance-aware).
+ *
+ * @param spec - Normalised service
+ * @param options - Derive options
+ */
+export function resolveExtraPorts(
+  spec: ServiceSpec,
+  options: DeriveOptions,
+): readonly StackExtraPort[] {
+  const recipe = recipeFor(spec.image, options.recipes ?? []);
+  const applied = recipe.apply(spec);
+  return (applied.extraPorts ?? []).map((p) => ({
+    containerPort: p.container,
+    hostPort: options.instanceId
+      ? extraHostPortForInstance(spec.role, p.host, options.instanceId)
+      : p.host,
+  }));
+}
+
 function toRow(spec: ServiceSpec, options: DeriveOptions): StackRow {
   const recipe = recipeFor(spec.image, options.recipes ?? []);
   return {
@@ -54,6 +85,7 @@ function toRow(spec: ServiceSpec, options: DeriveOptions): StackRow {
     service: spec.serviceName,
     containerPort: spec.port,
     hostPort: spec.hostPort,
+    extraPorts: resolveExtraPorts(spec, options),
   };
 }
 

package/src/docker/types.ts

@@ -60,6 +60,7 @@ export interface RecipeExtraPort {
 export interface RecipeApplyResult {
   readonly environment?: Readonly<Record<string, string>>;
   readonly command?: string | readonly string[];
+  readonly entrypoint?: string | readonly string[];
   readonly healthcheck?: ComposeHealthcheck;
   readonly volumes?: readonly string[];
   readonly user?: string;
@@ -128,6 +129,8 @@ export interface DeriveOptions {
   readonly host?: string;
   /** Extra image recipes (plugins). */
   readonly recipes?: readonly ImageRecipe[];
+  /** Preserved optional controls from an existing `.env.docker`. */
+  readonly controls?: Readonly<Record<string, string>>;
   /**
    * Local stack instance id (6-hex). When set, host ports are offset so two
    * `oke dev -s` projects do not share one Postgres on `:5432`.

package/src/docs-origin.ts

@@ -1,12 +1,12 @@
 /**
  * Canonical public docs origin for error links, README, and the site.
  *
- * Flip this one constant when the custom domain is attached:
- * `https://oke.omqkhafi.dev`
+ * Keep in lockstep with `packages/create-oke/src/docs-origin.ts` and
+ * `site/app/layout.tsx` (`metadataBase`).
  */
 
-/** Live docs site (Vercel). Planned cutover: `https://oke.omqkhafi.dev`. */
-export const DOCS_ORIGIN = "https://okengine.vercel.app" as const;
+/** Live docs site. */
+export const DOCS_ORIGIN = "https://oke.omqkhafi.dev" as const;
 
 /**
  * Absolute docs URL for a path under the handbook / site.

package/src/drivers/drizzle-dialect.test.ts

@@ -0,0 +1,20 @@
+/**
+ * Exhaustive SQL driver → drizzle-kit dialect map.
+ */
+
+import { describe, expect, test } from "bun:test";
+import { drizzleDialectFromSqlDriver, SQL_DRIVER_TO_DRIZZLE_DIALECT } from "./drizzle-dialect.ts";
+
+describe("SQL_DRIVER_TO_DRIZZLE_DIALECT", () => {
+  test("maps owned SQL drivers", () => {
+    expect(SQL_DRIVER_TO_DRIZZLE_DIALECT).toEqual({
+      sqlite: "sqlite",
+      postgres: "postgresql",
+    });
+  });
+
+  test("drizzleDialectFromSqlDriver resolves", () => {
+    expect(drizzleDialectFromSqlDriver("sqlite")).toBe("sqlite");
+    expect(drizzleDialectFromSqlDriver("postgres")).toBe("postgresql");
+  });
+});

package/src/drivers/drizzle-dialect.ts

@@ -0,0 +1,37 @@
+/**
+ * Map OKE `store.sql` driver ids to drizzle-kit dialects.
+ *
+ * drizzle-kit `1.0.0-rc.4` dialects (from its schema validator):
+ * `postgresql` · `mysql` · `sqlite` · `turso` · `singlestore` · `mssql` ·
+ * `cockroach` · `duckdb`. OKE owns kit-facing SQL drivers `sqlite` /
+ * `postgres` only — map those, never infer from connection URLs.
+ */
+
+import type { StoreDriverId } from "./types.ts";
+
+/** drizzle-kit `Dialect` values OKE currently emits for owned SQL drivers. */
+export type OkeDrizzleKitDialect = "sqlite" | "postgresql";
+
+/**
+ * Exhaustive map: adding a new SQL id to `StoreDriverId` without updating
+ * this `Record` is a compile error (via `Extract`), not a silent wrong
+ * dialect months later.
+ */
+export const SQL_DRIVER_TO_DRIZZLE_DIALECT: Record<
+  Extract<StoreDriverId, "sqlite" | "postgres">,
+  OkeDrizzleKitDialect
+> = {
+  sqlite: "sqlite",
+  postgres: "postgresql",
+};
+
+/**
+ * Resolve the drizzle-kit dialect for an OKE SQL driver id.
+ *
+ * @param driverId - Protocol driver id (`sqlite` | `postgres`)
+ */
+export function drizzleDialectFromSqlDriver(
+  driverId: Extract<StoreDriverId, "sqlite" | "postgres">,
+): OkeDrizzleKitDialect {
+  return SQL_DRIVER_TO_DRIZZLE_DIALECT[driverId];
+}

package/src/drivers/index.ts

@@ -102,8 +102,7 @@ export type { VaultDriverId, VaultOpenOptions, VaultBag, VaultDriver } from "./v
 
 export { memoryVaultDriver } from "./vault-memory.ts";
 export { envVaultDriver } from "./vault-env.ts";
-export { sopsVaultDriver, buildSopsFixture, sopsEncryptValue } from "./vault-sops.ts";
-export { openbaoVaultDriver } from "./vault-openbao.ts";
+export { openbaoVaultDriver, OpenBaoUnavailableError } from "./vault-openbao.ts";
 export { infisicalVaultDriver } from "./vault-infisical.ts";
 export { managedVaultDriver } from "./vault-managed.ts";