fix: keep Drizzle out of every published declaration (ADR 0053)
CI / verify (pull_request) Successful in 1m2s
CI / infrastructure-smoke (pull_request) Successful in 37s
CI / migration-smoke (pull_request) Successful in 1m52s
CI / standalone-module (pull_request) Successful in 26s
CI / image-build (pull_request) Successful in 28s
CI / deploy-smoke (same-origin) (pull_request) Successful in 43s
CI / deploy-smoke (split) (pull_request) Successful in 1m30s

@ekklesia/contracts still emitted a type-only import of
drizzle-orm/node-postgres for the legacy ModuleDatabase facade, so a
standalone module type-checked only because skipLibCheck hid it.

- ModuleDatabase, LegacyModuleRuntimeServices and
  AnyModuleRuntimeServices move to core/src/modules/database.ts, beside
  the facade Core builds; the facade itself is unchanged.
- contracts' runtime, route, and services generics no longer name an
  ORM: the database type is a plain parameter defaulting to the ABI v1
  executor, and the legacy definition's database is opaque until Core
  specializes it. Core and apps/api name the legacy types from Core.
- contracts drops its drizzle-orm optional peer and devDependency;
  Drizzle stays public only through @ekklesia/module-database/drizzle.
- The facade's type-level test moves from contracts to Core.
- Regression proof: the standalone fixture type-checks with
  skipLibCheck: false against the packed tarballs, with no drizzle-orm
  installed (the smoke asserts both). Against the previous contracts
  tarball the same check fails with TS2307 on drizzle-orm/node-postgres.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
