@prisma-next/contract 0.3.0-pr.99.6 → 0.3.0

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

@@ -1,147 +1,39 @@
 # @prisma-next/contract
 
-Core contract types, framework component descriptors, and JSON schemas for Prisma Next.
+Core contract data types and JSON schemas for Prisma Next.
 
 ## Overview
 
-This package provides the foundational type definitions for Prisma Next, including:
-- **Data contracts**: The canonical description of an application's data model and storage layout
-- **Framework component descriptors**: Base interfaces for the modular component system (families, targets, adapters, drivers, extensions)
-- **JSON Schemas**: Validation schemas for contract files
-
-## Responsibilities
-
-- **Core Contract Types**: Defines framework-level contract types (`ContractBase`, `Source`, `FamilyInstance`) that are shared across all target families
-- **Framework Component Model**: Provides base descriptor interfaces (`FamilyDescriptor`, `TargetDescriptor`, `AdapterDescriptor`, `DriverDescriptor`, `ExtensionDescriptor`) and identity instance bases (`FamilyInstance`, `TargetInstance`, `AdapterInstance`, `DriverInstance`, `ExtensionInstance`) that plane-specific types extend
-- **Document Family Types**: Provides TypeScript types for document target family contracts (`DocumentContract`)
-- **JSON Schema Validation**: Provides JSON Schemas for validating contract structure in IDEs and tooling
-- **Type Guards**: Provides runtime type guards for narrowing contract types (`isDocumentContract`)
-- **Emitter Types**: Defines emitter SPI types (`TargetFamilyHook`, `ValidationContext`, `TypesImportSpec`) that are shared between emitter and control plane
-
-The contract supports document target families:
-- **Document**: For document databases (MongoDB, Firestore, etc.)
+This package provides the foundational type definitions for Prisma Next data contracts:
 
-## Package Contents
+- **Contract data types**: The canonical description of an application's data model and storage layout (`ContractBase`, `DocumentContract`, `Source`, `FieldType`)
+- **Plan types**: Target-family-agnostic execution plan types (`ExecutionPlan`, `PlanMeta`, `ParamDescriptor`)
+- **Hash types**: Branded hash types for storage, execution, and profile hashing (`StorageHashBase`, `ExecutionHashBase`, `ProfileHashBase`)
+- **JSON Schemas**: Validation schemas for contract files
+- **Type guards**: Runtime type guards for narrowing contract types (`isDocumentContract`)
 
-- **TypeScript Types**: Type definitions for `DocumentContract`, `ContractMarkerRecord`, and related types
-- **Emitter Types**: SPI types for emitter hooks (`TargetFamilyHook`, `ValidationContext`, `TypesImportSpec`)
-- **JSON Schemas**: Schema definitions for validating `contract.json` files in IDEs and tooling
-  - `data-contract-document-v1.json` (Document family)
+This package is a **foundation-layer leaf** — it has no framework-domain dependencies and is consumed by all layers above it.
 
 ## Usage
 
-### TypeScript Types
-
-Import contract types in your TypeScript code:
-
 ```typescript
 import type {
+  Contract,
   ContractMarkerRecord,
   DocumentContract,
-  TargetFamilyHook,
-  TypesImportSpec,
-  ValidationContext,
+  ExecutionPlan,
+  PlanMeta,
 } from '@prisma-next/contract/types';
-import { isDocumentContract } from '@prisma-next/contract/types';
-
-// Use type guards to narrow the contract type
-function processContract(contract: DocumentContract) {
-  if (isDocumentContract(contract)) {
-    // contract is DocumentContract
-    console.log(contract.storage.document.collections);
-  }
-}
-
-// Use ContractMarkerRecord for database marker operations
-function processMarker(marker: ContractMarkerRecord) {
-  console.log(marker.coreHash, marker.profileHash);
-}
-
-// Use emitter types for implementing family hooks
-const myFamilyHook: TargetFamilyHook = {
-  id: 'my-family',
-  validateTypes: (ir, ctx: ValidationContext) => {
-    // Validation logic
-  },
-  validateStructure: (ir) => {
-    // Structure validation
-  },
-  generateContractTypes: (ir, codecTypeImports: TypesImportSpec[], operationTypeImports: TypesImportSpec[]) => {
-    // Type generation
-    return '// Generated types...';
-  },
-};
-```
-
-### Framework Component Model
-
-Import base descriptor and instance interfaces to define or type-check framework components:
+import { isDocumentContract, coreHash, profileHash } from '@prisma-next/contract/types';
 
