@prisma-next/emitter 0.3.0-pr.99.6 → 0.4.0-dev.1
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/LICENSE +201 -0
- package/README.md +45 -35
- package/dist/domain-type-generation.d.mts +38 -0
- package/dist/domain-type-generation.d.mts.map +1 -0
- package/dist/domain-type-generation.mjs +255 -0
- package/dist/domain-type-generation.mjs.map +1 -0
- package/dist/exports/index.d.mts +39 -0
- package/dist/exports/index.d.mts.map +1 -0
- package/dist/exports/index.mjs +106 -0
- package/dist/exports/index.mjs.map +1 -0
- package/dist/test/utils.d.mts +21 -0
- package/dist/test/utils.d.mts.map +1 -0
- package/dist/test/utils.mjs +18 -0
- package/dist/test/utils.mjs.map +1 -0
- package/dist/type-expression-safety-7_1tfJXA.mjs +8 -0
- package/dist/type-expression-safety-7_1tfJXA.mjs.map +1 -0
- package/dist/type-expression-safety.d.mts +5 -0
- package/dist/type-expression-safety.d.mts.map +1 -0
- package/dist/type-expression-safety.mjs +3 -0
- package/package.json +28 -12
- package/src/domain-type-generation.ts +429 -0
- package/src/emit-types.ts +23 -0
- package/src/emit.ts +68 -0
- package/src/exports/index.ts +14 -9
- package/src/generate-contract-dts.ts +117 -0
- package/src/type-expression-safety.ts +3 -0
- package/test/canonicalization.test.ts +196 -19
- package/test/domain-type-generation.test.ts +997 -0
- package/test/emitter.integration.test.ts +132 -187
- package/test/emitter.roundtrip.test.ts +117 -191
- package/test/emitter.test.ts +123 -494
- package/test/hashing.test.ts +9 -34
- package/test/mock-spi.ts +18 -0
- package/test/type-expression-safety.test.ts +34 -0
- package/test/utils.ts +30 -165
- package/dist/exports/index.js +0 -6
- package/dist/exports/index.js.map +0 -1
- package/dist/src/exports/index.d.ts +0 -4
- package/dist/src/exports/index.d.ts.map +0 -1
- package/dist/src/target-family.d.ts +0 -2
- package/dist/src/target-family.d.ts.map +0 -1
- package/dist/test/utils.d.ts +0 -14
- package/dist/test/utils.d.ts.map +0 -1
- package/dist/test/utils.js +0 -78
- package/dist/test/utils.js.map +0 -1
- package/src/target-family.ts +0 -7
- package/test/factories.test.ts +0 -274
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [2026] [Prisma Data, Inc]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -6,10 +6,10 @@ Contract emission engine that transforms authored data models into canonical JSO
|
|
|
6
6
|
|
|
7
7
|
The emitter is the core of Prisma Next's contract-first architecture. It takes authored data models (from PSL or TypeScript builders) and produces two deterministic artifacts:
|
|
8
8
|
|
|
9
|
-
1. **`contract.json`** — Canonical JSON representation of the data contract with embedded `
|
|
9
|
+
1. **`contract.json`** — Canonical JSON representation of the data contract with embedded `storageHash` and optional `executionHash`/`profileHash`. Callers may add `_generated` metadata field to indicate it's a generated artifact (excluded from canonicalization/hashing).
|
|
10
10
|
2. **`contract.d.ts`** — TypeScript type definitions used by query builders and tooling (types-only, no runtime code). Includes warning header comments generated by target family hooks to indicate it's a generated file.
|
|
11
11
|
|
|
12
|
-
The emitter is target-family-agnostic
|
|
12
|
+
The emitter is target-family-agnostic. The framework-owned `generateContractDts()` assembles the `.d.ts` template using shared domain utilities and delegates family-specific concerns to an `EmissionSpi` interface. This keeps the core thin while allowing SQL, Document, and other target families to extend emission behavior.
|
|
13
13
|
|
|
14
14
|
## Purpose
|
|
15
15
|
|
|
@@ -17,9 +17,9 @@ Provide a deterministic, verifiable representation of the application's data con
|
|
|
17
17
|
|
|
18
18
|
## Responsibilities
|
|
19
19
|
|
|
20
|
-
- **Parse**: Accept
|
|
21
|
-
- **Validate**: Core structure validation
|
|
22
|
-
- **Canonicalize**: Compute `
|
|
20
|
+
- **Parse**: Accept `Contract` values from authoring surfaces
|
|
21
|
+
- **Validate**: Core structure validation (family-specific validation is the caller's responsibility)
|
|
22
|
+
- **Canonicalize**: Compute `storageHash` (schema meaning), `executionHash` (execution defaults), and `profileHash` (capabilities/pins) from canonical JSON
|
|
23
23
|
- **Emit**: Generate `contract.json` and `contract.d.ts` with family-specific type generation
|
|
24
24
|
- **Descriptor-Agnostic**: The emitter is completely agnostic to how descriptors are produced. It receives pre-assembled `OperationRegistry`, `codecTypeImports`, `operationTypeImports`, and `extensionIds` from the CLI or family helpers—no pack manifest parsing happens inside the emitter.
|
|
25
25
|
|
|
@@ -41,7 +41,7 @@ flowchart TD
|
|
|
41
41
|
end
|
|
42
42
|
|
|
43
43
|
subgraph "Emitter Core"
|
|
44
|
-
IR[Contract
|
|
44
|
+
IR[Contract]
|
|
45
45
|
VAL[Validate Core Structure]
|
|
46
46
|
HASH[Compute Hashes]
|
|
47
47
|
EMIT[Emit JSON + DTS]
|
|
@@ -49,6 +49,7 @@ flowchart TD
|
|
|
49
49
|
|
|
50
50
|
subgraph "Target Family Hooks"
|
|
51
51
|
SQL[SQL Hook]
|
|
52
|
+
MONGO[Mongo Hook]
|
|
52
53
|
DOC[Document Hook]
|
|
53
54
|
end
|
|
54
55
|
|
|
@@ -61,8 +62,10 @@ flowchart TD
|
|
|
61
62
|
TS --> IR
|
|
62
63
|
IR --> VAL
|
|
63
64
|
VAL --> SQL
|
|
65
|
+
VAL --> MONGO
|
|
64
66
|
VAL --> DOC
|
|
65
67
|
SQL --> HASH
|
|
68
|
+
MONGO --> HASH
|
|
66
69
|
DOC --> HASH
|
|
67
70
|
PACK1 --> SQL
|
|
68
71
|
PACK2 --> DOC
|
|
@@ -73,34 +76,38 @@ flowchart TD
|
|
|
73
76
|
|
|
74
77
|
## Components
|
|
75
78
|
|
|
76
|
-
### Core Emitter (`
|
|
77
|
-
- Orchestrates
|
|
79
|
+
### Core Emitter (`emit.ts`)
|
|
80
|
+
- Orchestrates hashing and type generation
|
|
78
81
|
- Returns contract JSON and TypeScript definitions as strings (no file I/O)
|
|
79
82
|
- Pure transformation function
|
|
80
|
-
- Accepts `targetFamily:
|
|
81
|
-
|
|
82
|
-
###
|
|
83
|
-
-
|
|
84
|
-
|
|
85
|
-
- `
|
|
86
|
-
- `
|
|
87
|
-
-
|
|
88
|
-
-
|
|
89
|
-
|
|
90
|
-
|
|
83
|
+
- Accepts `targetFamily: EmissionSpi` as a required parameter (no global registry)
|
|
84
|
+
|
|
85
|
+
### Framework Template (`generate-contract-dts.ts`)
|
|
86
|
+
- Assembles the full `.d.ts` template using shared domain-level utilities from `domain-type-generation.ts`
|
|
87
|
+
- Delegates family-specific concerns to `EmissionSpi` callbacks:
|
|
88
|
+
- `generateStorageType`: Generate the family-specific storage type literal
|
|
89
|
+
- `generateModelStorageType`: Generate storage type for a single model
|
|
90
|
+
- `generateModelsType` (optional): Override default domain model type generation
|
|
91
|
+
- `getFamilyImports`, `getFamilyTypeAliases`, `getTypeMapsExpression`, `getContractWrapper`: Family-specific template fragments
|
|
92
|
+
|
|
93
|
+
### EmissionSpi (defined in `@prisma-next/framework-components/emission`)
|
|
94
|
+
- Focused interface for family-specific parts of contract type emission
|
|
95
|
+
- Authoring surfaces determine which SPI to use based on the contract's `targetFamily` field and pass it to `emit()`
|
|
96
|
+
- **Manifest-Agnostic**: The emitter receives pre-assembled context (type imports), not extension packs
|
|
97
|
+
|
|
98
|
+
**Known limitation**: The SQL emitter provides its own `generateModelsType` that derives field codecs from storage table columns (since SQL `model.fields.codecId` is not populated at authoring time). This means the shared `generateModelsType` utility is only used by Mongo. A future change to populate `model.fields.codecId` at authoring time would eliminate this override.
|
|
91
99
|
|
|
92
100
|
### Hashing (`hashing.ts`)
|
|
93
|
-
- `
|
|
101
|
+
- `computeStorageHash`: SHA-256 of schema structure (models, storage, relations)
|
|
102
|
+
- `computeExecutionHash`: SHA-256 of execution defaults
|
|
94
103
|
- `computeProfileHash`: SHA-256 of capabilities and adapter pins
|
|
95
104
|
|
|
96
105
|
### Canonicalization (`canonicalization.ts`)
|
|
97
|
-
- `canonicalizeContract`: Normalizes contract
|
|
106
|
+
- `canonicalizeContract`: Normalizes contract into stable JSON string for hashing
|
|
98
107
|
- Excludes `_generated` metadata field from canonicalization to ensure determinism
|
|
99
108
|
- Sorts object keys, omits default values, and orders top-level fields consistently
|
|
100
109
|
|
|
101
|
-
**Note**: Extension pack descriptor wiring happens in the CLI/family layer. The emitter only sees the resulting
|
|
102
|
-
|
|
103
|
-
**Note**: `TargetFamilyHook`, `ValidationContext`, and `TypesImportSpec` types are defined in `@prisma-next/contract/types` (shared plane) to allow both migration-plane (emitter) and shared-plane (control-plane) packages to import them without violating dependency rules. These types are re-exported from this package for backward compatibility.
|
|
110
|
+
**Note**: Extension pack descriptor wiring happens in the CLI/family layer. The emitter only sees the resulting type import arrays.
|
|
104
111
|
|
|
105
112
|
## Dependencies
|
|
106
113
|
|
|
@@ -121,7 +128,7 @@ This package is part of the **framework domain**, **tooling layer**, **migration
|
|
|
121
128
|
|
|
122
129
|
## Related ADRs
|
|
123
130
|
|
|
124
|
-
- [ADR 004 -
|
|
131
|
+
- [ADR 004 - Storage Hash vs Profile Hash](../../../../docs/architecture%20docs/adrs/ADR%20004%20-%20Storage%20Hash%20vs%20Profile%20Hash.md)
|
|
125
132
|
- [ADR 006 - Dual Authoring Modes](../../../../docs/architecture%20docs/adrs/ADR%20006%20-%20Dual%20Authoring%20Modes.md)
|
|
126
133
|
- [ADR 007 - Types Only Emission](../../../../docs/architecture%20docs/adrs/ADR%20007%20-%20Types%20Only%20Emission.md)
|
|
127
134
|
- [ADR 010 - Canonicalization Rules](../../../../docs/architecture%20docs/adrs/ADR%20010%20-%20Canonicalization%20Rules.md)
|
|
@@ -131,14 +138,15 @@ This package is part of the **framework domain**, **tooling layer**, **migration
|
|
|
131
138
|
|
|
132
139
|
```typescript
|
|
133
140
|
import { emit } from '@prisma-next/emitter';
|
|
134
|
-
import type {
|
|
141
|
+
import type { Contract } from '@prisma-next/contract/types';
|
|
135
142
|
import { createOperationRegistry } from '@prisma-next/operations';
|
|
136
143
|
|
|
137
144
|
// Determine target family SPI based on target family
|
|
138
|
-
import {
|
|
145
|
+
import { sqlEmission } from '@prisma-next/sql-contract-emitter';
|
|
146
|
+
// or: import { mongoEmission } from '@prisma-next/mongo-emitter';
|
|
139
147
|
|
|
140
148
|
// Emit contract
|
|
141
|
-
const
|
|
149
|
+
const contract: Contract = {
|
|
142
150
|
schemaVersion: '1',
|
|
143
151
|
targetFamily: 'sql',
|
|
144
152
|
target: 'postgres',
|
|
@@ -146,17 +154,18 @@ const ir: ContractIR = {
|
|
|
146
154
|
};
|
|
147
155
|
|
|
148
156
|
// Pass pre-assembled context to emit() (pack loading happens in CLI layer)
|
|
149
|
-
const result = await emit(
|
|
157
|
+
const result = await emit(contract, {
|
|
150
158
|
outputDir: './dist',
|
|
151
159
|
operationRegistry: createOperationRegistry(), // Pre-assembled from packs
|
|
152
160
|
codecTypeImports: [], // Extracted from packs (codec types)
|
|
153
161
|
operationTypeImports: [], // Extracted from packs (operation types)
|
|
154
162
|
extensionIds: ['postgres', 'pg'], // Extracted from packs
|
|
155
|
-
},
|
|
163
|
+
}, sqlEmission);
|
|
156
164
|
|
|
157
165
|
// result.contractJson: string (JSON) - canonical JSON without _generated metadata
|
|
158
166
|
// result.contractDts: string (TypeScript definitions) - includes warning header
|
|
159
|
-
// result.
|
|
167
|
+
// result.storageHash: string
|
|
168
|
+
// result.executionHash?: string
|
|
160
169
|
// result.profileHash?: string
|
|
161
170
|
```
|
|
162
171
|
|
|
@@ -164,12 +173,12 @@ const result = await emit(ir, {
|
|
|
164
173
|
|
|
165
174
|
## Test Utilities
|
|
166
175
|
|
|
167
|
-
When writing tests that create `
|
|
176
|
+
When writing tests that create `Contract` objects, use the factory helpers from `@prisma-next/contract/testing` or this package’s `test/utils` (`createTestContract`):
|
|
168
177
|
|
|
169
178
|
```typescript
|
|
170
|
-
import {
|
|
179
|
+
import { createTestContract } from './test/utils';
|
|
171
180
|
|
|
172
|
-
const
|
|
181
|
+
const contract = createTestContract({
|
|
173
182
|
storage: {
|
|
174
183
|
tables: {
|
|
175
184
|
user: {
|
|
@@ -186,5 +195,6 @@ This ensures all required fields are present with sensible defaults. See `.curso
|
|
|
186
195
|
|
|
187
196
|
## Exports
|
|
188
197
|
|
|
189
|
-
- `.`: Main emitter API (`emit`, types)
|
|
198
|
+
- `.`: Main emitter API (`emit`, types, shared domain-level generation utilities)
|
|
199
|
+
- `./domain-type-generation`: Shared domain-level `.d.ts` generation utilities (used by family-specific emitter hooks)
|
|
190
200
|
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import { ContractField, ContractModel, ContractValueObject } from "@prisma-next/contract/types";
|
|
2
|
+
import { CodecLookup } from "@prisma-next/framework-components/codec";
|
|
3
|
+
import { TypesImportSpec } from "@prisma-next/framework-components/emission";
|
|
4
|
+
|
|
5
|
+
//#region src/domain-type-generation.d.ts
|
|
6
|
+
declare function serializeValue(value: unknown): string;
|
|
7
|
+
declare function serializeObjectKey(key: string): string;
|
|
8
|
+
declare function generateRootsType(roots: Record<string, string> | undefined): string;
|
|
9
|
+
declare function generateModelFieldEntry(fieldName: string, field: ContractField): string;
|
|
10
|
+
declare function generateModelFieldsType(fields: Record<string, ContractField>): string;
|
|
11
|
+
declare function generateModelRelationsType(relations: Record<string, unknown>): string;
|
|
12
|
+
declare function generateModelsType(models: Record<string, ContractModel>, generateModelStorage: (modelName: string, model: ContractModel) => string): string;
|
|
13
|
+
declare function deduplicateImports(imports: TypesImportSpec[]): TypesImportSpec[];
|
|
14
|
+
declare function generateImportLines(imports: TypesImportSpec[]): string[];
|
|
15
|
+
declare function generateCodecTypeIntersection(imports: ReadonlyArray<TypesImportSpec>, named: string): string;
|
|
16
|
+
declare function serializeExecutionType(execution: Record<string, unknown>): string;
|
|
17
|
+
declare function generateHashTypeAliases(hashes: {
|
|
18
|
+
readonly storageHash: string;
|
|
19
|
+
readonly executionHash?: string;
|
|
20
|
+
readonly profileHash: string;
|
|
21
|
+
}): string;
|
|
22
|
+
type ResolvedFieldType = {
|
|
23
|
+
readonly input: string;
|
|
24
|
+
readonly output: string;
|
|
25
|
+
};
|
|
26
|
+
declare function resolveFieldType(field: ContractField, codecLookup?: CodecLookup): ResolvedFieldType;
|
|
27
|
+
declare function generateFieldResolvedType(field: ContractField, codecLookup?: CodecLookup, side?: 'input' | 'output'): string;
|
|
28
|
+
declare function generateBothFieldTypesMaps(models: Record<string, ContractModel> | undefined, codecLookup?: CodecLookup): ResolvedFieldType;
|
|
29
|
+
declare function generateFieldOutputTypesMap(models: Record<string, ContractModel> | undefined, codecLookup?: CodecLookup): string;
|
|
30
|
+
declare function generateFieldInputTypesMap(models: Record<string, ContractModel> | undefined, codecLookup?: CodecLookup): string;
|
|
31
|
+
declare function generateValueObjectType(_voName: string, vo: ContractValueObject, _valueObjects: Record<string, ContractValueObject>, side?: 'input' | 'output', codecLookup?: CodecLookup): string;
|
|
32
|
+
declare function resolveValueObjectType(_voName: string, vo: ContractValueObject, _valueObjects: Record<string, ContractValueObject>, codecLookup?: CodecLookup): ResolvedFieldType;
|
|
33
|
+
declare function generateContractFieldDescriptor(fieldName: string, field: ContractField): string;
|
|
34
|
+
declare function generateValueObjectsDescriptorType(valueObjects: Record<string, ContractValueObject> | undefined): string;
|
|
35
|
+
declare function generateValueObjectTypeAliases(valueObjects: Record<string, ContractValueObject> | undefined, codecLookup?: CodecLookup): string;
|
|
36
|
+
//#endregion
|
|
37
|
+
export { ResolvedFieldType, deduplicateImports, generateBothFieldTypesMaps, generateCodecTypeIntersection, generateContractFieldDescriptor, generateFieldInputTypesMap, generateFieldOutputTypesMap, generateFieldResolvedType, generateHashTypeAliases, generateImportLines, generateModelFieldEntry, generateModelFieldsType, generateModelRelationsType, generateModelsType, generateRootsType, generateValueObjectType, generateValueObjectTypeAliases, generateValueObjectsDescriptorType, resolveFieldType, resolveValueObjectType, serializeExecutionType, serializeObjectKey, serializeValue };
|
|
38
|
+
//# sourceMappingURL=domain-type-generation.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"domain-type-generation.d.mts","names":[],"sources":["../src/domain-type-generation.ts"],"sourcesContent":[],"mappings":";;;;;iBASgB,cAAA;iBA+BA,kBAAA;AA/BA,iBAsCA,iBAAA,CAtCc,KAAA,EAsCW,MAtCX,CAAA,MAAA,EAAA,MAAA,CAAA,GAAA,SAAA,CAAA,EAAA,MAAA;AA+Bd,iBAuBA,uBAAA,CAvBkB,SAAA,EAAA,MAAA,EAAA,KAAA,EAuBgC,aAvBhC,CAAA,EAAA,MAAA;AAOlB,iBAgCA,uBAAA,CAhC+B,MAAA,EAgCC,MAhCD,CAAA,MAAA,EAgCgB,aAhChB,CAAA,CAAA,EAAA,MAAA;AAgB/B,iBAwBA,0BAAA,CAxBkD,SAAa,EAwBzB,MAxByB,CAAA,MAAA,EAAA,OAAA,CAAA,CAAA,EAAA,MAAA;AAgB/D,iBA8CA,kBAAA,CA9C+C,MAAA,EA+CrD,MA/CsC,CAAA,MAAM,EA+C7B,aA/C6B,CAAA,EAAA,oBAAA,EAAA,CAAA,SAAA,EAAA,MAAA,EAAA,KAAA,EAgDH,aAhDG,EAAA,GAAA,MAAA,CAAA,EAAA,MAAA;AAQtC,iBA6EA,kBAAA,CA7E0B,OAAY,EA6EV,eA7EgB,EAAA,CAAA,EA6EI,eA7EJ,EAAA;AAsC5C,iBAoDA,mBAAA,CApDkB,OAAA,EAoDW,eApDX,EAAA,CAAA,EAAA,MAAA,EAAA;AACT,iBA0DT,6BAAA,CA1DS,OAAA,EA2Dd,aA3Dc,CA2DA,eA3DA,CAAA,EAAA,KAAA,EAAA,MAAA,CAAA,EAAA,MAAA;AAAf,iBAkEM,sBAAA,CAlEN,SAAA,EAkEwC,MAlExC,CAAA,MAAA,EAAA,OAAA,CAAA,CAAA,EAAA,MAAA;AACyC,iBA0EnC,uBAAA,CA1EmC,MAAA,EAAA;EAAa,SAAA,WAAA,EAAA,MAAA;EAqChD,SAAA,aAAkB,CAAA,EAAA,MAAA;EAalB,SAAA,WAAA,EAAmB,MAAA;AAOnC,CAAA,CAAA,EAAgB,MAAA;AAQA,KAyBJ,iBAAA,GAzB0B;EAStB,SAAA,KAAA,EAAA,MAAA;EAgBJ,SAAA,MAAA,EAAA,MAAiB;AAU7B,CAAA;AACS,iBADO,gBAAA,CACP,KAAA,EAAA,aAAA,EAAA,WAAA,CAAA,EACO,WADP,CAAA,EAEN,iBAFM;AACO,iBAmDA,yBAAA,CAnDA,KAAA,EAoDP,aApDO,EAAA,WAAA,CAAA,EAqDA,WArDA,EAAA,IAAA,CAAA,EAAA,OAAA,GAAA,QAAA,CAAA,EAAA,MAAA;AACb,iBA0Da,0BAAA,CA1Db,MAAA,EA2DO,MA3DP,CAAA,MAAA,EA2DsB,aA3DtB,CAAA,GAAA,SAAA,EAAA,WAAA,CAAA,EA4Da,WA5Db,CAAA,EA6DA,iBA7DA;AAAiB,iBAiGJ,2BAAA,CAjGI,MAAA,EAkGV,MAlGU,CAAA,MAAA,EAkGK,aAlGL,CAAA,GAAA,SAAA,EAAA,WAAA,CAAA,EAmGJ,WAnGI,CAAA,EAAA,MAAA;AAkDJ,iBAsDA,0BAAA,CArDP,MAAA,EAsDC,MArDM,CAAA,MAAW,EAqDF,aArDE,CAAA,GAAA,SAAA,EAAA,WAAA,CAAA,EAsDX,WAtDW,CAAA,EAAA,MAAA;AAMX,iBAqDA,uBAAA,CArD0B,OAAA,EAAA,MAAA,EAAA,EAAA,EAuDpC,mBAvDoC,EAAA,aAAA,EAwDzB,MAxDyB,CAAA,MAAA,EAwDV,mBAxDU,CAAA,EAAA,IAAA,CAAA,EAAA,OAAA,GAAA,QAAA,EAAA,WAAA,CAAA,EA0D1B,WA1D0B,CAAA,EAAA,MAAA;AACjB,iBA8DT,sBAAA,CA9DS,OAAA,EAAA,MAAA,EAAA,EAAA,EAgEnB,mBAhEmB,EAAA,aAAA,EAiER,MAjEQ,CAAA,MAAA,EAiEO,mBAjEP,CAAA,EAAA,WAAA,CAAA,EAkET,WAlES,CAAA,EAmEtB,iBAnEsB;AAAf,iBAmFM,+BAAA,CAnFN,SAAA,EAAA,MAAA,EAAA,KAAA,EAmFgE,aAnFhE,CAAA,EAAA,MAAA;AACM,iBAsGA,kCAAA,CAtGA,YAAA,EAuGA,MAvGA,CAAA,MAAA,EAuGe,mBAvGf,CAAA,GAAA,SAAA,CAAA,EAAA,MAAA;AACb,iBA0Ha,8BAAA,CA1Hb,YAAA,EA2Ha,MA3Hb,CAAA,MAAA,EA2H4B,mBA3H5B,CAAA,GAAA,SAAA,EAAA,WAAA,CAAA,EA4Ha,WA5Hb,CAAA,EAAA,MAAA"}
|