@prisma-next/core-control-plane 0.3.0-dev.9 → 0.3.0-dev.90

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,98 +1,56 @@
 # @prisma-next/core-control-plane
 
-Control plane domain actions, config types, validation, and error factories for Prisma Next.
+Control-plane migration and emission primitives for Prisma Next.
 
 ## Overview
 
-This package provides the core domain logic for control plane operations (contract emission, database verification) without any file I/O or CLI awareness. It's part of the core layer and can be used programmatically or by the CLI layer.
+This package provides control-plane building blocks consumed by CLI/tooling and target-family packages:
 
-## Responsibilities
-
-- **Config Types**: Type definitions for Prisma Next configuration (`PrismaNextConfig`, `ControlFamilyDescriptor`, `ControlTargetDescriptor`, `ControlAdapterDescriptor`, `ControlDriverDescriptor`, `ControlExtensionDescriptor`)
-- **Config Validation**: Pure validation logic for config structure (no file I/O)
-- **Config Normalization**: `defineConfig()` function for normalizing config with defaults
-- **Domain Actions**:
-  - `verifyDatabase()`: Verifies database contract markers (accepts config object and ContractIR)
+- migration/result interfaces and control-plane component types
+- stack composition helper (`createControlPlaneStack`)
+- schema-view interfaces
+- contract emission/hash helpers
+- structured error utilities used by CLI output mapping
 
-Note: Contract emission is implemented on the SQL family instance (e.g., `familyInstance.emitContract()`), not as a core domain action.
-- **Error Factories**: Domain error factories (`CliStructuredError`, config errors, runtime errors)
-- **Pack Manifest Types**: Type definitions for extension pack manifests
-- **Migration SPI**: Generic migration planner/runner interfaces (`MigrationPlanner<TFamilyId, TTargetId>`, `MigrationRunner<TFamilyId, TTargetId>`, `TargetMigrationsCapability<TFamilyId, TTargetId, TFamilyInstance>`) that thread family/target IDs for compile-time component compatibility enforcement
-  - `MigrationRunnerFailure` includes optional `meta` for structured debugging context (e.g., schema issues, SQL state)
+## Responsibilities
 
-## Dependencies
+- **Control stack and component contracts**: stack composition and migration-facing descriptor/instance types
+- **Migration SPI**: planner/runner/capability interfaces that thread family/target IDs through control flows
+- **Emission helpers**: canonicalization/hash utilities and emit result shaping
+- **Structured errors**: CLI/runtime envelope-compatible error factories
 
-- **Depends on**:
-  - `@prisma-next/contract` - ContractIR types
-  - `@prisma-next/emitter` - TargetFamilyHook, emit function
-  - `@prisma-next/operations` - OperationRegistry
-  - `arktype` - Validation
+## Usage
 
-- **Depended on by**:
-  - `@prisma-next/cli` - CLI layer uses domain actions
+Config authoring types and validation now live in `@prisma-next/config`:
 
-## Architecture
+- `@prisma-next/config/config-types`
+- `@prisma-next/config/config-validation`
 
