@prisma-next/cli 0.2.0 → 0.3.0-pr.72.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +82 -55
- package/dist/{chunk-C7QQMZ3I.js → chunk-ZKYEJROM.js} +1 -1
- package/dist/{chunk-C7QQMZ3I.js.map → chunk-ZKYEJROM.js.map} +1 -1
- package/dist/cli.js.map +1 -1
- package/dist/commands/db-init.js +1 -1
- package/dist/commands/db-introspect.js +1 -1
- package/dist/commands/db-schema-verify.js +1 -1
- package/dist/commands/db-sign.js +1 -1
- package/dist/commands/db-verify.js +1 -1
- package/package.json +11 -11
package/README.md
CHANGED
|
@@ -23,6 +23,20 @@ Provide a command-line interface that:
|
|
|
23
23
|
- **Help Output Formatting**: Custom styled help output with command trees and formatted descriptions
|
|
24
24
|
- **Config Management**: Load and validate `prisma-next.config.ts` files using Arktype validation
|
|
25
25
|
|
|
26
|
+
### Wiring validation
|
|
27
|
+
|
|
28
|
+
The CLI performs **wiring validation** at the composition boundary: it ensures the emitted contract artifacts are compatible with the descriptors wired in `prisma-next.config.ts`.
|
|
29
|
+
|
|
30
|
+
This prevents runtime mismatches (for example: a contract that declares extension packs, but a config that doesn’t provide the matching descriptors).
|
|
31
|
+
|
|
32
|
+
Commands that enforce wiring validation:
|
|
33
|
+
- **`db verify`**
|
|
34
|
+
- **`db introspect`** (when a contract is provided)
|
|
35
|
+
- **`db sign`**
|
|
36
|
+
- **`db init`**
|
|
37
|
+
|
|
38
|
+
If you hit a wiring validation error: add the required descriptors to `config.extensionPacks` (matched by descriptor `id`) and re-run the command.
|
|
39
|
+
|
|
26
40
|
**Note**: Control plane domain actions (database verification, contract emission) are implemented in `@prisma-next/core-control-plane`. The CLI uses the control plane domain actions programmatically but does not define control plane types itself.
|
|
27
41
|
|
|
28
42
|
## Command Descriptions
|
|
@@ -102,7 +116,7 @@ prisma-next db verify [--db <url>] [--config <path>] [--json] [-v] [-q] [--times
|
|
|
102
116
|
```
|
|
103
117
|
|
|
104
118
|
Options:
|
|
105
|
-
- `--db <url>`: Database connection string (optional
|
|
119
|
+
- `--db <url>`: Database connection string (optional; defaults to `config.db.url` if set)
|
|
106
120
|
- `--config <path>`: Optional. Path to `prisma-next.config.ts` (defaults to `./prisma-next.config.ts` if present)
|
|
107
121
|
- `--json`: Output as JSON object
|
|
108
122
|
- `-q, --quiet`: Quiet mode (errors only)
|
|
@@ -159,7 +173,7 @@ export default defineConfig({
|
|
|
159
173
|
|
|
160
174
|
1. **Load Contract**: Reads the emitted `contract.json` from `config.contract.output`
|
|
161
175
|
2. **Connect to Database**: Uses `config.driver.create(url)` to create a driver
|
|
162
|
-
3. **Create Family Instance**: Calls `config.family.create()` with target, adapter, driver, and extensions to create a family instance
|
|
176
|
+
3. **Create Family Instance**: Calls `config.family.create()` with target, adapter, driver, and `extensionPacks` (passed as `extensions`) to create a family instance
|
|
163
177
|
4. **Verify**: Calls `familyInstance.verify()` which:
|
|
164
178
|
- Reads the contract marker from the database
|
|
165
179
|
- Compares marker presence: Returns `PN-RTM-3001` if marker is missing
|
|
@@ -256,7 +270,7 @@ prisma-next db introspect [--db <url>] [--config <path>] [--json] [-v] [-q] [--t
|
|
|
256
270
|
```
|
|
257
271
|
|
|
258
272
|
Options:
|
|
259
|
-
- `--db <url>`: Database connection string (optional
|
|
273
|
+
- `--db <url>`: Database connection string (optional; defaults to `config.db.url` if set)
|
|
260
274
|
- `--config <path>`: Optional. Path to `prisma-next.config.ts` (defaults to `./prisma-next.config.ts` if present)
|
|
261
275
|
- `--json`: Output as JSON object
|
|
262
276
|
- `-q, --quiet`: Quiet mode (errors only)
|
|
@@ -306,7 +320,7 @@ export default defineConfig({
|
|
|
306
320
|
**Introspection Process:**
|
|
307
321
|
|
|
308
322
|
1. **Connect to Database**: Uses `config.driver.create(url)` to create a driver
|
|
309
|
-
2. **Create Family Instance**: Calls `config.family.create()` with target, adapter, driver, and extensions to create a family instance
|
|
323
|
+
2. **Create Family Instance**: Calls `config.family.create()` with target, adapter, driver, and `extensionPacks` (passed as `extensions`) to create a family instance
|
|
310
324
|
3. **Introspect**: Calls `familyInstance.introspect()` which:
|
|
311
325
|
- Queries the database catalog to discover schema structure
|
|
312
326
|
- Returns a family-specific schema IR (e.g., `SqlSchemaIR` for SQL family)
|
|
@@ -373,7 +387,7 @@ sql schema (tables: 2)
|
|
|
373
387
|
|
|
374
388
|
**Error Codes:**
|
|
375
389
|
- `PN-CLI-4010`: Missing driver in config — provide a driver descriptor
|
|
376
|
-
- `PN-CLI-
|
|
390
|
+
- `PN-CLI-4005`: Missing database URL — provide `--db <url>` or set `db.url` in config
|
|
377
391
|
|
|
378
392
|
**Family Requirements:**
|
|
379
393
|
|
|
@@ -407,7 +421,7 @@ prisma-next db sign [--db <url>] [--config <path>] [--json] [-v] [-q] [--timesta
|
|
|
407
421
|
```
|
|
408
422
|
|
|
409
423
|
Options:
|
|
410
|
-
- `--db <url>`: Database connection string (optional
|
|
424
|
+
- `--db <url>`: Database connection string (optional; defaults to `config.db.url` if set)
|
|
411
425
|
- `--config <path>`: Optional. Path to `prisma-next.config.ts` (defaults to `./prisma-next.config.ts` if present)
|
|
412
426
|
- `--json`: Output as JSON object
|
|
413
427
|
- `-q, --quiet`: Quiet mode (errors only)
|
|
@@ -464,7 +478,7 @@ export default defineConfig({
|
|
|
464
478
|
|
|
465
479
|
1. **Load Contract**: Reads the emitted `contract.json` from `config.contract.output`
|
|
466
480
|
2. **Connect to Database**: Uses `config.driver.create(url)` to create a driver
|
|
467
|
-
3. **Create Family Instance**: Calls `config.family.create()` with target, adapter, driver, and extensions to create a family instance
|
|
481
|
+
3. **Create Family Instance**: Calls `config.family.create()` with target, adapter, driver, and `extensionPacks` (passed as `extensions`) to create a family instance
|
|
468
482
|
4. **Schema Verification (Precondition)**: Calls `familyInstance.schemaVerify()` to verify the database schema matches the contract:
|
|
469
483
|
- If verification fails: Prints schema verification output and exits with code 1 (marker is not written)
|
|
470
484
|
- If verification passes: Proceeds to marker signing
|
|
@@ -570,7 +584,7 @@ For updated markers:
|
|
|
570
584
|
|
|
571
585
|
**Error Codes:**
|
|
572
586
|
- `PN-CLI-4010`: Missing driver in config — provide a driver descriptor
|
|
573
|
-
- `PN-CLI-
|
|
587
|
+
- `PN-CLI-4005`: Missing database URL — provide `--db <url>` or set `db.url` in config
|
|
574
588
|
- Exit code 1: Schema verification failed — database schema does not match contract (marker is not written)
|
|
575
589
|
|
|
576
590
|
**Relationship to Other Commands:**
|
|
@@ -609,7 +623,7 @@ The SQL family provides this via `@prisma-next/family-sql/control`. The `sign()`
|
|
|
609
623
|
|
|
610
624
|
### `prisma-next db init`
|
|
611
625
|
|
|
612
|
-
Initialize a database schema from the contract. This command
|
|
626
|
+
Initialize a database schema from the contract. This command plans and applies **additive-only** operations (create missing tables/columns/constraints/indexes) until the database satisfies the contract, then writes the contract marker.
|
|
613
627
|
|
|
614
628
|
**Command:**
|
|
615
629
|
```bash
|
|
@@ -617,10 +631,10 @@ prisma-next db init [--db <url>] [--config <path>] [--plan] [--json] [-v] [-q] [
|
|
|
617
631
|
```
|
|
618
632
|
|
|
619
633
|
Options:
|
|
620
|
-
- `--db <url>`: Database connection string (optional
|
|
634
|
+
- `--db <url>`: Database connection string (optional; defaults to `config.db.url` if set)
|
|
621
635
|
- `--config <path>`: Optional. Path to `prisma-next.config.ts` (defaults to `./prisma-next.config.ts` if present)
|
|
622
636
|
- `--plan`: Only show the migration plan, do not apply it
|
|
623
|
-
- `--json`: Output as JSON object
|
|
637
|
+
- `--json [format]`: Output as JSON (`object` only; `ndjson` is not supported for this command)
|
|
624
638
|
- `-q, --quiet`: Quiet mode (errors only)
|
|
625
639
|
- `-v, --verbose`: Verbose output (debug info, timings)
|
|
626
640
|
- `-vv, --trace`: Trace output (deep internals, stack traces)
|
|
@@ -675,51 +689,56 @@ export default defineConfig({
|
|
|
675
689
|
|
|
676
690
|
1. **Load Contract**: Reads the emitted `contract.json` from `config.contract.output`
|
|
677
691
|
2. **Connect to Database**: Uses `config.driver.create(url)` to create a driver
|
|
678
|
-
3. **Create Family Instance**: Calls `config.family.create()` with target, adapter, driver, and extensions
|
|
692
|
+
3. **Create Family Instance**: Calls `config.family.create()` with target, adapter, driver, and `extensionPacks` (passed as `extensions`)
|
|
679
693
|
4. **Introspect Schema**: Calls `familyInstance.introspect()` to get the current database schema IR
|
|
680
|
-
5. **
|
|
681
|
-
|
|
694
|
+
5. **Validate wiring**: Ensures the contract is compatible with the CLI config:
|
|
695
|
+
- `contract.targetFamily` matches `config.family.familyId`
|
|
696
|
+
- `contract.target` matches `config.target.targetId`
|
|
697
|
+
- `contract.extensionPacks` (if present) are provided by `config.extensionPacks` (matched by descriptor `id`)
|
|
698
|
+
6. **Create Planner/Runner**: Uses `config.target.migrations.createPlanner()` and `config.target.migrations.createRunner()`
|
|
699
|
+
7. **Plan Migration**: Calls `planner.plan()` with the contract IR, schema IR, additive-only policy, and `frameworkComponents` (the active target/adapter/extension descriptors)
|
|
682
700
|
- On conflict: Returns a structured failure with conflict list
|
|
683
701
|
- On success: Returns a migration plan with operations
|
|
684
|
-
|
|
702
|
+
8. **Apply Migration** (if not `--plan`):
|
|
685
703
|
- Calls `runner.execute()` to apply the plan
|
|
686
|
-
- Runner executes pre/post checks for each operation
|
|
687
704
|
- After execution, verifies schema matches contract
|
|
688
|
-
- Writes contract marker and ledger entry
|
|
705
|
+
- Writes contract marker (and records a ledger entry via the target runner)
|
|
689
706
|
|
|
690
707
|
**Output Format (TTY - Plan Mode):**
|
|
691
708
|
|
|
692
709
|
```
|
|
693
|
-
prisma-next db init ➜
|
|
710
|
+
prisma-next db init ➜ Bootstrap a database to match the current contract
|
|
694
711
|
config: prisma-next.config.ts
|
|
695
712
|
contract: src/prisma/contract.json
|
|
696
|
-
|
|
713
|
+
mode: plan (dry run)
|
|
714
|
+
|
|
715
|
+
✔ Planned 4 operation(s)
|
|
716
|
+
│
|
|
717
|
+
├─ Create table user [additive]
|
|
718
|
+
├─ Add unique constraint user_email_key on user [additive]
|
|
719
|
+
├─ Create index user_email_idx on user [additive]
|
|
720
|
+
└─ Add foreign key post_userId_fkey on post [additive]
|
|
697
721
|
|
|
698
|
-
|
|
699
|
-
├─ Create extension "plpgsql"
|
|
700
|
-
├─ Create table "user"
|
|
701
|
-
│ ├─ id: int4 (not null, primary key)
|
|
702
|
-
│ └─ email: text (not null)
|
|
703
|
-
└─ Create unique index "user_email_key"
|
|
722
|
+
Destination hash: sha256:abc123...
|
|
704
723
|
|
|
705
|
-
|
|
724
|
+
This is a dry run. No changes were applied.
|
|
725
|
+
Run without --plan to apply changes.
|
|
706
726
|
```
|
|
707
727
|
|
|
708
728
|
**Output Format (TTY - Apply Mode):**
|
|
709
729
|
|
|
710
730
|
```
|
|
711
|
-
prisma-next db init ➜
|
|
731
|
+
prisma-next db init ➜ Bootstrap a database to match the current contract
|
|
712
732
|
config: prisma-next.config.ts
|
|
713
733
|
contract: src/prisma/contract.json
|
|
714
|
-
database: localhost:5432/mydb
|
|
715
734
|
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
735
|
+
Applying migration plan and verifying schema...
|
|
736
|
+
→ Create table user...
|
|
737
|
+
→ Add unique constraint user_email_key on user...
|
|
738
|
+
→ Create index user_email_idx on user...
|
|
739
|
+
→ Add foreign key post_userId_fkey on post...
|
|
740
|
+
✔ Applied 4 operation(s)
|
|
741
|
+
Marker written: sha256:abc123...
|
|
723
742
|
```
|
|
724
743
|
|
|
725
744
|
**Output Format (JSON):**
|
|
@@ -729,33 +748,41 @@ prisma-next db init ➜ Initialize database schema from contract
|
|
|
729
748
|
"ok": true,
|
|
730
749
|
"mode": "apply",
|
|
731
750
|
"plan": {
|
|
732
|
-
"
|
|
733
|
-
"
|
|
751
|
+
"targetId": "postgres",
|
|
752
|
+
"destination": {
|
|
753
|
+
"coreHash": "sha256:abc123..."
|
|
754
|
+
},
|
|
755
|
+
"operations": [
|
|
756
|
+
{
|
|
757
|
+
"id": "table.user",
|
|
758
|
+
"label": "Create table user",
|
|
759
|
+
"operationClass": "additive"
|
|
760
|
+
}
|
|
761
|
+
]
|
|
734
762
|
},
|
|
735
763
|
"execution": {
|
|
736
|
-
"
|
|
737
|
-
"
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
"ledger": {
|
|
742
|
-
"id": "ledger-entry-uuid",
|
|
743
|
-
"createdAt": "2025-01-01T00:00:00Z"
|
|
744
|
-
}
|
|
764
|
+
"operationsPlanned": 4,
|
|
765
|
+
"operationsExecuted": 4
|
|
766
|
+
},
|
|
767
|
+
"marker": {
|
|
768
|
+
"coreHash": "sha256:abc123..."
|
|
745
769
|
}
|
|
746
770
|
}
|
|
747
771
|
```
|
|
748
772
|
|
|
749
773
|
**Error Codes:**
|
|
750
|
-
- `PN-CLI-
|
|
751
|
-
- `PN-CLI-
|
|
752
|
-
- `PN-CLI-
|
|
753
|
-
- `PN-CLI-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
-
|
|
757
|
-
|
|
758
|
-
|
|
774
|
+
- `PN-CLI-4004`: Contract file not found
|
|
775
|
+
- `PN-CLI-4005`: Missing database URL
|
|
776
|
+
- `PN-CLI-4008`: Unsupported JSON format (`--json ndjson` is rejected for `db init`)
|
|
777
|
+
- `PN-CLI-4010`: Missing driver in config
|
|
778
|
+
- `PN-CLI-4020`: Migration planning failed (conflicts)
|
|
779
|
+
- `PN-CLI-4021`: Target does not support migrations
|
|
780
|
+
- `PN-RTM-3000`: Runtime error (includes marker mismatch failures)
|
|
781
|
+
|
|
782
|
+
**Behavior Notes:**
|
|
783
|
+
|
|
784
|
+
- If the database already has a marker that matches the destination contract, `db init` succeeds as a noop (0 operations planned/executed).
|
|
785
|
+
- If the database has a marker that does **not** match the destination contract, `db init` fails (including in `--plan` mode). Use `db init` for bootstrapping; use your migration workflow to reconcile existing databases.
|
|
759
786
|
|
|
760
787
|
**Config File (`prisma-next.config.ts`):**
|
|
761
788
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/utils/framework-components.ts"],"sourcesContent":["import {\n checkContractComponentRequirements,\n type TargetBoundComponentDescriptor,\n} from '@prisma-next/contract/framework-components';\nimport type { ContractIR } from '@prisma-next/contract/ir';\nimport type {\n ControlAdapterDescriptor,\n ControlExtensionDescriptor,\n ControlFamilyDescriptor,\n ControlTargetDescriptor,\n} from '@prisma-next/core-control-plane/types';\nimport { errorConfigValidation, errorContractMissingExtensionPacks } from './cli-errors';\n\n/**\n * Asserts that all framework components are compatible with the expected family and target.\n *\n * This function validates that each component in the framework components array:\n * - Has kind 'target', 'adapter', 'extension', or 'driver'\n * - Has familyId matching expectedFamilyId\n * - Has targetId matching expectedTargetId\n *\n * This validation happens at the CLI composition boundary, before passing components\n * to typed planner/runner instances. It fills the gap between runtime validation\n * (via `validateConfig()`) and compile-time type enforcement.\n *\n * @param expectedFamilyId - The expected family ID (e.g., 'sql')\n * @param expectedTargetId - The expected target ID (e.g., 'postgres')\n * @param frameworkComponents - Array of framework components to validate\n * @returns The same array typed as TargetBoundComponentDescriptor\n * @throws CliStructuredError if any component is incompatible\n *\n * @example\n * ```ts\n * const config = await loadConfig();\n * const frameworkComponents = [config.target, config.adapter, ...(config.extensionPacks ?? [])];\n *\n * // Validate and type-narrow components before passing to planner\n * const typedComponents = assertFrameworkComponentsCompatible(\n * config.family.familyId,\n * config.target.targetId,\n * frameworkComponents\n * );\n *\n * const planner = target.migrations.createPlanner(familyInstance);\n * planner.plan({ contract, schema, policy, frameworkComponents: typedComponents });\n * ```\n */\nexport function assertFrameworkComponentsCompatible<\n TFamilyId extends string,\n TTargetId extends string,\n>(\n expectedFamilyId: TFamilyId,\n expectedTargetId: TTargetId,\n frameworkComponents: ReadonlyArray<unknown>,\n): ReadonlyArray<TargetBoundComponentDescriptor<TFamilyId, TTargetId>> {\n for (let i = 0; i < frameworkComponents.length; i++) {\n const component = frameworkComponents[i];\n\n // Check that component is an object\n if (typeof component !== 'object' || component === null) {\n throw errorConfigValidation('frameworkComponents[]', {\n why: `Framework component at index ${i} must be an object`,\n });\n }\n\n const record = component as Record<string, unknown>;\n\n // Check kind\n if (!Object.hasOwn(record, 'kind')) {\n throw errorConfigValidation('frameworkComponents[].kind', {\n why: `Framework component at index ${i} must have 'kind' property`,\n });\n }\n\n const kind = record['kind'];\n if (kind !== 'target' && kind !== 'adapter' && kind !== 'extension' && kind !== 'driver') {\n throw errorConfigValidation('frameworkComponents[].kind', {\n why: `Framework component at index ${i} has invalid kind '${String(kind)}' (must be 'target', 'adapter', 'extension', or 'driver')`,\n });\n }\n\n // Check familyId\n if (!Object.hasOwn(record, 'familyId')) {\n throw errorConfigValidation('frameworkComponents[].familyId', {\n why: `Framework component at index ${i} (kind: ${String(kind)}) must have 'familyId' property`,\n });\n }\n\n const familyId = record['familyId'];\n if (familyId !== expectedFamilyId) {\n throw errorConfigValidation('frameworkComponents[].familyId', {\n why: `Framework component at index ${i} (kind: ${String(kind)}) has familyId '${String(familyId)}' but expected '${expectedFamilyId}'`,\n });\n }\n\n // Check targetId\n if (!Object.hasOwn(record, 'targetId')) {\n throw errorConfigValidation('frameworkComponents[].targetId', {\n why: `Framework component at index ${i} (kind: ${String(kind)}) must have 'targetId' property`,\n });\n }\n\n const targetId = record['targetId'];\n if (targetId !== expectedTargetId) {\n throw errorConfigValidation('frameworkComponents[].targetId', {\n why: `Framework component at index ${i} (kind: ${String(kind)}) has targetId '${String(targetId)}' but expected '${expectedTargetId}'`,\n });\n }\n }\n\n // Type assertion is safe because we've validated all components above\n return frameworkComponents as ReadonlyArray<TargetBoundComponentDescriptor<TFamilyId, TTargetId>>;\n}\n\n/**\n * Validates that a contract is compatible with the configured family, target, adapter,\n * and extension packs. Throws on family/target mismatches or missing extension packs.\n *\n * This check ensures the emitted contract matches the CLI config before running\n * commands that depend on the contract (e.g., db verify, db sign).\n *\n * @param contract - The contract IR to validate (must include targetFamily, target, extensionPacks).\n * @param family - The configured family descriptor.\n * @param target - The configured target descriptor.\n * @param adapter - The configured adapter descriptor.\n * @param extensionPacks - Optional array of extension descriptors provided by the config.\n *\n * @throws {CliStructuredError} errorConfigValidation when contract.targetFamily or contract.target\n * doesn't match the configured family/target.\n * @throws {CliStructuredError} errorContractMissingExtensionPacks when the contract requires\n * extension packs that are not provided in the config (includes all missing packs in error.meta).\n *\n * @example\n * ```ts\n * import { assertContractRequirementsSatisfied } from './framework-components';\n *\n * const config = await loadConfig();\n * const contractIR = await loadContractJson(config.contract.output);\n *\n * // Throws if contract is incompatible with config\n * assertContractRequirementsSatisfied({\n * contract: contractIR,\n * family: config.family,\n * target: config.target,\n * adapter: config.adapter,\n * extensionPacks: config.
|
|
1
|
+
{"version":3,"sources":["../src/utils/framework-components.ts"],"sourcesContent":["import {\n checkContractComponentRequirements,\n type TargetBoundComponentDescriptor,\n} from '@prisma-next/contract/framework-components';\nimport type { ContractIR } from '@prisma-next/contract/ir';\nimport type {\n ControlAdapterDescriptor,\n ControlExtensionDescriptor,\n ControlFamilyDescriptor,\n ControlTargetDescriptor,\n} from '@prisma-next/core-control-plane/types';\nimport { errorConfigValidation, errorContractMissingExtensionPacks } from './cli-errors';\n\n/**\n * Asserts that all framework components are compatible with the expected family and target.\n *\n * This function validates that each component in the framework components array:\n * - Has kind 'target', 'adapter', 'extension', or 'driver'\n * - Has familyId matching expectedFamilyId\n * - Has targetId matching expectedTargetId\n *\n * This validation happens at the CLI composition boundary, before passing components\n * to typed planner/runner instances. It fills the gap between runtime validation\n * (via `validateConfig()`) and compile-time type enforcement.\n *\n * @param expectedFamilyId - The expected family ID (e.g., 'sql')\n * @param expectedTargetId - The expected target ID (e.g., 'postgres')\n * @param frameworkComponents - Array of framework components to validate\n * @returns The same array typed as TargetBoundComponentDescriptor\n * @throws CliStructuredError if any component is incompatible\n *\n * @example\n * ```ts\n * const config = await loadConfig();\n * const frameworkComponents = [config.target, config.adapter, ...(config.extensionPacks ?? [])];\n *\n * // Validate and type-narrow components before passing to planner\n * const typedComponents = assertFrameworkComponentsCompatible(\n * config.family.familyId,\n * config.target.targetId,\n * frameworkComponents\n * );\n *\n * const planner = target.migrations.createPlanner(familyInstance);\n * planner.plan({ contract, schema, policy, frameworkComponents: typedComponents });\n * ```\n */\nexport function assertFrameworkComponentsCompatible<\n TFamilyId extends string,\n TTargetId extends string,\n>(\n expectedFamilyId: TFamilyId,\n expectedTargetId: TTargetId,\n frameworkComponents: ReadonlyArray<unknown>,\n): ReadonlyArray<TargetBoundComponentDescriptor<TFamilyId, TTargetId>> {\n for (let i = 0; i < frameworkComponents.length; i++) {\n const component = frameworkComponents[i];\n\n // Check that component is an object\n if (typeof component !== 'object' || component === null) {\n throw errorConfigValidation('frameworkComponents[]', {\n why: `Framework component at index ${i} must be an object`,\n });\n }\n\n const record = component as Record<string, unknown>;\n\n // Check kind\n if (!Object.hasOwn(record, 'kind')) {\n throw errorConfigValidation('frameworkComponents[].kind', {\n why: `Framework component at index ${i} must have 'kind' property`,\n });\n }\n\n const kind = record['kind'];\n if (kind !== 'target' && kind !== 'adapter' && kind !== 'extension' && kind !== 'driver') {\n throw errorConfigValidation('frameworkComponents[].kind', {\n why: `Framework component at index ${i} has invalid kind '${String(kind)}' (must be 'target', 'adapter', 'extension', or 'driver')`,\n });\n }\n\n // Check familyId\n if (!Object.hasOwn(record, 'familyId')) {\n throw errorConfigValidation('frameworkComponents[].familyId', {\n why: `Framework component at index ${i} (kind: ${String(kind)}) must have 'familyId' property`,\n });\n }\n\n const familyId = record['familyId'];\n if (familyId !== expectedFamilyId) {\n throw errorConfigValidation('frameworkComponents[].familyId', {\n why: `Framework component at index ${i} (kind: ${String(kind)}) has familyId '${String(familyId)}' but expected '${expectedFamilyId}'`,\n });\n }\n\n // Check targetId\n if (!Object.hasOwn(record, 'targetId')) {\n throw errorConfigValidation('frameworkComponents[].targetId', {\n why: `Framework component at index ${i} (kind: ${String(kind)}) must have 'targetId' property`,\n });\n }\n\n const targetId = record['targetId'];\n if (targetId !== expectedTargetId) {\n throw errorConfigValidation('frameworkComponents[].targetId', {\n why: `Framework component at index ${i} (kind: ${String(kind)}) has targetId '${String(targetId)}' but expected '${expectedTargetId}'`,\n });\n }\n }\n\n // Type assertion is safe because we've validated all components above\n return frameworkComponents as ReadonlyArray<TargetBoundComponentDescriptor<TFamilyId, TTargetId>>;\n}\n\n/**\n * Validates that a contract is compatible with the configured family, target, adapter,\n * and extension packs. Throws on family/target mismatches or missing extension packs.\n *\n * This check ensures the emitted contract matches the CLI config before running\n * commands that depend on the contract (e.g., db verify, db sign).\n *\n * @param contract - The contract IR to validate (must include targetFamily, target, extensionPacks).\n * @param family - The configured family descriptor.\n * @param target - The configured target descriptor.\n * @param adapter - The configured adapter descriptor.\n * @param extensionPacks - Optional array of extension descriptors provided by the config.\n *\n * @throws {CliStructuredError} errorConfigValidation when contract.targetFamily or contract.target\n * doesn't match the configured family/target.\n * @throws {CliStructuredError} errorContractMissingExtensionPacks when the contract requires\n * extension packs that are not provided in the config (includes all missing packs in error.meta).\n *\n * @example\n * ```ts\n * import { assertContractRequirementsSatisfied } from './framework-components';\n *\n * const config = await loadConfig();\n * const contractIR = await loadContractJson(config.contract.output);\n *\n * // Throws if contract is incompatible with config\n * assertContractRequirementsSatisfied({\n * contract: contractIR,\n * family: config.family,\n * target: config.target,\n * adapter: config.adapter,\n * extensionPacks: config.extensionPacks,\n * });\n * ```\n */\nexport function assertContractRequirementsSatisfied<\n TFamilyId extends string,\n TTargetId extends string,\n>({\n contract,\n family,\n target,\n adapter,\n extensionPacks,\n}: {\n readonly contract: Pick<ContractIR, 'targetFamily' | 'target' | 'extensionPacks'>;\n readonly family: ControlFamilyDescriptor<TFamilyId>;\n readonly target: ControlTargetDescriptor<TFamilyId, TTargetId>;\n readonly adapter: ControlAdapterDescriptor<TFamilyId, TTargetId>;\n readonly extensionPacks?: readonly ControlExtensionDescriptor<TFamilyId, TTargetId>[] | undefined;\n}): void {\n const providedComponentIds = new Set<string>([target.id, adapter.id]);\n for (const extension of extensionPacks ?? []) {\n providedComponentIds.add(extension.id);\n }\n\n const result = checkContractComponentRequirements({\n contract,\n expectedTargetFamily: family.familyId,\n expectedTargetId: target.targetId,\n providedComponentIds,\n });\n\n if (result.familyMismatch) {\n throw errorConfigValidation('contract.targetFamily', {\n why: `Contract was emitted for family '${result.familyMismatch.actual}' but CLI config is wired to '${result.familyMismatch.expected}'.`,\n });\n }\n\n if (result.targetMismatch) {\n throw errorConfigValidation('contract.target', {\n why: `Contract target '${result.targetMismatch.actual}' does not match CLI target '${result.targetMismatch.expected}'.`,\n });\n }\n\n if (result.missingExtensionPackIds.length > 0) {\n throw errorContractMissingExtensionPacks({\n missingExtensionPacks: result.missingExtensionPackIds,\n providedComponentIds: [...providedComponentIds],\n });\n }\n}\n"],"mappings":";;;;;;AAAA;AAAA,EACE;AAAA,OAEK;AA4CA,SAAS,oCAId,kBACA,kBACA,qBACqE;AACrE,WAAS,IAAI,GAAG,IAAI,oBAAoB,QAAQ,KAAK;AACnD,UAAM,YAAY,oBAAoB,CAAC;AAGvC,QAAI,OAAO,cAAc,YAAY,cAAc,MAAM;AACvD,YAAM,sBAAsB,yBAAyB;AAAA,QACnD,KAAK,gCAAgC,CAAC;AAAA,MACxC,CAAC;AAAA,IACH;AAEA,UAAM,SAAS;AAGf,QAAI,CAAC,OAAO,OAAO,QAAQ,MAAM,GAAG;AAClC,YAAM,sBAAsB,8BAA8B;AAAA,QACxD,KAAK,gCAAgC,CAAC;AAAA,MACxC,CAAC;AAAA,IACH;AAEA,UAAM,OAAO,OAAO,MAAM;AAC1B,QAAI,SAAS,YAAY,SAAS,aAAa,SAAS,eAAe,SAAS,UAAU;AACxF,YAAM,sBAAsB,8BAA8B;AAAA,QACxD,KAAK,gCAAgC,CAAC,sBAAsB,OAAO,IAAI,CAAC;AAAA,MAC1E,CAAC;AAAA,IACH;AAGA,QAAI,CAAC,OAAO,OAAO,QAAQ,UAAU,GAAG;AACtC,YAAM,sBAAsB,kCAAkC;AAAA,QAC5D,KAAK,gCAAgC,CAAC,WAAW,OAAO,IAAI,CAAC;AAAA,MAC/D,CAAC;AAAA,IACH;AAEA,UAAM,WAAW,OAAO,UAAU;AAClC,QAAI,aAAa,kBAAkB;AACjC,YAAM,sBAAsB,kCAAkC;AAAA,QAC5D,KAAK,gCAAgC,CAAC,WAAW,OAAO,IAAI,CAAC,mBAAmB,OAAO,QAAQ,CAAC,mBAAmB,gBAAgB;AAAA,MACrI,CAAC;AAAA,IACH;AAGA,QAAI,CAAC,OAAO,OAAO,QAAQ,UAAU,GAAG;AACtC,YAAM,sBAAsB,kCAAkC;AAAA,QAC5D,KAAK,gCAAgC,CAAC,WAAW,OAAO,IAAI,CAAC;AAAA,MAC/D,CAAC;AAAA,IACH;AAEA,UAAM,WAAW,OAAO,UAAU;AAClC,QAAI,aAAa,kBAAkB;AACjC,YAAM,sBAAsB,kCAAkC;AAAA,QAC5D,KAAK,gCAAgC,CAAC,WAAW,OAAO,IAAI,CAAC,mBAAmB,OAAO,QAAQ,CAAC,mBAAmB,gBAAgB;AAAA,MACrI,CAAC;AAAA,IACH;AAAA,EACF;AAGA,SAAO;AACT;AAqCO,SAAS,oCAGd;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,GAMS;AACP,QAAM,uBAAuB,oBAAI,IAAY,CAAC,OAAO,IAAI,QAAQ,EAAE,CAAC;AACpE,aAAW,aAAa,kBAAkB,CAAC,GAAG;AAC5C,yBAAqB,IAAI,UAAU,EAAE;AAAA,EACvC;AAEA,QAAM,SAAS,mCAAmC;AAAA,IAChD;AAAA,IACA,sBAAsB,OAAO;AAAA,IAC7B,kBAAkB,OAAO;AAAA,IACzB;AAAA,EACF,CAAC;AAED,MAAI,OAAO,gBAAgB;AACzB,UAAM,sBAAsB,yBAAyB;AAAA,MACnD,KAAK,oCAAoC,OAAO,eAAe,MAAM,iCAAiC,OAAO,eAAe,QAAQ;AAAA,IACtI,CAAC;AAAA,EACH;AAEA,MAAI,OAAO,gBAAgB;AACzB,UAAM,sBAAsB,mBAAmB;AAAA,MAC7C,KAAK,oBAAoB,OAAO,eAAe,MAAM,gCAAgC,OAAO,eAAe,QAAQ;AAAA,IACrH,CAAC;AAAA,EACH;AAEA,MAAI,OAAO,wBAAwB,SAAS,GAAG;AAC7C,UAAM,mCAAmC;AAAA,MACvC,uBAAuB,OAAO;AAAA,MAC9B,sBAAsB,CAAC,GAAG,oBAAoB;AAAA,IAChD,CAAC;AAAA,EACH;AACF;","names":[]}
|