create-oke 0.9.1 → 0.10.0

package/src/transform.test.ts

@@ -11,8 +11,23 @@ import { resolveTemplateDir } from "./templates.ts";
 import { applyCreateAnswers, upsertAiDrivers } from "./transform.ts";
 import type { EnvDriverPins } from "./create-defaults.ts";
 
-function templateConfig(): string {
-  return readFileSync(join(resolveTemplateDir("standard"), "oke.config.ts"), "utf8");
+function templateConfig(id: "standard" | "advanced" = "advanced"): string {
+  return readFileSync(join(resolveTemplateDir(id), "oke.config.ts"), "utf8");
+}
+
+/** Evaluate `oke.config.ts` source via identity `defineConfig` (no okengine import). */
+function evalConfig(source: string): {
+  drivers?: {
+    ai?: unknown;
+    channel?: { ai?: unknown; email?: unknown };
+  };
+  images?: Record<string, string>;
+} {
+  const body = source
+    .replace(/^import\s+[\s\S]*?from\s+["'][^"']+["'];?\s*/m, "")
+    .replace(/export\s+default\s+/, "return ");
+  const defineConfig = <T>(c: T): T => c;
+  return new Function("defineConfig", body)(defineConfig) as ReturnType<typeof evalConfig>;
 }
 
 function defaultsWithIndex(indexLocal: string, indexDocker: string) {
@@ -67,39 +82,46 @@ describe("upsertAiDrivers", () => {
   };
 
   test("inserts drivers.ai as sibling of channel (not inside email)", () => {
-    const next = upsertAiDrivers(templateConfig(), ollamaPins);
-    expect(next).toMatch(/^ {4}ai:\s*\{/m);
-    expect(next).toContain('local: "ollama"');
-    const channel = next.match(/^ {4}channel:\s*\{[\s\S]*?\n {4}\},?\n/m)?.[0] ?? "";
-    expect(channel).toContain("email:");
-    expect(channel).not.toContain("ai:");
+    const next = upsertAiDrivers(templateConfig("advanced"), ollamaPins);
+    const config = evalConfig(next);
+    expect(config.drivers?.ai).toEqual(ollamaPins);
+    expect(config.drivers?.channel?.ai).toBeUndefined();
+    expect(config.drivers?.channel?.email).toBeDefined();
   });
 
   test("applyCreateAnswers with ai pins keeps top-level drivers.ai", () => {
-    const next = applyCreateAnswers(
-      templateConfig(),
-      toCreateDefaults({
-        template: "advanced",
-        profile: "docker-ready",
-        drivers: {
-          store: {
-            sql: pinsDockerReady("libsql", "postgres", "memory"),
-            kv: pinsLocalOnly("memory", "redis", "memory"),
-            files: pinsLocalOnly("fs", "s3", "memory"),
-            index: null,
+    const llamaPins = pinsDockerReady("openai-compatible", "openai-compatible", "mock");
+    for (const id of ["standard", "advanced"] as const) {
+      const next = applyCreateAnswers(
+        templateConfig(id),
+        toCreateDefaults({
+          template: "advanced",
+          profile: "docker-ready",
+          drivers: {
+            store: {
+              sql: pinsDockerReady("libsql", "postgres", "memory"),
+              kv: pinsLocalOnly("memory", "redis", "memory"),
+              files: pinsLocalOnly("fs", "s3", "memory"),
+              index: null,
+            },
+            signal: pinsLocalOnly("memory", "redis", "memory"),
+            clock: pinsLocalOnly("memory", "file", "frozen"),
+            vault: pinsLocalOnly("env", "openbao", "memory"),
+            channel: { email: pinsLocalOnly("console", "smtp", "console") },
+            ai: llamaPins,
           },
-          signal: pinsLocalOnly("memory", "redis", "memory"),
-          clock: pinsLocalOnly("memory", "file", "frozen"),
-          vault: pinsLocalOnly("env", "openbao", "memory"),
-          channel: { email: pinsLocalOnly("console", "smtp", "console") },
-          ai: ollamaPins,
-        },
-        ai: { enabled: true, provider: "ollama", driver: "ollama" },
-      }),
-    );
-    expect(next).toMatch(/^ {4}ai:\s*\{/m);
-    expect(next).toContain('ai: "ollama/ollama:latest"');
-    const channel = next.match(/^ {4}channel:\s*\{[\s\S]*?\n {4}\},?\n/m)?.[0] ?? "";
-    expect(channel).not.toContain("ai:");
+          ai: { enabled: true, provider: "llama-cpp", driver: "openai-compatible" },
+        }),
+      );
+      const config = evalConfig(next);
+      expect(config.drivers?.ai, id).toEqual({
+        local: "openai-compatible",
+        docker: "openai-compatible",
+        test: "mock",
+        prod: "openai-compatible",
+      });
+      expect(config.drivers?.channel?.ai, id).toBeUndefined();
+      expect(config.images?.ai, id).toBe("ghcr.io/ggml-org/llama.cpp:server-b10290");
+    }
   });
 });

package/src/transform.ts

@@ -5,7 +5,8 @@
  * Exactly:
  * 1. `package.json` `"name"` → the user-provided project name
  * 2. `package.json` `"okengine": "file:../.."` → an installable reference
- *    (absolute `file:<okengine-root>` in the monorepo; registry version otherwise)
+ *    (staged `file:~/.oke/create-oke/okengine` in the monorepo — not the
+ *    workspace root; registry version otherwise)
  * 3. Drop monorepo-only files that import paths outside the source tree
  *    (today: `tests/docker.test.ts`)
  * 4. Optional `--sql` / wizard choice → Drizzle dialect + `store.sql` pins
@@ -14,7 +15,14 @@
 import { readFileSync } from "node:fs";
 import { join } from "node:path";
 import type { CreateDefaults, EnvDriverPins } from "./create-defaults.ts";
-import { DEFAULT_IMAGES } from "./drivers-catalog.ts";
+import {
+  DEFAULT_IMAGES,
+  LLAMA_CPP_IMAGE,
+  OLLAMA_IMAGE,
+  SGLANG_IMAGE,
+  VLLM_IMAGE,
+} from "./drivers-catalog.ts";
+import { materializeLocalOkengineDependency } from "./local-okengine.ts";
 import { packageRoot } from "./templates.ts";
 
 /** SQL store drivers selectable at scaffold time. */
@@ -49,13 +57,15 @@ export type ScaffoldPackageJson = {
 /**
  * Resolve the `okengine` dependency string written into the scaffolded package.json.
  *
- * - Monorepo / local: `file:<absolute-okengine-root>` (installable; not `file:../..`)
+ * - Monorepo / local: staged publish-shaped `file:` package (no workspaces /
+ *   no monorepo `devDependencies` — those pull drizzle-zod and trip Bun’s RC
+ *   peer check)
  * - Published create-oke: the version of this package (kept in lockstep with okengine)
  *
  * @param localOkengineRoot - Absolute path when available
  */
 export function resolveOkengineDependency(localOkengineRoot: string | null): string {
-  if (localOkengineRoot) return `file:${localOkengineRoot}`;
+  if (localOkengineRoot) return materializeLocalOkengineDependency(localOkengineRoot);
   const pkgPath = join(packageRoot(), "package.json");
   const pkg = JSON.parse(readFileSync(pkgPath, "utf8")) as { version: string };
   return pkg.version;
@@ -269,11 +279,14 @@ export function upsertAiDrivers(source: string, pins: EnvDriverPins): string {
  * Format an env driver map literal.
  *
  * @param pins - Pins
- * @param indentLevel - Indent depth (2 spaces each)
+ * @param indentLevel - Indent of the map key (`signal` → 2, `sql`/`email` → 3;
+ *   two spaces each). Inner fields use `indentLevel + 1`; the closing `}`
+ *   aligns with the key. An off-by-one here made `email`'s `},` look like
+ *   `channel`'s close, so {@link upsertAiDrivers} nested `ai` under `channel`.
  */
 function formatEnvMap(pins: EnvDriverPins, indentLevel: number): string {
-  const pad = "  ".repeat(indentLevel);
-  const close = "  ".repeat(indentLevel - 1);
+  const pad = "  ".repeat(indentLevel + 1);
+  const close = "  ".repeat(indentLevel);
   return `{
 ${pad}local: "${pins.local}",
 ${pad}docker: "${pins.docker}",
@@ -329,13 +342,37 @@ function syncImages(source: string, defaults: CreateDefaults): string {
   if (d.store.index?.docker === "meilisearch") {
     pin("store.index", DEFAULT_IMAGES["store.index"]!);
   }
-  if (d.ai && (d.ai.docker === "ollama" || d.ai.local === "ollama")) {
-    pin("ai", DEFAULT_IMAGES.ai!);
+  if (
+    d.ai &&
+    (d.ai.docker === "ollama" ||
+      d.ai.local === "ollama" ||
+      d.ai.docker === "openai-compatible" ||
+      d.ai.local === "openai-compatible")
+  ) {
+    pin("ai", aiImageForDefaults(defaults));
   }
 
   return replaceImagesBlock(source, images);
 }
 
+/**
+ * Resolve `images.ai` from create-defaults provider / driver pins.
+ *
+ * @param defaults - Create answers
+ */
+function aiImageForDefaults(defaults: CreateDefaults): string {
+  const provider = defaults.ai.provider;
+  if (provider === "ollama" || defaults.drivers.ai?.local === "ollama") {
+    return OLLAMA_IMAGE;
+  }
+  if (provider === "vllm") return VLLM_IMAGE;
+  if (provider === "sglang") return SGLANG_IMAGE;
+  if (provider === "llama-cpp" || defaults.drivers.ai?.local === "openai-compatible") {
+    return LLAMA_CPP_IMAGE;
+  }
+  return DEFAULT_IMAGES.ai!;
+}
+
 /**
  * Parse role→image pins from an `images` block.
  *

package/src/wizard-select.ts

@@ -1,16 +1,15 @@
 /**
- * Shared Clack select helpers with optional ← Back.
+ * Shared Clack select helpers with optional Back.
  */
 
 import { isCancel, select } from "@clack/prompts";
 
-/** Sentinel — go back one wizard step (shown as "← Back" in selects). */
+/** Sentinel — go back one wizard step (shown as "Back" in selects). */
 export const WIZARD_BACK = "__back__" as const;
-/** {@link WIZARD_BACK} type alias. */
 export type WizardBack = typeof WIZARD_BACK;
 
 /**
- * Append "← Back" when allowed — pure helper for tests + {@link selectWithBack}.
+ * Append "Back" when allowed — pure helper for tests + {@link selectWithBack}.
  *
  * @param options - Choices
  * @param allowBack - Whether to append Back
@@ -20,11 +19,11 @@ export function withBackOption(
   allowBack: boolean,
 ): readonly { value: string; label: string; hint?: string }[] {
   if (!allowBack) return options;
-  return [...options, { value: WIZARD_BACK, label: "←  Back" }];
+  return [...options, { value: WIZARD_BACK, label: "Back" }];
 }
 
 /**
- * Select with an optional trailing "← Back" option.
+ * Select with an optional trailing "Back" option.
  *
  * @param message - Prompt
  * @param options - Choices (without back)

package/templates/advanced/.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+# Minimal CI for an okengine app — typecheck + test on every push/PR.
+# Expand later (lint, docker, deploy); keep this green from day one.
+
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  check:
+    name: typecheck · test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: oven-sh/setup-bun@v2.2.0
+        with:
+          bun-version: latest
+      - name: Install
+        run: bun install
+      - name: Typecheck
+        run: bun run typecheck
+      - name: Test
+        run: bun test

package/templates/advanced/.vscode/settings.json

@@ -0,0 +1,15 @@
+{
+  "files.exclude": {
+    "**/dist": true,
+    "**/.next": true,
+    "**/.turbo": true,
+    "**/bun.lock": true,
+    "**/node_modules": true,
+    "**/next-env.d.ts": true,
+    "**/worker-configuration.d.ts": true
+  },
+  "editor.formatOnSave": true,
+  "files.associations": {
+    "*.css": "tailwindcss"
+  }
+}

package/templates/advanced/README.md

@@ -2,12 +2,12 @@
 
 Docker-ready [okengine](https://oke.omqkhafi.dev) **Notes** starter — same domain as
 `standard`, plus files attach, a daily digest clock, and an AI summarize stub.
+Scaffold, not a finished product: keep the Flows you want, replace the rest.
 
 ```bash
 bun install
 oke mode docker   # seeded by create-oke recommended path
-oke dev
-oke db seed       # essential welcome note + local/docker sample notes
+oke dev           # auto db push; asks once whether to seed
 ```
 
 | Surface | URL |
@@ -24,14 +24,25 @@ oke db seed       # essential welcome note + local/docker sample notes
 | POST | `/notes/:id/summarize` | `notes.summarize` — `fx.ask` when AI is configured |
 | clock | `every("1d")` | `notes.digest` — active note count |
 
-Configure AI with `oke ai setup` or `create-oke --ai` (writes `src/ai.ts` + `drivers.ai`).
+Configure AI with `oke ai setup` or `create-oke --ai` (writes `src/core/ai.ts` + `drivers.ai`).
 Without AI, summarize returns a local excerpt (`via: "fallback"`).
 
+## Included vs you build
+
+| Ships ready | You still own |
+| ----------- | ------------- |
+| standard Notes surface + attach / digest / summarize | your domain beyond notes |
+| files Store pin + digest Clock | production file policy and schedules |
+| AI summarize stub (fallback without AI) | real prompts / models via `oke ai setup` |
+| `.github/workflows/ci.yml` (typecheck + test) | lint, docker, deploy when you need them |
+
 ## Layout extras
 
 | Path | Role |
 | ---- | ---- |
-| `src/seed/` | `oke db seed` — essential + dev sample notes |
+| `src/core/` | `store` (db + files) · gates · vault · channels |
+| `src/db/` | schema · seed · migrations |
+| `.github/workflows/ci.yml` | `bun run typecheck` + `bun test` on push/PR |
 
 ## Drivers
 

package/templates/advanced/drizzle.config.ts

@@ -5,17 +5,19 @@ import { defineConfig } from "drizzle-kit";
  *
  * Dialect comes from OKE's `store.sql` driver map (resolved by the CLI and
  * injected as `OKE_DRIZZLE_DIALECT`) — never inferred from `DATABASE_URL`
- * presence. `src/schema.generated.ts` is emitted from `src/schema.decl.ts`
+ * presence. `src/db/schema.generated.ts` is emitted from `src/db/schema.decl.ts`
  * for the active dialect as a pre-step of `oke db` / `oke dev`.
  *
- * Versioned prod migrations land in `./drizzle` — never mix with `.oke/`.
+ * Versioned prod migrations land in `./src/db/migrations` — never mix with `.oke/`.
  */
 const dialect = (process.env.OKE_DRIZZLE_DIALECT ?? "sqlite") as "sqlite" | "postgresql";
 
 export default defineConfig({
   dialect,
-  schema: "./src/schema.generated.ts",
-  out: "./drizzle",
+  schema: "./src/db/schema.generated.ts",
+  out: "./src/db/migrations",
+  // Core runtime tables (oke_crons, …) are created by drivers — not domain schema.
+  tablesFilter: ["!oke_*"],
   dbCredentials: {
     url:
       dialect === "postgresql"

package/templates/advanced/oke.config.ts

@@ -5,6 +5,10 @@ import { defineConfig } from "okengine/config";
  * Recommended create path seeds `.oke/mode` as docker.
  */
 export default defineConfig({
+  db: {
+    declare: "src/db/schema.decl.ts",
+    generated: "src/db/schema.generated.ts",
+  },
   drivers: {
     store: {
       sql: {
@@ -66,7 +70,7 @@ export default defineConfig({
         prod: "smtp",
       },
     },
-    // Opt in: create-oke --ai / oke ai setup writes drivers.ai + src/ai.ts
+    // Opt in: create-oke --ai / oke ai setup writes drivers.ai + src/core/ai.ts
   },
   images: {
     "store.sql": "postgres:18-alpine",
@@ -76,7 +80,7 @@ export default defineConfig({
     "channel.email": "axllent/mailpit:v1.22.3",
     vault: "openbao/openbao:2.6.1",
     // "store.index": "getmeili/meilisearch:v1.37",
-    // ai: "ollama/ollama:latest",
+    // ai: "ghcr.io/ggml-org/llama.cpp:server-b10290", // or ollama/ollama:0.32.6
   },
   i18n: { locales: ["en", "ar"], default: "en", dir: { ar: "rtl" } },
 });

package/templates/advanced/package.json

@@ -5,13 +5,16 @@
   "type": "module",
   "dependencies": {
     "okengine": "file:../../../..",
-    "drizzle-orm": "^1.0.0-rc.4",
+    "drizzle-orm": "1.0.0-rc.4",
     "zod": "^4.4.3"
   },
   "devDependencies": {
-    "drizzle-kit": "^1.0.0-rc.4"
+    "@types/bun": "latest",
+    "drizzle-kit": "1.0.0-rc.4",
+    "typescript": "^7.0.2"
   },
   "scripts": {
+    "typecheck": "tsc --noEmit",
     "test": "bun test",
     "dev": "oke dev"
   }

package/templates/advanced/src/app.ts

@@ -1,7 +1,4 @@
-import { db, files } from "./core";
-import "./gates";
-import "./vault";
-import "./channels";
+import { db, files, noteCreatedMail, webhookSecret } from "./core";
 import "./locales/en";
 import "./locales/ar";
 
@@ -9,22 +6,13 @@ import { oke } from "okengine";
 import * as main from "./flows/main";
 import * as notes from "./flows/notes";
 import { noteCreated } from "./flows/notes/signals";
-import { noteCreatedMail } from "./channels";
-import { webhookSecret } from "./vault";
 
 export const app = oke({
   name: "notes",
+  stores: [db, files],
   secrets: [webhookSecret],
   signals: [noteCreated],
   channel: { templates: [noteCreatedMail] },
 }).adopt({ main, notes });
 
 export type App = typeof app;
-
-Object.assign(app.$options, {
-  env: "test",
-  stores: [db, files],
-  secrets: [webhookSecret],
-  signals: [noteCreated],
-  channel: { templates: [noteCreatedMail] },
-});

package/templates/advanced/src/core/index.ts

@@ -0,0 +1,12 @@
+/**
+ * Core wiring — stores, gates, vault, channels (and AI when configured).
+ */
+
+export { db, files } from "./store";
+export { notesWrite } from "./gates";
+export { webhookSecret } from "./vault";
+export { noteCreatedMail } from "./channels";
+
+import "./gates";
+import "./vault";
+import "./channels";

package/templates/advanced/src/{core.ts → core/store.ts}

@@ -1,5 +1,5 @@
 import { store } from "okengine";
-import * as schema from "./schema.decl";
+import * as schema from "../db/schema.decl";
 
 /** App SQL store — tables from {@link schema}. */
 export const db = store.sql("app", { schema });

package/templates/{standard/src → advanced/src/db}/schema.decl.ts

@@ -2,7 +2,7 @@ import { store, field, id, now } from "okengine";
 
 /**
  * Notes domain — abstract declarations, emitted to
- * `src/schema.generated.ts` for the active dialect by `oke db` / `oke dev`.
+ * `src/db/schema.generated.ts` for the active dialect by `oke db` / `oke dev`.
  */
 export const notes = store.schema.table("notes", {
   id: field.text().primaryKey().defaultFn(id),

package/templates/advanced/src/{seed → db/seed}/index.ts

@@ -1,12 +1,12 @@
 import { defineSeed, type Fx } from "okengine";
-import { db } from "../core";
+import { db } from "../../core";
 import { notes } from "../schema.decl";
 
 /**
  * Seed data — run explicitly with `oke db seed` (never at boot).
  *
  * Categories: `essential` (every env) · `dev` (local|docker) · `prod` (prod only).
- * For multi-file composition (`src/seed/essential/*.ts` + arrays here), see
+ * For multi-file composition (`src/db/seed/essential/*.ts` + arrays here), see
  * Store docs → Seeding.
  */
 

package/templates/advanced/src/flows/notes/index.ts

@@ -1,10 +1,8 @@
 import { on, flow, http, every, gate, fail } from "okengine";
 import { eq, isNull } from "drizzle-orm";
 
-import { db, files } from "../../core";
-import { notes } from "../../schema.decl";
-import { webhookSecret } from "../../vault";
-import { noteCreatedMail } from "../../channels";
+import { db, files, noteCreatedMail, webhookSecret } from "../../core";
+import { notes } from "../../db/schema.decl";
 import {
   NoteAttachIn,
   NoteAttachOut,

package/templates/advanced/tests/advanced.test.ts

@@ -13,30 +13,31 @@ afterAll(async () => {
 });
 
 test("boots — health flow is named main.health", async () => {
-  const { data, error } = await t.api.main.health({});
+  const { data, error } = await t.api.main!.health!({});
   expect(error).toBeNull();
   expect(data).toEqual({ ok: true });
 });
 
 test("notes create → attach → summarize fallback → archive", async () => {
-  const created = await t.api.notes.create({
+  const created = await t.api.notes!.create!({
     title: "Advanced",
     body: "Body long enough to exercise attach and summarize paths in the advanced starter.",
   });
   expect(created.error).toBeNull();
-  const id = created.data!.id;
+  const id = (created.data as { id: string }).id;
 
   await t.signals.drain();
 
-  const attached = await t.api.notes.attach({ id, text: "attachment body" });
+  const attached = await t.api.notes!.attach!({ id, text: "attachment body" });
   expect(attached.error).toBeNull();
-  expect(attached.data?.key).toBe(`notes/${id}/attachment.txt`);
+  expect((attached.data as { key: string }).key).toBe(`notes/${id}/attachment.txt`);
 
-  const summary = await t.api.notes.summarize({ id });
+  const summary = await t.api.notes!.summarize!({ id });
   expect(summary.error).toBeNull();
-  expect(summary.data?.via).toBe("fallback");
-  expect(summary.data?.summary.length).toBeGreaterThan(0);
+  const out = summary.data as { via: string; summary: string };
+  expect(out.via).toBe("fallback");
+  expect(out.summary.length).toBeGreaterThan(0);
 
-  const archived = await t.api.notes.archive({ id });
+  const archived = await t.api.notes!.archive!({ id });
   expect(archived.error).toBeNull();
 });

package/templates/advanced/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "lib": ["ESNext"],
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleDetection": "force",
+    "types": ["bun"],
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+    "rewriteRelativeImportExtensions": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "erasableSyntaxOnly": true
+  },
+  "include": ["src/**/*.ts", "tests/**/*.ts", "oke.config.ts", "drizzle.config.ts"]
+}

package/templates/standard/.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+# Minimal CI for an okengine app — typecheck + test on every push/PR.
+# Expand later (lint, docker, deploy); keep this green from day one.
+
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  check:
+    name: typecheck · test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: oven-sh/setup-bun@v2.2.0
+        with:
+          bun-version: latest
+      - name: Install
+        run: bun install
+      - name: Typecheck
+        run: bun run typecheck
+      - name: Test
+        run: bun test

package/templates/standard/.vscode/settings.json

@@ -0,0 +1,15 @@
+{
+  "files.exclude": {
+    "**/dist": true,
+    "**/.next": true,
+    "**/.turbo": true,
+    "**/bun.lock": true,
+    "**/node_modules": true,
+    "**/next-env.d.ts": true,
+    "**/worker-configuration.d.ts": true
+  },
+  "editor.formatOnSave": true,
+  "files.associations": {
+    "*.css": "tailwindcss"
+  }
+}