create-oke 0.1.6 → 0.2.2

package/templates/hello/README.md

@@ -0,0 +1,38 @@
+# hello
+
+Fastest possible “it works” — one unit, two HTTP flows, **no Store**.
+
+## Run
+
+```bash
+bun install
+oke dev          # app :6530 · Console :6533 · MCP :6535
+```
+
+| Port | Try |
+|---|---|
+| `:6530` | `GET /` · `GET /hello` |
+| `:6533` | Console |
+| `:6535` | MCP |
+
+## What’s in this template
+
+```text
+hello/
+├── oke.config.ts
+├── src/
+│   ├── app.ts                 # oke({ name: "hello" }).adopt({ hello })
+│   └── flows/hello/index.ts   # GET / · GET /hello
+└── tests/hello.test.ts
+```
+
+- **Elements:** Flow only (no `store`, `gate`, `vault`, `channel`, or `ai`)
+- **Unit:** `hello`
+- **Flows:** `root` (`GET /`), `hello` (`GET /hello` → `{ message: "ok" }`)
+
+Replace `/hello` with your first real route. When you need persistence, move up to
+`minimal` or `standard` — or keep growing this tree.
+
+## Agent contract
+
+See [`AGENTS.md`](./AGENTS.md). Handbook: [okengine.vercel.app/docs](https://okengine.vercel.app/docs)

package/templates/hello/oke.config.ts

@@ -0,0 +1,3 @@
+import { defineConfig } from "okengine/config";
+
+export default defineConfig({});

package/templates/hello/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@oke/template-hello",
+  "version": "0.0.1",
+  "private": true,
+  "type": "module",
+  "dependencies": {
+    "okengine": "file:../..",
+    "zod": "^4.4.3"
+  },
+  "scripts": {
+    "test": "bun test",
+    "dev": "oke dev"
+  }
+}

package/templates/hello/src/app.ts

@@ -0,0 +1,10 @@
+import { oke } from "okengine";
+import * as hello from "./flows/hello";
+
+export const app = oke({ name: "hello" }).adopt({ hello });
+
+export type App = typeof app;
+
+Object.assign(app.$options, {
+  env: "test",
+});

package/templates/hello/src/flows/hello/index.ts

@@ -0,0 +1,27 @@
+import { on, flow, http } from "okengine";
+import { z } from "zod";
+
+/** First-run welcome — visit :6530/ after `oke dev`. */
+export const root = on(
+  http.get("/"),
+  flow({
+    out: z.object({
+      ok: z.literal(true),
+      console: z.string(),
+      try: z.string(),
+    }),
+    do: () => ({
+      ok: true as const,
+      console: "http://127.0.0.1:6533",
+      try: "/hello",
+    }),
+  }),
+);
+
+export const hello = on(
+  http.get("/hello"),
+  flow({
+    out: z.object({ message: z.string() }),
+    do: () => ({ message: "ok" }),
+  }),
+);

package/templates/hello/tests/hello.test.ts

@@ -0,0 +1,10 @@
+import { test, expect } from "bun:test";
+import { createTestApp } from "okengine/test";
+import { app } from "../src/app";
+
+test("boots and answers /hello", async () => {
+  const t = await createTestApp(app);
+  const { data, error } = await t.api.hello.hello({});
+  expect(error).toBeNull();
+  expect(data?.message).toBe("ok");
+});

package/templates/minimal/README.md

@@ -0,0 +1,41 @@
+# minimal
+
+Smallest shape you’d actually ship — **Store + HTTP flows** over a single table.
+
+## Run
+
+```bash
+bun install
+oke dev          # app :6530 · Console :6533 · MCP :6535
+```
+
+| Port | Try |
+|---|---|
+| `:6530` | `GET /` · `GET /entries` · `POST /entries` |
+| `:6533` | Console |
+| `:6535` | MCP |
+
+## What’s in this template
+
+```text
+minimal/
+├── oke.config.ts
+├── src/
+│   ├── app.ts                 # adopt({ main }), stores: [db]
+│   ├── core.ts                # store.sql("…")
+│   ├── schema.ts              # entries table (Drizzle)
+│   └── flows/main/index.ts    # GET / · GET|POST /entries
+└── tests/minimal.test.ts
+```
+
+- **Elements:** Flow · Store (`sql`)
+- **Unit:** `main`
+- **Flows:** `root`, `list` (`GET /entries`), `create` (`POST /entries` with `{ body }`)
+- **Schema:** `entries` — `id`, `body`, `createdAt`
+
+Swap `entries` for your domain table and grow flows beside it. Need gates,
+channels, or locales? Use `standard`.
+
+## Agent contract
+
+See [`AGENTS.md`](./AGENTS.md). Handbook: [okengine.vercel.app/docs](https://okengine.vercel.app/docs)

package/templates/minimal/oke.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from "okengine/config";
+
+export default defineConfig({
+  drivers: {
+    store: { sql: { dev: "sqlite", test: "memory", prod: "postgres" } },
+  },
+});

package/templates/minimal/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@oke/template-minimal",
+  "version": "0.0.1",
+  "private": true,
+  "type": "module",
+  "dependencies": {
+    "okengine": "file:../..",
+    "drizzle-orm": "^1.0.0-rc.4",
+    "zod": "^4.4.3"
+  },
+  "scripts": {
+    "test": "bun test",
+    "dev": "oke dev"
+  }
+}