-```typescript
-import type {
-  // Descriptors
-  ComponentDescriptor,
-  FamilyDescriptor,
-  TargetDescriptor,
-  AdapterDescriptor,
-  DriverDescriptor,
-  ExtensionDescriptor,
-  // Instances
-  FamilyInstance,
-  TargetInstance,
-  AdapterInstance,
-  DriverInstance,
-  ExtensionInstance,
-} from '@prisma-next/contract/framework-components';
-
-// Component descriptors share common properties
-interface MyDescriptor extends ComponentDescriptor<'custom'> {
-  readonly customField: string;
-}
-
-// Use FamilyDescriptor for family components
-const sqlFamily: FamilyDescriptor<'sql'> = {
-  kind: 'family',
-  id: 'sql',
-  familyId: 'sql',
-  version: '0.0.1',
-};
-
-// Use TargetDescriptor for target components
-const postgresTarget: TargetDescriptor<'sql', 'postgres'> = {
-  kind: 'target',
-  id: 'postgres',
-  familyId: 'sql',
-  targetId: 'postgres',
-  version: '0.0.1',
-  capabilities: { postgres: { returning: true } },
-};
-
-// Identity instance bases are extended by plane-specific instances
-interface MySqlInstance extends FamilyInstance<'sql'> {
-  // Plane-specific methods...
+if (isDocumentContract(contract)) {
+  const collections = contract.storage.document.collections;
 }
 ```
 
-The component hierarchy is:
-
-```
-Family (e.g., 'sql', 'document')
-  └── Target (e.g., 'postgres', 'mysql', 'mongodb')
-        ├── Adapter (protocol/dialect implementation)
-        ├── Driver (connection/execution layer)
-        └── Extension (optional capabilities like pgvector)
-```
-
-Plane-specific descriptors (`ControlFamilyDescriptor`, `RuntimeTargetDescriptor`, etc.) extend these bases with plane-specific factory methods and capabilities.
-
 ### JSON Schema Validation
 
-Reference the appropriate JSON schema in your `contract.json` files to enable IDE validation and autocomplete.
-
-#### Document Family
-
-For document targets (MongoDB, Firestore, etc.):
+Reference the appropriate JSON schema in your `contract.json` files to enable IDE validation:
 
 ```json
 {
@@ -149,154 +41,51 @@ For document targets (MongoDB, Firestore, etc.):
   "schemaVersion": "1",
   "target": "mongodb",
   "targetFamily": "document",
-  "coreHash": "sha256:...",
-  "storage": {
-    "document": {
-      "collections": {
-        "users": {
-          "name": "users",
-          "fields": {
-            "id": { "type": "objectId", "nullable": false },
-            "email": { "type": "string", "nullable": false }
-          }
-        }
-      }
-    }
-  }
-}
-```
-
-**Note:** For SQL contracts, use `@prisma-next/sql-query/schema-sql` instead:
-
-```json
-{
-  "$schema": "node_modules/@prisma-next/sql-query/schemas/data-contract-sql-v1.json",
-  "schemaVersion": "1",
-  "target": "postgres",
-  "targetFamily": "sql",
-  "coreHash": "sha256:...",
-  "storage": {
-    "tables": {
-      "user": {
-        "columns": {
-          "id": { "type": "int4", "nullable": false },
-          "email": { "type": "text", "nullable": false }
-        },
-        "primaryKey": {
-          "columns": ["id"],
-          "name": "user_pkey"
-        }
-      }
-    }
-  }
+  "storageHash": "sha256:..."
 }
 ```
 
