create-oke 0.10.2 → 0.11.0

package/templates/standard/src/core.ts

@@ -0,0 +1,55 @@
+/**
+ * App core — element wiring loaded by `import "@/core"` from `app.ts`.
+ *
+ * Order matches how you usually extend the starter:
+ * locales → store → gate → vault → channel → (AI via `oke ai setup`).
+ * Keep this file until a section outgrows it, then split by element.
+ */
+
+import "@/locales";
+
+import { channel, gate, store, vault } from "okengine";
+import { z } from "zod";
+import * as schema from "@/db/schema.decl";
+
+// --- Store -------------------------------------------------------------------
+
+/** SQL store for Notes (`schema.decl`). Drivers: pglite locally · postgres in docker. */
+export const db = store.sql("app", { schema });
+
+// --- Gate --------------------------------------------------------------------
+
+/**
+ * Write policy for notes. Starter allows everyone — swap in real auth scopes:
+ *
+ * ```ts
+ * export const notesWrite = gate.policy("notes:write", ({ auth }) =>
+ *   auth.scopes.has("notes:write"),
+ * );
+ * ```
+ */
+export const notesWrite = gate.policy("notes:write", () => true);
+
+// --- Vault -------------------------------------------------------------------
+
+/** HMAC secret for outbound note webhooks (`fx.vault.get` on create). */
+export const webhookSecret = vault.secret("APP_WEBHOOK_SECRET", {
+  description: "HMAC secret for outbound note webhooks",
+  dev: "dev-webhook-secret-change-me",
+});
+
+// --- Channel -----------------------------------------------------------------
+
+const mail = channel.email({ from: "Notes <notes@localhost>" });
+
+/** Fired when a note is created (console driver locally · SMTP in docker). */
+export const noteCreatedMail = mail.template("note-created", {
+  locales: ["en"],
+  schema: z.object({
+    id: z.string(),
+    title: z.string(),
+  }),
+});
+
+// --- AI ----------------------------------------------------------------------
+// `oke ai setup` / create-oke --ai appends models here.

package/templates/standard/src/db/schema.decl.ts

@@ -2,7 +2,7 @@ import { store, field, id, now } from "okengine";
 
 /**
  * Notes domain — abstract declarations, emitted to
- * `src/db/schema.generated.ts` for the active dialect by `oke db` / `oke dev`.
+ * `src/db/schema.drizzle.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/standard/src/db/seed/index.ts

@@ -1,6 +1,6 @@
 import { defineSeed, type Fx } from "okengine";
-import { db } from "../../core";
-import { notes } from "../schema.decl";
+import { db } from "@/core";
+import { notes } from "@/db/schema.decl";
 
 /**
  * Seed data — run explicitly with `oke db seed` (never at boot).

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

@@ -1,8 +1,8 @@
 import { on, flow, http, gate, fail } from "okengine";
 import { eq, isNull } from "drizzle-orm";
 
-import { db, noteCreatedMail, webhookSecret } from "../../core";
-import { notes } from "../../db/schema.decl";
+import { db, noteCreatedMail, webhookSecret } from "@/core";
+import { notes } from "@/db/schema.decl";
 import { NoteCreateIn, NoteIdIn, NoteListOut, NoteOut, NotFound } from "./shapes";
 import { noteCreated } from "./signals";
 
@@ -14,7 +14,6 @@ export const list = on(
   http.get("/notes").gate(gate.public),
   flow("notes.list", {
     out: NoteListOut,
-    effects: { reads: ["sql:app"] },
     do: async (_input, fx) => {
       const rows = await fx.store(db).select().from(notes).where(isNull(notes.archivedAt));
       const sorted = [...rows].sort((a, b) => Number(b.createdAt) - Number(a.createdAt));
@@ -37,14 +36,9 @@ export const create = on(
   flow("notes.create", {
     in: NoteCreateIn,
     out: NoteOut,
-    effects: {
-      writes: ["sql:app"],
-      emits: ["note-created"],
-      secrets: ["APP_WEBHOOK_SECRET"],
-    },
     do: async (input, fx) => {
       // Prove Vault is wired (local: env/dev fallback).
-      fx.vault(webhookSecret);
+      await fx.vault.get(webhookSecret);
       const id = fx.id();
       const createdAt = fx.clock.now();
       await fx.store(db).insert(notes).values({
@@ -73,7 +67,6 @@ export const get = on(
     in: NoteIdIn,
     out: NoteOut,
     errors: { NotFound },
-    effects: { reads: ["sql:app"] },
     do: async (input, fx) => {
       const row = await fx.store(db).findById(notes, input.id);
       if (!row) return fail("NotFound", { id: input.id });
@@ -95,7 +88,6 @@ export const archive = on(
     in: NoteIdIn,
     out: NoteOut,
     errors: { NotFound },
-    effects: { reads: ["sql:app"], writes: ["sql:app"] },
     do: async (input, fx) => {
       const row = await fx.store(db).findById(notes, input.id);
       if (!row) return fail("NotFound", { id: input.id });
@@ -120,7 +112,6 @@ export const archive = on(
 export const onCreated = on(
   noteCreated,
   flow("notes.onCreated", {
-    effects: { sends: ["note-created"] },
     do: async (payload, fx) => {
       await fx.send(noteCreatedMail, {
         to: "you@localhost",

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

@@ -0,0 +1,6 @@
+/**
+ * Message catalogs — imported once from `src/core.ts`.
+ * Add a sibling import when you add a locale file.
+ */
+
+import "./en";

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