package/templates/minimal/src/app.ts

@@ -0,0 +1,13 @@
+import { db } from "./core";
+
+import { oke } from "okengine";
+import * as main from "./flows/main";
+
+export const app = oke({ name: "minimal" }).adopt({ main });
+
+export type App = typeof app;
+
+Object.assign(app.$options, {
+  env: "test",
+  stores: [db],
+});

package/templates/minimal/src/core.ts

@@ -0,0 +1,4 @@
+import { store } from "okengine";
+import * as schema from "./schema";
+
+export const db = store.sql("app", { schema });

package/templates/minimal/src/flows/main/index.ts

@@ -0,0 +1,49 @@
+import { on, flow, http } from "okengine";
+import { z } from "zod";
+import { db } from "../../core";
+import { entries } from "../../schema";
+
+const NewEntry = z.object({ body: z.string().min(1) });
+const EntryId = z.object({ id: z.string() });
+const Entry = z.object({
+  id: z.string(),
+  body: z.string(),
+  createdAt: z.number(),
+});
+
+/** First-run welcome — visit :6530/ after `oke dev`. */
+export const root = on(
+  http.get("/"),
+  flow({
+    out: z.object({
+      ok: z.literal(true),
+      console: z.string(),
+      try: z.string(),
+    }),
+    do: () => ({
+      ok: true as const,
+      console: "http://127.0.0.1:6533",
+      try: "GET /entries",
+    }),
+  }),
+);
+
+export const create = on(
+  http.post("/entries"),
+  flow({
+    in: NewEntry,
+    out: EntryId,
+    do: async (input, fx) => {
+      const [row] = await fx.store(db).insert(entries).values(input).returning();
+      return { id: row.id };
+    },
+  }),
+);
+
+export const list = on(
+  http.get("/entries"),
+  flow({
+    out: Entry.array(),
+    do: (_, fx) => fx.store(db).select().from(entries),
+  }),
+);

package/templates/minimal/src/schema.ts

@@ -0,0 +1,8 @@
+import { sqliteTable, text, integer } from "drizzle-orm/sqlite-core";
+import { id, now } from "okengine/store";
+
+export const entries = sqliteTable("entries", {
+  id: text("id").primaryKey().$defaultFn(id),
+  body: text("body").notNull(),
+  createdAt: integer("created_at").notNull().$defaultFn(now),
+});

package/templates/minimal/tests/minimal.test.ts

@@ -0,0 +1,13 @@
+import { test, expect } from "bun:test";
+import { createTestApp } from "okengine/test";
+import { app } from "../src/app";
+
+test("boots — create then list", async () => {
+  const t = await createTestApp(app);
+  const { data, error } = await t.api.main.create({ body: "hello" });
+  expect(error).toBeNull();
+  expect(data?.id).toBeTruthy();
+  const { data: rows } = await t.api.main.list({});
+  expect(rows?.length).toBe(1);
+  expect(rows?.[0]?.body).toBe("hello");
+});

package/templates/standard/README.md

@@ -0,0 +1,47 @@
+# standard
+
+Full recommended file layout with **empty scaffolding** — structure without
+business logic. Default `create-oke` template.
+
+## Run
+
+```bash
+bun install
+oke dev          # app :6530 · Console :6533 · MCP :6535
+```
+
+| Port | Try |
+|---|---|
+| `:6530` | `GET /` · `GET /health` |
+| `:6533` | Console |
+| `:6535` | MCP |
+
+## What’s in this template
+
+```text
+standard/
+├── oke.config.ts
+├── src/
+│   ├── app.ts                 # adopt({ main }); wires stores + side modules
+│   ├── core.ts / schema.ts    # Store (replace the placeholder table)
+│   ├── gates.ts               # Gate stubs
+│   ├── vault.ts               # Vault stubs
+│   ├── channels.ts            # Channel stubs
+│   ├── locales/en.ts · ar.ts  # i18n stubs
+│   └── flows/main/
+│       ├── index.ts           # GET / · GET /health
+│       ├── shapes.ts          # contracts live next to flows
+│       └── signals.ts         # Signal stubs
+└── tests/standard.test.ts
+```
+
+- **Elements stubbed:** Flow · Store · Signal · Gate · Vault · Channel (+ locales)
+- **Unit:** `main`
+- **Flows to replace:** `root`, `health` — delete or rename once your domain exists
+
+Fill `schema.ts`, then add real flows under `src/flows/<unit>/`. Prefer this
+layout for new products; use `hello` / `minimal` only when you want less surface.
+
+## Agent contract
+
+See [`AGENTS.md`](./AGENTS.md). Handbook: [okengine.vercel.app/docs](https://okengine.vercel.app/docs)

package/templates/standard/oke.config.ts

@@ -0,0 +1,19 @@
+import { defineConfig } from "okengine/config";
+
+export default defineConfig({
+  drivers: {
+    store: {
+      sql: { dev: "sqlite", test: "memory", prod: "postgres" },
+      kv: { dev: "memory", test: "memory", prod: "redis" },
+    },
+    signal: { dev: "memory", test: "memory", prod: "postgres" },
+    clock: { dev: "memory", test: "frozen", prod: "postgres" },
+    vault: { dev: "dotenv", test: "memory", prod: "sops" },
+    channel: {
+      email: { dev: "console", test: "console", prod: "smtp" },
+      sms: { dev: "console", test: "console", prod: "unifonic" },
+      whatsapp: { dev: "console", test: "console", prod: "wa-cloud" },
+    },
+  },
+  i18n: { locales: ["en", "ar"], default: "en", dir: { ar: "rtl" } },
+});

package/templates/standard/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@oke/template-standard",
+  "version": "0.0.1",
+  "private": true,
+  "type": "module",
+  "dependencies": {
+    "okengine": "file:../..",
+    "drizzle-orm": "^1.0.0-rc.4",
+    "zod": "^4.4.3"
+  },
+  "scripts": {
+    "test": "bun test",
+    "dev": "oke dev"
+  }
+}

