@prisma-next/sql-runtime 0.3.0-dev.6 → 0.3.0-dev.64

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2026] [Prisma Data, Inc]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -10,7 +10,7 @@ SQL runtime implementation for Prisma Next.
 
 ## Overview
 
-The SQL runtime package implements the SQL family runtime by composing `@prisma-next/runtime-executor` with SQL-specific adapters, drivers, and codecs. It provides the public runtime API for SQL-based databases.
+The SQL runtime package implements the SQL family runtime by composing `@prisma-next/runtime-executor` with SQL-specific adapters, drivers, and codecs. It provides the public runtime API for SQL-based databases, including descriptor-based static context derivation via `SqlStaticContributions` and execution-plane composition via `ExecutionStack`.
 
 ## Purpose
 
@@ -18,6 +18,8 @@ Execute SQL query Plans with deterministic verification, guardrails, and feedbac
 
 ## Responsibilities
 
+- **Execution Stack Composition**: Compose runtime descriptors into a reusable `ExecutionStack`
+- **Descriptor-Based Static Context Derivation**: Build `ExecutionContext` from `SqlStaticContributions` on descriptors without instantiation
 - **SQL Context Creation**: Create runtime contexts with SQL contracts, adapters, and codecs
 - **SQL Marker Management**: Provide SQL statements for reading/writing contract markers
 - **Codec Encoding/Decoding**: Encode parameters and decode rows using SQL codec registries
@@ -27,33 +29,41 @@ Execute SQL query Plans with deterministic verification, guardrails, and feedbac
 
 ## Dependencies
 
+- `@prisma-next/core-execution-plane` - Runtime component descriptor types
 - `@prisma-next/runtime-executor` - Target-neutral execution engine
