@prisma-next/sql-runtime 0.3.0-dev.2 → 0.3.0-dev.21

package/package.json

@@ -1,33 +1,34 @@
 {
   "name": "@prisma-next/sql-runtime",
-  "version": "0.3.0-dev.2",
+  "version": "0.3.0-dev.21",
   "type": "module",
   "sideEffects": false,
   "description": "SQL runtime implementation for Prisma Next",
   "dependencies": {
-    "@prisma-next/contract": "0.3.0-dev.2",
-    "@prisma-next/core-execution-plane": "0.3.0-dev.2",
-    "@prisma-next/operations": "0.3.0-dev.2",
-    "@prisma-next/runtime-executor": "0.3.0-dev.2",
-    "@prisma-next/sql-contract": "0.3.0-dev.2",
-    "@prisma-next/sql-operations": "0.3.0-dev.2",
-    "@prisma-next/sql-relational-core": "0.3.0-dev.2"
+    "@prisma-next/contract": "0.3.0-dev.21",
+    "@prisma-next/core-execution-plane": "0.3.0-dev.21",
+    "@prisma-next/operations": "0.3.0-dev.21",
+    "@prisma-next/runtime-executor": "0.3.0-dev.21",
+    "@prisma-next/sql-contract": "0.3.0-dev.21",
+    "@prisma-next/sql-operations": "0.3.0-dev.21",
+    "@prisma-next/sql-relational-core": "0.3.0-dev.21"
   },
   "devDependencies": {
-    "@types/pg": "^8.11.10",
-    "@vitest/coverage-v8": "^4.0.0",
-    "pg": "^8.11.5",
-    "tsup": "^8.3.0",
-    "typescript": "^5.9.3",
-    "vitest": "^4.0.16",
+    "@types/pg": "8.16.0",
+    "pg": "8.16.3",
+    "tsup": "8.5.1",
+    "typescript": "5.9.3",
+    "vitest": "4.0.16",
     "@prisma-next/test-utils": "0.0.1"
   },
   "files": [
-    "dist"
+    "dist",
+    "src",
+    "test"
   ],
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
+      "types": "./dist/src/index.d.ts",
       "import": "./dist/index.js"
     },
     "./test/utils": {
@@ -36,13 +37,13 @@
     }
   },
   "scripts": {
-    "build": "tsup --config tsup.config.ts",
+    "build": "tsup --config tsup.config.ts && tsc --project tsconfig.build.json",
     "test": "vitest run --passWithNoTests",
     "test:coverage": "vitest run --coverage --passWithNoTests",
     "typecheck": "tsc --project tsconfig.json --noEmit",
-    "lint": "biome check . --config-path ../../../biome.json --error-on-warnings",
-    "lint:fix": "biome check --write . --config-path ../../../biome.json",
-    "lint:fix:unsafe": "biome check --write --unsafe . --config-path ../../../biome.json",
-    "clean": "node ../../../scripts/clean.mjs"
+    "lint": "biome check . --error-on-warnings",
+    "lint:fix": "biome check --write .",
+    "lint:fix:unsafe": "biome check --write --unsafe .",
+    "clean": "rm -rf dist coverage .tmp-output"
   }
 }

package/src/codecs/decoding.ts