package/templates/standard/src/app.ts

@@ -0,0 +1,18 @@
+import { db } from "./core";
+import "./gates";
+import "./vault";
+import "./channels";
+import "./locales/en";
+import "./locales/ar";
+
+import { oke } from "okengine";
+import * as main from "./flows/main";
+
+export const app = oke({ name: "standard" }).adopt({ main });
+
+export type App = typeof app;
+
+Object.assign(app.$options, {
+  env: "test",
+  stores: [db],
+});

package/templates/standard/src/channels.ts

@@ -0,0 +1,4 @@
+import { channel } from "okengine";
+
+// add channel templates here
+void channel;

package/templates/standard/src/core.ts

@@ -0,0 +1,4 @@
+import { store } from "okengine";
+import * as schema from "./schema";
+
+export const db = store.sql("app", { schema });

package/templates/standard/src/flows/main/index.ts

@@ -0,0 +1,31 @@
+import { on, flow, http } from "okengine";
+import { z } from "zod";
+
+import "./shapes";
+import "./signals";
+
+/** First-run welcome — visit :6530/ after `oke dev`. */
+export const root = on(
+  http.get("/"),
+  flow({
+    out: z.object({
+      ok: z.literal(true),
+      console: z.string(),
+      try: z.string(),
+    }),
+    do: () => ({
+      ok: true as const,
+      console: "http://127.0.0.1:6533",
+      try: "/health",
+    }),
+  }),
+);
+
+/** Replace with your unit's flows. */
+export const health = on(
+  http.get("/health"),
+  flow({
+    out: z.object({ ok: z.literal(true) }),
+    do: () => ({ ok: true as const }),
+  }),
+);

package/templates/standard/src/flows/main/shapes.ts

@@ -0,0 +1,2 @@
+// add unit shapes here
+export {};

package/templates/standard/src/flows/main/signals.ts

@@ -0,0 +1,4 @@
+import { signal } from "okengine";
+
+// add unit signals here
+void signal;

package/templates/standard/src/gates.ts

@@ -0,0 +1,4 @@
+import { gate } from "okengine";
+
+// add shared gates here
+void gate;

package/templates/standard/src/locales/ar.ts

@@ -0,0 +1,2 @@
+/** Locale strings — add keys as channel templates need them. */
+export default {};

package/templates/standard/src/locales/en.ts

@@ -0,0 +1,2 @@
+/** Locale strings — add keys as channel templates need them. */
+export default {};

package/templates/standard/src/schema.ts

@@ -0,0 +1,9 @@
+import { sqliteTable, text, integer } from "drizzle-orm/sqlite-core";
+import { id, now } from "okengine/store";
+
+/** Replace with your tables — keep defaults on the schema. */
+export const entries = sqliteTable("entries", {
+  id: text("id").primaryKey().$defaultFn(id),
+  body: text("body").notNull(),
+  createdAt: integer("created_at").notNull().$defaultFn(now),
+});

package/templates/standard/src/vault.ts

@@ -0,0 +1,4 @@
+import { vault } from "okengine";
+
+// add shared secrets here
+void vault;

package/templates/standard/tests/standard.test.ts

@@ -0,0 +1,10 @@
+import { test, expect } from "bun:test";
+import { createTestApp } from "okengine/test";
+import { app } from "../src/app";
+
+test("boots — health flow", async () => {
+  const t = await createTestApp(app);
+  const { data, error } = await t.api.main.health({});
+  expect(error).toBeNull();
+  expect(data).toEqual({ ok: true });
+});