@@ -1,6 +1,6 @@
 import { afterAll, beforeAll, expect, test } from "bun:test";
 import { createTestApp, type TestApp } from "okengine/test";
-import { app, type App } from "../src/app";
+import { app, type App } from "@/app";
 
 let t: TestApp<App>;
 

package/templates/standard/tsconfig.json

@@ -6,6 +6,9 @@
     "moduleDetection": "force",
     "types": ["bun"],
     "moduleResolution": "bundler",
+    "paths": {
+      "@/*": ["./src/*"]
+    },
     "allowImportingTsExtensions": true,
     "verbatimModuleSyntax": true,
     "noEmit": true,

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

@@ -1,13 +0,0 @@
-import { channel } from "okengine";
-import { z } from "zod";
-
-const mail = channel.email({ from: "Notes <notes@localhost>" });
-
-/** Email when a note is created (console driver locally · SMTP in docker). */
-export const noteCreatedMail = mail.template("note-created", {
-  locales: ["en", "ar"],
-  schema: z.object({
-    id: z.string(),
-    title: z.string(),
-  }),
-});

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

@@ -1,12 +0,0 @@
-import { gate } from "okengine";
-
-/**
- * Starter keeps HTTP public. Replace with real policies when you add auth:
- *
- * ```ts
- * export const canWriteNotes = gate.policy("notes:write", ({ auth }) =>
- *   auth.scopes.has("notes:write"),
- * );
- * ```
- */
-export const notesWrite = gate.policy("notes:write", () => true);

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

@@ -1,12 +0,0 @@
-/**
- * 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/store.ts

@@ -1,8 +0,0 @@
-import { store } from "okengine";
-import * as schema from "../db/schema.decl";
-
-/** App SQL store — tables from {@link schema}. */
-export const db = store.sql("app", { schema });
-
-/** Object storage for note attachments (fs locally · s3 in docker). */
-export const files = store.files("uploads");

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

@@ -1,7 +0,0 @@
-import { vault } from "okengine";
-
-/** Shared webhook HMAC secret — prove Vault wiring on note create. */
-export const webhookSecret = vault.secret("APP_WEBHOOK_SECRET", {
-  description: "HMAC secret for outbound note webhooks",
-  dev: "dev-webhook-secret-change-me",
-});

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

@@ -1,18 +0,0 @@
-import { defineLocale } from "okengine";
-import type { MessagesFor } from "okengine";
-import type { en } from "./en";
-
-const ar = {
-  errors: {
-    notFound: "غير موجود",
-    unauthorized: "غير مصرح",
-  },
-  notes: {
-    created: "تم إنشاء الملاحظة «{title}».",
-    archived: "تم أرشفة الملاحظة.",
-    empty: "لا توجد ملاحظات نشطة بعد.",
-    count: "{count, plural, zero {لا ملاحظات} one {ملاحظة واحدة} two {ملاحظتان} few {# ملاحظات} many {# ملاحظة} other {# ملاحظة}}",
-  },
-} satisfies MessagesFor<typeof en>;
-
-defineLocale("ar", ar);

package/templates/standard/src/core/channels.ts

@@ -1,13 +0,0 @@
-import { channel } from "okengine";
-import { z } from "zod";
-
-const mail = channel.email({ from: "Notes <notes@localhost>" });
-
-/** Email when a note is created (console driver locally · SMTP in docker). */
-export const noteCreatedMail = mail.template("note-created", {
-  locales: ["en", "ar"],
-  schema: z.object({
-    id: z.string(),
-    title: z.string(),
-  }),
-});

package/templates/standard/src/core/gates.ts

@@ -1,12 +0,0 @@
-import { gate } from "okengine";
-
-/**
- * Starter keeps HTTP public. Replace with real policies when you add auth:
- *
- * ```ts
- * export const canWriteNotes = gate.policy("notes:write", ({ auth }) =>
- *   auth.scopes.has("notes:write"),
- * );
- * ```
- */
-export const notesWrite = gate.policy("notes:write", () => true);

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

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

package/templates/standard/src/core/store.ts

@@ -1,5 +0,0 @@
-import { store } from "okengine";
-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/core/vault.ts

@@ -1,7 +0,0 @@
-import { vault } from "okengine";
-
-/** Shared webhook HMAC secret — prove Vault wiring on note create. */
-export const webhookSecret = vault.secret("APP_WEBHOOK_SECRET", {
-  description: "HMAC secret for outbound note webhooks",
-  dev: "dev-webhook-secret-change-me",
-});

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

@@ -1,18 +0,0 @@
-import { defineLocale } from "okengine";
-import type { MessagesFor } from "okengine";
-import type { en } from "./en";
-
-const ar = {
-  errors: {
-    notFound: "غير موجود",
-    unauthorized: "غير مصرح",
-  },
-  notes: {
-    created: "تم إنشاء الملاحظة «{title}».",
-    archived: "تم أرشفة الملاحظة.",
-    empty: "لا توجد ملاحظات نشطة بعد.",
-    count: "{count, plural, zero {لا ملاحظات} one {ملاحظة واحدة} two {ملاحظتان} few {# ملاحظات} many {# ملاحظة} other {# ملاحظة}}",
-  },
-} satisfies MessagesFor<typeof en>;
-
-defineLocale("ar", ar);