@@ -0,0 +1,140 @@
+import type { ExecutionPlan } from '@prisma-next/contract/types';
+import type { Codec, CodecRegistry } from '@prisma-next/sql-relational-core/ast';
+
+function resolveRowCodec(
+  alias: string,
+  plan: ExecutionPlan,
+  registry: CodecRegistry,
+): Codec | null {
+  const planCodecId = plan.meta.annotations?.codecs?.[alias] as string | undefined;
+  if (planCodecId) {
+    const codec = registry.get(planCodecId);
+    if (codec) {
+      return codec;
+    }
+  }
+
+  if (plan.meta.projectionTypes) {
+    const typeId = plan.meta.projectionTypes[alias];
+    if (typeId) {
+      const codec = registry.get(typeId);
+      if (codec) {
+        return codec;
+      }
+    }
+  }
+
+  return null;
+}
+
+export function decodeRow(
+  row: Record<string, unknown>,
+  plan: ExecutionPlan,
+  registry: CodecRegistry,
+): Record<string, unknown> {
+  const decoded: Record<string, unknown> = {};
+
+  let aliases: readonly string[];
+  const projection = plan.meta.projection;
+  if (projection && !Array.isArray(projection)) {
+    aliases = Object.keys(projection);
+  } else if (projection && Array.isArray(projection)) {
+    aliases = projection;
+  } else {
+    aliases = Object.keys(row);
+  }
+
+  for (const alias of aliases) {
+    const wireValue = row[alias];
+
+    const projection = plan.meta.projection;
+    const projectionValue =
+      projection && typeof projection === 'object' && !Array.isArray(projection)
+        ? (projection as Record<string, string>)[alias]
+        : undefined;
+
+    if (typeof projectionValue === 'string' && projectionValue.startsWith('include:')) {
+      if (wireValue === null || wireValue === undefined) {
+        decoded[alias] = [];
+        continue;
+      }
+
+      try {
+        let parsed: unknown;
+        if (typeof wireValue === 'string') {
+          parsed = JSON.parse(wireValue);
+        } else if (Array.isArray(wireValue)) {
+          parsed = wireValue;
+        } else {
+          parsed = JSON.parse(String(wireValue));
+        }
+
+        if (!Array.isArray(parsed)) {
+          throw new Error(`Expected array for include alias '${alias}', got ${typeof parsed}`);
+        }
+
+        decoded[alias] = parsed;
+      } catch (error) {
+        const decodeError = new Error(
+          `Failed to parse JSON array for include alias '${alias}': ${error instanceof Error ? error.message : String(error)}`,
+        ) as Error & {
+          code: string;
+          category: string;
+          severity: string;
+          details?: Record<string, unknown>;
+        };
+        decodeError.code = 'RUNTIME.DECODE_FAILED';
+        decodeError.category = 'RUNTIME';
+        decodeError.severity = 'error';
+        decodeError.details = {
+          alias,
+          wirePreview:
+            typeof wireValue === 'string' && wireValue.length > 100
+              ? `${wireValue.substring(0, 100)}...`
+              : String(wireValue).substring(0, 100),
+        };
+        throw decodeError;
+      }
+      continue;
+    }
+
+    if (wireValue === null || wireValue === undefined) {
+      decoded[alias] = wireValue;
+      continue;
+    }
+
+    const codec = resolveRowCodec(alias, plan, registry);
+
+    if (!codec) {
+      decoded[alias] = wireValue;
+      continue;
+    }
+
+    try {
+      decoded[alias] = codec.decode(wireValue);
+    } catch (error) {
+      const decodeError = new Error(
+        `Failed to decode row alias '${alias}' with codec '${codec.id}': ${error instanceof Error ? error.message : String(error)}`,
+      ) as Error & {
+        code: string;
+        category: string;
+        severity: string;
+        details?: Record<string, unknown>;
+      };
+      decodeError.code = 'RUNTIME.DECODE_FAILED';
+      decodeError.category = 'RUNTIME';
+      decodeError.severity = 'error';
+      decodeError.details = {
+        alias,
+        codec: codec.id,
+        wirePreview:
+          typeof wireValue === 'string' && wireValue.length > 100
+            ? `${wireValue.substring(0, 100)}...`
+            : String(wireValue).substring(0, 100),
+      };
+      throw decodeError;
+    }
+  }
+
+  return decoded;
+}

package/src/codecs/encoding.ts

@@ -0,0 +1,76 @@
+import type { ExecutionPlan, ParamDescriptor } from '@prisma-next/contract/types';
+import type { Codec, CodecRegistry } from '@prisma-next/sql-relational-core/ast';
+
+function resolveParamCodec(
+  paramDescriptor: ParamDescriptor,
+  plan: ExecutionPlan,
+  registry: CodecRegistry,
+): Codec | null {
+  const paramName = paramDescriptor.name ?? `param_${paramDescriptor.index ?? 0}`;
+
+  const planCodecId = plan.meta.annotations?.codecs?.[paramName] as string | undefined;
+  if (planCodecId) {
+    const codec = registry.get(planCodecId);
+    if (codec) {
+      return codec;
+    }
+  }
+
+  if (paramDescriptor.codecId) {
+    const codec = registry.get(paramDescriptor.codecId);
+    if (codec) {
+      return codec;
+    }
+  }
+
+  return null;
+}
+
+export function encodeParam(
+  value: unknown,
+  paramDescriptor: ParamDescriptor,
+  plan: ExecutionPlan,
+  registry: CodecRegistry,
+): unknown {
+  if (value === null || value === undefined) {
+    return null;
+  }
+
+  const codec = resolveParamCodec(paramDescriptor, plan, registry);
+  if (!codec) {
+    return value;
+  }
+
+  if (codec.encode) {
+    try {
+      return codec.encode(value);
+    } catch (error) {
+      throw new Error(
+        `Failed to encode parameter ${paramDescriptor.name ?? paramDescriptor.index}: ${error instanceof Error ? error.message : String(error)}`,
+      );
+    }
+  }
+
+  return value;
+}
+
+export function encodeParams(plan: ExecutionPlan, registry: CodecRegistry): readonly unknown[] {
+  if (plan.params.length === 0) {
+    return plan.params;
+  }
+
+  const encoded: unknown[] = [];
+
+  for (let i = 0; i < plan.params.length; i++) {
+    const paramValue = plan.params[i];
+    const paramDescriptor = plan.meta.paramDescriptors[i];
+
+    if (paramDescriptor) {
+      encoded.push(encodeParam(paramValue, paramDescriptor, plan, registry));
+    } else {
+      encoded.push(paramValue);
+    }
+  }
+
+  return Object.freeze(encoded);
+}

