@xemahq/biome-database-nest 0.8.0 → 0.10.0

package/dist/lib/nest/biome-database.module.js

@@ -13,23 +13,16 @@ const identity_client_1 = require("@xemahq/identity-client");
 const service_registry_nest_1 = require("@xemahq/service-registry-nest");
 const bootstrap_1 = require("../bootstrap");
 const migration_mode_1 = require("../migration-mode");
-const schema_name_1 = require("../schema-name");
 exports.BIOME_DATABASE_READY = Symbol.for('@xemahq/biome-database-nest:ready');
 let BiomeDatabaseModule = BiomeDatabaseModule_1 = class BiomeDatabaseModule {
     static forRoot(opts) {
-        if (opts.migrationMode !== migration_mode_1.BiomeDatabaseMigrationMode.ApplicationManaged &&
-            opts.migrationMode !== migration_mode_1.BiomeDatabaseMigrationMode.ExternallyManaged) {
+        if (opts.migrationMode !== migration_mode_1.BiomeDatabaseMigrationMode.ApplicationManaged) {
             throw new Error('[biome-database] migrationMode is required and must be a BiomeDatabaseMigrationMode.');
         }
-        if (opts.migrationMode === migration_mode_1.BiomeDatabaseMigrationMode.ExternallyManaged &&
-            opts.databases.length === 0) {
-            throw new Error('[biome-database] externally-managed mode requires at least one explicit database declaration.');
+        if (opts.databases.length === 0) {
+            throw new Error('[biome-database] every migration mode requires at least one explicit database declaration.');
         }
-        const databases = opts.migrationMode === migration_mode_1.BiomeDatabaseMigrationMode.ApplicationManaged
-            ? (opts.databases ?? [
-                { key: schema_name_1.DEFAULT_BIOME_DB_KEY, workspaceDir: process.cwd() },
-            ])
-            : opts.databases;
+        const databases = opts.databases;
         if ((0, service_registry_nest_1.isOpenApiExtraction)()) {
             return {
                 module: BiomeDatabaseModule_1,

package/dist/lib/nest/biome-database.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"biome-database.module.js","sourceRoot":"","sources":["../../../src/lib/nest/biome-database.module.ts"],"names":[],"mappings":";;;;;;;;;;AACA,2CAAwC;AACxC,6DAAmE;AAEnE,yEAGuC;AAEvC,4CAAuD;AAKvD,sDAA+D;AAC/D,gDAAsD;AAWzC,QAAA,oBAAoB,GAAG,MAAM,CAAC,GAAG,CAC5C,mCAAmC,CACpC,CAAC;AAqFK,IAAM,mBAAmB,2BAAzB,MAAM,mBAAmB;IAC9B,MAAM,CAAC,OAAO,CAAC,IAAgC;QAC7C,IACE,IAAI,CAAC,aAAa,KAAK,2CAA0B,CAAC,kBAAkB;YACpE,IAAI,CAAC,aAAa,KAAK,2CAA0B,CAAC,iBAAiB,EACnE,CAAC;YACD,MAAM,IAAI,KAAK,CACb,sFAAsF,CACvF,CAAC;QACJ,CAAC;QACD,IACE,IAAI,CAAC,aAAa,KAAK,2CAA0B,CAAC,iBAAiB;YACnE,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAC3B,CAAC;YACD,MAAM,IAAI,KAAK,CACb,+FAA+F,CAChG,CAAC;QACJ,CAAC;QACD,MAAM,SAAS,GAGb,IAAI,CAAC,aAAa,KAAK,2CAA0B,CAAC,kBAAkB;YAClE,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,IAAI;gBACjB,EAAE,GAAG,EAAE,kCAAoB,EAAE,YAAY,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE;aAC3D,CAAC;YACJ,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;QAQrB,IAAI,IAAA,2CAAmB,GAAE,EAAE,CAAC;YAC1B,OAAO;gBACL,MAAM,EAAE,qBAAmB;gBAC3B,MAAM,EAAE,IAAI;gBACZ,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,4BAAoB,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;gBAC9D,OAAO,EAAE,CAAC,4BAAoB,CAAC;aAChC,CAAC;QACJ,CAAC;QAED,OAAO;YACL,MAAM,EAAE,qBAAmB;YAC3B,MAAM,EAAE,IAAI;YACZ,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,4BAAoB;oBAC7B,UAAU,EAAE,KAAK,EACf,iBAA2C,EAC3C,WAAwB,EACT,EAAE;wBACjB,IACE,IAAI,CAAC,aAAa;4BAClB,2CAA0B,CAAC,kBAAkB,EAC7C,CAAC;4BACD,MAAM,IAAA,mCAAuB,EAAC;gCAC5B,OAAO,EAAE,IAAI,CAAC,OAAO;gCACrB,aAAa,EAAE,IAAI,CAAC,aAAa;gCACjC,SAAS,EAAE,SAAgD;gCAC3D,GAAG,CAAC,IAAI,CAAC,kBAAkB,KAAK,SAAS;oCACvC,CAAC,CAAC,EAAE,kBAAkB,EAAE,IAAI,CAAC,kBAAkB,EAAE;oCACjD,CAAC,CAAC,EAAE,CAAC;gCACP,YAAY,EAAE,GAAG,EAAE,CAAC,iBAAiB,CAAC,cAAc,EAAE;gCACtD,WAAW;6BACZ,CAAC,CAAC;wBACL,CAAC;6BAAM,CAAC;4BACN,MAAM,IAAA,mCAAuB,EAAC;gCAC5B,OAAO,EAAE,IAAI,CAAC,OAAO;gCACrB,aAAa,EAAE,IAAI,CAAC,aAAa;gCACjC,SAAS,EACP,SAAiE;gCACnE,YAAY,EAAE,GAAG,EAAE,CAAC,iBAAiB,CAAC,cAAc,EAAE;gCACtD,WAAW;6BACZ,CAAC,CAAC;wBACL,CAAC;wBACD,OAAO,IAAI,CAAC;oBACd,CAAC;oBACD,MAAM,EAAE,CAAC,0CAAwB,EAAE,0CAAkB,CAAC;iBACvD;aACF;YACD,OAAO,EAAE,CAAC,4BAAoB,CAAC;SAChC,CAAC;IACJ,CAAC;CACF,CAAA;AApFY,kDAAmB;8BAAnB,mBAAmB;IAD/B,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,mBAAmB,CAoF/B"}
+{"version":3,"file":"biome-database.module.js","sourceRoot":"","sources":["../../../src/lib/nest/biome-database.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAAwC;AACxC,6DAAmE;AACnE,yEAGuC;AAEvC,4CAAuD;AACvD,sDAA+D;AAiBlD,QAAA,oBAAoB,GAAG,MAAM,CAAC,GAAG,CAC5C,mCAAmC,CACpC,CAAC;AAwEK,IAAM,mBAAmB,2BAAzB,MAAM,mBAAmB;IAC9B,MAAM,CAAC,OAAO,CAAC,IAAgC;QAC7C,IACE,IAAI,CAAC,aAAa,KAAK,2CAA0B,CAAC,kBAAkB,EACpE,CAAC;YACD,MAAM,IAAI,KAAK,CACb,sFAAsF,CACvF,CAAC;QACJ,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CACb,4FAA4F,CAC7F,CAAC;QACJ,CAAC;QACD,MAAM,SAAS,GAEX,IAAI,CAAC,SAAS,CAAC;QAQnB,IAAI,IAAA,2CAAmB,GAAE,EAAE,CAAC;YAC1B,OAAO;gBACL,MAAM,EAAE,qBAAmB;gBAC3B,MAAM,EAAE,IAAI;gBACZ,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,4BAAoB,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;gBAC9D,OAAO,EAAE,CAAC,4BAAoB,CAAC;aAChC,CAAC;QACJ,CAAC;QAED,OAAO;YACL,MAAM,EAAE,qBAAmB;YAC3B,MAAM,EAAE,IAAI;YACZ,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,4BAAoB;oBAC7B,UAAU,EAAE,KAAK,EACf,iBAA2C,EAC3C,WAAwB,EACT,EAAE;wBACjB,IACE,IAAI,CAAC,aAAa;4BAClB,2CAA0B,CAAC,kBAAkB,EAC7C,CAAC;4BACD,MAAM,IAAA,mCAAuB,EAAC;gCAC5B,OAAO,EAAE,IAAI,CAAC,OAAO;gCACrB,aAAa,EAAE,IAAI,CAAC,aAAa;gCACjC,SAAS,EAAE,SAAgD;gCAC3D,GAAG,CAAC,IAAI,CAAC,kBAAkB,KAAK,SAAS;oCACvC,CAAC,CAAC,EAAE,kBAAkB,EAAE,IAAI,CAAC,kBAAkB,EAAE;oCACjD,CAAC,CAAC,EAAE,CAAC;gCACP,YAAY,EAAE,GAAG,EAAE,CAAC,iBAAiB,CAAC,cAAc,EAAE;gCACtD,WAAW;6BACZ,CAAC,CAAC;wBACL,CAAC;6BAAM,CAAC;4BACN,MAAM,IAAA,mCAAuB,EAAC;gCAC5B,OAAO,EAAE,IAAI,CAAC,OAAO;gCACrB,aAAa,EAAE,IAAI,CAAC,aAAa;gCACjC,SAAS,EACP,SAAS;gCACX,YAAY,EAAE,GAAG,EAAE,CAAC,iBAAiB,CAAC,cAAc,EAAE;gCACtD,WAAW;6BACZ,CAAC,CAAC;wBACL,CAAC;wBACD,OAAO,IAAI,CAAC;oBACd,CAAC;oBACD,MAAM,EAAE,CAAC,0CAAwB,EAAE,0CAAkB,CAAC;iBACvD;aACF;YACD,OAAO,EAAE,CAAC,4BAAoB,CAAC;SAChC,CAAC;IACJ,CAAC;CACF,CAAA;AA3EY,kDAAmB;8BAAnB,mBAAmB;IAD/B,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,mBAAmB,CA2E/B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xemahq/biome-database-nest",
-  "version": "0.8.0",
+  "version": "0.10.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)",
@@ -18,7 +18,8 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "src"
   ],
   "devDependencies": {
     "@nestjs/common": "11.1.13",
@@ -49,7 +50,7 @@
   },
   "dependencies": {
     "@xemahq/migration-runner-prisma": "^0.1.2",
-    "@xemahq/platform-common": "^0.5.9",
+    "@xemahq/platform-common": "^0.6.1",
     "pg": "8.16.3"
   },
   "exports": {

package/src/index.ts

@@ -0,0 +1,112 @@
+export { DEFAULT_BIOME_DB_KEY, deriveBiomeSchemaName } from './lib/schema-name';
+export {
+  composeIdentifier,
+  fitIdentifier,
+  IDENTIFIER_HASH_LENGTH,
+  POSTGRES_MAX_IDENTIFIER_LENGTH,
+  sanitizeIdentifierChars,
+  sanitizeIdentifierSegment,
+  type ComposeIdentifierInput,
+  type FitIdentifierInput,
+} from './lib/identifier';
+export {
+  rolesForSchema,
+  schemaRoleBase,
+  schemaRoleName,
+  SchemaRoleKind,
+  SCHEMA_ROLE_BASE_MAX_LENGTH,
+  SCHEMA_ROLE_SUFFIX_LENGTH,
+  type SchemaRoleNames,
+} from './lib/role-names';
+export {
+  resolveBiomeDatabaseConfigFromEnv,
+  type BiomeDatabaseConfig,
+} from './lib/config';
+export {
+  createBiomePrismaAdapter,
+  createBiomePrismaAdapterFromEnv,
+} from './lib/adapter';
+export {
+  fetchSystemDatabaseConfig,
+  type SystemDatabaseConfigRequest,
+} from './lib/control-plane-client';
+export {
+  resolveControlPlaneBaseUrl,
+  ORG_DATABASE_POOL_SERVICE_NAME,
+  type ControlPlaneDiscoveryOptions,
+} from './lib/control-plane-discovery';
+export {
+  bootstrapBiomeDatabases,
+  type BiomeDatabaseDeclaration,
+  type BootstrapBiomeDatabasesOptions,
+} from './lib/bootstrap';
+export { BiomeDatabaseMigrationMode } from './lib/migration-mode';
+export {
+  BiomeDatabaseModule,
+  BIOME_DATABASE_READY,
+  type BiomeDatabaseModuleOptions,
+} from './lib/nest/biome-database.module';
+export {
+  createBiomePrismaService,
+  type BiomePrismaClient,
+  type BiomePrismaClientCtor,
+  type BiomePrismaServiceInstance,
+  type CreateBiomePrismaServiceOptions,
+  type TenantIsolationServiceOptions,
+  type TenantScopedApi,
+} from './lib/nest/prisma-service-factory';
+export {
+  TenantIsolationMode,
+  TENANT_ISOLATION_MODE_ENV_VAR,
+  resolveTenantIsolationMode,
+} from './lib/tenant-isolation/tenant-isolation-mode';
+export {
+  TenantIsolationError,
+  TenantIsolationViolationKind,
+  formatTenantIsolationViolation,
+  type TenantIsolationViolation,
+} from './lib/tenant-isolation/tenant-isolation-error';
+export {
+  PrismaModelOperation,
+  scopeArgsToOrg,
+  type OrgScopeOutcome,
+  type OrgScopeRequest,
+} from './lib/tenant-isolation/org-scope';
+export {
+  DEFAULT_ORG_FIELD,
+  collectOrgScopedModels,
+  createTenantIsolationExtension,
+  readRuntimeModels,
+  type CreateTenantIsolationExtensionOptions,
+  type RuntimeDataModelField,
+  type RuntimeDataModelModel,
+  type TenantIsolationExtensionDefinition,
+  type TenantIsolationLogger,
+  type TenantIsolationQueryContext,
+} from './lib/tenant-isolation/tenant-isolation.extension';
+export {
+  assertUnscopedModelsDeclared,
+  collectUnscopableModels,
+  formatUnscopedModelReport,
+  normalizeUnscopedModelDeclarations,
+  UndeclaredUnscopedModelsError,
+  type AssertUnscopedModelsOptions,
+  type NormalizedUnscopedModelDeclaration,
+  type UnscopedModelDeclaration,
+  type UnscopedModelDeclarations,
+} from './lib/tenant-isolation/unscoped-models';
+export {
+  eraseOrgData,
+  OrgErasureBlockedError,
+  type EraseOrgDataOptions,
+  type OrgErasureReport,
+} from './lib/tenant-isolation/org-erasure';
+export {
+  OrgErasureModule,
+  OrgErasureController,
+  ORG_ERASURE_RUNNER,
+  ORG_DATA_ERASURE_CAPABILITY,
+  ORG_ERASURE_ROUTE_PATH,
+  type OrgErasureModuleOptions,
+  type OrgErasureRunner,
+} from './lib/nest/org-erasure.module';

package/src/lib/adapter.ts

@@ -0,0 +1,114 @@
+import { PrismaPg } from '@prisma/adapter-pg';
+import {
+  composeBiomeDatabaseUrl,
+  ensureBiomeDbSearchPath,
+} from '@xemahq/platform-common';
+
+import type { BiomeDatabaseConfig } from './config';
+import { resolveBiomeDatabaseConfigFromEnv } from './config';
+
+const DEFAULT_POOL_MAX = 3;
+
+/**
+ * Build a connection string from a {@link BiomeDatabaseConfig}, with `?schema=`
+ * when a per-biome schema is set and the libpq `search_path` option applied so
+ * RAW queries also resolve to the biome schema.
+ *
+ * @throws if the config is missing a part required to form a URL.
+ */
+function buildBiomeConnectionString(config: BiomeDatabaseConfig): string {
+  const url = composeBiomeDatabaseUrl({
+    user: config.username,
+    password: config.password,
+    host: config.host,
+    port: String(config.port),
+    database: config.database,
+    ...(config.schema !== undefined ? { schema: config.schema } : {}),
+    ...(config.sslParams !== undefined ? { sslParams: config.sslParams } : {}),
+  });
+  if (url === null) {
+    throw new Error(
+      'createBiomePrismaAdapter: incomplete BiomeDatabaseConfig — ' +
+        'host/port/database/username/password are all required.',
+    );
+  }
+  return ensureBiomeDbSearchPath(url);
+}
+
+/**
+ * Construct a {@link PrismaPg} driver-adapter pool whose Prisma Client qualifies
+ * ORM table names with the biome schema.
+ *
+ * THIS IS THE CENTRALIZED FIX. `@prisma/adapter-pg` (Prisma 7) ignores BOTH the
+ * URL `?schema=` and the connection `search_path` when qualifying ORM-emitted
+ * SQL — it falls back to `public.<table>` unless the schema is passed as the
+ * SECOND constructor argument. Passing `{ schema }` here makes Prisma emit
+ * `biome_<id>.<table>`. `ensureBiomeDbSearchPath` separately fixes RAW queries.
+ * Constructing the adapter correctly is the ONLY thing this function does, so
+ * the correct construction is the only construction a biome can perform.
+ */
+export function createBiomePrismaAdapter(config: BiomeDatabaseConfig): PrismaPg {
+  const connectionString = buildBiomeConnectionString(config);
+  return new PrismaPg(
+    {
+      connectionString,
+      min: 1,
+      max: config.poolMax ?? DEFAULT_POOL_MAX,
+      idleTimeoutMillis: 30_000,
+    },
+    config.schema !== undefined ? { schema: config.schema } : undefined,
+  );
+}
+
+/**
+ * Construct the schema-qualified adapter from the environment — the path the
+ * unchanged-shape `PrismaService` calls at construction time (post-bootstrap,
+ * where `DATABASE_URL`/`DB_*` are guaranteed set).
+ *
+ * Resolution order:
+ * 1. If `DATABASE_URL` (or `DATABASE_URL_<KEY>` for a non-default key) is set,
+ *    use it directly as the connection string (still applying
+ *    `ensureBiomeDbSearchPath` + the `{ schema }` second-arg from `DB_SCHEMA`).
+ * 2. Otherwise compose from the discrete `DB_*` vars.
+ *
+ * @throws if neither a `DATABASE_URL` nor a complete `DB_*` set is present.
+ */
+export function createBiomePrismaAdapterFromEnv(
+  env: NodeJS.ProcessEnv = process.env,
+  dbKey?: string,
+): PrismaPg {
+  const isDefault = dbKey === undefined || dbKey === '' || dbKey === 'primary';
+  const upperSuffix = isDefault
+    ? ''
+    : `_${dbKey!.toUpperCase().replace(/[^A-Z0-9]/g, '_')}`;
+
+  const directUrl = env[`DATABASE_URL${upperSuffix}`];
+  const schema = env[`DB_SCHEMA${upperSuffix}`];
+  const poolMaxRaw = env[`DB_POOL_MAX${upperSuffix}`] ?? env.DB_POOL_MAX;
+  const poolMax =
+    poolMaxRaw !== undefined && poolMaxRaw !== ''
+      ? Number.parseInt(poolMaxRaw, 10)
+      : DEFAULT_POOL_MAX;
+
+  if (directUrl !== undefined && directUrl !== '') {
+    const connectionString = ensureBiomeDbSearchPath(directUrl);
+    return new PrismaPg(
+      {
+        connectionString,
+        min: 1,
+        max: poolMax,
+        idleTimeoutMillis: 30_000,
+      },
+      schema !== undefined && schema !== '' ? { schema } : undefined,
+    );
+  }
+
+  const config = resolveBiomeDatabaseConfigFromEnv(env, dbKey);
+  if (config === null) {
+    throw new Error(
+      `createBiomePrismaAdapterFromEnv: no DATABASE_URL${upperSuffix} and no ` +
+        `DB_HOST${upperSuffix}/DB_HOST in the environment — cannot construct an adapter.`,
+    );
+  }
+  return createBiomePrismaAdapter(config);
+}