-```mermaid
-flowchart TD
-    subgraph "Core Layer"
-        CCP[@prisma-next/core-control-plane]
-    end
+### ControlPlaneStack
 
-    subgraph "Tooling Layer"
-        CLI[@prisma-next/cli]
-    end
+The `ControlPlaneStack` bundles component descriptors for control plane operations (creating family instances, running CLI commands, connecting to databases):
 
-    CLI -->|uses| CCP
-```
+```ts
+import { createControlPlaneStack } from '@prisma-next/core-control-plane/stack';
+import type { ControlPlaneStack } from '@prisma-next/core-control-plane/types';
 
-## Usage
-
-### Config Types and Validation
-
-```typescript
-import { defineConfig, validateConfig, type PrismaNextConfig } from '@prisma-next/core-control-plane/config-types';
-import { validateConfig } from '@prisma-next/core-control-plane/config-validation';
-
-// Define and normalize config
-const config = defineConfig({
-  family: sqlFamilyDescriptor,
-  target: postgresTargetDescriptor,
-  adapter: postgresAdapterDescriptor,
-  contract: {
-    source: contractBuilder,
-    output: 'src/prisma/contract.json',
-  },
+// Create a stack with sensible defaults
+const stack = createControlPlaneStack({
+  target: postgresTarget,
+  adapter: postgresAdapter,
+  driver: postgresDriver, // optional, defaults to undefined
+  extensionPacks: [pgvector], // optional, defaults to []
 });
 
-// Validate config structure (pure validation, no file I/O)
-validateConfig(config);
-```
-
-### Verify Database
+// Use stack for family instance creation
+const familyInstance = config.family.create(stack);
 
-```typescript
-import { verifyDatabase } from '@prisma-next/core-control-plane/verify-database';
-
-// Verify database - accepts config object and ContractIR (no file loading)
-const result = await verifyDatabase({
-  config: loadedConfig,
-  contractIR: parsedContract,
-  dbUrl: connectionString,
-  contractPath: 'src/prisma/contract.json',
-  configPath: 'prisma-next.config.ts',
-});
-
-if (result.ok) {
-  console.log('Database matches contract');
-} else {
-  console.error(`Verification failed: ${result.summary}`);
-}
+// Stack is also used internally by ControlClient and CLI commands
 ```
 
 ### Error Factories
 
-```typescript
+```ts
 import {
   errorConfigFileNotFound,
   errorMarkerMissing,
@@ -104,30 +62,6 @@ throw errorConfigFileNotFound('prisma-next.config.ts', {
 });
 ```
 
-## Migration SPI Design
-
-The migration planner/runner interfaces are generic over `TFamilyId` and `TTargetId` to enable compile-time enforcement of component compatibility:
-
-- **`MigrationPlanner<TFamilyId, TTargetId>`**: Generic planner interface that accepts `TargetBoundComponentDescriptor<TFamilyId, TTargetId>[]`
-- **`MigrationRunner<TFamilyId, TTargetId>`**: Generic runner interface that accepts `TargetBoundComponentDescriptor<TFamilyId, TTargetId>[]`
-- **`TargetMigrationsCapability<TFamilyId, TTargetId, TFamilyInstance>`**: Generic capability interface for targets that support migrations
-
-The CLI performs runtime validation at the composition boundary using `assertFrameworkComponentsCompatible()` before calling typed planner/runner instances. This validates that all components have matching `familyId` and `targetId`, then returns a typed `TargetBoundComponentDescriptor` array that satisfies the planner/runner interface requirements.
-
-```typescript
-// CLI composition boundary - runtime assertion + type narrowing
-const rawComponents = [config.target, config.adapter, ...(config.extensionPacks ?? [])];
-const frameworkComponents = assertFrameworkComponentsCompatible(
-  config.family.familyId,
-  config.target.targetId,
-  rawComponents,
-);
-
-// Now frameworkComponents is typed as TargetBoundComponentDescriptor<TFamilyId, TTargetId>[]
-const planner = target.migrations.createPlanner(sqlFamilyInstance);
-planner.plan({ contract, schema, policy, frameworkComponents });
-```
-
 ## Package Location
 
 This package is part of the **framework domain**, **core layer**, **migration plane**:
@@ -140,5 +74,3 @@ This package is part of the **framework domain**, **core layer**, **migration pl
 
 - [Package Layering](../../../../docs/architecture docs/Package-Layering.md)
 - [ADR 140 - Package Layering & Target-Family Namespacing](../../../../docs/architecture docs/adrs/ADR 140 - Package Layering & Target-Family Namespacing.md)
-
-

package/dist/constants.d.mts

@@ -0,0 +1,9 @@
+//#region src/constants.d.ts
+/**
+ * Sentinel value representing the absence of a contract (empty/new project).
+ * This is a human-readable marker, not a real SHA-256 hash.
+ */
+declare const EMPTY_CONTRACT_HASH: "sha256:empty";
+//#endregion
+export { EMPTY_CONTRACT_HASH };
+//# sourceMappingURL=constants.d.mts.map

package/dist/constants.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.mts","names":[],"sources":["../src/constants.ts"],"sourcesContent":[],"mappings":";;AAIA;;;cAAa"}

package/dist/constants.mjs

@@ -0,0 +1,10 @@
+//#region src/constants.ts
+/**
+* Sentinel value representing the absence of a contract (empty/new project).
+* This is a human-readable marker, not a real SHA-256 hash.
+*/
+const EMPTY_CONTRACT_HASH = "sha256:empty";
+
+//#endregion
+export { EMPTY_CONTRACT_HASH };
+//# sourceMappingURL=constants.mjs.map

package/dist/constants.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.mjs","names":[],"sources":["../src/constants.ts"],"sourcesContent":["/**\n * Sentinel value representing the absence of a contract (empty/new project).\n * This is a human-readable marker, not a real SHA-256 hash.\n */\nexport const EMPTY_CONTRACT_HASH = 'sha256:empty' as const;\n"],"mappings":";;;;;AAIA,MAAa,sBAAsB"}

package/dist/emission.d.mts

@@ -0,0 +1,58 @@
+import { TargetFamilyHook, TypeRenderEntry, TypesImportSpec } from "@prisma-next/contract/types";
+import { ContractIR } from "@prisma-next/contract/ir";
+import { OperationRegistry } from "@prisma-next/operations";
+
+//#region src/emission/canonicalization.d.ts
+type CanonicalContractInput = {
+  schemaVersion: string;
+  targetFamily: string;
+  target: string;
+  models: Record<string, unknown>;
+  relations: Record<string, unknown>;
+  storage: Record<string, unknown>;
+  execution?: Record<string, unknown>;
+  extensionPacks: Record<string, unknown>;
+  capabilities: Record<string, Record<string, boolean>>;
+  meta: Record<string, unknown>;
+  storageHash?: string;
+  executionHash?: string;
+  profileHash?: string;
+};
+declare function canonicalizeContract(ir: CanonicalContractInput): string;
+//#endregion
+//#region src/emission/types.d.ts
+interface EmitOptions {
+  readonly outputDir: string;
+  readonly operationRegistry?: OperationRegistry;
+  readonly codecTypeImports?: ReadonlyArray<TypesImportSpec>;
+  readonly operationTypeImports?: ReadonlyArray<TypesImportSpec>;
+  readonly extensionIds?: ReadonlyArray<string>;
+  /**
+   * Normalized parameterized type renderers, keyed by codecId.
+   * These are extracted from descriptors and normalized during assembly.
+   */
+  readonly parameterizedRenderers?: Map<string, TypeRenderEntry>;
+  /**
+   * Type imports for parameterized codecs.
+   * These are added to contract.d.ts alongside codec and operation type imports.
+   */
+  readonly parameterizedTypeImports?: ReadonlyArray<TypesImportSpec>;
+}
+interface EmitResult {
+  readonly contractJson: string;
+  readonly contractDts: string;
+  readonly storageHash: string;
+  readonly executionHash?: string;
+  readonly profileHash: string;
+}
+//#endregion
+//#region src/emission/emit.d.ts
+declare function emit(ir: ContractIR, options: EmitOptions, targetFamily: TargetFamilyHook): Promise<EmitResult>;
+//#endregion
+//#region src/emission/hashing.d.ts
+declare function computeStorageHash(contract: CanonicalContractInput): string;
+declare function computeProfileHash(contract: CanonicalContractInput): string;
+declare function computeExecutionHash(contract: CanonicalContractInput): string;
+//#endregion
+export { type EmitOptions, type EmitResult, canonicalizeContract, computeExecutionHash, computeProfileHash, computeStorageHash, emit };
+//# sourceMappingURL=emission.d.mts.map

package/dist/emission.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"emission.d.mts","names":[],"sources":["../src/emission/canonicalization.ts","../src/emission/types.ts","../src/emission/emit.ts","../src/emission/hashing.ts"],"sourcesContent":[],"mappings":";;;;;KAoBY,sBAAA;;;;UAIF;EAJE,SAAA,EAKC,MALD,CAAA,MAAA,EAAsB,OAAA,CAAA;EAIxB,OAAA,EAEC,MAFD,CAAA,MAAA,EAAA,OAAA,CAAA;EACG,SAAA,CAAA,EAEC,MAFD,CAAA,MAAA,EAAA,OAAA,CAAA;EACF,cAAA,EAEO,MAFP,CAAA,MAAA,EAAA,OAAA,CAAA;EACG,YAAA,EAEE,MAFF,CAAA,MAAA,EAEiB,MAFjB,CAAA,MAAA,EAAA,OAAA,CAAA,CAAA;EACI,IAAA,EAEV,MAFU,CAAA,MAAA,EAAA,OAAA,CAAA;EACa,WAAA,CAAA,EAAA,MAAA;EAAf,aAAA,CAAA,EAAA,MAAA;EACR,WAAA,CAAA,EAAA,MAAA;CAAM;AAkPE,iBAAA,oBAAA,CAAyB,EAAA,EAAA,sBAAsB,CAAA,EAAA,MAAA;;;UC7Q9C,WAAA;;+BAEc;EDenB,SAAA,gBAAsB,CAAA,ECdJ,aDcI,CCdU,eDcV,CAAA;EAIxB,SAAA,oBAAA,CAAA,ECjBwB,aDiBxB,CCjBsC,eDiBtC,CAAA;EACG,SAAA,YAAA,CAAA,ECjBa,aDiBb,CAAA,MAAA,CAAA;EACF;;;;EAGK,SAAA,sBAAA,CAAA,EChBoB,GDgBpB,CAAA,MAAA,EChBgC,eDgBhC,CAAA;EACR;;AAkPR;;sCC9PsC,cAAc;;AAfnC,UAkBA,UAAA,CAlBW;EAEG,SAAA,YAAA,EAAA,MAAA;EACa,SAAA,WAAA,EAAA,MAAA;EAAd,SAAA,WAAA,EAAA,MAAA;EACkB,SAAA,aAAA,CAAA,EAAA,MAAA;EAAd,SAAA,WAAA,EAAA,MAAA;;;;iBCmEZ,IAAA,KAChB,qBACK,2BACK,mBACb,QAAQ;;;iBCnEK,kBAAA,WAA6B;iBAgB7B,kBAAA,WAA6B;iBAgB7B,oBAAA,WAA+B"}