-After installing this package, IDEs like VS Code will automatically:
-- Validate your contract structure
-- Provide autocomplete for properties
-- Show descriptions and constraints in tooltips
-- Highlight errors for invalid configurations
+For SQL contracts, use `@prisma-next/sql-contract-ts/schema-sql` instead.
 
-## Schema Reference
-
-### Common Header Fields
-
-All contracts share these common fields:
-
-- **`schemaVersion`** (required): Contract schema version (currently `"1"`)
-- **`target`** (required): Database target identifier (e.g., `"postgres"`, `"mongo"`, `"firestore"`)
-- **`targetFamily`** (required): Target family classification (`"document"` for document contracts)
-- **`coreHash`** (required): SHA-256 hash of the core schema structure
-- **`profileHash`** (optional): SHA-256 hash of the capability profile
-- **`capabilities`** (optional): Capability flags declared by the contract
-- **`extensionPacks`** (optional): Extension packs and their configuration
-- **`meta`** (optional): Non-semantic metadata (excluded from hashing)
-- **`sources`** (optional): Read-only sources (views, etc.) available for querying
-
-### Document Family Structure
+## Exports
 
-- **`storage.document.collections`**: Object mapping collection names to collection definitions
-  - Each collection includes:
-    - **`name`**: Logical collection name
-    - **`id`** (optional): ID generation strategy (`auto`, `client`, `uuid`, `cuid`, `objectId`)
-    - **`fields`**: Field definitions using `FieldType` (supports nested objects and arrays)
-    - **`indexes`** (optional): Array of index definitions with keys and optional predicates
-    - **`readOnly`** (optional): Whether mutations are disallowed
+- `./types`: Contract data types, hash types, plan types, type guards
+- `./hashing`: Contract hashing utilities
+- `./testing`: Test helpers for creating contract fixtures
+- `./validate-contract`: Contract structure validation
+- `./validate-domain`: Domain model validation
 
 ## Type System
 
-### Type Guards
-
-Use type guards to narrow the contract type:
-
-```typescript
-import { isDocumentContract } from '@prisma-next/contract/types';
+### Plan Types
 
-if (isDocumentContract(contract)) {
-  // TypeScript knows contract is DocumentContract
-  const collections = contract.storage.document.collections;
-}
-```
+`ParamDescriptor` describes a single parameter in an execution plan:
 
-## Exports
+- **`source`**: Origin of the parameter (`'dsl'`, `'raw'`, or `'lane'`)
+- **`index`** (optional): 1-based position into `plan.params`
+- **`name`** (optional): Parameter name for codec resolution
+- **`codecId`**, **`nativeType`**, **`nullable`** (optional): Type metadata from contract
+- **`refs`** (optional): `{ table, column }` when the param is used against a known column
 
-- `./types`: Core contract type definitions, type guards, and emitter SPI types
-- `./framework-components`: Framework component model (descriptors + identity instance bases)
-- `./pack-manifest-types`: Extension pack manifest types
-- `./ir`: Contract IR types
-- `./schema-document`: Document family JSON Schema (`schemas/data-contract-document-v1.json`)
+### Column Defaults
 
-## Architecture
+- When adding column defaults, re-emit the contract and verify the emitted JSON includes the full default payload.
+- Keep `nullable: false` explicit for columns with defaults in emitted contracts.
+- Add the corresponding `defaults.*` capability when using function defaults like `autoincrement()` or `now()`.
 
