Files
Ekklesia/core/src/modules/legacy-schema-definition.ts
T
ekklesiaandClaude Opus 5.5 89d5d0f2da
CI / verify (pull_request) Successful in 1m2s
CI / infrastructure-smoke (pull_request) Successful in 28s
CI / migration-smoke (pull_request) Successful in 1m52s
CI / standalone-module (pull_request) Successful in 26s
CI / image-build (pull_request) Successful in 30s
CI / deploy-smoke (same-origin) (pull_request) Successful in 50s
CI / deploy-smoke (split) (pull_request) Successful in 1m42s
feat: standalone module-build readiness for the public @ekklesia packages (ADR 0053)
Makes the public module-development package set usable from a module
repository outside the monorepo. Nothing is published.

- Curated @ekklesia/module-sdk: an explicit author API, no contracts
  barrel, no identity/authorization internals, no Drizzle and no legacy
  ModuleDatabase type. defineModuleRuntime returns the SDK's own named
  interfaces so a module's emitted declarations never reach into
  @ekklesia/contracts. defineModuleSchema is gone; createModuleTable and
  defineModuleSchemaMetadata live in @ekklesia/module-database.
- Drizzle: no longer a dependency of module-sdk or contracts. Core keeps
  the legacy Drizzle schema validator (moved to core/src/modules) and
  its legacy runtime support; drizzle-orm is an optional peer only.
- React is a peer (plus devDependency) of @ekklesia/ui; the boundary
  checker allows exactly that consumer-selected peer.
- @ekklesia/typescript-config is publishable; module-ui-host is private.
  Every public package carries "ekklesia.distribution":
  "module-development" and no monorepo-root prepack.
- module-pack reads the Node.js range from the module's own engines.node
  and recognizes Ekklesia packages by name plus that marker, so
  registry-installed packages are incorporated, SDK-compatibility
  checked, and never credited as third-party.
- scripts/pack-public-packages.ts (pnpm packages:pack) rebuilds, packs
  and inspects the nine public tarballs; scripts/test-standalone-module.sh
  (pnpm test:standalone-module, new CI job) installs them into a fixture
  module outside the repository and proves it typechecks, builds,
  packages, and verifies.
- Public-package boundary tests and module-development docs.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-08 07:28:54 -05:00

74 lines
2.5 KiB
TypeScript

/**
* The legacy module schema definition (ADR 0007): a v8 module that declares no `database` default-
* exports `{ moduleId, tables }` with its Drizzle table objects themselves. Core alone validates it,
* for the legacy facade's deprecation window (ADR 0050). It lives here, beside Core's own Drizzle
* dependency, so that no package a module installs needs Drizzle at run time (ADR 0053).
*
* Erasable TypeScript with no relative imports: the verifier's probe imports this source file
* directly in tests (`module-package-probe.ts`).
*/
import { is } from "drizzle-orm";
import { type AnyPgTable, PgTable } from "drizzle-orm/pg-core";
import { type ModuleId, moduleIdSchema } from "@ekklesia/contracts";
export interface ModuleSchemaDefinition<
Tables extends Readonly<Record<string, AnyPgTable>> = Readonly<Record<string, AnyPgTable>>,
> {
readonly moduleId: ModuleId;
readonly tables: Tables;
}
const schemaDefinitionKeys = new Set(["moduleId", "tables"]);
const drizzleTableIsAlias = Symbol.for("drizzle:IsAlias");
function isRecord(value: unknown): value is Record<string, unknown> {
return typeof value === "object" && value !== null && !Array.isArray(value);
}
function hasOnlyStringKeys(value: object, allowedKeys?: ReadonlySet<string>): boolean {
return Reflect.ownKeys(value).every(
(key) => typeof key === "string" && (!allowedKeys || allowedKeys.has(key)),
);
}
export function isModuleSchemaDefinition(value: unknown): value is ModuleSchemaDefinition {
try {
if (
!isRecord(value) ||
!hasOnlyStringKeys(value, schemaDefinitionKeys) ||
!moduleIdSchema.safeParse(value.moduleId).success ||
!isRecord(value.tables) ||
!hasOnlyStringKeys(value.tables)
) {
return false;
}
const tables = Object.values(value.tables);
return (
tables.length > 0 &&
tables.every(
(table) =>
is(table, PgTable) &&
(table as unknown as Record<PropertyKey, unknown>)[drizzleTableIsAlias] === false,
)
);
} catch {
return false;
}
}
export function parseModuleSchemaDefinition(value: unknown): ModuleSchemaDefinition {
if (!isModuleSchemaDefinition(value)) {
throw new TypeError("Invalid Ekklesia module schema definition.");
}
const tables = Object.freeze(
Object.fromEntries(
Object.entries(value.tables).sort(([left], [right]) =>
left < right ? -1 : left > right ? 1 : 0,
),
) as Record<string, AnyPgTable>,
);
return Object.freeze({ moduleId: value.moduleId, tables });
}