package/src/codecs/validation.ts

@@ -0,0 +1,67 @@
+import { runtimeError } from '@prisma-next/runtime-executor';
+import type { SqlContract, SqlStorage } from '@prisma-next/sql-contract/types';
+import type { CodecRegistry } from '@prisma-next/sql-relational-core/ast';
+
+export function extractCodecIds(contract: SqlContract<SqlStorage>): Set<string> {
+  const codecIds = new Set<string>();
+
+  for (const table of Object.values(contract.storage.tables)) {
+    for (const column of Object.values(table.columns)) {
+      const codecId = column.codecId;
+      codecIds.add(codecId);
+    }
+  }
+
+  return codecIds;
+}
+
+function extractCodecIdsFromColumns(contract: SqlContract<SqlStorage>): Map<string, string> {
+  const codecIds = new Map<string, string>();
+
+  for (const [tableName, table] of Object.entries(contract.storage.tables)) {
+    for (const [columnName, column] of Object.entries(table.columns)) {
+      const codecId = column.codecId;
+      const key = `${tableName}.${columnName}`;
+      codecIds.set(key, codecId);
+    }
+  }
+
+  return codecIds;
+}
+
+export function validateContractCodecMappings(
+  registry: CodecRegistry,
+  contract: SqlContract<SqlStorage>,
+): void {
+  const codecIds = extractCodecIdsFromColumns(contract);
+  const invalidCodecs: Array<{ table: string; column: string; codecId: string }> = [];
+
+  for (const [key, codecId] of codecIds.entries()) {
+    if (!registry.has(codecId)) {
+      const parts = key.split('.');
+      const table = parts[0] ?? '';
+      const column = parts[1] ?? '';
+      invalidCodecs.push({ table, column, codecId });
+    }
+  }
+
+  if (invalidCodecs.length > 0) {
+    const details: Record<string, unknown> = {
+      contractTarget: contract.target,
+      invalidCodecs,
+    };
+
+    throw runtimeError(
+      'RUNTIME.CODEC_MISSING',
+      `Missing codec implementations for column codecIds: ${invalidCodecs.map((c) => `${c.table}.${c.column} (${c.codecId})`).join(', ')}`,
+      details,
+    );
+  }
+}
+
+export function validateCodecRegistryCompleteness(
+  registry: CodecRegistry,
+  contract: SqlContract<SqlStorage>,
+): void {
+  validateContractCodecMappings(registry, contract);
+}

package/src/exports/index.ts

@@ -0,0 +1,38 @@
+export type {
+  AfterExecuteResult,
+  BudgetsOptions,
+  LintsOptions,
+  Log,
+  Plugin,
+  PluginContext,
+} from '@prisma-next/runtime-executor';
+export { budgets, lints } from '@prisma-next/runtime-executor';
+export {
+  extractCodecIds,
+  validateCodecRegistryCompleteness,
+  validateContractCodecMappings,
+} from '../codecs/validation';
+export { lowerSqlPlan } from '../lower-sql-plan';
+export type {
+  CreateRuntimeContextOptions,
+  RuntimeContext,
+  SqlRuntimeAdapterInstance,
+  SqlRuntimeExtensionDescriptor,
+  SqlRuntimeExtensionInstance,
+} from '../sql-context';
+export { createRuntimeContext } from '../sql-context';
+export type { SqlStatement } from '../sql-marker';
+export {
+  ensureSchemaStatement,
+  ensureTableStatement,
+  readContractMarker,
+  writeContractMarker,
+} from '../sql-marker';
+export type {
+  Runtime,
+  RuntimeOptions,
+  RuntimeTelemetryEvent,
+  RuntimeVerifyOptions,
+  TelemetryOutcome,
+} from '../sql-runtime';
+export { createRuntime } from '../sql-runtime';