-- `@prisma-next/sql-contract` - SQL contract types
-- `@prisma-next/sql-target` - SQL family interfaces (legacy transitional package)
+- `@prisma-next/sql-contract` - SQL contract types (via `@prisma-next/sql-contract/types`)
 - `@prisma-next/operations` - Operation registry
 
 ## Usage
 
 ```typescript
-import { createRuntime, createRuntimeContext } from '@prisma-next/sql-runtime';
-import { createPostgresAdapter } from '@prisma-next/adapter-postgres';
-import { createPostgresDriver } from '@prisma-next/driver-postgres/runtime';
+import postgresAdapter from '@prisma-next/adapter-postgres/runtime';
+import postgresDriver from '@prisma-next/driver-postgres/runtime';
+import pgvector from '@prisma-next/extension-pgvector/runtime';
+import postgresTarget from '@prisma-next/target-postgres/runtime';
+import { instantiateExecutionStack } from '@prisma-next/core-execution-plane/stack';
+import { createExecutionContext, createRuntime, createSqlExecutionStack } from '@prisma-next/sql-runtime';
 
 const contract = validateContract<Contract>(contractJson);
-const adapter = createPostgresAdapter();
-
-const context = createRuntimeContext({
-  contract,
-  adapter,
-  extensions: [pgVector()],
+const stack = createSqlExecutionStack({
+  target: postgresTarget,
+  adapter: postgresAdapter,
+  driver: postgresDriver,
+  extensionPacks: [pgvector],
 });
 
+// Static context (no instantiation needed)
+const context = createExecutionContext({ contract, stack });
+
+// Dynamic runtime
+const stackInstance = instantiateExecutionStack(stack);
+const driver = stack.driver.create({ connect: { connectionString: process.env.DATABASE_URL } });
 const runtime = createRuntime({
-  adapter,
-  driver: createPostgresDriver({ connectionString: process.env.DATABASE_URL }),
-  verify: { mode: 'onFirstUse', requireMarker: false },
+  stackInstance,
   context,
-  plugins: [budgets(), lints()],
+  driver,
+  verify: { mode: 'onFirstUse', requireMarker: false },
+  plugins: [budgets()],
 });
 
 for await (const row of runtime.execute(plan)) {
@@ -63,22 +73,123 @@ for await (const row of runtime.execute(plan)) {
 
 ## Exports
 
+### Runtime
+
 - `createRuntime` - Create a SQL runtime instance
-- `createRuntimeContext` - Create a SQL runtime context
-- `RuntimeContext`, `Extension` - Context types
-- `budgets`, `lints` - SQL-compatible plugins (re-exported from runtime-executor)
-- `readContractMarker`, `writeContractMarker` - SQL marker statements
-- `encodeParams`, `decodeRow` - Codec encoding/decoding utilities
+- `Runtime` - Runtime instance type
+- `CreateRuntimeOptions` - Options for `createRuntime`
+- `RuntimeVerifyOptions` - Verification mode configuration
+- `RuntimeTelemetryEvent`, `TelemetryOutcome` - Telemetry event types
+
+### Context
+
+- `createExecutionContext` - Create an execution context from contract + descriptors-only stack
+- `createSqlExecutionStack` - SQL-specific stack factory that preserves descriptor types
+- `ExecutionContext` - Context type for SQL operations
+- `TypeHelperRegistry` - Registry for type helper lookup
+
+### Descriptors & Stack
+
+- `SqlStaticContributions` - Interface for descriptor-level static contributions (codecs, operations, parameterized codecs)
+- `SqlRuntimeTargetDescriptor`, `SqlRuntimeAdapterDescriptor`, `SqlRuntimeExtensionDescriptor` - Structural descriptor types requiring `SqlStaticContributions`
+- `SqlRuntimeAdapterInstance`, `SqlRuntimeDriverInstance`, `SqlRuntimeExtensionInstance` - Instance types
+- `SqlExecutionStack` - Descriptors-only stack type for static context creation
+- `SqlExecutionStackWithDriver` - Descriptor stack including driver for runtime instantiation
+- `RuntimeParameterizedCodecDescriptor` - Parameterized codec descriptor type
+
+### Codecs
+
 - `validateCodecRegistryCompleteness` - Codec validation
+- `extractCodecIds` - Extract codec IDs from a contract
+- `validateContractCodecMappings` - Validate contract codec mappings against registry
+
+### SQL Marker
+
+- `readContractMarker`, `writeContractMarker` - SQL marker statements
+- `ensureSchemaStatement`, `ensureTableStatement` - DDL statements for marker table setup
+- `SqlStatement` - SQL statement type
+
+### Plan Lowering
+
+- `lowerSqlPlan` - SQL plan lowering via adapter
+
+### Plugins
+
+- `budgets` - Re-exported from `@prisma-next/runtime-executor` (target-neutral)
+- `lints` - **AST-first lint plugin** (canonical in SQL domain), inspects `plan.ast` when present
+- `BudgetsOptions`, `LintsOptions` - Plugin option types
+- `Plugin`, `PluginContext` - Plugin interface types (from runtime-executor)
+- `AfterExecuteResult` - Plugin hook result type
+- `Log` - Log entry type
+
+#### Lints plugin (SQL domain)
+
+The `lints` plugin operates on `plan.ast` when it is a SQL `QueryAst`:
+
+- **DELETE without WHERE** — blocks execution (configurable severity)
+- **UPDATE without WHERE** — blocks execution (configurable severity)
+- **Unbounded SELECT** — warns/errors when `limit` is missing
+- **SELECT \* intent** — warns/errors when `selectAllIntent` is present
+
+When `plan.ast` is missing, the plugin falls back to raw heuristic guardrails (`fallbackWhenAstMissing: 'raw'`) or skips linting (`fallbackWhenAstMissing: 'skip'`). Default is `'raw'`.
+
+```typescript
+import { createRuntime, lints } from '@prisma-next/sql-runtime';
+
+const runtime = createRuntime({
+  // ...
+  plugins: [lints({ severities: { noLimit: 'error' } })],
+});
+```
 
 ## Architecture
 
-The SQL runtime composes runtime-executor with SQL-specific implementations:
+The SQL runtime composes runtime-executor with SQL-specific implementations. Descriptors implement `SqlStaticContributions` so `ExecutionContext` can be derived from the descriptors-only stack without instantiation.
+
+1. **ExecutionStack**: Descriptors-only stack (from `@prisma-next/core-execution-plane`)
+2. **SqlStaticContributions**: Codecs, operation signatures, and parameterized codecs contributed by each descriptor
+3. **ExecutionContext**: Built from contract + stack descriptors (no instantiation)
+4. **ExecutionStackInstance**: Instantiated components used at runtime for execution
+5. **SqlRuntime**: Wraps `RuntimeCore` and adds SQL-specific encoding/decoding
+6. **SqlMarker**: Provides SQL statements for marker management
+
+```mermaid
+flowchart LR
+  Stack[ExecutionStack] --> Context[ExecutionContext]
+  Stack --> StackI[ExecutionStackInstance]
+  Stack --> DriverDesc[Driver Descriptor]
+  Stack --> AdapterDesc[Adapter Descriptor]
+  Stack --> Packs[Extension Packs]
+  Context --> Runtime[SqlRuntime]
+  Runtime --> Core[RuntimeCore]
+  DriverDesc --> DriverInst[Driver Instance]
+  AdapterDesc --> AdapterInst[Adapter Instance]
+  Runtime --> DriverInst
+```
+
+## Related Subsystems
+
+- **[Query Lanes](../../../../docs/architecture%20docs/subsystems/3.%20Query%20Lanes.md)** — Lane authoring and plan building
+- **[Runtime & Plugin Framework](../../../../docs/architecture%20docs/subsystems/4.%20Runtime%20&%20Plugin%20Framework.md)** — Runtime execution pipeline
+- **[Adapters & Targets](../../../../docs/architecture%20docs/subsystems/5.%20Adapters%20&%20Targets.md)** — Adapter and driver responsibilities
+
+## Related ADRs
+
+- [ADR 152 - Execution Plane Descriptors and Instances](../../../../docs/architecture%20docs/adrs/ADR%20152%20-%20Execution%20Plane%20Descriptors%20and%20Instances.md)
+
+## Error Codes
+
+The SQL runtime uses stable error codes for programmatic error handling:
+
+- `RUNTIME.CONTRACT_FAMILY_MISMATCH` — Contract target family differs from runtime family
+- `RUNTIME.CONTRACT_TARGET_MISMATCH` — Contract target differs from stack target descriptor
+- `RUNTIME.MISSING_EXTENSION_PACK` — Contract requires an extension pack not provided in stack
+- `RUNTIME.DUPLICATE_PARAMETERIZED_CODEC` — Multiple extensions registered same parameterized codec
+- `RUNTIME.TYPE_PARAMS_INVALID` — Type parameters fail codec schema validation
+- `RUNTIME.CODEC_MISSING` — Required codec not found in registry
+- `RUNTIME.DECODE_FAILED` — Row decoding failed
 
-1. **SqlFamilyAdapter**: Implements `RuntimeFamilyAdapter` for SQL contracts
-2. **SqlRuntime**: Wraps `RuntimeCore` and adds SQL-specific encoding/decoding
-3. **SqlContext**: Creates contexts with SQL contracts, adapters, and codecs
-4. **SqlMarker**: Provides SQL statements for marker management
+All errors follow the repo's error envelope convention with `code`, `category`, `severity`, and optional `details`.
 
 ## Testing