prisma-next 0.0.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 +69 -0
- package/dist/agent-skill-mongo.md +106 -0
- package/dist/agent-skill-postgres.md +106 -0
- package/dist/cli-errors-BDCYR5ap.mjs +4 -0
- package/dist/cli-errors-DStABy9d.d.mts +3 -0
- package/dist/cli.d.mts +1 -0
- package/dist/cli.js +2 -0
- package/dist/cli.mjs +261 -0
- package/dist/cli.mjs.map +1 -0
- package/dist/client-tdnbk0OR.mjs +994 -0
- package/dist/client-tdnbk0OR.mjs.map +1 -0
- package/dist/commands/contract-emit.d.mts +7 -0
- package/dist/commands/contract-emit.d.mts.map +1 -0
- package/dist/commands/contract-emit.mjs +9 -0
- package/dist/commands/contract-infer.d.mts +7 -0
- package/dist/commands/contract-infer.d.mts.map +1 -0
- package/dist/commands/contract-infer.mjs +10 -0
- package/dist/commands/db-init.d.mts +7 -0
- package/dist/commands/db-init.d.mts.map +1 -0
- package/dist/commands/db-init.mjs +126 -0
- package/dist/commands/db-init.mjs.map +1 -0
- package/dist/commands/db-schema.d.mts +7 -0
- package/dist/commands/db-schema.d.mts.map +1 -0
- package/dist/commands/db-schema.mjs +56 -0
- package/dist/commands/db-schema.mjs.map +1 -0
- package/dist/commands/db-sign.d.mts +7 -0
- package/dist/commands/db-sign.d.mts.map +1 -0
- package/dist/commands/db-sign.mjs +137 -0
- package/dist/commands/db-sign.mjs.map +1 -0
- package/dist/commands/db-update.d.mts +7 -0
- package/dist/commands/db-update.d.mts.map +1 -0
- package/dist/commands/db-update.mjs +123 -0
- package/dist/commands/db-update.mjs.map +1 -0
- package/dist/commands/db-verify.d.mts +7 -0
- package/dist/commands/db-verify.d.mts.map +1 -0
- package/dist/commands/db-verify.mjs +323 -0
- package/dist/commands/db-verify.mjs.map +1 -0
- package/dist/commands/migration-apply.d.mts +36 -0
- package/dist/commands/migration-apply.d.mts.map +1 -0
- package/dist/commands/migration-apply.mjs +245 -0
- package/dist/commands/migration-apply.mjs.map +1 -0
- package/dist/commands/migration-new.d.mts +8 -0
- package/dist/commands/migration-new.d.mts.map +1 -0
- package/dist/commands/migration-new.mjs +152 -0
- package/dist/commands/migration-new.mjs.map +1 -0
- package/dist/commands/migration-plan.d.mts +47 -0
- package/dist/commands/migration-plan.d.mts.map +1 -0
- package/dist/commands/migration-plan.mjs +313 -0
- package/dist/commands/migration-plan.mjs.map +1 -0
- package/dist/commands/migration-ref.d.mts +43 -0
- package/dist/commands/migration-ref.d.mts.map +1 -0
- package/dist/commands/migration-ref.mjs +195 -0
- package/dist/commands/migration-ref.mjs.map +1 -0
- package/dist/commands/migration-show.d.mts +28 -0
- package/dist/commands/migration-show.d.mts.map +1 -0
- package/dist/commands/migration-show.mjs +140 -0
- package/dist/commands/migration-show.mjs.map +1 -0
- package/dist/commands/migration-status.d.mts +86 -0
- package/dist/commands/migration-status.d.mts.map +1 -0
- package/dist/commands/migration-status.mjs +9 -0
- package/dist/commands/migration-verify.d.mts +16 -0
- package/dist/commands/migration-verify.d.mts.map +1 -0
- package/dist/commands/migration-verify.mjs +110 -0
- package/dist/commands/migration-verify.mjs.map +1 -0
- package/dist/config-loader-C4VXKl8f.mjs +43 -0
- package/dist/config-loader-C4VXKl8f.mjs.map +1 -0
- package/dist/config-loader.d.mts +17 -0
- package/dist/config-loader.d.mts.map +1 -0
- package/dist/config-loader.mjs +3 -0
- package/dist/contract-emit-CRoS1nx5.mjs +118 -0
- package/dist/contract-emit-CRoS1nx5.mjs.map +1 -0
- package/dist/contract-emit-CVUWsFfx.mjs +6 -0
- package/dist/contract-emit-Ctn6mH9H.mjs +191 -0
- package/dist/contract-emit-Ctn6mH9H.mjs.map +1 -0
- package/dist/contract-enrichment-CGW6mm-E.mjs +79 -0
- package/dist/contract-enrichment-CGW6mm-E.mjs.map +1 -0
- package/dist/contract-infer-Ba1SE57Q.mjs +90 -0
- package/dist/contract-infer-Ba1SE57Q.mjs.map +1 -0
- package/dist/exports/config-types.d.mts +2 -0
- package/dist/exports/config-types.mjs +3 -0
- package/dist/exports/control-api.d.mts +624 -0
- package/dist/exports/control-api.d.mts.map +1 -0
- package/dist/exports/control-api.mjs +8 -0
- package/dist/exports/index.d.mts +26 -0
- package/dist/exports/index.d.mts.map +1 -0
- package/dist/exports/index.mjs +142 -0
- package/dist/exports/index.mjs.map +1 -0
- package/dist/extract-operation-statements-DZUJNmL3.mjs +13 -0
- package/dist/extract-operation-statements-DZUJNmL3.mjs.map +1 -0
- package/dist/extract-sql-ddl-DDMX-9mz.mjs +26 -0
- package/dist/extract-sql-ddl-DDMX-9mz.mjs.map +1 -0
- package/dist/framework-components-BAsliT4V.mjs +59 -0
- package/dist/framework-components-BAsliT4V.mjs.map +1 -0
- package/dist/init-DGraYDwV.mjs +430 -0
- package/dist/init-DGraYDwV.mjs.map +1 -0
- package/dist/inspect-live-schema-gYQiWfpl.mjs +91 -0
- package/dist/inspect-live-schema-gYQiWfpl.mjs.map +1 -0
- package/dist/migration-command-scaffold-x4n_ZhAh.mjs +105 -0
- package/dist/migration-command-scaffold-x4n_ZhAh.mjs.map +1 -0
- package/dist/migration-status-DyVDf5NI.mjs +1583 -0
- package/dist/migration-status-DyVDf5NI.mjs.map +1 -0
- package/dist/migrations-DTZBYXm1.mjs +173 -0
- package/dist/migrations-DTZBYXm1.mjs.map +1 -0
- package/dist/progress-adapter-B-YvmcDu.mjs +43 -0
- package/dist/progress-adapter-B-YvmcDu.mjs.map +1 -0
- package/dist/quick-reference-mongo.md +93 -0
- package/dist/quick-reference-postgres.md +91 -0
- package/dist/result-handler-oK_vA-Fn.mjs +697 -0
- package/dist/result-handler-oK_vA-Fn.mjs.map +1 -0
- package/dist/terminal-ui-C5k88MmW.mjs +274 -0
- package/dist/terminal-ui-C5k88MmW.mjs.map +1 -0
- package/dist/validate-contract-deps-esa-VQ0h.mjs +37 -0
- package/dist/validate-contract-deps-esa-VQ0h.mjs.map +1 -0
- package/dist/verify-DlFQ2FOw.mjs +385 -0
- package/dist/verify-DlFQ2FOw.mjs.map +1 -0
- package/package.json +126 -0
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
ADDED
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# prisma-next
|
|
2
|
+
|
|
3
|
+
The Prisma Next CLI. Emit contracts, verify and sign databases, and run migrations from a type-safe contract.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
pnpm add -D prisma-next
|
|
9
|
+
# or
|
|
10
|
+
npm install -D prisma-next
|
|
11
|
+
# or
|
|
12
|
+
yarn add -D prisma-next
|
|
13
|
+
# or
|
|
14
|
+
bun add -D prisma-next
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
No install? Run it directly:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
pnpm dlx prisma-next init
|
|
21
|
+
npx prisma-next init
|
|
22
|
+
bunx prisma-next init
|
|
23
|
+
yarn dlx prisma-next init
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Quickstart
|
|
27
|
+
|
|
28
|
+
In a project with a `package.json`:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
pnpm dlx prisma-next init
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Init prompts for your database (PostgreSQL or MongoDB) and schema location, scaffolds the config/schema/runtime files, installs the target facade (e.g. `@prisma-next/postgres`) plus `prisma-next`, and emits your contract.
|
|
35
|
+
|
|
36
|
+
## Commands
|
|
37
|
+
|
|
38
|
+
| Command | Purpose |
|
|
39
|
+
| --- | --- |
|
|
40
|
+
| `prisma-next init` | Scaffold a new Prisma Next project (config, schema, runtime, docs). |
|
|
41
|
+
| `prisma-next contract emit` | Emit `contract.json` and `contract.d.ts` from your schema. |
|
|
42
|
+
| `prisma-next contract infer` | Introspect a database and write an inferred PSL contract. |
|
|
43
|
+
| `prisma-next db init` | Bootstrap a database to match the current contract (additive only). |
|
|
44
|
+
| `prisma-next db update` | Update a database to match the current contract (including destructive ops). |
|
|
45
|
+
| `prisma-next db schema` | Inspect the live database schema. |
|
|
46
|
+
| `prisma-next db sign` | Write or update the contract marker on the database. |
|
|
47
|
+
| `prisma-next db verify` | Verify the database matches the emitted contract. |
|
|
48
|
+
| `prisma-next migration plan` | Plan a new migration from contract changes. |
|
|
49
|
+
| `prisma-next migration show` | Display a migration package. |
|
|
50
|
+
| `prisma-next migration status` | Show the migration graph and applied status. |
|
|
51
|
+
| `prisma-next migration apply` | Apply planned migrations to the database. |
|
|
52
|
+
| `prisma-next migration verify` | Verify a migration package's integrity. |
|
|
53
|
+
| `prisma-next migration ref` | Manage named refs in `migrations/refs.json`. |
|
|
54
|
+
|
|
55
|
+
Run `prisma-next --help` or `prisma-next <command> --help` for full options.
|
|
56
|
+
|
|
57
|
+
## Programmatic use
|
|
58
|
+
|
|
59
|
+
The package also exports subpaths for tooling integrations:
|
|
60
|
+
|
|
61
|
+
- `prisma-next/config-types` — `defineConfig` and config types
|
|
62
|
+
- `prisma-next/control-api` — `createControlClient` for programmatic control-plane operations
|
|
63
|
+
- `prisma-next/config-loader` — `loadConfig`
|
|
64
|
+
- `prisma-next/commands/*` — individual command factories (`createContractEmitCommand`, `createDbInitCommand`, …)
|
|
65
|
+
|
|
66
|
+
## Links
|
|
67
|
+
|
|
68
|
+
- Project: [prisma-next on GitHub](https://github.com/prisma/prisma-next)
|
|
69
|
+
- Internal architecture documentation: [`@prisma-next/cli` README](https://github.com/prisma/prisma-next/tree/main/packages/1-framework/3-tooling/cli)
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
# Prisma Next — project skill
|
|
2
|
+
|
|
3
|
+
This project uses **Prisma Next** with **MongoDB** via `@prisma-next/mongo`. Prisma Next lets the user define data models in a contract file and query them with a fully typed ORM.
|
|
4
|
+
|
|
5
|
+
## Files
|
|
6
|
+
|
|
7
|
+
- **Contract**: `{{schemaPath}}` — the user's data models. Edit this to add or change models.
|
|
8
|
+
- **Config**: `prisma-next.config.ts` — tells the CLI where the contract is and how to connect to the database. Loads `.env` via `dotenv/config`.
|
|
9
|
+
- **Database client**: `{{schemaDir}}/db.ts` — `import { db } from '{{dbImportPath}}'`. This is the entry point for all queries.
|
|
10
|
+
- **Generated files** (do not edit by hand):
|
|
11
|
+
- `{{schemaDir}}/contract.json` — compiled contract, used at runtime
|
|
12
|
+
- `{{schemaDir}}/contract.d.ts` — TypeScript types for the contract, used for autocomplete and type checking
|
|
13
|
+
|
|
14
|
+
## Commands
|
|
15
|
+
|
|
16
|
+
- `{{pkgRun}} contract emit` — regenerate `contract.json` and `contract.d.ts` after changing the contract
|
|
17
|
+
- `{{pkgRun}} db init` — bootstrap a database to match the contract (creates collections, indexes, constraints). Additive only — won't drop existing structures.
|
|
18
|
+
- `{{pkgRun}} db update` — update the database to match the current contract. Prompts for confirmation on destructive changes. Use `--dry-run` to preview.
|
|
19
|
+
- `{{pkgRun}} migration plan` — create a new migration from contract changes (offline, no database needed). Use `--name <slug>` to name it.
|
|
20
|
+
- `{{pkgRun}} migration apply` — apply pending migrations to the database
|
|
21
|
+
- `{{pkgRun}} migration status` — show which migrations are applied and which are pending
|
|
22
|
+
- `{{pkgRun}} migration show <name>` — show details of a specific migration
|
|
23
|
+
|
|
24
|
+
## How to write queries
|
|
25
|
+
|
|
26
|
+
Always use the ORM (`db.orm`). Only fall back to `db.sql` if the user explicitly asks for raw queries or the ORM doesn't support the operation.
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
import { db } from '{{dbImportPath}}';
|
|
30
|
+
|
|
31
|
+
// Find one record
|
|
32
|
+
const user = await db.orm.User
|
|
33
|
+
.where(user => user.email.eq('alice@example.com'))
|
|
34
|
+
.first();
|
|
35
|
+
// Returns { id: ObjectId; email: string; ... } | null
|
|
36
|
+
|
|
37
|
+
// Find multiple records
|
|
38
|
+
const users = await db.orm.User
|
|
39
|
+
.select('id', 'email')
|
|
40
|
+
.take(10)
|
|
41
|
+
.all();
|
|
42
|
+
// Returns Array<{ id: ObjectId; email: string }>
|
|
43
|
+
|
|
44
|
+
// Filter, order, limit
|
|
45
|
+
const recentPosts = await db.orm.Post
|
|
46
|
+
.where(post => post.authorId.eq(userId))
|
|
47
|
+
.orderBy(post => post.createdAt.desc())
|
|
48
|
+
.select('id', 'title', 'createdAt')
|
|
49
|
+
.take(50)
|
|
50
|
+
.all();
|
|
51
|
+
|
|
52
|
+
// Include relations
|
|
53
|
+
const usersWithPosts = await db.orm.User
|
|
54
|
+
.select('id', 'email')
|
|
55
|
+
.include('posts', post =>
|
|
56
|
+
post.select('id', 'title').orderBy(p => p.createdAt.desc()).take(5)
|
|
57
|
+
)
|
|
58
|
+
.take(10)
|
|
59
|
+
.all();
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Key ORM methods
|
|
63
|
+
|
|
64
|
+
- `.where(predicate)` — filter records. Predicate receives a model accessor with `.eq()`, `.neq()`, `.ilike()`, `.lt()`, `.gt()`, etc.
|
|
65
|
+
- `.select('field1', 'field2', ...)` — pick which fields to return
|
|
66
|
+
- `.orderBy(accessor => accessor.field.asc()` or `.desc())` — sort results
|
|
67
|
+
- `.take(n)` — limit number of results
|
|
68
|
+
- `.all()` — execute and return all matching records as an array
|
|
69
|
+
- `.first()` — execute and return the first matching record, or `null`
|
|
70
|
+
- `.first({ id: value })` — find a single record by primary key, or `null`
|
|
71
|
+
- `.include('relation', builder => ...)` — eager-load a relation
|
|
72
|
+
|
|
73
|
+
## Rules
|
|
74
|
+
|
|
75
|
+
- **Never hand-edit** `contract.json` or `contract.d.ts`. Always regenerate them with `contract emit`.
|
|
76
|
+
- **Always emit after contract changes.** When you modify `{{schemaPath}}`, run `{{pkgRun}} contract emit` before writing any code that depends on the new or changed models.
|
|
77
|
+
- **Don't restructure `db.ts`.** It's scaffolded by init and works as-is.
|
|
78
|
+
- **Use `db.orm` for queries**, not `db.sql`. The ORM is the primary query surface.
|
|
79
|
+
- **Connection string** is `DATABASE_URL` in `.env`. If the user reports connection errors, check this value and the `.env` file.
|
|
80
|
+
|
|
81
|
+
## Workflow for common tasks
|
|
82
|
+
|
|
83
|
+
**User wants to add a new model or field:**
|
|
84
|
+
1. Edit `{{schemaPath}}`
|
|
85
|
+
2. Run `{{pkgRun}} contract emit`
|
|
86
|
+
3. Write query code using `db.orm.ModelName`
|
|
87
|
+
|
|
88
|
+
**User wants to query data:**
|
|
89
|
+
1. Import `db` from `{{dbImportPath}}`
|
|
90
|
+
2. Use `db.orm.ModelName` with `.where()`, `.select()`, `.all()`, `.first()`, etc.
|
|
91
|
+
|
|
92
|
+
**User wants to set up or change the database connection:**
|
|
93
|
+
1. Edit `DATABASE_URL` in `.env`
|
|
94
|
+
2. The config file (`prisma-next.config.ts`) reads it automatically via `dotenv/config`
|
|
95
|
+
|
|
96
|
+
**User wants to set up the database for the first time:**
|
|
97
|
+
1. Run `{{pkgRun}} db init`
|
|
98
|
+
|
|
99
|
+
**User wants to update the database after changing the contract:**
|
|
100
|
+
1. Quick path: `{{pkgRun}} db update` — compares the database to the contract and applies changes directly
|
|
101
|
+
2. Migration path (for production workflows):
|
|
102
|
+
- `{{pkgRun}} migration plan --name describe-the-change` — creates a migration
|
|
103
|
+
- `{{pkgRun}} migration apply` — applies pending migrations
|
|
104
|
+
|
|
105
|
+
**User wants to check what migrations need to be applied:**
|
|
106
|
+
1. Run `{{pkgRun}} migration status`
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
# Prisma Next — project skill
|
|
2
|
+
|
|
3
|
+
This project uses **Prisma Next** with **PostgreSQL** via `@prisma-next/postgres`. Prisma Next lets the user define data models in a contract file and query them with a fully typed ORM.
|
|
4
|
+
|
|
5
|
+
## Files
|
|
6
|
+
|
|
7
|
+
- **Contract**: `{{schemaPath}}` — the user's data models. Edit this to add or change models.
|
|
8
|
+
- **Config**: `prisma-next.config.ts` — tells the CLI where the contract is and how to connect to the database. Loads `.env` via `dotenv/config`.
|
|
9
|
+
- **Database client**: `{{schemaDir}}/db.ts` — `import { db } from '{{dbImportPath}}'`. This is the entry point for all queries.
|
|
10
|
+
- **Generated files** (do not edit by hand):
|
|
11
|
+
- `{{schemaDir}}/contract.json` — compiled contract, used at runtime
|
|
12
|
+
- `{{schemaDir}}/contract.d.ts` — TypeScript types for the contract, used for autocomplete and type checking
|
|
13
|
+
|
|
14
|
+
## Commands
|
|
15
|
+
|
|
16
|
+
- `{{pkgRun}} contract emit` — regenerate `contract.json` and `contract.d.ts` after changing the contract
|
|
17
|
+
- `{{pkgRun}} db init` — bootstrap a database to match the contract (creates tables, indexes, constraints). Additive only — won't drop existing structures.
|
|
18
|
+
- `{{pkgRun}} db update` — update the database to match the current contract. Prompts for confirmation on destructive changes. Use `--dry-run` to preview.
|
|
19
|
+
- `{{pkgRun}} migration plan` — create a new migration from contract changes (offline, no database needed). Use `--name <slug>` to name it.
|
|
20
|
+
- `{{pkgRun}} migration apply` — apply pending migrations to the database
|
|
21
|
+
- `{{pkgRun}} migration status` — show which migrations are applied and which are pending
|
|
22
|
+
- `{{pkgRun}} migration show <name>` — show details of a specific migration
|
|
23
|
+
|
|
24
|
+
## How to write queries
|
|
25
|
+
|
|
26
|
+
Always use the ORM (`db.orm`). Only fall back to `db.sql` if the user explicitly asks for raw SQL or the ORM doesn't support the operation.
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
import { db } from '{{dbImportPath}}';
|
|
30
|
+
|
|
31
|
+
// Find one record
|
|
32
|
+
const user = await db.orm.User
|
|
33
|
+
.where(user => user.email.eq('alice@example.com'))
|
|
34
|
+
.first();
|
|
35
|
+
// Returns { id: number; email: string; ... } | null
|
|
36
|
+
|
|
37
|
+
// Find multiple records
|
|
38
|
+
const users = await db.orm.User
|
|
39
|
+
.select('id', 'email')
|
|
40
|
+
.take(10)
|
|
41
|
+
.all();
|
|
42
|
+
// Returns Array<{ id: number; email: string }>
|
|
43
|
+
|
|
44
|
+
// Filter, order, limit
|
|
45
|
+
const recentPosts = await db.orm.Post
|
|
46
|
+
.where(post => post.authorId.eq(userId))
|
|
47
|
+
.orderBy(post => post.createdAt.desc())
|
|
48
|
+
.select('id', 'title', 'createdAt')
|
|
49
|
+
.take(50)
|
|
50
|
+
.all();
|
|
51
|
+
|
|
52
|
+
// Include relations
|
|
53
|
+
const usersWithPosts = await db.orm.User
|
|
54
|
+
.select('id', 'email')
|
|
55
|
+
.include('posts', post =>
|
|
56
|
+
post.select('id', 'title').orderBy(p => p.createdAt.desc()).take(5)
|
|
57
|
+
)
|
|
58
|
+
.take(10)
|
|
59
|
+
.all();
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Key ORM methods
|
|
63
|
+
|
|
64
|
+
- `.where(predicate)` — filter records. Predicate receives a model accessor with `.eq()`, `.neq()`, `.ilike()`, `.lt()`, `.gt()`, etc.
|
|
65
|
+
- `.select('field1', 'field2', ...)` — pick which fields to return
|
|
66
|
+
- `.orderBy(accessor => accessor.field.asc()` or `.desc())` — sort results
|
|
67
|
+
- `.take(n)` — limit number of results
|
|
68
|
+
- `.all()` — execute and return all matching records as an array
|
|
69
|
+
- `.first()` — execute and return the first matching record, or `null`
|
|
70
|
+
- `.first({ id: value })` — find a single record by primary key, or `null`
|
|
71
|
+
- `.include('relation', builder => ...)` — eager-load a relation
|
|
72
|
+
|
|
73
|
+
## Rules
|
|
74
|
+
|
|
75
|
+
- **Never hand-edit** `contract.json` or `contract.d.ts`. Always regenerate them with `contract emit`.
|
|
76
|
+
- **Always emit after contract changes.** When you modify `{{schemaPath}}`, run `{{pkgRun}} contract emit` before writing any code that depends on the new or changed models.
|
|
77
|
+
- **Don't restructure `db.ts`.** It's scaffolded by init and works as-is.
|
|
78
|
+
- **Use `db.orm` for queries**, not `db.sql`. The ORM is the primary query surface.
|
|
79
|
+
- **Connection string** is `DATABASE_URL` in `.env`. If the user reports connection errors, check this value and the `.env` file.
|
|
80
|
+
|
|
81
|
+
## Workflow for common tasks
|
|
82
|
+
|
|
83
|
+
**User wants to add a new model or field:**
|
|
84
|
+
1. Edit `{{schemaPath}}`
|
|
85
|
+
2. Run `{{pkgRun}} contract emit`
|
|
86
|
+
3. Write query code using `db.orm.ModelName`
|
|
87
|
+
|
|
88
|
+
**User wants to query data:**
|
|
89
|
+
1. Import `db` from `{{dbImportPath}}`
|
|
90
|
+
2. Use `db.orm.ModelName` with `.where()`, `.select()`, `.all()`, `.first()`, etc.
|
|
91
|
+
|
|
92
|
+
**User wants to set up or change the database connection:**
|
|
93
|
+
1. Edit `DATABASE_URL` in `.env`
|
|
94
|
+
2. The config file (`prisma-next.config.ts`) reads it automatically via `dotenv/config`
|
|
95
|
+
|
|
96
|
+
**User wants to set up the database for the first time:**
|
|
97
|
+
1. Run `{{pkgRun}} db init`
|
|
98
|
+
|
|
99
|
+
**User wants to update the database after changing the contract:**
|
|
100
|
+
1. Quick path: `{{pkgRun}} db update` — compares the database to the contract and applies changes directly
|
|
101
|
+
2. Migration path (for production workflows):
|
|
102
|
+
- `{{pkgRun}} migration plan --name describe-the-change` — creates a migration
|
|
103
|
+
- `{{pkgRun}} migration apply` — applies pending migrations
|
|
104
|
+
|
|
105
|
+
**User wants to check what migrations need to be applied:**
|
|
106
|
+
1. Run `{{pkgRun}} migration status`
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { CliStructuredError, errorConfigValidation as errorConfigValidation$1, errorContractConfigMissing as errorContractConfigMissing$1, errorContractValidationFailed, errorDatabaseConnectionRequired, errorDriverRequired, errorFileNotFound, errorMigrationPlanningFailed, errorTargetMigrationNotSupported, errorUnexpected as errorUnexpected$1 } from "@prisma-next/errors/control";
|
|
2
|
+
import { ERROR_CODE_DESTRUCTIVE_CHANGES, errorDestructiveChanges, errorHashMismatch, errorMarkerMissing, errorRunnerFailed, errorRuntime as errorRuntime$1, errorTargetMismatch } from "@prisma-next/errors/execution";
|
|
3
|
+
|
|
4
|
+
export { errorUnexpected$1 as _, errorContractValidationFailed as a, errorDriverRequired as c, errorMarkerMissing as d, errorMigrationPlanningFailed as f, errorTargetMismatch as g, errorTargetMigrationNotSupported as h, errorContractConfigMissing$1 as i, errorFileNotFound as l, errorRuntime$1 as m, ERROR_CODE_DESTRUCTIVE_CHANGES as n, errorDatabaseConnectionRequired as o, errorRunnerFailed as p, errorConfigValidation$1 as r, errorDestructiveChanges as s, CliStructuredError as t, errorHashMismatch as u };
|
package/dist/cli.d.mts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { };
|
package/dist/cli.js
ADDED