import { createHash } from "node:crypto"; import { readFile } from "node:fs/promises"; import { ANONYMOUS_PRINCIPAL, type CapabilityId, type ModuleDatabase, type ModuleRouteDefinitionInput, type ModuleRouteHandlerContext, type ModuleRuntimeServices, parseDrizzleMigrationJournal, parseModuleManifest, parseModuleMigrationPolicy, type RegisteredCapability, } from "@ekklesia/module-sdk"; import { getTableConfig } from "drizzle-orm/pg-core"; import { describe, expect, it } from "vitest"; import moduleSchema, { records } from "../src/schema/index.js"; import moduleRuntime, { recordsCapability } from "../src/server/index.js"; /** A small typed fake `ModuleDatabase` — no PostgreSQL required for this unit test, which only * proves the example handler queries through the facade and shapes its response correctly. */ function fakeModuleDatabase(rows: readonly { id: string; value: string }[]): ModuleDatabase { const selectBuilder = { from: () => Promise.resolve(rows) }; return { select: () => selectBuilder } as unknown as ModuleDatabase; } async function registerAndCaptureRoutes(): Promise<{ provided: Map; routes: ModuleRouteDefinitionInput[]; }> { const provided = new Map(); const routes: ModuleRouteDefinitionInput[] = []; await moduleRuntime.register?.({ capabilities: { provide(capabilityId, implementation) { provided.set(capabilityId, implementation); }, resolve(_capabilityId: CapabilityId): RegisteredCapability | undefined { return undefined; }, }, http: { route(definition) { routes.push(definition); }, }, moduleId: "example", }); return { provided, routes }; } describe("module template", () => { it("ships a valid backend-only manifest", async () => { const manifestUrl = new URL("../ekklesia.module.json", import.meta.url); const manifestInput = JSON.parse(await readFile(manifestUrl, "utf8")) as unknown; const manifest = parseModuleManifest(manifestInput); expect(manifest.id).toBe("example"); expect(manifest.capabilities).toEqual([{ id: "example.records", version: "1.0.0" }]); expect(manifest.permissions).toEqual([ { id: "example.records.read", baseline: "restricted", description: "Read example records.", }, ]); expect(manifest.storage.buckets.map((bucket) => bucket.id)).toEqual(["records"]); expect(manifest.entrypoints.schema).toBe("./dist/schema/index.js"); expect(manifest.entrypoints.migrations).toBe("./drizzle"); }); it("packages a generated stable Drizzle migration and matching policy", async () => { const [journalInput, policyInput, packageInput, sql] = await Promise.all([ readFile(new URL("../drizzle/meta/_journal.json", import.meta.url), "utf8"), readFile(new URL("../drizzle/meta/_ekklesia.json", import.meta.url), "utf8"), readFile(new URL("../package.json", import.meta.url), "utf8"), readFile(new URL("../drizzle/0000_initial.sql", import.meta.url)), ]); const journal = parseDrizzleMigrationJournal(JSON.parse(journalInput) as unknown); const policy = parseModuleMigrationPolicy(JSON.parse(policyInput) as unknown); const packageJson = JSON.parse(packageInput) as { devDependencies?: Record; files?: string[]; }; expect(journal.entries.map((entry) => entry.tag)).toEqual(["0000_initial"]); expect(policy).toMatchObject({ moduleId: "example", entries: [{ tag: "0000_initial", destructive: { mode: "none" } }], }); expect(packageJson.devDependencies?.["drizzle-kit"]).toBe("0.31.10"); expect(packageJson.files).toContain("drizzle"); expect(createHash("sha256").update(sql).digest("hex")).toBe( "e09d6c9995fa2c4bd59b815afc9bb6ded6a2d4e1b3e1d97c10457a94a6a4f2a4", ); expect(sql.toString("utf8")).toContain('CREATE TABLE "example_records"'); }); it("exports the typed runtime definition used by the compiled server entrypoint, registering its one example route database-free", async () => { const { provided, routes } = await registerAndCaptureRoutes(); expect(moduleRuntime).toMatchObject({ id: "example", version: "0.1.0" }); expect(provided.get("example.records")).toBe(recordsCapability); expect(routes).toHaveLength(1); expect(routes[0]).toMatchObject({ method: "GET", path: "/records", permission: "example.records.read", // The template's example route demonstrates the explicit no-body contract: a GET route // accepts no request body at all. maxBodyBytes: 0, }); }); it("queries the module's own table through context.services.database in the example route handler", async () => { const { routes } = await registerAndCaptureRoutes(); const route = routes[0]; if (!route) { throw new Error("Expected the example route to be registered."); } const fakeRows = [{ id: "9d3f9f7e-3b1a-4c9a-8b8e-2b6b1e6f9a11", value: "hello" }]; const services: ModuleRuntimeServices = Object.freeze({ database: fakeModuleDatabase(fakeRows), }); const context: ModuleRouteHandlerContext = Object.freeze({ moduleId: "example", params: Object.freeze({}), principal: ANONYMOUS_PRINCIPAL, services, }); const response = await route.handler(new Request("http://localhost/records"), context); expect(response).toBeInstanceOf(Response); expect(await response.json()).toEqual(fakeRows); }); it("exports a namespaced module-owned Drizzle schema", () => { expect(moduleSchema.moduleId).toBe("example"); expect(moduleSchema.tables.records).toBe(records); expect(getTableConfig(records)).toMatchObject({ name: "example_records", schema: undefined }); }); });