package/src/index.ts

@@ -0,0 +1 @@
+export * from './exports';

package/src/lower-sql-plan.ts

@@ -0,0 +1,32 @@
+import type { ExecutionPlan } from '@prisma-next/contract/types';
+import type { SqlQueryPlan } from '@prisma-next/sql-relational-core/plan';
+import type { RuntimeContext } from './sql-context';
+
+/**
+ * Lowers a SQL query plan to an executable Plan by calling the adapter's lower method.
+ *
+ * This function is responsible for converting a lane-produced SqlQueryPlan (which contains
+ * AST and params but no SQL) into a fully executable Plan (which includes SQL string).
+ *
+ * @param context - Runtime context containing the adapter
+ * @param queryPlan - SQL query plan from a lane (contains AST, params, meta, but no SQL)
+ * @returns Fully executable Plan with SQL string
+ */
+export function lowerSqlPlan<Row>(
+  context: RuntimeContext,
+  queryPlan: SqlQueryPlan<Row>,
+): ExecutionPlan<Row> {
+  const lowered = context.adapter.lower(queryPlan.ast, {
+    contract: context.contract,
+    params: queryPlan.params,
+  });
+
+  const body = lowered.body;
+
+  return Object.freeze({
+    sql: body.sql,
+    params: body.params ?? queryPlan.params,
+    ast: queryPlan.ast,
+    meta: queryPlan.meta,
+  });
+}

package/src/sql-context.ts

@@ -0,0 +1,156 @@
+import type {
+  RuntimeAdapterDescriptor,
+  RuntimeAdapterInstance,
+  RuntimeExtensionDescriptor,
+  RuntimeExtensionInstance,
+  RuntimeTargetDescriptor,
+} from '@prisma-next/core-execution-plane/types';
+import { createOperationRegistry } from '@prisma-next/operations';
+import type { SqlContract, SqlStorage } from '@prisma-next/sql-contract/types';
+import type { SqlOperationSignature } from '@prisma-next/sql-operations';
+import type {
+  Adapter,
+  CodecRegistry,
+  LoweredStatement,
+  QueryAst,
+} from '@prisma-next/sql-relational-core/ast';
+import { createCodecRegistry } from '@prisma-next/sql-relational-core/ast';
+import type { QueryLaneContext } from '@prisma-next/sql-relational-core/query-lane-context';
+
+// ============================================================================
+// SQL Runtime Extension Types
+// ============================================================================
+
+/**
+ * SQL runtime extension instance.
+ * Extends the framework RuntimeExtensionInstance with SQL-specific hooks
+ * for contributing codecs and operations to the runtime context.
+ *
+ * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
+ */
+export interface SqlRuntimeExtensionInstance<TTargetId extends string>
+  extends RuntimeExtensionInstance<'sql', TTargetId> {
+  /** Returns codecs to register in the runtime context. */
+  codecs?(): CodecRegistry;
+  /** Returns operations to register in the runtime context. */
+  operations?(): ReadonlyArray<SqlOperationSignature>;
+}
+
+/**
+ * SQL runtime extension descriptor.
+ * Extends the framework RuntimeExtensionDescriptor with SQL-specific instance type.
+ *
+ * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
+ */
+export interface SqlRuntimeExtensionDescriptor<TTargetId extends string>
+  extends RuntimeExtensionDescriptor<'sql', TTargetId, SqlRuntimeExtensionInstance<TTargetId>> {
+  create(): SqlRuntimeExtensionInstance<TTargetId>;
+}
+
+// ============================================================================
+// SQL Runtime Adapter Instance
+// ============================================================================
+
+/**
+ * SQL runtime adapter instance interface.
+ * Combines RuntimeAdapterInstance identity with SQL Adapter behavior.
+ * The instance IS an Adapter (via intersection), not HAS an adapter property.
+ *
+ * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
+ */
+export type SqlRuntimeAdapterInstance<TTargetId extends string = string> = RuntimeAdapterInstance<
+  'sql',
+  TTargetId
+> &
+  Adapter<QueryAst, SqlContract<SqlStorage>, LoweredStatement>;
+
+// ============================================================================
+// SQL Runtime Context
+// ============================================================================
+
+export interface RuntimeContext<TContract extends SqlContract<SqlStorage> = SqlContract<SqlStorage>>
+  extends QueryLaneContext<TContract> {
+  readonly adapter:
+    | Adapter<QueryAst, TContract, LoweredStatement>
+    | Adapter<QueryAst, SqlContract<SqlStorage>, LoweredStatement>;
+}
+
+/**
+ * Descriptor-first options for creating a SQL runtime context.
+ * Takes the same framework composition as control-plane: target, adapter, extensionPacks.
+ *
+ * @template TContract - The SQL contract type
+ * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
+ */
+export interface CreateRuntimeContextOptions<
+  TContract extends SqlContract<SqlStorage> = SqlContract<SqlStorage>,
+  TTargetId extends string = string,
+> {
+  readonly contract: TContract;
+  readonly target: RuntimeTargetDescriptor<'sql', TTargetId>;
+  readonly adapter: RuntimeAdapterDescriptor<
+    'sql',
+    TTargetId,
+    SqlRuntimeAdapterInstance<TTargetId>
+  >;
+  readonly extensionPacks?: ReadonlyArray<SqlRuntimeExtensionDescriptor<TTargetId>>;
+}
+
+/**
+ * Creates a SQL runtime context from descriptor-first composition.
+ *
+ * The context includes:
+ * - The validated contract
+ * - The adapter instance (created from descriptor)
+ * - Codec registry (populated from adapter + extension instances)
+ * - Operation registry (populated from extension instances)
+ *
+ * @param options - Descriptor-first composition options
+ * @returns RuntimeContext with registries wired from all components
+ */
+export function createRuntimeContext<
+  TContract extends SqlContract<SqlStorage> = SqlContract<SqlStorage>,
+  TTargetId extends string = string,
+>(options: CreateRuntimeContextOptions<TContract, TTargetId>): RuntimeContext<TContract> {
+  const { contract, adapter: adapterDescriptor, extensionPacks } = options;
+
+  // Create adapter instance from descriptor
+  // The adapter instance IS an Adapter (via intersection)
+  const adapterInstance = adapterDescriptor.create();
+
+  // Create registries
+  const codecRegistry = createCodecRegistry();
+  const operationRegistry = createOperationRegistry();
+
+  // Register adapter codecs (adapter instance has profile.codecs())
+  const adapterCodecs = adapterInstance.profile.codecs();
+  for (const codec of adapterCodecs.values()) {
+    codecRegistry.register(codec);
+  }
+
+  // Create extension instances and register their codecs/operations
+  for (const extDescriptor of extensionPacks ?? []) {
+    const extInstance = extDescriptor.create();
+
+    const extCodecs = extInstance.codecs?.();
+    if (extCodecs) {
+      for (const codec of extCodecs.values()) {
+        codecRegistry.register(codec);
+      }
+    }
+
+    const extOperations = extInstance.operations?.();
+    if (extOperations) {
+      for (const operation of extOperations) {
+        operationRegistry.register(operation);
+      }
+    }
+  }
+
+  return {
+    contract,
+    adapter: adapterInstance,
+    operations: operationRegistry,
+    codecs: codecRegistry,
+  };
+}

