@xemahq/biome-database-nest 1.0.1 → 1.1.0

package/README.md

@@ -55,6 +55,26 @@ Mount it beside `XemaServiceModule.forBiome(...)`, which publishes the connectio
 
 Every Postgres session must run in UTC. The package verifies this and refuses to start otherwise; it never sets the zone.
 
+## Testing
+
+`@xemahq/pg-test-harness` (0.5 and later) provisions a scratch database but does not know how to migrate it. `createTestMigrator` from the `/testing` subpath returns the `migrate` callback it needs: the same migration phase a service runs at boot (`runBiomeMigrations`). It applies the service's Prisma migrations from `<rootDir>/prisma`, then the operator-migration ledger and the SDK-owned migrations you list, and verifies every owned table's shape. Running it again on the same schema changes nothing.
+
+```ts
+// tests/global-setup.ts
+import { createTestMigrator } from '@xemahq/biome-database-nest/testing';
+import { provisionTestDatabase } from '@xemahq/pg-test-harness';
+
+export default async function globalSetup(): Promise<void> {
+  await provisionTestDatabase({
+    serviceName: 'example',
+    rootDir: process.cwd(),
+    migrate: createTestMigrator({ sdkOwnedMigrations: [/* each SDK's migration set */] }),
+  });
+}
+```
+
+`createTestMigrator(options?)` takes `sdkOwnedMigrations?: readonly SdkOwnedMigrationSet[]` and returns `(target: { serviceName, rootDir, url, schema }) => Promise<void>`. It reads no environment variables.
+
 ## Peer requirements
 
 NestJS 10 or 11, Prisma 7 (`@prisma/client`, `@prisma/adapter-pg`), `@xemahq/identity-client`, `@xemahq/contracts`, `@xemahq/service-registry-nest`, `@xemahq/platform-common`.

package/dist/testing/index.d.ts

@@ -0,0 +1,12 @@
+import type { SdkOwnedMigrationSet } from '../lib/sdk-owned-migration-set';
+export interface TestMigrationTarget {
+    readonly serviceName: string;
+    readonly rootDir: string;
+    readonly url: string;
+    readonly schema: string;
+}
+export interface CreateTestMigratorOptions {
+    readonly sdkOwnedMigrations?: readonly SdkOwnedMigrationSet[];
+}
+export declare function createTestMigrator(options?: CreateTestMigratorOptions): (target: TestMigrationTarget) => Promise<void>;
+//# sourceMappingURL=index.d.ts.map

package/dist/testing/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/testing/index.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAM3E,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAE7B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,yBAAyB;IAExC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,SAAS,oBAAoB,EAAE,CAAC;CAC/D;AAWD,wBAAgB,kBAAkB,CAChC,OAAO,GAAE,yBAA8B,GACtC,CAAC,MAAM,EAAE,mBAAmB,KAAK,OAAO,CAAC,IAAI,CAAC,CA6BhD"}