-```mermaid
-flowchart TD
-    subgraph "Contract Package"
-        TYPES[Type Definitions]
-        SCHEMA[JSON Schemas]
-        GUARDS[Type Guards]
-    end
+## Dependencies
 
-    subgraph "Consumers"
-        EMITTER[Emitter]
-        RUNTIME[Runtime]
-        QUERY[Query Builder]
-    end
-
-    TYPES --> EMITTER
-    TYPES --> RUNTIME
-    TYPES --> QUERY
-    SCHEMA --> EMITTER
-    GUARDS --> RUNTIME
-    GUARDS --> QUERY
-```
+- **`@prisma-next/utils`**: Shared utility functions
 
 ## Related Subsystems
 
-- **[Data Contract](../../docs/architecture%20docs/subsystems/1.%20Data%20Contract.md)**: Detailed subsystem specification
-- **[Contract Emitter & Types](../../docs/architecture%20docs/subsystems/2.%20Contract%20Emitter%20&%20Types.md)**: Contract emission
+- [Data Contract](../../../../../docs/architecture%20docs/subsystems/1.%20Data%20Contract.md)
+- [Contract Emitter & Types](../../../../../docs/architecture%20docs/subsystems/2.%20Contract%20Emitter%20&%20Types.md)
 
 ## Related ADRs
 
-- [ADR 001 - Migrations as Edges](../../docs/architecture%20docs/adrs/ADR%20001%20-%20Migrations%20as%20Edges.md)
-- [ADR 004 - Core Hash vs Profile Hash](../../docs/architecture%20docs/adrs/ADR%20004%20-%20Core%20Hash%20vs%20Profile%20Hash.md)
-- [ADR 006 - Dual Authoring Modes](../../docs/architecture%20docs/adrs/ADR%20006%20-%20Dual%20Authoring%20Modes.md)
-- [ADR 010 - Canonicalization Rules](../../docs/architecture%20docs/adrs/ADR%20010%20-%20Canonicalization%20Rules.md)
-- [ADR 021 - Contract Marker Storage](../../docs/architecture%20docs/adrs/ADR%20021%20-%20Contract%20Marker%20Storage.md)
-
-## Dependencies
-
-- **`@prisma-next/operations`**: For `OperationRegistry` type used in `ValidationContext` and `TargetFamilyHook`
-- **Note**: This package depends on `@prisma-next/operations`, but `@prisma-next/operations` does not depend on this package (no cycle). The `OperationRegistry` type is used in emitter SPI types that are shared between migration-plane and shared-plane packages.
-
-**Dependents:**
-- **`@prisma-next/contract-authoring`**: Uses core contract types for authoring
-- **`@prisma-next/sql-contract`**: Extends core contract types for SQL family
-- **`@prisma-next/emitter`**: Uses contract types for emission
-- **`@prisma-next/runtime`**: Uses contract types for runtime execution
-- **`@prisma-next/sql-query`**: Uses contract types for query building
-
-## Related Packages
-
-- `@prisma-next/sql-query`: SQL query builder and plan types
-- `@prisma-next/runtime`: Runtime execution engine that consumes contracts
+- [ADR 001 - Migrations as Edges](../../../../../docs/architecture%20docs/adrs/ADR%20001%20-%20Migrations%20as%20Edges.md)
+- [ADR 004 - Storage Hash vs Profile Hash](../../../../../docs/architecture%20docs/adrs/ADR%20004%20-%20Storage%20Hash%20vs%20Profile%20Hash.md)
+- [ADR 010 - Canonicalization Rules](../../../../../docs/architecture%20docs/adrs/ADR%20010%20-%20Canonicalization%20Rules.md)
+- [ADR 021 - Contract Marker Storage](../../../../../docs/architecture%20docs/adrs/ADR%20021%20-%20Contract%20Marker%20Storage.md)
+- [ADR 185 - SPI types live at the lowest consuming layer](../../../../../docs/architecture%20docs/adrs/ADR%20185%20-%20SPI%20types%20live%20at%20the%20lowest%20consuming%20layer.md)