package/src/sql-family-adapter.ts

@@ -0,0 +1,43 @@
+import type { ExecutionPlan } from '@prisma-next/contract/types';
+import type {
+  MarkerReader,
+  MarkerStatement,
+  RuntimeFamilyAdapter,
+} from '@prisma-next/runtime-executor';
+import { runtimeError } from '@prisma-next/runtime-executor';
+import type { SqlContract, SqlStorage } from '@prisma-next/sql-contract/types';
+import { readContractMarker } from './sql-marker';
+
+class SqlMarkerReader implements MarkerReader {
+  readMarkerStatement(): MarkerStatement {
+    return readContractMarker();
+  }
+}
+
+export class SqlFamilyAdapter<TContract extends SqlContract<SqlStorage>>
+  implements RuntimeFamilyAdapter<TContract>
+{
+  readonly contract: TContract;
+  readonly markerReader: MarkerReader;
+
+  constructor(contract: TContract) {
+    this.contract = contract;
+    this.markerReader = new SqlMarkerReader();
+  }
+
+  validatePlan(plan: ExecutionPlan, contract: TContract): void {
+    if (plan.meta.target !== contract.target) {
+      throw runtimeError('PLAN.TARGET_MISMATCH', 'Plan target does not match runtime target', {
+        planTarget: plan.meta.target,
+        runtimeTarget: contract.target,
+      });
+    }
+
+    if (plan.meta.coreHash !== contract.coreHash) {
+      throw runtimeError('PLAN.HASH_MISMATCH', 'Plan core hash does not match runtime contract', {
+        planCoreHash: plan.meta.coreHash,
+        runtimeCoreHash: contract.coreHash,
+      });
+    }
+  }
+}