package/dist/testing/index.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTestMigrator = createTestMigrator;
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const biome_migrations_1 = require("../lib/biome-migrations");
+const operator_migration_1 = require("../lib/operator-migration");
+const SQL_IDENTIFIER = /^[a-z_][a-z0-9_]*$/iu;
+function createTestMigrator(options = {}) {
+    return async (target) => {
+        const schemaPath = (0, node_path_1.join)(target.rootDir, 'prisma', 'schema.prisma');
+        if (!(0, node_fs_1.existsSync)(schemaPath)) {
+            throw new Error(`${target.serviceName}: no Prisma schema at ${schemaPath}. Pass the service root as \`rootDir\` to provisionTestDatabase.`);
+        }
+        if (!SQL_IDENTIFIER.test(target.schema)) {
+            throw new Error(`${target.serviceName}: refusing scratch schema ${JSON.stringify(target.schema)}; it must match ${SQL_IDENTIFIER.source} before it is interpolated into CREATE SCHEMA.`);
+        }
+        const database = await (0, operator_migration_1.openOperatorMigrationClient)({
+            connectionString: target.url,
+        });
+        try {
+            await database.query(`CREATE SCHEMA IF NOT EXISTS "${target.schema}"`);
+            await (0, biome_migrations_1.runBiomeMigrations)({
+                database,
+                workspaceDir: target.rootDir,
+                connectionUrl: target.url,
+                label: target.serviceName,
+                sdkOwnedMigrations: options.sdkOwnedMigrations ?? [],
+            });
+        }
+        finally {
+            await database.end();
+        }
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/testing/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/testing/index.ts"],"names":[],"mappings":";;AAmCA,gDA+BC;AAlED,qCAAqC;AACrC,yCAAiC;AAEjC,8DAA6D;AAC7D,kEAAwE;AAsBxE,MAAM,cAAc,GAAG,sBAAsB,CAAC;AAS9C,SAAgB,kBAAkB,CAChC,UAAqC,EAAE;IAEvC,OAAO,KAAK,EAAE,MAAM,EAAE,EAAE;QACtB,MAAM,UAAU,GAAG,IAAA,gBAAI,EAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,EAAE,eAAe,CAAC,CAAC;QACnE,IAAI,CAAC,IAAA,oBAAU,EAAC,UAAU,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CACb,GAAG,MAAM,CAAC,WAAW,yBAAyB,UAAU,kEAAkE,CAC3H,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CACb,GAAG,MAAM,CAAC,WAAW,6BAA6B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,mBAAmB,cAAc,CAAC,MAAM,gDAAgD,CACxK,CAAC;QACJ,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAA,gDAA2B,EAAC;YACjD,gBAAgB,EAAE,MAAM,CAAC,GAAG;SAC7B,CAAC,CAAC;QACH,IAAI,CAAC;YACH,MAAM,QAAQ,CAAC,KAAK,CAAC,gCAAgC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;YACvE,MAAM,IAAA,qCAAkB,EAAC;gBACvB,QAAQ;gBACR,YAAY,EAAE,MAAM,CAAC,OAAO;gBAC5B,aAAa,EAAE,MAAM,CAAC,GAAG;gBACzB,KAAK,EAAE,MAAM,CAAC,WAAW;gBACzB,kBAAkB,EAAE,OAAO,CAAC,kBAAkB,IAAI,EAAE;aACrD,CAAC,CAAC;QACL,CAAC;gBAAS,CAAC;YACT,MAAM,QAAQ,CAAC,GAAG,EAAE,CAAC;QACvB,CAAC;IACH,CAAC,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xemahq/biome-database-nest",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Explicit database migration ownership, least-privilege runtime verification, and schema-qualified Prisma wiring for Xema biome services.",
   "license": "Apache-2.0",
   "author": "Neuralchowder Inc. <developer@xema.dev> (https://xema.dev)",
@@ -39,9 +39,9 @@
     "prisma": "7.8.0",
     "ts-jest": "^29.4.9",
     "typescript": "5.9.3",
-    "@xemahq/service-registry-nest": "1.0.1",
+    "@xemahq/eslint-config": "0.14.0",
     "@xemahq/xema-decorators": "1.0.1",
-    "@xemahq/eslint-config": "0.14.0"
+    "@xemahq/service-registry-nest": "1.1.0"
   },
   "peerDependencies": {
     "@nestjs/common": "^10 || ^11",
@@ -64,6 +64,11 @@
       "xema-source": "./src/index.ts",
       "default": "./dist/index.js"
     },
+    "./testing": {
+      "types": "./dist/testing/index.d.ts",
+      "xema-source": "./src/testing/index.ts",
+      "default": "./dist/testing/index.js"
+    },
     "./dist/lib/*": {
       "types": "./dist/lib/*.d.ts",
       "default": "./dist/lib/*.js"
@@ -78,6 +83,6 @@
     "typecheck": "tsc -p tsconfig.json --noEmit"
   },
   "xemaRelease": {
-    "sourceDigest": "sha256:d71e290d6ee853189569668b21c88db64034589b46296d141a1df86962c1e737"
+    "sourceDigest": "sha256:6a5dd5acb427f3601ffafd9f7f634024b4504d3968dd6508b0b4794998130f71"
   }
 }