This commit is contained in:
ekklesia
2026-10-08 07:40:43 -05:00
co-authored by Claude Opus 5.5
parent 89d5d0f2da
commit aaa7ebfd84
31 changed files with 190 additions and 178 deletions
+2 -2
View File
@@ -1,6 +1,5 @@
import { import {
isAuthenticatedPrincipal, isAuthenticatedPrincipal,
type ModuleRuntimeServices,
type ModuleSecretSource, type ModuleSecretSource,
type RegisteredModuleHttpRoute, type RegisteredModuleHttpRoute,
} from "@ekklesia/contracts"; } from "@ekklesia/contracts";
@@ -13,6 +12,7 @@ import type { DashboardStore } from "@ekklesia/core/dashboard";
import type { DeviceStore } from "@ekklesia/core/devices"; import type { DeviceStore } from "@ekklesia/core/devices";
import { type EkklesiaIdentityRuntime, IdentityRuntimeError } from "@ekklesia/core/identity"; import { type EkklesiaIdentityRuntime, IdentityRuntimeError } from "@ekklesia/core/identity";
import type { import type {
AnyModuleRuntimeServices,
DiscoveredModule, DiscoveredModule,
ModuleConfigurationLookup, ModuleConfigurationLookup,
ModuleConfigurationSettings, ModuleConfigurationSettings,
@@ -66,7 +66,7 @@ export interface CreateApiAppOptions {
/** The same per-module service lookup the caller's started module runtime used for every /** The same per-module service lookup the caller's started module runtime used for every
* module's `start`/`stop` hooks (`apps/api/src/server.ts`) — each handler receives its module's * module's `start`/`stop` hooks (`apps/api/src/server.ts`) — each handler receives its module's
* reference-identical service object, never a fresh facade or executor built per request. */ * reference-identical service object, never a fresh facade or executor built per request. */
readonly moduleServices: ModuleRuntimeServicesLookup | ModuleRuntimeServices; readonly moduleServices: ModuleRuntimeServicesLookup | AnyModuleRuntimeServices;
/** The platform's module UI publication policy — always the one Core builds from the exact /** The platform's module UI publication policy — always the one Core builds from the exact
* discovered inventory this runtime started (`createModuleUiPublicationRegistry`, * discovered inventory this runtime started (`createModuleUiPublicationRegistry`,
* `apps/api/src/server.ts`). Required rather than defaulted, for the same reason `moduleRoutes` * `apps/api/src/server.ts`). Required rather than defaulted, for the same reason `moduleRoutes`
+2 -1
View File
@@ -1,4 +1,4 @@
import type { ModuleDatabase, ModuleDatabaseExecutor, ModuleId } from "@ekklesia/contracts"; import type { ModuleDatabaseExecutor, ModuleId } from "@ekklesia/contracts";
import { import {
type AuthorizationDrizzleDatabase, type AuthorizationDrizzleDatabase,
createAuthorizationDrizzleView, createAuthorizationDrizzleView,
@@ -16,6 +16,7 @@ import {
createModuleDatabaseView, createModuleDatabaseView,
createModuleLifecycleView, createModuleLifecycleView,
type ModuleConfigurationDrizzleDatabase, type ModuleConfigurationDrizzleDatabase,
type ModuleDatabase,
type ModuleLifecycleDrizzleDatabase, type ModuleLifecycleDrizzleDatabase,
} from "@ekklesia/core/modules"; } from "@ekklesia/core/modules";
+3 -3
View File
@@ -1,15 +1,15 @@
import { import {
EMPTY_MODULE_CONFIGURATION, EMPTY_MODULE_CONFIGURATION,
EMPTY_MODULE_STORAGE, EMPTY_MODULE_STORAGE,
type ModuleDatabase,
type ModuleDatabaseExecutor, type ModuleDatabaseExecutor,
type ModuleId, type ModuleId,
type ModuleRouteHandlerContext, type ModuleRouteHandlerContext,
type ModuleRuntimeServices,
type RegisteredModuleHttpRoute, type RegisteredModuleHttpRoute,
} from "@ekklesia/contracts"; } from "@ekklesia/contracts";
import type { import type {
AnyModuleRuntimeServices,
ModuleConfigurationLookup, ModuleConfigurationLookup,
ModuleDatabase,
ModuleRealtimeRegistry, ModuleRealtimeRegistry,
ModuleRuntimeServicesLookup, ModuleRuntimeServicesLookup,
ModuleStorageLookup, ModuleStorageLookup,
@@ -40,7 +40,7 @@ export interface ModuleHttpRoutesOptions extends AuthorizationMiddlewareOptions
* received for this API runtime — never a fresh one built per request, and never touched for a * received for this API runtime — never a fresh one built per request, and never touched for a
* denied, trusted-origin-rejected, or `OPTIONS` request, since a handler is only ever invoked * denied, trusted-origin-rejected, or `OPTIONS` request, since a handler is only ever invoked
* after authorization succeeds. */ * after authorization succeeds. */
readonly services: ModuleRuntimeServicesLookup | ModuleRuntimeServices; readonly services: ModuleRuntimeServicesLookup | AnyModuleRuntimeServices;
/** /**
* Per-module frozen configuration snapshots — the exact map the module runtime started from * Per-module frozen configuration snapshots — the exact map the module runtime started from
* (ADR 0029), so a handler and that module's `start`/`stop` hooks receive the identical object * (ADR 0029), so a handler and that module's `start`/`stop` hooks receive the identical object
+2 -5
View File
@@ -1,11 +1,7 @@
import type { Socket } from "node:net"; import type { Socket } from "node:net";
import path from "node:path"; import path from "node:path";
import { pathToFileURL } from "node:url"; import { pathToFileURL } from "node:url";
import { import { EMPTY_MODULE_SECRET_SOURCE, type ModuleSecretSource } from "@ekklesia/contracts";
type AnyModuleRuntimeServices,
EMPTY_MODULE_SECRET_SOURCE,
type ModuleSecretSource,
} from "@ekklesia/contracts";
import { import {
createAuthorizationEvaluator, createAuthorizationEvaluator,
createAuthorizationStore, createAuthorizationStore,
@@ -21,6 +17,7 @@ import {
} from "@ekklesia/core/identity"; } from "@ekklesia/core/identity";
import { createSmtpMailProvider, type MailProvider } from "@ekklesia/core/mail"; import { createSmtpMailProvider, type MailProvider } from "@ekklesia/core/mail";
import { import {
type AnyModuleRuntimeServices,
createModuleConfigurationStore, createModuleConfigurationStore,
createModuleLifecycleStore, createModuleLifecycleStore,
createModuleUiPublicationRegistry, createModuleUiPublicationRegistry,
+4 -4
View File
@@ -1,8 +1,6 @@
import { import {
ANONYMOUS_PRINCIPAL, ANONYMOUS_PRINCIPAL,
createAuthenticatedPrincipal, createAuthenticatedPrincipal,
type ModuleDatabase,
type ModuleRuntimeServices,
moduleIdSchema, moduleIdSchema,
parseEkklesiaUserId, parseEkklesiaUserId,
parsePermissionId, parsePermissionId,
@@ -20,6 +18,8 @@ import { IdentityRuntimeError } from "@ekklesia/core/identity";
import { import {
createModuleUiPublicationRegistry, createModuleUiPublicationRegistry,
EMPTY_MODULE_REALTIME_REGISTRY, EMPTY_MODULE_REALTIME_REGISTRY,
type LegacyModuleRuntimeServices,
type ModuleDatabase,
type ModuleUiPublicationRegistry, type ModuleUiPublicationRegistry,
StagedModuleRealtimeRegistry, StagedModuleRealtimeRegistry,
} from "@ekklesia/core/modules"; } from "@ekklesia/core/modules";
@@ -48,9 +48,9 @@ function fakeRuntime(overrides: Partial<EkklesiaIdentityRuntime> = {}): Ekklesia
}; };
} }
/** A small typed fake `ModuleRuntimeServices` — these tests exercise `createApiApp`'s own wiring, /** A small typed fake `LegacyModuleRuntimeServices` — these tests exercise `createApiApp`'s own wiring,
* never real database behavior, so no PostgreSQL is required. */ * never real database behavior, so no PostgreSQL is required. */
function fakeModuleServices(): ModuleRuntimeServices { function fakeModuleServices(): LegacyModuleRuntimeServices {
const database = Object.freeze({ const database = Object.freeze({
delete: vi.fn(), delete: vi.fn(),
execute: vi.fn(), execute: vi.fn(),
+3 -3
View File
@@ -1,9 +1,7 @@
import { createHash } from "node:crypto"; import { createHash } from "node:crypto";
import { import {
ANONYMOUS_PRINCIPAL, ANONYMOUS_PRINCIPAL,
type ModuleDatabase,
type ModuleRouteHandler, type ModuleRouteHandler,
type ModuleRuntimeServices,
parsePermissionId, parsePermissionId,
type RegisteredModuleHttpRoute, type RegisteredModuleHttpRoute,
} from "@ekklesia/contracts"; } from "@ekklesia/contracts";
@@ -16,6 +14,8 @@ import type { EkklesiaIdentityRuntime } from "@ekklesia/core/identity";
import { import {
createModuleUiPublicationRegistry, createModuleUiPublicationRegistry,
EMPTY_MODULE_REALTIME_REGISTRY, EMPTY_MODULE_REALTIME_REGISTRY,
type LegacyModuleRuntimeServices,
type ModuleDatabase,
} from "@ekklesia/core/modules"; } from "@ekklesia/core/modules";
import { describe, expect, it, vi } from "vitest"; import { describe, expect, it, vi } from "vitest";
@@ -74,7 +74,7 @@ function fakeStore(): AuthorizationStore {
}; };
} }
function fakeModuleServices(): ModuleRuntimeServices { function fakeModuleServices(): LegacyModuleRuntimeServices {
return Object.freeze({ database: Object.freeze({}) as unknown as ModuleDatabase }); return Object.freeze({ database: Object.freeze({}) as unknown as ModuleDatabase });
} }
+3 -3
View File
@@ -5,8 +5,6 @@ import {
ANONYMOUS_PRINCIPAL, ANONYMOUS_PRINCIPAL,
createAuthenticatedPrincipal, createAuthenticatedPrincipal,
type EkklesiaPrincipal, type EkklesiaPrincipal,
type ModuleDatabase,
type ModuleRuntimeServices,
parseEkklesiaUserId, parseEkklesiaUserId,
} from "@ekklesia/contracts"; } from "@ekklesia/contracts";
import { import {
@@ -20,6 +18,8 @@ import {
createModuleUiPublicationRegistry, createModuleUiPublicationRegistry,
discoverModules, discoverModules,
EMPTY_MODULE_REALTIME_REGISTRY, EMPTY_MODULE_REALTIME_REGISTRY,
type LegacyModuleRuntimeServices,
type ModuleDatabase,
} from "@ekklesia/core/modules"; } from "@ekklesia/core/modules";
import type { Hono } from "hono"; import type { Hono } from "hono";
import { afterEach, describe, expect, it, vi } from "vitest"; import { afterEach, describe, expect, it, vi } from "vitest";
@@ -147,7 +147,7 @@ async function install(options: InstallOptions = {}): Promise<{ app: Hono }> {
moduleRealtime: EMPTY_MODULE_REALTIME_REGISTRY, moduleRealtime: EMPTY_MODULE_REALTIME_REGISTRY,
moduleServices: Object.freeze({ moduleServices: Object.freeze({
database: Object.freeze({}) as unknown as ModuleDatabase, database: Object.freeze({}) as unknown as ModuleDatabase,
}) as ModuleRuntimeServices, }) as LegacyModuleRuntimeServices,
moduleUi: createModuleUiPublicationRegistry(modules), moduleUi: createModuleUiPublicationRegistry(modules),
moduleLifecycle: { moduleLifecycle: {
snapshot: moduleLifecycleSnapshotFor(modules), snapshot: moduleLifecycleSnapshotFor(modules),
+3 -3
View File
@@ -1,8 +1,6 @@
import { import {
ANONYMOUS_PRINCIPAL, ANONYMOUS_PRINCIPAL,
type ModuleDatabase,
type ModuleRouteHandler, type ModuleRouteHandler,
type ModuleRuntimeServices,
parsePermissionId, parsePermissionId,
type RegisteredModuleHttpRoute, type RegisteredModuleHttpRoute,
} from "@ekklesia/contracts"; } from "@ekklesia/contracts";
@@ -15,6 +13,8 @@ import type { EkklesiaIdentityRuntime } from "@ekklesia/core/identity";
import { import {
createModuleUiPublicationRegistry, createModuleUiPublicationRegistry,
EMPTY_MODULE_REALTIME_REGISTRY, EMPTY_MODULE_REALTIME_REGISTRY,
type LegacyModuleRuntimeServices,
type ModuleDatabase,
} from "@ekklesia/core/modules"; } from "@ekklesia/core/modules";
import { afterEach, describe, expect, it, vi } from "vitest"; import { afterEach, describe, expect, it, vi } from "vitest";
import { createApiApp } from "../src/app.js"; import { createApiApp } from "../src/app.js";
@@ -56,7 +56,7 @@ function fakeStore(): AuthorizationStore {
}; };
} }
function fakeModuleServices(): ModuleRuntimeServices { function fakeModuleServices(): LegacyModuleRuntimeServices {
return Object.freeze({ database: Object.freeze({}) as unknown as ModuleDatabase }); return Object.freeze({ database: Object.freeze({}) as unknown as ModuleDatabase });
} }
@@ -6,8 +6,6 @@ import {
createAuthenticatedPrincipal, createAuthenticatedPrincipal,
type EkklesiaPrincipal, type EkklesiaPrincipal,
type ModuleConfigurationDeclarationInput, type ModuleConfigurationDeclarationInput,
type ModuleDatabase,
type ModuleRuntimeServices,
parseEkklesiaUserId, parseEkklesiaUserId,
} from "@ekklesia/contracts"; } from "@ekklesia/contracts";
import { import {
@@ -22,10 +20,12 @@ import {
createModuleUiPublicationRegistry, createModuleUiPublicationRegistry,
type DiscoveredModule, type DiscoveredModule,
discoverModules, discoverModules,
type LegacyModuleRuntimeServices,
type ModuleConfigurationRecord, type ModuleConfigurationRecord,
type ModuleConfigurationStore, type ModuleConfigurationStore,
ModuleConfigurationStoreError, ModuleConfigurationStoreError,
EMPTY_MODULE_REALTIME_REGISTRY, EMPTY_MODULE_REALTIME_REGISTRY,
type ModuleDatabase,
resolveModuleEligibility, resolveModuleEligibility,
} from "@ekklesia/core/modules"; } from "@ekklesia/core/modules";
import type { Hono } from "hono"; import type { Hono } from "hono";
@@ -213,7 +213,7 @@ async function install(options: InstallOptions = {}): Promise<Installation> {
moduleRealtime: EMPTY_MODULE_REALTIME_REGISTRY, moduleRealtime: EMPTY_MODULE_REALTIME_REGISTRY,
moduleServices: Object.freeze({ moduleServices: Object.freeze({
database: Object.freeze({}) as unknown as ModuleDatabase, database: Object.freeze({}) as unknown as ModuleDatabase,
}) as ModuleRuntimeServices, }) as LegacyModuleRuntimeServices,
moduleUi: createModuleUiPublicationRegistry(eligibility.eligibleModules), moduleUi: createModuleUiPublicationRegistry(eligibility.eligibleModules),
runtime, runtime,
trustedOrigins: [trustedOrigin], trustedOrigins: [trustedOrigin],
+3 -3
View File
@@ -5,8 +5,6 @@ import {
ANONYMOUS_PRINCIPAL, ANONYMOUS_PRINCIPAL,
createAuthenticatedPrincipal, createAuthenticatedPrincipal,
type EkklesiaPrincipal, type EkklesiaPrincipal,
type ModuleDatabase,
type ModuleRuntimeServices,
parseEkklesiaUserId, parseEkklesiaUserId,
} from "@ekklesia/contracts"; } from "@ekklesia/contracts";
import { import {
@@ -21,6 +19,8 @@ import {
type DiscoveredModule, type DiscoveredModule,
discoverModules, discoverModules,
EMPTY_MODULE_REALTIME_REGISTRY, EMPTY_MODULE_REALTIME_REGISTRY,
type LegacyModuleRuntimeServices,
type ModuleDatabase,
} from "@ekklesia/core/modules"; } from "@ekklesia/core/modules";
import type { Hono } from "hono"; import type { Hono } from "hono";
import { afterEach, describe, expect, it, vi } from "vitest"; import { afterEach, describe, expect, it, vi } from "vitest";
@@ -155,7 +155,7 @@ interface Installation {
readonly modules: readonly DiscoveredModule[]; readonly modules: readonly DiscoveredModule[];
} }
function fakeServices(): ModuleRuntimeServices { function fakeServices(): LegacyModuleRuntimeServices {
return Object.freeze({ database: Object.freeze({}) as unknown as ModuleDatabase }); return Object.freeze({ database: Object.freeze({}) as unknown as ModuleDatabase });
} }
+9 -9
View File
@@ -1,10 +1,8 @@
import { import {
ANONYMOUS_PRINCIPAL, ANONYMOUS_PRINCIPAL,
createAuthenticatedPrincipal, createAuthenticatedPrincipal,
type ModuleDatabase,
type ModuleRouteHandler, type ModuleRouteHandler,
type ModuleRouteHandlerContext, type ModuleRouteHandlerContext,
type ModuleRuntimeServices,
moduleRoutesOverlap, moduleRoutesOverlap,
type PermissionId, type PermissionId,
parsePermissionId, parsePermissionId,
@@ -20,6 +18,8 @@ import type { EkklesiaIdentityRuntime } from "@ekklesia/core/identity";
import { import {
createModuleUiPublicationRegistry, createModuleUiPublicationRegistry,
EMPTY_MODULE_REALTIME_REGISTRY, EMPTY_MODULE_REALTIME_REGISTRY,
type LegacyModuleRuntimeServices,
type ModuleDatabase,
type ModuleRuntimeServicesLookup, type ModuleRuntimeServicesLookup,
} from "@ekklesia/core/modules"; } from "@ekklesia/core/modules";
import { describe, expect, it, vi } from "vitest"; import { describe, expect, it, vi } from "vitest";
@@ -74,11 +74,11 @@ function moduleRoute(
return Object.freeze({ bodyMode: "buffered", maxBodyBytes: 1024, ...fields }); return Object.freeze({ bodyMode: "buffered", maxBodyBytes: 1024, ...fields });
} }
/** A small typed fake `ModuleRuntimeServices` — these tests exercise route mounting, /** A small typed fake `LegacyModuleRuntimeServices` — these tests exercise route mounting,
* authorization, and response sanitization, never real database behavior, so no PostgreSQL is * authorization, and response sanitization, never real database behavior, so no PostgreSQL is
* required. Each `database` method stays a distinct spy so a test can assert none of them were * required. Each `database` method stays a distinct spy so a test can assert none of them were
* ever called (denied, trusted-origin-rejected, and `OPTIONS` requests never reach a handler). */ * ever called (denied, trusted-origin-rejected, and `OPTIONS` requests never reach a handler). */
function fakeModuleServices(): ModuleRuntimeServices { function fakeModuleServices(): LegacyModuleRuntimeServices {
const database = Object.freeze({ const database = Object.freeze({
delete: vi.fn(), delete: vi.fn(),
execute: vi.fn(), execute: vi.fn(),
@@ -92,7 +92,7 @@ function fakeModuleServices(): ModuleRuntimeServices {
return Object.freeze({ database }); return Object.freeze({ database });
} }
function expectDatabaseFakeUntouched(services: ModuleRuntimeServices): void { function expectDatabaseFakeUntouched(services: LegacyModuleRuntimeServices): void {
expect(vi.mocked(services.database.select)).not.toHaveBeenCalled(); expect(vi.mocked(services.database.select)).not.toHaveBeenCalled();
expect(vi.mocked(services.database.selectDistinct)).not.toHaveBeenCalled(); expect(vi.mocked(services.database.selectDistinct)).not.toHaveBeenCalled();
expect(vi.mocked(services.database.selectDistinctOn)).not.toHaveBeenCalled(); expect(vi.mocked(services.database.selectDistinctOn)).not.toHaveBeenCalled();
@@ -108,7 +108,7 @@ function buildModuleApp(options: {
readonly registry: PermissionRegistry; readonly registry: PermissionRegistry;
readonly routes: readonly RegisteredModuleHttpRoute[]; readonly routes: readonly RegisteredModuleHttpRoute[];
readonly runtime?: EkklesiaIdentityRuntime; readonly runtime?: EkklesiaIdentityRuntime;
readonly services?: ModuleRuntimeServices | ModuleRuntimeServicesLookup; readonly services?: LegacyModuleRuntimeServices | ModuleRuntimeServicesLookup;
readonly trustedOrigins?: readonly string[]; readonly trustedOrigins?: readonly string[];
}) { }) {
const evaluator = options.evaluator ?? { const evaluator = options.evaluator ?? {
@@ -539,7 +539,7 @@ describe("module route authorization", () => {
expect(response.status).toBe(403); expect(response.status).toBe(403);
expect(await response.json()).toEqual({ code: "AUTHORIZATION_DENIED" }); expect(await response.json()).toEqual({ code: "AUTHORIZATION_DENIED" });
expect(handler).not.toHaveBeenCalled(); expect(handler).not.toHaveBeenCalled();
expectDatabaseFakeUntouched(services as ModuleRuntimeServices); expectDatabaseFakeUntouched(services as LegacyModuleRuntimeServices);
}); });
it("does not invoke the handler when principal resolution fails", async () => { it("does not invoke the handler when principal resolution fails", async () => {
@@ -668,7 +668,7 @@ describe("module route trusted-origin enforcement", () => {
} }
expect(handler).not.toHaveBeenCalled(); expect(handler).not.toHaveBeenCalled();
expect(evaluator.authorize).not.toHaveBeenCalled(); expect(evaluator.authorize).not.toHaveBeenCalled();
expectDatabaseFakeUntouched(services as ModuleRuntimeServices); expectDatabaseFakeUntouched(services as LegacyModuleRuntimeServices);
}); });
it("allows a trusted-origin state-changing request through to the handler", async () => { it("allows a trusted-origin state-changing request through to the handler", async () => {
@@ -797,7 +797,7 @@ describe("module route CORS", () => {
expect(handler).not.toHaveBeenCalled(); expect(handler).not.toHaveBeenCalled();
expect(evaluator.authorize).not.toHaveBeenCalled(); expect(evaluator.authorize).not.toHaveBeenCalled();
expectDatabaseFakeUntouched(services as ModuleRuntimeServices); expectDatabaseFakeUntouched(services as LegacyModuleRuntimeServices);
}); });
it("never reflects an untrusted origin for a module route", async () => { it("never reflects an untrusted origin for a module route", async () => {
@@ -5,8 +5,6 @@ import {
ANONYMOUS_PRINCIPAL, ANONYMOUS_PRINCIPAL,
createAuthenticatedPrincipal, createAuthenticatedPrincipal,
type EkklesiaPrincipal, type EkklesiaPrincipal,
type ModuleDatabase,
type ModuleRuntimeServices,
parseEkklesiaUserId, parseEkklesiaUserId,
} from "@ekklesia/contracts"; } from "@ekklesia/contracts";
import { import {
@@ -20,6 +18,8 @@ import {
createModuleUiPublicationRegistry, createModuleUiPublicationRegistry,
type DiscoveredModule, type DiscoveredModule,
discoverModules, discoverModules,
type LegacyModuleRuntimeServices,
type ModuleDatabase,
type ModuleLifecycleStore, type ModuleLifecycleStore,
ModuleLifecycleStoreError, ModuleLifecycleStoreError,
EMPTY_MODULE_REALTIME_REGISTRY, EMPTY_MODULE_REALTIME_REGISTRY,
@@ -189,7 +189,7 @@ async function install(options: InstallOptions = {}): Promise<Installation> {
moduleRealtime: EMPTY_MODULE_REALTIME_REGISTRY, moduleRealtime: EMPTY_MODULE_REALTIME_REGISTRY,
moduleServices: Object.freeze({ moduleServices: Object.freeze({
database: Object.freeze({}) as unknown as ModuleDatabase, database: Object.freeze({}) as unknown as ModuleDatabase,
}) as ModuleRuntimeServices, }) as LegacyModuleRuntimeServices,
moduleUi: createModuleUiPublicationRegistry(eligibility.eligibleModules), moduleUi: createModuleUiPublicationRegistry(eligibility.eligibleModules),
runtime, runtime,
trustedOrigins: [trustedOrigin], trustedOrigins: [trustedOrigin],
+3 -3
View File
@@ -4,9 +4,7 @@ import path from "node:path";
import { import {
ANONYMOUS_PRINCIPAL, ANONYMOUS_PRINCIPAL,
createAuthenticatedPrincipal, createAuthenticatedPrincipal,
type ModuleDatabase,
type ModuleRealtimePublisher, type ModuleRealtimePublisher,
type ModuleRuntimeServices,
parseEkklesiaUserId, parseEkklesiaUserId,
} from "@ekklesia/contracts"; } from "@ekklesia/contracts";
import { import {
@@ -18,6 +16,8 @@ import type { EkklesiaIdentityRuntime } from "@ekklesia/core/identity";
import { import {
composePlatformPermissionRegistry, composePlatformPermissionRegistry,
discoverModules, discoverModules,
type LegacyModuleRuntimeServices,
type ModuleDatabase,
type ModuleRealtimeRegistry, type ModuleRealtimeRegistry,
type ModuleRealtimeSubscription, type ModuleRealtimeSubscription,
startDiscoveredModuleRuntime, startDiscoveredModuleRuntime,
@@ -226,7 +226,7 @@ async function createFixtureModule(control: FixtureControl): Promise<{
return { directory, symbol }; return { directory, symbol };
} }
function services(): ModuleRuntimeServices { function services(): LegacyModuleRuntimeServices {
return Object.freeze({ database: Object.freeze({}) as ModuleDatabase }); return Object.freeze({ database: Object.freeze({}) as ModuleDatabase });
} }
+3 -3
View File
@@ -5,8 +5,6 @@ import {
ANONYMOUS_PRINCIPAL, ANONYMOUS_PRINCIPAL,
createAuthenticatedPrincipal, createAuthenticatedPrincipal,
type EkklesiaPrincipal, type EkklesiaPrincipal,
type ModuleDatabase,
type ModuleRuntimeServices,
parseEkklesiaUserId, parseEkklesiaUserId,
} from "@ekklesia/contracts"; } from "@ekklesia/contracts";
import { import {
@@ -18,6 +16,8 @@ import {
composePlatformPermissionRegistry, composePlatformPermissionRegistry,
createModuleUiPublicationRegistry, createModuleUiPublicationRegistry,
discoverModules, discoverModules,
type LegacyModuleRuntimeServices,
type ModuleDatabase,
startDiscoveredModuleRuntime, startDiscoveredModuleRuntime,
} from "@ekklesia/core/modules"; } from "@ekklesia/core/modules";
import { import {
@@ -241,7 +241,7 @@ async function startHarness(options: HarnessOptions = {}): Promise<Harness> {
modulesDirectory, modulesDirectory,
platformVersion: "0.1.0", platformVersion: "0.1.0",
}); });
const services: ModuleRuntimeServices = Object.freeze({ const services: LegacyModuleRuntimeServices = Object.freeze({
database: Object.freeze({}) as unknown as ModuleDatabase, database: Object.freeze({}) as unknown as ModuleDatabase,
}); });
// The module's real runtime: its server entrypoint is imported, registered, and started, and the // The module's real runtime: its server entrypoint is imported, registered, and started, and the
+3 -3
View File
@@ -5,8 +5,6 @@ import {
ANONYMOUS_PRINCIPAL, ANONYMOUS_PRINCIPAL,
createAuthenticatedPrincipal, createAuthenticatedPrincipal,
type EkklesiaPrincipal, type EkklesiaPrincipal,
type ModuleDatabase,
type ModuleRuntimeServices,
parseEkklesiaUserId, parseEkklesiaUserId,
} from "@ekklesia/contracts"; } from "@ekklesia/contracts";
import { import {
@@ -21,6 +19,8 @@ import {
type DiscoveredModule, type DiscoveredModule,
discoverModules, discoverModules,
EMPTY_MODULE_REALTIME_REGISTRY, EMPTY_MODULE_REALTIME_REGISTRY,
type LegacyModuleRuntimeServices,
type ModuleDatabase,
} from "@ekklesia/core/modules"; } from "@ekklesia/core/modules";
import type { Hono } from "hono"; import type { Hono } from "hono";
import { afterEach, describe, expect, it, vi } from "vitest"; import { afterEach, describe, expect, it, vi } from "vitest";
@@ -192,7 +192,7 @@ async function install(options: InstallOptions): Promise<Installation> {
revokeGrant: vi.fn(), revokeGrant: vi.fn(),
revokePlatformOwner: vi.fn(), revokePlatformOwner: vi.fn(),
} as unknown as AuthorizationStore; } as unknown as AuthorizationStore;
const services: ModuleRuntimeServices = Object.freeze({ const services: LegacyModuleRuntimeServices = Object.freeze({
database: Object.freeze({}) as unknown as ModuleDatabase, database: Object.freeze({}) as unknown as ModuleDatabase,
}); });
const permissionRegistry = composePlatformPermissionRegistry(modules); const permissionRegistry = composePlatformPermissionRegistry(modules);
+4 -6
View File
@@ -1,11 +1,7 @@
import { mkdir, mkdtemp, rm, writeFile } from "node:fs/promises"; import { mkdir, mkdtemp, rm, writeFile } from "node:fs/promises";
import { tmpdir } from "node:os"; import { tmpdir } from "node:os";
import path from "node:path"; import path from "node:path";
import { import { ANONYMOUS_PRINCIPAL } from "@ekklesia/contracts";
ANONYMOUS_PRINCIPAL,
type ModuleDatabase,
type ModuleRuntimeServices,
} from "@ekklesia/contracts";
import type { AuthorizationEvaluator, AuthorizationStore } from "@ekklesia/core/authorization"; import type { AuthorizationEvaluator, AuthorizationStore } from "@ekklesia/core/authorization";
import type { EkklesiaIdentityRuntime } from "@ekklesia/core/identity"; import type { EkklesiaIdentityRuntime } from "@ekklesia/core/identity";
import { import {
@@ -14,6 +10,8 @@ import {
type DiscoveredModule, type DiscoveredModule,
discoverModules, discoverModules,
EMPTY_MODULE_REALTIME_REGISTRY, EMPTY_MODULE_REALTIME_REGISTRY,
type LegacyModuleRuntimeServices,
type ModuleDatabase,
} from "@ekklesia/core/modules"; } from "@ekklesia/core/modules";
import { loadModuleUi } from "@ekklesia/module-ui-host"; import { loadModuleUi } from "@ekklesia/module-ui-host";
import { MODULE_UI_ABI_VERSION, NO_MODULE_UI_CONTRIBUTIONS } from "@ekklesia/module-ui-sdk"; import { MODULE_UI_ABI_VERSION, NO_MODULE_UI_CONTRIBUTIONS } from "@ekklesia/module-ui-sdk";
@@ -215,7 +213,7 @@ async function install(
: modules.filter((module) => publicationModuleIds.includes(module.manifest.id)); : modules.filter((module) => publicationModuleIds.includes(module.manifest.id));
const database = Object.freeze({}) as unknown as ModuleDatabase; const database = Object.freeze({}) as unknown as ModuleDatabase;
const services: ModuleRuntimeServices = Object.freeze({ database }); const services: LegacyModuleRuntimeServices = Object.freeze({ database });
const runtime: EkklesiaIdentityRuntime = { const runtime: EkklesiaIdentityRuntime = {
handleAuthRequest: vi.fn().mockResolvedValue(new Response(null, { status: 200 })), handleAuthRequest: vi.fn().mockResolvedValue(new Response(null, { status: 200 })),
// Anonymous, and every authorization decision denied: whatever this route does, it does it // Anonymous, and every authorization decision denied: whatever this route does, it does it
+49 -2
View File
@@ -1,7 +1,54 @@
import type { ModuleDatabase } from "@ekklesia/contracts"; import type { ModuleDatabaseAbiRuntimeServices, ModuleRuntimeServices } from "@ekklesia/contracts";
import { drizzle } from "drizzle-orm/node-postgres"; import { drizzle, type NodePgDatabase } from "drizzle-orm/node-postgres";
import type { Pool } from "pg"; import type { Pool } from "pg";
/**
* A trusted backend module's typed Drizzle query surface — the same query-building methods a
* platform-owned Drizzle instance exposes, restricted to exactly the operations a module needs to
* read and write its own tables. Derived with `Pick` from the real `drizzle-orm/node-postgres`
* database type rather than hand-declared, so every method keeps Drizzle's own table-aware
* argument and result inference exactly as-is — a module calling `database.select().from(table)`
* or `database.insert(table).values(...)` gets the identical typed builder a direct Drizzle caller
* would, with no `any`/`unknown` erasure anywhere in the chain.
*
* Deliberately excludes everything `NodePgDatabase` or the `drizzle(...)` factory otherwise
* exposes: `$client` (the raw `pg` client/pool), `_` (internal session/dialect/schema state),
* `query` (a relational-query builder tied to one schema, which would have to span every
* installed module's tables to exist here at all), `$cache`, `$count`, `$with`, `with`, and
* `refreshMaterializedView`. There is no connection string, pool, session, or dialect object
* reachable through this type. Carries no schema generic — a module brings its own Drizzle table
* objects to each call, so there is no global relational schema spanning every installed module for
* this type to leak.
*
* Core's own, private type (ADR 0053): it moved here from `@ekklesia/contracts` so no published
* package references Drizzle. New modules use the Module Database ABI v1 instead (ADR 0050), and
* the Module SDK never exposes this facade's type.
*
* This is an integration boundary, not a security sandbox: modules are trusted, compiled backend
* plugins that already run arbitrary code in this process, exactly like every other lifecycle hook
* and HTTP handler they define. `ModuleDatabase` exists to keep a module's code Drizzle-typed and
* decoupled from how the platform physically connects to PostgreSQL — not to defend against a
* malicious module, which this facade cannot do and does not attempt to do.
*/
export type ModuleDatabase = Pick<
NodePgDatabase,
| "select"
| "selectDistinct"
| "selectDistinctOn"
| "insert"
| "update"
| "delete"
| "execute"
| "transaction"
>;
/** The services a legacy module's hooks and handlers receive: the legacy facade. */
export type LegacyModuleRuntimeServices = ModuleRuntimeServices<ModuleDatabase>;
/** The services Core hands any started module: the legacy facade or the ABI v1 executor. */
export type AnyModuleRuntimeServices =
| LegacyModuleRuntimeServices
| ModuleDatabaseAbiRuntimeServices;
/** /**
* A typed `ModuleDatabase` view over an externally owned pool — the module-facing counterpart to * A typed `ModuleDatabase` view over an externally owned pool — the module-facing counterpart to
* `createIdentityDrizzleView` (`core/src/identity/database.ts`) and * `createIdentityDrizzleView` (`core/src/identity/database.ts`) and
+6 -8
View File
@@ -1,6 +1,5 @@
import { pathToFileURL } from "node:url"; import { pathToFileURL } from "node:url";
import { import {
type AnyModuleRuntimeServices,
type CapabilityId, type CapabilityId,
type CapabilityRegistrar, type CapabilityRegistrar,
type CapabilityResolver, type CapabilityResolver,
@@ -8,7 +7,6 @@ import {
EMPTY_MODULE_CONFIGURATION, EMPTY_MODULE_CONFIGURATION,
EMPTY_MODULE_STORAGE, EMPTY_MODULE_STORAGE,
type ModuleConfiguration, type ModuleConfiguration,
type ModuleDatabase,
type ModuleDatabaseExecutor, type ModuleDatabaseExecutor,
type ModuleHttpRouteRegistrar, type ModuleHttpRouteRegistrar,
type ModuleId, type ModuleId,
@@ -19,7 +17,6 @@ import {
type ModuleRouteHandler, type ModuleRouteHandler,
type ModuleRuntimeContext, type ModuleRuntimeContext,
type ModuleRuntimeDefinition, type ModuleRuntimeDefinition,
type ModuleRuntimeServices,
type ModuleStorage, type ModuleStorage,
moduleRouteShapeKey, moduleRouteShapeKey,
moduleRoutesOverlap, moduleRoutesOverlap,
@@ -28,6 +25,7 @@ import {
type RegisteredModuleHttpRoute, type RegisteredModuleHttpRoute,
safeParseModuleRouteDefinition, safeParseModuleRouteDefinition,
} from "@ekklesia/contracts"; } from "@ekklesia/contracts";
import type { AnyModuleRuntimeServices, ModuleDatabase } from "./database.js";
import { import {
type DiscoveredModule, type DiscoveredModule,
discoverModules, discoverModules,
@@ -137,7 +135,7 @@ export type ModuleStorageLookup = ReadonlyMap<string, ModuleStorage>;
/** One frozen service object per module id. Legacy modules may point at objects wrapping the same /** One frozen service object per module id. Legacy modules may point at objects wrapping the same
* facade; ABI-v1 modules each point at their own attributed executor. */ * facade; ABI-v1 modules each point at their own attributed executor. */
export type ModuleRuntimeServicesLookup = ReadonlyMap<string, AnyModuleRuntimeServices>; export type ModuleRuntimeServicesLookup = ReadonlyMap<string, AnyModuleRuntimeServices>;
export type ModuleRuntimeServicesSource = ModuleRuntimeServicesLookup | ModuleRuntimeServices; export type ModuleRuntimeServicesSource = ModuleRuntimeServicesLookup | AnyModuleRuntimeServices;
function servicesFor( function servicesFor(
services: ModuleRuntimeServicesSource, services: ModuleRuntimeServicesSource,
@@ -347,11 +345,11 @@ class StagedCapabilityRegistry {
createRuntimeContext( createRuntimeContext(
module: DiscoveredModule, module: DiscoveredModule,
phase: "rollback" | "start" | "stop", phase: "rollback" | "start" | "stop",
services: ModuleRuntimeServices, services: AnyModuleRuntimeServices,
config: ModuleConfiguration, config: ModuleConfiguration,
storage: ModuleStorage, storage: ModuleStorage,
realtime: ModuleRealtimePublisher, realtime: ModuleRealtimePublisher,
): ModuleRuntimeContext { ): ModuleRuntimeContext<ModuleDatabase | ModuleDatabaseExecutor> {
const capabilities: CapabilityResolver = Object.freeze({ const capabilities: CapabilityResolver = Object.freeze({
resolve: (capabilityId: CapabilityId): RegisteredCapability | undefined => { resolve: (capabilityId: CapabilityId): RegisteredCapability | undefined => {
this.#assertAccess(module, capabilityId, phase); this.#assertAccess(module, capabilityId, phase);
@@ -754,7 +752,7 @@ async function stopModules(
registry.createRuntimeContext( registry.createRuntimeContext(
module.discovered, module.discovered,
phase, phase,
servicesFor(services, module.discovered) as ModuleRuntimeServices, servicesFor(services, module.discovered),
configurationFor(configurations, moduleId), configurationFor(configurations, moduleId),
storageFor(storages, moduleId), storageFor(storages, moduleId),
realtimeRegistry.publisherFor(moduleId), realtimeRegistry.publisherFor(moduleId),
@@ -814,7 +812,7 @@ async function startModules(
registry.createRuntimeContext( registry.createRuntimeContext(
module.discovered, module.discovered,
"start", "start",
servicesFor(services, module.discovered) as ModuleRuntimeServices, servicesFor(services, module.discovered),
configurationFor(configurations, module.discovered.manifest.id), configurationFor(configurations, module.discovered.manifest.id),
storageFor(storages, module.discovered.manifest.id), storageFor(storages, module.discovered.manifest.id),
realtimeRegistry.publisherFor(module.discovered.manifest.id), realtimeRegistry.publisherFor(module.discovered.manifest.id),
@@ -1,8 +1,8 @@
import { integer, pgTable, text } from "drizzle-orm/pg-core"; import { integer, pgTable, text } from "drizzle-orm/pg-core";
import { describe, expect, it } from "vitest"; import { describe, expect, it } from "vitest";
import type { ModuleDatabase, ModuleRuntimeServices } from "../src/index.js"; import type { LegacyModuleRuntimeServices, ModuleDatabase } from "../src/modules/database.js";
const testTable = pgTable("contracts_module_database_test", { const testTable = pgTable("core_module_database_type_test", {
id: integer("id").primaryKey(), id: integer("id").primaryKey(),
name: text("name").notNull(), name: text("name").notNull(),
}); });
@@ -68,16 +68,17 @@ function typeOnlyExclusions(database: ModuleDatabase): void {
} }
void typeOnlyExclusions; void typeOnlyExclusions;
/** Never invoked — proves `ModuleRuntimeServices` has exactly one field, `database`, typed as /** Never invoked — proves a legacy module's `ModuleRuntimeServices` has exactly one field,
* `ModuleDatabase`, with no storage/jobs/configuration/secrets/authorization field this phase. */ * `database`, typed as `ModuleDatabase`, with no storage/jobs/configuration/secrets/authorization
function typeOnlyServicesShape(services: ModuleRuntimeServices): void { * field this phase. */
function typeOnlyServicesShape(services: LegacyModuleRuntimeServices): void {
const database: ModuleDatabase = services.database; const database: ModuleDatabase = services.database;
void database; void database;
// @ts-expect-error `storage` does not exist on `ModuleRuntimeServices` yet. // @ts-expect-error `storage` does not exist on the services yet.
void services.storage; void services.storage;
// @ts-expect-error `jobs` does not exist on `ModuleRuntimeServices` yet. // @ts-expect-error `jobs` does not exist on the services yet.
void services.jobs; void services.jobs;
// @ts-expect-error `authorization` does not exist on `ModuleRuntimeServices` yet. // @ts-expect-error `authorization` does not exist on the services yet.
void services.authorization; void services.authorization;
} }
void typeOnlyServicesShape; void typeOnlyServicesShape;
+3 -6
View File
@@ -1,11 +1,8 @@
import { mkdir, mkdtemp, rm, writeFile } from "node:fs/promises"; import { mkdir, mkdtemp, rm, writeFile } from "node:fs/promises";
import { tmpdir } from "node:os"; import { tmpdir } from "node:os";
import path from "node:path"; import path from "node:path";
import type { import type { ModuleRealtimePublisher } from "@ekklesia/contracts";
ModuleDatabase, import type { LegacyModuleRuntimeServices, ModuleDatabase } from "../src/modules/database.js";
ModuleRealtimePublisher,
ModuleRuntimeServices,
} from "@ekklesia/contracts";
import { afterEach, describe, expect, it } from "vitest"; import { afterEach, describe, expect, it } from "vitest";
import { ModuleRuntimeError, startModuleRuntime } from "../src/modules/runtime.js"; import { ModuleRuntimeError, startModuleRuntime } from "../src/modules/runtime.js";
@@ -22,7 +19,7 @@ afterEach(async () => {
); );
}); });
function fakeServices(): ModuleRuntimeServices { function fakeServices(): LegacyModuleRuntimeServices {
return Object.freeze({ database: Object.freeze({}) as ModuleDatabase }); return Object.freeze({ database: Object.freeze({}) as ModuleDatabase });
} }
+4 -5
View File
@@ -1,13 +1,12 @@
import { mkdir, mkdtemp, rm, writeFile } from "node:fs/promises"; import { mkdir, mkdtemp, rm, writeFile } from "node:fs/promises";
import { tmpdir } from "node:os"; import { tmpdir } from "node:os";
import path from "node:path"; import path from "node:path";
import type { ModuleConfiguration, ModuleDatabaseExecutor } from "@ekklesia/contracts";
import type { import type {
AnyModuleRuntimeServices, AnyModuleRuntimeServices,
ModuleConfiguration, LegacyModuleRuntimeServices,
ModuleDatabase, ModuleDatabase,
ModuleDatabaseExecutor, } from "../src/modules/database.js";
ModuleRuntimeServices,
} from "@ekklesia/contracts";
import { afterEach, describe, expect, it, vi } from "vitest"; import { afterEach, describe, expect, it, vi } from "vitest";
import { discoverModules } from "../src/modules/discovery.js"; import { discoverModules } from "../src/modules/discovery.js";
import { import {
@@ -151,7 +150,7 @@ function fakeModuleDatabase(): ModuleDatabase {
} }
function fakeModuleRuntimeServices(): ModuleRuntimeServicesLookup { function fakeModuleRuntimeServices(): ModuleRuntimeServicesLookup {
const services = new Map<string, ModuleRuntimeServices>(); const services = new Map<string, LegacyModuleRuntimeServices>();
const database = fakeModuleDatabase(); const database = fakeModuleDatabase();
return new Proxy(services, { return new Proxy(services, {
get(target, property, receiver) { get(target, property, receiver) {
+2 -1
View File
@@ -1403,7 +1403,8 @@ stays declarative and database-free. See
contract; this section covers only how `apps/api` composes and wires it. contract; this section covers only how `apps/api` composes and wires it.
- **`ModuleDatabase`.** A restricted, typed view over `NodePgDatabase` - **`ModuleDatabase`.** A restricted, typed view over `NodePgDatabase`
(`packages/contracts/src/module-database.ts`), exposing exactly `select`, `selectDistinct`, (`core/src/modules/database.ts`, Core's own type: no published package references Drizzle, per
ADR 0053), exposing exactly `select`, `selectDistinct`,
`selectDistinctOn`, `insert`, `update`, `delete`, `execute`, and `transaction`, each preserving `selectDistinctOn`, `insert`, `update`, `delete`, `execute`, and `transaction`, each preserving
Drizzle's own table-aware argument and result inference. It exposes no `$client`, no internal Drizzle's own table-aware argument and result inference. It exposes no `$client`, no internal
session/dialect state, no schema-bound relational `query` builder, and no connection string, session/dialect state, no schema-bound relational `query` builder, and no connection string,
-9
View File
@@ -27,20 +27,11 @@
"spdx-expression-parse": "5.0.0", "spdx-expression-parse": "5.0.0",
"zod": "4.4.3" "zod": "4.4.3"
}, },
"peerDependencies": {
"drizzle-orm": ">=0.45.2 <0.46.0"
},
"peerDependenciesMeta": {
"drizzle-orm": {
"optional": true
}
},
"devDependencies": { "devDependencies": {
"@biomejs/biome": "2.5.3", "@biomejs/biome": "2.5.3",
"@types/node": "24.13.3", "@types/node": "24.13.3",
"@types/semver": "7.7.1", "@types/semver": "7.7.1",
"@types/spdx-expression-parse": "4.0.0", "@types/spdx-expression-parse": "4.0.0",
"drizzle-orm": "0.45.2",
"typescript": "7.0.2", "typescript": "7.0.2",
"vitest": "4.1.10" "vitest": "4.1.10"
}, },
+5 -45
View File
@@ -1,59 +1,19 @@
import type { NodePgDatabase } from "drizzle-orm/node-postgres";
import type { ModuleDatabaseExecutor } from "./module-database-abi.js"; import type { ModuleDatabaseExecutor } from "./module-database-abi.js";
/**
* A trusted backend module's typed Drizzle query surface — the same query-building methods a
* platform-owned Drizzle instance exposes, restricted to exactly the operations a module needs to
* read and write its own tables. Derived with `Pick` from the real `drizzle-orm/node-postgres`
* database type rather than hand-declared, so every method keeps Drizzle's own table-aware
* argument and result inference exactly as-is — a module calling `database.select().from(table)`
* or `database.insert(table).values(...)` gets the identical typed builder a direct Drizzle caller
* would, with no `any`/`unknown` erasure anywhere in the chain.
*
* Deliberately excludes everything `NodePgDatabase` or the `drizzle(...)` factory otherwise
* exposes: `$client` (the raw `pg` client/pool), `_` (internal session/dialect/schema state),
* `query` (a relational-query builder tied to one schema, which would have to span every
* installed module's tables to exist here at all), `$cache`, `$count`, `$with`, `with`, and
* `refreshMaterializedView`. There is no connection string, pool, session, or dialect object
* reachable through this type. Carries no schema generic — a module brings its own Drizzle table
* objects (`@ekklesia/module-sdk`'s `defineModuleSchema`) to each call, so there is no global
* relational schema spanning every installed module for this type to leak.
*
* This is an integration boundary, not a security sandbox: modules are trusted, compiled backend
* plugins that already run arbitrary code in this process, exactly like every other lifecycle hook
* and HTTP handler they define. `ModuleDatabase` exists to keep a module's code Drizzle-typed and
* decoupled from how the platform physically connects to PostgreSQL — not to defend against a
* malicious module, which this facade cannot do and does not attempt to do.
*/
export type ModuleDatabase = Pick<
NodePgDatabase,
| "select"
| "selectDistinct"
| "selectDistinctOn"
| "insert"
| "update"
| "delete"
| "execute"
| "transaction"
>;
/** /**
* The complete set of platform-provided services a trusted module's `start`/`stop` lifecycle hooks * The complete set of platform-provided services a trusted module's `start`/`stop` lifecycle hooks
* and authorized HTTP route handlers receive — for this phase, exactly one: `database`. Frozen, and * and authorized HTTP route handlers receive — for this phase, exactly one: `database`. For a
* module that declares `database: { abi: 1 }` it is the Module Database ABI v1 executor; for a
* legacy module it is Core's legacy facade, whose type Core alone owns, so this package never
* references an ORM (ADR 0053). Frozen, and
* never handed to a module's `register` hook (`ModuleRegistrationContext` has no `services` field): * never handed to a module's `register` hook (`ModuleRegistrationContext` has no `services` field):
* registration stays declarative and database-free, exactly as before this contract existed. * registration stays declarative and database-free, exactly as before this contract existed.
* Deliberately has no storage, jobs, configuration, secrets, or authorization field yet — those * Deliberately has no storage, jobs, configuration, secrets, or authorization field yet — those
* remain out of scope until a later phase explicitly adds them here, one at a time, the same way * remain out of scope until a later phase explicitly adds them here, one at a time, the same way
* `database` was added. * `database` was added.
*/ */
export interface ModuleRuntimeServices< export interface ModuleRuntimeServices<Database = ModuleDatabaseExecutor> {
Database extends ModuleDatabase | ModuleDatabaseExecutor = ModuleDatabase,
> {
readonly database: Database; readonly database: Database;
} }
export type LegacyModuleRuntimeServices = ModuleRuntimeServices<ModuleDatabase>;
export type ModuleDatabaseAbiRuntimeServices = ModuleRuntimeServices<ModuleDatabaseExecutor>; export type ModuleDatabaseAbiRuntimeServices = ModuleRuntimeServices<ModuleDatabaseExecutor>;
export type AnyModuleRuntimeServices =
| LegacyModuleRuntimeServices
| ModuleDatabaseAbiRuntimeServices;
+9 -16
View File
@@ -2,7 +2,7 @@ import { z } from "zod";
import { type ModuleId, type PermissionId, permissionIdSchema } from "./identifiers.js"; import { type ModuleId, type PermissionId, permissionIdSchema } from "./identifiers.js";
import type { EkklesiaPrincipal } from "./identity.js"; import type { EkklesiaPrincipal } from "./identity.js";
import type { ModuleConfiguration } from "./module-configuration.js"; import type { ModuleConfiguration } from "./module-configuration.js";
import type { ModuleDatabase, ModuleRuntimeServices } from "./module-database.js"; import type { ModuleRuntimeServices } from "./module-database.js";
import type { ModuleDatabaseExecutor } from "./module-database-abi.js"; import type { ModuleDatabaseExecutor } from "./module-database-abi.js";
import type { ModuleRealtimePublisher } from "./module-realtime.js"; import type { ModuleRealtimePublisher } from "./module-realtime.js";
import type { ModuleStorage } from "./module-storage.js"; import type { ModuleStorage } from "./module-storage.js";
@@ -272,9 +272,7 @@ export function moduleRoutesOverlap(
* behavior, and uncaught-handler sanitization; permission enforcement always completes before a * behavior, and uncaught-handler sanitization; permission enforcement always completes before a
* handler — and therefore any parameter validation it performs — can run. * handler — and therefore any parameter validation it performs — can run.
*/ */
export interface ModuleRouteHandlerContext< export interface ModuleRouteHandlerContext<Database = ModuleDatabaseExecutor> {
Database extends ModuleDatabase | ModuleDatabaseExecutor = ModuleDatabase,
> {
readonly moduleId: ModuleId; readonly moduleId: ModuleId;
readonly principal: EkklesiaPrincipal; readonly principal: EkklesiaPrincipal;
readonly params: Readonly<Record<string, string>>; readonly params: Readonly<Record<string, string>>;
@@ -296,9 +294,10 @@ export interface ModuleRouteHandlerContext<
/** A framework-neutral Fetch handler: standard `Request` in, standard `Response` out. The full /** A framework-neutral Fetch handler: standard `Request` in, standard `Response` out. The full
* query string remains available through `Request.url`; there is no competing query or body * query string remains available through `Request.url`; there is no competing query or body
* abstraction. */ * abstraction. */
export type ModuleRouteHandler< export type ModuleRouteHandler<Database = ModuleDatabaseExecutor> = (
Database extends ModuleDatabase | ModuleDatabaseExecutor = ModuleDatabase, request: Request,
> = (request: Request, context: ModuleRouteHandlerContext<Database>) => Awaitable<Response>; context: ModuleRouteHandlerContext<Database>,
) => Awaitable<Response>;
/** /**
* What a module passes to `http.route(...)` during `register`. `permission` is a plain string here * What a module passes to `http.route(...)` during `register`. `permission` is a plain string here
@@ -313,9 +312,7 @@ export type ModuleRouteHandler<
* path, CORS/origin policy, authentication behavior, grant/platform-owner state, middleware, audit * path, CORS/origin policy, authentication behavior, grant/platform-owner state, middleware, audit
* metadata, another module's namespace, or an unprotected/no-permission route. * metadata, another module's namespace, or an unprotected/no-permission route.
*/ */
export interface ModuleRouteDefinitionInput< export interface ModuleRouteDefinitionInput<Database = ModuleDatabaseExecutor> {
Database extends ModuleDatabase | ModuleDatabaseExecutor = ModuleDatabase,
> {
readonly method: ModuleHttpMethod; readonly method: ModuleHttpMethod;
readonly path: string; readonly path: string;
readonly permission: string; readonly permission: string;
@@ -331,9 +328,7 @@ export interface ModuleRouteDefinitionInput<
/** The validated, canonical form of a `ModuleRouteDefinitionInput` — what `http.route` produces /** The validated, canonical form of a `ModuleRouteDefinitionInput` — what `http.route` produces
* only after every field passes its own grammar. */ * only after every field passes its own grammar. */
export interface ModuleRouteDefinition< export interface ModuleRouteDefinition<Database = ModuleDatabaseExecutor> {
Database extends ModuleDatabase | ModuleDatabaseExecutor = ModuleDatabase,
> {
readonly method: ModuleHttpMethod; readonly method: ModuleHttpMethod;
readonly path: ModuleRoutePath; readonly path: ModuleRoutePath;
readonly permission: PermissionId; readonly permission: PermissionId;
@@ -346,9 +341,7 @@ export interface ModuleRouteDefinition<
/** The Fetch-based registrar exposed as `context.http` during `register` only — never on /** The Fetch-based registrar exposed as `context.http` during `register` only — never on
* `ModuleRuntimeContext`, so `start`/`stop` cannot register a route after the fact. */ * `ModuleRuntimeContext`, so `start`/`stop` cannot register a route after the fact. */
export interface ModuleHttpRouteRegistrar< export interface ModuleHttpRouteRegistrar<Database = ModuleDatabaseExecutor> {
Database extends ModuleDatabase | ModuleDatabaseExecutor = ModuleDatabase,
> {
route(definition: ModuleRouteDefinitionInput<Database>): void; route(definition: ModuleRouteDefinitionInput<Database>): void;
} }
+8 -9
View File
@@ -1,7 +1,7 @@
import type { CapabilityId, ModuleId } from "./identifiers.js"; import type { CapabilityId, ModuleId } from "./identifiers.js";
import { moduleIdSchema } from "./identifiers.js"; import { moduleIdSchema } from "./identifiers.js";
import type { ModuleConfiguration } from "./module-configuration.js"; import type { ModuleConfiguration } from "./module-configuration.js";
import type { ModuleDatabase, ModuleRuntimeServices } from "./module-database.js"; import type { ModuleRuntimeServices } from "./module-database.js";
import type { ModuleDatabaseExecutor } from "./module-database-abi.js"; import type { ModuleDatabaseExecutor } from "./module-database-abi.js";
import type { ModuleHttpRouteRegistrar } from "./module-http.js"; import type { ModuleHttpRouteRegistrar } from "./module-http.js";
import type { ModuleRealtimeChannelRegistrar, ModuleRealtimePublisher } from "./module-realtime.js"; import type { ModuleRealtimeChannelRegistrar, ModuleRealtimePublisher } from "./module-realtime.js";
@@ -25,9 +25,7 @@ export interface CapabilityRegistrar extends CapabilityResolver {
provide(capabilityId: CapabilityId, implementation: unknown): void; provide(capabilityId: CapabilityId, implementation: unknown): void;
} }
export interface ModuleRegistrationContext< export interface ModuleRegistrationContext<Database = ModuleDatabaseExecutor> {
Database extends ModuleDatabase | ModuleDatabaseExecutor = ModuleDatabase,
> {
readonly capabilities: CapabilityRegistrar; readonly capabilities: CapabilityRegistrar;
/** Available only during `register` — never on `ModuleRuntimeContext` — so a route can only ever /** Available only during `register` — never on `ModuleRuntimeContext` — so a route can only ever
* be declared while Core is still building the immutable startup snapshot, never added or removed * be declared while Core is still building the immutable startup snapshot, never added or removed
@@ -52,9 +50,7 @@ export interface ModuleRegistrationContext<
* same frozen `services` object identity as the other, for a given API runtime — never a fresh * same frozen `services` object identity as the other, for a given API runtime — never a fresh
* `ModuleRuntimeServices` built per hook invocation. Unlike `ModuleRegistrationContext`, this never * `ModuleRuntimeServices` built per hook invocation. Unlike `ModuleRegistrationContext`, this never
* carries `http`: a route can only ever be declared during `register`. */ * carries `http`: a route can only ever be declared during `register`. */
export interface ModuleRuntimeContext< export interface ModuleRuntimeContext<Database = ModuleDatabaseExecutor> {
Database extends ModuleDatabase | ModuleDatabaseExecutor = ModuleDatabase,
> {
readonly capabilities: CapabilityResolver; readonly capabilities: CapabilityResolver;
readonly moduleId: ModuleId; readonly moduleId: ModuleId;
readonly services: ModuleRuntimeServices<Database>; readonly services: ModuleRuntimeServices<Database>;
@@ -87,7 +83,7 @@ export interface ModuleRuntimeContext<
readonly config: ModuleConfiguration; readonly config: ModuleConfiguration;
} }
interface ModuleRuntimeDefinitionBase<Database extends ModuleDatabase | ModuleDatabaseExecutor> { interface ModuleRuntimeDefinitionBase<Database> {
readonly id: ModuleId; readonly id: ModuleId;
readonly register?: (context: ModuleRegistrationContext<Database>) => Awaitable<void>; readonly register?: (context: ModuleRegistrationContext<Database>) => Awaitable<void>;
readonly start?: (context: ModuleRuntimeContext<Database>) => Awaitable<void>; readonly start?: (context: ModuleRuntimeContext<Database>) => Awaitable<void>;
@@ -95,7 +91,10 @@ interface ModuleRuntimeDefinitionBase<Database extends ModuleDatabase | ModuleDa
readonly version: string; readonly version: string;
} }
export interface LegacyModuleRuntimeDefinition extends ModuleRuntimeDefinitionBase<ModuleDatabase> { /** A module on the legacy database facade (ADR 0016), until its deprecation window ends (ADR 0050).
* The facade's type is Core's own, so here its database is opaque: Core specializes `Database`. */
export interface LegacyModuleRuntimeDefinition<Database = unknown>
extends ModuleRuntimeDefinitionBase<Database> {
readonly database?: never; readonly database?: never;
} }
-3
View File
@@ -171,9 +171,6 @@ importers:
'@types/spdx-expression-parse': '@types/spdx-expression-parse':
specifier: 4.0.0 specifier: 4.0.0
version: 4.0.0 version: 4.0.0
drizzle-orm:
specifier: 0.45.2
version: 0.45.2(@types/[email protected])([email protected])([email protected])
typescript: typescript:
specifier: 7.0.2 specifier: 7.0.2
version: 7.0.2 version: 7.0.2
+9 -1
View File
@@ -79,7 +79,15 @@ if (failures.length > 0) {
} }
EOF EOF
echo "==> Typechecking and building" # The published declarations must stand on their own: no package may name a module a consumer has
# not installed (Drizzle above all), and the fixture checks every declaration it reaches.
for project in tsconfig.json tsconfig.ui.json; do
(cd "$module" && ./node_modules/.bin/tsc --showConfig --project "$project") |
node -e 'const c = JSON.parse(require("fs").readFileSync(0, "utf8")); if (c.compilerOptions.skipLibCheck !== false) process.exit(1);' ||
fail "$project does not typecheck with skipLibCheck: false"
done
echo "==> Typechecking (skipLibCheck: false) and building"
(cd "$module" && pnpm run typecheck && pnpm run build) >"$work/build.log" 2>&1 || (cd "$module" && pnpm run typecheck && pnpm run build) >"$work/build.log" 2>&1 ||
{ tail -40 "$work/build.log" >&2; fail "typecheck or build"; } { tail -40 "$work/build.log" >&2; fail "typecheck or build"; }
+6 -2
View File
@@ -1,7 +1,11 @@
{ {
"extends": "@ekklesia/typescript-config/node.json", "extends": "@ekklesia/typescript-config/node.json",
"compilerOptions": { "compilerOptions": {
"noEmit": true "noEmit": true,
"skipLibCheck": false
}, },
"include": ["src/server/**/*.ts", "src/schema/**/*.ts"] "include": [
"src/server/**/*.ts",
"src/schema/**/*.ts"
]
} }
+5 -2
View File
@@ -2,7 +2,10 @@
"extends": "@ekklesia/typescript-config/browser-react.json", "extends": "@ekklesia/typescript-config/browser-react.json",
"compilerOptions": { "compilerOptions": {
"noEmit": true, "noEmit": true,
"types": [] "types": [],
"skipLibCheck": false
}, },
"include": ["src/ui/**/*.tsx"] "include": [
"src/ui/**/*.tsx"
]
} }
+22 -4
View File
@@ -28,6 +28,7 @@ type Manifest = Record<string, unknown> & {
peerDependencies?: Record<string, string>; peerDependencies?: Record<string, string>;
peerDependenciesMeta?: Record<string, { optional?: boolean }>; peerDependenciesMeta?: Record<string, { optional?: boolean }>;
optionalDependencies?: Record<string, string>; optionalDependencies?: Record<string, string>;
devDependencies?: Record<string, string>;
ekklesia?: Record<string, unknown>; ekklesia?: Record<string, unknown>;
files?: string[]; files?: string[];
}; };
@@ -163,14 +164,21 @@ describe("the curated Module SDK", () => {
} }
const contractsSource = path.join(repositoryRoot, "packages/contracts/src"); const contractsSource = path.join(repositoryRoot, "packages/contracts/src");
for (const file of await readdir(contractsSource)) { for (const file of await readdir(contractsSource)) {
// Only types: Core alone validates the legacy Drizzle schema definition, with its own Drizzle. // Not even a type: the legacy facade's Drizzle type and schema validator are Core's own, so no
// declaration a consumer type-checks names Drizzle.
const source = await readFile(path.join(contractsSource, file), "utf8"); const source = await readFile(path.join(contractsSource, file), "utf8");
for (const line of source.split("\n").filter((text) => /from\s+"drizzle-orm/u.test(text))) { expect(source, file).not.toMatch(/from\s+"drizzle-orm|import\(\s*"drizzle-orm/u);
expect(line, file).toMatch(/^import type /u);
}
} }
const contracts = await readJson("packages/contracts/package.json"); const contracts = await readJson("packages/contracts/package.json");
expect(Object.keys(contracts.exports as object)).toEqual([".", "./module-package"]); expect(Object.keys(contracts.exports as object)).toEqual([".", "./module-package"]);
for (const field of [
"dependencies",
"peerDependencies",
"optionalDependencies",
"devDependencies",
] as const) {
expect(contracts[field]?.["drizzle-orm"], field).toBeUndefined();
}
}); });
}); });
@@ -190,6 +198,16 @@ describe("module authors' dependencies", () => {
expect(guide).toContain("`@ekklesia/contracts` is not a direct dependency."); expect(guide).toContain("`@ekklesia/contracts` is not a direct dependency.");
}); });
it("type-check every published declaration in the standalone fixture", async () => {
// skipLibCheck would hide a declaration naming a package the module never installed.
for (const project of ["tsconfig.json", "tsconfig.ui.json"]) {
const config = await readJson<{ compilerOptions: { skipLibCheck?: boolean } }>(
`tests/fixtures/standalone-module/${project}`,
);
expect(config.compilerOptions.skipLibCheck, project).toBe(false);
}
});
it("pin module-pack exactly and declare engines.node in the standalone fixture", async () => { it("pin module-pack exactly and declare engines.node in the standalone fixture", async () => {
const fixture = await readJson("tests/fixtures/standalone-module/package.json"); const fixture = await readJson("tests/fixtures/standalone-module/package.json");
const devDependencies = fixture.devDependencies as Record<string, string>; const devDependencies = fixture.devDependencies as Record<string, string>;